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

# API Reference
<a name="API_Reference"></a>

This section provides documentation for the Amazon Lex API operations. For a list of AWS Regions where Amazon Lex is available, see [AWS Regions and Endpoints](https://docs.aws.amazon.com/general/latest/gr/rande.html#lex_region) in the *Amazon Web Services General Reference*.

**Topics**
+ [Actions](API_Operations.md)
+ [Data Types](API_Types.md)

# Actions
<a name="API_Operations"></a>

The following actions are supported by Amazon Lex Model Building Service:
+  [CreateBotVersion](API_CreateBotVersion.md) 
+  [CreateIntentVersion](API_CreateIntentVersion.md) 
+  [CreateSlotTypeVersion](API_CreateSlotTypeVersion.md) 
+  [DeleteBot](API_DeleteBot.md) 
+  [DeleteBotAlias](API_DeleteBotAlias.md) 
+  [DeleteBotChannelAssociation](API_DeleteBotChannelAssociation.md) 
+  [DeleteBotVersion](API_DeleteBotVersion.md) 
+  [DeleteIntent](API_DeleteIntent.md) 
+  [DeleteIntentVersion](API_DeleteIntentVersion.md) 
+  [DeleteSlotType](API_DeleteSlotType.md) 
+  [DeleteSlotTypeVersion](API_DeleteSlotTypeVersion.md) 
+  [DeleteUtterances](API_DeleteUtterances.md) 
+  [GetBot](API_GetBot.md) 
+  [GetBotAlias](API_GetBotAlias.md) 
+  [GetBotAliases](API_GetBotAliases.md) 
+  [GetBotChannelAssociation](API_GetBotChannelAssociation.md) 
+  [GetBotChannelAssociations](API_GetBotChannelAssociations.md) 
+  [GetBots](API_GetBots.md) 
+  [GetBotVersions](API_GetBotVersions.md) 
+  [GetBuiltinIntent](API_GetBuiltinIntent.md) 
+  [GetBuiltinIntents](API_GetBuiltinIntents.md) 
+  [GetBuiltinSlotTypes](API_GetBuiltinSlotTypes.md) 
+  [GetExport](API_GetExport.md) 
+  [GetImport](API_GetImport.md) 
+  [GetIntent](API_GetIntent.md) 
+  [GetIntents](API_GetIntents.md) 
+  [GetIntentVersions](API_GetIntentVersions.md) 
+  [GetMigration](API_GetMigration.md) 
+  [GetMigrations](API_GetMigrations.md) 
+  [GetSlotType](API_GetSlotType.md) 
+  [GetSlotTypes](API_GetSlotTypes.md) 
+  [GetSlotTypeVersions](API_GetSlotTypeVersions.md) 
+  [GetUtterancesView](API_GetUtterancesView.md) 
+  [ListTagsForResource](API_ListTagsForResource.md) 
+  [PutBot](API_PutBot.md) 
+  [PutBotAlias](API_PutBotAlias.md) 
+  [PutIntent](API_PutIntent.md) 
+  [PutSlotType](API_PutSlotType.md) 
+  [StartImport](API_StartImport.md) 
+  [StartMigration](API_StartMigration.md) 
+  [TagResource](API_TagResource.md) 
+  [UntagResource](API_UntagResource.md) 

The following actions are supported by Amazon Lex Runtime Service:
+  [DeleteSession](API_runtime_DeleteSession.md) 
+  [GetSession](API_runtime_GetSession.md) 
+  [PostContent](API_runtime_PostContent.md) 
+  [PostText](API_runtime_PostText.md) 
+  [PutSession](API_runtime_PutSession.md) 

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

The following actions are supported by Amazon Lex Model Building Service:
+  [CreateBotVersion](API_CreateBotVersion.md) 
+  [CreateIntentVersion](API_CreateIntentVersion.md) 
+  [CreateSlotTypeVersion](API_CreateSlotTypeVersion.md) 
+  [DeleteBot](API_DeleteBot.md) 
+  [DeleteBotAlias](API_DeleteBotAlias.md) 
+  [DeleteBotChannelAssociation](API_DeleteBotChannelAssociation.md) 
+  [DeleteBotVersion](API_DeleteBotVersion.md) 
+  [DeleteIntent](API_DeleteIntent.md) 
+  [DeleteIntentVersion](API_DeleteIntentVersion.md) 
+  [DeleteSlotType](API_DeleteSlotType.md) 
+  [DeleteSlotTypeVersion](API_DeleteSlotTypeVersion.md) 
+  [DeleteUtterances](API_DeleteUtterances.md) 
+  [GetBot](API_GetBot.md) 
+  [GetBotAlias](API_GetBotAlias.md) 
+  [GetBotAliases](API_GetBotAliases.md) 
+  [GetBotChannelAssociation](API_GetBotChannelAssociation.md) 
+  [GetBotChannelAssociations](API_GetBotChannelAssociations.md) 
+  [GetBots](API_GetBots.md) 
+  [GetBotVersions](API_GetBotVersions.md) 
+  [GetBuiltinIntent](API_GetBuiltinIntent.md) 
+  [GetBuiltinIntents](API_GetBuiltinIntents.md) 
+  [GetBuiltinSlotTypes](API_GetBuiltinSlotTypes.md) 
+  [GetExport](API_GetExport.md) 
+  [GetImport](API_GetImport.md) 
+  [GetIntent](API_GetIntent.md) 
+  [GetIntents](API_GetIntents.md) 
+  [GetIntentVersions](API_GetIntentVersions.md) 
+  [GetMigration](API_GetMigration.md) 
+  [GetMigrations](API_GetMigrations.md) 
+  [GetSlotType](API_GetSlotType.md) 
+  [GetSlotTypes](API_GetSlotTypes.md) 
+  [GetSlotTypeVersions](API_GetSlotTypeVersions.md) 
+  [GetUtterancesView](API_GetUtterancesView.md) 
+  [ListTagsForResource](API_ListTagsForResource.md) 
+  [PutBot](API_PutBot.md) 
+  [PutBotAlias](API_PutBotAlias.md) 
+  [PutIntent](API_PutIntent.md) 
+  [PutSlotType](API_PutSlotType.md) 
+  [StartImport](API_StartImport.md) 
+  [StartMigration](API_StartMigration.md) 
+  [TagResource](API_TagResource.md) 
+  [UntagResource](API_UntagResource.md) 

# CreateBotVersion
<a name="API_CreateBotVersion"></a>

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

**Note**  
You can update only the `$LATEST` version of the bot. You can't update the numbered versions that you create with the `CreateBotVersion` operation.

 When you create the first version of a bot, Amazon Lex sets the version to 1. Subsequent versions increment by 1. For more information, see [Versioning](versioning-aliases.md#versioning-intro). 

 This operation requires permission for the `lex:CreateBotVersion` action. 

## Request Syntax
<a name="API_CreateBotVersion_RequestSyntax"></a>

```
POST /bots/name/versions HTTP/1.1
Content-type: application/json

{
   "checksum": "string"
}
```

## URI Request Parameters
<a name="API_CreateBotVersion_RequestParameters"></a>

The request uses the following URI parameters.

 ** [name](#API_CreateBotVersion_RequestSyntax) **   <a name="lex-CreateBotVersion-request-uri-name"></a>
The name of the bot that you want to create a new version of. The name is case sensitive.   
Length Constraints: Minimum length of 2. Maximum length of 50.  
Pattern: `^([A-Za-z]_?)+$`   
Required: Yes

## Request Body
<a name="API_CreateBotVersion_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [checksum](#API_CreateBotVersion_RequestSyntax) **   <a name="lex-CreateBotVersion-request-checksum"></a>
Identifies a specific revision of the `$LATEST` version of the bot. If you specify a checksum and the `$LATEST` version of the bot has a different checksum, a `PreconditionFailedException` exception is returned and Amazon Lex doesn't publish a new version. If you don't specify a checksum, Amazon Lex publishes the `$LATEST` version.  
Type: String  
Required: No

## Response Syntax
<a name="API_CreateBotVersion_ResponseSyntax"></a>

```
HTTP/1.1 201
Content-type: application/json

{
   "abortStatement": { 
      "messages": [ 
         { 
            "content": "string",
            "contentType": "string",
            "groupNumber": number
         }
      ],
      "responseCard": "string"
   },
   "checksum": "string",
   "childDirected": boolean,
   "clarificationPrompt": { 
      "maxAttempts": number,
      "messages": [ 
         { 
            "content": "string",
            "contentType": "string",
            "groupNumber": number
         }
      ],
      "responseCard": "string"
   },
   "createdDate": number,
   "description": "string",
   "detectSentiment": boolean,
   "enableModelImprovements": boolean,
   "failureReason": "string",
   "idleSessionTTLInSeconds": number,
   "intents": [ 
      { 
         "intentName": "string",
         "intentVersion": "string"
      }
   ],
   "lastUpdatedDate": number,
   "locale": "string",
   "name": "string",
   "status": "string",
   "version": "string",
   "voiceId": "string"
}
```

## Response Elements
<a name="API_CreateBotVersion_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 201 response.

The following data is returned in JSON format by the service.

 ** [abortStatement](#API_CreateBotVersion_ResponseSyntax) **   <a name="lex-CreateBotVersion-response-abortStatement"></a>
The message that Amazon Lex uses to cancel a conversation. For more information, see [PutBot](API_PutBot.md).  
Type: [Statement](API_Statement.md) object

 ** [checksum](#API_CreateBotVersion_ResponseSyntax) **   <a name="lex-CreateBotVersion-response-checksum"></a>
Checksum identifying the version of the bot that was created.  
Type: String

 ** [childDirected](#API_CreateBotVersion_ResponseSyntax) **   <a name="lex-CreateBotVersion-response-childDirected"></a>
For each Amazon Lex bot created with the Amazon Lex Model Building Service, you must specify whether your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to the Children's Online Privacy Protection Act (COPPA) by specifying `true` or `false` in the `childDirected` field. By specifying `true` in the `childDirected` field, you confirm that your use of Amazon Lex **is** related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA. By specifying `false` in the `childDirected` field, you confirm that your use of Amazon Lex **is not** related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA. You may not specify a default value for the `childDirected` field that does not accurately reflect whether your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA.  
If your use of Amazon Lex relates to a website, program, or other application that is directed in whole or in part, to children under age 13, you must obtain any required verifiable parental consent under COPPA. For information regarding the use of Amazon Lex in connection with websites, programs, or other applications that are directed or targeted, in whole or in part, to children under age 13, see the [Amazon Lex FAQ.](https://aws.amazon.com/lex/faqs#data-security)   
Type: Boolean

 ** [clarificationPrompt](#API_CreateBotVersion_ResponseSyntax) **   <a name="lex-CreateBotVersion-response-clarificationPrompt"></a>
The message that Amazon Lex uses when it doesn't understand the user's request. For more information, see [PutBot](API_PutBot.md).   
Type: [Prompt](API_Prompt.md) object

 ** [createdDate](#API_CreateBotVersion_ResponseSyntax) **   <a name="lex-CreateBotVersion-response-createdDate"></a>
The date when the bot version was created.  
Type: Timestamp

 ** [description](#API_CreateBotVersion_ResponseSyntax) **   <a name="lex-CreateBotVersion-response-description"></a>
A description of the bot.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 200.

 ** [detectSentiment](#API_CreateBotVersion_ResponseSyntax) **   <a name="lex-CreateBotVersion-response-detectSentiment"></a>
Indicates whether utterances entered by the user should be sent to Amazon Comprehend for sentiment analysis.  
Type: Boolean

 ** [enableModelImprovements](#API_CreateBotVersion_ResponseSyntax) **   <a name="lex-CreateBotVersion-response-enableModelImprovements"></a>
Indicates whether the bot uses accuracy improvements. `true` indicates that the bot is using the improvements, otherwise, `false`.  
Type: Boolean

 ** [failureReason](#API_CreateBotVersion_ResponseSyntax) **   <a name="lex-CreateBotVersion-response-failureReason"></a>
If `status` is `FAILED`, Amazon Lex provides the reason that it failed to build the bot.  
Type: String

 ** [idleSessionTTLInSeconds](#API_CreateBotVersion_ResponseSyntax) **   <a name="lex-CreateBotVersion-response-idleSessionTTLInSeconds"></a>
The maximum time in seconds that Amazon Lex retains the data gathered in a conversation. For more information, see [PutBot](API_PutBot.md).  
Type: Integer  
Valid Range: Minimum value of 60. Maximum value of 86400.

 ** [intents](#API_CreateBotVersion_ResponseSyntax) **   <a name="lex-CreateBotVersion-response-intents"></a>
An array of `Intent` objects. For more information, see [PutBot](API_PutBot.md).  
Type: Array of [Intent](API_Intent.md) objects

 ** [lastUpdatedDate](#API_CreateBotVersion_ResponseSyntax) **   <a name="lex-CreateBotVersion-response-lastUpdatedDate"></a>
The date when the `$LATEST` version of this bot was updated.   
Type: Timestamp

 ** [locale](#API_CreateBotVersion_ResponseSyntax) **   <a name="lex-CreateBotVersion-response-locale"></a>
 Specifies the target locale for the bot.   
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` 

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

 ** [status](#API_CreateBotVersion_ResponseSyntax) **   <a name="lex-CreateBotVersion-response-status"></a>
 When you send a request to create or update a bot, Amazon Lex sets the `status` response element to `BUILDING`. After Amazon Lex builds the bot, it sets `status` to `READY`. If Amazon Lex can't build the bot, it sets `status` to `FAILED`. Amazon Lex returns the reason for the failure in the `failureReason` response element.   
Type: String  
Valid Values: `BUILDING | READY | READY_BASIC_TESTING | FAILED | NOT_BUILT` 

 ** [version](#API_CreateBotVersion_ResponseSyntax) **   <a name="lex-CreateBotVersion-response-version"></a>
The version of the bot.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `\$LATEST|[0-9]+` 

 ** [voiceId](#API_CreateBotVersion_ResponseSyntax) **   <a name="lex-CreateBotVersion-response-voiceId"></a>
The Amazon Polly voice ID that Amazon Lex uses for voice interactions with the user.  
Type: String

## Errors
<a name="API_CreateBotVersion_Errors"></a>

 ** BadRequestException **   
The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and try again.  
HTTP Status Code: 400

 ** ConflictException **   
 There was a conflict processing the request. Try your request again.   
HTTP Status Code: 409

 ** InternalFailureException **   
An internal Amazon Lex error occurred. Try your request again.  
HTTP Status Code: 500

 ** LimitExceededException **   
The request exceeded a limit. Try your request again.  
HTTP Status Code: 429

 ** NotFoundException **   
The resource specified in the request was not found. Check the resource and try again.  
HTTP Status Code: 404

 ** PreconditionFailedException **   
 The checksum of the resource that you are trying to change does not match the checksum in the request. Check the resource's checksum and try again.  
HTTP Status Code: 412

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

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/lex-models-2017-04-19/CreateBotVersion) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lex-models-2017-04-19/CreateBotVersion) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lex-models-2017-04-19/CreateBotVersion) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lex-models-2017-04-19/CreateBotVersion) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lex-models-2017-04-19/CreateBotVersion) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lex-models-2017-04-19/CreateBotVersion) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lex-models-2017-04-19/CreateBotVersion) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lex-models-2017-04-19/CreateBotVersion) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lex-models-2017-04-19/CreateBotVersion) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lex-models-2017-04-19/CreateBotVersion) 

# CreateIntentVersion
<a name="API_CreateIntentVersion"></a>

Creates a new version of an intent based on the `$LATEST` version of the intent. If the `$LATEST` version of this intent hasn't changed since you last updated it, Amazon Lex doesn't create a new version. It returns the last version you created.

**Note**  
You can update only the `$LATEST` version of the intent. You can't update the numbered versions that you create with the `CreateIntentVersion` operation.

 When you create a version of an intent, Amazon Lex sets the version to 1. Subsequent versions increment by 1. For more information, see [Versioning](versioning-aliases.md#versioning-intro). 

This operation requires permissions to perform the `lex:CreateIntentVersion` action. 

## Request Syntax
<a name="API_CreateIntentVersion_RequestSyntax"></a>

```
POST /intents/name/versions HTTP/1.1
Content-type: application/json

{
   "checksum": "string"
}
```

## URI Request Parameters
<a name="API_CreateIntentVersion_RequestParameters"></a>

The request uses the following URI parameters.

 ** [name](#API_CreateIntentVersion_RequestSyntax) **   <a name="lex-CreateIntentVersion-request-uri-name"></a>
The name of the intent that you want to create a new version of. The name is case sensitive.   
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `^([A-Za-z]_?)+$`   
Required: Yes

## Request Body
<a name="API_CreateIntentVersion_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [checksum](#API_CreateIntentVersion_RequestSyntax) **   <a name="lex-CreateIntentVersion-request-checksum"></a>
Checksum of the `$LATEST` version of the intent that should be used to create the new version. If you specify a checksum and the `$LATEST` version of the intent has a different checksum, Amazon Lex returns a `PreconditionFailedException` exception and doesn't publish a new version. If you don't specify a checksum, Amazon Lex publishes the `$LATEST` version.  
Type: String  
Required: No

## Response Syntax
<a name="API_CreateIntentVersion_ResponseSyntax"></a>

```
HTTP/1.1 201
Content-type: application/json

{
   "checksum": "string",
   "conclusionStatement": { 
      "messages": [ 
         { 
            "content": "string",
            "contentType": "string",
            "groupNumber": number
         }
      ],
      "responseCard": "string"
   },
   "confirmationPrompt": { 
      "maxAttempts": number,
      "messages": [ 
         { 
            "content": "string",
            "contentType": "string",
            "groupNumber": number
         }
      ],
      "responseCard": "string"
   },
   "createdDate": number,
   "description": "string",
   "dialogCodeHook": { 
      "messageVersion": "string",
      "uri": "string"
   },
   "followUpPrompt": { 
      "prompt": { 
         "maxAttempts": number,
         "messages": [ 
            { 
               "content": "string",
               "contentType": "string",
               "groupNumber": number
            }
         ],
         "responseCard": "string"
      },
      "rejectionStatement": { 
         "messages": [ 
            { 
               "content": "string",
               "contentType": "string",
               "groupNumber": number
            }
         ],
         "responseCard": "string"
      }
   },
   "fulfillmentActivity": { 
      "codeHook": { 
         "messageVersion": "string",
         "uri": "string"
      },
      "type": "string"
   },
   "inputContexts": [ 
      { 
         "name": "string"
      }
   ],
   "kendraConfiguration": { 
      "kendraIndex": "string",
      "queryFilterString": "string",
      "role": "string"
   },
   "lastUpdatedDate": number,
   "name": "string",
   "outputContexts": [ 
      { 
         "name": "string",
         "timeToLiveInSeconds": number,
         "turnsToLive": number
      }
   ],
   "parentIntentSignature": "string",
   "rejectionStatement": { 
      "messages": [ 
         { 
            "content": "string",
            "contentType": "string",
            "groupNumber": number
         }
      ],
      "responseCard": "string"
   },
   "sampleUtterances": [ "string" ],
   "slots": [ 
      { 
         "defaultValueSpec": { 
            "defaultValueList": [ 
               { 
                  "defaultValue": "string"
               }
            ]
         },
         "description": "string",
         "name": "string",
         "obfuscationSetting": "string",
         "priority": number,
         "responseCard": "string",
         "sampleUtterances": [ "string" ],
         "slotConstraint": "string",
         "slotType": "string",
         "slotTypeVersion": "string",
         "valueElicitationPrompt": { 
            "maxAttempts": number,
            "messages": [ 
               { 
                  "content": "string",
                  "contentType": "string",
                  "groupNumber": number
               }
            ],
            "responseCard": "string"
         }
      }
   ],
   "version": "string"
}
```

## Response Elements
<a name="API_CreateIntentVersion_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 201 response.

The following data is returned in JSON format by the service.

 ** [checksum](#API_CreateIntentVersion_ResponseSyntax) **   <a name="lex-CreateIntentVersion-response-checksum"></a>
Checksum of the intent version created.  
Type: String

 ** [conclusionStatement](#API_CreateIntentVersion_ResponseSyntax) **   <a name="lex-CreateIntentVersion-response-conclusionStatement"></a>
After the Lambda function specified in the `fulfillmentActivity` field fulfills the intent, Amazon Lex conveys this statement to the user.   
Type: [Statement](API_Statement.md) object

 ** [confirmationPrompt](#API_CreateIntentVersion_ResponseSyntax) **   <a name="lex-CreateIntentVersion-response-confirmationPrompt"></a>
If defined, the prompt that Amazon Lex uses to confirm the user's intent before fulfilling it.   
Type: [Prompt](API_Prompt.md) object

 ** [createdDate](#API_CreateIntentVersion_ResponseSyntax) **   <a name="lex-CreateIntentVersion-response-createdDate"></a>
The date that the intent was created.  
Type: Timestamp

 ** [description](#API_CreateIntentVersion_ResponseSyntax) **   <a name="lex-CreateIntentVersion-response-description"></a>
A description of the intent.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 200.

 ** [dialogCodeHook](#API_CreateIntentVersion_ResponseSyntax) **   <a name="lex-CreateIntentVersion-response-dialogCodeHook"></a>
If defined, Amazon Lex invokes this Lambda function for each user input.  
Type: [CodeHook](API_CodeHook.md) object

 ** [followUpPrompt](#API_CreateIntentVersion_ResponseSyntax) **   <a name="lex-CreateIntentVersion-response-followUpPrompt"></a>
If defined, Amazon Lex uses this prompt to solicit additional user activity after the intent is fulfilled.   
Type: [FollowUpPrompt](API_FollowUpPrompt.md) object

 ** [fulfillmentActivity](#API_CreateIntentVersion_ResponseSyntax) **   <a name="lex-CreateIntentVersion-response-fulfillmentActivity"></a>
 Describes how the intent is fulfilled.   
Type: [FulfillmentActivity](API_FulfillmentActivity.md) object

 ** [inputContexts](#API_CreateIntentVersion_ResponseSyntax) **   <a name="lex-CreateIntentVersion-response-inputContexts"></a>
An array of `InputContext` objects that lists the contexts that must be active for Amazon Lex to choose the intent in a conversation with the user.  
Type: Array of [InputContext](API_InputContext.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 5 items.

 ** [kendraConfiguration](#API_CreateIntentVersion_ResponseSyntax) **   <a name="lex-CreateIntentVersion-response-kendraConfiguration"></a>
Configuration information, if any, for connecting an Amazon Kendra index with the `AMAZON.KendraSearchIntent` intent.  
Type: [KendraConfiguration](API_KendraConfiguration.md) object

 ** [lastUpdatedDate](#API_CreateIntentVersion_ResponseSyntax) **   <a name="lex-CreateIntentVersion-response-lastUpdatedDate"></a>
The date that the intent was updated.   
Type: Timestamp

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

 ** [outputContexts](#API_CreateIntentVersion_ResponseSyntax) **   <a name="lex-CreateIntentVersion-response-outputContexts"></a>
An array of `OutputContext` objects that lists the contexts that the intent activates when the intent is fulfilled.  
Type: Array of [OutputContext](API_OutputContext.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 10 items.

 ** [parentIntentSignature](#API_CreateIntentVersion_ResponseSyntax) **   <a name="lex-CreateIntentVersion-response-parentIntentSignature"></a>
A unique identifier for a built-in intent.  
Type: String

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

 ** [sampleUtterances](#API_CreateIntentVersion_ResponseSyntax) **   <a name="lex-CreateIntentVersion-response-sampleUtterances"></a>
An array of sample utterances configured for the intent.   
Type: Array of strings  
Array Members: Minimum number of 0 items. Maximum number of 1500 items.  
Length Constraints: Minimum length of 1. Maximum length of 200.

 ** [slots](#API_CreateIntentVersion_ResponseSyntax) **   <a name="lex-CreateIntentVersion-response-slots"></a>
An array of slot types that defines the information required to fulfill the intent.  
Type: Array of [Slot](API_Slot.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 100 items.

 ** [version](#API_CreateIntentVersion_ResponseSyntax) **   <a name="lex-CreateIntentVersion-response-version"></a>
The version number assigned to the new version of the intent.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `\$LATEST|[0-9]+` 

## Errors
<a name="API_CreateIntentVersion_Errors"></a>

 ** BadRequestException **   
The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and try again.  
HTTP Status Code: 400

 ** ConflictException **   
 There was a conflict processing the request. Try your request again.   
HTTP Status Code: 409

 ** InternalFailureException **   
An internal Amazon Lex error occurred. Try your request again.  
HTTP Status Code: 500

 ** LimitExceededException **   
The request exceeded a limit. Try your request again.  
HTTP Status Code: 429

 ** NotFoundException **   
The resource specified in the request was not found. Check the resource and try again.  
HTTP Status Code: 404

 ** PreconditionFailedException **   
 The checksum of the resource that you are trying to change does not match the checksum in the request. Check the resource's checksum and try again.  
HTTP Status Code: 412

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

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/lex-models-2017-04-19/CreateIntentVersion) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lex-models-2017-04-19/CreateIntentVersion) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lex-models-2017-04-19/CreateIntentVersion) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lex-models-2017-04-19/CreateIntentVersion) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lex-models-2017-04-19/CreateIntentVersion) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lex-models-2017-04-19/CreateIntentVersion) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lex-models-2017-04-19/CreateIntentVersion) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lex-models-2017-04-19/CreateIntentVersion) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lex-models-2017-04-19/CreateIntentVersion) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lex-models-2017-04-19/CreateIntentVersion) 

# CreateSlotTypeVersion
<a name="API_CreateSlotTypeVersion"></a>

Creates a new version of a slot type based on the `$LATEST` version of the specified slot type. If the `$LATEST` version of this resource has not changed since the last version that you created, Amazon Lex doesn't create a new version. It returns the last version that you created. 

**Note**  
You can update only the `$LATEST` version of a slot type. You can't update the numbered versions that you create with the `CreateSlotTypeVersion` operation.

When you create a version of a slot type, Amazon Lex sets the version to 1. Subsequent versions increment by 1. For more information, see [Versioning](versioning-aliases.md#versioning-intro). 

This operation requires permissions for the `lex:CreateSlotTypeVersion` action.

## Request Syntax
<a name="API_CreateSlotTypeVersion_RequestSyntax"></a>

```
POST /slottypes/name/versions HTTP/1.1
Content-type: application/json

{
   "checksum": "string"
}
```

## URI Request Parameters
<a name="API_CreateSlotTypeVersion_RequestParameters"></a>

The request uses the following URI parameters.

 ** [name](#API_CreateSlotTypeVersion_RequestSyntax) **   <a name="lex-CreateSlotTypeVersion-request-uri-name"></a>
The name of the slot type that you want to create a new version for. The name is case sensitive.   
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `^([A-Za-z]_?)+$`   
Required: Yes

## Request Body
<a name="API_CreateSlotTypeVersion_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [checksum](#API_CreateSlotTypeVersion_RequestSyntax) **   <a name="lex-CreateSlotTypeVersion-request-checksum"></a>
Checksum for the `$LATEST` version of the slot type that you want to publish. If you specify a checksum and the `$LATEST` version of the slot type has a different checksum, Amazon Lex returns a `PreconditionFailedException` exception and doesn't publish the new version. If you don't specify a checksum, Amazon Lex publishes the `$LATEST` version.  
Type: String  
Required: No

## Response Syntax
<a name="API_CreateSlotTypeVersion_ResponseSyntax"></a>

```
HTTP/1.1 201
Content-type: application/json

{
   "checksum": "string",
   "createdDate": number,
   "description": "string",
   "enumerationValues": [ 
      { 
         "synonyms": [ "string" ],
         "value": "string"
      }
   ],
   "lastUpdatedDate": number,
   "name": "string",
   "parentSlotTypeSignature": "string",
   "slotTypeConfigurations": [ 
      { 
         "regexConfiguration": { 
            "pattern": "string"
         }
      }
   ],
   "valueSelectionStrategy": "string",
   "version": "string"
}
```

## Response Elements
<a name="API_CreateSlotTypeVersion_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 201 response.

The following data is returned in JSON format by the service.

 ** [checksum](#API_CreateSlotTypeVersion_ResponseSyntax) **   <a name="lex-CreateSlotTypeVersion-response-checksum"></a>
Checksum of the `$LATEST` version of the slot type.  
Type: String

 ** [createdDate](#API_CreateSlotTypeVersion_ResponseSyntax) **   <a name="lex-CreateSlotTypeVersion-response-createdDate"></a>
The date that the slot type was created.  
Type: Timestamp

 ** [description](#API_CreateSlotTypeVersion_ResponseSyntax) **   <a name="lex-CreateSlotTypeVersion-response-description"></a>
A description of the slot type.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 200.

 ** [enumerationValues](#API_CreateSlotTypeVersion_ResponseSyntax) **   <a name="lex-CreateSlotTypeVersion-response-enumerationValues"></a>
A list of `EnumerationValue` objects that defines the values that the slot type can take.  
Type: Array of [EnumerationValue](API_EnumerationValue.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 10000 items.

 ** [lastUpdatedDate](#API_CreateSlotTypeVersion_ResponseSyntax) **   <a name="lex-CreateSlotTypeVersion-response-lastUpdatedDate"></a>
The date that the slot type was updated. When you create a resource, the creation date and last update date are the same.  
Type: Timestamp

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

 ** [parentSlotTypeSignature](#API_CreateSlotTypeVersion_ResponseSyntax) **   <a name="lex-CreateSlotTypeVersion-response-parentSlotTypeSignature"></a>
The built-in slot type used a the parent of the slot type.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `^((AMAZON\.)_?|[A-Za-z]_?)+` 

 ** [slotTypeConfigurations](#API_CreateSlotTypeVersion_ResponseSyntax) **   <a name="lex-CreateSlotTypeVersion-response-slotTypeConfigurations"></a>
Configuration information that extends the parent built-in slot type.  
Type: Array of [SlotTypeConfiguration](API_SlotTypeConfiguration.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 10 items.

 ** [valueSelectionStrategy](#API_CreateSlotTypeVersion_ResponseSyntax) **   <a name="lex-CreateSlotTypeVersion-response-valueSelectionStrategy"></a>
The strategy that Amazon Lex uses to determine the value of the slot. For more information, see [PutSlotType](API_PutSlotType.md).  
Type: String  
Valid Values: `ORIGINAL_VALUE | TOP_RESOLUTION` 

 ** [version](#API_CreateSlotTypeVersion_ResponseSyntax) **   <a name="lex-CreateSlotTypeVersion-response-version"></a>
The version assigned to the new slot type version.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `\$LATEST|[0-9]+` 

## Errors
<a name="API_CreateSlotTypeVersion_Errors"></a>

 ** BadRequestException **   
The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and try again.  
HTTP Status Code: 400

 ** ConflictException **   
 There was a conflict processing the request. Try your request again.   
HTTP Status Code: 409

 ** InternalFailureException **   
An internal Amazon Lex error occurred. Try your request again.  
HTTP Status Code: 500

 ** LimitExceededException **   
The request exceeded a limit. Try your request again.  
HTTP Status Code: 429

 ** NotFoundException **   
The resource specified in the request was not found. Check the resource and try again.  
HTTP Status Code: 404

 ** PreconditionFailedException **   
 The checksum of the resource that you are trying to change does not match the checksum in the request. Check the resource's checksum and try again.  
HTTP Status Code: 412

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

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/lex-models-2017-04-19/CreateSlotTypeVersion) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lex-models-2017-04-19/CreateSlotTypeVersion) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lex-models-2017-04-19/CreateSlotTypeVersion) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lex-models-2017-04-19/CreateSlotTypeVersion) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lex-models-2017-04-19/CreateSlotTypeVersion) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lex-models-2017-04-19/CreateSlotTypeVersion) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lex-models-2017-04-19/CreateSlotTypeVersion) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lex-models-2017-04-19/CreateSlotTypeVersion) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lex-models-2017-04-19/CreateSlotTypeVersion) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lex-models-2017-04-19/CreateSlotTypeVersion) 

# DeleteBot
<a name="API_DeleteBot"></a>

Deletes all versions of the bot, including the `$LATEST` version. To delete a specific version of the bot, use the [DeleteBotVersion](API_DeleteBotVersion.md) operation. The `DeleteBot` operation doesn't immediately remove the bot schema. Instead, it is marked for deletion and removed later.

Amazon Lex stores utterances indefinitely for improving the ability of your bot to respond to user inputs. These utterances are not removed when the bot is deleted. To remove the utterances, use the [DeleteUtterances](API_DeleteUtterances.md) operation.

If a bot has an alias, you can't delete it. Instead, the `DeleteBot` operation returns a `ResourceInUseException` exception that includes a reference to the alias that refers to the bot. To remove the reference to the bot, delete the alias. If you get the same exception again, delete the referring alias until the `DeleteBot` operation is successful.

This operation requires permissions for the `lex:DeleteBot` action.

## Request Syntax
<a name="API_DeleteBot_RequestSyntax"></a>

```
DELETE /bots/name HTTP/1.1
```

## URI Request Parameters
<a name="API_DeleteBot_RequestParameters"></a>

The request uses the following URI parameters.

 ** [name](#API_DeleteBot_RequestSyntax) **   <a name="lex-DeleteBot-request-uri-name"></a>
The name of the bot. The name is case sensitive.   
Length Constraints: Minimum length of 2. Maximum length of 50.  
Pattern: `^([A-Za-z]_?)+$`   
Required: Yes

## Request Body
<a name="API_DeleteBot_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_DeleteBot_ResponseSyntax"></a>

```
HTTP/1.1 204
```

## Response Elements
<a name="API_DeleteBot_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.

## Errors
<a name="API_DeleteBot_Errors"></a>

 ** BadRequestException **   
The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and try again.  
HTTP Status Code: 400

 ** ConflictException **   
 There was a conflict processing the request. Try your request again.   
HTTP Status Code: 409

 ** InternalFailureException **   
An internal Amazon Lex error occurred. Try your request again.  
HTTP Status Code: 500

 ** LimitExceededException **   
The request exceeded a limit. Try your request again.  
HTTP Status Code: 429

 ** NotFoundException **   
The resource specified in the request was not found. Check the resource and try again.  
HTTP Status Code: 404

 ** ResourceInUseException **   
The resource that you are attempting to delete is referred to by another resource. Use this information to remove references to the resource that you are trying to delete.  
The body of the exception contains a JSON object that describes the resource.  
 `{ "resourceType": BOT | BOTALIAS | BOTCHANNEL | INTENT,`   
 `"resourceReference": {`   
 `"name": string, "version": string } }`     
 ** exampleReference **   
Describes the resource that refers to the resource that you are attempting to delete. This object is returned as part of the `ResourceInUseException` exception. 
HTTP Status Code: 400

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

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/lex-models-2017-04-19/DeleteBot) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lex-models-2017-04-19/DeleteBot) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lex-models-2017-04-19/DeleteBot) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lex-models-2017-04-19/DeleteBot) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lex-models-2017-04-19/DeleteBot) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lex-models-2017-04-19/DeleteBot) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lex-models-2017-04-19/DeleteBot) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lex-models-2017-04-19/DeleteBot) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lex-models-2017-04-19/DeleteBot) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lex-models-2017-04-19/DeleteBot) 

# DeleteBotAlias
<a name="API_DeleteBotAlias"></a>

Deletes an alias for the specified bot. 

You can't delete an alias that is used in the association between a bot and a messaging channel. If an alias is used in a channel association, the `DeleteBot` operation returns a `ResourceInUseException` exception that includes a reference to the channel association that refers to the bot. You can remove the reference to the alias by deleting the channel association. If you get the same exception again, delete the referring association until the `DeleteBotAlias` operation is successful.

## Request Syntax
<a name="API_DeleteBotAlias_RequestSyntax"></a>

```
DELETE /bots/botName/aliases/name HTTP/1.1
```

## URI Request Parameters
<a name="API_DeleteBotAlias_RequestParameters"></a>

The request uses the following URI parameters.

 ** [botName](#API_DeleteBotAlias_RequestSyntax) **   <a name="lex-DeleteBotAlias-request-uri-botName"></a>
The name of the bot that the alias points to.  
Length Constraints: Minimum length of 2. Maximum length of 50.  
Pattern: `^([A-Za-z]_?)+$`   
Required: Yes

 ** [name](#API_DeleteBotAlias_RequestSyntax) **   <a name="lex-DeleteBotAlias-request-uri-name"></a>
The name of the alias to delete. The name is case sensitive.   
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `^([A-Za-z]_?)+$`   
Required: Yes

## Request Body
<a name="API_DeleteBotAlias_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_DeleteBotAlias_ResponseSyntax"></a>

```
HTTP/1.1 204
```

## Response Elements
<a name="API_DeleteBotAlias_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.

## Errors
<a name="API_DeleteBotAlias_Errors"></a>

 ** BadRequestException **   
The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and try again.  
HTTP Status Code: 400

 ** ConflictException **   
 There was a conflict processing the request. Try your request again.   
HTTP Status Code: 409

 ** InternalFailureException **   
An internal Amazon Lex error occurred. Try your request again.  
HTTP Status Code: 500

 ** LimitExceededException **   
The request exceeded a limit. Try your request again.  
HTTP Status Code: 429

 ** NotFoundException **   
The resource specified in the request was not found. Check the resource and try again.  
HTTP Status Code: 404

 ** ResourceInUseException **   
The resource that you are attempting to delete is referred to by another resource. Use this information to remove references to the resource that you are trying to delete.  
The body of the exception contains a JSON object that describes the resource.  
 `{ "resourceType": BOT | BOTALIAS | BOTCHANNEL | INTENT,`   
 `"resourceReference": {`   
 `"name": string, "version": string } }`     
 ** exampleReference **   
Describes the resource that refers to the resource that you are attempting to delete. This object is returned as part of the `ResourceInUseException` exception. 
HTTP Status Code: 400

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

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/lex-models-2017-04-19/DeleteBotAlias) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lex-models-2017-04-19/DeleteBotAlias) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lex-models-2017-04-19/DeleteBotAlias) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lex-models-2017-04-19/DeleteBotAlias) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lex-models-2017-04-19/DeleteBotAlias) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lex-models-2017-04-19/DeleteBotAlias) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lex-models-2017-04-19/DeleteBotAlias) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lex-models-2017-04-19/DeleteBotAlias) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lex-models-2017-04-19/DeleteBotAlias) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lex-models-2017-04-19/DeleteBotAlias) 

# DeleteBotChannelAssociation
<a name="API_DeleteBotChannelAssociation"></a>

Deletes the association between an Amazon Lex bot and a messaging platform.

This operation requires permission for the `lex:DeleteBotChannelAssociation` action.

## Request Syntax
<a name="API_DeleteBotChannelAssociation_RequestSyntax"></a>

```
DELETE /bots/botName/aliases/aliasName/channels/name HTTP/1.1
```

## URI Request Parameters
<a name="API_DeleteBotChannelAssociation_RequestParameters"></a>

The request uses the following URI parameters.

 ** [aliasName](#API_DeleteBotChannelAssociation_RequestSyntax) **   <a name="lex-DeleteBotChannelAssociation-request-uri-botAlias"></a>
An alias that points to the specific version of the Amazon Lex bot to which this association is being made.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `^([A-Za-z]_?)+$`   
Required: Yes

 ** [botName](#API_DeleteBotChannelAssociation_RequestSyntax) **   <a name="lex-DeleteBotChannelAssociation-request-uri-botName"></a>
The name of the Amazon Lex bot.  
Length Constraints: Minimum length of 2. Maximum length of 50.  
Pattern: `^([A-Za-z]_?)+$`   
Required: Yes

 ** [name](#API_DeleteBotChannelAssociation_RequestSyntax) **   <a name="lex-DeleteBotChannelAssociation-request-uri-name"></a>
The name of the association. The name is case sensitive.   
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `^([A-Za-z]_?)+$`   
Required: Yes

## Request Body
<a name="API_DeleteBotChannelAssociation_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_DeleteBotChannelAssociation_ResponseSyntax"></a>

```
HTTP/1.1 204
```

## Response Elements
<a name="API_DeleteBotChannelAssociation_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.

## Errors
<a name="API_DeleteBotChannelAssociation_Errors"></a>

 ** BadRequestException **   
The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and try again.  
HTTP Status Code: 400

 ** ConflictException **   
 There was a conflict processing the request. Try your request again.   
HTTP Status Code: 409

 ** InternalFailureException **   
An internal Amazon Lex error occurred. Try your request again.  
HTTP Status Code: 500

 ** LimitExceededException **   
The request exceeded a limit. Try your request again.  
HTTP Status Code: 429

 ** NotFoundException **   
The resource specified in the request was not found. Check the resource and try again.  
HTTP Status Code: 404

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

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/lex-models-2017-04-19/DeleteBotChannelAssociation) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lex-models-2017-04-19/DeleteBotChannelAssociation) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lex-models-2017-04-19/DeleteBotChannelAssociation) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lex-models-2017-04-19/DeleteBotChannelAssociation) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lex-models-2017-04-19/DeleteBotChannelAssociation) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lex-models-2017-04-19/DeleteBotChannelAssociation) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lex-models-2017-04-19/DeleteBotChannelAssociation) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lex-models-2017-04-19/DeleteBotChannelAssociation) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lex-models-2017-04-19/DeleteBotChannelAssociation) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lex-models-2017-04-19/DeleteBotChannelAssociation) 

# DeleteBotVersion
<a name="API_DeleteBotVersion"></a>

Deletes a specific version of a bot. To delete all versions of a bot, use the [DeleteBot](API_DeleteBot.md) operation. 

This operation requires permissions for the `lex:DeleteBotVersion` action.

## Request Syntax
<a name="API_DeleteBotVersion_RequestSyntax"></a>

```
DELETE /bots/name/versions/version HTTP/1.1
```

## URI Request Parameters
<a name="API_DeleteBotVersion_RequestParameters"></a>

The request uses the following URI parameters.

 ** [name](#API_DeleteBotVersion_RequestSyntax) **   <a name="lex-DeleteBotVersion-request-uri-name"></a>
The name of the bot.  
Length Constraints: Minimum length of 2. Maximum length of 50.  
Pattern: `^([A-Za-z]_?)+$`   
Required: Yes

 ** [version](#API_DeleteBotVersion_RequestSyntax) **   <a name="lex-DeleteBotVersion-request-uri-version"></a>
The version of the bot to delete. You cannot delete the `$LATEST` version of the bot. To delete the `$LATEST` version, use the [DeleteBot](API_DeleteBot.md) operation.  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `[0-9]+`   
Required: Yes

## Request Body
<a name="API_DeleteBotVersion_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_DeleteBotVersion_ResponseSyntax"></a>

```
HTTP/1.1 204
```

## Response Elements
<a name="API_DeleteBotVersion_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.

## Errors
<a name="API_DeleteBotVersion_Errors"></a>

 ** BadRequestException **   
The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and try again.  
HTTP Status Code: 400

 ** ConflictException **   
 There was a conflict processing the request. Try your request again.   
HTTP Status Code: 409

 ** InternalFailureException **   
An internal Amazon Lex error occurred. Try your request again.  
HTTP Status Code: 500

 ** LimitExceededException **   
The request exceeded a limit. Try your request again.  
HTTP Status Code: 429

 ** NotFoundException **   
The resource specified in the request was not found. Check the resource and try again.  
HTTP Status Code: 404

 ** ResourceInUseException **   
The resource that you are attempting to delete is referred to by another resource. Use this information to remove references to the resource that you are trying to delete.  
The body of the exception contains a JSON object that describes the resource.  
 `{ "resourceType": BOT | BOTALIAS | BOTCHANNEL | INTENT,`   
 `"resourceReference": {`   
 `"name": string, "version": string } }`     
 ** exampleReference **   
Describes the resource that refers to the resource that you are attempting to delete. This object is returned as part of the `ResourceInUseException` exception. 
HTTP Status Code: 400

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

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/lex-models-2017-04-19/DeleteBotVersion) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lex-models-2017-04-19/DeleteBotVersion) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lex-models-2017-04-19/DeleteBotVersion) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lex-models-2017-04-19/DeleteBotVersion) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lex-models-2017-04-19/DeleteBotVersion) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lex-models-2017-04-19/DeleteBotVersion) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lex-models-2017-04-19/DeleteBotVersion) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lex-models-2017-04-19/DeleteBotVersion) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lex-models-2017-04-19/DeleteBotVersion) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lex-models-2017-04-19/DeleteBotVersion) 

# DeleteIntent
<a name="API_DeleteIntent"></a>

Deletes all versions of the intent, including the `$LATEST` version. To delete a specific version of the intent, use the [DeleteIntentVersion](API_DeleteIntentVersion.md) operation.

 You can delete a version of an intent only if it is not referenced. To delete an intent that is referred to in one or more bots (see [Amazon Lex: How It Works](how-it-works.md)), you must remove those references first. 

**Note**  
 If you get the `ResourceInUseException` exception, it provides an example reference that shows where the intent is referenced. To remove the reference to the intent, either update the bot or delete it. If you get the same exception when you attempt to delete the intent again, repeat until the intent has no references and the call to `DeleteIntent` is successful. 

 This operation requires permission for the `lex:DeleteIntent` action. 

## Request Syntax
<a name="API_DeleteIntent_RequestSyntax"></a>

```
DELETE /intents/name HTTP/1.1
```

## URI Request Parameters
<a name="API_DeleteIntent_RequestParameters"></a>

The request uses the following URI parameters.

 ** [name](#API_DeleteIntent_RequestSyntax) **   <a name="lex-DeleteIntent-request-uri-name"></a>
The name of the intent. The name is case sensitive.   
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `^([A-Za-z]_?)+$`   
Required: Yes

## Request Body
<a name="API_DeleteIntent_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_DeleteIntent_ResponseSyntax"></a>

```
HTTP/1.1 204
```

## Response Elements
<a name="API_DeleteIntent_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.

## Errors
<a name="API_DeleteIntent_Errors"></a>

 ** BadRequestException **   
The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and try again.  
HTTP Status Code: 400

 ** ConflictException **   
 There was a conflict processing the request. Try your request again.   
HTTP Status Code: 409

 ** InternalFailureException **   
An internal Amazon Lex error occurred. Try your request again.  
HTTP Status Code: 500

 ** LimitExceededException **   
The request exceeded a limit. Try your request again.  
HTTP Status Code: 429

 ** NotFoundException **   
The resource specified in the request was not found. Check the resource and try again.  
HTTP Status Code: 404

 ** ResourceInUseException **   
The resource that you are attempting to delete is referred to by another resource. Use this information to remove references to the resource that you are trying to delete.  
The body of the exception contains a JSON object that describes the resource.  
 `{ "resourceType": BOT | BOTALIAS | BOTCHANNEL | INTENT,`   
 `"resourceReference": {`   
 `"name": string, "version": string } }`     
 ** exampleReference **   
Describes the resource that refers to the resource that you are attempting to delete. This object is returned as part of the `ResourceInUseException` exception. 
HTTP Status Code: 400

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

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/lex-models-2017-04-19/DeleteIntent) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lex-models-2017-04-19/DeleteIntent) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lex-models-2017-04-19/DeleteIntent) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lex-models-2017-04-19/DeleteIntent) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lex-models-2017-04-19/DeleteIntent) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lex-models-2017-04-19/DeleteIntent) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lex-models-2017-04-19/DeleteIntent) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lex-models-2017-04-19/DeleteIntent) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lex-models-2017-04-19/DeleteIntent) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lex-models-2017-04-19/DeleteIntent) 

# DeleteIntentVersion
<a name="API_DeleteIntentVersion"></a>

Deletes a specific version of an intent. To delete all versions of a intent, use the [DeleteIntent](API_DeleteIntent.md) operation. 

This operation requires permissions for the `lex:DeleteIntentVersion` action.

## Request Syntax
<a name="API_DeleteIntentVersion_RequestSyntax"></a>

```
DELETE /intents/name/versions/version HTTP/1.1
```

## URI Request Parameters
<a name="API_DeleteIntentVersion_RequestParameters"></a>

The request uses the following URI parameters.

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

 ** [version](#API_DeleteIntentVersion_RequestSyntax) **   <a name="lex-DeleteIntentVersion-request-uri-version"></a>
The version of the intent to delete. You cannot delete the `$LATEST` version of the intent. To delete the `$LATEST` version, use the [DeleteIntent](API_DeleteIntent.md) operation.  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `[0-9]+`   
Required: Yes

## Request Body
<a name="API_DeleteIntentVersion_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_DeleteIntentVersion_ResponseSyntax"></a>

```
HTTP/1.1 204
```

## Response Elements
<a name="API_DeleteIntentVersion_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.

## Errors
<a name="API_DeleteIntentVersion_Errors"></a>

 ** BadRequestException **   
The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and try again.  
HTTP Status Code: 400

 ** ConflictException **   
 There was a conflict processing the request. Try your request again.   
HTTP Status Code: 409

 ** InternalFailureException **   
An internal Amazon Lex error occurred. Try your request again.  
HTTP Status Code: 500

 ** LimitExceededException **   
The request exceeded a limit. Try your request again.  
HTTP Status Code: 429

 ** NotFoundException **   
The resource specified in the request was not found. Check the resource and try again.  
HTTP Status Code: 404

 ** ResourceInUseException **   
The resource that you are attempting to delete is referred to by another resource. Use this information to remove references to the resource that you are trying to delete.  
The body of the exception contains a JSON object that describes the resource.  
 `{ "resourceType": BOT | BOTALIAS | BOTCHANNEL | INTENT,`   
 `"resourceReference": {`   
 `"name": string, "version": string } }`     
 ** exampleReference **   
Describes the resource that refers to the resource that you are attempting to delete. This object is returned as part of the `ResourceInUseException` exception. 
HTTP Status Code: 400

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

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/lex-models-2017-04-19/DeleteIntentVersion) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lex-models-2017-04-19/DeleteIntentVersion) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lex-models-2017-04-19/DeleteIntentVersion) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lex-models-2017-04-19/DeleteIntentVersion) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lex-models-2017-04-19/DeleteIntentVersion) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lex-models-2017-04-19/DeleteIntentVersion) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lex-models-2017-04-19/DeleteIntentVersion) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lex-models-2017-04-19/DeleteIntentVersion) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lex-models-2017-04-19/DeleteIntentVersion) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lex-models-2017-04-19/DeleteIntentVersion) 

# DeleteSlotType
<a name="API_DeleteSlotType"></a>

Deletes all versions of the slot type, including the `$LATEST` version. To delete a specific version of the slot type, use the [DeleteSlotTypeVersion](API_DeleteSlotTypeVersion.md) operation.

 You can delete a version of a slot type only if it is not referenced. To delete a slot type that is referred to in one or more intents, you must remove those references first. 

**Note**  
 If you get the `ResourceInUseException` exception, the exception provides an example reference that shows the intent where the slot type is referenced. To remove the reference to the slot type, either update the intent or delete it. If you get the same exception when you attempt to delete the slot type again, repeat until the slot type has no references and the `DeleteSlotType` call is successful. 

This operation requires permission for the `lex:DeleteSlotType` action.

## Request Syntax
<a name="API_DeleteSlotType_RequestSyntax"></a>

```
DELETE /slottypes/name HTTP/1.1
```

## URI Request Parameters
<a name="API_DeleteSlotType_RequestParameters"></a>

The request uses the following URI parameters.

 ** [name](#API_DeleteSlotType_RequestSyntax) **   <a name="lex-DeleteSlotType-request-uri-name"></a>
The name of the slot type. The name is case sensitive.   
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `^([A-Za-z]_?)+$`   
Required: Yes

## Request Body
<a name="API_DeleteSlotType_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_DeleteSlotType_ResponseSyntax"></a>

```
HTTP/1.1 204
```

## Response Elements
<a name="API_DeleteSlotType_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.

## Errors
<a name="API_DeleteSlotType_Errors"></a>

 ** BadRequestException **   
The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and try again.  
HTTP Status Code: 400

 ** ConflictException **   
 There was a conflict processing the request. Try your request again.   
HTTP Status Code: 409

 ** InternalFailureException **   
An internal Amazon Lex error occurred. Try your request again.  
HTTP Status Code: 500

 ** LimitExceededException **   
The request exceeded a limit. Try your request again.  
HTTP Status Code: 429

 ** NotFoundException **   
The resource specified in the request was not found. Check the resource and try again.  
HTTP Status Code: 404

 ** ResourceInUseException **   
The resource that you are attempting to delete is referred to by another resource. Use this information to remove references to the resource that you are trying to delete.  
The body of the exception contains a JSON object that describes the resource.  
 `{ "resourceType": BOT | BOTALIAS | BOTCHANNEL | INTENT,`   
 `"resourceReference": {`   
 `"name": string, "version": string } }`     
 ** exampleReference **   
Describes the resource that refers to the resource that you are attempting to delete. This object is returned as part of the `ResourceInUseException` exception. 
HTTP Status Code: 400

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

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/lex-models-2017-04-19/DeleteSlotType) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lex-models-2017-04-19/DeleteSlotType) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lex-models-2017-04-19/DeleteSlotType) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lex-models-2017-04-19/DeleteSlotType) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lex-models-2017-04-19/DeleteSlotType) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lex-models-2017-04-19/DeleteSlotType) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lex-models-2017-04-19/DeleteSlotType) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lex-models-2017-04-19/DeleteSlotType) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lex-models-2017-04-19/DeleteSlotType) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lex-models-2017-04-19/DeleteSlotType) 

# DeleteSlotTypeVersion
<a name="API_DeleteSlotTypeVersion"></a>

Deletes a specific version of a slot type. To delete all versions of a slot type, use the [DeleteSlotType](API_DeleteSlotType.md) operation. 

This operation requires permissions for the `lex:DeleteSlotTypeVersion` action.

## Request Syntax
<a name="API_DeleteSlotTypeVersion_RequestSyntax"></a>

```
DELETE /slottypes/name/version/version HTTP/1.1
```

## URI Request Parameters
<a name="API_DeleteSlotTypeVersion_RequestParameters"></a>

The request uses the following URI parameters.

 ** [name](#API_DeleteSlotTypeVersion_RequestSyntax) **   <a name="lex-DeleteSlotTypeVersion-request-uri-name"></a>
The name of the slot type.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `^([A-Za-z]_?)+$`   
Required: Yes

 ** [version](#API_DeleteSlotTypeVersion_RequestSyntax) **   <a name="lex-DeleteSlotTypeVersion-request-uri-version"></a>
The version of the slot type to delete. You cannot delete the `$LATEST` version of the slot type. To delete the `$LATEST` version, use the [DeleteSlotType](API_DeleteSlotType.md) operation.  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `[0-9]+`   
Required: Yes

## Request Body
<a name="API_DeleteSlotTypeVersion_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_DeleteSlotTypeVersion_ResponseSyntax"></a>

```
HTTP/1.1 204
```

## Response Elements
<a name="API_DeleteSlotTypeVersion_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.

## Errors
<a name="API_DeleteSlotTypeVersion_Errors"></a>

 ** BadRequestException **   
The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and try again.  
HTTP Status Code: 400

 ** ConflictException **   
 There was a conflict processing the request. Try your request again.   
HTTP Status Code: 409

 ** InternalFailureException **   
An internal Amazon Lex error occurred. Try your request again.  
HTTP Status Code: 500

 ** LimitExceededException **   
The request exceeded a limit. Try your request again.  
HTTP Status Code: 429

 ** NotFoundException **   
The resource specified in the request was not found. Check the resource and try again.  
HTTP Status Code: 404

 ** ResourceInUseException **   
The resource that you are attempting to delete is referred to by another resource. Use this information to remove references to the resource that you are trying to delete.  
The body of the exception contains a JSON object that describes the resource.  
 `{ "resourceType": BOT | BOTALIAS | BOTCHANNEL | INTENT,`   
 `"resourceReference": {`   
 `"name": string, "version": string } }`     
 ** exampleReference **   
Describes the resource that refers to the resource that you are attempting to delete. This object is returned as part of the `ResourceInUseException` exception. 
HTTP Status Code: 400

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

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/lex-models-2017-04-19/DeleteSlotTypeVersion) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lex-models-2017-04-19/DeleteSlotTypeVersion) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lex-models-2017-04-19/DeleteSlotTypeVersion) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lex-models-2017-04-19/DeleteSlotTypeVersion) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lex-models-2017-04-19/DeleteSlotTypeVersion) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lex-models-2017-04-19/DeleteSlotTypeVersion) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lex-models-2017-04-19/DeleteSlotTypeVersion) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lex-models-2017-04-19/DeleteSlotTypeVersion) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lex-models-2017-04-19/DeleteSlotTypeVersion) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lex-models-2017-04-19/DeleteSlotTypeVersion) 

# DeleteUtterances
<a name="API_DeleteUtterances"></a>

Deletes stored utterances.

Amazon Lex stores the utterances that users send to your bot. Utterances are stored for 15 days for use with the [GetUtterancesView](API_GetUtterancesView.md) operation, and then stored indefinitely for use in improving the ability of your bot to respond to user input.

Use the `DeleteUtterances` operation to manually delete stored utterances for a specific user. When you use the `DeleteUtterances` operation, utterances stored for improving your bot's ability to respond to user input are deleted immediately. Utterances stored for use with the `GetUtterancesView` operation are deleted after 15 days.

This operation requires permissions for the `lex:DeleteUtterances` action.

## Request Syntax
<a name="API_DeleteUtterances_RequestSyntax"></a>

```
DELETE /bots/botName/utterances/userId HTTP/1.1
```

## URI Request Parameters
<a name="API_DeleteUtterances_RequestParameters"></a>

The request uses the following URI parameters.

 ** [botName](#API_DeleteUtterances_RequestSyntax) **   <a name="lex-DeleteUtterances-request-uri-botName"></a>
The name of the bot that stored the utterances.  
Length Constraints: Minimum length of 2. Maximum length of 50.  
Pattern: `^([A-Za-z]_?)+$`   
Required: Yes

 ** [userId](#API_DeleteUtterances_RequestSyntax) **   <a name="lex-DeleteUtterances-request-uri-userId"></a>
 The unique identifier for the user that made the utterances. This is the user ID that was sent in the [PostContent](http://docs.aws.amazon.com/lex/latest/dg/API_runtime_PostContent.html) or [PostText](http://docs.aws.amazon.com/lex/latest/dg/API_runtime_PostText.html) operation request that contained the utterance.  
Length Constraints: Minimum length of 2. Maximum length of 100.  
Required: Yes

## Request Body
<a name="API_DeleteUtterances_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_DeleteUtterances_ResponseSyntax"></a>

```
HTTP/1.1 204
```

## Response Elements
<a name="API_DeleteUtterances_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.

## Errors
<a name="API_DeleteUtterances_Errors"></a>

 ** BadRequestException **   
The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and try again.  
HTTP Status Code: 400

 ** InternalFailureException **   
An internal Amazon Lex error occurred. Try your request again.  
HTTP Status Code: 500

 ** LimitExceededException **   
The request exceeded a limit. Try your request again.  
HTTP Status Code: 429

 ** NotFoundException **   
The resource specified in the request was not found. Check the resource and try again.  
HTTP Status Code: 404

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

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/lex-models-2017-04-19/DeleteUtterances) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lex-models-2017-04-19/DeleteUtterances) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lex-models-2017-04-19/DeleteUtterances) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lex-models-2017-04-19/DeleteUtterances) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lex-models-2017-04-19/DeleteUtterances) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lex-models-2017-04-19/DeleteUtterances) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lex-models-2017-04-19/DeleteUtterances) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lex-models-2017-04-19/DeleteUtterances) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lex-models-2017-04-19/DeleteUtterances) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lex-models-2017-04-19/DeleteUtterances) 

# GetBot
<a name="API_GetBot"></a>

Returns metadata information for a specific bot. You must provide the bot name and the bot version or alias. 

 This operation requires permissions for the `lex:GetBot` action. 

## Request Syntax
<a name="API_GetBot_RequestSyntax"></a>

```
GET /bots/name/versions/versionoralias HTTP/1.1
```

## URI Request Parameters
<a name="API_GetBot_RequestParameters"></a>

The request uses the following URI parameters.

 ** [name](#API_GetBot_RequestSyntax) **   <a name="lex-GetBot-request-uri-name"></a>
The name of the bot. The name is case sensitive.   
Length Constraints: Minimum length of 2. Maximum length of 50.  
Pattern: `^([A-Za-z]_?)+$`   
Required: Yes

 ** [versionoralias](#API_GetBot_RequestSyntax) **   <a name="lex-GetBot-request-uri-versionOrAlias"></a>
The version or alias of the bot.  
Required: Yes

## Request Body
<a name="API_GetBot_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_GetBot_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "abortStatement": { 
      "messages": [ 
         { 
            "content": "string",
            "contentType": "string",
            "groupNumber": number
         }
      ],
      "responseCard": "string"
   },
   "checksum": "string",
   "childDirected": boolean,
   "clarificationPrompt": { 
      "maxAttempts": number,
      "messages": [ 
         { 
            "content": "string",
            "contentType": "string",
            "groupNumber": number
         }
      ],
      "responseCard": "string"
   },
   "createdDate": number,
   "description": "string",
   "detectSentiment": boolean,
   "enableModelImprovements": boolean,
   "failureReason": "string",
   "idleSessionTTLInSeconds": number,
   "intents": [ 
      { 
         "intentName": "string",
         "intentVersion": "string"
      }
   ],
   "lastUpdatedDate": number,
   "locale": "string",
   "name": "string",
   "nluIntentConfidenceThreshold": number,
   "status": "string",
   "version": "string",
   "voiceId": "string"
}
```

## Response Elements
<a name="API_GetBot_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [abortStatement](#API_GetBot_ResponseSyntax) **   <a name="lex-GetBot-response-abortStatement"></a>
The message that Amazon Lex returns when the user elects to end the conversation without completing it. For more information, see [PutBot](API_PutBot.md).  
Type: [Statement](API_Statement.md) object

 ** [checksum](#API_GetBot_ResponseSyntax) **   <a name="lex-GetBot-response-checksum"></a>
Checksum of the bot used to identify a specific revision of the bot's `$LATEST` version.  
Type: String

 ** [childDirected](#API_GetBot_ResponseSyntax) **   <a name="lex-GetBot-response-childDirected"></a>
For each Amazon Lex bot created with the Amazon Lex Model Building Service, you must specify whether your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to the Children's Online Privacy Protection Act (COPPA) by specifying `true` or `false` in the `childDirected` field. By specifying `true` in the `childDirected` field, you confirm that your use of Amazon Lex **is** related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA. By specifying `false` in the `childDirected` field, you confirm that your use of Amazon Lex **is not** related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA. You may not specify a default value for the `childDirected` field that does not accurately reflect whether your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA.  
If your use of Amazon Lex relates to a website, program, or other application that is directed in whole or in part, to children under age 13, you must obtain any required verifiable parental consent under COPPA. For information regarding the use of Amazon Lex in connection with websites, programs, or other applications that are directed or targeted, in whole or in part, to children under age 13, see the [Amazon Lex FAQ.](https://aws.amazon.com/lex/faqs#data-security)   
Type: Boolean

 ** [clarificationPrompt](#API_GetBot_ResponseSyntax) **   <a name="lex-GetBot-response-clarificationPrompt"></a>
The message Amazon Lex uses when it doesn't understand the user's request. For more information, see [PutBot](API_PutBot.md).   
Type: [Prompt](API_Prompt.md) object

 ** [createdDate](#API_GetBot_ResponseSyntax) **   <a name="lex-GetBot-response-createdDate"></a>
The date that the bot was created.  
Type: Timestamp

 ** [description](#API_GetBot_ResponseSyntax) **   <a name="lex-GetBot-response-description"></a>
A description of the bot.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 200.

 ** [detectSentiment](#API_GetBot_ResponseSyntax) **   <a name="lex-GetBot-response-detectSentiment"></a>
Indicates whether user utterances should be sent to Amazon Comprehend for sentiment analysis.  
Type: Boolean

 ** [enableModelImprovements](#API_GetBot_ResponseSyntax) **   <a name="lex-GetBot-response-enableModelImprovements"></a>
Indicates whether the bot uses accuracy improvements. `true` indicates that the bot is using the improvements, otherwise, `false`.  
Type: Boolean

 ** [failureReason](#API_GetBot_ResponseSyntax) **   <a name="lex-GetBot-response-failureReason"></a>
If `status` is `FAILED`, Amazon Lex explains why it failed to build the bot.  
Type: String

 ** [idleSessionTTLInSeconds](#API_GetBot_ResponseSyntax) **   <a name="lex-GetBot-response-idleSessionTTLInSeconds"></a>
The maximum time in seconds that Amazon Lex retains the data gathered in a conversation. For more information, see [PutBot](API_PutBot.md).  
Type: Integer  
Valid Range: Minimum value of 60. Maximum value of 86400.

 ** [intents](#API_GetBot_ResponseSyntax) **   <a name="lex-GetBot-response-intents"></a>
An array of `intent` objects. For more information, see [PutBot](API_PutBot.md).  
Type: Array of [Intent](API_Intent.md) objects

 ** [lastUpdatedDate](#API_GetBot_ResponseSyntax) **   <a name="lex-GetBot-response-lastUpdatedDate"></a>
The date that the bot was updated. When you create a resource, the creation date and last updated date are the same.   
Type: Timestamp

 ** [locale](#API_GetBot_ResponseSyntax) **   <a name="lex-GetBot-response-locale"></a>
 The target locale for the bot.   
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` 

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

 ** [nluIntentConfidenceThreshold](#API_GetBot_ResponseSyntax) **   <a name="lex-GetBot-response-nluIntentConfidenceThreshold"></a>
The score that determines where Amazon Lex inserts the `AMAZON.FallbackIntent`, `AMAZON.KendraSearchIntent`, or both when returning alternative intents in a [PostContent](https://docs.aws.amazon.com/lex/latest/dg/API_runtime_PostContent.html) or [PostText](https://docs.aws.amazon.com/lex/latest/dg/API_runtime_PostText.html) response. `AMAZON.FallbackIntent` is inserted if the confidence score for all intents is below this value. `AMAZON.KendraSearchIntent` is only inserted if it is configured for the bot.  
Type: Double  
Valid Range: Minimum value of 0. Maximum value of 1.

 ** [status](#API_GetBot_ResponseSyntax) **   <a name="lex-GetBot-response-status"></a>
The status of the bot.   
When the status is `BUILDING` Amazon Lex is building the bot for testing and use.  
If the status of the bot is `READY_BASIC_TESTING`, you can test the bot using the exact utterances specified in the bot's intents. When the bot is ready for full testing or to run, the status is `READY`.  
If there was a problem with building the bot, the status is `FAILED` and the `failureReason` field explains why the bot did not build.  
If the bot was saved but not built, the status is `NOT_BUILT`.  
Type: String  
Valid Values: `BUILDING | READY | READY_BASIC_TESTING | FAILED | NOT_BUILT` 

 ** [version](#API_GetBot_ResponseSyntax) **   <a name="lex-GetBot-response-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]+` 

 ** [voiceId](#API_GetBot_ResponseSyntax) **   <a name="lex-GetBot-response-voiceId"></a>
The Amazon Polly voice ID that Amazon Lex uses for voice interaction with the user. For more information, see [PutBot](API_PutBot.md).  
Type: String

## Errors
<a name="API_GetBot_Errors"></a>

 ** BadRequestException **   
The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and try again.  
HTTP Status Code: 400

 ** InternalFailureException **   
An internal Amazon Lex error occurred. Try your request again.  
HTTP Status Code: 500

 ** LimitExceededException **   
The request exceeded a limit. Try your request again.  
HTTP Status Code: 429

 ** NotFoundException **   
The resource specified in the request was not found. Check the resource and try again.  
HTTP Status Code: 404

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

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/lex-models-2017-04-19/GetBot) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lex-models-2017-04-19/GetBot) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lex-models-2017-04-19/GetBot) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lex-models-2017-04-19/GetBot) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lex-models-2017-04-19/GetBot) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lex-models-2017-04-19/GetBot) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lex-models-2017-04-19/GetBot) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lex-models-2017-04-19/GetBot) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lex-models-2017-04-19/GetBot) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lex-models-2017-04-19/GetBot) 

# GetBotAlias
<a name="API_GetBotAlias"></a>

Returns information about an Amazon Lex bot alias. For more information about aliases, see [Versioning and Aliases](versioning-aliases.md).

This operation requires permissions for the `lex:GetBotAlias` action.

## Request Syntax
<a name="API_GetBotAlias_RequestSyntax"></a>

```
GET /bots/botName/aliases/name HTTP/1.1
```

## URI Request Parameters
<a name="API_GetBotAlias_RequestParameters"></a>

The request uses the following URI parameters.

 ** [botName](#API_GetBotAlias_RequestSyntax) **   <a name="lex-GetBotAlias-request-uri-botName"></a>
The name of the bot.  
Length Constraints: Minimum length of 2. Maximum length of 50.  
Pattern: `^([A-Za-z]_?)+$`   
Required: Yes

 ** [name](#API_GetBotAlias_RequestSyntax) **   <a name="lex-GetBotAlias-request-uri-name"></a>
The name of the bot alias. The name is case sensitive.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `^([A-Za-z]_?)+$`   
Required: Yes

## Request Body
<a name="API_GetBotAlias_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_GetBotAlias_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "botName": "string",
   "botVersion": "string",
   "checksum": "string",
   "conversationLogs": { 
      "iamRoleArn": "string",
      "logSettings": [ 
         { 
            "destination": "string",
            "kmsKeyArn": "string",
            "logType": "string",
            "resourceArn": "string",
            "resourcePrefix": "string"
         }
      ]
   },
   "createdDate": number,
   "description": "string",
   "lastUpdatedDate": number,
   "name": "string"
}
```

## Response Elements
<a name="API_GetBotAlias_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

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

 ** [botVersion](#API_GetBotAlias_ResponseSyntax) **   <a name="lex-GetBotAlias-response-botVersion"></a>
The version of the bot that the alias points to.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `\$LATEST|[0-9]+` 

 ** [checksum](#API_GetBotAlias_ResponseSyntax) **   <a name="lex-GetBotAlias-response-checksum"></a>
Checksum of the bot alias.  
Type: String

 ** [conversationLogs](#API_GetBotAlias_ResponseSyntax) **   <a name="lex-GetBotAlias-response-conversationLogs"></a>
The settings that determine how Amazon Lex uses conversation logs for the alias.  
Type: [ConversationLogsResponse](API_ConversationLogsResponse.md) object

 ** [createdDate](#API_GetBotAlias_ResponseSyntax) **   <a name="lex-GetBotAlias-response-createdDate"></a>
The date that the bot alias was created.  
Type: Timestamp

 ** [description](#API_GetBotAlias_ResponseSyntax) **   <a name="lex-GetBotAlias-response-description"></a>
A description of the bot alias.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 200.

 ** [lastUpdatedDate](#API_GetBotAlias_ResponseSyntax) **   <a name="lex-GetBotAlias-response-lastUpdatedDate"></a>
The date that the bot alias was updated. When you create a resource, the creation date and the last updated date are the same.  
Type: Timestamp

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

## Errors
<a name="API_GetBotAlias_Errors"></a>

 ** BadRequestException **   
The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and try again.  
HTTP Status Code: 400

 ** InternalFailureException **   
An internal Amazon Lex error occurred. Try your request again.  
HTTP Status Code: 500

 ** LimitExceededException **   
The request exceeded a limit. Try your request again.  
HTTP Status Code: 429

 ** NotFoundException **   
The resource specified in the request was not found. Check the resource and try again.  
HTTP Status Code: 404

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

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/lex-models-2017-04-19/GetBotAlias) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lex-models-2017-04-19/GetBotAlias) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lex-models-2017-04-19/GetBotAlias) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lex-models-2017-04-19/GetBotAlias) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lex-models-2017-04-19/GetBotAlias) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lex-models-2017-04-19/GetBotAlias) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lex-models-2017-04-19/GetBotAlias) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lex-models-2017-04-19/GetBotAlias) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lex-models-2017-04-19/GetBotAlias) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lex-models-2017-04-19/GetBotAlias) 

# GetBotAliases
<a name="API_GetBotAliases"></a>

Returns a list of aliases for a specified Amazon Lex bot.

This operation requires permissions for the `lex:GetBotAliases` action.

## Request Syntax
<a name="API_GetBotAliases_RequestSyntax"></a>

```
GET /bots/botName/aliases/?maxResults=maxResults&nameContains=nameContains&nextToken=nextToken HTTP/1.1
```

## URI Request Parameters
<a name="API_GetBotAliases_RequestParameters"></a>

The request uses the following URI parameters.

 ** [botName](#API_GetBotAliases_RequestSyntax) **   <a name="lex-GetBotAliases-request-uri-botName"></a>
The name of the bot.  
Length Constraints: Minimum length of 2. Maximum length of 50.  
Pattern: `^([A-Za-z]_?)+$`   
Required: Yes

 ** [maxResults](#API_GetBotAliases_RequestSyntax) **   <a name="lex-GetBotAliases-request-uri-maxResults"></a>
The maximum number of aliases to return in the response. The default is 50. .   
Valid Range: Minimum value of 1. Maximum value of 50.

 ** [nameContains](#API_GetBotAliases_RequestSyntax) **   <a name="lex-GetBotAliases-request-uri-nameContains"></a>
Substring to match in bot alias names. An alias will be returned if any part of its name matches the substring. For example, "xyz" matches both "xyzabc" and "abcxyz."  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `^([A-Za-z]_?)+$` 

 ** [nextToken](#API_GetBotAliases_RequestSyntax) **   <a name="lex-GetBotAliases-request-uri-nextToken"></a>
A pagination token for fetching the next page of aliases. If the response to this call is truncated, Amazon Lex returns a pagination token in the response. To fetch the next page of aliases, specify the pagination token in the next request. 

## Request Body
<a name="API_GetBotAliases_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_GetBotAliases_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "BotAliases": [ 
      { 
         "botName": "string",
         "botVersion": "string",
         "checksum": "string",
         "conversationLogs": { 
            "iamRoleArn": "string",
            "logSettings": [ 
               { 
                  "destination": "string",
                  "kmsKeyArn": "string",
                  "logType": "string",
                  "resourceArn": "string",
                  "resourcePrefix": "string"
               }
            ]
         },
         "createdDate": number,
         "description": "string",
         "lastUpdatedDate": number,
         "name": "string"
      }
   ],
   "nextToken": "string"
}
```

## Response Elements
<a name="API_GetBotAliases_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [BotAliases](#API_GetBotAliases_ResponseSyntax) **   <a name="lex-GetBotAliases-response-BotAliases"></a>
An array of `BotAliasMetadata` objects, each describing a bot alias.  
Type: Array of [BotAliasMetadata](API_BotAliasMetadata.md) objects

 ** [nextToken](#API_GetBotAliases_ResponseSyntax) **   <a name="lex-GetBotAliases-response-nextToken"></a>
A pagination token for fetching next page of aliases. If the response to this call is truncated, Amazon Lex returns a pagination token in the response. To fetch the next page of aliases, specify the pagination token in the next request.   
Type: String

## Errors
<a name="API_GetBotAliases_Errors"></a>

 ** BadRequestException **   
The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and try again.  
HTTP Status Code: 400

 ** InternalFailureException **   
An internal Amazon Lex error occurred. Try your request again.  
HTTP Status Code: 500

 ** LimitExceededException **   
The request exceeded a limit. Try your request again.  
HTTP Status Code: 429

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

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/lex-models-2017-04-19/GetBotAliases) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lex-models-2017-04-19/GetBotAliases) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lex-models-2017-04-19/GetBotAliases) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lex-models-2017-04-19/GetBotAliases) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lex-models-2017-04-19/GetBotAliases) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lex-models-2017-04-19/GetBotAliases) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lex-models-2017-04-19/GetBotAliases) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lex-models-2017-04-19/GetBotAliases) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lex-models-2017-04-19/GetBotAliases) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lex-models-2017-04-19/GetBotAliases) 

# GetBotChannelAssociation
<a name="API_GetBotChannelAssociation"></a>

Returns information about the association between an Amazon Lex bot and a messaging platform.

This operation requires permissions for the `lex:GetBotChannelAssociation` action.

## Request Syntax
<a name="API_GetBotChannelAssociation_RequestSyntax"></a>

```
GET /bots/botName/aliases/aliasName/channels/name HTTP/1.1
```

## URI Request Parameters
<a name="API_GetBotChannelAssociation_RequestParameters"></a>

The request uses the following URI parameters.

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

 ** [botName](#API_GetBotChannelAssociation_RequestSyntax) **   <a name="lex-GetBotChannelAssociation-request-uri-botName"></a>
The name of the Amazon Lex bot.  
Length Constraints: Minimum length of 2. Maximum length of 50.  
Pattern: `^([A-Za-z]_?)+$`   
Required: Yes

 ** [name](#API_GetBotChannelAssociation_RequestSyntax) **   <a name="lex-GetBotChannelAssociation-request-uri-name"></a>
The name of the association between the bot and the channel. The name is case sensitive.   
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `^([A-Za-z]_?)+$`   
Required: Yes

## Request Body
<a name="API_GetBotChannelAssociation_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_GetBotChannelAssociation_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "botAlias": "string",
   "botConfiguration": { 
      "string" : "string" 
   },
   "botName": "string",
   "createdDate": number,
   "description": "string",
   "failureReason": "string",
   "name": "string",
   "status": "string",
   "type": "string"
}
```

## Response Elements
<a name="API_GetBotChannelAssociation_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [botAlias](#API_GetBotChannelAssociation_ResponseSyntax) **   <a name="lex-GetBotChannelAssociation-response-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]_?)+$` 

 ** [botConfiguration](#API_GetBotChannelAssociation_ResponseSyntax) **   <a name="lex-GetBotChannelAssociation-response-botConfiguration"></a>
Provides information that the messaging platform needs to communicate with the Amazon Lex bot.  
Type: String to string map  
Map Entries: Maximum number of 10 items.

 ** [botName](#API_GetBotChannelAssociation_ResponseSyntax) **   <a name="lex-GetBotChannelAssociation-response-botName"></a>
The name of the Amazon Lex bot.  
Type: String  
Length Constraints: Minimum length of 2. Maximum length of 50.  
Pattern: `^([A-Za-z]_?)+$` 

 ** [createdDate](#API_GetBotChannelAssociation_ResponseSyntax) **   <a name="lex-GetBotChannelAssociation-response-createdDate"></a>
The date that the association between the bot and the channel was created.  
Type: Timestamp

 ** [description](#API_GetBotChannelAssociation_ResponseSyntax) **   <a name="lex-GetBotChannelAssociation-response-description"></a>
A description of the association between the bot and the channel.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 200.

 ** [failureReason](#API_GetBotChannelAssociation_ResponseSyntax) **   <a name="lex-GetBotChannelAssociation-response-failureReason"></a>
If `status` is `FAILED`, Amazon Lex provides the reason that it failed to create the association.  
Type: String

 ** [name](#API_GetBotChannelAssociation_ResponseSyntax) **   <a name="lex-GetBotChannelAssociation-response-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]_?)+$` 

 ** [status](#API_GetBotChannelAssociation_ResponseSyntax) **   <a name="lex-GetBotChannelAssociation-response-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` 

 ** [type](#API_GetBotChannelAssociation_ResponseSyntax) **   <a name="lex-GetBotChannelAssociation-response-type"></a>
The type of the messaging platform.  
Type: String  
Valid Values: `Facebook | Slack | Twilio-Sms | Kik` 

## Errors
<a name="API_GetBotChannelAssociation_Errors"></a>

 ** BadRequestException **   
The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and try again.  
HTTP Status Code: 400

 ** InternalFailureException **   
An internal Amazon Lex error occurred. Try your request again.  
HTTP Status Code: 500

 ** LimitExceededException **   
The request exceeded a limit. Try your request again.  
HTTP Status Code: 429

 ** NotFoundException **   
The resource specified in the request was not found. Check the resource and try again.  
HTTP Status Code: 404

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

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/lex-models-2017-04-19/GetBotChannelAssociation) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lex-models-2017-04-19/GetBotChannelAssociation) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lex-models-2017-04-19/GetBotChannelAssociation) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lex-models-2017-04-19/GetBotChannelAssociation) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lex-models-2017-04-19/GetBotChannelAssociation) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lex-models-2017-04-19/GetBotChannelAssociation) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lex-models-2017-04-19/GetBotChannelAssociation) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lex-models-2017-04-19/GetBotChannelAssociation) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lex-models-2017-04-19/GetBotChannelAssociation) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lex-models-2017-04-19/GetBotChannelAssociation) 

# GetBotChannelAssociations
<a name="API_GetBotChannelAssociations"></a>

 Returns a list of all of the channels associated with the specified bot. 

The `GetBotChannelAssociations` operation requires permissions for the `lex:GetBotChannelAssociations` action.

## Request Syntax
<a name="API_GetBotChannelAssociations_RequestSyntax"></a>

```
GET /bots/botName/aliases/aliasName/channels/?maxResults=maxResults&nameContains=nameContains&nextToken=nextToken HTTP/1.1
```

## URI Request Parameters
<a name="API_GetBotChannelAssociations_RequestParameters"></a>

The request uses the following URI parameters.

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

 ** [botName](#API_GetBotChannelAssociations_RequestSyntax) **   <a name="lex-GetBotChannelAssociations-request-uri-botName"></a>
The name of the Amazon Lex bot in the association.  
Length Constraints: Minimum length of 2. Maximum length of 50.  
Pattern: `^([A-Za-z]_?)+$`   
Required: Yes

 ** [maxResults](#API_GetBotChannelAssociations_RequestSyntax) **   <a name="lex-GetBotChannelAssociations-request-uri-maxResults"></a>
The maximum number of associations to return in the response. The default is 50.   
Valid Range: Minimum value of 1. Maximum value of 50.

 ** [nameContains](#API_GetBotChannelAssociations_RequestSyntax) **   <a name="lex-GetBotChannelAssociations-request-uri-nameContains"></a>
Substring to match in channel association names. An association will be returned if any part of its name matches the substring. For example, "xyz" matches both "xyzabc" and "abcxyz." To return all bot channel associations, use a hyphen ("-") as the `nameContains` parameter.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `^([A-Za-z]_?)+$` 

 ** [nextToken](#API_GetBotChannelAssociations_RequestSyntax) **   <a name="lex-GetBotChannelAssociations-request-uri-nextToken"></a>
A pagination token for fetching the next page of associations. If the response to this call is truncated, Amazon Lex returns a pagination token in the response. To fetch the next page of associations, specify the pagination token in the next request. 

## Request Body
<a name="API_GetBotChannelAssociations_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_GetBotChannelAssociations_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "botChannelAssociations": [ 
      { 
         "botAlias": "string",
         "botConfiguration": { 
            "string" : "string" 
         },
         "botName": "string",
         "createdDate": number,
         "description": "string",
         "failureReason": "string",
         "name": "string",
         "status": "string",
         "type": "string"
      }
   ],
   "nextToken": "string"
}
```

## Response Elements
<a name="API_GetBotChannelAssociations_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [botChannelAssociations](#API_GetBotChannelAssociations_ResponseSyntax) **   <a name="lex-GetBotChannelAssociations-response-botChannelAssociations"></a>
An array of objects, one for each association, that provides information about the Amazon Lex bot and its association with the channel.   
Type: Array of [BotChannelAssociation](API_BotChannelAssociation.md) objects

 ** [nextToken](#API_GetBotChannelAssociations_ResponseSyntax) **   <a name="lex-GetBotChannelAssociations-response-nextToken"></a>
A pagination token that fetches the next page of associations. If the response to this call is truncated, Amazon Lex returns a pagination token in the response. To fetch the next page of associations, specify the pagination token in the next request.   
Type: String

## Errors
<a name="API_GetBotChannelAssociations_Errors"></a>

 ** BadRequestException **   
The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and try again.  
HTTP Status Code: 400

 ** InternalFailureException **   
An internal Amazon Lex error occurred. Try your request again.  
HTTP Status Code: 500

 ** LimitExceededException **   
The request exceeded a limit. Try your request again.  
HTTP Status Code: 429

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

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/lex-models-2017-04-19/GetBotChannelAssociations) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lex-models-2017-04-19/GetBotChannelAssociations) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lex-models-2017-04-19/GetBotChannelAssociations) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lex-models-2017-04-19/GetBotChannelAssociations) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lex-models-2017-04-19/GetBotChannelAssociations) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lex-models-2017-04-19/GetBotChannelAssociations) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lex-models-2017-04-19/GetBotChannelAssociations) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lex-models-2017-04-19/GetBotChannelAssociations) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lex-models-2017-04-19/GetBotChannelAssociations) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lex-models-2017-04-19/GetBotChannelAssociations) 

# GetBots
<a name="API_GetBots"></a>

Returns bot information as follows: 
+ If you provide the `nameContains` field, the response includes information for the `$LATEST` version of all bots whose name contains the specified string.
+ If you don't specify the `nameContains` field, the operation returns information about the `$LATEST` version of all of your bots.

This operation requires permission for the `lex:GetBots` action.

## Request Syntax
<a name="API_GetBots_RequestSyntax"></a>

```
GET /bots/?maxResults=maxResults&nameContains=nameContains&nextToken=nextToken HTTP/1.1
```

## URI Request Parameters
<a name="API_GetBots_RequestParameters"></a>

The request uses the following URI parameters.

 ** [maxResults](#API_GetBots_RequestSyntax) **   <a name="lex-GetBots-request-uri-maxResults"></a>
The maximum number of bots to return in the response that the request will return. The default is 10.  
Valid Range: Minimum value of 1. Maximum value of 50.

 ** [nameContains](#API_GetBots_RequestSyntax) **   <a name="lex-GetBots-request-uri-nameContains"></a>
Substring to match in bot names. A bot will be returned if any part of its name matches the substring. For example, "xyz" matches both "xyzabc" and "abcxyz."  
Length Constraints: Minimum length of 2. Maximum length of 50.  
Pattern: `^([A-Za-z]_?)+$` 

 ** [nextToken](#API_GetBots_RequestSyntax) **   <a name="lex-GetBots-request-uri-nextToken"></a>
A pagination token that fetches the next page of bots. If the response to this call is truncated, Amazon Lex returns a pagination token in the response. To fetch the next page of bots, specify the pagination token in the next request. 

## Request Body
<a name="API_GetBots_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_GetBots_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "bots": [ 
      { 
         "createdDate": number,
         "description": "string",
         "lastUpdatedDate": number,
         "name": "string",
         "status": "string",
         "version": "string"
      }
   ],
   "nextToken": "string"
}
```

## Response Elements
<a name="API_GetBots_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [bots](#API_GetBots_ResponseSyntax) **   <a name="lex-GetBots-response-bots"></a>
An array of `botMetadata` objects, with one entry for each bot.   
Type: Array of [BotMetadata](API_BotMetadata.md) objects

 ** [nextToken](#API_GetBots_ResponseSyntax) **   <a name="lex-GetBots-response-nextToken"></a>
If the response is truncated, it includes a pagination token that you can specify in your next request to fetch the next page of bots.   
Type: String

## Errors
<a name="API_GetBots_Errors"></a>

 ** BadRequestException **   
The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and try again.  
HTTP Status Code: 400

 ** InternalFailureException **   
An internal Amazon Lex error occurred. Try your request again.  
HTTP Status Code: 500

 ** LimitExceededException **   
The request exceeded a limit. Try your request again.  
HTTP Status Code: 429

 ** NotFoundException **   
The resource specified in the request was not found. Check the resource and try again.  
HTTP Status Code: 404

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

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/lex-models-2017-04-19/GetBots) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lex-models-2017-04-19/GetBots) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lex-models-2017-04-19/GetBots) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lex-models-2017-04-19/GetBots) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lex-models-2017-04-19/GetBots) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lex-models-2017-04-19/GetBots) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lex-models-2017-04-19/GetBots) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lex-models-2017-04-19/GetBots) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lex-models-2017-04-19/GetBots) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lex-models-2017-04-19/GetBots) 

# GetBotVersions
<a name="API_GetBotVersions"></a>

Gets information about all of the versions of a bot.

The `GetBotVersions` operation returns a `BotMetadata` object for each version of a bot. For example, if a bot has three numbered versions, the `GetBotVersions` operation returns four `BotMetadata` objects in the response, one for each numbered version and one for the `$LATEST` version. 

The `GetBotVersions` operation always returns at least one version, the `$LATEST` version.

This operation requires permissions for the `lex:GetBotVersions` action.

## Request Syntax
<a name="API_GetBotVersions_RequestSyntax"></a>

```
GET /bots/name/versions/?maxResults=maxResults&nextToken=nextToken HTTP/1.1
```

## URI Request Parameters
<a name="API_GetBotVersions_RequestParameters"></a>

The request uses the following URI parameters.

 ** [maxResults](#API_GetBotVersions_RequestSyntax) **   <a name="lex-GetBotVersions-request-uri-maxResults"></a>
The maximum number of bot versions to return in the response. The default is 10.  
Valid Range: Minimum value of 1. Maximum value of 50.

 ** [name](#API_GetBotVersions_RequestSyntax) **   <a name="lex-GetBotVersions-request-uri-name"></a>
The name of the bot for which versions should be returned.  
Length Constraints: Minimum length of 2. Maximum length of 50.  
Pattern: `^([A-Za-z]_?)+$`   
Required: Yes

 ** [nextToken](#API_GetBotVersions_RequestSyntax) **   <a name="lex-GetBotVersions-request-uri-nextToken"></a>
A pagination token for fetching the next page of bot versions. If the response to this call is truncated, Amazon Lex returns a pagination token in the response. To fetch the next page of versions, specify the pagination token in the next request. 

## Request Body
<a name="API_GetBotVersions_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_GetBotVersions_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "bots": [ 
      { 
         "createdDate": number,
         "description": "string",
         "lastUpdatedDate": number,
         "name": "string",
         "status": "string",
         "version": "string"
      }
   ],
   "nextToken": "string"
}
```

## Response Elements
<a name="API_GetBotVersions_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [bots](#API_GetBotVersions_ResponseSyntax) **   <a name="lex-GetBotVersions-response-bots"></a>
An array of `BotMetadata` objects, one for each numbered version of the bot plus one for the `$LATEST` version.  
Type: Array of [BotMetadata](API_BotMetadata.md) objects

 ** [nextToken](#API_GetBotVersions_ResponseSyntax) **   <a name="lex-GetBotVersions-response-nextToken"></a>
A pagination token for fetching the next page of bot versions. If the response to this call is truncated, Amazon Lex returns a pagination token in the response. To fetch the next page of versions, specify the pagination token in the next request.   
Type: String

## Errors
<a name="API_GetBotVersions_Errors"></a>

 ** BadRequestException **   
The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and try again.  
HTTP Status Code: 400

 ** InternalFailureException **   
An internal Amazon Lex error occurred. Try your request again.  
HTTP Status Code: 500

 ** LimitExceededException **   
The request exceeded a limit. Try your request again.  
HTTP Status Code: 429

 ** NotFoundException **   
The resource specified in the request was not found. Check the resource and try again.  
HTTP Status Code: 404

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

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/lex-models-2017-04-19/GetBotVersions) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lex-models-2017-04-19/GetBotVersions) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lex-models-2017-04-19/GetBotVersions) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lex-models-2017-04-19/GetBotVersions) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lex-models-2017-04-19/GetBotVersions) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lex-models-2017-04-19/GetBotVersions) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lex-models-2017-04-19/GetBotVersions) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lex-models-2017-04-19/GetBotVersions) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lex-models-2017-04-19/GetBotVersions) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lex-models-2017-04-19/GetBotVersions) 

# GetBuiltinIntent
<a name="API_GetBuiltinIntent"></a>

Returns information about a built-in intent.

This operation requires permission for the `lex:GetBuiltinIntent` action.

## Request Syntax
<a name="API_GetBuiltinIntent_RequestSyntax"></a>

```
GET /builtins/intents/signature HTTP/1.1
```

## URI Request Parameters
<a name="API_GetBuiltinIntent_RequestParameters"></a>

The request uses the following URI parameters.

 ** [signature](#API_GetBuiltinIntent_RequestSyntax) **   <a name="lex-GetBuiltinIntent-request-uri-signature"></a>
The unique identifier for a 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*.  
Required: Yes

## Request Body
<a name="API_GetBuiltinIntent_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_GetBuiltinIntent_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "signature": "string",
   "slots": [ 
      { 
         "name": "string"
      }
   ],
   "supportedLocales": [ "string" ]
}
```

## Response Elements
<a name="API_GetBuiltinIntent_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [signature](#API_GetBuiltinIntent_ResponseSyntax) **   <a name="lex-GetBuiltinIntent-response-signature"></a>
The unique identifier for a built-in intent.  
Type: String

 ** [slots](#API_GetBuiltinIntent_ResponseSyntax) **   <a name="lex-GetBuiltinIntent-response-slots"></a>
An array of `BuiltinIntentSlot` objects, one entry for each slot type in the intent.  
Type: Array of [BuiltinIntentSlot](API_BuiltinIntentSlot.md) objects

 ** [supportedLocales](#API_GetBuiltinIntent_ResponseSyntax) **   <a name="lex-GetBuiltinIntent-response-supportedLocales"></a>
A list of 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` 

## Errors
<a name="API_GetBuiltinIntent_Errors"></a>

 ** BadRequestException **   
The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and try again.  
HTTP Status Code: 400

 ** InternalFailureException **   
An internal Amazon Lex error occurred. Try your request again.  
HTTP Status Code: 500

 ** LimitExceededException **   
The request exceeded a limit. Try your request again.  
HTTP Status Code: 429

 ** NotFoundException **   
The resource specified in the request was not found. Check the resource and try again.  
HTTP Status Code: 404

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

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/lex-models-2017-04-19/GetBuiltinIntent) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lex-models-2017-04-19/GetBuiltinIntent) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lex-models-2017-04-19/GetBuiltinIntent) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lex-models-2017-04-19/GetBuiltinIntent) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lex-models-2017-04-19/GetBuiltinIntent) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lex-models-2017-04-19/GetBuiltinIntent) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lex-models-2017-04-19/GetBuiltinIntent) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lex-models-2017-04-19/GetBuiltinIntent) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lex-models-2017-04-19/GetBuiltinIntent) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lex-models-2017-04-19/GetBuiltinIntent) 

# GetBuiltinIntents
<a name="API_GetBuiltinIntents"></a>

Gets a list of built-in intents that meet the specified criteria.

This operation requires permission for the `lex:GetBuiltinIntents` action.

## Request Syntax
<a name="API_GetBuiltinIntents_RequestSyntax"></a>

```
GET /builtins/intents/?locale=locale&maxResults=maxResults&nextToken=nextToken&signatureContains=signatureContains HTTP/1.1
```

## URI Request Parameters
<a name="API_GetBuiltinIntents_RequestParameters"></a>

The request uses the following URI parameters.

 ** [locale](#API_GetBuiltinIntents_RequestSyntax) **   <a name="lex-GetBuiltinIntents-request-uri-locale"></a>
A list of locales that the intent supports.  
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` 

 ** [maxResults](#API_GetBuiltinIntents_RequestSyntax) **   <a name="lex-GetBuiltinIntents-request-uri-maxResults"></a>
The maximum number of intents to return in the response. The default is 10.  
Valid Range: Minimum value of 1. Maximum value of 50.

 ** [nextToken](#API_GetBuiltinIntents_RequestSyntax) **   <a name="lex-GetBuiltinIntents-request-uri-nextToken"></a>
A pagination token that fetches the next page of intents. If this API call is truncated, Amazon Lex returns a pagination token in the response. To fetch the next page of intents, use the pagination token in the next request.

 ** [signatureContains](#API_GetBuiltinIntents_RequestSyntax) **   <a name="lex-GetBuiltinIntents-request-uri-signatureContains"></a>
Substring to match in built-in intent signatures. An intent will be returned if any part of its signature matches the substring. For example, "xyz" matches both "xyzabc" and "abcxyz." 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*.

## Request Body
<a name="API_GetBuiltinIntents_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_GetBuiltinIntents_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "intents": [ 
      { 
         "signature": "string",
         "supportedLocales": [ "string" ]
      }
   ],
   "nextToken": "string"
}
```

## Response Elements
<a name="API_GetBuiltinIntents_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [intents](#API_GetBuiltinIntents_ResponseSyntax) **   <a name="lex-GetBuiltinIntents-response-intents"></a>
An array of `builtinIntentMetadata` objects, one for each intent in the response.  
Type: Array of [BuiltinIntentMetadata](API_BuiltinIntentMetadata.md) objects

 ** [nextToken](#API_GetBuiltinIntents_ResponseSyntax) **   <a name="lex-GetBuiltinIntents-response-nextToken"></a>
A pagination token that fetches the next page of intents. If the response to this API call is truncated, Amazon Lex returns a pagination token in the response. To fetch the next page of intents, specify the pagination token in the next request.  
Type: String

## Errors
<a name="API_GetBuiltinIntents_Errors"></a>

 ** BadRequestException **   
The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and try again.  
HTTP Status Code: 400

 ** InternalFailureException **   
An internal Amazon Lex error occurred. Try your request again.  
HTTP Status Code: 500

 ** LimitExceededException **   
The request exceeded a limit. Try your request again.  
HTTP Status Code: 429

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

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/lex-models-2017-04-19/GetBuiltinIntents) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lex-models-2017-04-19/GetBuiltinIntents) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lex-models-2017-04-19/GetBuiltinIntents) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lex-models-2017-04-19/GetBuiltinIntents) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lex-models-2017-04-19/GetBuiltinIntents) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lex-models-2017-04-19/GetBuiltinIntents) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lex-models-2017-04-19/GetBuiltinIntents) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lex-models-2017-04-19/GetBuiltinIntents) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lex-models-2017-04-19/GetBuiltinIntents) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lex-models-2017-04-19/GetBuiltinIntents) 

# GetBuiltinSlotTypes
<a name="API_GetBuiltinSlotTypes"></a>

Gets a list of built-in slot types that meet the specified criteria.

For a list of built-in slot types, 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*.

This operation requires permission for the `lex:GetBuiltInSlotTypes` action.

## Request Syntax
<a name="API_GetBuiltinSlotTypes_RequestSyntax"></a>

```
GET /builtins/slottypes/?locale=locale&maxResults=maxResults&nextToken=nextToken&signatureContains=signatureContains HTTP/1.1
```

## URI Request Parameters
<a name="API_GetBuiltinSlotTypes_RequestParameters"></a>

The request uses the following URI parameters.

 ** [locale](#API_GetBuiltinSlotTypes_RequestSyntax) **   <a name="lex-GetBuiltinSlotTypes-request-uri-locale"></a>
A list of locales that the slot type supports.  
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` 

 ** [maxResults](#API_GetBuiltinSlotTypes_RequestSyntax) **   <a name="lex-GetBuiltinSlotTypes-request-uri-maxResults"></a>
The maximum number of slot types to return in the response. The default is 10.  
Valid Range: Minimum value of 1. Maximum value of 50.

 ** [nextToken](#API_GetBuiltinSlotTypes_RequestSyntax) **   <a name="lex-GetBuiltinSlotTypes-request-uri-nextToken"></a>
A pagination token that fetches the next page of slot types. If the response to this API call is truncated, Amazon Lex returns a pagination token in the response. To fetch the next page of slot types, specify the pagination token in the next request.

 ** [signatureContains](#API_GetBuiltinSlotTypes_RequestSyntax) **   <a name="lex-GetBuiltinSlotTypes-request-uri-signatureContains"></a>
Substring to match in built-in slot type signatures. A slot type will be returned if any part of its signature matches the substring. For example, "xyz" matches both "xyzabc" and "abcxyz."

## Request Body
<a name="API_GetBuiltinSlotTypes_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_GetBuiltinSlotTypes_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "nextToken": "string",
   "slotTypes": [ 
      { 
         "signature": "string",
         "supportedLocales": [ "string" ]
      }
   ]
}
```

## Response Elements
<a name="API_GetBuiltinSlotTypes_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [nextToken](#API_GetBuiltinSlotTypes_ResponseSyntax) **   <a name="lex-GetBuiltinSlotTypes-response-nextToken"></a>
If the response is truncated, the response includes a pagination token that you can use in your next request to fetch the next page of slot types.  
Type: String

 ** [slotTypes](#API_GetBuiltinSlotTypes_ResponseSyntax) **   <a name="lex-GetBuiltinSlotTypes-response-slotTypes"></a>
An array of `BuiltInSlotTypeMetadata` objects, one entry for each slot type returned.  
Type: Array of [BuiltinSlotTypeMetadata](API_BuiltinSlotTypeMetadata.md) objects

## Errors
<a name="API_GetBuiltinSlotTypes_Errors"></a>

 ** BadRequestException **   
The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and try again.  
HTTP Status Code: 400

 ** InternalFailureException **   
An internal Amazon Lex error occurred. Try your request again.  
HTTP Status Code: 500

 ** LimitExceededException **   
The request exceeded a limit. Try your request again.  
HTTP Status Code: 429

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

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/lex-models-2017-04-19/GetBuiltinSlotTypes) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lex-models-2017-04-19/GetBuiltinSlotTypes) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lex-models-2017-04-19/GetBuiltinSlotTypes) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lex-models-2017-04-19/GetBuiltinSlotTypes) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lex-models-2017-04-19/GetBuiltinSlotTypes) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lex-models-2017-04-19/GetBuiltinSlotTypes) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lex-models-2017-04-19/GetBuiltinSlotTypes) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lex-models-2017-04-19/GetBuiltinSlotTypes) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lex-models-2017-04-19/GetBuiltinSlotTypes) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lex-models-2017-04-19/GetBuiltinSlotTypes) 

# GetExport
<a name="API_GetExport"></a>

Exports the contents of a Amazon Lex resource in a specified format. 

## Request Syntax
<a name="API_GetExport_RequestSyntax"></a>

```
GET /exports/?exportType=exportType&name=name&resourceType=resourceType&version=version HTTP/1.1
```

## URI Request Parameters
<a name="API_GetExport_RequestParameters"></a>

The request uses the following URI parameters.

 ** [exportType](#API_GetExport_RequestSyntax) **   <a name="lex-GetExport-request-uri-exportType"></a>
The format of the exported data.  
Valid Values: `ALEXA_SKILLS_KIT | LEX`   
Required: Yes

 ** [name](#API_GetExport_RequestSyntax) **   <a name="lex-GetExport-request-uri-name"></a>
The name of the bot to export.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `[a-zA-Z_]+`   
Required: Yes

 ** [resourceType](#API_GetExport_RequestSyntax) **   <a name="lex-GetExport-request-uri-resourceType"></a>
The type of resource to export.   
Valid Values: `BOT | INTENT | SLOT_TYPE`   
Required: Yes

 ** [version](#API_GetExport_RequestSyntax) **   <a name="lex-GetExport-request-uri-version"></a>
The version of the bot to export.  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `[0-9]+`   
Required: Yes

## Request Body
<a name="API_GetExport_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_GetExport_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "exportStatus": "string",
   "exportType": "string",
   "failureReason": "string",
   "name": "string",
   "resourceType": "string",
   "url": "string",
   "version": "string"
}
```

## Response Elements
<a name="API_GetExport_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [exportStatus](#API_GetExport_ResponseSyntax) **   <a name="lex-GetExport-response-exportStatus"></a>
The status of the export.   
+  `IN_PROGRESS` - The export is in progress.
+  `READY` - The export is complete.
+  `FAILED` - The export could not be completed.
Type: String  
Valid Values: `IN_PROGRESS | READY | FAILED` 

 ** [exportType](#API_GetExport_ResponseSyntax) **   <a name="lex-GetExport-response-exportType"></a>
The format of the exported data.  
Type: String  
Valid Values: `ALEXA_SKILLS_KIT | LEX` 

 ** [failureReason](#API_GetExport_ResponseSyntax) **   <a name="lex-GetExport-response-failureReason"></a>
If `status` is `FAILED`, Amazon Lex provides the reason that it failed to export the resource.  
Type: String

 ** [name](#API_GetExport_ResponseSyntax) **   <a name="lex-GetExport-response-name"></a>
The name of the bot being exported.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `[a-zA-Z_]+` 

 ** [resourceType](#API_GetExport_ResponseSyntax) **   <a name="lex-GetExport-response-resourceType"></a>
The type of the exported resource.  
Type: String  
Valid Values: `BOT | INTENT | SLOT_TYPE` 

 ** [url](#API_GetExport_ResponseSyntax) **   <a name="lex-GetExport-response-url"></a>
An S3 pre-signed URL that provides the location of the exported resource. The exported resource is a ZIP archive that contains the exported resource in JSON format. The structure of the archive may change. Your code should not rely on the archive structure.  
Type: String

 ** [version](#API_GetExport_ResponseSyntax) **   <a name="lex-GetExport-response-version"></a>
The version of the bot being exported.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `[0-9]+` 

## Errors
<a name="API_GetExport_Errors"></a>

 ** BadRequestException **   
The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and try again.  
HTTP Status Code: 400

 ** InternalFailureException **   
An internal Amazon Lex error occurred. Try your request again.  
HTTP Status Code: 500

 ** LimitExceededException **   
The request exceeded a limit. Try your request again.  
HTTP Status Code: 429

 ** NotFoundException **   
The resource specified in the request was not found. Check the resource and try again.  
HTTP Status Code: 404

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

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/lex-models-2017-04-19/GetExport) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lex-models-2017-04-19/GetExport) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lex-models-2017-04-19/GetExport) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lex-models-2017-04-19/GetExport) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lex-models-2017-04-19/GetExport) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lex-models-2017-04-19/GetExport) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lex-models-2017-04-19/GetExport) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lex-models-2017-04-19/GetExport) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lex-models-2017-04-19/GetExport) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lex-models-2017-04-19/GetExport) 

# GetImport
<a name="API_GetImport"></a>

Gets information about an import job started with the `StartImport` operation.

## Request Syntax
<a name="API_GetImport_RequestSyntax"></a>

```
GET /imports/importId HTTP/1.1
```

## URI Request Parameters
<a name="API_GetImport_RequestParameters"></a>

The request uses the following URI parameters.

 ** [importId](#API_GetImport_RequestSyntax) **   <a name="lex-GetImport-request-uri-importId"></a>
The identifier of the import job information to return.  
Required: Yes

## Request Body
<a name="API_GetImport_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_GetImport_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "createdDate": number,
   "failureReason": [ "string" ],
   "importId": "string",
   "importStatus": "string",
   "mergeStrategy": "string",
   "name": "string",
   "resourceType": "string"
}
```

## Response Elements
<a name="API_GetImport_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [createdDate](#API_GetImport_ResponseSyntax) **   <a name="lex-GetImport-response-createdDate"></a>
A timestamp for the date and time that the import job was created.  
Type: Timestamp

 ** [failureReason](#API_GetImport_ResponseSyntax) **   <a name="lex-GetImport-response-failureReason"></a>
A string that describes why an import job failed to complete.  
Type: Array of strings

 ** [importId](#API_GetImport_ResponseSyntax) **   <a name="lex-GetImport-response-importId"></a>
The identifier for the specific import job.  
Type: String

 ** [importStatus](#API_GetImport_ResponseSyntax) **   <a name="lex-GetImport-response-importStatus"></a>
The status of the import job. If the status is `FAILED`, you can get the reason for the failure from the `failureReason` field.  
Type: String  
Valid Values: `IN_PROGRESS | COMPLETE | FAILED` 

 ** [mergeStrategy](#API_GetImport_ResponseSyntax) **   <a name="lex-GetImport-response-mergeStrategy"></a>
The action taken when there was a conflict between an existing resource and a resource in the import file.  
Type: String  
Valid Values: `OVERWRITE_LATEST | FAIL_ON_CONFLICT` 

 ** [name](#API_GetImport_ResponseSyntax) **   <a name="lex-GetImport-response-name"></a>
The name given to the import job.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `[a-zA-Z_]+` 

 ** [resourceType](#API_GetImport_ResponseSyntax) **   <a name="lex-GetImport-response-resourceType"></a>
The type of resource imported.  
Type: String  
Valid Values: `BOT | INTENT | SLOT_TYPE` 

## Errors
<a name="API_GetImport_Errors"></a>

 ** BadRequestException **   
The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and try again.  
HTTP Status Code: 400

 ** InternalFailureException **   
An internal Amazon Lex error occurred. Try your request again.  
HTTP Status Code: 500

 ** LimitExceededException **   
The request exceeded a limit. Try your request again.  
HTTP Status Code: 429

 ** NotFoundException **   
The resource specified in the request was not found. Check the resource and try again.  
HTTP Status Code: 404

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

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/lex-models-2017-04-19/GetImport) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lex-models-2017-04-19/GetImport) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lex-models-2017-04-19/GetImport) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lex-models-2017-04-19/GetImport) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lex-models-2017-04-19/GetImport) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lex-models-2017-04-19/GetImport) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lex-models-2017-04-19/GetImport) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lex-models-2017-04-19/GetImport) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lex-models-2017-04-19/GetImport) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lex-models-2017-04-19/GetImport) 

# GetIntent
<a name="API_GetIntent"></a>

 Returns information about an intent. In addition to the intent name, you must specify the intent version. 

 This operation requires permissions to perform the `lex:GetIntent` action. 

## Request Syntax
<a name="API_GetIntent_RequestSyntax"></a>

```
GET /intents/name/versions/version HTTP/1.1
```

## URI Request Parameters
<a name="API_GetIntent_RequestParameters"></a>

The request uses the following URI parameters.

 ** [name](#API_GetIntent_RequestSyntax) **   <a name="lex-GetIntent-request-uri-name"></a>
The name of the intent. The name is case sensitive.   
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `^([A-Za-z]_?)+$`   
Required: Yes

 ** [version](#API_GetIntent_RequestSyntax) **   <a name="lex-GetIntent-request-uri-version"></a>
The version of the intent.  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `\$LATEST|[0-9]+`   
Required: Yes

## Request Body
<a name="API_GetIntent_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_GetIntent_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "checksum": "string",
   "conclusionStatement": { 
      "messages": [ 
         { 
            "content": "string",
            "contentType": "string",
            "groupNumber": number
         }
      ],
      "responseCard": "string"
   },
   "confirmationPrompt": { 
      "maxAttempts": number,
      "messages": [ 
         { 
            "content": "string",
            "contentType": "string",
            "groupNumber": number
         }
      ],
      "responseCard": "string"
   },
   "createdDate": number,
   "description": "string",
   "dialogCodeHook": { 
      "messageVersion": "string",
      "uri": "string"
   },
   "followUpPrompt": { 
      "prompt": { 
         "maxAttempts": number,
         "messages": [ 
            { 
               "content": "string",
               "contentType": "string",
               "groupNumber": number
            }
         ],
         "responseCard": "string"
      },
      "rejectionStatement": { 
         "messages": [ 
            { 
               "content": "string",
               "contentType": "string",
               "groupNumber": number
            }
         ],
         "responseCard": "string"
      }
   },
   "fulfillmentActivity": { 
      "codeHook": { 
         "messageVersion": "string",
         "uri": "string"
      },
      "type": "string"
   },
   "inputContexts": [ 
      { 
         "name": "string"
      }
   ],
   "kendraConfiguration": { 
      "kendraIndex": "string",
      "queryFilterString": "string",
      "role": "string"
   },
   "lastUpdatedDate": number,
   "name": "string",
   "outputContexts": [ 
      { 
         "name": "string",
         "timeToLiveInSeconds": number,
         "turnsToLive": number
      }
   ],
   "parentIntentSignature": "string",
   "rejectionStatement": { 
      "messages": [ 
         { 
            "content": "string",
            "contentType": "string",
            "groupNumber": number
         }
      ],
      "responseCard": "string"
   },
   "sampleUtterances": [ "string" ],
   "slots": [ 
      { 
         "defaultValueSpec": { 
            "defaultValueList": [ 
               { 
                  "defaultValue": "string"
               }
            ]
         },
         "description": "string",
         "name": "string",
         "obfuscationSetting": "string",
         "priority": number,
         "responseCard": "string",
         "sampleUtterances": [ "string" ],
         "slotConstraint": "string",
         "slotType": "string",
         "slotTypeVersion": "string",
         "valueElicitationPrompt": { 
            "maxAttempts": number,
            "messages": [ 
               { 
                  "content": "string",
                  "contentType": "string",
                  "groupNumber": number
               }
            ],
            "responseCard": "string"
         }
      }
   ],
   "version": "string"
}
```

## Response Elements
<a name="API_GetIntent_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [checksum](#API_GetIntent_ResponseSyntax) **   <a name="lex-GetIntent-response-checksum"></a>
Checksum of the intent.  
Type: String

 ** [conclusionStatement](#API_GetIntent_ResponseSyntax) **   <a name="lex-GetIntent-response-conclusionStatement"></a>
After the Lambda function specified in the `fulfillmentActivity` element fulfills the intent, Amazon Lex conveys this statement to the user.  
Type: [Statement](API_Statement.md) object

 ** [confirmationPrompt](#API_GetIntent_ResponseSyntax) **   <a name="lex-GetIntent-response-confirmationPrompt"></a>
If defined in the bot, Amazon Lex uses prompt to confirm the intent before fulfilling the user's request. For more information, see [PutIntent](API_PutIntent.md).   
Type: [Prompt](API_Prompt.md) object

 ** [createdDate](#API_GetIntent_ResponseSyntax) **   <a name="lex-GetIntent-response-createdDate"></a>
The date that the intent was created.  
Type: Timestamp

 ** [description](#API_GetIntent_ResponseSyntax) **   <a name="lex-GetIntent-response-description"></a>
A description of the intent.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 200.

 ** [dialogCodeHook](#API_GetIntent_ResponseSyntax) **   <a name="lex-GetIntent-response-dialogCodeHook"></a>
If defined in the bot, Amazon Amazon Lex invokes this Lambda function for each user input. For more information, see [PutIntent](API_PutIntent.md).   
Type: [CodeHook](API_CodeHook.md) object

 ** [followUpPrompt](#API_GetIntent_ResponseSyntax) **   <a name="lex-GetIntent-response-followUpPrompt"></a>
If defined in the bot, Amazon Lex uses this prompt to solicit additional user activity after the intent is fulfilled. For more information, see [PutIntent](API_PutIntent.md).  
Type: [FollowUpPrompt](API_FollowUpPrompt.md) object

 ** [fulfillmentActivity](#API_GetIntent_ResponseSyntax) **   <a name="lex-GetIntent-response-fulfillmentActivity"></a>
Describes how the intent is fulfilled. For more information, see [PutIntent](API_PutIntent.md).   
Type: [FulfillmentActivity](API_FulfillmentActivity.md) object

 ** [inputContexts](#API_GetIntent_ResponseSyntax) **   <a name="lex-GetIntent-response-inputContexts"></a>
An array of `InputContext` objects that lists the contexts that must be active for Amazon Lex to choose the intent in a conversation with the user.  
Type: Array of [InputContext](API_InputContext.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 5 items.

 ** [kendraConfiguration](#API_GetIntent_ResponseSyntax) **   <a name="lex-GetIntent-response-kendraConfiguration"></a>
Configuration information, if any, to connect to an Amazon Kendra index with the `AMAZON.KendraSearchIntent` intent.  
Type: [KendraConfiguration](API_KendraConfiguration.md) object

 ** [lastUpdatedDate](#API_GetIntent_ResponseSyntax) **   <a name="lex-GetIntent-response-lastUpdatedDate"></a>
The date that the intent was updated. When you create a resource, the creation date and the last updated date are the same.   
Type: Timestamp

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

 ** [outputContexts](#API_GetIntent_ResponseSyntax) **   <a name="lex-GetIntent-response-outputContexts"></a>
An array of `OutputContext` objects that lists the contexts that the intent activates when the intent is fulfilled.  
Type: Array of [OutputContext](API_OutputContext.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 10 items.

 ** [parentIntentSignature](#API_GetIntent_ResponseSyntax) **   <a name="lex-GetIntent-response-parentIntentSignature"></a>
A unique identifier for a built-in intent.  
Type: String

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

 ** [sampleUtterances](#API_GetIntent_ResponseSyntax) **   <a name="lex-GetIntent-response-sampleUtterances"></a>
An array of sample utterances configured for the intent.  
Type: Array of strings  
Array Members: Minimum number of 0 items. Maximum number of 1500 items.  
Length Constraints: Minimum length of 1. Maximum length of 200.

 ** [slots](#API_GetIntent_ResponseSyntax) **   <a name="lex-GetIntent-response-slots"></a>
An array of intent slots configured for the intent.  
Type: Array of [Slot](API_Slot.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 100 items.

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

## Errors
<a name="API_GetIntent_Errors"></a>

 ** BadRequestException **   
The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and try again.  
HTTP Status Code: 400

 ** InternalFailureException **   
An internal Amazon Lex error occurred. Try your request again.  
HTTP Status Code: 500

 ** LimitExceededException **   
The request exceeded a limit. Try your request again.  
HTTP Status Code: 429

 ** NotFoundException **   
The resource specified in the request was not found. Check the resource and try again.  
HTTP Status Code: 404

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

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/lex-models-2017-04-19/GetIntent) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lex-models-2017-04-19/GetIntent) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lex-models-2017-04-19/GetIntent) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lex-models-2017-04-19/GetIntent) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lex-models-2017-04-19/GetIntent) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lex-models-2017-04-19/GetIntent) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lex-models-2017-04-19/GetIntent) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lex-models-2017-04-19/GetIntent) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lex-models-2017-04-19/GetIntent) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lex-models-2017-04-19/GetIntent) 

# GetIntents
<a name="API_GetIntents"></a>

Returns intent information as follows: 
+ If you specify the `nameContains` field, returns the `$LATEST` version of all intents that contain the specified string.
+  If you don't specify the `nameContains` field, returns information about the `$LATEST` version of all intents. 

 The operation requires permission for the `lex:GetIntents` action. 

## Request Syntax
<a name="API_GetIntents_RequestSyntax"></a>

```
GET /intents/?maxResults=maxResults&nameContains=nameContains&nextToken=nextToken HTTP/1.1
```

## URI Request Parameters
<a name="API_GetIntents_RequestParameters"></a>

The request uses the following URI parameters.

 ** [maxResults](#API_GetIntents_RequestSyntax) **   <a name="lex-GetIntents-request-uri-maxResults"></a>
The maximum number of intents to return in the response. The default is 10.  
Valid Range: Minimum value of 1. Maximum value of 50.

 ** [nameContains](#API_GetIntents_RequestSyntax) **   <a name="lex-GetIntents-request-uri-nameContains"></a>
Substring to match in intent names. An intent will be returned if any part of its name matches the substring. For example, "xyz" matches both "xyzabc" and "abcxyz."  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `^([A-Za-z]_?)+$` 

 ** [nextToken](#API_GetIntents_RequestSyntax) **   <a name="lex-GetIntents-request-uri-nextToken"></a>
A pagination token that fetches the next page of intents. If the response to this API call is truncated, Amazon Lex returns a pagination token in the response. To fetch the next page of intents, specify the pagination token in the next request. 

## Request Body
<a name="API_GetIntents_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_GetIntents_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "intents": [ 
      { 
         "createdDate": number,
         "description": "string",
         "lastUpdatedDate": number,
         "name": "string",
         "version": "string"
      }
   ],
   "nextToken": "string"
}
```

## Response Elements
<a name="API_GetIntents_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [intents](#API_GetIntents_ResponseSyntax) **   <a name="lex-GetIntents-response-intents"></a>
An array of `Intent` objects. For more information, see [PutBot](API_PutBot.md).  
Type: Array of [IntentMetadata](API_IntentMetadata.md) objects

 ** [nextToken](#API_GetIntents_ResponseSyntax) **   <a name="lex-GetIntents-response-nextToken"></a>
If the response is truncated, the response includes a pagination token that you can specify in your next request to fetch the next page of intents.   
Type: String

## Errors
<a name="API_GetIntents_Errors"></a>

 ** BadRequestException **   
The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and try again.  
HTTP Status Code: 400

 ** InternalFailureException **   
An internal Amazon Lex error occurred. Try your request again.  
HTTP Status Code: 500

 ** LimitExceededException **   
The request exceeded a limit. Try your request again.  
HTTP Status Code: 429

 ** NotFoundException **   
The resource specified in the request was not found. Check the resource and try again.  
HTTP Status Code: 404

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

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/lex-models-2017-04-19/GetIntents) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lex-models-2017-04-19/GetIntents) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lex-models-2017-04-19/GetIntents) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lex-models-2017-04-19/GetIntents) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lex-models-2017-04-19/GetIntents) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lex-models-2017-04-19/GetIntents) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lex-models-2017-04-19/GetIntents) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lex-models-2017-04-19/GetIntents) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lex-models-2017-04-19/GetIntents) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lex-models-2017-04-19/GetIntents) 

# GetIntentVersions
<a name="API_GetIntentVersions"></a>

Gets information about all of the versions of an intent.

The `GetIntentVersions` operation returns an `IntentMetadata` object for each version of an intent. For example, if an intent has three numbered versions, the `GetIntentVersions` operation returns four `IntentMetadata` objects in the response, one for each numbered version and one for the `$LATEST` version. 

The `GetIntentVersions` operation always returns at least one version, the `$LATEST` version.

This operation requires permissions for the `lex:GetIntentVersions` action.

## Request Syntax
<a name="API_GetIntentVersions_RequestSyntax"></a>

```
GET /intents/name/versions/?maxResults=maxResults&nextToken=nextToken HTTP/1.1
```

## URI Request Parameters
<a name="API_GetIntentVersions_RequestParameters"></a>

The request uses the following URI parameters.

 ** [maxResults](#API_GetIntentVersions_RequestSyntax) **   <a name="lex-GetIntentVersions-request-uri-maxResults"></a>
The maximum number of intent versions to return in the response. The default is 10.  
Valid Range: Minimum value of 1. Maximum value of 50.

 ** [name](#API_GetIntentVersions_RequestSyntax) **   <a name="lex-GetIntentVersions-request-uri-name"></a>
The name of the intent for which versions should be returned.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `^([A-Za-z]_?)+$`   
Required: Yes

 ** [nextToken](#API_GetIntentVersions_RequestSyntax) **   <a name="lex-GetIntentVersions-request-uri-nextToken"></a>
A pagination token for fetching the next page of intent versions. If the response to this call is truncated, Amazon Lex returns a pagination token in the response. To fetch the next page of versions, specify the pagination token in the next request. 

## Request Body
<a name="API_GetIntentVersions_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_GetIntentVersions_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "intents": [ 
      { 
         "createdDate": number,
         "description": "string",
         "lastUpdatedDate": number,
         "name": "string",
         "version": "string"
      }
   ],
   "nextToken": "string"
}
```

## Response Elements
<a name="API_GetIntentVersions_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [intents](#API_GetIntentVersions_ResponseSyntax) **   <a name="lex-GetIntentVersions-response-intents"></a>
An array of `IntentMetadata` objects, one for each numbered version of the intent plus one for the `$LATEST` version.  
Type: Array of [IntentMetadata](API_IntentMetadata.md) objects

 ** [nextToken](#API_GetIntentVersions_ResponseSyntax) **   <a name="lex-GetIntentVersions-response-nextToken"></a>
A pagination token for fetching the next page of intent versions. If the response to this call is truncated, Amazon Lex returns a pagination token in the response. To fetch the next page of versions, specify the pagination token in the next request.   
Type: String

## Errors
<a name="API_GetIntentVersions_Errors"></a>

 ** BadRequestException **   
The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and try again.  
HTTP Status Code: 400

 ** InternalFailureException **   
An internal Amazon Lex error occurred. Try your request again.  
HTTP Status Code: 500

 ** LimitExceededException **   
The request exceeded a limit. Try your request again.  
HTTP Status Code: 429

 ** NotFoundException **   
The resource specified in the request was not found. Check the resource and try again.  
HTTP Status Code: 404

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

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/lex-models-2017-04-19/GetIntentVersions) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lex-models-2017-04-19/GetIntentVersions) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lex-models-2017-04-19/GetIntentVersions) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lex-models-2017-04-19/GetIntentVersions) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lex-models-2017-04-19/GetIntentVersions) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lex-models-2017-04-19/GetIntentVersions) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lex-models-2017-04-19/GetIntentVersions) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lex-models-2017-04-19/GetIntentVersions) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lex-models-2017-04-19/GetIntentVersions) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lex-models-2017-04-19/GetIntentVersions) 

# GetMigration
<a name="API_GetMigration"></a>

Provides details about an ongoing or complete migration from an Amazon Lex V1 bot to an Amazon Lex V2 bot. Use this operation to view the migration alerts and warnings related to the migration.

## Request Syntax
<a name="API_GetMigration_RequestSyntax"></a>

```
GET /migrations/migrationId HTTP/1.1
```

## URI Request Parameters
<a name="API_GetMigration_RequestParameters"></a>

The request uses the following URI parameters.

 ** [migrationId](#API_GetMigration_RequestSyntax) **   <a name="lex-GetMigration-request-uri-migrationId"></a>
The unique identifier of the migration to view. The `migrationID` is returned by the [StartMigration](API_StartMigration.md) operation.  
Length Constraints: Fixed length of 10.  
Pattern: `^[0-9a-zA-Z]+$`   
Required: Yes

## Request Body
<a name="API_GetMigration_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_GetMigration_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "alerts": [ 
      { 
         "details": [ "string" ],
         "message": "string",
         "referenceURLs": [ "string" ],
         "type": "string"
      }
   ],
   "migrationId": "string",
   "migrationStatus": "string",
   "migrationStrategy": "string",
   "migrationTimestamp": number,
   "v1BotLocale": "string",
   "v1BotName": "string",
   "v1BotVersion": "string",
   "v2BotId": "string",
   "v2BotRole": "string"
}
```

## Response Elements
<a name="API_GetMigration_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [alerts](#API_GetMigration_ResponseSyntax) **   <a name="lex-GetMigration-response-alerts"></a>
A list of alerts and warnings that indicate issues with the migration for the Amazon Lex V1 bot to Amazon Lex V2. You receive a warning when an Amazon Lex V1 feature has a different implementation in Amazon Lex V2.  
For more information, see [Migrating a bot](https://docs.aws.amazon.com/lexv2/latest/dg/migrate.html) in the *Amazon Lex V2 developer guide*.  
Type: Array of [MigrationAlert](API_MigrationAlert.md) objects

 ** [migrationId](#API_GetMigration_ResponseSyntax) **   <a name="lex-GetMigration-response-migrationId"></a>
The unique identifier of the migration. This is the same as the identifier used when calling the `GetMigration` operation.  
Type: String  
Length Constraints: Fixed length of 10.  
Pattern: `^[0-9a-zA-Z]+$` 

 ** [migrationStatus](#API_GetMigration_ResponseSyntax) **   <a name="lex-GetMigration-response-migrationStatus"></a>
Indicates the status of the migration. When the status is `COMPLETE` the migration is finished and 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` 

 ** [migrationStrategy](#API_GetMigration_ResponseSyntax) **   <a name="lex-GetMigration-response-migrationStrategy"></a>
The strategy used to conduct the migration.  
+  `CREATE_NEW` - Creates a new Amazon Lex V2 bot and migrates the Amazon Lex V1 bot to the new bot.
+  `UPDATE_EXISTING` - Overwrites the existing Amazon Lex V2 bot metadata and the locale being migrated. It doesn't change any other locales in the Amazon Lex V2 bot. If the locale doesn't exist, a new locale is created in the Amazon Lex V2 bot.
Type: String  
Valid Values: `CREATE_NEW | UPDATE_EXISTING` 

 ** [migrationTimestamp](#API_GetMigration_ResponseSyntax) **   <a name="lex-GetMigration-response-migrationTimestamp"></a>
The date and time that the migration started.  
Type: Timestamp

 ** [v1BotLocale](#API_GetMigration_ResponseSyntax) **   <a name="lex-GetMigration-response-v1BotLocale"></a>
The locale of the Amazon Lex V1 bot migrated to Amazon Lex V2.  
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` 

 ** [v1BotName](#API_GetMigration_ResponseSyntax) **   <a name="lex-GetMigration-response-v1BotName"></a>
The name of the Amazon Lex V1 bot migrated to Amazon Lex V2.  
Type: String  
Length Constraints: Minimum length of 2. Maximum length of 50.  
Pattern: `^([A-Za-z]_?)+$` 

 ** [v1BotVersion](#API_GetMigration_ResponseSyntax) **   <a name="lex-GetMigration-response-v1BotVersion"></a>
The version of the Amazon Lex V1 bot migrated to Amazon Lex V2.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `\$LATEST|[0-9]+` 

 ** [v2BotId](#API_GetMigration_ResponseSyntax) **   <a name="lex-GetMigration-response-v2BotId"></a>
The unique identifier of the Amazon Lex V2 bot that the Amazon Lex V1 is being migrated to.  
Type: String  
Length Constraints: Fixed length of 10.  
Pattern: `^[0-9a-zA-Z]+$` 

 ** [v2BotRole](#API_GetMigration_ResponseSyntax) **   <a name="lex-GetMigration-response-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/.+$` 

## Errors
<a name="API_GetMigration_Errors"></a>

 ** BadRequestException **   
The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and try again.  
HTTP Status Code: 400

 ** InternalFailureException **   
An internal Amazon Lex error occurred. Try your request again.  
HTTP Status Code: 500

 ** LimitExceededException **   
The request exceeded a limit. Try your request again.  
HTTP Status Code: 429

 ** NotFoundException **   
The resource specified in the request was not found. Check the resource and try again.  
HTTP Status Code: 404

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

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/lex-models-2017-04-19/GetMigration) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lex-models-2017-04-19/GetMigration) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lex-models-2017-04-19/GetMigration) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lex-models-2017-04-19/GetMigration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lex-models-2017-04-19/GetMigration) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lex-models-2017-04-19/GetMigration) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lex-models-2017-04-19/GetMigration) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lex-models-2017-04-19/GetMigration) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lex-models-2017-04-19/GetMigration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lex-models-2017-04-19/GetMigration) 

