API version 2016-11-28 of the Amazon Lex Runtime Service SDK configuration.

Either the Amazon Lex bot is still building, or one of the dependent services (Amazon Polly, AWS Lambda) failed with an internal service error.

Request validation failed, there is no usable message in the context, or the bot build failed, is still in progress, or contains unbuilt changes.

Two clients are using the same AWS account, Amazon Lex bot, and user ID.

One of the dependencies, such as AWS Lambda or Amazon Polly, threw an exception. For example,

• If Amazon Lex does not have sufficient permissions to call a Lambda function.
• If a Lambda function takes longer than 30 seconds to execute.
• If a fulfillment Lambda function returns a Delegate dialog action without removing any slot values.

Internal service error. Retry the call.

Exceeded a limit.

This exception is not used.

The accept header in the request does not have a valid value.

The resource (such as the Amazon Lex bot or an alias) that is referred to is not found.

The input speech is too long.

The Content-Type header (PostContent API) has an invalid value.

A context is a variable that contains information about the current state of the conversation between a user and Amazon Lex. Context can be set automatically by Amazon Lex when an intent is fulfilled, or it can be set at runtime using the PutContent, PutText, or PutSession operation.

See: newActiveContext smart constructor.

Create a value of ActiveContext with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:name:ActiveContext', activeContext_name - The name of the context.

$sel:timeToLive:ActiveContext', activeContext_timeToLive - The length of time or number of turns that a context remains active.

$sel:parameters:ActiveContext', activeContext_parameters - State variables for the current context. You can use these values as default values for slots in subsequent events.

The name of the context.

The length of time or number of turns that a context remains active.

State variables for the current context. You can use these values as default values for slots in subsequent events.

The length of time or number of turns that a context remains active.

See: newActiveContextTimeToLive smart constructor.

Create a value of ActiveContextTimeToLive with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:timeToLiveInSeconds:ActiveContextTimeToLive', activeContextTimeToLive_timeToLiveInSeconds - The number of seconds that the context should be active after it is first sent in a PostContent or PostText response. You can set the value between 5 and 86,400 seconds (24 hours).

$sel:turnsToLive:ActiveContextTimeToLive', activeContextTimeToLive_turnsToLive - The number of conversation turns that the context should be active. A conversation turn is one PostContent or PostText request and the corresponding response from Amazon Lex.

The number of seconds that the context should be active after it is first sent in a PostContent or PostText response. You can set the value between 5 and 86,400 seconds (24 hours).

The number of conversation turns that the context should be active. A conversation turn is one PostContent or PostText request and the corresponding response from Amazon Lex.

Represents an option to be shown on the client platform (Facebook, Slack, etc.)

See: newButton smart constructor.

Create a value of Button with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:text:Button', button_text - Text that is visible to the user on the button.

$sel:value:Button', button_value - The value sent to Amazon Lex when a user chooses the button. For example, consider button text "NYC." When the user chooses the button, the value sent can be "New York City."

Text that is visible to the user on the button.

The value sent to Amazon Lex when a user chooses the button. For example, consider button text "NYC." When the user chooses the button, the value sent can be "New York City."

Describes the next action that the bot should take in its interaction with the user and provides information about the context in which the action takes place. Use the DialogAction data type to set the interaction to a specific state, or to return the interaction to a previous state.

See: newDialogAction smart constructor.

Create a value of DialogAction with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:fulfillmentState:DialogAction', dialogAction_fulfillmentState - The fulfillment state of the intent. The possible values are:

• Failed - The Lambda function associated with the intent failed to fulfill the intent.
• Fulfilled - The intent has fulfilled by the Lambda function associated with the intent.
• ReadyForFulfillment - All of the information necessary for the intent is present and the intent ready to be fulfilled by the client application.

$sel:intentName:DialogAction', dialogAction_intentName - The name of the intent.

$sel:message:DialogAction', dialogAction_message - The message that should be shown to the user. If you don't specify a message, Amazon Lex will use the message configured for the intent.

