Amazon Lex Model Building V2

2022/09/09 - Amazon Lex Model Building V2 - 7 updated api methods

Changes  This release is for supporting Composite Slot Type feature in AWS Lex V2. Composite Slot Type will help developer to logically group coherent slots and maintain their inter-relationships in runtime conversation.

CreateSlot (updated) Link ¶
Changes (both)
{'subSlotSetting': {'expression': 'string',
                    'slotSpecifications': {'string': {'slotTypeId': 'string',
                                                      'valueElicitationSetting': {'defaultValueSpecification': {'defaultValueList': [{'defaultValue': 'string'}]},
                                                                                  'promptSpecification': {'allowInterrupt': 'boolean',
                                                                                                          'maxRetries': 'integer',
                                                                                                          'messageGroups': [{'message': {'customPayload': {'value': 'string'},
                                                                                                                                         'imageResponseCard': {'buttons': [{'text': 'string',
                                                                                                                                                                            'value': 'string'}],
                                                                                                                                                               'imageUrl': 'string',
                                                                                                                                                               'subtitle': 'string',
                                                                                                                                                               'title': 'string'},
                                                                                                                                         'plainTextMessage': {'value': 'string'},
                                                                                                                                         'ssmlMessage': {'value': 'string'}},
                                                                                                                             'variations': [{'customPayload': {'value': 'string'},
                                                                                                                                             'imageResponseCard': {'buttons': [{'text': 'string',
                                                                                                                                                                                'value': 'string'}],
                                                                                                                                                                   'imageUrl': 'string',
                                                                                                                                                                   'subtitle': 'string',
                                                                                                                                                                   'title': 'string'},
                                                                                                                                             'plainTextMessage': {'value': 'string'},
                                                                                                                                             'ssmlMessage': {'value': 'string'}}]}],
                                                                                                          'messageSelectionStrategy': 'Random '
                                                                                                                                      '| '
                                                                                                                                      'Ordered'},
                                                                                  'sampleUtterances': [{'utterance': 'string'}],
                                                                                  'waitAndContinueSpecification': {'active': 'boolean',
                                                                                                                   'continueResponse': {'allowInterrupt': 'boolean',
                                                                                                                                        'messageGroups': [{'message': {'customPayload': {'value': 'string'},
                                                                                                                                                                       'imageResponseCard': {'buttons': [{'text': 'string',
                                                                                                                                                                                                          'value': 'string'}],
                                                                                                                                                                                             'imageUrl': 'string',
                                                                                                                                                                                             'subtitle': 'string',
                                                                                                                                                                                             'title': 'string'},
                                                                                                                                                                       'plainTextMessage': {'value': 'string'},
                                                                                                                                                                       'ssmlMessage': {'value': 'string'}},
                                                                                                                                                           'variations': [{'customPayload': {'value': 'string'},
                                                                                                                                                                           'imageResponseCard': {'buttons': [{'text': 'string',
                                                                                                                                                                                                              'value': 'string'}],
                                                                                                                                                                                                 'imageUrl': 'string',
                                                                                                                                                                                                 'subtitle': 'string',
                                                                                                                                                                                                 'title': 'string'},
                                                                                                                                                                           'plainTextMessage': {'value': 'string'},
                                                                                                                                                                           'ssmlMessage': {'value': 'string'}}]}]},
                                                                                                                   'stillWaitingResponse': {'allowInterrupt': 'boolean',
                                                                                                                                            'frequencyInSeconds': 'integer',
                                                                                                                                            'messageGroups': [{'message': {'customPayload': {'value': 'string'},
                                                                                                                                                                           'imageResponseCard': {'buttons': [{'text': 'string',
                                                                                                                                                                                                              'value': 'string'}],
                                                                                                                                                                                                 'imageUrl': 'string',
                                                                                                                                                                                                 'subtitle': 'string',
                                                                                                                                                                                                 'title': 'string'},
                                                                                                                                                                           'plainTextMessage': {'value': 'string'},
                                                                                                                                                                           'ssmlMessage': {'value': 'string'}},
                                                                                                                                                               'variations': [{'customPayload': {'value': 'string'},
                                                                                                                                                                               'imageResponseCard': {'buttons': [{'text': 'string',
                                                                                                                                                                                                                  'value': 'string'}],
                                                                                                                                                                                                     'imageUrl': 'string',
                                                                                                                                                                                                     'subtitle': 'string',
                                                                                                                                                                                                     'title': 'string'},
                                                                                                                                                                               'plainTextMessage': {'value': 'string'},
                                                                                                                                                                               'ssmlMessage': {'value': 'string'}}]}],
                                                                                                                                            'timeoutInSeconds': 'integer'},
                                                                                                                   'waitingResponse': {'allowInterrupt': 'boolean',
                                                                                                                                       'messageGroups': [{'message': {'customPayload': {'value': 'string'},
                                                                                                                                                                      'imageResponseCard': {'buttons': [{'text': 'string',
                                                                                                                                                                                                         'value': 'string'}],
                                                                                                                                                                                            'imageUrl': 'string',
                                                                                                                                                                                            'subtitle': 'string',
                                                                                                                                                                                            'title': 'string'},
                                                                                                                                                                      'plainTextMessage': {'value': 'string'},
                                                                                                                                                                      'ssmlMessage': {'value': 'string'}},
                                                                                                                                                          'variations': [{'customPayload': {'value': 'string'},
                                                                                                                                                                          'imageResponseCard': {'buttons': [{'text': 'string',
                                                                                                                                                                                                             'value': 'string'}],
                                                                                                                                                                                                'imageUrl': 'string',
                                                                                                                                                                                                'subtitle': 'string',
                                                                                                                                                                                                'title': 'string'},
                                                                                                                                                                          'plainTextMessage': {'value': 'string'},
                                                                                                                                                                          'ssmlMessage': {'value': 'string'}}]}]}}}}}}}

Creates a slot in an intent. A slot is a variable needed to fulfill an intent. For example, an OrderPizza intent might need slots for size, crust, and number of pizzas. For each slot, you define one or more utterances that Amazon Lex uses to elicit a response from the user.

See also: AWS API Documentation

Request Syntax

client.create_slot(
    slotName='string',
    description='string',
    slotTypeId='string',
    valueElicitationSetting={
        'defaultValueSpecification': {
            'defaultValueList': [
                {
                    'defaultValue': 'string'
                },
            ]
        },
        'slotConstraint': 'Required'|'Optional',
        'promptSpecification': {
            'messageGroups': [
                {
                    'message': {
                        'plainTextMessage': {
                            'value': 'string'
                        },
                        'customPayload': {
                            'value': 'string'
                        },
                        'ssmlMessage': {
                            'value': 'string'
                        },
                        'imageResponseCard': {
                            'title': 'string',
                            'subtitle': 'string',
                            'imageUrl': 'string',
                            'buttons': [
                                {
                                    'text': 'string',
                                    'value': 'string'
                                },
                            ]
                        }
                    },
                    'variations': [
                        {
                            'plainTextMessage': {
                                'value': 'string'
                            },
                            'customPayload': {
                                'value': 'string'
                            },
                            'ssmlMessage': {
                                'value': 'string'
                            },
                            'imageResponseCard': {
                                'title': 'string',
                                'subtitle': 'string',
                                'imageUrl': 'string',
                                'buttons': [
                                    {
                                        'text': 'string',
                                        'value': 'string'
                                    },
                                ]
                            }
                        },
                    ]
                },
            ],
            'maxRetries': 123,
            'allowInterrupt': True|False,
            'messageSelectionStrategy': 'Random'|'Ordered'
        },
        'sampleUtterances': [
            {
                'utterance': 'string'
            },
        ],
        'waitAndContinueSpecification': {
            'waitingResponse': {
                'messageGroups': [
                    {
                        'message': {
                            'plainTextMessage': {
                                'value': 'string'
                            },
                            'customPayload': {
                                'value': 'string'
                            },
                            'ssmlMessage': {
                                'value': 'string'
                            },
                            'imageResponseCard': {
                                'title': 'string',
                                'subtitle': 'string',
                                'imageUrl': 'string',
                                'buttons': [
                                    {
                                        'text': 'string',
                                        'value': 'string'
                                    },
                                ]
                            }
                        },
                        'variations': [
                            {
                                'plainTextMessage': {
                                    'value': 'string'
                                },
                                'customPayload': {
                                    'value': 'string'
                                },
                                'ssmlMessage': {
                                    'value': 'string'
                                },
                                'imageResponseCard': {
                                    'title': 'string',
                                    'subtitle': 'string',
                                    'imageUrl': 'string',
                                    'buttons': [
                                        {
                                            'text': 'string',
                                            'value': 'string'
                                        },
                                    ]
                                }
                            },
                        ]
                    },
                ],
                'allowInterrupt': True|False
            },
            'continueResponse': {
                'messageGroups': [
                    {
                        'message': {
                            'plainTextMessage': {
                                'value': 'string'
                            },
                            'customPayload': {
                                'value': 'string'
                            },
                            'ssmlMessage': {
                                'value': 'string'
                            },
                            'imageResponseCard': {
                                'title': 'string',
                                'subtitle': 'string',
                                'imageUrl': 'string',
                                'buttons': [
                                    {
                                        'text': 'string',
                                        'value': 'string'
                                    },
                                ]
                            }
                        },
                        'variations': [
                            {
                                'plainTextMessage': {
                                    'value': 'string'
                                },
                                'customPayload': {
                                    'value': 'string'
                                },
                                'ssmlMessage': {
                                    'value': 'string'
                                },
                                'imageResponseCard': {
                                    'title': 'string',
                                    'subtitle': 'string',
                                    'imageUrl': 'string',
                                    'buttons': [
                                        {
                                            'text': 'string',
                                            'value': 'string'
                                        },
                                    ]
                                }
                            },
                        ]
                    },
                ],
                'allowInterrupt': True|False
            },
            'stillWaitingResponse': {
                'messageGroups': [
                    {
                        'message': {
                            'plainTextMessage': {
                                'value': 'string'
                            },
                            'customPayload': {
                                'value': 'string'
                            },
                            'ssmlMessage': {
                                'value': 'string'
                            },
                            'imageResponseCard': {
                                'title': 'string',
                                'subtitle': 'string',
                                'imageUrl': 'string',
                                'buttons': [
                                    {
                                        'text': 'string',
                                        'value': 'string'
                                    },
                                ]
                            }
                        },
                        'variations': [
                            {
                                'plainTextMessage': {
                                    'value': 'string'
                                },
                                'customPayload': {
                                    'value': 'string'
                                },
                                'ssmlMessage': {
                                    'value': 'string'
                                },
                                'imageResponseCard': {
                                    'title': 'string',
                                    'subtitle': 'string',
                                    'imageUrl': 'string',
                                    'buttons': [
                                        {
                                            'text': 'string',
                                            'value': 'string'
                                        },
                                    ]
                                }
                            },
                        ]
                    },
                ],
                'frequencyInSeconds': 123,
                'timeoutInSeconds': 123,
                'allowInterrupt': True|False
            },
            'active': True|False
        },
        'slotCaptureSetting': {
            'captureResponse': {
                'messageGroups': [
                    {
                        'message': {
                            'plainTextMessage': {
                                'value': 'string'
                            },
                            'customPayload': {
                                'value': 'string'
                            },
                            'ssmlMessage': {
                                'value': 'string'
                            },
                            'imageResponseCard': {
                                'title': 'string',
                                'subtitle': 'string',
                                'imageUrl': 'string',
                                'buttons': [
                                    {
                                        'text': 'string',
                                        'value': 'string'
                                    },
                                ]
                            }
                        },
                        'variations': [
                            {
                                'plainTextMessage': {
                                    'value': 'string'
                                },
                                'customPayload': {
                                    'value': 'string'
                                },
                                'ssmlMessage': {
                                    'value': 'string'
                                },
                                'imageResponseCard': {
                                    'title': 'string',
                                    'subtitle': 'string',
                                    'imageUrl': 'string',
                                    'buttons': [
                                        {
                                            'text': 'string',
                                            'value': 'string'
                                        },
                                    ]
                                }
                            },
                        ]
                    },
                ],
                'allowInterrupt': True|False
            },
            'captureNextStep': {
                'dialogAction': {
                    'type': 'ElicitIntent'|'StartIntent'|'ElicitSlot'|'EvaluateConditional'|'InvokeDialogCodeHook'|'ConfirmIntent'|'FulfillIntent'|'CloseIntent'|'EndConversation',
                    'slotToElicit': 'string',
                    'suppressNextMessage': True|False
                },
                'intent': {
                    'name': 'string',
                    'slots': {
                        'string': {
                            'shape': 'Scalar'|'List',
                            'value': {
                                'interpretedValue': 'string'
                            },
                            'values': [
                                {'... recursive ...'},
                            ]
                        }
                    }
                },
                'sessionAttributes': {
                    'string': 'string'
                }
            },
            'captureConditional': {
                'active': True|False,
                'conditionalBranches': [
                    {
                        'name': 'string',
                        'condition': {
                            'expressionString': 'string'
                        },
                        'nextStep': {
                            'dialogAction': {
                                'type': 'ElicitIntent'|'StartIntent'|'ElicitSlot'|'EvaluateConditional'|'InvokeDialogCodeHook'|'ConfirmIntent'|'FulfillIntent'|'CloseIntent'|'EndConversation',
                                'slotToElicit': 'string',
                                'suppressNextMessage': True|False
                            },
                            'intent': {
                                'name': 'string',
                                'slots': {
                                    'string': {
                                        'shape': 'Scalar'|'List',
                                        'value': {
                                            'interpretedValue': 'string'
                                        },
                                        'values': [
                                            {'... recursive ...'},
                                        ]
                                    }
                                }
                            },
                            'sessionAttributes': {
                                'string': 'string'
                            }
                        },
                        'response': {
                            'messageGroups': [
                                {
                                    'message': {
                                        'plainTextMessage': {
                                            'value': 'string'
                                        },
                                        'customPayload': {
                                            'value': 'string'
                                        },
                                        'ssmlMessage': {
                                            'value': 'string'
                                        },
                                        'imageResponseCard': {
                                            'title': 'string',
                                            'subtitle': 'string',
                                            'imageUrl': 'string',
                                            'buttons': [
                                                {
                                                    'text': 'string',
                                                    'value': 'string'
                                                },
                                            ]
                                        }
                                    },
                                    'variations': [
                                        {
                                            'plainTextMessage': {
                                                'value': 'string'
                                            },
                                            'customPayload': {
                                                'value': 'string'
                                            },
                                            'ssmlMessage': {
                                                'value': 'string'
                                            },
                                            'imageResponseCard': {
                                                'title': 'string',
                                                'subtitle': 'string',
                                                'imageUrl': 'string',
                                                'buttons': [
                                                    {
                                                        'text': 'string',
                                                        'value': 'string'
                                                    },
                                                ]
                                            }
                                        },
                                    ]
                                },
                            ],
                            'allowInterrupt': True|False
                        }
                    },
                ],
                'defaultBranch': {
                    'nextStep': {
                        'dialogAction': {
                            'type': 'ElicitIntent'|'StartIntent'|'ElicitSlot'|'EvaluateConditional'|'InvokeDialogCodeHook'|'ConfirmIntent'|'FulfillIntent'|'CloseIntent'|'EndConversation',
                            'slotToElicit': 'string',
                            'suppressNextMessage': True|False
                        },
                        'intent': {
                            'name': 'string',
                            'slots': {
                                'string': {
                                    'shape': 'Scalar'|'List',
                                    'value': {
                                        'interpretedValue': 'string'
                                    },
                                    'values': [
                                        {'... recursive ...'},
                                    ]
                                }
                            }
                        },
                        'sessionAttributes': {
                            'string': 'string'
                        }
                    },
                    'response': {
                        'messageGroups': [
                            {
                                'message': {
                                    'plainTextMessage': {
                                        'value': 'string'
                                    },
                                    'customPayload': {
                                        'value': 'string'
                                    },
                                    'ssmlMessage': {
                                        'value': 'string'
                                    },
                                    'imageResponseCard': {
                                        'title': 'string',
                                        'subtitle': 'string',
                                        'imageUrl': 'string',
                                        'buttons': [
                                            {
                                                'text': 'string',
                                                'value': 'string'
                                            },
                                        ]
                                    }
                                },
                                'variations': [
                                    {
                                        'plainTextMessage': {
                                            'value': 'string'
                                        },
                                        'customPayload': {
                                            'value': 'string'
                                        },
                                        'ssmlMessage': {
                                            'value': 'string'
                                        },
                                        'imageResponseCard': {
                                            'title': 'string',
                                            'subtitle': 'string',
                                            'imageUrl': 'string',
                                            'buttons': [
                                                {
                                                    'text': 'string',
                                                    'value': 'string'
                                                },
                                            ]
                                        }
                                    },
                                ]
                            },
                        ],
                        'allowInterrupt': True|False
                    }
                }
            },
            'failureResponse': {
                'messageGroups': [
                    {
                        'message': {
                            'plainTextMessage': {
                                'value': 'string'
                            },
                            'customPayload': {
                                'value': 'string'
                            },
                            'ssmlMessage': {
                                'value': 'string'
                            },
                            'imageResponseCard': {
                                'title': 'string',
                                'subtitle': 'string',
                                'imageUrl': 'string',
                                'buttons': [
                                    {
                                        'text': 'string',
                                        'value': 'string'
                                    },
                                ]
                            }
                        },
                        'variations': [
                            {
                                'plainTextMessage': {
                                    'value': 'string'
                                },
                                'customPayload': {
                                    'value': 'string'
                                },
                                'ssmlMessage': {
                                    'value': 'string'
                                },
                                'imageResponseCard': {
                                    'title': 'string',
                                    'subtitle': 'string',
                                    'imageUrl': 'string',
                                    'buttons': [
                                        {
                                            'text': 'string',
                                            'value': 'string'
                                        },
                                    ]
                                }
                            },
                        ]
                    },
                ],
                'allowInterrupt': True|False
            },
            'failureNextStep': {
                'dialogAction': {
                    'type': 'ElicitIntent'|'StartIntent'|'ElicitSlot'|'EvaluateConditional'|'InvokeDialogCodeHook'|'ConfirmIntent'|'FulfillIntent'|'CloseIntent'|'EndConversation',
                    'slotToElicit': 'string',
                    'suppressNextMessage': True|False
                },
                'intent': {
                    'name': 'string',
                    'slots': {
                        'string': {
                            'shape': 'Scalar'|'List',
                            'value': {
                                'interpretedValue': 'string'
                            },
                            'values': [
                                {'... recursive ...'},
                            ]
                        }
                    }
                },
                'sessionAttributes': {
                    'string': 'string'
                }
            },
            'failureConditional': {
                'active': True|False,
                'conditionalBranches': [
                    {
                        'name': 'string',
                        'condition': {
                            'expressionString': 'string'
                        },
                        'nextStep': {
                            'dialogAction': {
                                'type': 'ElicitIntent'|'StartIntent'|'ElicitSlot'|'EvaluateConditional'|'InvokeDialogCodeHook'|'ConfirmIntent'|'FulfillIntent'|'CloseIntent'|'EndConversation',
                                'slotToElicit': 'string',
                                'suppressNextMessage': True|False
                            },
                            'intent': {
                                'name': 'string',
                                'slots': {
                                    'string': {
                                        'shape': 'Scalar'|'List',
                                        'value': {
                                            'interpretedValue': 'string'
                                        },
                                        'values': [
                                            {'... recursive ...'},
                                        ]
                                    }
                                }
                            },
                            'sessionAttributes': {
                                'string': 'string'
                            }
                        },
                        'response': {
                            'messageGroups': [
                                {
                                    'message': {
                                        'plainTextMessage': {
                                            'value': 'string'
                                        },
                                        'customPayload': {
                                            'value': 'string'
                                        },
                                        'ssmlMessage': {
                                            'value': 'string'
                                        },
                                        'imageResponseCard': {
                                            'title': 'string',
                                            'subtitle': 'string',
                                            'imageUrl': 'string',
                                            'buttons': [
                                                {
                                                    'text': 'string',
                                                    'value': 'string'
                                                },
                                            ]
                                        }
                                    },
                                    'variations': [
                                        {
                                            'plainTextMessage': {
                                                'value': 'string'
                                            },
                                            'customPayload': {
                                                'value': 'string'
                                            },
                                            'ssmlMessage': {
                                                'value': 'string'
                                            },
                                            'imageResponseCard': {
                                                'title': 'string',
                                                'subtitle': 'string',
                                                'imageUrl': 'string',
                                                'buttons': [
                                                    {
                                                        'text': 'string',
                                                        'value': 'string'
                                                    },
                                                ]
                                            }
                                        },
                                    ]
                                },
                            ],
                            'allowInterrupt': True|False
                        }
                    },
                ],
                'defaultBranch': {
                    'nextStep': {
                        'dialogAction': {
                            'type': 'ElicitIntent'|'StartIntent'|'ElicitSlot'|'EvaluateConditional'|'InvokeDialogCodeHook'|'ConfirmIntent'|'FulfillIntent'|'CloseIntent'|'EndConversation',
                            'slotToElicit': 'string',
                            'suppressNextMessage': True|False
                        },
                        'intent': {
                            'name': 'string',
                            'slots': {
                                'string': {
                                    'shape': 'Scalar'|'List',
                                    'value': {
                                        'interpretedValue': 'string'
                                    },
                                    'values': [
                                        {'... recursive ...'},
                                    ]
                                }
                            }
                        },
                        'sessionAttributes': {
                            'string': 'string'
                        }
                    },
                    'response': {
                        'messageGroups': [
                            {
                                'message': {
                                    'plainTextMessage': {
                                        'value': 'string'
                                    },
                                    'customPayload': {
                                        'value': 'string'
                                    },
                                    'ssmlMessage': {
                                        'value': 'string'
                                    },
                                    'imageResponseCard': {
                                        'title': 'string',
                                        'subtitle': 'string',
                                        'imageUrl': 'string',
                                        'buttons': [
                                            {
                                                'text': 'string',
                                                'value': 'string'
                                            },
                                        ]
                                    }
                                },
                                'variations': [
                                    {
                                        'plainTextMessage': {
                                            'value': 'string'
                                        },
                                        'customPayload': {
                                            'value': 'string'
                                        },
                                        'ssmlMessage': {
                                            'value': 'string'
                                        },
                                        'imageResponseCard': {
                                            'title': 'string',
                                            'subtitle': 'string',
                                            'imageUrl': 'string',
                                            'buttons': [
                                                {
                                                    'text': 'string',
                                                    'value': 'string'
                                                },
                                            ]
                                        }
                                    },
                                ]
                            },
                        ],
                        'allowInterrupt': True|False
                    }
                }
            },
            'codeHook': {
                'enableCodeHookInvocation': True|False,
                'active': True|False,
                'invocationLabel': 'string',
                'postCodeHookSpecification': {
                    'successResponse': {
                        'messageGroups': [
                            {
                                'message': {
                                    'plainTextMessage': {
                                        'value': 'string'
                                    },
                                    'customPayload': {
                                        'value': 'string'
                                    },
                                    'ssmlMessage': {
                                        'value': 'string'
                                    },
                                    'imageResponseCard': {
                                        'title': 'string',
                                        'subtitle': 'string',
                                        'imageUrl': 'string',
                                        'buttons': [
                                            {
                                                'text': 'string',
                                                'value': 'string'
                                            },
                                        ]
                                    }
                                },
                                'variations': [
                                    {
                                        'plainTextMessage': {
                                            'value': 'string'
                                        },
                                        'customPayload': {
                                            'value': 'string'
                                        },
                                        'ssmlMessage': {
                                            'value': 'string'
                                        },
                                        'imageResponseCard': {
                                            'title': 'string',
                                            'subtitle': 'string',
                                            'imageUrl': 'string',
                                            'buttons': [
                                                {
                                                    'text': 'string',
                                                    'value': 'string'
                                                },
                                            ]
                                        }
                                    },
                                ]
                            },
                        ],
                        'allowInterrupt': True|False
                    },
                    'successNextStep': {
                        'dialogAction': {
                            'type': 'ElicitIntent'|'StartIntent'|'ElicitSlot'|'EvaluateConditional'|'InvokeDialogCodeHook'|'ConfirmIntent'|'FulfillIntent'|'CloseIntent'|'EndConversation',
                            'slotToElicit': 'string',
                            'suppressNextMessage': True|False
                        },
                        'intent': {
                            'name': 'string',
                            'slots': {
                                'string': {
                                    'shape': 'Scalar'|'List',
                                    'value': {
                                        'interpretedValue': 'string'
                                    },
                                    'values': [
                                        {'... recursive ...'},
                                    ]
                                }
                            }
                        },
                        'sessionAttributes': {
                            'string': 'string'
                        }
                    },
                    'successConditional': {
                        'active': True|False,
                        'conditionalBranches': [
                            {
                                'name': 'string',
                                'condition': {
                                    'expressionString': 'string'
                                },
                                'nextStep': {
                                    'dialogAction': {
                                        'type': 'ElicitIntent'|'StartIntent'|'ElicitSlot'|'EvaluateConditional'|'InvokeDialogCodeHook'|'ConfirmIntent'|'FulfillIntent'|'CloseIntent'|'EndConversation',
                                        'slotToElicit': 'string',
                                        'suppressNextMessage': True|False
                                    },
                                    'intent': {
                                        'name': 'string',
                                        'slots': {
                                            'string': {
                                                'shape': 'Scalar'|'List',
                                                'value': {
                                                    'interpretedValue': 'string'
                                                },
                                                'values': [
                                                    {'... recursive ...'},
                                                ]
                                            }
                                        }
                                    },
                                    'sessionAttributes': {
                                        'string': 'string'
                                    }
                                },
                                'response': {
                                    'messageGroups': [
                                        {
                                            'message': {
                                                'plainTextMessage': {
                                                    'value': 'string'
                                                },
                                                'customPayload': {
                                                    'value': 'string'
                                                },
                                                'ssmlMessage': {
                                                    'value': 'string'
                                                },
                                                'imageResponseCard': {
                                                    'title': 'string',
                                                    'subtitle': 'string',
                                                    'imageUrl': 'string',
                                                    'buttons': [
                                                        {
                                                            'text': 'string',
                                                            'value': 'string'
                                                        },
                                                    ]
                                                }
                                            },
                                            'variations': [
                                                {
                                                    'plainTextMessage': {
                                                        'value': 'string'
                                                    },
                                                    'customPayload': {
                                                        'value': 'string'
                                                    },
                                                    'ssmlMessage': {
                                                        'value': 'string'
                                                    },
                                                    'imageResponseCard': {
                                                        'title': 'string',
                                                        'subtitle': 'string',
                                                        'imageUrl': 'string',
                                                        'buttons': [
                                                            {
                                                                'text': 'string',
                                                                'value': 'string'
                                                            },
                                                        ]
                                                    }
                                                },
                                            ]
                                        },
                                    ],
                                    'allowInterrupt': True|False
                                }
                            },
                        ],
                        'defaultBranch': {
                            'nextStep': {
                                'dialogAction': {
                                    'type': 'ElicitIntent'|'StartIntent'|'ElicitSlot'|'EvaluateConditional'|'InvokeDialogCodeHook'|'ConfirmIntent'|'FulfillIntent'|'CloseIntent'|'EndConversation',
                                    'slotToElicit': 'string',
                                    'suppressNextMessage': True|False
                                },
                                'intent': {
                                    'name': 'string',
                                    'slots': {
                                        'string': {
                                            'shape': 'Scalar'|'List',
                                            'value': {
                                                'interpretedValue': 'string'
                                            },
                                            'values': [
                                                {'... recursive ...'},
                                            ]
                                        }
                                    }
                                },
                                'sessionAttributes': {
                                    'string': 'string'
                                }
                            },
                            'response': {
                                'messageGroups': [
                                    {
                                        'message': {
                                            'plainTextMessage': {
                                                'value': 'string'
                                            },
                                            'customPayload': {
                                                'value': 'string'
                                            },
                                            'ssmlMessage': {
                                                'value': 'string'
                                            },
                                            'imageResponseCard': {
                                                'title': 'string',
                                                'subtitle': 'string',
                                                'imageUrl': 'string',
                                                'buttons': [
                                                    {
                                                        'text': 'string',
                                                        'value': 'string'
                                                    },
                                                ]
                                            }
                                        },
                                        'variations': [
                                            {
                                                'plainTextMessage': {
                                                    'value': 'string'
                                                },
                                                'customPayload': {
                                                    'value': 'string'
                                                },
                                                'ssmlMessage': {
                                                    'value': 'string'
                                                },
                                                'imageResponseCard': {
                                                    'title': 'string',
                                                    'subtitle': 'string',
                                                    'imageUrl': 'string',
                                                    'buttons': [
                                                        {
                                                            'text': 'string',
                                                            'value': 'string'
                                                        },
                                                    ]
                                                }
                                            },
                                        ]
                                    },
                                ],
                                'allowInterrupt': True|False
                            }
                        }
                    },
                    'failureResponse': {
                        'messageGroups': [
                            {
                                'message': {
                                    'plainTextMessage': {
                                        'value': 'string'
                                    },
                                    'customPayload': {
                                        'value': 'string'
                                    },
                                    'ssmlMessage': {
                                        'value': 'string'
                                    },
                                    'imageResponseCard': {
                                        'title': 'string',
                                        'subtitle': 'string',
                                        'imageUrl': 'string',
                                        'buttons': [
                                            {
                                                'text': 'string',
                                                'value': 'string'
                                            },
                                        ]
                                    }
                                },
                                'variations': [
                                    {
                                        'plainTextMessage': {
                                            'value': 'string'
                                        },
                                        'customPayload': {
                                            'value': 'string'
                                        },
                                        'ssmlMessage': {
                                            'value': 'string'
                                        },
                                        'imageResponseCard': {
                                            'title': 'string',
                                            'subtitle': 'string',
                                            'imageUrl': 'string',
                                            'buttons': [
                                                {
                                                    'text': 'string',
                                                    'value': 'string'
                                                },
                                            ]
                                        }
                                    },
                                ]
                            },
                        ],
                        'allowInterrupt': True|False
                    },
                    'failureNextStep': {
                        'dialogAction': {
                            'type': 'ElicitIntent'|'StartIntent'|'ElicitSlot'|'EvaluateConditional'|'InvokeDialogCodeHook'|'ConfirmIntent'|'FulfillIntent'|'CloseIntent'|'EndConversation',
                            'slotToElicit': 'string',
                            'suppressNextMessage': True|False
                        },
                        'intent': {
                            'name': 'string',
                            'slots': {
                                'string': {
                                    'shape': 'Scalar'|'List',
                                    'value': {
                                        'interpretedValue': 'string'
                                    },
                                    'values': [
                                        {'... recursive ...'},
                                    ]
                                }
                            }
                        },
                        'sessionAttributes': {
                            'string': 'string'
                        }
                    },
                    'failureConditional': {
                        'active': True|False,
                        'conditionalBranches': [
                            {
                                'name': 'string',
                                'condition': {
                                    'expressionString': 'string'
                                },
                                'nextStep': {
                                    'dialogAction': {
                                        'type': 'ElicitIntent'|'StartIntent'|'ElicitSlot'|'EvaluateConditional'|'InvokeDialogCodeHook'|'ConfirmIntent'|'FulfillIntent'|'CloseIntent'|'EndConversation',
                                        'slotToElicit': 'string',
                                        'suppressNextMessage': True|False
                                    },
                                    'intent': {
                                        'name': 'string',
                                        'slots': {
                                            'string': {
                                                'shape': 'Scalar'|'List',
                                                'value': {
                                                    'interpretedValue': 'string'
                                                },
                                                'values': [
                                                    {'... recursive ...'},
                                                ]
                                            }
                                        }
                                    },
                                    'sessionAttributes': {
                                        'string': 'string'
                                    }
                                },
                                'response': {
                                    'messageGroups': [
                                        {
                                            'message': {
                                                'plainTextMessage': {
                                                    'value': 'string'
                                                },
                                                'customPayload': {
                                                    'value': 'string'
                                                },
                                                'ssmlMessage': {
                                                    'value': 'string'
                                                },
                                                'imageResponseCard': {
                                                    'title': 'string',
                                                    'subtitle': 'string',
                                                    'imageUrl': 'string',
                                                    'buttons': [
                                                        {
                                                            'text': 'string',
                                                            'value': 'string'
                                                        },
                                                    ]
                                                }
                                            },
                                            'variations': [
                                                {
                                                    'plainTextMessage': {
                                                        'value': 'string'
                                                    },
                                                    'customPayload': {
                                                        'value': 'string'
                                                    },
                                                    'ssmlMessage': {
                                                        'value': 'string'
                                                    },
                                                    'imageResponseCard': {
                                                        'title': 'string',
                                                        'subtitle': 'string',
                                                        'imageUrl': 'string',
                                                        'buttons': [
                                                            {
                                                                'text': 'string',
                                                                'value': 'string'
                                                            },
                                                        ]
                                                    }
                                                },
                                            ]
                                        },
                                    ],
                                    'allowInterrupt': True|False
                                }
                            },
                        ],
                        'defaultBranch': {
                            'nextStep': {
                                'dialogAction': {
                                    'type': 'ElicitIntent'|'StartIntent'|'ElicitSlot'|'EvaluateConditional'|'InvokeDialogCodeHook'|'ConfirmIntent'|'FulfillIntent'|'CloseIntent'|'EndConversation',
                                    'slotToElicit': 'string',
                                    'suppressNextMessage': True|False
                                },
                                'intent': {
                                    'name': 'string',
                                    'slots': {
                                        'string': {
                                            'shape': 'Scalar'|'List',
                                            'value': {
                                                'interpretedValue': 'string'
                                            },
                                            'values': [
                                                {'... recursive ...'},
                                            ]
                                        }
                                    }
                                },
                                'sessionAttributes': {
                                    'string': 'string'
                                }
                            },
                            'response': {
                                'messageGroups': [
                                    {
                                        'message': {
                                            'plainTextMessage': {
                                                'value': 'string'
                                            },
                                            'customPayload': {
                                                'value': 'string'
                                            },
                                            'ssmlMessage': {
                                                'value': 'string'
                                            },
                                            'imageResponseCard': {
                                                'title': 'string',
                                                'subtitle': 'string',
                                                'imageUrl': 'string',
                                                'buttons': [
                                                    {
                                                        'text': 'string',
                                                        'value': 'string'
                                                    },
                                                ]
                                            }
                                        },
                                        'variations': [
                                            {
                                                'plainTextMessage': {
                                                    'value': 'string'
                                                },
                                                'customPayload': {
                                                    'value': 'string'
                                                },
                                                'ssmlMessage': {
                                                    'value': 'string'
                                                },
                                                'imageResponseCard': {
                                                    'title': 'string',
                                                    'subtitle': 'string',
                                                    'imageUrl': 'string',
                                                    'buttons': [
                                                        {
                                                            'text': 'string',
                                                            'value': 'string'
                                                        },
                                                    ]
                                                }
                                            },
                                        ]
                                    },
                                ],
                                'allowInterrupt': True|False
                            }
                        }
                    },
                    'timeoutResponse': {
                        'messageGroups': [
                            {
                                'message': {
                                    'plainTextMessage': {
                                        'value': 'string'
                                    },
                                    'customPayload': {
                                        'value': 'string'
                                    },
                                    'ssmlMessage': {
                                        'value': 'string'
                                    },
                                    'imageResponseCard': {
                                        'title': 'string',
                                        'subtitle': 'string',
                                        'imageUrl': 'string',
                                        'buttons': [
                                            {
                                                'text': 'string',
                                                'value': 'string'
                                            },
                                        ]
                                    }
                                },
                                'variations': [
                                    {
                                        'plainTextMessage': {
                                            'value': 'string'
                                        },
                                        'customPayload': {
                                            'value': 'string'
                                        },
                                        'ssmlMessage': {
                                            'value': 'string'
                                        },
                                        'imageResponseCard': {
                                            'title': 'string',
                                            'subtitle': 'string',
                                            'imageUrl': 'string',
                                            'buttons': [
                                                {
                                                    'text': 'string',
                                                    'value': 'string'
                                                },
                                            ]
                                        }
                                    },
                                ]
                            },
                        ],
                        'allowInterrupt': True|False
                    },
                    'timeoutNextStep': {
                        'dialogAction': {
                            'type': 'ElicitIntent'|'StartIntent'|'ElicitSlot'|'EvaluateConditional'|'InvokeDialogCodeHook'|'ConfirmIntent'|'FulfillIntent'|'CloseIntent'|'EndConversation',
                            'slotToElicit': 'string',
                            'suppressNextMessage': True|False
                        },
                        'intent': {
                            'name': 'string',
                            'slots': {
                                'string': {
                                    'shape': 'Scalar'|'List',
                                    'value': {
                                        'interpretedValue': 'string'
                                    },
                                    'values': [
                                        {'... recursive ...'},
                                    ]
                                }
                            }
                        },
                        'sessionAttributes': {
                            'string': 'string'
                        }
                    },
                    'timeoutConditional': {
                        'active': True|False,
                        'conditionalBranches': [
                            {
                                'name': 'string',
                                'condition': {
                                    'expressionString': 'string'
                                },
                                'nextStep': {
                                    'dialogAction': {
                                        'type': 'ElicitIntent'|'StartIntent'|'ElicitSlot'|'EvaluateConditional'|'InvokeDialogCodeHook'|'ConfirmIntent'|'FulfillIntent'|'CloseIntent'|'EndConversation',
                                        'slotToElicit': 'string',
                                        'suppressNextMessage': True|False
                                    },
                                    'intent': {
                                        'name': 'string',
                                        'slots': {
                                            'string': {
                                                'shape': 'Scalar'|'List',
                                                'value': {
                                                    'interpretedValue': 'string'
                                                },
                                                'values': [
                                                    {'... recursive ...'},
                                                ]
                                            }
                                        }
                                    },
                                    'sessionAttributes': {
                                        'string': 'string'
                                    }
                                },
                                'response': {
                                    'messageGroups': [
                                        {
                                            'message': {
                                                'plainTextMessage': {
                                                    'value': 'string'
                                                },
                                                'customPayload': {
                                                    'value': 'string'
                                                },
                                                'ssmlMessage': {
                                                    'value': 'string'
                                                },
                                                'imageResponseCard': {
                                                    'title': 'string',
                                                    'subtitle': 'string',
                                                    'imageUrl': 'string',
                                                    'buttons': [
                                                        {
                                                            'text': 'string',
                                                            'value': 'string'
                                                        },
                                                    ]
                                                }
                                            },
                                            'variations': [
                                                {
                                                    'plainTextMessage': {
                                                        'value': 'string'
                                                    },
                                                    'customPayload': {
                                                        'value': 'string'
                                                    },
                                                    'ssmlMessage': {
                                                        'value': 'string'
                                                    },
                                                    'imageResponseCard': {
                                                        'title': 'string',
                                                        'subtitle': 'string',
                                                        'imageUrl': 'string',
                                                        'buttons': [
                                                            {
                                                                'text': 'string',
                                                                'value': 'string'
                                                            },
                                                        ]
                                                    }
                                                },
                                            ]
                                        },
                                    ],
                                    'allowInterrupt': True|False
                                }
                            },
                        ],
                        'defaultBranch': {
                            'nextStep': {
                                'dialogAction': {
                                    'type': 'ElicitIntent'|'StartIntent'|'ElicitSlot'|'EvaluateConditional'|'InvokeDialogCodeHook'|'ConfirmIntent'|'FulfillIntent'|'CloseIntent'|'EndConversation',
                                    'slotToElicit': 'string',
                                    'suppressNextMessage': True|False
                                },
                                'intent': {
                                    'name': 'string',
                                    'slots': {
                                        'string': {
                                            'shape': 'Scalar'|'List',
                                            'value': {
                                                'interpretedValue': 'string'
                                            },
                                            'values': [
                                                {'... recursive ...'},
                                            ]
                                        }
                                    }
                                },
                                'sessionAttributes': {
                                    'string': 'string'
                                }
                            },
                            'response': {
                                'messageGroups': [
                                    {
                                        'message': {
                                            'plainTextMessage': {
                                                'value': 'string'
                                            },
                                            'customPayload': {
                                                'value': 'string'
                                            },
                                            'ssmlMessage': {
                                                'value': 'string'
                                            },
                                            'imageResponseCard': {
                                                'title': 'string',
                                                'subtitle': 'string',
                                                'imageUrl': 'string',
                                                'buttons': [
                                                    {
                                                        'text': 'string',
                                                        'value': 'string'
                                                    },
                                                ]
                                            }
                                        },
                                        'variations': [
                                            {
                                                'plainTextMessage': {
                                                    'value': 'string'
                                                },
                                                'customPayload': {
                                                    'value': 'string'
                                                },
                                                'ssmlMessage': {
                                                    'value': 'string'
                                                },
                                                'imageResponseCard': {
                                                    'title': 'string',
                                                    'subtitle': 'string',
                                                    'imageUrl': 'string',
                                                    'buttons': [
                                                        {
                                                            'text': 'string',
                                                            'value': 'string'
                                                        },
                                                    ]
                                                }
                                            },
                                        ]
                                    },
                                ],
                                'allowInterrupt': True|False
                            }
                        }
                    }
                }
            },
            'elicitationCodeHook': {
                'enableCodeHookInvocation': True|False,
                'invocationLabel': 'string'
            }
        }
    },
    obfuscationSetting={
        'obfuscationSettingType': 'None'|'DefaultObfuscation'
    },
    botId='string',
    botVersion='string',
    localeId='string',
    intentId='string',
    multipleValuesSetting={
        'allowMultipleValues': True|False
    },
    subSlotSetting={
        'expression': 'string',
        'slotSpecifications': {
            'string': {
                'slotTypeId': 'string',
                'valueElicitationSetting': {
                    'defaultValueSpecification': {
                        'defaultValueList': [
                            {
                                'defaultValue': 'string'
                            },
                        ]
                    },
                    'promptSpecification': {
                        'messageGroups': [
                            {
                                'message': {
                                    'plainTextMessage': {
                                        'value': 'string'
                                    },
                                    'customPayload': {
                                        'value': 'string'
                                    },
                                    'ssmlMessage': {
                                        'value': 'string'
                                    },
                                    'imageResponseCard': {
                                        'title': 'string',
                                        'subtitle': 'string',
                                        'imageUrl': 'string',
                                        'buttons': [
                                            {
                                                'text': 'string',
                                                'value': 'string'
                                            },
                                        ]
                                    }
                                },
                                'variations': [
                                    {
                                        'plainTextMessage': {
                                            'value': 'string'
                                        },
                                        'customPayload': {
                                            'value': 'string'
                                        },
                                        'ssmlMessage': {
                                            'value': 'string'
                                        },
                                        'imageResponseCard': {
                                            'title': 'string',
                                            'subtitle': 'string',
                                            'imageUrl': 'string',
                                            'buttons': [
                                                {
                                                    'text': 'string',
                                                    'value': 'string'
                                                },
                                            ]
                                        }
                                    },
                                ]
                            },
                        ],
                        'maxRetries': 123,
                        'allowInterrupt': True|False,
                        'messageSelectionStrategy': 'Random'|'Ordered'
                    },
                    'sampleUtterances': [
                        {
                            'utterance': 'string'
                        },
                    ],
                    'waitAndContinueSpecification': {
                        'waitingResponse': {
                            'messageGroups': [
                                {
                                    'message': {
                                        'plainTextMessage': {
                                            'value': 'string'
                                        },
                                        'customPayload': {
                                            'value': 'string'
                                        },
                                        'ssmlMessage': {
                                            'value': 'string'
                                        },
                                        'imageResponseCard': {
                                            'title': 'string',
                                            'subtitle': 'string',
                                            'imageUrl': 'string',
                                            'buttons': [
                                                {
                                                    'text': 'string',
                                                    'value': 'string'
                                                },
                                            ]
                                        }
                                    },
                                    'variations': [
                                        {
                                            'plainTextMessage': {
                                                'value': 'string'
                                            },
                                            'customPayload': {
                                                'value': 'string'
                                            },
                                            'ssmlMessage': {
                                                'value': 'string'
                                            },
                                            'imageResponseCard': {
                                                'title': 'string',
                                                'subtitle': 'string',
                                                'imageUrl': 'string',
                                                'buttons': [
                                                    {
                                                        'text': 'string',
                                                        'value': 'string'
                                                    },
                                                ]
                                            }
                                        },
                                    ]
                                },
                            ],
                            'allowInterrupt': True|False
                        },
                        'continueResponse': {
                            'messageGroups': [
                                {
                                    'message': {
                                        'plainTextMessage': {
                                            'value': 'string'
                                        },
                                        'customPayload': {
                                            'value': 'string'
                                        },
                                        'ssmlMessage': {
                                            'value': 'string'
                                        },
                                        'imageResponseCard': {
                                            'title': 'string',
                                            'subtitle': 'string',
                                            'imageUrl': 'string',
                                            'buttons': [
                                                {
                                                    'text': 'string',
                                                    'value': 'string'
                                                },
                                            ]
                                        }
                                    },
                                    'variations': [
                                        {
                                            'plainTextMessage': {
                                                'value': 'string'
                                            },
                                            'customPayload': {
                                                'value': 'string'
                                            },
                                            'ssmlMessage': {
                                                'value': 'string'
                                            },
                                            'imageResponseCard': {
                                                'title': 'string',
                                                'subtitle': 'string',
                                                'imageUrl': 'string',
                                                'buttons': [
                                                    {
                                                        'text': 'string',
                                                        'value': 'string'
                                                    },
                                                ]
                                            }
                                        },
                                    ]
                                },
                            ],
                            'allowInterrupt': True|False
                        },
                        'stillWaitingResponse': {
                            'messageGroups': [
                                {
                                    'message': {
                                        'plainTextMessage': {
                                            'value': 'string'
                                        },
                                        'customPayload': {
                                            'value': 'string'
                                        },
                                        'ssmlMessage': {
                                            'value': 'string'
                                        },
                                        'imageResponseCard': {
                                            'title': 'string',
                                            'subtitle': 'string',
                                            'imageUrl': 'string',
                                            'buttons': [
                                                {
                                                    'text': 'string',
                                                    'value': 'string'
                                                },
                                            ]
                                        }
                                    },
                                    'variations': [
                                        {
                                            'plainTextMessage': {
                                                'value': 'string'
                                            },
                                            'customPayload': {
                                                'value': 'string'
                                            },
                                            'ssmlMessage': {
                                                'value': 'string'
                                            },
                                            'imageResponseCard': {
                                                'title': 'string',
                                                'subtitle': 'string',
                                                'imageUrl': 'string',
                                                'buttons': [
                                                    {
                                                        'text': 'string',
                                                        'value': 'string'
                                                    },
                                                ]
                                            }
                                        },
                                    ]
                                },
                            ],
                            'frequencyInSeconds': 123,
                            'timeoutInSeconds': 123,
                            'allowInterrupt': True|False
                        },
                        'active': True|False
                    }
                }
            }
        }
    }
)
type slotName

string

param slotName

[REQUIRED]

The name of the slot. Slot names must be unique within the bot that contains the slot.

type description

string

param description

A description of the slot. Use this to help identify the slot in lists.

type slotTypeId

string

param slotTypeId

The unique identifier for the slot type associated with this slot. The slot type determines the values that can be entered into the slot.

type valueElicitationSetting

dict

param valueElicitationSetting

[REQUIRED]

Specifies prompts that Amazon Lex sends to the user to elicit a response that provides the value for the slot.

  • defaultValueSpecification (dict) --

    A list of default values for a slot. Default values are used when Amazon Lex hasn't determined a value for a slot. You can specify default values from context variables, session attributes, and defined values.

    • defaultValueList (list) -- [REQUIRED]

      A list of default values. Amazon Lex chooses the default value to use in the order that they are presented in the list.

      • (dict) --

        Specifies the default value to use when a user doesn't provide a value for a slot.

        • defaultValue (string) -- [REQUIRED]

          The default value to use when a user doesn't provide a value for a slot.

  • slotConstraint (string) -- [REQUIRED]

    Specifies whether the slot is required or optional.

  • promptSpecification (dict) --

    The prompt that Amazon Lex uses to elicit the slot value from the user.

    • messageGroups (list) -- [REQUIRED]

      A collection of messages that Amazon Lex can send to the user. Amazon Lex chooses the actual message to send at runtime.

      • (dict) --

        Provides one or more messages that Amazon Lex should send to the user.

        • message (dict) -- [REQUIRED]

          The primary message that Amazon Lex should send to the user.

          • plainTextMessage (dict) --

            A message in plain text format.

            • value (string) -- [REQUIRED]

              The message to send to the user.

          • customPayload (dict) --

            A message in a custom format defined by the client application.

            • value (string) -- [REQUIRED]

              The string that is sent to your application.

          • ssmlMessage (dict) --

            A message in Speech Synthesis Markup Language (SSML).

            • value (string) -- [REQUIRED]

              The SSML text that defines the prompt.

          • imageResponseCard (dict) --

            A message that defines a response card that the client application can show to the user.

            • title (string) -- [REQUIRED]

              The title to display on the response card. The format of the title is determined by the platform displaying the response card.

            • subtitle (string) --

              The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

            • imageUrl (string) --

              The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

            • buttons (list) --

              A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.

              • (dict) --

                Describes a button to use on a response card used to gather slot values from a user.

                • text (string) -- [REQUIRED]

                  The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

                • value (string) -- [REQUIRED]

                  The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

        • variations (list) --

          Message variations to send to the user. When variations are defined, Amazon Lex chooses the primary message or one of the variations to send to the user.

          • (dict) --

            The object that provides message text and it's type.

            • plainTextMessage (dict) --

              A message in plain text format.

              • value (string) -- [REQUIRED]

                The message to send to the user.

            • customPayload (dict) --

              A message in a custom format defined by the client application.

              • value (string) -- [REQUIRED]

                The string that is sent to your application.

            • ssmlMessage (dict) --

              A message in Speech Synthesis Markup Language (SSML).

              • value (string) -- [REQUIRED]

                The SSML text that defines the prompt.

            • imageResponseCard (dict) --

              A message that defines a response card that the client application can show to the user.

              • title (string) -- [REQUIRED]

                The title to display on the response card. The format of the title is determined by the platform displaying the response card.

              • subtitle (string) --

                The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

              • imageUrl (string) --

                The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

              • buttons (list) --

                A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.

                • (dict) --

                  Describes a button to use on a response card used to gather slot values from a user.

                  • text (string) -- [REQUIRED]

                    The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

                  • value (string) -- [REQUIRED]

                    The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

    • maxRetries (integer) -- [REQUIRED]

      The maximum number of times the bot tries to elicit a response from the user using this prompt.

    • allowInterrupt (boolean) --

      Indicates whether the user can interrupt a speech prompt from the bot.

    • messageSelectionStrategy (string) --

      Indicates how a message is selected from a message group among retries.

  • sampleUtterances (list) --

    If you know a specific pattern that users might respond to an Amazon Lex request for a slot value, you can provide those utterances to improve accuracy. This is optional. In most cases, Amazon Lex is capable of understanding user utterances.

    • (dict) --

      A sample utterance that invokes an intent or respond to a slot elicitation prompt.

      • utterance (string) -- [REQUIRED]

        The sample utterance that Amazon Lex uses to build its machine-learning model to recognize intents.

  • waitAndContinueSpecification (dict) --

    Specifies the prompts that Amazon Lex uses while a bot is waiting for customer input.

    • waitingResponse (dict) -- [REQUIRED]

      The response that Amazon Lex sends to indicate that the bot is waiting for the conversation to continue.

      • messageGroups (list) -- [REQUIRED]

        A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.

        • (dict) --

          Provides one or more messages that Amazon Lex should send to the user.

          • message (dict) -- [REQUIRED]

            The primary message that Amazon Lex should send to the user.

            • plainTextMessage (dict) --

              A message in plain text format.

              • value (string) -- [REQUIRED]

                The message to send to the user.

            • customPayload (dict) --

              A message in a custom format defined by the client application.

              • value (string) -- [REQUIRED]

                The string that is sent to your application.

            • ssmlMessage (dict) --

              A message in Speech Synthesis Markup Language (SSML).

              • value (string) -- [REQUIRED]

                The SSML text that defines the prompt.

            • imageResponseCard (dict) --

              A message that defines a response card that the client application can show to the user.

              • title (string) -- [REQUIRED]

                The title to display on the response card. The format of the title is determined by the platform displaying the response card.

              • subtitle (string) --

                The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

              • imageUrl (string) --

                The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

              • buttons (list) --

                A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.

                • (dict) --

                  Describes a button to use on a response card used to gather slot values from a user.

                  • text (string) -- [REQUIRED]

                    The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

                  • value (string) -- [REQUIRED]

                    The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

          • variations (list) --

            Message variations to send to the user. When variations are defined, Amazon Lex chooses the primary message or one of the variations to send to the user.

            • (dict) --

              The object that provides message text and it's type.

              • plainTextMessage (dict) --

                A message in plain text format.

                • value (string) -- [REQUIRED]

                  The message to send to the user.

              • customPayload (dict) --

                A message in a custom format defined by the client application.

                • value (string) -- [REQUIRED]

                  The string that is sent to your application.

              • ssmlMessage (dict) --

                A message in Speech Synthesis Markup Language (SSML).

                • value (string) -- [REQUIRED]

                  The SSML text that defines the prompt.

              • imageResponseCard (dict) --

                A message that defines a response card that the client application can show to the user.

                • title (string) -- [REQUIRED]

                  The title to display on the response card. The format of the title is determined by the platform displaying the response card.

                • subtitle (string) --

                  The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

                • imageUrl (string) --

                  The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

                • buttons (list) --

                  A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.

                  • (dict) --

                    Describes a button to use on a response card used to gather slot values from a user.

                    • text (string) -- [REQUIRED]

                      The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

                    • value (string) -- [REQUIRED]

                      The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

      • allowInterrupt (boolean) --

        Indicates whether the user can interrupt a speech response from Amazon Lex.

    • continueResponse (dict) -- [REQUIRED]

      The response that Amazon Lex sends to indicate that the bot is ready to continue the conversation.

      • messageGroups (list) -- [REQUIRED]

        A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.

        • (dict) --

          Provides one or more messages that Amazon Lex should send to the user.

          • message (dict) -- [REQUIRED]

            The primary message that Amazon Lex should send to the user.

            • plainTextMessage (dict) --

              A message in plain text format.

              • value (string) -- [REQUIRED]

                The message to send to the user.

            • customPayload (dict) --

              A message in a custom format defined by the client application.

              • value (string) -- [REQUIRED]

                The string that is sent to your application.

            • ssmlMessage (dict) --

              A message in Speech Synthesis Markup Language (SSML).

              • value (string) -- [REQUIRED]

                The SSML text that defines the prompt.

            • imageResponseCard (dict) --

              A message that defines a response card that the client application can show to the user.

              • title (string) -- [REQUIRED]

                The title to display on the response card. The format of the title is determined by the platform displaying the response card.

              • subtitle (string) --

                The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

              • imageUrl (string) --

                The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

              • buttons (list) --

                A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.

                • (dict) --

                  Describes a button to use on a response card used to gather slot values from a user.

                  • text (string) -- [REQUIRED]

                    The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

                  • value (string) -- [REQUIRED]

                    The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

          • variations (list) --

            Message variations to send to the user. When variations are defined, Amazon Lex chooses the primary message or one of the variations to send to the user.

            • (dict) --

              The object that provides message text and it's type.

              • plainTextMessage (dict) --

                A message in plain text format.

                • value (string) -- [REQUIRED]

                  The message to send to the user.

              • customPayload (dict) --

                A message in a custom format defined by the client application.

                • value (string) -- [REQUIRED]

                  The string that is sent to your application.

              • ssmlMessage (dict) --

                A message in Speech Synthesis Markup Language (SSML).

                • value (string) -- [REQUIRED]

                  The SSML text that defines the prompt.

              • imageResponseCard (dict) --

                A message that defines a response card that the client application can show to the user.

                • title (string) -- [REQUIRED]

                  The title to display on the response card. The format of the title is determined by the platform displaying the response card.

                • subtitle (string) --

                  The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

                • imageUrl (string) --

                  The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

                • buttons (list) --

                  A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.

                  • (dict) --

                    Describes a button to use on a response card used to gather slot values from a user.

                    • text (string) -- [REQUIRED]

                      The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

                    • value (string) -- [REQUIRED]

                      The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

      • allowInterrupt (boolean) --

        Indicates whether the user can interrupt a speech response from Amazon Lex.

    • stillWaitingResponse (dict) --

      A response that Amazon Lex sends periodically to the user to indicate that the bot is still waiting for input from the user.

      • messageGroups (list) -- [REQUIRED]

        One or more message groups, each containing one or more messages, that define the prompts that Amazon Lex sends to the user.

        • (dict) --

          Provides one or more messages that Amazon Lex should send to the user.

          • message (dict) -- [REQUIRED]

            The primary message that Amazon Lex should send to the user.

            • plainTextMessage (dict) --

              A message in plain text format.

              • value (string) -- [REQUIRED]

                The message to send to the user.

            • customPayload (dict) --

              A message in a custom format defined by the client application.

              • value (string) -- [REQUIRED]

                The string that is sent to your application.

            • ssmlMessage (dict) --

              A message in Speech Synthesis Markup Language (SSML).

              • value (string) -- [REQUIRED]

                The SSML text that defines the prompt.

            • imageResponseCard (dict) --

              A message that defines a response card that the client application can show to the user.

              • title (string) -- [REQUIRED]

                The title to display on the response card. The format of the title is determined by the platform displaying the response card.

              • subtitle (string) --

                The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

              • imageUrl (string) --

                The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

              • buttons (list) --

                A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.

                • (dict) --

                  Describes a button to use on a response card used to gather slot values from a user.

                  • text (string) -- [REQUIRED]

                    The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

                  • value (string) -- [REQUIRED]

                    The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

          • variations (list) --

            Message variations to send to the user. When variations are defined, Amazon Lex chooses the primary message or one of the variations to send to the user.

            • (dict) --

              The object that provides message text and it's type.

              • plainTextMessage (dict) --

                A message in plain text format.

                • value (string) -- [REQUIRED]

                  The message to send to the user.

              • customPayload (dict) --

                A message in a custom format defined by the client application.

                • value (string) -- [REQUIRED]

                  The string that is sent to your application.

              • ssmlMessage (dict) --

                A message in Speech Synthesis Markup Language (SSML).

                • value (string) -- [REQUIRED]

                  The SSML text that defines the prompt.

              • imageResponseCard (dict) --

                A message that defines a response card that the client application can show to the user.

                • title (string) -- [REQUIRED]

                  The title to display on the response card. The format of the title is determined by the platform displaying the response card.

                • subtitle (string) --

                  The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

                • imageUrl (string) --

                  The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

                • buttons (list) --

                  A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.

                  • (dict) --

                    Describes a button to use on a response card used to gather slot values from a user.

                    • text (string) -- [REQUIRED]

                      The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

                    • value (string) -- [REQUIRED]

                      The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

      • frequencyInSeconds (integer) -- [REQUIRED]

        How often a message should be sent to the user. Minimum of 1 second, maximum of 5 minutes.

      • timeoutInSeconds (integer) -- [REQUIRED]

        If Amazon Lex waits longer than this length of time for a response, it will stop sending messages.

      • allowInterrupt (boolean) --

        Indicates that the user can interrupt the response by speaking while the message is being played.

    • active (boolean) --

      Specifies whether the bot will wait for a user to respond. When this field is false, wait and continue responses for a slot aren't used. If the active field isn't specified, the default is true.

  • slotCaptureSetting (dict) --

    Specifies the settings that Amazon Lex uses when a slot value is successfully entered by a user.

    • captureResponse (dict) --

      Specifies a list of message groups that Amazon Lex uses to respond the user input.

      • messageGroups (list) -- [REQUIRED]

        A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.

        • (dict) --

          Provides one or more messages that Amazon Lex should send to the user.

          • message (dict) -- [REQUIRED]

            The primary message that Amazon Lex should send to the user.

            • plainTextMessage (dict) --

              A message in plain text format.

              • value (string) -- [REQUIRED]

                The message to send to the user.

            • customPayload (dict) --

              A message in a custom format defined by the client application.

              • value (string) -- [REQUIRED]

                The string that is sent to your application.

            • ssmlMessage (dict) --

              A message in Speech Synthesis Markup Language (SSML).

              • value (string) -- [REQUIRED]

                The SSML text that defines the prompt.

            • imageResponseCard (dict) --

              A message that defines a response card that the client application can show to the user.

              • title (string) -- [REQUIRED]

                The title to display on the response card. The format of the title is determined by the platform displaying the response card.

              • subtitle (string) --

                The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

              • imageUrl (string) --

                The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

              • buttons (list) --

                A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.

                • (dict) --

                  Describes a button to use on a response card used to gather slot values from a user.

                  • text (string) -- [REQUIRED]

                    The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

                  • value (string) -- [REQUIRED]

                    The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

          • variations (list) --

            Message variations to send to the user. When variations are defined, Amazon Lex chooses the primary message or one of the variations to send to the user.

            • (dict) --

              The object that provides message text and it's type.

              • plainTextMessage (dict) --

                A message in plain text format.

                • value (string) -- [REQUIRED]

                  The message to send to the user.

              • customPayload (dict) --

                A message in a custom format defined by the client application.

                • value (string) -- [REQUIRED]

                  The string that is sent to your application.

              • ssmlMessage (dict) --

                A message in Speech Synthesis Markup Language (SSML).

                • value (string) -- [REQUIRED]

                  The SSML text that defines the prompt.

              • imageResponseCard (dict) --

                A message that defines a response card that the client application can show to the user.

                • title (string) -- [REQUIRED]

                  The title to display on the response card. The format of the title is determined by the platform displaying the response card.

                • subtitle (string) --

                  The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

                • imageUrl (string) --

                  The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

                • buttons (list) --

                  A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.

                  • (dict) --

                    Describes a button to use on a response card used to gather slot values from a user.

                    • text (string) -- [REQUIRED]

                      The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

                    • value (string) -- [REQUIRED]

                      The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

      • allowInterrupt (boolean) --

        Indicates whether the user can interrupt a speech response from Amazon Lex.

    • captureNextStep (dict) --

      Specifies the next step that the bot runs when the slot value is captured before the code hook times out.

      • dialogAction (dict) --

        Defines the action that the bot executes at runtime when the conversation reaches this step.

        • type (string) -- [REQUIRED]

          The action that the bot should execute.

        • slotToElicit (string) --

          If the dialog action is ElicitSlot , defines the slot to elicit from the user.

        • suppressNextMessage (boolean) --

          When true the next message for the intent is not used.

      • intent (dict) --

        Override settings to configure the intent state.

        • name (string) --

          The name of the intent. Only required when you're switching intents.

        • slots (dict) --

          A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.,

          • (string) --

            • (dict) --

              The slot values that Amazon Lex uses when it sets slot values in a dialog step.

              • shape (string) --

                When the shape value is List , it indicates that the values field contains a list of slot values. When the value is Scalar , it indicates that the value field contains a single value.

              • value (dict) --

                The current value of the slot.

                • interpretedValue (string) --

                  The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the resolvedValues list.

              • values (list) --

                A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."

                • (dict) --

                  The slot values that Amazon Lex uses when it sets slot values in a dialog step.

      • sessionAttributes (dict) --

        Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.

        • (string) --

          • (string) --

    • captureConditional (dict) --

      A list of conditional branches to evaluate after the slot value is captured.

      • active (boolean) -- [REQUIRED]

        Determines whether a conditional branch is active. When active is false, the conditions are not evaluated.

      • conditionalBranches (list) -- [REQUIRED]

        A list of conditional branches. A conditional branch is made up of a condition, a response and a next step. The response and next step are executed when the condition is true.

        • (dict) --

          A set of actions that Amazon Lex should run if the condition is matched.

          • name (string) -- [REQUIRED]

            The name of the branch.

          • condition (dict) -- [REQUIRED]

            Contains the expression to evaluate. If the condition is true, the branch's actions are taken.

            • expressionString (string) -- [REQUIRED]

              The expression string that is evaluated.

          • nextStep (dict) -- [REQUIRED]

            The next step in the conversation.

            • dialogAction (dict) --

              Defines the action that the bot executes at runtime when the conversation reaches this step.

              • type (string) -- [REQUIRED]

                The action that the bot should execute.

              • slotToElicit (string) --

                If the dialog action is ElicitSlot , defines the slot to elicit from the user.

              • suppressNextMessage (boolean) --

                When true the next message for the intent is not used.

            • intent (dict) --

              Override settings to configure the intent state.

              • name (string) --

                The name of the intent. Only required when you're switching intents.

              • slots (dict) --

                A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.,

                • (string) --

                  • (dict) --

                    The slot values that Amazon Lex uses when it sets slot values in a dialog step.

                    • shape (string) --

                      When the shape value is List , it indicates that the values field contains a list of slot values. When the value is Scalar , it indicates that the value field contains a single value.

                    • value (dict) --

                      The current value of the slot.

                      • interpretedValue (string) --

                        The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the resolvedValues list.

                    • values (list) --

                      A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."

                      • (dict) --

                        The slot values that Amazon Lex uses when it sets slot values in a dialog step.

            • sessionAttributes (dict) --

              Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.

              • (string) --

                • (string) --

          • response (dict) --

            Specifies a list of message groups that Amazon Lex uses to respond the user input.

            • messageGroups (list) -- [REQUIRED]

              A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.

              • (dict) --

                Provides one or more messages that Amazon Lex should send to the user.

                • message (dict) -- [REQUIRED]

                  The primary message that Amazon Lex should send to the user.

                  • plainTextMessage (dict) --

                    A message in plain text format.

                    • value (string) -- [REQUIRED]

                      The message to send to the user.

                  • customPayload (dict) --

                    A message in a custom format defined by the client application.

                    • value (string) -- [REQUIRED]

                      The string that is sent to your application.

                  • ssmlMessage (dict) --

                    A message in Speech Synthesis Markup Language (SSML).

                    • value (string) -- [REQUIRED]

                      The SSML text that defines the prompt.

                  • imageResponseCard (dict) --

                    A message that defines a response card that the client application can show to the user.

                    • title (string) -- [REQUIRED]

                      The title to display on the response card. The format of the title is determined by the platform displaying the response card.

                    • subtitle (string) --

                      The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

                    • imageUrl (string) --

                      The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

                    • buttons (list) --

                      A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.

                      • (dict) --

                        Describes a button to use on a response card used to gather slot values from a user.

                        • text (string) -- [REQUIRED]

                          The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

                        • value (string) -- [REQUIRED]

                          The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

                • variations (list) --

                  Message variations to send to the user. When variations are defined, Amazon Lex chooses the primary message or one of the variations to send to the user.

                  • (dict) --

                    The object that provides message text and it's type.

                    • plainTextMessage (dict) --

                      A message in plain text format.

                      • value (string) -- [REQUIRED]

                        The message to send to the user.

                    • customPayload (dict) --

                      A message in a custom format defined by the client application.

                      • value (string) -- [REQUIRED]

                        The string that is sent to your application.

                    • ssmlMessage (dict) --

                      A message in Speech Synthesis Markup Language (SSML).

                      • value (string) -- [REQUIRED]

                        The SSML text that defines the prompt.

                    • imageResponseCard (dict) --

                      A message that defines a response card that the client application can show to the user.

                      • title (string) -- [REQUIRED]

                        The title to display on the response card. The format of the title is determined by the platform displaying the response card.

                      • subtitle (string) --

                        The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

                      • imageUrl (string) --

                        The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

                      • buttons (list) --

                        A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.

                        • (dict) --

                          Describes a button to use on a response card used to gather slot values from a user.

                          • text (string) -- [REQUIRED]

                            The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

                          • value (string) -- [REQUIRED]

                            The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

            • allowInterrupt (boolean) --

              Indicates whether the user can interrupt a speech response from Amazon Lex.

      • defaultBranch (dict) -- [REQUIRED]

        The conditional branch that should be followed when the conditions for other branches are not satisfied. A conditional branch is made up of a condition, a response and a next step.

        • nextStep (dict) --

          The next step in the conversation.

          • dialogAction (dict) --

            Defines the action that the bot executes at runtime when the conversation reaches this step.

            • type (string) -- [REQUIRED]

              The action that the bot should execute.

            • slotToElicit (string) --

              If the dialog action is ElicitSlot , defines the slot to elicit from the user.

            • suppressNextMessage (boolean) --

              When true the next message for the intent is not used.

          • intent (dict) --

            Override settings to configure the intent state.

            • name (string) --

              The name of the intent. Only required when you're switching intents.

            • slots (dict) --

              A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.,

              • (string) --

                • (dict) --

                  The slot values that Amazon Lex uses when it sets slot values in a dialog step.

                  • shape (string) --

                    When the shape value is List , it indicates that the values field contains a list of slot values. When the value is Scalar , it indicates that the value field contains a single value.

                  • value (dict) --

                    The current value of the slot.

                    • interpretedValue (string) --

                      The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the resolvedValues list.

                  • values (list) --

                    A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."

                    • (dict) --

                      The slot values that Amazon Lex uses when it sets slot values in a dialog step.

          • sessionAttributes (dict) --

            Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.

            • (string) --

              • (string) --

        • response (dict) --

          Specifies a list of message groups that Amazon Lex uses to respond the user input.

          • messageGroups (list) -- [REQUIRED]

            A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.

            • (dict) --

              Provides one or more messages that Amazon Lex should send to the user.

              • message (dict) -- [REQUIRED]

                The primary message that Amazon Lex should send to the user.

                • plainTextMessage (dict) --

                  A message in plain text format.

                  • value (string) -- [REQUIRED]

                    The message to send to the user.

                • customPayload (dict) --

                  A message in a custom format defined by the client application.

                  • value (string) -- [REQUIRED]

                    The string that is sent to your application.

                • ssmlMessage (dict) --

                  A message in Speech Synthesis Markup Language (SSML).

                  • value (string) -- [REQUIRED]

                    The SSML text that defines the prompt.

                • imageResponseCard (dict) --

                  A message that defines a response card that the client application can show to the user.

                  • title (string) -- [REQUIRED]

                    The title to display on the response card. The format of the title is determined by the platform displaying the response card.

                  • subtitle (string) --

                    The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

                  • imageUrl (string) --

                    The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

                  • buttons (list) --

                    A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.

                    • (dict) --

                      Describes a button to use on a response card used to gather slot values from a user.

                      • text (string) -- [REQUIRED]

                        The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

                      • value (string) -- [REQUIRED]

                        The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

              • variations (list) --

                Message variations to send to the user. When variations are defined, Amazon Lex chooses the primary message or one of the variations to send to the user.

                • (dict) --

                  The object that provides message text and it's type.

                  • plainTextMessage (dict) --

                    A message in plain text format.

                    • value (string) -- [REQUIRED]

                      The message to send to the user.

                  • customPayload (dict) --

                    A message in a custom format defined by the client application.

                    • value (string) -- [REQUIRED]

                      The string that is sent to your application.

                  • ssmlMessage (dict) --

                    A message in Speech Synthesis Markup Language (SSML).

                    • value (string) -- [REQUIRED]

                      The SSML text that defines the prompt.

                  • imageResponseCard (dict) --

                    A message that defines a response card that the client application can show to the user.

                    • title (string) -- [REQUIRED]

                      The title to display on the response card. The format of the title is determined by the platform displaying the response card.

                    • subtitle (string) --

                      The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

                    • imageUrl (string) --

                      The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

                    • buttons (list) --

                      A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.

                      • (dict) --

                        Describes a button to use on a response card used to gather slot values from a user.

                        • text (string) -- [REQUIRED]

                          The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

                        • value (string) -- [REQUIRED]

                          The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

          • allowInterrupt (boolean) --

            Indicates whether the user can interrupt a speech response from Amazon Lex.

    • failureResponse (dict) --

      Specifies a list of message groups that Amazon Lex uses to respond the user input.

      • messageGroups (list) -- [REQUIRED]

        A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.

        • (dict) --

          Provides one or more messages that Amazon Lex should send to the user.

          • message (dict) -- [REQUIRED]

            The primary message that Amazon Lex should send to the user.

            • plainTextMessage (dict) --

              A message in plain text format.

              • value (string) -- [REQUIRED]

                The message to send to the user.

            • customPayload (dict) --

              A message in a custom format defined by the client application.

              • value (string) -- [REQUIRED]

                The string that is sent to your application.

            • ssmlMessage (dict) --

              A message in Speech Synthesis Markup Language (SSML).

              • value (string) -- [REQUIRED]

                The SSML text that defines the prompt.

            • imageResponseCard (dict) --

              A message that defines a response card that the client application can show to the user.

              • title (string) -- [REQUIRED]

                The title to display on the response card. The format of the title is determined by the platform displaying the response card.

              • subtitle (string) --

                The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

              • imageUrl (string) --

                The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

              • buttons (list) --

                A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.

                • (dict) --

                  Describes a button to use on a response card used to gather slot values from a user.

                  • text (string) -- [REQUIRED]

                    The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

                  • value (string) -- [REQUIRED]

                    The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

          • variations (list) --

            Message variations to send to the user. When variations are defined, Amazon Lex chooses the primary message or one of the variations to send to the user.

            • (dict) --

              The object that provides message text and it's type.

              • plainTextMessage (dict) --

                A message in plain text format.

                • value (string) -- [REQUIRED]

                  The message to send to the user.

              • customPayload (dict) --

                A message in a custom format defined by the client application.

                • value (string) -- [REQUIRED]

                  The string that is sent to your application.

              • ssmlMessage (dict) --

                A message in Speech Synthesis Markup Language (SSML).

                • value (string) -- [REQUIRED]

                  The SSML text that defines the prompt.

              • imageResponseCard (dict) --

                A message that defines a response card that the client application can show to the user.

                • title (string) -- [REQUIRED]

                  The title to display on the response card. The format of the title is determined by the platform displaying the response card.

                • subtitle (string) --

                  The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

                • imageUrl (string) --

                  The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

                • buttons (list) --

                  A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.

                  • (dict) --

                    Describes a button to use on a response card used to gather slot values from a user.

                    • text (string) -- [REQUIRED]

                      The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

                    • value (string) -- [REQUIRED]

                      The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

      • allowInterrupt (boolean) --

        Indicates whether the user can interrupt a speech response from Amazon Lex.

    • failureNextStep (dict) --

      Specifies the next step that the bot runs when the slot value code is not recognized.

      • dialogAction (dict) --

        Defines the action that the bot executes at runtime when the conversation reaches this step.

        • type (string) -- [REQUIRED]

          The action that the bot should execute.

        • slotToElicit (string) --

          If the dialog action is ElicitSlot , defines the slot to elicit from the user.

        • suppressNextMessage (boolean) --

          When true the next message for the intent is not used.

      • intent (dict) --

        Override settings to configure the intent state.

        • name (string) --

          The name of the intent. Only required when you're switching intents.

        • slots (dict) --

          A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.,

          • (string) --

            • (dict) --

              The slot values that Amazon Lex uses when it sets slot values in a dialog step.

              • shape (string) --

                When the shape value is List , it indicates that the values field contains a list of slot values. When the value is Scalar , it indicates that the value field contains a single value.

              • value (dict) --

                The current value of the slot.

                • interpretedValue (string) --

                  The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the resolvedValues list.

              • values (list) --

                A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."

                • (dict) --

                  The slot values that Amazon Lex uses when it sets slot values in a dialog step.

      • sessionAttributes (dict) --

        Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.

        • (string) --

          • (string) --

    • failureConditional (dict) --

      A list of conditional branches to evaluate when the slot value isn't captured.

      • active (boolean) -- [REQUIRED]

        Determines whether a conditional branch is active. When active is false, the conditions are not evaluated.

      • conditionalBranches (list) -- [REQUIRED]

        A list of conditional branches. A conditional branch is made up of a condition, a response and a next step. The response and next step are executed when the condition is true.

        • (dict) --

          A set of actions that Amazon Lex should run if the condition is matched.

          • name (string) -- [REQUIRED]

            The name of the branch.

          • condition (dict) -- [REQUIRED]

            Contains the expression to evaluate. If the condition is true, the branch's actions are taken.

            • expressionString (string) -- [REQUIRED]

              The expression string that is evaluated.

          • nextStep (dict) -- [REQUIRED]

            The next step in the conversation.

            • dialogAction (dict) --

              Defines the action that the bot executes at runtime when the conversation reaches this step.

              • type (string) -- [REQUIRED]

                The action that the bot should execute.

              • slotToElicit (string) --

                If the dialog action is ElicitSlot , defines the slot to elicit from the user.

              • suppressNextMessage (boolean) --

                When true the next message for the intent is not used.

            • intent (dict) --

              Override settings to configure the intent state.

              • name (string) --

                The name of the intent. Only required when you're switching intents.

              • slots (dict) --

                A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.,

                • (string) --

                  • (dict) --

                    The slot values that Amazon Lex uses when it sets slot values in a dialog step.

                    • shape (string) --

                      When the shape value is List , it indicates that the values field contains a list of slot values. When the value is Scalar , it indicates that the value field contains a single value.

                    • value (dict) --

                      The current value of the slot.

                      • interpretedValue (string) --

                        The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the resolvedValues list.

                    • values (list) --

                      A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."

                      • (dict) --

                        The slot values that Amazon Lex uses when it sets slot values in a dialog step.

            • sessionAttributes (dict) --

              Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.

              • (string) --

                • (string) --

          • response (dict) --

            Specifies a list of message groups that Amazon Lex uses to respond the user input.

            • messageGroups (list) -- [REQUIRED]

              A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.

              • (dict) --

                Provides one or more messages that Amazon Lex should send to the user.

                • message (dict) -- [REQUIRED]

                  The primary message that Amazon Lex should send to the user.

                  • plainTextMessage (dict) --

                    A message in plain text format.

                    • value (string) -- [REQUIRED]

                      The message to send to the user.

                  • customPayload (dict) --

                    A message in a custom format defined by the client application.

                    • value (string) -- [REQUIRED]

                      The string that is sent to your application.

                  • ssmlMessage (dict) --

                    A message in Speech Synthesis Markup Language (SSML).

                    • value (string) -- [REQUIRED]

                      The SSML text that defines the prompt.

                  • imageResponseCard (dict) --

                    A message that defines a response card that the client application can show to the user.

                    • title (string) -- [REQUIRED]

                      The title to display on the response card. The format of the title is determined by the platform displaying the response card.

                    • subtitle (string) --

                      The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

                    • imageUrl (string) --

                      The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

                    • buttons (list) --

                      A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.

                      • (dict) --

                        Describes a button to use on a response card used to gather slot values from a user.

                        • text (string) -- [REQUIRED]

                          The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

                        • value (string) -- [REQUIRED]

                          The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

                • variations (list) --

                  Message variations to send to the user. When variations are defined, Amazon Lex chooses the primary message or one of the variations to send to the user.

                  • (dict) --

                    The object that provides message text and it's type.

                    • plainTextMessage (dict) --

                      A message in plain text format.

                      • value (string) -- [REQUIRED]

                        The message to send to the user.

                    • customPayload (dict) --

                      A message in a custom format defined by the client application.

                      • value (string) -- [REQUIRED]

                        The string that is sent to your application.

                    • ssmlMessage (dict) --

                      A message in Speech Synthesis Markup Language (SSML).

                      • value (string) -- [REQUIRED]

                        The SSML text that defines the prompt.

                    • imageResponseCard (dict) --

                      A message that defines a response card that the client application can show to the user.

                      • title (string) -- [REQUIRED]

                        The title to display on the response card. The format of the title is determined by the platform displaying the response card.

                      • subtitle (string) --

                        The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

                      • imageUrl (string) --

                        The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

                      • buttons (list) --

                        A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.

                        • (dict) --

                          Describes a button to use on a response card used to gather slot values from a user.

                          • text (string) -- [REQUIRED]

                            The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

                          • value (string) -- [REQUIRED]

                            The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

            • allowInterrupt (boolean) --

              Indicates whether the user can interrupt a speech response from Amazon Lex.

      • defaultBranch (dict) -- [REQUIRED]

        The conditional branch that should be followed when the conditions for other branches are not satisfied. A conditional branch is made up of a condition, a response and a next step.

        • nextStep (dict) --

          The next step in the conversation.

          • dialogAction (dict) --

            Defines the action that the bot executes at runtime when the conversation reaches this step.

            • type (string) -- [REQUIRED]

              The action that the bot should execute.

            • slotToElicit (string) --

              If the dialog action is ElicitSlot , defines the slot to elicit from the user.

            • suppressNextMessage (boolean) --

              When true the next message for the intent is not used.

          • intent (dict) --

            Override settings to configure the intent state.

            • name (string) --

              The name of the intent. Only required when you're switching intents.

            • slots (dict) --

              A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.,

              • (string) --

                • (dict) --

                  The slot values that Amazon Lex uses when it sets slot values in a dialog step.

                  • shape (string) --

                    When the shape value is List , it indicates that the values field contains a list of slot values. When the value is Scalar , it indicates that the value field contains a single value.

                  • value (dict) --

                    The current value of the slot.

                    • interpretedValue (string) --

                      The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the resolvedValues list.

                  • values (list) --

                    A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."

                    • (dict) --

                      The slot values that Amazon Lex uses when it sets slot values in a dialog step.

          • sessionAttributes (dict) --

            Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.

            • (string) --

              • (string) --

        • response (dict) --

          Specifies a list of message groups that Amazon Lex uses to respond the user input.

          • messageGroups (list) -- [REQUIRED]

            A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.

            • (dict) --

              Provides one or more messages that Amazon Lex should send to the user.

              • message (dict) -- [REQUIRED]

                The primary message that Amazon Lex should send to the user.

                • plainTextMessage (dict) --

                  A message in plain text format.

                  • value (string) -- [REQUIRED]

                    The message to send to the user.

                • customPayload (dict) --

                  A message in a custom format defined by the client application.

                  • value (string) -- [REQUIRED]

                    The string that is sent to your application.

                • ssmlMessage (dict) --

                  A message in Speech Synthesis Markup Language (SSML).

                  • value (string) -- [REQUIRED]

                    The SSML text that defines the prompt.

                • imageResponseCard (dict) --

                  A message that defines a response card that the client application can show to the user.

                  • title (string) -- [REQUIRED]

                    The title to display on the response card. The format of the title is determined by the platform displaying the response card.

                  • subtitle (string) --

                    The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

                  • imageUrl (string) --

                    The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

                  • buttons (list) --

                    A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.

                    • (dict) --

                      Describes a button to use on a response card used to gather slot values from a user.

                      • text (string) -- [REQUIRED]

                        The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

                      • value (string) -- [REQUIRED]

                        The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

              • variations (list) --

                Message variations to send to the user. When variations are defined, Amazon Lex chooses the primary message or one of the variations to send to the user.

                • (dict) --

                  The object that provides message text and it's type.

                  • plainTextMessage (dict) --

                    A message in plain text format.

                    • value (string) -- [REQUIRED]

                      The message to send to the user.

                  • customPayload (dict) --

                    A message in a custom format defined by the client application.

                    • value (string) -- [REQUIRED]

                      The string that is sent to your application.

                  • ssmlMessage (dict) --

                    A message in Speech Synthesis Markup Language (SSML).

                    • value (string) -- [REQUIRED]

                      The SSML text that defines the prompt.

                  • imageResponseCard (dict) --

                    A message that defines a response card that the client application can show to the user.

                    • title (string) -- [REQUIRED]

                      The title to display on the response card. The format of the title is determined by the platform displaying the response card.

                    • subtitle (string) --

                      The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

                    • imageUrl (string) --

                      The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

                    • buttons (list) --

                      A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.

                      • (dict) --

                        Describes a button to use on a response card used to gather slot values from a user.

                        • text (string) -- [REQUIRED]

                          The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

                        • value (string) -- [REQUIRED]

                          The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

          • allowInterrupt (boolean) --

            Indicates whether the user can interrupt a speech response from Amazon Lex.

    • codeHook (dict) --

      Code hook called after Amazon Lex successfully captures a slot value.

      • enableCodeHookInvocation (boolean) -- [REQUIRED]

        Indicates whether a Lambda function should be invoked for the dialog.

      • active (boolean) -- [REQUIRED]

        Determines whether a dialog code hook is used when the intent is activated.

      • invocationLabel (string) --

        A label that indicates the dialog step from which the dialog code hook is happening.

      • postCodeHookSpecification (dict) -- [REQUIRED]

        Contains the responses and actions that Amazon Lex takes after the Lambda function is complete.

        • successResponse (dict) --

          Specifies a list of message groups that Amazon Lex uses to respond the user input.

          • messageGroups (list) -- [REQUIRED]

            A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.

            • (dict) --

              Provides one or more messages that Amazon Lex should send to the user.

              • message (dict) -- [REQUIRED]

                The primary message that Amazon Lex should send to the user.

                • plainTextMessage (dict) --

                  A message in plain text format.

                  • value (string) -- [REQUIRED]

                    The message to send to the user.

                • customPayload (dict) --

                  A message in a custom format defined by the client application.

                  • value (string) -- [REQUIRED]

                    The string that is sent to your application.

                • ssmlMessage (dict) --

                  A message in Speech Synthesis Markup Language (SSML).

                  • value (string) -- [REQUIRED]

                    The SSML text that defines the prompt.

                • imageResponseCard (dict) --

                  A message that defines a response card that the client application can show to the user.

                  • title (string) -- [REQUIRED]

                    The title to display on the response card. The format of the title is determined by the platform displaying the response card.

                  • subtitle (string) --

                    The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

                  • imageUrl (string) --

                    The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

                  • buttons (list) --

                    A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.

                    • (dict) --

                      Describes a button to use on a response card used to gather slot values from a user.

                      • text (string) -- [REQUIRED]

                        The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

                      • value (string) -- [REQUIRED]

                        The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

              • variations (list) --

                Message variations to send to the user. When variations are defined, Amazon Lex chooses the primary message or one of the variations to send to the user.

                • (dict) --

                  The object that provides message text and it's type.

                  • plainTextMessage (dict) --

                    A message in plain text format.

                    • value (string) -- [REQUIRED]

                      The message to send to the user.

                  • customPayload (dict) --

                    A message in a custom format defined by the client application.

                    • value (string) -- [REQUIRED]

                      The string that is sent to your application.

                  • ssmlMessage (dict) --

                    A message in Speech Synthesis Markup Language (SSML).

                    • value (string) -- [REQUIRED]

                      The SSML text that defines the prompt.

                  • imageResponseCard (dict) --

                    A message that defines a response card that the client application can show to the user.

                    • title (string) -- [REQUIRED]

                      The title to display on the response card. The format of the title is determined by the platform displaying the response card.

                    • subtitle (string) --

                      The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

                    • imageUrl (string) --

                      The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

                    • buttons (list) --

                      A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.

                      • (dict) --

                        Describes a button to use on a response card used to gather slot values from a user.

                        • text (string) -- [REQUIRED]

                          The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

                        • value (string) -- [REQUIRED]

                          The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

          • allowInterrupt (boolean) --

            Indicates whether the user can interrupt a speech response from Amazon Lex.

        • successNextStep (dict) --

          Specifics the next step the bot runs after the dialog code hook finishes successfully.

          • dialogAction (dict) --

            Defines the action that the bot executes at runtime when the conversation reaches this step.

            • type (string) -- [REQUIRED]

              The action that the bot should execute.

            • slotToElicit (string) --

              If the dialog action is ElicitSlot , defines the slot to elicit from the user.

            • suppressNextMessage (boolean) --

              When true the next message for the intent is not used.

          • intent (dict) --

            Override settings to configure the intent state.

            • name (string) --

              The name of the intent. Only required when you're switching intents.

            • slots (dict) --

              A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.,

              • (string) --

                • (dict) --

                  The slot values that Amazon Lex uses when it sets slot values in a dialog step.

                  • shape (string) --

                    When the shape value is List , it indicates that the values field contains a list of slot values. When the value is Scalar , it indicates that the value field contains a single value.

                  • value (dict) --

                    The current value of the slot.

                    • interpretedValue (string) --

                      The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the resolvedValues list.

                  • values (list) --

                    A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."

                    • (dict) --

                      The slot values that Amazon Lex uses when it sets slot values in a dialog step.

          • sessionAttributes (dict) --

            Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.

            • (string) --

              • (string) --

        • successConditional (dict) --

          A list of conditional branches to evaluate after the dialog code hook finishes successfully.

          • active (boolean) -- [REQUIRED]

            Determines whether a conditional branch is active. When active is false, the conditions are not evaluated.

          • conditionalBranches (list) -- [REQUIRED]

            A list of conditional branches. A conditional branch is made up of a condition, a response and a next step. The response and next step are executed when the condition is true.

            • (dict) --

              A set of actions that Amazon Lex should run if the condition is matched.

              • name (string) -- [REQUIRED]

                The name of the branch.

              • condition (dict) -- [REQUIRED]

                Contains the expression to evaluate. If the condition is true, the branch's actions are taken.

                • expressionString (string) -- [REQUIRED]

                  The expression string that is evaluated.

              • nextStep (dict) -- [REQUIRED]

                The next step in the conversation.

                • dialogAction (dict) --

                  Defines the action that the bot executes at runtime when the conversation reaches this step.

                  • type (string) -- [REQUIRED]

                    The action that the bot should execute.

                  • slotToElicit (string) --

                    If the dialog action is ElicitSlot , defines the slot to elicit from the user.

                  • suppressNextMessage (boolean) --

                    When true the next message for the intent is not used.

                • intent (dict) --

                  Override settings to configure the intent state.

                  • name (string) --

                    The name of the intent. Only required when you're switching intents.

                  • slots (dict) --

                    A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.,

                    • (string) --

                      • (dict) --

                        The slot values that Amazon Lex uses when it sets slot values in a dialog step.

                        • shape (string) --

                          When the shape value is List , it indicates that the values field contains a list of slot values. When the value is Scalar , it indicates that the value field contains a single value.

                        • value (dict) --

                          The current value of the slot.

                          • interpretedValue (string) --

                            The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the resolvedValues list.

                        • values (list) --

                          A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."

                          • (dict) --

                            The slot values that Amazon Lex uses when it sets slot values in a dialog step.

                • sessionAttributes (dict) --

                  Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.

                  • (string) --

                    • (string) --

              • response (dict) --

                Specifies a list of message groups that Amazon Lex uses to respond the user input.

                • messageGroups (list) -- [REQUIRED]

                  A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.

                  • (dict) --

                    Provides one or more messages that Amazon Lex should send to the user.

                    • message (dict) -- [REQUIRED]

                      The primary message that Amazon Lex should send to the user.

                      • plainTextMessage (dict) --

                        A message in plain text format.

                        • value (string) -- [REQUIRED]

                          The message to send to the user.

                      • customPayload (dict) --

                        A message in a custom format defined by the client application.

                        • value (string) -- [REQUIRED]

                          The string that is sent to your application.

                      • ssmlMessage (dict) --

                        A message in Speech Synthesis Markup Language (SSML).

                        • value (string) -- [REQUIRED]

                          The SSML text that defines the prompt.

                      • imageResponseCard (dict) --

                        A message that defines a response card that the client application can show to the user.

                        • title (string) -- [REQUIRED]

                          The title to display on the response card. The format of the title is determined by the platform displaying the response card.

                        • subtitle (string) --

                          The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

                        • imageUrl (string) --

                          The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

                        • buttons (list) --

                          A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.

                          • (dict) --

                            Describes a button to use on a response card used to gather slot values from a user.

                            • text (string) -- [REQUIRED]

                              The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

                            • value (string) -- [REQUIRED]

                              The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

                    • variations (list) --

                      Message variations to send to the user. When variations are defined, Amazon Lex chooses the primary message or one of the variations to send to the user.

                      • (dict) --

                        The object that provides message text and it's type.

                        • plainTextMessage (dict) --

                          A message in plain text format.

                          • value (string) -- [REQUIRED]

                            The message to send to the user.

                        • customPayload (dict) --

                          A message in a custom format defined by the client application.

                          • value (string) -- [REQUIRED]

                            The string that is sent to your application.

                        • ssmlMessage (dict) --

                          A message in Speech Synthesis Markup Language (SSML).

                          • value (string) -- [REQUIRED]

                            The SSML text that defines the prompt.

                        • imageResponseCard (dict) --

                          A message that defines a response card that the client application can show to the user.

                          • title (string) -- [REQUIRED]

                            The title to display on the response card. The format of the title is determined by the platform displaying the response card.

                          • subtitle (string) --

                            The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

                          • imageUrl (string) --

                            The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

                          • buttons (list) --

                            A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.

                            • (dict) --

                              Describes a button to use on a response card used to gather slot values from a user.

                              • text (string) -- [REQUIRED]

                                The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

                              • value (string) -- [REQUIRED]

                                The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

                • allowInterrupt (boolean) --

                  Indicates whether the user can interrupt a speech response from Amazon Lex.

          • defaultBranch (dict) -- [REQUIRED]

            The conditional branch that should be followed when the conditions for other branches are not satisfied. A conditional branch is made up of a condition, a response and a next step.

            • nextStep (dict) --

              The next step in the conversation.

              • dialogAction (dict) --

                Defines the action that the bot executes at runtime when the conversation reaches this step.

                • type (string) -- [REQUIRED]

                  The action that the bot should execute.

                • slotToElicit (string) --

                  If the dialog action is ElicitSlot , defines the slot to elicit from the user.

                • suppressNextMessage (boolean) --

                  When true the next message for the intent is not used.

              • intent (dict) --

                Override settings to configure the intent state.

                • name (string) --

                  The name of the intent. Only required when you're switching intents.

                • slots (dict) --

                  A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.,

                  • (string) --

                    • (dict) --

                      The slot values that Amazon Lex uses when it sets slot values in a dialog step.

                      • shape (string) --

                        When the shape value is List , it indicates that the values field contains a list of slot values. When the value is Scalar , it indicates that the value field contains a single value.

                      • value (dict) --

                        The current value of the slot.

                        • interpretedValue (string) --

                          The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the resolvedValues list.

                      • values (list) --

                        A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."

                        • (dict) --

                          The slot values that Amazon Lex uses when it sets slot values in a dialog step.

              • sessionAttributes (dict) --

                Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.

                • (string) --

                  • (string) --

            • response (dict) --

              Specifies a list of message groups that Amazon Lex uses to respond the user input.

              • messageGroups (list) -- [REQUIRED]

                A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.

                • (dict) --

                  Provides one or more messages that Amazon Lex should send to the user.

                  • message (dict) -- [REQUIRED]

                    The primary message that Amazon Lex should send to the user.

                    • plainTextMessage (dict) --

                      A message in plain text format.

                      • value (string) -- [REQUIRED]

                        The message to send to the user.

                    • customPayload (dict) --

                      A message in a custom format defined by the client application.

                      • value (string) -- [REQUIRED]

                        The string that is sent to your application.

                    • ssmlMessage (dict) --

                      A message in Speech Synthesis Markup Language (SSML).

                      • value (string) -- [REQUIRED]

                        The SSML text that defines the prompt.

                    • imageResponseCard (dict) --

                      A message that defines a response card that the client application can show to the user.

                      • title (string) -- [REQUIRED]

                        The title to display on the response card. The format of the title is determined by the platform displaying the response card.

                      • subtitle (string) --

                        The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

                      • imageUrl (string) --

                        The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

                      • buttons (list) --

                        A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.

                        • (dict) --

                          Describes a button to use on a response card used to gather slot values from a user.

                          • text (string) -- [REQUIRED]

                            The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

                          • value (string) -- [REQUIRED]

                            The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

                  • variations (list) --

                    Message variations to send to the user. When variations are defined, Amazon Lex chooses the primary message or one of the variations to send to the user.

                    • (dict) --

                      The object that provides message text and it's type.

                      • plainTextMessage (dict) --

                        A message in plain text format.

                        • value (string) -- [REQUIRED]

                          The message to send to the user.

                      • customPayload (dict) --

                        A message in a custom format defined by the client application.

                        • value (string) -- [REQUIRED]

                          The string that is sent to your application.

                      • ssmlMessage (dict) --

                        A message in Speech Synthesis Markup Language (SSML).

                        • value (string) -- [REQUIRED]

                          The SSML text that defines the prompt.

                      • imageResponseCard (dict) --

                        A message that defines a response card that the client application can show to the user.

                        • title (string) -- [REQUIRED]

                          The title to display on the response card. The format of the title is determined by the platform displaying the response card.

                        • subtitle (string) --

                          The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

                        • imageUrl (string) --

                          The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

                        • buttons (list) --

                          A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.

                          • (dict) --

                            Describes a button to use on a response card used to gather slot values from a user.

                            • text (string) -- [REQUIRED]

                              The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

                            • value (string) -- [REQUIRED]

                              The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

              • allowInterrupt (boolean) --

                Indicates whether the user can interrupt a speech response from Amazon Lex.

        • failureResponse (dict) --

          Specifies a list of message groups that Amazon Lex uses to respond the user input.

          • messageGroups (list) -- [REQUIRED]

            A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.

            • (dict) --

              Provides one or more messages that Amazon Lex should send to the user.

              • message (dict) -- [REQUIRED]

                The primary message that Amazon Lex should send to the user.

                • plainTextMessage (dict) --

                  A message in plain text format.

                  • value (string) -- [REQUIRED]

                    The message to send to the user.

                • customPayload (dict) --

                  A message in a custom format defined by the client application.

                  • value (string) -- [REQUIRED]

                    The string that is sent to your application.

                • ssmlMessage (dict) --

                  A message in Speech Synthesis Markup Language (SSML).

                  • value (string) -- [REQUIRED]

                    The SSML text that defines the prompt.

                • imageResponseCard (dict) --

                  A message that defines a response card that the client application can show to the user.

                  • title (string) -- [REQUIRED]

                    The title to display on the response card. The format of the title is determined by the platform displaying the response card.

                  • subtitle (string) --

                    The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

                  • imageUrl (string) --

                    The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

                  • buttons (list) --

                    A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.

                    • (dict) --

                      Describes a button to use on a response card used to gather slot values from a user.

                      • text (string) -- [REQUIRED]

                        The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

                      • value (string) -- [REQUIRED]

                        The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

              • variations (list) --

                Message variations to send to the user. When variations are defined, Amazon Lex chooses the primary message or one of the variations to send to the user.

                • (dict) --

                  The object that provides message text and it's type.

                  • plainTextMessage (dict) --

                    A message in plain text format.

                    • value (string) -- [REQUIRED]

                      The message to send to the user.

                  • customPayload (dict) --

                    A message in a custom format defined by the client application.

                    • value (string) -- [REQUIRED]

                      The string that is sent to your application.

                  • ssmlMessage (dict) --

                    A message in Speech Synthesis Markup Language (SSML).

                    • value (string) -- [REQUIRED]

                      The SSML text that defines the prompt.

                  • imageResponseCard (dict) --

                    A message that defines a response card that the client application can show to the user.

                    • title (string) -- [REQUIRED]

                      The title to display on the response card. The format of the title is determined by the platform displaying the response card.

                    • subtitle (string) --

                      The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

                    • imageUrl (string) --

                      The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

                    • buttons (list) --

                      A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.

                      • (dict) --

                        Describes a button to use on a response card used to gather slot values from a user.

                        • text (string) -- [REQUIRED]

                          The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

                        • value (string) -- [REQUIRED]

                          The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

          • allowInterrupt (boolean) --

            Indicates whether the user can interrupt a speech response from Amazon Lex.

        • failureNextStep (dict) --

          Specifies the next step the bot runs after the dialog code hook throws an exception or returns with the State field of the Intent object set to Failed .

          • dialogAction (dict) --

            Defines the action that the bot executes at runtime when the conversation reaches this step.

            • type (string) -- [REQUIRED]

              The action that the bot should execute.

            • slotToElicit (string) --

              If the dialog action is ElicitSlot , defines the slot to elicit from the user.

            • suppressNextMessage (boolean) --

              When true the next message for the intent is not used.

          • intent (dict) --

            Override settings to configure the intent state.

            • name (string) --

              The name of the intent. Only required when you're switching intents.

            • slots (dict) --

              A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.,

              • (string) --

                • (dict) --

                  The slot values that Amazon Lex uses when it sets slot values in a dialog step.

                  • shape (string) --

                    When the shape value is List , it indicates that the values field contains a list of slot values. When the value is Scalar , it indicates that the value field contains a single value.

                  • value (dict) --

                    The current value of the slot.

                    • interpretedValue (string) --

                      The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the resolvedValues list.

                  • values (list) --

                    A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."

                    • (dict) --

                      The slot values that Amazon Lex uses when it sets slot values in a dialog step.

          • sessionAttributes (dict) --

            Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.

            • (string) --

              • (string) --

        • failureConditional (dict) --

          A list of conditional branches to evaluate after the dialog code hook throws an exception or returns with the State field of the Intent object set to Failed .

          • active (boolean) -- [REQUIRED]

            Determines whether a conditional branch is active. When active is false, the conditions are not evaluated.

          • conditionalBranches (list) -- [REQUIRED]

            A list of conditional branches. A conditional branch is made up of a condition, a response and a next step. The response and next step are executed when the condition is true.

            • (dict) --

              A set of actions that Amazon Lex should run if the condition is matched.

              • name (string) -- [REQUIRED]

                The name of the branch.

              • condition (dict) -- [REQUIRED]

                Contains the expression to evaluate. If the condition is true, the branch's actions are taken.

                • expressionString (string) -- [REQUIRED]

                  The expression string that is evaluated.

              • nextStep (dict) -- [REQUIRED]

                The next step in the conversation.

                • dialogAction (dict) --

                  Defines the action that the bot executes at runtime when the conversation reaches this step.

                  • type (string) -- [REQUIRED]

                    The action that the bot should execute.

                  • slotToElicit (string) --

                    If the dialog action is ElicitSlot , defines the slot to elicit from the user.

                  • suppressNextMessage (boolean) --

                    When true the next message for the intent is not used.

                • intent (dict) --

                  Override settings to configure the intent state.

                  • name (string) --

                    The name of the intent. Only required when you're switching intents.

                  • slots (dict) --

                    A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.,

                    • (string) --

                      • (dict) --

                        The slot values that Amazon Lex uses when it sets slot values in a dialog step.

                        • shape (string) --

                          When the shape value is List , it indicates that the values field contains a list of slot values. When the value is Scalar , it indicates that the value field contains a single value.

                        • value (dict) --

                          The current value of the slot.

                          • interpretedValue (string) --

                            The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the resolvedValues list.

                        • values (list) --

                          A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."

                          • (dict) --

                            The slot values that Amazon Lex uses when it sets slot values in a dialog step.

                • sessionAttributes (dict) --

                  Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.

                  • (string) --

                    • (string) --

              • response (dict) --

                Specifies a list of message groups that Amazon Lex uses to respond the user input.

                • messageGroups (list) -- [REQUIRED]

                  A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.

                  • (dict) --

                    Provides one or more messages that Amazon Lex should send to the user.

                    • message (dict) -- [REQUIRED]

                      The primary message that Amazon Lex should send to the user.

                      • plainTextMessage (dict) --

                        A message in plain text format.

                        • value (string) -- [REQUIRED]

                          The message to send to the user.

                      • customPayload (dict) --

                        A message in a custom format defined by the client application.

                        • value (string) -- [REQUIRED]

                          The string that is sent to your application.

                      • ssmlMessage (dict) --

                        A message in Speech Synthesis Markup Language (SSML).

                        • value (string) -- [REQUIRED]

                          The SSML text that defines the prompt.

                      • imageResponseCard (dict) --

                        A message that defines a response card that the client application can show to the user.

                        • title (string) -- [REQUIRED]

                          The title to display on the response card. The format of the title is determined by the platform displaying the response card.

                        • subtitle (string) --

                          The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

                        • imageUrl (string) --

                          The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

                        • buttons (list) --

                          A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.

                          • (dict) --

                            Describes a button to use on a response card used to gather slot values from a user.

                            • text (string) -- [REQUIRED]

                              The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

                            • value (string) -- [REQUIRED]

                              The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

                    • variations (list) --

                      Message variations to send to the user. When variations are defined, Amazon Lex chooses the primary message or one of the variations to send to the user.

                      • (dict) --

                        The object that provides message text and it's type.

                        • plainTextMessage (dict) --

                          A message in plain text format.

                          • value (string) -- [REQUIRED]

                            The message to send to the user.

                        • customPayload (dict) --

                          A message in a custom format defined by the client application.

                          • value (string) -- [REQUIRED]

                            The string that is sent to your application.

                        • ssmlMessage (dict) --

                          A message in Speech Synthesis Markup Language (SSML).

                          • value (string) -- [REQUIRED]

                            The SSML text that defines the prompt.

                        • imageResponseCard (dict) --

                          A message that defines a response card that the client application can show to the user.

                          • title (string) -- [REQUIRED]

                            The title to display on the response card. The format of the title is determined by the platform displaying the response card.

                          • subtitle (string) --

                            The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

                          • imageUrl (string) --

                            The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

                          • buttons (list) --

                            A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.

                            • (dict) --

                              Describes a button to use on a response card used to gather slot values from a user.

                              • text (string) -- [REQUIRED]

                                The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

                              • value (string) -- [REQUIRED]

                                The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

                • allowInterrupt (boolean) --

                  Indicates whether the user can interrupt a speech response from Amazon Lex.

          • defaultBranch (dict) -- [REQUIRED]

            The conditional branch that should be followed when the conditions for other branches are not satisfied. A conditional branch is made up of a condition, a response and a next step.

            • nextStep (dict) --

              The next step in the conversation.

              • dialogAction (dict) --

                Defines the action that the bot executes at runtime when the conversation reaches this step.

                • type (string) -- [REQUIRED]

                  The action that the bot should execute.

                • slotToElicit (string) --

                  If the dialog action is ElicitSlot , defines the slot to elicit from the user.

                • suppressNextMessage (boolean) --

                  When true the next message for the intent is not used.

              • intent (dict) --

                Override settings to configure the intent state.

                • name (string) --

                  The name of the intent. Only required when you're switching intents.

                • slots (dict) --

                  A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.,

                  • (string) --

                    • (dict) --

                      The slot values that Amazon Lex uses when it sets slot values in a dialog step.

                      • shape (string) --

                        When the shape value is List , it indicates that the values field contains a list of slot values. When the value is Scalar , it indicates that the value field contains a single value.

                      • value (dict) --

                        The current value of the slot.

                        • interpretedValue (string) --

                          The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the resolvedValues list.

                      • values (list) --

                        A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."

                        • (dict) --

                          The slot values that Amazon Lex uses when it sets slot values in a dialog step.

              • sessionAttributes (dict) --

                Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.

                • (string) --

                  • (string) --

            • response (dict) --

              Specifies a list of message groups that Amazon Lex uses to respond the user input.

              • messageGroups (list) -- [REQUIRED]

                A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.

                • (dict) --

                  Provides one or more messages that Amazon Lex should send to the user.

                  • message (dict) -- [REQUIRED]

                    The primary message that Amazon Lex should send to the user.

                    • plainTextMessage (dict) --

                      A message in plain text format.

                      • value (string) -- [REQUIRED]

                        The message to send to the user.

                    • customPayload (dict) --

                      A message in a custom format defined by the client application.

                      • value (string) -- [REQUIRED]

                        The string that is sent to your application.

                    • ssmlMessage (dict) --

                      A message in Speech Synthesis Markup Language (SSML).

                      • value (string) -- [REQUIRED]

                        The SSML text that defines the prompt.

                    • imageResponseCard (dict) --

                      A message that defines a response card that the client application can show to the user.

                      • title (string) -- [REQUIRED]

                        The title to display on the response card. The format of the title is determined by the platform displaying the response card.

                      • subtitle (string) --

                        The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

                      • imageUrl (string) --

                        The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

                      • buttons (list) --

                        A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.

                        • (dict) --

                          Describes a button to use on a response card used to gather slot values from a user.

                          • text (string) -- [REQUIRED]

                            The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

                          • value (string) -- [REQUIRED]

                            The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

                  • variations (list) --

                    Message variations to send to the user. When variations are defined, Amazon Lex chooses the primary message or one of the variations to send to the user.

                    • (dict) --

                      The object that provides message text and it's type.

                      • plainTextMessage (dict) --

                        A message in plain text format.

                        • value (string) -- [REQUIRED]

                          The message to send to the user.

                      • customPayload (dict) --

                        A message in a custom format defined by the client application.

                        • value (string) -- [REQUIRED]

                          The string that is sent to your application.

                      • ssmlMessage (dict) --

                        A message in Speech Synthesis Markup Language (SSML).

                        • value (string) -- [REQUIRED]

                          The SSML text that defines the prompt.

                      • imageResponseCard (dict) --

                        A message that defines a response card that the client application can show to the user.

                        • title (string) -- [REQUIRED]

                          The title to display on the response card. The format of the title is determined by the platform displaying the response card.

                        • subtitle (string) --

                          The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

                        • imageUrl (string) --

                          The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

                        • buttons (list) --

                          A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.

                          • (dict) --

                            Describes a button to use on a response card used to gather slot values from a user.

                            • text (string) -- [REQUIRED]

                              The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

                            • value (string) -- [REQUIRED]

                              The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

              • allowInterrupt (boolean) --

                Indicates whether the user can interrupt a speech response from Amazon Lex.

        • timeoutResponse (dict) --

          Specifies a list of message groups that Amazon Lex uses to respond the user input.

          • messageGroups (list) -- [REQUIRED]

            A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.

            • (dict) --

              Provides one or more messages that Amazon Lex should send to the user.

              • message (dict) -- [REQUIRED]

                The primary message that Amazon Lex should send to the user.

                • plainTextMessage (dict) --

                  A message in plain text format.

                  • value (string) -- [REQUIRED]

                    The message to send to the user.

                • customPayload (dict) --

                  A message in a custom format defined by the client application.

                  • value (string) -- [REQUIRED]

                    The string that is sent to your application.

                • ssmlMessage (dict) --

                  A message in Speech Synthesis Markup Language (SSML).

                  • value (string) -- [REQUIRED]

                    The SSML text that defines the prompt.

                • imageResponseCard (dict) --

                  A message that defines a response card that the client application can show to the user.

                  • title (string) -- [REQUIRED]

                    The title to display on the response card. The format of the title is determined by the platform displaying the response card.

                  • subtitle (string) --

                    The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

                  • imageUrl (string) --

                    The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

                  • buttons (list) --

                    A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.

                    • (dict) --

                      Describes a button to use on a response card used to gather slot values from a user.

                      • text (string) -- [REQUIRED]

                        The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

                      • value (string) -- [REQUIRED]

                        The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

              • variations (list) --

                Message variations to send to the user. When variations are defined, Amazon Lex chooses the primary message or one of the variations to send to the user.

                • (dict) --

                  The object that provides message text and it's type.

                  • plainTextMessage (dict) --

                    A message in plain text format.

                    • value (string) -- [REQUIRED]

                      The message to send to the user.

                  • customPayload (dict) --

                    A message in a custom format defined by the client application.

                    • value (string) -- [REQUIRED]

                      The string that is sent to your application.

                  • ssmlMessage (dict) --

                    A message in Speech Synthesis Markup Language (SSML).

                    • value (string) -- [REQUIRED]

                      The SSML text that defines the prompt.

                  • imageResponseCard (dict) --

                    A message that defines a response card that the client application can show to the user.

                    • title (string) -- [REQUIRED]

                      The title to display on the response card. The format of the title is determined by the platform displaying the response card.

                    • subtitle (string) --

                      The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

                    • imageUrl (string) --

                      The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

                    • buttons (list) --

                      A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.

                      • (dict) --

                        Describes a button to use on a response card used to gather slot values from a user.

                        • text (string) -- [REQUIRED]

                          The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

                        • value (string) -- [REQUIRED]

                          The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

          • allowInterrupt (boolean) --

            Indicates whether the user can interrupt a speech response from Amazon Lex.

        • timeoutNextStep (dict) --

          Specifies the next step that the bot runs when the code hook times out.

          • dialogAction (dict) --

            Defines the action that the bot executes at runtime when the conversation reaches this step.

            • type (string) -- [REQUIRED]

              The action that the bot should execute.

            • slotToElicit (string) --

              If the dialog action is ElicitSlot , defines the slot to elicit from the user.

            • suppressNextMessage (boolean) --

              When true the next message for the intent is not used.

          • intent (dict) --

            Override settings to configure the intent state.

            • name (string) --

              The name of the intent. Only required when you're switching intents.

            • slots (dict) --

              A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.,

              • (string) --

                • (dict) --

                  The slot values that Amazon Lex uses when it sets slot values in a dialog step.

                  • shape (string) --

                    When the shape value is List , it indicates that the values field contains a list of slot values. When the value is Scalar , it indicates that the value field contains a single value.

                  • value (dict) --

                    The current value of the slot.

                    • interpretedValue (string) --

                      The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the resolvedValues list.

                  • values (list) --

                    A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."

                    • (dict) --

                      The slot values that Amazon Lex uses when it sets slot values in a dialog step.

          • sessionAttributes (dict) --

            Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.

            • (string) --

              • (string) --

        • timeoutConditional (dict) --

          A list of conditional branches to evaluate if the code hook times out.

          • active (boolean) -- [REQUIRED]

            Determines whether a conditional branch is active. When active is false, the conditions are not evaluated.

          • conditionalBranches (list) -- [REQUIRED]

            A list of conditional branches. A conditional branch is made up of a condition, a response and a next step. The response and next step are executed when the condition is true.

            • (dict) --

              A set of actions that Amazon Lex should run if the condition is matched.

              • name (string) -- [REQUIRED]

                The name of the branch.

              • condition (dict) -- [REQUIRED]

                Contains the expression to evaluate. If the condition is true, the branch's actions are taken.

                • expressionString (string) -- [REQUIRED]

                  The expression string that is evaluated.

              • nextStep (dict) -- [REQUIRED]

                The next step in the conversation.

                • dialogAction (dict) --

                  Defines the action that the bot executes at runtime when the conversation reaches this step.

                  • type (string) -- [REQUIRED]

                    The action that the bot should execute.

                  • slotToElicit (string) --

                    If the dialog action is ElicitSlot , defines the slot to elicit from the user.

                  • suppressNextMessage (boolean) --

                    When true the next message for the intent is not used.

                • intent (dict) --

                  Override settings to configure the intent state.

                  • name (string) --

                    The name of the intent. Only required when you're switching intents.

                  • slots (dict) --

                    A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.,

                    • (string) --

                      • (dict) --

                        The slot values that Amazon Lex uses when it sets slot values in a dialog step.

                        • shape (string) --

                          When the shape value is List , it indicates that the values field contains a list of slot values. When the value is Scalar , it indicates that the value field contains a single value.

                        • value (dict) --

                          The current value of the slot.

                          • interpretedValue (string) --

                            The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the resolvedValues list.

                        • values (list) --

                          A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."

                          • (dict) --

                            The slot values that Amazon Lex uses when it sets slot values in a dialog step.

                • sessionAttributes (dict) --

                  Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.

                  • (string) --

                    • (string) --

              • response (dict) --

                Specifies a list of message groups that Amazon Lex uses to respond the user input.

                • messageGroups (list) -- [REQUIRED]

                  A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.

                  • (dict) --

                    Provides one or more messages that Amazon Lex should send to the user.

                    • message (dict) -- [REQUIRED]

                      The primary message that Amazon Lex should send to the user.

                      • plainTextMessage (dict) --

                        A message in plain text format.

                        • value (string) -- [REQUIRED]

                          The message to send to the user.

                      • customPayload (dict) --

                        A message in a custom format defined by the client application.

                        • value (string) -- [REQUIRED]

                          The string that is sent to your application.

                      • ssmlMessage (dict) --

                        A message in Speech Synthesis Markup Language (SSML).

                        • value (string) -- [REQUIRED]

                          The SSML text that defines the prompt.

                      • imageResponseCard (dict) --

                        A message that defines a response card that the client application can show to the user.

                        • title (string) -- [REQUIRED]

                          The title to display on the response card. The format of the title is determined by the platform displaying the response card.

                        • subtitle (string) --

                          The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

                        • imageUrl (string) --

                          The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

                        • buttons (list) --

                          A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.

                          • (dict) --

                            Describes a button to use on a response card used to gather slot values from a user.

                            • text (string) -- [REQUIRED]

                              The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

                            • value (string) -- [REQUIRED]

                              The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

                    • variations (list) --

                      Message variations to send to the user. When variations are defined, Amazon Lex chooses the primary message or one of the variations to send to the user.

                      • (dict) --

                        The object that provides message text and it's type.

                        • plainTextMessage (dict) --

                          A message in plain text format.

                          • value (string) -- [REQUIRED]

                            The message to send to the user.

                        • customPayload (dict) --

                          A message in a custom format defined by the client application.

                          • value (string) -- [REQUIRED]

                            The string that is sent to your application.

                        • ssmlMessage (dict) --

                          A message in Speech Synthesis Markup Language (SSML).

                          • value (string) -- [REQUIRED]

                            The SSML text that defines the prompt.

                        • imageResponseCard (dict) --

                          A message that defines a response card that the client application can show to the user.

                          • title (string) -- [REQUIRED]

                            The title to display on the response card. The format of the title is determined by the platform displaying the response card.

                          • subtitle (string) --

                            The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

                          • imageUrl (string) --

                            The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

                          • buttons (list) --

                            A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.

                            • (dict) --

                              Describes a button to use on a response card used to gather slot values from a user.

                              • text (string) -- [REQUIRED]

                                The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

                              • value (string) -- [REQUIRED]

                                The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

                • allowInterrupt (boolean) --

                  Indicates whether the user can interrupt a speech response from Amazon Lex.

          • defaultBranch (dict) -- [REQUIRED]

            The conditional branch that should be followed when the conditions for other branches are not satisfied. A conditional branch is made up of a condition, a response and a next step.

            • nextStep (dict) --

              The next step in the conversation.

              • dialogAction (dict) --

                Defines the action that the bot executes at runtime when the conversation reaches this step.

                • type (string) -- [REQUIRED]

                  The action that the bot should execute.

                • slotToElicit (string) --

                  If the dialog action is ElicitSlot , defines the slot to elicit from the user.

                • suppressNextMessage (boolean) --

                  When true the next message for the intent is not used.

              • intent (dict) --

                Override settings to configure the intent state.

                • name (string) --

                  The name of the intent. Only required when you're switching intents.

                • slots (dict) --

                  A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.,

                  • (string) --

                    • (dict) --

                      The slot values that Amazon Lex uses when it sets slot values in a dialog step.

                      • shape (string) --

                        When the shape value is List , it indicates that the values field contains a list of slot values. When the value is Scalar , it indicates that the value field contains a single value.

                      • value (dict) --

                        The current value of the slot.

                        • interpretedValue (string) --

                          The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the resolvedValues list.

                      • values (list) --

                        A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."

                        • (dict) --

                          The slot values that Amazon Lex uses when it sets slot values in a dialog step.

              • sessionAttributes (dict) --

                Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.

                • (string) --

                  • (string) --

            • response (dict) --

              Specifies a list of message groups that Amazon Lex uses to respond the user input.

              • messageGroups (list) -- [REQUIRED]

                A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.

                • (dict) --

                  Provides one or more messages that Amazon Lex should send to the user.

                  • message (dict) -- [REQUIRED]

                    The primary message that Amazon Lex should send to the user.

                    • plainTextMessage (dict) --

                      A message in plain text format.

                      • value (string) -- [REQUIRED]

                        The message to send to the user.

                    • customPayload (dict) --

                      A message in a custom format defined by the client application.

                      • value (string) -- [REQUIRED]

                        The string that is sent to your application.

                    • ssmlMessage (dict) --

                      A message in Speech Synthesis Markup Language (SSML).

                      • value (string) -- [REQUIRED]

                        The SSML text that defines the prompt.

                    • imageResponseCard (dict) --

                      A message that defines a response card that the client application can show to the user.

                      • title (string) -- [REQUIRED]

                        The title to display on the response card. The format of the title is determined by the platform displaying the response card.

                      • subtitle (string) --

                        The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

                      • imageUrl (string) --

                        The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

                      • buttons (list) --

                        A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.

                        • (dict) --

                          Describes a button to use on a response card used to gather slot values from a user.

                          • text (string) -- [REQUIRED]

                            The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

                          • value (string) -- [REQUIRED]

                            The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

                  • variations (list) --

                    Message variations to send to the user. When variations are defined, Amazon Lex chooses the primary message or one of the variations to send to the user.

                    • (dict) --

                      The object that provides message text and it's type.

                      • plainTextMessage (dict) --

                        A message in plain text format.

                        • value (string) -- [REQUIRED]

                          The message to send to the user.

                      • customPayload (dict) --

                        A message in a custom format defined by the client application.

                        • value (string) -- [REQUIRED]

                          The string that is sent to your application.

                      • ssmlMessage (dict) --

                        A message in Speech Synthesis Markup Language (SSML).

                        • value (string) -- [REQUIRED]

                          The SSML text that defines the prompt.

                      • imageResponseCard (dict) --

                        A message that defines a response card that the client application can show to the user.

                        • title (string) -- [REQUIRED]

                          The title to display on the response card. The format of the title is determined by the platform displaying the response card.

                        • subtitle (string) --

                          The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

                        • imageUrl (string) --

                          The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

                        • buttons (list) --

                          A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.

                          • (dict) --

                            Describes a button to use on a response card used to gather slot values from a user.

                            • text (string) -- [REQUIRED]

                              The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

                            • value (string) -- [REQUIRED]

                              The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

              • allowInterrupt (boolean) --

                Indicates whether the user can interrupt a speech response from Amazon Lex.

    • elicitationCodeHook (dict) --

      Code hook called when Amazon Lex doesn't capture a slot value.

      • enableCodeHookInvocation (boolean) -- [REQUIRED]

        Indicates whether a Lambda function should be invoked for the dialog.

      • invocationLabel (string) --

        A label that indicates the dialog step from which the dialog code hook is happening.

type obfuscationSetting

dict

param obfuscationSetting

Determines how slot values are used in Amazon CloudWatch logs. If the value of the obfuscationSetting parameter is DefaultObfuscation , slot values are obfuscated in the log output. If the value is None , the actual value is present in the log output.

The default is to obfuscate values in the CloudWatch logs.

  • obfuscationSettingType (string) -- [REQUIRED]

    Value that determines whether Amazon Lex obscures slot values in conversation logs. The default is to obscure the values.

type botId

string

param botId

[REQUIRED]

The identifier of the bot associated with the slot.

type botVersion

string

param botVersion

[REQUIRED]

The version of the bot associated with the slot.

type localeId

string

param localeId

[REQUIRED]

The identifier of the language and locale that the slot will be used in. The string must match one of the supported locales. All of the bots, intents, slot types used by the slot must have the same locale. For more information, see Supported languages .

type intentId

string

param intentId

[REQUIRED]

The identifier of the intent that contains the slot.

type multipleValuesSetting

dict

param multipleValuesSetting

Indicates whether the slot returns multiple values in one response. Multi-value slots are only available in the en-US locale. If you set this value to true in any other locale, Amazon Lex throws a ValidationException .

If the multipleValuesSetting is not set, the default value is false .

  • allowMultipleValues (boolean) --

    Indicates whether a slot can return multiple values. When true , the slot may return more than one value in a response. When false , the slot returns only a single value.

    Multi-value slots are only available in the en-US locale. If you set this value to true in any other locale, Amazon Lex throws a ValidationException .

    If the allowMutlipleValues is not set, the default value is false .

type subSlotSetting

dict

param subSlotSetting

Specifications for the constituent sub slots and the expression for the composite slot.

  • expression (string) --

    The expression text for defining the constituent sub slots in the composite slot using logical AND and OR operators.

  • slotSpecifications (dict) --

    Specifications for the constituent sub slots of a composite slot.

    • (string) --

      • (dict) --

        Subslot specifications.

        • slotTypeId (string) -- [REQUIRED]

          The unique identifier assigned to the slot type.

        • valueElicitationSetting (dict) -- [REQUIRED]

          Specifies the elicitation setting details for constituent sub slots of a composite slot.

          • defaultValueSpecification (dict) --

            Defines a list of values that Amazon Lex should use as the default value for a slot.

            • defaultValueList (list) -- [REQUIRED]

              A list of default values. Amazon Lex chooses the default value to use in the order that they are presented in the list.

              • (dict) --

                Specifies the default value to use when a user doesn't provide a value for a slot.

                • defaultValue (string) -- [REQUIRED]

                  The default value to use when a user doesn't provide a value for a slot.

          • promptSpecification (dict) -- [REQUIRED]

            Specifies a list of message groups that Amazon Lex sends to a user to elicit a response.

            • messageGroups (list) -- [REQUIRED]

              A collection of messages that Amazon Lex can send to the user. Amazon Lex chooses the actual message to send at runtime.

              • (dict) --

                Provides one or more messages that Amazon Lex should send to the user.

                • message (dict) -- [REQUIRED]

                  The primary message that Amazon Lex should send to the user.

                  • plainTextMessage (dict) --

                    A message in plain text format.

                    • value (string) -- [REQUIRED]

                      The message to send to the user.

                  • customPayload (dict) --

                    A message in a custom format defined by the client application.

                    • value (string) -- [REQUIRED]

                      The string that is sent to your application.

                  • ssmlMessage (dict) --

                    A message in Speech Synthesis Markup Language (SSML).

                    • value (string) -- [REQUIRED]

                      The SSML text that defines the prompt.

                  • imageResponseCard (dict) --

                    A message that defines a response card that the client application can show to the user.

                    • title (string) -- [REQUIRED]

                      The title to display on the response card. The format of the title is determined by the platform displaying the response card.

                    • subtitle (string) --

                      The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

                    • imageUrl (string) --

                      The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

                    • buttons (list) --

                      A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.

                      • (dict) --

                        Describes a button to use on a response card used to gather slot values from a user.

                        • text (string) -- [REQUIRED]

                          The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

                        • value (string) -- [REQUIRED]

                          The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

                • variations (list) --

                  Message variations to send to the user. When variations are defined, Amazon Lex chooses the primary message or one of the variations to send to the user.

                  • (dict) --

                    The object that provides message text and it's type.

                    • plainTextMessage (dict) --

                      A message in plain text format.

                      • value (string) -- [REQUIRED]

                        The message to send to the user.

                    • customPayload (dict) --

                      A message in a custom format defined by the client application.

                      • value (string) -- [REQUIRED]

                        The string that is sent to your application.

                    • ssmlMessage (dict) --

                      A message in Speech Synthesis Markup Language (SSML).

                      • value (string) -- [REQUIRED]

                        The SSML text that defines the prompt.

                    • imageResponseCard (dict) --

                      A message that defines a response card that the client application can show to the user.

                      • title (string) -- [REQUIRED]

                        The title to display on the response card. The format of the title is determined by the platform displaying the response card.

                      • subtitle (string) --

                        The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

                      • imageUrl (string) --

                        The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

                      • buttons (list) --

                        A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.

                        • (dict) --

                          Describes a button to use on a response card used to gather slot values from a user.

                          • text (string) -- [REQUIRED]

                            The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

                          • value (string) -- [REQUIRED]

                            The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

            • maxRetries (integer) -- [REQUIRED]

              The maximum number of times the bot tries to elicit a response from the user using this prompt.

            • allowInterrupt (boolean) --

              Indicates whether the user can interrupt a speech prompt from the bot.

            • messageSelectionStrategy (string) --

              Indicates how a message is selected from a message group among retries.

          • sampleUtterances (list) --

            If you know a specific pattern that users might respond to an Amazon Lex request for a sub slot value, you can provide those utterances to improve accuracy. This is optional. In most cases Amazon Lex is capable of understanding user utterances. This is similar to SampleUtterances for slots.

            • (dict) --

              A sample utterance that invokes an intent or respond to a slot elicitation prompt.

              • utterance (string) -- [REQUIRED]

                The sample utterance that Amazon Lex uses to build its machine-learning model to recognize intents.

          • waitAndContinueSpecification (dict) --

            Specifies the prompts that Amazon Lex uses while a bot is waiting for customer input.

            • waitingResponse (dict) -- [REQUIRED]

              The response that Amazon Lex sends to indicate that the bot is waiting for the conversation to continue.

              • messageGroups (list) -- [REQUIRED]

                A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.

                • (dict) --

                  Provides one or more messages that Amazon Lex should send to the user.

                  • message (dict) -- [REQUIRED]

                    The primary message that Amazon Lex should send to the user.

                    • plainTextMessage (dict) --

                      A message in plain text format.

                      • value (string) -- [REQUIRED]

                        The message to send to the user.

                    • customPayload (dict) --

                      A message in a custom format defined by the client application.

                      • value (string) -- [REQUIRED]

                        The string that is sent to your application.

                    • ssmlMessage (dict) --

                      A message in Speech Synthesis Markup Language (SSML).

                      • value (string) -- [REQUIRED]

                        The SSML text that defines the prompt.

                    • imageResponseCard (dict) --

                      A message that defines a response card that the client application can show to the user.

                      • title (string) -- [REQUIRED]

                        The title to display on the response card. The format of the title is determined by the platform displaying the response card.

                      • subtitle (string) --

                        The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

                      • imageUrl (string) --

                        The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

                      • buttons (list) --

                        A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.

                        • (dict) --

                          Describes a button to use on a response card used to gather slot values from a user.

                          • text (string) -- [REQUIRED]

                            The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

                          • value (string) -- [REQUIRED]

                            The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

                  • variations (list) --

                    Message variations to send to the user. When variations are defined, Amazon Lex chooses the primary message or one of the variations to send to the user.

                    • (dict) --

                      The object that provides message text and it's type.

                      • plainTextMessage (dict) --

                        A message in plain text format.

                        • value (string) -- [REQUIRED]

                          The message to send to the user.

                      • customPayload (dict) --

                        A message in a custom format defined by the client application.

                        • value (string) -- [REQUIRED]

                          The string that is sent to your application.

                      • ssmlMessage (dict) --

                        A message in Speech Synthesis Markup Language (SSML).

                        • value (string) -- [REQUIRED]

                          The SSML text that defines the prompt.

                      • imageResponseCard (dict) --

                        A message that defines a response card that the client application can show to the user.

                        • title (string) -- [REQUIRED]

                          The title to display on the response card. The format of the title is determined by the platform displaying the response card.

                        • subtitle (string) --

                          The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

                        • imageUrl (string) --

                          The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

                        • buttons (list) --

                          A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.

                          • (dict) --

                            Describes a button to use on a response card used to gather slot values from a user.

                            • text (string) -- [REQUIRED]

                              The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

                            • value (string) -- [REQUIRED]

                              The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

              • allowInterrupt (boolean) --

                Indicates whether the user can interrupt a speech response from Amazon Lex.

            • continueResponse (dict) -- [REQUIRED]

              The response that Amazon Lex sends to indicate that the bot is ready to continue the conversation.

              • messageGroups (list) -- [REQUIRED]

                A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.

                • (dict) --

                  Provides one or more messages that Amazon Lex should send to the user.

                  • message (dict) -- [REQUIRED]

                    The primary message that Amazon Lex should send to the user.

                    • plainTextMessage (dict) --

                      A message in plain text format.

                      • value (string) -- [REQUIRED]

                        The message to send to the user.

                    • customPayload (dict) --

                      A message in a custom format defined by the client application.

                      • value (string) -- [REQUIRED]

                        The string that is sent to your application.

                    • ssmlMessage (dict) --

                      A message in Speech Synthesis Markup Language (SSML).

                      • value (string) -- [REQUIRED]

                        The SSML text that defines the prompt.

                    • imageResponseCard (dict) --

                      A message that defines a response card that the client application can show to the user.

                      • title (string) -- [REQUIRED]

                        The title to display on the response card. The format of the title is determined by the platform displaying the response card.

                      • subtitle (string) --

                        The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

                      • imageUrl (string) --

                        The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

                      • buttons (list) --

                        A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.

                        • (dict) --

                          Describes a button to use on a response card used to gather slot values from a user.

                          • text (string) -- [REQUIRED]

                            The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

                          • value (string) -- [REQUIRED]

                            The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

                  • variations (list) --

                    Message variations to send to the user. When variations are defined, Amazon Lex chooses the primary message or one of the variations to send to the user.

                    • (dict) --

                      The object that provides message text and it's type.

                      • plainTextMessage (dict) --

                        A message in plain text format.

                        • value (string) -- [REQUIRED]

                          The message to send to the user.

                      • customPayload (dict) --

                        A message in a custom format defined by the client application.

                        • value (string) -- [REQUIRED]

                          The string that is sent to your application.

                      • ssmlMessage (dict) --

                        A message in Speech Synthesis Markup Language (SSML).

                        • value (string) -- [REQUIRED]

                          The SSML text that defines the prompt.

                      • imageResponseCard (dict) --

                        A message that defines a response card that the client application can show to the user.

                        • title (string) -- [REQUIRED]

                          The title to display on the response card. The format of the title is determined by the platform displaying the response card.

                        • subtitle (string) --

                          The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

                        • imageUrl (string) --

                          The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

                        • buttons (list) --

                          A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.

                          • (dict) --

                            Describes a button to use on a response card used to gather slot values from a user.

                            • text (string) -- [REQUIRED]

                              The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

                            • value (string) -- [REQUIRED]

                              The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

              • allowInterrupt (boolean) --

                Indicates whether the user can interrupt a speech response from Amazon Lex.

            • stillWaitingResponse (dict) --

              A response that Amazon Lex sends periodically to the user to indicate that the bot is still waiting for input from the user.

              • messageGroups (list) -- [REQUIRED]

                One or more message groups, each containing one or more messages, that define the prompts that Amazon Lex sends to the user.

                • (dict) --

                  Provides one or more messages that Amazon Lex should send to the user.

                  • message (dict) -- [REQUIRED]

                    The primary message that Amazon Lex should send to the user.

                    • plainTextMessage (dict) --

                      A message in plain text format.

                      • value (string) -- [REQUIRED]

                        The message to send to the user.

                    • customPayload (dict) --

                      A message in a custom format defined by the client application.

                      • value (string) -- [REQUIRED]

                        The string that is sent to your application.

                    • ssmlMessage (dict) --

                      A message in Speech Synthesis Markup Language (SSML).

                      • value (string) -- [REQUIRED]

                        The SSML text that defines the prompt.

                    • imageResponseCard (dict) --

                      A message that defines a response card that the client application can show to the user.

                      • title (string) -- [REQUIRED]

                        The title to display on the response card. The format of the title is determined by the platform displaying the response card.

                      • subtitle (string) --

                        The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

                      • imageUrl (string) --

                        The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

                      • buttons (list) --

                        A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.

                        • (dict) --

                          Describes a button to use on a response card used to gather slot values from a user.

                          • text (string) -- [REQUIRED]

                            The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

                          • value (string) -- [REQUIRED]

                            The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

                  • variations (list) --

                    Message variations to send to the user. When variations are defined, Amazon Lex chooses the primary message or one of the variations to send to the user.

                    • (dict) --

                      The object that provides message text and it's type.

                      • plainTextMessage (dict) --

                        A message in plain text format.

                        • value (string) -- [REQUIRED]

                          The message to send to the user.

                      • customPayload (dict) --

                        A message in a custom format defined by the client application.

                        • value (string) -- [REQUIRED]

                          The string that is sent to your application.

                      • ssmlMessage (dict) --

                        A message in Speech Synthesis Markup Language (SSML).

                        • value (string) -- [REQUIRED]

                          The SSML text that defines the prompt.

                      • imageResponseCard (dict) --

                        A message that defines a response card that the client application can show to the user.

                        • title (string) -- [REQUIRED]

                          The title to display on the response card. The format of the title is determined by the platform displaying the response card.

                        • subtitle (string) --

                          The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

                        • imageUrl (string) --

                          The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

                        • buttons (list) --

                          A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.

                          • (dict) --

                            Describes a button to use on a response card used to gather slot values from a user.

                            • text (string) -- [REQUIRED]

                              The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

                            • value (string) -- [REQUIRED]

                              The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

              • frequencyInSeconds (integer) -- [REQUIRED]

                How often a message should be sent to the user. Minimum of 1 second, maximum of 5 minutes.

              • timeoutInSeconds (integer) -- [REQUIRED]

                If Amazon Lex waits longer than this length of time for a response, it will stop sending messages.

              • allowInterrupt (boolean) --

                Indicates that the user can interrupt the response by speaking while the message is being played.

            • active (boolean) --

              Specifies whether the bot will wait for a user to respond. When this field is false, wait and continue responses for a slot aren't used. If the active field isn't specified, the default is true.

rtype

dict

returns

Response Syntax

{
    'slotId': 'string',
    'slotName': 'string',
    'description': 'string',
    'slotTypeId': 'string',
    'valueElicitationSetting': {
        'defaultValueSpecification': {
            'defaultValueList': [
                {
                    'defaultValue': 'string'
                },
            ]
        },
        'slotConstraint': 'Required'|'Optional',
        'promptSpecification': {
            'messageGroups': [
                {
                    'message': {
                        'plainTextMessage': {
                            'value': 'string'
                        },
                        'customPayload': {
                            'value': 'string'
                        },
                        'ssmlMessage': {
                            'value': 'string'
                        },
                        'imageResponseCard': {
                            'title': 'string',
                            'subtitle': 'string',
                            'imageUrl': 'string',
                            'buttons': [
                                {
                                    'text': 'string',
                                    'value': 'string'
                                },
                            ]
                        }
                    },
                    'variations': [
                        {
                            'plainTextMessage': {
                                'value': 'string'
                            },
                            'customPayload': {
                                'value': 'string'
                            },
                            'ssmlMessage': {
                                'value': 'string'
                            },
                            'imageResponseCard': {
                                'title': 'string',
                                'subtitle': 'string',
                                'imageUrl': 'string',
                                'buttons': [
                                    {
                                        'text': 'string',
                                        'value': 'string'
                                    },
                                ]
                            }
                        },
                    ]
                },
            ],
            'maxRetries': 123,
            'allowInterrupt': True|False,
            'messageSelectionStrategy': 'Random'|'Ordered'
        },
        'sampleUtterances': [
            {
                'utterance': 'string'
            },
        ],
        'waitAndContinueSpecification': {
            'waitingResponse': {
                'messageGroups': [
                    {
                        'message': {
                            'plainTextMessage': {
                                'value': 'string'
                            },
                            'customPayload': {
                                'value': 'string'
                            },
                            'ssmlMessage': {
                                'value': 'string'
                            },
                            'imageResponseCard': {
                                'title': 'string',
                                'subtitle': 'string',
                                'imageUrl': 'string',
                                'buttons': [
                                    {
                                        'text': 'string',
                                        'value': 'string'
                                    },
                                ]
                            }
                        },
                        'variations': [
                            {
                                'plainTextMessage': {
                                    'value': 'string'
                                },
                                'customPayload': {
                                    'value': 'string'
                                },
                                'ssmlMessage': {
                                    'value': 'string'
                                },
                                'imageResponseCard': {
                                    'title': 'string',
                                    'subtitle': 'string',
                                    'imageUrl': 'string',
                                    'buttons': [
                                        {
                                            'text': 'string',
                                            'value': 'string'
                                        },
                                    ]
                                }
                            },
                        ]
                    },
                ],
                'allowInterrupt': True|False
            },
            'continueResponse': {
                'messageGroups': [
                    {
                        'message': {
                            'plainTextMessage': {
                                'value': 'string'
                            },
                            'customPayload': {
                                'value': 'string'
                            },
                            'ssmlMessage': {
                                'value': 'string'
                            },
                            'imageResponseCard': {
                                'title': 'string',
                                'subtitle': 'string',
                                'imageUrl': 'string',
                                'buttons': [
                                    {
                                        'text': 'string',
                                        'value': 'string'
                                    },
                                ]
                            }
                        },
                        'variations': [
                            {
                                'plainTextMessage': {
                                    'value': 'string'
                                },
                                'customPayload': {
                                    'value': 'string'
                                },
                                'ssmlMessage': {
                                    'value': 'string'
                                },
                                'imageResponseCard': {
                                    'title': 'string',
                                    'subtitle': 'string',
                                    'imageUrl': 'string',
                                    'buttons': [
                                        {
                                            'text': 'string',
                                            'value': 'string'
                                        },
                                    ]
                                }
                            },
                        ]
                    },
                ],
                'allowInterrupt': True|False
            },
            'stillWaitingResponse': {
                'messageGroups': [
                    {
                        'message': {
                            'plainTextMessage': {
                                'value': 'string'
                            },
                            'customPayload': {
                                'value': 'string'
                            },
                            'ssmlMessage': {
                                'value': 'string'
                            },
                            'imageResponseCard': {
                                'title': 'string',
                                'subtitle': 'string',
                                'imageUrl': 'string',
                                'buttons': [
                                    {
                                        'text': 'string',
                                        'value': 'string'
                                    },
                                ]
                            }
                        },
                        'variations': [
                            {
                                'plainTextMessage': {
                                    'value': 'string'
                                },
                                'customPayload': {
                                    'value': 'string'
                                },
                                'ssmlMessage': {
                                    'value': 'string'
                                },
                                'imageResponseCard': {
                                    'title': 'string',
                                    'subtitle': 'string',
                                    'imageUrl': 'string',
                                    'buttons': [
                                        {
                                            'text': 'string',
                                            'value': 'string'
                                        },
                                    ]
                                }
                            },
                        ]
                    },
                ],
                'frequencyInSeconds': 123,
                'timeoutInSeconds': 123,
                'allowInterrupt': True|False
            },
            'active': True|False
        },
        'slotCaptureSetting': {
            'captureResponse': {
                'messageGroups': [
                    {
                        'message': {
                            'plainTextMessage': {
                                'value': 'string'
                            },
                            'customPayload': {
                                'value': 'string'
                            },
                            'ssmlMessage': {
                                'value': 'string'
                            },
                            'imageResponseCard': {
                                'title': 'string',
                                'subtitle': 'string',
                                'imageUrl': 'string',
                                'buttons': [
                                    {
                                        'text': 'string',
                                        'value': 'string'
                                    },
                                ]
                            }
                        },
                        'variations': [
                            {
                                'plainTextMessage': {
                                    'value': 'string'
                                },
                                'customPayload': {
                                    'value': 'string'
                                },
                                'ssmlMessage': {
                                    'value': 'string'
                                },
                                'imageResponseCard': {
                                    'title': 'string',
                                    'subtitle': 'string',
                                    'imageUrl': 'string',
                                    'buttons': [
                                        {
                                            'text': 'string',
                                            'value': 'string'
                                        },
                                    ]
                                }
                            },
                        ]
                    },
                ],
                'allowInterrupt': True|False
            },
            'captureNextStep': {
                'dialogAction': {
                    'type': 'ElicitIntent'|'StartIntent'|'ElicitSlot'|'EvaluateConditional'|'InvokeDialogCodeHook'|'ConfirmIntent'|'FulfillIntent'|'CloseIntent'|'EndConversation',
                    'slotToElicit': 'string',
                    'suppressNextMessage': True|False
                },
                'intent': {
                    'name': 'string',
                    'slots': {
                        'string': {
                            'shape': 'Scalar'|'List',
                            'value': {
                                'interpretedValue': 'string'
                            },
                            'values': [
                                {'... recursive ...'},
                            ]
                        }
                    }
                },
                'sessionAttributes': {
                    'string': 'string'
                }
            },
            'captureConditional': {
                'active': True|False,
                'conditionalBranches': [
                    {
                        'name': 'string',
                        'condition': {
                            'expressionString': 'string'
                        },
                        'nextStep': {
                            'dialogAction': {
                                'type': 'ElicitIntent'|'StartIntent'|'ElicitSlot'|'EvaluateConditional'|'InvokeDialogCodeHook'|'ConfirmIntent'|'FulfillIntent'|'CloseIntent'|'EndConversation',
                                'slotToElicit': 'string',
                                'suppressNextMessage': True|False
                            },
                            'intent': {
                                'name': 'string',
                                'slots': {
                                    'string': {
                                        'shape': 'Scalar'|'List',
                                        'value': {
                                            'interpretedValue': 'string'
                                        },
                                        'values': [
                                            {'... recursive ...'},
                                        ]
                                    }
                                }
                            },
                            'sessionAttributes': {
                                'string': 'string'
                            }
                        },
                        'response': {
                            'messageGroups': [
                                {
                                    'message': {
                                        'plainTextMessage': {
                                            'value': 'string'
                                        },
                                        'customPayload': {
                                            'value': 'string'
                                        },
                                        'ssmlMessage': {
                                            'value': 'string'
                                        },
                                        'imageResponseCard': {
                                            'title': 'string',
                                            'subtitle': 'string',
                                            'imageUrl': 'string',
                                            'buttons': [
                                                {
                                                    'text': 'string',
                                                    'value': 'string'
                                                },
                                            ]
                                        }
                                    },
                                    'variations': [
                                        {
                                            'plainTextMessage': {
                                                'value': 'string'
                                            },
                                            'customPayload': {
                                                'value': 'string'
                                            },
                                            'ssmlMessage': {
                                                'value': 'string'
                                            },
                                            'imageResponseCard': {
                                                'title': 'string',
                                                'subtitle': 'string',
                                                'imageUrl': 'string',
                                                'buttons': [
                                                    {
                                                        'text': 'string',
                                                        'value': 'string'
                                                    },
                                                ]
                                            }
                                        },
                                    ]
                                },
                            ],
                            'allowInterrupt': True|False
                        }
                    },
                ],
                'defaultBranch': {
                    'nextStep': {
                        'dialogAction': {
                            'type': 'ElicitIntent'|'StartIntent'|'ElicitSlot'|'EvaluateConditional'|'InvokeDialogCodeHook'|'ConfirmIntent'|'FulfillIntent'|'CloseIntent'|'EndConversation',
                            'slotToElicit': 'string',
                            'suppressNextMessage': True|False
                        },
                        'intent': {
                            'name': 'string',
                            'slots': {
                                'string': {
                                    'shape': 'Scalar'|'List',
                                    'value': {
                                        'interpretedValue': 'string'
                                    },
                                    'values': [
                                        {'... recursive ...'},
                                    ]
                                }
                            }
                        },
                        'sessionAttributes': {
                            'string': 'string'
                        }
                    },
                    'response': {
                        'messageGroups': [
                            {
                                'message': {
                                    'plainTextMessage': {
                                        'value': 'string'
                                    },
                                    'customPayload': {
                                        'value': 'string'
                                    },
                                    'ssmlMessage': {
                                        'value': 'string'
                                    },
                                    'imageResponseCard': {
                                        'title': 'string',
                                        'subtitle': 'string',
                                        'imageUrl': 'string',
                                        'buttons': [
                                            {
                                                'text': 'string',
                                                'value': 'string'
                                            },
                                        ]
                                    }
                                },
                                'variations': [
                                    {
                                        'plainTextMessage': {
                                            'value': 'string'
                                        },
                                        'customPayload': {
                                            'value': 'string'
                                        },
                                        'ssmlMessage': {
                                            'value': 'string'
                                        },
                                        'imageResponseCard': {
                                            'title': 'string',
                                            'subtitle': 'string',
                                            'imageUrl': 'string',
                                            'buttons': [
                                                {
                                                    'text': 'string',
                                                    'value': 'string'
                                                },
                                            ]
                                        }
                                    },
                                ]
                            },
                        ],
                        'allowInterrupt': True|False
                    }
                }
            },
            'failureResponse': {
                'messageGroups': [
                    {
                        'message': {
                            'plainTextMessage': {
                                'value': 'string'
                            },
                            'customPayload': {
                                'value': 'string'
                            },
                            'ssmlMessage': {
                                'value': 'string'
                            },
                            'imageResponseCard': {
                                'title': 'string',
                                'subtitle': 'string',
                                'imageUrl': 'string',
                                'buttons': [
                                    {
                                        'text': 'string',
                                        'value': 'string'
                                    },
                                ]
                            }
                        },
                        'variations': [
                            {
                                'plainTextMessage': {
                                    'value': 'string'
                                },
                                'customPayload': {
                                    'value': 'string'
                                },
                                'ssmlMessage': {
                                    'value': 'string'
                                },
                                'imageResponseCard': {
                                    'title': 'string',
                                    'subtitle': 'string',
                                    'imageUrl': 'string',
                                    'buttons': [
                                        {
                                            'text': 'string',
                                            'value': 'string'
                                        },
                                    ]
                                }
                            },
                        ]
                    },
                ],
                'allowInterrupt': True|False
            },
            'failureNextStep': {
                'dialogAction': {
                    'type': 'ElicitIntent'|'StartIntent'|'ElicitSlot'|'EvaluateConditional'|'InvokeDialogCodeHook'|'ConfirmIntent'|'FulfillIntent'|'CloseIntent'|'EndConversation',
                    'slotToElicit': 'string',
                    'suppressNextMessage': True|False
                },
                'intent': {
                    'name': 'string',
                    'slots': {
                        'string': {
                            'shape': 'Scalar'|'List',
                            'value': {
                                'interpretedValue': 'string'
                            },
                            'values': [
                                {'... recursive ...'},
                            ]
                        }
                    }
                },
                'sessionAttributes': {
                    'string': 'string'
                }
            },
            'failureConditional': {
                'active': True|False,
                'conditionalBranches': [
                    {
                        'name': 'string',
                        'condition': {
                            'expressionString': 'string'
                        },
                        'nextStep': {
                            'dialogAction': {
                                'type': 'ElicitIntent'|'StartIntent'|'ElicitSlot'|'EvaluateConditional'|'InvokeDialogCodeHook'|'ConfirmIntent'|'FulfillIntent'|'CloseIntent'|'EndConversation',
                                'slotToElicit': 'string',
                                'suppressNextMessage': True|False
                            },
                            'intent': {
                                'name': 'string',
                                'slots': {
                                    'string': {
                                        'shape': 'Scalar'|'List',
                                        'value': {
                                            'interpretedValue': 'string'
                                        },
                                        'values': [
                                            {'... recursive ...'},
                                        ]
                                    }
                                }
                            },
                            'sessionAttributes': {
                                'string': 'string'
                            }
                        },
                        'response': {
                            'messageGroups': [
                                {
                                    'message': {
                                        'plainTextMessage': {
                                            'value': 'string'
                                        },
                                        'customPayload': {
                                            'value': 'string'
                                        },
                                        'ssmlMessage': {
                                            'value': 'string'
                                        },
                                        'imageResponseCard': {
                                            'title': 'string',
                                            'subtitle': 'string',
                                            'imageUrl': 'string',
                                            'buttons': [
                                                {
                                                    'text': 'string',
                                                    'value': 'string'
                                                },
                                            ]
                                        }
                                    },
                                    'variations': [
                                        {
                                            'plainTextMessage': {
                                                'value': 'string'
                                            },
                                            'customPayload': {
                                                'value': 'string'
                                            },
                                            'ssmlMessage': {
                                                'value': 'string'
                                            },
                                            'imageResponseCard': {
                                                'title': 'string',
                                                'subtitle': 'string',
                                                'imageUrl': 'string',
                                                'buttons': [
                                                    {
                                                        'text': 'string',
                                                        'value': 'string'
                                                    },
                                                ]
                                            }
                                        },
                                    ]
                                },
                            ],
                            'allowInterrupt': True|False
                        }
                    },
                ],
                'defaultBranch': {
                    'nextStep': {
                        'dialogAction': {
                            'type': 'ElicitIntent'|'StartIntent'|'ElicitSlot'|'EvaluateConditional'|'InvokeDialogCodeHook'|'ConfirmIntent'|'FulfillIntent'|'CloseIntent'|'EndConversation',
                            'slotToElicit': 'string',
                            'suppressNextMessage': True|False
                        },
                        'intent': {
                            'name': 'string',
                            'slots': {
                                'string': {
                                    'shape': 'Scalar'|'List',
                                    'value': {
                                        'interpretedValue': 'string'
                                    },
                                    'values': [
                                        {'... recursive ...'},
                                    ]
                                }
                            }
                        },
                        'sessionAttributes': {
                            'string': 'string'
                        }
                    },
                    'response': {
                        'messageGroups': [
                            {
                                'message': {
                                    'plainTextMessage': {
                                        'value': 'string'
                                    },
                                    'customPayload': {
                                        'value': 'string'
                                    },
                                    'ssmlMessage': {
                                        'value': 'string'
                                    },
                                    'imageResponseCard': {
                                        'title': 'string',
                                        'subtitle': 'string',
                                        'imageUrl': 'string',
                                        'buttons': [
                                            {
                                                'text': 'string',
                                                'value': 'string'
                                            },
                                        ]
                                    }
                                },
                                'variations': [
                                    {
                                        'plainTextMessage': {
                                            'value': 'string'
                                        },
                                        'customPayload': {
                                            'value': 'string'
                                        },
                                        'ssmlMessage': {
                                            'value': 'string'
                                        },
                                        'imageResponseCard': {
                                            'title': 'string',
                                            'subtitle': 'string',
                                            'imageUrl': 'string',
                                            'buttons': [
                                                {
                                                    'text': 'string',
                                                    'value': 'string'
                                                },
                                            ]
                                        }
                                    },
                                ]
                            },
                        ],
                        'allowInterrupt': True|False
                    }
                }
            },
            'codeHook': {
                'enableCodeHookInvocation': True|False,
                'active': True|False,
                'invocationLabel': 'string',
                'postCodeHookSpecification': {
                    'successResponse': {
                        'messageGroups': [
                            {
                                'message': {
                                    'plainTextMessage': {
                                        'value': 'string'
                                    },
                                    'customPayload': {
                                        'value': 'string'
                                    },
                                    'ssmlMessage': {
                                        'value': 'string'
                                    },
                                    'imageResponseCard': {
                                        'title': 'string',
                                        'subtitle': 'string',
                                        'imageUrl': 'string',
                                        'buttons': [
                                            {
                                                'text': 'string',
                                                'value': 'string'
                                            },
                                        ]
                                    }
                                },
                                'variations': [
                                    {
                                        'plainTextMessage': {
                                            'value': 'string'
                                        },
                                        'customPayload': {
                                            'value': 'string'
                                        },
                                        'ssmlMessage': {
                                            'value': 'string'
                                        },
                                        'imageResponseCard': {
                                            'title': 'string',
                                            'subtitle': 'string',
                                            'imageUrl': 'string',
                                            'buttons': [
                                                {
                                                    'text': 'string',
                                                    'value': 'string'
                                                },
                                            ]
                                        }
                                    },
                                ]
                            },
                        ],
                        'allowInterrupt': True|False
                    },
                    'successNextStep': {
                        'dialogAction': {
                            'type': 'ElicitIntent'|'StartIntent'|'ElicitSlot'|'EvaluateConditional'|'InvokeDialogCodeHook'|'ConfirmIntent'|'FulfillIntent'|'CloseIntent'|'EndConversation',
                            'slotToElicit': 'string',
                            'suppressNextMessage': True|False
                        },
                        'intent': {
                            'name': 'string',
                            'slots': {
                                'string': {
                                    'shape': 'Scalar'|'List',
                                    'value': {
                                        'interpretedValue': 'string'
                                    },
                                    'values': [
                                        {'... recursive ...'},
                                    ]
                                }
                            }
                        },
                        'sessionAttributes': {
                            'string': 'string'
                        }
                    },
                    'successConditional': {
                        'active': True|False,
                        'conditionalBranches': [
                            {
                                'name': 'string',
                                'condition': {
                                    'expressionString': 'string'
                                },
                                'nextStep': {
                                    'dialogAction': {
                                        'type': 'ElicitIntent'|'StartIntent'|'ElicitSlot'|'EvaluateConditional'|'InvokeDialogCodeHook'|'ConfirmIntent'|'FulfillIntent'|'CloseIntent'|'EndConversation',
                                        'slotToElicit': 'string',
                                        'suppressNextMessage': True|False
                                    },
                                    'intent': {
                                        'name': 'string',
                                        'slots': {
                                            'string': {
                                                'shape': 'Scalar'|'List',
                                                'value': {
                                                    'interpretedValue': 'string'
                                                },
                                                'values': [
                                                    {'... recursive ...'},
                                                ]
                                            }
                                        }
                                    },
                                    'sessionAttributes': {
                                        'string': 'string'
                                    }
                                },
                                'response': {
                                    'messageGroups': [
                                        {
                                            'message': {
                                                'plainTextMessage': {
                                                    'value': 'string'
                                                },
                                                'customPayload': {
                                                    'value': 'string'
                                                },
                                                'ssmlMessage': {
                                                    'value': 'string'
                                                },
                                                'imageResponseCard': {
                                                    'title': 'string',
                                                    'subtitle': 'string',
                                                    'imageUrl': 'string',
                                                    'buttons': [
                                                        {
                                                            'text': 'string',
                                                            'value': 'string'
                                                        },
                                                    ]
                                                }
                                            },
                                            'variations': [
                                                {
                                                    'plainTextMessage': {
                                                        'value': 'string'
                                                    },
                                                    'customPayload': {
                                                        'value': 'string'
                                                    },
                                                    'ssmlMessage': {
                                                        'value': 'string'
                                                    },
                                                    'imageResponseCard': {
                                                        'title': 'string',
                                                        'subtitle': 'string',
                                                        'imageUrl': 'string',
                                                        'buttons': [
                                                            {
                                                                'text': 'string',
                                                                'value': 'string'
                                                            },
                                                        ]
                                                    }
                                                },
                                            ]
                                        },
                                    ],
                                    'allowInterrupt': True|False
                                }
                            },
                        ],
                        'defaultBranch': {
                            'nextStep': {
                                'dialogAction': {
                                    'type': 'ElicitIntent'|'StartIntent'|'ElicitSlot'|'EvaluateConditional'|'InvokeDialogCodeHook'|'ConfirmIntent'|'FulfillIntent'|'CloseIntent'|'EndConversation',
                                    'slotToElicit': 'string',
                                    'suppressNextMessage': True|False
                                },
                                'intent': {
                                    'name': 'string',
                                    'slots': {
                                        'string': {
                                            'shape': 'Scalar'|'List',
                                            'value': {
                                                'interpretedValue': 'string'
                                            },
                                            'values': [
                                                {'... recursive ...'},
                                            ]
                                        }
                                    }
                                },
                                'sessionAttributes': {
                                    'string': 'string'
                                }
                            },
                            'response': {
                                'messageGroups': [
                                    {
                                        'message': {
                                            'plainTextMessage': {
                                                'value': 'string'
                                            },
                                            'customPayload': {
                                                'value': 'string'
                                            },
                                            'ssmlMessage': {
                                                'value': 'string'
                                            },
                                            'imageResponseCard': {
                                                'title': 'string',
                                                'subtitle': 'string',
                                                'imageUrl': 'string',
                                                'buttons': [
                                                    {
                                                        'text': 'string',
                                                        'value': 'string'
                                                    },
                                                ]
                                            }
                                        },
                                        'variations': [
                                            {
                                                'plainTextMessage': {
                                                    'value': 'string'
                                                },
                                                'customPayload': {
                                                    'value': 'string'
                                                },
                                                'ssmlMessage': {
                                                    'value': 'string'
                                                },
                                                'imageResponseCard': {
                                                    'title': 'string',
                                                    'subtitle': 'string',
                                                    'imageUrl': 'string',
                                                    'buttons': [
                                                        {
                                                            'text': 'string',
                                                            'value': 'string'
                                                        },
                                                    ]
                                                }
                                            },
                                        ]
                                    },
                                ],
                                'allowInterrupt': True|False
                            }
                        }
                    },
                    'failureResponse': {
                        'messageGroups': [
                            {
                                'message': {
                                    'plainTextMessage': {
                                        'value': 'string'
                                    },
                                    'customPayload': {
                                        'value': 'string'
                                    },
                                    'ssmlMessage': {
                                        'value': 'string'
                                    },
                                    'imageResponseCard': {
                                        'title': 'string',
                                        'subtitle': 'string',
                                        'imageUrl': 'string',
                                        'buttons': [
                                            {
                                                'text': 'string',
                                                'value': 'string'
                                            },
                                        ]
                                    }
                                },
                                'variations': [
                                    {
                                        'plainTextMessage': {
                                            'value': 'string'
                                        },
                                        'customPayload': {
                                            'value': 'string'
                                        },
                                        'ssmlMessage': {
                                            'value': 'string'
                                        },
                                        'imageResponseCard': {
                                            'title': 'string',
                                            'subtitle': 'string',
                                            'imageUrl': 'string',
                                            'buttons': [
                                                {
                                                    'text': 'string',
                                                    'value': 'string'
                                                },
                                            ]
                                        }
                                    },
                                ]
                            },
                        ],
                        'allowInterrupt': True|False
                    },
                    'failureNextStep': {
                        'dialogAction': {
                            'type': 'ElicitIntent'|'StartIntent'|'ElicitSlot'|'EvaluateConditional'|'InvokeDialogCodeHook'|'ConfirmIntent'|'FulfillIntent'|'CloseIntent'|'EndConversation',
                            'slotToElicit': 'string',
                            'suppressNextMessage': True|False
                        },
                        'intent': {
                            'name': 'string',
                            'slots': {
                                'string': {
                                    'shape': 'Scalar'|'List',
                                    'value': {
                                        'interpretedValue': 'string'
                                    },
                                    'values': [
                                        {'... recursive ...'},
                                    ]
                                }
                            }
                        },
                        'sessionAttributes': {
                            'string': 'string'
                        }
                    },
                    'failureConditional': {
                        'active': True|False,
                        'conditionalBranches': [
                            {
                                'name': 'string',
                                'condition': {
                                    'expressionString': 'string'
                                },
                                'nextStep': {
                                    'dialogAction': {
                                        'type': 'ElicitIntent'|'StartIntent'|'ElicitSlot'|'EvaluateConditional'|'InvokeDialogCodeHook'|'ConfirmIntent'|'FulfillIntent'|'CloseIntent'|'EndConversation',
                                        'slotToElicit': 'string',
                                        'suppressNextMessage': True|False
                                    },
                                    'intent': {
                                        'name': 'string',
                                        'slots': {
                                            'string': {
                                                'shape': 'Scalar'|'List',
                                                'value': {
                                                    'interpretedValue': 'string'
                                                },
                                                'values': [
                                                    {'... recursive ...'},
                                                ]
                                            }
                                        }
                                    },
                                    'sessionAttributes': {
                                        'string': 'string'
                                    }
                                },
                                'response': {
                                    'messageGroups': [
                                        {
                                            'message': {
                                                'plainTextMessage': {
                                                    'value': 'string'
                                                },
                                                'customPayload': {
                                                    'value': 'string'
                                                },
                                                'ssmlMessage': {
                                                    'value': 'string'
                                                },
                                                'imageResponseCard': {
                                                    'title': 'string',
                                                    'subtitle': 'string',
                                                    'imageUrl': 'string',
                                                    'buttons': [
                                                        {
                                                            'text': 'string',
                                                            'value': 'string'
                                                        },
                                                    ]
                                                }
                                            },
                                            'variations': [
                                                {
                                                    'plainTextMessage': {
                                                        'value': 'string'
                                                    },
                                                    'customPayload': {
                                                        'value': 'string'
                                                    },
                                                    'ssmlMessage': {
                                                        'value': 'string'
                                                    },
                                                    'imageResponseCard': {
                                                        'title': 'string',
                                                        'subtitle': 'string',
                                                        'imageUrl': 'string',
                                                        'buttons': [
                                                            {
                                                                'text': 'string',
                                                                'value': 'string'
                                                            },
                                                        ]
                                                    }
                                                },
                                            ]
                                        },
                                    ],
                                    'allowInterrupt': True|False
                                }
                            },
                        ],
                        'defaultBranch': {
                            'nextStep': {
                                'dialogAction': {
                                    'type': 'ElicitIntent'|'StartIntent'|'ElicitSlot'|'EvaluateConditional'|'InvokeDialogCodeHook'|'ConfirmIntent'|'FulfillIntent'|'CloseIntent'|'EndConversation',
                                    'slotToElicit': 'string',
                                    'suppressNextMessage': True|False
                                },
                                'intent': {
                                    'name': 'string',
                                    'slots': {
                                        'string': {
                                            'shape': 'Scalar'|'List',
                                            'value': {
                                                'interpretedValue': 'string'
                                            },
                                            'values': [
                                                {'... recursive ...'},
                                            ]
                                        }
                                    }
                                },
                                'sessionAttributes': {
                                    'string': 'string'
                                }
                            },
                            'response': {
                                'messageGroups': [
                                    {
                                        'message': {
                                            'plainTextMessage': {
                                                'value': 'string'
                                            },
                                            'customPayload': {
                                                'value': 'string'
                                            },
                                            'ssmlMessage': {
                                                'value': 'string'
                                            },
                                            'imageResponseCard': {
                                                'title': 'string',
                                                'subtitle': 'string',
                                                'imageUrl': 'string',
                                                'buttons': [
                                                    {
                                                        'text': 'string',
                                                        'value': 'string'
                                                    },
                                                ]
                                            }
                                        },
                                        'variations': [
                                            {
                                                'plainTextMessage': {
                                                    'value': 'string'
                                                },
                                                'customPayload': {
                                                    'value': 'string'
                                                },
                                                'ssmlMessage': {
                                                    'value': 'string'
                                                },
                                                'imageResponseCard': {
                                                    'title': 'string',
                                                    'subtitle': 'string',
                                                    'imageUrl': 'string',
                                                    'buttons': [
                                                        {
                                                            'text': 'string',
                                                            'value': 'string'
                                                        },
                                                    ]
                                                }
                                            },
                                        ]
                                    },
                                ],
                                'allowInterrupt': True|False
                            }
                        }
                    },
                    'timeoutResponse': {
                        'messageGroups': [
                            {
                                'message': {
                                    'plainTextMessage': {
                                        'value': 'string'
                                    },
                                    'customPayload': {
                                        'value': 'string'
                                    },
                                    'ssmlMessage': {
                                        'value': 'string'
                                    },
                                    'imageResponseCard': {
                                        'title': 'string',
                                        'subtitle': 'string',
                                        'imageUrl': 'string',
                                        'buttons': [
                                            {
                                                'text': 'string',
                                                'value': 'string'
                                            },
                                        ]
                                    }
                                },
                                'variations': [
                                    {
                                        'plainTextMessage': {
                                            'value': 'string'
                                        },
                                        'customPayload': {
                                            'value': 'string'
                                        },
                                        'ssmlMessage': {
                                            'value': 'string'
                                        },
                                        'imageResponseCard': {
                                            'title': 'string',
                                            'subtitle': 'string',
                                            'imageUrl': 'string',
                                            'buttons': [
                                                {
                                                    'text': 'string',
                                                    'value': 'string'
                                                },
                                            ]
                                        }
                                    },
                                ]
                            },
                        ],
                        'allowInterrupt': True|False
                    },
                    'timeoutNextStep': {
                        'dialogAction': {
                            'type': 'ElicitIntent'|'StartIntent'|'ElicitSlot'|'EvaluateConditional'|'InvokeDialogCodeHook'|'ConfirmIntent'|'FulfillIntent'|'CloseIntent'|'EndConversation',
                            'slotToElicit': 'string',
                            'suppressNextMessage': True|False
                        },
                        'intent': {
                            'name': 'string',
                            'slots': {
                                'string': {
                                    'shape': 'Scalar'|'List',
                                    'value': {
                                        'interpretedValue': 'string'
                                    },
                                    'values': [
                                        {'... recursive ...'},
                                    ]
                                }
                            }
                        },
                        'sessionAttributes': {
                            'string': 'string'
                        }
                    },
                    'timeoutConditional': {
                        'active': True|False,
                        'conditionalBranches': [
                            {
                                'name': 'string',
                                'condition': {
                                    'expressionString': 'string'
                                },
                                'nextStep': {
                                    'dialogAction': {
                                        'type': 'ElicitIntent'|'StartIntent'|'ElicitSlot'|'EvaluateConditional'|'InvokeDialogCodeHook'|'ConfirmIntent'|'FulfillIntent'|'CloseIntent'|'EndConversation',
                                        'slotToElicit': 'string',
                                        'suppressNextMessage': True|False
                                    },
                                    'intent': {
                                        'name': 'string',
                                        'slots': {
                                            'string': {
                                                'shape': 'Scalar'|'List',
                                                'value': {
                                                    'interpretedValue': 'string'
                                                },
                                                'values': [
                                                    {'... recursive ...'},
                                                ]
                                            }
                                        }
                                    },
                                    'sessionAttributes': {
                                        'string': 'string'
                                    }
                                },
                                'response': {
                                    'messageGroups': [
                                        {
                                            'message': {
                                                'plainTextMessage': {
                                                    'value': 'string'
                                                },
                                                'customPayload': {
                                                    'value': 'string'
                                                },
                                                'ssmlMessage': {
                                                    'value': 'string'
                                                },
                                                'imageResponseCard': {
                                                    'title': 'string',
                                                    'subtitle': 'string',
                                                    'imageUrl': 'string',
                                                    'buttons': [
                                                        {
                                                            'text': 'string',
                                                            'value': 'string'
                                                        },
                                                    ]
                                                }
                                            },
                                            'variations': [
                                                {
                                                    'plainTextMessage': {
                                                        'value': 'string'
                                                    },
                                                    'customPayload': {
                                                        'value': 'string'
                                                    },
                                                    'ssmlMessage': {
                                                        'value': 'string'
                                                    },
                                                    'imageResponseCard': {
                                                        'title': 'string',
                                                        'subtitle': 'string',
                                                        'imageUrl': 'string',
                                                        'buttons': [
                                                            {
                                                                'text': 'string',
                                                                'value': 'string'
                                                            },
                                                        ]
                                                    }
                                                },
                                            ]
                                        },
                                    ],
                                    'allowInterrupt': True|False
                                }
                            },
                        ],
                        'defaultBranch': {
                            'nextStep': {
                                'dialogAction': {
                                    'type': 'ElicitIntent'|'StartIntent'|'ElicitSlot'|'EvaluateConditional'|'InvokeDialogCodeHook'|'ConfirmIntent'|'FulfillIntent'|'CloseIntent'|'EndConversation',
                                    'slotToElicit': 'string',
                                    'suppressNextMessage': True|False
                                },
                                'intent': {
                                    'name': 'string',
                                    'slots': {
                                        'string': {
                                            'shape': 'Scalar'|'List',
                                            'value': {
                                                'interpretedValue': 'string'
                                            },
                                            'values': [
                                                {'... recursive ...'},
                                            ]
                                        }
                                    }
                                },
                                'sessionAttributes': {
                                    'string': 'string'
                                }
                            },
                            'response': {
                                'messageGroups': [
                                    {
                                        'message': {
                                            'plainTextMessage': {
                                                'value': 'string'
                                            },
                                            'customPayload': {
                                                'value': 'string'
                                            },
                                            'ssmlMessage': {
                                                'value': 'string'
                                            },
                                            'imageResponseCard': {
                                                'title': 'string',
                                                'subtitle': 'string',
                                                'imageUrl': 'string',
                                                'buttons': [
                                                    {
                                                        'text': 'string',
                                                        'value': 'string'
                                                    },
                                                ]
                                            }
                                        },
                                        'variations': [
                                            {
                                                'plainTextMessage': {
                                                    'value': 'string'
                                                },
                                                'customPayload': {
                                                    'value': 'string'
                                                },
                                                'ssmlMessage': {
                                                    'value': 'string'
                                                },
                                                'imageResponseCard': {
                                                    'title': 'string',
                                                    'subtitle': 'string',
                                                    'imageUrl': 'string',
                                                    'buttons': [
                                                        {
                                                            'text': 'string',
                                                            'value': 'string'
                                                        },
                                                    ]
                                                }
                                            },
                                        ]
                                    },
                                ],
                                'allowInterrupt': True|False
                            }
                        }
                    }
                }
            },
            'elicitationCodeHook': {
                'enableCodeHookInvocation': True|False,
                'invocationLabel': 'string'
            }
        }
    },
    'obfuscationSetting': {
        'obfuscationSettingType': 'None'|'DefaultObfuscation'
    },
    'botId': 'string',
    'botVersion': 'string',
    'localeId': 'string',
    'intentId': 'string',
    'creationDateTime': datetime(2015, 1, 1),
    'multipleValuesSetting': {
        'allowMultipleValues': True|False
    },
    'subSlotSetting': {
        'expression': 'string',
        'slotSpecifications': {
            'string': {
                'slotTypeId': 'string',
                'valueElicitationSetting': {
                    'defaultValueSpecification': {
                        'defaultValueList': [
                            {
                                'defaultValue': 'string'
                            },
                        ]
                    },
                    'promptSpecification': {
                        'messageGroups': [
                            {
                                'message': {
                                    'plainTextMessage': {
                                        'value': 'string'
                                    },
                                    'customPayload': {
                                        'value': 'string'
                                    },
                                    'ssmlMessage': {
                                        'value': 'string'
                                    },
                                    'imageResponseCard': {
                                        'title': 'string',
                                        'subtitle': 'string',
                                        'imageUrl': 'string',
                                        'buttons': [
                                            {
                                                'text': 'string',
                                                'value': 'string'
                                            },
                                        ]
                                    }
                                },
                                'variations': [
                                    {
                                        'plainTextMessage': {
                                            'value': 'string'
                                        },
                                        'customPayload': {
                                            'value': 'string'
                                        },
                                        'ssmlMessage': {
                                            'value': 'string'
                                        },
                                        'imageResponseCard': {
                                            'title': 'string',
                                            'subtitle': 'string',
                                            'imageUrl': 'string',
                                            'buttons': [
                                                {
                                                    'text': 'string',
                                                    'value': 'string'
                                                },
                                            ]
                                        }
                                    },
                                ]
                            },
                        ],
                        'maxRetries': 123,
                        'allowInterrupt': True|False,
                        'messageSelectionStrategy': 'Random'|'Ordered'
                    },
                    'sampleUtterances': [
                        {
                            'utterance': 'string'
                        },
                    ],
                    'waitAndContinueSpecification': {
                        'waitingResponse': {
                            'messageGroups': [
                                {
                                    'message': {
                                        'plainTextMessage': {
                                            'value': 'string'
                                        },
                                        'customPayload': {
                                            'value': 'string'
                                        },
                                        'ssmlMessage': {
                                            'value': 'string'
                                        },
                                        'imageResponseCard': {
                                            'title': 'string',
                                            'subtitle': 'string',
                                            'imageUrl': 'string',
                                            'buttons': [
                                                {
                                                    'text': 'string',
                                                    'value': 'string'
                                                },
                                            ]
                                        }
                                    },
                                    'variations': [
                                        {
                                            'plainTextMessage': {
                                                'value': 'string'
                                            },
                                            'customPayload': {
                                                'value': 'string'
                                            },
                                            'ssmlMessage': {
                                                'value': 'string'
                                            },
                                            'imageResponseCard': {
                                                'title': 'string',
                                                'subtitle': 'string',
                                                'imageUrl': 'string',
                                                'buttons': [
                                                    {
                                                        'text': 'string',
                                                        'value': 'string'
                                                    },
                                                ]
                                            }
                                        },
                                    ]
                                },
                            ],
                            'allowInterrupt': True|False
                        },
                        'continueResponse': {
                            'messageGroups': [
                                {
                                    'message': {
                                        'plainTextMessage': {
                                            'value': 'string'
                                        },
                                        'customPayload': {
                                            'value': 'string'
                                        },
                                        'ssmlMessage': {
                                            'value': 'string'
                                        },
                                        'imageResponseCard': {
                                            'title': 'string',
                                            'subtitle': 'string',
                                            'imageUrl': 'string',
                                            'buttons': [
                                                {
                                                    'text': 'string',
                                                    'value': 'string'
                                                },
                                            ]
                                        }
                                    },
                                    'variations': [
                                        {
                                            'plainTextMessage': {
                                                'value': 'string'
                                            },
                                            'customPayload': {
                                                'value': 'string'
                                            },
                                            'ssmlMessage': {
                                                'value': 'string'
                                            },
                                            'imageResponseCard': {
                                                'title': 'string',
                                                'subtitle': 'string',
                                                'imageUrl': 'string',
                                                'buttons': [
                                                    {
                                                        'text': 'string',
                                                        'value': 'string'
                                                    },
                                                ]
                                            }
                                        },
                                    ]
                                },
                            ],
                            'allowInterrupt': True|False
                        },
                        'stillWaitingResponse': {
                            'messageGroups': [
                                {
                                    'message': {
                                        'plainTextMessage': {
                                            'value': 'string'
                                        },
                                        'customPayload': {
                                            'value': 'string'
                                        },
                                        'ssmlMessage': {
                                            'value': 'string'
                                        },
                                        'imageResponseCard': {
                                            'title': 'string',
                                            'subtitle': 'string',
                                            'imageUrl': 'string',
                                            'buttons': [
                                                {
                                                    'text': 'string',
                                                    'value': 'string'
                                                },
                                            ]
                                        }
                                    },
                                    'variations': [
                                        {
                                            'plainTextMessage': {
                                                'value': 'string'
                                            },
                                            'customPayload': {
                                                'value': 'string'
                                            },
                                            'ssmlMessage': {
                                                'value': 'string'
                                            },
                                            'imageResponseCard': {
                                                'title': 'string',
                                                'subtitle': 'string',
                                                'imageUrl': 'string',
                                                'buttons': [
                                                    {
                                                        'text': 'string',
                                                        'value': 'string'
                                                    },
                                                ]
                                            }
                                        },
                                    ]
                                },
                            ],
                            'frequencyInSeconds': 123,
                            'timeoutInSeconds': 123,
                            'allowInterrupt': True|False
                        },
                        'active': True|False
                    }
                }
            }
        }
    }
}

Response Structure

  • (dict) --

    • slotId (string) --

      The unique identifier associated with the slot. Use this to identify the slot when you update or delete it.

    • slotName (string) --

      The name specified for the slot.

    • description (string) --

      The description associated with the slot.

    • slotTypeId (string) --

      The unique identifier of the slot type associated with this slot.

    • valueElicitationSetting (dict) --

      The value elicitation settings specified for the slot.

      • defaultValueSpecification (dict) --

        A list of default values for a slot. Default values are used when Amazon Lex hasn't determined a value for a slot. You can specify default values from context variables, session attributes, and defined values.

        • defaultValueList (list) --

          A list of default values. Amazon Lex chooses the default value to use in the order that they are presented in the list.

          • (dict) --

            Specifies the default value to use when a user doesn't provide a value for a slot.

            • defaultValue (string) --

              The default value to use when a user doesn't provide a value for a slot.

      • slotConstraint (string) --

        Specifies whether the slot is required or optional.

      • promptSpecification (dict) --

        The prompt that Amazon Lex uses to elicit the slot value from the user.

        • messageGroups (list) --

          A collection of messages that Amazon Lex can send to the user. Amazon Lex chooses the actual message to send at runtime.

          • (dict) --

            Provides one or more messages that Amazon Lex should send to the user.

            • message (dict) --

              The primary message that Amazon Lex should send to the user.

              • plainTextMessage (dict) --

                A message in plain text format.

                • value (string) --

                  The message to send to the user.

              • customPayload (dict) --

                A message in a custom format defined by the client application.

                • value (string) --

                  The string that is sent to your application.

              • ssmlMessage (dict) --

                A message in Speech Synthesis Markup Language (SSML).

                • value (string) --

                  The SSML text that defines the prompt.

              • imageResponseCard (dict) --

                A message that defines a response card that the client application can show to the user.

                • title (string) --

                  The title to display on the response card. The format of the title is determined by the platform displaying the response card.

                • subtitle (string) --

                  The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

                • imageUrl (string) --

                  The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

                • buttons (list) --

                  A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.

                  • (dict) --

                    Describes a button to use on a response card used to gather slot values from a user.

                    • text (string) --

                      The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

                    • value (string) --

                      The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

            • variations (list) --

              Message variations to send to the user. When variations are defined, Amazon Lex chooses the primary message or one of the variations to send to the user.

              • (dict) --

                The object that provides message text and it's type.

                • plainTextMessage (dict) --

                  A message in plain text format.

                  • value (string) --

                    The message to send to the user.

                • customPayload (dict) --

                  A message in a custom format defined by the client application.

                  • value (string) --

                    The string that is sent to your application.

                • ssmlMessage (dict) --

                  A message in Speech Synthesis Markup Language (SSML).

                  • value (string) --

                    The SSML text that defines the prompt.

                • imageResponseCard (dict) --

                  A message that defines a response card that the client application can show to the user.

                  • title (string) --

                    The title to display on the response card. The format of the title is determined by the platform displaying the response card.

                  • subtitle (string) --

                    The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

                  • imageUrl (string) --

                    The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

                  • buttons (list) --

                    A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.

                    • (dict) --

                      Describes a button to use on a response card used to gather slot values from a user.

                      • text (string) --

                        The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

                      • value (string) --

                        The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

        • maxRetries (integer) --

          The maximum number of times the bot tries to elicit a response from the user using this prompt.

        • allowInterrupt (boolean) --

          Indicates whether the user can interrupt a speech prompt from the bot.

        • messageSelectionStrategy (string) --

          Indicates how a message is selected from a message group among retries.

      • sampleUtterances (list) --

        If you know a specific pattern that users might respond to an Amazon Lex request for a slot value, you can provide those utterances to improve accuracy. This is optional. In most cases, Amazon Lex is capable of understanding user utterances.

        • (dict) --

          A sample utterance that invokes an intent or respond to a slot elicitation prompt.

          • utterance (string) --

            The sample utterance that Amazon Lex uses to build its machine-learning model to recognize intents.

      • waitAndContinueSpecification (dict) --

        Specifies the prompts that Amazon Lex uses while a bot is waiting for customer input.

        • waitingResponse (dict) --

          The response that Amazon Lex sends to indicate that the bot is waiting for the conversation to continue.

          • messageGroups (list) --

            A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.

            • (dict) --

              Provides one or more messages that Amazon Lex should send to the user.

              • message (dict) --

                The primary message that Amazon Lex should send to the user.

                • plainTextMessage (dict) --

                  A message in plain text format.

                  • value (string) --

                    The message to send to the user.

                • customPayload (dict) --

                  A message in a custom format defined by the client application.

                  • value (string) --

                    The string that is sent to your application.

                • ssmlMessage (dict) --

                  A message in Speech Synthesis Markup Language (SSML).

                  • value (string) --

                    The SSML text that defines the prompt.

                • imageResponseCard (dict) --

                  A message that defines a response card that the client application can show to the user.

                  • title (string) --

                    The title to display on the response card. The format of the title is determined by the platform displaying the response card.

                  • subtitle (string) --

                    The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

                  • imageUrl (string) --

                    The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

                  • buttons (list) --

                    A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.

                    • (dict) --

                      Describes a button to use on a response card used to gather slot values from a user.

                      • text (string) --

                        The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

                      • value (string) --

                        The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

              • variations (list) --

                Message variations to send to the user. When variations are defined, Amazon Lex chooses the primary message or one of the variations to send to the user.

                • (dict) --

                  The object that provides message text and it's type.

                  • plainTextMessage (dict) --

                    A message in plain text format.

                    • value (string) --

                      The message to send to the user.

                  • customPayload (dict) --

                    A message in a custom format defined by the client application.

                    • value (string) --

                      The string that is sent to your application.

                  • ssmlMessage (dict) --

                    A message in Speech Synthesis Markup Language (SSML).

                    • value (string) --

                      The SSML text that defines the prompt.

                  • imageResponseCard (dict) --

                    A message that defines a response card that the client application can show to the user.

                    • title (string) --

                      The title to display on the response card. The format of the title is determined by the platform displaying the response card.

                    • subtitle (string) --

                      The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

                    • imageUrl (string) --

                      The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

                    • buttons (list) --

                      A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.

                      • (dict) --

                        Describes a button to use on a response card used to gather slot values from a user.

                        • text (string) --

                          The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

                        • value (string) --

                          The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

          • allowInterrupt (boolean) --

            Indicates whether the user can interrupt a speech response from Amazon Lex.

        • continueResponse (dict) --

          The response that Amazon Lex sends to indicate that the bot is ready to continue the conversation.

          • messageGroups (list) --

            A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.

            • (dict) --

              Provides one or more messages that Amazon Lex should send to the user.

              • message (dict) --

                The primary message that Amazon Lex should send to the user.

                • plainTextMessage (dict) --

                  A message in plain text format.

                  • value (string) --

                    The message to send to the user.

                • customPayload (dict) --

                  A message in a custom format defined by the client application.

                  • value (string) --

                    The string that is sent to your application.

                • ssmlMessage (dict) --

                  A message in Speech Synthesis Markup Language (SSML).

                  • value (string) --

                    The SSML text that defines the prompt.

                • imageResponseCard (dict) --

                  A message that defines a response card that the client application can show to the user.

                  • title (string) --

                    The title to display on the response card. The format of the title is determined by the platform displaying the response card.

                  • subtitle (string) --

                    The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

                  • imageUrl (string) --

                    The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

                  • buttons (list) --

                    A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.

                    • (dict) --

                      Describes a button to use on a response card used to gather slot values from a user.

                      • text (string) --

                        The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

                      • value (string) --

                        The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

              • variations (list) --

                Message variations to send to the user. When variations are defined, Amazon Lex chooses the primary message or one of the variations to send to the user.

                • (dict) --

                  The object that provides message text and it's type.

                  • plainTextMessage (dict) --

                    A message in plain text format.

                    • value (string) --

                      The message to send to the user.

                  • customPayload (dict) --

                    A message in a custom format defined by the client application.

                    • value (string) --

                      The string that is sent to your application.

                  • ssmlMessage (dict) --

                    A message in Speech Synthesis Markup Language (SSML).

                    • value (string) --

                      The SSML text that defines the prompt.

                  • imageResponseCard (dict) --

                    A message that defines a response card that the client application can show to the user.

                    • title (string) --

                      The title to display on the response card. The format of the title is determined by the platform displaying the response card.

                    • subtitle (string) --

                      The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

                    • imageUrl (string) --

                      The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

                    • buttons (list) --

                      A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.

                      • (dict) --

                        Describes a button to use on a response card used to gather slot values from a user.

                        • text (string) --

                          The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

                        • value (string) --

                          The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

          • allowInterrupt (boolean) --

            Indicates whether the user can interrupt a speech response from Amazon Lex.

        • stillWaitingResponse (dict) --

          A response that Amazon Lex sends periodically to the user to indicate that the bot is still waiting for input from the user.

          • messageGroups (list) --

            One or more message groups, each containing one or more messages, that define the prompts that Amazon Lex sends to the user.

            • (dict) --

              Provides one or more messages that Amazon Lex should send to the user.

              • message (dict) --

                The primary message that Amazon Lex should send to the user.

                • plainTextMessage (dict) --

                  A message in plain text format.

                  • value (string) --

                    The message to send to the user.

                • customPayload (dict) --

                  A message in a custom format defined by the client application.

                  • value (string) --

                    The string that is sent to your application.

                • ssmlMessage (dict) --

                  A message in Speech Synthesis Markup Language (SSML).

                  • value (string) --

                    The SSML text that defines the prompt.

                • imageResponseCard (dict) --

                  A message that defines a response card that the client application can show to the user.

                  • title (string) --

                    The title to display on the response card. The format of the title is determined by the platform displaying the response card.

                  • subtitle (string) --

                    The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

                  • imageUrl (string) --

                    The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

                  • buttons (list) --

                    A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.

                    • (dict) --

                      Describes a button to use on a response card used to gather slot values from a user.

                      • text (string) --

                        The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

                      • value (string) --

                        The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

              • variations (list) --

                Message variations to send to the user. When variations are defined, Amazon Lex chooses the primary message or one of the variations to send to the user.

                • (dict) --

                  The object that provides message text and it's type.

                  • plainTextMessage (dict) --

                    A message in plain text format.

                    • value (string) --

                      The message to send to the user.

                  • customPayload (dict) --

                    A message in a custom format defined by the client application.

                    • value (string) --

                      The string that is sent to your application.

                  • ssmlMessage (dict) --

                    A message in Speech Synthesis Markup Language (SSML).

                    • value (string) --

                      The SSML text that defines the prompt.

                  • imageResponseCard (dict) --

                    A message that defines a response card that the client application can show to the user.

                    • title (string) --

                      The title to display on the response card. The format of the title is determined by the platform displaying the response card.

                    • subtitle (string) --

                      The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

                    • imageUrl (string) --

                      The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

                    • buttons (list) --

                      A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.

                      • (dict) --

                        Describes a button to use on a response card used to gather slot values from a user.

                        • text (string) --

                          The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

                        • value (string) --

                          The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

          • frequencyInSeconds (integer) --

            How often a message should be sent to the user. Minimum of 1 second, maximum of 5 minutes.

          • timeoutInSeconds (integer) --

            If Amazon Lex waits longer than this length of time for a response, it will stop sending messages.

          • allowInterrupt (boolean) --

            Indicates that the user can interrupt the response by speaking while the message is being played.

        • active (boolean) --

          Specifies whether the bot will wait for a user to respond. When this field is false, wait and continue responses for a slot aren't used. If the active field isn't specified, the default is true.

      • slotCaptureSetting (dict) --

        Specifies the settings that Amazon Lex uses when a slot value is successfully entered by a user.

        • captureResponse (dict) --

          Specifies a list of message groups that Amazon Lex uses to respond the user input.

          • messageGroups (list) --

            A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.

            • (dict) --

              Provides one or more messages that Amazon Lex should send to the user.

              • message (dict) --

                The primary message that Amazon Lex should send to the user.

                • plainTextMessage (dict) --

                  A message in plain text format.

                  • value (string) --

                    The message to send to the user.

                • customPayload (dict) --

                  A message in a custom format defined by the client application.

                  • value (string) --

                    The string that is sent to your application.

                • ssmlMessage (dict) --

                  A message in Speech Synthesis Markup Language (SSML).

                  • value (string) --

                    The SSML text that defines the prompt.

                • imageResponseCard (dict) --

                  A message that defines a response card that the client application can show to the user.

                  • title (string) --

                    The title to display on the response card. The format of the title is determined by the platform displaying the response card.

                  • subtitle (string) --

                    The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

                  • imageUrl (string) --

                    The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

                  • buttons (list) --

                    A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.

                    • (dict) --

                      Describes a button to use on a response card used to gather slot values from a user.

                      • text (string) --

                        The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

                      • value (string) --

                        The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

              • variations (list) --

                Message variations to send to the user. When variations are defined, Amazon Lex chooses the primary message or one of the variations to send to the user.

                • (dict) --

                  The object that provides message text and it's type.

                  • plainTextMessage (dict) --

                    A message in plain text format.

                    • value (string) --

                      The message to send to the user.

                  • customPayload (dict) --

                    A message in a custom format defined by the client application.

                    • value (string) --

                      The string that is sent to your application.

                  • ssmlMessage (dict) --

                    A message in Speech Synthesis Markup Language (SSML).

                    • value (string) --

                      The SSML text that defines the prompt.

                  • imageResponseCard (dict) --

                    A message that defines a response card that the client application can show to the user.

                    • title (string) --

                      The title to display on the response card. The format of the title is determined by the platform displaying the response card.

                    • subtitle (string) --

                      The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

                    • imageUrl (string) --

                      The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

                    • buttons (list) --

                      A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.

                      • (dict) --

                        Describes a button to use on a response card used to gather slot values from a user.

                        • text (string) --

                          The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

                        • value (string) --

                          The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

          • allowInterrupt (boolean) --

            Indicates whether the user can interrupt a speech response from Amazon Lex.

        • captureNextStep (dict) --

          Specifies the next step that the bot runs when the slot value is captured before the code hook times out.

          • dialogAction (dict) --

            Defines the action that the bot executes at runtime when the conversation reaches this step.

            • type (string) --

              The action that the bot should execute.

            • slotToElicit (string) --

              If the dialog action is ElicitSlot , defines the slot to elicit from the user.

            • suppressNextMessage (boolean) --

              When true the next message for the intent is not used.

          • intent (dict) --

            Override settings to configure the intent state.

            • name (string) --

              The name of the intent. Only required when you're switching intents.

            • slots (dict) --

              A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.,

              • (string) --

                • (dict) --

                  The slot values that Amazon Lex uses when it sets slot values in a dialog step.

                  • shape (string) --

                    When the shape value is List , it indicates that the values field contains a list of slot values. When the value is Scalar , it indicates that the value field contains a single value.

                  • value (dict) --

                    The current value of the slot.

                    • interpretedValue (string) --

                      The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the resolvedValues list.

                  • values (list) --

                    A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."

                    • (dict) --

                      The slot values that Amazon Lex uses when it sets slot values in a dialog step.

          • sessionAttributes (dict) --

            Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.

            • (string) --

              • (string) --

        • captureConditional (dict) --

          A list of conditional branches to evaluate after the slot value is captured.

          • active (boolean) --

            Determines whether a conditional branch is active. When active is false, the conditions are not evaluated.

          • conditionalBranches (list) --

            A list of conditional branches. A conditional branch is made up of a condition, a response and a next step. The response and next step are executed when the condition is true.

            • (dict) --

              A set of actions that Amazon Lex should run if the condition is matched.

              • name (string) --

                The name of the branch.

              • condition (dict) --

                Contains the expression to evaluate. If the condition is true, the branch's actions are taken.

                • expressionString (string) --

                  The expression string that is evaluated.

              • nextStep (dict) --

                The next step in the conversation.

                • dialogAction (dict) --

                  Defines the action that the bot executes at runtime when the conversation reaches this step.

                  • type (string) --

                    The action that the bot should execute.

                  • slotToElicit (string) --

                    If the dialog action is ElicitSlot , defines the slot to elicit from the user.

                  • suppressNextMessage (boolean) --

                    When true the next message for the intent is not used.

                • intent (dict) --

                  Override settings to configure the intent state.

                  • name (string) --

                    The name of the intent. Only required when you're switching intents.

                  • slots (dict) --

                    A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.,

                    • (string) --

                      • (dict) --

                        The slot values that Amazon Lex uses when it sets slot values in a dialog step.

                        • shape (string) --

                          When the shape value is List , it indicates that the values field contains a list of slot values. When the value is Scalar , it indicates that the value field contains a single value.

                        • value (dict) --

                          The current value of the slot.

                          • interpretedValue (string) --

                            The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the resolvedValues list.

                        • values (list) --

                          A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."

                          • (dict) --

                            The slot values that Amazon Lex uses when it sets slot values in a dialog step.

                • sessionAttributes (dict) --

                  Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.

                  • (string) --

                    • (string) --

              • response (dict) --

                Specifies a list of message groups that Amazon Lex uses to respond the user input.

                • messageGroups (list) --

                  A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.

                  • (dict) --

                    Provides one or more messages that Amazon Lex should send to the user.

                    • message (dict) --

                      The primary message that Amazon Lex should send to the user.

                      • plainTextMessage (dict) --

                        A message in plain text format.

                        • value (string) --

                          The message to send to the user.

                      • customPayload (dict) --

                        A message in a custom format defined by the client application.

                        • value (string) --

                          The string that is sent to your application.

                      • ssmlMessage (dict) --

                        A message in Speech Synthesis Markup Language (SSML).

                        • value (string) --

                          The SSML text that defines the prompt.

                      • imageResponseCard (dict) --

                        A message that defines a response card that the client application can show to the user.

                        • title (string) --

                          The title to display on the response card. The format of the title is determined by the platform displaying the response card.

                        • subtitle (string) --

                          The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

                        • imageUrl (string) --

                          The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

                        • buttons (list) --

                          A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.

                          • (dict) --

                            Describes a button to use on a response card used to gather slot values from a user.

                            • text (string) --

                              The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

                            • value (string) --

                              The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

                    • variations (list) --

                      Message variations to send to the user. When variations are defined, Amazon Lex chooses the primary message or one of the variations to send to the user.

                      • (dict) --

                        The object that provides message text and it's type.

                        • plainTextMessage (dict) --

                          A message in plain text format.

                          • value (string) --

                            The message to send to the user.

                        • customPayload (dict) --

                          A message in a custom format defined by the client application.

                          • value (string) --

                            The string that is sent to your application.

                        • ssmlMessage (dict) --

                          A message in Speech Synthesis Markup Language (SSML).

                          • value (string) --

                            The SSML text that defines the prompt.

                        • imageResponseCard (dict) --

                          A message that defines a response card that the client application can show to the user.

                          • title (string) --

                            The title to display on the response card. The format of the title is determined by the platform displaying the response card.

                          • subtitle (string) --

                            The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

                          • imageUrl (string) --

                            The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

                          • buttons (list) --

                            A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.

                            • (dict) --

                              Describes a button to use on a response card used to gather slot values from a user.

                              • text (string) --

                                The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

                              • value (string) --

                                The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

                • allowInterrupt (boolean) --

                  Indicates whether the user can interrupt a speech response from Amazon Lex.

          • defaultBranch (dict) --

            The conditional branch that should be followed when the conditions for other branches are not satisfied. A conditional branch is made up of a condition, a response and a next step.

            • nextStep (dict) --

              The next step in the conversation.

              • dialogAction (dict) --

                Defines the action that the bot executes at runtime when the conversation reaches this step.

                • type (string) --

                  The action that the bot should execute.

                • slotToElicit (string) --

                  If the dialog action is ElicitSlot , defines the slot to elicit from the user.

                • suppressNextMessage (boolean) --

                  When true the next message for the intent is not used.

              • intent (dict) --

                Override settings to configure the intent state.

                • name (string) --

                  The name of the intent. Only required when you're switching intents.

                • slots (dict) --

                  A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.,

                  • (string) --

                    • (dict) --

                      The slot values that Amazon Lex uses when it sets slot values in a dialog step.

                      • shape (string) --

                        When the shape value is List , it indicates that the values field contains a list of slot values. When the value is Scalar , it indicates that the value field contains a single value.

                      • value (dict) --

                        The current value of the slot.

                        • interpretedValue (string) --

                          The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the resolvedValues list.

                      • values (list) --

                        A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."

                        • (dict) --

                          The slot values that Amazon Lex uses when it sets slot values in a dialog step.

              • sessionAttributes (dict) --

                Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.

                • (string) --

                  • (string) --

            • response (dict) --

              Specifies a list of message groups that Amazon Lex uses to respond the user input.

              • messageGroups (list) --

                A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.

                • (dict) --

                  Provides one or more messages that Amazon Lex should send to the user.

                  • message (dict) --

                    The primary message that Amazon Lex should send to the user.

                    • plainTextMessage (dict) --

                      A message in plain text format.

                      • value (string) --

                        The message to send to the user.

                    • customPayload (dict) --

                      A message in a custom format defined by the client application.

                      • value (string) --

                        The string that is sent to your application.

                    • ssmlMessage (dict) --

                      A message in Speech Synthesis Markup Language (SSML).

                      • value (string) --

                        The SSML text that defines the prompt.

                    • imageResponseCard (dict) --

                      A message that defines a response card that the client application can show to the user.

                      • title (string) --

                        The title to display on the response card. The format of the title is determined by the platform displaying the response card.

                      • subtitle (string) --

                        The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

                      • imageUrl (string) --

                        The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

                      • buttons (list) --

                        A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.

                        • (dict) --

                          Describes a button to use on a response card used to gather slot values from a user.

                          • text (string) --

                            The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

                          • value (string) --

                            The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

                  • variations (list) --

                    Message variations to send to the user. When variations are defined, Amazon Lex chooses the primary message or one of the variations to send to the user.

                    • (dict) --

                      The object that provides message text and it's type.

                      • plainTextMessage (dict) --

                        A message in plain text format.

                        • value (string) --

                          The message to send to the user.

                      • customPayload (dict) --

                        A message in a custom format defined by the client application.

                        • value (string) --

                          The string that is sent to your application.

                      • ssmlMessage (dict) --

                        A message in Speech Synthesis Markup Language (SSML).

                        • value (string) --

                          The SSML text that defines the prompt.

                      • imageResponseCard (dict) --

                        A message that defines a response card that the client application can show to the user.

                        • title (string) --

                          The title to display on the response card. The format of the title is determined by the platform displaying the response card.

                        • subtitle (string) --

                          The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

                        • imageUrl (string) --

                          The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

                        • buttons (list) --

                          A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.

                          • (dict) --

                            Describes a button to use on a response card used to gather slot values from a user.

                            • text (string) --

                              The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

                            • value (string) --

                              The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

              • allowInterrupt (boolean) --

                Indicates whether the user can interrupt a speech response from Amazon Lex.

        • failureResponse (dict) --

          Specifies a list of message groups that Amazon Lex uses to respond the user input.

          • messageGroups (list) --

            A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.

            • (dict) --

              Provides one or more messages that Amazon Lex should send to the user.

              • message (dict) --

                The primary message that Amazon Lex should send to the user.

                • plainTextMessage (dict) --

                  A message in plain text format.

                  • value (string) --

                    The message to send to the user.

                • customPayload (dict) --

                  A message in a custom format defined by the client application.

                  • value (string) --

                    The string that is sent to your application.

                • ssmlMessage (dict) --

                  A message in Speech Synthesis Markup Language (SSML).

                  • value (string) --

                    The SSML text that defines the prompt.

                • imageResponseCard (dict) --

                  A message that defines a response card that the client application can show to the user.

                  • title (string) --

                    The title to display on the response card. The format of the title is determined by the platform displaying the response card.

                  • subtitle (string) --

                    The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

                  • imageUrl (string) --

                    The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

                  • buttons (list) --

                    A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.

                    • (dict) --

                      Describes a button to use on a response card used to gather slot values from a user.

                      • text (string) --

                        The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

                      • value (string) --

                        The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

              • variations (list) --

                Message variations to send to the user. When variations are defined, Amazon Lex chooses the primary message or one of the variations to send to the user.

                • (dict) --

                  The object that provides message text and it's type.

                  • plainTextMessage (dict) --

                    A message in plain text format.

                    • value (string) --

                      The message to send to the user.

                  • customPayload (dict) --

                    A message in a custom format defined by the client application.

                    • value (string) --

                      The string that is sent to your application.

                  • ssmlMessage (dict) --

                    A message in Speech Synthesis Markup Language (SSML).

                    • value (string) --

                      The SSML text that defines the prompt.

                  • imageResponseCard (dict) --

                    A message that defines a response card that the client application can show to the user.

                    • title (string) --

                      The title to display on the response card. The format of the title is determined by the platform displaying the response card.

                    • subtitle (string) --

                      The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

                    • imageUrl (string) --

                      The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

                    • buttons (list) --

                      A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.

                      • (dict) --

                        Describes a button to use on a response card used to gather slot values from a user.

                        • text (string) --

                          The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

                        • value (string) --

                          The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

          • allowInterrupt (boolean) --

            Indicates whether the user can interrupt a speech response from Amazon Lex.

        • failureNextStep (dict) --

          Specifies the next step that the bot runs when the slot value code is not recognized.

          • dialogAction (dict) --

            Defines the action that the bot executes at runtime when the conversation reaches this step.

            • type (string) --

              The action that the bot should execute.

            • slotToElicit (string) --

              If the dialog action is ElicitSlot , defines the slot to elicit from the user.

            • suppressNextMessage (boolean) --

              When true the next message for the intent is not used.

          • intent (dict) --

            Override settings to configure the intent state.

            • name (string) --

              The name of the intent. Only required when you're switching intents.

            • slots (dict) --

              A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.,

              • (string) --

                • (dict) --

                  The slot values that Amazon Lex uses when it sets slot values in a dialog step.

                  • shape (string) --

                    When the shape value is List , it indicates that the values field contains a list of slot values. When the value is Scalar , it indicates that the value field contains a single value.

                  • value (dict) --

                    The current value of the slot.

                    • interpretedValue (string) --

                      The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the resolvedValues list.

                  • values (list) --

                    A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."

                    • (dict) --

                      The slot values that Amazon Lex uses when it sets slot values in a dialog step.

          • sessionAttributes (dict) --

            Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.

            • (string) --

              • (string) --

        • failureConditional (dict) --

          A list of conditional branches to evaluate when the slot value isn't captured.

          • active (boolean) --

            Determines whether a conditional branch is active. When active is false, the conditions are not evaluated.

          • conditionalBranches (list) --

            A list of conditional branches. A conditional branch is made up of a condition, a response and a next step. The response and next step are executed when the condition is true.

            • (dict) --

              A set of actions that Amazon Lex should run if the condition is matched.

              • name (string) --

                The name of the branch.

              • condition (dict) --

                Contains the expression to evaluate. If the condition is true, the branch's actions are taken.

                • expressionString (string) --

                  The expression string that is evaluated.

              • nextStep (dict) --

                The next step in the conversation.

                • dialogAction (dict) --

                  Defines the action that the bot executes at runtime when the conversation reaches this step.

                  • type (string) --

                    The action that the bot should execute.

                  • slotToElicit (string) --

                    If the dialog action is ElicitSlot , defines the slot to elicit from the user.

                  • suppressNextMessage (boolean) --

                    When true the next message for the intent is not used.

                • intent (dict) --

                  Override settings to configure the intent state.

                  • name (string) --

                    The name of the intent. Only required when you're switching intents.

                  • slots (dict) --

                    A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.,

                    • (string) --

                      • (dict) --

                        The slot values that Amazon Lex uses when it sets slot values in a dialog step.

                        • shape (string) --

                          When the shape value is List , it indicates that the values field contains a list of slot values. When the value is Scalar , it indicates that the value field contains a single value.

                        • value (dict) --

                          The current value of the slot.

                          • interpretedValue (string) --

                            The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the resolvedValues list.

                        • values (list) --

                          A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."

                          • (dict) --

                            The slot values that Amazon Lex uses when it sets slot values in a dialog step.

                • sessionAttributes (dict) --

                  Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.

                  • (string) --

                    • (string) --

              • response (dict) --

                Specifies a list of message groups that Amazon Lex uses to respond the user input.

                • messageGroups (list) --

                  A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.

                  • (dict) --

                    Provides one or more messages that Amazon Lex should send to the user.

                    • message (dict) --

                      The primary message that Amazon Lex should send to the user.

                      • plainTextMessage (dict) --

                        A message in plain text format.

                        • value (string) --

                          The message to send to the user.

                      • customPayload (dict) --

                        A message in a custom format defined by the client application.

                        • value (string) --

                          The string that is sent to your application.

                      • ssmlMessage (dict) --

                        A message in Speech Synthesis Markup Language (SSML).

                        • value (string) --

                          The SSML text that defines the prompt.

                      • imageResponseCard (dict) --

                        A message that defines a response card that the client application can show to the user.

                        • title (string) --

                          The title to display on the response card. The format of the title is determined by the platform displaying the response card.

                        • subtitle (string) --

                          The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

                        • imageUrl (string) --

                          The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

                        • buttons (list) --

                          A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.

                          • (dict) --

                            Describes a button to use on a response card used to gather slot values from a user.

                            • text (string) --

                              The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

                            • value (string) --

                              The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

                    • variations (list) --

                      Message variations to send to the user. When variations are defined, Amazon Lex chooses the primary message or one of the variations to send to the user.

                      • (dict) --

                        The object that provides message text and it's type.

                        • plainTextMessage (dict) --

                          A message in plain text format.

                          • value (string) --

                            The message to send to the user.

                        • customPayload (dict) --

                          A message in a custom format defined by the client application.

                          • value (string) --

                            The string that is sent to your application.

                        • ssmlMessage (dict) --

                          A message in Speech Synthesis Markup Language (SSML).

                          • value (string) --

                            The SSML text that defines the prompt.

                        • imageResponseCard (dict) --

                          A message that defines a response card that the client application can show to the user.

                          • title (string) --

                            The title to display on the response card. The format of the title is determined by the platform displaying the response card.

                          • subtitle (string) --

                            The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

                          • imageUrl (string) --

                            The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

                          • buttons (list) --

                            A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.

                            • (dict) --

                              Describes a button to use on a response card used to gather slot values from a user.

                              • text (string) --

                                The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

                              • value (string) --

                                The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

                • allowInterrupt (boolean) --

                  Indicates whether the user can interrupt a speech response from Amazon Lex.

          • defaultBranch (dict) --

            The conditional branch that should be followed when the conditions for other branches are not satisfied. A conditional branch is made up of a condition, a response and a next step.

            • nextStep (dict) --

              The next step in the conversation.

              • dialogAction (dict) --

                Defines the action that the bot executes at runtime when the conversation reaches this step.

                • type (string) --

                  The action that the bot should execute.

                • slotToElicit (string) --

                  If the dialog action is ElicitSlot , defines the slot to elicit from the user.

                • suppressNextMessage (boolean) --

                  When true the next message for the intent is not used.

              • intent (dict) --

                Override settings to configure the intent state.

                • name (string) --

                  The name of the intent. Only required when you're switching intents.

                • slots (dict) --

                  A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.,

                  • (string) --

                    • (dict) --

                      The slot values that Amazon Lex uses when it sets slot values in a dialog step.

                      • shape (string) --

                        When the shape value is List , it indicates that the values field contains a list of slot values. When the value is Scalar , it indicates that the value field contains a single value.

                      • value (dict) --

                        The current value of the slot.

                        • interpretedValue (string) --

                          The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the resolvedValues list.

                      • values (list) --

                        A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."

                        • (dict) --

                          The slot values that Amazon Lex uses when it sets slot values in a dialog step.

              • sessionAttributes (dict) --

                Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.

                • (string) --

                  • (string) --

            • response (dict) --

              Specifies a list of message groups that Amazon Lex uses to respond the user input.

              • messageGroups (list) --

                A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.

                • (dict) --

                  Provides one or more messages that Amazon Lex should send to the user.

                  • message (dict) --

                    The primary message that Amazon Lex should send to the user.

                    • plainTextMessage (dict) --

                      A message in plain text format.

                      • value (string) --

                        The message to send to the user.

                    • customPayload (dict) --

                      A message in a custom format defined by the client application.

                      • value (string) --

                        The string that is sent to your application.

                    • ssmlMessage (dict) --

                      A message in Speech Synthesis Markup Language (SSML).

                      • value (string) --

                        The SSML text that defines the prompt.

                    • imageResponseCard (dict) --

                      A message that defines a response card that the client application can show to the user.

                      • title (string) --

                        The title to display on the response card. The format of the title is determined by the platform displaying the response card.

                      • subtitle (string) --

                        The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

                      • imageUrl (string) --

                        The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

                      • buttons (list) --

                        A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.

                        • (dict) --

                          Describes a button to use on a response card used to gather slot values from a user.

                          • text (string) --

                            The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

                          • value (string) --

                            The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

                  • variations (list) --

                    Message variations to send to the user. When variations are defined, Amazon Lex chooses the primary message or one of the variations to send to the user.

                    • (dict) --

                      The object that provides message text and it's type.

                      • plainTextMessage (dict) --

                        A message in plain text format.

                        • value (string) --

                          The message to send to the user.

                      • customPayload (dict) --

                        A message in a custom format defined by the client application.

                        • value (string) --

                          The string that is sent to your application.

                      • ssmlMessage (dict) --

                        A message in Speech Synthesis Markup Language (SSML).

                        • value (string) --

                          The SSML text that defines the prompt.

                      • imageResponseCard (dict) --

                        A message that defines a response card that the client application can show to the user.

                        • title (string) --

                          The title to display on the response card. The format of the title is determined by the platform displaying the response card.

                        • subtitle (string) --

                          The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

                        • imageUrl (string) --

                          The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

                        • buttons (list) --

                          A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.

                          • (dict) --

                            Describes a button to use on a response card used to gather slot values from a user.

                            • text (string) --

                              The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

                            • value (string) --

                              The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

              • allowInterrupt (boolean) --

                Indicates whether the user can interrupt a speech response from Amazon Lex.

        • codeHook (dict) --

          Code hook called after Amazon Lex successfully captures a slot value.

          • enableCodeHookInvocation (boolean) --

            Indicates whether a Lambda function should be invoked for the dialog.

          • active (boolean) --

            Determines whether a dialog code hook is used when the intent is activated.

          • invocationLabel (string) --

            A label that indicates the dialog step from which the dialog code hook is happening.

          • postCodeHookSpecification (dict) --

            Contains the responses and actions that Amazon Lex takes after the Lambda function is complete.

            • successResponse (dict) --

              Specifies a list of message groups that Amazon Lex uses to respond the user input.

              • messageGroups (list) --

                A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.

                • (dict) --

                  Provides one or more messages that Amazon Lex should send to the user.

                  • message (dict) --

                    The primary message that Amazon Lex should send to the user.

                    • plainTextMessage (dict) --

                      A message in plain text format.

                      • value (string) --

                        The message to send to the user.

                    • customPayload (dict) --

                      A message in a custom format defined by the client application.

                      • value (string) --

                        The string that is sent to your application.

                    • ssmlMessage (dict) --

                      A message in Speech Synthesis Markup Language (SSML).

                      • value (string) --

                        The SSML text that defines the prompt.

                    • imageResponseCard (dict) --

                      A message that defines a response card that the client application can show to the user.

                      • title (string) --

                        The title to display on the response card. The format of the title is determined by the platform displaying the response card.

                      • subtitle (string) --

                        The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

                      • imageUrl (string) --

                        The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

                      • buttons (list) --

                        A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.

                        • (dict) --

                          Describes a button to use on a response card used to gather slot values from a user.

                          • text (string) --

                            The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

                          • value (string) --

                            The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

                  • variations (list) --

                    Message variations to send to the user. When variations are defined, Amazon Lex chooses the primary message or one of the variations to send to the user.

                    • (dict) --

                      The object that provides message text and it's type.

                      • plainTextMessage (dict) --

                        A message in plain text format.

                        • value (string) --

                          The message to send to the user.

                      • customPayload (dict) --

                        A message in a custom format defined by the client application.

                        • value (string) --

                          The string that is sent to your application.

                      • ssmlMessage (dict) --

                        A message in Speech Synthesis Markup Language (SSML).

                        • value (string) --

                          The SSML text that defines the prompt.

                      • imageResponseCard (dict) --

                        A message that defines a response card that the client application can show to the user.

                        • title (string) --

                          The title to display on the response card. The format of the title is determined by the platform displaying the response card.

                        • subtitle (string) --

                          The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

                        • imageUrl (string) --

                          The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

                        • buttons (list) --

                          A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.

                          • (dict) --

                            Describes a button to use on a response card used to gather slot values from a user.

                            • text (string) --

                              The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

                            • value (string) --

                              The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

              • allowInterrupt (boolean) --

                Indicates whether the user can interrupt a speech response from Amazon Lex.

            • successNextStep (dict) --

              Specifics the next step the bot runs after the dialog code hook finishes successfully.

              • dialogAction (dict) --

                Defines the action that the bot executes at runtime when the conversation reaches this step.

                • type (string) --

                  The action that the bot should execute.

                • slotToElicit (string) --

                  If the dialog action is ElicitSlot , defines the slot to elicit from the user.

                • suppressNextMessage (boolean) --

                  When true the next message for the intent is not used.

              • intent (dict) --

                Override settings to configure the intent state.

                • name (string) --

                  The name of the intent. Only required when you're switching intents.

                • slots (dict) --

                  A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.,

                  • (string) --

                    • (dict) --

                      The slot values that Amazon Lex uses when it sets slot values in a dialog step.

                      • shape (string) --

                        When the shape value is List , it indicates that the values field contains a list of slot values. When the value is Scalar , it indicates that the value field contains a single value.

                      • value (dict) --

                        The current value of the slot.

                        • interpretedValue (string) --

                          The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the resolvedValues list.

                      • values (list) --

                        A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."

                        • (dict) --

                          The slot values that Amazon Lex uses when it sets slot values in a dialog step.

              • sessionAttributes (dict) --

                Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.

                • (string) --

                  • (string) --

            • successConditional (dict) --

              A list of conditional branches to evaluate after the dialog code hook finishes successfully.

              • active (boolean) --

                Determines whether a conditional branch is active. When active is false, the conditions are not evaluated.

              • conditionalBranches (list) --

                A list of conditional branches. A conditional branch is made up of a condition, a response and a next step. The response and next step are executed when the condition is true.

                • (dict) --

                  A set of actions that Amazon Lex should run if the condition is matched.

                  • name (string) --

                    The name of the branch.

                  • condition (dict) --

                    Contains the expression to evaluate. If the condition is true, the branch's actions are taken.

                    • expressionString (string) --

                      The expression string that is evaluated.

                  • nextStep (dict) --

                    The next step in the conversation.

                    • dialogAction (dict) --

                      Defines the action that the bot executes at runtime when the conversation reaches this step.

                      • type (string) --

                        The action that the bot should execute.

                      • slotToElicit (string) --

                        If the dialog action is ElicitSlot , defines the slot to elicit from the user.

                      • suppressNextMessage (boolean) --

                        When true the next message for the intent is not used.

                    • intent (dict) --

                      Override settings to configure the intent state.

                      • name (string) --

                        The name of the intent. Only required when you're switching intents.

                      • slots (dict) --

                        A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.,

                        • (string) --

                          • (dict) --

                            The slot values that Amazon Lex uses when it sets slot values in a dialog step.

                            • shape (string) --

                              When the shape value is List , it indicates that the values field contains a list of slot values. When the value is Scalar , it indicates that the value field contains a single value.

                            • value (dict) --

                              The current value of the slot.

                              • interpretedValue (string) --

                                The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the resolvedValues list.

                            • values (list) --

                              A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."

                              • (dict) --

                                The slot values that Amazon Lex uses when it sets slot values in a dialog step.

                    • sessionAttributes (dict) --

                      Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.

                      • (string) --

                        • (string) --

                  • response (dict) --

                    Specifies a list of message groups that Amazon Lex uses to respond the user input.

                    • messageGroups (list) --

                      A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.

                      • (dict) --

                        Provides one or more messages that Amazon Lex should send to the user.

                        • message (dict) --

                          The primary message that Amazon Lex should send to the user.

                          • plainTextMessage (dict) --

                            A message in plain text format.

                            • value (string) --

                              The message to send to the user.

                          • customPayload (dict) --

                            A message in a custom format defined by the client application.

                            • value (string) --

                              The string that is sent to your application.

                          • ssmlMessage (dict) --

                            A message in Speech Synthesis Markup Language (SSML).

                            • value (string) --

                              The SSML text that defines the prompt.

                          • imageResponseCard (dict) --

                            A message that defines a response card that the client application can show to the user.

                            • title (string) --

                              The title to display on the response card. The format of the title is determined by the platform displaying the response card.

                            • subtitle (string) --

                              The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

                            • imageUrl (string) --

                              The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

                            • buttons (list) --

                              A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.

                              • (dict) --

                                Describes a button to use on a response card used to gather slot values from a user.

                                • text (string) --

                                  The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

                                • value (string) --

                                  The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

                        • variations (list) --

                          Message variations to send to the user. When variations are defined, Amazon Lex chooses the primary message or one of the variations to send to the user.

                          • (dict) --

                            The object that provides message text and it's type.

                            • plainTextMessage (dict) --

                              A message in plain text format.

                              • value (string) --

                                The message to send to the user.

                            • customPayload (dict) --

                              A message in a custom format defined by the client application.

                              • value (string) --

                                The string that is sent to your application.

                            • ssmlMessage (dict) --

                              A message in Speech Synthesis Markup Language (SSML).

                              • value (string) --

                                The SSML text that defines the prompt.

                            • imageResponseCard (dict) --

                              A message that defines a response card that the client application can show to the user.

                              • title (string) --

                                The title to display on the response card. The format of the title is determined by the platform displaying the response card.

                              • subtitle (string) --

                                The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

                              • imageUrl (string) --

                                The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

                              • buttons (list) --

                                A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.

                                • (dict) --

                                  Describes a button to use on a response card used to gather slot values from a user.

                                  • text (string) --

                                    The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

                                  • value (string) --

                                    The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

                    • allowInterrupt (boolean) --

                      Indicates whether the user can interrupt a speech response from Amazon Lex.

              • defaultBranch (dict) --

                The conditional branch that should be followed when the conditions for other branches are not satisfied. A conditional branch is made up of a condition, a response and a next step.

                • nextStep (dict) --

                  The next step in the conversation.

                  • dialogAction (dict) --

                    Defines the action that the bot executes at runtime when the conversation reaches this step.

                    • type (string) --

                      The action that the bot should execute.

                    • slotToElicit (string) --

                      If the dialog action is ElicitSlot , defines the slot to elicit from the user.

                    • suppressNextMessage (boolean) --

                      When true the next message for the intent is not used.

                  • intent (dict) --

                    Override settings to configure the intent state.

                    • name (string) --

                      The name of the intent. Only required when you're switching intents.

                    • slots (dict) --

                      A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.,

                      • (string) --

                        • (dict) --

                          The slot values that Amazon Lex uses when it sets slot values in a dialog step.

                          • shape (string) --

                            When the shape value is List , it indicates that the values field contains a list of slot values. When the value is Scalar , it indicates that the value field contains a single value.

                          • value (dict) --

                            The current value of the slot.

                            • interpretedValue (string) --

                              The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the resolvedValues list.

                          • values (list) --

                            A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."

                            • (dict) --

                              The slot values that Amazon Lex uses when it sets slot values in a dialog step.

                  • sessionAttributes (dict) --

                    Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.

                    • (string) --

                      • (string) --

                • response (dict) --

                  Specifies a list of message groups that Amazon Lex uses to respond the user input.

                  • messageGroups (list) --

                    A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.

                    • (dict) --

                      Provides one or more messages that Amazon Lex should send to the user.

                      • message (dict) --

                        The primary message that Amazon Lex should send to the user.

                        • plainTextMessage (dict) --

                          A message in plain text format.

                          • value (string) --

                            The message to send to the user.

                        • customPayload (dict) --

                          A message in a custom format defined by the client application.

                          • value (string) --

                            The string that is sent to your application.

                        • ssmlMessage (dict) --

                          A message in Speech Synthesis Markup Language (SSML).

                          • value (string) --

                            The SSML text that defines the prompt.

                        • imageResponseCard (dict) --

                          A message that defines a response card that the client application can show to the user.

                          • title (string) --

                            The title to display on the response card. The format of the title is determined by the platform displaying the response card.

                          • subtitle (string) --

                            The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

                          • imageUrl (string) --

                            The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

                          • buttons (list) --

                            A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.

                            • (dict) --

                              Describes a button to use on a response card used to gather slot values from a user.

                              • text (string) --

                                The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

                              • value (string) --

                                The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

                      • variations (list) --

                        Message variations to send to the user. When variations are defined, Amazon Lex chooses the primary message or one of the variations to send to the user.

                        • (dict) --

                          The object that provides message text and it's type.

                          • plainTextMessage (dict) --

                            A message in plain text format.

                            • value (string) --

                              The message to send to the user.

                          • customPayload (dict) --

                            A message in a custom format defined by the client application.

                            • value (string) --

                              The string that is sent to your application.

                          • ssmlMessage (dict) --

                            A message in Speech Synthesis Markup Language (SSML).

                            • value (string) --

                              The SSML text that defines the prompt.

                          • imageResponseCard (dict) --

                            A message that defines a response card that the client application can show to the user.

                            • title (string) --

                              The title to display on the response card. The format of the title is determined by the platform displaying the response card.

                            • subtitle (string) --

                              The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

                            • imageUrl (string) --

                              The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

                            • buttons (list) --

                              A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.

                              • (dict) --

                                Describes a button to use on a response card used to gather slot values from a user.

                                • text (string) --

                                  The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

                                • value (string) --

                                  The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

                  • allowInterrupt (boolean) --

                    Indicates whether the user can interrupt a speech response from Amazon Lex.

            • failureResponse (dict) --

              Specifies a list of message groups that Amazon Lex uses to respond the user input.

              • messageGroups (list) --

                A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.

                • (dict) --

                  Provides one or more messages that Amazon Lex should send to the user.

                  • message (dict) --

                    The primary message that Amazon Lex should send to the user.

                    • plainTextMessage (dict) --

                      A message in plain text format.

                      • value (string) --

                        The message to send to the user.

                    • customPayload (dict) --

                      A message in a custom format defined by the client application.

                      • value (string) --

                        The string that is sent to your application.

                    • ssmlMessage (dict) --

                      A message in Speech Synthesis Markup Language (SSML).

                      • value (string) --

                        The SSML text that defines the prompt.

                    • imageResponseCard (dict) --

                      A message that defines a response card that the client application can show to the user.

                      • title (string) --

                        The title to display on the response card. The format of the title is determined by the platform displaying the response card.

                      • subtitle (string) --

                        The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

                      • imageUrl (string) --

                        The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

                      • buttons (list) --

                        A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.

                        • (dict) --

                          Describes a button to use on a response card used to gather slot values from a user.

                          • text (string) --

                            The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

                          • value (string) --

                            The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

                  • variations (list) --

                    Message variations to send to the user. When variations are defined, Amazon Lex chooses the primary message or one of the variations to send to the user.

                    • (dict) --

                      The object that provides message text and it's type.

                      • plainTextMessage (dict) --

                        A message in plain text format.

                        • value (string) --

                          The message to send to the user.

                      • customPayload (dict) --

                        A message in a custom format defined by the client application.

                        • value (string) --

                          The string that is sent to your application.

                      • ssmlMessage (dict) --

                        A message in Speech Synthesis Markup Language (SSML).

                        • value (string) --

                          The SSML text that defines the prompt.

                      • imageResponseCard (dict) --

                        A message that defines a response card that the client application can show to the user.

                        • title (string) --

                          The title to display on the response card. The format of the title is determined by the platform displaying the response card.

                        • subtitle (string) --

                          The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

                        • imageUrl (string) --

                          The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

                        • buttons (list) --

                          A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.

                          • (dict) --

                            Describes a button to use on a response card used to gather slot values from a user.

                            • text (string) --

                              The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

                            • value (string) --

                              The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

              • allowInterrupt (boolean) --

                Indicates whether the user can interrupt a speech response from Amazon Lex.

            • failureNextStep (dict) --

              Specifies the next step the bot runs after the dialog code hook throws an exception or returns with the State field of the Intent object set to Failed .

              • dialogAction (dict) --

                Defines the action that the bot executes at runtime when the conversation reaches this step.

                • type (string) --

                  The action that the bot should execute.

                • slotToElicit (string) --

                  If the dialog action is ElicitSlot , defines the slot to elicit from the user.

                • suppressNextMessage (boolean) --

                  When true the next message for the intent is not used.

              • intent (dict) --

                Override settings to configure the intent state.

                • name (string) --

                  The name of the intent. Only required when you're switching intents.

                • slots (dict) --

                  A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.,

                  • (string) --

                    • (dict) --

                      The slot values that Amazon Lex uses when it sets slot values in a dialog step.

                      • shape (string) --

                        When the shape value is List , it indicates that the values field contains a list of slot values. When the value is Scalar , it indicates that the value field contains a single value.

                      • value (dict) --

                        The current value of the slot.

                        • interpretedValue (string) --

                          The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the resolvedValues list.

                      • values (list) --

                        A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."

                        • (dict) --

                          The slot values that Amazon Lex uses when it sets slot values in a dialog step.

              • sessionAttributes (dict) --

                Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.

                • (string) --

                  • (string) --

            • failureConditional (dict) --

              A list of conditional branches to evaluate after the dialog code hook throws an exception or returns with the State field of the Intent object set to Failed .

              • active (boolean) --

                Determines whether a conditional branch is active. When active is false, the conditions are not evaluated.

              • conditionalBranches (list) --

                A list of conditional branches. A conditional branch is made up of a condition, a response and a next step. The response and next step are executed when the condition is true.

                • (dict) --

                  A set of actions that Amazon Lex should run if the condition is matched.

                  • name (string) --

                    The name of the branch.

                  • condition (dict) --

                    Contains the expression to evaluate. If the condition is true, the branch's actions are taken.

                    • expressionString (string) --

                      The expression string that is evaluated.

                  • nextStep (dict) --

                    The next step in the conversation.

                    • dialogAction (dict) --

                      Defines the action that the bot executes at runtime when the conversation reaches this step.

                      • type (string) --

                        The action that the bot should execute.

                      • slotToElicit (string) --

                        If the dialog action is ElicitSlot , defines the slot to elicit from the user.

                      • suppressNextMessage (boolean) --

                        When true the next message for the intent is not used.

                    • intent (dict) --

                      Override settings to configure the intent state.

                      • name (string) --

                        The name of the intent. Only required when you're switching intents.

                      • slots (dict) --

                        A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.,

                        • (string) --

                          • (dict) --

                            The slot values that Amazon Lex uses when it sets slot values in a dialog step.

                            • shape (string) --

                              When the shape value is List , it indicates that the values field contains a list of slot values. When the value is Scalar , it indicates that the value field contains a single value.

                            • value (dict) --

                              The current value of the slot.

                              • interpretedValue (string) --

                                The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the resolvedValues list.

                            • values (list) --

                              A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."

                              • (dict) --

                                The slot values that Amazon Lex uses when it sets slot values in a dialog step.

                    • sessionAttributes (dict) --

                      Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.

                      • (string) --

                        • (string) --

                  • response (dict) --

                    Specifies a list of message groups that Amazon Lex uses to respond the user input.

                    • messageGroups (list) --

                      A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.

                      • (dict) --

                        Provides one or more messages that Amazon Lex should send to the user.

                        • message (dict) --

                          The primary message that Amazon Lex should send to the user.

                          • plainTextMessage (dict) --

                            A message in plain text format.

                            • value (string) --

                              The message to send to the user.

                          • customPayload (dict) --

                            A message in a custom format defined by the client application.

                            • value (string) --

                              The string that is sent to your application.

                          • ssmlMessage (dict) --

                            A message in Speech Synthesis Markup Language (SSML).

                            • value (string) --

                              The SSML text that defines the prompt.

                          • imageResponseCard (dict) --

                            A message that defines a response card that the client application can show to the user.

                            • title (string) --

                              The title to display on the response card. The format of the title is determined by the platform displaying the response card.

                            • subtitle (string) --

                              The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

                            • imageUrl (string) --

                              The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

                            • buttons (list) --

                              A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.

                              • (dict) --

                                Describes a button to use on a response card used to gather slot values from a user.

                                • text (string) --

                                  The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

                                • value (string) --

                                  The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

                        • variations (list) --

                          Message variations to send to the user. When variations are defined, Amazon Lex chooses the primary message or one of the variations to send to the user.

                          • (dict) --

                            The object that provides message text and it's type.

                            • plainTextMessage (dict) --

                              A message in plain text format.

                              • value (string) --

                                The message to send to the user.

                            • customPayload (dict) --

                              A message in a custom format defined by the client application.

                              • value (string) --

                                The string that is sent to your application.

                            • ssmlMessage (dict) --

                              A message in Speech Synthesis Markup Language (SSML).

                              • value (string) --

                                The SSML text that defines the prompt.

                            • imageResponseCard (dict) --

                              A message that defines a response card that the client application can show to the user.

                              • title (string) --

                                The title to display on the response card. The format of the title is determined by the platform displaying the response card.

                              • subtitle (string) --

                                The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

                              • imageUrl (string) --

                                The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

                              • buttons (list) --

                                A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.

                                • (dict) --

                                  Describes a button to use on a response card used to gather slot values from a user.

                                  • text (string) --

                                    The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

                                  • value (string) --

                                    The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

                    • allowInterrupt (boolean) --

                      Indicates whether the user can interrupt a speech response from Amazon Lex.

              • defaultBranch (dict) --

                The conditional branch that should be followed when the conditions for other branches are not satisfied. A conditional branch is made up of a condition, a response and a next step.

                • nextStep (dict) --

                  The next step in the conversation.

                  • dialogAction (dict) --

                    Defines the action that the bot executes at runtime when the conversation reaches this step.

                    • type (string) --

                      The action that the bot should execute.

                    • slotToElicit (string) --

                      If the dialog action is ElicitSlot , defines the slot to elicit from the user.

                    • suppressNextMessage (boolean) --

                      When true the next message for the intent is not used.

                  • intent (dict) --

                    Override settings to configure the intent state.

                    • name (string) --

                      The name of the intent. Only required when you're switching intents.

                    • slots (dict) --

                      A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.,

                      • (string) --

                        • (dict) --

                          The slot values that Amazon Lex uses when it sets slot values in a dialog step.

                          • shape (string) --

                            When the shape value is List , it indicates that the values field contains a list of slot values. When the value is Scalar , it indicates that the value field contains a single value.

                          • value (dict) --

                            The current value of the slot.

                            • interpretedValue (string) --

                              The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the resolvedValues list.

                          • values (list) --

                            A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."

                            • (dict) --

                              The slot values that Amazon Lex uses when it sets slot values in a dialog step.

                  • sessionAttributes (dict) --

                    Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.

                    • (string) --

                      • (string) --

                • response (dict) --

                  Specifies a list of message groups that Amazon Lex uses to respond the user input.

                  • messageGroups (list) --

                    A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.

                    • (dict) --

                      Provides one or more messages that Amazon Lex should send to the user.

                      • message (dict) --

                        The primary message that Amazon Lex should send to the user.

                        • plainTextMessage (dict) --

                          A message in plain text format.

                          • value (string) --

                            The message to send to the user.

                        • customPayload (dict) --

                          A message in a custom format defined by the client application.

                          • value (string) --

                            The string that is sent to your application.

                        • ssmlMessage (dict) --

                          A message in Speech Synthesis Markup Language (SSML).

                          • value (string) --

                            The SSML text that defines the prompt.

                        • imageResponseCard (dict) --

                          A message that defines a response card that the client application can show to the user.

                          • title (string) --

                            The title to display on the response card. The format of the title is determined by the platform displaying the response card.

                          • subtitle (string) --

                            The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

                          • imageUrl (string) --

                            The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

                          • buttons (list) --

                            A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.

                            • (dict) --

                              Describes a button to use on a response card used to gather slot values from a user.

                              • text (string) --

                                The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

                              • value (string) --

                                The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

                      • variations (list) --

                        Message variations to send to the user. When variations are defined, Amazon Lex chooses the primary message or one of the variations to send to the user.

                        • (dict) --

                          The object that provides message text and it's type.

                          • plainTextMessage (dict) --

                            A message in plain text format.

                            • value (string) --

                              The message to send to the user.

                          • customPayload (dict) --

                            A message in a custom format defined by the client application.

                            • value (string) --

                              The string that is sent to your application.

                          • ssmlMessage (dict) --

                            A message in Speech Synthesis Markup Language (SSML).

                            • value (string) --

                              The SSML text that defines the prompt.

                          • imageResponseCard (dict) --

                            A message that defines a response card that the client application can show to the user.

                            • title (string) --

                              The title to display on the response card. The format of the title is determined by the platform displaying the response card.

                            • subtitle (string) --

                              The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

                            • imageUrl (string) --

                              The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

                            • buttons (list) --

                              A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.

                              • (dict) --

                                Describes a button to use on a response card used to gather slot values from a user.

                                • text (string) --

                                  The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

                                • value (string) --

                                  The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

                  • allowInterrupt (boolean) --

                    Indicates whether the user can interrupt a speech response from Amazon Lex.

            • timeoutResponse (dict) --

              Specifies a list of message groups that Amazon Lex uses to respond the user input.

              • messageGroups (list) --

                A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.

                • (dict) --

                  Provides one or more messages that Amazon Lex should send to the user.

                  • message (dict) --

                    The primary message that Amazon Lex should send to the user.

                    • plainTextMessage (dict) --

                      A message in plain text format.

                      • value (string) --

                        The message to send to the user.

                    • customPayload (dict) --

                      A message in a custom format defined by the client application.

                      • value (string) --

                        The string that is sent to your application.

                    • ssmlMessage (dict) --

                      A message in Speech Synthesis Markup Language (SSML).

                      • value (string) --

                        The SSML text that defines the prompt.

                    • imageResponseCard (dict) --

                      A message that defines a response card that the client application can show to the user.

                      • title (string) --

                        The title to display on the response card. The format of the title is determined by the platform displaying the response card.

                      • subtitle (string) --

                        The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

                      • imageUrl (string) --

                        The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

                      • buttons (list) --

                        A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.

                        • (dict) --

                          Describes a button to use on a response card used to gather slot values from a user.

                          • text (string) --

                            The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

                          • value (string) --

                            The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

                  • variations (list) --

                    Message variations to send to the user. When variations are defined, Amazon Lex chooses the primary message or one of the variations to send to the user.

                    • (dict) --

                      The object that provides message text and it's type.

                      • plainTextMessage (dict) --

                        A message in plain text format.

                        • value (string) --

                          The message to send to the user.

                      • customPayload (dict) --

                        A message in a custom format defined by the client application.

                        • value (string) --

                          The string that is sent to your application.

                      • ssmlMessage (dict) --

                        A message in Speech Synthesis Markup Language (SSML).

                        • value (string) --

                          The SSML text that defines the prompt.

                      • imageResponseCard (dict) --

                        A message that defines a response card that the client application can show to the user.

                        • title (string) --

                          The title to display on the response card. The format of the title is determined by the platform displaying the response card.

                        • subtitle (string) --

                          The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

                        • imageUrl (string) --

                          The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

                        • buttons (list) --

                          A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.

                          • (dict) --

                            Describes a button to use on a response card used to gather slot values from a user.

                            • text (string) --

                              The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

                            • value (string) --

                              The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

              • allowInterrupt (boolean) --

                Indicates whether the user can interrupt a speech response from Amazon Lex.

            • timeoutNextStep (dict) --

              Specifies the next step that the bot runs when the code hook times out.

              • dialogAction (dict) --

                Defines the action that the bot executes at runtime when the conversation reaches this step.

                • type (string) --

                  The action that the bot should execute.

                • slotToElicit (string) --

                  If the dialog action is ElicitSlot , defines the slot to elicit from the user.

                • suppressNextMessage (boolean) --

                  When true the next message for the intent is not used.

              • intent (dict) --

                Override settings to configure the intent state.

                • name (string) --

                  The name of the intent. Only required when you're switching intents.

                • slots (dict) --

                  A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.,

                  • (string) --

                    • (dict) --

                      The slot values that Amazon Lex uses when it sets slot values in a dialog step.

                      • shape (string) --

                        When the shape value is List , it indicates that the values field contains a list of slot values. When the value is Scalar , it indicates that the value field contains a single value.

                      • value (dict) --

                        The current value of the slot.

                        • interpretedValue (string) --

                          The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the resolvedValues list.

                      • values (list) --

                        A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."

                        • (dict) --

                          The slot values that Amazon Lex uses when it sets slot values in a dialog step.

              • sessionAttributes (dict) --

                Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.

                • (string) --

                  • (string) --

            • timeoutConditional (dict) --

              A list of conditional branches to evaluate if the code hook times out.

              • active (boolean) --

                Determines whether a conditional branch is active. When active is false, the conditions are not evaluated.

              • conditionalBranches (list) --

                A list of conditional branches. A conditional branch is made up of a condition, a response and a next step. The response and next step are executed when the condition is true.

                • (dict) --

                  A set of actions that Amazon Lex should run if the condition is matched.

                  • name (string) --

                    The name of the branch.

                  • condition (dict) --

                    Contains the expression to evaluate. If the condition is true, the branch's actions are taken.

                    • expressionString (string) --

                      The expression string that is evaluated.

                  • nextStep (dict) --

                    The next step in the conversation.

                    • dialogAction (dict) --

                      Defines the action that the bot executes at runtime when the conversation reaches this step.

                      • type (string) --

                        The action that the bot should execute.

                      • slotToElicit (string) --

                        If the dialog action is ElicitSlot , defines the slot to elicit from the user.

                      • suppressNextMessage (boolean) --

                        When true the next message for the intent is not used.

                    • intent (dict) --

                      Override settings to configure the intent state.

                      • name (string) --

                        The name of the intent. Only required when you're switching intents.

                      • slots (dict) --

                        A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.,

                        • (string) --

                          • (dict) --

                            The slot values that Amazon Lex uses when it sets slot values in a dialog step.

                            • shape (string) --

                              When the shape value is List , it indicates that the values field contains a list of slot values. When the value is Scalar , it indicates that the value field contains a single value.

                            • value (dict) --

                              The current value of the slot.

                              • interpretedValue (string) --

                                The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the resolvedValues list.

                            • values (list) --

                              A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."

                              • (dict) --

                                The slot values that Amazon Lex uses when it sets slot values in a dialog step.

                    • sessionAttributes (dict) --

                      Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.

                      • (string) --

                        • (string) --

                  • response (dict) --

                    Specifies a list of message groups that Amazon Lex uses to respond the user input.

                    • messageGroups (list) --

                      A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.

                      • (dict) --

                        Provides one or more messages that Amazon Lex should send to the user.

                        • message (dict) --

                          The primary message that Amazon Lex should send to the user.

                          • plainTextMessage (dict) --

                            A message in plain text format.

                            • value (string) --

                              The message to send to the user.

                          • customPayload (dict) --

                            A message in a custom format defined by the client application.

                            • value (string) --

                              The string that is sent to your application.

                          • ssmlMessage (dict) --

                            A message in Speech Synthesis Markup Language (SSML).

                            • value (string) --

                              The SSML text that defines the prompt.

                          • imageResponseCard (dict) --

                            A message that defines a response card that the client application can show to the user.

                            • title (string) --

                              The title to display on the response card. The format of the title is determined by the platform displaying the response card.

                            • subtitle (string) --

                              The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

                            • imageUrl (string) --

                              The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

                            • buttons (list) --

                              A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.

                              • (dict) --

                                Describes a button to use on a response card used to gather slot values from a user.

                                • text (string) --

                                  The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

                                • value (string) --

                                  The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

                        • variations (list) --

                          Message variations to send to the user. When variations are defined, Amazon Lex chooses the primary message or one of the variations to send to the user.

                          • (dict) --

                            The object that provides message text and it's type.

                            • plainTextMessage (dict) --

                              A message in plain text format.

                              • value (string) --

                                The message to send to the user.

                            • customPayload (dict) --

                              A message in a custom format defined by the client application.

                              • value (string) --

                                The string that is sent to your application.

                            • ssmlMessage (dict) --

                              A message in Speech Synthesis Markup Language (SSML).

                              • value (string) --

                                The SSML text that defines the prompt.

                            • imageResponseCard (dict) --

                              A message that defines a response card that the client application can show to the user.

                              • title (string) --

                                The title to display on the response card. The format of the title is determined by the platform displaying the response card.

                              • subtitle (string) --

                                The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

                              • imageUrl (string) --

                                The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

                              • buttons (list) --

                                A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.

                                • (dict) --

                                  Describes a button to use on a response card used to gather slot values from a user.

                                  • text (string) --

                                    The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

                                  • value (string) --

                                    The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

                    • allowInterrupt (boolean) --

                      Indicates whether the user can interrupt a speech response from Amazon Lex.

              • defaultBranch (dict) --

                The conditional branch that should be followed when the conditions for other branches are not satisfied. A conditional branch is made up of a condition, a response and a next step.

                • nextStep (dict) --

                  The next step in the conversation.

                  • dialogAction (dict) --

                    Defines the action that the bot executes at runtime when the conversation reaches this step.

                    • type (string) --

                      The action that the bot should execute.

                    • slotToElicit (string) --

                      If the dialog action is ElicitSlot , defines the slot to elicit from the user.

                    • suppressNextMessage (boolean) --

                      When true the next message for the intent is not used.

                  • intent (dict) --

                    Override settings to configure the intent state.

                    • name (string) --

                      The name of the intent. Only required when you're switching intents.

                    • slots (dict) --

                      A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.,

                      • (string) --

                        • (dict) --

                          The slot values that Amazon Lex uses when it sets slot values in a dialog step.

                          • shape (string) --

                            When the shape value is List , it indicates that the values field contains a list of slot values. When the value is Scalar , it indicates that the value field contains a single value.

                          • value (dict) --

                            The current value of the slot.

                            • interpretedValue (string) --

                              The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the resolvedValues list.

                          • values (list) --

                            A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."

                            • (dict) --

                              The slot values that Amazon Lex uses when it sets slot values in a dialog step.

                  • sessionAttributes (dict) --

                    Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.

                    • (string) --

                      • (string) --

                • response (dict) --

                  Specifies a list of message groups that Amazon Lex uses to respond the user input.

                  • messageGroups (list) --

                    A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.

                    • (dict) --

                      Provides one or more messages that Amazon Lex should send to the user.

                      • message (dict) --

                        The primary message that Amazon Lex should send to the user.

                        • plainTextMessage (dict) --

                          A message in plain text format.

                          • value (string) --

                            The message to send to the user.

                        • customPayload (dict) --

                          A message in a custom format defined by the client application.

                          • value (string) --

                            The string that is sent to your application.

                        • ssmlMessage (dict) --

                          A message in Speech Synthesis Markup Language (SSML).

                          • value (string) --

                            The SSML text that defines the prompt.

                        • imageResponseCard (dict) --

                          A message that defines a response card that the client application can show to the user.

                          • title (string) --

                            The title to display on the response card. The format of the title is determined by the platform displaying the response card.

                          • subtitle (string) --

                            The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

                          • imageUrl (string) --

                            The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

                          • buttons (list) --

                            A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.

                            • (dict) --

                              Describes a button to use on a response card used to gather slot values from a user.

                              • text (string) --

                                The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

                              • value (string) --

                                The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

                      • variations (list) --

                        Message variations to send to the user. When variations are defined, Amazon Lex chooses the primary message or one of the variations to send to the user.

                        • (dict) --

                          The object that provides message text and it's type.

                          • plainTextMessage (dict) --

                            A message in plain text format.

                            • value (string) --

                              The message to send to the user.

                          • customPayload (dict) --

                            A message in a custom format defined by the client application.

                            • value (string) --

                              The string that is sent to your application.

                          • ssmlMessage (dict) --

                            A message in Speech Synthesis Markup Language (SSML).

                            • value (string) --

                              The SSML text that defines the prompt.

                          • imageResponseCard (dict) --

                            A message that defines a response card that the client application can show to the user.

                            • title (string) --

                              The title to display on the response card. The format of the title is determined by the platform displaying the response card.

                            • subtitle (string) --

                              The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

                            • imageUrl (string) --

                              The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

                            • buttons (list) --

                              A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.

                              • (dict) --

                                Describes a button to use on a response card used to gather slot values from a user.

                                • text (string) --

                                  The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

                                • value (string) --

                                  The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

                  • allowInterrupt (boolean) --

                    Indicates whether the user can interrupt a speech response from Amazon Lex.

        • elicitationCodeHook (dict) --

          Code hook called when Amazon Lex doesn't capture a slot value.

          • enableCodeHookInvocation (boolean) --

            Indicates whether a Lambda function should be invoked for the dialog.

          • invocationLabel (string) --

            A label that indicates the dialog step from which the dialog code hook is happening.

    • obfuscationSetting (dict) --

      Indicates whether the slot is configured to obfuscate values in Amazon CloudWatch logs.

      • obfuscationSettingType (string) --

        Value that determines whether Amazon Lex obscures slot values in conversation logs. The default is to obscure the values.

    • botId (string) --

      The unique identifier of the bot associated with the slot.

    • botVersion (string) --

      The version of the bot associated with the slot.

    • localeId (string) --

      The language and local specified for the slot.

    • intentId (string) --

      The unique identifier of the intent associated with the slot.

    • creationDateTime (datetime) --

      The timestamp of the date and time that the slot was created.

    • multipleValuesSetting (dict) --

      Indicates whether the slot returns multiple values in one response.

      • allowMultipleValues (boolean) --

        Indicates whether a slot can return multiple values. When true , the slot may return more than one value in a response. When false , the slot returns only a single value.

        Multi-value slots are only available in the en-US locale. If you set this value to true in any other locale, Amazon Lex throws a ValidationException .

        If the allowMutlipleValues is not set, the default value is false .

    • subSlotSetting (dict) --

      Specifications for the constituent sub slots and the expression for the composite slot.

      • expression (string) --

        The expression text for defining the constituent sub slots in the composite slot using logical AND and OR operators.

      • slotSpecifications (dict) --

        Specifications for the constituent sub slots of a composite slot.

        • (string) --

          • (dict) --

            Subslot specifications.

            • slotTypeId (string) --

              The unique identifier assigned to the slot type.

            • valueElicitationSetting (dict) --

              Specifies the elicitation setting details for constituent sub slots of a composite slot.

              • defaultValueSpecification (dict) --

                Defines a list of values that Amazon Lex should use as the default value for a slot.

                • defaultValueList (list) --

                  A list of default values. Amazon Lex chooses the default value to use in the order that they are presented in the list.

                  • (dict) --

                    Specifies the default value to use when a user doesn't provide a value for a slot.

                    • defaultValue (string) --

                      The default value to use when a user doesn't provide a value for a slot.

              • promptSpecification (dict) --

                Specifies a list of message groups that Amazon Lex sends to a user to elicit a response.

                • messageGroups (list) --

                  A collection of messages that Amazon Lex can send to the user. Amazon Lex chooses the actual message to send at runtime.

                  • (dict) --

                    Provides one or more messages that Amazon Lex should send to the user.

                    • message (dict) --

                      The primary message that Amazon Lex should send to the user.

                      • plainTextMessage (dict) --

                        A message in plain text format.

                        • value (string) --

                          The message to send to the user.

                      • customPayload (dict) --

                        A message in a custom format defined by the client application.

                        • value (string) --

                          The string that is sent to your application.

                      • ssmlMessage (dict) --

                        A message in Speech Synthesis Markup Language (SSML).

                        • value (string) --

                          The SSML text that defines the prompt.

                      • imageResponseCard (dict) --

                        A message that defines a response card that the client application can show to the user.

                        • title (string) --

                          The title to display on the response card. The format of the title is determined by the platform displaying the response card.

                        • subtitle (string) --

                          The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

                        • imageUrl (string) --

                          The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

                        • buttons (list) --

                          A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.

                          • (dict) --

                            Describes a button to use on a response card used to gather slot values from a user.

                            • text (string) --

                              The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

                            • value (string) --

                              The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

                    • variations (list) --

                      Message variations to send to the user. When variations are defined, Amazon Lex chooses the primary message or one of the variations to send to the user.

                      • (dict) --

                        The object that provides message text and it's type.

                        • plainTextMessage (dict) --

                          A message in plain text format.

                          • value (string) --

                            The message to send to the user.

                        • customPayload (dict) --

                          A message in a custom format defined by the client application.

                          • value (string) --

                            The string that is sent to your application.

                        • ssmlMessage (dict) --

                          A message in Speech Synthesis Markup Language (SSML).

                          • value (string) --

                            The SSML text that defines the prompt.

                        • imageResponseCard (dict) --

                          A message that defines a response card that the client application can show to the user.

                          • title (string) --

                            The title to display on the response card. The format of the title is determined by the platform displaying the response card.

                          • subtitle (string) --

                            The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

                          • imageUrl (string) --

                            The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

                          • buttons (list) --

                            A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.

                            • (dict) --

                              Describes a button to use on a response card used to gather slot values from a user.

                              • text (string) --

                                The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

                              • value (string) --

                                The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

                • maxRetries (integer) --

                  The maximum number of times the bot tries to elicit a response from the user using this prompt.

                • allowInterrupt (boolean) --

                  Indicates whether the user can interrupt a speech prompt from the bot.

                • messageSelectionStrategy (string) --

                  Indicates how a message is selected from a message group among retries.

              • sampleUtterances (list) --

                If you know a specific pattern that users might respond to an Amazon Lex request for a sub slot value, you can provide those utterances to improve accuracy. This is optional. In most cases Amazon Lex is capable of understanding user utterances. This is similar to SampleUtterances for slots.

                • (dict) --

                  A sample utterance that invokes an intent or respond to a slot elicitation prompt.

                  • utterance (string) --

                    The sample utterance that Amazon Lex uses to build its machine-learning model to recognize intents.

              • waitAndContinueSpecification (dict) --

                Specifies the prompts that Amazon Lex uses while a bot is waiting for customer input.

                • waitingResponse (dict) --

                  The response that Amazon Lex sends to indicate that the bot is waiting for the conversation to continue.

                  • messageGroups (list) --

                    A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.

                    • (dict) --

                      Provides one or more messages that Amazon Lex should send to the user.

                      • message (dict) --

                        The primary message that Amazon Lex should send to the user.

                        • plainTextMessage (dict) --

                          A message in plain text format.

                          • value (string) --

                            The message to send to the user.

                        • customPayload (dict) --

                          A message in a custom format defined by the client application.

                          • value (string) --

                            The string that is sent to your application.

                        • ssmlMessage (dict) --

                          A message in Speech Synthesis Markup Language (SSML).

                          • value (string) --

                            The SSML text that defines the prompt.

                        • imageResponseCard (dict) --

                          A message that defines a response card that the client application can show to the user.

                          • title (string) --

                            The title to display on the response card. The format of the title is determined by the platform displaying the response card.

                          • subtitle (string) --

                            The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

                          • imageUrl (string) --

                            The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

                          • buttons (list) --

                            A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.

                            • (dict) --

                              Describes a button to use on a response card used to gather slot values from a user.

                              • text (string) --

                                The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

                              • value (string) --

                                The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

                      • variations (list) --

                        Message variations to send to the user. When variations are defined, Amazon Lex chooses the primary message or one of the variations to send to the user.

                        • (dict) --

                          The object that provides message text and it's type.

                          • plainTextMessage (dict) --

                            A message in plain text format.

                            • value (string) --

                              The message to send to the user.

                          • customPayload (dict) --

                            A message in a custom format defined by the client application.

                            • value (string) --

                              The string that is sent to your application.

                          • ssmlMessage (dict) --

                            A message in Speech Synthesis Markup Language (SSML).

                            • value (string) --

                              The SSML text that defines the prompt.

                          • imageResponseCard (dict) --

                            A message that defines a response card that the client application can show to the user.

                            • title (string) --

                              The title to display on the response card. The format of the title is determined by the platform displaying the response card.

                            • subtitle (string) --

                              The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

                            • imageUrl (string) --

                              The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

                            • buttons (list) --

                              A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.

                              • (dict) --

                                Describes a button to use on a response card used to gather slot values from a user.

                                • text (string) --

                                  The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

                                • value (string) --

                                  The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

                  • allowInterrupt (boolean) --

                    Indicates whether the user can interrupt a speech response from Amazon Lex.

                • continueResponse (dict) --

                  The response that Amazon Lex sends to indicate that the bot is ready to continue the conversation.

                  • messageGroups (list) --

                    A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.

                    • (dict) --

                      Provides one or more messages that Amazon Lex should send to the user.

                      • message (dict) --

                        The primary message that Amazon Lex should send to the user.

                        • plainTextMessage (dict) --

                          A message in plain text format.

                          • value (string) --

                            The message to send to the user.

                        • customPayload (dict) --

                          A message in a custom format defined by the client application.

                          • value (string) --

                            The string that is sent to your application.

                        • ssmlMessage (dict) --

                          A message in Speech Synthesis Markup Language (SSML).

                          • value (string) --

                            The SSML text that defines the prompt.

                        • imageResponseCard (dict) --

                          A message that defines a response card that the client application can show to the user.

                          • title (string) --

                            The title to display on the response card. The format of the title is determined by the platform displaying the response card.

                          • subtitle (string) --

                            The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

                          • imageUrl (string) --

                            The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

                          • buttons (list) --

                            A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.

                            • (dict) --

                              Describes a button to use on a response card used to gather slot values from a user.

                              • text (string) --

                                The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

                              • value (string) --

                                The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

                      • variations (list) --

                        Message variations to send to the user. When variations are defined, Amazon Lex chooses the primary message or one of the variations to send to the user.

                        • (dict) --

                          The object that provides message text and it's type.

                          • plainTextMessage (dict) --

                            A message in plain text format.

                            • value (string) --

                              The message to send to the user.

                          • customPayload (dict) --

                            A message in a custom format defined by the client application.

                            • value (string) --

                              The string that is sent to your application.

                          • ssmlMessage (dict) --

                            A message in Speech Synthesis Markup Language (SSML).

                            • value (string) --

                              The SSML text that defines the prompt.

                          • imageResponseCard (dict) --

                            A message that defines a response card that the client application can show to the user.

                            • title (string) --

                              The title to display on the response card. The format of the title is determined by the platform displaying the response card.

                            • subtitle (string) --

                              The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

                            • imageUrl (string) --

                              The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

                            • buttons (list) --

                              A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.

                              • (dict) --

                                Describes a button to use on a response card used to gather slot values from a user.

                                • text (string) --

                                  The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

                                • value (string) --

                                  The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

                  • allowInterrupt (boolean) --

                    Indicates whether the user can interrupt a speech response from Amazon Lex.

                • stillWaitingResponse (dict) --

                  A response that Amazon Lex sends periodically to the user to indicate that the bot is still waiting for input from the user.

                  • messageGroups (list) --

                    One or more message groups, each containing one or more messages, that define the prompts that Amazon Lex sends to the user.

                    • (dict) --

                      Provides one or more messages that Amazon Lex should send to the user.

                      • message (dict) --

                        The primary message that Amazon Lex should send to the user.

                        • plainTextMessage (dict) --

                          A message in plain text format.

                          • value (string) --

                            The message to send to the user.

                        • customPayload (dict) --

                          A message in a custom format defined by the client application.

                          • value (string) --

                            The string that is sent to your application.

                        • ssmlMessage (dict) --

                          A message in Speech Synthesis Markup Language (SSML).

                          • value (string) --

                            The SSML text that defines the prompt.

                        • imageResponseCard (dict) --

                          A message that defines a response card that the client application can show to the user.

                          • title (string) --

                            The title to display on the response card. The format of the title is determined by the platform displaying the response card.

                          • subtitle (string) --

                            The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

                          • imageUrl (string) --

                            The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

                          • buttons (list) --

                            A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.

                            • (dict) --

                              Describes a button to use on a response card used to gather slot values from a user.

                              • text (string) --

                                The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

                              • value (string) --

                                The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

                      • variations (list) --

                        Message variations to send to the user. When variations are defined, Amazon Lex chooses the primary message or one of the variations to send to the user.

                        • (dict) --

                          The object that provides message text and it's type.

                          • plainTextMessage (dict) --

                            A message in plain text format.

                            • value (string) --

                              The message to send to the user.

                          • customPayload (dict) --

                            A message in a custom format defined by the client application.

                            • value (string) --

                              The string that is sent to your application.

                          • ssmlMessage (dict) --

                            A message in Speech Synthesis Markup Language (SSML).

                            • value (string) --

                              The SSML text that defines the prompt.

                          • imageResponseCard (dict) --

                            A message that defines a response card that the client application can show to the user.

                            • title (string) --

                              The title to display on the response card. The format of the title is determined by the platform displaying the response card.

                            • subtitle (string) --

                              The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

                            • imageUrl (string) --

                              The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

                            • buttons (list) --

                              A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.

                              • (dict) --

                                Describes a button to use on a response card used to gather slot values from a user.

                                • text (string) --

                                  The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

                                • value (string) --

                                  The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

                  • frequencyInSeconds (integer) --

                    How often a message should be sent to the user. Minimum of 1 second, maximum of 5 minutes.

                  • timeoutInSeconds (integer) --

                    If Amazon Lex waits longer than this length of time for a response, it will stop sending messages.

                  • allowInterrupt (boolean) --

                    Indicates that the user can interrupt the response by speaking while the message is being played.

                • active (boolean) --

                  Specifies whether the bot will wait for a user to respond. When this field is false, wait and continue responses for a slot aren't used. If the active field isn't specified, the default is true.

CreateSlotType (updated) Link ¶
Changes (both)
{'compositeSlotTypeSetting': {'subSlots': [{'name': 'string',
                                            'slotTypeId': 'string'}]},
 'valueSelectionSetting': {'resolutionStrategy': {'Concatenation'}}}

Creates a custom slot type

To create a custom slot type, specify a name for the slot type and a set of enumeration values, the values that a slot of this type can assume.

See also: AWS API Documentation

Request Syntax

client.create_slot_type(
    slotTypeName='string',
    description='string',
    slotTypeValues=[
        {
            'sampleValue': {
                'value': 'string'
            },
            'synonyms': [
                {
                    'value': 'string'
                },
            ]
        },
    ],
    valueSelectionSetting={
        'resolutionStrategy': 'OriginalValue'|'TopResolution'|'Concatenation',
        'regexFilter': {
            'pattern': 'string'
        },
        'advancedRecognitionSetting': {
            'audioRecognitionStrategy': 'UseSlotValuesAsCustomVocabulary'
        }
    },
    parentSlotTypeSignature='string',
    botId='string',
    botVersion='string',
    localeId='string',
    externalSourceSetting={
        'grammarSlotTypeSetting': {
            'source': {
                's3BucketName': 'string',
                's3ObjectKey': 'string',
                'kmsKeyArn': 'string'
            }
        }
    },
    compositeSlotTypeSetting={
        'subSlots': [
            {
                'name': 'string',
                'slotTypeId': 'string'
            },
        ]
    }
)
type slotTypeName

string

param slotTypeName

[REQUIRED]

The name for the slot. A slot type name must be unique within the account.

type description

string

param description

A description of the slot type. Use the description to help identify the slot type in lists.

type slotTypeValues

list

param slotTypeValues

A list of SlotTypeValue objects that defines the values that the slot type can take. Each value can have a list of synonyms, additional values that help train the machine learning model about the values that it resolves for a slot.

  • (dict) --

    Each slot type can have a set of values. Each SlotTypeValue represents a value that the slot type can take.

    • sampleValue (dict) --

      The value of the slot type entry.

      • value (string) -- [REQUIRED]

        The value that can be used for a slot type.

    • synonyms (list) --

      Additional values related to the slot type entry.

      • (dict) --

        Defines one of the values for a slot type.

        • value (string) -- [REQUIRED]

          The value that can be used for a slot type.

type valueSelectionSetting

dict

param valueSelectionSetting

Determines the strategy that Amazon Lex uses to select a value from the list of possible values. The field can be set to one of the following values:

  • OriginalValue - Returns the value entered by the user, if the user value is similar to the slot value.

  • TopResolution - If there is a resolution list for the slot, return the first value in the resolution list. If there is no resolution list, return null.

If you don't specify the valueSelectionSetting parameter, the default is OriginalValue .

  • resolutionStrategy (string) -- [REQUIRED]

    Determines the slot resolution strategy that Amazon Lex uses to return slot type values. The field can be set to one of the following values:

    • OriginalValue - Returns the value entered by the user, if the user value is similar to the slot value.

    • TopResolution - If there is a resolution list for the slot, return the first value in the resolution list as the slot type value. If there is no resolution list, null is returned.

    If you don't specify the valueSelectionStrategy, the default is OriginalValue.

  • regexFilter (dict) --

    A regular expression used to validate the value of a slot.

    • pattern (string) -- [REQUIRED]

      A regular expression used to validate the value of a slot.

      Use a standard regular expression. Amazon Lex supports the following characters in the regular expression:

      • A-Z, a-z

      • 0-9

      • Unicode characters ("u<Unicode>")

      Represent Unicode characters with four digits, for example "u0041" or "u005A".

      The following regular expression operators are not supported:

      • Infinite repeaters: *, +, or {x,} with no upper bound.

      • Wild card (.)

  • advancedRecognitionSetting (dict) --

    Provides settings that enable advanced recognition settings for slot values.

    • audioRecognitionStrategy (string) --

      Enables using the slot values as a custom vocabulary for recognizing user utterances.

type parentSlotTypeSignature

string

param parentSlotTypeSignature

The built-in slot type used as a parent of this slot type. When you define a parent slot type, the new slot type has the configuration of the parent slot type.

Only AMAZON.AlphaNumeric is supported.

type botId

string

param botId

[REQUIRED]

The identifier of the bot associated with this slot type.

type botVersion

string

param botVersion

[REQUIRED]

The identifier of the bot version associated with this slot type.

type localeId

string

param localeId

[REQUIRED]

The identifier of the language and locale that the slot type will be used in. The string must match one of the supported locales. All of the bots, intents, and slots used by the slot type must have the same locale. For more information, see Supported languages .

type externalSourceSetting

dict

param externalSourceSetting

Sets the type of external information used to create the slot type.

  • grammarSlotTypeSetting (dict) --

    Settings required for a slot type based on a grammar that you provide.

    • source (dict) --

      The source of the grammar used to create the slot type.

      • s3BucketName (string) -- [REQUIRED]

        The name of the S3 bucket that contains the grammar source.

      • s3ObjectKey (string) -- [REQUIRED]

        The path to the grammar in the S3 bucket.

      • kmsKeyArn (string) --

        The Amazon KMS key required to decrypt the contents of the grammar, if any.

type compositeSlotTypeSetting

dict

param compositeSlotTypeSetting

Specifications for a composite slot type.

  • subSlots (list) --

    Subslots in the composite slot.

    • (dict) --

      Subslot type composition.

      • name (string) -- [REQUIRED]

        Name of a constituent sub slot inside a composite slot.

      • slotTypeId (string) -- [REQUIRED]

        The unique identifier assigned to a slot type. This refers to either a built-in slot type or the unique slotTypeId of a custom slot type.

rtype

dict

returns

Response Syntax

{
    'slotTypeId': 'string',
    'slotTypeName': 'string',
    'description': 'string',
    'slotTypeValues': [
        {
            'sampleValue': {
                'value': 'string'
            },
            'synonyms': [
                {
                    'value': 'string'
                },
            ]
        },
    ],
    'valueSelectionSetting': {
        'resolutionStrategy': 'OriginalValue'|'TopResolution'|'Concatenation',
        'regexFilter': {
            'pattern': 'string'
        },
        'advancedRecognitionSetting': {
            'audioRecognitionStrategy': 'UseSlotValuesAsCustomVocabulary'
        }
    },
    'parentSlotTypeSignature': 'string',
    'botId': 'string',
    'botVersion': 'string',
    'localeId': 'string',
    'creationDateTime': datetime(2015, 1, 1),
    'externalSourceSetting': {
        'grammarSlotTypeSetting': {
            'source': {
                's3BucketName': 'string',
                's3ObjectKey': 'string',
                'kmsKeyArn': 'string'
            }
        }
    },
    'compositeSlotTypeSetting': {
        'subSlots': [
            {
                'name': 'string',
                'slotTypeId': 'string'
            },
        ]
    }
}

Response Structure

  • (dict) --

    • slotTypeId (string) --

      The unique identifier assigned to the slot type. Use this to identify the slot type in the UpdateSlotType and DeleteSlotType operations.

    • slotTypeName (string) --

      The name specified for the slot type.

    • description (string) --

      The description specified for the slot type.

    • slotTypeValues (list) --

      The list of values that the slot type can assume.

      • (dict) --

        Each slot type can have a set of values. Each SlotTypeValue represents a value that the slot type can take.

        • sampleValue (dict) --

          The value of the slot type entry.

          • value (string) --

            The value that can be used for a slot type.

        • synonyms (list) --

          Additional values related to the slot type entry.

          • (dict) --

            Defines one of the values for a slot type.

            • value (string) --

              The value that can be used for a slot type.

    • valueSelectionSetting (dict) --

      The strategy that Amazon Lex uses to select a value from the list of possible values.

      • resolutionStrategy (string) --

        Determines the slot resolution strategy that Amazon Lex uses to return slot type values. The field can be set to one of the following values:

        • OriginalValue - Returns the value entered by the user, if the user value is similar to the slot value.

        • TopResolution - If there is a resolution list for the slot, return the first value in the resolution list as the slot type value. If there is no resolution list, null is returned.

        If you don't specify the valueSelectionStrategy, the default is OriginalValue.

      • regexFilter (dict) --

        A regular expression used to validate the value of a slot.

        • pattern (string) --

          A regular expression used to validate the value of a slot.

          Use a standard regular expression. Amazon Lex supports the following characters in the regular expression:

          • A-Z, a-z

          • 0-9

          • Unicode characters ("u<Unicode>")

          Represent Unicode characters with four digits, for example "u0041" or "u005A".

          The following regular expression operators are not supported:

          • Infinite repeaters: *, +, or {x,} with no upper bound.

          • Wild card (.)

      • advancedRecognitionSetting (dict) --

        Provides settings that enable advanced recognition settings for slot values.

        • audioRecognitionStrategy (string) --

          Enables using the slot values as a custom vocabulary for recognizing user utterances.

    • parentSlotTypeSignature (string) --

      The signature of the base slot type specified for the slot type.

    • botId (string) --

      The identifier for the bot associated with the slot type.

    • botVersion (string) --

      The version of the bot associated with the slot type.

    • localeId (string) --

      The specified language and local specified for the slot type.

    • creationDateTime (datetime) --

      A timestamp of the date and time that the slot type was created.

    • externalSourceSetting (dict) --

      The type of external information used to create the slot type.

      • grammarSlotTypeSetting (dict) --

        Settings required for a slot type based on a grammar that you provide.

        • source (dict) --

          The source of the grammar used to create the slot type.

          • s3BucketName (string) --

            The name of the S3 bucket that contains the grammar source.

          • s3ObjectKey (string) --

            The path to the grammar in the S3 bucket.

          • kmsKeyArn (string) --

            The Amazon KMS key required to decrypt the contents of the grammar, if any.

    • compositeSlotTypeSetting (dict) --

      Specifications for a composite slot type.

      • subSlots (list) --

        Subslots in the composite slot.

        • (dict) --

          Subslot type composition.

          • name (string) --

            Name of a constituent sub slot inside a composite slot.

          • slotTypeId (string) --

            The unique identifier assigned to a slot type. This refers to either a built-in slot type or the unique slotTypeId of a custom slot type.

DescribeSlot (updated) Link ¶
Changes (response)
{'subSlotSetting': {'expression': 'string',
                    'slotSpecifications': {'string': {'slotTypeId': 'string',
                                                      'valueElicitationSetting': {'defaultValueSpecification': {'defaultValueList': [{'defaultValue': 'string'}]},
                                                                                  'promptSpecification': {'allowInterrupt': 'boolean',
                                                                                                          'maxRetries': 'integer',
                                                                                                          'messageGroups': [{'message': {'customPayload': {'value': 'string'},
                                                                                                                                         'imageResponseCard': {'buttons': [{'text': 'string',
                                                                                                                                                                            'value': 'string'}],
                                                                                                                                                               'imageUrl': 'string',
                                                                                                                                                               'subtitle': 'string',
                                                                                                                                                               'title': 'string'},
                                                                                                                                         'plainTextMessage': {'value': 'string'},
                                                                                                                                         'ssmlMessage': {'value': 'string'}},
                                                                                                                             'variations': [{'customPayload': {'value': 'string'},
                                                                                                                                             'imageResponseCard': {'buttons': [{'text': 'string',
                                                                                                                                                                                'value': 'string'}],
                                                                                                                                                                   'imageUrl': 'string',
                                                                                                                                                                   'subtitle': 'string',
                                                                                                                                                                   'title': 'string'},
                                                                                                                                             'plainTextMessage': {'value': 'string'},
                                                                                                                                             'ssmlMessage': {'value': 'string'}}]}],
                                                                                                          'messageSelectionStrategy': 'Random '
                                                                                                                                      '| '
                                                                                                                                      'Ordered'},
                                                                                  'sampleUtterances': [{'utterance': 'string'}],
                                                                                  'waitAndContinueSpecification': {'active': 'boolean',
                                                                                                                   'continueResponse': {'allowInterrupt': 'boolean',
                                                                                                                                        'messageGroups': [{'message': {'customPayload': {'value': 'string'},
                                                                                                                                                                       'imageResponseCard': {'buttons': [{'text': 'string',
                                                                                                                                                                                                          'value': 'string'}],
                                                                                                                                                                                             'imageUrl': 'string',
                                                                                                                                                                                             'subtitle': 'string',
                                                                                                                                                                                             'title': 'string'},
                                                                                                                                                                       'plainTextMessage': {'value': 'string'},
                                                                                                                                                                       'ssmlMessage': {'value': 'string'}},
                                                                                                                                                           'variations': [{'customPayload': {'value': 'string'},
                                                                                                                                                                           'imageResponseCard': {'buttons': [{'text': 'string',
                                                                                                                                                                                                              'value': 'string'}],
                                                                                                                                                                                                 'imageUrl': 'string',
                                                                                                                                                                                                 'subtitle': 'string',
                                                                                                                                                                                                 'title': 'string'},
                                                                                                                                                                           'plainTextMessage': {'value': 'string'},
                                                                                                                                                                           'ssmlMessage': {'value': 'string'}}]}]},
                                                                                                                   'stillWaitingResponse': {'allowInterrupt': 'boolean',
                                                                                                                                            'frequencyInSeconds': 'integer',
                                                                                                                                            'messageGroups': [{'message': {'customPayload': {'value': 'string'},
                                                                                                                                                                           'imageResponseCard': {'buttons': [{'text': 'string',
                                                                                                                                                                                                              'value': 'string'}],
                                                                                                                                                                                                 'imageUrl': 'string',
                                                                                                                                                                                                 'subtitle': 'string',
                                                                                                                                                                                                 'title': 'string'},
                                                                                                                                                                           'plainTextMessage': {'value': 'string'},
                                                                                                                                                                           'ssmlMessage': {'value': 'string'}},
                                                                                                                                                               'variations': [{'customPayload': {'value': 'string'},
                                                                                                                                                                               'imageResponseCard': {'buttons': [{'text': 'string',
                                                                                                                                                                                                                  'value': 'string'}],
                                                                                                                                                                                                     'imageUrl': 'string',
                                                                                                                                                                                                     'subtitle': 'string',
                                                                                                                                                                                                     'title': 'string'},
                                                                                                                                                                               'plainTextMessage': {'value': 'string'},
                                                                                                                                                                               'ssmlMessage': {'value': 'string'}}]}],
                                                                                                                                            'timeoutInSeconds': 'integer'},
                                                                                                                   'waitingResponse': {'allowInterrupt': 'boolean',
                                                                                                                                       'messageGroups': [{'message': {'customPayload': {'value': 'string'},
                                                                                                                                                                      'imageResponseCard': {'buttons': [{'text': 'string',
                                                                                                                                                                                                         'value': 'string'}],
                                                                                                                                                                                            'imageUrl': 'string',
                                                                                                                                                                                            'subtitle': 'string',
                                                                                                                                                                                            'title': 'string'},
                                                                                                                                                                      'plainTextMessage': {'value': 'string'},
                                                                                                                                                                      'ssmlMessage': {'value': 'string'}},
                                                                                                                                                          'variations': [{'customPayload': {'value': 'string'},
                                                                                                                                                                          'imageResponseCard': {'buttons': [{'text': 'string',
                                                                                                                                                                                                             'value': 'string'}],
                                                                                                                                                                                                'imageUrl': 'string',
                                                                                                                                                                                                'subtitle': 'string',
                                                                                                                                                                                                'title': 'string'},
                                                                                                                                                                          'plainTextMessage': {'value': 'string'},
                                                                                                                                                                          'ssmlMessage': {'value': 'string'}}]}]}}}}}}}

Gets metadata information about a slot.

See also: AWS API Documentation

Request Syntax

client.describe_slot(
    slotId='string',
    botId='string',
    botVersion='string',
    localeId='string',
    intentId='string'
)
type slotId

string

param slotId

[REQUIRED]

The unique identifier for the slot.

type botId

string

param botId

[REQUIRED]

The identifier of the bot associated with the slot.

type botVersion

string

param botVersion

[REQUIRED]

The version of the bot associated with the slot.

type localeId

string

param localeId

[REQUIRED]

The identifier of the language and locale of the slot to describe. The string must match one of the supported locales. For more information, see Supported languages .

type intentId

string

param intentId

[REQUIRED]

The identifier of the intent that contains the slot.

rtype

dict

returns

Response Syntax

{
    'slotId': 'string',
    'slotName': 'string',
    'description': 'string',
    'slotTypeId': 'string',
    'valueElicitationSetting': {
        'defaultValueSpecification': {
            'defaultValueList': [
                {
                    'defaultValue': 'string'
                },
            ]
        },
        'slotConstraint': 'Required'|'Optional',
        'promptSpecification': {
            'messageGroups': [
                {
                    'message': {
                        'plainTextMessage': {
                            'value': 'string'
                        },
                        'customPayload': {
                            'value': 'string'
                        },
                        'ssmlMessage': {
                            'value': 'string'
                        },
                        'imageResponseCard': {
                            'title': 'string',
                            'subtitle': 'string',
                            'imageUrl': 'string',
                            'buttons': [
                                {
                                    'text': 'string',
                                    'value': 'string'
                                },
                            ]
                        }
                    },
                    'variations': [
                        {
                            'plainTextMessage': {
                                'value': 'string'
                            },
                            'customPayload': {
                                'value': 'string'
                            },
                            'ssmlMessage': {
                                'value': 'string'
                            },
                            'imageResponseCard': {
                                'title': 'string',
                                'subtitle': 'string',
                                'imageUrl': 'string',
                                'buttons': [
                                    {
                                        'text': 'string',
                                        'value': 'string'
                                    },
                                ]
                            }
                        },
                    ]
                },
            ],
            'maxRetries': 123,
            'allowInterrupt': True|False,
            'messageSelectionStrategy': 'Random'|'Ordered'
        },
        'sampleUtterances': [
            {
                'utterance': 'string'
            },
        ],
        'waitAndContinueSpecification': {
            'waitingResponse': {
                'messageGroups': [
                    {
                        'message': {
                            'plainTextMessage': {
                                'value': 'string'
                            },
                            'customPayload': {
                                'value': 'string'
                            },
                            'ssmlMessage': {
                                'value': 'string'
                            },
                            'imageResponseCard': {
                                'title': 'string',
                                'subtitle': 'string',
                                'imageUrl': 'string',
                                'buttons': [
                                    {
                                        'text': 'string',
                                        'value': 'string'
                                    },
                                ]
                            }
                        },
                        'variations': [
                            {
                                'plainTextMessage': {
                                    'value': 'string'
                                },
                                'customPayload': {
                                    'value': 'string'
                                },
                                'ssmlMessage': {
                                    'value': 'string'
                                },
                                'imageResponseCard': {
                                    'title': 'string',
                                    'subtitle': 'string',
                                    'imageUrl': 'string',
                                    'buttons': [
                                        {
                                            'text': 'string',
                                            'value': 'string'
                                        },
                                    ]
                                }
                            },
                        ]
                    },
                ],
                'allowInterrupt': True|False
            },
            'continueResponse': {
                'messageGroups': [
                    {
                        'message': {
                            'plainTextMessage': {
                                'value': 'string'
                            },
                            'customPayload': {
                                'value': 'string'
                            },
                            'ssmlMessage': {
                                'value': 'string'
                            },
                            'imageResponseCard': {
                                'title': 'string',
                                'subtitle': 'string',
                                'imageUrl': 'string',
                                'buttons': [
                                    {
                                        'text': 'string',
                                        'value': 'string'
                                    },
                                ]
                            }
                        },
                        'variations': [
                            {
                                'plainTextMessage': {
                                    'value': 'string'
                                },
                                'customPayload': {
                                    'value': 'string'
                                },
                                'ssmlMessage': {
                                    'value': 'string'
                                },
                                'imageResponseCard': {
                                    'title': 'string',
                                    'subtitle': 'string',
                                    'imageUrl': 'string',
                                    'buttons': [
                                        {
                                            'text': 'string',
                                            'value': 'string'
                                        },
                                    ]
                                }
                            },
                        ]
                    },
                ],
                'allowInterrupt': True|False
            },
            'stillWaitingResponse': {
                'messageGroups': [
                    {
                        'message': {
                            'plainTextMessage': {
                                'value': 'string'
                            },
                            'customPayload': {
                                'value': 'string'
                            },
                            'ssmlMessage': {
                                'value': 'string'
                            },
                            'imageResponseCard': {
                                'title': 'string',
                                'subtitle': 'string',
                                'imageUrl': 'string',
                                'buttons': [
                                    {
                                        'text': 'string',
                                        'value': 'string'
                                    },
                                ]
                            }
                        },
                        'variations': [
                            {
                                'plainTextMessage': {
                                    'value': 'string'
                                },
                                'customPayload': {
                                    'value': 'string'
                                },
                                'ssmlMessage': {
                                    'value': 'string'
                                },
                                'imageResponseCard': {
                                    'title': 'string',
                                    'subtitle': 'string',
                                    'imageUrl': 'string',
                                    'buttons': [
                                        {
                                            'text': 'string',
                                            'value': 'string'
                                        },
                                    ]
                                }
                            },
                        ]
                    },
                ],
                'frequencyInSeconds': 123,
                'timeoutInSeconds': 123,
                'allowInterrupt': True|False
            },
            'active': True|False
        },
        'slotCaptureSetting': {
            'captureResponse': {
                'messageGroups': [
                    {
                        'message': {
                            'plainTextMessage': {
                                'value': 'string'
                            },
                            'customPayload': {
                                'value': 'string'
                            },
                            'ssmlMessage': {
                                'value': 'string'
                            },
                            'imageResponseCard': {
                                'title': 'string',
                                'subtitle': 'string',
                                'imageUrl': 'string',
                                'buttons': [
                                    {
                                        'text': 'string',
                                        'value': 'string'
                                    },
                                ]
                            }
                        },
                        'variations': [
                            {
                                'plainTextMessage': {
                                    'value': 'string'
                                },
                                'customPayload': {
                                    'value': 'string'
                                },
                                'ssmlMessage': {
                                    'value': 'string'
                                },
                                'imageResponseCard': {
                                    'title': 'string',
                                    'subtitle': 'string',
                                    'imageUrl': 'string',
                                    'buttons': [
                                        {
                                            'text': 'string',
                                            'value': 'string'
                                        },
                                    ]
                                }
                            },
                        ]
                    },
                ],
                'allowInterrupt': True|False
            },
            'captureNextStep': {
                'dialogAction': {
                    'type': 'ElicitIntent'|'StartIntent'|'ElicitSlot'|'EvaluateConditional'|'InvokeDialogCodeHook'|'ConfirmIntent'|'FulfillIntent'|'CloseIntent'|'EndConversation',
                    'slotToElicit': 'string',
                    'suppressNextMessage': True|False
                },
                'intent': {
                    'name': 'string',
                    'slots': {
                        'string': {
                            'shape': 'Scalar'|'List',
                            'value': {
                                'interpretedValue': 'string'
                            },
                            'values': [
                                {'... recursive ...'},
                            ]
                        }
                    }
                },
                'sessionAttributes': {
                    'string': 'string'
                }
            },
            'captureConditional': {
                'active': True|False,
                'conditionalBranches': [
                    {
                        'name': 'string',
                        'condition': {
                            'expressionString': 'string'
                        },
                        'nextStep': {
                            'dialogAction': {
                                'type': 'ElicitIntent'|'StartIntent'|'ElicitSlot'|'EvaluateConditional'|'InvokeDialogCodeHook'|'ConfirmIntent'|'FulfillIntent'|'CloseIntent'|'EndConversation',
                                'slotToElicit': 'string',
                                'suppressNextMessage': True|False
                            },
                            'intent': {
                                'name': 'string',
                                'slots': {
                                    'string': {
                                        'shape': 'Scalar'|'List',
                                        'value': {
                                            'interpretedValue': 'string'
                                        },
                                        'values': [
                                            {'... recursive ...'},
                                        ]
                                    }
                                }
                            },
                            'sessionAttributes': {
                                'string': 'string'
                            }
                        },
                        'response': {
                            'messageGroups': [
                                {
                                    'message': {
                                        'plainTextMessage': {
                                            'value': 'string'
                                        },
                                        'customPayload': {
                                            'value': 'string'
                                        },
                                        'ssmlMessage': {
                                            'value': 'string'
                                        },
                                        'imageResponseCard': {
                                            'title': 'string',
                                            'subtitle': 'string',
                                            'imageUrl': 'string',
                                            'buttons': [
                                                {
                                                    'text': 'string',
                                                    'value': 'string'
                                                },
                                            ]
                                        }
                                    },
                                    'variations': [
                                        {
                                            'plainTextMessage': {
                                                'value': 'string'
                                            },
                                            'customPayload': {
                                                'value': 'string'
                                            },
                                            'ssmlMessage': {
                                                'value': 'string'
                                            },
                                            'imageResponseCard': {
                                                'title': 'string',
                                                'subtitle': 'string',
                                                'imageUrl': 'string',
                                                'buttons': [
                                                    {
                                                        'text': 'string',
                                                        'value': 'string'
                                                    },
                                                ]
                                            }
                                        },
                                    ]
                                },
                            ],
                            'allowInterrupt': True|False
                        }
                    },
                ],
                'defaultBranch': {
                    'nextStep': {
                        'dialogAction': {
                            'type': 'ElicitIntent'|'StartIntent'|'ElicitSlot'|'EvaluateConditional'|'InvokeDialogCodeHook'|'ConfirmIntent'|'FulfillIntent'|'CloseIntent'|'EndConversation',
                            'slotToElicit': 'string',
                            'suppressNextMessage': True|False
                        },
                        'intent': {
                            'name': 'string',
                            'slots': {
                                'string': {
                                    'shape': 'Scalar'|'List',
                                    'value': {
                                        'interpretedValue': 'string'
                                    },
                                    'values': [
                                        {'... recursive ...'},
                                    ]
                                }
                            }
                        },
                        'sessionAttributes': {
                            'string': 'string'
                        }
                    },
                    'response': {
                        'messageGroups': [
                            {
                                'message': {
                                    'plainTextMessage': {
                                        'value': 'string'
                                    },
                                    'customPayload': {
                                        'value': 'string'
                                    },
                                    'ssmlMessage': {
                                        'value': 'string'
                                    },
                                    'imageResponseCard': {
                                        'title': 'string',
                                        'subtitle': 'string',
                                        'imageUrl': 'string',
                                        'buttons': [
                                            {
                                                'text': 'string',
                                                'value': 'string'
                                            },
                                        ]
                                    }
                                },
                                'variations': [
                                    {
                                        'plainTextMessage': {
                                            'value': 'string'
                                        },
                                        'customPayload': {
                                            'value': 'string'
                                        },
                                        'ssmlMessage': {
                                            'value': 'string'
                                        },
                                        'imageResponseCard': {
                                            'title': 'string',
                                            'subtitle': 'string',
                                            'imageUrl': 'string',
                                            'buttons': [
                                                {
                                                    'text': 'string',
                                                    'value': 'string'
                                                },
                                            ]
                                        }
                                    },
                                ]
                            },
                        ],
                        'allowInterrupt': True|False
                    }
                }
            },
            'failureResponse': {
                'messageGroups': [
                    {
                        'message': {
                            'plainTextMessage': {
                                'value': 'string'
                            },
                            'customPayload': {
                                'value': 'string'
                            },
                            'ssmlMessage': {
                                'value': 'string'
                            },
                            'imageResponseCard': {
                                'title': 'string',
                                'subtitle': 'string',
                                'imageUrl': 'string',
                                'buttons': [
                                    {
                                        'text': 'string',
                                        'value': 'string'
                                    },
                                ]
                            }
                        },
                        'variations': [
                            {
                                'plainTextMessage': {
                                    'value': 'string'
                                },
                                'customPayload': {
                                    'value': 'string'
                                },
                                'ssmlMessage': {
                                    'value': 'string'
                                },
                                'imageResponseCard': {
                                    'title': 'string',
                                    'subtitle': 'string',
                                    'imageUrl': 'string',
                                    'buttons': [
                                        {
                                            'text': 'string',
                                            'value': 'string'
                                        },
                                    ]
                                }
                            },
                        ]
                    },
                ],
                'allowInterrupt': True|False
            },
            'failureNextStep': {
                'dialogAction': {
                    'type': 'ElicitIntent'|'StartIntent'|'ElicitSlot'|'EvaluateConditional'|'InvokeDialogCodeHook'|'ConfirmIntent'|'FulfillIntent'|'CloseIntent'|'EndConversation',
                    'slotToElicit': 'string',
                    'suppressNextMessage': True|False
                },
                'intent': {
                    'name': 'string',
                    'slots': {
                        'string': {
                            'shape': 'Scalar'|'List',
                            'value': {
                                'interpretedValue': 'string'
                            },
                            'values': [
                                {'... recursive ...'},
                            ]
                        }
                    }
                },
                'sessionAttributes': {
                    'string': 'string'
                }
            },
            'failureConditional': {
                'active': True|False,
                'conditionalBranches': [
                    {
                        'name': 'string',
                        'condition': {
                            'expressionString': 'string'
                        },
                        'nextStep': {
                            'dialogAction': {
                                'type': 'ElicitIntent'|'StartIntent'|'ElicitSlot'|'EvaluateConditional'|'InvokeDialogCodeHook'|'ConfirmIntent'|'FulfillIntent'|'CloseIntent'|'EndConversation',
                                'slotToElicit': 'string',
                                'suppressNextMessage': True|False
                            },
                            'intent': {
                                'name': 'string',
                                'slots': {
                                    'string': {
                                        'shape': 'Scalar'|'List',
                                        'value': {
                                            'interpretedValue': 'string'
                                        },
                                        'values': [
                                            {'... recursive ...'},
                                        ]
                                    }
                                }
                            },
                            'sessionAttributes': {
                                'string': 'string'
                            }
                        },
                        'response': {
                            'messageGroups': [
                                {
                                    'message': {
                                        'plainTextMessage': {
                                            'value': 'string'
                                        },
                                        'customPayload': {
                                            'value': 'string'
                                        },
                                        'ssmlMessage': {
                                            'value': 'string'
                                        },
                                        'imageResponseCard': {
                                            'title': 'string',
                                            'subtitle': 'string',
                                            'imageUrl': 'string',
                                            'buttons': [
                                                {
                                                    'text': 'string',
                                                    'value': 'string'
                                                },
                                            ]
                                        }
                                    },
                                    'variations': [
                                        {
                                            'plainTextMessage': {
                                                'value': 'string'
                                            },
                                            'customPayload': {
                                                'value': 'string'
                                            },
                                            'ssmlMessage': {
                                                'value': 'string'
                                            },
                                            'imageResponseCard': {
                                                'title': 'string',
                                                'subtitle': 'string',
                                                'imageUrl': 'string',
                                                'buttons': [
                                                    {
                                                        'text': 'string',
                                                        'value': 'string'
                                                    },
                                                ]
                                            }
                                        },
                                    ]
                                },
                            ],
                            'allowInterrupt': True|False
                        }
                    },
                ],
                'defaultBranch': {
                    'nextStep': {
                        'dialogAction': {
                            'type': 'ElicitIntent'|'StartIntent'|'ElicitSlot'|'EvaluateConditional'|'InvokeDialogCodeHook'|'ConfirmIntent'|'FulfillIntent'|'CloseIntent'|'EndConversation',
                            'slotToElicit': 'string',
                            'suppressNextMessage': True|False
                        },
                        'intent': {
                            'name': 'string',
                            'slots': {
                                'string': {
                                    'shape': 'Scalar'|'List',
                                    'value': {
                                        'interpretedValue': 'string'
                                    },
                                    'values': [
                                        {'... recursive ...'},
                                    ]
                                }
                            }
                        },
                        'sessionAttributes': {
                            'string': 'string'
                        }
                    },
                    'response': {
                        'messageGroups': [
                            {
                                'message': {
                                    'plainTextMessage': {
                                        'value': 'string'
                                    },
                                    'customPayload': {
                                        'value': 'string'
                                    },
                                    'ssmlMessage': {
                                        'value': 'string'
                                    },
                                    'imageResponseCard': {
                                        'title': 'string',
                                        'subtitle': 'string',
                                        'imageUrl': 'string',
                                        'buttons': [
                                            {
                                                'text': 'string',
                                                'value': 'string'
                                            },
                                        ]
                                    }
                                },
                                'variations': [
                                    {
                                        'plainTextMessage': {
                                            'value': 'string'
                                        },
                                        'customPayload': {
                                            'value': 'string'
                                        },
                                        'ssmlMessage': {
                                            'value': 'string'
                                        },
                                        'imageResponseCard': {
                                            'title': 'string',
                                            'subtitle': 'string',
                                            'imageUrl': 'string',
                                            'buttons': [
                                                {
                                                    'text': 'string',
                                                    'value': 'string'
                                                },
                                            ]
                                        }
                                    },
                                ]
                            },
                        ],
                        'allowInterrupt': True|False
                    }
                }
            },
            'codeHook': {
                'enableCodeHookInvocation': True|False,
                'active': True|False,
                'invocationLabel': 'string',
                'postCodeHookSpecification': {
                    'successResponse': {
                        'messageGroups': [
                            {
                                'message': {
                                    'plainTextMessage': {
                                        'value': 'string'
                                    },
                                    'customPayload': {
                                        'value': 'string'
                                    },
                                    'ssmlMessage': {
                                        'value': 'string'
                                    },
                                    'imageResponseCard': {
                                        'title': 'string',
                                        'subtitle': 'string',
                                        'imageUrl': 'string',
                                        'buttons': [
                                            {
                                                'text': 'string',
                                                'value': 'string'
                                            },
                                        ]
                                    }
                                },
                                'variations': [
                                    {
                                        'plainTextMessage': {
                                            'value': 'string'
                                        },
                                        'customPayload': {
                                            'value': 'string'
                                        },
                                        'ssmlMessage': {
                                            'value': 'string'
                                        },
                                        'imageResponseCard': {
                                            'title': 'string',
                                            'subtitle': 'string',
                                            'imageUrl': 'string',
                                            'buttons': [
                                                {
                                                    'text': 'string',
                                                    'value': 'string'
                                                },
                                            ]
                                        }
                                    },
                                ]
                            },
                        ],
                        'allowInterrupt': True|False
                    },
                    'successNextStep': {
                        'dialogAction': {
                            'type': 'ElicitIntent'|'StartIntent'|'ElicitSlot'|'EvaluateConditional'|'InvokeDialogCodeHook'|'ConfirmIntent'|'FulfillIntent'|'CloseIntent'|'EndConversation',
                            'slotToElicit': 'string',
                            'suppressNextMessage': True|False
                        },
                        'intent': {
                            'name': 'string',
                            'slots': {
                                'string': {
                                    'shape': 'Scalar'|'List',
                                    'value': {
                                        'interpretedValue': 'string'
                                    },
                                    'values': [
                                        {'... recursive ...'},
                                    ]
                                }
                            }
                        },
                        'sessionAttributes': {
                            'string': 'string'
                        }
                    },
                    'successConditional': {
                        'active': True|False,
                        'conditionalBranches': [
                            {
                                'name': 'string',
                                'condition': {
                                    'expressionString': 'string'
                                },
                                'nextStep': {
                                    'dialogAction': {
                                        'type': 'ElicitIntent'|'StartIntent'|'ElicitSlot'|'EvaluateConditional'|'InvokeDialogCodeHook'|'ConfirmIntent'|'FulfillIntent'|'CloseIntent'|'EndConversation',
                                        'slotToElicit': 'string',
                                        'suppressNextMessage': True|False
                                    },
                                    'intent': {
                                        'name': 'string',
                                        'slots': {
                                            'string': {
                                                'shape': 'Scalar'|'List',
                                                'value': {
                                                    'interpretedValue': 'string'
                                                },
                                                'values': [
                                                    {'... recursive ...'},
                                                ]
                                            }
                                        }
                                    },
                                    'sessionAttributes': {
                                        'string': 'string'
                                    }
                                },
                                'response': {
                                    'messageGroups': [
                                        {
                                            'message': {
                                                'plainTextMessage': {
                                                    'value': 'string'
                                                },
                                                'customPayload': {
                                                    'value': 'string'
                                                },
                                                'ssmlMessage': {
                                                    'value': 'string'
                                                },
                                                'imageResponseCard': {
                                                    'title': 'string',
                                                    'subtitle': 'string',
                                                    'imageUrl': 'string',
                                                    'buttons': [
                                                        {
                                                            'text': 'string',
                                                            'value': 'string'
                                                        },
                                                    ]
                                                }
                                            },
                                            'variations': [
                                                {
                                                    'plainTextMessage': {
                                                        'value': 'string'
                                                    },
                                                    'customPayload': {
                                                        'value': 'string'
                                                    },
                                                    'ssmlMessage': {
                                                        'value': 'string'
                                                    },
                                                    'imageResponseCard': {
                                                        'title': 'string',
                                                        'subtitle': 'string',
                                                        'imageUrl': 'string',
                                                        'buttons': [
                                                            {
                                                                'text': 'string',
                                                                'value': 'string'
                                                            },
                                                        ]
                                                    }
                                                },
                                            ]
                                        },
                                    ],
                                    'allowInterrupt': True|False
                                }
                            },
                        ],
                        'defaultBranch': {
                            'nextStep': {
                                'dialogAction': {
                                    'type': 'ElicitIntent'|'StartIntent'|'ElicitSlot'|'EvaluateConditional'|'InvokeDialogCodeHook'|'ConfirmIntent'|'FulfillIntent'|'CloseIntent'|'EndConversation',
                                    'slotToElicit': 'string',
                                    'suppressNextMessage': True|False
                                },
                                'intent': {
                                    'name': 'string',
                                    'slots': {
                                        'string': {
                                            'shape': 'Scalar'|'List',
                                            'value': {
                                                'interpretedValue': 'string'
                                            },
                                            'values': [
                                                {'... recursive ...'},
                                            ]
                                        }
                                    }
                                },
                                'sessionAttributes': {
                                    'string': 'string'
                                }
                            },
                            'response': {
                                'messageGroups': [
                                    {
                                        'message': {
                                            'plainTextMessage': {
                                                'value': 'string'
                                            },
                                            'customPayload': {
                                                'value': 'string'
                                            },
                                            'ssmlMessage': {
                                                'value': 'string'
                                            },
                                            'imageResponseCard': {
                                                'title': 'string',
                                                'subtitle': 'string',
                                                'imageUrl': 'string',
                                                'buttons': [
                                                    {
                                                        'text': 'string',
                                                        'value': 'string'
                                                    },
                                                ]
                                            }
                                        },
                                        'variations': [
                                            {
                                                'plainTextMessage': {
                                                    'value': 'string'
                                                },
                                                'customPayload': {
                                                    'value': 'string'
                                                },
                                                'ssmlMessage': {
                                                    'value': 'string'
                                                },
                                                'imageResponseCard': {
                                                    'title': 'string',
                                                    'subtitle': 'string',
                                                    'imageUrl': 'string',
                                                    'buttons': [
                                                        {
                                                            'text': 'string',
                                                            'value': 'string'
                                                        },
                                                    ]
                                                }
                                            },
                                        ]
                                    },
                                ],
                                'allowInterrupt': True|False
                            }
                        }
                    },
                    'failureResponse': {
                        'messageGroups': [
                            {
                                'message': {
                                    'plainTextMessage': {
                                        'value': 'string'
                                    },
                                    'customPayload': {
                                        'value': 'string'
                                    },
                                    'ssmlMessage': {
                                        'value': 'string'
                                    },
                                    'imageResponseCard': {
                                        'title': 'string',
                                        'subtitle': 'string',
                                        'imageUrl': 'string',
                                        'buttons': [
                                            {
                                                'text': 'string',
                                                'value': 'string'
                                            },
                                        ]
                                    }
                                },
                                'variations': [
                                    {
                                        'plainTextMessage': {
                                            'value': 'string'
                                        },
                                        'customPayload': {
                                            'value': 'string'
                                        },
                                        'ssmlMessage': {
                                            'value': 'string'
                                        },
                                        'imageResponseCard': {
                                            'title': 'string',
                                            'subtitle': 'string',
                                            'imageUrl': 'string',
                                            'buttons': [
                                                {
                                                    'text': 'string',
                                                    'value': 'string'
                                                },
                                            ]
                                        }
                                    },
                                ]
                            },
                        ],
                        'allowInterrupt': True|False
                    },
                    'failureNextStep': {
                        'dialogAction': {
                            'type': 'ElicitIntent'|'StartIntent'|'ElicitSlot'|'EvaluateConditional'|'InvokeDialogCodeHook'|'ConfirmIntent'|'FulfillIntent'|'CloseIntent'|'EndConversation',
                            'slotToElicit': 'string',
                            'suppressNextMessage': True|False
                        },
                        'intent': {
                            'name': 'string',
                            'slots': {
                                'string': {
                                    'shape': 'Scalar'|'List',
                                    'value': {
                                        'interpretedValue': 'string'
                                    },
                                    'values': [
                                        {'... recursive ...'},
                                    ]
                                }
                            }
                        },
                        'sessionAttributes': {
                            'string': 'string'
                        }
                    },
                    'failureConditional': {
                        'active': True|False,
                        'conditionalBranches': [
                            {
                                'name': 'string',
                                'condition': {
                                    'expressionString': 'string'
                                },
                                'nextStep': {
                                    'dialogAction': {
                                        'type': 'ElicitIntent'|'StartIntent'|'ElicitSlot'|'EvaluateConditional'|'InvokeDialogCodeHook'|'ConfirmIntent'|'FulfillIntent'|'CloseIntent'|'EndConversation',
                                        'slotToElicit': 'string',
                                        'suppressNextMessage': True|False
                                    },
                                    'intent': {
                                        'name': 'string',
                                        'slots': {
                                            'string': {
                                                'shape': 'Scalar'|'List',
                                                'value': {
                                                    'interpretedValue': 'string'
                                                },
                                                'values': [
                                                    {'... recursive ...'},
                                                ]
                                            }
                                        }
                                    },
                                    'sessionAttributes': {
                                        'string': 'string'
                                    }
                                },
                                'response': {
                                    'messageGroups': [
                                        {
                                            'message': {
                                                'plainTextMessage': {
                                                    'value': 'string'
                                                },
                                                'customPayload': {
                                                    'value': 'string'
                                                },
                                                'ssmlMessage': {
                                                    'value': 'string'
                                                },
                                                'imageResponseCard': {
                                                    'title': 'string',
                                                    'subtitle': 'string',
                                                    'imageUrl': 'string',
                                                    'buttons': [
                                                        {
                                                            'text': 'string',
                                                            'value': 'string'
                                                        },
                                                    ]
                                                }
                                            },
                                            'variations': [
                                                {
                                                    'plainTextMessage': {
                                                        'value': 'string'
                                                    },
                                                    'customPayload': {
                                                        'value': 'string'
                                                    },
                                                    'ssmlMessage': {
                                                        'value': 'string'
                                                    },
                                                    'imageResponseCard': {
                                                        'title': 'string',
                                                        'subtitle': 'string',
                                                        'imageUrl': 'string',
                                                        'buttons': [
                                                            {
                                                                'text': 'string',
                                                                'value': 'string'
                                                            },
                                                        ]
                                                    }
                                                },
                                            ]
                                        },
                                    ],
                                    'allowInterrupt': True|False
                                }
                            },
                        ],
                        'defaultBranch': {
                            'nextStep': {
                                'dialogAction': {
                                    'type': 'ElicitIntent'|'StartIntent'|'ElicitSlot'|'EvaluateConditional'|'InvokeDialogCodeHook'|'ConfirmIntent'|'FulfillIntent'|'CloseIntent'|'EndConversation',
                                    'slotToElicit': 'string',
                                    'suppressNextMessage': True|False
                                },
                                'intent': {
                                    'name': 'string',
                                    'slots': {
                                        'string': {
                                            'shape': 'Scalar'|'List',
                                            'value': {
                                                'interpretedValue': 'string'
                                            },
                                            'values': [
                                                {'... recursive ...'},
                                            ]
                                        }
                                    }
                                },
                                'sessionAttributes': {
                                    'string': 'string'
                                }
                            },
                            'response': {
                                'messageGroups': [
                                    {
                                        'message': {
                                            'plainTextMessage': {
                                                'value': 'string'
                                            },
                                            'customPayload': {
                                                'value': 'string'
                                            },
                                            'ssmlMessage': {
                                                'value': 'string'
                                            },
                                            'imageResponseCard': {
                                                'title': 'string',
                                                'subtitle': 'string',
                                                'imageUrl': 'string',
                                                'buttons': [
                                                    {
                                                        'text': 'string',
                                                        'value': 'string'
                                                    },
                                                ]
                                            }
                                        },
                                        'variations': [
                                            {
                                                'plainTextMessage': {
                                                    'value': 'string'
                                                },
                                                'customPayload': {
                                                    'value': 'string'
                                                },
                                                'ssmlMessage': {
                                                    'value': 'string'
                                                },
                                                'imageResponseCard': {
                                                    'title': 'string',
                                                    'subtitle': 'string',
                                                    'imageUrl': 'string',
                                                    'buttons': [
                                                        {
                                                            'text': 'string',
                                                            'value': 'string'
                                                        },
                                                    ]
                                                }
                                            },
                                        ]
                                    },
                                ],
                                'allowInterrupt': True|False
                            }
                        }
                    },
                    'timeoutResponse': {
                        'messageGroups': [
                            {
                                'message': {
                                    'plainTextMessage': {
                                        'value': 'string'
                                    },
                                    'customPayload': {
                                        'value': 'string'
                                    },
                                    'ssmlMessage': {
                                        'value': 'string'
                                    },
                                    'imageResponseCard': {
                                        'title': 'string',
                                        'subtitle': 'string',
                                        'imageUrl': 'string',
                                        'buttons': [
                                            {
                                                'text': 'string',
                                                'value': 'string'
                                            },
                                        ]
                                    }
                                },
                                'variations': [
                                    {
                                        'plainTextMessage': {
                                            'value': 'string'
                                        },
                                        'customPayload': {
                                            'value': 'string'
                                        },
                                        'ssmlMessage': {
                                            'value': 'string'
                                        },
                                        'imageResponseCard': {
                                            'title': 'string',
                                            'subtitle': 'string',
                                            'imageUrl': 'string',
                                            'buttons': [
                                                {
                                                    'text': 'string',
                                                    'value': 'string'
                                                },
                                            ]
                                        }
                                    },
                                ]
                            },
                        ],
                        'allowInterrupt': True|False
                    },
                    'timeoutNextStep': {
                        'dialogAction': {
                            'type': 'ElicitIntent'|'StartIntent'|'ElicitSlot'|'EvaluateConditional'|'InvokeDialogCodeHook'|'ConfirmIntent'|'FulfillIntent'|'CloseIntent'|'EndConversation',
                            'slotToElicit': 'string',
                            'suppressNextMessage': True|False
                        },
                        'intent': {
                            'name': 'string',
                            'slots': {
                                'string': {
                                    'shape': 'Scalar'|'List',
                                    'value': {
                                        'interpretedValue': 'string'
                                    },
                                    'values': [
                                        {'... recursive ...'},
                                    ]
                                }
                            }
                        },
                        'sessionAttributes': {
                            'string': 'string'
                        }
                    },
                    'timeoutConditional': {
                        'active': True|False,
                        'conditionalBranches': [
                            {
                                'name': 'string',
                                'condition': {
                                    'expressionString': 'string'
                                },
                                'nextStep': {
                                    'dialogAction': {
                                        'type': 'ElicitIntent'|'StartIntent'|'ElicitSlot'|'EvaluateConditional'|'InvokeDialogCodeHook'|'ConfirmIntent'|'FulfillIntent'|'CloseIntent'|'EndConversation',
                                        'slotToElicit': 'string',
                                        'suppressNextMessage': True|False
                                    },
                                    'intent': {
                                        'name': 'string',
                                        'slots': {
                                            'string': {
                                                'shape': 'Scalar'|'List',
                                                'value': {
                                                    'interpretedValue': 'string'
                                                },
                                                'values': [
                                                    {'... recursive ...'},
                                                ]
                                            }
                                        }
                                    },
                                    'sessionAttributes': {
                                        'string': 'string'
                                    }
                                },
                                'response': {
                                    'messageGroups': [
                                        {
                                            'message': {
                                                'plainTextMessage': {
                                                    'value': 'string'
                                                },
                                                'customPayload': {
                                                    'value': 'string'
                                                },
                                                'ssmlMessage': {
                                                    'value': 'string'
                                                },
                                                'imageResponseCard': {
                                                    'title': 'string',
                                                    'subtitle': 'string',
                                                    'imageUrl': 'string',
                                                    'buttons': [
                                                        {
                                                            'text': 'string',
                                                            'value': 'string'
                                                        },
                                                    ]
                                                }
                                            },
                                            'variations': [
                                                {
                                                    'plainTextMessage': {
                                                        'value': 'string'
                                                    },
                                                    'customPayload': {
                                                        'value': 'string'
                                                    },
                                                    'ssmlMessage': {
                                                        'value': 'string'
                                                    },
                                                    'imageResponseCard': {
                                                        'title': 'string',
                                                        'subtitle': 'string',
                                                        'imageUrl': 'string',
                                                        'buttons': [
                                                            {
                                                                'text': 'string',
                                                                'value': 'string'
                                                            },
                                                        ]
                                                    }
                                                },
                                            ]
                                        },
                                    ],
                                    'allowInterrupt': True|False
                                }
                            },
                        ],
                        'defaultBranch': {
                            'nextStep': {
                                'dialogAction': {
                                    'type': 'ElicitIntent'|'StartIntent'|'ElicitSlot'|'EvaluateConditional'|'InvokeDialogCodeHook'|'ConfirmIntent'|'FulfillIntent'|'CloseIntent'|'EndConversation',
                                    'slotToElicit': 'string',
                                    'suppressNextMessage': True|False
                                },
                                'intent': {
                                    'name': 'string',
                                    'slots': {
                                        'string': {
                                            'shape': 'Scalar'|'List',
                                            'value': {
                                                'interpretedValue': 'string'
                                            },
                                            'values': [
                                                {'... recursive ...'},
                                            ]
                                        }
                                    }
                                },
                                'sessionAttributes': {
                                    'string': 'string'
                                }
                            },
                            'response': {
                                'messageGroups': [
                                    {
                                        'message': {
                                            'plainTextMessage': {
                                                'value': 'string'
                                            },
                                            'customPayload': {
                                                'value': 'string'
                                            },
                                            'ssmlMessage': {
                                                'value': 'string'
                                            },
                                            'imageResponseCard': {
                                                'title': 'string',
                                                'subtitle': 'string',
                                                'imageUrl': 'string',
                                                'buttons': [
                                                    {
                                                        'text': 'string',
                                                        'value': 'string'
                                                    },
                                                ]
                                            }
                                        },
                                        'variations': [
                                            {
                                                'plainTextMessage': {
                                                    'value': 'string'
                                                },
                                                'customPayload': {
                                                    'value': 'string'
                                                },
                                                'ssmlMessage': {
                                                    'value': 'string'
                                                },
                                                'imageResponseCard': {
                                                    'title': 'string',
                                                    'subtitle': 'string',
                                                    'imageUrl': 'string',
                                                    'buttons': [
                                                        {
                                                            'text': 'string',
                                                            'value': 'string'
                                                        },
                                                    ]
                                                }
                                            },
                                        ]
                                    },
                                ],
                                'allowInterrupt': True|False
                            }
                        }
                    }
                }
            },
            'elicitationCodeHook': {
                'enableCodeHookInvocation': True|False,
                'invocationLabel': 'string'
            }
        }
    },
    'obfuscationSetting': {
        'obfuscationSettingType': 'None'|'DefaultObfuscation'
    },
    'botId': 'string',
    'botVersion': 'string',
    'localeId': 'string',
    'intentId': 'string',
    'creationDateTime': datetime(2015, 1, 1),
    'lastUpdatedDateTime': datetime(2015, 1, 1),
    'multipleValuesSetting': {
        'allowMultipleValues': True|False
    },
    'subSlotSetting': {
        'expression': 'string',
        'slotSpecifications': {
            'string': {
                'slotTypeId': 'string',
                'valueElicitationSetting': {
                    'defaultValueSpecification': {
                        'defaultValueList': [
                            {
                                'defaultValue': 'string'
                            },
                        ]
                    },
                    'promptSpecification': {
                        'messageGroups': [
                            {
                                'message': {
                                    'plainTextMessage': {
                                        'value': 'string'
                                    },
                                    'customPayload': {
                                        'value': 'string'
                                    },
                                    'ssmlMessage': {
                                        'value': 'string'
                                    },
                                    'imageResponseCard': {
                                        'title': 'string',
                                        'subtitle': 'string',
                                        'imageUrl': 'string',
                                        'buttons': [
                                            {
                                                'text': 'string',
                                                'value': 'string'
                                            },
                                        ]
                                    }
                                },
                                'variations': [
                                    {
                                        'plainTextMessage': {
                                            'value': 'string'
                                        },
                                        'customPayload': {
                                            'value': 'string'
                                        },
                                        'ssmlMessage': {
                                            'value': 'string'
                                        },
                                        'imageResponseCard': {
                                            'title': 'string',
                                            'subtitle': 'string',
                                            'imageUrl': 'string',
                                            'buttons': [
                                                {
                                                    'text': 'string',
                                                    'value': 'string'
                                                },
                                            ]
                                        }
                                    },
                                ]
                            },
                        ],
                        'maxRetries': 123,
                        'allowInterrupt': True|False,
                        'messageSelectionStrategy': 'Random'|'Ordered'
                    },
                    'sampleUtterances': [
                        {
                            'utterance': 'string'
                        },
                    ],
                    'waitAndContinueSpecification': {
                        'waitingResponse': {
                            'messageGroups': [
                                {
                                    'message': {
                                        'plainTextMessage': {
                                            'value': 'string'
                                        },
                                        'customPayload': {
                                            'value': 'string'
                                        },
                                        'ssmlMessage': {
                                            'value': 'string'
                                        },
                                        'imageResponseCard': {
                                            'title': 'string',
                                            'subtitle': 'string',
                                            'imageUrl': 'string',
                                            'buttons': [
                                                {
                                                    'text': 'string',
                                                    'value': 'string'
                                                },
                                            ]
                                        }
                                    },
                                    'variations': [
                                        {
                                            'plainTextMessage': {
                                                'value': 'string'
                                            },
                                            'customPayload': {
                                                'value': 'string'
                                            },
                                            'ssmlMessage': {
                                                'value': 'string'
                                            },
                                            'imageResponseCard': {
                                                'title': 'string',
                                                'subtitle': 'string',
                                                'imageUrl': 'string',
                                                'buttons': [
                                                    {
                                                        'text': 'string',
                                                        'value': 'string'
                                                    },
                                                ]
                                            }
                                        },
                                    ]
                                },
                            ],
                            'allowInterrupt': True|False
                        },
                        'continueResponse': {
                            'messageGroups': [
                                {
                                    'message': {
                                        'plainTextMessage': {
                                            'value': 'string'
                                        },
                                        'customPayload': {
                                            'value': 'string'
                                        },
                                        'ssmlMessage': {
                                            'value': 'string'
                                        },
                                        'imageResponseCard': {
                                            'title': 'string',
                                            'subtitle': 'string',
                                            'imageUrl': 'string',
                                            'buttons': [
                                                {
                                                    'text': 'string',
                                                    'value': 'string'
                                                },
                                            ]
                                        }
                                    },
                                    'variations': [
                                        {
                                            'plainTextMessage': {
                                                'value': 'string'
                                            },
                                            'customPayload': {
                                                'value': 'string'
                                            },
                                            'ssmlMessage': {
                                                'value': 'string'
                                            },
                                            'imageResponseCard': {
                                                'title': 'string',
                                                'subtitle': 'string',
                                                'imageUrl': 'string',
                                                'buttons': [
                                                    {
                                                        'text': 'string',
                                                        'value': 'string'
                                                    },
                                                ]
                                            }
                                        },
                                    ]
                                },
                            ],
                            'allowInterrupt': True|False
                        },
                        'stillWaitingResponse': {
                            'messageGroups': [
                                {
                                    'message': {
                                        'plainTextMessage': {
                                            'value': 'string'
                                        },
                                        'customPayload': {
                                            'value': 'string'
                                        },
                                        'ssmlMessage': {
                                            'value': 'string'
                                        },
                                        'imageResponseCard': {
                                            'title': 'string',
                                            'subtitle': 'string',
                                            'imageUrl': 'string',
                                            'buttons': [
                                                {
                                                    'text': 'string',
                                                    'value': 'string'
                                                },
                                            ]
                                        }
                                    },
                                    'variations': [
                                        {
                                            'plainTextMessage': {
                                                'value': 'string'
                                            },
                                            'customPayload': {
                                                'value': 'string'
                                            },
                                            'ssmlMessage': {
                                                'value': 'string'
                                            },
                                            'imageResponseCard': {
                                                'title': 'string',
                                                'subtitle': 'string',
                                                'imageUrl': 'string',
                                                'buttons': [
                                                    {
                                                        'text': 'string',
                                                        'value': 'string'
                                                    },
                                                ]
                                            }
                                        },
                                    ]
                                },
                            ],
                            'frequencyInSeconds': 123,
                            'timeoutInSeconds': 123,
                            'allowInterrupt': True|False
                        },
                        'active': True|False
                    }
                }
            }
        }
    }
}

Response Structure

  • (dict) --

    • slotId (string) --

      The unique identifier generated for the slot.

    • slotName (string) --

      The name specified for the slot.

    • description (string) --

      The description specified for the slot.

    • slotTypeId (string) --

      The identifier of the slot type that determines the values entered into the slot.

    • valueElicitationSetting (dict) --

      Prompts that Amazon Lex uses to elicit a value for the slot.

      • defaultValueSpecification (dict) --

        A list of default values for a slot. Default values are used when Amazon Lex hasn't determined a value for a slot. You can specify default values from context variables, session attributes, and defined values.

        • defaultValueList (list) --

          A list of default values. Amazon Lex chooses the default value to use in the order that they are presented in the list.

          • (dict) --

            Specifies the default value to use when a user doesn't provide a value for a slot.

            • defaultValue (string) --

              The default value to use when a user doesn't provide a value for a slot.

      • slotConstraint (string) --

        Specifies whether the slot is required or optional.

      • promptSpecification (dict) --

        The prompt that Amazon Lex uses to elicit the slot value from the user.

        • messageGroups (list) --

          A collection of messages that Amazon Lex can send to the user. Amazon Lex chooses the actual message to send at runtime.

          • (dict) --

            Provides one or more messages that Amazon Lex should send to the user.

            • message (dict) --

              The primary message that Amazon Lex should send to the user.

              • plainTextMessage (dict) --

                A message in plain text format.

                • value (string) --

                  The message to send to the user.

              • customPayload (dict) --

                A message in a custom format defined by the client application.

                • value (string) --

                  The string that is sent to your application.

              • ssmlMessage (dict) --

                A message in Speech Synthesis Markup Language (SSML).

                • value (string) --

                  The SSML text that defines the prompt.

              • imageResponseCard (dict) --

                A message that defines a response card that the client application can show to the user.

                • title (string) --

                  The title to display on the response card. The format of the title is determined by the platform displaying the response card.

                • subtitle (string) --

                  The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

                • imageUrl (string) --

                  The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

                • buttons (list) --

                  A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.

                  • (dict) --

                    Describes a button to use on a response card used to gather slot values from a user.

                    • text (string) --

                      The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

                    • value (string) --

                      The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

            • variations (list) --

              Message variations to send to the user. When variations are defined, Amazon Lex chooses the primary message or one of the variations to send to the user.

              • (dict) --

                The object that provides message text and it's type.

                • plainTextMessage (dict) --

                  A message in plain text format.

                  • value (string) --

                    The message to send to the user.

                • customPayload (dict) --

                  A message in a custom format defined by the client application.

                  • value (string) --

                    The string that is sent to your application.

                • ssmlMessage (dict) --

                  A message in Speech Synthesis Markup Language (SSML).

                  • value (string) --

                    The SSML text that defines the prompt.

                • imageResponseCard (dict) --

                  A message that defines a response card that the client application can show to the user.

                  • title (string) --

                    The title to display on the response card. The format of the title is determined by the platform displaying the response card.

                  • subtitle (string) --

                    The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

                  • imageUrl (string) --

                    The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

                  • buttons (list) --

                    A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.

                    • (dict) --

                      Describes a button to use on a response card used to gather slot values from a user.

                      • text (string) --

                        The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

                      • value (string) --

                        The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

        • maxRetries (integer) --

          The maximum number of times the bot tries to elicit a response from the user using this prompt.

        • allowInterrupt (boolean) --

          Indicates whether the user can interrupt a speech prompt from the bot.

        • messageSelectionStrategy (string) --

          Indicates how a message is selected from a message group among retries.

      • sampleUtterances (list) --

        If you know a specific pattern that users might respond to an Amazon Lex request for a slot value, you can provide those utterances to improve accuracy. This is optional. In most cases, Amazon Lex is capable of understanding user utterances.

        • (dict) --

          A sample utterance that invokes an intent or respond to a slot elicitation prompt.

          • utterance (string) --

            The sample utterance that Amazon Lex uses to build its machine-learning model to recognize intents.

      • waitAndContinueSpecification (dict) --

        Specifies the prompts that Amazon Lex uses while a bot is waiting for customer input.

        • waitingResponse (dict) --

          The response that Amazon Lex sends to indicate that the bot is waiting for the conversation to continue.

          • messageGroups (list) --

            A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.

            • (dict) --

              Provides one or more messages that Amazon Lex should send to the user.

              • message (dict) --

                The primary message that Amazon Lex should send to the user.

                • plainTextMessage (dict) --

                  A message in plain text format.

                  • value (string) --

                    The message to send to the user.

                • customPayload (dict) --

                  A message in a custom format defined by the client application.

                  • value (string) --

                    The string that is sent to your application.

                • ssmlMessage (dict) --

                  A message in Speech Synthesis Markup Language (SSML).

                  • value (string) --

                    The SSML text that defines the prompt.

                • imageResponseCard (dict) --

                  A message that defines a response card that the client application can show to the user.

                  • title (string) --

                    The title to display on the response card. The format of the title is determined by the platform displaying the response card.

                  • subtitle (string) --

                    The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

                  • imageUrl (string) --

                    The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

                  • buttons (list) --

                    A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.

                    • (dict) --

                      Describes a button to use on a response card used to gather slot values from a user.

                      • text (string) --

                        The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

                      • value (string) --

                        The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

              • variations (list) --

                Message variations to send to the user. When variations are defined, Amazon Lex chooses the primary message or one of the variations to send to the user.

                • (dict) --

                  The object that provides message text and it's type.

                  • plainTextMessage (dict) --

                    A message in plain text format.

                    • value (string) --

                      The message to send to the user.

                  • customPayload (dict) --

                    A message in a custom format defined by the client application.

                    • value (string) --

                      The string that is sent to your application.

                  • ssmlMessage (dict) --

                    A message in Speech Synthesis Markup Language (SSML).

                    • value (string) --

                      The SSML text that defines the prompt.

                  • imageResponseCard (dict) --

                    A message that defines a response card that the client application can show to the user.

                    • title (string) --

                      The title to display on the response card. The format of the title is determined by the platform displaying the response card.

                    • subtitle (string) --

                      The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

                    • imageUrl (string) --

                      The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

                    • buttons (list) --

                      A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.

                      • (dict) --

                        Describes a button to use on a response card used to gather slot values from a user.

                        • text (string) --

                          The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

                        • value (string) --

                          The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

          • allowInterrupt (boolean) --

            Indicates whether the user can interrupt a speech response from Amazon Lex.

        • continueResponse (dict) --

          The response that Amazon Lex sends to indicate that the bot is ready to continue the conversation.

          • messageGroups (list) --

            A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.

            • (dict) --

              Provides one or more messages that Amazon Lex should send to the user.

              • message (dict) --

                The primary message that Amazon Lex should send to the user.

                • plainTextMessage (dict) --

                  A message in plain text format.

                  • value (string) --

                    The message to send to the user.

                • customPayload (dict) --

                  A message in a custom format defined by the client application.

                  • value (string) --

                    The string that is sent to your application.

                • ssmlMessage (dict) --

                  A message in Speech Synthesis Markup Language (SSML).

                  • value (string) --

                    The SSML text that defines the prompt.

                • imageResponseCard (dict) --

                  A message that defines a response card that the client application can show to the user.

                  • title (string) --

                    The title to display on the response card. The format of the title is determined by the platform displaying the response card.

                  • subtitle (string) --

                    The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

                  • imageUrl (string) --

                    The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

                  • buttons (list) --

                    A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.

                    • (dict) --

                      Describes a button to use on a response card used to gather slot values from a user.

                      • text (string) --

                        The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

                      • value (string) --

                        The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

              • variations (list) --

                Message variations to send to the user. When variations are defined, Amazon Lex chooses the primary message or one of the variations to send to the user.

                • (dict) --

                  The object that provides message text and it's type.

                  • plainTextMessage (dict) --

                    A message in plain text format.

                    • value (string) --

                      The message to send to the user.

                  • customPayload (dict) --

                    A message in a custom format defined by the client application.

                    • value (string) --

                      The string that is sent to your application.

                  • ssmlMessage (dict) --

                    A message in Speech Synthesis Markup Language (SSML).

                    • value (string) --

                      The SSML text that defines the prompt.

                  • imageResponseCard (dict) --

                    A message that defines a response card that the client application can show to the user.

                    • title (string) --

                      The title to display on the response card. The format of the title is determined by the platform displaying the response card.

                    • subtitle (string) --

                      The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

                    • imageUrl (string) --

                      The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

                    • buttons (list) --

                      A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.

                      • (dict) --

                        Describes a button to use on a response card used to gather slot values from a user.

                        • text (string) --

                          The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

                        • value (string) --

                          The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

          • allowInterrupt (boolean) --

            Indicates whether the user can interrupt a speech response from Amazon Lex.

        • stillWaitingResponse (dict) --

          A response that Amazon Lex sends periodically to the user to indicate that the bot is still waiting for input from the user.

          • messageGroups (list) --

            One or more message groups, each containing one or more messages, that define the prompts that Amazon Lex sends to the user.

            • (dict) --

              Provides one or more messages that Amazon Lex should send to the user.

              • message (dict) --

                The primary message that Amazon Lex should send to the user.

                • plainTextMessage (dict) --

                  A message in plain text format.

                  • value (string) --

                    The message to send to the user.

                • customPayload (dict) --

                  A message in a custom format defined by the client application.

                  • value (string) --

                    The string that is sent to your application.

                • ssmlMessage (dict) --

                  A message in Speech Synthesis Markup Language (SSML).

                  • value (string) --

                    The SSML text that defines the prompt.

                • imageResponseCard (dict) --

                  A message that defines a response card that the client application can show to the user.

                  • title (string) --

                    The title to display on the response card. The format of the title is determined by the platform displaying the response card.

                  • subtitle (string) --

                    The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

                  • imageUrl (string) --

                    The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

                  • buttons (list) --

                    A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.

                    • (dict) --

                      Describes a button to use on a response card used to gather slot values from a user.

                      • text (string) --

                        The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

                      • value (string) --

                        The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

              • variations (list) --

                Message variations to send to the user. When variations are defined, Amazon Lex chooses the primary message or one of the variations to send to the user.

                • (dict) --

                  The object that provides message text and it's type.

                  • plainTextMessage (dict) --

                    A message in plain text format.

                    • value (string) --

                      The message to send to the user.

                  • customPayload (dict) --

                    A message in a custom format defined by the client application.

                    • value (string) --

                      The string that is sent to your application.

                  • ssmlMessage (dict) --

                    A message in Speech Synthesis Markup Language (SSML).

                    • value (string) --

                      The SSML text that defines the prompt.

                  • imageResponseCard (dict) --

                    A message that defines a response card that the client application can show to the user.

                    • title (string) --

                      The title to display on the response card. The format of the title is determined by the platform displaying the response card.

                    • subtitle (string) --

                      The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

                    • imageUrl (string) --

                      The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

                    • buttons (list) --

                      A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.

                      • (dict) --

                        Describes a button to use on a response card used to gather slot values from a user.

                        • text (string) --

                          The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

                        • value (string) --

                          The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

          • frequencyInSeconds (integer) --

            How often a message should be sent to the user. Minimum of 1 second, maximum of 5 minutes.

          • timeoutInSeconds (integer) --

            If Amazon Lex waits longer than this length of time for a response, it will stop sending messages.

          • allowInterrupt (boolean) --

            Indicates that the user can interrupt the response by speaking while the message is being played.

        • active (boolean) --

          Specifies whether the bot will wait for a user to respond. When this field is false, wait and continue responses for a slot aren't used. If the active field isn't specified, the default is true.

      • slotCaptureSetting (dict) --

        Specifies the settings that Amazon Lex uses when a slot value is successfully entered by a user.

        • captureResponse (dict) --

          Specifies a list of message groups that Amazon Lex uses to respond the user input.

          • messageGroups (list) --

            A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.

            • (dict) --

              Provides one or more messages that Amazon Lex should send to the user.

              • message (dict) --

                The primary message that Amazon Lex should send to the user.

                • plainTextMessage (dict) --

                  A message in plain text format.

                  • value (string) --

                    The message to send to the user.

                • customPayload (dict) --

                  A message in a custom format defined by the client application.

                  • value (string) --

                    The string that is sent to your application.

                • ssmlMessage (dict) --

                  A message in Speech Synthesis Markup Language (SSML).

                  • value (string) --

                    The SSML text that defines the prompt.

                • imageResponseCard (dict) --

                  A message that defines a response card that the client application can show to the user.

                  • title (string) --

                    The title to display on the response card. The format of the title is determined by the platform displaying the response card.

                  • subtitle (string) --

                    The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

                  • imageUrl (string) --

                    The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

                  • buttons (list) --

                    A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.

                    • (dict) --

                      Describes a button to use on a response card used to gather slot values from a user.

                      • text (string) --

                        The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

                      • value (string) --

                        The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

              • variations (list) --

                Message variations to send to the user. When variations are defined, Amazon Lex chooses the primary message or one of the variations to send to the user.

                • (dict) --

                  The object that provides message text and it's type.

                  • plainTextMessage (dict) --

                    A message in plain text format.

                    • value (string) --

                      The message to send to the user.

                  • customPayload (dict) --

                    A message in a custom format defined by the client application.

                    • value (string) --

                      The string that is sent to your application.

                  • ssmlMessage (dict) --

                    A message in Speech Synthesis Markup Language (SSML).

                    • value (string) --

                      The SSML text that defines the prompt.

                  • imageResponseCard (dict) --

                    A message that defines a response card that the client application can show to the user.

                    • title (string) --

                      The title to display on the response card. The format of the title is determined by the platform displaying the response card.

                    • subtitle (string) --

                      The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

                    • imageUrl (string) --

                      The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

                    • buttons (list) --

                      A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.

                      • (dict) --

                        Describes a button to use on a response card used to gather slot values from a user.

                        • text (string) --

                          The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

                        • value (string) --

                          The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

          • allowInterrupt (boolean) --

            Indicates whether the user can interrupt a speech response from Amazon Lex.

        • captureNextStep (dict) --

          Specifies the next step that the bot runs when the slot value is captured before the code hook times out.

          • dialogAction (dict) --

            Defines the action that the bot executes at runtime when the conversation reaches this step.

            • type (string) --

              The action that the bot should execute.

            • slotToElicit (string) --

              If the dialog action is ElicitSlot , defines the slot to elicit from the user.

            • suppressNextMessage (boolean) --

              When true the next message for the intent is not used.

          • intent (dict) --

            Override settings to configure the intent state.

            • name (string) --

              The name of the intent. Only required when you're switching intents.

            • slots (dict) --

              A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.,

              • (string) --

                • (dict) --

                  The slot values that Amazon Lex uses when it sets slot values in a dialog step.

                  • shape (string) --

                    When the shape value is List , it indicates that the values field contains a list of slot values. When the value is Scalar , it indicates that the value field contains a single value.

                  • value (dict) --

                    The current value of the slot.

                    • interpretedValue (string) --

                      The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the resolvedValues list.

                  • values (list) --

                    A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."

                    • (dict) --

                      The slot values that Amazon Lex uses when it sets slot values in a dialog step.

          • sessionAttributes (dict) --

            Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.

            • (string) --

              • (string) --

        • captureConditional (dict) --

          A list of conditional branches to evaluate after the slot value is captured.

          • active (boolean) --

            Determines whether a conditional branch is active. When active is false, the conditions are not evaluated.

          • conditionalBranches (list) --

            A list of conditional branches. A conditional branch is made up of a condition, a response and a next step. The response and next step are executed when the condition is true.

            • (dict) --

              A set of actions that Amazon Lex should run if the condition is matched.

              • name (string) --

                The name of the branch.

              • condition (dict) --

                Contains the expression to evaluate. If the condition is true, the branch's actions are taken.

                • expressionString (string) --

                  The expression string that is evaluated.

              • nextStep (dict) --

                The next step in the conversation.

                • dialogAction (dict) --

                  Defines the action that the bot executes at runtime when the conversation reaches this step.

                  • type (string) --

                    The action that the bot should execute.

                  • slotToElicit (string) --

                    If the dialog action is ElicitSlot , defines the slot to elicit from the user.

                  • suppressNextMessage (boolean) --

                    When true the next message for the intent is not used.

                • intent (dict) --

                  Override settings to configure the intent state.

                  • name (string) --

                    The name of the intent. Only required when you're switching intents.

                  • slots (dict) --

                    A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.,

                    • (string) --

                      • (dict) --

                        The slot values that Amazon Lex uses when it sets slot values in a dialog step.

                        • shape (string) --

                          When the shape value is List , it indicates that the values field contains a list of slot values. When the value is Scalar , it indicates that the value field contains a single value.

                        • value (dict) --

                          The current value of the slot.

                          • interpretedValue (string) --

                            The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the resolvedValues list.

                        • values (list) --

                          A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."

                          • (dict) --

                            The slot values that Amazon Lex uses when it sets slot values in a dialog step.

                • sessionAttributes (dict) --

                  Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.

                  • (string) --

                    • (string) --

              • response (dict) --

                Specifies a list of message groups that Amazon Lex uses to respond the user input.

                • messageGroups (list) --

                  A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.

                  • (dict) --

                    Provides one or more messages that Amazon Lex should send to the user.

                    • message (dict) --

                      The primary message that Amazon Lex should send to the user.

                      • plainTextMessage (dict) --

                        A message in plain text format.

                        • value (string) --

                          The message to send to the user.

                      • customPayload (dict) --

                        A message in a custom format defined by the client application.

                        • value (string) --

                          The string that is sent to your application.

                      • ssmlMessage (dict) --

                        A message in Speech Synthesis Markup Language (SSML).

                        • value (string) --

                          The SSML text that defines the prompt.

                      • imageResponseCard (dict) --

                        A message that defines a response card that the client application can show to the user.

                        • title (string) --

                          The title to display on the response card. The format of the title is determined by the platform displaying the response card.

                        • subtitle (string) --

                          The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

                        • imageUrl (string) --

                          The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

                        • buttons (list) --

                          A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.

                          • (dict) --

                            Describes a button to use on a response card used to gather slot values from a user.

                            • text (string) --

                              The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

                            • value (string) --

                              The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

                    • variations (list) --

                      Message variations to send to the user. When variations are defined, Amazon Lex chooses the primary message or one of the variations to send to the user.

                      • (dict) --

                        The object that provides message text and it's type.

                        • plainTextMessage (dict) --

                          A message in plain text format.

                          • value (string) --

                            The message to send to the user.

                        • customPayload (dict) --

                          A message in a custom format defined by the client application.

                          • value (string) --

                            The string that is sent to your application.

                        • ssmlMessage (dict) --

                          A message in Speech Synthesis Markup Language (SSML).

                          • value (string) --

                            The SSML text that defines the prompt.

                        • imageResponseCard (dict) --

                          A message that defines a response card that the client application can show to the user.

                          • title (string) --

                            The title to display on the response card. The format of the title is determined by the platform displaying the response card.

                          • subtitle (string) --

                            The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

                          • imageUrl (string) --

                            The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

                          • buttons (list) --

                            A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.

                            • (dict) --

                              Describes a button to use on a response card used to gather slot values from a user.

                              • text (string) --

                                The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

                              • value (string) --

                                The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

                • allowInterrupt (boolean) --

                  Indicates whether the user can interrupt a speech response from Amazon Lex.

          • defaultBranch (dict) --

            The conditional branch that should be followed when the conditions for other branches are not satisfied. A conditional branch is made up of a condition, a response and a next step.

            • nextStep (dict) --

              The next step in the conversation.

              • dialogAction (dict) --

                Defines the action that the bot executes at runtime when the conversation reaches this step.

                • type (string) --

                  The action that the bot should execute.

                • slotToElicit (string) --

                  If the dialog action is ElicitSlot , defines the slot to elicit from the user.

                • suppressNextMessage (boolean) --

                  When true the next message for the intent is not used.

              • intent (dict) --

                Override settings to configure the intent state.

                • name (string) --

                  The name of the intent. Only required when you're switching intents.

                • slots (dict) --

                  A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.,

                  • (string) --

                    • (dict) --

                      The slot values that Amazon Lex uses when it sets slot values in a dialog step.

                      • shape (string) --

                        When the shape value is List , it indicates that the values field contains a list of slot values. When the value is Scalar , it indicates that the value field contains a single value.

                      • value (dict) --

                        The current value of the slot.

                        • interpretedValue (string) --

                          The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the resolvedValues list.

                      • values (list) --

                        A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."

                        • (dict) --

                          The slot values that Amazon Lex uses when it sets slot values in a dialog step.

              • sessionAttributes (dict) --

                Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.

                • (string) --

                  • (string) --

            • response (dict) --

              Specifies a list of message groups that Amazon Lex uses to respond the user input.

              • messageGroups (list) --

                A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.

                • (dict) --

                  Provides one or more messages that Amazon Lex should send to the user.

                  • message (dict) --

                    The primary message that Amazon Lex should send to the user.

                    • plainTextMessage (dict) --

                      A message in plain text format.

                      • value (string) --

                        The message to send to the user.

                    • customPayload (dict) --

                      A message in a custom format defined by the client application.

                      • value (string) --

                        The string that is sent to your application.

                    • ssmlMessage (dict) --

                      A message in Speech Synthesis Markup Language (SSML).

                      • value (string) --

                        The SSML text that defines the prompt.

                    • imageResponseCard (dict) --

                      A message that defines a response card that the client application can show to the user.

                      • title (string) --

                        The title to display on the response card. The format of the title is determined by the platform displaying the response card.

                      • subtitle (string) --

                        The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

                      • imageUrl (string) --

                        The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

                      • buttons (list) --

                        A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.

                        • (dict) --

                          Describes a button to use on a response card used to gather slot values from a user.

                          • text (string) --

                            The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

                          • value (string) --

                            The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

                  • variations (list) --

                    Message variations to send to the user. When variations are defined, Amazon Lex chooses the primary message or one of the variations to send to the user.

                    • (dict) --

                      The object that provides message text and it's type.

                      • plainTextMessage (dict) --

                        A message in plain text format.

                        • value (string) --

                          The message to send to the user.

                      • customPayload (dict) --

                        A message in a custom format defined by the client application.

                        • value (string) --

                          The string that is sent to your application.

                      • ssmlMessage (dict) --

                        A message in Speech Synthesis Markup Language (SSML).

                        • value (string) --

                          The SSML text that defines the prompt.

                      • imageResponseCard (dict) --

                        A message that defines a response card that the client application can show to the user.

                        • title (string) --

                          The title to display on the response card. The format of the title is determined by the platform displaying the response card.

                        • subtitle (string) --

                          The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

                        • imageUrl (string) --

                          The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

                        • buttons (list) --

                          A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.

                          • (dict) --

                            Describes a button to use on a response card used to gather slot values from a user.

                            • text (string) --

                              The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

                            • value (string) --

                              The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

              • allowInterrupt (boolean) --

                Indicates whether the user can interrupt a speech response from Amazon Lex.

        • failureResponse (dict) --

          Specifies a list of message groups that Amazon Lex uses to respond the user input.

          • messageGroups (list) --

            A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.

            • (dict) --

              Provides one or more messages that Amazon Lex should send to the user.

              • message (dict) --

                The primary message that Amazon Lex should send to the user.

                • plainTextMessage (dict) --

                  A message in plain text format.

                  • value (string) --

                    The message to send to the user.

                • customPayload (dict) --

                  A message in a custom format defined by the client application.

                  • value (string) --

                    The string that is sent to your application.

                • ssmlMessage (dict) --

                  A message in Speech Synthesis Markup Language (SSML).

                  • value (string) --

                    The SSML text that defines the prompt.

                • imageResponseCard (dict) --

                  A message that defines a response card that the client application can show to the user.

                  • title (string) --

                    The title to display on the response card. The format of the title is determined by the platform displaying the response card.

                  • subtitle (string) --

                    The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

                  • imageUrl (string) --

                    The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

                  • buttons (list) --

                    A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.

                    • (dict) --

                      Describes a button to use on a response card used to gather slot values from a user.

                      • text (string) --

                        The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

                      • value (string) --

                        The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

              • variations (list) --

                Message variations to send to the user. When variations are defined, Amazon Lex chooses the primary message or one of the variations to send to the user.

                • (dict) --

                  The object that provides message text and it's type.

                  • plainTextMessage (dict) --

                    A message in plain text format.

                    • value (string) --

                      The message to send to the user.

                  • customPayload (dict) --

                    A message in a custom format defined by the client application.

                    • value (string) --

                      The string that is sent to your application.

                  • ssmlMessage (dict) --

                    A message in Speech Synthesis Markup Language (SSML).

                    • value (string) --

                      The SSML text that defines the prompt.

                  • imageResponseCard (dict) --

                    A message that defines a response card that the client application can show to the user.

                    • title (string) --

                      The title to display on the response card. The format of the title is determined by the platform displaying the response card.

                    • subtitle (string) --

                      The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

                    • imageUrl (string) --

                      The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

                    • buttons (list) --

                      A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.

                      • (dict) --

                        Describes a button to use on a response card used to gather slot values from a user.

                        • text (string) --

                          The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

                        • value (string) --

                          The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

          • allowInterrupt (boolean) --

            Indicates whether the user can interrupt a speech response from Amazon Lex.

        • failureNextStep (dict) --

          Specifies the next step that the bot runs when the slot value code is not recognized.

          • dialogAction (dict) --

            Defines the action that the bot executes at runtime when the conversation reaches this step.

            • type (string) --

              The action that the bot should execute.

            • slotToElicit (string) --

              If the dialog action is ElicitSlot , defines the slot to elicit from the user.

            • suppressNextMessage (boolean) --

              When true the next message for the intent is not used.

          • intent (dict) --

            Override settings to configure the intent state.

            • name (string) --

              The name of the intent. Only required when you're switching intents.

            • slots (dict) --

              A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.,

              • (string) --

                • (dict) --

                  The slot values that Amazon Lex uses when it sets slot values in a dialog step.

                  • shape (string) --

                    When the shape value is List , it indicates that the values field contains a list of slot values. When the value is Scalar , it indicates that the value field contains a single value.

                  • value (dict) --

                    The current value of the slot.

                    • interpretedValue (string) --

                      The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the resolvedValues list.

                  • values (list) --

                    A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."

                    • (dict) --

                      The slot values that Amazon Lex uses when it sets slot values in a dialog step.

          • sessionAttributes (dict) --

            Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.

            • (string) --

              • (string) --

        • failureConditional (dict) --

          A list of conditional branches to evaluate when the slot value isn't captured.

          • active (boolean) --

            Determines whether a conditional branch is active. When active is false, the conditions are not evaluated.

          • conditionalBranches (list) --

            A list of conditional branches. A conditional branch is made up of a condition, a response and a next step. The response and next step are executed when the condition is true.

            • (dict) --

              A set of actions that Amazon Lex should run if the condition is matched.

              • name (string) --

                The name of the branch.

              • condition (dict) --

                Contains the expression to evaluate. If the condition is true, the branch's actions are taken.

                • expressionString (string) --

                  The expression string that is evaluated.

              • nextStep (dict) --

                The next step in the conversation.

                • dialogAction (dict) --

                  Defines the action that the bot executes at runtime when the conversation reaches this step.

                  • type (string) --

                    The action that the bot should execute.

                  • slotToElicit (string) --

                    If the dialog action is ElicitSlot , defines the slot to elicit from the user.

                  • suppressNextMessage (boolean) --

                    When true the next message for the intent is not used.

                • intent (dict) --

                  Override settings to configure the intent state.

                  • name (string) --

                    The name of the intent. Only required when you're switching intents.

                  • slots (dict) --

                    A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.,

                    • (string) --

                      • (dict) --

                        The slot values that Amazon Lex uses when it sets slot values in a dialog step.

                        • shape (string) --

                          When the shape value is List , it indicates that the values field contains a list of slot values. When the value is Scalar , it indicates that the value field contains a single value.

                        • value (dict) --

                          The current value of the slot.

                          • interpretedValue (string) --

                            The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the resolvedValues list.

                        • values (list) --

                          A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."

                          • (dict) --

                            The slot values that Amazon Lex uses when it sets slot values in a dialog step.

                • sessionAttributes (dict) --

                  Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.

                  • (string) --

                    • (string) --

              • response (dict) --

                Specifies a list of message groups that Amazon Lex uses to respond the user input.

                • messageGroups (list) --

                  A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.

                  • (dict) --

                    Provides one or more messages that Amazon Lex should send to the user.

                    • message (dict) --

                      The primary message that Amazon Lex should send to the user.

                      • plainTextMessage (dict) --

                        A message in plain text format.

                        • value (string) --

                          The message to send to the user.

                      • customPayload (dict) --

                        A message in a custom format defined by the client application.

                        • value (string) --

                          The string that is sent to your application.

                      • ssmlMessage (dict) --

                        A message in Speech Synthesis Markup Language (SSML).

                        • value (string) --

                          The SSML text that defines the prompt.

                      • imageResponseCard (dict) --

                        A message that defines a response card that the client application can show to the user.

                        • title (string) --

                          The title to display on the response card. The format of the title is determined by the platform displaying the response card.

                        • subtitle (string) --

                          The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

                        • imageUrl (string) --

                          The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

                        • buttons (list) --

                          A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.

                          • (dict) --

                            Describes a button to use on a response card used to gather slot values from a user.

                            • text (string) --

                              The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

                            • value (string) --

                              The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

                    • variations (list) --

                      Message variations to send to the user. When variations are defined, Amazon Lex chooses the primary message or one of the variations to send to the user.

                      • (dict) --

                        The object that provides message text and it's type.

                        • plainTextMessage (dict) --

                          A message in plain text format.

                          • value (string) --

                            The message to send to the user.

                        • customPayload (dict) --

                          A message in a custom format defined by the client application.

                          • value (string) --

                            The string that is sent to your application.

                        • ssmlMessage (dict) --

                          A message in Speech Synthesis Markup Language (SSML).

                          • value (string) --

                            The SSML text that defines the prompt.

                        • imageResponseCard (dict) --

                          A message that defines a response card that the client application can show to the user.

                          • title (string) --

                            The title to display on the response card. The format of the title is determined by the platform displaying the response card.

                          • subtitle (string) --

                            The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

                          • imageUrl (string) --

                            The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

                          • buttons (list) --

                            A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.

                            • (dict) --

                              Describes a button to use on a response card used to gather slot values from a user.

                              • text (string) --

                                The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

                              • value (string) --

                                The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

                • allowInterrupt (boolean) --

                  Indicates whether the user can interrupt a speech response from Amazon Lex.

          • defaultBranch (dict) --

            The conditional branch that should be followed when the conditions for other branches are not satisfied. A conditional branch is made up of a condition, a response and a next step.

            • nextStep (dict) --

              The next step in the conversation.

              • dialogAction (dict) --

                Defines the action that the bot executes at runtime when the conversation reaches this step.

                • type (string) --

                  The action that the bot should execute.

                • slotToElicit (string) --

                  If the dialog action is ElicitSlot , defines the slot to elicit from the user.

                • suppressNextMessage (boolean) --

                  When true the next message for the intent is not used.

              • intent (dict) --

                Override settings to configure the intent state.

                • name (string) --

                  The name of the intent. Only required when you're switching intents.

                • slots (dict) --

                  A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.,

                  • (string) --

                    • (dict) --

                      The slot values that Amazon Lex uses when it sets slot values in a dialog step.

                      • shape (string) --

                        When the shape value is List , it indicates that the values field contains a list of slot values. When the value is Scalar , it indicates that the value field contains a single value.

                      • value (dict) --

                        The current value of the slot.

                        • interpretedValue (string) --

                          The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the resolvedValues list.

                      • values (list) --

                        A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."

                        • (dict) --

                          The slot values that Amazon Lex uses when it sets slot values in a dialog step.

              • sessionAttributes (dict) --

                Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.

                • (string) --

                  • (string) --

            • response (dict) --

              Specifies a list of message groups that Amazon Lex uses to respond the user input.

              • messageGroups (list) --

                A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.

                • (dict) --

                  Provides one or more messages that Amazon Lex should send to the user.

                  • message (dict) --

                    The primary message that Amazon Lex should send to the user.

                    • plainTextMessage (dict) --

                      A message in plain text format.

                      • value (string) --

                        The message to send to the user.

                    • customPayload (dict) --

                      A message in a custom format defined by the client application.

                      • value (string) --

                        The string that is sent to your application.

                    • ssmlMessage (dict) --

                      A message in Speech Synthesis Markup Language (SSML).

                      • value (string) --

                        The SSML text that defines the prompt.

                    • imageResponseCard (dict) --

                      A message that defines a response card that the client application can show to the user.

                      • title (string) --

                        The title to display on the response card. The format of the title is determined by the platform displaying the response card.

                      • subtitle (string) --

                        The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

                      • imageUrl (string) --

                        The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

                      • buttons (list) --

                        A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.

                        • (dict) --

                          Describes a button to use on a response card used to gather slot values from a user.

                          • text (string) --

                            The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

                          • value (string) --

                            The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

                  • variations (list) --

                    Message variations to send to the user. When variations are defined, Amazon Lex chooses the primary message or one of the variations to send to the user.

                    • (dict) --

                      The object that provides message text and it's type.

                      • plainTextMessage (dict) --

                        A message in plain text format.

                        • value (string) --

                          The message to send to the user.

                      • customPayload (dict) --

                        A message in a custom format defined by the client application.

                        • value (string) --

                          The string that is sent to your application.

                      • ssmlMessage (dict) --

                        A message in Speech Synthesis Markup Language (SSML).

                        • value (string) --

                          The SSML text that defines the prompt.

                      • imageResponseCard (dict) --

                        A message that defines a response card that the client application can show to the user.

                        • title (string) --

                          The title to display on the response card. The format of the title is determined by the platform displaying the response card.

                        • subtitle (string) --

                          The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

                        • imageUrl (string) --

                          The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

                        • buttons (list) --

                          A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.

                          • (dict) --

                            Describes a button to use on a response card used to gather slot values from a user.

                            • text (string) --

                              The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

                            • value (string) --

                              The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

              • allowInterrupt (boolean) --

                Indicates whether the user can interrupt a speech response from Amazon Lex.

        • codeHook (dict) --

          Code hook called after Amazon Lex successfully captures a slot value.

          • enableCodeHookInvocation (boolean) --

            Indicates whether a Lambda function should be invoked for the dialog.

          • active (boolean) --

            Determines whether a dialog code hook is used when the intent is activated.

          • invocationLabel (string) --

            A label that indicates the dialog step from which the dialog code hook is happening.

          • postCodeHookSpecification (dict) --

            Contains the responses and actions that Amazon Lex takes after the Lambda function is complete.

            • successResponse (dict) --

              Specifies a list of message groups that Amazon Lex uses to respond the user input.

              • messageGroups (list) --

                A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.

                • (dict) --

                  Provides one or more messages that Amazon Lex should send to the user.

                  • message (dict) --

                    The primary message that Amazon Lex should send to the user.

                    • plainTextMessage (dict) --

                      A message in plain text format.

                      • value (string) --

                        The message to send to the user.

                    • customPayload (dict) --

                      A message in a custom format defined by the client application.

                      • value (string) --

                        The string that is sent to your application.

                    • ssmlMessage (dict) --

                      A message in Speech Synthesis Markup Language (SSML).

                      • value (string) --

                        The SSML text that defines the prompt.

                    • imageResponseCard (dict) --

                      A message that defines a response card that the client application can show to the user.

                      • title (string) --

                        The title to display on the response card. The format of the title is determined by the platform displaying the response card.

                      • subtitle (string) --

                        The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

                      • imageUrl (string) --

                        The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

                      • buttons (list) --

                        A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.

                        • (dict) --

                          Describes a button to use on a response card used to gather slot values from a user.

                          • text (string) --

                            The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

                          • value (string) --

                            The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

                  • variations (list) --

                    Message variations to send to the user. When variations are defined, Amazon Lex chooses the primary message or one of the variations to send to the user.

                    • (dict) --

                      The object that provides message text and it's type.

                      • plainTextMessage (dict) --

                        A message in plain text format.

                        • value (string) --

                          The message to send to the user.

                      • customPayload (dict) --

                        A message in a custom format defined by the client application.

                        • value (string) --

                          The string that is sent to your application.

                      • ssmlMessage (dict) --

                        A message in Speech Synthesis Markup Language (SSML).

                        • value (string) --

                          The SSML text that defines the prompt.

                      • imageResponseCard (dict) --

                        A message that defines a response card that the client application can show to the user.

                        • title (string) --

                          The title to display on the response card. The format of the title is determined by the platform displaying the response card.

                        • subtitle (string) --

                          The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

                        • imageUrl (string) --

                          The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

                        • buttons (list) --

                          A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.

                          • (dict) --

                            Describes a button to use on a response card used to gather slot values from a user.

                            • text (string) --

                              The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

                            • value (string) --

                              The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

              • allowInterrupt (boolean) --

                Indicates whether the user can interrupt a speech response from Amazon Lex.

            • successNextStep (dict) --

              Specifics the next step the bot runs after the dialog code hook finishes successfully.

              • dialogAction (dict) --

                Defines the action that the bot executes at runtime when the conversation reaches this step.

                • type (string) --

                  The action that the bot should execute.

                • slotToElicit (string) --

                  If the dialog action is ElicitSlot , defines the slot to elicit from the user.

                • suppressNextMessage (boolean) --

                  When true the next message for the intent is not used.

              • intent (dict) --

                Override settings to configure the intent state.

                • name (string) --

                  The name of the intent. Only required when you're switching intents.

                • slots (dict) --

                  A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.,

                  • (string) --

                    • (dict) --

                      The slot values that Amazon Lex uses when it sets slot values in a dialog step.

                      • shape (string) --

                        When the shape value is List , it indicates that the values field contains a list of slot values. When the value is Scalar , it indicates that the value field contains a single value.

                      • value (dict) --

                        The current value of the slot.

                        • interpretedValue (string) --

                          The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the resolvedValues list.

                      • values (list) --

                        A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."

                        • (dict) --

                          The slot values that Amazon Lex uses when it sets slot values in a dialog step.

              • sessionAttributes (dict) --

                Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.

                • (string) --

                  • (string) --

            • successConditional (dict) --

              A list of conditional branches to evaluate after the dialog code hook finishes successfully.

              • active (boolean) --

                Determines whether a conditional branch is active. When active is false, the conditions are not evaluated.

              • conditionalBranches (list) --

                A list of conditional branches. A conditional branch is made up of a condition, a response and a next step. The response and next step are executed when the condition is true.

                • (dict) --

                  A set of actions that Amazon Lex should run if the condition is matched.

                  • name (string) --

                    The name of the branch.

                  • condition (dict) --

                    Contains the expression to evaluate. If the condition is true, the branch's actions are taken.

                    • expressionString (string) --

                      The expression string that is evaluated.

                  • nextStep (dict) --

                    The next step in the conversation.

                    • dialogAction (dict) --

                      Defines the action that the bot executes at runtime when the conversation reaches this step.

                      • type (string) --

                        The action that the bot should execute.

                      • slotToElicit (string) --

                        If the dialog action is ElicitSlot , defines the slot to elicit from the user.

                      • suppressNextMessage (boolean) --

                        When true the next message for the intent is not used.

                    • intent (dict) --

                      Override settings to configure the intent state.

                      • name (string) --

                        The name of the intent. Only required when you're switching intents.

                      • slots (dict) --

                        A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.,

                        • (string) --

                          • (dict) --

                            The slot values that Amazon Lex uses when it sets slot values in a dialog step.

                            • shape (string) --

                              When the shape value is List , it indicates that the values field contains a list of slot values. When the value is Scalar , it indicates that the value field contains a single value.

                            • value (dict) --

                              The current value of the slot.

                              • interpretedValue (string) --

                                The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the resolvedValues list.

                            • values (list) --

                              A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."

                              • (dict) --

                                The slot values that Amazon Lex uses when it sets slot values in a dialog step.

                    • sessionAttributes (dict) --

                      Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.

                      • (string) --

                        • (string) --

                  • response (dict) --

                    Specifies a list of message groups that Amazon Lex uses to respond the user input.

                    • messageGroups (list) --

                      A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.

                      • (dict) --

                        Provides one or more messages that Amazon Lex should send to the user.

                        • message (dict) --

                          The primary message that Amazon Lex should send to the user.

                          • plainTextMessage (dict) --

                            A message in plain text format.

                            • value (string) --

                              The message to send to the user.

                          • customPayload (dict) --

                            A message in a custom format defined by the client application.

                            • value (string) --

                              The string that is sent to your application.

                          • ssmlMessage (dict) --

                            A message in Speech Synthesis Markup Language (SSML).

                            • value (string) --

                              The SSML text that defines the prompt.

                          • imageResponseCard (dict) --

                            A message that defines a response card that the client application can show to the user.

                            • title (string) --

                              The title to display on the response card. The format of the title is determined by the platform displaying the response card.

                            • subtitle (string) --

                              The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

                            • imageUrl (string) --

                              The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

                            • buttons (list) --

                              A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.

                              • (dict) --

                                Describes a button to use on a response card used to gather slot values from a user.

                                • text (string) --

                                  The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

                                • value (string) --

                                  The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

                        • variations (list) --

                          Message variations to send to the user. When variations are defined, Amazon Lex chooses the primary message or one of the variations to send to the user.

                          • (dict) --

                            The object that provides message text and it's type.

                            • plainTextMessage (dict) --

                              A message in plain text format.

                              • value (string) --

                                The message to send to the user.

                            • customPayload (dict) --

                              A message in a custom format defined by the client application.

                              • value (string) --

                                The string that is sent to your application.

                            • ssmlMessage (dict) --

                              A message in Speech Synthesis Markup Language (SSML).

                              • value (string) --

                                The SSML text that defines the prompt.

                            • imageResponseCard (dict) --

                              A message that defines a response card that the client application can show to the user.

                              • title (string) --

                                The title to display on the response card. The format of the title is determined by the platform displaying the response card.

                              • subtitle (string) --

                                The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

                              • imageUrl (string) --

                                The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

                              • buttons (list) --

                                A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.

                                • (dict) --

                                  Describes a button to use on a response card used to gather slot values from a user.

                                  • text (string) --

                                    The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

                                  • value (string) --

                                    The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

                    • allowInterrupt (boolean) --

                      Indicates whether the user can interrupt a speech response from Amazon Lex.

              • defaultBranch (dict) --

                The conditional branch that should be followed when the conditions for other branches are not satisfied. A conditional branch is made up of a condition, a response and a next step.

                • nextStep (dict) --

                  The next step in the conversation.

                  • dialogAction (dict) --

                    Defines the action that the bot executes at runtime when the conversation reaches this step.

                    • type (string) --

                      The action that the bot should execute.

                    • slotToElicit (string) --

                      If the dialog action is ElicitSlot , defines the slot to elicit from the user.

                    • suppressNextMessage (boolean) --

                      When true the next message for the intent is not used.

                  • intent (dict) --

                    Override settings to configure the intent state.

                    • name (string) --

                      The name of the intent. Only required when you're switching intents.

                    • slots (dict) --

                      A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.,

                      • (string) --

                        • (dict) --

                          The slot values that Amazon Lex uses when it sets slot values in a dialog step.

                          • shape (string) --

                            When the shape value is List , it indicates that the values field contains a list of slot values. When the value is Scalar , it indicates that the value field contains a single value.

                          • value (dict) --

                            The current value of the slot.

                            • interpretedValue (string) --

                              The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the resolvedValues list.

                          • values (list) --

                            A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."

                            • (dict) --

                              The slot values that Amazon Lex uses when it sets slot values in a dialog step.

                  • sessionAttributes (dict) --

                    Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.

                    • (string) --

                      • (string) --

                • response (dict) --

                  Specifies a list of message groups that Amazon Lex uses to respond the user input.

                  • messageGroups (list) --

                    A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.

                    • (dict) --

                      Provides one or more messages that Amazon Lex should send to the user.

                      • message (dict) --

                        The primary message that Amazon Lex should send to the user.

                        • plainTextMessage (dict) --

                          A message in plain text format.

                          • value (string) --

                            The message to send to the user.

                        • customPayload (dict) --

                          A message in a custom format defined by the client application.

                          • value (string) --

                            The string that is sent to your application.

                        • ssmlMessage (dict) --

                          A message in Speech Synthesis Markup Language (SSML).

                          • value (string) --

                            The SSML text that defines the prompt.

                        • imageResponseCard (dict) --

                          A message that defines a response card that the client application can show to the user.

                          • title (string) --

                            The title to display on the response card. The format of the title is determined by the platform displaying the response card.

                          • subtitle (string) --

                            The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

                          • imageUrl (string) --

                            The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

                          • buttons (list) --

                            A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.

                            • (dict) --

                              Describes a button to use on a response card used to gather slot values from a user.

                              • text (string) --

                                The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

                              • value (string) --

                                The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

                      • variations (list) --

                        Message variations to send to the user. When variations are defined, Amazon Lex chooses the primary message or one of the variations to send to the user.

                        • (dict) --

                          The object that provides message text and it's type.

                          • plainTextMessage (dict) --

                            A message in plain text format.

                            • value (string) --

                              The message to send to the user.

                          • customPayload (dict) --

                            A message in a custom format defined by the client application.

                            • value (string) --

                              The string that is sent to your application.

                          • ssmlMessage (dict) --

                            A message in Speech Synthesis Markup Language (SSML).

                            • value (string) --

                              The SSML text that defines the prompt.

                          • imageResponseCard (dict) --

                            A message that defines a response card that the client application can show to the user.

                            • title (string) --

                              The title to display on the response card. The format of the title is determined by the platform displaying the response card.

                            • subtitle (string) --

                              The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

                            • imageUrl (string) --

                              The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

                            • buttons (list) --

                              A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.

                              • (dict) --

                                Describes a button to use on a response card used to gather slot values from a user.

                                • text (string) --

                                  The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

                                • value (string) --

                                  The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

                  • allowInterrupt (boolean) --

                    Indicates whether the user can interrupt a speech response from Amazon Lex.

            • failureResponse (dict) --

              Specifies a list of message groups that Amazon Lex uses to respond the user input.

              • messageGroups (list) --

                A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.

                • (dict) --

                  Provides one or more messages that Amazon Lex should send to the user.

                  • message (dict) --

                    The primary message that Amazon Lex should send to the user.

                    • plainTextMessage (dict) --

                      A message in plain text format.

                      • value (string) --

                        The message to send to the user.

                    • customPayload (dict) --

                      A message in a custom format defined by the client application.

                      • value (string) --

                        The string that is sent to your application.

                    • ssmlMessage (dict) --

                      A message in Speech Synthesis Markup Language (SSML).

                      • value (string) --

                        The SSML text that defines the prompt.

                    • imageResponseCard (dict) --

                      A message that defines a response card that the client application can show to the user.

                      • title (string) --

                        The title to display on the response card. The format of the title is determined by the platform displaying the response card.

                      • subtitle (string) --

                        The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

                      • imageUrl (string) --

                        The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

                      • buttons (list) --

                        A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.

                        • (dict) --

                          Describes a button to use on a response card used to gather slot values from a user.

                          • text (string) --

                            The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

                          • value (string) --

                            The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

                  • variations (list) --

                    Message variations to send to the user. When variations are defined, Amazon Lex chooses the primary message or one of the variations to send to the user.

                    • (dict) --

                      The object that provides message text and it's type.

                      • plainTextMessage (dict) --

                        A message in plain text format.

                        • value (string) --

                          The message to send to the user.

                      • customPayload (dict) --

                        A message in a custom format defined by the client application.

                        • value (string) --

                          The string that is sent to your application.

                      • ssmlMessage (dict) --

                        A message in Speech Synthesis Markup Language (SSML).

                        • value (string) --

                          The SSML text that defines the prompt.

                      • imageResponseCard (dict) --

                        A message that defines a response card that the client application can show to the user.

                        • title (string) --

                          The title to display on the response card. The format of the title is determined by the platform displaying the response card.

                        • subtitle (string) --

                          The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

                        • imageUrl (string) --

                          The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

                        • buttons (list) --

                          A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.

                          • (dict) --

                            Describes a button to use on a response card used to gather slot values from a user.

                            • text (string) --

                              The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

                            • value (string) --

                              The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

              • allowInterrupt (boolean) --

                Indicates whether the user can interrupt a speech response from Amazon Lex.

            • failureNextStep (dict) --

              Specifies the next step the bot runs after the dialog code hook throws an exception or returns with the State field of the Intent object set to Failed .

              • dialogAction (dict) --

                Defines the action that the bot executes at runtime when the conversation reaches this step.

                • type (string) --

                  The action that the bot should execute.

                • slotToElicit (string) --

                  If the dialog action is ElicitSlot , defines the slot to elicit from the user.

                • suppressNextMessage (boolean) --

                  When true the next message for the intent is not used.

              • intent (dict) --

                Override settings to configure the intent state.

                • name (string) --

                  The name of the intent. Only required when you're switching intents.

                • slots (dict) --

                  A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.,

                  • (string) --

                    • (dict) --

                      The slot values that Amazon Lex uses when it sets slot values in a dialog step.

                      • shape (string) --

                        When the shape value is List , it indicates that the values field contains a list of slot values. When the value is Scalar , it indicates that the value field contains a single value.

                      • value (dict) --

                        The current value of the slot.

                        • interpretedValue (string) --

                          The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the resolvedValues list.

                      • values (list) --

                        A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."

                        • (dict) --

                          The slot values that Amazon Lex uses when it sets slot values in a dialog step.

              • sessionAttributes (dict) --

                Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.

                • (string) --

                  • (string) --

            • failureConditional (dict) --

              A list of conditional branches to evaluate after the dialog code hook throws an exception or returns with the State field of the Intent object set to Failed .

              • active (boolean) --

                Determines whether a conditional branch is active. When active is false, the conditions are not evaluated.

              • conditionalBranches (list) --

                A list of conditional branches. A conditional branch is made up of a condition, a response and a next step. The response and next step are executed when the condition is true.

                • (dict) --

                  A set of actions that Amazon Lex should run if the condition is matched.

                  • name (string) --

                    The name of the branch.

                  • condition (dict) --

                    Contains the expression to evaluate. If the condition is true, the branch's actions are taken.

                    • expressionString (string) --

                      The expression string that is evaluated.

                  • nextStep (dict) --

                    The next step in the conversation.

                    • dialogAction (dict) --

                      Defines the action that the bot executes at runtime when the conversation reaches this step.

                      • type (string) --

                        The action that the bot should execute.

                      • slotToElicit (string) --

                        If the dialog action is ElicitSlot , defines the slot to elicit from the user.

                      • suppressNextMessage (boolean) --

                        When true the next message for the intent is not used.

                    • intent (dict) --

                      Override settings to configure the intent state.

                      • name (string) --

                        The name of the intent. Only required when you're switching intents.

                      • slots (dict) --

                        A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.,

                        • (string) --

                          • (dict) --

                            The slot values that Amazon Lex uses when it sets slot values in a dialog step.

                            • shape (string) --

                              When the shape value is List , it indicates that the values field contains a list of slot values. When the value is Scalar , it indicates that the value field contains a single value.

                            • value (dict) --

                              The current value of the slot.

                              • interpretedValue (string) --

                                The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the resolvedValues list.

                            • values (list) --

                              A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."

                              • (dict) --

                                The slot values that Amazon Lex uses when it sets slot values in a dialog step.

                    • sessionAttributes (dict) --

                      Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.

                      • (string) --

                        • (string) --

                  • response (dict) --

                    Specifies a list of message groups that Amazon Lex uses to respond the user input.

                    • messageGroups (list) --

                      A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.

                      • (dict) --

                        Provides one or more messages that Amazon Lex should send to the user.

                        • message (dict) --

                          The primary message that Amazon Lex should send to the user.

                          • plainTextMessage (dict) --

                            A message in plain text format.

                            • value (string) --

                              The message to send to the user.

                          • customPayload (dict) --

                            A message in a custom format defined by the client application.

                            • value (string) --

                              The string that is sent to your application.

                          • ssmlMessage (dict) --

                            A message in Speech Synthesis Markup Language (SSML).

                            • value (string) --

                              The SSML text that defines the prompt.

                          • imageResponseCard (dict) --

                            A message that defines a response card that the client application can show to the user.

                            • title (string) --

                              The title to display on the response card. The format of the title is determined by the platform displaying the response card.

                            • subtitle (string) --

                              The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

                            • imageUrl (string) --

                              The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

                            • buttons (list) --

                              A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.

                              • (dict) --

                                Describes a button to use on a response card used to gather slot values from a user.

                                • text (string) --

                                  The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

                                • value (string) --

                                  The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

                        • variations (list) --

                          Message variations to send to the user. When variations are defined, Amazon Lex chooses the primary message or one of the variations to send to the user.

                          • (dict) --

                            The object that provides message text and it's type.

                            • plainTextMessage (dict) --

                              A message in plain text format.

                              • value (string) --

                                The message to send to the user.

                            • customPayload (dict) --

                              A message in a custom format defined by the client application.

                              • value (string) --

                                The string that is sent to your application.

                            • ssmlMessage (dict) --

                              A message in Speech Synthesis Markup Language (SSML).

                              • value (string) --

                                The SSML text that defines the prompt.

                            • imageResponseCard (dict) --

                              A message that defines a response card that the client application can show to the user.

                              • title (string) --

                                The title to display on the response card. The format of the title is determined by the platform displaying the response card.

                              • subtitle (string) --

                                The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

                              • imageUrl (string) --

                                The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

                              • buttons (list) --

                                A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.

                                • (dict) --

                                  Describes a button to use on a response card used to gather slot values from a user.

                                  • text (string) --

                                    The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

                                  • value (string) --

                                    The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

                    • allowInterrupt (boolean) --

                      Indicates whether the user can interrupt a speech response from Amazon Lex.

              • defaultBranch (dict) --

                The conditional branch that should be followed when the conditions for other branches are not satisfied. A conditional branch is made up of a condition, a response and a next step.

                • nextStep (dict) --

                  The next step in the conversation.

                  • dialogAction (dict) --

                    Defines the action that the bot executes at runtime when the conversation reaches this step.

                    • type (string) --

                      The action that the bot should execute.

                    • slotToElicit (string) --

                      If the dialog action is ElicitSlot , defines the slot to elicit from the user.

                    • suppressNextMessage (boolean) --

                      When true the next message for the intent is not used.

                  • intent (dict) --

                    Override settings to configure the intent state.

                    • name (string) --

                      The name of the intent. Only required when you're switching intents.

                    • slots (dict) --

                      A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.,

                      • (string) --

                        • (dict) --

                          The slot values that Amazon Lex uses when it sets slot values in a dialog step.

                          • shape (string) --

                            When the shape value is List , it indicates that the values field contains a list of slot values. When the value is Scalar , it indicates that the value field contains a single value.

                          • value (dict) --

                            The current value of the slot.

                            • interpretedValue (string) --

                              The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the resolvedValues list.

                          • values (list) --

                            A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."

                            • (dict) --

                              The slot values that Amazon Lex uses when it sets slot values in a dialog step.

                  • sessionAttributes (dict) --

                    Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.

                    • (string) --

                      • (string) --

                • response (dict) --

                  Specifies a list of message groups that Amazon Lex uses to respond the user input.

                  • messageGroups (list) --

                    A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.

                    • (dict) --

                      Provides one or more messages that Amazon Lex should send to the user.

                      • message (dict) --

                        The primary message that Amazon Lex should send to the user.

                        • plainTextMessage (dict) --

                          A message in plain text format.

                          • value (string) --

                            The message to send to the user.

                        • customPayload (dict) --

                          A message in a custom format defined by the client application.

                          • value (string) --

                            The string that is sent to your application.

                        • ssmlMessage (dict) --

                          A message in Speech Synthesis Markup Language (SSML).

                          • value (string) --

                            The SSML text that defines the prompt.

                        • imageResponseCard (dict) --

                          A message that defines a response card that the client application can show to the user.

                          • title (string) --

                            The title to display on the response card. The format of the title is determined by the platform displaying the response card.

                          • subtitle (string) --

                            The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

                          • imageUrl (string) --

                            The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

                          • buttons (list) --

                            A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.

                            • (dict) --

                              Describes a button to use on a response card used to gather slot values from a user.

                              • text (string) --

                                The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

                              • value (string) --

                                The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

                      • variations (list) --

                        Message variations to send to the user. When variations are defined, Amazon Lex chooses the primary message or one of the variations to send to the user.

                        • (dict) --

                          The object that provides message text and it's type.

                          • plainTextMessage (dict) --

                            A message in plain text format.

                            • value (string) --

                              The message to send to the user.

                          • customPayload (dict) --

                            A message in a custom format defined by the client application.

                            • value (string) --

                              The string that is sent to your application.

                          • ssmlMessage (dict) --

                            A message in Speech Synthesis Markup Language (SSML).

                            • value (string) --

                              The SSML text that defines the prompt.

                          • imageResponseCard (dict) --

                            A message that defines a response card that the client application can show to the user.

                            • title (string) --

                              The title to display on the response card. The format of the title is determined by the platform displaying the response card.

                            • subtitle (string) --

                              The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

                            • imageUrl (string) --

                              The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

                            • buttons (list) --

                              A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.

                              • (dict) --

                                Describes a button to use on a response card used to gather slot values from a user.

                                • text (string) --

                                  The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

                                • value (string) --

                                  The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

                  • allowInterrupt (boolean) --

                    Indicates whether the user can interrupt a speech response from Amazon Lex.

            • timeoutResponse (dict) --

              Specifies a list of message groups that Amazon Lex uses to respond the user input.

              • messageGroups (list) --

                A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.

                • (dict) --

                  Provides one or more messages that Amazon Lex should send to the user.

                  • message (dict) --

                    The primary message that Amazon Lex should send to the user.

                    • plainTextMessage (dict) --

                      A message in plain text format.

                      • value (string) --

                        The message to send to the user.

                    • customPayload (dict) --

                      A message in a custom format defined by the client application.

                      • value (string) --

                        The string that is sent to your application.

                    • ssmlMessage (dict) --

                      A message in Speech Synthesis Markup Language (SSML).

                      • value (string) --

                        The SSML text that defines the prompt.

                    • imageResponseCard (dict) --

                      A message that defines a response card that the client application can show to the user.

                      • title (string) --

                        The title to display on the response card. The format of the title is determined by the platform displaying the response card.

                      • subtitle (string) --

                        The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

                      • imageUrl (string) --

                        The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

                      • buttons (list) --

                        A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.

                        • (dict) --

                          Describes a button to use on a response card used to gather slot values from a user.

                          • text (string) --

                            The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

                          • value (string) --

                            The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

                  • variations (list) --

                    Message variations to send to the user. When variations are defined, Amazon Lex chooses the primary message or one of the variations to send to the user.

                    • (dict) --

                      The object that provides message text and it's type.

                      • plainTextMessage (dict) --

                        A message in plain text format.

                        • value (string) --

                          The message to send to the user.

                      • customPayload (dict) --

                        A message in a custom format defined by the client application.

                        • value (string) --

                          The string that is sent to your application.

                      • ssmlMessage (dict) --

                        A message in Speech Synthesis Markup Language (SSML).

                        • value (string) --

                          The SSML text that defines the prompt.

                      • imageResponseCard (dict) --

                        A message that defines a response card that the client application can show to the user.

                        • title (string) --

                          The title to display on the response card. The format of the title is determined by the platform displaying the response card.

                        • subtitle (string) --

                          The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

                        • imageUrl (string) --

                          The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

                        • buttons (list) --

                          A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.

                          • (dict) --

                            Describes a button to use on a response card used to gather slot values from a user.

                            • text (string) --

                              The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

                            • value (string) --

                              The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

              • allowInterrupt (boolean) --

                Indicates whether the user can interrupt a speech response from Amazon Lex.

            • timeoutNextStep (dict) --

              Specifies the next step that the bot runs when the code hook times out.

              • dialogAction (dict) --

                Defines the action that the bot executes at runtime when the conversation reaches this step.

                • type (string) --

                  The action that the bot should execute.

                • slotToElicit (string) --

                  If the dialog action is ElicitSlot , defines the slot to elicit from the user.

                • suppressNextMessage (boolean) --

                  When true the next message for the intent is not used.

              • intent (dict) --

                Override settings to configure the intent state.

                • name (string) --

                  The name of the intent. Only required when you're switching intents.

                • slots (dict) --

                  A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.,

                  • (string) --

                    • (dict) --

                      The slot values that Amazon Lex uses when it sets slot values in a dialog step.

                      • shape (string) --

                        When the shape value is List , it indicates that the values field contains a list of slot values. When the value is Scalar , it indicates that the value field contains a single value.

                      • value (dict) --

                        The current value of the slot.

                        • interpretedValue (string) --

                          The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the resolvedValues list.

                      • values (list) --

                        A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."

                        • (dict) --

                          The slot values that Amazon Lex uses when it sets slot values in a dialog step.

              • sessionAttributes (dict) --

                Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.

                • (string) --

                  • (string) --

            • timeoutConditional (dict) --

              A list of conditional branches to evaluate if the code hook times out.

              • active (boolean) --

                Determines whether a conditional branch is active. When active is false, the conditions are not evaluated.

              • conditionalBranches (list) --

                A list of conditional branches. A conditional branch is made up of a condition, a response and a next step. The response and next step are executed when the condition is true.

                • (dict) --

                  A set of actions that Amazon Lex should run if the condition is matched.

                  • name (string) --

                    The name of the branch.

                  • condition (dict) --

                    Contains the expression to evaluate. If the condition is true, the branch's actions are taken.

                    • expressionString (string) --

                      The expression string that is evaluated.

                  • nextStep (dict) --

                    The next step in the conversation.

                    • dialogAction (dict) --

                      Defines the action that the bot executes at runtime when the conversation reaches this step.

                      • type (string) --

                        The action that the bot should execute.

                      • slotToElicit (string) --

                        If the dialog action is ElicitSlot , defines the slot to elicit from the user.

                      • suppressNextMessage (boolean) --

                        When true the next message for the intent is not used.

                    • intent (dict) --

                      Override settings to configure the intent state.

                      • name (string) --

                        The name of the intent. Only required when you're switching intents.

                      • slots (dict) --

                        A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.,

                        • (string) --

                          • (dict) --

                            The slot values that Amazon Lex uses when it sets slot values in a dialog step.

                            • shape (string) --

                              When the shape value is List , it indicates that the values field contains a list of slot values. When the value is Scalar , it indicates that the value field contains a single value.

                            • value (dict) --

                              The current value of the slot.

                              • interpretedValue (string) --

                                The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the resolvedValues list.

                            • values (list) --

                              A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."

                              • (dict) --

                                The slot values that Amazon Lex uses when it sets slot values in a dialog step.

                    • sessionAttributes (dict) --

                      Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.

                      • (string) --

                        • (string) --

                  • response (dict) --

                    Specifies a list of message groups that Amazon Lex uses to respond the user input.

                    • messageGroups (list) --

                      A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.

                      • (dict) --

                        Provides one or more messages that Amazon Lex should send to the user.

                        • message (dict) --

                          The primary message that Amazon Lex should send to the user.

                          • plainTextMessage (dict) --

                            A message in plain text format.

                            • value (string) --

                              The message to send to the user.

                          • customPayload (dict) --

                            A message in a custom format defined by the client application.

                            • value (string) --

                              The string that is sent to your application.

                          • ssmlMessage (dict) --

                            A message in Speech Synthesis Markup Language (SSML).

                            • value (string) --

                              The SSML text that defines the prompt.

                          • imageResponseCard (dict) --

                            A message that defines a response card that the client application can show to the user.

                            • title (string) --

                              The title to display on the response card. The format of the title is determined by the platform displaying the response card.

                            • subtitle (string) --

                              The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

                            • imageUrl (string) --

                              The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

                            • buttons (list) --

                              A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.

                              • (dict) --

                                Describes a button to use on a response card used to gather slot values from a user.

                                • text (string) --

                                  The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

                                • value (string) --

                                  The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

                        • variations (list) --

                          Message variations to send to the user. When variations are defined, Amazon Lex chooses the primary message or one of the variations to send to the user.

                          • (dict) --

                            The object that provides message text and it's type.

                            • plainTextMessage (dict) --

                              A message in plain text format.

                              • value (string) --

                                The message to send to the user.

                            • customPayload (dict) --

                              A message in a custom format defined by the client application.

                              • value (string) --

                                The string that is sent to your application.

                            • ssmlMessage (dict) --

                              A message in Speech Synthesis Markup Language (SSML).

                              • value (string) --

                                The SSML text that defines the prompt.

                            • imageResponseCard (dict) --

                              A message that defines a response card that the client application can show to the user.

                              • title (string) --

                                The title to display on the response card. The format of the title is determined by the platform displaying the response card.

                              • subtitle (string) --

                                The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

                              • imageUrl (string) --

                                The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

                              • buttons (list) --

                                A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.

                                • (dict) --

                                  Describes a button to use on a response card used to gather slot values from a user.

                                  • text (string) --

                                    The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

                                  • value (string) --

                                    The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

                    • allowInterrupt (boolean) --

                      Indicates whether the user can interrupt a speech response from Amazon Lex.

              • defaultBranch (dict) --

                The conditional branch that should be followed when the conditions for other branches are not satisfied. A conditional branch is made up of a condition, a response and a next step.

                • nextStep (dict) --

                  The next step in the conversation.

                  • dialogAction (dict) --

                    Defines the action that the bot executes at runtime when the conversation reaches this step.

                    • type (string) --

                      The action that the bot should execute.

                    • slotToElicit (string) --

                      If the dialog action is ElicitSlot , defines the slot to elicit from the user.

                    • suppressNextMessage (boolean) --

                      When true the next message for the intent is not used.

                  • intent (dict) --

                    Override settings to configure the intent state.

                    • name (string) --

                      The name of the intent. Only required when you're switching intents.

                    • slots (dict) --

                      A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.,

                      • (string) --

                        • (dict) --

                          The slot values that Amazon Lex uses when it sets slot values in a dialog step.

                          • shape (string) --

                            When the shape value is List , it indicates that the values field contains a list of slot values. When the value is Scalar , it indicates that the value field contains a single value.

                          • value (dict) --

                            The current value of the slot.

                            • interpretedValue (string) --

                              The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the resolvedValues list.

                          • values (list) --

                            A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."

                            • (dict) --

                              The slot values that Amazon Lex uses when it sets slot values in a dialog step.

                  • sessionAttributes (dict) --

                    Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.

                    • (string) --

                      • (string) --

                • response (dict) --

                  Specifies a list of message groups that Amazon Lex uses to respond the user input.

                  • messageGroups (list) --

                    A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.

                    • (dict) --

                      Provides one or more messages that Amazon Lex should send to the user.

                      • message (dict) --

                        The primary message that Amazon Lex should send to the user.

                        • plainTextMessage (dict) --

                          A message in plain text format.

                          • value (string) --

                            The message to send to the user.

                        • customPayload (dict) --

                          A message in a custom format defined by the client application.

                          • value (string) --

                            The string that is sent to your application.

                        • ssmlMessage (dict) --

                          A message in Speech Synthesis Markup Language (SSML).

                          • value (string) --

                            The SSML text that defines the prompt.

                        • imageResponseCard (dict) --

                          A message that defines a response card that the client application can show to the user.

                          • title (string) --

                            The title to display on the response card. The format of the title is determined by the platform displaying the response card.

                          • subtitle (string) --

                            The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

                          • imageUrl (string) --

                            The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

                          • buttons (list) --

                            A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.

                            • (dict) --

                              Describes a button to use on a response card used to gather slot values from a user.

                              • text (string) --

                                The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

                              • value (string) --

                                The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

                      • variations (list) --

                        Message variations to send to the user. When variations are defined, Amazon Lex chooses the primary message or one of the variations to send to the user.

                        • (dict) --

                          The object that provides message text and it's type.

                          • plainTextMessage (dict) --

                            A message in plain text format.

                            • value (string) --

                              The message to send to the user.

                          • customPayload (dict) --

                            A message in a custom format defined by the client application.

                            • value (string) --

                              The string that is sent to your application.

                          • ssmlMessage (dict) --

                            A message in Speech Synthesis Markup Language (SSML).

                            • value (string) --

                              The SSML text that defines the prompt.

                          • imageResponseCard (dict) --

                            A message that defines a response card that the client application can show to the user.

                            • title (string) --

                              The title to display on the response card. The format of the title is determined by the platform displaying the response card.

                            • subtitle (string) --

                              The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

                            • imageUrl (string) --

                              The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

                            • buttons (list) --

                              A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.

                              • (dict) --

                                Describes a button to use on a response card used to gather slot values from a user.

                                • text (string) --

                                  The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

                                • value (string) --

                                  The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

                  • allowInterrupt (boolean) --

                    Indicates whether the user can interrupt a speech response from Amazon Lex.

        • elicitationCodeHook (dict) --

          Code hook called when Amazon Lex doesn't capture a slot value.

          • enableCodeHookInvocation (boolean) --

            Indicates whether a Lambda function should be invoked for the dialog.

          • invocationLabel (string) --

            A label that indicates the dialog step from which the dialog code hook is happening.

    • obfuscationSetting (dict) --

      Whether slot values are shown in Amazon CloudWatch logs. If the value is None , the actual value of the slot is shown in logs.

      • obfuscationSettingType (string) --

        Value that determines whether Amazon Lex obscures slot values in conversation logs. The default is to obscure the values.

    • botId (string) --

      The identifier of the bot associated with the slot.

    • botVersion (string) --

      The version of the bot associated with the slot.

    • localeId (string) --

      The language and locale specified for the slot.

    • intentId (string) --

      The identifier of the intent associated with the slot.

    • creationDateTime (datetime) --

      A timestamp of the date and time that the slot was created.

    • lastUpdatedDateTime (datetime) --

      A timestamp of the date and time that the slot was last updated.

    • multipleValuesSetting (dict) --

      Indicates whether the slot accepts multiple values in a single utterance.

      If the multipleValuesSetting is not set, the default value is false .

      • allowMultipleValues (boolean) --

        Indicates whether a slot can return multiple values. When true , the slot may return more than one value in a response. When false , the slot returns only a single value.

        Multi-value slots are only available in the en-US locale. If you set this value to true in any other locale, Amazon Lex throws a ValidationException .

        If the allowMutlipleValues is not set, the default value is false .

    • subSlotSetting (dict) --

      Specifications for the constituent sub slots and the expression for the composite slot.

      • expression (string) --

        The expression text for defining the constituent sub slots in the composite slot using logical AND and OR operators.

      • slotSpecifications (dict) --

        Specifications for the constituent sub slots of a composite slot.

        • (string) --

          • (dict) --

            Subslot specifications.

            • slotTypeId (string) --

              The unique identifier assigned to the slot type.

            • valueElicitationSetting (dict) --

              Specifies the elicitation setting details for constituent sub slots of a composite slot.

              • defaultValueSpecification (dict) --

                Defines a list of values that Amazon Lex should use as the default value for a slot.

                • defaultValueList (list) --

                  A list of default values. Amazon Lex chooses the default value to use in the order that they are presented in the list.

                  • (dict) --

                    Specifies the default value to use when a user doesn't provide a value for a slot.

                    • defaultValue (string) --

                      The default value to use when a user doesn't provide a value for a slot.

              • promptSpecification (dict) --

                Specifies a list of message groups that Amazon Lex sends to a user to elicit a response.

                • messageGroups (list) --

                  A collection of messages that Amazon Lex can send to the user. Amazon Lex chooses the actual message to send at runtime.

                  • (dict) --

                    Provides one or more messages that Amazon Lex should send to the user.

                    • message (dict) --

                      The primary message that Amazon Lex should send to the user.

                      • plainTextMessage (dict) --

                        A message in plain text format.

                        • value (string) --

                          The message to send to the user.

                      • customPayload (dict) --

                        A message in a custom format defined by the client application.

                        • value (string) --

                          The string that is sent to your application.

                      • ssmlMessage (dict) --

                        A message in Speech Synthesis Markup Language (SSML).

                        • value (string) --

                          The SSML text that defines the prompt.

                      • imageResponseCard (dict) --

                        A message that defines a response card that the client application can show to the user.

                        • title (string) --

                          The title to display on the response card. The format of the title is determined by the platform displaying the response card.

                        • subtitle (string) --

                          The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

                        • imageUrl (string) --

                          The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

                        • buttons (list) --

                          A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.

                          • (dict) --

                            Describes a button to use on a response card used to gather slot values from a user.

                            • text (string) --

                              The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

                            • value (string) --

                              The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

                    • variations (list) --

                      Message variations to send to the user. When variations are defined, Amazon Lex chooses the primary message or one of the variations to send to the user.

                      • (dict) --

                        The object that provides message text and it's type.

                        • plainTextMessage (dict) --

                          A message in plain text format.

                          • value (string) --

                            The message to send to the user.

                        • customPayload (dict) --

                          A message in a custom format defined by the client application.

                          • value (string) --

                            The string that is sent to your application.

                        • ssmlMessage (dict) --

                          A message in Speech Synthesis Markup Language (SSML).

                          • value (string) --

                            The SSML text that defines the prompt.

                        • imageResponseCard (dict) --

                          A message that defines a response card that the client application can show to the user.

                          • title (string) --

                            The title to display on the response card. The format of the title is determined by the platform displaying the response card.

                          • subtitle (string) --

                            The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

                          • imageUrl (string) --

                            The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

                          • buttons (list) --

                            A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.

                            • (dict) --

                              Describes a button to use on a response card used to gather slot values from a user.

                              • text (string) --

                                The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

                              • value (string) --

                                The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

                • maxRetries (integer) --

                  The maximum number of times the bot tries to elicit a response from the user using this prompt.

                • allowInterrupt (boolean) --

                  Indicates whether the user can interrupt a speech prompt from the bot.

                • messageSelectionStrategy (string) --

                  Indicates how a message is selected from a message group among retries.

              • sampleUtterances (list) --

                If you know a specific pattern that users might respond to an Amazon Lex request for a sub slot value, you can provide those utterances to improve accuracy. This is optional. In most cases Amazon Lex is capable of understanding user utterances. This is similar to SampleUtterances for slots.

                • (dict) --

                  A sample utterance that invokes an intent or respond to a slot elicitation prompt.

                  • utterance (string) --

                    The sample utterance that Amazon Lex uses to build its machine-learning model to recognize intents.

              • waitAndContinueSpecification (dict) --

                Specifies the prompts that Amazon Lex uses while a bot is waiting for customer input.

                • waitingResponse (dict) --

                  The response that Amazon Lex sends to indicate that the bot is waiting for the conversation to continue.

                  • messageGroups (list) --

                    A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.

                    • (dict) --

                      Provides one or more messages that Amazon Lex should send to the user.

                      • message (dict) --

                        The primary message that Amazon Lex should send to the user.

                        • plainTextMessage (dict) --

                          A message in plain text format.

                          • value (string) --

                            The message to send to the user.

                        • customPayload (dict) --

                          A message in a custom format defined by the client application.

                          • value (string) --

                            The string that is sent to your application.

                        • ssmlMessage (dict) --

                          A message in Speech Synthesis Markup Language (SSML).

                          • value (string) --

                            The SSML text that defines the prompt.

                        • imageResponseCard (dict) --

                          A message that defines a response card that the client application can show to the user.

                          • title (string) --

                            The title to display on the response card. The format of the title is determined by the platform displaying the response card.

                          • subtitle (string) --

                            The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

                          • imageUrl (string) --

                            The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

                          • buttons (list) --

                            A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.

                            • (dict) --

                              Describes a button to use on a response card used to gather slot values from a user.

                              • text (string) --

                                The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

                              • value (string) --

                                The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

                      • variations (list) --

                        Message variations to send to the user. When variations are defined, Amazon Lex chooses the primary message or one of the variations to send to the user.

                        • (dict) --

                          The object that provides message text and it's type.

                          • plainTextMessage (dict) --

                            A message in plain text format.

                            • value (string) --

                              The message to send to the user.

                          • customPayload (dict) --

                            A message in a custom format defined by the client application.

                            • value (string) --

                              The string that is sent to your application.

                          • ssmlMessage (dict) --

                            A message in Speech Synthesis Markup Language (SSML).

                            • value (string) --

                              The SSML text that defines the prompt.

                          • imageResponseCard (dict) --

                            A message that defines a response card that the client application can show to the user.

                            • title (string) --

                              The title to display on the response card. The format of the title is determined by the platform displaying the response card.

                            • subtitle (string) --

                              The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

                            • imageUrl (string) --

                              The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

                            • buttons (list) --

                              A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.

                              • (dict) --

                                Describes a button to use on a response card used to gather slot values from a user.

                                • text (string) --

                                  The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

                                • value (string) --

                                  The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

                  • allowInterrupt (boolean) --

                    Indicates whether the user can interrupt a speech response from Amazon Lex.

                • continueResponse (dict) --

                  The response that Amazon Lex sends to indicate that the bot is ready to continue the conversation.

                  • messageGroups (list) --

                    A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.

                    • (dict) --

                      Provides one or more messages that Amazon Lex should send to the user.

                      • message (dict) --

                        The primary message that Amazon Lex should send to the user.

                        • plainTextMessage (dict) --

                          A message in plain text format.

                          • value (string) --

                            The message to send to the user.

                        • customPayload (dict) --

                          A message in a custom format defined by the client application.

                          • value (string) --

                            The string that is sent to your application.

                        • ssmlMessage (dict) --

                          A message in Speech Synthesis Markup Language (SSML).

                          • value (string) --

                            The SSML text that defines the prompt.

                        • imageResponseCard (dict) --

                          A message that defines a response card that the client application can show to the user.

                          • title (string) --

                            The title to display on the response card. The format of the title is determined by the platform displaying the response card.

                          • subtitle (string) --

                            The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

                          • imageUrl (string) --

                            The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

                          • buttons (list) --

                            A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.

                            • (dict) --

                              Describes a button to use on a response card used to gather slot values from a user.

                              • text (string) --

                                The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

                              • value (string) --

                                The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

                      • variations (list) --

                        Message variations to send to the user. When variations are defined, Amazon Lex chooses the primary message or one of the variations to send to the user.

                        • (dict) --

                          The object that provides message text and it's type.

                          • plainTextMessage (dict) --

                            A message in plain text format.

                            • value (string) --

                              The message to send to the user.

                          • customPayload (dict) --

                            A message in a custom format defined by the client application.

                            • value (string) --

                              The string that is sent to your application.

                          • ssmlMessage (dict) --

                            A message in Speech Synthesis Markup Language (SSML).

                            • value (string) --

                              The SSML text that defines the prompt.

                          • imageResponseCard (dict) --

                            A message that defines a response card that the client application can show to the user.

                            • title (string) --

                              The title to display on the response card. The format of the title is determined by the platform displaying the response card.

                            • subtitle (string) --

                              The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

                            • imageUrl (string) --

                              The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

                            • buttons (list) --

                              A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.

                              • (dict) --

                                Describes a button to use on a response card used to gather slot values from a user.

                                • text (string) --

                                  The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

                                • value (string) --

                                  The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

                  • allowInterrupt (boolean) --

                    Indicates whether the user can interrupt a speech response from Amazon Lex.

                • stillWaitingResponse (dict) --

                  A response that Amazon Lex sends periodically to the user to indicate that the bot is still waiting for input from the user.

                  • messageGroups (list) --

                    One or more message groups, each containing one or more messages, that define the prompts that Amazon Lex sends to the user.

                    • (dict) --

                      Provides one or more messages that Amazon Lex should send to the user.

                      • message (dict) --

                        The primary message that Amazon Lex should send to the user.

                        • plainTextMessage (dict) --

                          A message in plain text format.

                          • value (string) --

                            The message to send to the user.

                        • customPayload (dict) --

                          A message in a custom format defined by the client application.

                          • value (string) --

                            The string that is sent to your application.

                        • ssmlMessage (dict) --

                          A message in Speech Synthesis Markup Language (SSML).

                          • value (string) --

                            The SSML text that defines the prompt.

                        • imageResponseCard (dict) --

                          A message that defines a response card that the client application can show to the user.

                          • title (string) --

                            The title to display on the response card. The format of the title is determined by the platform displaying the response card.

                          • subtitle (string) --

                            The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

                          • imageUrl (string) --

                            The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

                          • buttons (list) --

                            A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.

                            • (dict) --

                              Describes a button to use on a response card used to gather slot values from a user.

                              • text (string) --

                                The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

                              • value (string) --

                                The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

                      • variations (list) --

                        Message variations to send to the user. When variations are defined, Amazon Lex chooses the primary message or one of the variations to send to the user.

                        • (dict) --

                          The object that provides message text and it's type.

                          • plainTextMessage (dict) --

                            A message in plain text format.

                            • value (string) --

                              The message to send to the user.

                          • customPayload (dict) --

                            A message in a custom format defined by the client application.

                            • value (string) --

                              The string that is sent to your application.

                          • ssmlMessage (dict) --

                            A message in Speech Synthesis Markup Language (SSML).

                            • value (string) --

                              The SSML text that defines the prompt.

                          • imageResponseCard (dict) --

                            A message that defines a response card that the client application can show to the user.

                            • title (string) --

                              The title to display on the response card. The format of the title is determined by the platform displaying the response card.

                            • subtitle (string) --

                              The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

                            • imageUrl (string) --

                              The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

                            • buttons (list) --

                              A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.

                              • (dict) --

                                Describes a button to use on a response card used to gather slot values from a user.

                                • text (string) --

                                  The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

                                • value (string) --

                                  The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

                  • frequencyInSeconds (integer) --

                    How often a message should be sent to the user. Minimum of 1 second, maximum of 5 minutes.

                  • timeoutInSeconds (integer) --

                    If Amazon Lex waits longer than this length of time for a response, it will stop sending messages.

                  • allowInterrupt (boolean) --

                    Indicates that the user can interrupt the response by speaking while the message is being played.

                • active (boolean) --

                  Specifies whether the bot will wait for a user to respond. When this field is false, wait and continue responses for a slot aren't used. If the active field isn't specified, the default is true.

DescribeSlotType (updated) Link ¶
Changes (response)
{'compositeSlotTypeSetting': {'subSlots': [{'name': 'string',
                                            'slotTypeId': 'string'}]},
 'valueSelectionSetting': {'resolutionStrategy': {'Concatenation'}}}

Gets metadata information about a slot type.

See also: AWS API Documentation

Request Syntax

client.describe_slot_type(
    slotTypeId='string',
    botId='string',
    botVersion='string',
    localeId='string'
)
type slotTypeId

string

param slotTypeId

[REQUIRED]

The identifier of the slot type.

type botId

string

param botId

[REQUIRED]

The identifier of the bot associated with the slot type.

type botVersion

string

param botVersion

[REQUIRED]

The version of the bot associated with the slot type.

type localeId

string

param localeId

[REQUIRED]

The identifier of the language and locale of the slot type to describe. The string must match one of the supported locales. For more information, see Supported languages .

rtype

dict

returns

Response Syntax

{
    'slotTypeId': 'string',
    'slotTypeName': 'string',
    'description': 'string',
    'slotTypeValues': [
        {
            'sampleValue': {
                'value': 'string'
            },
            'synonyms': [
                {
                    'value': 'string'
                },
            ]
        },
    ],
    'valueSelectionSetting': {
        'resolutionStrategy': 'OriginalValue'|'TopResolution'|'Concatenation',
        'regexFilter': {
            'pattern': 'string'
        },
        'advancedRecognitionSetting': {
            'audioRecognitionStrategy': 'UseSlotValuesAsCustomVocabulary'
        }
    },
    'parentSlotTypeSignature': 'string',
    'botId': 'string',
    'botVersion': 'string',
    'localeId': 'string',
    'creationDateTime': datetime(2015, 1, 1),
    'lastUpdatedDateTime': datetime(2015, 1, 1),
    'externalSourceSetting': {
        'grammarSlotTypeSetting': {
            'source': {
                's3BucketName': 'string',
                's3ObjectKey': 'string',
                'kmsKeyArn': 'string'
            }
        }
    },
    'compositeSlotTypeSetting': {
        'subSlots': [
            {
                'name': 'string',
                'slotTypeId': 'string'
            },
        ]
    }
}

Response Structure

  • (dict) --

    • slotTypeId (string) --

      The unique identifier for the slot type.

    • slotTypeName (string) --

      The name specified for the slot type.

    • description (string) --

      The description specified for the slot type.

    • slotTypeValues (list) --

      The values that the slot type can take. Includes any synonyms for the slot type values.

      • (dict) --

        Each slot type can have a set of values. Each SlotTypeValue represents a value that the slot type can take.

        • sampleValue (dict) --

          The value of the slot type entry.

          • value (string) --

            The value that can be used for a slot type.

        • synonyms (list) --

          Additional values related to the slot type entry.

          • (dict) --

            Defines one of the values for a slot type.

            • value (string) --

              The value that can be used for a slot type.

    • valueSelectionSetting (dict) --

      The strategy that Amazon Lex uses to choose a value from a list of possible values.

      • resolutionStrategy (string) --

        Determines the slot resolution strategy that Amazon Lex uses to return slot type values. The field can be set to one of the following values:

        • OriginalValue - Returns the value entered by the user, if the user value is similar to the slot value.

        • TopResolution - If there is a resolution list for the slot, return the first value in the resolution list as the slot type value. If there is no resolution list, null is returned.

        If you don't specify the valueSelectionStrategy, the default is OriginalValue.

      • regexFilter (dict) --

        A regular expression used to validate the value of a slot.

        • pattern (string) --

          A regular expression used to validate the value of a slot.

          Use a standard regular expression. Amazon Lex supports the following characters in the regular expression:

          • A-Z, a-z

          • 0-9

          • Unicode characters ("u<Unicode>")

          Represent Unicode characters with four digits, for example "u0041" or "u005A".

          The following regular expression operators are not supported:

          • Infinite repeaters: *, +, or {x,} with no upper bound.

          • Wild card (.)

      • advancedRecognitionSetting (dict) --

        Provides settings that enable advanced recognition settings for slot values.

        • audioRecognitionStrategy (string) --

          Enables using the slot values as a custom vocabulary for recognizing user utterances.

    • parentSlotTypeSignature (string) --

      The built in slot type used as a parent to this slot type.

    • botId (string) --

      The identifier of the bot associated with the slot type.

    • botVersion (string) --

      The version of the bot associated with the slot type.

    • localeId (string) --

      The language and locale specified for the slot type.

    • creationDateTime (datetime) --

      A timestamp of the date and time that the slot type was created.

    • lastUpdatedDateTime (datetime) --

      A timestamp of the date and time that the slot type was last updated.

    • externalSourceSetting (dict) --

      Provides information about the external source of the slot type's definition.

      • grammarSlotTypeSetting (dict) --

        Settings required for a slot type based on a grammar that you provide.

        • source (dict) --

          The source of the grammar used to create the slot type.

          • s3BucketName (string) --

            The name of the S3 bucket that contains the grammar source.

          • s3ObjectKey (string) --

            The path to the grammar in the S3 bucket.

          • kmsKeyArn (string) --

            The Amazon KMS key required to decrypt the contents of the grammar, if any.

    • compositeSlotTypeSetting (dict) --

      Specifications for a composite slot type.

      • subSlots (list) --

        Subslots in the composite slot.

        • (dict) --

          Subslot type composition.

          • name (string) --

            Name of a constituent sub slot inside a composite slot.

          • slotTypeId (string) --

            The unique identifier assigned to a slot type. This refers to either a built-in slot type or the unique slotTypeId of a custom slot type.

ListSlotTypes (updated) Link ¶
Changes (response)
{'slotTypeSummaries': {'slotTypeCategory': {'Composite'}}}

Gets a list of slot types that match the specified criteria.

See also: AWS API Documentation

Request Syntax

client.list_slot_types(
    botId='string',
    botVersion='string',
    localeId='string',
    sortBy={
        'attribute': 'SlotTypeName'|'LastUpdatedDateTime',
        'order': 'Ascending'|'Descending'
    },
    filters=[
        {
            'name': 'SlotTypeName'|'ExternalSourceType',
            'values': [
                'string',
            ],
            'operator': 'CO'|'EQ'
        },
    ],
    maxResults=123,
    nextToken='string'
)
type botId

string

param botId

[REQUIRED]

The unique identifier of the bot that contains the slot types.

type botVersion

string

param botVersion

[REQUIRED]

The version of the bot that contains the slot type.

type localeId

string

param localeId

[REQUIRED]

The identifier of the language and locale of the slot types to list. The string must match one of the supported locales. For more information, see Supported languages .

type sortBy

dict

param sortBy

Determines the sort order for the response from the ListSlotTypes operation. You can choose to sort by the slot type name or last updated date in either ascending or descending order.

  • attribute (string) -- [REQUIRED]

    The attribute to use to sort the list of slot types.

  • order (string) -- [REQUIRED]

    The order to sort the list. You can say ascending or descending.

type filters

list

param filters

Provides the specification of a filter used to limit the slot types in the response to only those that match the filter specification. You can only specify one filter and only one string to filter on.

  • (dict) --

    Filters the response from the ListSlotTypes operation.

    • name (string) -- [REQUIRED]

      The name of the field to use for filtering.

    • values (list) -- [REQUIRED]

      The value to use to filter the response.

      • (string) --

    • operator (string) -- [REQUIRED]

      The operator to use for the filter. Specify EQ when the ListSlotTypes operation should return only aliases that equal the specified value. Specify CO when the ListSlotTypes operation should return aliases that contain the specified value.

type maxResults

integer

param maxResults

The maximum number of slot types to return in each page of results. If there are fewer results than the max page size, only the actual number of results are returned.

type nextToken

string

param nextToken

If the response from the ListSlotTypes operation contains more results than specified in the maxResults parameter, a token is returned in the response. Use that token in the nextToken parameter to return the next page of results.

rtype

dict

returns

Response Syntax

{
    'botId': 'string',
    'botVersion': 'string',
    'localeId': 'string',
    'slotTypeSummaries': [
        {
            'slotTypeId': 'string',
            'slotTypeName': 'string',
            'description': 'string',
            'parentSlotTypeSignature': 'string',
            'lastUpdatedDateTime': datetime(2015, 1, 1),
            'slotTypeCategory': 'Custom'|'Extended'|'ExternalGrammar'|'Composite'
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) --

    • botId (string) --

      The identifier of the bot that contains the slot types.

    • botVersion (string) --

      The version of the bot that contains the slot types.

    • localeId (string) --

      The language and local of the slot types in the list.

    • slotTypeSummaries (list) --

      Summary information for the slot types that meet the filter criteria specified in the request. The length of the list is specified in the maxResults parameter of the request. If there are more slot types available, the nextToken field contains a token to get the next page of results.

      • (dict) --

        Provides summary information about a slot type.

        • slotTypeId (string) --

          The unique identifier assigned to the slot type.

        • slotTypeName (string) --

          The name of the slot type.

        • description (string) --

          The description of the slot type.

        • parentSlotTypeSignature (string) --

          If the slot type is derived from a built-on slot type, the name of the parent slot type.

        • lastUpdatedDateTime (datetime) --

          A timestamp of the date and time that the slot type was last updated.

        • slotTypeCategory (string) --

          Indicates the type of the slot type.

          • Custom - A slot type that you created using custom values. For more information, see Creating custom slot types .

          • Extended - A slot type created by extending the AMAZON.AlphaNumeric built-in slot type. For more information, see AMAZON.AlphaNumeric .

          • ExternalGrammar - A slot type using a custom GRXML grammar to define values. For more information, see Using a custom grammar slot type .

    • nextToken (string) --

      A token that indicates whether there are more results to return in a response to the ListSlotTypes operation. If the nextToken field is present, you send the contents as the nextToken parameter of a ListSlotTypes operation request to get the next page of results.

UpdateSlot (updated) Link ¶
Changes (both)
{'subSlotSetting': {'expression': 'string',
                    'slotSpecifications': {'string': {'slotTypeId': 'string',
                                                      'valueElicitationSetting': {'defaultValueSpecification': {'defaultValueList': [{'defaultValue': 'string'}]},
                                                                                  'promptSpecification': {'allowInterrupt': 'boolean',
                                                                                                          'maxRetries': 'integer',
                                                                                                          'messageGroups': [{'message': {'customPayload': {'value': 'string'},
                                                                                                                                         'imageResponseCard': {'buttons': [{'text': 'string',
                                                                                                                                                                            'value': 'string'}],
                                                                                                                                                               'imageUrl': 'string',
                                                                                                                                                               'subtitle': 'string',
                                                                                                                                                               'title': 'string'},
                                                                                                                                         'plainTextMessage': {'value': 'string'},
                                                                                                                                         'ssmlMessage': {'value': 'string'}},
                                                                                                                             'variations': [{'customPayload': {'value': 'string'},
                                                                                                                                             'imageResponseCard': {'buttons': [{'text': 'string',
                                                                                                                                                                                'value': 'string'}],
                                                                                                                                                                   'imageUrl': 'string',
                                                                                                                                                                   'subtitle': 'string',
                                                                                                                                                                   'title': 'string'},
                                                                                                                                             'plainTextMessage': {'value': 'string'},
                                                                                                                                             'ssmlMessage': {'value': 'string'}}]}],
                                                                                                          'messageSelectionStrategy': 'Random '
                                                                                                                                      '| '
                                                                                                                                      'Ordered'},
                                                                                  'sampleUtterances': [{'utterance': 'string'}],
                                                                                  'waitAndContinueSpecification': {'active': 'boolean',
                                                                                                                   'continueResponse': {'allowInterrupt': 'boolean',
                                                                                                                                        'messageGroups': [{'message': {'customPayload': {'value': 'string'},
                                                                                                                                                                       'imageResponseCard': {'buttons': [{'text': 'string',
                                                                                                                                                                                                          'value': 'string'}],
                                                                                                                                                                                             'imageUrl': 'string',
                                                                                                                                                                                             'subtitle': 'string',
                                                                                                                                                                                             'title': 'string'},
                                                                                                                                                                       'plainTextMessage': {'value': 'string'},
                                                                                                                                                                       'ssmlMessage': {'value': 'string'}},
                                                                                                                                                           'variations': [{'customPayload': {'value': 'string'},
                                                                                                                                                                           'imageResponseCard': {'buttons': [{'text': 'string',
                                                                                                                                                                                                              'value': 'string'}],
                                                                                                                                                                                                 'imageUrl': 'string',
                                                                                                                                                                                                 'subtitle': 'string',
                                                                                                                                                                                                 'title': 'string'},
                                                                                                                                                                           'plainTextMessage': {'value': 'string'},
                                                                                                                                                                           'ssmlMessage': {'value': 'string'}}]}]},
                                                                                                                   'stillWaitingResponse': {'allowInterrupt': 'boolean',
                                                                                                                                            'frequencyInSeconds': 'integer',
                                                                                                                                            'messageGroups': [{'message': {'customPayload': {'value': 'string'},
                                                                                                                                                                           'imageResponseCard': {'buttons': [{'text': 'string',
                                                                                                                                                                                                              'value': 'string'}],
                                                                                                                                                                                                 'imageUrl': 'string',
                                                                                                                                                                                                 'subtitle': 'string',
                                                                                                                                                                                                 'title': 'string'},
                                                                                                                                                                           'plainTextMessage': {'value': 'string'},
                                                                                                                                                                           'ssmlMessage': {'value': 'string'}},
                                                                                                                                                               'variations': [{'customPayload': {'value': 'string'},
                                                                                                                                                                               'imageResponseCard': {'buttons': [{'text': 'string',
                                                                                                                                                                                                                  'value': 'string'}],
                                                                                                                                                                                                     'imageUrl': 'string',
                                                                                                                                                                                                     'subtitle': 'string',
                                                                                                                                                                                                     'title': 'string'},
                                                                                                                                                                               'plainTextMessage': {'value': 'string'},
                                                                                                                                                                               'ssmlMessage': {'value': 'string'}}]}],
                                                                                                                                            'timeoutInSeconds': 'integer'},
                                                                                                                   'waitingResponse': {'allowInterrupt': 'boolean',
                                                                                                                                       'messageGroups': [{'message': {'customPayload': {'value': 'string'},
                                                                                                                                                                      'imageResponseCard': {'buttons': [{'text': 'string',
                                                                                                                                                                                                         'value': 'string'}],
                                                                                                                                                                                            'imageUrl': 'string',
                                                                                                                                                                                            'subtitle': 'string',
                                                                                                                                                                                            'title': 'string'},
                                                                                                                                                                      'plainTextMessage': {'value': 'string'},
                                                                                                                                                                      'ssmlMessage': {'value': 'string'}},
                                                                                                                                                          'variations': [{'customPayload': {'value': 'string'},
                                                                                                                                                                          'imageResponseCard': {'buttons': [{'text': 'string',
                                                                                                                                                                                                             'value': 'string'}],
                                                                                                                                                                                                'imageUrl': 'string',
                                                                                                                                                                                                'subtitle': 'string',
                                                                                                                                                                                                'title': 'string'},
                                                                                                                                                                          'plainTextMessage': {'value': 'string'},
                                                                                                                                                                          'ssmlMessage': {'value': 'string'}}]}]}}}}}}}

Updates the settings for a slot.

See also: AWS API Documentation

Request Syntax

client.update_slot(
    slotId='string',
    slotName='string',
    description='string',
    slotTypeId='string',
    valueElicitationSetting={
        'defaultValueSpecification': {
            'defaultValueList': [
                {
                    'defaultValue': 'string'
                },
            ]
        },
        'slotConstraint': 'Required'|'Optional',
        'promptSpecification': {
            'messageGroups': [
                {
                    'message': {
                        'plainTextMessage': {
                            'value': 'string'
                        },
                        'customPayload': {
                            'value': 'string'
                        },
                        'ssmlMessage': {
                            'value': 'string'
                        },
                        'imageResponseCard': {
                            'title': 'string',
                            'subtitle': 'string',
                            'imageUrl': 'string',
                            'buttons': [
                                {
                                    'text': 'string',
                                    'value': 'string'
                                },
                            ]
                        }
                    },
                    'variations': [
                        {
                            'plainTextMessage': {
                                'value': 'string'
                            },
                            'customPayload': {
                                'value': 'string'
                            },
                            'ssmlMessage': {
                                'value': 'string'
                            },
                            'imageResponseCard': {
                                'title': 'string',
                                'subtitle': 'string',
                                'imageUrl': 'string',
                                'buttons': [
                                    {
                                        'text': 'string',
                                        'value': 'string'
                                    },
                                ]
                            }
                        },
                    ]
                },
            ],
            'maxRetries': 123,
            'allowInterrupt': True|False,
            'messageSelectionStrategy': 'Random'|'Ordered'
        },
        'sampleUtterances': [
            {
                'utterance': 'string'
            },
        ],
        'waitAndContinueSpecification': {
            'waitingResponse': {
                'messageGroups': [
                    {
                        'message': {
                            'plainTextMessage': {
                                'value': 'string'
                            },
                            'customPayload': {
                                'value': 'string'
                            },
                            'ssmlMessage': {
                                'value': 'string'
                            },
                            'imageResponseCard': {
                                'title': 'string',
                                'subtitle': 'string',
                                'imageUrl': 'string',
                                'buttons': [
                                    {
                                        'text': 'string',
                                        'value': 'string'
                                    },
                                ]
                            }
                        },
                        'variations': [
                            {
                                'plainTextMessage': {
                                    'value': 'string'
                                },
                                'customPayload': {
                                    'value': 'string'
                                },
                                'ssmlMessage': {
                                    'value': 'string'
                                },
                                'imageResponseCard': {
                                    'title': 'string',
                                    'subtitle': 'string',
                                    'imageUrl': 'string',
                                    'buttons': [
                                        {
                                            'text': 'string',
                                            'value': 'string'
                                        },
                                    ]
                                }
                            },
                        ]
                    },
                ],
                'allowInterrupt': True|False
            },
            'continueResponse': {
                'messageGroups': [
                    {
                        'message': {
                            'plainTextMessage': {
                                'value': 'string'
                            },
                            'customPayload': {
                                'value': 'string'
                            },
                            'ssmlMessage': {
                                'value': 'string'
                            },
                            'imageResponseCard': {
                                'title': 'string',
                                'subtitle': 'string',
                                'imageUrl': 'string',
                                'buttons': [
                                    {
                                        'text': 'string',
                                        'value': 'string'
                                    },
                                ]
                            }
                        },
                        'variations': [
                            {
                                'plainTextMessage': {
                                    'value': 'string'
                                },
                                'customPayload': {
                                    'value': 'string'
                                },
                                'ssmlMessage': {
                                    'value': 'string'
                                },
                                'imageResponseCard': {
                                    'title': 'string',
                                    'subtitle': 'string',
                                    'imageUrl': 'string',
                                    'buttons': [
                                        {
                                            'text': 'string',
                                            'value': 'string'
                                        },
                                    ]
                                }
                            },
                        ]
                    },
                ],
                'allowInterrupt': True|False
            },
            'stillWaitingResponse': {
                'messageGroups': [
                    {
                        'message': {
                            'plainTextMessage': {
                                'value': 'string'
                            },
                            'customPayload': {
                                'value': 'string'
                            },
                            'ssmlMessage': {
                                'value': 'string'
                            },
                            'imageResponseCard': {
                                'title': 'string',
                                'subtitle': 'string',
                                'imageUrl': 'string',
                                'buttons': [
                                    {
                                        'text': 'string',
                                        'value': 'string'
                                    },
                                ]
                            }
                        },
                        'variations': [
                            {
                                'plainTextMessage': {
                                    'value': 'string'
                                },
                                'customPayload': {
                                    'value': 'string'
                                },
                                'ssmlMessage': {
                                    'value': 'string'
                                },
                                'imageResponseCard': {
                                    'title': 'string',
                                    'subtitle': 'string',
                                    'imageUrl': 'string',
                                    'buttons': [
                                        {
                                            'text': 'string',
                                            'value': 'string'
                                        },
                                    ]
                                }
                            },
                        ]
                    },
                ],
                'frequencyInSeconds': 123,
                'timeoutInSeconds': 123,
                'allowInterrupt': True|False
            },
            'active': True|False
        },
        'slotCaptureSetting': {
            'captureResponse': {
                'messageGroups': [
                    {
                        'message': {
                            'plainTextMessage': {
                                'value': 'string'
                            },
                            'customPayload': {
                                'value': 'string'
                            },
                            'ssmlMessage': {
                                'value': 'string'
                            },
                            'imageResponseCard': {
                                'title': 'string',
                                'subtitle': 'string',
                                'imageUrl': 'string',
                                'buttons': [
                                    {
                                        'text': 'string',
                                        'value': 'string'
                                    },
                                ]
                            }
                        },
                        'variations': [
                            {
                                'plainTextMessage': {
                                    'value': 'string'
                                },
                                'customPayload': {
                                    'value': 'string'
                                },
                                'ssmlMessage': {
                                    'value': 'string'
                                },
                                'imageResponseCard': {
                                    'title': 'string',
                                    'subtitle': 'string',
                                    'imageUrl': 'string',
                                    'buttons': [
                                        {
                                            'text': 'string',
                                            'value': 'string'
                                        },
                                    ]
                                }
                            },
                        ]
                    },
                ],
                'allowInterrupt': True|False
            },
            'captureNextStep': {
                'dialogAction': {
                    'type': 'ElicitIntent'|'StartIntent'|'ElicitSlot'|'EvaluateConditional'|'InvokeDialogCodeHook'|'ConfirmIntent'|'FulfillIntent'|'CloseIntent'|'EndConversation',
                    'slotToElicit': 'string',
                    'suppressNextMessage': True|False
                },
                'intent': {
                    'name': 'string',
                    'slots': {
                        'string': {
                            'shape': 'Scalar'|'List',
                            'value': {
                                'interpretedValue': 'string'
                            },
                            'values': [
                                {'... recursive ...'},
                            ]
                        }
                    }
                },
                'sessionAttributes': {
                    'string': 'string'
                }
            },
            'captureConditional': {
                'active': True|False,
                'conditionalBranches': [
                    {
                        'name': 'string',
                        'condition': {
                            'expressionString': 'string'
                        },
                        'nextStep': {
                            'dialogAction': {
                                'type': 'ElicitIntent'|'StartIntent'|'ElicitSlot'|'EvaluateConditional'|'InvokeDialogCodeHook'|'ConfirmIntent'|'FulfillIntent'|'CloseIntent'|'EndConversation',
                                'slotToElicit': 'string',
                                'suppressNextMessage': True|False
                            },
                            'intent': {
                                'name': 'string',
                                'slots': {
                                    'string': {
                                        'shape': 'Scalar'|'List',
                                        'value': {
                                            'interpretedValue': 'string'
                                        },
                                        'values': [
                                            {'... recursive ...'},
                                        ]
                                    }
                                }
                            },
                            'sessionAttributes': {
                                'string': 'string'
                            }
                        },
                        'response': {
                            'messageGroups': [
                                {
                                    'message': {
                                        'plainTextMessage': {
                                            'value': 'string'
                                        },
                                        'customPayload': {
                                            'value': 'string'
                                        },
                                        'ssmlMessage': {
                                            'value': 'string'
                                        },
                                        'imageResponseCard': {
                                            'title': 'string',
                                            'subtitle': 'string',
                                            'imageUrl': 'string',
                                            'buttons': [
                                                {
                                                    'text': 'string',
                                                    'value': 'string'
                                                },
                                            ]
                                        }
                                    },
                                    'variations': [
                                        {
                                            'plainTextMessage': {
                                                'value': 'string'
                                            },
                                            'customPayload': {
                                                'value': 'string'
                                            },
                                            'ssmlMessage': {
                                                'value': 'string'
                                            },
                                            'imageResponseCard': {
                                                'title': 'string',
                                                'subtitle': 'string',
                                                'imageUrl': 'string',
                                                'buttons': [
                                                    {
                                                        'text': 'string',
                                                        'value': 'string'
                                                    },
                                                ]
                                            }
                                        },
                                    ]
                                },
                            ],
                            'allowInterrupt': True|False
                        }
                    },
                ],
                'defaultBranch': {
                    'nextStep': {
                        'dialogAction': {
                            'type': 'ElicitIntent'|'StartIntent'|'ElicitSlot'|'EvaluateConditional'|'InvokeDialogCodeHook'|'ConfirmIntent'|'FulfillIntent'|'CloseIntent'|'EndConversation',
                            'slotToElicit': 'string',
                            'suppressNextMessage': True|False
                        },
                        'intent': {
                            'name': 'string',
                            'slots': {
                                'string': {
                                    'shape': 'Scalar'|'List',
                                    'value': {
                                        'interpretedValue': 'string'
                                    },
                                    'values': [
                                        {'... recursive ...'},
                                    ]
                                }
                            }
                        },
                        'sessionAttributes': {
                            'string': 'string'
                        }
                    },
                    'response': {
                        'messageGroups': [
                            {
                                'message': {
                                    'plainTextMessage': {
                                        'value': 'string'
                                    },
                                    'customPayload': {
                                        'value': 'string'
                                    },
                                    'ssmlMessage': {
                                        'value': 'string'
                                    },
                                    'imageResponseCard': {
                                        'title': 'string',
                                        'subtitle': 'string',
                                        'imageUrl': 'string',
                                        'buttons': [
                                            {
                                                'text': 'string',
                                                'value': 'string'
                                            },
                                        ]
                                    }
                                },
                                'variations': [
                                    {
                                        'plainTextMessage': {
                                            'value': 'string'
                                        },
                                        'customPayload': {
                                            'value': 'string'
                                        },
                                        'ssmlMessage': {
                                            'value': 'string'
                                        },
                                        'imageResponseCard': {
                                            'title': 'string',
                                            'subtitle': 'string',
                                            'imageUrl': 'string',
                                            'buttons': [
                                                {
                                                    'text': 'string',
                                                    'value': 'string'
                                                },
                                            ]
                                        }
                                    },
                                ]
                            },
                        ],
                        'allowInterrupt': True|False
                    }
                }
            },
            'failureResponse': {
                'messageGroups': [
                    {
                        'message': {
                            'plainTextMessage': {
                                'value': 'string'
                            },
                            'customPayload': {
                                'value': 'string'
                            },
                            'ssmlMessage': {
                                'value': 'string'
                            },
                            'imageResponseCard': {
                                'title': 'string',
                                'subtitle': 'string',
                                'imageUrl': 'string',
                                'buttons': [
                                    {
                                        'text': 'string',
                                        'value': 'string'
                                    },
                                ]
                            }
                        },
                        'variations': [
                            {
                                'plainTextMessage': {
                                    'value': 'string'
                                },
                                'customPayload': {
                                    'value': 'string'
                                },
                                'ssmlMessage': {
                                    'value': 'string'
                                },
                                'imageResponseCard': {
                                    'title': 'string',
                                    'subtitle': 'string',
                                    'imageUrl': 'string',
                                    'buttons': [
                                        {
                                            'text': 'string',
                                            'value': 'string'
                                        },
                                    ]
                                }
                            },
                        ]
                    },
                ],
                'allowInterrupt': True|False
            },
            'failureNextStep': {
                'dialogAction': {
                    'type': 'ElicitIntent'|'StartIntent'|'ElicitSlot'|'EvaluateConditional'|'InvokeDialogCodeHook'|'ConfirmIntent'|'FulfillIntent'|'CloseIntent'|'EndConversation',
                    'slotToElicit': 'string',
                    'suppressNextMessage': True|False
                },
                'intent': {
                    'name': 'string',
                    'slots': {
                        'string': {
                            'shape': 'Scalar'|'List',
                            'value': {
                                'interpretedValue': 'string'
                            },
                            'values': [
                                {'... recursive ...'},
                            ]
                        }
                    }
                },
                'sessionAttributes': {
                    'string': 'string'
                }
            },
            'failureConditional': {
                'active': True|False,
                'conditionalBranches': [
                    {
                        'name': 'string',
                        'condition': {
                            'expressionString': 'string'
                        },
                        'nextStep': {
                            'dialogAction': {
                                'type': 'ElicitIntent'|'StartIntent'|'ElicitSlot'|'EvaluateConditional'|'InvokeDialogCodeHook'|'ConfirmIntent'|'FulfillIntent'|'CloseIntent'|'EndConversation',
                                'slotToElicit': 'string',
                                'suppressNextMessage': True|False
                            },
                            'intent': {
                                'name': 'string',
                                'slots': {
                                    'string': {
                                        'shape': 'Scalar'|'List',
                                        'value': {
                                            'interpretedValue': 'string'
                                        },
                                        'values': [
                                            {'... recursive ...'},
                                        ]
                                    }
                                }
                            },
                            'sessionAttributes': {
                                'string': 'string'
                            }
                        },
                        'response': {
                            'messageGroups': [
                                {
                                    'message': {
                                        'plainTextMessage': {
                                            'value': 'string'
                                        },
                                        'customPayload': {
                                            'value': 'string'
                                        },
                                        'ssmlMessage': {
                                            'value': 'string'
                                        },
                                        'imageResponseCard': {
                                            'title': 'string',
                                            'subtitle': 'string',
                                            'imageUrl': 'string',
                                            'buttons': [
                                                {
                                                    'text': 'string',
                                                    'value': 'string'
                                                },
                                            ]
                                        }
                                    },
                                    'variations': [
                                        {
                                            'plainTextMessage': {
                                                'value': 'string'
                                            },
                                            'customPayload': {
                                                'value': 'string'
                                            },
                                            'ssmlMessage': {
                                                'value': 'string'
                                            },
                                            'imageResponseCard': {
                                                'title': 'string',
                                                'subtitle': 'string',
                                                'imageUrl': 'string',
                                                'buttons': [
                                                    {
                                                        'text': 'string',
                                                        'value': 'string'
                                                    },
                                                ]
                                            }
                                        },
                                    ]
                                },
                            ],
                            'allowInterrupt': True|False
                        }
                    },
                ],
                'defaultBranch': {
                    'nextStep': {
                        'dialogAction': {
                            'type': 'ElicitIntent'|'StartIntent'|'ElicitSlot'|'EvaluateConditional'|'InvokeDialogCodeHook'|'ConfirmIntent'|'FulfillIntent'|'CloseIntent'|'EndConversation',
                            'slotToElicit': 'string',
                            'suppressNextMessage': True|False
                        },
                        'intent': {
                            'name': 'string',
                            'slots': {
                                'string': {
                                    'shape': 'Scalar'|'List',
                                    'value': {
                                        'interpretedValue': 'string'
                                    },
                                    'values': [
                                        {'... recursive ...'},
                                    ]
                                }
                            }
                        },
                        'sessionAttributes': {
                            'string': 'string'
                        }
                    },
                    'response': {
                        'messageGroups': [
                            {
                                'message': {
                                    'plainTextMessage': {
                                        'value': 'string'
                                    },
                                    'customPayload': {
                                        'value': 'string'
                                    },
                                    'ssmlMessage': {
                                        'value': 'string'
                                    },
                                    'imageResponseCard': {
                                        'title': 'string',
                                        'subtitle': 'string',
                                        'imageUrl': 'string',
                                        'buttons': [
                                            {
                                                'text': 'string',
                                                'value': 'string'
                                            },
                                        ]
                                    }
                                },
                                'variations': [
                                    {
                                        'plainTextMessage': {
                                            'value': 'string'
                                        },
                                        'customPayload': {
                                            'value': 'string'
                                        },
                                        'ssmlMessage': {
                                            'value': 'string'
                                        },
                                        'imageResponseCard': {
                                            'title': 'string',
                                            'subtitle': 'string',
                                            'imageUrl': 'string',
                                            'buttons': [
                                                {
                                                    'text': 'string',
                                                    'value': 'string'
                                                },
                                            ]
                                        }
                                    },
                                ]
                            },
                        ],
                        'allowInterrupt': True|False
                    }
                }
            },
            'codeHook': {
                'enableCodeHookInvocation': True|False,
                'active': True|False,
                'invocationLabel': 'string',
                'postCodeHookSpecification': {
                    'successResponse': {
                        'messageGroups': [
                            {
                                'message': {
                                    'plainTextMessage': {
                                        'value': 'string'
                                    },
                                    'customPayload': {
                                        'value': 'string'
                                    },
                                    'ssmlMessage': {
                                        'value': 'string'
                                    },
                                    'imageResponseCard': {
                                        'title': 'string',
                                        'subtitle': 'string',
                                        'imageUrl': 'string',
                                        'buttons': [
                                            {
                                                'text': 'string',
                                                'value': 'string'
                                            },
                                        ]
                                    }
                                },
                                'variations': [
                                    {
                                        'plainTextMessage': {
                                            'value': 'string'
                                        },
                                        'customPayload': {
                                            'value': 'string'
                                        },
                                        'ssmlMessage': {
                                            'value': 'string'
                                        },
                                        'imageResponseCard': {
                                            'title': 'string',
                                            'subtitle': 'string',
                                            'imageUrl': 'string',
                                            'buttons': [
                                                {
                                                    'text': 'string',
                                                    'value': 'string'
                                                },
                                            ]
                                        }
                                    },
                                ]
                            },
                        ],
                        'allowInterrupt': True|False
                    },
                    'successNextStep': {
                        'dialogAction': {
                            'type': 'ElicitIntent'|'StartIntent'|'ElicitSlot'|'EvaluateConditional'|'InvokeDialogCodeHook'|'ConfirmIntent'|'FulfillIntent'|'CloseIntent'|'EndConversation',
                            'slotToElicit': 'string',
                            'suppressNextMessage': True|False
                        },
                        'intent': {
                            'name': 'string',
                            'slots': {
                                'string': {
                                    'shape': 'Scalar'|'List',
                                    'value': {
                                        'interpretedValue': 'string'
                                    },
                                    'values': [
                                        {'... recursive ...'},
                                    ]
                                }
                            }
                        },
                        'sessionAttributes': {
                            'string': 'string'
                        }
                    },
                    'successConditional': {
                        'active': True|False,
                        'conditionalBranches': [
                            {
                                'name': 'string',
                                'condition': {
                                    'expressionString': 'string'
                                },
                                'nextStep': {
                                    'dialogAction': {
                                        'type': 'ElicitIntent'|'StartIntent'|'ElicitSlot'|'EvaluateConditional'|'InvokeDialogCodeHook'|'ConfirmIntent'|'FulfillIntent'|'CloseIntent'|'EndConversation',
                                        'slotToElicit': 'string',
                                        'suppressNextMessage': True|False
                                    },
                                    'intent': {
                                        'name': 'string',
                                        'slots': {
                                            'string': {
                                                'shape': 'Scalar'|'List',
                                                'value': {
                                                    'interpretedValue': 'string'
                                                },
                                                'values': [
                                                    {'... recursive ...'},
                                                ]
                                            }
                                        }
                                    },
                                    'sessionAttributes': {
                                        'string': 'string'
                                    }
                                },
                                'response': {
                                    'messageGroups': [
                                        {
                                            'message': {
                                                'plainTextMessage': {
                                                    'value': 'string'
                                                },
                                                'customPayload': {
                                                    'value': 'string'
                                                },
                                                'ssmlMessage': {
                                                    'value': 'string'
                                                },
                                                'imageResponseCard': {
                                                    'title': 'string',
                                                    'subtitle': 'string',
                                                    'imageUrl': 'string',
                                                    'buttons': [
                                                        {
                                                            'text': 'string',
                                                            'value': 'string'
                                                        },
                                                    ]
                                                }
                                            },
                                            'variations': [
                                                {
                                                    'plainTextMessage': {
                                                        'value': 'string'
                                                    },
                                                    'customPayload': {
                                                        'value': 'string'
                                                    },
                                                    'ssmlMessage': {
                                                        'value': 'string'
                                                    },
                                                    'imageResponseCard': {
                                                        'title': 'string',
                                                        'subtitle': 'string',
                                                        'imageUrl': 'string',
                                                        'buttons': [
                                                            {
                                                                'text': 'string',
                                                                'value': 'string'
                                                            },
                                                        ]
                                                    }
                                                },
                                            ]
                                        },
                                    ],
                                    'allowInterrupt': True|False
                                }
                            },
                        ],
                        'defaultBranch': {
                            'nextStep': {
                                'dialogAction': {
                                    'type': 'ElicitIntent'|'StartIntent'|'ElicitSlot'|'EvaluateConditional'|'InvokeDialogCodeHook'|'ConfirmIntent'|'FulfillIntent'|'CloseIntent'|'EndConversation',
                                    'slotToElicit': 'string',
                                    'suppressNextMessage': True|False
                                },
                                'intent': {
                                    'name': 'string',
                                    'slots': {
                                        'string': {
                                            'shape': 'Scalar'|'List',
                                            'value': {
                                                'interpretedValue': 'string'
                                            },
                                            'values': [
                                                {'... recursive ...'},
                                            ]
                                        }
                                    }
                                },
                                'sessionAttributes': {
                                    'string': 'string'
                                }
                            },
                            'response': {
                                'messageGroups': [
                                    {
                                        'message': {
                                            'plainTextMessage': {
                                                'value': 'string'
                                            },
                                            'customPayload': {
                                                'value': 'string'
                                            },
                                            'ssmlMessage': {
                                                'value': 'string'
                                            },
                                            'imageResponseCard': {
                                                'title': 'string',
                                                'subtitle': 'string',
                                                'imageUrl': 'string',
                                                'buttons': [
                                                    {
                                                        'text': 'string',
                                                        'value': 'string'
                                                    },
                                                ]
                                            }
                                        },
                                        'variations': [
                                            {
                                                'plainTextMessage': {
                                                    'value': 'string'
                                                },
                                                'customPayload': {
                                                    'value': 'string'
                                                },
                                                'ssmlMessage': {
                                                    'value': 'string'
                                                },
                                                'imageResponseCard': {
                                                    'title': 'string',
                                                    'subtitle': 'string',
                                                    'imageUrl': 'string',
                                                    'buttons': [
                                                        {
                                                            'text': 'string',
                                                            'value': 'string'
                                                        },
                                                    ]
                                                }
                                            },
                                        ]
                                    },
                                ],
                                'allowInterrupt': True|False
                            }
                        }
                    },
                    'failureResponse': {
                        'messageGroups': [
                            {
                                'message': {
                                    'plainTextMessage': {
                                        'value': 'string'
                                    },
                                    'customPayload': {
                                        'value': 'string'
                                    },
                                    'ssmlMessage': {
                                        'value': 'string'
                                    },
                                    'imageResponseCard': {
                                        'title': 'string',
                                        'subtitle': 'string',
                                        'imageUrl': 'string',
                                        'buttons': [
                                            {
                                                'text': 'string',
                                                'value': 'string'
                                            },
                                        ]
                                    }
                                },
                                'variations': [
                                    {
                                        'plainTextMessage': {
                                            'value': 'string'
                                        },
                                        'customPayload': {
                                            'value': 'string'
                                        },
                                        'ssmlMessage': {
                                            'value': 'string'
                                        },
                                        'imageResponseCard': {
                                            'title': 'string',
                                            'subtitle': 'string',
                                            'imageUrl': 'string',
                                            'buttons': [
                                                {
                                                    'text': 'string',
                                                    'value': 'string'
                                                },
                                            ]
                                        }
                                    },
                                ]
                            },
                        ],
                        'allowInterrupt': True|False
                    },
                    'failureNextStep': {
                        'dialogAction': {
                            'type': 'ElicitIntent'|'StartIntent'|'ElicitSlot'|'EvaluateConditional'|'InvokeDialogCodeHook'|'ConfirmIntent'|'FulfillIntent'|'CloseIntent'|'EndConversation',
                            'slotToElicit': 'string',
                            'suppressNextMessage': True|False
                        },
                        'intent': {
                            'name': 'string',
                            'slots': {
                                'string': {
                                    'shape': 'Scalar'|'List',
                                    'value': {
                                        'interpretedValue': 'string'
                                    },
                                    'values': [
                                        {'... recursive ...'},
                                    ]
                                }
                            }
                        },
                        'sessionAttributes': {
                            'string': 'string'
                        }
                    },
                    'failureConditional': {
                        'active': True|False,
                        'conditionalBranches': [
                            {
                                'name': 'string',
                                'condition': {
                                    'expressionString': 'string'
                                },
                                'nextStep': {
                                    'dialogAction': {
                                        'type': 'ElicitIntent'|'StartIntent'|'ElicitSlot'|'EvaluateConditional'|'InvokeDialogCodeHook'|'ConfirmIntent'|'FulfillIntent'|'CloseIntent'|'EndConversation',
                                        'slotToElicit': 'string',
                                        'suppressNextMessage': True|False
                                    },
                                    'intent': {
                                        'name': 'string',
                                        'slots': {
                                            'string': {
                                                'shape': 'Scalar'|'List',
                                                'value': {
                                                    'interpretedValue': 'string'
                                                },
                                                'values': [
                                                    {'... recursive ...'},
                                                ]
                                            }
                                        }
                                    },
                                    'sessionAttributes': {
                                        'string': 'string'
                                    }
                                },
                                'response': {
                                    'messageGroups': [
                                        {
                                            'message': {
                                                'plainTextMessage': {
                                                    'value': 'string'
                                                },
                                                'customPayload': {
                                                    'value': 'string'
                                                },
                                                'ssmlMessage': {
                                                    'value': 'string'
                                                },
                                                'imageResponseCard': {
                                                    'title': 'string',
                                                    'subtitle': 'string',
                                                    'imageUrl': 'string',
                                                    'buttons': [
                                                        {
                                                            'text': 'string',
                                                            'value': 'string'
                                                        },
                                                    ]
                                                }
                                            },
                                            'variations': [
                                                {
                                                    'plainTextMessage': {
                                                        'value': 'string'
                                                    },
                                                    'customPayload': {
                                                        'value': 'string'
                                                    },
                                                    'ssmlMessage': {
                                                        'value': 'string'
                                                    },
                                                    'imageResponseCard': {
                                                        'title': 'string',
                                                        'subtitle': 'string',
                                                        'imageUrl': 'string',
                                                        'buttons': [
                                                            {
                                                                'text': 'string',
                                                                'value': 'string'
                                                            },
                                                        ]
                                                    }
                                                },
                                            ]
                                        },
                                    ],
                                    'allowInterrupt': True|False
                                }
                            },
                        ],
                        'defaultBranch': {
                            'nextStep': {
                                'dialogAction': {
                                    'type': 'ElicitIntent'|'StartIntent'|'ElicitSlot'|'EvaluateConditional'|'InvokeDialogCodeHook'|'ConfirmIntent'|'FulfillIntent'|'CloseIntent'|'EndConversation',
                                    'slotToElicit': 'string',
                                    'suppressNextMessage': True|False
                                },
                                'intent': {
                                    'name': 'string',
                                    'slots': {
                                        'string': {
                                            'shape': 'Scalar'|'List',
                                            'value': {
                                                'interpretedValue': 'string'
                                            },
                                            'values': [
                                                {'... recursive ...'},
                                            ]
                                        }
                                    }
                                },
                                'sessionAttributes': {
                                    'string': 'string'
                                }
                            },
                            'response': {
                                'messageGroups': [
                                    {
                                        'message': {
                                            'plainTextMessage': {
                                                'value': 'string'
                                            },
                                            'customPayload': {
                                                'value': 'string'
                                            },
                                            'ssmlMessage': {
                                                'value': 'string'
                                            },
                                            'imageResponseCard': {
                                                'title': 'string',
                                                'subtitle': 'string',
                                                'imageUrl': 'string',
                                                'buttons': [
                                                    {
                                                        'text': 'string',
                                                        'value': 'string'
                                                    },
                                                ]
                                            }
                                        },
                                        'variations': [
                                            {
                                                'plainTextMessage': {
                                                    'value': 'string'
                                                },
                                                'customPayload': {
                                                    'value': 'string'
                                                },
                                                'ssmlMessage': {
                                                    'value': 'string'
                                                },
                                                'imageResponseCard': {
                                                    'title': 'string',
                                                    'subtitle': 'string',
                                                    'imageUrl': 'string',
                                                    'buttons': [
                                                        {
                                                            'text': 'string',
                                                            'value': 'string'
                                                        },
                                                    ]
                                                }
                                            },
                                        ]
                                    },
                                ],
                                'allowInterrupt': True|False
                            }
                        }
                    },
                    'timeoutResponse': {
                        'messageGroups': [
                            {
                                'message': {
                                    'plainTextMessage': {
                                        'value': 'string'
                                    },
                                    'customPayload': {
                                        'value': 'string'
                                    },
                                    'ssmlMessage': {
                                        'value': 'string'
                                    },
                                    'imageResponseCard': {
                                        'title': 'string',
                                        'subtitle': 'string',
                                        'imageUrl': 'string',
                                        'buttons': [
                                            {
                                                'text': 'string',
                                                'value': 'string'
                                            },
                                        ]
                                    }
                                },
                                'variations': [
                                    {
                                        'plainTextMessage': {
                                            'value': 'string'
                                        },
                                        'customPayload': {
                                            'value': 'string'
                                        },
                                        'ssmlMessage': {
                                            'value': 'string'
                                        },
                                        'imageResponseCard': {
                                            'title': 'string',
                                            'subtitle': 'string',
                                            'imageUrl': 'string',
                                            'buttons': [
                                                {
                                                    'text': 'string',
                                                    'value': 'string'
                                                },
                                            ]
                                        }
                                    },
                                ]
                            },
                        ],
                        'allowInterrupt': True|False
                    },
                    'timeoutNextStep': {
                        'dialogAction': {
                            'type': 'ElicitIntent'|'StartIntent'|'ElicitSlot'|'EvaluateConditional'|'InvokeDialogCodeHook'|'ConfirmIntent'|'FulfillIntent'|'CloseIntent'|'EndConversation',
                            'slotToElicit': 'string',
                            'suppressNextMessage': True|False
                        },
                        'intent': {
                            'name': 'string',
                            'slots': {
                                'string': {
                                    'shape': 'Scalar'|'List',
                                    'value': {
                                        'interpretedValue': 'string'
                                    },
                                    'values': [
                                        {'... recursive ...'},
                                    ]
                                }
                            }
                        },
                        'sessionAttributes': {
                            'string': 'string'
                        }
                    },
                    'timeoutConditional': {
                        'active': True|False,
                        'conditionalBranches': [
                            {
                                'name': 'string',
                                'condition': {
                                    'expressionString': 'string'
                                },
                                'nextStep': {
                                    'dialogAction': {
                                        'type': 'ElicitIntent'|'StartIntent'|'ElicitSlot'|'EvaluateConditional'|'InvokeDialogCodeHook'|'ConfirmIntent'|'FulfillIntent'|'CloseIntent'|'EndConversation',
                                        'slotToElicit': 'string',
                                        'suppressNextMessage': True|False
                                    },
                                    'intent': {
                                        'name': 'string',
                                        'slots': {
                                            'string': {
                                                'shape': 'Scalar'|'List',
                                                'value': {
                                                    'interpretedValue': 'string'
                                                },
                                                'values': [
                                                    {'... recursive ...'},
                                                ]
                                            }
                                        }
                                    },
                                    'sessionAttributes': {
                                        'string': 'string'
                                    }
                                },
                                'response': {
                                    'messageGroups': [
                                        {
                                            'message': {
                                                'plainTextMessage': {
                                                    'value': 'string'
                                                },
                                                'customPayload': {
                                                    'value': 'string'
                                                },
                                                'ssmlMessage': {
                                                    'value': 'string'
                                                },
                                                'imageResponseCard': {
                                                    'title': 'string',
                                                    'subtitle': 'string',
                                                    'imageUrl': 'string',
                                                    'buttons': [
                                                        {
                                                            'text': 'string',
                                                            'value': 'string'
                                                        },
                                                    ]
                                                }
                                            },
                                            'variations': [
                                                {
                                                    'plainTextMessage': {
                                                        'value': 'string'
                                                    },
                                                    'customPayload': {
                                                        'value': 'string'
                                                    },
                                                    'ssmlMessage': {
                                                        'value': 'string'
                                                    },
                                                    'imageResponseCard': {
                                                        'title': 'string',
                                                        'subtitle': 'string',
                                                        'imageUrl': 'string',
                                                        'buttons': [
                                                            {
                                                                'text': 'string',
                                                                'value': 'string'
                                                            },
                                                        ]
                                                    }
                                                },
                                            ]
                                        },
                                    ],
                                    'allowInterrupt': True|False
                                }
                            },
                        ],
                        'defaultBranch': {
                            'nextStep': {
                                'dialogAction': {
                                    'type': 'ElicitIntent'|'StartIntent'|'ElicitSlot'|'EvaluateConditional'|'InvokeDialogCodeHook'|'ConfirmIntent'|'FulfillIntent'|'CloseIntent'|'EndConversation',
                                    'slotToElicit': 'string',
                                    'suppressNextMessage': True|False
                                },
                                'intent': {
                                    'name': 'string',
                                    'slots': {
                                        'string': {
                                            'shape': 'Scalar'|'List',
                                            'value': {
                                                'interpretedValue': 'string'
                                            },
                                            'values': [
                                                {'... recursive ...'},
                                            ]
                                        }
                                    }
                                },
                                'sessionAttributes': {
                                    'string': 'string'
                                }
                            },
                            'response': {
                                'messageGroups': [
                                    {
                                        'message': {
                                            'plainTextMessage': {
                                                'value': 'string'
                                            },
                                            'customPayload': {
                                                'value': 'string'
                                            },
                                            'ssmlMessage': {
                                                'value': 'string'
                                            },
                                            'imageResponseCard': {
                                                'title': 'string',
                                                'subtitle': 'string',
                                                'imageUrl': 'string',
                                                'buttons': [
                                                    {
                                                        'text': 'string',
                                                        'value': 'string'
                                                    },
                                                ]
                                            }
                                        },
                                        'variations': [
                                            {
                                                'plainTextMessage': {
                                                    'value': 'string'
                                                },
                                                'customPayload': {
                                                    'value': 'string'
                                                },
                                                'ssmlMessage': {
                                                    'value': 'string'
                                                },
                                                'imageResponseCard': {
                                                    'title': 'string',
                                                    'subtitle': 'string',
                                                    'imageUrl': 'string',
                                                    'buttons': [
                                                        {
                                                            'text': 'string',
                                                            'value': 'string'
                                                        },
                                                    ]
                                                }
                                            },
                                        ]
                                    },
                                ],
                                'allowInterrupt': True|False
                            }
                        }
                    }
                }
            },
            'elicitationCodeHook': {
                'enableCodeHookInvocation': True|False,
                'invocationLabel': 'string'
            }
        }
    },
    obfuscationSetting={
        'obfuscationSettingType': 'None'|'DefaultObfuscation'
    },
    botId='string',
    botVersion='string',
    localeId='string',
    intentId='string',
    multipleValuesSetting={
        'allowMultipleValues': True|False
    },
    subSlotSetting={
        'expression': 'string',
        'slotSpecifications': {
            'string': {
                'slotTypeId': 'string',
                'valueElicitationSetting': {
                    'defaultValueSpecification': {
                        'defaultValueList': [
                            {
                                'defaultValue': 'string'
                            },
                        ]
                    },
                    'promptSpecification': {
                        'messageGroups': [
                            {
                                'message': {
                                    'plainTextMessage': {
                                        'value': 'string'
                                    },
                                    'customPayload': {
                                        'value': 'string'
                                    },
                                    'ssmlMessage': {
                                        'value': 'string'
                                    },
                                    'imageResponseCard': {
                                        'title': 'string',
                                        'subtitle': 'string',
                                        'imageUrl': 'string',
                                        'buttons': [
                                            {
                                                'text': 'string',
                                                'value': 'string'
                                            },
                                        ]
                                    }
                                },
                                'variations': [
                                    {
                                        'plainTextMessage': {
                                            'value': 'string'
                                        },
                                        'customPayload': {
                                            'value': 'string'
                                        },
                                        'ssmlMessage': {
                                            'value': 'string'
                                        },
                                        'imageResponseCard': {
                                            'title': 'string',
                                            'subtitle': 'string',
                                            'imageUrl': 'string',
                                            'buttons': [
                                                {
                                                    'text': 'string',
                                                    'value': 'string'
                                                },
                                            ]
                                        }
                                    },
                                ]
                            },
                        ],
                        'maxRetries': 123,
                        'allowInterrupt': True|False,
                        'messageSelectionStrategy': 'Random'|'Ordered'
                    },
                    'sampleUtterances': [
                        {
                            'utterance': 'string'
                        },
                    ],
                    'waitAndContinueSpecification': {
                        'waitingResponse': {
                            'messageGroups': [
                                {
                                    'message': {
                                        'plainTextMessage': {
                                            'value': 'string'
                                        },
                                        'customPayload': {
                                            'value': 'string'
                                        },
                                        'ssmlMessage': {
                                            'value': 'string'
                                        },
                                        'imageResponseCard': {
                                            'title': 'string',
                                            'subtitle': 'string',
                                            'imageUrl': 'string',
                                            'buttons': [
                                                {
                                                    'text': 'string',
                                                    'value': 'string'
                                                },
                                            ]
                                        }
                                    },
                                    'variations': [
                                        {
                                            'plainTextMessage': {
                                                'value': 'string'
                                            },
                                            'customPayload': {
                                                'value': 'string'
                                            },
                                            'ssmlMessage': {
                                                'value': 'string'
                                            },
                                            'imageResponseCard': {
                                                'title': 'string',
                                                'subtitle': 'string',
                                                'imageUrl': 'string',
                                                'buttons': [
                                                    {
                                                        'text': 'string',
                                                        'value': 'string'
                                                    },
                                                ]
                                            }
                                        },
                                    ]
                                },
                            ],
                            'allowInterrupt': True|False
                        },
                        'continueResponse': {
                            'messageGroups': [
                                {
                                    'message': {
                                        'plainTextMessage': {
                                            'value': 'string'
                                        },
                                        'customPayload': {
                                            'value': 'string'
                                        },
                                        'ssmlMessage': {
                                            'value': 'string'
                                        },
                                        'imageResponseCard': {
                                            'title': 'string',
                                            'subtitle': 'string',
                                            'imageUrl': 'string',
                                            'buttons': [
                                                {
                                                    'text': 'string',
                                                    'value': 'string'
                                                },
                                            ]
                                        }
                                    },
                                    'variations': [
                                        {
                                            'plainTextMessage': {
                                                'value': 'string'
                                            },
                                            'customPayload': {
                                                'value': 'string'
                                            },
                                            'ssmlMessage': {
                                                'value': 'string'
                                            },
                                            'imageResponseCard': {
                                                'title': 'string',
                                                'subtitle': 'string',
                                                'imageUrl': 'string',
                                                'buttons': [
                                                    {
                                                        'text': 'string',
                                                        'value': 'string'
                                                    },
                                                ]
                                            }
                                        },
                                    ]
                                },
                            ],
                            'allowInterrupt': True|False
                        },
                        'stillWaitingResponse': {
                            'messageGroups': [
                                {
                                    'message': {
                                        'plainTextMessage': {
                                            'value': 'string'
                                        },
                                        'customPayload': {
                                            'value': 'string'
                                        },
                                        'ssmlMessage': {
                                            'value': 'string'
                                        },
                                        'imageResponseCard': {
                                            'title': 'string',
                                            'subtitle': 'string',
                                            'imageUrl': 'string',
                                            'buttons': [
                                                {
                                                    'text': 'string',
                                                    'value': 'string'
                                                },
                                            ]
                                        }
                                    },
                                    'variations': [
                                        {
                                            'plainTextMessage': {
                                                'value': 'string'
                                            },
                                            'customPayload': {
                                                'value': 'string'
                                            },
                                            'ssmlMessage': {
                                                'value': 'string'
                                            },
                                            'imageResponseCard': {
                                                'title': 'string',
                                                'subtitle': 'string',
                                                'imageUrl': 'string',
                                                'buttons': [
                                                    {
                                                        'text': 'string',
                                                        'value': 'string'
                                                    },
                                                ]
                                            }
                                        },
                                    ]
                                },
                            ],
                            'frequencyInSeconds': 123,
                            'timeoutInSeconds': 123,
                            'allowInterrupt': True|False
                        },
                        'active': True|False
                    }
                }
            }
        }
    }
)
type slotId

string

param slotId

[REQUIRED]

The unique identifier for the slot to update.

type slotName

string

param slotName

[REQUIRED]

The new name for the slot.

type description

string

param description

The new description for the slot.

type slotTypeId

string

param slotTypeId

The unique identifier of the new slot type to associate with this slot.

type valueElicitationSetting

dict

param valueElicitationSetting

[REQUIRED]

A new set of prompts that Amazon Lex sends to the user to elicit a response the provides a value for the slot.

  • defaultValueSpecification (dict) --

    A list of default values for a slot. Default values are used when Amazon Lex hasn't determined a value for a slot. You can specify default values from context variables, session attributes, and defined values.

    • defaultValueList (list) -- [REQUIRED]

      A list of default values. Amazon Lex chooses the default value to use in the order that they are presented in the list.

      • (dict) --

        Specifies the default value to use when a user doesn't provide a value for a slot.

        • defaultValue (string) -- [REQUIRED]

          The default value to use when a user doesn't provide a value for a slot.

  • slotConstraint (string) -- [REQUIRED]

    Specifies whether the slot is required or optional.

  • promptSpecification (dict) --

    The prompt that Amazon Lex uses to elicit the slot value from the user.

    • messageGroups (list) -- [REQUIRED]

      A collection of messages that Amazon Lex can send to the user. Amazon Lex chooses the actual message to send at runtime.

      • (dict) --

        Provides one or more messages that Amazon Lex should send to the user.

        • message (dict) -- [REQUIRED]

          The primary message that Amazon Lex should send to the user.

          • plainTextMessage (dict) --

            A message in plain text format.

            • value (string) -- [REQUIRED]

              The message to send to the user.

          • customPayload (dict) --

            A message in a custom format defined by the client application.

            • value (string) -- [REQUIRED]

              The string that is sent to your application.

          • ssmlMessage (dict) --

            A message in Speech Synthesis Markup Language (SSML).

            • value (string) -- [REQUIRED]

              The SSML text that defines the prompt.

          • imageResponseCard (dict) --

            A message that defines a response card that the client application can show to the user.

            • title (string) -- [REQUIRED]

              The title to display on the response card. The format of the title is determined by the platform displaying the response card.

            • subtitle (string) --

              The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

            • imageUrl (string) --

              The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

            • buttons (list) --

              A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.

              • (dict) --

                Describes a button to use on a response card used to gather slot values from a user.

                • text (string) -- [REQUIRED]

                  The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

                • value (string) -- [REQUIRED]

                  The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

        • variations (list) --

          Message variations to send to the user. When variations are defined, Amazon Lex chooses the primary message or one of the variations to send to the user.

          • (dict) --

            The object that provides message text and it's type.

            • plainTextMessage (dict) --

              A message in plain text format.

              • value (string) -- [REQUIRED]

                The message to send to the user.

            • customPayload (dict) --

              A message in a custom format defined by the client application.

              • value (string) -- [REQUIRED]

                The string that is sent to your application.

            • ssmlMessage (dict) --

              A message in Speech Synthesis Markup Language (SSML).

              • value (string) -- [REQUIRED]

                The SSML text that defines the prompt.

            • imageResponseCard (dict) --

              A message that defines a response card that the client application can show to the user.

              • title (string) -- [REQUIRED]

                The title to display on the response card. The format of the title is determined by the platform displaying the response card.

              • subtitle (string) --

                The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

              • imageUrl (string) --

                The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

              • buttons (list) --

                A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.

                • (dict) --

                  Describes a button to use on a response card used to gather slot values from a user.

                  • text (string) -- [REQUIRED]

                    The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

                  • value (string) -- [REQUIRED]

                    The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

    • maxRetries (integer) -- [REQUIRED]

      The maximum number of times the bot tries to elicit a response from the user using this prompt.

    • allowInterrupt (boolean) --

      Indicates whether the user can interrupt a speech prompt from the bot.

    • messageSelectionStrategy (string) --

      Indicates how a message is selected from a message group among retries.

  • sampleUtterances (list) --

    If you know a specific pattern that users might respond to an Amazon Lex request for a slot value, you can provide those utterances to improve accuracy. This is optional. In most cases, Amazon Lex is capable of understanding user utterances.

    • (dict) --

      A sample utterance that invokes an intent or respond to a slot elicitation prompt.

      • utterance (string) -- [REQUIRED]

        The sample utterance that Amazon Lex uses to build its machine-learning model to recognize intents.

  • waitAndContinueSpecification (dict) --

    Specifies the prompts that Amazon Lex uses while a bot is waiting for customer input.

    • waitingResponse (dict) -- [REQUIRED]

      The response that Amazon Lex sends to indicate that the bot is waiting for the conversation to continue.

      • messageGroups (list) -- [REQUIRED]

        A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.

        • (dict) --

          Provides one or more messages that Amazon Lex should send to the user.

          • message (dict) -- [REQUIRED]

            The primary message that Amazon Lex should send to the user.

            • plainTextMessage (dict) --

              A message in plain text format.

              • value (string) -- [REQUIRED]

                The message to send to the user.

            • customPayload (dict) --

              A message in a custom format defined by the client application.

              • value (string) -- [REQUIRED]

                The string that is sent to your application.

            • ssmlMessage (dict) --

              A message in Speech Synthesis Markup Language (SSML).

              • value (string) -- [REQUIRED]

                The SSML text that defines the prompt.

            • imageResponseCard (dict) --

              A message that defines a response card that the client application can show to the user.

              • title (string) -- [REQUIRED]

                The title to display on the response card. The format of the title is determined by the platform displaying the response card.

              • subtitle (string) --

                The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

              • imageUrl (string) --

                The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

              • buttons (list) --

                A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.

                • (dict) --

                  Describes a button to use on a response card used to gather slot values from a user.

                  • text (string) -- [REQUIRED]

                    The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

                  • value (string) -- [REQUIRED]

                    The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

          • variations (list) --

            Message variations to send to the user. When variations are defined, Amazon Lex chooses the primary message or one of the variations to send to the user.

            • (dict) --

              The object that provides message text and it's type.

              • plainTextMessage (dict) --

                A message in plain text format.

                • value (string) -- [REQUIRED]

                  The message to send to the user.

              • customPayload (dict) --

                A message in a custom format defined by the client application.

                • value (string) -- [REQUIRED]

                  The string that is sent to your application.

              • ssmlMessage (dict) --

                A message in Speech Synthesis Markup Language (SSML).

                • value (string) -- [REQUIRED]

                  The SSML text that defines the prompt.

              • imageResponseCard (dict) --

                A message that defines a response card that the client application can show to the user.

                • title (string) -- [REQUIRED]

                  The title to display on the response card. The format of the title is determined by the platform displaying the response card.

                • subtitle (string) --

                  The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

                • imageUrl (string) --

                  The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

                • buttons (list) --

                  A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.

                  • (dict) --

                    Describes a button to use on a response card used to gather slot values from a user.

                    • text (string) -- [REQUIRED]

                      The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

                    • value (stri