Type object
Schema URL https://catalog.lintel.tools/schemas/schemastore/serverless-framework-configuration/_shared/latest--aws-lex-bot.json
Parent schema serverless-framework-configuration
Type: object

Amazon Lex conversational bot performing automated tasks such as ordering a pizza, booking a hotel, and so on.. Source:- https://docs.aws.amazon.com/lexv2/latest/dg/build-create.html

Properties

Name string | Aws_CF_FunctionString required

Unique name for a resource.

RoleArn string | Aws_CF_FunctionString required

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

DataPrivacy object required

Data privacy setting of the Bot.

1 nested properties
ChildDirected boolean required
IdleSessionTTLInSeconds integer required

IdleSessionTTLInSeconds of the resource

min=60max=86400
Description string | Aws_CF_FunctionString

A description of the resource

BotLocales BotLocale[]

List of bot locales

uniqueItems=true
BotFileS3Location object

S3 location of bot definitions zip file, if it's not defined inline in CloudFormation.

3 nested properties
S3Bucket string | Aws_CF_FunctionString required
S3ObjectKey string | Aws_CF_FunctionString required
S3ObjectVersion string | Aws_CF_FunctionString

For versioned objects, the version of the deployment package object to use. If not specified, the current object version will be used.

BotTags Tag[]

A list of tags to add to the bot, which can only be added at bot creation.

maxItems=200uniqueItems=true
TestBotAliasTags Tag[]

A list of tags to add to the test alias for a bot, , which can only be added at bot/bot alias creation.

maxItems=200uniqueItems=true
AutoBuildBotLocales boolean

Specifies whether to build the bot locales after bot creation completes.

TestBotAliasSettings object

Configuring the test bot alias settings for a given bot

4 nested properties
BotAliasLocaleSettings BotAliasLocaleSettingsItem[]

A list of bot alias locale settings to add to the bot alias.

maxItems=50uniqueItems=true
ConversationLogSettings object

Contains information about code hooks that Amazon Lex calls during a conversation.

2 nested properties
AudioLogSettings AudioLogSetting[]

List of audio log settings that pertain to the conversation log settings for the bot's TestBotAlias.

maxItems=1uniqueItems=true
TextLogSettings TextLogSetting[]

List of text log settings that pertain to the conversation log settings for the bot's TestBotAlias

maxItems=1uniqueItems=true
Description string | Aws_CF_FunctionString

A description of the resource

SentimentAnalysisSettings object

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

1 nested properties
DetectSentiment boolean required

Enable to call Amazon Comprehend for Sentiment natively within Lex

Definitions

BotAliasLocaleSettingsList BotAliasLocaleSettingsItem[]

A list of bot alias locale settings to add to the bot alias.

BotAliasLocaleSettingsItem object

A locale setting in alias

LocaleId string | Aws_CF_FunctionString required

A string used to identify the locale

BotAliasLocaleSetting object required

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

2 nested properties
Enabled boolean required

Whether the Lambda code hook is enabled

CodeHookSpecification object

Contains information about code hooks that Amazon Lex calls during a conversation.

1 nested properties
LambdaCodeHook object required

Contains information about code hooks that Amazon Lex calls during a conversation.

BotAliasLocaleSettings object

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

Enabled boolean required

Whether the Lambda code hook is enabled

CodeHookSpecification object

Contains information about code hooks that Amazon Lex calls during a conversation.

1 nested properties
LambdaCodeHook object required

Contains information about code hooks that Amazon Lex calls during a conversation.

2 nested properties
CodeHookInterfaceVersion string | Aws_CF_FunctionString required

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

LambdaArn string | Aws_CF_FunctionString required

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

CodeHookSpecification object

Contains information about code hooks that Amazon Lex calls during a conversation.

LambdaCodeHook object required

Contains information about code hooks that Amazon Lex calls during a conversation.

2 nested properties
CodeHookInterfaceVersion string | Aws_CF_FunctionString required

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

LambdaArn string | Aws_CF_FunctionString required

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

LambdaCodeHook object

Contains information about code hooks that Amazon Lex calls during a conversation.

CodeHookInterfaceVersion string | Aws_CF_FunctionString required

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

LambdaArn string | Aws_CF_FunctionString required

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

ConversationLogSettings object

Contains information about code hooks that Amazon Lex calls during a conversation.

AudioLogSettings AudioLogSetting[]

List of audio log settings that pertain to the conversation log settings for the bot's TestBotAlias.

maxItems=1uniqueItems=true
TextLogSettings TextLogSetting[]

List of text log settings that pertain to the conversation log settings for the bot's TestBotAlias

maxItems=1uniqueItems=true
AudioLogSettings AudioLogSetting[]

List of audio log settings that pertain to the conversation log settings for the bot's TestBotAlias.

TextLogSettings TextLogSetting[]

List of text log settings that pertain to the conversation log settings for the bot's TestBotAlias

AudioLogSetting object

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.

Destination object required

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

1 nested properties
S3Bucket object required

Specifies an Amazon S3 bucket for logging audio conversations

3 nested properties
S3BucketArn string | Aws_CF_FunctionString required

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

LogPrefix string | Aws_CF_FunctionString required

The Amazon S3 key of the deployment package.

KmsKeyArn string | Aws_CF_FunctionString

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

Enabled boolean required
TextLogSetting object

Contains information about code hooks that Amazon Lex calls during a conversation.

Destination object required

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

1 nested properties
CloudWatch object required
2 nested properties
CloudWatchLogGroupArn string | Aws_CF_FunctionString required

A string used to identify the groupArn for the Cloudwatch Log Group

LogPrefix string | Aws_CF_FunctionString required

A string containing the value for the Log Prefix

Enabled boolean required
AudioLogDestination object

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

S3Bucket object required

Specifies an Amazon S3 bucket for logging audio conversations

3 nested properties
S3BucketArn string | Aws_CF_FunctionString required

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

LogPrefix string | Aws_CF_FunctionString required

The Amazon S3 key of the deployment package.

KmsKeyArn string | Aws_CF_FunctionString

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

TextLogDestination object

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

CloudWatch object required
2 nested properties
CloudWatchLogGroupArn string | Aws_CF_FunctionString required

A string used to identify the groupArn for the Cloudwatch Log Group

LogPrefix string | Aws_CF_FunctionString required

A string containing the value for the Log Prefix

CloudWatchLogGroupLogDestination object
CloudWatchLogGroupArn string | Aws_CF_FunctionString required

A string used to identify the groupArn for the Cloudwatch Log Group

LogPrefix string | Aws_CF_FunctionString required

A string containing the value for the Log Prefix

S3BucketLogDestination object

Specifies an Amazon S3 bucket for logging audio conversations

S3BucketArn string | Aws_CF_FunctionString required

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

LogPrefix string | Aws_CF_FunctionString required

The Amazon S3 key of the deployment package.

KmsKeyArn string | Aws_CF_FunctionString

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

TestBotAliasSettings object

Configuring the test bot alias settings for a given bot

BotAliasLocaleSettings BotAliasLocaleSettingsItem[]

A list of bot alias locale settings to add to the bot alias.

maxItems=50uniqueItems=true
ConversationLogSettings object

Contains information about code hooks that Amazon Lex calls during a conversation.

2 nested properties
AudioLogSettings AudioLogSetting[]

List of audio log settings that pertain to the conversation log settings for the bot's TestBotAlias.

maxItems=1uniqueItems=true
TextLogSettings TextLogSetting[]

List of text log settings that pertain to the conversation log settings for the bot's TestBotAlias

maxItems=1uniqueItems=true
Description string | Aws_CF_FunctionString

A description of the resource

SentimentAnalysisSettings object

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

1 nested properties
DetectSentiment boolean required

Enable to call Amazon Comprehend for Sentiment natively within Lex

RoleArn string | Aws_CF_FunctionString

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

Id string | Aws_CF_FunctionString

Unique ID of resource

BotArn string | Aws_CF_FunctionString
Name string | Aws_CF_FunctionString

Unique name for a resource.

Description string | Aws_CF_FunctionString

A description of the resource

DataPrivacy object

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

ChildDirected boolean required

Specify whether your use of Amazon Lex is related to 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).

IdleSessionTTLInSeconds integer

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

Utterance string | Aws_CF_FunctionString

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

SampleUtterance object

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

Utterance string | Aws_CF_FunctionString required

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

SampleUtterancesList SampleUtterance[]

An array of sample utterances

Tag object

A key-value pair for tagging Lex resources

Key string | Aws_CF_FunctionString required

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 | Aws_CF_FunctionString required

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

LocaleId string | Aws_CF_FunctionString

The identifier of the language and locale that the bot will be used in.

VoiceSettings object

Settings for using an Amazon Polly voice to communicate with a user.

VoiceId string | Aws_CF_FunctionString required

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

Engine string | Aws_CF_FunctionString

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.

ConfidenceThreshold number

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

ParentIntentSignature string | Aws_CF_FunctionString

A unique identifier for the built-in intent to base this intent on.

DialogCodeHookSetting object

Settings that determine the Lambda function that Amazon Lex uses for processing user responses.

Enabled boolean required
FulfillmentStartResponseSpecification object

Provides settings for a message that is sent to the user when a fulfillment Lambda function starts running.

MessageGroups MessageGroup[] required