$sel:messageFormat:DialogAction', dialogAction_messageFormat - - PlainText - The message contains plain UTF-8 text.

• CustomPayload - The message is a custom format for the client.
• SSML - The message contains text formatted for voice output.
• Composite - The message contains an escaped JSON object containing one or more messages. For more information, see Message Groups.

$sel:slotToElicit:DialogAction', dialogAction_slotToElicit - The name of the slot that should be elicited from the user.

$sel:slots:DialogAction', dialogAction_slots - Map of the slots that have been gathered and their values.

$sel:type':DialogAction', dialogAction_type - The next action that the bot should take in its interaction with the user. The possible values are:

• ConfirmIntent - The next action is asking the user if the intent is complete and ready to be fulfilled. This is a yes/no question such as "Place the order?"
• Close - Indicates that the there will not be a response from the user. For example, the statement "Your order has been placed" does not require a response.
• Delegate - The next action is determined by Amazon Lex.
• ElicitIntent - The next action is to determine the intent that the user wants to fulfill.
• ElicitSlot - The next action is to elicit a slot value from the user.

The fulfillment state of the intent. The possible values are:

• Failed - The Lambda function associated with the intent failed to fulfill the intent.
• Fulfilled - The intent has fulfilled by the Lambda function associated with the intent.
• ReadyForFulfillment - All of the information necessary for the intent is present and the intent ready to be fulfilled by the client application.

The name of the intent.

The message that should be shown to the user. If you don't specify a message, Amazon Lex will use the message configured for the intent.

• PlainText - The message contains plain UTF-8 text.
• CustomPayload - The message is a custom format for the client.
• SSML - The message contains text formatted for voice output.
• Composite - The message contains an escaped JSON object containing one or more messages. For more information, see Message Groups.

The name of the slot that should be elicited from the user.

Map of the slots that have been gathered and their values.

The next action that the bot should take in its interaction with the user. The possible values are:

• ConfirmIntent - The next action is asking the user if the intent is complete and ready to be fulfilled. This is a yes/no question such as "Place the order?"
• Close - Indicates that the there will not be a response from the user. For example, the statement "Your order has been placed" does not require a response.
• Delegate - The next action is determined by Amazon Lex.
• ElicitIntent - The next action is to determine the intent that the user wants to fulfill.
• ElicitSlot - The next action is to elicit a slot value from the user.

Represents an option rendered to the user when a prompt is shown. It could be an image, a button, a link, or text.

See: newGenericAttachment smart constructor.

Create a value of GenericAttachment with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:attachmentLinkUrl:GenericAttachment', genericAttachment_attachmentLinkUrl - The URL of an attachment to the response card.

$sel:buttons:GenericAttachment', genericAttachment_buttons - The list of options to show to the user.

$sel:imageUrl:GenericAttachment', genericAttachment_imageUrl - The URL of an image that is displayed to the user.

$sel:subTitle:GenericAttachment', genericAttachment_subTitle - The subtitle shown below the title.

$sel:title:GenericAttachment', genericAttachment_title - The title of the option.

The URL of an attachment to the response card.

The list of options to show to the user.

The URL of an image that is displayed to the user.

The subtitle shown below the title.

The title of the option.

Provides a score that indicates the confidence that Amazon Lex has that an intent is the one that satisfies the user's intent.

See: newIntentConfidence smart constructor.

Create a value of IntentConfidence with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:score:IntentConfidence', intentConfidence_score - A score that indicates how confident Amazon Lex is that an intent satisfies the user's intent. Ranges between 0.00 and 1.00. Higher scores indicate higher confidence.

A score that indicates how confident Amazon Lex is that an intent satisfies the user's intent. Ranges between 0.00 and 1.00. Higher scores indicate higher confidence.

Provides information about the state of an intent. You can use this information to get the current state of an intent so that you can process the intent, or so that you can return the intent to its previous state.

See: newIntentSummary smart constructor.

