LexModelsV2

Client

class LexModelsV2.Client

A low-level client representing Amazon Lex Model Building V2 (Lex Models V2)

client = session.create_client('lexv2-models')

These are the available methods:

build_bot_locale(**kwargs)

Builds a bot, its intents, and its slot types into a specific locale. A bot can be built into multiple locales. At runtime the locale is used to choose a specific build of the bot.

See also: AWS API Documentation

Request Syntax

response = client.build_bot_locale(
    botId='string',
    botVersion='string',
    localeId='string'
)
Parameters
  • botId (string) --

    [REQUIRED]

    The identifier of the bot to build. The identifier is returned in the response from the CreateBot operation.

  • botVersion (string) --

    [REQUIRED]

    The version of the bot to build. This can only be the draft version of the bot.

  • localeId (string) --

    [REQUIRED]

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

Return type

dict

Returns

Response Syntax

{
    'botId': 'string',
    'botVersion': 'string',
    'localeId': 'string',
    'botLocaleStatus': 'Creating'|'Building'|'Built'|'ReadyExpressTesting'|'Failed'|'Deleting'|'NotBuilt'|'Importing'|'Processing',
    'lastBuildSubmittedDateTime': datetime(2015, 1, 1)
}

Response Structure

  • (dict) --

    • botId (string) --

      The identifier of the specified bot.

    • botVersion (string) --

      The version of the bot that was built. This is only the draft version of the bot.

    • localeId (string) --

      The language and locale specified of where the bot can be used.

    • botLocaleStatus (string) --

      The bot's build status. When the status is ReadyExpressTesting you can test the bot using the utterances defined for the intents and slot types. When the status is Built , the bot is ready for use and can be tested using any utterance.

    • lastBuildSubmittedDateTime (datetime) --

      A timestamp indicating the date and time that the bot was last built for this locale.

Exceptions

can_paginate(operation_name)

Check if an operation can be paginated.

Parameters
operation_name (string) -- The operation name. This is the same name as the method name on the client. For example, if the method name is create_foo, and you'd normally invoke the operation as client.create_foo(**kwargs), if the create_foo operation can be paginated, you can use the call client.get_paginator("create_foo").
Returns
True if the operation can be paginated, False otherwise.
close()

Closes underlying endpoint connections.

create_bot(**kwargs)

Creates an Amazon Lex conversational bot.

See also: AWS API Documentation

Request Syntax

response = client.create_bot(
    botName='string',
    description='string',
    roleArn='string',
    dataPrivacy={
        'childDirected': True|False
    },
    idleSessionTTLInSeconds=123,
    botTags={
        'string': 'string'
    },
    testBotAliasTags={
        'string': 'string'
    }
)
Parameters
  • botName (string) --

    [REQUIRED]

    The name of the bot. The bot name must be unique in the account that creates the bot.

  • description (string) -- A description of the bot. It appears in lists to help you identify a particular bot.
  • roleArn (string) --

    [REQUIRED]

    The Amazon Resource Name (ARN) of an IAM role that has permission to access the bot.

  • dataPrivacy (dict) --

    [REQUIRED]

    Provides information on additional privacy protections Amazon Lex should use with the bot's data.

    • childDirected (boolean) -- [REQUIRED]

      For each Amazon Lex bot created with the Amazon Lex Model Building Service, you must specify whether your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to the Children's Online Privacy Protection Act (COPPA) by specifying true or false in the childDirected field. By specifying true in the childDirected field, you confirm that your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA. By specifying false in the childDirected field, you confirm that your use of Amazon Lex is not related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA. You may not specify a default value for the childDirected field that does not accurately reflect whether your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA. If your use of Amazon Lex relates to a website, program, or other application that is directed in whole or in part, to children under age 13, you must obtain any required verifiable parental consent under COPPA. For information regarding the use of Amazon Lex in connection with websites, programs, or other applications that are directed or targeted, in whole or in part, to children under age 13, see the Amazon Lex FAQ .

  • idleSessionTTLInSeconds (integer) --

    [REQUIRED]

    The time, in seconds, that Amazon Lex should keep information about a user's conversation with the bot.

    A user interaction remains active for the amount of time specified. If no conversation occurs during this time, the session expires and Amazon Lex deletes any data provided before the timeout.

    You can specify between 60 (1 minute) and 86,400 (24 hours) seconds.

  • botTags (dict) --

    A list of tags to add to the bot. You can only add tags when you create a bot. You can't use the UpdateBot operation to update tags. To update tags, use the TagResource operation.

    • (string) --
      • (string) --
  • testBotAliasTags (dict) --

    A list of tags to add to the test alias for a bot. You can only add tags when you create a bot. You can't use the UpdateAlias operation to update tags. To update tags on the test alias, use the TagResource operation.

    • (string) --
      • (string) --
Return type

dict

Returns

Response Syntax

{
    'botId': 'string',
    'botName': 'string',
    'description': 'string',
    'roleArn': 'string',
    'dataPrivacy': {
        'childDirected': True|False
    },
    'idleSessionTTLInSeconds': 123,
    'botStatus': 'Creating'|'Available'|'Inactive'|'Deleting'|'Failed'|'Versioning'|'Importing',
    'creationDateTime': datetime(2015, 1, 1),
    'botTags': {
        'string': 'string'
    },
    'testBotAliasTags': {
        'string': 'string'
    }
}