# GetMigrations
<a name="API_GetMigrations"></a>

Gets a list of migrations between Amazon Lex V1 and Amazon Lex V2.

## Request Syntax
<a name="API_GetMigrations_RequestSyntax"></a>

```
GET /migrations?maxResults=maxResults&migrationStatusEquals=migrationStatusEquals&nextToken=nextToken&sortByAttribute=sortByAttribute&sortByOrder=sortByOrder&v1BotNameContains=v1BotNameContains HTTP/1.1
```

## URI Request Parameters
<a name="API_GetMigrations_RequestParameters"></a>

The request uses the following URI parameters.

 ** [maxResults](#API_GetMigrations_RequestSyntax) **   <a name="lex-GetMigrations-request-uri-maxResults"></a>
The maximum number of migrations to return in the response. The default is 10.  
Valid Range: Minimum value of 1. Maximum value of 50.

 ** [migrationStatusEquals](#API_GetMigrations_RequestSyntax) **   <a name="lex-GetMigrations-request-uri-migrationStatusEquals"></a>
Filters the list to contain only migrations in the specified state.  
Valid Values: `IN_PROGRESS | COMPLETED | FAILED` 

 ** [nextToken](#API_GetMigrations_RequestSyntax) **   <a name="lex-GetMigrations-request-uri-nextToken"></a>
A pagination token that fetches the next page of migrations. If the response to this operation is truncated, Amazon Lex returns a pagination token in the response. To fetch the next page of migrations, specify the pagination token in the request.

 ** [sortByAttribute](#API_GetMigrations_RequestSyntax) **   <a name="lex-GetMigrations-request-uri-sortByAttribute"></a>
The field to sort the list of migrations by. You can sort by the Amazon Lex V1 bot name or the date and time that the migration was started.  
Valid Values: `V1_BOT_NAME | MIGRATION_DATE_TIME` 

 ** [sortByOrder](#API_GetMigrations_RequestSyntax) **   <a name="lex-GetMigrations-request-uri-sortByOrder"></a>
The order so sort the list.  
Valid Values: `ASCENDING | DESCENDING` 

 ** [v1BotNameContains](#API_GetMigrations_RequestSyntax) **   <a name="lex-GetMigrations-request-uri-v1BotNameContains"></a>
Filters the list to contain only bots whose name contains the specified string. The string is matched anywhere in the bot name.  
Length Constraints: Minimum length of 2. Maximum length of 50.  
Pattern: `^([A-Za-z]_?)+$` 

## Request Body
<a name="API_GetMigrations_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_GetMigrations_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "migrationSummaries": [ 
      { 
         "migrationId": "string",
         "migrationStatus": "string",
         "migrationStrategy": "string",
         "migrationTimestamp": number,
         "v1BotLocale": "string",
         "v1BotName": "string",
         "v1BotVersion": "string",
         "v2BotId": "string",
         "v2BotRole": "string"
      }
   ],
   "nextToken": "string"
}
```

## Response Elements
<a name="API_GetMigrations_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [migrationSummaries](#API_GetMigrations_ResponseSyntax) **   <a name="lex-GetMigrations-response-migrationSummaries"></a>
An array of summaries for migrations from Amazon Lex V1 to Amazon Lex V2. To see details of the migration, use the `migrationId` from the summary in a call to the [GetMigration](API_GetMigration.md) operation.  
Type: Array of [MigrationSummary](API_MigrationSummary.md) objects

 ** [nextToken](#API_GetMigrations_ResponseSyntax) **   <a name="lex-GetMigrations-response-nextToken"></a>
If the response is truncated, it includes a pagination token that you can specify in your next request to fetch the next page of migrations.  
Type: String

## Errors
<a name="API_GetMigrations_Errors"></a>

 ** BadRequestException **   
The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and try again.  
HTTP Status Code: 400

 ** InternalFailureException **   
An internal Amazon Lex error occurred. Try your request again.  
HTTP Status Code: 500

 ** LimitExceededException **   
The request exceeded a limit. Try your request again.  
HTTP Status Code: 429

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

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/lex-models-2017-04-19/GetMigrations) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lex-models-2017-04-19/GetMigrations) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lex-models-2017-04-19/GetMigrations) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lex-models-2017-04-19/GetMigrations) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lex-models-2017-04-19/GetMigrations) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lex-models-2017-04-19/GetMigrations) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lex-models-2017-04-19/GetMigrations) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lex-models-2017-04-19/GetMigrations) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lex-models-2017-04-19/GetMigrations) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lex-models-2017-04-19/GetMigrations) 

# GetSlotType
<a name="API_GetSlotType"></a>

Returns information about a specific version of a slot type. In addition to specifying the slot type name, you must specify the slot type version.

This operation requires permissions for the `lex:GetSlotType` action.

## Request Syntax
<a name="API_GetSlotType_RequestSyntax"></a>

```
GET /slottypes/name/versions/version HTTP/1.1
```

## URI Request Parameters
<a name="API_GetSlotType_RequestParameters"></a>

The request uses the following URI parameters.

 ** [name](#API_GetSlotType_RequestSyntax) **   <a name="lex-GetSlotType-request-uri-name"></a>
The name of the slot type. The name is case sensitive.   
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `^([A-Za-z]_?)+$`   
Required: Yes

 ** [version](#API_GetSlotType_RequestSyntax) **   <a name="lex-GetSlotType-request-uri-version"></a>
The version of the slot type.   
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `\$LATEST|[0-9]+`   
Required: Yes

## Request Body
<a name="API_GetSlotType_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_GetSlotType_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "checksum": "string",
   "createdDate": number,
   "description": "string",
   "enumerationValues": [ 
      { 
         "synonyms": [ "string" ],
         "value": "string"
      }
   ],
   "lastUpdatedDate": number,
   "name": "string",
   "parentSlotTypeSignature": "string",
   "slotTypeConfigurations": [ 
      { 
         "regexConfiguration": { 
            "pattern": "string"
         }
      }
   ],
   "valueSelectionStrategy": "string",
   "version": "string"
}
```

## Response Elements
<a name="API_GetSlotType_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [checksum](#API_GetSlotType_ResponseSyntax) **   <a name="lex-GetSlotType-response-checksum"></a>
Checksum of the `$LATEST` version of the slot type.  
Type: String

 ** [createdDate](#API_GetSlotType_ResponseSyntax) **   <a name="lex-GetSlotType-response-createdDate"></a>
The date that the slot type was created.  
Type: Timestamp

 ** [description](#API_GetSlotType_ResponseSyntax) **   <a name="lex-GetSlotType-response-description"></a>
A description of the slot type.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 200.

 ** [enumerationValues](#API_GetSlotType_ResponseSyntax) **   <a name="lex-GetSlotType-response-enumerationValues"></a>
A list of `EnumerationValue` objects that defines the values that the slot type can take.  
Type: Array of [EnumerationValue](API_EnumerationValue.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 10000 items.

 ** [lastUpdatedDate](#API_GetSlotType_ResponseSyntax) **   <a name="lex-GetSlotType-response-lastUpdatedDate"></a>
The date that the slot type was updated. When you create a resource, the creation date and last update date are the same.  
Type: Timestamp

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

 ** [parentSlotTypeSignature](#API_GetSlotType_ResponseSyntax) **   <a name="lex-GetSlotType-response-parentSlotTypeSignature"></a>
The built-in slot type used as a parent for the slot type.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `^((AMAZON\.)_?|[A-Za-z]_?)+` 

 ** [slotTypeConfigurations](#API_GetSlotType_ResponseSyntax) **   <a name="lex-GetSlotType-response-slotTypeConfigurations"></a>
Configuration information that extends the parent built-in slot type.  
Type: Array of [SlotTypeConfiguration](API_SlotTypeConfiguration.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 10 items.

 ** [valueSelectionStrategy](#API_GetSlotType_ResponseSyntax) **   <a name="lex-GetSlotType-response-valueSelectionStrategy"></a>
The strategy that Amazon Lex uses to determine the value of the slot. For more information, see [PutSlotType](API_PutSlotType.md).  
Type: String  
Valid Values: `ORIGINAL_VALUE | TOP_RESOLUTION` 

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

## Errors
<a name="API_GetSlotType_Errors"></a>

 ** BadRequestException **   
The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and try again.  
HTTP Status Code: 400

 ** InternalFailureException **   
An internal Amazon Lex error occurred. Try your request again.  
HTTP Status Code: 500

 ** LimitExceededException **   
The request exceeded a limit. Try your request again.  
HTTP Status Code: 429

 ** NotFoundException **   
The resource specified in the request was not found. Check the resource and try again.  
HTTP Status Code: 404

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

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/lex-models-2017-04-19/GetSlotType) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lex-models-2017-04-19/GetSlotType) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lex-models-2017-04-19/GetSlotType) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lex-models-2017-04-19/GetSlotType) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lex-models-2017-04-19/GetSlotType) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lex-models-2017-04-19/GetSlotType) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lex-models-2017-04-19/GetSlotType) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lex-models-2017-04-19/GetSlotType) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lex-models-2017-04-19/GetSlotType) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lex-models-2017-04-19/GetSlotType) 

# GetSlotTypes
<a name="API_GetSlotTypes"></a>

Returns slot type information as follows: 
+ If you specify the `nameContains` field, returns the `$LATEST` version of all slot types that contain the specified string.
+  If you don't specify the `nameContains` field, returns information about the `$LATEST` version of all slot types. 

 The operation requires permission for the `lex:GetSlotTypes` action. 

## Request Syntax
<a name="API_GetSlotTypes_RequestSyntax"></a>

```
GET /slottypes/?maxResults=maxResults&nameContains=nameContains&nextToken=nextToken HTTP/1.1
```

## URI Request Parameters
<a name="API_GetSlotTypes_RequestParameters"></a>

The request uses the following URI parameters.

 ** [maxResults](#API_GetSlotTypes_RequestSyntax) **   <a name="lex-GetSlotTypes-request-uri-maxResults"></a>
The maximum number of slot types to return in the response. The default is 10.  
Valid Range: Minimum value of 1. Maximum value of 50.

 ** [nameContains](#API_GetSlotTypes_RequestSyntax) **   <a name="lex-GetSlotTypes-request-uri-nameContains"></a>
Substring to match in slot type names. A slot type will be returned if any part of its name matches the substring. For example, "xyz" matches both "xyzabc" and "abcxyz."  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `^([A-Za-z]_?)+$` 

 ** [nextToken](#API_GetSlotTypes_RequestSyntax) **   <a name="lex-GetSlotTypes-request-uri-nextToken"></a>
A pagination token that fetches the next page of slot types. If the response to this API call is truncated, Amazon Lex returns a pagination token in the response. To fetch next page of slot types, specify the pagination token in the next request.

## Request Body
<a name="API_GetSlotTypes_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_GetSlotTypes_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "nextToken": "string",
   "slotTypes": [ 
      { 
         "createdDate": number,
         "description": "string",
         "lastUpdatedDate": number,
         "name": "string",
         "version": "string"
      }
   ]
}
```

## Response Elements
<a name="API_GetSlotTypes_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [nextToken](#API_GetSlotTypes_ResponseSyntax) **   <a name="lex-GetSlotTypes-response-nextToken"></a>
If the response is truncated, it includes a pagination token that you can specify in your next request to fetch the next page of slot types.  
Type: String

 ** [slotTypes](#API_GetSlotTypes_ResponseSyntax) **   <a name="lex-GetSlotTypes-response-slotTypes"></a>
An array of objects, one for each slot type, that provides information such as the name of the slot type, the version, and a description.  
Type: Array of [SlotTypeMetadata](API_SlotTypeMetadata.md) objects

## Errors
<a name="API_GetSlotTypes_Errors"></a>

 ** BadRequestException **   
The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and try again.  
HTTP Status Code: 400

 ** InternalFailureException **   
An internal Amazon Lex error occurred. Try your request again.  
HTTP Status Code: 500

 ** LimitExceededException **   
The request exceeded a limit. Try your request again.  
HTTP Status Code: 429

 ** NotFoundException **   
The resource specified in the request was not found. Check the resource and try again.  
HTTP Status Code: 404

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

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/lex-models-2017-04-19/GetSlotTypes) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lex-models-2017-04-19/GetSlotTypes) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lex-models-2017-04-19/GetSlotTypes) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lex-models-2017-04-19/GetSlotTypes) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lex-models-2017-04-19/GetSlotTypes) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lex-models-2017-04-19/GetSlotTypes) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lex-models-2017-04-19/GetSlotTypes) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lex-models-2017-04-19/GetSlotTypes) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lex-models-2017-04-19/GetSlotTypes) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lex-models-2017-04-19/GetSlotTypes) 

# GetSlotTypeVersions
<a name="API_GetSlotTypeVersions"></a>

Gets information about all versions of a slot type.

The `GetSlotTypeVersions` operation returns a `SlotTypeMetadata` object for each version of a slot type. For example, if a slot type has three numbered versions, the `GetSlotTypeVersions` operation returns four `SlotTypeMetadata` objects in the response, one for each numbered version and one for the `$LATEST` version. 

The `GetSlotTypeVersions` operation always returns at least one version, the `$LATEST` version.

This operation requires permissions for the `lex:GetSlotTypeVersions` action.

## Request Syntax
<a name="API_GetSlotTypeVersions_RequestSyntax"></a>

```
GET /slottypes/name/versions/?maxResults=maxResults&nextToken=nextToken HTTP/1.1
```

## URI Request Parameters
<a name="API_GetSlotTypeVersions_RequestParameters"></a>

The request uses the following URI parameters.

 ** [maxResults](#API_GetSlotTypeVersions_RequestSyntax) **   <a name="lex-GetSlotTypeVersions-request-uri-maxResults"></a>
The maximum number of slot type versions to return in the response. The default is 10.  
Valid Range: Minimum value of 1. Maximum value of 50.

 ** [name](#API_GetSlotTypeVersions_RequestSyntax) **   <a name="lex-GetSlotTypeVersions-request-uri-name"></a>
The name of the slot type for which versions should be returned.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `^([A-Za-z]_?)+$`   
Required: Yes

 ** [nextToken](#API_GetSlotTypeVersions_RequestSyntax) **   <a name="lex-GetSlotTypeVersions-request-uri-nextToken"></a>
A pagination token for fetching the next page of slot type versions. If the response to this call is truncated, Amazon Lex returns a pagination token in the response. To fetch the next page of versions, specify the pagination token in the next request. 

## Request Body
<a name="API_GetSlotTypeVersions_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_GetSlotTypeVersions_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "nextToken": "string",
   "slotTypes": [ 
      { 
         "createdDate": number,
         "description": "string",
         "lastUpdatedDate": number,
         "name": "string",
         "version": "string"
      }
   ]
}
```

## Response Elements
<a name="API_GetSlotTypeVersions_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [nextToken](#API_GetSlotTypeVersions_ResponseSyntax) **   <a name="lex-GetSlotTypeVersions-response-nextToken"></a>
A pagination token for fetching the next page of slot type versions. If the response to this call is truncated, Amazon Lex returns a pagination token in the response. To fetch the next page of versions, specify the pagination token in the next request.   
Type: String

 ** [slotTypes](#API_GetSlotTypeVersions_ResponseSyntax) **   <a name="lex-GetSlotTypeVersions-response-slotTypes"></a>
An array of `SlotTypeMetadata` objects, one for each numbered version of the slot type plus one for the `$LATEST` version.  
Type: Array of [SlotTypeMetadata](API_SlotTypeMetadata.md) objects

## Errors
<a name="API_GetSlotTypeVersions_Errors"></a>

 ** BadRequestException **   
The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and try again.  
HTTP Status Code: 400

 ** InternalFailureException **   
An internal Amazon Lex error occurred. Try your request again.  
HTTP Status Code: 500

 ** LimitExceededException **   
The request exceeded a limit. Try your request again.  
HTTP Status Code: 429

 ** NotFoundException **   
The resource specified in the request was not found. Check the resource and try again.  
HTTP Status Code: 404

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

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/lex-models-2017-04-19/GetSlotTypeVersions) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lex-models-2017-04-19/GetSlotTypeVersions) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lex-models-2017-04-19/GetSlotTypeVersions) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lex-models-2017-04-19/GetSlotTypeVersions) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lex-models-2017-04-19/GetSlotTypeVersions) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lex-models-2017-04-19/GetSlotTypeVersions) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lex-models-2017-04-19/GetSlotTypeVersions) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lex-models-2017-04-19/GetSlotTypeVersions) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lex-models-2017-04-19/GetSlotTypeVersions) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lex-models-2017-04-19/GetSlotTypeVersions) 