Create a value of IntentSummary with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:checkpointLabel:IntentSummary', intentSummary_checkpointLabel - A user-defined label that identifies a particular intent. You can use this label to return to a previous intent.

Use the checkpointLabelFilter parameter of the GetSessionRequest operation to filter the intents returned by the operation to those with only the specified label.

$sel:confirmationStatus:IntentSummary', intentSummary_confirmationStatus - The status of the intent after the user responds to the confirmation prompt. If the user confirms the intent, Amazon Lex sets this field to Confirmed. If the user denies the intent, Amazon Lex sets this value to Denied. The possible values are:

• Confirmed - The user has responded "Yes" to the confirmation prompt, confirming that the intent is complete and that it is ready to be fulfilled.
• Denied - The user has responded "No" to the confirmation prompt.
• None - The user has never been prompted for confirmation; or, the user was prompted but did not confirm or deny the prompt.

$sel:fulfillmentState:IntentSummary', intentSummary_fulfillmentState - The fulfillment state of the intent. The possible values are:

• Failed - The Lambda function associated with the intent failed to fulfill the intent.
• Fulfilled - The intent has fulfilled by the Lambda function associated with the intent.
• ReadyForFulfillment - All of the information necessary for the intent is present and the intent ready to be fulfilled by the client application.

$sel:intentName:IntentSummary', intentSummary_intentName - The name of the intent.

$sel:slotToElicit:IntentSummary', intentSummary_slotToElicit - The next slot to elicit from the user. If there is not slot to elicit, the field is blank.

$sel:slots:IntentSummary', intentSummary_slots - Map of the slots that have been gathered and their values.

$sel:dialogActionType:IntentSummary', intentSummary_dialogActionType - The next action that the bot should take in its interaction with the user. The possible values are:

• ConfirmIntent - The next action is asking the user if the intent is complete and ready to be fulfilled. This is a yes/no question such as "Place the order?"
• Close - Indicates that the there will not be a response from the user. For example, the statement "Your order has been placed" does not require a response.
• ElicitIntent - The next action is to determine the intent that the user wants to fulfill.
• ElicitSlot - The next action is to elicit a slot value from the user.

A user-defined label that identifies a particular intent. You can use this label to return to a previous intent.

Use the checkpointLabelFilter parameter of the GetSessionRequest operation to filter the intents returned by the operation to those with only the specified label.

The status of the intent after the user responds to the confirmation prompt. If the user confirms the intent, Amazon Lex sets this field to Confirmed. If the user denies the intent, Amazon Lex sets this value to Denied. The possible values are:

• Confirmed - The user has responded "Yes" to the confirmation prompt, confirming that the intent is complete and that it is ready to be fulfilled.
• Denied - The user has responded "No" to the confirmation prompt.
• None - The user has never been prompted for confirmation; or, the user was prompted but did not confirm or deny the prompt.

The fulfillment state of the intent. The possible values are:

• Failed - The Lambda function associated with the intent failed to fulfill the intent.
• Fulfilled - The intent has fulfilled by the Lambda function associated with the intent.
• ReadyForFulfillment - All of the information necessary for the intent is present and the intent ready to be fulfilled by the client application.

The name of the intent.

The next slot to elicit from the user. If there is not slot to elicit, the field is blank.

Map of the slots that have been gathered and their values.

The next action that the bot should take in its interaction with the user. The possible values are:

• ConfirmIntent - The next action is asking the user if the intent is complete and ready to be fulfilled. This is a yes/no question such as "Place the order?"
• Close - Indicates that the there will not be a response from the user. For example, the statement "Your order has been placed" does not require a response.
• ElicitIntent - The next action is to determine the intent that the user wants to fulfill.
• ElicitSlot - The next action is to elicit a slot value from the user.

An intent that Amazon Lex suggests satisfies the user's intent. Includes the name of the intent, the confidence that Amazon Lex has that the user's intent is satisfied, and the slots defined for the intent.

See: newPredictedIntent smart constructor.