One to 5 message groups that contain update messages. Amazon Lex chooses one of the messages to play to the user.

minItems=1maxItems=5
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.

min=1max=900
AllowInterrupt boolean

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

FulfillmentUpdateResponseSpecification object

Provides settings for a message that is sent periodically to the user while a fulfillment Lambda function is running.

MessageGroups MessageGroup[] required

One to 5 message groups that contain update messages. Amazon Lex chooses one of the messages to play to the user.

minItems=1maxItems=5
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.

min=1max=900
AllowInterrupt boolean

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

FulfillmentUpdatesSpecification object

Provides information for updating the user on the progress of fulfilling an intent.

Active boolean required

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

StartResponse object

Provides settings for a message that is sent to the user when a fulfillment Lambda function starts running.

3 nested properties
MessageGroups MessageGroup[] required

One to 5 message groups that contain update messages. Amazon Lex chooses one of the messages to play to the user.

minItems=1maxItems=5
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.

min=1max=900
AllowInterrupt boolean

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

UpdateResponse object

Provides settings for a message that is sent periodically to the user while a fulfillment Lambda function is running.

3 nested properties
MessageGroups MessageGroup[] required

One to 5 message groups that contain update messages. Amazon Lex chooses one of the messages to play to the user.

minItems=1maxItems=5
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.

min=1max=900
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.

min=1max=900
PostFulfillmentStatusSpecification object

Provides a setting that determines whether the post-fulfillment response is sent to the user.

SuccessResponse object

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

2 nested properties
MessageGroupsList MessageGroup[] required

One to 5 message groups that contain update messages. Amazon Lex chooses one of the messages to play to the user.

minItems=1maxItems=5
AllowInterrupt boolean

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

SuccessNextStep object

The current state of the conversation with the user.

3 nested properties
DialogAction object

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

3 nested properties
Type string | Aws_CF_FunctionString required

The possible values of actions that the conversation can take.

SlotToElicit string | Aws_CF_FunctionString

Unique name for a resource.

SuppressNextMessage boolean

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

Intent object

Override settings to configure the intent state.

2 nested properties
Name string | Aws_CF_FunctionString

Unique name for a resource.

A map of all of the slot value overrides for the intent.

SessionAttributes SessionAttribute[]

List of session attributes to be applied when the conversation reaches this step.

SuccessConditional object

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.

3 nested properties
IsActive boolean required

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

ConditionalBranches ConditionalBranch[] required

A list of 1 to 4 conditional branches to fork the conversation flow.

minItems=1maxItems=4
DefaultBranch object required

A set of actions that Amazon Lex should run if none of the other conditions are met.

2 nested properties
NextStep object

The current state of the conversation with the user.

Response object

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

FailureResponse object

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

2 nested properties
MessageGroupsList MessageGroup[] required

One to 5 message groups that contain update messages. Amazon Lex chooses one of the messages to play to the user.

minItems=1maxItems=5
AllowInterrupt boolean

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

FailureNextStep object

The current state of the conversation with the user.

3 nested properties
DialogAction object

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

3 nested properties
Type string | Aws_CF_FunctionString required

The possible values of actions that the conversation can take.

SlotToElicit string | Aws_CF_FunctionString

Unique name for a resource.

SuppressNextMessage boolean

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

Intent object

Override settings to configure the intent state.

2 nested properties
Name string | Aws_CF_FunctionString

Unique name for a resource.

A map of all of the slot value overrides for the intent.

SessionAttributes SessionAttribute[]

List of session attributes to be applied when the conversation reaches this step.

FailureConditional object

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.

3 nested properties
IsActive boolean required

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

ConditionalBranches ConditionalBranch[] required

A list of 1 to 4 conditional branches to fork the conversation flow.

minItems=1maxItems=4
DefaultBranch object required

A set of actions that Amazon Lex should run if none of the other conditions are met.

2 nested properties
NextStep object

The current state of the conversation with the user.

Response object

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

TimeoutResponse object

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

2 nested properties
MessageGroupsList MessageGroup[] required

One to 5 message groups that contain update messages. Amazon Lex chooses one of the messages to play to the user.

minItems=1maxItems=5
AllowInterrupt boolean

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

TimeoutNextStep object

The current state of the conversation with the user.

3 nested properties
DialogAction object

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

3 nested properties
Type string | Aws_CF_FunctionString required

The possible values of actions that the conversation can take.

SlotToElicit string | Aws_CF_FunctionString

Unique name for a resource.

SuppressNextMessage boolean

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

Intent object

Override settings to configure the intent state.

2 nested properties
Name string | Aws_CF_FunctionString

Unique name for a resource.

A map of all of the slot value overrides for the intent.

SessionAttributes SessionAttribute[]

List of session attributes to be applied when the conversation reaches this step.

TimeoutConditional object

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.

3 nested properties
IsActive boolean required

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

ConditionalBranches ConditionalBranch[] required

A list of 1 to 4 conditional branches to fork the conversation flow.

minItems=1maxItems=4
DefaultBranch object required

A set of actions that Amazon Lex should run if none of the other conditions are met.

2 nested properties
NextStep object

The current state of the conversation with the user.

Response object

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

FulfillmentCodeHookSetting object

Settings that determine if a Lambda function should be invoked to fulfill a specific intent.

Enabled boolean required
FulfillmentUpdatesSpecification object

Provides information for updating the user on the progress of fulfilling an intent.

4 nested properties
Active boolean required

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

StartResponse object

Provides settings for a message that is sent to the user when a fulfillment Lambda function starts running.

3 nested properties
MessageGroups MessageGroup[] required

One to 5 message groups that contain update messages. Amazon Lex chooses one of the messages to play to the user.

minItems=1maxItems=5
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.

min=1max=900
AllowInterrupt boolean

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

UpdateResponse object

Provides settings for a message that is sent periodically to the user while a fulfillment Lambda function is running.

3 nested properties
MessageGroups MessageGroup[] required

One to 5 message groups that contain update messages. Amazon Lex chooses one of the messages to play to the user.

minItems=1maxItems=5
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.

min=1max=900
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.

min=1max=900
PostFulfillmentStatusSpecification object

Provides a setting that determines whether the post-fulfillment response is sent to the user.

9 nested properties
SuccessResponse object

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

2 nested properties
MessageGroupsList MessageGroup[] required

One to 5 message groups that contain update messages. Amazon Lex chooses one of the messages to play to the user.

minItems=1maxItems=5
AllowInterrupt boolean

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

SuccessNextStep object

The current state of the conversation with the user.

3 nested properties
DialogAction object

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

Intent object

Override settings to configure the intent state.

SessionAttributes SessionAttribute[]

List of session attributes to be applied when the conversation reaches this step.

SuccessConditional object

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.

3 nested properties
IsActive boolean required

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

ConditionalBranches ConditionalBranch[] required

A list of 1 to 4 conditional branches to fork the conversation flow.

minItems=1maxItems=4
DefaultBranch object required

A set of actions that Amazon Lex should run if none of the other conditions are met.

FailureResponse object

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

2 nested properties
MessageGroupsList MessageGroup[] required

One to 5 message groups that contain update messages. Amazon Lex chooses one of the messages to play to the user.

minItems=1maxItems=5
AllowInterrupt boolean

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

FailureNextStep object

The current state of the conversation with the user.

3 nested properties
DialogAction object

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

Intent object

Override settings to configure the intent state.

SessionAttributes SessionAttribute[]

List of session attributes to be applied when the conversation reaches this step.

FailureConditional object

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.

3 nested properties
IsActive boolean required

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

ConditionalBranches ConditionalBranch[] required

A list of 1 to 4 conditional branches to fork the conversation flow.

minItems=1maxItems=4
DefaultBranch object required

A set of actions that Amazon Lex should run if none of the other conditions are met.

TimeoutResponse object

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

2 nested properties
MessageGroupsList MessageGroup[] required

One to 5 message groups that contain update messages. Amazon Lex chooses one of the messages to play to the user.

minItems=1maxItems=5
AllowInterrupt boolean

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

TimeoutNextStep object

The current state of the conversation with the user.

3 nested properties
DialogAction object

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

Intent object

Override settings to configure the intent state.

SessionAttributes SessionAttribute[]

List of session attributes to be applied when the conversation reaches this step.

TimeoutConditional object

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.

3 nested properties
IsActive boolean required

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

ConditionalBranches ConditionalBranch[] required

A list of 1 to 4 conditional branches to fork the conversation flow.

minItems=1maxItems=4
DefaultBranch object required

A set of actions that Amazon Lex should run if none of the other conditions are met.

IsActive boolean

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

Button object

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

Text string | Aws_CF_FunctionString required

The text that appears on the button.

Value string | Aws_CF_FunctionString required

The value returned to Amazon Lex when the user chooses this button.

AttachmentTitle string | Aws_CF_FunctionString
AttachmentUrl string | Aws_CF_FunctionString
ImageResponseCard object

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

Title string | Aws_CF_FunctionString required
Subtitle string | Aws_CF_FunctionString
ImageUrl string | Aws_CF_FunctionString
Buttons Button[]

A list of buttons that should be displayed on the response card.

maxItems=5
PlainTextMessage object

A message in plain text format.

Value string | Aws_CF_FunctionString required