# GetUtterancesView
<a name="API_GetUtterancesView"></a>

Use the `GetUtterancesView` operation to get information about the utterances that your users have made to your bot. You can use this list to tune the utterances that your bot responds to.

For example, say that you have created a bot to order flowers. After your users have used your bot for a while, use the `GetUtterancesView` operation to see the requests that they have made and whether they have been successful. You might find that the utterance "I want flowers" is not being recognized. You could add this utterance to the `OrderFlowers` intent so that your bot recognizes that utterance.

After you publish a new version of a bot, you can get information about the old version and the new so that you can compare the performance across the two versions. 

Utterance statistics are generated once a day. Data is available for the last 15 days. You can request information for up to 5 versions of your bot in each request. Amazon Lex returns the most frequent utterances received by the bot in the last 15 days. The response contains information about a maximum of 100 utterances for each version.

Utterance statistics are not generated under the following conditions:
+ The `childDirected` field was set to true when the bot was created.
+ You are using slot obfuscation with one or more slots.
+ You opted out of participating in improving Amazon Lex.

This operation requires permissions for the `lex:GetUtterancesView` action.

## Request Syntax
<a name="API_GetUtterancesView_RequestSyntax"></a>

```
GET /bots/botname/utterances?view=aggregation&bot_versions=botVersions&status_type=statusType HTTP/1.1
```