Response Structure

  • (dict) --

    • botId (string) --

      A unique identifier for a particular bot. You use this to identify the bot when you call other Amazon Lex API operations.

    • botName (string) --

      The name specified for the bot.

    • description (string) --

      The description specified for the bot.

    • roleArn (string) --

      The IAM role specified for the bot.

    • dataPrivacy (dict) --

      The data privacy settings specified for the bot.

      • childDirected (boolean) --

        For each Amazon Lex bot created with the Amazon Lex Model Building Service, you must specify whether your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to the Children's Online Privacy Protection Act (COPPA) by specifying true or false in the childDirected field. By specifying true in the childDirected field, you confirm that your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA. By specifying false in the childDirected field, you confirm that your use of Amazon Lex is not related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA. You may not specify a default value for the childDirected field that does not accurately reflect whether your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA. If your use of Amazon Lex relates to a website, program, or other application that is directed in whole or in part, to children under age 13, you must obtain any required verifiable parental consent under COPPA. For information regarding the use of Amazon Lex in connection with websites, programs, or other applications that are directed or targeted, in whole or in part, to children under age 13, see the Amazon Lex FAQ .

    • idleSessionTTLInSeconds (integer) --

      The session idle time specified for the bot.

    • botStatus (string) --

      Shows the current status of the bot. The bot is first in the Creating status. Once the bot is read for use, it changes to the Available status. After the bot is created, you can use the Draft version of the bot.

    • creationDateTime (datetime) --

      A timestamp indicating the date and time that the bot was created.

    • botTags (dict) --

      A list of tags associated with the bot.

      • (string) --
        • (string) --
    • testBotAliasTags (dict) --

      A list of tags associated with the test alias for the bot.

      • (string) --
        • (string) --

Exceptions

create_bot_alias(**kwargs)

Creates an alias for the specified version of a bot. Use an alias to enable you to change the version of a bot without updating applications that use the bot.

For example, you can create an alias called "PROD" that your applications use to call the Amazon Lex bot.

See also: AWS API Documentation

Request Syntax

response = client.create_bot_alias(
    botAliasName='string',
    description='string',
    botVersion='string',
    botAliasLocaleSettings={
        'string': {
            'enabled': True|False,
            'codeHookSpecification': {
                'lambdaCodeHook': {
                    'lambdaARN': 'string',
                    'codeHookInterfaceVersion': 'string'
                }
            }
        }
    },
    conversationLogSettings={
        'textLogSettings': [
            {
                'enabled': True|False,
                'destination': {
                    'cloudWatch': {
                        'cloudWatchLogGroupArn': 'string',
                        'logPrefix': 'string'
                    }
                }
            },
        ],
        'audioLogSettings': [
            {
                'enabled': True|False,
                'destination': {
                    's3Bucket': {
                        'kmsKeyArn': 'string',
                        's3BucketArn': 'string',
                        'logPrefix': 'string'
                    }
                }
            },
        ]
    },
    sentimentAnalysisSettings={
        'detectSentiment': True|False
    },
    botId='string',
    tags={
        'string': 'string'
    }
)
Parameters
  • botAliasName (string) --

    [REQUIRED]

    The alias to create. The name must be unique for the bot.

  • description (string) -- A description of the alias. Use this description to help identify the alias.
  • botVersion (string) -- The version of the bot that this alias points to. You can use the UpdateBotAlias operation to change the bot version associated with the alias.
  • botAliasLocaleSettings (dict) --

    Maps configuration information to a specific locale. You can use this parameter to specify a specific Lambda function to run different functions in different locales.

    • (string) --
      • (dict) --

        Specifies settings that are unique to a locale. For example, you can use different Lambda function depending on the bot's locale.

        • enabled (boolean) -- [REQUIRED]

          Determines whether the locale is enabled for the bot. If the value is false , the locale isn't available for use.

        • codeHookSpecification (dict) --

          Specifies the Lambda function that should be used in the locale.

          • lambdaCodeHook (dict) -- [REQUIRED]

            Specifies a Lambda function that verifies requests to a bot or fulfills the user's request to a bot.

            • lambdaARN (string) -- [REQUIRED]

              The Amazon Resource Name (ARN) of the Lambda function.

            • codeHookInterfaceVersion (string) -- [REQUIRED]

              The version of the request-response that you want Amazon Lex to use to invoke your Lambda function.

  • conversationLogSettings (dict) --

    Specifies whether Amazon Lex logs text and audio for a conversation with the bot. When you enable conversation logs, text logs store text input, transcripts of audio input, and associated metadata in Amazon CloudWatch Logs. Audio logs store audio input in Amazon S3.

    • textLogSettings (list) --

      The Amazon CloudWatch Logs settings for logging text and metadata.

      • (dict) --

        Defines settings to enable text conversation logs.

        • enabled (boolean) -- [REQUIRED]

          Determines whether conversation logs should be stored for an alias.

        • destination (dict) -- [REQUIRED]

          Defines the Amazon CloudWatch Logs destination log group for conversation text logs.

          • cloudWatch (dict) -- [REQUIRED]

            Defines the Amazon CloudWatch Logs log group where text and metadata logs are delivered.

            • cloudWatchLogGroupArn (string) -- [REQUIRED]

              The Amazon Resource Name (ARN) of the log group where text and metadata logs are delivered.

            • logPrefix (string) -- [REQUIRED]

              The prefix of the log stream name within the log group that you specified

    • audioLogSettings (list) --

      The Amazon S3 settings for logging audio to an S3 bucket.

      • (dict) --

        Settings for logging audio of conversations between Amazon Lex and a user. You specify whether to log audio and the Amazon S3 bucket where the audio file is stored.

        • enabled (boolean) -- [REQUIRED]

          Determines whether audio logging in enabled for the bot.

        • destination (dict) -- [REQUIRED]

          The location of audio log files collected when conversation logging is enabled for a bot.

          • s3Bucket (dict) -- [REQUIRED]

            The Amazon S3 bucket where the audio log files are stored. The IAM role specified in the roleArn parameter of the CreateBot operation must have permission to write to this bucket.

            • kmsKeyArn (string) --

              The Amazon Resource Name (ARN) of an AWS Key Management Service (KMS) key for encrypting audio log files stored in an S3 bucket.

            • s3BucketArn (string) -- [REQUIRED]

              The Amazon Resource Name (ARN) of an Amazon S3 bucket where audio log files are stored.

            • logPrefix (string) -- [REQUIRED]

              The S3 prefix to assign to audio log files.

  • sentimentAnalysisSettings (dict) --

    Determines whether Amazon Lex will use Amazon Comprehend to detect the sentiment of user utterances.

    • detectSentiment (boolean) -- [REQUIRED]

      Sets whether Amazon Lex uses Amazon Comprehend to detect the sentiment of user utterances.

  • botId (string) --

    [REQUIRED]

    The unique identifier of the bot that the alias applies to.

  • tags (dict) --

    A list of tags to add to the bot alias. You can only add tags when you create an alias, you can't use the UpdateBotAlias operation to update the tags on a bot alias. To update tags, use the TagResource operation.

    • (string) --
      • (string) --