The message to send to the user.

CustomPayload object

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

Value string | Aws_CF_FunctionString required

The string that is sent to your application.

SSMLMessage object

A message in Speech Synthesis Markup Language (SSML).

Value string | Aws_CF_FunctionString required

The SSML text that defines the prompt.

Message object

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

PlainTextMessage object

A message in plain text format.

1 nested properties
Value string | Aws_CF_FunctionString required

The message to send to the user.

CustomPayload object

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

1 nested properties
Value string | Aws_CF_FunctionString required

The string that is sent to your application.

SSMLMessage object

A message in Speech Synthesis Markup Language (SSML).

1 nested properties
Value string | Aws_CF_FunctionString required

The SSML text that defines the prompt.

ImageResponseCard object

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

4 nested properties
Title string | Aws_CF_FunctionString required
Subtitle string | Aws_CF_FunctionString
ImageUrl string | Aws_CF_FunctionString
Buttons Button[]

A list of buttons that should be displayed on the response card.

maxItems=5
MessageGroup object

One or more messages that Amazon Lex can send to the user.

Message object required

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

4 nested properties
PlainTextMessage object

A message in plain text format.

1 nested properties
Value string | Aws_CF_FunctionString required

The message to send to the user.

CustomPayload object

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

1 nested properties
Value string | Aws_CF_FunctionString required

The string that is sent to your application.

SSMLMessage object

A message in Speech Synthesis Markup Language (SSML).

1 nested properties
Value string | Aws_CF_FunctionString required

The SSML text that defines the prompt.

ImageResponseCard object

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

4 nested properties
Title string | Aws_CF_FunctionString required
Subtitle string | Aws_CF_FunctionString
ImageUrl string | Aws_CF_FunctionString
Buttons Button[]

A list of buttons that should be displayed on the response card.

maxItems=5
Variations Message[]

Message variations to send to the user.

maxItems=2
MessageGroupsList MessageGroup[]

One to 5 message groups that contain update messages. Amazon Lex chooses one of the messages to play to the user.

PromptMaxRetries integer

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

MessageSelectionStrategy string | Aws_CF_FunctionString

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

AllowedInputTypes object

Specifies the allowed input types.

AllowAudioInput boolean required

Indicates whether audio input is allowed.

AllowDTMFInput boolean required

Indicates whether DTMF input is allowed.

DTMFSpecification object

Specifies the settings on DTMF input.

DeletionCharacter string | Aws_CF_FunctionString required

The DTMF character that clears the accumulated DTMF digits and immediately ends the input.

EndCharacter string | Aws_CF_FunctionString required

The DTMF character that immediately ends input. If the user does not press this character, the input ends after the end timeout.

EndTimeoutMs integer required

How long the bot should wait after the last DTMF character input before assuming that the input has concluded.

min=1
MaxLength integer required

The maximum number of DTMF digits allowed in an utterance.

min=1max=1024
AudioSpecification object

Specifies the audio input specifications.

EndTimeoutMs integer required

Time for which a bot waits after the customer stops speaking to assume the utterance is finished.

min=1
MaxLengthMs integer required

Time for how long Amazon Lex waits before speech input is truncated and the speech is returned to application.

min=1
AudioAndDTMFInputSpecification object

Specifies the audio and DTMF input specification.

StartTimeoutMs integer required

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.

min=1
DTMFSpecification object

Specifies the settings on DTMF input.

4 nested properties
DeletionCharacter string | Aws_CF_FunctionString required

The DTMF character that clears the accumulated DTMF digits and immediately ends the input.

EndCharacter string | Aws_CF_FunctionString required

The DTMF character that immediately ends input. If the user does not press this character, the input ends after the end timeout.

EndTimeoutMs integer required

How long the bot should wait after the last DTMF character input before assuming that the input has concluded.

min=1
MaxLength integer required

The maximum number of DTMF digits allowed in an utterance.

min=1max=1024
AudioSpecification object

Specifies the audio input specifications.

2 nested properties
EndTimeoutMs integer required

Time for which a bot waits after the customer stops speaking to assume the utterance is finished.

min=1
MaxLengthMs integer required

Time for how long Amazon Lex waits before speech input is truncated and the speech is returned to application.

min=1
TextInputSpecification object

Specifies the text input specifications.

StartTimeoutMs integer required

Time for which a bot waits before re-prompting a customer for text input.

min=1
PromptAttemptSpecification object

Specifies the settings on a prompt attempt.

AllowedInputTypes object required

Specifies the allowed input types.

2 nested properties
AllowAudioInput boolean required

Indicates whether audio input is allowed.

AllowDTMFInput boolean required

Indicates whether DTMF input is allowed.

AllowInterrupt boolean

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

AudioAndDTMFInputSpecification object

Specifies the audio and DTMF input specification.

3 nested properties
StartTimeoutMs integer required

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.

min=1
DTMFSpecification object

Specifies the settings on DTMF input.

4 nested properties
DeletionCharacter string | Aws_CF_FunctionString required

The DTMF character that clears the accumulated DTMF digits and immediately ends the input.

EndCharacter string | Aws_CF_FunctionString required

The DTMF character that immediately ends input. If the user does not press this character, the input ends after the end timeout.

EndTimeoutMs integer required

How long the bot should wait after the last DTMF character input before assuming that the input has concluded.

min=1
MaxLength integer required

The maximum number of DTMF digits allowed in an utterance.

min=1max=1024
AudioSpecification object

Specifies the audio input specifications.

2 nested properties
EndTimeoutMs integer required

Time for which a bot waits after the customer stops speaking to assume the utterance is finished.

min=1
MaxLengthMs integer required

Time for how long Amazon Lex waits before speech input is truncated and the speech is returned to application.

min=1
TextInputSpecification object

Specifies the text input specifications.

1 nested properties
StartTimeoutMs integer required

Time for which a bot waits before re-prompting a customer for text input.

min=1
PromptSpecification object

Prompts the user to confirm the intent.

MessageGroupsList MessageGroup[] required

One to 5 message groups that contain update messages. Amazon Lex chooses one of the messages to play to the user.

minItems=1maxItems=5
MaxRetries integer required

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

min=0max=5
AllowInterrupt boolean

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

MessageSelectionStrategy string | Aws_CF_FunctionString

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

PromptAttemptsSpecification object

Specifies the advanced settings on each attempt of the prompt.

ResponseSpecification object

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

MessageGroupsList MessageGroup[] required

One to 5 message groups that contain update messages. Amazon Lex chooses one of the messages to play to the user.

minItems=1maxItems=5
AllowInterrupt boolean

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

StillWaitingResponseFrequency integer

How often a message should be sent to the user in seconds.

StillWaitingResponseTimeout integer

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

StillWaitingResponseSpecification object

StillWaitingResponseSpecification.

MessageGroupsList MessageGroup[] required

One to 5 message groups that contain update messages. Amazon Lex chooses one of the messages to play to the user.

minItems=1maxItems=5
FrequencyInSeconds integer required

How often a message should be sent to the user in seconds.

min=1max=300
TimeoutInSeconds integer required

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

min=1max=900
AllowInterrupt boolean

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

IntentConfirmationSetting object

Provides a prompt for making sure that the user is ready for the intent to be fulfilled.

PromptSpecification object required

Prompts the user to confirm the intent.

5 nested properties
MessageGroupsList MessageGroup[] required

One to 5 message groups that contain update messages. Amazon Lex chooses one of the messages to play to the user.

minItems=1maxItems=5
MaxRetries integer required

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

min=0max=5
AllowInterrupt boolean

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

MessageSelectionStrategy string | Aws_CF_FunctionString

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

PromptAttemptsSpecification object

Specifies the advanced settings on each attempt of the prompt.

IsActive 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 object

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

2 nested properties
MessageGroupsList MessageGroup[] required

One to 5 message groups that contain update messages. Amazon Lex chooses one of the messages to play to the user.

minItems=1maxItems=5
AllowInterrupt boolean

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

ConfirmationNextStep object

The current state of the conversation with the user.

3 nested properties
DialogAction object

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

3 nested properties
Type string | Aws_CF_FunctionString required

The possible values of actions that the conversation can take.

SlotToElicit string | Aws_CF_FunctionString

Unique name for a resource.

SuppressNextMessage boolean

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

Intent object

Override settings to configure the intent state.

2 nested properties
Name string | Aws_CF_FunctionString

Unique name for a resource.

A map of all of the slot value overrides for the intent.

SessionAttributes SessionAttribute[]

List of session attributes to be applied when the conversation reaches this step.

ConfirmationConditional object

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.

3 nested properties
IsActive boolean required

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

ConditionalBranches ConditionalBranch[] required

A list of 1 to 4 conditional branches to fork the conversation flow.

minItems=1maxItems=4
DefaultBranch object required

A set of actions that Amazon Lex should run if none of the other conditions are met.

2 nested properties
NextStep object

The current state of the conversation with the user.

Response object

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

DeclinationResponse object

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

2 nested properties
MessageGroupsList MessageGroup[] required

One to 5 message groups that contain update messages. Amazon Lex chooses one of the messages to play to the user.

minItems=1maxItems=5
AllowInterrupt boolean

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

DeclinationNextStep object

The current state of the conversation with the user.

3 nested properties
DialogAction object

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