## URI Request Parameters
<a name="API_GetUtterancesView_RequestParameters"></a>

The request uses the following URI parameters.

 ** [botname](#API_GetUtterancesView_RequestSyntax) **   <a name="lex-GetUtterancesView-request-uri-botName"></a>
The name of the bot for which utterance information should be returned.  
Length Constraints: Minimum length of 2. Maximum length of 50.  
Pattern: `^([A-Za-z]_?)+$`   
Required: Yes

 ** [botVersions](#API_GetUtterancesView_RequestSyntax) **   <a name="lex-GetUtterancesView-request-uri-botVersions"></a>
An array of bot versions for which utterance information should be returned. The limit is 5 versions per request.  
Array Members: Minimum number of 1 item. Maximum number of 5 items.  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `\$LATEST|[0-9]+`   
Required: Yes

 ** [statusType](#API_GetUtterancesView_RequestSyntax) **   <a name="lex-GetUtterancesView-request-uri-statusType"></a>
To return utterances that were recognized and handled, use `Detected`. To return utterances that were not recognized, use `Missed`.  
Valid Values: `Detected | Missed`   
Required: Yes

## Request Body
<a name="API_GetUtterancesView_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_GetUtterancesView_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "botName": "string",
   "utterances": [ 
      { 
         "botVersion": "string",
         "utterances": [ 
            { 
               "count": number,
               "distinctUsers": number,
               "firstUtteredDate": number,
               "lastUtteredDate": number,
               "utteranceString": "string"
            }
         ]
      }
   ]
}
```

## Response Elements
<a name="API_GetUtterancesView_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [botName](#API_GetUtterancesView_ResponseSyntax) **   <a name="lex-GetUtterancesView-response-botName"></a>
The name of the bot for which utterance information was returned.  
Type: String  
Length Constraints: Minimum length of 2. Maximum length of 50.  
Pattern: `^([A-Za-z]_?)+$` 

 ** [utterances](#API_GetUtterancesView_ResponseSyntax) **   <a name="lex-GetUtterancesView-response-utterances"></a>
An array of [UtteranceList](API_UtteranceList.md) objects, each containing a list of [UtteranceData](API_UtteranceData.md) objects describing the utterances that were processed by your bot. The response contains a maximum of 100 `UtteranceData` objects for each version. Amazon Lex returns the most frequent utterances received by the bot in the last 15 days.  
Type: Array of [UtteranceList](API_UtteranceList.md) objects

## Errors
<a name="API_GetUtterancesView_Errors"></a>

 ** BadRequestException **   
The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and try again.  
HTTP Status Code: 400

 ** InternalFailureException **   
An internal Amazon Lex error occurred. Try your request again.  
HTTP Status Code: 500

 ** LimitExceededException **   
The request exceeded a limit. Try your request again.  
HTTP Status Code: 429

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

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/lex-models-2017-04-19/GetUtterancesView) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lex-models-2017-04-19/GetUtterancesView) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lex-models-2017-04-19/GetUtterancesView) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lex-models-2017-04-19/GetUtterancesView) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lex-models-2017-04-19/GetUtterancesView) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lex-models-2017-04-19/GetUtterancesView) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lex-models-2017-04-19/GetUtterancesView) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lex-models-2017-04-19/GetUtterancesView) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lex-models-2017-04-19/GetUtterancesView) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lex-models-2017-04-19/GetUtterancesView) 

# ListTagsForResource
<a name="API_ListTagsForResource"></a>

Gets a list of tags associated with the specified resource. Only bots, bot aliases, and bot channels can have tags associated with them.

## Request Syntax
<a name="API_ListTagsForResource_RequestSyntax"></a>

```
GET /tags/resourceArn HTTP/1.1
```

## URI Request Parameters
<a name="API_ListTagsForResource_RequestParameters"></a>

The request uses the following URI parameters.

 ** [resourceArn](#API_ListTagsForResource_RequestSyntax) **   <a name="lex-ListTagsForResource-request-uri-resourceArn"></a>
The Amazon Resource Name (ARN) of the resource to get a list of tags for.  
Length Constraints: Minimum length of 1. Maximum length of 1011.  
Required: Yes

## Request Body
<a name="API_ListTagsForResource_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_ListTagsForResource_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "tags": [ 
      { 
         "key": "string",
         "value": "string"
      }
   ]
}
```

## Response Elements
<a name="API_ListTagsForResource_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [tags](#API_ListTagsForResource_ResponseSyntax) **   <a name="lex-ListTagsForResource-response-tags"></a>
The tags associated with a resource.  
Type: Array of [Tag](API_Tag.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 200 items.

## Errors
<a name="API_ListTagsForResource_Errors"></a>

 ** BadRequestException **   
The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and try again.  
HTTP Status Code: 400

 ** InternalFailureException **   
An internal Amazon Lex error occurred. Try your request again.  
HTTP Status Code: 500

 ** LimitExceededException **   
The request exceeded a limit. Try your request again.  
HTTP Status Code: 429

 ** NotFoundException **   
The resource specified in the request was not found. Check the resource and try again.  
HTTP Status Code: 404

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

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/lex-models-2017-04-19/ListTagsForResource) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lex-models-2017-04-19/ListTagsForResource) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lex-models-2017-04-19/ListTagsForResource) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lex-models-2017-04-19/ListTagsForResource) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lex-models-2017-04-19/ListTagsForResource) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lex-models-2017-04-19/ListTagsForResource) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lex-models-2017-04-19/ListTagsForResource) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lex-models-2017-04-19/ListTagsForResource) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lex-models-2017-04-19/ListTagsForResource) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lex-models-2017-04-19/ListTagsForResource) 