Return type

dict

Returns

Response Syntax

{
    'botAliasId': 'string',
    'botAliasName': 'string',
    'description': 'string',
    'botVersion': 'string',
    'botAliasLocaleSettings': {
        'string': {
            'enabled': True|False,
            'codeHookSpecification': {
                'lambdaCodeHook': {
                    'lambdaARN': 'string',
                    'codeHookInterfaceVersion': 'string'
                }
            }
        }
    },
    'conversationLogSettings': {
        'textLogSettings': [
            {
                'enabled': True|False,
                'destination': {
                    'cloudWatch': {
                        'cloudWatchLogGroupArn': 'string',
                        'logPrefix': 'string'
                    }
                }
            },
        ],
        'audioLogSettings': [
            {
                'enabled': True|False,
                'destination': {
                    's3Bucket': {
                        'kmsKeyArn': 'string',
                        's3BucketArn': 'string',
                        'logPrefix': 'string'
                    }
                }
            },
        ]
    },
    'sentimentAnalysisSettings': {
        'detectSentiment': True|False
    },
    'botAliasStatus': 'Creating'|'Available'|'Deleting'|'Failed',
    'botId': 'string',
    'creationDateTime': datetime(2015, 1, 1),
    'tags': {
        'string': 'string'
    }
}

Response Structure

  • (dict) --

    • botAliasId (string) --

      The unique identifier of the bot alias.

    • botAliasName (string) --

      The name specified for the bot alias.

    • description (string) --

      The description specified for the bot alias.

    • botVersion (string) --

      The version of the bot associated with this alias.

    • botAliasLocaleSettings (dict) --

      Configuration information for a specific locale.

      • (string) --

        • (dict) --

          Specifies settings that are unique to a locale. For example, you can use different Lambda function depending on the bot's locale.

          • enabled (boolean) --

            Determines whether the locale is enabled for the bot. If the value is false , the locale isn't available for use.

          • codeHookSpecification (dict) --

            Specifies the Lambda function that should be used in the locale.

            • lambdaCodeHook (dict) --

              Specifies a Lambda function that verifies requests to a bot or fulfills the user's request to a bot.

              • lambdaARN (string) --

                The Amazon Resource Name (ARN) of the Lambda function.

              • codeHookInterfaceVersion (string) --

                The version of the request-response that you want Amazon Lex to use to invoke your Lambda function.

    • conversationLogSettings (dict) --

      The conversation log settings specified for the alias.

      • textLogSettings (list) --

        The Amazon CloudWatch Logs settings for logging text and metadata.

        • (dict) --

          Defines settings to enable text conversation logs.

          • enabled (boolean) --

            Determines whether conversation logs should be stored for an alias.

          • destination (dict) --

            Defines the Amazon CloudWatch Logs destination log group for conversation text logs.

            • cloudWatch (dict) --

              Defines the Amazon CloudWatch Logs log group where text and metadata logs are delivered.

              • cloudWatchLogGroupArn (string) --

                The Amazon Resource Name (ARN) of the log group where text and metadata logs are delivered.

              • logPrefix (string) --

                The prefix of the log stream name within the log group that you specified

      • audioLogSettings (list) --

        The Amazon S3 settings for logging audio to an S3 bucket.

        • (dict) --

          Settings for logging audio of conversations between Amazon Lex and a user. You specify whether to log audio and the Amazon S3 bucket where the audio file is stored.

          • enabled (boolean) --

            Determines whether audio logging in enabled for the bot.

          • destination (dict) --

            The location of audio log files collected when conversation logging is enabled for a bot.

            • s3Bucket (dict) --

              The Amazon S3 bucket where the audio log files are stored. The IAM role specified in the roleArn parameter of the CreateBot operation must have permission to write to this bucket.

              • kmsKeyArn (string) --

                The Amazon Resource Name (ARN) of an AWS Key Management Service (KMS) key for encrypting audio log files stored in an S3 bucket.

              • s3BucketArn (string) --

                The Amazon Resource Name (ARN) of an Amazon S3 bucket where audio log files are stored.

              • logPrefix (string) --

                The S3 prefix to assign to audio log files.

    • sentimentAnalysisSettings (dict) --

      Determines whether Amazon Lex will use Amazon Comprehend to detect the sentiment of user utterances.

      • detectSentiment (boolean) --

        Sets whether Amazon Lex uses Amazon Comprehend to detect the sentiment of user utterances.

    • botAliasStatus (string) --

      The current status of the alias. The alias is first put into the Creating state. When the alias is ready to be used, it is put into the Available state. You can use the DescribeBotAlias operation to get the current state of an alias.

    • botId (string) --

      The unique identifier of the bot that this alias applies to.

    • creationDateTime (datetime) --

      A Unix timestamp indicating the date and time that the bot alias was created.

    • tags (dict) --

      A list of tags associated with the bot alias.

      • (string) --
        • (string) --