3 nested properties
Type string | Aws_CF_FunctionString required

The possible values of actions that the conversation can take.

SlotToElicit string | Aws_CF_FunctionString

Unique name for a resource.

SuppressNextMessage boolean

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

Intent object

Override settings to configure the intent state.

2 nested properties
Name string | Aws_CF_FunctionString

Unique name for a resource.

A map of all of the slot value overrides for the intent.

SessionAttributes SessionAttribute[]

List of session attributes to be applied when the conversation reaches this step.

DeclinationConditional object

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.

3 nested properties
IsActive boolean required

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

ConditionalBranches ConditionalBranch[] required

A list of 1 to 4 conditional branches to fork the conversation flow.

minItems=1maxItems=4
DefaultBranch object required

A set of actions that Amazon Lex should run if none of the other conditions are met.

2 nested properties
NextStep object

The current state of the conversation with the user.

Response object

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

FailureResponse object

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

2 nested properties
MessageGroupsList MessageGroup[] required

One to 5 message groups that contain update messages. Amazon Lex chooses one of the messages to play to the user.

minItems=1maxItems=5
AllowInterrupt boolean

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

FailureNextStep object

The current state of the conversation with the user.

3 nested properties
DialogAction object

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

3 nested properties
Type string | Aws_CF_FunctionString required

The possible values of actions that the conversation can take.

SlotToElicit string | Aws_CF_FunctionString

Unique name for a resource.

SuppressNextMessage boolean

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

Intent object

Override settings to configure the intent state.

2 nested properties
Name string | Aws_CF_FunctionString

Unique name for a resource.

A map of all of the slot value overrides for the intent.

SessionAttributes SessionAttribute[]

List of session attributes to be applied when the conversation reaches this step.

FailureConditional object

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.

3 nested properties
IsActive boolean required

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

ConditionalBranches ConditionalBranch[] required

A list of 1 to 4 conditional branches to fork the conversation flow.

minItems=1maxItems=4
DefaultBranch object required

A set of actions that Amazon Lex should run if none of the other conditions are met.

2 nested properties
NextStep object

The current state of the conversation with the user.

Response object

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

CodeHook object

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

4 nested properties
EnableCodeHookInvocation boolean required

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

IsActive boolean required

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

PostCodeHookSpecification object required

Specifies next steps to run after the dialog code hook finishes.

9 nested properties
SuccessResponse object

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

SuccessNextStep object

The current state of the conversation with the user.

SuccessConditional object

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.

FailureResponse object

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

FailureNextStep object

The current state of the conversation with the user.

FailureConditional object

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.

TimeoutResponse object

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

TimeoutNextStep object

The current state of the conversation with the user.

TimeoutConditional object

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.

InvocationLabel string | Aws_CF_FunctionString

Unique name for a resource.

ElicitationCodeHook object

Settings that specify the dialog code hook that is called by Amazon Lex between eliciting slot values.

2 nested properties
EnableCodeHookInvocation boolean required

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

InvocationLabel string | Aws_CF_FunctionString

Unique name for a resource.

IntentClosingSetting object

Provides a statement the Amazon Lex conveys to the user when the intent is successfully fulfilled.

ClosingResponse object

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

2 nested properties
MessageGroupsList MessageGroup[] required

One to 5 message groups that contain update messages. Amazon Lex chooses one of the messages to play to the user.

minItems=1maxItems=5
AllowInterrupt boolean

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

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

Conditional object

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.

3 nested properties
IsActive boolean required

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

ConditionalBranches ConditionalBranch[] required

A list of 1 to 4 conditional branches to fork the conversation flow.

minItems=1maxItems=4
DefaultBranch object required

A set of actions that Amazon Lex should run if none of the other conditions are met.

2 nested properties
NextStep object

The current state of the conversation with the user.

Response object

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

NextStep object

The current state of the conversation with the user.

3 nested properties
DialogAction object

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

3 nested properties
Type string | Aws_CF_FunctionString required

The possible values of actions that the conversation can take.

SlotToElicit string | Aws_CF_FunctionString

Unique name for a resource.

SuppressNextMessage boolean

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

Intent object

Override settings to configure the intent state.

2 nested properties
Name string | Aws_CF_FunctionString

Unique name for a resource.

A map of all of the slot value overrides for the intent.

SessionAttributes SessionAttribute[]

List of session attributes to be applied when the conversation reaches this step.

InputContext object

InputContext specified for the intent.

Name string | Aws_CF_FunctionString required

Unique name for a resource.

InputContextsList InputContext[]

The list of input contexts specified for the intent.

ContextTimeToLiveInSeconds integer

The amount of time, in seconds, that the output context should remain active.

ContextTurnsToLive integer

The number of conversation turns that the output context should remain active.

OutputContext object

A session context that is activated when an intent is fulfilled.

Name string | Aws_CF_FunctionString required

Unique name for a resource.

TimeToLiveInSeconds integer required

The amount of time, in seconds, that the output context should remain active.

min=5max=86400
TurnsToLive integer required

The number of conversation turns that the output context should remain active.

min=1max=20
OutputContextsList OutputContext[]

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

KendraIndexArn string | Aws_CF_FunctionString

The Amazon Resource Name (ARN) of the Amazon Kendra index that you want the AMAZON.KendraSearchIntent intent to search.

QueryFilterString string | Aws_CF_FunctionString

A query filter that Amazon Lex sends to Amazon Kendra to filter the response from a query.

KendraConfiguration object

Configuration for searching a Amazon Kendra index specified for the intent.

KendraIndex string | Aws_CF_FunctionString required

The Amazon Resource Name (ARN) of the Amazon Kendra index that you want the AMAZON.KendraSearchIntent intent to search.

QueryFilterStringEnabled boolean

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

QueryFilterString string | Aws_CF_FunctionString

A query filter that Amazon Lex sends to Amazon Kendra to filter the response from a query.

PriorityValue integer

The priority that a slot should be elicited.

SlotPriority object

The priority that Amazon Lex should use when eliciting slot values from a user.

Priority integer required

The priority that a slot should be elicited.

min=0max=100
SlotName string | Aws_CF_FunctionString required

Unique name for a resource.

SlotPrioritiesList SlotPriority[]

List for slot priorities

Intent object

Represents an action that the user wants to perform.

Name string | Aws_CF_FunctionString required

Unique name for a resource.

Description string | Aws_CF_FunctionString

A description of the resource

ParentIntentSignature string | Aws_CF_FunctionString

A unique identifier for the built-in intent to base this intent on.

SampleUtterances SampleUtterance[]

An array of sample utterances

DialogCodeHook object

Settings that determine the Lambda function that Amazon Lex uses for processing user responses.

1 nested properties
Enabled boolean required
FulfillmentCodeHook object

Settings that determine if a Lambda function should be invoked to fulfill a specific intent.

4 nested properties
Enabled boolean required
FulfillmentUpdatesSpecification object

Provides information for updating the user on the progress of fulfilling an intent.

4 nested properties
Active boolean required

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

StartResponse object

Provides settings for a message that is sent to the user when a fulfillment Lambda function starts running.

UpdateResponse object

Provides settings for a message that is sent periodically to the user while a fulfillment Lambda function is running.

TimeoutInSeconds integer

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

min=1max=900
PostFulfillmentStatusSpecification object

Provides a setting that determines whether the post-fulfillment response is sent to the user.

9 nested properties
SuccessResponse object

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

SuccessNextStep object

The current state of the conversation with the user.

SuccessConditional object

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.

FailureResponse object

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

FailureNextStep object

The current state of the conversation with the user.

FailureConditional object

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.

TimeoutResponse object

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

TimeoutNextStep object

The current state of the conversation with the user.

TimeoutConditional object

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.

IsActive boolean

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

IntentConfirmationSetting object

Provides a prompt for making sure that the user is ready for the intent to be fulfilled.

13 nested properties
PromptSpecification object required

Prompts the user to confirm the intent.

5 nested properties
MessageGroupsList MessageGroup[] required

One to 5 message groups that contain update messages. Amazon Lex chooses one of the messages to play to the user.

minItems=1maxItems=5
MaxRetries integer required

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

min=0max=5
AllowInterrupt boolean

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

MessageSelectionStrategy string | Aws_CF_FunctionString

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

PromptAttemptsSpecification object

Specifies the advanced settings on each attempt of the prompt.

IsActive 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 object

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

2 nested properties
MessageGroupsList MessageGroup[] required

One to 5 message groups that contain update messages. Amazon Lex chooses one of the messages to play to the user.

minItems=1maxItems=5
AllowInterrupt boolean

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

ConfirmationNextStep object

The current state of the conversation with the user.

3 nested properties
DialogAction object

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

Intent object

Override settings to configure the intent state.

SessionAttributes SessionAttribute[]

List of session attributes to be applied when the conversation reaches this step.

ConfirmationConditional object

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.

3 nested properties
IsActive boolean required

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

ConditionalBranches ConditionalBranch[] required

A list of 1 to 4 conditional branches to fork the conversation flow.

minItems=1maxItems=4
DefaultBranch object required

A set of actions that Amazon Lex should run if none of the other conditions are met.

DeclinationResponse object

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

2 nested properties
MessageGroupsList MessageGroup[] required

One to 5 message groups that contain update messages. Amazon Lex chooses one of the messages to play to the user.