# PutBot
<a name="API_PutBot"></a>

Creates an Amazon Lex conversational bot or replaces an existing bot. When you create or update a bot you are only required to specify a name, a locale, and whether the bot is directed toward children under age 13. You can use this to add intents later, or to remove intents from an existing bot. When you create a bot with the minimum information, the bot is created or updated but Amazon Lex returns the `` response `FAILED`. You can build the bot after you add one or more intents. For more information about Amazon Lex bots, see [Amazon Lex: How It Works](how-it-works.md). 

If you specify the name of an existing bot, the fields in the request replace the existing values in the `$LATEST` version of the bot. Amazon Lex removes any fields that you don't provide values for in the request, except for the `idleTTLInSeconds` and `privacySettings` fields, which are set to their default values. If you don't specify values for required fields, Amazon Lex throws an exception.

This operation requires permissions for the `lex:PutBot` action. For more information, see [Identity and Access Management for Amazon Lex](security-iam.md).

## Request Syntax
<a name="API_PutBot_RequestSyntax"></a>

```
PUT /bots/name/versions/$LATEST HTTP/1.1
Content-type: application/json

{
   "abortStatement": { 
      "messages": [ 
         { 
            "content": "string",
            "contentType": "string",
            "groupNumber": number
         }
      ],
      "responseCard": "string"
   },
   "checksum": "string",
   "childDirected": boolean,
   "clarificationPrompt": { 
      "maxAttempts": number,
      "messages": [ 
         { 
            "content": "string",
            "contentType": "string",
            "groupNumber": number
         }
      ],
      "responseCard": "string"
   },
   "createVersion": boolean,
   "description": "string",
   "detectSentiment": boolean,
   "enableModelImprovements": boolean,
   "idleSessionTTLInSeconds": number,
   "intents": [ 
      { 
         "intentName": "string",
         "intentVersion": "string"
      }
   ],
   "locale": "string",
   "nluIntentConfidenceThreshold": number,
   "processBehavior": "string",
   "tags": [ 
      { 
         "key": "string",
         "value": "string"
      }
   ],
   "voiceId": "string"
}
```

## URI Request Parameters
<a name="API_PutBot_RequestParameters"></a>

