Amazon Lex conversational bot performing automated tasks such as ordering a pizza, booking a hotel, and so on.
data_privacy
(Attributes) Data privacy setting of the Bot. (see below for nested schema)idle_session_ttl_in_seconds
(Number) IdleSessionTTLInSeconds of the resourcename
(String) Unique name for a resource.role_arn
(String) The Amazon Resource Name (ARN) of an IAM role that has permission to access the bot.auto_build_bot_locales
(Boolean) Specifies whether to build the bot locales after bot creation completes.bot_file_s3_location
(Attributes) S3 location of bot definitions zip file, if it's not defined inline in CloudFormation. (see below for nested schema)bot_locales
(Attributes Set) List of bot locales (see below for nested schema)bot_tags
(Attributes Set) A list of tags to add to the bot, which can only be added at bot creation. (see below for nested schema)description
(String) A description of the resourcetest_bot_alias_settings
(Attributes) Configuring the test bot alias settings for a given bot (see below for nested schema)test_bot_alias_tags
(Attributes Set) A list of tags to add to the test alias for a bot, , which can only be added at bot/bot alias creation. (see below for nested schema)arn
(String)bot_id
(String) Unique ID of resourceid
(String) Uniquely identifies the resource.data_privacy
Required:
child_directed
(Boolean)bot_file_s3_location
Required:
s3_bucket
(String) An Amazon S3 bucket in the same AWS Region as your function. The bucket can be in a different AWS account.s3_object_key
(String) The Amazon S3 key of the deployment package.Optional:
s3_object_version
(String) For versioned objects, the version of the deployment package object to use. If not specified, the current object version will be used.bot_locales
Required:
locale_id
(String) The identifier of the language and locale that the bot will be used in.nlu_confidence_threshold
(Number) The specified confidence threshold for inserting the AMAZON.FallbackIntent and AMAZON.KendraSearchIntent intents.Optional:
custom_vocabulary
(Attributes) A custom vocabulary is a list of specific phrases that you want Amazon Lex V2 to recognize in the audio input. (see below for nested schema)description
(String) A description of the resourceintents
(Attributes Set) List of intents (see below for nested schema)slot_types
(Attributes Set) List of SlotTypes (see below for nested schema)voice_settings
(Attributes) Settings for using an Amazon Polly voice to communicate with a user. (see below for nested schema)bot_locales.custom_vocabulary
Required:
custom_vocabulary_items
(Attributes Set) (see below for nested schema)bot_locales.custom_vocabulary.custom_vocabulary_items
Required:
phrase
(String) Phrase that should be recognized.Optional:
weight
(Number) The degree to which the phrase recognition is boosted.bot_locales.intents
Required:
name
(String) Unique name for a resource.Optional:
description
(String) A description of the resourcedialog_code_hook
(Attributes) Settings that determine the Lambda function that Amazon Lex uses for processing user responses. (see below for nested schema)fulfillment_code_hook
(Attributes) Settings that determine if a Lambda function should be invoked to fulfill a specific intent. (see below for nested schema)input_contexts
(Attributes List) The list of input contexts specified for the intent. (see below for nested schema)intent_closing_setting
(Attributes) Response that Amazon Lex sends to the user when the intent is closed. (see below for nested schema)intent_confirmation_setting
(Attributes) Prompts that Amazon Lex sends to the user to confirm the completion of an intent. (see below for nested schema)kendra_configuration
(Attributes) Configuration for searching a Amazon Kendra index specified for the intent. (see below for nested schema)output_contexts
(Attributes List) A list of contexts that the intent activates when it is fulfilled. (see below for nested schema)parent_intent_signature
(String) A unique identifier for the built-in intent to base this intent on.sample_utterances
(Attributes List) An array of sample utterances (see below for nested schema)slot_priorities
(Attributes List) List for slot priorities (see below for nested schema)slots
(Attributes Set) List of slots (see below for nested schema)bot_locales.intents.dialog_code_hook
Required:
enabled
(Boolean)bot_locales.intents.fulfillment_code_hook
Required:
enabled
(Boolean)Optional:
fulfillment_updates_specification
(Attributes) Provides information for updating the user on the progress of fulfilling an intent. (see below for nested schema)post_fulfillment_status_specification
(Attributes) Provides information for updating the user on the progress of fulfilling an intent. (see below for nested schema)bot_locales.intents.fulfillment_code_hook.fulfillment_updates_specification
Required:
active
(Boolean) Determines whether fulfillment updates are sent to the user. When this field is true, updates are sent.Optional:
start_response
(Attributes) Provides settings for a message that is sent to the user when a fulfillment Lambda function starts running. (see below for nested schema)timeout_in_seconds
(Number) The length of time that the fulfillment Lambda function should run before it times out.update_response
(Attributes) Provides settings for a message that is sent periodically to the user while a fulfillment Lambda function is running. (see below for nested schema)bot_locales.intents.fulfillment_code_hook.post_fulfillment_status_specification.start_response
Required:
delay_in_seconds
(Number) 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.message_groups
(Attributes List) One to 5 message groups that contain update messages. Amazon Lex chooses one of the messages to play to the user. (see below for nested schema)Optional:
allow_interrupt
(Boolean) Determines whether the user can interrupt the start message while it is playing.bot_locales.intents.fulfillment_code_hook.post_fulfillment_status_specification.start_response.message_groups
Required:
message
(Attributes) The primary message that Amazon Lex should send to the user. (see below for nested schema)Optional:
variations
(Attributes List) Message variations to send to the user. (see below for nested schema)bot_locales.intents.fulfillment_code_hook.post_fulfillment_status_specification.start_response.allow_interrupt.message
Optional:
custom_payload
(Attributes) A message in a custom format defined by the client application. (see below for nested schema)image_response_card
(Attributes) A message that defines a response card that the client application can show to the user. (see below for nested schema)plain_text_message
(Attributes) A message in plain text format. (see below for nested schema)ssml_message
(Attributes) A message in Speech Synthesis Markup Language (SSML). (see below for nested schema)bot_locales.intents.fulfillment_code_hook.post_fulfillment_status_specification.start_response.allow_interrupt.variations.custom_payload
Required:
value
(String) The string that is sent to your application.bot_locales.intents.fulfillment_code_hook.post_fulfillment_status_specification.start_response.allow_interrupt.variations.image_response_card
Required:
title
(String) The title to display on the response card.Optional:
buttons
(Attributes List) A list of buttons that should be displayed on the response card. (see below for nested schema)image_url
(String) The URL of an image to display on the response card.subtitle
(String) The subtitle to display on the response card.bot_locales.intents.fulfillment_code_hook.post_fulfillment_status_specification.start_response.allow_interrupt.variations.ssml_message.buttons
Required:
text
(String) The text that appears on the button.value
(String) The value returned to Amazon Lex when the user chooses this button.bot_locales.intents.fulfillment_code_hook.post_fulfillment_status_specification.start_response.allow_interrupt.variations.plain_text_message
Required:
value
(String) The message to send to the user.bot_locales.intents.fulfillment_code_hook.post_fulfillment_status_specification.start_response.allow_interrupt.variations.ssml_message
Required:
value
(String) The SSML text that defines the prompt.bot_locales.intents.fulfillment_code_hook.post_fulfillment_status_specification.start_response.allow_interrupt.variations
Optional:
custom_payload
(Attributes) A message in a custom format defined by the client application. (see below for nested schema)image_response_card
(Attributes) A message that defines a response card that the client application can show to the user. (see below for nested schema)plain_text_message
(Attributes) A message in plain text format. (see below for nested schema)ssml_message
(Attributes) A message in Speech Synthesis Markup Language (SSML). (see below for nested schema)bot_locales.intents.fulfillment_code_hook.post_fulfillment_status_specification.start_response.allow_interrupt.variations.custom_payload
Required:
value
(String) The string that is sent to your application.bot_locales.intents.fulfillment_code_hook.post_fulfillment_status_specification.start_response.allow_interrupt.variations.image_response_card
Required:
title
(String) The title to display on the response card.Optional:
buttons
(Attributes List) A list of buttons that should be displayed on the response card. (see below for nested schema)image_url
(String) The URL of an image to display on the response card.subtitle
(String) The subtitle to display on the response card.bot_locales.intents.fulfillment_code_hook.post_fulfillment_status_specification.start_response.allow_interrupt.variations.ssml_message.buttons
Required:
text
(String) The text that appears on the button.value
(String) The value returned to Amazon Lex when the user chooses this button.bot_locales.intents.fulfillment_code_hook.post_fulfillment_status_specification.start_response.allow_interrupt.variations.plain_text_message
Required:
value
(String) The message to send to the user.bot_locales.intents.fulfillment_code_hook.post_fulfillment_status_specification.start_response.allow_interrupt.variations.ssml_message
Required:
value
(String) The SSML text that defines the prompt.bot_locales.intents.fulfillment_code_hook.post_fulfillment_status_specification.update_response
Required:
frequency_in_seconds
(Number) 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.message_groups
(Attributes List) One to 5 message groups that contain update messages. Amazon Lex chooses one of the messages to play to the user. (see below for nested schema)Optional:
allow_interrupt
(Boolean) Determines whether the user can interrupt an update message while it is playing.bot_locales.intents.fulfillment_code_hook.post_fulfillment_status_specification.update_response.message_groups
Required:
message
(Attributes) The primary message that Amazon Lex should send to the user. (see below for nested schema)Optional:
variations
(Attributes List) Message variations to send to the user. (see below for nested schema)bot_locales.intents.fulfillment_code_hook.post_fulfillment_status_specification.update_response.allow_interrupt.message
Optional:
custom_payload
(Attributes) A message in a custom format defined by the client application. (see below for nested schema)image_response_card
(Attributes) A message that defines a response card that the client application can show to the user. (see below for nested schema)plain_text_message
(Attributes) A message in plain text format. (see below for nested schema)ssml_message
(Attributes) A message in Speech Synthesis Markup Language (SSML). (see below for nested schema)bot_locales.intents.fulfillment_code_hook.post_fulfillment_status_specification.update_response.allow_interrupt.variations.custom_payload
Required:
value
(String) The string that is sent to your application.bot_locales.intents.fulfillment_code_hook.post_fulfillment_status_specification.update_response.allow_interrupt.variations.image_response_card
Required:
title
(String) The title to display on the response card.Optional:
buttons
(Attributes List) A list of buttons that should be displayed on the response card. (see below for nested schema)image_url
(String) The URL of an image to display on the response card.subtitle
(String) The subtitle to display on the response card.bot_locales.intents.fulfillment_code_hook.post_fulfillment_status_specification.update_response.allow_interrupt.variations.ssml_message.buttons
Required:
text
(String) The text that appears on the button.value
(String) The value returned to Amazon Lex when the user chooses this button.bot_locales.intents.fulfillment_code_hook.post_fulfillment_status_specification.update_response.allow_interrupt.variations.plain_text_message
Required:
value
(String) The message to send to the user.bot_locales.intents.fulfillment_code_hook.post_fulfillment_status_specification.update_response.allow_interrupt.variations.ssml_message
Required:
value
(String) The SSML text that defines the prompt.bot_locales.intents.fulfillment_code_hook.post_fulfillment_status_specification.update_response.allow_interrupt.variations
Optional:
custom_payload
(Attributes) A message in a custom format defined by the client application. (see below for nested schema)image_response_card
(Attributes) A message that defines a response card that the client application can show to the user. (see below for nested schema)plain_text_message
(Attributes) A message in plain text format. (see below for nested schema)ssml_message
(Attributes) A message in Speech Synthesis Markup Language (SSML). (see below for nested schema)bot_locales.intents.fulfillment_code_hook.post_fulfillment_status_specification.update_response.allow_interrupt.variations.custom_payload
Required:
value
(String) The string that is sent to your application.bot_locales.intents.fulfillment_code_hook.post_fulfillment_status_specification.update_response.allow_interrupt.variations.image_response_card
Required:
title
(String) The title to display on the response card.Optional:
buttons
(Attributes List) A list of buttons that should be displayed on the response card. (see below for nested schema)image_url
(String) The URL of an image to display on the response card.subtitle
(String) The subtitle to display on the response card.bot_locales.intents.fulfillment_code_hook.post_fulfillment_status_specification.update_response.allow_interrupt.variations.ssml_message.buttons
Required:
text
(String) The text that appears on the button.value
(String) The value returned to Amazon Lex when the user chooses this button.bot_locales.intents.fulfillment_code_hook.post_fulfillment_status_specification.update_response.allow_interrupt.variations.plain_text_message
Required:
value
(String) The message to send to the user.bot_locales.intents.fulfillment_code_hook.post_fulfillment_status_specification.update_response.allow_interrupt.variations.ssml_message
Required:
value
(String) The SSML text that defines the prompt.bot_locales.intents.fulfillment_code_hook.post_fulfillment_status_specification
Optional:
failure_response
(Attributes) A list of message groups that Amazon Lex uses to respond the user input. (see below for nested schema)success_response
(Attributes) A list of message groups that Amazon Lex uses to respond the user input. (see below for nested schema)timeout_response
(Attributes) A list of message groups that Amazon Lex uses to respond the user input. (see below for nested schema)bot_locales.intents.fulfillment_code_hook.post_fulfillment_status_specification.failure_response
Required:
message_groups_list
(Attributes List) One to 5 message groups that contain update messages. Amazon Lex chooses one of the messages to play to the user. (see below for nested schema)Optional:
allow_interrupt
(Boolean) Indicates whether the user can interrupt a speech prompt from the bot.bot_locales.intents.fulfillment_code_hook.post_fulfillment_status_specification.failure_response.message_groups_list
Required:
message
(Attributes) The primary message that Amazon Lex should send to the user. (see below for nested schema)Optional:
variations
(Attributes List) Message variations to send to the user. (see below for nested schema)bot_locales.intents.fulfillment_code_hook.post_fulfillment_status_specification.failure_response.allow_interrupt.message
Optional:
custom_payload
(Attributes) A message in a custom format defined by the client application. (see below for nested schema)image_response_card
(Attributes) A message that defines a response card that the client application can show to the user. (see below for nested schema)plain_text_message
(Attributes) A message in plain text format. (see below for nested schema)ssml_message
(Attributes) A message in Speech Synthesis Markup Language (SSML). (see below for nested schema)bot_locales.intents.fulfillment_code_hook.post_fulfillment_status_specification.failure_response.allow_interrupt.variations.custom_payload
Required:
value
(String) The string that is sent to your application.bot_locales.intents.fulfillment_code_hook.post_fulfillment_status_specification.failure_response.allow_interrupt.variations.image_response_card
Required:
title
(String) The title to display on the response card.Optional:
buttons
(Attributes List) A list of buttons that should be displayed on the response card. (see below for nested schema)image_url
(String) The URL of an image to display on the response card.subtitle
(String) The subtitle to display on the response card.bot_locales.intents.fulfillment_code_hook.post_fulfillment_status_specification.failure_response.allow_interrupt.variations.ssml_message.buttons
Required:
text
(String) The text that appears on the button.value
(String) The value returned to Amazon Lex when the user chooses this button.bot_locales.intents.fulfillment_code_hook.post_fulfillment_status_specification.failure_response.allow_interrupt.variations.plain_text_message
Required:
value
(String) The message to send to the user.bot_locales.intents.fulfillment_code_hook.post_fulfillment_status_specification.failure_response.allow_interrupt.variations.ssml_message
Required:
value
(String) The SSML text that defines the prompt.bot_locales.intents.fulfillment_code_hook.post_fulfillment_status_specification.failure_response.allow_interrupt.variations
Optional:
custom_payload
(Attributes) A message in a custom format defined by the client application. (see below for nested schema)image_response_card
(Attributes) A message that defines a response card that the client application can show to the user. (see below for nested schema)plain_text_message
(Attributes) A message in plain text format. (see below for nested schema)ssml_message
(Attributes) A message in Speech Synthesis Markup Language (SSML). (see below for nested schema)bot_locales.intents.fulfillment_code_hook.post_fulfillment_status_specification.failure_response.allow_interrupt.variations.custom_payload
Required:
value
(String) The string that is sent to your application.bot_locales.intents.fulfillment_code_hook.post_fulfillment_status_specification.failure_response.allow_interrupt.variations.image_response_card
Required:
title
(String) The title to display on the response card.Optional:
buttons
(Attributes List) A list of buttons that should be displayed on the response card. (see below for nested schema)image_url
(String) The URL of an image to display on the response card.subtitle
(String) The subtitle to display on the response card.bot_locales.intents.fulfillment_code_hook.post_fulfillment_status_specification.failure_response.allow_interrupt.variations.ssml_message.buttons
Required:
text
(String) The text that appears on the button.value
(String) The value returned to Amazon Lex when the user chooses this button.bot_locales.intents.fulfillment_code_hook.post_fulfillment_status_specification.failure_response.allow_interrupt.variations.plain_text_message
Required:
value
(String) The message to send to the user.bot_locales.intents.fulfillment_code_hook.post_fulfillment_status_specification.failure_response.allow_interrupt.variations.ssml_message
Required:
value
(String) The SSML text that defines the prompt.bot_locales.intents.fulfillment_code_hook.post_fulfillment_status_specification.success_response
Required:
message_groups_list
(Attributes List) One to 5 message groups that contain update messages. Amazon Lex chooses one of the messages to play to the user. (see below for nested schema)Optional:
allow_interrupt
(Boolean) Indicates whether the user can interrupt a speech prompt from the bot.bot_locales.intents.fulfillment_code_hook.post_fulfillment_status_specification.success_response.message_groups_list
Required:
message
(Attributes) The primary message that Amazon Lex should send to the user. (see below for nested schema)Optional:
variations
(Attributes List) Message variations to send to the user. (see below for nested schema)bot_locales.intents.fulfillment_code_hook.post_fulfillment_status_specification.success_response.allow_interrupt.message
Optional:
custom_payload
(Attributes) A message in a custom format defined by the client application. (see below for nested schema)image_response_card
(Attributes) A message that defines a response card that the client application can show to the user. (see below for nested schema)plain_text_message
(Attributes) A message in plain text format. (see below for nested schema)ssml_message
(Attributes) A message in Speech Synthesis Markup Language (SSML). (see below for nested schema)bot_locales.intents.fulfillment_code_hook.post_fulfillment_status_specification.success_response.allow_interrupt.variations.custom_payload
Required:
value
(String) The string that is sent to your application.bot_locales.intents.fulfillment_code_hook.post_fulfillment_status_specification.success_response.allow_interrupt.variations.image_response_card
Required:
title
(String) The title to display on the response card.Optional:
buttons
(Attributes List) A list of buttons that should be displayed on the response card. (see below for nested schema)image_url
(String) The URL of an image to display on the response card.subtitle
(String) The subtitle to display on the response card.bot_locales.intents.fulfillment_code_hook.post_fulfillment_status_specification.success_response.allow_interrupt.variations.ssml_message.buttons
Required:
text
(String) The text that appears on the button.value
(String) The value returned to Amazon Lex when the user chooses this button.bot_locales.intents.fulfillment_code_hook.post_fulfillment_status_specification.success_response.allow_interrupt.variations.plain_text_message
Required:
value
(String) The message to send to the user.bot_locales.intents.fulfillment_code_hook.post_fulfillment_status_specification.success_response.allow_interrupt.variations.ssml_message
Required:
value
(String) The SSML text that defines the prompt.bot_locales.intents.fulfillment_code_hook.post_fulfillment_status_specification.success_response.allow_interrupt.variations
Optional:
custom_payload
(Attributes) A message in a custom format defined by the client application. (see below for nested schema)image_response_card
(Attributes) A message that defines a response card that the client application can show to the user. (see below for nested schema)plain_text_message
(Attributes) A message in plain text format. (see below for nested schema)ssml_message
(Attributes) A message in Speech Synthesis Markup Language (SSML). (see below for nested schema)bot_locales.intents.fulfillment_code_hook.post_fulfillment_status_specification.success_response.allow_interrupt.variations.custom_payload
Required:
value
(String) The string that is sent to your application.bot_locales.intents.fulfillment_code_hook.post_fulfillment_status_specification.success_response.allow_interrupt.variations.image_response_card
Required:
title
(String) The title to display on the response card.Optional:
buttons
(Attributes List) A list of buttons that should be displayed on the response card. (see below for nested schema)image_url
(String) The URL of an image to display on the response card.subtitle
(String) The subtitle to display on the response card.bot_locales.intents.fulfillment_code_hook.post_fulfillment_status_specification.success_response.allow_interrupt.variations.ssml_message.buttons
Required:
text
(String) The text that appears on the button.value
(String) The value returned to Amazon Lex when the user chooses this button.bot_locales.intents.fulfillment_code_hook.post_fulfillment_status_specification.success_response.allow_interrupt.variations.plain_text_message
Required:
value
(String) The message to send to the user.bot_locales.intents.fulfillment_code_hook.post_fulfillment_status_specification.success_response.allow_interrupt.variations.ssml_message
Required:
value
(String) The SSML text that defines the prompt.bot_locales.intents.fulfillment_code_hook.post_fulfillment_status_specification.timeout_response
Required:
message_groups_list
(Attributes List) One to 5 message groups that contain update messages. Amazon Lex chooses one of the messages to play to the user. (see below for nested schema)Optional:
allow_interrupt
(Boolean) Indicates whether the user can interrupt a speech prompt from the bot.bot_locales.intents.fulfillment_code_hook.post_fulfillment_status_specification.timeout_response.message_groups_list
Required:
message
(Attributes) The primary message that Amazon Lex should send to the user. (see below for nested schema)Optional:
variations
(Attributes List) Message variations to send to the user. (see below for nested schema)bot_locales.intents.fulfillment_code_hook.post_fulfillment_status_specification.timeout_response.allow_interrupt.message
Optional:
custom_payload
(Attributes) A message in a custom format defined by the client application. (see below for nested schema)image_response_card
(Attributes) A message that defines a response card that the client application can show to the user. (see below for nested schema)plain_text_message
(Attributes) A message in plain text format. (see below for nested schema)ssml_message
(Attributes) A message in Speech Synthesis Markup Language (SSML). (see below for nested schema)bot_locales.intents.fulfillment_code_hook.post_fulfillment_status_specification.timeout_response.allow_interrupt.variations.custom_payload
Required:
value
(String) The string that is sent to your application.bot_locales.intents.fulfillment_code_hook.post_fulfillment_status_specification.timeout_response.allow_interrupt.variations.image_response_card
Required:
title
(String) The title to display on the response card.Optional:
buttons
(Attributes List) A list of buttons that should be displayed on the response card. (see below for nested schema)image_url
(String) The URL of an image to display on the response card.subtitle
(String) The subtitle to display on the response card.bot_locales.intents.fulfillment_code_hook.post_fulfillment_status_specification.timeout_response.allow_interrupt.variations.ssml_message.buttons
Required:
text
(String) The text that appears on the button.value
(String) The value returned to Amazon Lex when the user chooses this button.bot_locales.intents.fulfillment_code_hook.post_fulfillment_status_specification.timeout_response.allow_interrupt.variations.plain_text_message
Required:
value
(String) The message to send to the user.bot_locales.intents.fulfillment_code_hook.post_fulfillment_status_specification.timeout_response.allow_interrupt.variations.ssml_message
Required:
value
(String) The SSML text that defines the prompt.bot_locales.intents.fulfillment_code_hook.post_fulfillment_status_specification.timeout_response.allow_interrupt.variations
Optional:
custom_payload
(Attributes) A message in a custom format defined by the client application. (see below for nested schema)image_response_card
(Attributes) A message that defines a response card that the client application can show to the user. (see below for nested schema)plain_text_message
(Attributes) A message in plain text format. (see below for nested schema)ssml_message
(Attributes) A message in Speech Synthesis Markup Language (SSML). (see below for nested schema)bot_locales.intents.fulfillment_code_hook.post_fulfillment_status_specification.timeout_response.allow_interrupt.variations.custom_payload
Required:
value
(String) The string that is sent to your application.bot_locales.intents.fulfillment_code_hook.post_fulfillment_status_specification.timeout_response.allow_interrupt.variations.image_response_card
Required:
title
(String) The title to display on the response card.Optional:
buttons
(Attributes List) A list of buttons that should be displayed on the response card. (see below for nested schema)image_url
(String) The URL of an image to display on the response card.subtitle
(String) The subtitle to display on the response card.bot_locales.intents.fulfillment_code_hook.post_fulfillment_status_specification.timeout_response.allow_interrupt.variations.ssml_message.buttons
Required:
text
(String) The text that appears on the button.value
(String) The value returned to Amazon Lex when the user chooses this button.bot_locales.intents.fulfillment_code_hook.post_fulfillment_status_specification.timeout_response.allow_interrupt.variations.plain_text_message
Required:
value
(String) The message to send to the user.bot_locales.intents.fulfillment_code_hook.post_fulfillment_status_specification.timeout_response.allow_interrupt.variations.ssml_message
Required:
value
(String) The SSML text that defines the prompt.bot_locales.intents.input_contexts
Required:
name
(String) The name of the context.bot_locales.intents.intent_closing_setting
Required:
closing_response
(Attributes) A list of message groups that Amazon Lex uses to respond the user input. (see below for nested schema)Optional:
is_active
(Boolean)bot_locales.intents.intent_closing_setting.closing_response
Required:
message_groups_list
(Attributes List) One to 5 message groups that contain update messages. Amazon Lex chooses one of the messages to play to the user. (see below for nested schema)Optional:
allow_interrupt
(Boolean) Indicates whether the user can interrupt a speech prompt from the bot.bot_locales.intents.intent_closing_setting.is_active.message_groups_list
Required:
message
(Attributes) The primary message that Amazon Lex should send to the user. (see below for nested schema)Optional:
variations
(Attributes List) Message variations to send to the user. (see below for nested schema)bot_locales.intents.intent_closing_setting.is_active.message_groups_list.message
Optional:
custom_payload
(Attributes) A message in a custom format defined by the client application. (see below for nested schema)image_response_card
(Attributes) A message that defines a response card that the client application can show to the user. (see below for nested schema)plain_text_message
(Attributes) A message in plain text format. (see below for nested schema)ssml_message
(Attributes) A message in Speech Synthesis Markup Language (SSML). (see below for nested schema)bot_locales.intents.intent_closing_setting.is_active.message_groups_list.variations.custom_payload
Required:
value
(String) The string that is sent to your application.bot_locales.intents.intent_closing_setting.is_active.message_groups_list.variations.image_response_card
Required:
title
(String) The title to display on the response card.Optional:
buttons
(Attributes List) A list of buttons that should be displayed on the response card. (see below for nested schema)image_url
(String) The URL of an image to display on the response card.subtitle
(String) The subtitle to display on the response card.bot_locales.intents.intent_closing_setting.is_active.message_groups_list.variations.ssml_message.buttons
Required:
text
(String) The text that appears on the button.value
(String) The value returned to Amazon Lex when the user chooses this button.bot_locales.intents.intent_closing_setting.is_active.message_groups_list.variations.plain_text_message
Required:
value
(String) The message to send to the user.bot_locales.intents.intent_closing_setting.is_active.message_groups_list.variations.ssml_message
Required:
value
(String) The SSML text that defines the prompt.bot_locales.intents.intent_closing_setting.is_active.message_groups_list.variations
Optional:
custom_payload
(Attributes) A message in a custom format defined by the client application. (see below for nested schema)image_response_card
(Attributes) A message that defines a response card that the client application can show to the user. (see below for nested schema)plain_text_message
(Attributes) A message in plain text format. (see below for nested schema)ssml_message
(Attributes) A message in Speech Synthesis Markup Language (SSML). (see below for nested schema)bot_locales.intents.intent_closing_setting.is_active.message_groups_list.variations.custom_payload
Required:
value
(String) The string that is sent to your application.bot_locales.intents.intent_closing_setting.is_active.message_groups_list.variations.image_response_card
Required:
title
(String) The title to display on the response card.Optional:
buttons
(Attributes List) A list of buttons that should be displayed on the response card. (see below for nested schema)image_url
(String) The URL of an image to display on the response card.subtitle
(String) The subtitle to display on the response card.bot_locales.intents.intent_closing_setting.is_active.message_groups_list.variations.ssml_message.buttons
Required:
text
(String) The text that appears on the button.value
(String) The value returned to Amazon Lex when the user chooses this button.bot_locales.intents.intent_closing_setting.is_active.message_groups_list.variations.plain_text_message
Required:
value
(String) The message to send to the user.bot_locales.intents.intent_closing_setting.is_active.message_groups_list.variations.ssml_message
Required:
value
(String) The SSML text that defines the prompt.bot_locales.intents.intent_confirmation_setting
Required:
declination_response
(Attributes) A list of message groups that Amazon Lex uses to respond the user input. (see below for nested schema)prompt_specification
(Attributes) Prompts the user to confirm the intent. (see below for nested schema)Optional:
is_active
(Boolean)bot_locales.intents.intent_confirmation_setting.declination_response
Required:
message_groups_list
(Attributes List) One to 5 message groups that contain update messages. Amazon Lex chooses one of the messages to play to the user. (see below for nested schema)Optional:
allow_interrupt
(Boolean) Indicates whether the user can interrupt a speech prompt from the bot.bot_locales.intents.intent_confirmation_setting.is_active.message_groups_list
Required:
message
(Attributes) The primary message that Amazon Lex should send to the user. (see below for nested schema)Optional:
variations
(Attributes List) Message variations to send to the user. (see below for nested schema)bot_locales.intents.intent_confirmation_setting.is_active.message_groups_list.message
Optional:
custom_payload
(Attributes) A message in a custom format defined by the client application. (see below for nested schema)image_response_card
(Attributes) A message that defines a response card that the client application can show to the user. (see below for nested schema)plain_text_message
(Attributes) A message in plain text format. (see below for nested schema)ssml_message
(Attributes) A message in Speech Synthesis Markup Language (SSML). (see below for nested schema)bot_locales.intents.intent_confirmation_setting.is_active.message_groups_list.variations.custom_payload
Required:
value
(String) The string that is sent to your application.bot_locales.intents.intent_confirmation_setting.is_active.message_groups_list.variations.image_response_card
Required:
title
(String) The title to display on the response card.Optional:
buttons
(Attributes List) A list of buttons that should be displayed on the response card. (see below for nested schema)image_url
(String) The URL of an image to display on the response card.subtitle
(String) The subtitle to display on the response card.bot_locales.intents.intent_confirmation_setting.is_active.message_groups_list.variations.ssml_message.buttons
Required:
text
(String) The text that appears on the button.value
(String) The value returned to Amazon Lex when the user chooses this button.bot_locales.intents.intent_confirmation_setting.is_active.message_groups_list.variations.plain_text_message
Required:
value
(String) The message to send to the user.bot_locales.intents.intent_confirmation_setting.is_active.message_groups_list.variations.ssml_message
Required:
value
(String) The SSML text that defines the prompt.bot_locales.intents.intent_confirmation_setting.is_active.message_groups_list.variations
Optional:
custom_payload
(Attributes) A message in a custom format defined by the client application. (see below for nested schema)image_response_card
(Attributes) A message that defines a response card that the client application can show to the user. (see below for nested schema)plain_text_message
(Attributes) A message in plain text format. (see below for nested schema)ssml_message
(Attributes) A message in Speech Synthesis Markup Language (SSML). (see below for nested schema)bot_locales.intents.intent_confirmation_setting.is_active.message_groups_list.variations.custom_payload
Required:
value
(String) The string that is sent to your application.bot_locales.intents.intent_confirmation_setting.is_active.message_groups_list.variations.image_response_card
Required:
title
(String) The title to display on the response card.Optional:
buttons
(Attributes List) A list of buttons that should be displayed on the response card. (see below for nested schema)image_url
(String) The URL of an image to display on the response card.subtitle
(String) The subtitle to display on the response card.bot_locales.intents.intent_confirmation_setting.is_active.message_groups_list.variations.ssml_message.buttons
Required:
text
(String) The text that appears on the button.value
(String) The value returned to Amazon Lex when the user chooses this button.bot_locales.intents.intent_confirmation_setting.is_active.message_groups_list.variations.plain_text_message
Required:
value
(String) The message to send to the user.bot_locales.intents.intent_confirmation_setting.is_active.message_groups_list.variations.ssml_message
Required:
value
(String) The SSML text that defines the prompt.bot_locales.intents.intent_confirmation_setting.prompt_specification
Required:
max_retries
(Number) The maximum number of times the bot tries to elicit a resonse from the user using this prompt.message_groups_list
(Attributes List) One to 5 message groups that contain update messages. Amazon Lex chooses one of the messages to play to the user. (see below for nested schema)Optional:
allow_interrupt
(Boolean) Indicates whether the user can interrupt a speech prompt from the bot.message_selection_strategy
(String) Indicates how a message is selected from a message group among retries.prompt_attempts_specification
(Attributes Map) Specifies the advanced settings on each attempt of the prompt. (see below for nested schema)bot_locales.intents.intent_confirmation_setting.is_active.message_groups_list
Required:
message
(Attributes) The primary message that Amazon Lex should send to the user. (see below for nested schema)Optional:
variations
(Attributes List) Message variations to send to the user. (see below for nested schema)bot_locales.intents.intent_confirmation_setting.is_active.message_groups_list.message
Optional:
custom_payload
(Attributes) A message in a custom format defined by the client application. (see below for nested schema)image_response_card
(Attributes) A message that defines a response card that the client application can show to the user. (see below for nested schema)plain_text_message
(Attributes) A message in plain text format. (see below for nested schema)ssml_message
(Attributes) A message in Speech Synthesis Markup Language (SSML). (see below for nested schema)bot_locales.intents.intent_confirmation_setting.is_active.message_groups_list.variations.custom_payload
Required:
value
(String) The string that is sent to your application.bot_locales.intents.intent_confirmation_setting.is_active.message_groups_list.variations.image_response_card
Required:
title
(String) The title to display on the response card.Optional:
buttons
(Attributes List) A list of buttons that should be displayed on the response card. (see below for nested schema)image_url
(String) The URL of an image to display on the response card.subtitle
(String) The subtitle to display on the response card.bot_locales.intents.intent_confirmation_setting.is_active.message_groups_list.variations.ssml_message.buttons
Required:
text
(String) The text that appears on the button.value
(String) The value returned to Amazon Lex when the user chooses this button.bot_locales.intents.intent_confirmation_setting.is_active.message_groups_list.variations.plain_text_message
Required:
value
(String) The message to send to the user.bot_locales.intents.intent_confirmation_setting.is_active.message_groups_list.variations.ssml_message
Required:
value
(String) The SSML text that defines the prompt.bot_locales.intents.intent_confirmation_setting.is_active.message_groups_list.variations
Optional:
custom_payload
(Attributes) A message in a custom format defined by the client application. (see below for nested schema)image_response_card
(Attributes) A message that defines a response card that the client application can show to the user. (see below for nested schema)plain_text_message
(Attributes) A message in plain text format. (see below for nested schema)ssml_message
(Attributes) A message in Speech Synthesis Markup Language (SSML). (see below for nested schema)bot_locales.intents.intent_confirmation_setting.is_active.message_groups_list.variations.custom_payload
Required:
value
(String) The string that is sent to your application.bot_locales.intents.intent_confirmation_setting.is_active.message_groups_list.variations.image_response_card
Required:
title
(String) The title to display on the response card.Optional:
buttons
(Attributes List) A list of buttons that should be displayed on the response card. (see below for nested schema)image_url
(String) The URL of an image to display on the response card.subtitle
(String) The subtitle to display on the response card.bot_locales.intents.intent_confirmation_setting.is_active.message_groups_list.variations.ssml_message.buttons
Required:
text
(String) The text that appears on the button.value
(String) The value returned to Amazon Lex when the user chooses this button.bot_locales.intents.intent_confirmation_setting.is_active.message_groups_list.variations.plain_text_message
Required:
value
(String) The message to send to the user.bot_locales.intents.intent_confirmation_setting.is_active.message_groups_list.variations.ssml_message
Required:
value
(String) The SSML text that defines the prompt.bot_locales.intents.intent_confirmation_setting.is_active.prompt_attempts_specification
Optional:
allow_interrupt
(Boolean) Indicates whether the user can interrupt a speech prompt attempt from the bot.allowed_input_types
(Attributes) Specifies the allowed input types. (see below for nested schema)audio_and_dtmf_input_specification
(Attributes) Specifies the audio and DTMF input specification. (see below for nested schema)text_input_specification
(Attributes) Specifies the text input specifications. (see below for nested schema)bot_locales.intents.intent_confirmation_setting.is_active.prompt_attempts_specification.allowed_input_types
Required:
allow_audio_input
(Boolean) Indicates whether audio input is allowed.allow_dtmf_input
(Boolean) Indicates whether DTMF input is allowed.bot_locales.intents.intent_confirmation_setting.is_active.prompt_attempts_specification.audio_and_dtmf_input_specification
Required:
start_timeout_ms
(Number) Time for which a bot waits before assuming that the customer isn't going to speak or press a key. This timeout is shared between Audio and DTMF inputs.Optional:
audio_specification
(Attributes) Specifies the audio input specifications. (see below for nested schema)dtmf_specification
(Attributes) Specifies the settings on DTMF input. (see below for nested schema)bot_locales.intents.intent_confirmation_setting.is_active.prompt_attempts_specification.text_input_specification.audio_specification
Required:
end_timeout_ms
(Number) Time for which a bot waits after the customer stops speaking to assume the utterance is finished.max_length_ms
(Number) Time for how long Amazon Lex waits before speech input is truncated and the speech is returned to application.bot_locales.intents.intent_confirmation_setting.is_active.prompt_attempts_specification.text_input_specification.dtmf_specification
Required:
deletion_character
(String) The DTMF character that clears the accumulated DTMF digits and immediately ends the input.end_character
(String) The DTMF character that immediately ends input. If the user does not press this character, the input ends after the end timeout.end_timeout_ms
(Number) How long the bot should wait after the last DTMF character input before assuming that the input has concluded.max_length
(Number) The maximum number of DTMF digits allowed in an utterance.bot_locales.intents.intent_confirmation_setting.is_active.prompt_attempts_specification.text_input_specification
Required:
start_timeout_ms
(Number) Time for which a bot waits before re-prompting a customer for text input.bot_locales.intents.kendra_configuration
Required:
kendra_index
(String) The Amazon Resource Name (ARN) of the Amazon Kendra index that you want the AMAZON.KendraSearchIntent intent to search.Optional:
query_filter_string
(String) A query filter that Amazon Lex sends to Amazon Kendra to filter the response from a query.query_filter_string_enabled
(Boolean) Determines whether the AMAZON.KendraSearchIntent intent uses a custom query string to query the Amazon Kendra index.bot_locales.intents.output_contexts
Required:
name
(String) Unique name for a resource.time_to_live_in_seconds
(Number) The amount of time, in seconds, that the output context should remain active.turns_to_live
(Number) The number of conversation turns that the output context should remain active.bot_locales.intents.sample_utterances
Required:
utterance
(String) The sample utterance that Amazon Lex uses to build its machine-learning model to recognize intents/slots.bot_locales.intents.slot_priorities
Required:
priority
(Number) The priority that a slot should be elicited.slot_name
(String) The name of the slot.bot_locales.intents.slots
Required:
name
(String) Unique name for a resource.slot_type_name
(String) The slot type name that is used in the slot. Allows for custom and built-in slot type namesvalue_elicitation_setting
(Attributes) Settings that you can use for eliciting a slot value. (see below for nested schema)Optional:
description
(String) A description of the resourcemultiple_values_setting
(Attributes) Indicates whether a slot can return multiple values. (see below for nested schema)obfuscation_setting
(Attributes) Determines whether Amazon Lex obscures slot values in conversation logs. (see below for nested schema)bot_locales.intents.slots.value_elicitation_setting
Required:
slot_constraint
(String) Specifies whether the slot is required or optional.Optional:
default_value_specification
(Attributes) A list of default values for a slot. (see below for nested schema)prompt_specification
(Attributes) The prompt that Amazon Lex uses to elicit the slot value from the user. (see below for nested schema)sample_utterances
(Attributes List) If you know a specific pattern that users might respond to an Amazon Lex request for a slot value, you can provide those utterances to improve accuracy. (see below for nested schema)wait_and_continue_specification
(Attributes) Specifies the prompts that Amazon Lex uses while a bot is waiting for customer input. (see below for nested schema)bot_locales.intents.slots.obfuscation_setting.default_value_specification
Required:
default_value_list
(Attributes List) A list of slot default values (see below for nested schema)bot_locales.intents.slots.obfuscation_setting.default_value_specification.default_value_list
Required:
default_value
(String) The default value to use when a user doesn't provide a value for a slot.bot_locales.intents.slots.obfuscation_setting.prompt_specification
Required:
max_retries
(Number) The maximum number of times the bot tries to elicit a resonse from the user using this prompt.message_groups_list
(Attributes List) One to 5 message groups that contain update messages. Amazon Lex chooses one of the messages to play to the user. (see below for nested schema)Optional:
allow_interrupt
(Boolean) Indicates whether the user can interrupt a speech prompt from the bot.message_selection_strategy
(String) Indicates how a message is selected from a message group among retries.prompt_attempts_specification
(Attributes Map) Specifies the advanced settings on each attempt of the prompt. (see below for nested schema)bot_locales.intents.slots.obfuscation_setting.prompt_specification.message_groups_list
Required:
message
(Attributes) The primary message that Amazon Lex should send to the user. (see below for nested schema)Optional:
variations
(Attributes List) Message variations to send to the user. (see below for nested schema)bot_locales.intents.slots.obfuscation_setting.prompt_specification.prompt_attempts_specification.message
Optional:
custom_payload
(Attributes) A message in a custom format defined by the client application. (see below for nested schema)image_response_card
(Attributes) A message that defines a response card that the client application can show to the user. (see below for nested schema)plain_text_message
(Attributes) A message in plain text format. (see below for nested schema)ssml_message
(Attributes) A message in Speech Synthesis Markup Language (SSML). (see below for nested schema)bot_locales.intents.slots.obfuscation_setting.prompt_specification.prompt_attempts_specification.variations.custom_payload
Required:
value
(String) The string that is sent to your application.bot_locales.intents.slots.obfuscation_setting.prompt_specification.prompt_attempts_specification.variations.image_response_card
Required:
title
(String) The title to display on the response card.Optional:
buttons
(Attributes List) A list of buttons that should be displayed on the response card. (see below for nested schema)image_url
(String) The URL of an image to display on the response card.subtitle
(String) The subtitle to display on the response card.bot_locales.intents.slots.obfuscation_setting.prompt_specification.prompt_attempts_specification.variations.ssml_message.buttons
Required:
text
(String) The text that appears on the button.value
(String) The value returned to Amazon Lex when the user chooses this button.bot_locales.intents.slots.obfuscation_setting.prompt_specification.prompt_attempts_specification.variations.plain_text_message
Required:
value
(String) The message to send to the user.bot_locales.intents.slots.obfuscation_setting.prompt_specification.prompt_attempts_specification.variations.ssml_message
Required:
value
(String) The SSML text that defines the prompt.bot_locales.intents.slots.obfuscation_setting.prompt_specification.prompt_attempts_specification.variations
Optional:
custom_payload
(Attributes) A message in a custom format defined by the client application. (see below for nested schema)image_response_card
(Attributes) A message that defines a response card that the client application can show to the user. (see below for nested schema)plain_text_message
(Attributes) A message in plain text format. (see below for nested schema)ssml_message
(Attributes) A message in Speech Synthesis Markup Language (SSML). (see below for nested schema)bot_locales.intents.slots.obfuscation_setting.prompt_specification.prompt_attempts_specification.variations.custom_payload
Required:
value
(String) The string that is sent to your application.bot_locales.intents.slots.obfuscation_setting.prompt_specification.prompt_attempts_specification.variations.image_response_card
Required:
title
(String) The title to display on the response card.Optional:
buttons
(Attributes List) A list of buttons that should be displayed on the response card. (see below for nested schema)image_url
(String) The URL of an image to display on the response card.subtitle
(String) The subtitle to display on the response card.bot_locales.intents.slots.obfuscation_setting.prompt_specification.prompt_attempts_specification.variations.ssml_message.buttons
Required:
text
(String) The text that appears on the button.value
(String) The value returned to Amazon Lex when the user chooses this button.bot_locales.intents.slots.obfuscation_setting.prompt_specification.prompt_attempts_specification.variations.plain_text_message
Required:
value
(String) The message to send to the user.bot_locales.intents.slots.obfuscation_setting.prompt_specification.prompt_attempts_specification.variations.ssml_message
Required:
value
(String) The SSML text that defines the prompt.bot_locales.intents.slots.obfuscation_setting.prompt_specification.prompt_attempts_specification
Optional:
allow_interrupt
(Boolean) Indicates whether the user can interrupt a speech prompt attempt from the bot.allowed_input_types
(Attributes) Specifies the allowed input types. (see below for nested schema)audio_and_dtmf_input_specification
(Attributes) Specifies the audio and DTMF input specification. (see below for nested schema)text_input_specification
(Attributes) Specifies the text input specifications. (see below for nested schema)bot_locales.intents.slots.obfuscation_setting.prompt_specification.prompt_attempts_specification.allowed_input_types
Required:
allow_audio_input
(Boolean) Indicates whether audio input is allowed.allow_dtmf_input
(Boolean) Indicates whether DTMF input is allowed.bot_locales.intents.slots.obfuscation_setting.prompt_specification.prompt_attempts_specification.audio_and_dtmf_input_specification
Required:
start_timeout_ms
(Number) Time for which a bot waits before assuming that the customer isn't going to speak or press a key. This timeout is shared between Audio and DTMF inputs.Optional:
audio_specification
(Attributes) Specifies the audio input specifications. (see below for nested schema)dtmf_specification
(Attributes) Specifies the settings on DTMF input. (see below for nested schema)bot_locales.intents.slots.obfuscation_setting.prompt_specification.prompt_attempts_specification.text_input_specification.audio_specification
Required:
end_timeout_ms
(Number) Time for which a bot waits after the customer stops speaking to assume the utterance is finished.max_length_ms
(Number) Time for how long Amazon Lex waits before speech input is truncated and the speech is returned to application.bot_locales.intents.slots.obfuscation_setting.prompt_specification.prompt_attempts_specification.text_input_specification.dtmf_specification
Required:
deletion_character
(String) The DTMF character that clears the accumulated DTMF digits and immediately ends the input.end_character
(String) The DTMF character that immediately ends input. If the user does not press this character, the input ends after the end timeout.end_timeout_ms
(Number) How long the bot should wait after the last DTMF character input before assuming that the input has concluded.max_length
(Number) The maximum number of DTMF digits allowed in an utterance.bot_locales.intents.slots.obfuscation_setting.prompt_specification.prompt_attempts_specification.text_input_specification
Required:
start_timeout_ms
(Number) Time for which a bot waits before re-prompting a customer for text input.bot_locales.intents.slots.obfuscation_setting.sample_utterances
Required:
utterance
(String) The sample utterance that Amazon Lex uses to build its machine-learning model to recognize intents/slots.bot_locales.intents.slots.obfuscation_setting.wait_and_continue_specification
Required:
continue_response
(Attributes) The response that Amazon Lex sends to indicate that the bot is ready to continue the conversation. (see below for nested schema)waiting_response
(Attributes) The response that Amazon Lex sends to indicate that the bot is waiting for the conversation to continue. (see below for nested schema)Optional:
is_active
(Boolean) Specifies whether the bot will wait for a user to respond.still_waiting_response
(Attributes) The response that Amazon Lex sends periodically to the user to indicate that the bot is still waiting for input from the user. (see below for nested schema)bot_locales.intents.slots.obfuscation_setting.wait_and_continue_specification.continue_response
Required:
message_groups_list
(Attributes List) One to 5 message groups that contain update messages. Amazon Lex chooses one of the messages to play to the user. (see below for nested schema)Optional:
allow_interrupt
(Boolean) Indicates whether the user can interrupt a speech prompt from the bot.bot_locales.intents.slots.obfuscation_setting.wait_and_continue_specification.still_waiting_response.message_groups_list
Required:
message
(Attributes) The primary message that Amazon Lex should send to the user. (see below for nested schema)Optional:
variations
(Attributes List) Message variations to send to the user. (see below for nested schema)bot_locales.intents.slots.obfuscation_setting.wait_and_continue_specification.still_waiting_response.allow_interrupt.message
Optional:
custom_payload
(Attributes) A message in a custom format defined by the client application. (see below for nested schema)image_response_card
(Attributes) A message that defines a response card that the client application can show to the user. (see below for nested schema)plain_text_message
(Attributes) A message in plain text format. (see below for nested schema)ssml_message
(Attributes) A message in Speech Synthesis Markup Language (SSML). (see below for nested schema)bot_locales.intents.slots.obfuscation_setting.wait_and_continue_specification.still_waiting_response.allow_interrupt.variations.custom_payload
Required:
value
(String) The string that is sent to your application.bot_locales.intents.slots.obfuscation_setting.wait_and_continue_specification.still_waiting_response.allow_interrupt.variations.image_response_card
Required:
title
(String) The title to display on the response card.Optional:
buttons
(Attributes List) A list of buttons that should be displayed on the response card. (see below for nested schema)image_url
(String) The URL of an image to display on the response card.subtitle
(String) The subtitle to display on the response card.bot_locales.intents.slots.obfuscation_setting.wait_and_continue_specification.still_waiting_response.allow_interrupt.variations.image_response_card.buttons
Required:
text
(String) The text that appears on the button.value
(String) The value returned to Amazon Lex when the user chooses this button.bot_locales.intents.slots.obfuscation_setting.wait_and_continue_specification.still_waiting_response.allow_interrupt.variations.plain_text_message
Required:
value
(String) The message to send to the user.bot_locales.intents.slots.obfuscation_setting.wait_and_continue_specification.still_waiting_response.allow_interrupt.variations.ssml_message
Required:
value
(String) The SSML text that defines the prompt.bot_locales.intents.slots.obfuscation_setting.wait_and_continue_specification.still_waiting_response.allow_interrupt.variations
Optional:
custom_payload
(Attributes) A message in a custom format defined by the client application. (see below for nested schema)image_response_card
(Attributes) A message that defines a response card that the client application can show to the user. (see below for nested schema)plain_text_message
(Attributes) A message in plain text format. (see below for nested schema)ssml_message
(Attributes) A message in Speech Synthesis Markup Language (SSML). (see below for nested schema)bot_locales.intents.slots.obfuscation_setting.wait_and_continue_specification.still_waiting_response.allow_interrupt.variations.custom_payload
Required:
value
(String) The string that is sent to your application.bot_locales.intents.slots.obfuscation_setting.wait_and_continue_specification.still_waiting_response.allow_interrupt.variations.image_response_card
Required:
title
(String) The title to display on the response card.Optional:
buttons
(Attributes List) A list of buttons that should be displayed on the response card. (see below for nested schema)image_url
(String) The URL of an image to display on the response card.subtitle
(String) The subtitle to display on the response card.bot_locales.intents.slots.obfuscation_setting.wait_and_continue_specification.still_waiting_response.allow_interrupt.variations.image_response_card.buttons
Required:
text
(String) The text that appears on the button.value
(String) The value returned to Amazon Lex when the user chooses this button.bot_locales.intents.slots.obfuscation_setting.wait_and_continue_specification.still_waiting_response.allow_interrupt.variations.plain_text_message
Required:
value
(String) The message to send to the user.bot_locales.intents.slots.obfuscation_setting.wait_and_continue_specification.still_waiting_response.allow_interrupt.variations.ssml_message
Required:
value
(String) The SSML text that defines the prompt.bot_locales.intents.slots.obfuscation_setting.wait_and_continue_specification.waiting_response
Required:
message_groups_list
(Attributes List) One to 5 message groups that contain update messages. Amazon Lex chooses one of the messages to play to the user. (see below for nested schema)Optional:
allow_interrupt
(Boolean) Indicates whether the user can interrupt a speech prompt from the bot.bot_locales.intents.slots.obfuscation_setting.wait_and_continue_specification.still_waiting_response.message_groups_list
Required:
message
(Attributes) The primary message that Amazon Lex should send to the user. (see below for nested schema)Optional:
variations
(Attributes List) Message variations to send to the user. (see below for nested schema)bot_locales.intents.slots.obfuscation_setting.wait_and_continue_specification.still_waiting_response.allow_interrupt.message
Optional:
custom_payload
(Attributes) A message in a custom format defined by the client application. (see below for nested schema)image_response_card
(Attributes) A message that defines a response card that the client application can show to the user. (see below for nested schema)plain_text_message
(Attributes) A message in plain text format. (see below for nested schema)ssml_message
(Attributes) A message in Speech Synthesis Markup Language (SSML). (see below for nested schema)bot_locales.intents.slots.obfuscation_setting.wait_and_continue_specification.still_waiting_response.allow_interrupt.variations.custom_payload
Required:
value
(String) The string that is sent to your application.bot_locales.intents.slots.obfuscation_setting.wait_and_continue_specification.still_waiting_response.allow_interrupt.variations.image_response_card
Required:
title
(String) The title to display on the response card.Optional:
buttons
(Attributes List) A list of buttons that should be displayed on the response card. (see below for nested schema)image_url
(String) The URL of an image to display on the response card.subtitle
(String) The subtitle to display on the response card.bot_locales.intents.slots.obfuscation_setting.wait_and_continue_specification.still_waiting_response.allow_interrupt.variations.image_response_card.buttons
Required:
text
(String) The text that appears on the button.value
(String) The value returned to Amazon Lex when the user chooses this button.bot_locales.intents.slots.obfuscation_setting.wait_and_continue_specification.still_waiting_response.allow_interrupt.variations.plain_text_message
Required:
value
(String) The message to send to the user.bot_locales.intents.slots.obfuscation_setting.wait_and_continue_specification.still_waiting_response.allow_interrupt.variations.ssml_message
Required:
value
(String) The SSML text that defines the prompt.bot_locales.intents.slots.obfuscation_setting.wait_and_continue_specification.still_waiting_response.allow_interrupt.variations
Optional:
custom_payload
(Attributes) A message in a custom format defined by the client application. (see below for nested schema)image_response_card
(Attributes) A message that defines a response card that the client application can show to the user. (see below for nested schema)plain_text_message
(Attributes) A message in plain text format. (see below for nested schema)ssml_message
(Attributes) A message in Speech Synthesis Markup Language (SSML). (see below for nested schema)bot_locales.intents.slots.obfuscation_setting.wait_and_continue_specification.still_waiting_response.allow_interrupt.variations.custom_payload
Required:
value
(String) The string that is sent to your application.bot_locales.intents.slots.obfuscation_setting.wait_and_continue_specification.still_waiting_response.allow_interrupt.variations.image_response_card
Required:
title
(String) The title to display on the response card.Optional:
buttons
(Attributes List) A list of buttons that should be displayed on the response card. (see below for nested schema)image_url
(String) The URL of an image to display on the response card.subtitle
(String) The subtitle to display on the response card.bot_locales.intents.slots.obfuscation_setting.wait_and_continue_specification.still_waiting_response.allow_interrupt.variations.image_response_card.buttons
Required:
text
(String) The text that appears on the button.value
(String) The value returned to Amazon Lex when the user chooses this button.bot_locales.intents.slots.obfuscation_setting.wait_and_continue_specification.still_waiting_response.allow_interrupt.variations.plain_text_message
Required:
value
(String) The message to send to the user.bot_locales.intents.slots.obfuscation_setting.wait_and_continue_specification.still_waiting_response.allow_interrupt.variations.ssml_message
Required:
value
(String) The SSML text that defines the prompt.bot_locales.intents.slots.obfuscation_setting.wait_and_continue_specification.still_waiting_response
Required:
frequency_in_seconds
(Number) How often a message should be sent to the user in seconds.message_groups_list
(Attributes List) One to 5 message groups that contain update messages. Amazon Lex chooses one of the messages to play to the user. (see below for nested schema)timeout_in_seconds
(Number) If Amazon Lex waits longer than this length of time in seconds for a response, it will stop sending messages.Optional:
allow_interrupt
(Boolean) Indicates whether the user can interrupt a speech prompt from the bot.bot_locales.intents.slots.obfuscation_setting.wait_and_continue_specification.still_waiting_response.message_groups_list
Required:
message
(Attributes) The primary message that Amazon Lex should send to the user. (see below for nested schema)Optional:
variations
(Attributes List) Message variations to send to the user. (see below for nested schema)bot_locales.intents.slots.obfuscation_setting.wait_and_continue_specification.still_waiting_response.allow_interrupt.message
Optional:
custom_payload
(Attributes) A message in a custom format defined by the client application. (see below for nested schema)image_response_card
(Attributes) A message that defines a response card that the client application can show to the user. (see below for nested schema)plain_text_message
(Attributes) A message in plain text format. (see below for nested schema)ssml_message
(Attributes) A message in Speech Synthesis Markup Language (SSML). (see below for nested schema)bot_locales.intents.slots.obfuscation_setting.wait_and_continue_specification.still_waiting_response.allow_interrupt.variations.custom_payload
Required:
value
(String) The string that is sent to your application.bot_locales.intents.slots.obfuscation_setting.wait_and_continue_specification.still_waiting_response.allow_interrupt.variations.image_response_card
Required:
title
(String) The title to display on the response card.Optional:
buttons
(Attributes List) A list of buttons that should be displayed on the response card. (see below for nested schema)image_url
(String) The URL of an image to display on the response card.subtitle
(String) The subtitle to display on the response card.bot_locales.intents.slots.obfuscation_setting.wait_and_continue_specification.still_waiting_response.allow_interrupt.variations.image_response_card.buttons
Required:
text
(String) The text that appears on the button.value
(String) The value returned to Amazon Lex when the user chooses this button.bot_locales.intents.slots.obfuscation_setting.wait_and_continue_specification.still_waiting_response.allow_interrupt.variations.plain_text_message
Required:
value
(String) The message to send to the user.bot_locales.intents.slots.obfuscation_setting.wait_and_continue_specification.still_waiting_response.allow_interrupt.variations.ssml_message
Required:
value
(String) The SSML text that defines the prompt.bot_locales.intents.slots.obfuscation_setting.wait_and_continue_specification.still_waiting_response.allow_interrupt.variations
Optional:
custom_payload
(Attributes) A message in a custom format defined by the client application. (see below for nested schema)image_response_card
(Attributes) A message that defines a response card that the client application can show to the user. (see below for nested schema)plain_text_message
(Attributes) A message in plain text format. (see below for nested schema)ssml_message
(Attributes) A message in Speech Synthesis Markup Language (SSML). (see below for nested schema)bot_locales.intents.slots.obfuscation_setting.wait_and_continue_specification.still_waiting_response.allow_interrupt.variations.custom_payload
Required:
value
(String) The string that is sent to your application.bot_locales.intents.slots.obfuscation_setting.wait_and_continue_specification.still_waiting_response.allow_interrupt.variations.image_response_card
Required:
title
(String) The title to display on the response card.Optional:
buttons
(Attributes List) A list of buttons that should be displayed on the response card. (see below for nested schema)image_url
(String) The URL of an image to display on the response card.subtitle
(String) The subtitle to display on the response card.bot_locales.intents.slots.obfuscation_setting.wait_and_continue_specification.still_waiting_response.allow_interrupt.variations.image_response_card.buttons
Required:
text
(String) The text that appears on the button.value
(String) The value returned to Amazon Lex when the user chooses this button.bot_locales.intents.slots.obfuscation_setting.wait_and_continue_specification.still_waiting_response.allow_interrupt.variations.plain_text_message
Required:
value
(String) The message to send to the user.bot_locales.intents.slots.obfuscation_setting.wait_and_continue_specification.still_waiting_response.allow_interrupt.variations.ssml_message
Required:
value
(String) The SSML text that defines the prompt.bot_locales.intents.slots.multiple_values_setting
Optional:
allow_multiple_values
(Boolean)bot_locales.intents.slots.obfuscation_setting
Required:
obfuscation_setting_type
(String) Value that determines whether Amazon Lex obscures slot values in conversation logs. The default is to obscure the values.bot_locales.slot_types
Required:
name
(String) Unique name for a resource.Optional:
description
(String) A description of the resourceexternal_source_setting
(Attributes) Provides information about the external source of the slot type's definition. (see below for nested schema)parent_slot_type_signature
(String) The built-in slot type used as a parent of this slot type.slot_type_values
(Attributes List) A List of slot type values (see below for nested schema)value_selection_setting
(Attributes) Contains settings used by Amazon Lex to select a slot value. (see below for nested schema)bot_locales.slot_types.external_source_setting
Optional:
grammar_slot_type_setting
(Attributes) Settings required for a slot type based on a grammar that you provide. (see below for nested schema)bot_locales.slot_types.external_source_setting.grammar_slot_type_setting
Optional:
source
(Attributes) Describes the Amazon S3 bucket name and location for the grammar that is the source for the slot type. (see below for nested schema)bot_locales.slot_types.external_source_setting.grammar_slot_type_setting.source
Required:
s3_bucket_name
(String) The name of the S3 bucket that contains the grammar source.s3_object_key
(String) The path to the grammar in the S3 bucket.Optional:
kms_key_arn
(String) The Amazon KMS key required to decrypt the contents of the grammar, if any.bot_locales.slot_types.slot_type_values
Required:
sample_value
(Attributes) Defines one of the values for a slot type. (see below for nested schema)Optional:
synonyms
(Attributes List) Additional values related to the slot type entry. (see below for nested schema)bot_locales.slot_types.slot_type_values.sample_value
Required:
value
(String) The value that can be used for a slot type.bot_locales.slot_types.slot_type_values.synonyms
Required:
value
(String) The value that can be used for a slot type.bot_locales.slot_types.value_selection_setting
Required:
resolution_strategy
(String)Optional:
advanced_recognition_setting
(Attributes) Provides settings that enable advanced recognition settings for slot values. (see below for nested schema)regex_filter
(Attributes) A regular expression used to validate the value of a slot. (see below for nested schema)bot_locales.slot_types.value_selection_setting.advanced_recognition_setting
Optional:
audio_recognition_strategy
(String) Enables using slot values as a custom vocabulary when recognizing user utterances.bot_locales.slot_types.value_selection_setting.regex_filter
Required:
pattern
(String) Regex patternbot_locales.voice_settings
Required:
voice_id
(String) The Amazon Polly voice ID that Amazon Lex uses for voice interaction with the user.Optional:
engine
(String) Indicates the type of Amazon Polly voice that Amazon Lex should use for voice interaction with the user. For more information, see the engine parameter of the SynthesizeSpeech operation in the Amazon Polly developer guide.bot_tags
Required:
key
(String) The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.value
(String) The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.test_bot_alias_settings
Optional:
bot_alias_locale_settings
(Attributes Set) A list of bot alias locale settings to add to the bot alias. (see below for nested schema)conversation_log_settings
(Attributes) Contains information about code hooks that Amazon Lex calls during a conversation. (see below for nested schema)description
(String) A description of the resourcesentiment_analysis_settings
(Attributes) Determines whether Amazon Lex will use Amazon Comprehend to detect the sentiment of user utterances. (see below for nested schema)test_bot_alias_settings.bot_alias_locale_settings
Required:
bot_alias_locale_setting
(Attributes) You can use this parameter to specify a specific Lambda function to run different functions in different locales. (see below for nested schema)locale_id
(String) A string used to identify the localetest_bot_alias_settings.bot_alias_locale_settings.bot_alias_locale_setting
Required:
enabled
(Boolean) Whether the Lambda code hook is enabledOptional:
code_hook_specification
(Attributes) Contains information about code hooks that Amazon Lex calls during a conversation. (see below for nested schema)test_bot_alias_settings.bot_alias_locale_settings.bot_alias_locale_setting.code_hook_specification
Required:
lambda_code_hook
(Attributes) Contains information about code hooks that Amazon Lex calls during a conversation. (see below for nested schema)test_bot_alias_settings.bot_alias_locale_settings.bot_alias_locale_setting.code_hook_specification.lambda_code_hook
Required:
code_hook_interface_version
(String) The version of the request-response that you want Amazon Lex to use to invoke your Lambda function.lambda_arn
(String) The Amazon Resource Name (ARN) of the Lambda function.test_bot_alias_settings.conversation_log_settings
Optional:
audio_log_settings
(Attributes Set) List of audio log settings that pertain to the conversation log settings for the bot's TestBotAlias. (see below for nested schema)text_log_settings
(Attributes Set) List of text log settings that pertain to the conversation log settings for the bot's TestBotAlias (see below for nested schema)test_bot_alias_settings.conversation_log_settings.audio_log_settings
Required:
destination
(Attributes) The location of audio log files collected when conversation logging is enabled for a bot. (see below for nested schema)enabled
(Boolean)test_bot_alias_settings.conversation_log_settings.audio_log_settings.destination
Required:
s3_bucket
(Attributes) Specifies an Amazon S3 bucket for logging audio conversations (see below for nested schema)test_bot_alias_settings.conversation_log_settings.audio_log_settings.enabled.s3_bucket
Required:
log_prefix
(String) The Amazon S3 key of the deployment package.s3_bucket_arn
(String) The Amazon Resource Name (ARN) of an Amazon S3 bucket where audio log files are stored.Optional:
kms_key_arn
(String) The Amazon Resource Name (ARN) of an AWS Key Management Service (KMS) key for encrypting audio log files stored in an S3 bucket.test_bot_alias_settings.conversation_log_settings.text_log_settings
Required:
destination
(Attributes) Defines the Amazon CloudWatch Logs destination log group for conversation text logs. (see below for nested schema)enabled
(Boolean)test_bot_alias_settings.conversation_log_settings.text_log_settings.destination
Required:
cloudwatch
(Attributes) (see below for nested schema)test_bot_alias_settings.conversation_log_settings.text_log_settings.enabled.cloudwatch
Required:
cloudwatch_log_group_arn
(String) A string used to identify the groupArn for the Cloudwatch Log Grouplog_prefix
(String) A string containing the value for the Log Prefixtest_bot_alias_settings.sentiment_analysis_settings
Required:
detect_sentiment
(Boolean) Enable to call Amazon Comprehend for Sentiment natively within Lextest_bot_alias_tags
Required:
key
(String) The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.value
(String) The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.Import is supported using the following syntax:
$ terraform import awscc_lex_bot.example <resource ID>