minItems=1maxItems=5
AllowInterrupt boolean

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

DeclinationNextStep object

The current state of the conversation with the user.

3 nested properties
DialogAction object

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

Intent object

Override settings to configure the intent state.

SessionAttributes SessionAttribute[]

List of session attributes to be applied when the conversation reaches this step.

DeclinationConditional object

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.

3 nested properties
IsActive boolean required

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

ConditionalBranches ConditionalBranch[] required

A list of 1 to 4 conditional branches to fork the conversation flow.

minItems=1maxItems=4
DefaultBranch object required

A set of actions that Amazon Lex should run if none of the other conditions are met.

FailureResponse object

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

2 nested properties
MessageGroupsList MessageGroup[] required

One to 5 message groups that contain update messages. Amazon Lex chooses one of the messages to play to the user.

minItems=1maxItems=5
AllowInterrupt boolean

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

FailureNextStep object

The current state of the conversation with the user.

3 nested properties
DialogAction object

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

Intent object

Override settings to configure the intent state.

SessionAttributes SessionAttribute[]

List of session attributes to be applied when the conversation reaches this step.

FailureConditional object

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.

3 nested properties
IsActive boolean required

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

ConditionalBranches ConditionalBranch[] required

A list of 1 to 4 conditional branches to fork the conversation flow.

minItems=1maxItems=4
DefaultBranch object required

A set of actions that Amazon Lex should run if none of the other conditions are met.

CodeHook object

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

4 nested properties
EnableCodeHookInvocation boolean required

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

IsActive boolean required

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

PostCodeHookSpecification object required

Specifies next steps to run after the dialog code hook finishes.

InvocationLabel string | Aws_CF_FunctionString

Unique name for a resource.

ElicitationCodeHook object

Settings that specify the dialog code hook that is called by Amazon Lex between eliciting slot values.

2 nested properties
EnableCodeHookInvocation boolean required

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

InvocationLabel string | Aws_CF_FunctionString

Unique name for a resource.

IntentClosingSetting object

Provides a statement the Amazon Lex conveys to the user when the intent is successfully fulfilled.

4 nested properties
ClosingResponse object

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

2 nested properties
MessageGroupsList MessageGroup[] required

One to 5 message groups that contain update messages. Amazon Lex chooses one of the messages to play to the user.

minItems=1maxItems=5
AllowInterrupt boolean

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

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

Conditional object

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.

3 nested properties
IsActive boolean required

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

ConditionalBranches ConditionalBranch[] required

A list of 1 to 4 conditional branches to fork the conversation flow.

minItems=1maxItems=4
DefaultBranch object required

A set of actions that Amazon Lex should run if none of the other conditions are met.

NextStep object

The current state of the conversation with the user.

3 nested properties
DialogAction object

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

Intent object

Override settings to configure the intent state.

SessionAttributes SessionAttribute[]

List of session attributes to be applied when the conversation reaches this step.

InitialResponseSetting object

Configuration setting for a response sent to the user before Amazon Lex starts eliciting slots.

4 nested properties
InitialResponse object

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

2 nested properties
MessageGroupsList MessageGroup[] required

One to 5 message groups that contain update messages. Amazon Lex chooses one of the messages to play to the user.

minItems=1maxItems=5
AllowInterrupt boolean

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

NextStep object

The current state of the conversation with the user.

3 nested properties
DialogAction object

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

Intent object

Override settings to configure the intent state.

SessionAttributes SessionAttribute[]

List of session attributes to be applied when the conversation reaches this step.

Conditional object

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.

3 nested properties
IsActive boolean required

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

ConditionalBranches ConditionalBranch[] required

A list of 1 to 4 conditional branches to fork the conversation flow.

minItems=1maxItems=4
DefaultBranch object required

A set of actions that Amazon Lex should run if none of the other conditions are met.

CodeHook object

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

4 nested properties
EnableCodeHookInvocation boolean required

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

IsActive boolean required

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

PostCodeHookSpecification object required

Specifies next steps to run after the dialog code hook finishes.

InvocationLabel string | Aws_CF_FunctionString

Unique name for a resource.

InputContexts InputContext[]

The list of input contexts specified for the intent.

maxItems=5
OutputContexts OutputContext[]

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

maxItems=10
KendraConfiguration object

Configuration for searching a Amazon Kendra index specified for the intent.

3 nested properties
KendraIndex string | Aws_CF_FunctionString required

The Amazon Resource Name (ARN) of the Amazon Kendra index that you want the AMAZON.KendraSearchIntent intent to search.

QueryFilterStringEnabled boolean

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

QueryFilterString string | Aws_CF_FunctionString

A query filter that Amazon Lex sends to Amazon Kendra to filter the response from a query.

SlotPriorities SlotPriority[]

List for slot priorities

Slots Slot[]

List of slots

maxItems=100uniqueItems=true
ParentSlotTypeSignature string | Aws_CF_FunctionString

The built-in slot type used as a parent of this slot type.

SlotTypeName string | Aws_CF_FunctionString

The slot type name that is used in the slot. Allows for custom and built-in slot type names

SampleValue object

Defines one of the values for a slot type.

Value string | Aws_CF_FunctionString required

The value that can be used for a slot type.

SynonymList SampleValue[]

Additional values related to the slot type entry.

SlotTypeValue object

Value that the slot type can take.

SampleValue object required

Defines one of the values for a slot type.

1 nested properties
Value string | Aws_CF_FunctionString required

The value that can be used for a slot type.

Synonyms SampleValue[]

Additional values related to the slot type entry.

maxItems=10000
SlotTypeValues SlotTypeValue[]

A List of slot type values

SlotValueResolutionStrategy string | Aws_CF_FunctionString
SlotValueRegexFilter object

A regular expression used to validate the value of a slot.

Pattern string | Aws_CF_FunctionString required

Regex pattern

AudioRecognitionStrategy string | Aws_CF_FunctionString

Enables using slot values as a custom vocabulary when recognizing user utterances.

AdvancedRecognitionSetting object

Provides settings that enable advanced recognition settings for slot values.

AudioRecognitionStrategy string | Aws_CF_FunctionString

Enables using slot values as a custom vocabulary when recognizing user utterances.

SlotValueSelectionSetting object

Contains settings used by Amazon Lex to select a slot value.

ResolutionStrategy string | Aws_CF_FunctionString required
RegexFilter object

A regular expression used to validate the value of a slot.

1 nested properties
Pattern string | Aws_CF_FunctionString required

Regex pattern

AdvancedRecognitionSetting object

Provides settings that enable advanced recognition settings for slot values.

1 nested properties
AudioRecognitionStrategy string | Aws_CF_FunctionString

Enables using slot values as a custom vocabulary when recognizing user utterances.

S3BucketName string | Aws_CF_FunctionString
S3ObjectKey string | Aws_CF_FunctionString
GrammarSlotTypeSource object

Describes the Amazon S3 bucket name and location for the grammar that is the source for the slot type.

S3BucketName string | Aws_CF_FunctionString required
S3ObjectKey string | Aws_CF_FunctionString required
KmsKeyArn string | Aws_CF_FunctionString

The Amazon KMS key required to decrypt the contents of the grammar, if any.

GrammarSlotTypeSetting object

Settings required for a slot type based on a grammar that you provide.

Source object

Describes the Amazon S3 bucket name and location for the grammar that is the source for the slot type.

3 nested properties
S3BucketName string | Aws_CF_FunctionString required
S3ObjectKey string | Aws_CF_FunctionString required
KmsKeyArn string | Aws_CF_FunctionString

The Amazon KMS key required to decrypt the contents of the grammar, if any.

ExternalSourceSetting object

Provides information about the external source of the slot type's definition.

GrammarSlotTypeSetting object

Settings required for a slot type based on a grammar that you provide.

1 nested properties
Source object

Describes the Amazon S3 bucket name and location for the grammar that is the source for the slot type.

3 nested properties
S3BucketName string | Aws_CF_FunctionString required
S3ObjectKey string | Aws_CF_FunctionString required
KmsKeyArn string | Aws_CF_FunctionString

The Amazon KMS key required to decrypt the contents of the grammar, if any.

SlotType object

A custom, extended built-in or a grammar slot type.

Name string | Aws_CF_FunctionString required

Unique name for a resource.

Description string | Aws_CF_FunctionString

A description of the resource

ParentSlotTypeSignature string | Aws_CF_FunctionString

The built-in slot type used as a parent of this slot type.

SlotTypeValues SlotTypeValue[]

A List of slot type values

maxItems=10000
ValueSelectionSetting object

Contains settings used by Amazon Lex to select a slot value.

3 nested properties
ResolutionStrategy string | Aws_CF_FunctionString required
RegexFilter object

A regular expression used to validate the value of a slot.

1 nested properties
Pattern string | Aws_CF_FunctionString required

Regex pattern

AdvancedRecognitionSetting object

Provides settings that enable advanced recognition settings for slot values.

1 nested properties
AudioRecognitionStrategy string | Aws_CF_FunctionString

Enables using slot values as a custom vocabulary when recognizing user utterances.

ExternalSourceSetting object

Provides information about the external source of the slot type's definition.

1 nested properties
GrammarSlotTypeSetting object

Settings required for a slot type based on a grammar that you provide.