The request uses the following URI parameters.

 ** [name](#API_PutBot_RequestSyntax) **   <a name="lex-PutBot-request-uri-name"></a>
The name of the bot. The name is *not* case sensitive.   
Length Constraints: Minimum length of 2. Maximum length of 50.  
Pattern: `^([A-Za-z]_?)+$`   
Required: Yes

## Request Body
<a name="API_PutBot_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [abortStatement](#API_PutBot_RequestSyntax) **   <a name="lex-PutBot-request-abortStatement"></a>
When Amazon Lex can't understand the user's input in context, it tries to elicit the information a few times. After that, Amazon Lex sends the message defined in `abortStatement` to the user, and then cancels the conversation. To set the number of retries, use the `valueElicitationPrompt` field for the slot type.   
For example, in a pizza ordering bot, Amazon Lex might ask a user "What type of crust would you like?" If the user's response is not one of the expected responses (for example, "thin crust, "deep dish," etc.), Amazon Lex tries to elicit a correct response a few more times.   
For example, in a pizza ordering application, `OrderPizza` might be one of the intents. This intent might require the `CrustType` slot. You specify the `valueElicitationPrompt` field when you create the `CrustType` slot.  
If you have defined a fallback intent the cancel statement will not be sent to the user, the fallback intent is used instead. For more information, see [ AMAZON.FallbackIntent](https://docs.aws.amazon.com/lex/latest/dg/built-in-intent-fallback.html).  
Type: [Statement](API_Statement.md) object  
Required: No

 ** [checksum](#API_PutBot_RequestSyntax) **   <a name="lex-PutBot-request-checksum"></a>
Identifies a specific revision of the `$LATEST` version.  
When you create a new bot, leave the `checksum` field blank. If you specify a checksum you get a `BadRequestException` exception.  
When you want to update a bot, set the `checksum` field to the checksum of the most recent revision of the `$LATEST` version. If you don't specify the ` checksum` field, or if the checksum does not match the `$LATEST` version, you get a `PreconditionFailedException` exception.  
Type: String  
Required: No

 ** [childDirected](#API_PutBot_RequestSyntax) **   <a name="lex-PutBot-request-childDirected"></a>
For each Amazon Lex bot created with the Amazon Lex Model Building Service, you must specify whether your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to the Children's Online Privacy Protection Act (COPPA) by specifying `true` or `false` in the `childDirected` field. By specifying `true` in the `childDirected` field, you confirm that your use of Amazon Lex **is** related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA. By specifying `false` in the `childDirected` field, you confirm that your use of Amazon Lex **is not** related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA. You may not specify a default value for the `childDirected` field that does not accurately reflect whether your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA.  
If your use of Amazon Lex relates to a website, program, or other application that is directed in whole or in part, to children under age 13, you must obtain any required verifiable parental consent under COPPA. For information regarding the use of Amazon Lex in connection with websites, programs, or other applications that are directed or targeted, in whole or in part, to children under age 13, see the [Amazon Lex FAQ.](https://aws.amazon.com/lex/faqs#data-security)   
Type: Boolean  
Required: Yes

 ** [clarificationPrompt](#API_PutBot_RequestSyntax) **   <a name="lex-PutBot-request-clarificationPrompt"></a>
When Amazon Lex doesn't understand the user's intent, it uses this message to get clarification. To specify how many times Amazon Lex should repeat the clarification prompt, use the `maxAttempts` field. If Amazon Lex still doesn't understand, it sends the message in the `abortStatement` field.   
When you create a clarification prompt, make sure that it suggests the correct response from the user. for example, for a bot that orders pizza and drinks, you might create this clarification prompt: "What would you like to do? You can say 'Order a pizza' or 'Order a drink.'"  
If you have defined a fallback intent, it will be invoked if the clarification prompt is repeated the number of times defined in the `maxAttempts` field. For more information, see [ AMAZON.FallbackIntent](https://docs.aws.amazon.com/lex/latest/dg/built-in-intent-fallback.html).  
If you don't define a clarification prompt, at runtime Amazon Lex will return a 400 Bad Request exception in three cases:   
+ Follow-up prompt - When the user responds to a follow-up prompt but does not provide an intent. For example, in response to a follow-up prompt that says "Would you like anything else today?" the user says "Yes." Amazon Lex will return a 400 Bad Request exception because it does not have a clarification prompt to send to the user to get an intent.
+ Lambda function - When using a Lambda function, you return an `ElicitIntent` dialog type. Since Amazon Lex does not have a clarification prompt to get an intent from the user, it returns a 400 Bad Request exception.
+ PutSession operation - When using the `PutSession` operation, you send an `ElicitIntent` dialog type. Since Amazon Lex does not have a clarification prompt to get an intent from the user, it returns a 400 Bad Request exception.
Type: [Prompt](API_Prompt.md) object  
Required: No

 ** [createVersion](#API_PutBot_RequestSyntax) **   <a name="lex-PutBot-request-createVersion"></a>
When set to `true` a new numbered version of the bot is created. This is the same as calling the `CreateBotVersion` operation. If you don't specify `createVersion`, the default is `false`.  
Type: Boolean  
Required: No

 ** [description](#API_PutBot_RequestSyntax) **   <a name="lex-PutBot-request-description"></a>
A description of the bot.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 200.  
Required: No

 ** [detectSentiment](#API_PutBot_RequestSyntax) **   <a name="lex-PutBot-request-detectSentiment"></a>
When set to `true` user utterances are sent to Amazon Comprehend for sentiment analysis. If you don't specify `detectSentiment`, the default is `false`.  
Type: Boolean  
Required: No

 ** [enableModelImprovements](#API_PutBot_RequestSyntax) **   <a name="lex-PutBot-request-enableModelImprovements"></a>
Set to `true` to enable access to natural language understanding improvements.   
When you set the `enableModelImprovements` parameter to `true` you can use the `nluIntentConfidenceThreshold` parameter to configure confidence scores. For more information, see [Confidence Scores](https://docs.aws.amazon.com/lex/latest/dg/confidence-scores.html).  
You can only set the `enableModelImprovements` parameter in certain Regions. If you set the parameter to `true`, your bot has access to accuracy improvements.  
The Regions where you can set the `enableModelImprovements` parameter to `false` for the en-US locale are:  
+ US East (N. Virginia) (us-east-1)
+ US West (Oregon) (us-west-2)
+ Asia Pacific (Sydney) (ap-southeast-2)
+ EU (Ireland) (eu-west-1)
In other Regions and locales, the `enableModelImprovements` parameter is set to `true` by default. In these Regions and locales setting the parameter to `false` throws a `ValidationException` exception.  
Type: Boolean  
Required: No

 ** [idleSessionTTLInSeconds](#API_PutBot_RequestSyntax) **   <a name="lex-PutBot-request-idleSessionTTLInSeconds"></a>
The maximum time in seconds that Amazon Lex retains the data gathered in a conversation.  
A user interaction session remains active for the amount of time specified. If no conversation occurs during this time, the session expires and Amazon Lex deletes any data provided before the timeout.  
For example, suppose that a user chooses the OrderPizza intent, but gets sidetracked halfway through placing an order. If the user doesn't complete the order within the specified time, Amazon Lex discards the slot information that it gathered, and the user must start over.  
If you don't include the `idleSessionTTLInSeconds` element in a `PutBot` operation request, Amazon Lex uses the default value. This is also true if the request replaces an existing bot.  
The default is 300 seconds (5 minutes).  
Type: Integer  
Valid Range: Minimum value of 60. Maximum value of 86400.  
Required: No

 ** [intents](#API_PutBot_RequestSyntax) **   <a name="lex-PutBot-request-intents"></a>
An array of `Intent` objects. Each intent represents a command that a user can express. For example, a pizza ordering bot might support an OrderPizza intent. For more information, see [Amazon Lex: How It Works](how-it-works.md).  
Type: Array of [Intent](API_Intent.md) objects  
Required: No

 ** [locale](#API_PutBot_RequestSyntax) **   <a name="lex-PutBot-request-locale"></a>
 Specifies the target locale for the bot. Any intent used in the bot must be compatible with the locale of the bot.   
The default is `en-US`.  
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: Yes

 ** [nluIntentConfidenceThreshold](#API_PutBot_RequestSyntax) **   <a name="lex-PutBot-request-nluIntentConfidenceThreshold"></a>
Determines the threshold where Amazon Lex will insert the `AMAZON.FallbackIntent`, `AMAZON.KendraSearchIntent`, or both when returning alternative intents in a [PostContent](https://docs.aws.amazon.com/lex/latest/dg/API_runtime_PostContent.html) or [PostText](https://docs.aws.amazon.com/lex/latest/dg/API_runtime_PostText.html) response. `AMAZON.FallbackIntent` and `AMAZON.KendraSearchIntent` are only inserted if they are configured for the bot.  
You must set the `enableModelImprovements` parameter to `true` to use confidence scores in the following regions.  
+ US East (N. Virginia) (us-east-1)
+ US West (Oregon) (us-west-2)
+ Asia Pacific (Sydney) (ap-southeast-2)
+ EU (Ireland) (eu-west-1)
In other Regions, the `enableModelImprovements` parameter is set to `true` by default.  
For example, suppose a bot is configured with the confidence threshold of 0.80 and the `AMAZON.FallbackIntent`. Amazon Lex returns three alternative intents with the following confidence scores: IntentA (0.70), IntentB (0.60), IntentC (0.50). The response from the `PostText` operation would be:  
+ AMAZON.FallbackIntent
+ IntentA
+ IntentB
+ IntentC
Type: Double  
Valid Range: Minimum value of 0. Maximum value of 1.  
Required: No

 ** [processBehavior](#API_PutBot_RequestSyntax) **   <a name="lex-PutBot-request-processBehavior"></a>
If you set the `processBehavior` element to `BUILD`, Amazon Lex builds the bot so that it can be run. If you set the element to `SAVE` Amazon Lex saves the bot, but doesn't build it.   
If you don't specify this value, the default value is `BUILD`.  
Type: String  
Valid Values: `SAVE | BUILD`   
Required: No

 ** [tags](#API_PutBot_RequestSyntax) **   <a name="lex-PutBot-request-tags"></a>
A list of tags to add to the bot. You can only add tags when you create a bot, you can't use the `PutBot` operation to update the tags on a bot. To update tags, use the `TagResource` operation.  
Type: Array of [Tag](API_Tag.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 200 items.  
Required: No

 ** [voiceId](#API_PutBot_RequestSyntax) **   <a name="lex-PutBot-request-voiceId"></a>
The Amazon Polly voice ID that you want Amazon Lex to use for voice interactions with the user. The locale configured for the voice must match the locale of the bot. For more information, see [Voices in Amazon Polly](https://docs.aws.amazon.com/polly/latest/dg/voicelist.html) in the *Amazon Polly Developer Guide*.  
Type: String  
Required: No

## Response Syntax
<a name="API_PutBot_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "abortStatement": { 
      "messages": [ 
         { 
            "content": "string",
            "contentType": "string",
            "groupNumber": number
         }
      ],
      "responseCard": "string"
   },
   "checksum": "string",
   "childDirected": boolean,
   "clarificationPrompt": { 
      "maxAttempts": number,
      "messages": [ 
         { 
            "content": "string",
            "contentType": "string",
            "groupNumber": number
         }
      ],
      "responseCard": "string"
   },
   "createdDate": number,
   "createVersion": boolean,
   "description": "string",
   "detectSentiment": boolean,
   "enableModelImprovements": boolean,
   "failureReason": "string",
   "idleSessionTTLInSeconds": number,
   "intents": [ 
      { 
         "intentName": "string",
         "intentVersion": "string"
      }
   ],
   "lastUpdatedDate": number,
   "locale": "string",
   "name": "string",
   "nluIntentConfidenceThreshold": number,
   "status": "string",
   "tags": [ 
      { 
         "key": "string",
         "value": "string"
      }
   ],
   "version": "string",
   "voiceId": "string"
}
```

## Response Elements
<a name="API_PutBot_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [abortStatement](#API_PutBot_ResponseSyntax) **   <a name="lex-PutBot-response-abortStatement"></a>
The message that Amazon Lex uses to cancel a conversation. For more information, see [PutBot](#API_PutBot).  
Type: [Statement](API_Statement.md) object

 ** [checksum](#API_PutBot_ResponseSyntax) **   <a name="lex-PutBot-response-checksum"></a>
Checksum of the bot that you created.  
Type: String

 ** [childDirected](#API_PutBot_ResponseSyntax) **   <a name="lex-PutBot-response-childDirected"></a>
For each Amazon Lex bot created with the Amazon Lex Model Building Service, you must specify whether your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to the Children's Online Privacy Protection Act (COPPA) by specifying `true` or `false` in the `childDirected` field. By specifying `true` in the `childDirected` field, you confirm that your use of Amazon Lex **is** related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA. By specifying `false` in the `childDirected` field, you confirm that your use of Amazon Lex **is not** related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA. You may not specify a default value for the `childDirected` field that does not accurately reflect whether your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA.  
If your use of Amazon Lex relates to a website, program, or other application that is directed in whole or in part, to children under age 13, you must obtain any required verifiable parental consent under COPPA. For information regarding the use of Amazon Lex in connection with websites, programs, or other applications that are directed or targeted, in whole or in part, to children under age 13, see the [Amazon Lex FAQ.](https://aws.amazon.com/lex/faqs#data-security)   
Type: Boolean

 ** [clarificationPrompt](#API_PutBot_ResponseSyntax) **   <a name="lex-PutBot-response-clarificationPrompt"></a>
 The prompts that Amazon Lex uses when it doesn't understand the user's intent. For more information, see [PutBot](#API_PutBot).   
Type: [Prompt](API_Prompt.md) object

 ** [createdDate](#API_PutBot_ResponseSyntax) **   <a name="lex-PutBot-response-createdDate"></a>
The date that the bot was created.  
Type: Timestamp

 ** [createVersion](#API_PutBot_ResponseSyntax) **   <a name="lex-PutBot-response-createVersion"></a>
 `True` if a new version of the bot was created. If the `createVersion` field was not specified in the request, the `createVersion` field is set to false in the response.  
Type: Boolean

 ** [description](#API_PutBot_ResponseSyntax) **   <a name="lex-PutBot-response-description"></a>
A description of the bot.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 200.

 ** [detectSentiment](#API_PutBot_ResponseSyntax) **   <a name="lex-PutBot-response-detectSentiment"></a>
 `true` if the bot is configured to send user utterances to Amazon Comprehend for sentiment analysis. If the `detectSentiment` field was not specified in the request, the `detectSentiment` field is `false` in the response.  
Type: Boolean

 ** [enableModelImprovements](#API_PutBot_ResponseSyntax) **   <a name="lex-PutBot-response-enableModelImprovements"></a>
Indicates whether the bot uses accuracy improvements. `true` indicates that the bot is using the improvements, otherwise, `false`.  
Type: Boolean

 ** [failureReason](#API_PutBot_ResponseSyntax) **   <a name="lex-PutBot-response-failureReason"></a>
If `status` is `FAILED`, Amazon Lex provides the reason that it failed to build the bot.  
Type: String

 ** [idleSessionTTLInSeconds](#API_PutBot_ResponseSyntax) **   <a name="lex-PutBot-response-idleSessionTTLInSeconds"></a>
The maximum length of time that Amazon Lex retains the data gathered in a conversation. For more information, see [PutBot](#API_PutBot).  
Type: Integer  
Valid Range: Minimum value of 60. Maximum value of 86400.

 ** [intents](#API_PutBot_ResponseSyntax) **   <a name="lex-PutBot-response-intents"></a>
An array of `Intent` objects. For more information, see [PutBot](#API_PutBot).  
Type: Array of [Intent](API_Intent.md) objects

 ** [lastUpdatedDate](#API_PutBot_ResponseSyntax) **   <a name="lex-PutBot-response-lastUpdatedDate"></a>
The date that the bot was updated. When you create a resource, the creation date and last updated date are the same.  
Type: Timestamp

 ** [locale](#API_PutBot_ResponseSyntax) **   <a name="lex-PutBot-response-locale"></a>
 The target locale for the bot.   
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` 

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

 ** [nluIntentConfidenceThreshold](#API_PutBot_ResponseSyntax) **   <a name="lex-PutBot-response-nluIntentConfidenceThreshold"></a>
The score that determines where Amazon Lex inserts the `AMAZON.FallbackIntent`, `AMAZON.KendraSearchIntent`, or both when returning alternative intents in a [PostContent](https://docs.aws.amazon.com/lex/latest/dg/API_runtime_PostContent.html) or [PostText](https://docs.aws.amazon.com/lex/latest/dg/API_runtime_PostText.html) response. `AMAZON.FallbackIntent` is inserted if the confidence score for all intents is below this value. `AMAZON.KendraSearchIntent` is only inserted if it is configured for the bot.  
Type: Double  
Valid Range: Minimum value of 0. Maximum value of 1.

 ** [status](#API_PutBot_ResponseSyntax) **   <a name="lex-PutBot-response-status"></a>
 When you send a request to create a bot with `processBehavior` set to `BUILD`, Amazon Lex sets the `status` response element to `BUILDING`.  
In the `READY_BASIC_TESTING` state you can test the bot with user inputs that exactly match the utterances configured for the bot's intents and values in the slot types.  
If Amazon Lex can't build the bot, Amazon Lex sets `status` to `FAILED`. Amazon Lex returns the reason for the failure in the `failureReason` response element.   
When you set `processBehavior` to `SAVE`, Amazon Lex sets the status code to `NOT BUILT`.  
When the bot is in the `READY` state you can test and publish the bot.  
Type: String  
Valid Values: `BUILDING | READY | READY_BASIC_TESTING | FAILED | NOT_BUILT` 

 ** [tags](#API_PutBot_ResponseSyntax) **   <a name="lex-PutBot-response-tags"></a>
A list of tags associated with the bot.  
Type: Array of [Tag](API_Tag.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 200 items.

 ** [version](#API_PutBot_ResponseSyntax) **   <a name="lex-PutBot-response-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]+` 

 ** [voiceId](#API_PutBot_ResponseSyntax) **   <a name="lex-PutBot-response-voiceId"></a>
The Amazon Polly voice ID that Amazon Lex uses for voice interaction with the user. For more information, see [PutBot](#API_PutBot).  
Type: String

## Errors
<a name="API_PutBot_Errors"></a>

 ** BadRequestException **   
The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and try again.  
HTTP Status Code: 400

 ** ConflictException **   
 There was a conflict processing the request. Try your request again.   
HTTP Status Code: 409

 ** InternalFailureException **   
An internal Amazon Lex error occurred. Try your request again.  
HTTP Status Code: 500

 ** LimitExceededException **   
The request exceeded a limit. Try your request again.  
HTTP Status Code: 429

 ** PreconditionFailedException **   
 The checksum of the resource that you are trying to change does not match the checksum in the request. Check the resource's checksum and try again.  
HTTP Status Code: 412

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

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/lex-models-2017-04-19/PutBot) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lex-models-2017-04-19/PutBot) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lex-models-2017-04-19/PutBot) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lex-models-2017-04-19/PutBot) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lex-models-2017-04-19/PutBot) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lex-models-2017-04-19/PutBot) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lex-models-2017-04-19/PutBot) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lex-models-2017-04-19/PutBot) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lex-models-2017-04-19/PutBot) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lex-models-2017-04-19/PutBot) 

# PutBotAlias
<a name="API_PutBotAlias"></a>

Creates an alias for the specified version of the bot or replaces an alias for the specified bot. To change the version of the bot that the alias points to, replace the alias. For more information about aliases, see [Versioning and Aliases](versioning-aliases.md).

This operation requires permissions for the `lex:PutBotAlias` action. 

## Request Syntax
<a name="API_PutBotAlias_RequestSyntax"></a>

```
PUT /bots/botName/aliases/name HTTP/1.1
Content-type: application/json

{
   "botVersion": "string",
   "checksum": "string",
   "conversationLogs": { 
      "iamRoleArn": "string",
      "logSettings": [ 
         { 
            "destination": "string",
            "kmsKeyArn": "string",
            "logType": "string",
            "resourceArn": "string"
         }
      ]
   },
   "description": "string",
   "tags": [ 
      { 
         "key": "string",
         "value": "string"
      }
   ]
}
```

## URI Request Parameters
<a name="API_PutBotAlias_RequestParameters"></a>

The request uses the following URI parameters.

 ** [botName](#API_PutBotAlias_RequestSyntax) **   <a name="lex-PutBotAlias-request-uri-botName"></a>
The name of the bot.  
Length Constraints: Minimum length of 2. Maximum length of 50.  
Pattern: `^([A-Za-z]_?)+$`   
Required: Yes

 ** [name](#API_PutBotAlias_RequestSyntax) **   <a name="lex-PutBotAlias-request-uri-name"></a>
The name of the alias. The name is *not* case sensitive.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `^([A-Za-z]_?)+$`   
Required: Yes

## Request Body
<a name="API_PutBotAlias_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [botVersion](#API_PutBotAlias_RequestSyntax) **   <a name="lex-PutBotAlias-request-botVersion"></a>
The version of the bot.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `\$LATEST|[0-9]+`   
Required: Yes

 ** [checksum](#API_PutBotAlias_RequestSyntax) **   <a name="lex-PutBotAlias-request-checksum"></a>
Identifies a specific revision of the `$LATEST` version.  
When you create a new bot alias, leave the `checksum` field blank. If you specify a checksum you get a `BadRequestException` exception.  
When you want to update a bot alias, set the `checksum` field to the checksum of the most recent revision of the `$LATEST` version. If you don't specify the ` checksum` field, or if the checksum does not match the `$LATEST` version, you get a `PreconditionFailedException` exception.  
Type: String  
Required: No

 ** [conversationLogs](#API_PutBotAlias_RequestSyntax) **   <a name="lex-PutBotAlias-request-conversationLogs"></a>
Settings for conversation logs for the alias.  
Type: [ConversationLogsRequest](API_ConversationLogsRequest.md) object  
Required: No

 ** [description](#API_PutBotAlias_RequestSyntax) **   <a name="lex-PutBotAlias-request-description"></a>
A description of the alias.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 200.  
Required: No

 ** [tags](#API_PutBotAlias_RequestSyntax) **   <a name="lex-PutBotAlias-request-tags"></a>
A list of tags to add to the bot alias. You can only add tags when you create an alias, you can't use the `PutBotAlias` operation to update the tags on a bot alias. To update tags, use the `TagResource` operation.  
Type: Array of [Tag](API_Tag.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 200 items.  
Required: No

## Response Syntax
<a name="API_PutBotAlias_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "botName": "string",
   "botVersion": "string",
   "checksum": "string",
   "conversationLogs": { 
      "iamRoleArn": "string",
      "logSettings": [ 
         { 
            "destination": "string",
            "kmsKeyArn": "string",
            "logType": "string",
            "resourceArn": "string",
            "resourcePrefix": "string"
         }
      ]
   },
   "createdDate": number,
   "description": "string",
   "lastUpdatedDate": number,
   "name": "string",
   "tags": [ 
      { 
         "key": "string",
         "value": "string"
      }
   ]
}
```

## Response Elements
<a name="API_PutBotAlias_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

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

 ** [botVersion](#API_PutBotAlias_ResponseSyntax) **   <a name="lex-PutBotAlias-response-botVersion"></a>
The version of the bot that the alias points to.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `\$LATEST|[0-9]+` 

 ** [checksum](#API_PutBotAlias_ResponseSyntax) **   <a name="lex-PutBotAlias-response-checksum"></a>
The checksum for the current version of the alias.  
Type: String

 ** [conversationLogs](#API_PutBotAlias_ResponseSyntax) **   <a name="lex-PutBotAlias-response-conversationLogs"></a>
The settings that determine how Amazon Lex uses conversation logs for the alias.  
Type: [ConversationLogsResponse](API_ConversationLogsResponse.md) object

 ** [createdDate](#API_PutBotAlias_ResponseSyntax) **   <a name="lex-PutBotAlias-response-createdDate"></a>
The date that the bot alias was created.  
Type: Timestamp

 ** [description](#API_PutBotAlias_ResponseSyntax) **   <a name="lex-PutBotAlias-response-description"></a>
A description of the alias.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 200.

 ** [lastUpdatedDate](#API_PutBotAlias_ResponseSyntax) **   <a name="lex-PutBotAlias-response-lastUpdatedDate"></a>
The date that the bot alias was updated. When you create a resource, the creation date and the last updated date are the same.  
Type: Timestamp

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

 ** [tags](#API_PutBotAlias_ResponseSyntax) **   <a name="lex-PutBotAlias-response-tags"></a>
A list of tags associated with a bot.  
Type: Array of [Tag](API_Tag.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 200 items.

## Errors
<a name="API_PutBotAlias_Errors"></a>

 ** BadRequestException **   
The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and try again.  
HTTP Status Code: 400

 ** ConflictException **   
 There was a conflict processing the request. Try your request again.   
HTTP Status Code: 409

 ** InternalFailureException **   
An internal Amazon Lex error occurred. Try your request again.  
HTTP Status Code: 500

 ** LimitExceededException **   
The request exceeded a limit. Try your request again.  
HTTP Status Code: 429

 ** PreconditionFailedException **   
 The checksum of the resource that you are trying to change does not match the checksum in the request. Check the resource's checksum and try again.  
HTTP Status Code: 412

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

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/lex-models-2017-04-19/PutBotAlias) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lex-models-2017-04-19/PutBotAlias) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lex-models-2017-04-19/PutBotAlias) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lex-models-2017-04-19/PutBotAlias) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lex-models-2017-04-19/PutBotAlias) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lex-models-2017-04-19/PutBotAlias) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lex-models-2017-04-19/PutBotAlias) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lex-models-2017-04-19/PutBotAlias) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lex-models-2017-04-19/PutBotAlias) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lex-models-2017-04-19/PutBotAlias) 

# PutIntent
<a name="API_PutIntent"></a>

Creates an intent or replaces an existing intent.

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

To create an intent or replace an existing intent, you must provide the following:
+ Intent name. For example, `OrderPizza`.
+ Sample utterances. For example, "Can I order a pizza, please." and "I want to order a pizza."
+ Information to be gathered. You specify slot types for the information that your bot will request from the user. You can specify standard slot types, such as a date or a time, or custom slot types such as the size and crust of a pizza.
+ How the intent will be fulfilled. You can provide a Lambda function or configure the intent to return the intent information to the client application. If you use a Lambda function, when all of the intent information is available, Amazon Lex invokes your Lambda function. If you configure your intent to return the intent information to the client application. 

You can specify other optional information in the request, such as:
+ A confirmation prompt to ask the user to confirm an intent. For example, "Shall I order your pizza?"
+ A conclusion statement to send to the user after the intent has been fulfilled. For example, "I placed your pizza order."
+ A follow-up prompt that asks the user for additional activity. For example, asking "Do you want to order a drink with your pizza?"

If you specify an existing intent name to update the intent, Amazon Lex replaces the values in the `$LATEST` version of the intent with the values in the request. Amazon Lex removes fields that you don't provide in the request. If you don't specify the required fields, Amazon Lex throws an exception. When you update the `$LATEST` version of an intent, the `status` field of any bot that uses the `$LATEST` version of the intent is set to `NOT_BUILT`.

For more information, see [Amazon Lex: How It Works](how-it-works.md).

This operation requires permissions for the `lex:PutIntent` action.

## Request Syntax
<a name="API_PutIntent_RequestSyntax"></a>

```
PUT /intents/name/versions/$LATEST HTTP/1.1
Content-type: application/json

{
   "checksum": "string",
   "conclusionStatement": { 
      "messages": [ 
         { 
            "content": "string",
            "contentType": "string",
            "groupNumber": number
         }
      ],
      "responseCard": "string"
   },
   "confirmationPrompt": { 
      "maxAttempts": number,
      "messages": [ 
         { 
            "content": "string",
            "contentType": "string",
            "groupNumber": number
         }
      ],
      "responseCard": "string"
   },
   "createVersion": boolean,
   "description": "string",
   "dialogCodeHook": { 
      "messageVersion": "string",
      "uri": "string"
   },
   "followUpPrompt": { 
      "prompt": { 
         "maxAttempts": number,
         "messages": [ 
            { 
               "content": "string",
               "contentType": "string",
               "groupNumber": number
            }
         ],
         "responseCard": "string"
      },
      "rejectionStatement": { 
         "messages": [ 
            { 
               "content": "string",
               "contentType": "string",
               "groupNumber": number
            }
         ],
         "responseCard": "string"
      }
   },
   "fulfillmentActivity": { 
      "codeHook": { 
         "messageVersion": "string",
         "uri": "string"
      },
      "type": "string"
   },
   "inputContexts": [ 
      { 
         "name": "string"
      }
   ],
   "kendraConfiguration": { 
      "kendraIndex": "string",
      "queryFilterString": "string",
      "role": "string"
   },
   "outputContexts": [ 
      { 
         "name": "string",
         "timeToLiveInSeconds": number,
         "turnsToLive": number
      }
   ],
   "parentIntentSignature": "string",
   "rejectionStatement": { 
      "messages": [ 
         { 
            "content": "string",
            "contentType": "string",
            "groupNumber": number
         }
      ],
      "responseCard": "string"
   },
   "sampleUtterances": [ "string" ],
   "slots": [ 
      { 
         "defaultValueSpec": { 
            "defaultValueList": [ 
               { 
                  "defaultValue": "string"
               }
            ]
         },
         "description": "string",
         "name": "string",
         "obfuscationSetting": "string",
         "priority": number,
         "responseCard": "string",
         "sampleUtterances": [ "string" ],
         "slotConstraint": "string",
         "slotType": "string",
         "slotTypeVersion": "string",
         "valueElicitationPrompt": { 
            "maxAttempts": number,
            "messages": [ 
               { 
                  "content": "string",
                  "contentType": "string",
                  "groupNumber": number
               }
            ],
            "responseCard": "string"
         }
      }
   ]
}
```

## URI Request Parameters
<a name="API_PutIntent_RequestParameters"></a>

The request uses the following URI parameters.

 ** [name](#API_PutIntent_RequestSyntax) **   <a name="lex-PutIntent-request-uri-name"></a>
The name of the intent. The name is *not* case sensitive.   
The name can't match a built-in intent name, or a built-in intent name with "AMAZON." removed. For example, because there is a built-in intent called `AMAZON.HelpIntent`, you can't create a custom intent called `HelpIntent`.  
For a list of built-in intents, 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*.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `^([A-Za-z]_?)+$`   
Required: Yes

## Request Body
<a name="API_PutIntent_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [checksum](#API_PutIntent_RequestSyntax) **   <a name="lex-PutIntent-request-checksum"></a>
Identifies a specific revision of the `$LATEST` version.  
When you create a new intent, leave the `checksum` field blank. If you specify a checksum you get a `BadRequestException` exception.  
When you want to update a intent, set the `checksum` field to the checksum of the most recent revision of the `$LATEST` version. If you don't specify the ` checksum` field, or if the checksum does not match the `$LATEST` version, you get a `PreconditionFailedException` exception.  
Type: String  
Required: No

 ** [conclusionStatement](#API_PutIntent_RequestSyntax) **   <a name="lex-PutIntent-request-conclusionStatement"></a>
 The statement that you want Amazon Lex to convey to the user after the intent is successfully fulfilled by the Lambda function.   
This element is relevant only if you provide a Lambda function in the `fulfillmentActivity`. If you return the intent to the client application, you can't specify this element.  
The `followUpPrompt` and `conclusionStatement` are mutually exclusive. You can specify only one.
Type: [Statement](API_Statement.md) object  
Required: No

 ** [confirmationPrompt](#API_PutIntent_RequestSyntax) **   <a name="lex-PutIntent-request-confirmationPrompt"></a>
Prompts the user to confirm the intent. This question should have a yes or no answer.  
Amazon Lex uses this prompt to ensure that the user acknowledges that the intent is ready for fulfillment. For example, with the `OrderPizza` intent, you might want to confirm that the order is correct before placing it. For other intents, such as intents that simply respond to user questions, you might not need to ask the user for confirmation before providing the information.   
You you must provide both the `rejectionStatement` and the `confirmationPrompt`, or neither.
Type: [Prompt](API_Prompt.md) object  
Required: No

 ** [createVersion](#API_PutIntent_RequestSyntax) **   <a name="lex-PutIntent-request-createVersion"></a>
When set to `true` a new numbered version of the intent is created. This is the same as calling the `CreateIntentVersion` operation. If you do not specify `createVersion`, the default is `false`.  
Type: Boolean  
Required: No

 ** [description](#API_PutIntent_RequestSyntax) **   <a name="lex-PutIntent-request-description"></a>
A description of the intent.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 200.  
Required: No

 ** [dialogCodeHook](#API_PutIntent_RequestSyntax) **   <a name="lex-PutIntent-request-dialogCodeHook"></a>
 Specifies a Lambda function to invoke for each user input. You can invoke this Lambda function to personalize user interaction.   
For example, suppose your bot determines that the user is John. Your Lambda function might retrieve John's information from a backend database and prepopulate some of the values. For example, if you find that John is gluten intolerant, you might set the corresponding intent slot, `GlutenIntolerant`, to true. You might find John's phone number and set the corresponding session attribute.   
Type: [CodeHook](API_CodeHook.md) object  
Required: No

 ** [followUpPrompt](#API_PutIntent_RequestSyntax) **   <a name="lex-PutIntent-request-followUpPrompt"></a>
Amazon Lex uses this prompt to solicit additional activity after fulfilling an intent. For example, after the `OrderPizza` intent is fulfilled, you might prompt the user to order a drink.  
The action that Amazon Lex takes depends on the user's response, as follows:  
+ If the user says "Yes" it responds with the clarification prompt that is configured for the bot.
+ if the user says "Yes" and continues with an utterance that triggers an intent it starts a conversation for the intent.
+ If the user says "No" it responds with the rejection statement configured for the the follow-up prompt.
+ If it doesn't recognize the utterance it repeats the follow-up prompt again.
The `followUpPrompt` field and the `conclusionStatement` field are mutually exclusive. You can specify only one.   
Type: [FollowUpPrompt](API_FollowUpPrompt.md) object  
Required: No

 ** [fulfillmentActivity](#API_PutIntent_RequestSyntax) **   <a name="lex-PutIntent-request-fulfillmentActivity"></a>
Required. Describes how the intent is fulfilled. For example, after a user provides all of the information for a pizza order, `fulfillmentActivity` defines how the bot places an order with a local pizza store.   
 You might configure Amazon Lex to return all of the intent information to the client application, or direct it to invoke a Lambda function that can process the intent (for example, place an order with a pizzeria).   
Type: [FulfillmentActivity](API_FulfillmentActivity.md) object  
Required: No

 ** [inputContexts](#API_PutIntent_RequestSyntax) **   <a name="lex-PutIntent-request-inputContexts"></a>
An array of `InputContext` objects that lists the contexts that must be active for Amazon Lex to choose the intent in a conversation with the user.  
Type: Array of [InputContext](API_InputContext.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 5 items.  
Required: No

 ** [kendraConfiguration](#API_PutIntent_RequestSyntax) **   <a name="lex-PutIntent-request-kendraConfiguration"></a>
Configuration information required to use the `AMAZON.KendraSearchIntent` intent to connect to an Amazon Kendra index. For more information, see [ AMAZON.KendraSearchIntent](http://docs.aws.amazon.com/lex/latest/dg/built-in-intent-kendra-search.html).  
Type: [KendraConfiguration](API_KendraConfiguration.md) object  
Required: No

 ** [outputContexts](#API_PutIntent_RequestSyntax) **   <a name="lex-PutIntent-request-outputContexts"></a>
An array of `OutputContext` objects that lists the contexts that the intent activates when the intent is fulfilled.  
Type: Array of [OutputContext](API_OutputContext.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 10 items.  
Required: No

 ** [parentIntentSignature](#API_PutIntent_RequestSyntax) **   <a name="lex-PutIntent-request-parentIntentSignature"></a>
A unique identifier for the built-in intent to base this intent on. 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

 ** [rejectionStatement](#API_PutIntent_RequestSyntax) **   <a name="lex-PutIntent-request-rejectionStatement"></a>
When the user answers "no" to the question defined in `confirmationPrompt`, Amazon Lex responds with this statement to acknowledge that the intent was canceled.   
You must provide both the `rejectionStatement` and the `confirmationPrompt`, or neither.
Type: [Statement](API_Statement.md) object  
Required: No

 ** [sampleUtterances](#API_PutIntent_RequestSyntax) **   <a name="lex-PutIntent-request-sampleUtterances"></a>
An array of utterances (strings) that a user might say to signal the intent. For example, "I want \$1PizzaSize\$1 pizza", "Order \$1Quantity\$1 \$1PizzaSize\$1 pizzas".   
In each utterance, a slot name is enclosed in curly braces.   
Type: Array of strings  
Array Members: Minimum number of 0 items. Maximum number of 1500 items.  
Length Constraints: Minimum length of 1. Maximum length of 200.  
Required: No

 ** [slots](#API_PutIntent_RequestSyntax) **   <a name="lex-PutIntent-request-slots"></a>
An array of intent slots. At runtime, Amazon Lex elicits required slot values from the user using prompts defined in the slots. For more information, see [Amazon Lex: How It Works](how-it-works.md).   
Type: Array of [Slot](API_Slot.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 100 items.  
Required: No

## Response Syntax
<a name="API_PutIntent_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "checksum": "string",
   "conclusionStatement": { 
      "messages": [ 
         { 
            "content": "string",
            "contentType": "string",
            "groupNumber": number
         }
      ],
      "responseCard": "string"
   },
   "confirmationPrompt": { 
      "maxAttempts": number,
      "messages": [ 
         { 
            "content": "string",
            "contentType": "string",
            "groupNumber": number
         }
      ],
      "responseCard": "string"
   },
   "createdDate": number,
   "createVersion": boolean,
   "description": "string",
   "dialogCodeHook": { 
      "messageVersion": "string",
      "uri": "string"
   },
   "followUpPrompt": { 
      "prompt": { 
         "maxAttempts": number,
         "messages": [ 
            { 
               "content": "string",
               "contentType": "string",
               "groupNumber": number
            }
         ],
         "responseCard": "string"
      },
      "rejectionStatement": { 
         "messages": [ 
            { 
               "content": "string",
               "contentType": "string",
               "groupNumber": number
            }
         ],
         "responseCard": "string"
      }
   },
   "fulfillmentActivity": { 
      "codeHook": { 
         "messageVersion": "string",
         "uri": "string"
      },
      "type": "string"
   },
   "inputContexts": [ 
      { 
         "name": "string"
      }
   ],
   "kendraConfiguration": { 
      "kendraIndex": "string",
      "queryFilterString": "string",
      "role": "string"
   },
   "lastUpdatedDate": number,
   "name": "string",
   "outputContexts": [ 
      { 
         "name": "string",
         "timeToLiveInSeconds": number,
         "turnsToLive": number
      }
   ],
   "parentIntentSignature": "string",
   "rejectionStatement": { 
      "messages": [ 
         { 
            "content": "string",
            "contentType": "string",
            "groupNumber": number
         }
      ],
      "responseCard": "string"
   },
   "sampleUtterances": [ "string" ],
   "slots": [ 
      { 
         "defaultValueSpec": { 
            "defaultValueList": [ 
               { 
                  "defaultValue": "string"
               }
            ]
         },
         "description": "string",
         "name": "string",
         "obfuscationSetting": "string",
         "priority": number,
         "responseCard": "string",
         "sampleUtterances": [ "string" ],
         "slotConstraint": "string",
         "slotType": "string",
         "slotTypeVersion": "string",
         "valueElicitationPrompt": { 
            "maxAttempts": number,
            "messages": [ 
               { 
                  "content": "string",
                  "contentType": "string",
                  "groupNumber": number
               }
            ],
            "responseCard": "string"
         }
      }
   ],
   "version": "string"
}
```

## Response Elements
<a name="API_PutIntent_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [checksum](#API_PutIntent_ResponseSyntax) **   <a name="lex-PutIntent-response-checksum"></a>
Checksum of the `$LATEST`version of the intent created or updated.  
Type: String

 ** [conclusionStatement](#API_PutIntent_ResponseSyntax) **   <a name="lex-PutIntent-response-conclusionStatement"></a>
After the Lambda function specified in the`fulfillmentActivity`intent fulfills the intent, Amazon Lex conveys this statement to the user.  
Type: [Statement](API_Statement.md) object

 ** [confirmationPrompt](#API_PutIntent_ResponseSyntax) **   <a name="lex-PutIntent-response-confirmationPrompt"></a>
If defined in the intent, Amazon Lex prompts the user to confirm the intent before fulfilling it.  
Type: [Prompt](API_Prompt.md) object

 ** [createdDate](#API_PutIntent_ResponseSyntax) **   <a name="lex-PutIntent-response-createdDate"></a>
The date that the intent was created.  
Type: Timestamp

 ** [createVersion](#API_PutIntent_ResponseSyntax) **   <a name="lex-PutIntent-response-createVersion"></a>
 `True` if a new version of the intent was created. If the `createVersion` field was not specified in the request, the `createVersion` field is set to false in the response.  
Type: Boolean

 ** [description](#API_PutIntent_ResponseSyntax) **   <a name="lex-PutIntent-response-description"></a>
A description of the intent.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 200.

 ** [dialogCodeHook](#API_PutIntent_ResponseSyntax) **   <a name="lex-PutIntent-response-dialogCodeHook"></a>
If defined in the intent, Amazon Lex invokes this Lambda function for each user input.  
Type: [CodeHook](API_CodeHook.md) object

 ** [followUpPrompt](#API_PutIntent_ResponseSyntax) **   <a name="lex-PutIntent-response-followUpPrompt"></a>
If defined in the intent, Amazon Lex uses this prompt to solicit additional user activity after the intent is fulfilled.  
Type: [FollowUpPrompt](API_FollowUpPrompt.md) object

 ** [fulfillmentActivity](#API_PutIntent_ResponseSyntax) **   <a name="lex-PutIntent-response-fulfillmentActivity"></a>
If defined in the intent, Amazon Lex invokes this Lambda function to fulfill the intent after the user provides all of the information required by the intent.  
Type: [FulfillmentActivity](API_FulfillmentActivity.md) object

 ** [inputContexts](#API_PutIntent_ResponseSyntax) **   <a name="lex-PutIntent-response-inputContexts"></a>
An array of `InputContext` objects that lists the contexts that must be active for Amazon Lex to choose the intent in a conversation with the user.  
Type: Array of [InputContext](API_InputContext.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 5 items.

 ** [kendraConfiguration](#API_PutIntent_ResponseSyntax) **   <a name="lex-PutIntent-response-kendraConfiguration"></a>
Configuration information, if any, required to connect to an Amazon Kendra index and use the `AMAZON.KendraSearchIntent` intent.  
Type: [KendraConfiguration](API_KendraConfiguration.md) object

 ** [lastUpdatedDate](#API_PutIntent_ResponseSyntax) **   <a name="lex-PutIntent-response-lastUpdatedDate"></a>
The date that the intent was updated. When you create a resource, the creation date and last update dates are the same.  
Type: Timestamp

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

 ** [outputContexts](#API_PutIntent_ResponseSyntax) **   <a name="lex-PutIntent-response-outputContexts"></a>
An array of `OutputContext` objects that lists the contexts that the intent activates when the intent is fulfilled.  
Type: Array of [OutputContext](API_OutputContext.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 10 items.

 ** [parentIntentSignature](#API_PutIntent_ResponseSyntax) **   <a name="lex-PutIntent-response-parentIntentSignature"></a>
A unique identifier for the built-in intent that this intent is based on.  
Type: String

 ** [rejectionStatement](#API_PutIntent_ResponseSyntax) **   <a name="lex-PutIntent-response-rejectionStatement"></a>
If the user answers "no" to the question defined in `confirmationPrompt` Amazon Lex responds with this statement to acknowledge that the intent was canceled.   
Type: [Statement](API_Statement.md) object

 ** [sampleUtterances](#API_PutIntent_ResponseSyntax) **   <a name="lex-PutIntent-response-sampleUtterances"></a>
 An array of sample utterances that are configured for the intent.   
Type: Array of strings  
Array Members: Minimum number of 0 items. Maximum number of 1500 items.  
Length Constraints: Minimum length of 1. Maximum length of 200.

 ** [slots](#API_PutIntent_ResponseSyntax) **   <a name="lex-PutIntent-response-slots"></a>
An array of intent slots that are configured for the intent.  
Type: Array of [Slot](API_Slot.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 100 items.

 ** [version](#API_PutIntent_ResponseSyntax) **   <a name="lex-PutIntent-response-version"></a>
The version of the intent. For a new intent, the version is always `$LATEST`.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `\$LATEST|[0-9]+` 

## Errors
<a name="API_PutIntent_Errors"></a>

 ** BadRequestException **   
The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and try again.  
HTTP Status Code: 400

 ** ConflictException **   
 There was a conflict processing the request. Try your request again.   
HTTP Status Code: 409

 ** InternalFailureException **   
An internal Amazon Lex error occurred. Try your request again.  
HTTP Status Code: 500

 ** LimitExceededException **   
The request exceeded a limit. Try your request again.  
HTTP Status Code: 429

 ** PreconditionFailedException **   
 The checksum of the resource that you are trying to change does not match the checksum in the request. Check the resource's checksum and try again.  
HTTP Status Code: 412

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

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/lex-models-2017-04-19/PutIntent) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lex-models-2017-04-19/PutIntent) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lex-models-2017-04-19/PutIntent) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lex-models-2017-04-19/PutIntent) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lex-models-2017-04-19/PutIntent) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lex-models-2017-04-19/PutIntent) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lex-models-2017-04-19/PutIntent) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lex-models-2017-04-19/PutIntent) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lex-models-2017-04-19/PutIntent) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lex-models-2017-04-19/PutIntent) 

# PutSlotType
<a name="API_PutSlotType"></a>

Creates a custom slot type or replaces an existing custom slot type.

To create a custom slot type, specify a name for the slot type and a set of enumeration values, which are the values that a slot of this type can assume. For more information, see [Amazon Lex: How It Works](how-it-works.md).

If you specify the name of an existing slot type, the fields in the request replace the existing values in the `$LATEST` version of the slot type. Amazon Lex removes the fields that you don't provide in the request. If you don't specify required fields, Amazon Lex throws an exception. When you update the `$LATEST` version of a slot type, if a bot uses the `$LATEST` version of an intent that contains the slot type, the bot's `status` field is set to `NOT_BUILT`.

This operation requires permissions for the `lex:PutSlotType` action.

## Request Syntax
<a name="API_PutSlotType_RequestSyntax"></a>

```
PUT /slottypes/name/versions/$LATEST HTTP/1.1
Content-type: application/json

{
   "checksum": "string",
   "createVersion": boolean,
   "description": "string",
   "enumerationValues": [ 
      { 
         "synonyms": [ "string" ],
         "value": "string"
      }
   ],
   "parentSlotTypeSignature": "string",
   "slotTypeConfigurations": [ 
      { 
         "regexConfiguration": { 
            "pattern": "string"
         }
      }
   ],
   "valueSelectionStrategy": "string"
}
```

## URI Request Parameters
<a name="API_PutSlotType_RequestParameters"></a>

The request uses the following URI parameters.

 ** [name](#API_PutSlotType_RequestSyntax) **   <a name="lex-PutSlotType-request-uri-name"></a>
The name of the slot type. The name is *not* case sensitive.   
The name can't match a built-in slot type name, or a built-in slot type name with "AMAZON." removed. For example, because there is a built-in slot type called `AMAZON.DATE`, you can't create a custom slot type called `DATE`.  
For a list of built-in slot types, 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*.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `^([A-Za-z]_?)+$`   
Required: Yes

## Request Body
<a name="API_PutSlotType_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [checksum](#API_PutSlotType_RequestSyntax) **   <a name="lex-PutSlotType-request-checksum"></a>
Identifies a specific revision of the `$LATEST` version.  
When you create a new slot type, leave the `checksum` field blank. If you specify a checksum you get a `BadRequestException` exception.  
When you want to update a slot type, set the `checksum` field to the checksum of the most recent revision of the `$LATEST` version. If you don't specify the ` checksum` field, or if the checksum does not match the `$LATEST` version, you get a `PreconditionFailedException` exception.  
Type: String  
Required: No

 ** [createVersion](#API_PutSlotType_RequestSyntax) **   <a name="lex-PutSlotType-request-createVersion"></a>
When set to `true` a new numbered version of the slot type is created. This is the same as calling the `CreateSlotTypeVersion` operation. If you do not specify `createVersion`, the default is `false`.  
Type: Boolean  
Required: No

 ** [description](#API_PutSlotType_RequestSyntax) **   <a name="lex-PutSlotType-request-description"></a>
A description of the slot type.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 200.  
Required: No

 ** [enumerationValues](#API_PutSlotType_RequestSyntax) **   <a name="lex-PutSlotType-request-enumerationValues"></a>
A list of `EnumerationValue` objects that defines the values that the slot type can take. Each value can have a list of `synonyms`, which are additional values that help train the machine learning model about the values that it resolves for a slot.   
A regular expression slot type doesn't require enumeration values. All other slot types require a list of enumeration values.  
When Amazon Lex resolves a slot value, it generates a resolution list that contains up to five possible values for the slot. If you are using a Lambda function, this resolution list is passed to the function. If you are not using a Lambda function you can choose to return the value that the user entered or the first value in the resolution list as the slot value. The `valueSelectionStrategy` field indicates the option to use.   
Type: Array of [EnumerationValue](API_EnumerationValue.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 10000 items.  
Required: No

 ** [parentSlotTypeSignature](#API_PutSlotType_RequestSyntax) **   <a name="lex-PutSlotType-request-parentSlotTypeSignature"></a>
The built-in slot type used as the parent of the slot type. When you define a parent slot type, the new slot type has all of the same configuration as the parent.  
Only `AMAZON.AlphaNumeric` is supported.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `^((AMAZON\.)_?|[A-Za-z]_?)+`   
Required: No

 ** [slotTypeConfigurations](#API_PutSlotType_RequestSyntax) **   <a name="lex-PutSlotType-request-slotTypeConfigurations"></a>
Configuration information that extends the parent built-in slot type. The configuration is added to the settings for the parent slot type.  
Type: Array of [SlotTypeConfiguration](API_SlotTypeConfiguration.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 10 items.  
Required: No

 ** [valueSelectionStrategy](#API_PutSlotType_RequestSyntax) **   <a name="lex-PutSlotType-request-valueSelectionStrategy"></a>
Determines the slot resolution strategy that Amazon Lex uses to return slot type values. The field can be set to one of the following values:  
+  `ORIGINAL_VALUE` - Returns the value entered by the user, if the user value is similar to the slot value.
+  `TOP_RESOLUTION` - If there is a resolution list for the slot, return the first value in the resolution list as the slot type value. If there is no resolution list, null is returned.
If you don't specify the `valueSelectionStrategy`, the default is `ORIGINAL_VALUE`.  
Type: String  
Valid Values: `ORIGINAL_VALUE | TOP_RESOLUTION`   
Required: No

## Response Syntax
<a name="API_PutSlotType_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "checksum": "string",
   "createdDate": number,
   "createVersion": boolean,
   "description": "string",
   "enumerationValues": [ 
      { 
         "synonyms": [ "string" ],
         "value": "string"
      }
   ],
   "lastUpdatedDate": number,
   "name": "string",
   "parentSlotTypeSignature": "string",
   "slotTypeConfigurations": [ 
      { 
         "regexConfiguration": { 
            "pattern": "string"
         }
      }
   ],
   "valueSelectionStrategy": "string",
   "version": "string"
}
```

## Response Elements
<a name="API_PutSlotType_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [checksum](#API_PutSlotType_ResponseSyntax) **   <a name="lex-PutSlotType-response-checksum"></a>
Checksum of the `$LATEST` version of the slot type.  
Type: String

 ** [createdDate](#API_PutSlotType_ResponseSyntax) **   <a name="lex-PutSlotType-response-createdDate"></a>
The date that the slot type was created.  
Type: Timestamp

 ** [createVersion](#API_PutSlotType_ResponseSyntax) **   <a name="lex-PutSlotType-response-createVersion"></a>
 `True` if a new version of the slot type was created. If the `createVersion` field was not specified in the request, the `createVersion` field is set to false in the response.  
Type: Boolean

 ** [description](#API_PutSlotType_ResponseSyntax) **   <a name="lex-PutSlotType-response-description"></a>
A description of the slot type.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 200.

 ** [enumerationValues](#API_PutSlotType_ResponseSyntax) **   <a name="lex-PutSlotType-response-enumerationValues"></a>
A list of `EnumerationValue` objects that defines the values that the slot type can take.  
Type: Array of [EnumerationValue](API_EnumerationValue.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 10000 items.

 ** [lastUpdatedDate](#API_PutSlotType_ResponseSyntax) **   <a name="lex-PutSlotType-response-lastUpdatedDate"></a>
The date that the slot type was updated. When you create a slot type, the creation date and last update date are the same.  
Type: Timestamp

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

 ** [parentSlotTypeSignature](#API_PutSlotType_ResponseSyntax) **   <a name="lex-PutSlotType-response-parentSlotTypeSignature"></a>
The built-in slot type used as the parent of the slot type.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `^((AMAZON\.)_?|[A-Za-z]_?)+` 

 ** [slotTypeConfigurations](#API_PutSlotType_ResponseSyntax) **   <a name="lex-PutSlotType-response-slotTypeConfigurations"></a>
Configuration information that extends the parent built-in slot type.  
Type: Array of [SlotTypeConfiguration](API_SlotTypeConfiguration.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 10 items.

 ** [valueSelectionStrategy](#API_PutSlotType_ResponseSyntax) **   <a name="lex-PutSlotType-response-valueSelectionStrategy"></a>
The slot resolution strategy that Amazon Lex uses to determine the value of the slot. For more information, see [PutSlotType](#API_PutSlotType).  
Type: String  
Valid Values: `ORIGINAL_VALUE | TOP_RESOLUTION` 

 ** [version](#API_PutSlotType_ResponseSyntax) **   <a name="lex-PutSlotType-response-version"></a>
The version of the slot type. For a new slot type, the version is always `$LATEST`.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `\$LATEST|[0-9]+` 

## Errors
<a name="API_PutSlotType_Errors"></a>

 ** BadRequestException **   
The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and try again.  
HTTP Status Code: 400

 ** ConflictException **   
 There was a conflict processing the request. Try your request again.   
HTTP Status Code: 409

 ** InternalFailureException **   
An internal Amazon Lex error occurred. Try your request again.  
HTTP Status Code: 500

 ** LimitExceededException **   
The request exceeded a limit. Try your request again.  
HTTP Status Code: 429

 ** PreconditionFailedException **   
 The checksum of the resource that you are trying to change does not match the checksum in the request. Check the resource's checksum and try again.  
HTTP Status Code: 412

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

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/lex-models-2017-04-19/PutSlotType) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lex-models-2017-04-19/PutSlotType) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lex-models-2017-04-19/PutSlotType) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lex-models-2017-04-19/PutSlotType) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lex-models-2017-04-19/PutSlotType) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lex-models-2017-04-19/PutSlotType) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lex-models-2017-04-19/PutSlotType) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lex-models-2017-04-19/PutSlotType) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lex-models-2017-04-19/PutSlotType) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lex-models-2017-04-19/PutSlotType) 

# StartImport
<a name="API_StartImport"></a>

Starts a job to import a resource to Amazon Lex.

## Request Syntax
<a name="API_StartImport_RequestSyntax"></a>

```
POST /imports/ HTTP/1.1
Content-type: application/json

{
   "mergeStrategy": "string",
   "payload": blob,
   "resourceType": "string",
   "tags": [ 
      { 
         "key": "string",
         "value": "string"
      }
   ]
}
```

## URI Request Parameters
<a name="API_StartImport_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_StartImport_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [mergeStrategy](#API_StartImport_RequestSyntax) **   <a name="lex-StartImport-request-mergeStrategy"></a>
Specifies the action that the `StartImport` operation should take when there is an existing resource with the same name.  
+ FAIL\$1ON\$1CONFLICT - The import operation is stopped on the first conflict between a resource in the import file and an existing resource. The name of the resource causing the conflict is in the `failureReason` field of the response to the `GetImport` operation.

  OVERWRITE\$1LATEST - The import operation proceeds even if there is a conflict with an existing resource. The \$1LASTEST version of the existing resource is overwritten with the data from the import file.
Type: String  
Valid Values: `OVERWRITE_LATEST | FAIL_ON_CONFLICT`   
Required: Yes

 ** [payload](#API_StartImport_RequestSyntax) **   <a name="lex-StartImport-request-payload"></a>
A zip archive in binary format. The archive should contain one file, a JSON file containing the resource to import. The resource should match the type specified in the `resourceType` field.  
Type: Base64-encoded binary data object  
Required: Yes

 ** [resourceType](#API_StartImport_RequestSyntax) **   <a name="lex-StartImport-request-resourceType"></a>
Specifies the type of resource to export. Each resource also exports any resources that it depends on.   
+ A bot exports dependent intents.
+ An intent exports dependent slot types.
Type: String  
Valid Values: `BOT | INTENT | SLOT_TYPE`   
Required: Yes

 ** [tags](#API_StartImport_RequestSyntax) **   <a name="lex-StartImport-request-tags"></a>
A list of tags to add to the imported bot. You can only add tags when you import a bot, you can't add tags to an intent or slot type.  
Type: Array of [Tag](API_Tag.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 200 items.  
Required: No

## Response Syntax
<a name="API_StartImport_ResponseSyntax"></a>

```
HTTP/1.1 201
Content-type: application/json

{
   "createdDate": number,
   "importId": "string",
   "importStatus": "string",
   "mergeStrategy": "string",
   "name": "string",
   "resourceType": "string",
   "tags": [ 
      { 
         "key": "string",
         "value": "string"
      }
   ]
}
```

## Response Elements
<a name="API_StartImport_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 201 response.

The following data is returned in JSON format by the service.

 ** [createdDate](#API_StartImport_ResponseSyntax) **   <a name="lex-StartImport-response-createdDate"></a>
A timestamp for the date and time that the import job was requested.  
Type: Timestamp

 ** [importId](#API_StartImport_ResponseSyntax) **   <a name="lex-StartImport-response-importId"></a>
The identifier for the specific import job.  
Type: String

 ** [importStatus](#API_StartImport_ResponseSyntax) **   <a name="lex-StartImport-response-importStatus"></a>
The status of the import job. If the status is `FAILED`, you can get the reason for the failure using the `GetImport` operation.  
Type: String  
Valid Values: `IN_PROGRESS | COMPLETE | FAILED` 

 ** [mergeStrategy](#API_StartImport_ResponseSyntax) **   <a name="lex-StartImport-response-mergeStrategy"></a>
The action to take when there is a merge conflict.  
Type: String  
Valid Values: `OVERWRITE_LATEST | FAIL_ON_CONFLICT` 

 ** [name](#API_StartImport_ResponseSyntax) **   <a name="lex-StartImport-response-name"></a>
The name given to the import job.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `[a-zA-Z_]+` 

 ** [resourceType](#API_StartImport_ResponseSyntax) **   <a name="lex-StartImport-response-resourceType"></a>
The type of resource to import.  
Type: String  
Valid Values: `BOT | INTENT | SLOT_TYPE` 

 ** [tags](#API_StartImport_ResponseSyntax) **   <a name="lex-StartImport-response-tags"></a>
A list of tags added to the imported bot.  
Type: Array of [Tag](API_Tag.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 200 items.

## Errors
<a name="API_StartImport_Errors"></a>

 ** BadRequestException **   
The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and try again.  
HTTP Status Code: 400

 ** InternalFailureException **   
An internal Amazon Lex error occurred. Try your request again.  
HTTP Status Code: 500

 ** LimitExceededException **   
The request exceeded a limit. Try your request again.  
HTTP Status Code: 429

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

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/lex-models-2017-04-19/StartImport) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lex-models-2017-04-19/StartImport) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lex-models-2017-04-19/StartImport) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lex-models-2017-04-19/StartImport) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lex-models-2017-04-19/StartImport) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lex-models-2017-04-19/StartImport) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lex-models-2017-04-19/StartImport) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lex-models-2017-04-19/StartImport) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lex-models-2017-04-19/StartImport) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lex-models-2017-04-19/StartImport) 

# StartMigration
<a name="API_StartMigration"></a>

Starts migrating a bot from Amazon Lex V1 to Amazon Lex V2. Migrate your bot when you want to take advantage of the new features of Amazon Lex V2.

For more information, see [Migrating a bot](https://docs.aws.amazon.com/lex/latest/dg/migrate.html) in the *Amazon Lex developer guide*.

## Request Syntax
<a name="API_StartMigration_RequestSyntax"></a>

```
POST /migrations HTTP/1.1
Content-type: application/json

{
   "migrationStrategy": "string",
   "v1BotName": "string",
   "v1BotVersion": "string",
   "v2BotName": "string",
   "v2BotRole": "string"
}
```

## URI Request Parameters
<a name="API_StartMigration_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_StartMigration_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [migrationStrategy](#API_StartMigration_RequestSyntax) **   <a name="lex-StartMigration-request-migrationStrategy"></a>
The strategy used to conduct the migration.  
+  `CREATE_NEW` - Creates a new Amazon Lex V2 bot and migrates the Amazon Lex V1 bot to the new bot.
+  `UPDATE_EXISTING` - Overwrites the existing Amazon Lex V2 bot metadata and the locale being migrated. It doesn't change any other locales in the Amazon Lex V2 bot. If the locale doesn't exist, a new locale is created in the Amazon Lex V2 bot.
Type: String  
Valid Values: `CREATE_NEW | UPDATE_EXISTING`   
Required: Yes

 ** [v1BotName](#API_StartMigration_RequestSyntax) **   <a name="lex-StartMigration-request-v1BotName"></a>
The name of the Amazon Lex V1 bot that you are migrating to Amazon Lex V2.  
Type: String  
Length Constraints: Minimum length of 2. Maximum length of 50.  
Pattern: `^([A-Za-z]_?)+$`   
Required: Yes

 ** [v1BotVersion](#API_StartMigration_RequestSyntax) **   <a name="lex-StartMigration-request-v1BotVersion"></a>
The version of the bot to migrate to Amazon Lex V2. You can migrate the `$LATEST` version as well as any numbered version.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `\$LATEST|[0-9]+`   
Required: Yes

 ** [v2BotName](#API_StartMigration_RequestSyntax) **   <a name="lex-StartMigration-request-v2BotName"></a>
The name of the Amazon Lex V2 bot that you are migrating the Amazon Lex V1 bot to.   
+ If the Amazon Lex V2 bot doesn't exist, you must use the `CREATE_NEW` migration strategy.
+ If the Amazon Lex V2 bot exists, you must use the `UPDATE_EXISTING` migration strategy to change the contents of the Amazon Lex V2 bot.
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `^([0-9a-zA-Z][_-]?)+$`   
Required: Yes

 ** [v2BotRole](#API_StartMigration_RequestSyntax) **   <a name="lex-StartMigration-request-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: Yes

## Response Syntax
<a name="API_StartMigration_ResponseSyntax"></a>

```
HTTP/1.1 202
Content-type: application/json

{
   "migrationId": "string",
   "migrationStrategy": "string",
   "migrationTimestamp": number,
   "v1BotLocale": "string",
   "v1BotName": "string",
   "v1BotVersion": "string",
   "v2BotId": "string",
   "v2BotRole": "string"
}
```

## Response Elements
<a name="API_StartMigration_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 202 response.

The following data is returned in JSON format by the service.

 ** [migrationId](#API_StartMigration_ResponseSyntax) **   <a name="lex-StartMigration-response-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]+$` 

 ** [migrationStrategy](#API_StartMigration_ResponseSyntax) **   <a name="lex-StartMigration-response-migrationStrategy"></a>
The strategy used to conduct the migration.  
Type: String  
Valid Values: `CREATE_NEW | UPDATE_EXISTING` 

 ** [migrationTimestamp](#API_StartMigration_ResponseSyntax) **   <a name="lex-StartMigration-response-migrationTimestamp"></a>
The date and time that the migration started.  
Type: Timestamp

 ** [v1BotLocale](#API_StartMigration_ResponseSyntax) **   <a name="lex-StartMigration-response-v1BotLocale"></a>
The locale used for the Amazon Lex V1 bot.   
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` 

 ** [v1BotName](#API_StartMigration_ResponseSyntax) **   <a name="lex-StartMigration-response-v1BotName"></a>
The name of the Amazon Lex V1 bot that you are migrating to Amazon Lex V2.  
Type: String  
Length Constraints: Minimum length of 2. Maximum length of 50.  
Pattern: `^([A-Za-z]_?)+$` 

 ** [v1BotVersion](#API_StartMigration_ResponseSyntax) **   <a name="lex-StartMigration-response-v1BotVersion"></a>
The version of the bot to migrate to Amazon Lex V2.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `\$LATEST|[0-9]+` 

 ** [v2BotId](#API_StartMigration_ResponseSyntax) **   <a name="lex-StartMigration-response-v2BotId"></a>
The unique identifier for the Amazon Lex V2 bot.   
Type: String  
Length Constraints: Fixed length of 10.  
Pattern: `^[0-9a-zA-Z]+$` 

 ** [v2BotRole](#API_StartMigration_ResponseSyntax) **   <a name="lex-StartMigration-response-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/.+$` 

## Errors
<a name="API_StartMigration_Errors"></a>

 ** AccessDeniedException **   
Your IAM user or role does not have permission to call the Amazon Lex V2 APIs required to migrate your bot.  
HTTP Status Code: 403

 ** BadRequestException **   
The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and try again.  
HTTP Status Code: 400

 ** InternalFailureException **   
An internal Amazon Lex error occurred. Try your request again.  
HTTP Status Code: 500

 ** LimitExceededException **   
The request exceeded a limit. Try your request again.  
HTTP Status Code: 429

 ** NotFoundException **   
The resource specified in the request was not found. Check the resource and try again.  
HTTP Status Code: 404

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

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/lex-models-2017-04-19/StartMigration) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lex-models-2017-04-19/StartMigration) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lex-models-2017-04-19/StartMigration) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lex-models-2017-04-19/StartMigration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lex-models-2017-04-19/StartMigration) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lex-models-2017-04-19/StartMigration) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lex-models-2017-04-19/StartMigration) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lex-models-2017-04-19/StartMigration) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lex-models-2017-04-19/StartMigration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lex-models-2017-04-19/StartMigration) 

# TagResource
<a name="API_TagResource"></a>

Adds the specified tags to the specified resource. If a tag key already exists, the existing value is replaced with the new value.

## Request Syntax
<a name="API_TagResource_RequestSyntax"></a>

```
POST /tags/resourceArn HTTP/1.1
Content-type: application/json

{
   "tags": [ 
      { 
         "key": "string",
         "value": "string"
      }
   ]
}
```

## URI Request Parameters
<a name="API_TagResource_RequestParameters"></a>

The request uses the following URI parameters.

 ** [resourceArn](#API_TagResource_RequestSyntax) **   <a name="lex-TagResource-request-uri-resourceArn"></a>
The Amazon Resource Name (ARN) of the bot, bot alias, or bot channel to tag.  
Length Constraints: Minimum length of 1. Maximum length of 1011.  
Required: Yes

## Request Body
<a name="API_TagResource_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [tags](#API_TagResource_RequestSyntax) **   <a name="lex-TagResource-request-tags"></a>
A list of tag keys to add to the resource. If a tag key already exists, the existing value is replaced with the new value.  
Type: Array of [Tag](API_Tag.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 200 items.  
Required: Yes

## Response Syntax
<a name="API_TagResource_ResponseSyntax"></a>

```
HTTP/1.1 204
```

## Response Elements
<a name="API_TagResource_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.

## Errors
<a name="API_TagResource_Errors"></a>

 ** BadRequestException **   
The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and try again.  
HTTP Status Code: 400

 ** ConflictException **   
 There was a conflict processing the request. Try your request again.   
HTTP Status Code: 409

 ** InternalFailureException **   
An internal Amazon Lex error occurred. Try your request again.  
HTTP Status Code: 500

 ** LimitExceededException **   
The request exceeded a limit. Try your request again.  
HTTP Status Code: 429

 ** NotFoundException **   
The resource specified in the request was not found. Check the resource and try again.  
HTTP Status Code: 404

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

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/lex-models-2017-04-19/TagResource) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lex-models-2017-04-19/TagResource) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lex-models-2017-04-19/TagResource) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lex-models-2017-04-19/TagResource) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lex-models-2017-04-19/TagResource) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lex-models-2017-04-19/TagResource) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lex-models-2017-04-19/TagResource) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lex-models-2017-04-19/TagResource) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lex-models-2017-04-19/TagResource) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lex-models-2017-04-19/TagResource) 

# UntagResource
<a name="API_UntagResource"></a>

Removes tags from a bot, bot alias or bot channel.

## Request Syntax
<a name="API_UntagResource_RequestSyntax"></a>

```
DELETE /tags/resourceArn?tagKeys=tagKeys HTTP/1.1
```

## URI Request Parameters
<a name="API_UntagResource_RequestParameters"></a>

The request uses the following URI parameters.

 ** [resourceArn](#API_UntagResource_RequestSyntax) **   <a name="lex-UntagResource-request-uri-resourceArn"></a>
The Amazon Resource Name (ARN) of the resource to remove the tags from.  
Length Constraints: Minimum length of 1. Maximum length of 1011.  
Required: Yes

 ** [tagKeys](#API_UntagResource_RequestSyntax) **   <a name="lex-UntagResource-request-uri-tagKeys"></a>
A list of tag keys to remove from the resource. If a tag key does not exist on the resource, it is ignored.  
Array Members: Minimum number of 0 items. Maximum number of 200 items.  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Required: Yes

## Request Body
<a name="API_UntagResource_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_UntagResource_ResponseSyntax"></a>

```
HTTP/1.1 204
```

## Response Elements
<a name="API_UntagResource_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.

## Errors
<a name="API_UntagResource_Errors"></a>

 ** BadRequestException **   
The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and try again.  
HTTP Status Code: 400

 ** ConflictException **   
 There was a conflict processing the request. Try your request again.   
HTTP Status Code: 409

 ** InternalFailureException **   
An internal Amazon Lex error occurred. Try your request again.  
HTTP Status Code: 500

 ** LimitExceededException **   
The request exceeded a limit. Try your request again.  
HTTP Status Code: 429

 ** NotFoundException **   
The resource specified in the request was not found. Check the resource and try again.  
HTTP Status Code: 404

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

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/lex-models-2017-04-19/UntagResource) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lex-models-2017-04-19/UntagResource) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lex-models-2017-04-19/UntagResource) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lex-models-2017-04-19/UntagResource) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lex-models-2017-04-19/UntagResource) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lex-models-2017-04-19/UntagResource) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lex-models-2017-04-19/UntagResource) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lex-models-2017-04-19/UntagResource) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lex-models-2017-04-19/UntagResource) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lex-models-2017-04-19/UntagResource) 

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

The following actions are supported by Amazon Lex Runtime Service:
+  [DeleteSession](API_runtime_DeleteSession.md) 
+  [GetSession](API_runtime_GetSession.md) 
+  [PostContent](API_runtime_PostContent.md) 
+  [PostText](API_runtime_PostText.md) 
+  [PutSession](API_runtime_PutSession.md) 

# DeleteSession
<a name="API_runtime_DeleteSession"></a>

Removes session information for a specified bot, alias, and user ID. 

## Request Syntax
<a name="API_runtime_DeleteSession_RequestSyntax"></a>

```
DELETE /bot/botName/alias/botAlias/user/userId/session HTTP/1.1
```

## URI Request Parameters
<a name="API_runtime_DeleteSession_RequestParameters"></a>

The request uses the following URI parameters.

 ** [botAlias](#API_runtime_DeleteSession_RequestSyntax) **   <a name="lex-runtime_DeleteSession-request-uri-botAlias"></a>
The alias in use for the bot that contains the session data.  
Required: Yes

 ** [botName](#API_runtime_DeleteSession_RequestSyntax) **   <a name="lex-runtime_DeleteSession-request-uri-botName"></a>
The name of the bot that contains the session data.  
Required: Yes

 ** [userId](#API_runtime_DeleteSession_RequestSyntax) **   <a name="lex-runtime_DeleteSession-request-uri-userId"></a>
The identifier of the user associated with the session data.  
Length Constraints: Minimum length of 2. Maximum length of 100.  
Pattern: `[0-9a-zA-Z._:-]+`   
Required: Yes

## Request Body
<a name="API_runtime_DeleteSession_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_runtime_DeleteSession_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "botAlias": "string",
   "botName": "string",
   "sessionId": "string",
   "userId": "string"
}
```

## Response Elements
<a name="API_runtime_DeleteSession_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [botAlias](#API_runtime_DeleteSession_ResponseSyntax) **   <a name="lex-runtime_DeleteSession-response-botAlias"></a>
The alias in use for the bot associated with the session data.  
Type: String

 ** [botName](#API_runtime_DeleteSession_ResponseSyntax) **   <a name="lex-runtime_DeleteSession-response-botName"></a>
The name of the bot associated with the session data.  
Type: String

 ** [sessionId](#API_runtime_DeleteSession_ResponseSyntax) **   <a name="lex-runtime_DeleteSession-response-sessionId"></a>
The unique identifier for the session.  
Type: String

 ** [userId](#API_runtime_DeleteSession_ResponseSyntax) **   <a name="lex-runtime_DeleteSession-response-userId"></a>
The ID of the client application user.  
Type: String  
Length Constraints: Minimum length of 2. Maximum length of 100.  
Pattern: `[0-9a-zA-Z._:-]+` 

## Errors
<a name="API_runtime_DeleteSession_Errors"></a>

 ** BadRequestException **   
 Request validation failed, there is no usable message in the context, or the bot build failed, is still in progress, or contains unbuilt changes.   
HTTP Status Code: 400

 ** ConflictException **   
 Two clients are using the same AWS account, Amazon Lex bot, and user ID.   
HTTP Status Code: 409

 ** InternalFailureException **   
Internal service error. Retry the call.  
HTTP Status Code: 500

 ** LimitExceededException **   
Exceeded a limit.  
HTTP Status Code: 429

 ** NotFoundException **   
The resource (such as the Amazon Lex bot or an alias) that is referred to is not found.  
HTTP Status Code: 404

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

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/runtime.lex-2016-11-28/DeleteSession) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/runtime.lex-2016-11-28/DeleteSession) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/runtime.lex-2016-11-28/DeleteSession) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/runtime.lex-2016-11-28/DeleteSession) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/runtime.lex-2016-11-28/DeleteSession) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/runtime.lex-2016-11-28/DeleteSession) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/runtime.lex-2016-11-28/DeleteSession) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/runtime.lex-2016-11-28/DeleteSession) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/runtime.lex-2016-11-28/DeleteSession) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/runtime.lex-2016-11-28/DeleteSession) 

# GetSession
<a name="API_runtime_GetSession"></a>

Returns session information for a specified bot, alias, and user ID.

## Request Syntax
<a name="API_runtime_GetSession_RequestSyntax"></a>

```
GET /bot/botName/alias/botAlias/user/userId/session/?checkpointLabelFilter=checkpointLabelFilter HTTP/1.1
```

## URI Request Parameters
<a name="API_runtime_GetSession_RequestParameters"></a>

The request uses the following URI parameters.

 ** [botAlias](#API_runtime_GetSession_RequestSyntax) **   <a name="lex-runtime_GetSession-request-uri-botAlias"></a>
The alias in use for the bot that contains the session data.  
Required: Yes

 ** [botName](#API_runtime_GetSession_RequestSyntax) **   <a name="lex-runtime_GetSession-request-uri-botName"></a>
The name of the bot that contains the session data.  
Required: Yes

 ** [checkpointLabelFilter](#API_runtime_GetSession_RequestSyntax) **   <a name="lex-runtime_GetSession-request-uri-checkpointLabelFilter"></a>
A string used to filter the intents returned in the `recentIntentSummaryView` structure.   
When you specify a filter, only intents with their `checkpointLabel` field set to that string are returned.  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `[a-zA-Z0-9-]+` 

 ** [userId](#API_runtime_GetSession_RequestSyntax) **   <a name="lex-runtime_GetSession-request-uri-userId"></a>
The ID of the client application user. Amazon Lex uses this to identify a user's conversation with your bot.   
Length Constraints: Minimum length of 2. Maximum length of 100.  
Pattern: `[0-9a-zA-Z._:-]+`   
Required: Yes

## Request Body
<a name="API_runtime_GetSession_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_runtime_GetSession_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "activeContexts": [ 
      { 
         "name": "string",
         "parameters": { 
            "string" : "string" 
         },
         "timeToLive": { 
            "timeToLiveInSeconds": number,
            "turnsToLive": number
         }
      }
   ],
   "dialogAction": { 
      "fulfillmentState": "string",
      "intentName": "string",
      "message": "string",
      "messageFormat": "string",
      "slots": { 
         "string" : "string" 
      },
      "slotToElicit": "string",
      "type": "string"
   },
   "recentIntentSummaryView": [ 
      { 
         "checkpointLabel": "string",
         "confirmationStatus": "string",
         "dialogActionType": "string",
         "fulfillmentState": "string",
         "intentName": "string",
         "slots": { 
            "string" : "string" 
         },
         "slotToElicit": "string"
      }
   ],
   "sessionAttributes": { 
      "string" : "string" 
   },
   "sessionId": "string"
}
```

## Response Elements
<a name="API_runtime_GetSession_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [activeContexts](#API_runtime_GetSession_ResponseSyntax) **   <a name="lex-runtime_GetSession-response-activeContexts"></a>
A list of active contexts for the session. A context can be set when an intent is fulfilled or by calling the `PostContent`, `PostText`, or `PutSession` operation.  
You can use a context to control the intents that can follow up an intent, or to modify the operation of your application.  
Type: Array of [ActiveContext](API_runtime_ActiveContext.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 20 items.

 ** [dialogAction](#API_runtime_GetSession_ResponseSyntax) **   <a name="lex-runtime_GetSession-response-dialogAction"></a>
Describes the current state of the bot.  
Type: [DialogAction](API_runtime_DialogAction.md) object

 ** [recentIntentSummaryView](#API_runtime_GetSession_ResponseSyntax) **   <a name="lex-runtime_GetSession-response-recentIntentSummaryView"></a>
An array of information about the intents used in the session. The array can contain a maximum of three summaries. If more than three intents are used in the session, the `recentIntentSummaryView` operation contains information about the last three intents used.  
If you set the `checkpointLabelFilter` parameter in the request, the array contains only the intents with the specified label.  
Type: Array of [IntentSummary](API_runtime_IntentSummary.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 3 items.

 ** [sessionAttributes](#API_runtime_GetSession_ResponseSyntax) **   <a name="lex-runtime_GetSession-response-sessionAttributes"></a>
Map of key/value pairs representing the session-specific context information. It contains application information passed between Amazon Lex and a client application.  
Type: String to string map

 ** [sessionId](#API_runtime_GetSession_ResponseSyntax) **   <a name="lex-runtime_GetSession-response-sessionId"></a>
A unique identifier for the session.  
Type: String

## Errors
<a name="API_runtime_GetSession_Errors"></a>

 ** BadRequestException **   
 Request validation failed, there is no usable message in the context, or the bot build failed, is still in progress, or contains unbuilt changes.   
HTTP Status Code: 400

 ** InternalFailureException **   
Internal service error. Retry the call.  
HTTP Status Code: 500

 ** LimitExceededException **   
Exceeded a limit.  
HTTP Status Code: 429

 ** NotFoundException **   
The resource (such as the Amazon Lex bot or an alias) that is referred to is not found.  
HTTP Status Code: 404

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

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/runtime.lex-2016-11-28/GetSession) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/runtime.lex-2016-11-28/GetSession) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/runtime.lex-2016-11-28/GetSession) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/runtime.lex-2016-11-28/GetSession) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/runtime.lex-2016-11-28/GetSession) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/runtime.lex-2016-11-28/GetSession) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/runtime.lex-2016-11-28/GetSession) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/runtime.lex-2016-11-28/GetSession) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/runtime.lex-2016-11-28/GetSession) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/runtime.lex-2016-11-28/GetSession) 

# PostContent
<a name="API_runtime_PostContent"></a>

 Sends user input (text or speech) to Amazon Lex. Clients use this API to send text and audio requests to Amazon Lex at runtime. Amazon Lex interprets the user input using the machine learning model that it built for the bot. 

The `PostContent` operation supports audio input at 8kHz and 16kHz. You can use 8kHz audio to achieve higher speech recognition accuracy in telephone audio applications. 

 In response, Amazon Lex returns the next message to convey to the user. Consider the following example messages: 
+  For a user input "I would like a pizza," Amazon Lex might return a response with a message eliciting slot data (for example, `PizzaSize`): "What size pizza would you like?". 
+  After the user provides all of the pizza order information, Amazon Lex might return a response with a message to get user confirmation: "Order the pizza?". 
+  After the user replies "Yes" to the confirmation prompt, Amazon Lex might return a conclusion statement: "Thank you, your cheese pizza has been ordered.". 

 Not all Amazon Lex messages require a response from the user. For example, conclusion statements do not require a response. Some messages require only a yes or no response. In addition to the `message`, Amazon Lex provides additional context about the message in the response that you can use to enhance client behavior, such as displaying the appropriate client user interface. Consider the following examples: 
+  If the message is to elicit slot data, Amazon Lex returns the following context information: 
  +  `x-amz-lex-dialog-state` header set to `ElicitSlot` 
  +  `x-amz-lex-intent-name` header set to the intent name in the current context 
  +  `x-amz-lex-slot-to-elicit` header set to the slot name for which the `message` is eliciting information 
  +  `x-amz-lex-slots` header set to a map of slots configured for the intent with their current values 
+  If the message is a confirmation prompt, the `x-amz-lex-dialog-state` header is set to `Confirmation` and the `x-amz-lex-slot-to-elicit` header is omitted. 
+  If the message is a clarification prompt configured for the intent, indicating that the user intent is not understood, the `x-amz-dialog-state` header is set to `ElicitIntent` and the `x-amz-slot-to-elicit` header is omitted. 

 In addition, Amazon Lex also returns your application-specific `sessionAttributes`. For more information, see [Managing Conversation Context](https://docs.aws.amazon.com/lex/latest/dg/context-mgmt.html). 

## Request Syntax
<a name="API_runtime_PostContent_RequestSyntax"></a>

```
POST /bot/botName/alias/botAlias/user/userId/content HTTP/1.1
x-amz-lex-session-attributes: sessionAttributes
x-amz-lex-request-attributes: requestAttributes
Content-Type: contentType
Accept: accept
x-amz-lex-active-contexts: activeContexts

inputStream
```

## URI Request Parameters
<a name="API_runtime_PostContent_RequestParameters"></a>

The request uses the following URI parameters.

 ** [accept](#API_runtime_PostContent_RequestSyntax) **   <a name="lex-runtime_PostContent-request-accept"></a>
 You pass this value as the `Accept` HTTP header.   
 The message Amazon Lex returns in the response can be either text or speech based on the `Accept` HTTP header value in the request.   
+  If the value is `text/plain; charset=utf-8`, Amazon Lex returns text in the response. 
+  If the value begins with `audio/`, Amazon Lex returns speech in the response. Amazon Lex uses Amazon Polly to generate the speech (using the configuration you specified in the `Accept` header). For example, if you specify `audio/mpeg` as the value, Amazon Lex returns speech in the MPEG format.
+ If the value is `audio/pcm`, the speech returned is `audio/pcm` in 16-bit, little endian format. 
+ The following are the accepted values:
  + audio/mpeg
  + audio/ogg
  + audio/pcm
  + text/plain; charset=utf-8
  + audio/\$1 (defaults to mpeg)

 ** [activeContexts](#API_runtime_PostContent_RequestSyntax) **   <a name="lex-runtime_PostContent-request-activeContexts"></a>
A list of contexts active for the request. A context can be activated when a previous intent is fulfilled, or by including the context in the request,  
If you don't specify a list of contexts, Amazon Lex will use the current list of contexts for the session. If you specify an empty list, all contexts for the session are cleared.

 ** [botAlias](#API_runtime_PostContent_RequestSyntax) **   <a name="lex-runtime_PostContent-request-uri-botAlias"></a>
Alias of the Amazon Lex bot.  
Required: Yes

 ** [botName](#API_runtime_PostContent_RequestSyntax) **   <a name="lex-runtime_PostContent-request-uri-botName"></a>
Name of the Amazon Lex bot.  
Required: Yes

 ** [contentType](#API_runtime_PostContent_RequestSyntax) **   <a name="lex-runtime_PostContent-request-contentType"></a>
 You pass this value as the `Content-Type` HTTP header.   
 Indicates the audio format or text. The header value must start with one of the following prefixes:   
+ PCM format, audio data must be in little-endian byte order.
  + audio/l16; rate=16000; channels=1
  + audio/x-l16; sample-rate=16000; channel-count=1
  + audio/lpcm; sample-rate=8000; sample-size-bits=16; channel-count=1; is-big-endian=false 
+ Opus format
  + audio/x-cbr-opus-with-preamble; preamble-size=0; bit-rate=256000; frame-size-milliseconds=4
+ Text format
  + text/plain; charset=utf-8
Required: Yes

 ** [requestAttributes](#API_runtime_PostContent_RequestSyntax) **   <a name="lex-runtime_PostContent-request-requestAttributes"></a>
You pass this value as the `x-amz-lex-request-attributes` HTTP header.  
Request-specific information passed between Amazon Lex and a client application. The value must be a JSON serialized and base64 encoded map with string keys and values. The total size of the `requestAttributes` and `sessionAttributes` headers is limited to 12 KB.  
The namespace `x-amz-lex:` is reserved for special attributes. Don't create any request attributes with the prefix `x-amz-lex:`.  
For more information, see [Setting Request Attributes](https://docs.aws.amazon.com/lex/latest/dg/context-mgmt.html#context-mgmt-request-attribs).

 ** [sessionAttributes](#API_runtime_PostContent_RequestSyntax) **   <a name="lex-runtime_PostContent-request-sessionAttributes"></a>
You pass this value as the `x-amz-lex-session-attributes` HTTP header.  
Application-specific information passed between Amazon Lex and a client application. The value must be a JSON serialized and base64 encoded map with string keys and values. The total size of the `sessionAttributes` and `requestAttributes` headers is limited to 12 KB.  
For more information, see [Setting Session Attributes](https://docs.aws.amazon.com/lex/latest/dg/context-mgmt.html#context-mgmt-session-attribs).

 ** [userId](#API_runtime_PostContent_RequestSyntax) **   <a name="lex-runtime_PostContent-request-uri-userId"></a>
The ID of the client application user. Amazon Lex uses this to identify a user's conversation with your bot. At runtime, each request must contain the `userID` field.  
To decide the user ID to use for your application, consider the following factors.  
+ The `userID` field must not contain any personally identifiable information of the user, for example, name, personal identification numbers, or other end user personal information.
+ If you want a user to start a conversation on one device and continue on another device, use a user-specific identifier.
+ If you want the same user to be able to have two independent conversations on two different devices, choose a device-specific identifier.
+ A user can't have two independent conversations with two different versions of the same bot. For example, a user can't have a conversation with the PROD and BETA versions of the same bot. If you anticipate that a user will need to have conversation with two different versions, for example, while testing, include the bot alias in the user ID to separate the two conversations.
Length Constraints: Minimum length of 2. Maximum length of 100.  
Pattern: `[0-9a-zA-Z._:-]+`   
Required: Yes

## Request Body
<a name="API_runtime_PostContent_RequestBody"></a>

The request accepts the following binary data.

 ** [inputStream](#API_runtime_PostContent_RequestSyntax) **   <a name="lex-runtime_PostContent-request-inputStream"></a>
 User input in PCM or Opus audio format or text format as described in the `Content-Type` HTTP header.   
You can stream audio data to Amazon Lex or you can create a local buffer that captures all of the audio data before sending. In general, you get better performance if you stream audio data rather than buffering the data locally.  
Required: Yes

## Response Syntax
<a name="API_runtime_PostContent_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-Type: contentType
x-amz-lex-intent-name: intentName
x-amz-lex-nlu-intent-confidence: nluIntentConfidence
x-amz-lex-alternative-intents: alternativeIntents
x-amz-lex-slots: slots
x-amz-lex-session-attributes: sessionAttributes
x-amz-lex-sentiment: sentimentResponse
x-amz-lex-message: message
x-amz-lex-encoded-message: encodedMessage
x-amz-lex-message-format: messageFormat
x-amz-lex-dialog-state: dialogState
x-amz-lex-slot-to-elicit: slotToElicit
x-amz-lex-input-transcript: inputTranscript
x-amz-lex-encoded-input-transcript: encodedInputTranscript
x-amz-lex-bot-version: botVersion
x-amz-lex-session-id: sessionId
x-amz-lex-active-contexts: activeContexts

audioStream
```

## Response Elements
<a name="API_runtime_PostContent_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The response returns the following HTTP headers.

 ** [activeContexts](#API_runtime_PostContent_ResponseSyntax) **   <a name="lex-runtime_PostContent-response-activeContexts"></a>
A list of active contexts for the session. A context can be set when an intent is fulfilled or by calling the `PostContent`, `PostText`, or `PutSession` operation.  
You can use a context to control the intents that can follow up an intent, or to modify the operation of your application.

 ** [alternativeIntents](#API_runtime_PostContent_ResponseSyntax) **   <a name="lex-runtime_PostContent-response-alternativeIntents"></a>
One to four alternative intents that may be applicable to the user's intent.  
Each alternative includes a score that indicates how confident Amazon Lex is that the intent matches the user's intent. The intents are sorted by the confidence score.

 ** [botVersion](#API_runtime_PostContent_ResponseSyntax) **   <a name="lex-runtime_PostContent-response-botVersion"></a>
The version of the bot that responded to the conversation. You can use this information to help determine if one version of a bot is performing better than another version.  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `[0-9]+|\$LATEST` 

 ** [contentType](#API_runtime_PostContent_ResponseSyntax) **   <a name="lex-runtime_PostContent-response-contentType"></a>
Content type as specified in the `Accept` HTTP header in the request.

 ** [dialogState](#API_runtime_PostContent_ResponseSyntax) **   <a name="lex-runtime_PostContent-response-dialogState"></a>
Identifies the current state of the user interaction. Amazon Lex returns one of the following values as `dialogState`. The client can optionally use this information to customize the user interface.   
+  `ElicitIntent` - Amazon Lex wants to elicit the user's intent. Consider the following examples: 

   For example, a user might utter an intent ("I want to order a pizza"). If Amazon Lex cannot infer the user intent from this utterance, it will return this dialog state. 
+  `ConfirmIntent` - Amazon Lex is expecting a "yes" or "no" response. 

  For example, Amazon Lex wants user confirmation before fulfilling an intent. Instead of a simple "yes" or "no" response, a user might respond with additional information. For example, "yes, but make it a thick crust pizza" or "no, I want to order a drink." Amazon Lex can process such additional information (in these examples, update the crust type slot or change the intent from OrderPizza to OrderDrink). 
+  `ElicitSlot` - Amazon Lex is expecting the value of a slot for the current intent. 

   For example, suppose that in the response Amazon Lex sends this message: "What size pizza would you like?". A user might reply with the slot value (e.g., "medium"). The user might also provide additional information in the response (e.g., "medium thick crust pizza"). Amazon Lex can process such additional information appropriately. 
+  `Fulfilled` - Conveys that the Lambda function has successfully fulfilled the intent. 
+  `ReadyForFulfillment` - Conveys that the client has to fulfill the request. 
+  `Failed` - Conveys that the conversation with the user failed. 

   This can happen for various reasons, including that the user does not provide an appropriate response to prompts from the service (you can configure how many times Amazon Lex can prompt a user for specific information), or if the Lambda function fails to fulfill the intent. 
Valid Values: `ElicitIntent | ConfirmIntent | ElicitSlot | Fulfilled | ReadyForFulfillment | Failed` 

 ** [encodedInputTranscript](#API_runtime_PostContent_ResponseSyntax) **   <a name="lex-runtime_PostContent-response-encodedInputTranscript"></a>
The text used to process the request.  
If the input was an audio stream, the `encodedInputTranscript` field contains the text extracted from the audio stream. This is the text that is actually processed to recognize intents and slot values. You can use this information to determine if Amazon Lex is correctly processing the audio that you send.  
The `encodedInputTranscript` field is base-64 encoded. You must decode the field before you can use the value.

 ** [encodedMessage](#API_runtime_PostContent_ResponseSyntax) **   <a name="lex-runtime_PostContent-response-encodedMessage"></a>
The message to convey to the user. The message can come from the bot's configuration or from a Lambda function.  
If the intent is not configured with a Lambda function, or if the Lambda function returned `Delegate` as the `dialogAction.type` in its response, Amazon Lex decides on the next course of action and selects an appropriate message from the bot's configuration based on the current interaction context. For example, if Amazon Lex isn't able to understand user input, it uses a clarification prompt message.  
When you create an intent you can assign messages to groups. When messages are assigned to groups Amazon Lex returns one message from each group in the response. The message field is an escaped JSON string containing the messages. For more information about the structure of the JSON string returned, see [Supported Message Formats](howitworks-manage-prompts.md#msg-prompts-formats).  
If the Lambda function returns a message, Amazon Lex passes it to the client in its response.  
The `encodedMessage` field is base-64 encoded. You must decode the field before you can use the value.  
Length Constraints: Minimum length of 1. Maximum length of 1366.

 ** [inputTranscript](#API_runtime_PostContent_ResponseSyntax) **   <a name="lex-runtime_PostContent-response-inputTranscript"></a>
 *This header has been deprecated.*   
The text used to process the request.  
You can use this field only in the de-DE, en-AU, en-GB, en-US, es-419, es-ES, es-US, fr-CA, fr-FR, and it-IT locales. In all other locales, the `inputTranscript` field is null. You should use the `encodedInputTranscript` field instead.  
If the input was an audio stream, the `inputTranscript` field contains the text extracted from the audio stream. This is the text that is actually processed to recognize intents and slot values. You can use this information to determine if Amazon Lex is correctly processing the audio that you send.

 ** [intentName](#API_runtime_PostContent_ResponseSyntax) **   <a name="lex-runtime_PostContent-response-intentName"></a>
Current user intent that Amazon Lex is aware of.

 ** [message](#API_runtime_PostContent_ResponseSyntax) **   <a name="lex-runtime_PostContent-response-message"></a>
 *This header has been deprecated.*   
You can only use this field in the de-DE, en-AU, en-GB, en-US, es-419, es-ES, es-US, fr-CA, fr-FR, and it-IT locales. In all other locales, the `message` field is null. You should use the `encodedMessage` field instead.  
The message to convey to the user. The message can come from the bot's configuration or from a Lambda function.  
If the intent is not configured with a Lambda function, or if the Lambda function returned `Delegate` as the `dialogAction.type` in its response, Amazon Lex decides on the next course of action and selects an appropriate message from the bot's configuration based on the current interaction context. For example, if Amazon Lex isn't able to understand user input, it uses a clarification prompt message.  
When you create an intent you can assign messages to groups. When messages are assigned to groups Amazon Lex returns one message from each group in the response. The message field is an escaped JSON string containing the messages. For more information about the structure of the JSON string returned, see [Supported Message Formats](howitworks-manage-prompts.md#msg-prompts-formats).  
If the Lambda function returns a message, Amazon Lex passes it to the client in its response.  
Length Constraints: Minimum length of 1. Maximum length of 1024.

 ** [messageFormat](#API_runtime_PostContent_ResponseSyntax) **   <a name="lex-runtime_PostContent-response-messageFormat"></a>
The format of the response message. One of the following values:  
+  `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 from the groups that messages were assigned to when the intent was created.
Valid Values: `PlainText | CustomPayload | SSML | Composite` 

 ** [nluIntentConfidence](#API_runtime_PostContent_ResponseSyntax) **   <a name="lex-runtime_PostContent-response-nluIntentConfidence"></a>
Provides a score that indicates how confident Amazon Lex is that the returned intent is the one that matches the user's intent. The score is between 0.0 and 1.0.  
The score is a relative score, not an absolute score. The score may change based on improvements to Amazon Lex. 

 ** [sentimentResponse](#API_runtime_PostContent_ResponseSyntax) **   <a name="lex-runtime_PostContent-response-sentimentResponse"></a>
The sentiment expressed in an utterance.  
When the bot is configured to send utterances to Amazon Comprehend for sentiment analysis, this field contains the result of the analysis.

 ** [sessionAttributes](#API_runtime_PostContent_ResponseSyntax) **   <a name="lex-runtime_PostContent-response-sessionAttributes"></a>
 Map of key/value pairs representing the session-specific context information. 

 ** [sessionId](#API_runtime_PostContent_ResponseSyntax) **   <a name="lex-runtime_PostContent-response-sessionId"></a>
The unique identifier for the session.

 ** [slots](#API_runtime_PostContent_ResponseSyntax) **   <a name="lex-runtime_PostContent-response-slots"></a>
Map of zero or more intent slots (name/value pairs) Amazon Lex detected from the user input during the conversation. The field is base-64 encoded.  
Amazon Lex creates a resolution list containing likely values for a slot. The value that it returns is determined by the `valueSelectionStrategy` selected when the slot type was created or updated. If `valueSelectionStrategy` is set to `ORIGINAL_VALUE`, the value provided by the user is returned, if the user value is similar to the slot values. If `valueSelectionStrategy` is set to `TOP_RESOLUTION` Amazon Lex returns the first value in the resolution list or, if there is no resolution list, null. If you don't specify a `valueSelectionStrategy`, the default is `ORIGINAL_VALUE`.

 ** [slotToElicit](#API_runtime_PostContent_ResponseSyntax) **   <a name="lex-runtime_PostContent-response-slotToElicit"></a>
 If the `dialogState` value is `ElicitSlot`, returns the name of the slot for which Amazon Lex is eliciting a value. 

The response returns the following as the HTTP body.

 ** [audioStream](#API_runtime_PostContent_ResponseSyntax) **   <a name="lex-runtime_PostContent-response-audioStream"></a>
The prompt (or statement) to convey to the user. This is based on the bot configuration and context. For example, if Amazon Lex did not understand the user intent, it sends the `clarificationPrompt` configured for the bot. If the intent requires confirmation before taking the fulfillment action, it sends the `confirmationPrompt`. Another example: Suppose that the Lambda function successfully fulfilled the intent, and sent a message to convey to the user. Then Amazon Lex sends that message in the response. 

## Errors
<a name="API_runtime_PostContent_Errors"></a>

 ** BadGatewayException **   
Either the Amazon Lex bot is still building, or one of the dependent services (Amazon Polly, AWS Lambda) failed with an internal service error.  
HTTP Status Code: 502

 ** BadRequestException **   
 Request validation failed, there is no usable message in the context, or the bot build failed, is still in progress, or contains unbuilt changes.   
HTTP Status Code: 400

 ** ConflictException **   
 Two clients are using the same AWS account, Amazon Lex bot, and user ID.   
HTTP Status Code: 409

 ** DependencyFailedException **   
 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.
HTTP Status Code: 424

 ** InternalFailureException **   
Internal service error. Retry the call.  
HTTP Status Code: 500

 ** LimitExceededException **   
Exceeded a limit.  
HTTP Status Code: 429

 ** LoopDetectedException **   
This exception is not used.  
HTTP Status Code: 508

 ** NotAcceptableException **   
The accept header in the request does not have a valid value.  
HTTP Status Code: 406

 ** NotFoundException **   
The resource (such as the Amazon Lex bot or an alias) that is referred to is not found.  
HTTP Status Code: 404

 ** RequestTimeoutException **   
The input speech is too long.  
HTTP Status Code: 408

 ** UnsupportedMediaTypeException **   
The Content-Type header (`PostContent` API) has an invalid value.   
HTTP Status Code: 415

## Examples
<a name="API_runtime_PostContent_Examples"></a>

### Example 1
<a name="API_runtime_PostContent_Example_1"></a>

 In this request, the URI identifies a bot (Traffic), bot version (\$1LATEST), and end user name (someuser). The `Content-Type` header identifies the format of the audio in the body. Amazon Lex also supports other formats. To convert audio from one format to another, if necessary, you can use SoX open source software. You specify the format in which you want to get the response by adding the `Accept` HTTP header. 

 In the response, the `x-amz-lex-message` header shows the response that Amazon Lex returned. The client can then send this response to the user. The same message is sent in audio/MPEG format through chunked encoding (as requested). 

#### Sample Request
<a name="API_runtime_PostContent_Example_1_Request"></a>

```
"POST /bot/Traffic/alias/$LATEST/user/someuser/content HTTP/1.1[\r][\n]"
"x-amz-lex-session-attributes: eyJ1c2VyTmFtZSI6IkJvYiJ9[\r][\n]"
"Content-Type: audio/x-l16; channel-count=1; sample-rate=16000f[\r][\n]"
"Accept: audio/mpeg[\r][\n]"
"Host: runtime.lex.us-east-1.amazonaws.com[\r][\n]"
"Authorization: AWS4-HMAC-SHA256 Credential=BLANKED_OUT/20161230/us-east-1/lex/aws4_request, 
SignedHeaders=accept;content-type;host;x-amz-content-sha256;x-amz-date;x-amz-lex-session-attributes, Signature=78ca5b54ea3f64a17ff7522de02cd90a9acd2365b45a9ce9b96ea105bb1c7ec2[\r][\n]"
"X-Amz-Date: 20161230T181426Z[\r][\n]"
"X-Amz-Content-Sha256: e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855[\r][\n]"
"Transfer-Encoding: chunked[\r][\n]"
"Connection: Keep-Alive[\r][\n]"
"User-Agent: Apache-HttpClient/4.5.x (Java/1.8.0_112)[\r][\n]"
"Accept-Encoding: gzip,deflate[\r][\n]"
"[\r][\n]"
"1000[\r][\n]"
"[0x7][0x0][0x7][0x0][\n]"
"[0x0][0x7][0x0][0xfc][0xff][\n]"
"[0x0][\n]"
…
```

#### Sample Response
<a name="API_runtime_PostContent_Example_1_Response"></a>

```
"HTTP/1.1 200 OK[\r][\n]"
"x-amzn-RequestId: cc8b34af-cebb-11e6-a35c-55f3a992f28d[\r][\n]"
"x-amz-lex-message: Sorry, can you repeat that?[\r][\n]"
"x-amz-lex-dialog-state: ElicitIntent[\r][\n]"
"x-amz-lex-session-attributes: eyJ1c2VyTmFtZSI6IkJvYiJ9[\r][\n]"
"Content-Type: audio/mpeg[\r][\n]"
"Transfer-Encoding: chunked[\r][\n]"
"Date: Fri, 30 Dec 2016 18:14:28 GMT[\r][\n]"
"[\r][\n]"               
"2000[\r][\n]"
"ID3[0x4][0x0][0x0][0x0][0x0][0x0]#TSSE[0x0][0x0][0x0][0xf][0x0][0x0][0x3]Lavf57.41.100[0x0][0x0][0x0][0x0][0x0][0x0][0x0][0x0][0x0][0x0][0x0][0xff][0xf3]`[0xc4][0x0][0x1b]{[0x8d][0xe8][0x1]C[0x18][0x1][0x0]J[0xe0]`b[0xdd][0xd1][0xb][0xfd][0x11][0xdf][0xfe]";[0xbb][0xbb][0x9f][0xee][0xee][0xee][0xee]|DDD/[0xff][0xff][0xff][0xff]www?D[0xf7]w^?[0xff][0xfa]h[0x88][0x85][0xfe][0x88][0x88][0x88][[0xa2]'[0xff][0xfa]"{[0x9f][0xe8][0x88]]D[0xeb][0xbb][0xbb][0xa2]!u[0xfd][0xdd][0xdf][0x88][0x94][0x0]F[0xef][0xa1]8[0x0][0x82]w[0x88]N[0x0][0x0][0x9b][0xbb][0xe8][0xe
…
```

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

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/runtime.lex-2016-11-28/PostContent) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/runtime.lex-2016-11-28/PostContent) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/runtime.lex-2016-11-28/PostContent) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/runtime.lex-2016-11-28/PostContent) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/runtime.lex-2016-11-28/PostContent) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/runtime.lex-2016-11-28/PostContent) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/runtime.lex-2016-11-28/PostContent) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/runtime.lex-2016-11-28/PostContent) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/runtime.lex-2016-11-28/PostContent) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/runtime.lex-2016-11-28/PostContent) 

# PostText
<a name="API_runtime_PostText"></a>

Sends user input to Amazon Lex. Client applications can use this API to send requests to Amazon Lex at runtime. Amazon Lex then interprets the user input using the machine learning model it built for the bot. 

 In response, Amazon Lex returns the next `message` to convey to the user an optional `responseCard` to display. Consider the following example messages: 
+  For a user input "I would like a pizza", Amazon Lex might return a response with a message eliciting slot data (for example, PizzaSize): "What size pizza would you like?" 
+  After the user provides all of the pizza order information, Amazon Lex might return a response with a message to obtain user confirmation "Proceed with the pizza order?". 
+  After the user replies to a confirmation prompt with a "yes", Amazon Lex might return a conclusion statement: "Thank you, your cheese pizza has been ordered.". 

 Not all Amazon Lex messages require a user response. For example, a conclusion statement does not require a response. Some messages require only a "yes" or "no" user response. In addition to the `message`, Amazon Lex provides additional context about the message in the response that you might use to enhance client behavior, for example, to display the appropriate client user interface. These are the `slotToElicit`, `dialogState`, `intentName`, and `slots` fields in the response. Consider the following examples: 
+ If the message is to elicit slot data, Amazon Lex returns the following context information:
  +  `dialogState` set to ElicitSlot 
  +  `intentName` set to the intent name in the current context 
  +  `slotToElicit` set to the slot name for which the `message` is eliciting information 
  +  `slots` set to a map of slots, configured for the intent, with currently known values 
+  If the message is a confirmation prompt, the `dialogState` is set to ConfirmIntent and `SlotToElicit` is set to null. 
+ If the message is a clarification prompt (configured for the intent) that indicates that user intent is not understood, the `dialogState` is set to ElicitIntent and `slotToElicit` is set to null. 

 In addition, Amazon Lex also returns your application-specific `sessionAttributes`. For more information, see [Managing Conversation Context](https://docs.aws.amazon.com/lex/latest/dg/context-mgmt.html). 

## Request Syntax
<a name="API_runtime_PostText_RequestSyntax"></a>

```
POST /bot/botName/alias/botAlias/user/userId/text HTTP/1.1
Content-type: application/json

{
   "activeContexts": [ 
      { 
         "name": "string",
         "parameters": { 
            "string" : "string" 
         },
         "timeToLive": { 
            "timeToLiveInSeconds": number,
            "turnsToLive": number
         }
      }
   ],
   "inputText": "string",
   "requestAttributes": { 
      "string" : "string" 
   },
   "sessionAttributes": { 
      "string" : "string" 
   }
}
```

## URI Request Parameters
<a name="API_runtime_PostText_RequestParameters"></a>

The request uses the following URI parameters.

 ** [botAlias](#API_runtime_PostText_RequestSyntax) **   <a name="lex-runtime_PostText-request-uri-botAlias"></a>
The alias of the Amazon Lex bot.  
Required: Yes

 ** [botName](#API_runtime_PostText_RequestSyntax) **   <a name="lex-runtime_PostText-request-uri-botName"></a>
The name of the Amazon Lex bot.  
Required: Yes

 ** [userId](#API_runtime_PostText_RequestSyntax) **   <a name="lex-runtime_PostText-request-uri-userId"></a>
The ID of the client application user. Amazon Lex uses this to identify a user's conversation with your bot. At runtime, each request must contain the `userID` field.  
To decide the user ID to use for your application, consider the following factors.  
+ The `userID` field must not contain any personally identifiable information of the user, for example, name, personal identification numbers, or other end user personal information.
+ If you want a user to start a conversation on one device and continue on another device, use a user-specific identifier.
+ If you want the same user to be able to have two independent conversations on two different devices, choose a device-specific identifier.
+ A user can't have two independent conversations with two different versions of the same bot. For example, a user can't have a conversation with the PROD and BETA versions of the same bot. If you anticipate that a user will need to have conversation with two different versions, for example, while testing, include the bot alias in the user ID to separate the two conversations.
Length Constraints: Minimum length of 2. Maximum length of 100.  
Pattern: `[0-9a-zA-Z._:-]+`   
Required: Yes

## Request Body
<a name="API_runtime_PostText_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [activeContexts](#API_runtime_PostText_RequestSyntax) **   <a name="lex-runtime_PostText-request-activeContexts"></a>
A list of contexts active for the request. A context can be activated when a previous intent is fulfilled, or by including the context in the request,  
If you don't specify a list of contexts, Amazon Lex will use the current list of contexts for the session. If you specify an empty list, all contexts for the session are cleared.  
Type: Array of [ActiveContext](API_runtime_ActiveContext.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 20 items.  
Required: No

 ** [inputText](#API_runtime_PostText_RequestSyntax) **   <a name="lex-runtime_PostText-request-inputText"></a>
The text that the user entered (Amazon Lex interprets this text).  
When you are using the AWS CLI, you can't pass a URL in the `--input-text` parameter. Pass the URL using the `--cli-input-json` parameter instead.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Required: Yes

 ** [requestAttributes](#API_runtime_PostText_RequestSyntax) **   <a name="lex-runtime_PostText-request-requestAttributes"></a>
Request-specific information passed between Amazon Lex and a client application.  
The namespace `x-amz-lex:` is reserved for special attributes. Don't create any request attributes with the prefix `x-amz-lex:`.  
For more information, see [Setting Request Attributes](https://docs.aws.amazon.com/lex/latest/dg/context-mgmt.html#context-mgmt-request-attribs).  
Type: String to string map  
Required: No

 ** [sessionAttributes](#API_runtime_PostText_RequestSyntax) **   <a name="lex-runtime_PostText-request-sessionAttributes"></a>
Application-specific information passed between Amazon Lex and a client application.  
For more information, see [Setting Session Attributes](https://docs.aws.amazon.com/lex/latest/dg/context-mgmt.html#context-mgmt-session-attribs).  
Type: String to string map  
Required: No

## Response Syntax
<a name="API_runtime_PostText_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "activeContexts": [ 
      { 
         "name": "string",
         "parameters": { 
            "string" : "string" 
         },
         "timeToLive": { 
            "timeToLiveInSeconds": number,
            "turnsToLive": number
         }
      }
   ],
   "alternativeIntents": [ 
      { 
         "intentName": "string",
         "nluIntentConfidence": { 
            "score": number
         },
         "slots": { 
            "string" : "string" 
         }
      }
   ],
   "botVersion": "string",
   "dialogState": "string",
   "intentName": "string",
   "message": "string",
   "messageFormat": "string",
   "nluIntentConfidence": { 
      "score": number
   },
   "responseCard": { 
      "contentType": "string",
      "genericAttachments": [ 
         { 
            "attachmentLinkUrl": "string",
            "buttons": [ 
               { 
                  "text": "string",
                  "value": "string"
               }
            ],
            "imageUrl": "string",
            "subTitle": "string",
            "title": "string"
         }
      ],
      "version": "string"
   },
   "sentimentResponse": { 
      "sentimentLabel": "string",
      "sentimentScore": "string"
   },
   "sessionAttributes": { 
      "string" : "string" 
   },
   "sessionId": "string",
   "slots": { 
      "string" : "string" 
   },
   "slotToElicit": "string"
}
```

## Response Elements
<a name="API_runtime_PostText_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [activeContexts](#API_runtime_PostText_ResponseSyntax) **   <a name="lex-runtime_PostText-response-activeContexts"></a>
A list of active contexts for the session. A context can be set when an intent is fulfilled or by calling the `PostContent`, `PostText`, or `PutSession` operation.  
You can use a context to control the intents that can follow up an intent, or to modify the operation of your application.  
Type: Array of [ActiveContext](API_runtime_ActiveContext.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 20 items.

 ** [alternativeIntents](#API_runtime_PostText_ResponseSyntax) **   <a name="lex-runtime_PostText-response-alternativeIntents"></a>
One to four alternative intents that may be applicable to the user's intent.  
Each alternative includes a score that indicates how confident Amazon Lex is that the intent matches the user's intent. The intents are sorted by the confidence score.  
Type: Array of [PredictedIntent](API_runtime_PredictedIntent.md) objects  
Array Members: Maximum number of 4 items.

 ** [botVersion](#API_runtime_PostText_ResponseSyntax) **   <a name="lex-runtime_PostText-response-botVersion"></a>
The version of the bot that responded to the conversation. You can use this information to help determine if one version of a bot is performing better than another version.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `[0-9]+|\$LATEST` 

 ** [dialogState](#API_runtime_PostText_ResponseSyntax) **   <a name="lex-runtime_PostText-response-dialogState"></a>
 Identifies the current state of the user interaction. Amazon Lex returns one of the following values as `dialogState`. The client can optionally use this information to customize the user interface.   
+  `ElicitIntent` - Amazon Lex wants to elicit user intent. 

  For example, a user might utter an intent ("I want to order a pizza"). If Amazon Lex cannot infer the user intent from this utterance, it will return this dialogState.
+  `ConfirmIntent` - Amazon Lex is expecting a "yes" or "no" response. 

   For example, Amazon Lex wants user confirmation before fulfilling an intent. 

  Instead of a simple "yes" or "no," a user might respond with additional information. For example, "yes, but make it thick crust pizza" or "no, I want to order a drink". Amazon Lex can process such additional information (in these examples, update the crust type slot value, or change intent from OrderPizza to OrderDrink).
+  `ElicitSlot` - Amazon Lex is expecting a slot value for the current intent. 

  For example, suppose that in the response Amazon Lex sends this message: "What size pizza would you like?". A user might reply with the slot value (e.g., "medium"). The user might also provide additional information in the response (e.g., "medium thick crust pizza"). Amazon Lex can process such additional information appropriately. 
+  `Fulfilled` - Conveys that the Lambda function configured for the intent has successfully fulfilled the intent. 
+  `ReadyForFulfillment` - Conveys that the client has to fulfill the intent. 
+  `Failed` - Conveys that the conversation with the user failed. 

   This can happen for various reasons including that the user did not provide an appropriate response to prompts from the service (you can configure how many times Amazon Lex can prompt a user for specific information), or the Lambda function failed to fulfill the intent. 
Type: String  
Valid Values: `ElicitIntent | ConfirmIntent | ElicitSlot | Fulfilled | ReadyForFulfillment | Failed` 

 ** [intentName](#API_runtime_PostText_ResponseSyntax) **   <a name="lex-runtime_PostText-response-intentName"></a>
The current user intent that Amazon Lex is aware of.  
Type: String

 ** [message](#API_runtime_PostText_ResponseSyntax) **   <a name="lex-runtime_PostText-response-message"></a>
The message to convey to the user. The message can come from the bot's configuration or from a Lambda function.  
If the intent is not configured with a Lambda function, or if the Lambda function returned `Delegate` as the `dialogAction.type` its response, Amazon Lex decides on the next course of action and selects an appropriate message from the bot's configuration based on the current interaction context. For example, if Amazon Lex isn't able to understand user input, it uses a clarification prompt message.  
When you create an intent you can assign messages to groups. When messages are assigned to groups Amazon Lex returns one message from each group in the response. The message field is an escaped JSON string containing the messages. For more information about the structure of the JSON string returned, see [Supported Message Formats](howitworks-manage-prompts.md#msg-prompts-formats).  
If the Lambda function returns a message, Amazon Lex passes it to the client in its response.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.

 ** [messageFormat](#API_runtime_PostText_ResponseSyntax) **   <a name="lex-runtime_PostText-response-messageFormat"></a>
The format of the response message. One of the following values:  
+  `PlainText` - The message contains plain UTF-8 text.
+  `CustomPayload` - The message is a custom format defined by the Lambda function.
+  `SSML` - The message contains text formatted for voice output.
+  `Composite` - The message contains an escaped JSON object containing one or more messages from the groups that messages were assigned to when the intent was created.
Type: String  
Valid Values: `PlainText | CustomPayload | SSML | Composite` 

 ** [nluIntentConfidence](#API_runtime_PostText_ResponseSyntax) **   <a name="lex-runtime_PostText-response-nluIntentConfidence"></a>
Provides a score that indicates how confident Amazon Lex is that the returned intent is the one that matches the user's intent. The score is between 0.0 and 1.0. For more information, see [Confidence Scores](https://docs.aws.amazon.com/lex/latest/dg/confidence-scores.html).  
The score is a relative score, not an absolute score. The score may change based on improvements to Amazon Lex.  
Type: [IntentConfidence](API_runtime_IntentConfidence.md) object

 ** [responseCard](#API_runtime_PostText_ResponseSyntax) **   <a name="lex-runtime_PostText-response-responseCard"></a>
Represents the options that the user has to respond to the current prompt. Response Card can come from the bot configuration (in the Amazon Lex console, choose the settings button next to a slot) or from a code hook (Lambda function).   
Type: [ResponseCard](API_runtime_ResponseCard.md) object

 ** [sentimentResponse](#API_runtime_PostText_ResponseSyntax) **   <a name="lex-runtime_PostText-response-sentimentResponse"></a>
The sentiment expressed in and utterance.  
When the bot is configured to send utterances to Amazon Comprehend for sentiment analysis, this field contains the result of the analysis.  
Type: [SentimentResponse](API_runtime_SentimentResponse.md) object

 ** [sessionAttributes](#API_runtime_PostText_ResponseSyntax) **   <a name="lex-runtime_PostText-response-sessionAttributes"></a>
A map of key-value pairs representing the session-specific context information.  
Type: String to string map

 ** [sessionId](#API_runtime_PostText_ResponseSyntax) **   <a name="lex-runtime_PostText-response-sessionId"></a>
A unique identifier for the session.  
Type: String

 ** [slots](#API_runtime_PostText_ResponseSyntax) **   <a name="lex-runtime_PostText-response-slots"></a>
 The intent slots that Amazon Lex detected from the user input in the conversation.   
Amazon Lex creates a resolution list containing likely values for a slot. The value that it returns is determined by the `valueSelectionStrategy` selected when the slot type was created or updated. If `valueSelectionStrategy` is set to `ORIGINAL_VALUE`, the value provided by the user is returned, if the user value is similar to the slot values. If `valueSelectionStrategy` is set to `TOP_RESOLUTION` Amazon Lex returns the first value in the resolution list or, if there is no resolution list, null. If you don't specify a `valueSelectionStrategy`, the default is `ORIGINAL_VALUE`.  
Type: String to string map

 ** [slotToElicit](#API_runtime_PostText_ResponseSyntax) **   <a name="lex-runtime_PostText-response-slotToElicit"></a>
If the `dialogState` value is `ElicitSlot`, returns the name of the slot for which Amazon Lex is eliciting a value.   
Type: String

## Errors
<a name="API_runtime_PostText_Errors"></a>

 ** BadGatewayException **   
Either the Amazon Lex bot is still building, or one of the dependent services (Amazon Polly, AWS Lambda) failed with an internal service error.  
HTTP Status Code: 502

 ** BadRequestException **   
 Request validation failed, there is no usable message in the context, or the bot build failed, is still in progress, or contains unbuilt changes.   
HTTP Status Code: 400

 ** ConflictException **   
 Two clients are using the same AWS account, Amazon Lex bot, and user ID.   
HTTP Status Code: 409

 ** DependencyFailedException **   
 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.
HTTP Status Code: 424

 ** InternalFailureException **   
Internal service error. Retry the call.  
HTTP Status Code: 500

 ** LimitExceededException **   
Exceeded a limit.  
HTTP Status Code: 429

 ** LoopDetectedException **   
This exception is not used.  
HTTP Status Code: 508

 ** NotFoundException **   
The resource (such as the Amazon Lex bot or an alias) that is referred to is not found.  
HTTP Status Code: 404

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

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/runtime.lex-2016-11-28/PostText) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/runtime.lex-2016-11-28/PostText) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/runtime.lex-2016-11-28/PostText) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/runtime.lex-2016-11-28/PostText) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/runtime.lex-2016-11-28/PostText) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/runtime.lex-2016-11-28/PostText) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/runtime.lex-2016-11-28/PostText) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/runtime.lex-2016-11-28/PostText) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/runtime.lex-2016-11-28/PostText) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/runtime.lex-2016-11-28/PostText) 

# PutSession
<a name="API_runtime_PutSession"></a>

Creates a new session or modifies an existing session with an Amazon Lex bot. Use this operation to enable your application to set the state of the bot.

For more information, see [Managing Sessions](https://docs.aws.amazon.com/lex/latest/dg/how-session-api.html).

## Request Syntax
<a name="API_runtime_PutSession_RequestSyntax"></a>

```
POST /bot/botName/alias/botAlias/user/userId/session HTTP/1.1
Accept: accept
Content-type: application/json

{
   "activeContexts": [ 
      { 
         "name": "string",
         "parameters": { 
            "string" : "string" 
         },
         "timeToLive": { 
            "timeToLiveInSeconds": number,
            "turnsToLive": number
         }
      }
   ],
   "dialogAction": { 
      "fulfillmentState": "string",
      "intentName": "string",
      "message": "string",
      "messageFormat": "string",
      "slots": { 
         "string" : "string" 
      },
      "slotToElicit": "string",
      "type": "string"
   },
   "recentIntentSummaryView": [ 
      { 
         "checkpointLabel": "string",
         "confirmationStatus": "string",
         "dialogActionType": "string",
         "fulfillmentState": "string",
         "intentName": "string",
         "slots": { 
            "string" : "string" 
         },
         "slotToElicit": "string"
      }
   ],
   "sessionAttributes": { 
      "string" : "string" 
   }
}
```

## URI Request Parameters
<a name="API_runtime_PutSession_RequestParameters"></a>

The request uses the following URI parameters.

 ** [accept](#API_runtime_PutSession_RequestSyntax) **   <a name="lex-runtime_PutSession-request-accept"></a>
The message that Amazon Lex returns in the response can be either text or speech based depending on the value of this field.  
+ If the value is `text/plain; charset=utf-8`, Amazon Lex returns text in the response.
+ If the value begins with `audio/`, Amazon Lex returns speech in the response. Amazon Lex uses Amazon Polly to generate the speech in the configuration that you specify. For example, if you specify `audio/mpeg` as the value, Amazon Lex returns speech in the MPEG format.
+ If the value is `audio/pcm`, the speech is returned as `audio/pcm` in 16-bit, little endian format.
+ The following are the accepted values:
  +  `audio/mpeg` 
  +  `audio/ogg` 
  +  `audio/pcm` 
  +  `audio/*` (defaults to mpeg)
  +  `text/plain; charset=utf-8` 

 ** [botAlias](#API_runtime_PutSession_RequestSyntax) **   <a name="lex-runtime_PutSession-request-uri-botAlias"></a>
The alias in use for the bot that contains the session data.  
Required: Yes

 ** [botName](#API_runtime_PutSession_RequestSyntax) **   <a name="lex-runtime_PutSession-request-uri-botName"></a>
The name of the bot that contains the session data.  
Required: Yes

 ** [userId](#API_runtime_PutSession_RequestSyntax) **   <a name="lex-runtime_PutSession-request-uri-userId"></a>
The ID of the client application user. Amazon Lex uses this to identify a user's conversation with your bot.   
Length Constraints: Minimum length of 2. Maximum length of 100.  
Pattern: `[0-9a-zA-Z._:-]+`   
Required: Yes

## Request Body
<a name="API_runtime_PutSession_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [activeContexts](#API_runtime_PutSession_RequestSyntax) **   <a name="lex-runtime_PutSession-request-activeContexts"></a>
A list of contexts active for the request. A context can be activated when a previous intent is fulfilled, or by including the context in the request,  
If you don't specify a list of contexts, Amazon Lex will use the current list of contexts for the session. If you specify an empty list, all contexts for the session are cleared.  
Type: Array of [ActiveContext](API_runtime_ActiveContext.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 20 items.  
Required: No

 ** [dialogAction](#API_runtime_PutSession_RequestSyntax) **   <a name="lex-runtime_PutSession-request-dialogAction"></a>
Sets the next action that the bot should take to fulfill the conversation.  
Type: [DialogAction](API_runtime_DialogAction.md) object  
Required: No

 ** [recentIntentSummaryView](#API_runtime_PutSession_RequestSyntax) **   <a name="lex-runtime_PutSession-request-recentIntentSummaryView"></a>
A summary of the recent intents for the bot. You can use the intent summary view to set a checkpoint label on an intent and modify attributes of intents. You can also use it to remove or add intent summary objects to the list.  
An intent that you modify or add to the list must make sense for the bot. For example, the intent name must be valid for the bot. You must provide valid values for:  
+  `intentName` 
+ slot names
+  `slotToElict` 
If you send the `recentIntentSummaryView` parameter in a `PutSession` request, the contents of the new summary view replaces the old summary view. For example, if a `GetSession` request returns three intents in the summary view and you call `PutSession` with one intent in the summary view, the next call to `GetSession` will only return one intent.  
Type: Array of [IntentSummary](API_runtime_IntentSummary.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 3 items.  
Required: No

 ** [sessionAttributes](#API_runtime_PutSession_RequestSyntax) **   <a name="lex-runtime_PutSession-request-sessionAttributes"></a>
Map of key/value pairs representing the session-specific context information. It contains application information passed between Amazon Lex and a client application.  
Type: String to string map  
Required: No

## Response Syntax
<a name="API_runtime_PutSession_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-Type: contentType
x-amz-lex-intent-name: intentName
x-amz-lex-slots: slots
x-amz-lex-session-attributes: sessionAttributes
x-amz-lex-message: message
x-amz-lex-encoded-message: encodedMessage
x-amz-lex-message-format: messageFormat
x-amz-lex-dialog-state: dialogState
x-amz-lex-slot-to-elicit: slotToElicit
x-amz-lex-session-id: sessionId
x-amz-lex-active-contexts: activeContexts

audioStream
```

## Response Elements
<a name="API_runtime_PutSession_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The response returns the following HTTP headers.

 ** [activeContexts](#API_runtime_PutSession_ResponseSyntax) **   <a name="lex-runtime_PutSession-response-activeContexts"></a>
A list of active contexts for the session.

 ** [contentType](#API_runtime_PutSession_ResponseSyntax) **   <a name="lex-runtime_PutSession-response-contentType"></a>
Content type as specified in the `Accept` HTTP header in the request.

 ** [dialogState](#API_runtime_PutSession_ResponseSyntax) **   <a name="lex-runtime_PutSession-response-dialogState"></a>
  
+  `ConfirmIntent` - Amazon Lex is expecting a "yes" or "no" response to confirm the intent before fulfilling an intent.
+  `ElicitIntent` - Amazon Lex wants to elicit the user's intent.
+  `ElicitSlot` - Amazon Lex is expecting the value of a slot for the current intent.
+  `Failed` - Conveys that the conversation with the user has failed. This can happen for various reasons, including the user does not provide an appropriate response to prompts from the service, or if the Lambda function fails to fulfill the intent.
+  `Fulfilled` - Conveys that the Lambda function has sucessfully fulfilled the intent.
+  `ReadyForFulfillment` - Conveys that the client has to fulfill the intent.
Valid Values: `ElicitIntent | ConfirmIntent | ElicitSlot | Fulfilled | ReadyForFulfillment | Failed` 

 ** [encodedMessage](#API_runtime_PutSession_ResponseSyntax) **   <a name="lex-runtime_PutSession-response-encodedMessage"></a>
The next message that should be presented to the user.  
The `encodedMessage` field is base-64 encoded. You must decode the field before you can use the value.  
Length Constraints: Minimum length of 1. Maximum length of 1366.

 ** [intentName](#API_runtime_PutSession_ResponseSyntax) **   <a name="lex-runtime_PutSession-response-intentName"></a>
The name of the current intent.

 ** [message](#API_runtime_PutSession_ResponseSyntax) **   <a name="lex-runtime_PutSession-response-message"></a>
 *This header has been deprecated.*   
The next message that should be presented to the user.  
You can only use this field in the de-DE, en-AU, en-GB, en-US, es-419, es-ES, es-US, fr-CA, fr-FR, and it-IT locales. In all other locales, the `message` field is null. You should use the `encodedMessage` field instead.  
Length Constraints: Minimum length of 1. Maximum length of 1024.

 ** [messageFormat](#API_runtime_PutSession_ResponseSyntax) **   <a name="lex-runtime_PutSession-response-messageFormat"></a>
The format of the response message. One of the following values:  
+  `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 from the groups that messages were assigned to when the intent was created.
Valid Values: `PlainText | CustomPayload | SSML | Composite` 

 ** [sessionAttributes](#API_runtime_PutSession_ResponseSyntax) **   <a name="lex-runtime_PutSession-response-sessionAttributes"></a>
Map of key/value pairs representing session-specific context information.

 ** [sessionId](#API_runtime_PutSession_ResponseSyntax) **   <a name="lex-runtime_PutSession-response-sessionId"></a>
A unique identifier for the session.

 ** [slots](#API_runtime_PutSession_ResponseSyntax) **   <a name="lex-runtime_PutSession-response-slots"></a>
Map of zero or more intent slots Amazon Lex detected from the user input during the conversation.  
Amazon Lex creates a resolution list containing likely values for a slot. The value that it returns is determined by the `valueSelectionStrategy` selected when the slot type was created or updated. If `valueSelectionStrategy` is set to `ORIGINAL_VALUE`, the value provided by the user is returned, if the user value is similar to the slot values. If `valueSelectionStrategy` is set to `TOP_RESOLUTION` Amazon Lex returns the first value in the resolution list or, if there is no resolution list, null. If you don't specify a `valueSelectionStrategy` the default is `ORIGINAL_VALUE`. 

 ** [slotToElicit](#API_runtime_PutSession_ResponseSyntax) **   <a name="lex-runtime_PutSession-response-slotToElicit"></a>
If the `dialogState` is `ElicitSlot`, returns the name of the slot for which Amazon Lex is eliciting a value.

The response returns the following as the HTTP body.

 ** [audioStream](#API_runtime_PutSession_ResponseSyntax) **   <a name="lex-runtime_PutSession-response-audioStream"></a>
The audio version of the message to convey to the user.

## Errors
<a name="API_runtime_PutSession_Errors"></a>

 ** BadGatewayException **   
Either the Amazon Lex bot is still building, or one of the dependent services (Amazon Polly, AWS Lambda) failed with an internal service error.  
HTTP Status Code: 502

 ** BadRequestException **   
 Request validation failed, there is no usable message in the context, or the bot build failed, is still in progress, or contains unbuilt changes.   
HTTP Status Code: 400

 ** ConflictException **   
 Two clients are using the same AWS account, Amazon Lex bot, and user ID.   
HTTP Status Code: 409

 ** DependencyFailedException **   
 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.
HTTP Status Code: 424

 ** InternalFailureException **   
Internal service error. Retry the call.  
HTTP Status Code: 500

 ** LimitExceededException **   
Exceeded a limit.  
HTTP Status Code: 429

 ** NotAcceptableException **   
The accept header in the request does not have a valid value.  
HTTP Status Code: 406

 ** NotFoundException **   
The resource (such as the Amazon Lex bot or an alias) that is referred to is not found.  
HTTP Status Code: 404

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

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/runtime.lex-2016-11-28/PutSession) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/runtime.lex-2016-11-28/PutSession) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/runtime.lex-2016-11-28/PutSession) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/runtime.lex-2016-11-28/PutSession) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/runtime.lex-2016-11-28/PutSession) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/runtime.lex-2016-11-28/PutSession) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/runtime.lex-2016-11-28/PutSession) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/runtime.lex-2016-11-28/PutSession) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/runtime.lex-2016-11-28/PutSession) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/runtime.lex-2016-11-28/PutSession) 

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