Exceptions

create_bot_locale(**kwargs)

Creates a locale in the bot. The locale contains the intents and slot types that the bot uses in conversations with users in the specified language and locale. You must add a locale to a bot before you can add intents and slot types to the bot.

See also: AWS API Documentation

Request Syntax

response = client.create_bot_locale(
    botId='string',
    botVersion='string',
    localeId='string',
    description='string',
    nluIntentConfidenceThreshold=123.0,
    voiceSettings={
        'voiceId': 'string',
        'engine': 'standard'|'neural'
    }
)
Parameters
  • botId (string) --

    [REQUIRED]

    The identifier of the bot to create the locale for.

  • botVersion (string) --

    [REQUIRED]

    The version of the bot to create the locale for. This can only be the draft version of the bot.

  • localeId (string) --

    [REQUIRED]

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

  • description (string) -- A description of the bot locale. Use this to help identify the bot locale in lists.
  • nluIntentConfidenceThreshold (float) --

    [REQUIRED]

    Determines the threshold where Amazon Lex will insert the AMAZON.FallbackIntent , AMAZON.KendraSearchIntent , or both when returning alternative intents. AMAZON.FallbackIntent and AMAZON.KendraSearchIntent are only inserted if they are configured for the bot.

    For example, suppose a bot is configured with the confidence threshold of 0.80 and the AMAZON.FallbackIntent . Amazon Lex returns three alternative intents with the following confidence scores: IntentA (0.70), IntentB (0.60), IntentC (0.50). The response from the RecognizeText operation would be:

    • AMAZON.FallbackIntent
    • IntentA
    • IntentB
    • IntentC
  • voiceSettings (dict) --

    The Amazon Polly voice ID that Amazon Lex uses for voice interaction with the user.

Return type

dict

Returns

Response Syntax

{
    'botId': 'string',
    'botVersion': 'string',
    'localeName': 'string',
    'localeId': 'string',
    'description': 'string',
    'nluIntentConfidenceThreshold': 123.0,
    'voiceSettings': {
        'voiceId': 'string',
        'engine': 'standard'|'neural'
    },
    'botLocaleStatus': 'Creating'|'Building'|'Built'|'ReadyExpressTesting'|'Failed'|'Deleting'|'NotBuilt'|'Importing'|'Processing',
    'creationDateTime': datetime(2015, 1, 1)
}

Response Structure

  • (dict) --

    • botId (string) --

      The specified bot identifier.

    • botVersion (string) --

      The specified bot version.

    • localeName (string) --

      The specified locale name.

    • localeId (string) --

      The specified locale identifier.

    • description (string) --

      The specified description of the bot locale.

    • nluIntentConfidenceThreshold (float) --

      The specified confidence threshold for inserting the AMAZON.FallbackIntent and AMAZON.KendraSearchIntent intents.

    • voiceSettings (dict) --

      The Amazon Polly voice ID that Amazon Lex uses for voice interaction with the user.

    • botLocaleStatus (string) --

      The status of the bot.

      When the status is Creating the bot locale is being configured. When the status is Building Amazon Lex is building the bot for testing and use.

      If the status of the bot is ReadyExpressTesting , you can test the bot using the exact utterances specified in the bots' intents. When the bot is ready for full testing or to run, the status is Built .

      If there was a problem with building the bot, the status is Failed . If the bot was saved but not built, the status is NotBuilt .

    • creationDateTime (datetime) --

      A timestamp specifying the date and time that the bot locale was created.