1 nested properties
Source object

Describes the Amazon S3 bucket name and location for the grammar that is the source for the slot type.

CustomVocabularyItem object

A custom vocabulary item that contains the phrase to recognize and a weight to give the boost.

Phrase string | Aws_CF_FunctionString required

Phrase that should be recognized.

Weight integer

The degree to which the phrase recognition is boosted. The weight 0 means that no boosting will be applied and the entry will only be used for performing replacements using the displayAs field.

min=0max=3
DisplayAs string | Aws_CF_FunctionString

Defines how you want your phrase to look in your transcription output.

CustomVocabularyItems CustomVocabularyItem[]
CustomVocabulary object

A custom vocabulary is a list of specific phrases that you want Amazon Lex V2 to recognize in the audio input.

CustomVocabularyItems CustomVocabularyItem[] required
maxItems=500uniqueItems=true
SlotDefaultValue object

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

DefaultValue string | Aws_CF_FunctionString required

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

SlotDefaultValueSpecification object

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

DefaultValueList SlotDefaultValue[] required

A list of slot default values

maxItems=10
SlotConstraint string | Aws_CF_FunctionString
WaitAndContinueSpecification object

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

WaitingResponse object required

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

2 nested properties
MessageGroupsList MessageGroup[] required

One to 5 message groups that contain update messages. Amazon Lex chooses one of the messages to play to the user.

minItems=1maxItems=5
AllowInterrupt boolean

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

ContinueResponse object required

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

2 nested properties
MessageGroupsList MessageGroup[] required

One to 5 message groups that contain update messages. Amazon Lex chooses one of the messages to play to the user.

minItems=1maxItems=5
AllowInterrupt boolean

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

StillWaitingResponse object

StillWaitingResponseSpecification.

4 nested properties
MessageGroupsList MessageGroup[] required

One to 5 message groups that contain update messages. Amazon Lex chooses one of the messages to play to the user.

minItems=1maxItems=5
FrequencyInSeconds integer required

How often a message should be sent to the user in seconds.

min=1max=300
TimeoutInSeconds integer required

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

min=1max=900
AllowInterrupt boolean

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

IsActive boolean

Specifies whether the bot will wait for a user to respond.

SlotValueElicitationSetting object

Settings that you can use for eliciting a slot value.

SlotConstraint string | Aws_CF_FunctionString required
DefaultValueSpecification object

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

1 nested properties
DefaultValueList SlotDefaultValue[] required

A list of slot default values

maxItems=10
PromptSpecification object

Prompts the user to confirm the intent.

5 nested properties
MessageGroupsList MessageGroup[] required

One to 5 message groups that contain update messages. Amazon Lex chooses one of the messages to play to the user.

minItems=1maxItems=5
MaxRetries integer required

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

min=0max=5
AllowInterrupt boolean

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

MessageSelectionStrategy string | Aws_CF_FunctionString

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

PromptAttemptsSpecification object

Specifies the advanced settings on each attempt of the prompt.

SampleUtterances SampleUtterance[]

An array of sample utterances

WaitAndContinueSpecification object

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

4 nested properties
WaitingResponse object required

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

2 nested properties
MessageGroupsList MessageGroup[] required

One to 5 message groups that contain update messages. Amazon Lex chooses one of the messages to play to the user.

minItems=1maxItems=5
AllowInterrupt boolean

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

ContinueResponse object required

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

2 nested properties
MessageGroupsList MessageGroup[] required

One to 5 message groups that contain update messages. Amazon Lex chooses one of the messages to play to the user.

minItems=1maxItems=5
AllowInterrupt boolean

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

StillWaitingResponse object

StillWaitingResponseSpecification.

4 nested properties
MessageGroupsList MessageGroup[] required

One to 5 message groups that contain update messages. Amazon Lex chooses one of the messages to play to the user.

minItems=1maxItems=5
FrequencyInSeconds integer required

How often a message should be sent to the user in seconds.

min=1max=300
TimeoutInSeconds integer required

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

min=1max=900
AllowInterrupt boolean

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

IsActive boolean

Specifies whether the bot will wait for a user to respond.

SlotCaptureSetting object

Settings used when Amazon Lex successfully captures a slot value from a user.

8 nested properties
CaptureResponse object

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

2 nested properties
MessageGroupsList MessageGroup[] required

One to 5 message groups that contain update messages. Amazon Lex chooses one of the messages to play to the user.

minItems=1maxItems=5
AllowInterrupt boolean

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

CaptureNextStep object

The current state of the conversation with the user.

3 nested properties
DialogAction object

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

Intent object

Override settings to configure the intent state.

SessionAttributes SessionAttribute[]

List of session attributes to be applied when the conversation reaches this step.

CaptureConditional object

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.

3 nested properties
IsActive boolean required

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

ConditionalBranches ConditionalBranch[] required

A list of 1 to 4 conditional branches to fork the conversation flow.

minItems=1maxItems=4
DefaultBranch object required

A set of actions that Amazon Lex should run if none of the other conditions are met.

FailureResponse object

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

2 nested properties
MessageGroupsList MessageGroup[] required

One to 5 message groups that contain update messages. Amazon Lex chooses one of the messages to play to the user.

minItems=1maxItems=5
AllowInterrupt boolean

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

FailureNextStep object

The current state of the conversation with the user.

3 nested properties
DialogAction object

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

Intent object

Override settings to configure the intent state.

SessionAttributes SessionAttribute[]

List of session attributes to be applied when the conversation reaches this step.

FailureConditional object

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.

3 nested properties
IsActive boolean required

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

ConditionalBranches ConditionalBranch[] required

A list of 1 to 4 conditional branches to fork the conversation flow.

minItems=1maxItems=4
DefaultBranch object required

A set of actions that Amazon Lex should run if none of the other conditions are met.

CodeHook object

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

4 nested properties
EnableCodeHookInvocation boolean required

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

IsActive boolean required

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

PostCodeHookSpecification object required

Specifies next steps to run after the dialog code hook finishes.

InvocationLabel string | Aws_CF_FunctionString

Unique name for a resource.

ElicitationCodeHook object

Settings that specify the dialog code hook that is called by Amazon Lex between eliciting slot values.

2 nested properties
EnableCodeHookInvocation boolean required

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

InvocationLabel string | Aws_CF_FunctionString

Unique name for a resource.

ObfuscationSetting object

Determines whether Amazon Lex obscures slot values in conversation logs.

ObfuscationSettingType string | Aws_CF_FunctionString required

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

MultipleValuesSetting object

Indicates whether a slot can return multiple values.

AllowMultipleValues boolean
Slot object

A slot is a variable needed to fulfill an intent, where an intent can require zero or more slots.

Name string | Aws_CF_FunctionString required

Unique name for a resource.

SlotTypeName string | Aws_CF_FunctionString required

The slot type name that is used in the slot. Allows for custom and built-in slot type names

ValueElicitationSetting object required

Settings that you can use for eliciting a slot value.

6 nested properties
SlotConstraint string | Aws_CF_FunctionString required
DefaultValueSpecification object

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

1 nested properties
DefaultValueList SlotDefaultValue[] required

A list of slot default values

maxItems=10
PromptSpecification object

Prompts the user to confirm the intent.

5 nested properties
MessageGroupsList MessageGroup[] required

One to 5 message groups that contain update messages. Amazon Lex chooses one of the messages to play to the user.

minItems=1maxItems=5
MaxRetries integer required

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

min=0max=5
AllowInterrupt boolean

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

MessageSelectionStrategy string | Aws_CF_FunctionString

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

PromptAttemptsSpecification object

Specifies the advanced settings on each attempt of the prompt.

SampleUtterances SampleUtterance[]

An array of sample utterances

WaitAndContinueSpecification object

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

4 nested properties
WaitingResponse object required

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

ContinueResponse object required

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

StillWaitingResponse object

StillWaitingResponseSpecification.

IsActive boolean

Specifies whether the bot will wait for a user to respond.

SlotCaptureSetting object

Settings used when Amazon Lex successfully captures a slot value from a user.

8 nested properties
CaptureResponse object

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

CaptureNextStep object

The current state of the conversation with the user.

CaptureConditional object

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.

FailureResponse object

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

FailureNextStep object

The current state of the conversation with the user.

FailureConditional object

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.

CodeHook object

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

ElicitationCodeHook object

Settings that specify the dialog code hook that is called by Amazon Lex between eliciting slot values.

Description string | Aws_CF_FunctionString

A description of the resource

ObfuscationSetting object

Determines whether Amazon Lex obscures slot values in conversation logs.

1 nested properties
ObfuscationSettingType string | Aws_CF_FunctionString required

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

MultipleValuesSetting object

Indicates whether a slot can return multiple values.

1 nested properties
AllowMultipleValues boolean
BotLocale object

A locale in the bot, which contains the intents and slot types that the bot uses in conversations with users in the specified language and locale.

LocaleId string | Aws_CF_FunctionString required

The identifier of the language and locale that the bot will be used in.

NluConfidenceThreshold number required

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

min=0max=1
Description string | Aws_CF_FunctionString

A description of the resource

VoiceSettings object

Settings for using an Amazon Polly voice to communicate with a user.

2 nested properties
VoiceId string | Aws_CF_FunctionString required

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

