End of support notice: On September 15, 2025, AWS will discontinue support for Amazon Lex V1. After September 15, 2025, you will no longer be able to access the Amazon Lex V1 console or Amazon Lex V1 resources. If you are using Amazon Lex V2, refer to the [Amazon Lex V2 guide](https://docs.aws.amazon.com/lexv2/latest/dg/what-is.html) instead. . 

# Data Types
<a name="API_Types"></a>

The following data types are supported by Amazon Lex Model Building Service:
+  [BotAliasMetadata](API_BotAliasMetadata.md) 
+  [BotChannelAssociation](API_BotChannelAssociation.md) 
+  [BotMetadata](API_BotMetadata.md) 
+  [BuiltinIntentMetadata](API_BuiltinIntentMetadata.md) 
+  [BuiltinIntentSlot](API_BuiltinIntentSlot.md) 
+  [BuiltinSlotTypeMetadata](API_BuiltinSlotTypeMetadata.md) 
+  [CodeHook](API_CodeHook.md) 
+  [ConversationLogsRequest](API_ConversationLogsRequest.md) 
+  [ConversationLogsResponse](API_ConversationLogsResponse.md) 
+  [EnumerationValue](API_EnumerationValue.md) 
+  [FollowUpPrompt](API_FollowUpPrompt.md) 
+  [FulfillmentActivity](API_FulfillmentActivity.md) 
+  [InputContext](API_InputContext.md) 
+  [Intent](API_Intent.md) 
+  [IntentMetadata](API_IntentMetadata.md) 
+  [KendraConfiguration](API_KendraConfiguration.md) 
+  [LogSettingsRequest](API_LogSettingsRequest.md) 
+  [LogSettingsResponse](API_LogSettingsResponse.md) 
+  [Message](API_Message.md) 
+  [MigrationAlert](API_MigrationAlert.md) 
+  [MigrationSummary](API_MigrationSummary.md) 
+  [OutputContext](API_OutputContext.md) 
+  [Prompt](API_Prompt.md) 
+  [ResourceReference](API_ResourceReference.md) 
+  [Slot](API_Slot.md) 
+  [SlotDefaultValue](API_SlotDefaultValue.md) 
+  [SlotDefaultValueSpec](API_SlotDefaultValueSpec.md) 
+  [SlotTypeConfiguration](API_SlotTypeConfiguration.md) 
+  [SlotTypeMetadata](API_SlotTypeMetadata.md) 
+  [SlotTypeRegexConfiguration](API_SlotTypeRegexConfiguration.md) 
+  [Statement](API_Statement.md) 
+  [Tag](API_Tag.md) 
+  [UtteranceData](API_UtteranceData.md) 
+  [UtteranceList](API_UtteranceList.md) 

The following data types are supported by Amazon Lex Runtime Service:
+  [ActiveContext](API_runtime_ActiveContext.md) 
+  [ActiveContextTimeToLive](API_runtime_ActiveContextTimeToLive.md) 
+  [Button](API_runtime_Button.md) 
+  [DialogAction](API_runtime_DialogAction.md) 
+  [GenericAttachment](API_runtime_GenericAttachment.md) 
+  [IntentConfidence](API_runtime_IntentConfidence.md) 
+  [IntentSummary](API_runtime_IntentSummary.md) 
+  [PredictedIntent](API_runtime_PredictedIntent.md) 
+  [ResponseCard](API_runtime_ResponseCard.md) 
+  [SentimentResponse](API_runtime_SentimentResponse.md) 

# Amazon Lex Model Building Service
<a name="API_Types_Amazon_Lex_Model_Building_Service"></a>

The following data types are supported by Amazon Lex Model Building Service:
+  [BotAliasMetadata](API_BotAliasMetadata.md) 
+  [BotChannelAssociation](API_BotChannelAssociation.md) 
+  [BotMetadata](API_BotMetadata.md) 
+  [BuiltinIntentMetadata](API_BuiltinIntentMetadata.md) 
+  [BuiltinIntentSlot](API_BuiltinIntentSlot.md) 
+  [BuiltinSlotTypeMetadata](API_BuiltinSlotTypeMetadata.md) 
+  [CodeHook](API_CodeHook.md) 
+  [ConversationLogsRequest](API_ConversationLogsRequest.md) 
+  [ConversationLogsResponse](API_ConversationLogsResponse.md) 
+  [EnumerationValue](API_EnumerationValue.md) 
+  [FollowUpPrompt](API_FollowUpPrompt.md) 
+  [FulfillmentActivity](API_FulfillmentActivity.md) 
+  [InputContext](API_InputContext.md) 
+  [Intent](API_Intent.md) 
+  [IntentMetadata](API_IntentMetadata.md) 
+  [KendraConfiguration](API_KendraConfiguration.md) 
+  [LogSettingsRequest](API_LogSettingsRequest.md) 
+  [LogSettingsResponse](API_LogSettingsResponse.md) 
+  [Message](API_Message.md) 
+  [MigrationAlert](API_MigrationAlert.md) 
+  [MigrationSummary](API_MigrationSummary.md) 
+  [OutputContext](API_OutputContext.md) 
+  [Prompt](API_Prompt.md) 
+  [ResourceReference](API_ResourceReference.md) 
+  [Slot](API_Slot.md) 
+  [SlotDefaultValue](API_SlotDefaultValue.md) 
+  [SlotDefaultValueSpec](API_SlotDefaultValueSpec.md) 
+  [SlotTypeConfiguration](API_SlotTypeConfiguration.md) 
+  [SlotTypeMetadata](API_SlotTypeMetadata.md) 
+  [SlotTypeRegexConfiguration](API_SlotTypeRegexConfiguration.md) 
+  [Statement](API_Statement.md) 
+  [Tag](API_Tag.md) 
+  [UtteranceData](API_UtteranceData.md) 
+  [UtteranceList](API_UtteranceList.md) 

# BotAliasMetadata
<a name="API_BotAliasMetadata"></a>

Provides information about a bot alias.

## Contents
<a name="API_BotAliasMetadata_Contents"></a>

 ** botName **   <a name="lex-Type-BotAliasMetadata-botName"></a>
The name of the bot to which the alias points.  
Type: String  
Length Constraints: Minimum length of 2. Maximum length of 50.  
Pattern: `^([A-Za-z]_?)+$`   
Required: No

 ** botVersion **   <a name="lex-Type-BotAliasMetadata-botVersion"></a>
The version of the Amazon Lex bot to which the alias points.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `\$LATEST|[0-9]+`   
Required: No

 ** checksum **   <a name="lex-Type-BotAliasMetadata-checksum"></a>
Checksum of the bot alias.  
Type: String  
Required: No

 ** conversationLogs **   <a name="lex-Type-BotAliasMetadata-conversationLogs"></a>
Settings that determine how Amazon Lex uses conversation logs for the alias.  
Type: [ConversationLogsResponse](API_ConversationLogsResponse.md) object  
Required: No

 ** createdDate **   <a name="lex-Type-BotAliasMetadata-createdDate"></a>
The date that the bot alias was created.  
Type: Timestamp  
Required: No

 ** description **   <a name="lex-Type-BotAliasMetadata-description"></a>
A description of the bot alias.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 200.  
Required: No

 ** lastUpdatedDate **   <a name="lex-Type-BotAliasMetadata-lastUpdatedDate"></a>
The date that the bot alias was updated. When you create a resource, the creation date and last updated date are the same.  
Type: Timestamp  
Required: No

 ** name **   <a name="lex-Type-BotAliasMetadata-name"></a>
The name of the bot alias.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `^([A-Za-z]_?)+$`   
Required: No

## See Also
<a name="API_BotAliasMetadata_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lex-models-2017-04-19/BotAliasMetadata) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lex-models-2017-04-19/BotAliasMetadata) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lex-models-2017-04-19/BotAliasMetadata) 

# BotChannelAssociation
<a name="API_BotChannelAssociation"></a>

Represents an association between an Amazon Lex bot and an external messaging platform.

## Contents
<a name="API_BotChannelAssociation_Contents"></a>

 ** botAlias **   <a name="lex-Type-BotChannelAssociation-botAlias"></a>
An alias pointing to the specific version of the Amazon Lex bot to which this association is being made.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `^([A-Za-z]_?)+$`   
Required: No

 ** botConfiguration **   <a name="lex-Type-BotChannelAssociation-botConfiguration"></a>
Provides information necessary to communicate with the messaging platform.   
Type: String to string map  
Map Entries: Maximum number of 10 items.  
Required: No

 ** botName **   <a name="lex-Type-BotChannelAssociation-botName"></a>
The name of the Amazon Lex bot to which this association is being made.   
Currently, Amazon Lex supports associations with Facebook and Slack, and Twilio.
Type: String  
Length Constraints: Minimum length of 2. Maximum length of 50.  
Pattern: `^([A-Za-z]_?)+$`   
Required: No

 ** createdDate **   <a name="lex-Type-BotChannelAssociation-createdDate"></a>
The date that the association between the Amazon Lex bot and the channel was created.   
Type: Timestamp  
Required: No

 ** description **   <a name="lex-Type-BotChannelAssociation-description"></a>
A text description of the association you are creating.   
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 200.  
Required: No

 ** failureReason **   <a name="lex-Type-BotChannelAssociation-failureReason"></a>
If `status` is `FAILED`, Amazon Lex provides the reason that it failed to create the association.  
Type: String  
Required: No

 ** name **   <a name="lex-Type-BotChannelAssociation-name"></a>
The name of the association between the bot and the channel.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `^([A-Za-z]_?)+$`   
Required: No

 ** status **   <a name="lex-Type-BotChannelAssociation-status"></a>
The status of the bot channel.   
+  `CREATED` - The channel has been created and is ready for use.
+  `IN_PROGRESS` - Channel creation is in progress.
+  `FAILED` - There was an error creating the channel. For information about the reason for the failure, see the `failureReason` field.
Type: String  
Valid Values: `IN_PROGRESS | CREATED | FAILED`   
Required: No

 ** type **   <a name="lex-Type-BotChannelAssociation-type"></a>
Specifies the type of association by indicating the type of channel being established between the Amazon Lex bot and the external messaging platform.  
Type: String  
Valid Values: `Facebook | Slack | Twilio-Sms | Kik`   
Required: No

## See Also
<a name="API_BotChannelAssociation_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lex-models-2017-04-19/BotChannelAssociation) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lex-models-2017-04-19/BotChannelAssociation) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lex-models-2017-04-19/BotChannelAssociation) 

# BotMetadata
<a name="API_BotMetadata"></a>

Provides information about a bot. .

## Contents
<a name="API_BotMetadata_Contents"></a>

 ** createdDate **   <a name="lex-Type-BotMetadata-createdDate"></a>
The date that the bot was created.  
Type: Timestamp  
Required: No

 ** description **   <a name="lex-Type-BotMetadata-description"></a>
A description of the bot.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 200.  
Required: No

 ** lastUpdatedDate **   <a name="lex-Type-BotMetadata-lastUpdatedDate"></a>
The date that the bot was updated. When you create a bot, the creation date and last updated date are the same.   
Type: Timestamp  
Required: No

 ** name **   <a name="lex-Type-BotMetadata-name"></a>
The name of the bot.   
Type: String  
Length Constraints: Minimum length of 2. Maximum length of 50.  
Pattern: `^([A-Za-z]_?)+$`   
Required: No

 ** status **   <a name="lex-Type-BotMetadata-status"></a>
The status of the bot.  
Type: String  
Valid Values: `BUILDING | READY | READY_BASIC_TESTING | FAILED | NOT_BUILT`   
Required: No

 ** version **   <a name="lex-Type-BotMetadata-version"></a>
The version of the bot. For a new bot, the version is always `$LATEST`.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `\$LATEST|[0-9]+`   
Required: No

## See Also
<a name="API_BotMetadata_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lex-models-2017-04-19/BotMetadata) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lex-models-2017-04-19/BotMetadata) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lex-models-2017-04-19/BotMetadata) 

# BuiltinIntentMetadata
<a name="API_BuiltinIntentMetadata"></a>

Provides metadata for a built-in intent.

## Contents
<a name="API_BuiltinIntentMetadata_Contents"></a>

 ** signature **   <a name="lex-Type-BuiltinIntentMetadata-signature"></a>
A unique identifier for the built-in intent. To find the signature for an intent, see [Standard Built-in Intents](https://developer.amazon.com/public/solutions/alexa/alexa-skills-kit/docs/built-in-intent-ref/standard-intents) in the *Alexa Skills Kit*.  
Type: String  
Required: No

 ** supportedLocales **   <a name="lex-Type-BuiltinIntentMetadata-supportedLocales"></a>
A list of identifiers for the locales that the intent supports.  
Type: Array of strings  
Valid Values: `de-DE | en-AU | en-GB | en-IN | en-US | es-419 | es-ES | es-US | fr-FR | fr-CA | it-IT | ja-JP | ko-KR`   
Required: No

## See Also
<a name="API_BuiltinIntentMetadata_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lex-models-2017-04-19/BuiltinIntentMetadata) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lex-models-2017-04-19/BuiltinIntentMetadata) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lex-models-2017-04-19/BuiltinIntentMetadata) 

# BuiltinIntentSlot
<a name="API_BuiltinIntentSlot"></a>

Provides information about a slot used in a built-in intent.

## Contents
<a name="API_BuiltinIntentSlot_Contents"></a>

 ** name **   <a name="lex-Type-BuiltinIntentSlot-name"></a>
A list of the slots defined for the intent.  
Type: String  
Required: No

## See Also
<a name="API_BuiltinIntentSlot_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lex-models-2017-04-19/BuiltinIntentSlot) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lex-models-2017-04-19/BuiltinIntentSlot) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lex-models-2017-04-19/BuiltinIntentSlot) 

# BuiltinSlotTypeMetadata
<a name="API_BuiltinSlotTypeMetadata"></a>

Provides information about a built in slot type.

## Contents
<a name="API_BuiltinSlotTypeMetadata_Contents"></a>

 ** signature **   <a name="lex-Type-BuiltinSlotTypeMetadata-signature"></a>
A unique identifier for the built-in slot type. To find the signature for a slot type, see [Slot Type Reference](https://developer.amazon.com/public/solutions/alexa/alexa-skills-kit/docs/built-in-intent-ref/slot-type-reference) in the *Alexa Skills Kit*.  
Type: String  
Required: No

 ** supportedLocales **   <a name="lex-Type-BuiltinSlotTypeMetadata-supportedLocales"></a>
A list of target locales for the slot.   
Type: Array of strings  
Valid Values: `de-DE | en-AU | en-GB | en-IN | en-US | es-419 | es-ES | es-US | fr-FR | fr-CA | it-IT | ja-JP | ko-KR`   
Required: No

## See Also
<a name="API_BuiltinSlotTypeMetadata_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lex-models-2017-04-19/BuiltinSlotTypeMetadata) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lex-models-2017-04-19/BuiltinSlotTypeMetadata) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lex-models-2017-04-19/BuiltinSlotTypeMetadata) 

# CodeHook
<a name="API_CodeHook"></a>

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

## Contents
<a name="API_CodeHook_Contents"></a>

 ** messageVersion **   <a name="lex-Type-CodeHook-messageVersion"></a>
The version of the request-response that you want Amazon Lex to use to invoke your Lambda function. For more information, see [Using Lambda Functions](using-lambda.md).  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 5.  
Required: Yes

 ** uri **   <a name="lex-Type-CodeHook-uri"></a>
The Amazon Resource Name (ARN) of the Lambda function.  
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 2048.  
Pattern: `arn:aws[a-zA-Z-]*:lambda:[a-z]+-[a-z]+(-[a-z]+)*-[0-9]:[0-9]{12}:function:[a-zA-Z0-9-_]+(\/[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})?(:[a-zA-Z0-9-_]+)?`   
Required: Yes

## See Also
<a name="API_CodeHook_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lex-models-2017-04-19/CodeHook) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lex-models-2017-04-19/CodeHook) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lex-models-2017-04-19/CodeHook) 

# ConversationLogsRequest
<a name="API_ConversationLogsRequest"></a>

Provides the settings needed for conversation logs.

## Contents
<a name="API_ConversationLogsRequest_Contents"></a>

 ** iamRoleArn **   <a name="lex-Type-ConversationLogsRequest-iamRoleArn"></a>
The Amazon Resource Name (ARN) of an IAM role with permission to write to your CloudWatch Logs for text logs and your S3 bucket for audio logs. If audio encryption is enabled, this role also provides access permission for the AWS KMS key used for encrypting audio logs. For more information, see [Creating an IAM Role and Policy for Conversation Logs](https://docs.aws.amazon.com/lex/latest/dg/conversation-logs-role-and-policy.html).  
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 2048.  
Pattern: `^arn:[\w\-]+:iam::[\d]{12}:role/.+$`   
Required: Yes

 ** logSettings **   <a name="lex-Type-ConversationLogsRequest-logSettings"></a>
The settings for your conversation logs. You can log the conversation text, conversation audio, or both.  
Type: Array of [LogSettingsRequest](API_LogSettingsRequest.md) objects  
Required: Yes

## See Also
<a name="API_ConversationLogsRequest_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lex-models-2017-04-19/ConversationLogsRequest) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lex-models-2017-04-19/ConversationLogsRequest) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lex-models-2017-04-19/ConversationLogsRequest) 

# ConversationLogsResponse
<a name="API_ConversationLogsResponse"></a>

Contains information about conversation log settings.

## Contents
<a name="API_ConversationLogsResponse_Contents"></a>

 ** iamRoleArn **   <a name="lex-Type-ConversationLogsResponse-iamRoleArn"></a>
The Amazon Resource Name (ARN) of the IAM role used to write your logs to CloudWatch Logs or an S3 bucket.  
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 2048.  
Pattern: `^arn:[\w\-]+:iam::[\d]{12}:role/.+$`   
Required: No

 ** logSettings **   <a name="lex-Type-ConversationLogsResponse-logSettings"></a>
The settings for your conversation logs. You can log text, audio, or both.  
Type: Array of [LogSettingsResponse](API_LogSettingsResponse.md) objects  
Required: No

## See Also
<a name="API_ConversationLogsResponse_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lex-models-2017-04-19/ConversationLogsResponse) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lex-models-2017-04-19/ConversationLogsResponse) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lex-models-2017-04-19/ConversationLogsResponse) 

# EnumerationValue
<a name="API_EnumerationValue"></a>

Each slot type can have a set of values. Each enumeration value represents a value the slot type can take. 

For example, a pizza ordering bot could have a slot type that specifies the type of crust that the pizza should have. The slot type could include the values 
+ thick
+ thin
+ stuffed

## Contents
<a name="API_EnumerationValue_Contents"></a>

 ** value **   <a name="lex-Type-EnumerationValue-value"></a>
The value of the slot type.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 140.  
Required: Yes

 ** synonyms **   <a name="lex-Type-EnumerationValue-synonyms"></a>
Additional values related to the slot type value.  
Type: Array of strings  
Length Constraints: Minimum length of 1. Maximum length of 140.  
Required: No

## See Also
<a name="API_EnumerationValue_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lex-models-2017-04-19/EnumerationValue) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lex-models-2017-04-19/EnumerationValue) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lex-models-2017-04-19/EnumerationValue) 

# FollowUpPrompt
<a name="API_FollowUpPrompt"></a>

A prompt for additional activity after an intent is fulfilled. For example, after the `OrderPizza` intent is fulfilled, you might prompt the user to find out whether the user wants to order drinks.

## Contents
<a name="API_FollowUpPrompt_Contents"></a>

 ** prompt **   <a name="lex-Type-FollowUpPrompt-prompt"></a>
Prompts for information from the user.   
Type: [Prompt](API_Prompt.md) object  
Required: Yes

 ** rejectionStatement **   <a name="lex-Type-FollowUpPrompt-rejectionStatement"></a>
If the user answers "no" to the question defined in the `prompt` field, Amazon Lex responds with this statement to acknowledge that the intent was canceled.   
Type: [Statement](API_Statement.md) object  
Required: Yes

## See Also
<a name="API_FollowUpPrompt_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lex-models-2017-04-19/FollowUpPrompt) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lex-models-2017-04-19/FollowUpPrompt) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lex-models-2017-04-19/FollowUpPrompt) 

# FulfillmentActivity
<a name="API_FulfillmentActivity"></a>

 Describes how the intent is fulfilled after the user provides all of the information required for the intent. You can provide a Lambda function to process the intent, or you can return the intent information to the client application. We recommend that you use a Lambda function so that the relevant logic lives in the Cloud and limit the client-side code primarily to presentation. If you need to update the logic, you only update the Lambda function; you don't need to upgrade your client application. 

Consider the following examples:
+ In a pizza ordering application, after the user provides all of the information for placing an order, you use a Lambda function to place an order with a pizzeria. 
+ In a gaming application, when a user says "pick up a rock," this information must go back to the client application so that it can perform the operation and update the graphics. In this case, you want Amazon Lex to return the intent data to the client. 

## Contents
<a name="API_FulfillmentActivity_Contents"></a>

 ** type **   <a name="lex-Type-FulfillmentActivity-type"></a>
 How the intent should be fulfilled, either by running a Lambda function or by returning the slot data to the client application.   
Type: String  
Valid Values: `ReturnIntent | CodeHook`   
Required: Yes

 ** codeHook **   <a name="lex-Type-FulfillmentActivity-codeHook"></a>
 A description of the Lambda function that is run to fulfill the intent.   
Type: [CodeHook](API_CodeHook.md) object  
Required: No

## See Also
<a name="API_FulfillmentActivity_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lex-models-2017-04-19/FulfillmentActivity) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lex-models-2017-04-19/FulfillmentActivity) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lex-models-2017-04-19/FulfillmentActivity) 

# InputContext
<a name="API_InputContext"></a>

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

## Contents
<a name="API_InputContext_Contents"></a>

 ** name **   <a name="lex-Type-InputContext-name"></a>
The name of the context.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `^([A-Za-z]_?)+$`   
Required: Yes

## See Also
<a name="API_InputContext_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lex-models-2017-04-19/InputContext) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lex-models-2017-04-19/InputContext) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lex-models-2017-04-19/InputContext) 

# Intent
<a name="API_Intent"></a>

Identifies the specific version of an intent.

## Contents
<a name="API_Intent_Contents"></a>

 ** intentName **   <a name="lex-Type-Intent-intentName"></a>
The name of the intent.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `^([A-Za-z]_?)+$`   
Required: Yes

 ** intentVersion **   <a name="lex-Type-Intent-intentVersion"></a>
The version of the intent.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `\$LATEST|[0-9]+`   
Required: Yes

## See Also
<a name="API_Intent_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lex-models-2017-04-19/Intent) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lex-models-2017-04-19/Intent) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lex-models-2017-04-19/Intent) 

# IntentMetadata
<a name="API_IntentMetadata"></a>

Provides information about an intent.

## Contents
<a name="API_IntentMetadata_Contents"></a>

 ** createdDate **   <a name="lex-Type-IntentMetadata-createdDate"></a>
The date that the intent was created.  
Type: Timestamp  
Required: No

 ** description **   <a name="lex-Type-IntentMetadata-description"></a>
A description of the intent.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 200.  
Required: No

 ** lastUpdatedDate **   <a name="lex-Type-IntentMetadata-lastUpdatedDate"></a>
The date that the intent was updated. When you create an intent, the creation date and last updated date are the same.  
Type: Timestamp  
Required: No

 ** name **   <a name="lex-Type-IntentMetadata-name"></a>
The name of the intent.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `^([A-Za-z]_?)+$`   
Required: No

 ** version **   <a name="lex-Type-IntentMetadata-version"></a>
The version of the intent.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `\$LATEST|[0-9]+`   
Required: No

## See Also
<a name="API_IntentMetadata_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lex-models-2017-04-19/IntentMetadata) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lex-models-2017-04-19/IntentMetadata) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lex-models-2017-04-19/IntentMetadata) 

# KendraConfiguration
<a name="API_KendraConfiguration"></a>

Provides configuration information for the AMAZON.KendraSearchIntent intent. When you use this intent, Amazon Lex searches the specified Amazon Kendra index and returns documents from the index that match the user's utterance. For more information, see [ AMAZON.KendraSearchIntent](http://docs.aws.amazon.com/lex/latest/dg/built-in-intent-kendra-search.html).

## Contents
<a name="API_KendraConfiguration_Contents"></a>

 ** kendraIndex **   <a name="lex-Type-KendraConfiguration-kendraIndex"></a>
The Amazon Resource Name (ARN) of the Amazon Kendra index that you want the AMAZON.KendraSearchIntent intent to search. The index must be in the same account and Region as the Amazon Lex bot. If the Amazon Kendra index does not exist, you get an exception when you call the `PutIntent` operation.  
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 2048.  
Pattern: `arn:aws:kendra:[a-z]+-[a-z]+-[0-9]:[0-9]{12}:index\/[a-zA-Z0-9][a-zA-Z0-9_-]*`   
Required: Yes

 ** role **   <a name="lex-Type-KendraConfiguration-role"></a>
The Amazon Resource Name (ARN) of an IAM role that has permission to search the Amazon Kendra index. The role must be in the same account and Region as the Amazon Lex bot. If the role does not exist, you get an exception when you call the `PutIntent` operation.  
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 2048.  
Pattern: `arn:aws:iam::[0-9]{12}:role/.*`   
Required: Yes

 ** queryFilterString **   <a name="lex-Type-KendraConfiguration-queryFilterString"></a>
A query filter that Amazon Lex sends to Amazon Kendra to filter the response from the query. The filter is in the format defined by Amazon Kendra. For more information, see [Filtering queries](http://docs.aws.amazon.com/kendra/latest/dg/filtering.html).  
You can override this filter string with a new filter string at runtime.  
Type: String  
Length Constraints: Minimum length of 0.  
Required: No

## See Also
<a name="API_KendraConfiguration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lex-models-2017-04-19/KendraConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lex-models-2017-04-19/KendraConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lex-models-2017-04-19/KendraConfiguration) 

# LogSettingsRequest
<a name="API_LogSettingsRequest"></a>

Settings used to configure delivery mode and destination for conversation logs.

## Contents
<a name="API_LogSettingsRequest_Contents"></a>

 ** destination **   <a name="lex-Type-LogSettingsRequest-destination"></a>
Where the logs will be delivered. Text logs are delivered to a CloudWatch Logs log group. Audio logs are delivered to an S3 bucket.  
Type: String  
Valid Values: `CLOUDWATCH_LOGS | S3`   
Required: Yes

 ** logType **   <a name="lex-Type-LogSettingsRequest-logType"></a>
The type of logging to enable. Text logs are delivered to a CloudWatch Logs log group. Audio logs are delivered to an S3 bucket.  
Type: String  
Valid Values: `AUDIO | TEXT`   
Required: Yes

 ** resourceArn **   <a name="lex-Type-LogSettingsRequest-resourceArn"></a>
The Amazon Resource Name (ARN) of the CloudWatch Logs log group or S3 bucket where the logs should be delivered.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `^arn:[\w\-]+:(?:logs:[\w\-]+:[\d]{12}:log-group:[\.\-_/#A-Za-z0-9]{1,512}(?::\*)?|s3:::[a-z0-9][\.\-a-z0-9]{1,61}[a-z0-9])$`   
Required: Yes

 ** kmsKeyArn **   <a name="lex-Type-LogSettingsRequest-kmsKeyArn"></a>
The Amazon Resource Name (ARN) of the AWS KMS customer managed key for encrypting audio logs delivered to an S3 bucket. The key does not apply to CloudWatch Logs and is optional for S3 buckets.  
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 2048.  
Pattern: `^arn:[\w\-]+:kms:[\w\-]+:[\d]{12}:(?:key\/[\w\-]+|alias\/[a-zA-Z0-9:\/_\-]{1,256})$`   
Required: No

## See Also
<a name="API_LogSettingsRequest_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lex-models-2017-04-19/LogSettingsRequest) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lex-models-2017-04-19/LogSettingsRequest) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lex-models-2017-04-19/LogSettingsRequest) 

# LogSettingsResponse
<a name="API_LogSettingsResponse"></a>

The settings for conversation logs.

## Contents
<a name="API_LogSettingsResponse_Contents"></a>

 ** destination **   <a name="lex-Type-LogSettingsResponse-destination"></a>
The destination where logs are delivered.  
Type: String  
Valid Values: `CLOUDWATCH_LOGS | S3`   
Required: No

 ** kmsKeyArn **   <a name="lex-Type-LogSettingsResponse-kmsKeyArn"></a>
The Amazon Resource Name (ARN) of the key used to encrypt audio logs in an S3 bucket.  
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 2048.  
Pattern: `^arn:[\w\-]+:kms:[\w\-]+:[\d]{12}:(?:key\/[\w\-]+|alias\/[a-zA-Z0-9:\/_\-]{1,256})$`   
Required: No

 ** logType **   <a name="lex-Type-LogSettingsResponse-logType"></a>
The type of logging that is enabled.  
Type: String  
Valid Values: `AUDIO | TEXT`   
Required: No

 ** resourceArn **   <a name="lex-Type-LogSettingsResponse-resourceArn"></a>
The Amazon Resource Name (ARN) of the CloudWatch Logs log group or S3 bucket where the logs are delivered.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `^arn:[\w\-]+:(?:logs:[\w\-]+:[\d]{12}:log-group:[\.\-_/#A-Za-z0-9]{1,512}(?::\*)?|s3:::[a-z0-9][\.\-a-z0-9]{1,61}[a-z0-9])$`   
Required: No

 ** resourcePrefix **   <a name="lex-Type-LogSettingsResponse-resourcePrefix"></a>
The resource prefix is the first part of the S3 object key within the S3 bucket that you specified to contain audio logs. For CloudWatch Logs it is the prefix of the log stream name within the log group that you specified.   
Type: String  
Length Constraints: Maximum length of 1024.  
Required: No

## See Also
<a name="API_LogSettingsResponse_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lex-models-2017-04-19/LogSettingsResponse) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lex-models-2017-04-19/LogSettingsResponse) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lex-models-2017-04-19/LogSettingsResponse) 

# Message
<a name="API_Message"></a>

The message object that provides the message text and its type.

## Contents
<a name="API_Message_Contents"></a>

 ** content **   <a name="lex-Type-Message-content"></a>
The text of the message.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1000.  
Required: Yes

 ** contentType **   <a name="lex-Type-Message-contentType"></a>
The content type of the message string.  
Type: String  
Valid Values: `PlainText | SSML | CustomPayload`   
Required: Yes

 ** groupNumber **   <a name="lex-Type-Message-groupNumber"></a>
Identifies the message group that the message belongs to. When a group is assigned to a message, Amazon Lex returns one message from each group in the response.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 5.  
Required: No

## See Also
<a name="API_Message_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lex-models-2017-04-19/Message) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lex-models-2017-04-19/Message) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lex-models-2017-04-19/Message) 

# MigrationAlert
<a name="API_MigrationAlert"></a>

Provides information about alerts and warnings that Amazon Lex sends during a migration. The alerts include information about how to resolve the issue.

## Contents
<a name="API_MigrationAlert_Contents"></a>

 ** details **   <a name="lex-Type-MigrationAlert-details"></a>
Additional details about the alert.  
Type: Array of strings  
Required: No

 ** message **   <a name="lex-Type-MigrationAlert-message"></a>
A message that describes why the alert was issued.  
Type: String  
Required: No

 ** referenceURLs **   <a name="lex-Type-MigrationAlert-referenceURLs"></a>
A link to the Amazon Lex documentation that describes how to resolve the alert.  
Type: Array of strings  
Required: No

 ** type **   <a name="lex-Type-MigrationAlert-type"></a>
The type of alert. There are two kinds of alerts:  
+  `ERROR` - There was an issue with the migration that can't be resolved. The migration stops.
+  `WARN` - There was an issue with the migration that requires manual changes to the new Amazon Lex V2 bot. The migration continues.
Type: String  
Valid Values: `ERROR | WARN`   
Required: No

## See Also
<a name="API_MigrationAlert_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lex-models-2017-04-19/MigrationAlert) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lex-models-2017-04-19/MigrationAlert) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lex-models-2017-04-19/MigrationAlert) 

# MigrationSummary
<a name="API_MigrationSummary"></a>

Provides information about migrating a bot from Amazon Lex V1 to Amazon Lex V2.

## Contents
<a name="API_MigrationSummary_Contents"></a>

 ** migrationId **   <a name="lex-Type-MigrationSummary-migrationId"></a>
The unique identifier that Amazon Lex assigned to the migration.  
Type: String  
Length Constraints: Fixed length of 10.  
Pattern: `^[0-9a-zA-Z]+$`   
Required: No

 ** migrationStatus **   <a name="lex-Type-MigrationSummary-migrationStatus"></a>
The status of the operation. When the status is `COMPLETE` the bot is available in Amazon Lex V2. There may be alerts and warnings that need to be resolved to complete the migration.  
Type: String  
Valid Values: `IN_PROGRESS | COMPLETED | FAILED`   
Required: No

 ** migrationStrategy **   <a name="lex-Type-MigrationSummary-migrationStrategy"></a>
The strategy used to conduct the migration.  
Type: String  
Valid Values: `CREATE_NEW | UPDATE_EXISTING`   
Required: No

 ** migrationTimestamp **   <a name="lex-Type-MigrationSummary-migrationTimestamp"></a>
The date and time that the migration started.  
Type: Timestamp  
Required: No

 ** v1BotLocale **   <a name="lex-Type-MigrationSummary-v1BotLocale"></a>
The locale of the Amazon Lex V1 bot that is the source of the migration.  
Type: String  
Valid Values: `de-DE | en-AU | en-GB | en-IN | en-US | es-419 | es-ES | es-US | fr-FR | fr-CA | it-IT | ja-JP | ko-KR`   
Required: No

 ** v1BotName **   <a name="lex-Type-MigrationSummary-v1BotName"></a>
The name of the Amazon Lex V1 bot that is the source of the migration.  
Type: String  
Length Constraints: Minimum length of 2. Maximum length of 50.  
Pattern: `^([A-Za-z]_?)+$`   
Required: No

 ** v1BotVersion **   <a name="lex-Type-MigrationSummary-v1BotVersion"></a>
The version of the Amazon Lex V1 bot that is the source of the migration.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `\$LATEST|[0-9]+`   
Required: No

 ** v2BotId **   <a name="lex-Type-MigrationSummary-v2BotId"></a>
The unique identifier of the Amazon Lex V2 that is the destination of the migration.  
Type: String  
Length Constraints: Fixed length of 10.  
Pattern: `^[0-9a-zA-Z]+$`   
Required: No

 ** v2BotRole **   <a name="lex-Type-MigrationSummary-v2BotRole"></a>
The IAM role that Amazon Lex uses to run the Amazon Lex V2 bot.  
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 2048.  
Pattern: `^arn:[\w\-]+:iam::[\d]{12}:role/.+$`   
Required: No

## See Also
<a name="API_MigrationSummary_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lex-models-2017-04-19/MigrationSummary) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lex-models-2017-04-19/MigrationSummary) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lex-models-2017-04-19/MigrationSummary) 

# OutputContext
<a name="API_OutputContext"></a>

The specification of an output context that is set when an intent is fulfilled.

## Contents
<a name="API_OutputContext_Contents"></a>

 ** name **   <a name="lex-Type-OutputContext-name"></a>
The name of the context.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `^([A-Za-z]_?)+$`   
Required: Yes

 ** timeToLiveInSeconds **   <a name="lex-Type-OutputContext-timeToLiveInSeconds"></a>
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).  
Type: Integer  
Valid Range: Minimum value of 5. Maximum value of 86400.  
Required: Yes

 ** turnsToLive **   <a name="lex-Type-OutputContext-turnsToLive"></a>
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.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 20.  
Required: Yes

## See Also
<a name="API_OutputContext_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lex-models-2017-04-19/OutputContext) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lex-models-2017-04-19/OutputContext) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lex-models-2017-04-19/OutputContext) 

# Prompt
<a name="API_Prompt"></a>

Obtains information from the user. To define a prompt, provide one or more messages and specify the number of attempts to get information from the user. If you provide more than one message, Amazon Lex chooses one of the messages to use to prompt the user. For more information, see [Amazon Lex: How It Works](how-it-works.md).

## Contents
<a name="API_Prompt_Contents"></a>

 ** maxAttempts **   <a name="lex-Type-Prompt-maxAttempts"></a>
The number of times to prompt the user for information.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 5.  
Required: Yes

 ** messages **   <a name="lex-Type-Prompt-messages"></a>
An array of objects, each of which provides a message string and its type. You can specify the message string in plain text or in Speech Synthesis Markup Language (SSML).  
Type: Array of [Message](API_Message.md) objects  
Array Members: Minimum number of 1 item. Maximum number of 15 items.  
Required: Yes

 ** responseCard **   <a name="lex-Type-Prompt-responseCard"></a>
A response card. Amazon Lex uses this prompt at runtime, in the `PostText` API response. It substitutes session attributes and slot values for placeholders in the response card. For more information, see [Using a Response Card](ex-resp-card.md).   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 50000.  
Required: No

## See Also
<a name="API_Prompt_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lex-models-2017-04-19/Prompt) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lex-models-2017-04-19/Prompt) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lex-models-2017-04-19/Prompt) 

# ResourceReference
<a name="API_ResourceReference"></a>

Describes the resource that refers to the resource that you are attempting to delete. This object is returned as part of the `ResourceInUseException` exception. 

## Contents
<a name="API_ResourceReference_Contents"></a>

 ** name **   <a name="lex-Type-ResourceReference-name"></a>
The name of the resource that is using the resource that you are trying to delete.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `[a-zA-Z_]+`   
Required: No

 ** version **   <a name="lex-Type-ResourceReference-version"></a>
The version of the resource that is using the resource that you are trying to delete.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `\$LATEST|[0-9]+`   
Required: No

## See Also
<a name="API_ResourceReference_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lex-models-2017-04-19/ResourceReference) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lex-models-2017-04-19/ResourceReference) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lex-models-2017-04-19/ResourceReference) 

# Slot
<a name="API_Slot"></a>

Identifies the version of a specific slot.

## Contents
<a name="API_Slot_Contents"></a>

 ** name **   <a name="lex-Type-Slot-name"></a>
The name of the slot.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `^([A-Za-z](-|_|.)?)+$`   
Required: Yes

 ** slotConstraint **   <a name="lex-Type-Slot-slotConstraint"></a>
Specifies whether the slot is required or optional.   
Type: String  
Valid Values: `Required | Optional`   
Required: Yes

 ** defaultValueSpec **   <a name="lex-Type-Slot-defaultValueSpec"></a>
A list of default values for the slot. Default values are used when Amazon Lex hasn't determined a value for a slot. You can specify default values from context variables, session attributes, and defined values.  
Type: [SlotDefaultValueSpec](API_SlotDefaultValueSpec.md) object  
Required: No

 ** description **   <a name="lex-Type-Slot-description"></a>
A description of the slot.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 200.  
Required: No

 ** obfuscationSetting **   <a name="lex-Type-Slot-obfuscationSetting"></a>
Determines whether a slot is obfuscated in conversation logs and stored utterances. When you obfuscate a slot, the value is replaced by the slot name in curly braces (\$1\$1). For example, if the slot name is "full\$1name", obfuscated values are replaced with "\$1full\$1name\$1". For more information, see [ Slot Obfuscation ](https://docs.aws.amazon.com/lex/latest/dg/how-obfuscate.html).   
Type: String  
Valid Values: `NONE | DEFAULT_OBFUSCATION`   
Required: No

 ** priority **   <a name="lex-Type-Slot-priority"></a>
 Directs Amazon Lex the order in which to elicit this slot value from the user. For example, if the intent has two slots with priorities 1 and 2, AWS Amazon Lex first elicits a value for the slot with priority 1.  
If multiple slots share the same priority, the order in which Amazon Lex elicits values is arbitrary.  
Type: Integer  
Valid Range: Minimum value of 0. Maximum value of 100.  
Required: No

 ** responseCard **   <a name="lex-Type-Slot-responseCard"></a>
 A set of possible responses for the slot type used by text-based clients. A user chooses an option from the response card, instead of using text to reply.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 50000.  
Required: No

 ** sampleUtterances **   <a name="lex-Type-Slot-sampleUtterances"></a>
 If you know a specific pattern with which users might respond to an Amazon Lex request for a slot value, you can provide those utterances to improve accuracy. This is optional. In most cases, Amazon Lex is capable of understanding user utterances.   
Type: Array of strings  
Array Members: Minimum number of 0 items. Maximum number of 10 items.  
Length Constraints: Minimum length of 1. Maximum length of 200.  
Required: No

 ** slotType **   <a name="lex-Type-Slot-slotType"></a>
The type of the slot, either a custom slot type that you defined or one of the built-in slot types.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `^((AMAZON\.)_?|[A-Za-z]_?)+`   
Required: No

 ** slotTypeVersion **   <a name="lex-Type-Slot-slotTypeVersion"></a>
The version of the slot type.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `\$LATEST|[0-9]+`   
Required: No

 ** valueElicitationPrompt **   <a name="lex-Type-Slot-valueElicitationPrompt"></a>
The prompt that Amazon Lex uses to elicit the slot value from the user.  
Type: [Prompt](API_Prompt.md) object  
Required: No

## See Also
<a name="API_Slot_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lex-models-2017-04-19/Slot) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lex-models-2017-04-19/Slot) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lex-models-2017-04-19/Slot) 

# SlotDefaultValue
<a name="API_SlotDefaultValue"></a>

A default value for a slot.

## Contents
<a name="API_SlotDefaultValue_Contents"></a>

 ** defaultValue **   <a name="lex-Type-SlotDefaultValue-defaultValue"></a>
The default value for the slot. You can specify one of the following:  
+  `#context-name.slot-name` - The slot value "slot-name" in the context "context-name."
+  `{attribute}` - The slot value of the session attribute "attribute."
+  `'value'` - The discrete value "value."
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 202.  
Required: Yes

## See Also
<a name="API_SlotDefaultValue_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lex-models-2017-04-19/SlotDefaultValue) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lex-models-2017-04-19/SlotDefaultValue) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lex-models-2017-04-19/SlotDefaultValue) 

# SlotDefaultValueSpec
<a name="API_SlotDefaultValueSpec"></a>

Contains the default values for a slot. Default values are used when Amazon Lex hasn't determined a value for a slot.

## Contents
<a name="API_SlotDefaultValueSpec_Contents"></a>

 ** defaultValueList **   <a name="lex-Type-SlotDefaultValueSpec-defaultValueList"></a>
The default values for a slot. You can specify more than one default. For example, you can specify a default value to use from a matching context variable, a session attribute, or a fixed value.  
The default value chosen is selected based on the order that you specify them in the list. For example, if you specify a context variable and a fixed value in that order, Amazon Lex uses the context variable if it is available, else it uses the fixed value.  
Type: Array of [SlotDefaultValue](API_SlotDefaultValue.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 10 items.  
Required: Yes

## See Also
<a name="API_SlotDefaultValueSpec_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lex-models-2017-04-19/SlotDefaultValueSpec) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lex-models-2017-04-19/SlotDefaultValueSpec) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lex-models-2017-04-19/SlotDefaultValueSpec) 

# SlotTypeConfiguration
<a name="API_SlotTypeConfiguration"></a>

Provides configuration information for a slot type.

## Contents
<a name="API_SlotTypeConfiguration_Contents"></a>

 ** regexConfiguration **   <a name="lex-Type-SlotTypeConfiguration-regexConfiguration"></a>
A regular expression used to validate the value of a slot.  
Type: [SlotTypeRegexConfiguration](API_SlotTypeRegexConfiguration.md) object  
Required: No

## See Also
<a name="API_SlotTypeConfiguration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lex-models-2017-04-19/SlotTypeConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lex-models-2017-04-19/SlotTypeConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lex-models-2017-04-19/SlotTypeConfiguration) 

# SlotTypeMetadata
<a name="API_SlotTypeMetadata"></a>

Provides information about a slot type..

## Contents
<a name="API_SlotTypeMetadata_Contents"></a>

 ** createdDate **   <a name="lex-Type-SlotTypeMetadata-createdDate"></a>
The date that the slot type was created.  
Type: Timestamp  
Required: No

 ** description **   <a name="lex-Type-SlotTypeMetadata-description"></a>
A description of the slot type.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 200.  
Required: No

 ** lastUpdatedDate **   <a name="lex-Type-SlotTypeMetadata-lastUpdatedDate"></a>
The date that the slot type was updated. When you create a resource, the creation date and last updated date are the same.   
Type: Timestamp  
Required: No

 ** name **   <a name="lex-Type-SlotTypeMetadata-name"></a>
The name of the slot type.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `^([A-Za-z]_?)+$`   
Required: No

 ** version **   <a name="lex-Type-SlotTypeMetadata-version"></a>
The version of the slot type.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `\$LATEST|[0-9]+`   
Required: No

## See Also
<a name="API_SlotTypeMetadata_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lex-models-2017-04-19/SlotTypeMetadata) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lex-models-2017-04-19/SlotTypeMetadata) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lex-models-2017-04-19/SlotTypeMetadata) 

# SlotTypeRegexConfiguration
<a name="API_SlotTypeRegexConfiguration"></a>

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

## Contents
<a name="API_SlotTypeRegexConfiguration_Contents"></a>

 ** pattern **   <a name="lex-Type-SlotTypeRegexConfiguration-pattern"></a>
A regular expression used to validate the value of a slot.   
Use a standard regular expression. Amazon Lex supports the following characters in the regular expression:  
+ A-Z, a-z
+ 0-9
+ Unicode characters ("\$1 u<Unicode>")
Represent Unicode characters with four digits, for example "\$1u0041" or "\$1u005A".  
The following regular expression operators are not supported:  
+ Infinite repeaters: \$1, \$1, or \$1x,\$1 with no upper bound.
+ Wild card (.)
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

## See Also
<a name="API_SlotTypeRegexConfiguration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lex-models-2017-04-19/SlotTypeRegexConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lex-models-2017-04-19/SlotTypeRegexConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lex-models-2017-04-19/SlotTypeRegexConfiguration) 

# Statement
<a name="API_Statement"></a>

A collection of messages that convey information to the user. At runtime, Amazon Lex selects the message to convey. 

## Contents
<a name="API_Statement_Contents"></a>

 ** messages **   <a name="lex-Type-Statement-messages"></a>
A collection of message objects.  
Type: Array of [Message](API_Message.md) objects  
Array Members: Minimum number of 1 item. Maximum number of 15 items.  
Required: Yes

 ** responseCard **   <a name="lex-Type-Statement-responseCard"></a>
 At runtime, if the client is using the [PostText](http://docs.aws.amazon.com/lex/latest/dg/API_runtime_PostText.html) API, Amazon Lex includes the response card in the response. It substitutes all of the session attributes and slot values for placeholders in the response card.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 50000.  
Required: No

## See Also
<a name="API_Statement_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lex-models-2017-04-19/Statement) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lex-models-2017-04-19/Statement) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lex-models-2017-04-19/Statement) 

# Tag
<a name="API_Tag"></a>

A list of key/value pairs that identify a bot, bot alias, or bot channel. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: \$1 . : / = \$1 - @. 

## Contents
<a name="API_Tag_Contents"></a>

 ** key **   <a name="lex-Type-Tag-key"></a>
The key for the tag. Keys are not case-sensitive and must be unique.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Required: Yes

 ** value **   <a name="lex-Type-Tag-value"></a>
The value associated with a key. The value may be an empty string but it can't be null.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 256.  
Required: Yes

## See Also
<a name="API_Tag_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lex-models-2017-04-19/Tag) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lex-models-2017-04-19/Tag) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lex-models-2017-04-19/Tag) 

# UtteranceData
<a name="API_UtteranceData"></a>

Provides information about a single utterance that was made to your bot. 

## Contents
<a name="API_UtteranceData_Contents"></a>

 ** count **   <a name="lex-Type-UtteranceData-count"></a>
The number of times that the utterance was processed.  
Type: Integer  
Required: No

 ** distinctUsers **   <a name="lex-Type-UtteranceData-distinctUsers"></a>
The total number of individuals that used the utterance.  
Type: Integer  
Required: No

 ** firstUtteredDate **   <a name="lex-Type-UtteranceData-firstUtteredDate"></a>
The date that the utterance was first recorded.  
Type: Timestamp  
Required: No

 ** lastUtteredDate **   <a name="lex-Type-UtteranceData-lastUtteredDate"></a>
The date that the utterance was last recorded.  
Type: Timestamp  
Required: No

 ** utteranceString **   <a name="lex-Type-UtteranceData-utteranceString"></a>
The text that was entered by the user or the text representation of an audio clip.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2000.  
Required: No

## See Also
<a name="API_UtteranceData_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lex-models-2017-04-19/UtteranceData) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lex-models-2017-04-19/UtteranceData) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lex-models-2017-04-19/UtteranceData) 

# UtteranceList
<a name="API_UtteranceList"></a>

Provides a list of utterances that have been made to a specific version of your bot. The list contains a maximum of 100 utterances.

## Contents
<a name="API_UtteranceList_Contents"></a>

 ** botVersion **   <a name="lex-Type-UtteranceList-botVersion"></a>
The version of the bot that processed the list.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `\$LATEST|[0-9]+`   
Required: No

 ** utterances **   <a name="lex-Type-UtteranceList-utterances"></a>
One or more [UtteranceData](API_UtteranceData.md) objects that contain information about the utterances that have been made to a bot. The maximum number of object is 100.  
Type: Array of [UtteranceData](API_UtteranceData.md) objects  
Required: No

## See Also
<a name="API_UtteranceList_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lex-models-2017-04-19/UtteranceList) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lex-models-2017-04-19/UtteranceList) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lex-models-2017-04-19/UtteranceList) 

# Amazon Lex Runtime Service
<a name="API_Types_Amazon_Lex_Runtime_Service"></a>

The following data types are supported by Amazon Lex Runtime Service:
+  [ActiveContext](API_runtime_ActiveContext.md) 
+  [ActiveContextTimeToLive](API_runtime_ActiveContextTimeToLive.md) 
+  [Button](API_runtime_Button.md) 
+  [DialogAction](API_runtime_DialogAction.md) 
+  [GenericAttachment](API_runtime_GenericAttachment.md) 
+  [IntentConfidence](API_runtime_IntentConfidence.md) 
+  [IntentSummary](API_runtime_IntentSummary.md) 
+  [PredictedIntent](API_runtime_PredictedIntent.md) 
+  [ResponseCard](API_runtime_ResponseCard.md) 
+  [SentimentResponse](API_runtime_SentimentResponse.md) 

# ActiveContext
<a name="API_runtime_ActiveContext"></a>

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.

## Contents
<a name="API_runtime_ActiveContext_Contents"></a>

 ** name **   <a name="lex-Type-runtime_ActiveContext-name"></a>
The name of the context.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `^([A-Za-z]_?)+$`   
Required: Yes

 ** parameters **   <a name="lex-Type-runtime_ActiveContext-parameters"></a>
State variables for the current context. You can use these values as default values for slots in subsequent events.  
Type: String to string map  
Map Entries: Minimum number of 0 items. Maximum number of 10 items.  
Key Length Constraints: Minimum length of 1. Maximum length of 100.  
Value Length Constraints: Minimum length of 1. Maximum length of 1024.  
Required: Yes

 ** timeToLive **   <a name="lex-Type-runtime_ActiveContext-timeToLive"></a>
The length of time or number of turns that a context remains active.  
Type: [ActiveContextTimeToLive](API_runtime_ActiveContextTimeToLive.md) object  
Required: Yes

## See Also
<a name="API_runtime_ActiveContext_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/runtime.lex-2016-11-28/ActiveContext) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/runtime.lex-2016-11-28/ActiveContext) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/runtime.lex-2016-11-28/ActiveContext) 

# ActiveContextTimeToLive
<a name="API_runtime_ActiveContextTimeToLive"></a>

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

## Contents
<a name="API_runtime_ActiveContextTimeToLive_Contents"></a>

 ** timeToLiveInSeconds **   <a name="lex-Type-runtime_ActiveContextTimeToLive-timeToLiveInSeconds"></a>
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).  
Type: Integer  
Valid Range: Minimum value of 5. Maximum value of 86400.  
Required: No

 ** turnsToLive **   <a name="lex-Type-runtime_ActiveContextTimeToLive-turnsToLive"></a>
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.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 20.  
Required: No

## See Also
<a name="API_runtime_ActiveContextTimeToLive_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/runtime.lex-2016-11-28/ActiveContextTimeToLive) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/runtime.lex-2016-11-28/ActiveContextTimeToLive) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/runtime.lex-2016-11-28/ActiveContextTimeToLive) 

# Button
<a name="API_runtime_Button"></a>

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

## Contents
<a name="API_runtime_Button_Contents"></a>

 ** text **   <a name="lex-Type-runtime_Button-text"></a>
Text that is visible to the user on the button.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 15.  
Required: Yes

 ** value **   <a name="lex-Type-runtime_Button-value"></a>
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."  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1000.  
Required: Yes

## See Also
<a name="API_runtime_Button_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/runtime.lex-2016-11-28/Button) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/runtime.lex-2016-11-28/Button) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/runtime.lex-2016-11-28/Button) 

# DialogAction
<a name="API_runtime_DialogAction"></a>

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.

## Contents
<a name="API_runtime_DialogAction_Contents"></a>

 ** type **   <a name="lex-Type-runtime_DialogAction-type"></a>
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.
Type: String  
Valid Values: `ElicitIntent | ConfirmIntent | ElicitSlot | Close | Delegate`   
Required: Yes

 ** fulfillmentState **   <a name="lex-Type-runtime_DialogAction-fulfillmentState"></a>
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.
Type: String  
Valid Values: `Fulfilled | Failed | ReadyForFulfillment`   
Required: No

 ** intentName **   <a name="lex-Type-runtime_DialogAction-intentName"></a>
The name of the intent.  
Type: String  
Required: No

 ** message **   <a name="lex-Type-runtime_DialogAction-message"></a>
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.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Required: No

 ** messageFormat **   <a name="lex-Type-runtime_DialogAction-messageFormat"></a>
+  `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](https://docs.aws.amazon.com/lex/latest/dg/howitworks-manage-prompts.html). 
Type: String  
Valid Values: `PlainText | CustomPayload | SSML | Composite`   
Required: No

 ** slots **   <a name="lex-Type-runtime_DialogAction-slots"></a>
Map of the slots that have been gathered and their values.   
Type: String to string map  
Required: No

 ** slotToElicit **   <a name="lex-Type-runtime_DialogAction-slotToElicit"></a>
The name of the slot that should be elicited from the user.  
Type: String  
Required: No

## See Also
<a name="API_runtime_DialogAction_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/runtime.lex-2016-11-28/DialogAction) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/runtime.lex-2016-11-28/DialogAction) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/runtime.lex-2016-11-28/DialogAction) 

# GenericAttachment
<a name="API_runtime_GenericAttachment"></a>

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

## Contents
<a name="API_runtime_GenericAttachment_Contents"></a>

 ** attachmentLinkUrl **   <a name="lex-Type-runtime_GenericAttachment-attachmentLinkUrl"></a>
The URL of an attachment to the response card.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Required: No

 ** buttons **   <a name="lex-Type-runtime_GenericAttachment-buttons"></a>
The list of options to show to the user.  
Type: Array of [Button](API_runtime_Button.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 5 items.  
Required: No

 ** imageUrl **   <a name="lex-Type-runtime_GenericAttachment-imageUrl"></a>
The URL of an image that is displayed to the user.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Required: No

 ** subTitle **   <a name="lex-Type-runtime_GenericAttachment-subTitle"></a>
The subtitle shown below the title.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 80.  
Required: No

 ** title **   <a name="lex-Type-runtime_GenericAttachment-title"></a>
The title of the option.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 80.  
Required: No

## See Also
<a name="API_runtime_GenericAttachment_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/runtime.lex-2016-11-28/GenericAttachment) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/runtime.lex-2016-11-28/GenericAttachment) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/runtime.lex-2016-11-28/GenericAttachment) 

# IntentConfidence
<a name="API_runtime_IntentConfidence"></a>

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

## Contents
<a name="API_runtime_IntentConfidence_Contents"></a>

 ** score **   <a name="lex-Type-runtime_IntentConfidence-score"></a>
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.  
Type: Double  
Required: No

## See Also
<a name="API_runtime_IntentConfidence_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/runtime.lex-2016-11-28/IntentConfidence) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/runtime.lex-2016-11-28/IntentConfidence) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/runtime.lex-2016-11-28/IntentConfidence) 

# IntentSummary
<a name="API_runtime_IntentSummary"></a>

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.

## Contents
<a name="API_runtime_IntentSummary_Contents"></a>

 ** dialogActionType **   <a name="lex-Type-runtime_IntentSummary-dialogActionType"></a>
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.
Type: String  
Valid Values: `ElicitIntent | ConfirmIntent | ElicitSlot | Close | Delegate`   
Required: Yes

 ** checkpointLabel **   <a name="lex-Type-runtime_IntentSummary-checkpointLabel"></a>
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.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `[a-zA-Z0-9-]+`   
Required: No

 ** confirmationStatus **   <a name="lex-Type-runtime_IntentSummary-confirmationStatus"></a>
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.
Type: String  
Valid Values: `None | Confirmed | Denied`   
Required: No

 ** fulfillmentState **   <a name="lex-Type-runtime_IntentSummary-fulfillmentState"></a>
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.
Type: String  
Valid Values: `Fulfilled | Failed | ReadyForFulfillment`   
Required: No

 ** intentName **   <a name="lex-Type-runtime_IntentSummary-intentName"></a>
The name of the intent.  
Type: String  
Required: No

 ** slots **   <a name="lex-Type-runtime_IntentSummary-slots"></a>
Map of the slots that have been gathered and their values.   
Type: String to string map  
Required: No

 ** slotToElicit **   <a name="lex-Type-runtime_IntentSummary-slotToElicit"></a>
The next slot to elicit from the user. If there is not slot to elicit, the field is blank.  
Type: String  
Required: No

## See Also
<a name="API_runtime_IntentSummary_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/runtime.lex-2016-11-28/IntentSummary) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/runtime.lex-2016-11-28/IntentSummary) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/runtime.lex-2016-11-28/IntentSummary) 

# PredictedIntent
<a name="API_runtime_PredictedIntent"></a>

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.

## Contents
<a name="API_runtime_PredictedIntent_Contents"></a>

 ** intentName **   <a name="lex-Type-runtime_PredictedIntent-intentName"></a>
The name of the intent that Amazon Lex suggests satisfies the user's intent.  
Type: String  
Required: No

 ** nluIntentConfidence **   <a name="lex-Type-runtime_PredictedIntent-nluIntentConfidence"></a>
Indicates how confident Amazon Lex is that an intent satisfies the user's intent.  
Type: [IntentConfidence](API_runtime_IntentConfidence.md) object  
Required: No

 ** slots **   <a name="lex-Type-runtime_PredictedIntent-slots"></a>
The slot and slot values associated with the predicted intent.  
Type: String to string map  
Required: No

## See Also
<a name="API_runtime_PredictedIntent_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/runtime.lex-2016-11-28/PredictedIntent) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/runtime.lex-2016-11-28/PredictedIntent) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/runtime.lex-2016-11-28/PredictedIntent) 

# ResponseCard
<a name="API_runtime_ResponseCard"></a>

If you configure a response card when creating your bots, Amazon Lex substitutes the session attributes and slot values that are available, and then returns it. The response card can also come from a Lambda function ( `dialogCodeHook` and `fulfillmentActivity` on an intent).

## Contents
<a name="API_runtime_ResponseCard_Contents"></a>

 ** contentType **   <a name="lex-Type-runtime_ResponseCard-contentType"></a>
The content type of the response.  
Type: String  
Valid Values: `application/vnd.amazonaws.card.generic`   
Required: No

 ** genericAttachments **   <a name="lex-Type-runtime_ResponseCard-genericAttachments"></a>
An array of attachment objects representing options.  
Type: Array of [GenericAttachment](API_runtime_GenericAttachment.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 10 items.  
Required: No

 ** version **   <a name="lex-Type-runtime_ResponseCard-version"></a>
The version of the response card format.  
Type: String  
Required: No

## See Also
<a name="API_runtime_ResponseCard_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/runtime.lex-2016-11-28/ResponseCard) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/runtime.lex-2016-11-28/ResponseCard) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/runtime.lex-2016-11-28/ResponseCard) 

# SentimentResponse
<a name="API_runtime_SentimentResponse"></a>

The sentiment expressed in an utterance.

When the bot is configured to send utterances to Amazon Comprehend for sentiment analysis, this field structure contains the result of the analysis.

## Contents
<a name="API_runtime_SentimentResponse_Contents"></a>

 ** sentimentLabel **   <a name="lex-Type-runtime_SentimentResponse-sentimentLabel"></a>
The inferred sentiment that Amazon Comprehend has the highest confidence in.  
Type: String  
Required: No

 ** sentimentScore **   <a name="lex-Type-runtime_SentimentResponse-sentimentScore"></a>
The likelihood that the sentiment was correctly inferred.  
Type: String  
Required: No

## See Also
<a name="API_runtime_SentimentResponse_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/runtime.lex-2016-11-28/SentimentResponse) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/runtime.lex-2016-11-28/SentimentResponse) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/runtime.lex-2016-11-28/SentimentResponse)