Exceptions

create_bot_version(**kwargs)

Creates a new version of the bot based on the DRAFT version. If the DRAFT version of this resource hasn't changed since you created the last version, Amazon Lex doesn't create a new version, it returns the last created version.

When you create the first version of a bot, Amazon Lex sets the version to 1. Subsequent versions increment by 1.

See also: AWS API Documentation

Request Syntax

response = client.create_bot_version(
    botId='string',
    description='string',
    botVersionLocaleSpecification={
        'string': {
            'sourceBotVersion': 'string'
        }
    }
)
Parameters
  • botId (string) --

    [REQUIRED]

    The identifier of the bot to create the version for.

  • description (string) -- A description of the version. Use the description to help identify the version in lists.
  • botVersionLocaleSpecification (dict) --

    [REQUIRED]

    Specifies the locales that Amazon Lex adds to this version. You can choose the Draft version or any other previously published version for each locale. When you specify a source version, the locale data is copied from the source version to the new version.

    • (string) --
      • (dict) --

        The version of a bot used for a bot locale.

        • sourceBotVersion (string) -- [REQUIRED]

          The version of a bot used for a bot locale.

Return type

dict

Returns

Response Syntax

{
    'botId': 'string',
    'description': 'string',
    'botVersion': 'string',
    'botVersionLocaleSpecification': {
        'string': {
            'sourceBotVersion': 'string'
        }
    },
    'botStatus': 'Creating'|'Available'|'Inactive'|'Deleting'|'Failed'|'Versioning'|'Importing',
    'creationDateTime': datetime(2015, 1, 1)
}

Response Structure

  • (dict) --

    • botId (string) --

      The bot identifier specified in the request.

    • description (string) --

      The description of the version specified in the request.

    • botVersion (string) --

      The version number assigned to the version.

    • botVersionLocaleSpecification (dict) --

      The source versions used for each locale in the new version.

      • (string) --

        • (dict) --

          The version of a bot used for a bot locale.

          • sourceBotVersion (string) --

            The version of a bot used for a bot locale.

    • botStatus (string) --

      When you send a request to create or update a bot, Amazon Lex sets the status response element to Creating . After Amazon Lex builds the bot, it sets status to Available . If Amazon Lex can't build the bot, it sets status to Failed .

    • creationDateTime (datetime) --

      A timestamp of the date and time that the version was created.

Exceptions

create_export(**kwargs)

Creates a zip archive containing the contents of a bot or a bot locale. The archive contains a directory structure that contains JSON files that define the bot.

You can create an archive that contains the complete definition of a bot, or you can specify that the archive contain only the definition of a single bot locale.

For more information about exporting bots, and about the structure of the export archive, see Importing and exporting bots

See also: AWS API Documentation

Request Syntax

response = client.create_export(
    resourceSpecification={
        'botExportSpecification': {
            'botId': 'string',
            'botVersion': 'string'
        },
        'botLocaleExportSpecification': {
            'botId': 'string',
            'botVersion': 'string',
            'localeId': 'string'
        },
        'customVocabularyExportSpecification': {
            'botId': 'string',
            'botVersion': 'string',
            'localeId': 'string'
        }
    },
    fileFormat='LexJson'|'TSV',
    filePassword='string'
)
Parameters
  • resourceSpecification (dict) --

    [REQUIRED]

    Specifies the type of resource to export, either a bot or a bot locale. You can only specify one type of resource to export.

    • botExportSpecification (dict) --

      Parameters for exporting a bot.

      • botId (string) -- [REQUIRED]

        The identifier of the bot assigned by Amazon Lex.

      • botVersion (string) -- [REQUIRED]

        The version of the bot that was exported. This will be either DRAFT or the version number.

    • botLocaleExportSpecification (dict) --

      Parameters for exporting a bot locale.

      • botId (string) -- [REQUIRED]

        The identifier of the bot to create the locale for.

      • botVersion (string) -- [REQUIRED]

        The version of the bot to export.

      • localeId (string) -- [REQUIRED]

        The identifier of the language and locale to export. The string must match one of the locales in the bot.

    • customVocabularyExportSpecification (dict) --

      The parameters required to export a custom vocabulary.

      • botId (string) -- [REQUIRED]

        The identifier of the bot that contains the custom vocabulary to export.

      • botVersion (string) -- [REQUIRED]

        The version of the bot that contains the custom vocabulary to export.

      • localeId (string) -- [REQUIRED]

        The locale of the bot that contains the custom vocabulary to export.

  • fileFormat (string) --

    [REQUIRED]

    The file format of the bot or bot locale definition files.

  • filePassword (string) -- An password to use to encrypt the exported archive. Using a password is optional, but you should encrypt the archive to protect the data in transit between Amazon Lex and your local computer.
Return type

dict

Returns

Response Syntax

{
    'exportId': 'string',
    'resourceSpecification': {
        'botExportSpecification': {
            'botId': 'string',
            'botVersion': 'string'
        },
        'botLocaleExportSpecification': {
            'botId': 'string',
            'botVersion': 'string',
            'localeId': 'string'
        },
        'customVocabularyExportSpecification': {
            'botId': 'string',
            'botVersion': 'string',
            'localeId': 'string'
        }
    },
    'fileFormat': 'LexJson'|'TSV',
    'exportStatus': 'InProgress'|'Completed'|'Failed'|'Deleting',
    'creationDateTime': datetime(2015, 1, 1)
}