Engine string | Aws_CF_FunctionString

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.

Intents Intent[]

List of intents

maxItems=1000uniqueItems=true
SlotTypes SlotType[]

List of SlotTypes

maxItems=250uniqueItems=true
CustomVocabulary object

A custom vocabulary is a list of specific phrases that you want Amazon Lex V2 to recognize in the audio input.

1 nested properties
CustomVocabularyItems CustomVocabularyItem[] required
maxItems=500uniqueItems=true
S3Location object

S3 location of bot definitions zip file, if it's not defined inline in CloudFormation.

S3Bucket string | Aws_CF_FunctionString required
S3ObjectKey string | Aws_CF_FunctionString required
S3ObjectVersion string | Aws_CF_FunctionString

For versioned objects, the version of the deployment package object to use. If not specified, the current object version will be used.

Condition object

Provides an expression that evaluates to true or false.

ExpressionString string | Aws_CF_FunctionString required

Expression that is evaluated to true or false at runtime.

Conditional object

Contains conditional branches to fork the conversation flow.

IsActive boolean required
ConditionalBranches ConditionalBranch[] required

A list of 1 to 4 conditional branches to fork the conversation flow.

minItems=1maxItems=4
ConditionalSpecification object

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.

IsActive boolean required

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

ConditionalBranches ConditionalBranch[] required

A list of 1 to 4 conditional branches to fork the conversation flow.

minItems=1maxItems=4
DefaultBranch object required

A set of actions that Amazon Lex should run if none of the other conditions are met.

2 nested properties
NextStep object

The current state of the conversation with the user.

3 nested properties
DialogAction object

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

Intent object

Override settings to configure the intent state.

SessionAttributes SessionAttribute[]

List of session attributes to be applied when the conversation reaches this step.

Response object

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

2 nested properties
MessageGroupsList MessageGroup[] required

One to 5 message groups that contain update messages. Amazon Lex chooses one of the messages to play to the user.

minItems=1maxItems=5
AllowInterrupt boolean

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

DefaultConditionalBranch object

A set of actions that Amazon Lex should run if none of the other conditions are met.

NextStep object

The current state of the conversation with the user.

3 nested properties
DialogAction object

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

3 nested properties
Type string | Aws_CF_FunctionString required

The possible values of actions that the conversation can take.

SlotToElicit string | Aws_CF_FunctionString

Unique name for a resource.

SuppressNextMessage boolean

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

Intent object

Override settings to configure the intent state.

2 nested properties
Name string | Aws_CF_FunctionString

Unique name for a resource.

A map of all of the slot value overrides for the intent.

SessionAttributes SessionAttribute[]

List of session attributes to be applied when the conversation reaches this step.

Response object

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

2 nested properties
MessageGroupsList MessageGroup[] required

One to 5 message groups that contain update messages. Amazon Lex chooses one of the messages to play to the user.

minItems=1maxItems=5
AllowInterrupt boolean

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

ConditionalBranch object

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

Name string | Aws_CF_FunctionString required

Unique name for a resource.

Condition object required

Provides an expression that evaluates to true or false.

1 nested properties
ExpressionString string | Aws_CF_FunctionString required

Expression that is evaluated to true or false at runtime.

NextStep object required

The current state of the conversation with the user.

3 nested properties
DialogAction object

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

3 nested properties
Type string | Aws_CF_FunctionString required

The possible values of actions that the conversation can take.

SlotToElicit string | Aws_CF_FunctionString

Unique name for a resource.

SuppressNextMessage boolean

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

Intent object

Override settings to configure the intent state.

2 nested properties
Name string | Aws_CF_FunctionString

Unique name for a resource.

A map of all of the slot value overrides for the intent.

SessionAttributes SessionAttribute[]

List of session attributes to be applied when the conversation reaches this step.

Response object

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

2 nested properties
MessageGroupsList MessageGroup[] required

One to 5 message groups that contain update messages. Amazon Lex chooses one of the messages to play to the user.

minItems=1maxItems=5
AllowInterrupt boolean

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

ConditionalBranches ConditionalBranch[]

A list of 1 to 4 conditional branches to fork the conversation flow.

InitialResponseSetting object

Configuration setting for a response sent to the user before Amazon Lex starts eliciting slots.

InitialResponse object

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

2 nested properties
MessageGroupsList MessageGroup[] required

One to 5 message groups that contain update messages. Amazon Lex chooses one of the messages to play to the user.

minItems=1maxItems=5
AllowInterrupt boolean

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

NextStep object

The current state of the conversation with the user.

3 nested properties
DialogAction object

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

3 nested properties
Type string | Aws_CF_FunctionString required

The possible values of actions that the conversation can take.

SlotToElicit string | Aws_CF_FunctionString

Unique name for a resource.

SuppressNextMessage boolean

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

Intent object

Override settings to configure the intent state.

2 nested properties
Name string | Aws_CF_FunctionString

Unique name for a resource.

A map of all of the slot value overrides for the intent.

SessionAttributes SessionAttribute[]

List of session attributes to be applied when the conversation reaches this step.

Conditional object

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.

3 nested properties
IsActive boolean required

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

ConditionalBranches ConditionalBranch[] required

A list of 1 to 4 conditional branches to fork the conversation flow.

minItems=1maxItems=4
DefaultBranch object required

A set of actions that Amazon Lex should run if none of the other conditions are met.

2 nested properties
NextStep object

The current state of the conversation with the user.

Response object

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

CodeHook object

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

4 nested properties
EnableCodeHookInvocation boolean required

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

IsActive boolean required

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

PostCodeHookSpecification object required

Specifies next steps to run after the dialog code hook finishes.

9 nested properties
SuccessResponse object

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

SuccessNextStep object

The current state of the conversation with the user.

SuccessConditional object

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.

FailureResponse object

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

FailureNextStep object

The current state of the conversation with the user.

FailureConditional object

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.

TimeoutResponse object

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

TimeoutNextStep object

The current state of the conversation with the user.

TimeoutConditional object

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.

InvocationLabel string | Aws_CF_FunctionString

Unique name for a resource.

ConditionExpression string | Aws_CF_FunctionString

Expression that is evaluated to true or false at runtime.

DialogCodeHookInvocationSetting object

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.

IsActive boolean required

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

PostCodeHookSpecification object required

Specifies next steps to run after the dialog code hook finishes.

9 nested properties
SuccessResponse object

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

2 nested properties
MessageGroupsList MessageGroup[] required

One to 5 message groups that contain update messages. Amazon Lex chooses one of the messages to play to the user.

minItems=1maxItems=5
AllowInterrupt boolean

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

SuccessNextStep object

The current state of the conversation with the user.

3 nested properties
DialogAction object

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

Intent object

Override settings to configure the intent state.

SessionAttributes SessionAttribute[]

List of session attributes to be applied when the conversation reaches this step.

SuccessConditional object

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.

3 nested properties
IsActive boolean required

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

ConditionalBranches ConditionalBranch[] required

A list of 1 to 4 conditional branches to fork the conversation flow.

minItems=1maxItems=4
DefaultBranch object required

A set of actions that Amazon Lex should run if none of the other conditions are met.

FailureResponse object

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

2 nested properties
MessageGroupsList MessageGroup[] required

One to 5 message groups that contain update messages. Amazon Lex chooses one of the messages to play to the user.

minItems=1maxItems=5
AllowInterrupt boolean

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

FailureNextStep object

The current state of the conversation with the user.

3 nested properties
DialogAction object

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

Intent object

Override settings to configure the intent state.

SessionAttributes SessionAttribute[]

List of session attributes to be applied when the conversation reaches this step.

FailureConditional object

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.

3 nested properties
IsActive boolean required

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

ConditionalBranches ConditionalBranch[] required

A list of 1 to 4 conditional branches to fork the conversation flow.

minItems=1maxItems=4
DefaultBranch object required

A set of actions that Amazon Lex should run if none of the other conditions are met.

TimeoutResponse object

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

2 nested properties
MessageGroupsList MessageGroup[] required

One to 5 message groups that contain update messages. Amazon Lex chooses one of the messages to play to the user.

minItems=1maxItems=5
AllowInterrupt boolean

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

TimeoutNextStep object

The current state of the conversation with the user.

3 nested properties
DialogAction object

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

Intent object

Override settings to configure the intent state.

SessionAttributes SessionAttribute[]

List of session attributes to be applied when the conversation reaches this step.

TimeoutConditional object

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.

3 nested properties
IsActive boolean required

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

ConditionalBranches ConditionalBranch[] required

A list of 1 to 4 conditional branches to fork the conversation flow.

minItems=1maxItems=4
DefaultBranch object required

A set of actions that Amazon Lex should run if none of the other conditions are met.

InvocationLabel string | Aws_CF_FunctionString

Unique name for a resource.

ElicitationCodeHookInvocationSetting object

Settings that specify the dialog code hook that is called by Amazon Lex between eliciting slot values.

EnableCodeHookInvocation boolean required

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

InvocationLabel string | Aws_CF_FunctionString

Unique name for a resource.

PostDialogCodeHookInvocationSpecification object

Specifies next steps to run after the dialog code hook finishes.

SuccessResponse object

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

2 nested properties
MessageGroupsList MessageGroup[] required

One to 5 message groups that contain update messages. Amazon Lex chooses one of the messages to play to the user.

minItems=1maxItems=5
AllowInterrupt boolean

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

SuccessNextStep object

The current state of the conversation with the user.

3 nested properties
DialogAction object

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

3 nested properties
Type string | Aws_CF_FunctionString required

The possible values of actions that the conversation can take.

SlotToElicit string | Aws_CF_FunctionString

Unique name for a resource.

SuppressNextMessage boolean

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

Intent object

Override settings to configure the intent state.

2 nested properties
Name string | Aws_CF_FunctionString

Unique name for a resource.

A map of all of the slot value overrides for the intent.

SessionAttributes SessionAttribute[]

List of session attributes to be applied when the conversation reaches this step.

SuccessConditional object

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.

3 nested properties
IsActive boolean required

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

ConditionalBranches ConditionalBranch[] required

A list of 1 to 4 conditional branches to fork the conversation flow.

minItems=1maxItems=4
DefaultBranch object required

A set of actions that Amazon Lex should run if none of the other conditions are met.

2 nested properties
NextStep object

The current state of the conversation with the user.

Response object

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

FailureResponse object

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

2 nested properties
MessageGroupsList MessageGroup[] required

One to 5 message groups that contain update messages. Amazon Lex chooses one of the messages to play to the user.

minItems=1maxItems=5
AllowInterrupt boolean

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

FailureNextStep object

The current state of the conversation with the user.

3 nested properties
DialogAction object

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

3 nested properties
Type string | Aws_CF_FunctionString required

The possible values of actions that the conversation can take.

SlotToElicit string | Aws_CF_FunctionString

Unique name for a resource.

SuppressNextMessage boolean

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

Intent object

Override settings to configure the intent state.

2 nested properties
Name string | Aws_CF_FunctionString

Unique name for a resource.

A map of all of the slot value overrides for the intent.

SessionAttributes SessionAttribute[]

List of session attributes to be applied when the conversation reaches this step.

FailureConditional object

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.

3 nested properties
IsActive boolean required

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

ConditionalBranches ConditionalBranch[] required

A list of 1 to 4 conditional branches to fork the conversation flow.

minItems=1maxItems=4
DefaultBranch object required

A set of actions that Amazon Lex should run if none of the other conditions are met.

2 nested properties
NextStep object

The current state of the conversation with the user.

Response object

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

TimeoutResponse object

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

2 nested properties
MessageGroupsList MessageGroup[] required

One to 5 message groups that contain update messages. Amazon Lex chooses one of the messages to play to the user.

minItems=1maxItems=5
AllowInterrupt boolean

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

TimeoutNextStep object

The current state of the conversation with the user.

3 nested properties
DialogAction object

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

3 nested properties
Type string | Aws_CF_FunctionString required

The possible values of actions that the conversation can take.

SlotToElicit string | Aws_CF_FunctionString

Unique name for a resource.

SuppressNextMessage boolean

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

Intent object

Override settings to configure the intent state.

2 nested properties
Name string | Aws_CF_FunctionString

Unique name for a resource.

A map of all of the slot value overrides for the intent.

SessionAttributes SessionAttribute[]

List of session attributes to be applied when the conversation reaches this step.

TimeoutConditional object

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.

3 nested properties
IsActive boolean required

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

ConditionalBranches ConditionalBranch[] required

A list of 1 to 4 conditional branches to fork the conversation flow.

minItems=1maxItems=4
DefaultBranch object required

A set of actions that Amazon Lex should run if none of the other conditions are met.

2 nested properties
NextStep object

The current state of the conversation with the user.

Response object

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

DialogState object

The current state of the conversation with the user.

DialogAction object

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

3 nested properties
Type string | Aws_CF_FunctionString required

The possible values of actions that the conversation can take.

SlotToElicit string | Aws_CF_FunctionString

Unique name for a resource.

SuppressNextMessage boolean

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

Intent object

Override settings to configure the intent state.

2 nested properties
Name string | Aws_CF_FunctionString

Unique name for a resource.

A map of all of the slot value overrides for the intent.

SessionAttributes SessionAttribute[]

List of session attributes to be applied when the conversation reaches this step.

DialogAction object

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

Type string | Aws_CF_FunctionString required

The possible values of actions that the conversation can take.

SlotToElicit string | Aws_CF_FunctionString

Unique name for a resource.

SuppressNextMessage boolean

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

DialogActionType string | Aws_CF_FunctionString

The possible values of actions that the conversation can take.

SessionAttribute object

Key/value pair representing session-specific context information. It contains application information passed between Amazon Lex and a client application.

Key string | Aws_CF_FunctionString required
Value string | Aws_CF_FunctionString
IntentOverride object

Override settings to configure the intent state.

Name string | Aws_CF_FunctionString

Unique name for a resource.

A map of all of the slot value overrides for the intent.

SlotValueOverrideMap object

A map of slot names and their overridden values.

SlotName string | Aws_CF_FunctionString

Unique name for a resource.

SlotValueOverride object

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

3 nested properties
Shape string | Aws_CF_FunctionString

The different shapes that a slot can be in during a conversation.

Value object

The value to set in a slot.

1 nested properties
InterpretedValue string | Aws_CF_FunctionString

The value that Amazon Lex determines for the slot.

An array of values that slots should be set to

SlotValueOverride object

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

Shape string | Aws_CF_FunctionString

The different shapes that a slot can be in during a conversation.

Value object

The value to set in a slot.

1 nested properties
InterpretedValue string | Aws_CF_FunctionString

The value that Amazon Lex determines for the slot.

An array of values that slots should be set to

SlotValue object

The value to set in a slot.

InterpretedValue string | Aws_CF_FunctionString

The value that Amazon Lex determines for the slot.

SlotValues SlotValueOverride[]

An array of values that slots should be set to

SlotShape string | Aws_CF_FunctionString

The different shapes that a slot can be in during a conversation.

SlotCaptureSetting object

Settings used when Amazon Lex successfully captures a slot value from a user.

CaptureResponse object

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

2 nested properties
MessageGroupsList MessageGroup[] required

One to 5 message groups that contain update messages. Amazon Lex chooses one of the messages to play to the user.

minItems=1maxItems=5
AllowInterrupt boolean

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

CaptureNextStep object

The current state of the conversation with the user.

3 nested properties
DialogAction object

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

3 nested properties
Type string | Aws_CF_FunctionString required

The possible values of actions that the conversation can take.

SlotToElicit string | Aws_CF_FunctionString

Unique name for a resource.

SuppressNextMessage boolean

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

Intent object

Override settings to configure the intent state.

2 nested properties
Name string | Aws_CF_FunctionString

Unique name for a resource.

A map of all of the slot value overrides for the intent.

SessionAttributes SessionAttribute[]

List of session attributes to be applied when the conversation reaches this step.

CaptureConditional object

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.

3 nested properties
IsActive boolean required

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

ConditionalBranches ConditionalBranch[] required

A list of 1 to 4 conditional branches to fork the conversation flow.

minItems=1maxItems=4
DefaultBranch object required

A set of actions that Amazon Lex should run if none of the other conditions are met.

2 nested properties
NextStep object

The current state of the conversation with the user.

Response object

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

FailureResponse object

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

2 nested properties
MessageGroupsList MessageGroup[] required

One to 5 message groups that contain update messages. Amazon Lex chooses one of the messages to play to the user.

minItems=1maxItems=5
AllowInterrupt boolean

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

FailureNextStep object

The current state of the conversation with the user.

3 nested properties
DialogAction object

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

3 nested properties
Type string | Aws_CF_FunctionString required

The possible values of actions that the conversation can take.

SlotToElicit string | Aws_CF_FunctionString

Unique name for a resource.

SuppressNextMessage boolean

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

Intent object

Override settings to configure the intent state.

2 nested properties
Name string | Aws_CF_FunctionString

Unique name for a resource.

A map of all of the slot value overrides for the intent.

SessionAttributes SessionAttribute[]

List of session attributes to be applied when the conversation reaches this step.

FailureConditional object

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.

3 nested properties
IsActive boolean required

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

ConditionalBranches ConditionalBranch[] required

A list of 1 to 4 conditional branches to fork the conversation flow.

minItems=1maxItems=4
DefaultBranch object required

A set of actions that Amazon Lex should run if none of the other conditions are met.

2 nested properties
NextStep object

The current state of the conversation with the user.

Response object

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

CodeHook object

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

4 nested properties
EnableCodeHookInvocation boolean required

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

IsActive boolean required

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

PostCodeHookSpecification object required

Specifies next steps to run after the dialog code hook finishes.

9 nested properties
SuccessResponse object

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

SuccessNextStep object

The current state of the conversation with the user.

SuccessConditional object

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.

FailureResponse object

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

FailureNextStep object

The current state of the conversation with the user.

FailureConditional object

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.

TimeoutResponse object

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

TimeoutNextStep object

The current state of the conversation with the user.

TimeoutConditional object

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.

InvocationLabel string | Aws_CF_FunctionString

Unique name for a resource.

ElicitationCodeHook object

Settings that specify the dialog code hook that is called by Amazon Lex between eliciting slot values.

2 nested properties
EnableCodeHookInvocation boolean required

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

InvocationLabel string | Aws_CF_FunctionString

Unique name for a resource.