Response Structure

  • (dict) --

    • exportId (string) --

      An identifier for a specific request to create an export.

    • resourceSpecification (dict) --

      A description of the type of resource that was exported, either a bot or a bot locale.

      • botExportSpecification (dict) --

        Parameters for exporting a bot.

        • botId (string) --

          The identifier of the bot assigned by Amazon Lex.

        • botVersion (string) --

          The version of the bot that was exported. This will be either DRAFT or the version number.

      • botLocaleExportSpecification (dict) --

        Parameters for exporting a bot locale.

        • botId (string) --

          The identifier of the bot to create the locale for.

        • botVersion (string) --

          The version of the bot to export.

        • localeId (string) --

          The identifier of the language and locale to export. The string must match one of the locales in the bot.

      • customVocabularyExportSpecification (dict) --

        The parameters required to export a custom vocabulary.

        • botId (string) --

          The identifier of the bot that contains the custom vocabulary to export.

        • botVersion (string) --

          The version of the bot that contains the custom vocabulary to export.

        • localeId (string) --

          The locale of the bot that contains the custom vocabulary to export.

    • fileFormat (string) --

      The file format used for the bot or bot locale definition files.

    • exportStatus (string) --

      The status of the export. When the status is Completed , you can use the DescribeExport operation to get the pre-signed S3 URL link to your exported bot or bot locale.

    • creationDateTime (datetime) --

      The date and time that the request to export a bot was created.

Exceptions

create_intent(**kwargs)

Creates an intent.

To define the interaction between the user and your bot, you define one or more intents. For example, for a pizza ordering bot you would create an OrderPizza intent.

When you create an intent, you must provide a name. You can optionally provide the following:

  • Sample utterances. For example, "I want to order a pizza" and "Can I order a pizza." You can't provide utterances for built-in intents.
  • Information to be gathered. You specify slots for the information that you bot requests from the user. You can specify standard slot types, such as date and time, or custom slot types for your application.
  • How the intent is fulfilled. You can provide a Lambda function or configure the intent to return the intent information to your client application. If you use a Lambda function, Amazon Lex invokes the function when all of the intent information is available.
  • A confirmation prompt to send to the user to confirm an intent. For example, "Shall I order your pizza?"
  • A conclusion statement to send to the user after the intent is fulfilled. For example, "I ordered your pizza."
  • A follow-up prompt that asks the user for additional activity. For example, "Do you want a drink with your pizza?"

See also: AWS API Documentation

Request Syntax

response = client.create_intent(
    intentName='string',
    description='string',
    parentIntentSignature='string',
    sampleUtterances=[
        {
            'utterance': 'string'
        },
    ],
    dialogCodeHook={
        'enabled': True|False
    },
    fulfillmentCodeHook={
        'enabled': True|False,
        'postFulfillmentStatusSpecification': {
            '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
            },
            '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
            },
            '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
            },
            '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
                    }
                }
            },
            '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
                    }
                }
            },
            '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
                    }
                }
            }
        },
        'fulfillmentUpdatesSpecification': {
            'active': True|False,
            'startResponse': {
                'delayInSeconds': 123,
                '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
            },
            'updateResponse': {
                'frequencyInSeconds': 123,
                '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
            },
            'timeoutInSeconds': 123
        },
        'active': True|False
    },
    intentConfirmationSetting={
        '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'
        },
        'declinationResponse': {
            '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
        },
        'active': True|False,
        'confirmationResponse': {
            '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
        },
        'confirmationNextStep': {
            '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'
            }
        },
        'confirmationConditional': {
            '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
                }
            }
        },
        'declinationNextStep': {
            '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'
            }
        },
        'declinationConditional': {
            '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'
        }
    },
    intentClosingSetting={
        'closingResponse': {
            '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
        },
        'active': True|False,
        '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'
            }
        },
        'conditional': {
            '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
                }
            }
        }
    },
    inputContexts=[
        {
            'name': 'string'
        },
    ],
    outputContexts=[
        {
            'name': 'string',
            'timeToLiveInSeconds': 123,
            'turnsToLive': 123
        },
    ],
    kendraConfiguration={
        'kendraIndex': 'string',
        'queryFilterStringEnabled': True|False,
        'queryFilterString': 'string'
    },
    botId='string',
    botVersion='string',
    localeId='string',
    initialResponseSetting={
        'initialResponse': {
            '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
        },
        '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'
            }
        },
        'conditional': {
            '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
                        }
                    }
                }
            }
        }
    }
)
Parameters
  • intentName (string) --

    [REQUIRED]

    The name of the intent. Intent names must be unique in the locale that contains the intent and cannot match the name of any built-in intent.

  • description (string) -- A description of the intent. Use the description to help identify the intent in lists.
  • parentIntentSignature (string) -- A unique identifier for the built-in intent to base this intent on.
  • sampleUtterances (list) --

    An array of strings that a user might say to signal the intent. For example, "I want a pizza", or "I want a {PizzaSize} pizza".

    In an utterance, slot names are enclosed in curly braces ("{", "}") to indicate where they should be displayed in the utterance shown to the user..

    • (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.

  • dialogCodeHook (dict) --

    Specifies that Amazon Lex invokes the alias Lambda function for each user input. You can invoke this Lambda function to personalize user interaction.

    For example, suppose that your bot determines that the user's name is John. You Lambda function might retrieve John's information from a backend database and prepopulate some of the values. For example, if you find that John is gluten intolerant, you might set the corresponding intent slot, glutenIntolerant to true . You might find John's phone number and set the corresponding session attribute.

    • enabled (boolean) -- [REQUIRED]

      Enables the dialog code hook so that it processes user requests.

  • fulfillmentCodeHook (dict) --

    Specifies that Amazon Lex invokes the alias Lambda function when the intent is ready for fulfillment. You can invoke this function to complete the bot's transaction with the user.

    For example, in a pizza ordering bot, the Lambda function can look up the closest pizza restaurant to the customer's location and then place an order on the customer's behalf.

    • enabled (boolean) -- [REQUIRED]

      Indicates whether a Lambda function should be invoked to fulfill a specific intent.

    • postFulfillmentStatusSpecification (dict) --

      Provides settings for messages sent to the user for after the Lambda fulfillment function completes. Post-fulfillment messages can be sent for both streaming and non-streaming conversations.

      • 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.

      • 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.

      • 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.

      • successNextStep (dict) --

        Specifies the next step in the conversation that Amazon Lex invokes when the fulfillment code hook completes 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 fulfillment 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.

      • failureNextStep (dict) --

        Specifies the next step the bot runs after the fulfillment 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 fulfillment 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.

      • timeoutNextStep (dict) --

        Specifies the next step that the bot runs when the fulfillment 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 fulfillment 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.

    • fulfillmentUpdatesSpecification (dict) --

      Provides settings for update messages sent to the user for long-running Lambda fulfillment functions. Fulfillment updates can be used only with streaming conversations.

      • active (boolean) -- [REQUIRED]

        Determines whether fulfillment updates are sent to the user. When this field is true, updates are sent.

        If the active field is set to true, the startResponse , updateResponse , and timeoutInSeconds fields are required.

      • startResponse (dict) --

        Provides configuration information for the message sent to users when the fulfillment Lambda functions starts running.

        • delayInSeconds (integer) -- [REQUIRED]

          The delay between when the Lambda fulfillment function starts running and the start message is played. If the Lambda function returns before the delay is over, the start message isn't played.

        • messageGroups (list) -- [REQUIRED]

          One to 5 message groups that contain start messages. Amazon Lex chooses one of the messages to play 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.

        • allowInterrupt (boolean) --

          Determines whether the user can interrupt the start message while it is playing.

      • updateResponse (dict) --

        Provides configuration information for messages sent periodically to the user while the fulfillment Lambda function is running.

        • frequencyInSeconds (integer) -- [REQUIRED]

          The frequency that a message is sent to the user. When the period ends, Amazon Lex chooses a message from the message groups and plays it to the user. If the fulfillment Lambda returns before the first period ends, an update message is not played to the user.

        • messageGroups (list) -- [REQUIRED]

          One to 5 message groups that contain update messages. Amazon Lex chooses one of the messages to play 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.

        • allowInterrupt (boolean) --

          Determines whether the user can interrupt an update message while it is playing.

      • timeoutInSeconds (integer) --

        The length of time that the fulfillment Lambda function should run before it times out.

    • active (boolean) --

      Determines whether the fulfillment code hook is used. When active is false, the code hook doesn't run.

  • intentConfirmationSetting (dict) --

    Provides prompts that Amazon Lex sends to the user to confirm the completion of an intent. If the user answers "no," the settings contain a statement that is sent to the user to end the intent.

    • promptSpecification (dict) -- [REQUIRED]

      Prompts the user to confirm the intent. This question should have a yes or no answer.

      Amazon Lex uses this prompt to ensure that the user acknowledges that the intent is ready for fulfillment. For example, with the OrderPizza intent, you might want to confirm that the order is correct before placing it. For other intents, such as intents that simply respond to user questions, you might not need to ask the user for confirmation before providing the information.

      • 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.

    • declinationResponse (dict) --

      When the user answers "no" to the question defined in promptSpecification , Amazon Lex responds with this response to acknowledge that the intent was canceled.

      • 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.

    • active (boolean) --

      Specifies whether the intent's confirmation is sent to the user. When this field is false, confirmation and declination responses aren't sent. If the active field isn't specified, the default is true.

    • confirmationResponse (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.

    • confirmationNextStep (dict) --

      Specifies the next step that the bot executes when the customer confirms the intent.

      • 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) --
    • confirmationConditional (dict) --

      A list of conditional branches to evaluate after the intent is closed.

      • 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.

    • declinationNextStep (dict) --

      Specifies the next step that the bot executes when the customer declines the intent.

      • 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) --
    • declinationConditional (dict) --

      A list of conditional branches to evaluate after the intent is declined.

      • 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) --

      The next step to take in the conversation if the confirmation step fails.

      • 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) --

      Provides a list of conditional branches. Branches are evaluated in the order that they are entered in the list. The first branch with a condition that evaluates to true is executed. The last branch in the list is the default branch. The default branch should not have any condition expression. The default branch is executed if no other branch has a matching condition.

      • 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) --

      The DialogCodeHookInvocationSetting object associated with intent's confirmation step. The dialog code hook is triggered based on these invocation settings when the confirmation next step or declination next step or failure next step is InvokeDialogCodeHook .

      • 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) --

      The DialogCodeHookInvocationSetting used when the code hook is invoked during confirmation prompt retries.

      • 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.

  • intentClosingSetting (dict) --

    Sets the response that Amazon Lex sends to the user when the intent is closed.

    • closingResponse (dict) --

      The response that Amazon Lex sends to the user when the intent is complete.

      • 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.

    • active (boolean) --

      Specifies whether an intent's closing response is used. When this field is false, the closing response isn't sent to the user. If the active field isn't specified, the default is true.

    • nextStep (dict) --

      Specifies the next step that the bot executes after playing the intent's closing response.

      • 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) --
    • conditional (dict) --

      A list of conditional branches associated with the intent's closing response. These branches are executed when the nextStep attribute is set to EvalutateConditional .

      • 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.

  • inputContexts (list) --

    A list of contexts that must be active for this intent to be considered by Amazon Lex.

    When an intent has an input context list, Amazon Lex only considers using the intent in an interaction with the user when the specified contexts are included in the active context list for the session. If the contexts are not active, then Amazon Lex will not use the intent.

    A context can be automatically activated using the outputContexts property or it can be set at runtime.

    For example, if there are two intents with different input contexts that respond to the same utterances, only the intent with the active context will respond.

    An intent may have up to 5 input contexts. If an intent has multiple input contexts, all of the contexts must be active to consider the intent.

    • (dict) --

      The name of a context that must be active for an intent to be selected by Amazon Lex.

      • name (string) -- [REQUIRED]

        The name of the context.

  • outputContexts (list) --

    A lists of contexts that the intent activates when it is fulfilled.

    You can use an output context to indicate the intents that Amazon Lex should consider for the next turn of the conversation with a customer.

    When you use the outputContextsList property, all of the contexts specified in the list are activated when the intent is fulfilled. You can set up to 10 output contexts. You can also set the number of conversation turns that the context should be active, or the length of time that the context should be active.

    • (dict) --

      Describes a session context that is activated when an intent is fulfilled.

      • name (string) -- [REQUIRED]

        The name of the output context.

      • timeToLiveInSeconds (integer) -- [REQUIRED]

        The amount of time, in seconds, that the output context should remain active. The time is figured from the first time the context is sent to the user.

      • turnsToLive (integer) -- [REQUIRED]

        The number of conversation turns that the output context should remain active. The number of turns is counted from the first time that the context is sent to the user.

  • kendraConfiguration (dict) --

    Configuration information required to use the AMAZON.KendraSearchIntent intent to connect to an Amazon Kendra index. The AMAZON.KendraSearchIntent intent is called when Amazon Lex can't determine another intent to invoke.

    • kendraIndex (string) -- [REQUIRED]

      The Amazon Resource Name (ARN) of the Amazon Kendra index that you want the AMAZON.KendraSearchIntent intent to search. The index must be in the same account and Region as the Amazon Lex bot.

    • queryFilterStringEnabled (boolean) --

      Determines whether the AMAZON.KendraSearchIntent intent uses a custom query string to query the Amazon Kendra index.

    • queryFilterString (string) --

      A query filter that Amazon Lex sends to Amazon Kendra to filter the response from a query. The filter is in the format defined by Amazon Kendra. For more information, see Filtering queries .

  • botId (string) --

    [REQUIRED]

    The identifier of the bot associated with this intent.

  • botVersion (string) --

    [REQUIRED]

    The identifier of the version of the bot associated with this intent.

  • localeId (string) --

    [REQUIRED]

    The identifier of the language and locale where this intent is used. All of the bots, slot types, and slots used by the intent must have the same locale. For more information, see Supported languages .

  • initialResponseSetting (dict) --

    Configuration settings for the response that is sent to the user at the beginning of a conversation, before eliciting slot values.

    • initialResponse (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.

    • 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) --
    • conditional (dict) --

      Provides a list of conditional branches. Branches are evaluated in the order that they are entered in the list. The first branch with a condition that evaluates to true is executed. The last branch in the list is the default branch. The default branch should not have any condition expression. The default branch is executed if no other branch has a matching condition.

      • 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) --

      Settings that specify the dialog code hook that is called by Amazon Lex at a step of the conversation.

      • 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.

Return type

dict

Returns

Response Syntax

{
    'intentId': 'string',
    'intentName': 'string',
    'description': 'string',
    'parentIntentSignature': 'string',
    'sampleUtterances': [
        {
            'utterance': 'string'
        },
    ],
    'dialogCodeHook': {
        'enabled': True|False
    },
    'fulfillmentCodeHook': {
        'enabled': True|False,
        'postFulfillmentStatusSpecification': {
            '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
            },
            '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
            },
            '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
            },
            '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
                    }
                }
            },
            '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'