# Amazon Lex Model Building V2
The following actions are supported by Amazon Lex Model Building V2:
+ [BatchCreateCustomVocabularyItem](API_BatchCreateCustomVocabularyItem.md)
+ [BatchDeleteCustomVocabularyItem](API_BatchDeleteCustomVocabularyItem.md)
+ [BatchUpdateCustomVocabularyItem](API_BatchUpdateCustomVocabularyItem.md)
+ [BuildBotLocale](API_BuildBotLocale.md)
+ [CreateBot](API_CreateBot.md)
+ [CreateBotAlias](API_CreateBotAlias.md)
+ [CreateBotLocale](API_CreateBotLocale.md)
+ [CreateBotReplica](API_CreateBotReplica.md)
+ [CreateBotVersion](API_CreateBotVersion.md)
+ [CreateExport](API_CreateExport.md)
+ [CreateIntent](API_CreateIntent.md)
+ [CreateResourcePolicy](API_CreateResourcePolicy.md)
+ [CreateResourcePolicyStatement](API_CreateResourcePolicyStatement.md)
+ [CreateSlot](API_CreateSlot.md)
+ [CreateSlotType](API_CreateSlotType.md)
+ [CreateTestSetDiscrepancyReport](API_CreateTestSetDiscrepancyReport.md)
+ [CreateUploadUrl](API_CreateUploadUrl.md)
+ [DeleteBot](API_DeleteBot.md)
+ [DeleteBotAlias](API_DeleteBotAlias.md)
+ [DeleteBotAnalyzerRecommendation](API_DeleteBotAnalyzerRecommendation.md)
+ [DeleteBotLocale](API_DeleteBotLocale.md)
+ [DeleteBotReplica](API_DeleteBotReplica.md)
+ [DeleteBotVersion](API_DeleteBotVersion.md)
+ [DeleteCustomVocabulary](API_DeleteCustomVocabulary.md)
+ [DeleteExport](API_DeleteExport.md)
+ [DeleteImport](API_DeleteImport.md)
+ [DeleteIntent](API_DeleteIntent.md)
+ [DeleteResourcePolicy](API_DeleteResourcePolicy.md)
+ [DeleteResourcePolicyStatement](API_DeleteResourcePolicyStatement.md)
+ [DeleteSlot](API_DeleteSlot.md)
+ [DeleteSlotType](API_DeleteSlotType.md)
+ [DeleteTestSet](API_DeleteTestSet.md)
+ [DeleteUtterances](API_DeleteUtterances.md)
+ [DescribeBot](API_DescribeBot.md)
+ [DescribeBotAlias](API_DescribeBotAlias.md)
+ [DescribeBotAnalyzerRecommendation](API_DescribeBotAnalyzerRecommendation.md)
+ [DescribeBotLocale](API_DescribeBotLocale.md)
+ [DescribeBotRecommendation](API_DescribeBotRecommendation.md)
+ [DescribeBotReplica](API_DescribeBotReplica.md)
+ [DescribeBotResourceGeneration](API_DescribeBotResourceGeneration.md)
+ [DescribeBotVersion](API_DescribeBotVersion.md)
+ [DescribeCustomVocabularyMetadata](API_DescribeCustomVocabularyMetadata.md)
+ [DescribeExport](API_DescribeExport.md)
+ [DescribeImport](API_DescribeImport.md)
+ [DescribeIntent](API_DescribeIntent.md)
+ [DescribeResourcePolicy](API_DescribeResourcePolicy.md)
+ [DescribeSlot](API_DescribeSlot.md)
+ [DescribeSlotType](API_DescribeSlotType.md)
+ [DescribeTestExecution](API_DescribeTestExecution.md)
+ [DescribeTestSet](API_DescribeTestSet.md)
+ [DescribeTestSetDiscrepancyReport](API_DescribeTestSetDiscrepancyReport.md)
+ [DescribeTestSetGeneration](API_DescribeTestSetGeneration.md)
+ [GenerateBotElement](API_GenerateBotElement.md)
+ [GetTestExecutionArtifactsUrl](API_GetTestExecutionArtifactsUrl.md)
+ [ListAggregatedUtterances](API_ListAggregatedUtterances.md)
+ [ListBotAliases](API_ListBotAliases.md)
+ [ListBotAliasReplicas](API_ListBotAliasReplicas.md)
+ [ListBotAnalyzerHistory](API_ListBotAnalyzerHistory.md)
+ [ListBotLocales](API_ListBotLocales.md)
+ [ListBotRecommendations](API_ListBotRecommendations.md)
+ [ListBotReplicas](API_ListBotReplicas.md)
+ [ListBotResourceGenerations](API_ListBotResourceGenerations.md)
+ [ListBots](API_ListBots.md)
+ [ListBotVersionReplicas](API_ListBotVersionReplicas.md)
+ [ListBotVersions](API_ListBotVersions.md)
+ [ListBuiltInIntents](API_ListBuiltInIntents.md)
+ [ListBuiltInSlotTypes](API_ListBuiltInSlotTypes.md)
+ [ListCustomVocabularyItems](API_ListCustomVocabularyItems.md)
+ [ListExports](API_ListExports.md)
+ [ListImports](API_ListImports.md)
+ [ListIntentMetrics](API_ListIntentMetrics.md)
+ [ListIntentPaths](API_ListIntentPaths.md)
+ [ListIntents](API_ListIntents.md)
+ [ListIntentStageMetrics](API_ListIntentStageMetrics.md)
+ [ListRecommendedIntents](API_ListRecommendedIntents.md)
+ [ListSessionAnalyticsData](API_ListSessionAnalyticsData.md)
+ [ListSessionMetrics](API_ListSessionMetrics.md)
+ [ListSlots](API_ListSlots.md)
+ [ListSlotTypes](API_ListSlotTypes.md)
+ [ListTagsForResource](API_ListTagsForResource.md)
+ [ListTestExecutionResultItems](API_ListTestExecutionResultItems.md)
+ [ListTestExecutions](API_ListTestExecutions.md)
+ [ListTestSetRecords](API_ListTestSetRecords.md)
+ [ListTestSets](API_ListTestSets.md)
+ [ListUtteranceAnalyticsData](API_ListUtteranceAnalyticsData.md)
+ [ListUtteranceMetrics](API_ListUtteranceMetrics.md)
+ [SearchAssociatedTranscripts](API_SearchAssociatedTranscripts.md)
+ [StartBotAnalyzer](API_StartBotAnalyzer.md)
+ [StartBotRecommendation](API_StartBotRecommendation.md)
+ [StartBotResourceGeneration](API_StartBotResourceGeneration.md)
+ [StartImport](API_StartImport.md)
+ [StartTestExecution](API_StartTestExecution.md)
+ [StartTestSetGeneration](API_StartTestSetGeneration.md)
+ [StopBotAnalyzer](API_StopBotAnalyzer.md)
+ [StopBotRecommendation](API_StopBotRecommendation.md)
+ [TagResource](API_TagResource.md)
+ [UntagResource](API_UntagResource.md)
+ [UpdateBot](API_UpdateBot.md)
+ [UpdateBotAlias](API_UpdateBotAlias.md)
+ [UpdateBotLocale](API_UpdateBotLocale.md)
+ [UpdateBotRecommendation](API_UpdateBotRecommendation.md)
+ [UpdateExport](API_UpdateExport.md)
+ [UpdateIntent](API_UpdateIntent.md)
+ [UpdateResourcePolicy](API_UpdateResourcePolicy.md)
+ [UpdateSlot](API_UpdateSlot.md)
+ [UpdateSlotType](API_UpdateSlotType.md)
+ [UpdateTestSet](API_UpdateTestSet.md)
# BatchCreateCustomVocabularyItem
Create a batch of custom vocabulary items for a given bot locale's custom vocabulary.
## Request Syntax
```
PUT /bots/botId/botversions/botVersion/botlocales/localeId/customvocabulary/DEFAULT/batchcreate HTTP/1.1
Content-type: application/json
{
"customVocabularyItemList": [
{
"displayAs": "string",
"phrase": "string",
"weight": number
}
]
}
```
## URI Request Parameters
The request uses the following URI parameters.
** [botId](#API_BatchCreateCustomVocabularyItem_RequestSyntax) **
The identifier of the bot associated with this custom vocabulary.
Length Constraints: Fixed length of 10.
Pattern: `^[0-9a-zA-Z]+$`
Required: Yes
** [botVersion](#API_BatchCreateCustomVocabularyItem_RequestSyntax) **
The identifier of the version of the bot associated with this custom vocabulary.
Length Constraints: Minimum length of 1. Maximum length of 5.
Pattern: `^(DRAFT|[0-9]+)$`
Required: Yes
** [localeId](#API_BatchCreateCustomVocabularyItem_RequestSyntax) **
The identifier of the language and locale where this custom vocabulary is used. The string must match one of the supported locales. For more information, see [ Supported Languages ](https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html).
Required: Yes
## Request Body
The request accepts the following data in JSON format.
** [customVocabularyItemList](#API_BatchCreateCustomVocabularyItem_RequestSyntax) **
A list of new custom vocabulary items. Each entry must contain a phrase and can optionally contain a displayAs and/or a weight.
Type: Array of [NewCustomVocabularyItem](API_NewCustomVocabularyItem.md) objects
Array Members: Minimum number of 1 item. Maximum number of 10 items.
Required: Yes
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"botId": "string",
"botVersion": "string",
"errors": [
{
"errorCode": "string",
"errorMessage": "string",
"itemId": "string"
}
],
"localeId": "string",
"resources": [
{
"displayAs": "string",
"itemId": "string",
"phrase": "string",
"weight": number
}
]
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [botId](#API_BatchCreateCustomVocabularyItem_ResponseSyntax) **
The identifier of the bot associated with this custom vocabulary.
Type: String
Length Constraints: Fixed length of 10.
Pattern: `^[0-9a-zA-Z]+$`
** [botVersion](#API_BatchCreateCustomVocabularyItem_ResponseSyntax) **
The identifier of the version of the bot associated with this custom vocabulary.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 5.
Pattern: `^(DRAFT|[0-9]+)$`
** [errors](#API_BatchCreateCustomVocabularyItem_ResponseSyntax) **
A list of custom vocabulary items that failed to create during the operation. The reason for the error is contained within each error object.
Type: Array of [FailedCustomVocabularyItem](API_FailedCustomVocabularyItem.md) objects
** [localeId](#API_BatchCreateCustomVocabularyItem_ResponseSyntax) **
The identifier of the language and locale where this custom vocabulary is used. The string must match one of the supported locales. For more information, see [ Supported Languages ](https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html).
Type: String
** [resources](#API_BatchCreateCustomVocabularyItem_ResponseSyntax) **
A list of custom vocabulary items that were successfully created during the operation.
Type: Array of [CustomVocabularyItem](API_CustomVocabularyItem.md) objects
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** InternalServerException **
The service encountered an unexpected condition. Try your request again.
HTTP Status Code: 500
** ResourceNotFoundException **
You asked to describe a resource that doesn't exist. Check the resource that you are requesting and try again.
HTTP Status Code: 404
** ServiceQuotaExceededException **
You have reached a quota for your bot.
HTTP Status Code: 402
** ThrottlingException **
Your request rate is too high. Reduce the frequency of requests.
** retryAfterSeconds **
The number of seconds after which the user can invoke the API again.
HTTP Status Code: 429
** ValidationException **
One of the input parameters in your request isn't valid. Check the parameters and try your request again.
HTTP Status Code: 400
## See Also
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/models.lex.v2-2020-08-07/BatchCreateCustomVocabularyItem)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/models.lex.v2-2020-08-07/BatchCreateCustomVocabularyItem)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/BatchCreateCustomVocabularyItem)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/models.lex.v2-2020-08-07/BatchCreateCustomVocabularyItem)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/BatchCreateCustomVocabularyItem)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/models.lex.v2-2020-08-07/BatchCreateCustomVocabularyItem)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/models.lex.v2-2020-08-07/BatchCreateCustomVocabularyItem)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/models.lex.v2-2020-08-07/BatchCreateCustomVocabularyItem)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/models.lex.v2-2020-08-07/BatchCreateCustomVocabularyItem)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/BatchCreateCustomVocabularyItem)
# BatchDeleteCustomVocabularyItem
Delete a batch of custom vocabulary items for a given bot locale's custom vocabulary.
## Request Syntax
```
POST /bots/botId/botversions/botVersion/botlocales/localeId/customvocabulary/DEFAULT/batchdelete HTTP/1.1
Content-type: application/json
{
"customVocabularyItemList": [
{
"itemId": "string"
}
]
}
```
## URI Request Parameters
The request uses the following URI parameters.
** [botId](#API_BatchDeleteCustomVocabularyItem_RequestSyntax) **
The identifier of the bot associated with this custom vocabulary.
Length Constraints: Fixed length of 10.
Pattern: `^[0-9a-zA-Z]+$`
Required: Yes
** [botVersion](#API_BatchDeleteCustomVocabularyItem_RequestSyntax) **
The identifier of the version of the bot associated with this custom vocabulary.
Length Constraints: Minimum length of 1. Maximum length of 5.
Pattern: `^(DRAFT|[0-9]+)$`
Required: Yes
** [localeId](#API_BatchDeleteCustomVocabularyItem_RequestSyntax) **
The identifier of the language and locale where this custom vocabulary is used. The string must match one of the supported locales. For more information, see [ Supported Languages ](https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html).
Required: Yes
## Request Body
The request accepts the following data in JSON format.
** [customVocabularyItemList](#API_BatchDeleteCustomVocabularyItem_RequestSyntax) **
A list of custom vocabulary items requested to be deleted. Each entry must contain the unique custom vocabulary entry identifier.
Type: Array of [CustomVocabularyEntryId](API_CustomVocabularyEntryId.md) objects
Array Members: Minimum number of 1 item. Maximum number of 10 items.
Required: Yes
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"botId": "string",
"botVersion": "string",
"errors": [
{
"errorCode": "string",
"errorMessage": "string",
"itemId": "string"
}
],
"localeId": "string",
"resources": [
{
"displayAs": "string",
"itemId": "string",
"phrase": "string",
"weight": number
}
]
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [botId](#API_BatchDeleteCustomVocabularyItem_ResponseSyntax) **
The identifier of the bot associated with this custom vocabulary.
Type: String
Length Constraints: Fixed length of 10.
Pattern: `^[0-9a-zA-Z]+$`
** [botVersion](#API_BatchDeleteCustomVocabularyItem_ResponseSyntax) **
The identifier of the version of the bot associated with this custom vocabulary.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 5.
Pattern: `^(DRAFT|[0-9]+)$`
** [errors](#API_BatchDeleteCustomVocabularyItem_ResponseSyntax) **
A list of custom vocabulary items that failed to delete during the operation. The reason for the error is contained within each error object.
Type: Array of [FailedCustomVocabularyItem](API_FailedCustomVocabularyItem.md) objects
** [localeId](#API_BatchDeleteCustomVocabularyItem_ResponseSyntax) **
The identifier of the language and locale where this custom vocabulary is used. The string must match one of the supported locales. For more information, see Supported languages (https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html).
Type: String
** [resources](#API_BatchDeleteCustomVocabularyItem_ResponseSyntax) **
A list of custom vocabulary items that were successfully deleted during the operation.
Type: Array of [CustomVocabularyItem](API_CustomVocabularyItem.md) objects
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** InternalServerException **
The service encountered an unexpected condition. Try your request again.
HTTP Status Code: 500
** ResourceNotFoundException **
You asked to describe a resource that doesn't exist. Check the resource that you are requesting and try again.
HTTP Status Code: 404
** ServiceQuotaExceededException **
You have reached a quota for your bot.
HTTP Status Code: 402
** ThrottlingException **
Your request rate is too high. Reduce the frequency of requests.
** retryAfterSeconds **
The number of seconds after which the user can invoke the API again.
HTTP Status Code: 429
** ValidationException **
One of the input parameters in your request isn't valid. Check the parameters and try your request again.
HTTP Status Code: 400
## See Also
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/models.lex.v2-2020-08-07/BatchDeleteCustomVocabularyItem)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/models.lex.v2-2020-08-07/BatchDeleteCustomVocabularyItem)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/BatchDeleteCustomVocabularyItem)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/models.lex.v2-2020-08-07/BatchDeleteCustomVocabularyItem)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/BatchDeleteCustomVocabularyItem)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/models.lex.v2-2020-08-07/BatchDeleteCustomVocabularyItem)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/models.lex.v2-2020-08-07/BatchDeleteCustomVocabularyItem)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/models.lex.v2-2020-08-07/BatchDeleteCustomVocabularyItem)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/models.lex.v2-2020-08-07/BatchDeleteCustomVocabularyItem)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/BatchDeleteCustomVocabularyItem)
# BatchUpdateCustomVocabularyItem
Update a batch of custom vocabulary items for a given bot locale's custom vocabulary.
## Request Syntax
```
PUT /bots/botId/botversions/botVersion/botlocales/localeId/customvocabulary/DEFAULT/batchupdate HTTP/1.1
Content-type: application/json
{
"customVocabularyItemList": [
{
"displayAs": "string",
"itemId": "string",
"phrase": "string",
"weight": number
}
]
}
```
## URI Request Parameters
The request uses the following URI parameters.
** [botId](#API_BatchUpdateCustomVocabularyItem_RequestSyntax) **
The identifier of the bot associated with this custom vocabulary
Length Constraints: Fixed length of 10.
Pattern: `^[0-9a-zA-Z]+$`
Required: Yes
** [botVersion](#API_BatchUpdateCustomVocabularyItem_RequestSyntax) **
The identifier of the version of the bot associated with this custom vocabulary.
Length Constraints: Minimum length of 1. Maximum length of 5.
Pattern: `^(DRAFT|[0-9]+)$`
Required: Yes
** [localeId](#API_BatchUpdateCustomVocabularyItem_RequestSyntax) **
The identifier of the language and locale where this custom vocabulary is used. The string must match one of the supported locales. For more information, see [ Supported Languages ](https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html).
Required: Yes
## Request Body
The request accepts the following data in JSON format.
** [customVocabularyItemList](#API_BatchUpdateCustomVocabularyItem_RequestSyntax) **
A list of custom vocabulary items with updated fields. Each entry must contain a phrase and can optionally contain a displayAs and/or a weight.
Type: Array of [CustomVocabularyItem](API_CustomVocabularyItem.md) objects
Array Members: Minimum number of 1 item. Maximum number of 10 items.
Required: Yes
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"botId": "string",
"botVersion": "string",
"errors": [
{
"errorCode": "string",
"errorMessage": "string",
"itemId": "string"
}
],
"localeId": "string",
"resources": [
{
"displayAs": "string",
"itemId": "string",
"phrase": "string",
"weight": number
}
]
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [botId](#API_BatchUpdateCustomVocabularyItem_ResponseSyntax) **
The identifier of the bot associated with this custom vocabulary.
Type: String
Length Constraints: Fixed length of 10.
Pattern: `^[0-9a-zA-Z]+$`
** [botVersion](#API_BatchUpdateCustomVocabularyItem_ResponseSyntax) **
The identifier of the version of the bot associated with this custom vocabulary.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 5.
Pattern: `^(DRAFT|[0-9]+)$`
** [errors](#API_BatchUpdateCustomVocabularyItem_ResponseSyntax) **
A list of custom vocabulary items that failed to update during the operation. The reason for the error is contained within each error object.
Type: Array of [FailedCustomVocabularyItem](API_FailedCustomVocabularyItem.md) objects
** [localeId](#API_BatchUpdateCustomVocabularyItem_ResponseSyntax) **
The identifier of the language and locale where this custom vocabulary is used. The string must match one of the supported locales. For more information, see [ Supported Languages ](https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html).
Type: String
** [resources](#API_BatchUpdateCustomVocabularyItem_ResponseSyntax) **
A list of custom vocabulary items that were successfully updated during the operation.
Type: Array of [CustomVocabularyItem](API_CustomVocabularyItem.md) objects
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** InternalServerException **
The service encountered an unexpected condition. Try your request again.
HTTP Status Code: 500
** ResourceNotFoundException **
You asked to describe a resource that doesn't exist. Check the resource that you are requesting and try again.
HTTP Status Code: 404
** ServiceQuotaExceededException **
You have reached a quota for your bot.
HTTP Status Code: 402
** ThrottlingException **
Your request rate is too high. Reduce the frequency of requests.
** retryAfterSeconds **
The number of seconds after which the user can invoke the API again.
HTTP Status Code: 429
** ValidationException **
One of the input parameters in your request isn't valid. Check the parameters and try your request again.
HTTP Status Code: 400
## See Also
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/models.lex.v2-2020-08-07/BatchUpdateCustomVocabularyItem)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/models.lex.v2-2020-08-07/BatchUpdateCustomVocabularyItem)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/BatchUpdateCustomVocabularyItem)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/models.lex.v2-2020-08-07/BatchUpdateCustomVocabularyItem)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/BatchUpdateCustomVocabularyItem)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/models.lex.v2-2020-08-07/BatchUpdateCustomVocabularyItem)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/models.lex.v2-2020-08-07/BatchUpdateCustomVocabularyItem)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/models.lex.v2-2020-08-07/BatchUpdateCustomVocabularyItem)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/models.lex.v2-2020-08-07/BatchUpdateCustomVocabularyItem)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/BatchUpdateCustomVocabularyItem)
# BuildBotLocale
Builds a bot, its intents, and its slot types into a specific locale. A bot can be built into multiple locales. At runtime the locale is used to choose a specific build of the bot.
## Request Syntax
```
POST /bots/botId/botversions/botVersion/botlocales/localeId/ HTTP/1.1
```
## URI Request Parameters
The request uses the following URI parameters.
** [botId](#API_BuildBotLocale_RequestSyntax) **
The identifier of the bot to build. The identifier is returned in the response from the [CreateBot](https://docs.aws.amazon.com/lexv2/latest/APIReference/API_CreateBot.html) operation.
Length Constraints: Fixed length of 10.
Pattern: `^[0-9a-zA-Z]+$`
Required: Yes
** [botVersion](#API_BuildBotLocale_RequestSyntax) **
The version of the bot to build. This can only be the draft version of the bot.
Length Constraints: Fixed length of 5.
Pattern: `^DRAFT$`
Required: Yes
** [localeId](#API_BuildBotLocale_RequestSyntax) **
The identifier of the language and locale that the bot will be used in. The string must match one of the supported locales. All of the intents, slot types, and slots used in the bot must have the same locale. For more information, see [Supported languages](https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html).
Required: Yes
## Request Body
The request does not have a request body.
## Response Syntax
```
HTTP/1.1 202
Content-type: application/json
{
"botId": "string",
"botLocaleStatus": "string",
"botVersion": "string",
"lastBuildSubmittedDateTime": number,
"localeId": "string"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 202 response.
The following data is returned in JSON format by the service.
** [botId](#API_BuildBotLocale_ResponseSyntax) **
The identifier of the specified bot.
Type: String
Length Constraints: Fixed length of 10.
Pattern: `^[0-9a-zA-Z]+$`
** [botLocaleStatus](#API_BuildBotLocale_ResponseSyntax) **
The bot's build status. When the status is `ReadyExpressTesting` you can test the bot using the utterances defined for the intents and slot types. When the status is `Built`, the bot is ready for use and can be tested using any utterance.
Type: String
Valid Values: `Creating | Building | Built | ReadyExpressTesting | Failed | Deleting | NotBuilt | Importing | Processing`
** [botVersion](#API_BuildBotLocale_ResponseSyntax) **
The version of the bot that was built. This is only the draft version of the bot.
Type: String
Length Constraints: Fixed length of 5.
Pattern: `^DRAFT$`
** [lastBuildSubmittedDateTime](#API_BuildBotLocale_ResponseSyntax) **
A timestamp indicating the date and time that the bot was last built for this locale.
Type: Timestamp
** [localeId](#API_BuildBotLocale_ResponseSyntax) **
The language and locale specified of where the bot can be used.
Type: String
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** ConflictException **
The action that you tried to perform couldn't be completed because the resource is in a conflicting state. For example, deleting a bot that is in the CREATING state. Try your request again.
HTTP Status Code: 409
** InternalServerException **
The service encountered an unexpected condition. Try your request again.
HTTP Status Code: 500
** PreconditionFailedException **
Your request couldn't be completed because one or more request fields aren't valid. Check the fields in your request and try again.
HTTP Status Code: 412
** ServiceQuotaExceededException **
You have reached a quota for your bot.
HTTP Status Code: 402
** ThrottlingException **
Your request rate is too high. Reduce the frequency of requests.
** retryAfterSeconds **
The number of seconds after which the user can invoke the API again.
HTTP Status Code: 429
** ValidationException **
One of the input parameters in your request isn't valid. Check the parameters and try your request again.
HTTP Status Code: 400
## See Also
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/models.lex.v2-2020-08-07/BuildBotLocale)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/models.lex.v2-2020-08-07/BuildBotLocale)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/BuildBotLocale)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/models.lex.v2-2020-08-07/BuildBotLocale)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/BuildBotLocale)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/models.lex.v2-2020-08-07/BuildBotLocale)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/models.lex.v2-2020-08-07/BuildBotLocale)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/models.lex.v2-2020-08-07/BuildBotLocale)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/models.lex.v2-2020-08-07/BuildBotLocale)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/BuildBotLocale)
# CreateBot
Creates an Amazon Lex conversational bot.
## Request Syntax
```
PUT /bots/ HTTP/1.1
Content-type: application/json
{
"botMembers": [
{
"botMemberAliasId": "string",
"botMemberAliasName": "string",
"botMemberId": "string",
"botMemberName": "string",
"botMemberVersion": "string"
}
],
"botName": "string",
"botTags": {
"string" : "string"
},
"botType": "string",
"dataPrivacy": {
"childDirected": boolean
},
"description": "string",
"errorLogSettings": {
"enabled": boolean
},
"idleSessionTTLInSeconds": number,
"roleArn": "string",
"testBotAliasTags": {
"string" : "string"
}
}
```
## URI Request Parameters
The request does not use any URI parameters.
## Request Body
The request accepts the following data in JSON format.
** [botMembers](#API_CreateBot_RequestSyntax) **
The list of bot members in a network to be created.
Type: Array of [BotMember](API_BotMember.md) objects
Array Members: Minimum number of 0 items. Maximum number of 10 items.
Required: No
** [botName](#API_CreateBot_RequestSyntax) **
The name of the bot. The bot name must be unique in the account that creates the bot.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern: `^([0-9a-zA-Z][_-]?){1,100}$`
Required: Yes
** [botTags](#API_CreateBot_RequestSyntax) **
A list of tags to add to the bot. You can only add tags when you create a bot. You can't use the `UpdateBot` operation to update tags. To update tags, use the `TagResource` operation.
Type: String to string map
Map Entries: Minimum number of 0 items. Maximum number of 200 items.
Key Length Constraints: Minimum length of 1. Maximum length of 128.
Value Length Constraints: Minimum length of 0. Maximum length of 256.
Required: No
** [botType](#API_CreateBot_RequestSyntax) **
The type of a bot to create.
Type: String
Valid Values: `Bot | BotNetwork`
Required: No
** [dataPrivacy](#API_CreateBot_RequestSyntax) **
Provides information on additional privacy protections Amazon Lex should use with the bot's data.
Type: [DataPrivacy](API_DataPrivacy.md) object
Required: Yes
** [description](#API_CreateBot_RequestSyntax) **
A description of the bot. It appears in lists to help you identify a particular bot.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 2000.
Required: No
** [errorLogSettings](#API_CreateBot_RequestSyntax) **
Specifies the configuration for error logging during bot creation.
Type: [ErrorLogSettings](API_ErrorLogSettings.md) object
Required: No
** [idleSessionTTLInSeconds](#API_CreateBot_RequestSyntax) **
The time, in seconds, that Amazon Lex should keep information about a user's conversation with the bot.
A user interaction 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.
You can specify between 60 (1 minute) and 86,400 (24 hours) seconds.
Type: Integer
Valid Range: Minimum value of 60. Maximum value of 86400.
Required: Yes
** [roleArn](#API_CreateBot_RequestSyntax) **
The Amazon Resource Name (ARN) of an IAM role that has permission to access the bot.
Type: String
Length Constraints: Minimum length of 32. Maximum length of 2048.
Pattern: `^arn:aws:iam::[0-9]{12}:role/.*$`
Required: Yes
** [testBotAliasTags](#API_CreateBot_RequestSyntax) **
A list of tags to add to the test alias for a bot. You can only add tags when you create a bot. You can't use the `UpdateAlias` operation to update tags. To update tags on the test alias, use the `TagResource` operation.
Type: String to string map
Map Entries: Minimum number of 0 items. Maximum number of 200 items.
Key Length Constraints: Minimum length of 1. Maximum length of 128.
Value Length Constraints: Minimum length of 0. Maximum length of 256.
Required: No
## Response Syntax
```
HTTP/1.1 202
Content-type: application/json
{
"botId": "string",
"botMembers": [
{
"botMemberAliasId": "string",
"botMemberAliasName": "string",
"botMemberId": "string",
"botMemberName": "string",
"botMemberVersion": "string"
}
],
"botName": "string",
"botStatus": "string",
"botTags": {
"string" : "string"
},
"botType": "string",
"creationDateTime": number,
"dataPrivacy": {
"childDirected": boolean
},
"description": "string",
"errorLogSettings": {
"enabled": boolean
},
"idleSessionTTLInSeconds": number,
"roleArn": "string",
"testBotAliasTags": {
"string" : "string"
}
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 202 response.
The following data is returned in JSON format by the service.
** [botId](#API_CreateBot_ResponseSyntax) **
A unique identifier for a particular bot. You use this to identify the bot when you call other Amazon Lex API operations.
Type: String
Length Constraints: Fixed length of 10.
Pattern: `^[0-9a-zA-Z]+$`
** [botMembers](#API_CreateBot_ResponseSyntax) **
The list of bots in a network that was created.
Type: Array of [BotMember](API_BotMember.md) objects
Array Members: Minimum number of 0 items. Maximum number of 10 items.
** [botName](#API_CreateBot_ResponseSyntax) **
The name specified for the bot.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern: `^([0-9a-zA-Z][_-]?){1,100}$`
** [botStatus](#API_CreateBot_ResponseSyntax) **
Shows the current status of the bot. The bot is first in the `Creating` status. Once the bot is read for use, it changes to the `Available` status. After the bot is created, you can use the `DRAFT` version of the bot.
Type: String
Valid Values: `Creating | Available | Inactive | Deleting | Failed | Versioning | Importing | Updating`
** [botTags](#API_CreateBot_ResponseSyntax) **
A list of tags associated with the bot.
Type: String to string map
Map Entries: Minimum number of 0 items. Maximum number of 200 items.
Key Length Constraints: Minimum length of 1. Maximum length of 128.
Value Length Constraints: Minimum length of 0. Maximum length of 256.
** [botType](#API_CreateBot_ResponseSyntax) **
The type of a bot that was created.
Type: String
Valid Values: `Bot | BotNetwork`
** [creationDateTime](#API_CreateBot_ResponseSyntax) **
A timestamp indicating the date and time that the bot was created.
Type: Timestamp
** [dataPrivacy](#API_CreateBot_ResponseSyntax) **
The data privacy settings specified for the bot.
Type: [DataPrivacy](API_DataPrivacy.md) object
** [description](#API_CreateBot_ResponseSyntax) **
The description specified for the bot.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 2000.
** [errorLogSettings](#API_CreateBot_ResponseSyntax) **
Specifies configuration settings for delivering error logs to Cloudwatch Logs in an Amazon Lex bot response.
Type: [ErrorLogSettings](API_ErrorLogSettings.md) object
** [idleSessionTTLInSeconds](#API_CreateBot_ResponseSyntax) **
The session idle time specified for the bot.
Type: Integer
Valid Range: Minimum value of 60. Maximum value of 86400.
** [roleArn](#API_CreateBot_ResponseSyntax) **
The IAM role specified for the bot.
Type: String
Length Constraints: Minimum length of 32. Maximum length of 2048.
Pattern: `^arn:aws:iam::[0-9]{12}:role/.*$`
** [testBotAliasTags](#API_CreateBot_ResponseSyntax) **
A list of tags associated with the test alias for the bot.
Type: String to string map
Map Entries: Minimum number of 0 items. Maximum number of 200 items.
Key Length Constraints: Minimum length of 1. Maximum length of 128.
Value Length Constraints: Minimum length of 0. Maximum length of 256.
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** ConflictException **
The action that you tried to perform couldn't be completed because the resource is in a conflicting state. For example, deleting a bot that is in the CREATING state. Try your request again.
HTTP Status Code: 409
** InternalServerException **
The service encountered an unexpected condition. Try your request again.
HTTP Status Code: 500
** PreconditionFailedException **
Your request couldn't be completed because one or more request fields aren't valid. Check the fields in your request and try again.
HTTP Status Code: 412
** ServiceQuotaExceededException **
You have reached a quota for your bot.
HTTP Status Code: 402
** ThrottlingException **
Your request rate is too high. Reduce the frequency of requests.
** retryAfterSeconds **
The number of seconds after which the user can invoke the API again.
HTTP Status Code: 429
** ValidationException **
One of the input parameters in your request isn't valid. Check the parameters and try your request again.
HTTP Status Code: 400
## See Also
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/models.lex.v2-2020-08-07/CreateBot)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/models.lex.v2-2020-08-07/CreateBot)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/CreateBot)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/models.lex.v2-2020-08-07/CreateBot)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/CreateBot)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/models.lex.v2-2020-08-07/CreateBot)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/models.lex.v2-2020-08-07/CreateBot)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/models.lex.v2-2020-08-07/CreateBot)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/models.lex.v2-2020-08-07/CreateBot)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/CreateBot)
# CreateBotAlias
Creates an alias for the specified version of a bot. Use an alias to enable you to change the version of a bot without updating applications that use the bot.
For example, you can create an alias called "PROD" that your applications use to call the Amazon Lex bot.
## Request Syntax
```
PUT /bots/botId/botaliases/ HTTP/1.1
Content-type: application/json
{
"botAliasLocaleSettings": {
"string" : {
"codeHookSpecification": {
"lambdaCodeHook": {
"codeHookInterfaceVersion": "string",
"lambdaARN": "string"
}
},
"enabled": boolean
}
},
"botAliasName": "string",
"botVersion": "string",
"conversationLogSettings": {
"audioLogSettings": [
{
"destination": {
"s3Bucket": {
"kmsKeyArn": "string",
"logPrefix": "string",
"s3BucketArn": "string"
}
},
"enabled": boolean,
"selectiveLoggingEnabled": boolean
}
],
"textLogSettings": [
{
"destination": {
"cloudWatch": {
"cloudWatchLogGroupArn": "string",
"logPrefix": "string"
}
},
"enabled": boolean,
"selectiveLoggingEnabled": boolean
}
]
},
"description": "string",
"sentimentAnalysisSettings": {
"detectSentiment": boolean
},
"tags": {
"string" : "string"
}
}
```
## URI Request Parameters
The request uses the following URI parameters.
** [botId](#API_CreateBotAlias_RequestSyntax) **
The unique identifier of the bot that the alias applies to.
Length Constraints: Fixed length of 10.
Pattern: `^[0-9a-zA-Z]+$`
Required: Yes
## Request Body
The request accepts the following data in JSON format.
** [botAliasLocaleSettings](#API_CreateBotAlias_RequestSyntax) **
Maps configuration information to a specific locale. You can use this parameter to specify a specific Lambda function to run different functions in different locales.
Type: String to [BotAliasLocaleSettings](API_BotAliasLocaleSettings.md) object map
Map Entries: Maximum number of items.
Required: No
** [botAliasName](#API_CreateBotAlias_RequestSyntax) **
The alias to create. The name must be unique for the bot.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern: `^([0-9a-zA-Z][_-]?){1,100}$`
Required: Yes
** [botVersion](#API_CreateBotAlias_RequestSyntax) **
The version of the bot that this alias points to. You can use the [UpdateBotAlias](https://docs.aws.amazon.com/lexv2/latest/APIReference/API_UpdateBotAlias.html) operation to change the bot version associated with the alias.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 5.
Pattern: `^[0-9]+$`
Required: No
** [conversationLogSettings](#API_CreateBotAlias_RequestSyntax) **
Specifies whether Amazon Lex logs text and audio for a conversation with the bot. When you enable conversation logs, text logs store text input, transcripts of audio input, and associated metadata in Amazon CloudWatch Logs. Audio logs store audio input in Amazon S3.
Type: [ConversationLogSettings](API_ConversationLogSettings.md) object
Required: No
** [description](#API_CreateBotAlias_RequestSyntax) **
A description of the alias. Use this description to help identify the alias.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 2000.
Required: No
** [sentimentAnalysisSettings](#API_CreateBotAlias_RequestSyntax) **
Determines whether Amazon Lex will use Amazon Comprehend to detect the sentiment of user utterances.
Type: [SentimentAnalysisSettings](API_SentimentAnalysisSettings.md) object
Required: No
** [tags](#API_CreateBotAlias_RequestSyntax) **
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 `UpdateBotAlias` operation to update the tags on a bot alias. To update tags, use the `TagResource` operation.
Type: String to string map
Map Entries: Minimum number of 0 items. Maximum number of 200 items.
Key Length Constraints: Minimum length of 1. Maximum length of 128.
Value Length Constraints: Minimum length of 0. Maximum length of 256.
Required: No
## Response Syntax
```
HTTP/1.1 202
Content-type: application/json
{
"botAliasId": "string",
"botAliasLocaleSettings": {
"string" : {
"codeHookSpecification": {
"lambdaCodeHook": {
"codeHookInterfaceVersion": "string",
"lambdaARN": "string"
}
},
"enabled": boolean
}
},
"botAliasName": "string",
"botAliasStatus": "string",
"botId": "string",
"botVersion": "string",
"conversationLogSettings": {
"audioLogSettings": [
{
"destination": {
"s3Bucket": {
"kmsKeyArn": "string",
"logPrefix": "string",
"s3BucketArn": "string"
}
},
"enabled": boolean,
"selectiveLoggingEnabled": boolean
}
],
"textLogSettings": [
{
"destination": {
"cloudWatch": {
"cloudWatchLogGroupArn": "string",
"logPrefix": "string"
}
},
"enabled": boolean,
"selectiveLoggingEnabled": boolean
}
]
},
"creationDateTime": number,
"description": "string",
"sentimentAnalysisSettings": {
"detectSentiment": boolean
},
"tags": {
"string" : "string"
}
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 202 response.
The following data is returned in JSON format by the service.
** [botAliasId](#API_CreateBotAlias_ResponseSyntax) **
The unique identifier of the bot alias.
Type: String
Length Constraints: Fixed length of 10.
Pattern: `^(\bTSTALIASID\b|[0-9a-zA-Z]+)$`
** [botAliasLocaleSettings](#API_CreateBotAlias_ResponseSyntax) **
Configuration information for a specific locale.
Type: String to [BotAliasLocaleSettings](API_BotAliasLocaleSettings.md) object map
Map Entries: Maximum number of items.
** [botAliasName](#API_CreateBotAlias_ResponseSyntax) **
The name specified for the bot alias.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern: `^([0-9a-zA-Z][_-]?){1,100}$`
** [botAliasStatus](#API_CreateBotAlias_ResponseSyntax) **
The current status of the alias. The alias is first put into the `Creating` state. When the alias is ready to be used, it is put into the `Available` state. You can use the `DescribeBotAlias` operation to get the current state of an alias.
Type: String
Valid Values: `Creating | Available | Deleting | Failed`
** [botId](#API_CreateBotAlias_ResponseSyntax) **
The unique identifier of the bot that this alias applies to.
Type: String
Length Constraints: Fixed length of 10.
Pattern: `^[0-9a-zA-Z]+$`
** [botVersion](#API_CreateBotAlias_ResponseSyntax) **
The version of the bot associated with this alias.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 5.
Pattern: `^[0-9]+$`
** [conversationLogSettings](#API_CreateBotAlias_ResponseSyntax) **
The conversation log settings specified for the alias.
Type: [ConversationLogSettings](API_ConversationLogSettings.md) object
** [creationDateTime](#API_CreateBotAlias_ResponseSyntax) **
A Unix timestamp indicating the date and time that the bot alias was created.
Type: Timestamp
** [description](#API_CreateBotAlias_ResponseSyntax) **
The description specified for the bot alias.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 2000.
** [sentimentAnalysisSettings](#API_CreateBotAlias_ResponseSyntax) **
Determines whether Amazon Lex will use Amazon Comprehend to detect the sentiment of user utterances.
Type: [SentimentAnalysisSettings](API_SentimentAnalysisSettings.md) object
** [tags](#API_CreateBotAlias_ResponseSyntax) **
A list of tags associated with the bot alias.
Type: String to string map
Map Entries: Minimum number of 0 items. Maximum number of 200 items.
Key Length Constraints: Minimum length of 1. Maximum length of 128.
Value Length Constraints: Minimum length of 0. Maximum length of 256.
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** ConflictException **
The action that you tried to perform couldn't be completed because the resource is in a conflicting state. For example, deleting a bot that is in the CREATING state. Try your request again.
HTTP Status Code: 409
** InternalServerException **
The service encountered an unexpected condition. Try your request again.
HTTP Status Code: 500
** PreconditionFailedException **
Your request couldn't be completed because one or more request fields aren't valid. Check the fields in your request and try again.
HTTP Status Code: 412
** ServiceQuotaExceededException **
You have reached a quota for your bot.
HTTP Status Code: 402
** ThrottlingException **
Your request rate is too high. Reduce the frequency of requests.
** retryAfterSeconds **
The number of seconds after which the user can invoke the API again.
HTTP Status Code: 429
** ValidationException **
One of the input parameters in your request isn't valid. Check the parameters and try your request again.
HTTP Status Code: 400
## See Also
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/models.lex.v2-2020-08-07/CreateBotAlias)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/models.lex.v2-2020-08-07/CreateBotAlias)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/CreateBotAlias)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/models.lex.v2-2020-08-07/CreateBotAlias)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/CreateBotAlias)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/models.lex.v2-2020-08-07/CreateBotAlias)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/models.lex.v2-2020-08-07/CreateBotAlias)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/models.lex.v2-2020-08-07/CreateBotAlias)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/models.lex.v2-2020-08-07/CreateBotAlias)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/CreateBotAlias)
# CreateBotLocale
Creates a locale in the bot. The locale contains the intents and slot types that the bot uses in conversations with users in the specified language and locale. You must add a locale to a bot before you can add intents and slot types to the bot.
## Request Syntax
```
PUT /bots/botId/botversions/botVersion/botlocales/ HTTP/1.1
Content-type: application/json
{
"description": "string",
"generativeAISettings": {
"buildtimeSettings": {
"descriptiveBotBuilder": {
"bedrockModelSpecification": {
"customPrompt": "string",
"guardrail": {
"identifier": "string",
"version": "string"
},
"modelArn": "string",
"traceStatus": "string"
},
"enabled": boolean
},
"sampleUtteranceGeneration": {
"bedrockModelSpecification": {
"customPrompt": "string",
"guardrail": {
"identifier": "string",
"version": "string"
},
"modelArn": "string",
"traceStatus": "string"
},
"enabled": boolean
}
},
"runtimeSettings": {
"nluImprovement": {
"assistedNluMode": "string",
"enabled": boolean,
"intentDisambiguationSettings": {
"customDisambiguationMessage": "string",
"enabled": boolean,
"maxDisambiguationIntents": number
}
},
"slotResolutionImprovement": {
"bedrockModelSpecification": {
"customPrompt": "string",
"guardrail": {
"identifier": "string",
"version": "string"
},
"modelArn": "string",
"traceStatus": "string"
},
"enabled": boolean
}
}
},
"localeId": "string",
"nluIntentConfidenceThreshold": number,
"speechDetectionSensitivity": "string",
"speechRecognitionSettings": {
"speechModelConfig": {
"deepgramConfig": {
"apiTokenSecretArn": "string",
"modelId": "string"
}
},
"speechModelPreference": "string"
},
"unifiedSpeechSettings": {
"speechFoundationModel": {
"modelArn": "string",
"voiceId": "string"
}
},
"voiceSettings": {
"engine": "string",
"voiceId": "string"
}
}
```
## URI Request Parameters
The request uses the following URI parameters.
** [botId](#API_CreateBotLocale_RequestSyntax) **
The identifier of the bot to create the locale for.
Length Constraints: Fixed length of 10.
Pattern: `^[0-9a-zA-Z]+$`
Required: Yes
** [botVersion](#API_CreateBotLocale_RequestSyntax) **
The version of the bot to create the locale for. This can only be the draft version of the bot.
Length Constraints: Fixed length of 5.
Pattern: `^DRAFT$`
Required: Yes
## Request Body
The request accepts the following data in JSON format.
** [description](#API_CreateBotLocale_RequestSyntax) **
A description of the bot locale. Use this to help identify the bot locale in lists.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 2000.
Required: No
** [generativeAISettings](#API_CreateBotLocale_RequestSyntax) **
Contains specifications about the generative AI capabilities from Amazon Bedrock that you can turn on for your bot.
Type: [GenerativeAISettings](API_GenerativeAISettings.md) object
Required: No
** [localeId](#API_CreateBotLocale_RequestSyntax) **
The identifier of the language and locale that the bot will be used in. The string must match one of the supported locales. All of the intents, slot types, and slots used in the bot must have the same locale. For more information, see [Supported languages](https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html).
Type: String
Required: Yes
** [nluIntentConfidenceThreshold](#API_CreateBotLocale_RequestSyntax) **
Determines the threshold where Amazon Lex will insert the `AMAZON.FallbackIntent`, `AMAZON.KendraSearchIntent`, or both when returning alternative intents. `AMAZON.FallbackIntent` and `AMAZON.KendraSearchIntent` are only inserted if they are configured for the bot.
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 `RecognizeText` operation would be:
+ AMAZON.FallbackIntent
+ IntentA
+ IntentB
+ IntentC
Type: Double
Valid Range: Minimum value of 0. Maximum value of 1.
Required: Yes
** [speechDetectionSensitivity](#API_CreateBotLocale_RequestSyntax) **
The sensitivity level for voice activity detection (VAD) in the bot locale. This setting helps optimize speech recognition accuracy by adjusting how the system responds to background noise during voice interactions.
Type: String
Valid Values: `Default | HighNoiseTolerance | MaximumNoiseTolerance`
Required: No
** [speechRecognitionSettings](#API_CreateBotLocale_RequestSyntax) **
Speech-to-text settings to configure for the new bot locale.
Type: [SpeechRecognitionSettings](API_SpeechRecognitionSettings.md) object
Required: No
** [unifiedSpeechSettings](#API_CreateBotLocale_RequestSyntax) **
Unified speech settings to configure for the new bot locale.
Type: [UnifiedSpeechSettings](API_UnifiedSpeechSettings.md) object
Required: No
** [voiceSettings](#API_CreateBotLocale_RequestSyntax) **
The Amazon Polly voice ID that Amazon Lex uses for voice interaction with the user.
Type: [VoiceSettings](API_VoiceSettings.md) object
Required: No
## Response Syntax
```
HTTP/1.1 202
Content-type: application/json
{
"botId": "string",
"botLocaleStatus": "string",
"botVersion": "string",
"creationDateTime": number,
"description": "string",
"generativeAISettings": {
"buildtimeSettings": {
"descriptiveBotBuilder": {
"bedrockModelSpecification": {
"customPrompt": "string",
"guardrail": {
"identifier": "string",
"version": "string"
},
"modelArn": "string",
"traceStatus": "string"
},
"enabled": boolean
},
"sampleUtteranceGeneration": {
"bedrockModelSpecification": {
"customPrompt": "string",
"guardrail": {
"identifier": "string",
"version": "string"
},
"modelArn": "string",
"traceStatus": "string"
},
"enabled": boolean
}
},
"runtimeSettings": {
"nluImprovement": {
"assistedNluMode": "string",
"enabled": boolean,
"intentDisambiguationSettings": {
"customDisambiguationMessage": "string",
"enabled": boolean,
"maxDisambiguationIntents": number
}
},
"slotResolutionImprovement": {
"bedrockModelSpecification": {
"customPrompt": "string",
"guardrail": {
"identifier": "string",
"version": "string"
},
"modelArn": "string",
"traceStatus": "string"
},
"enabled": boolean
}
}
},
"localeId": "string",
"localeName": "string",
"nluIntentConfidenceThreshold": number,
"speechDetectionSensitivity": "string",
"speechRecognitionSettings": {
"speechModelConfig": {
"deepgramConfig": {
"apiTokenSecretArn": "string",
"modelId": "string"
}
},
"speechModelPreference": "string"
},
"unifiedSpeechSettings": {
"speechFoundationModel": {
"modelArn": "string",
"voiceId": "string"
}
},
"voiceSettings": {
"engine": "string",
"voiceId": "string"
}
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 202 response.
The following data is returned in JSON format by the service.
** [botId](#API_CreateBotLocale_ResponseSyntax) **
The specified bot identifier.
Type: String
Length Constraints: Fixed length of 10.
Pattern: `^[0-9a-zA-Z]+$`
** [botLocaleStatus](#API_CreateBotLocale_ResponseSyntax) **
The status of the bot.
When the status is `Creating` the bot locale is being configured. When the status is `Building` Amazon Lex is building the bot for testing and use.
If the status of the bot is `ReadyExpressTesting`, you can test the bot using the exact utterances specified in the bots' intents. When the bot is ready for full testing or to run, the status is `Built`.
If there was a problem with building the bot, the status is `Failed`. If the bot was saved but not built, the status is `NotBuilt`.
Type: String
Valid Values: `Creating | Building | Built | ReadyExpressTesting | Failed | Deleting | NotBuilt | Importing | Processing`
** [botVersion](#API_CreateBotLocale_ResponseSyntax) **
The specified bot version.
Type: String
Length Constraints: Fixed length of 5.
Pattern: `^DRAFT$`
** [creationDateTime](#API_CreateBotLocale_ResponseSyntax) **
A timestamp specifying the date and time that the bot locale was created.
Type: Timestamp
** [description](#API_CreateBotLocale_ResponseSyntax) **
The specified description of the bot locale.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 2000.
** [generativeAISettings](#API_CreateBotLocale_ResponseSyntax) **
Contains specifications about the generative AI capabilities from Amazon Bedrock that you can turn on for your bot.
Type: [GenerativeAISettings](API_GenerativeAISettings.md) object
** [localeId](#API_CreateBotLocale_ResponseSyntax) **
The specified locale identifier.
Type: String
** [localeName](#API_CreateBotLocale_ResponseSyntax) **
The specified locale name.
Type: String
** [nluIntentConfidenceThreshold](#API_CreateBotLocale_ResponseSyntax) **
The specified confidence threshold for inserting the `AMAZON.FallbackIntent` and `AMAZON.KendraSearchIntent` intents.
Type: Double
Valid Range: Minimum value of 0. Maximum value of 1.
** [speechDetectionSensitivity](#API_CreateBotLocale_ResponseSyntax) **
The sensitivity level for voice activity detection (VAD) that was specified for the bot locale.
Type: String
Valid Values: `Default | HighNoiseTolerance | MaximumNoiseTolerance`
** [speechRecognitionSettings](#API_CreateBotLocale_ResponseSyntax) **
The speech-to-text settings configured for the created bot locale.
Type: [SpeechRecognitionSettings](API_SpeechRecognitionSettings.md) object
** [unifiedSpeechSettings](#API_CreateBotLocale_ResponseSyntax) **
The unified speech settings configured for the created bot locale.
Type: [UnifiedSpeechSettings](API_UnifiedSpeechSettings.md) object
** [voiceSettings](#API_CreateBotLocale_ResponseSyntax) **
The Amazon Polly voice ID that Amazon Lex uses for voice interaction with the user.
Type: [VoiceSettings](API_VoiceSettings.md) object
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** ConflictException **
The action that you tried to perform couldn't be completed because the resource is in a conflicting state. For example, deleting a bot that is in the CREATING state. Try your request again.
HTTP Status Code: 409
** InternalServerException **
The service encountered an unexpected condition. Try your request again.
HTTP Status Code: 500
** PreconditionFailedException **
Your request couldn't be completed because one or more request fields aren't valid. Check the fields in your request and try again.
HTTP Status Code: 412
** ServiceQuotaExceededException **
You have reached a quota for your bot.
HTTP Status Code: 402
** ThrottlingException **
Your request rate is too high. Reduce the frequency of requests.
** retryAfterSeconds **
The number of seconds after which the user can invoke the API again.
HTTP Status Code: 429
** ValidationException **
One of the input parameters in your request isn't valid. Check the parameters and try your request again.
HTTP Status Code: 400
## See Also
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/models.lex.v2-2020-08-07/CreateBotLocale)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/models.lex.v2-2020-08-07/CreateBotLocale)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/CreateBotLocale)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/models.lex.v2-2020-08-07/CreateBotLocale)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/CreateBotLocale)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/models.lex.v2-2020-08-07/CreateBotLocale)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/models.lex.v2-2020-08-07/CreateBotLocale)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/models.lex.v2-2020-08-07/CreateBotLocale)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/models.lex.v2-2020-08-07/CreateBotLocale)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/CreateBotLocale)
# CreateBotReplica
Action to create a replication of the source bot in the secondary region.
## Request Syntax
```
PUT /bots/botId/replicas/ HTTP/1.1
Content-type: application/json
{
"replicaRegion": "string"
}
```
## URI Request Parameters
The request uses the following URI parameters.
** [botId](#API_CreateBotReplica_RequestSyntax) **
The request for the unique bot ID of the source bot to be replicated in the secondary region.
Length Constraints: Fixed length of 10.
Pattern: `^[0-9a-zA-Z]+$`
Required: Yes
## Request Body
The request accepts the following data in JSON format.
** [replicaRegion](#API_CreateBotReplica_RequestSyntax) **
The request for the secondary region that will be used in the replication of the source bot.
Type: String
Length Constraints: Minimum length of 2. Maximum length of 25.
Required: Yes
## Response Syntax
```
HTTP/1.1 202
Content-type: application/json
{
"botId": "string",
"botReplicaStatus": "string",
"creationDateTime": number,
"replicaRegion": "string",
"sourceRegion": "string"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 202 response.
The following data is returned in JSON format by the service.
** [botId](#API_CreateBotReplica_ResponseSyntax) **
The unique bot ID of the replicated bot generated.
Type: String
Length Constraints: Fixed length of 10.
Pattern: `^[0-9a-zA-Z]+$`
** [botReplicaStatus](#API_CreateBotReplica_ResponseSyntax) **
The operational status of the replicated bot generated.
Type: String
Valid Values: `Enabling | Enabled | Deleting | Failed`
** [creationDateTime](#API_CreateBotReplica_ResponseSyntax) **
The creation date and time of the replicated bot generated.
Type: Timestamp
** [replicaRegion](#API_CreateBotReplica_ResponseSyntax) **
The region of the replicated bot generated.
Type: String
Length Constraints: Minimum length of 2. Maximum length of 25.
** [sourceRegion](#API_CreateBotReplica_ResponseSyntax) **
The source region for the source bot used for the replicated bot generated.
Type: String
Length Constraints: Minimum length of 2. Maximum length of 25.
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** ConflictException **
The action that you tried to perform couldn't be completed because the resource is in a conflicting state. For example, deleting a bot that is in the CREATING state. Try your request again.
HTTP Status Code: 409
** InternalServerException **
The service encountered an unexpected condition. Try your request again.
HTTP Status Code: 500
** PreconditionFailedException **
Your request couldn't be completed because one or more request fields aren't valid. Check the fields in your request and try again.
HTTP Status Code: 412
** ServiceQuotaExceededException **
You have reached a quota for your bot.
HTTP Status Code: 402
** ThrottlingException **
Your request rate is too high. Reduce the frequency of requests.
** retryAfterSeconds **
The number of seconds after which the user can invoke the API again.
HTTP Status Code: 429
** ValidationException **
One of the input parameters in your request isn't valid. Check the parameters and try your request again.
HTTP Status Code: 400
## Examples
### This example illustrates one example input of CreateBotReplica.
This example illustrates one usage of CreateBotReplica.
```
PUT https://models-v2-lex.us-east-1.amazonaws.com/bots/BOT1234567/replicas
{
"replicaRegion": "us-west-2"
}
```
### This example illustrates one example response of CreateBotReplica.
This example illustrates one usage of CreateBotReplica.
```
{
"botId": "BOT1234567",
"botReplicaStatus": "Enabling",
"creationDateTime": 1.706821927957E9,
"replicaRegion": "us-west-2",
"sourceRegion": "us-east-1"
}
```
## See Also
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/models.lex.v2-2020-08-07/CreateBotReplica)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/models.lex.v2-2020-08-07/CreateBotReplica)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/CreateBotReplica)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/models.lex.v2-2020-08-07/CreateBotReplica)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/CreateBotReplica)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/models.lex.v2-2020-08-07/CreateBotReplica)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/models.lex.v2-2020-08-07/CreateBotReplica)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/models.lex.v2-2020-08-07/CreateBotReplica)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/models.lex.v2-2020-08-07/CreateBotReplica)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/CreateBotReplica)
# CreateBotVersion
Creates an immutable version of the bot. When you create the first version of a bot, Amazon Lex sets the version number to 1. Subsequent bot versions increase in an increment of 1. The version number will always represent the total number of versions created of the bot, not the current number of versions. If a bot version is deleted, that bot version number will not be reused.
## Request Syntax
```
PUT /bots/botId/botversions/ HTTP/1.1
Content-type: application/json
{
"botVersionLocaleSpecification": {
"string" : {
"sourceBotVersion": "string"
}
},
"description": "string"
}
```
## URI Request Parameters
The request uses the following URI parameters.
** [botId](#API_CreateBotVersion_RequestSyntax) **
The identifier of the bot to create the version for.
Length Constraints: Fixed length of 10.
Pattern: `^[0-9a-zA-Z]+$`
Required: Yes
## Request Body
The request accepts the following data in JSON format.
** [botVersionLocaleSpecification](#API_CreateBotVersion_RequestSyntax) **
Specifies the locales that Amazon Lex adds to this version. You can choose the `Draft` version or any other previously published version for each locale. When you specify a source version, the locale data is copied from the source version to the new version.
Type: String to [BotVersionLocaleDetails](API_BotVersionLocaleDetails.md) object map
Map Entries: Maximum number of items.
Required: Yes
** [description](#API_CreateBotVersion_RequestSyntax) **
A description of the version. Use the description to help identify the version in lists.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 2000.
Required: No
## Response Syntax
```
HTTP/1.1 202
Content-type: application/json
{
"botId": "string",
"botStatus": "string",
"botVersion": "string",
"botVersionLocaleSpecification": {
"string" : {
"sourceBotVersion": "string"
}
},
"creationDateTime": number,
"description": "string"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 202 response.
The following data is returned in JSON format by the service.
** [botId](#API_CreateBotVersion_ResponseSyntax) **
The bot identifier specified in the request.
Type: String
Length Constraints: Fixed length of 10.
Pattern: `^[0-9a-zA-Z]+$`
** [botStatus](#API_CreateBotVersion_ResponseSyntax) **
When you send a request to create or update a bot, Amazon Lex sets the status response element to `Creating`. After Amazon Lex builds the bot, it sets status to `Available`. If Amazon Lex can't build the bot, it sets status to `Failed`.
Type: String
Valid Values: `Creating | Available | Inactive | Deleting | Failed | Versioning | Importing | Updating`
** [botVersion](#API_CreateBotVersion_ResponseSyntax) **
The version number assigned to the version.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 5.
Pattern: `^[0-9]+$`
** [botVersionLocaleSpecification](#API_CreateBotVersion_ResponseSyntax) **
The source versions used for each locale in the new version.
Type: String to [BotVersionLocaleDetails](API_BotVersionLocaleDetails.md) object map
Map Entries: Maximum number of items.
** [creationDateTime](#API_CreateBotVersion_ResponseSyntax) **
A timestamp of the date and time that the version was created.
Type: Timestamp
** [description](#API_CreateBotVersion_ResponseSyntax) **
The description of the version specified in the request.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 2000.
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** ConflictException **
The action that you tried to perform couldn't be completed because the resource is in a conflicting state. For example, deleting a bot that is in the CREATING state. Try your request again.
HTTP Status Code: 409
** InternalServerException **
The service encountered an unexpected condition. Try your request again.
HTTP Status Code: 500
** PreconditionFailedException **
Your request couldn't be completed because one or more request fields aren't valid. Check the fields in your request and try again.
HTTP Status Code: 412
** ServiceQuotaExceededException **
You have reached a quota for your bot.
HTTP Status Code: 402
** ThrottlingException **
Your request rate is too high. Reduce the frequency of requests.
** retryAfterSeconds **
The number of seconds after which the user can invoke the API again.
HTTP Status Code: 429
** ValidationException **
One of the input parameters in your request isn't valid. Check the parameters and try your request again.
HTTP Status Code: 400
## See Also
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/models.lex.v2-2020-08-07/CreateBotVersion)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/models.lex.v2-2020-08-07/CreateBotVersion)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/CreateBotVersion)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/models.lex.v2-2020-08-07/CreateBotVersion)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/CreateBotVersion)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/models.lex.v2-2020-08-07/CreateBotVersion)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/models.lex.v2-2020-08-07/CreateBotVersion)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/models.lex.v2-2020-08-07/CreateBotVersion)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/models.lex.v2-2020-08-07/CreateBotVersion)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/CreateBotVersion)
# CreateExport
Creates a zip archive containing the contents of a bot or a bot locale. The archive contains a directory structure that contains JSON files that define the bot.
You can create an archive that contains the complete definition of a bot, or you can specify that the archive contain only the definition of a single bot locale.
For more information about exporting bots, and about the structure of the export archive, see [ Importing and exporting bots ](https://docs.aws.amazon.com/lexv2/latest/dg/importing-exporting.html)
## Request Syntax
```
PUT /exports/ HTTP/1.1
Content-type: application/json
{
"fileFormat": "string",
"filePassword": "string",
"resourceSpecification": {
"botExportSpecification": {
"botId": "string",
"botVersion": "string"
},
"botLocaleExportSpecification": {
"botId": "string",
"botVersion": "string",
"localeId": "string"
},
"customVocabularyExportSpecification": {
"botId": "string",
"botVersion": "string",
"localeId": "string"
},
"testSetExportSpecification": {
"testSetId": "string"
}
}
}
```
## URI Request Parameters
The request does not use any URI parameters.
## Request Body
The request accepts the following data in JSON format.
** [fileFormat](#API_CreateExport_RequestSyntax) **
The file format of the bot or bot locale definition files.
Type: String
Valid Values: `LexJson | TSV | CSV`
Required: Yes
** [filePassword](#API_CreateExport_RequestSyntax) **
An password to use to encrypt the exported archive. Using a password is optional, but you should encrypt the archive to protect the data in transit between Amazon Lex and your local computer.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Required: No
** [resourceSpecification](#API_CreateExport_RequestSyntax) **
Specifies the type of resource to export, either a bot or a bot locale. You can only specify one type of resource to export.
Type: [ExportResourceSpecification](API_ExportResourceSpecification.md) object
Required: Yes
## Response Syntax
```
HTTP/1.1 202
Content-type: application/json
{
"creationDateTime": number,
"exportId": "string",
"exportStatus": "string",
"fileFormat": "string",
"resourceSpecification": {
"botExportSpecification": {
"botId": "string",
"botVersion": "string"
},
"botLocaleExportSpecification": {
"botId": "string",
"botVersion": "string",
"localeId": "string"
},
"customVocabularyExportSpecification": {
"botId": "string",
"botVersion": "string",
"localeId": "string"
},
"testSetExportSpecification": {
"testSetId": "string"
}
}
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 202 response.
The following data is returned in JSON format by the service.
** [creationDateTime](#API_CreateExport_ResponseSyntax) **
The date and time that the request to export a bot was created.
Type: Timestamp
** [exportId](#API_CreateExport_ResponseSyntax) **
An identifier for a specific request to create an export.
Type: String
Length Constraints: Fixed length of 10.
Pattern: `^[0-9a-zA-Z]+$`
** [exportStatus](#API_CreateExport_ResponseSyntax) **
The status of the export. When the status is `Completed`, you can use the [DescribeExport](https://docs.aws.amazon.com/lexv2/latest/APIReference/API_DescribeExport.html) operation to get the pre-signed S3 URL link to your exported bot or bot locale.
Type: String
Valid Values: `InProgress | Completed | Failed | Deleting`
** [fileFormat](#API_CreateExport_ResponseSyntax) **
The file format used for the bot or bot locale definition files.
Type: String
Valid Values: `LexJson | TSV | CSV`
** [resourceSpecification](#API_CreateExport_ResponseSyntax) **
A description of the type of resource that was exported, either a bot or a bot locale.
Type: [ExportResourceSpecification](API_ExportResourceSpecification.md) object
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** ConflictException **
The action that you tried to perform couldn't be completed because the resource is in a conflicting state. For example, deleting a bot that is in the CREATING state. Try your request again.
HTTP Status Code: 409
** InternalServerException **
The service encountered an unexpected condition. Try your request again.
HTTP Status Code: 500
** ResourceNotFoundException **
You asked to describe a resource that doesn't exist. Check the resource that you are requesting and try again.
HTTP Status Code: 404
** ServiceQuotaExceededException **
You have reached a quota for your bot.
HTTP Status Code: 402
** ThrottlingException **
Your request rate is too high. Reduce the frequency of requests.
** retryAfterSeconds **
The number of seconds after which the user can invoke the API again.
HTTP Status Code: 429
** ValidationException **
One of the input parameters in your request isn't valid. Check the parameters and try your request again.
HTTP Status Code: 400
## See Also
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/models.lex.v2-2020-08-07/CreateExport)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/models.lex.v2-2020-08-07/CreateExport)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/CreateExport)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/models.lex.v2-2020-08-07/CreateExport)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/CreateExport)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/models.lex.v2-2020-08-07/CreateExport)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/models.lex.v2-2020-08-07/CreateExport)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/models.lex.v2-2020-08-07/CreateExport)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/models.lex.v2-2020-08-07/CreateExport)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/CreateExport)
# CreateIntent
Creates an intent.
To define the interaction between the user and your bot, you define one or more intents. For example, for a pizza ordering bot you would create an `OrderPizza` intent.
When you create an intent, you must provide a name. You can optionally provide the following:
+ Sample utterances. For example, "I want to order a pizza" and "Can I order a pizza." You can't provide utterances for built-in intents.
+ Information to be gathered. You specify slots for the information that you bot requests from the user. You can specify standard slot types, such as date and time, or custom slot types for your application.
+ How the intent is fulfilled. You can provide a Lambda function or configure the intent to return the intent information to your client application. If you use a Lambda function, Amazon Lex invokes the function when all of the intent information is available.
+ A confirmation prompt to send to the user to confirm an intent. For example, "Shall I order your pizza?"
+ A conclusion statement to send to the user after the intent is fulfilled. For example, "I ordered your pizza."
+ A follow-up prompt that asks the user for additional activity. For example, "Do you want a drink with your pizza?"
## Request Syntax
```
PUT /bots/botId/botversions/botVersion/botlocales/localeId/intents/ HTTP/1.1
Content-type: application/json
{
"description": "string",
"dialogCodeHook": {
"enabled": boolean
},
"fulfillmentCodeHook": {
"active": boolean,
"enabled": boolean,
"fulfillmentUpdatesSpecification": {
"active": boolean,
"startResponse": {
"allowInterrupt": boolean,
"delayInSeconds": number,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
},
"timeoutInSeconds": number,
"updateResponse": {
"allowInterrupt": boolean,
"frequencyInSeconds": number,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
}
},
"postFulfillmentStatusSpecification": {
"failureConditional": {
"active": boolean,
"conditionalBranches": [
{
"condition": {
"expressionString": "string"
},
"name": "string",
"nextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"response": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
}
}
],
"defaultBranch": {
"nextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"response": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
}
}
},
"failureNextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"failureResponse": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
},
"successConditional": {
"active": boolean,
"conditionalBranches": [
{
"condition": {
"expressionString": "string"
},
"name": "string",
"nextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"response": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
}
}
],
"defaultBranch": {
"nextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"response": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
}
}
},
"successNextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"successResponse": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
},
"timeoutConditional": {
"active": boolean,
"conditionalBranches": [
{
"condition": {
"expressionString": "string"
},
"name": "string",
"nextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"response": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
}
}
],
"defaultBranch": {
"nextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"response": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
}
}
},
"timeoutNextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"timeoutResponse": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
}
}
},
"initialResponseSetting": {
"codeHook": {
"active": boolean,
"enableCodeHookInvocation": boolean,
"invocationLabel": "string",
"postCodeHookSpecification": {
"failureConditional": {
"active": boolean,
"conditionalBranches": [
{
"condition": {
"expressionString": "string"
},
"name": "string",
"nextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"response": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
}
}
],
"defaultBranch": {
"nextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"response": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
}
}
},
"failureNextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"failureResponse": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
},
"successConditional": {
"active": boolean,
"conditionalBranches": [
{
"condition": {
"expressionString": "string"
},
"name": "string",
"nextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"response": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
}
}
],
"defaultBranch": {
"nextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"response": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
}
}
},
"successNextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"successResponse": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
},
"timeoutConditional": {
"active": boolean,
"conditionalBranches": [
{
"condition": {
"expressionString": "string"
},
"name": "string",
"nextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"response": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
}
}
],
"defaultBranch": {
"nextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"response": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
}
}
},
"timeoutNextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"timeoutResponse": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
}
}
},
"conditional": {
"active": boolean,
"conditionalBranches": [
{
"condition": {
"expressionString": "string"
},
"name": "string",
"nextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"response": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
}
}
],
"defaultBranch": {
"nextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"response": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
}
}
},
"initialResponse": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
},
"nextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
}
},
"inputContexts": [
{
"name": "string"
}
],
"intentClosingSetting": {
"active": boolean,
"closingResponse": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
},
"conditional": {
"active": boolean,
"conditionalBranches": [
{
"condition": {
"expressionString": "string"
},
"name": "string",
"nextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"response": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
}
}
],
"defaultBranch": {
"nextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"response": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
}
}
},
"nextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
}
},
"intentConfirmationSetting": {
"active": boolean,
"codeHook": {
"active": boolean,
"enableCodeHookInvocation": boolean,
"invocationLabel": "string",
"postCodeHookSpecification": {
"failureConditional": {
"active": boolean,
"conditionalBranches": [
{
"condition": {
"expressionString": "string"
},
"name": "string",
"nextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"response": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
}
}
],
"defaultBranch": {
"nextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"response": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
}
}
},
"failureNextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"failureResponse": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
},
"successConditional": {
"active": boolean,
"conditionalBranches": [
{
"condition": {
"expressionString": "string"
},
"name": "string",
"nextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"response": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
}
}
],
"defaultBranch": {
"nextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"response": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
}
}
},
"successNextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"successResponse": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
},
"timeoutConditional": {
"active": boolean,
"conditionalBranches": [
{
"condition": {
"expressionString": "string"
},
"name": "string",
"nextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"response": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
}
}
],
"defaultBranch": {
"nextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"response": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
}
}
},
"timeoutNextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"timeoutResponse": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
}
}
},
"confirmationConditional": {
"active": boolean,
"conditionalBranches": [
{
"condition": {
"expressionString": "string"
},
"name": "string",
"nextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"response": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
}
}
],
"defaultBranch": {
"nextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"response": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
}
}
},
"confirmationNextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"confirmationResponse": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
},
"declinationConditional": {
"active": boolean,
"conditionalBranches": [
{
"condition": {
"expressionString": "string"
},
"name": "string",
"nextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"response": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
}
}
],
"defaultBranch": {
"nextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"response": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
}
}
},
"declinationNextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"declinationResponse": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
},
"elicitationCodeHook": {
"enableCodeHookInvocation": boolean,
"invocationLabel": "string"
},
"failureConditional": {
"active": boolean,
"conditionalBranches": [
{
"condition": {
"expressionString": "string"
},
"name": "string",
"nextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"response": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
}
}
],
"defaultBranch": {
"nextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"response": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
}
}
},
"failureNextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"failureResponse": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
},
"promptSpecification": {
"allowInterrupt": boolean,
"maxRetries": number,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
],
"messageSelectionStrategy": "string",
"promptAttemptsSpecification": {
"string" : {
"allowedInputTypes": {
"allowAudioInput": boolean,
"allowDTMFInput": boolean
},
"allowInterrupt": boolean,
"audioAndDTMFInputSpecification": {
"audioSpecification": {
"endTimeoutMs": number,
"maxLengthMs": number
},
"dtmfSpecification": {
"deletionCharacter": "string",
"endCharacter": "string",
"endTimeoutMs": number,
"maxLength": number
},
"startTimeoutMs": number
},
"textInputSpecification": {
"startTimeoutMs": number
}
}
}
}
},
"intentDisplayName": "string",
"intentName": "string",
"kendraConfiguration": {
"kendraIndex": "string",
"queryFilterString": "string",
"queryFilterStringEnabled": boolean
},
"outputContexts": [
{
"name": "string",
"timeToLiveInSeconds": number,
"turnsToLive": number
}
],
"parentIntentSignature": "string",
"qInConnectIntentConfiguration": {
"qInConnectAssistantConfiguration": {
"assistantArn": "string"
}
},
"qnAIntentConfiguration": {
"bedrockModelConfiguration": {
"customPrompt": "string",
"guardrail": {
"identifier": "string",
"version": "string"
},
"modelArn": "string",
"traceStatus": "string"
},
"dataSourceConfiguration": {
"bedrockKnowledgeStoreConfiguration": {
"bedrockKnowledgeBaseArn": "string",
"exactResponse": boolean,
"exactResponseFields": {
"answerField": "string"
}
},
"kendraConfiguration": {
"exactResponse": boolean,
"kendraIndex": "string",
"queryFilterString": "string",
"queryFilterStringEnabled": boolean
},
"opensearchConfiguration": {
"domainEndpoint": "string",
"exactResponse": boolean,
"exactResponseFields": {
"answerField": "string",
"questionField": "string"
},
"includeFields": [ "string" ],
"indexName": "string"
}
}
},
"sampleUtterances": [
{
"utterance": "string"
}
]
}
```
## URI Request Parameters
The request uses the following URI parameters.
** [botId](#API_CreateIntent_RequestSyntax) **
The identifier of the bot associated with this intent.
Length Constraints: Fixed length of 10.
Pattern: `^[0-9a-zA-Z]+$`
Required: Yes
** [botVersion](#API_CreateIntent_RequestSyntax) **
The version of the bot associated with this intent.
Length Constraints: Fixed length of 5.
Pattern: `^DRAFT$`
Required: Yes
** [localeId](#API_CreateIntent_RequestSyntax) **
The identifier of the language and locale where this intent is used. All of the bots, slot types, and slots used by the intent must have the same locale. For more information, see [Supported languages](https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html).
Required: Yes
## Request Body
The request accepts the following data in JSON format.
** [description](#API_CreateIntent_RequestSyntax) **
A description of the intent. Use the description to help identify the intent in lists.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 2000.
Required: No
** [dialogCodeHook](#API_CreateIntent_RequestSyntax) **
Specifies that Amazon Lex invokes the alias Lambda function for each user input. You can invoke this Lambda function to personalize user interaction.
For example, suppose that your bot determines that the user's name is John. You 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: [DialogCodeHookSettings](API_DialogCodeHookSettings.md) object
Required: No
** [fulfillmentCodeHook](#API_CreateIntent_RequestSyntax) **
Specifies that Amazon Lex invokes the alias Lambda function when the intent is ready for fulfillment. You can invoke this function to complete the bot's transaction with the user.
For example, in a pizza ordering bot, the Lambda function can look up the closest pizza restaurant to the customer's location and then place an order on the customer's behalf.
Type: [FulfillmentCodeHookSettings](API_FulfillmentCodeHookSettings.md) object
Required: No
** [initialResponseSetting](#API_CreateIntent_RequestSyntax) **
Configuration settings for the response that is sent to the user at the beginning of a conversation, before eliciting slot values.
Type: [InitialResponseSetting](API_InitialResponseSetting.md) object
Required: No
** [inputContexts](#API_CreateIntent_RequestSyntax) **
A list of contexts that must be active for this intent to be considered by Amazon Lex.
When an intent has an input context list, Amazon Lex only considers using the intent in an interaction with the user when the specified contexts are included in the active context list for the session. If the contexts are not active, then Amazon Lex will not use the intent.
A context can be automatically activated using the `outputContexts` property or it can be set at runtime.
For example, if there are two intents with different input contexts that respond to the same utterances, only the intent with the active context will respond.
An intent may have up to 5 input contexts. If an intent has multiple input contexts, all of the contexts must be active to consider the intent.
Type: Array of [InputContext](API_InputContext.md) objects
Array Members: Minimum number of 0 items. Maximum number of 5 items.
Required: No
** [intentClosingSetting](#API_CreateIntent_RequestSyntax) **
Sets the response that Amazon Lex sends to the user when the intent is closed.
Type: [IntentClosingSetting](API_IntentClosingSetting.md) object
Required: No
** [intentConfirmationSetting](#API_CreateIntent_RequestSyntax) **
Provides prompts that Amazon Lex sends to the user to confirm the completion of an intent. If the user answers "no," the settings contain a statement that is sent to the user to end the intent.
Type: [IntentConfirmationSetting](API_IntentConfirmationSetting.md) object
Required: No
** [intentDisplayName](#API_CreateIntent_RequestSyntax) **
A display name for the intent. If configured, This name will be shown to users during Intent Disambiguation instead of the intent name. Display names should be user-friendly, descriptive and match the intent's purpose to improve user experience during disambiguation.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Required: No
** [intentName](#API_CreateIntent_RequestSyntax) **
The name of the intent. Intent names must be unique in the locale that contains the intent and cannot match the name of any built-in intent.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern: `^([0-9a-zA-Z][_-]?){1,100}$`
Required: Yes
** [kendraConfiguration](#API_CreateIntent_RequestSyntax) **
Configuration information required to use the `AMAZON.KendraSearchIntent` intent to connect to an Amazon Kendra index. The `AMAZON.KendraSearchIntent` intent is called when Amazon Lex can't determine another intent to invoke.
Type: [KendraConfiguration](API_KendraConfiguration.md) object
Required: No
** [outputContexts](#API_CreateIntent_RequestSyntax) **
A lists of contexts that the intent activates when it is fulfilled.
You can use an output context to indicate the intents that Amazon Lex should consider for the next turn of the conversation with a customer.
When you use the `outputContextsList` property, all of the contexts specified in the list are activated when the intent is fulfilled. You can set up to 10 output contexts. You can also set the number of conversation turns that the context should be active, or the length of time that the context should be active.
Type: Array of [OutputContext](API_OutputContext.md) objects
Array Members: Minimum number of 0 items. Maximum number of 10 items.
Required: No
** [parentIntentSignature](#API_CreateIntent_RequestSyntax) **
A unique identifier for the built-in intent to base this intent on.
Type: String
Required: No
** [qInConnectIntentConfiguration](#API_CreateIntent_RequestSyntax) **
Qinconnect intent configuration details for the create intent request.
Type: [QInConnectIntentConfiguration](API_QInConnectIntentConfiguration.md) object
Required: No
** [qnAIntentConfiguration](#API_CreateIntent_RequestSyntax) **
Specifies the configuration of the built-in `Amazon.QnAIntent`. The `AMAZON.QnAIntent` intent is called when Amazon Lex can't determine another intent to invoke. If you specify this field, you can't specify the `kendraConfiguration` field.
Type: [QnAIntentConfiguration](API_QnAIntentConfiguration.md) object
Required: No
** [sampleUtterances](#API_CreateIntent_RequestSyntax) **
An array of strings that a user might say to signal the intent. For example, "I want a pizza", or "I want a \$1PizzaSize\$1 pizza".
In an utterance, slot names are enclosed in curly braces ("\$1", "\$1") to indicate where they should be displayed in the utterance shown to the user..
Type: Array of [SampleUtterance](API_SampleUtterance.md) objects
Required: No
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"botId": "string",
"botVersion": "string",
"creationDateTime": number,
"description": "string",
"dialogCodeHook": {
"enabled": boolean
},
"fulfillmentCodeHook": {
"active": boolean,
"enabled": boolean,
"fulfillmentUpdatesSpecification": {
"active": boolean,
"startResponse": {
"allowInterrupt": boolean,
"delayInSeconds": number,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
},
"timeoutInSeconds": number,
"updateResponse": {
"allowInterrupt": boolean,
"frequencyInSeconds": number,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
}
},
"postFulfillmentStatusSpecification": {
"failureConditional": {
"active": boolean,
"conditionalBranches": [
{
"condition": {
"expressionString": "string"
},
"name": "string",
"nextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"response": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
}
}
],
"defaultBranch": {
"nextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"response": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
}
}
},
"failureNextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"failureResponse": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
},
"successConditional": {
"active": boolean,
"conditionalBranches": [
{
"condition": {
"expressionString": "string"
},
"name": "string",
"nextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"response": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
}
}
],
"defaultBranch": {
"nextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"response": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
}
}
},
"successNextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"successResponse": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
},
"timeoutConditional": {
"active": boolean,
"conditionalBranches": [
{
"condition": {
"expressionString": "string"
},
"name": "string",
"nextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"response": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
}
}
],
"defaultBranch": {
"nextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"response": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
}
}
},
"timeoutNextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"timeoutResponse": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
}
}
},
"initialResponseSetting": {
"codeHook": {
"active": boolean,
"enableCodeHookInvocation": boolean,
"invocationLabel": "string",
"postCodeHookSpecification": {
"failureConditional": {
"active": boolean,
"conditionalBranches": [
{
"condition": {
"expressionString": "string"
},
"name": "string",
"nextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"response": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
}
}
],
"defaultBranch": {
"nextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"response": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
}
}
},
"failureNextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"failureResponse": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
},
"successConditional": {
"active": boolean,
"conditionalBranches": [
{
"condition": {
"expressionString": "string"
},
"name": "string",
"nextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"response": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
}
}
],
"defaultBranch": {
"nextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"response": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
}
}
},
"successNextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"successResponse": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
},
"timeoutConditional": {
"active": boolean,
"conditionalBranches": [
{
"condition": {
"expressionString": "string"
},
"name": "string",
"nextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"response": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
}
}
],
"defaultBranch": {
"nextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"response": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
}
}
},
"timeoutNextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"timeoutResponse": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
}
}
},
"conditional": {
"active": boolean,
"conditionalBranches": [
{
"condition": {
"expressionString": "string"
},
"name": "string",
"nextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"response": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
}
}
],
"defaultBranch": {
"nextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"response": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
}
}
},
"initialResponse": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
},
"nextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
}
},
"inputContexts": [
{
"name": "string"
}
],
"intentClosingSetting": {
"active": boolean,
"closingResponse": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
},
"conditional": {
"active": boolean,
"conditionalBranches": [
{
"condition": {
"expressionString": "string"
},
"name": "string",
"nextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"response": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
}
}
],
"defaultBranch": {
"nextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"response": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
}
}
},
"nextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
}
},
"intentConfirmationSetting": {
"active": boolean,
"codeHook": {
"active": boolean,
"enableCodeHookInvocation": boolean,
"invocationLabel": "string",
"postCodeHookSpecification": {
"failureConditional": {
"active": boolean,
"conditionalBranches": [
{
"condition": {
"expressionString": "string"
},
"name": "string",
"nextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"response": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
}
}
],
"defaultBranch": {
"nextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"response": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
}
}
},
"failureNextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"failureResponse": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
},
"successConditional": {
"active": boolean,
"conditionalBranches": [
{
"condition": {
"expressionString": "string"
},
"name": "string",
"nextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"response": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
}
}
],
"defaultBranch": {
"nextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"response": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
}
}
},
"successNextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"successResponse": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
},
"timeoutConditional": {
"active": boolean,
"conditionalBranches": [
{
"condition": {
"expressionString": "string"
},
"name": "string",
"nextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"response": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
}
}
],
"defaultBranch": {
"nextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"response": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
}
}
},
"timeoutNextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"timeoutResponse": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
}
}
},
"confirmationConditional": {
"active": boolean,
"conditionalBranches": [
{
"condition": {
"expressionString": "string"
},
"name": "string",
"nextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"response": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
}
}
],
"defaultBranch": {
"nextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"response": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
}
}
},
"confirmationNextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"confirmationResponse": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
},
"declinationConditional": {
"active": boolean,
"conditionalBranches": [
{
"condition": {
"expressionString": "string"
},
"name": "string",
"nextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"response": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
}
}
],
"defaultBranch": {
"nextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"response": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
}
}
},
"declinationNextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"declinationResponse": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
},
"elicitationCodeHook": {
"enableCodeHookInvocation": boolean,
"invocationLabel": "string"
},
"failureConditional": {
"active": boolean,
"conditionalBranches": [
{
"condition": {
"expressionString": "string"
},
"name": "string",
"nextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"response": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
}
}
],
"defaultBranch": {
"nextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"response": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
}
}
},
"failureNextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"failureResponse": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
},
"promptSpecification": {
"allowInterrupt": boolean,
"maxRetries": number,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
],
"messageSelectionStrategy": "string",
"promptAttemptsSpecification": {
"string" : {
"allowedInputTypes": {
"allowAudioInput": boolean,
"allowDTMFInput": boolean
},
"allowInterrupt": boolean,
"audioAndDTMFInputSpecification": {
"audioSpecification": {
"endTimeoutMs": number,
"maxLengthMs": number
},
"dtmfSpecification": {
"deletionCharacter": "string",
"endCharacter": "string",
"endTimeoutMs": number,
"maxLength": number
},
"startTimeoutMs": number
},
"textInputSpecification": {
"startTimeoutMs": number
}
}
}
}
},
"intentDisplayName": "string",
"intentId": "string",
"intentName": "string",
"kendraConfiguration": {
"kendraIndex": "string",
"queryFilterString": "string",
"queryFilterStringEnabled": boolean
},
"localeId": "string",
"outputContexts": [
{
"name": "string",
"timeToLiveInSeconds": number,
"turnsToLive": number
}
],
"parentIntentSignature": "string",
"qInConnectIntentConfiguration": {
"qInConnectAssistantConfiguration": {
"assistantArn": "string"
}
},
"qnAIntentConfiguration": {
"bedrockModelConfiguration": {
"customPrompt": "string",
"guardrail": {
"identifier": "string",
"version": "string"
},
"modelArn": "string",
"traceStatus": "string"
},
"dataSourceConfiguration": {
"bedrockKnowledgeStoreConfiguration": {
"bedrockKnowledgeBaseArn": "string",
"exactResponse": boolean,
"exactResponseFields": {
"answerField": "string"
}
},
"kendraConfiguration": {
"exactResponse": boolean,
"kendraIndex": "string",
"queryFilterString": "string",
"queryFilterStringEnabled": boolean
},
"opensearchConfiguration": {
"domainEndpoint": "string",
"exactResponse": boolean,
"exactResponseFields": {
"answerField": "string",
"questionField": "string"
},
"includeFields": [ "string" ],
"indexName": "string"
}
}
},
"sampleUtterances": [
{
"utterance": "string"
}
]
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [botId](#API_CreateIntent_ResponseSyntax) **
The identifier of the bot associated with the intent.
Type: String
Length Constraints: Fixed length of 10.
Pattern: `^[0-9a-zA-Z]+$`
** [botVersion](#API_CreateIntent_ResponseSyntax) **
The version of the bot associated with the intent.
Type: String
Length Constraints: Fixed length of 5.
Pattern: `^DRAFT$`
** [creationDateTime](#API_CreateIntent_ResponseSyntax) **
A timestamp of the date and time that the intent was created.
Type: Timestamp
** [description](#API_CreateIntent_ResponseSyntax) **
The description specified for the intent.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 2000.
** [dialogCodeHook](#API_CreateIntent_ResponseSyntax) **
The dialog Lambda function specified for the intent.
Type: [DialogCodeHookSettings](API_DialogCodeHookSettings.md) object
** [fulfillmentCodeHook](#API_CreateIntent_ResponseSyntax) **
The fulfillment Lambda function specified for the intent.
Type: [FulfillmentCodeHookSettings](API_FulfillmentCodeHookSettings.md) object
** [initialResponseSetting](#API_CreateIntent_ResponseSyntax) **
Configuration settings for the response that is sent to the user at the beginning of a conversation, before eliciting slot values.
Type: [InitialResponseSetting](API_InitialResponseSetting.md) object
** [inputContexts](#API_CreateIntent_ResponseSyntax) **
The list of input contexts specified for the intent.
Type: Array of [InputContext](API_InputContext.md) objects
Array Members: Minimum number of 0 items. Maximum number of 5 items.
** [intentClosingSetting](#API_CreateIntent_ResponseSyntax) **
The closing setting specified for the intent.
Type: [IntentClosingSetting](API_IntentClosingSetting.md) object
** [intentConfirmationSetting](#API_CreateIntent_ResponseSyntax) **
The confirmation setting specified for the intent.
Type: [IntentConfirmationSetting](API_IntentConfirmationSetting.md) object
** [intentDisplayName](#API_CreateIntent_ResponseSyntax) **
The display name specified for the intent.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
** [intentId](#API_CreateIntent_ResponseSyntax) **
A unique identifier for the intent.
Type: String
Length Constraints: Fixed length of 10.
Pattern: `^[0-9a-zA-Z]+$`
** [intentName](#API_CreateIntent_ResponseSyntax) **
The name specified for the intent.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern: `^([0-9a-zA-Z][_-]?){1,100}$`
** [kendraConfiguration](#API_CreateIntent_ResponseSyntax) **
Configuration for searching a Amazon Kendra index specified for the intent.
Type: [KendraConfiguration](API_KendraConfiguration.md) object
** [localeId](#API_CreateIntent_ResponseSyntax) **
The locale that the intent is specified to use.
Type: String
** [outputContexts](#API_CreateIntent_ResponseSyntax) **
The list of output contexts specified for the intent.
Type: Array of [OutputContext](API_OutputContext.md) objects
Array Members: Minimum number of 0 items. Maximum number of 10 items.
** [parentIntentSignature](#API_CreateIntent_ResponseSyntax) **
The signature of the parent intent specified for the intent.
Type: String
** [qInConnectIntentConfiguration](#API_CreateIntent_ResponseSyntax) **
Qinconnect intent configuration details for the create intent response.
Type: [QInConnectIntentConfiguration](API_QInConnectIntentConfiguration.md) object
** [qnAIntentConfiguration](#API_CreateIntent_ResponseSyntax) **
Details about the the configuration of the built-in `Amazon.QnAIntent`.
Type: [QnAIntentConfiguration](API_QnAIntentConfiguration.md) object
** [sampleUtterances](#API_CreateIntent_ResponseSyntax) **
The sample utterances specified for the intent.
Type: Array of [SampleUtterance](API_SampleUtterance.md) objects
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** ConflictException **
The action that you tried to perform couldn't be completed because the resource is in a conflicting state. For example, deleting a bot that is in the CREATING state. Try your request again.
HTTP Status Code: 409
** InternalServerException **
The service encountered an unexpected condition. Try your request again.
HTTP Status Code: 500
** PreconditionFailedException **
Your request couldn't be completed because one or more request fields aren't valid. Check the fields in your request and try again.
HTTP Status Code: 412
** ServiceQuotaExceededException **
You have reached a quota for your bot.
HTTP Status Code: 402
** ThrottlingException **
Your request rate is too high. Reduce the frequency of requests.
** retryAfterSeconds **
The number of seconds after which the user can invoke the API again.
HTTP Status Code: 429
** ValidationException **
One of the input parameters in your request isn't valid. Check the parameters and try your request again.
HTTP Status Code: 400
## See Also
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/models.lex.v2-2020-08-07/CreateIntent)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/models.lex.v2-2020-08-07/CreateIntent)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/CreateIntent)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/models.lex.v2-2020-08-07/CreateIntent)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/CreateIntent)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/models.lex.v2-2020-08-07/CreateIntent)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/models.lex.v2-2020-08-07/CreateIntent)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/models.lex.v2-2020-08-07/CreateIntent)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/models.lex.v2-2020-08-07/CreateIntent)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/CreateIntent)
# CreateResourcePolicy
Creates a new resource policy with the specified policy statements.
## Request Syntax
```
POST /policy/resourceArn/ HTTP/1.1
Content-type: application/json
{
"policy": "string"
}
```
## URI Request Parameters
The request uses the following URI parameters.
** [resourceArn](#API_CreateResourcePolicy_RequestSyntax) **
The Amazon Resource Name (ARN) of the bot or bot alias that the resource policy is attached to.
Length Constraints: Minimum length of 1. Maximum length of 1011.
Required: Yes
## Request Body
The request accepts the following data in JSON format.
** [policy](#API_CreateResourcePolicy_RequestSyntax) **
A resource policy to add to the resource. The policy is a JSON structure that contains one or more statements that define the policy. The policy must follow the IAM syntax. For more information about the contents of a JSON policy document, see [ IAM JSON policy reference ](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies.html).
If the policy isn't valid, Amazon Lex returns a validation exception.
Type: String
Length Constraints: Minimum length of 2.
Required: Yes
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"resourceArn": "string",
"revisionId": "string"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [resourceArn](#API_CreateResourcePolicy_ResponseSyntax) **
The Amazon Resource Name (ARN) of the bot or bot alias that the resource policy was attached to.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1011.
** [revisionId](#API_CreateResourcePolicy_ResponseSyntax) **
The current revision of the resource policy. Use the revision ID to make sure that you are updating the most current version of a resource policy when you add a policy statement to a resource, delete a resource, or update a resource.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 5.
Pattern: `^[0-9]+$`
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** InternalServerException **
The service encountered an unexpected condition. Try your request again.
HTTP Status Code: 500
** PreconditionFailedException **
Your request couldn't be completed because one or more request fields aren't valid. Check the fields in your request and try again.
HTTP Status Code: 412
** ResourceNotFoundException **
You asked to describe a resource that doesn't exist. Check the resource that you are requesting and try again.
HTTP Status Code: 404
** ServiceQuotaExceededException **
You have reached a quota for your bot.
HTTP Status Code: 402
** ThrottlingException **
Your request rate is too high. Reduce the frequency of requests.
** retryAfterSeconds **
The number of seconds after which the user can invoke the API again.
HTTP Status Code: 429
** ValidationException **
One of the input parameters in your request isn't valid. Check the parameters and try your request again.
HTTP Status Code: 400
## See Also
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/models.lex.v2-2020-08-07/CreateResourcePolicy)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/models.lex.v2-2020-08-07/CreateResourcePolicy)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/CreateResourcePolicy)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/models.lex.v2-2020-08-07/CreateResourcePolicy)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/CreateResourcePolicy)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/models.lex.v2-2020-08-07/CreateResourcePolicy)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/models.lex.v2-2020-08-07/CreateResourcePolicy)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/models.lex.v2-2020-08-07/CreateResourcePolicy)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/models.lex.v2-2020-08-07/CreateResourcePolicy)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/CreateResourcePolicy)
# CreateResourcePolicyStatement
Adds a new resource policy statement to a bot or bot alias. If a resource policy exists, the statement is added to the current resource policy. If a policy doesn't exist, a new policy is created.
You can't create a resource policy statement that allows cross-account access.
You need to add the `CreateResourcePolicy` or `UpdateResourcePolicy` action to the bot role in order to call the API.
## Request Syntax
```
POST /policy/resourceArn/statements/?expectedRevisionId=expectedRevisionId HTTP/1.1
Content-type: application/json
{
"action": [ "string" ],
"condition": {
"string" : {
"string" : "string"
}
},
"effect": "string",
"principal": [
{
"arn": "string",
"service": "string"
}
],
"statementId": "string"
}
```
## URI Request Parameters
The request uses the following URI parameters.
** [expectedRevisionId](#API_CreateResourcePolicyStatement_RequestSyntax) **
The identifier of the revision of the policy to edit. If this revision ID doesn't match the current revision ID, Amazon Lex throws an exception.
If you don't specify a revision, Amazon Lex overwrites the contents of the policy with the new values.
Length Constraints: Minimum length of 1. Maximum length of 5.
Pattern: `^[0-9]+$`
** [resourceArn](#API_CreateResourcePolicyStatement_RequestSyntax) **
The Amazon Resource Name (ARN) of the bot or bot alias that the resource policy is attached to.
Length Constraints: Minimum length of 1. Maximum length of 1011.
Required: Yes
## Request Body
The request accepts the following data in JSON format.
** [action](#API_CreateResourcePolicyStatement_RequestSyntax) **
The Amazon Lex action that this policy either allows or denies. The action must apply to the resource type of the specified ARN. For more information, see [ Actions, resources, and condition keys for Amazon Lex V2](https://docs.aws.amazon.com/service-authorization/latest/reference/list_amazonlexv2.html).
Type: Array of strings
Length Constraints: Minimum length of 5. Maximum length of 50.
Pattern: `lex:[a-zA-Z*]+$`
Required: Yes
** [condition](#API_CreateResourcePolicyStatement_RequestSyntax) **
Specifies a condition when the policy is in effect. If the principal of the policy is a service principal, you must provide two condition blocks, one with a SourceAccount global condition key and one with a SourceArn global condition key.
For more information, see [IAM JSON policy elements: Condition ](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements_condition.html).
Type: String to string to string map map
Map Entries: Minimum number of 0 items. Maximum number of 10 items.
Key Length Constraints: Minimum length of 1.
Map Entries: Minimum number of 0 items. Maximum number of 10 items.
Key Length Constraints: Minimum length of 1. Maximum length of 1024.
Value Length Constraints: Minimum length of 1. Maximum length of 1024.
Required: No
** [effect](#API_CreateResourcePolicyStatement_RequestSyntax) **
Determines whether the statement allows or denies access to the resource.
Type: String
Valid Values: `Allow | Deny`
Required: Yes
** [principal](#API_CreateResourcePolicyStatement_RequestSyntax) **
An IAM principal, such as an IAM user, IAM role, or AWS services that is allowed or denied access to a resource. For more information, see [AWS JSON policy elements: Principal](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements_principal.html).
Type: Array of [Principal](API_Principal.md) objects
Required: Yes
** [statementId](#API_CreateResourcePolicyStatement_RequestSyntax) **
The name of the statement. The ID is the same as the `Sid` IAM property. The statement name must be unique within the policy. For more information, see [IAM JSON policy elements: Sid](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements_sid.html).
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern: `^([0-9a-zA-Z][_-]?){1,100}$`
Required: Yes
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"resourceArn": "string",
"revisionId": "string"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [resourceArn](#API_CreateResourcePolicyStatement_ResponseSyntax) **
The Amazon Resource Name (ARN) of the bot or bot alias that the resource policy is attached to.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1011.
** [revisionId](#API_CreateResourcePolicyStatement_ResponseSyntax) **
The current revision of the resource policy. Use the revision ID to make sure that you are updating the most current version of a resource policy when you add a policy statement to a resource, delete a resource, or update a resource.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 5.
Pattern: `^[0-9]+$`
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** ConflictException **
The action that you tried to perform couldn't be completed because the resource is in a conflicting state. For example, deleting a bot that is in the CREATING state. Try your request again.
HTTP Status Code: 409
** InternalServerException **
The service encountered an unexpected condition. Try your request again.
HTTP Status Code: 500
** PreconditionFailedException **
Your request couldn't be completed because one or more request fields aren't valid. Check the fields in your request and try again.
HTTP Status Code: 412
** ResourceNotFoundException **
You asked to describe a resource that doesn't exist. Check the resource that you are requesting and try again.
HTTP Status Code: 404
** ServiceQuotaExceededException **
You have reached a quota for your bot.
HTTP Status Code: 402
** ThrottlingException **
Your request rate is too high. Reduce the frequency of requests.
** retryAfterSeconds **
The number of seconds after which the user can invoke the API again.
HTTP Status Code: 429
** ValidationException **
One of the input parameters in your request isn't valid. Check the parameters and try your request again.
HTTP Status Code: 400
## See Also
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/models.lex.v2-2020-08-07/CreateResourcePolicyStatement)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/models.lex.v2-2020-08-07/CreateResourcePolicyStatement)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/CreateResourcePolicyStatement)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/models.lex.v2-2020-08-07/CreateResourcePolicyStatement)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/CreateResourcePolicyStatement)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/models.lex.v2-2020-08-07/CreateResourcePolicyStatement)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/models.lex.v2-2020-08-07/CreateResourcePolicyStatement)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/models.lex.v2-2020-08-07/CreateResourcePolicyStatement)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/models.lex.v2-2020-08-07/CreateResourcePolicyStatement)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/CreateResourcePolicyStatement)
# CreateSlot
Creates a slot in an intent. A slot is a variable needed to fulfill an intent. For example, an `OrderPizza` intent might need slots for size, crust, and number of pizzas. For each slot, you define one or more utterances that Amazon Lex uses to elicit a response from the user.
## Request Syntax
```
PUT /bots/botId/botversions/botVersion/botlocales/localeId/intents/intentId/slots/ HTTP/1.1
Content-type: application/json
{
"description": "string",
"multipleValuesSetting": {
"allowMultipleValues": boolean
},
"obfuscationSetting": {
"obfuscationSettingType": "string"
},
"slotName": "string",
"slotTypeId": "string",
"subSlotSetting": {
"expression": "string",
"slotSpecifications": {
"string" : {
"slotTypeId": "string",
"valueElicitationSetting": {
"defaultValueSpecification": {
"defaultValueList": [
{
"defaultValue": "string"
}
]
},
"promptSpecification": {
"allowInterrupt": boolean,
"maxRetries": number,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
],
"messageSelectionStrategy": "string",
"promptAttemptsSpecification": {
"string" : {
"allowedInputTypes": {
"allowAudioInput": boolean,
"allowDTMFInput": boolean
},
"allowInterrupt": boolean,
"audioAndDTMFInputSpecification": {
"audioSpecification": {
"endTimeoutMs": number,
"maxLengthMs": number
},
"dtmfSpecification": {
"deletionCharacter": "string",
"endCharacter": "string",
"endTimeoutMs": number,
"maxLength": number
},
"startTimeoutMs": number
},
"textInputSpecification": {
"startTimeoutMs": number
}
}
}
},
"sampleUtterances": [
{
"utterance": "string"
}
],
"waitAndContinueSpecification": {
"active": boolean,
"continueResponse": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
},
"stillWaitingResponse": {
"allowInterrupt": boolean,
"frequencyInSeconds": number,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
],
"timeoutInSeconds": number
},
"waitingResponse": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
}
}
}
}
}
},
"valueElicitationSetting": {
"defaultValueSpecification": {
"defaultValueList": [
{
"defaultValue": "string"
}
]
},
"promptSpecification": {
"allowInterrupt": boolean,
"maxRetries": number,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
],
"messageSelectionStrategy": "string",
"promptAttemptsSpecification": {
"string" : {
"allowedInputTypes": {
"allowAudioInput": boolean,
"allowDTMFInput": boolean
},
"allowInterrupt": boolean,
"audioAndDTMFInputSpecification": {
"audioSpecification": {
"endTimeoutMs": number,
"maxLengthMs": number
},
"dtmfSpecification": {
"deletionCharacter": "string",
"endCharacter": "string",
"endTimeoutMs": number,
"maxLength": number
},
"startTimeoutMs": number
},
"textInputSpecification": {
"startTimeoutMs": number
}
}
}
},
"sampleUtterances": [
{
"utterance": "string"
}
],
"slotCaptureSetting": {
"captureConditional": {
"active": boolean,
"conditionalBranches": [
{
"condition": {
"expressionString": "string"
},
"name": "string",
"nextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"response": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
}
}
],
"defaultBranch": {
"nextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"response": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
}
}
},
"captureNextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"captureResponse": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
},
"codeHook": {
"active": boolean,
"enableCodeHookInvocation": boolean,
"invocationLabel": "string",
"postCodeHookSpecification": {
"failureConditional": {
"active": boolean,
"conditionalBranches": [
{
"condition": {
"expressionString": "string"
},
"name": "string",
"nextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"response": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
}
}
],
"defaultBranch": {
"nextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"response": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
}
}
},
"failureNextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"failureResponse": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
},
"successConditional": {
"active": boolean,
"conditionalBranches": [
{
"condition": {
"expressionString": "string"
},
"name": "string",
"nextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"response": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
}
}
],
"defaultBranch": {
"nextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"response": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
}
}
},
"successNextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"successResponse": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
},
"timeoutConditional": {
"active": boolean,
"conditionalBranches": [
{
"condition": {
"expressionString": "string"
},
"name": "string",
"nextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"response": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
}
}
],
"defaultBranch": {
"nextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"response": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
}
}
},
"timeoutNextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"timeoutResponse": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
}
}
},
"elicitationCodeHook": {
"enableCodeHookInvocation": boolean,
"invocationLabel": "string"
},
"failureConditional": {
"active": boolean,
"conditionalBranches": [
{
"condition": {
"expressionString": "string"
},
"name": "string",
"nextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"response": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
}
}
],
"defaultBranch": {
"nextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"response": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
}
}
},
"failureNextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"failureResponse": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
}
},
"slotConstraint": "string",
"slotResolutionSetting": {
"slotResolutionStrategy": "string"
},
"waitAndContinueSpecification": {
"active": boolean,
"continueResponse": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
},
"stillWaitingResponse": {
"allowInterrupt": boolean,
"frequencyInSeconds": number,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
],
"timeoutInSeconds": number
},
"waitingResponse": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
}
}
}
}
```
## URI Request Parameters
The request uses the following URI parameters.
** [botId](#API_CreateSlot_RequestSyntax) **
The identifier of the bot associated with the slot.
Length Constraints: Fixed length of 10.
Pattern: `^[0-9a-zA-Z]+$`
Required: Yes
** [botVersion](#API_CreateSlot_RequestSyntax) **
The version of the bot associated with the slot.
Length Constraints: Fixed length of 5.
Pattern: `^DRAFT$`
Required: Yes
** [intentId](#API_CreateSlot_RequestSyntax) **
The identifier of the intent that contains the slot.
Length Constraints: Fixed length of 10.
Pattern: `^[0-9a-zA-Z]+$`
Required: Yes
** [localeId](#API_CreateSlot_RequestSyntax) **
The identifier of the language and locale that the slot will be used in. The string must match one of the supported locales. All of the bots, intents, slot types used by the slot must have the same locale. For more information, see [Supported languages](https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html).
Required: Yes
## Request Body
The request accepts the following data in JSON format.
** [description](#API_CreateSlot_RequestSyntax) **
A description of the slot. Use this to help identify the slot in lists.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 2000.
Required: No
** [multipleValuesSetting](#API_CreateSlot_RequestSyntax) **
Indicates whether the slot returns multiple values in one response. Multi-value slots are only available in the `en-US` locale. If you set this value to `true` in any other locale, Amazon Lex throws a `ValidationException`.
If the `multipleValuesSetting` is not set, the default value is `false`.
Type: [MultipleValuesSetting](API_MultipleValuesSetting.md) object
Required: No
** [obfuscationSetting](#API_CreateSlot_RequestSyntax) **
Determines how slot values are used in Amazon CloudWatch logs. If the value of the `obfuscationSetting` parameter is `DefaultObfuscation`, slot values are obfuscated in the log output. If the value is `None`, the actual value is present in the log output.
The default is to obfuscate values in the CloudWatch logs.
Type: [ObfuscationSetting](API_ObfuscationSetting.md) object
Required: No
** [slotName](#API_CreateSlot_RequestSyntax) **
The name of the slot. Slot names must be unique within the bot that contains the slot.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern: `^([0-9a-zA-Z][_-]?){1,100}$`
Required: Yes
** [slotTypeId](#API_CreateSlot_RequestSyntax) **
The unique identifier for the slot type associated with this slot. The slot type determines the values that can be entered into the slot.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 25.
Pattern: `^((AMAZON\.)[a-zA-Z_]+?|[0-9a-zA-Z]+)$`
Required: No
** [subSlotSetting](#API_CreateSlot_RequestSyntax) **
Specifications for the constituent sub slots and the expression for the composite slot.
Type: [SubSlotSetting](API_SubSlotSetting.md) object
Required: No
** [valueElicitationSetting](#API_CreateSlot_RequestSyntax) **
Specifies prompts that Amazon Lex sends to the user to elicit a response that provides the value for the slot.
Type: [SlotValueElicitationSetting](API_SlotValueElicitationSetting.md) object
Required: Yes
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"botId": "string",
"botVersion": "string",
"creationDateTime": number,
"description": "string",
"intentId": "string",
"localeId": "string",
"multipleValuesSetting": {
"allowMultipleValues": boolean
},
"obfuscationSetting": {
"obfuscationSettingType": "string"
},
"slotId": "string",
"slotName": "string",
"slotTypeId": "string",
"subSlotSetting": {
"expression": "string",
"slotSpecifications": {
"string" : {
"slotTypeId": "string",
"valueElicitationSetting": {
"defaultValueSpecification": {
"defaultValueList": [
{
"defaultValue": "string"
}
]
},
"promptSpecification": {
"allowInterrupt": boolean,
"maxRetries": number,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
],
"messageSelectionStrategy": "string",
"promptAttemptsSpecification": {
"string" : {
"allowedInputTypes": {
"allowAudioInput": boolean,
"allowDTMFInput": boolean
},
"allowInterrupt": boolean,
"audioAndDTMFInputSpecification": {
"audioSpecification": {
"endTimeoutMs": number,
"maxLengthMs": number
},
"dtmfSpecification": {
"deletionCharacter": "string",
"endCharacter": "string",
"endTimeoutMs": number,
"maxLength": number
},
"startTimeoutMs": number
},
"textInputSpecification": {
"startTimeoutMs": number
}
}
}
},
"sampleUtterances": [
{
"utterance": "string"
}
],
"waitAndContinueSpecification": {
"active": boolean,
"continueResponse": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
},
"stillWaitingResponse": {
"allowInterrupt": boolean,
"frequencyInSeconds": number,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
],
"timeoutInSeconds": number
},
"waitingResponse": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
}
}
}
}
}
},
"valueElicitationSetting": {
"defaultValueSpecification": {
"defaultValueList": [
{
"defaultValue": "string"
}
]
},
"promptSpecification": {
"allowInterrupt": boolean,
"maxRetries": number,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
],
"messageSelectionStrategy": "string",
"promptAttemptsSpecification": {
"string" : {
"allowedInputTypes": {
"allowAudioInput": boolean,
"allowDTMFInput": boolean
},
"allowInterrupt": boolean,
"audioAndDTMFInputSpecification": {
"audioSpecification": {
"endTimeoutMs": number,
"maxLengthMs": number
},
"dtmfSpecification": {
"deletionCharacter": "string",
"endCharacter": "string",
"endTimeoutMs": number,
"maxLength": number
},
"startTimeoutMs": number
},
"textInputSpecification": {
"startTimeoutMs": number
}
}
}
},
"sampleUtterances": [
{
"utterance": "string"
}
],
"slotCaptureSetting": {
"captureConditional": {
"active": boolean,
"conditionalBranches": [
{
"condition": {
"expressionString": "string"
},
"name": "string",
"nextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"response": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
}
}
],
"defaultBranch": {
"nextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"response": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
}
}
},
"captureNextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"captureResponse": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
},
"codeHook": {
"active": boolean,
"enableCodeHookInvocation": boolean,
"invocationLabel": "string",
"postCodeHookSpecification": {
"failureConditional": {
"active": boolean,
"conditionalBranches": [
{
"condition": {
"expressionString": "string"
},
"name": "string",
"nextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"response": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
}
}
],
"defaultBranch": {
"nextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"response": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
}
}
},
"failureNextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"failureResponse": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
},
"successConditional": {
"active": boolean,
"conditionalBranches": [
{
"condition": {
"expressionString": "string"
},
"name": "string",
"nextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"response": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
}
}
],
"defaultBranch": {
"nextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"response": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
}
}
},
"successNextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"successResponse": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
},
"timeoutConditional": {
"active": boolean,
"conditionalBranches": [
{
"condition": {
"expressionString": "string"
},
"name": "string",
"nextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"response": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
}
}
],
"defaultBranch": {
"nextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"response": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
}
}
},
"timeoutNextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"timeoutResponse": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
}
}
},
"elicitationCodeHook": {
"enableCodeHookInvocation": boolean,
"invocationLabel": "string"
},
"failureConditional": {
"active": boolean,
"conditionalBranches": [
{
"condition": {
"expressionString": "string"
},
"name": "string",
"nextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"response": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
}
}
],
"defaultBranch": {
"nextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"response": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
}
}
},
"failureNextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"failureResponse": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
}
},
"slotConstraint": "string",
"slotResolutionSetting": {
"slotResolutionStrategy": "string"
},
"waitAndContinueSpecification": {
"active": boolean,
"continueResponse": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
},
"stillWaitingResponse": {
"allowInterrupt": boolean,
"frequencyInSeconds": number,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
],
"timeoutInSeconds": number
},
"waitingResponse": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
}
}
}
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [botId](#API_CreateSlot_ResponseSyntax) **
The unique identifier of the bot associated with the slot.
Type: String
Length Constraints: Fixed length of 10.
Pattern: `^[0-9a-zA-Z]+$`
** [botVersion](#API_CreateSlot_ResponseSyntax) **
The version of the bot associated with the slot.
Type: String
Length Constraints: Fixed length of 5.
Pattern: `^DRAFT$`
** [creationDateTime](#API_CreateSlot_ResponseSyntax) **
The timestamp of the date and time that the slot was created.
Type: Timestamp
** [description](#API_CreateSlot_ResponseSyntax) **
The description associated with the slot.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 2000.
** [intentId](#API_CreateSlot_ResponseSyntax) **
The unique identifier of the intent associated with the slot.
Type: String
Length Constraints: Fixed length of 10.
Pattern: `^[0-9a-zA-Z]+$`
** [localeId](#API_CreateSlot_ResponseSyntax) **
The language and local specified for the slot.
Type: String
** [multipleValuesSetting](#API_CreateSlot_ResponseSyntax) **
Indicates whether the slot returns multiple values in one response.
Type: [MultipleValuesSetting](API_MultipleValuesSetting.md) object
** [obfuscationSetting](#API_CreateSlot_ResponseSyntax) **
Indicates whether the slot is configured to obfuscate values in Amazon CloudWatch logs.
Type: [ObfuscationSetting](API_ObfuscationSetting.md) object
** [slotId](#API_CreateSlot_ResponseSyntax) **
The unique identifier associated with the slot. Use this to identify the slot when you update or delete it.
Type: String
Length Constraints: Fixed length of 10.
Pattern: `^[0-9a-zA-Z]+$`
** [slotName](#API_CreateSlot_ResponseSyntax) **
The name specified for the slot.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern: `^([0-9a-zA-Z][_-]?){1,100}$`
** [slotTypeId](#API_CreateSlot_ResponseSyntax) **
The unique identifier of the slot type associated with this slot.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 25.
Pattern: `^((AMAZON\.)[a-zA-Z_]+?|[0-9a-zA-Z]+)$`
** [subSlotSetting](#API_CreateSlot_ResponseSyntax) **
Specifications for the constituent sub slots and the expression for the composite slot.
Type: [SubSlotSetting](API_SubSlotSetting.md) object
** [valueElicitationSetting](#API_CreateSlot_ResponseSyntax) **
The value elicitation settings specified for the slot.
Type: [SlotValueElicitationSetting](API_SlotValueElicitationSetting.md) object
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** ConflictException **
The action that you tried to perform couldn't be completed because the resource is in a conflicting state. For example, deleting a bot that is in the CREATING state. Try your request again.
HTTP Status Code: 409
** InternalServerException **
The service encountered an unexpected condition. Try your request again.
HTTP Status Code: 500
** PreconditionFailedException **
Your request couldn't be completed because one or more request fields aren't valid. Check the fields in your request and try again.
HTTP Status Code: 412
** ServiceQuotaExceededException **
You have reached a quota for your bot.
HTTP Status Code: 402
** ThrottlingException **
Your request rate is too high. Reduce the frequency of requests.
** retryAfterSeconds **
The number of seconds after which the user can invoke the API again.
HTTP Status Code: 429
** ValidationException **
One of the input parameters in your request isn't valid. Check the parameters and try your request again.
HTTP Status Code: 400
## See Also
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/models.lex.v2-2020-08-07/CreateSlot)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/models.lex.v2-2020-08-07/CreateSlot)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/CreateSlot)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/models.lex.v2-2020-08-07/CreateSlot)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/CreateSlot)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/models.lex.v2-2020-08-07/CreateSlot)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/models.lex.v2-2020-08-07/CreateSlot)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/models.lex.v2-2020-08-07/CreateSlot)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/models.lex.v2-2020-08-07/CreateSlot)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/CreateSlot)
# CreateSlotType
Creates a custom slot type
To create a custom slot type, specify a name for the slot type and a set of enumeration values, the values that a slot of this type can assume.
## Request Syntax
```
PUT /bots/botId/botversions/botVersion/botlocales/localeId/slottypes/ HTTP/1.1
Content-type: application/json
{
"compositeSlotTypeSetting": {
"subSlots": [
{
"name": "string",
"slotTypeId": "string"
}
]
},
"description": "string",
"externalSourceSetting": {
"grammarSlotTypeSetting": {
"source": {
"kmsKeyArn": "string",
"s3BucketName": "string",
"s3ObjectKey": "string"
}
}
},
"parentSlotTypeSignature": "string",
"slotTypeName": "string",
"slotTypeValues": [
{
"sampleValue": {
"value": "string"
},
"synonyms": [
{
"value": "string"
}
]
}
],
"valueSelectionSetting": {
"advancedRecognitionSetting": {
"audioRecognitionStrategy": "string"
},
"regexFilter": {
"pattern": "string"
},
"resolutionStrategy": "string"
}
}
```
## URI Request Parameters
The request uses the following URI parameters.
** [botId](#API_CreateSlotType_RequestSyntax) **
The identifier of the bot associated with this slot type.
Length Constraints: Fixed length of 10.
Pattern: `^[0-9a-zA-Z]+$`
Required: Yes
** [botVersion](#API_CreateSlotType_RequestSyntax) **
The identifier of the bot version associated with this slot type.
Length Constraints: Fixed length of 5.
Pattern: `^DRAFT$`
Required: Yes
** [localeId](#API_CreateSlotType_RequestSyntax) **
The identifier of the language and locale that the slot type will be used in. The string must match one of the supported locales. All of the bots, intents, and slots used by the slot type must have the same locale. For more information, see [Supported languages](https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html).
Required: Yes
## Request Body
The request accepts the following data in JSON format.
** [compositeSlotTypeSetting](#API_CreateSlotType_RequestSyntax) **
Specifications for a composite slot type.
Type: [CompositeSlotTypeSetting](API_CompositeSlotTypeSetting.md) object
Required: No
** [description](#API_CreateSlotType_RequestSyntax) **
A description of the slot type. Use the description to help identify the slot type in lists.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 2000.
Required: No
** [externalSourceSetting](#API_CreateSlotType_RequestSyntax) **
Sets the type of external information used to create the slot type.
Type: [ExternalSourceSetting](API_ExternalSourceSetting.md) object
Required: No
** [parentSlotTypeSignature](#API_CreateSlotType_RequestSyntax) **
The built-in slot type used as a parent of this slot type. When you define a parent slot type, the new slot type has the configuration of the parent slot type.
Only `AMAZON.AlphaNumeric` is supported.
Type: String
Required: No
** [slotTypeName](#API_CreateSlotType_RequestSyntax) **
The name for the slot. A slot type name must be unique within the intent.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern: `^([0-9a-zA-Z][_-]?){1,100}$`
Required: Yes
** [slotTypeValues](#API_CreateSlotType_RequestSyntax) **
A list of `SlotTypeValue` objects that defines the values that the slot type can take. Each value can have a list of synonyms, additional values that help train the machine learning model about the values that it resolves for a slot.
Type: Array of [SlotTypeValue](API_SlotTypeValue.md) objects
Array Members: Minimum number of 1 item. Maximum number of 10000 items.
Required: No
** [valueSelectionSetting](#API_CreateSlotType_RequestSyntax) **
Determines the strategy that Amazon Lex uses to select a value from the list of possible 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. If there is no resolution list, return null.
If you don't specify the `valueSelectionSetting` parameter, the default is `ORIGINAL_VALUE`.
Type: [SlotValueSelectionSetting](API_SlotValueSelectionSetting.md) object
Required: No
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"botId": "string",
"botVersion": "string",
"compositeSlotTypeSetting": {
"subSlots": [
{
"name": "string",
"slotTypeId": "string"
}
]
},
"creationDateTime": number,
"description": "string",
"externalSourceSetting": {
"grammarSlotTypeSetting": {
"source": {
"kmsKeyArn": "string",
"s3BucketName": "string",
"s3ObjectKey": "string"
}
}
},
"localeId": "string",
"parentSlotTypeSignature": "string",
"slotTypeId": "string",
"slotTypeName": "string",
"slotTypeValues": [
{
"sampleValue": {
"value": "string"
},
"synonyms": [
{
"value": "string"
}
]
}
],
"valueSelectionSetting": {
"advancedRecognitionSetting": {
"audioRecognitionStrategy": "string"
},
"regexFilter": {
"pattern": "string"
},
"resolutionStrategy": "string"
}
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [botId](#API_CreateSlotType_ResponseSyntax) **
The identifier for the bot associated with the slot type.
Type: String
Length Constraints: Fixed length of 10.
Pattern: `^[0-9a-zA-Z]+$`
** [botVersion](#API_CreateSlotType_ResponseSyntax) **
The version of the bot associated with the slot type.
Type: String
Length Constraints: Fixed length of 5.
Pattern: `^DRAFT$`
** [compositeSlotTypeSetting](#API_CreateSlotType_ResponseSyntax) **
Specifications for a composite slot type.
Type: [CompositeSlotTypeSetting](API_CompositeSlotTypeSetting.md) object
** [creationDateTime](#API_CreateSlotType_ResponseSyntax) **
A timestamp of the date and time that the slot type was created.
Type: Timestamp
** [description](#API_CreateSlotType_ResponseSyntax) **
The description specified for the slot type.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 2000.
** [externalSourceSetting](#API_CreateSlotType_ResponseSyntax) **
The type of external information used to create the slot type.
Type: [ExternalSourceSetting](API_ExternalSourceSetting.md) object
** [localeId](#API_CreateSlotType_ResponseSyntax) **
The specified language and local specified for the slot type.
Type: String
** [parentSlotTypeSignature](#API_CreateSlotType_ResponseSyntax) **
The signature of the base slot type specified for the slot type.
Type: String
** [slotTypeId](#API_CreateSlotType_ResponseSyntax) **
The unique identifier assigned to the slot type. Use this to identify the slot type in the `UpdateSlotType` and `DeleteSlotType` operations.
Type: String
Length Constraints: Fixed length of 10.
Pattern: `^[0-9a-zA-Z]+$`
** [slotTypeName](#API_CreateSlotType_ResponseSyntax) **
The name specified for the slot type.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern: `^([0-9a-zA-Z][_-]?){1,100}$`
** [slotTypeValues](#API_CreateSlotType_ResponseSyntax) **
The list of values that the slot type can assume.
Type: Array of [SlotTypeValue](API_SlotTypeValue.md) objects
Array Members: Minimum number of 1 item. Maximum number of 10000 items.
** [valueSelectionSetting](#API_CreateSlotType_ResponseSyntax) **
The strategy that Amazon Lex uses to select a value from the list of possible values.
Type: [SlotValueSelectionSetting](API_SlotValueSelectionSetting.md) object
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** ConflictException **
The action that you tried to perform couldn't be completed because the resource is in a conflicting state. For example, deleting a bot that is in the CREATING state. Try your request again.
HTTP Status Code: 409
** InternalServerException **
The service encountered an unexpected condition. Try your request again.
HTTP Status Code: 500
** PreconditionFailedException **
Your request couldn't be completed because one or more request fields aren't valid. Check the fields in your request and try again.
HTTP Status Code: 412
** ServiceQuotaExceededException **
You have reached a quota for your bot.
HTTP Status Code: 402
** ThrottlingException **
Your request rate is too high. Reduce the frequency of requests.
** retryAfterSeconds **
The number of seconds after which the user can invoke the API again.
HTTP Status Code: 429
** ValidationException **
One of the input parameters in your request isn't valid. Check the parameters and try your request again.
HTTP Status Code: 400
## See Also
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/models.lex.v2-2020-08-07/CreateSlotType)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/models.lex.v2-2020-08-07/CreateSlotType)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/CreateSlotType)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/models.lex.v2-2020-08-07/CreateSlotType)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/CreateSlotType)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/models.lex.v2-2020-08-07/CreateSlotType)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/models.lex.v2-2020-08-07/CreateSlotType)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/models.lex.v2-2020-08-07/CreateSlotType)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/models.lex.v2-2020-08-07/CreateSlotType)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/CreateSlotType)
# CreateTestSetDiscrepancyReport
Create a report that describes the differences between the bot and the test set.
## Request Syntax
```
POST /testsets/testSetId/testsetdiscrepancy HTTP/1.1
Content-type: application/json
{
"target": {
"botAliasTarget": {
"botAliasId": "string",
"botId": "string",
"localeId": "string"
}
}
}
```
## URI Request Parameters
The request uses the following URI parameters.
** [testSetId](#API_CreateTestSetDiscrepancyReport_RequestSyntax) **
The test set Id for the test set discrepancy report.
Length Constraints: Fixed length of 10.
Pattern: `^[0-9a-zA-Z]+$`
Required: Yes
## Request Body
The request accepts the following data in JSON format.
** [target](#API_CreateTestSetDiscrepancyReport_RequestSyntax) **
The target bot for the test set discrepancy report.
Type: [TestSetDiscrepancyReportResourceTarget](API_TestSetDiscrepancyReportResourceTarget.md) object
Required: Yes
## Response Syntax
```
HTTP/1.1 202
Content-type: application/json
{
"creationDateTime": number,
"target": {
"botAliasTarget": {
"botAliasId": "string",
"botId": "string",
"localeId": "string"
}
},
"testSetDiscrepancyReportId": "string",
"testSetId": "string"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 202 response.
The following data is returned in JSON format by the service.
** [creationDateTime](#API_CreateTestSetDiscrepancyReport_ResponseSyntax) **
The creation date and time for the test set discrepancy report.
Type: Timestamp
** [target](#API_CreateTestSetDiscrepancyReport_ResponseSyntax) **
The target bot for the test set discrepancy report.
Type: [TestSetDiscrepancyReportResourceTarget](API_TestSetDiscrepancyReportResourceTarget.md) object
** [testSetDiscrepancyReportId](#API_CreateTestSetDiscrepancyReport_ResponseSyntax) **
The unique identifier of the test set discrepancy report to describe.
Type: String
Length Constraints: Fixed length of 10.
Pattern: `^[0-9a-zA-Z]+$`
** [testSetId](#API_CreateTestSetDiscrepancyReport_ResponseSyntax) **
The test set Id for the test set discrepancy report.
Type: String
Length Constraints: Fixed length of 10.
Pattern: `^[0-9a-zA-Z]+$`
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** ConflictException **
The action that you tried to perform couldn't be completed because the resource is in a conflicting state. For example, deleting a bot that is in the CREATING state. Try your request again.
HTTP Status Code: 409
** InternalServerException **
The service encountered an unexpected condition. Try your request again.
HTTP Status Code: 500
** ResourceNotFoundException **
You asked to describe a resource that doesn't exist. Check the resource that you are requesting and try again.
HTTP Status Code: 404
** ServiceQuotaExceededException **
You have reached a quota for your bot.
HTTP Status Code: 402
** ThrottlingException **
Your request rate is too high. Reduce the frequency of requests.
** retryAfterSeconds **
The number of seconds after which the user can invoke the API again.
HTTP Status Code: 429
** ValidationException **
One of the input parameters in your request isn't valid. Check the parameters and try your request again.
HTTP Status Code: 400
## See Also
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/models.lex.v2-2020-08-07/CreateTestSetDiscrepancyReport)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/models.lex.v2-2020-08-07/CreateTestSetDiscrepancyReport)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/CreateTestSetDiscrepancyReport)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/models.lex.v2-2020-08-07/CreateTestSetDiscrepancyReport)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/CreateTestSetDiscrepancyReport)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/models.lex.v2-2020-08-07/CreateTestSetDiscrepancyReport)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/models.lex.v2-2020-08-07/CreateTestSetDiscrepancyReport)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/models.lex.v2-2020-08-07/CreateTestSetDiscrepancyReport)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/models.lex.v2-2020-08-07/CreateTestSetDiscrepancyReport)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/CreateTestSetDiscrepancyReport)
# CreateUploadUrl
Gets a pre-signed S3 write URL that you use to upload the zip archive when importing a bot or a bot locale.
## Request Syntax
```
POST /createuploadurl/ HTTP/1.1
```
## URI Request Parameters
The request does not use any URI parameters.
## Request Body
The request does not have a request body.
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"importId": "string",
"uploadUrl": "string"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [importId](#API_CreateUploadUrl_ResponseSyntax) **
An identifier for a unique import job. Use it when you call the [StartImport](https://docs.aws.amazon.com/lexv2/latest/APIReference/API_StartImport.html) operation.
Type: String
Length Constraints: Fixed length of 10.
Pattern: `^[0-9a-zA-Z]+$`
** [uploadUrl](#API_CreateUploadUrl_ResponseSyntax) **
A pre-signed S3 write URL. Upload the zip archive file that contains the definition of your bot or bot locale.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** ConflictException **
The action that you tried to perform couldn't be completed because the resource is in a conflicting state. For example, deleting a bot that is in the CREATING state. Try your request again.
HTTP Status Code: 409
** InternalServerException **
The service encountered an unexpected condition. Try your request again.
HTTP Status Code: 500
** ResourceNotFoundException **
You asked to describe a resource that doesn't exist. Check the resource that you are requesting and try again.
HTTP Status Code: 404
** ThrottlingException **
Your request rate is too high. Reduce the frequency of requests.
** retryAfterSeconds **
The number of seconds after which the user can invoke the API again.
HTTP Status Code: 429
** ValidationException **
One of the input parameters in your request isn't valid. Check the parameters and try your request again.
HTTP Status Code: 400
## See Also
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/models.lex.v2-2020-08-07/CreateUploadUrl)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/models.lex.v2-2020-08-07/CreateUploadUrl)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/CreateUploadUrl)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/models.lex.v2-2020-08-07/CreateUploadUrl)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/CreateUploadUrl)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/models.lex.v2-2020-08-07/CreateUploadUrl)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/models.lex.v2-2020-08-07/CreateUploadUrl)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/models.lex.v2-2020-08-07/CreateUploadUrl)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/models.lex.v2-2020-08-07/CreateUploadUrl)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/CreateUploadUrl)
# DeleteBot
Deletes all versions of a bot, including the `Draft` version. To delete a specific version, use the `DeleteBotVersion` operation.
When you delete a bot, all of the resources contained in the bot are also deleted. Deleting a bot removes all locales, intents, slot, and slot types defined for the bot.
If a bot has an alias, the `DeleteBot` operation returns a `ResourceInUseException` exception. If you want to delete the bot and the alias, set the `skipResourceInUseCheck` parameter to `true`.
## Request Syntax
```
DELETE /bots/botId/?skipResourceInUseCheck=skipResourceInUseCheck HTTP/1.1
```
## URI Request Parameters
The request uses the following URI parameters.
** [botId](#API_DeleteBot_RequestSyntax) **
The identifier of the bot to delete.
Length Constraints: Fixed length of 10.
Pattern: `^[0-9a-zA-Z]+$`
Required: Yes
** [skipResourceInUseCheck](#API_DeleteBot_RequestSyntax) **
By default, Amazon Lex checks if any other resource, such as an alias or bot network, is using the bot version before it is deleted and throws a `ResourceInUseException` exception if the bot is being used by another resource. Set this parameter to `true` to skip this check and remove the bot even if it is being used by another resource.
## Request Body
The request does not have a request body.
## Response Syntax
```
HTTP/1.1 202
Content-type: application/json
{
"botId": "string",
"botStatus": "string"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 202 response.
The following data is returned in JSON format by the service.
** [botId](#API_DeleteBot_ResponseSyntax) **
The unique identifier of the bot that Amazon Lex is deleting.
Type: String
Length Constraints: Fixed length of 10.
Pattern: `^[0-9a-zA-Z]+$`
** [botStatus](#API_DeleteBot_ResponseSyntax) **
The current status of the bot. The status is `Deleting` while the bot and its associated resources are being deleted.
Type: String
Valid Values: `Creating | Available | Inactive | Deleting | Failed | Versioning | Importing | Updating`
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** ConflictException **
The action that you tried to perform couldn't be completed because the resource is in a conflicting state. For example, deleting a bot that is in the CREATING state. Try your request again.
HTTP Status Code: 409
** InternalServerException **
The service encountered an unexpected condition. Try your request again.
HTTP Status Code: 500
** PreconditionFailedException **
Your request couldn't be completed because one or more request fields aren't valid. Check the fields in your request and try again.
HTTP Status Code: 412
** ServiceQuotaExceededException **
You have reached a quota for your bot.
HTTP Status Code: 402
** ThrottlingException **
Your request rate is too high. Reduce the frequency of requests.
** retryAfterSeconds **
The number of seconds after which the user can invoke the API again.
HTTP Status Code: 429
** ValidationException **
One of the input parameters in your request isn't valid. Check the parameters and try your request again.
HTTP Status Code: 400
## See Also
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/models.lex.v2-2020-08-07/DeleteBot)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/models.lex.v2-2020-08-07/DeleteBot)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/DeleteBot)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/models.lex.v2-2020-08-07/DeleteBot)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/DeleteBot)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/models.lex.v2-2020-08-07/DeleteBot)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/models.lex.v2-2020-08-07/DeleteBot)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/models.lex.v2-2020-08-07/DeleteBot)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/models.lex.v2-2020-08-07/DeleteBot)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/DeleteBot)
# DeleteBotAlias
Deletes the specified bot alias.
## Request Syntax
```
DELETE /bots/botId/botaliases/botAliasId/?skipResourceInUseCheck=skipResourceInUseCheck HTTP/1.1
```
## URI Request Parameters
The request uses the following URI parameters.
** [botAliasId](#API_DeleteBotAlias_RequestSyntax) **
The unique identifier of the bot alias to delete.
Length Constraints: Fixed length of 10.
Pattern: `^(\bTSTALIASID\b|[0-9a-zA-Z]+)$`
Required: Yes
** [botId](#API_DeleteBotAlias_RequestSyntax) **
The unique identifier of the bot associated with the alias to delete.
Length Constraints: Fixed length of 10.
Pattern: `^[0-9a-zA-Z]+$`
Required: Yes
** [skipResourceInUseCheck](#API_DeleteBotAlias_RequestSyntax) **
By default, Amazon Lex checks if any other resource, such as a bot network, is using the bot alias before it is deleted and throws a `ResourceInUseException` exception if the alias is being used by another resource. Set this parameter to `true` to skip this check and remove the alias even if it is being used by another resource.
## Request Body
The request does not have a request body.
## Response Syntax
```
HTTP/1.1 202
Content-type: application/json
{
"botAliasId": "string",
"botAliasStatus": "string",
"botId": "string"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 202 response.
The following data is returned in JSON format by the service.
** [botAliasId](#API_DeleteBotAlias_ResponseSyntax) **
The unique identifier of the bot alias to delete.
Type: String
Length Constraints: Fixed length of 10.
Pattern: `^(\bTSTALIASID\b|[0-9a-zA-Z]+)$`
** [botAliasStatus](#API_DeleteBotAlias_ResponseSyntax) **
The current status of the alias. The status is `Deleting` while the alias is in the process of being deleted. Once the alias is deleted, it will no longer appear in the list of aliases returned by the `ListBotAliases` operation.
Type: String
Valid Values: `Creating | Available | Deleting | Failed`
** [botId](#API_DeleteBotAlias_ResponseSyntax) **
The unique identifier of the bot that contains the alias to delete.
Type: String
Length Constraints: Fixed length of 10.
Pattern: `^[0-9a-zA-Z]+$`
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** ConflictException **
The action that you tried to perform couldn't be completed because the resource is in a conflicting state. For example, deleting a bot that is in the CREATING state. Try your request again.
HTTP Status Code: 409
** InternalServerException **
The service encountered an unexpected condition. Try your request again.
HTTP Status Code: 500
** PreconditionFailedException **
Your request couldn't be completed because one or more request fields aren't valid. Check the fields in your request and try again.
HTTP Status Code: 412
** ServiceQuotaExceededException **
You have reached a quota for your bot.
HTTP Status Code: 402
** ThrottlingException **
Your request rate is too high. Reduce the frequency of requests.
** retryAfterSeconds **
The number of seconds after which the user can invoke the API again.
HTTP Status Code: 429
** ValidationException **
One of the input parameters in your request isn't valid. Check the parameters and try your request again.
HTTP Status Code: 400
## See Also
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/models.lex.v2-2020-08-07/DeleteBotAlias)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/models.lex.v2-2020-08-07/DeleteBotAlias)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/DeleteBotAlias)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/models.lex.v2-2020-08-07/DeleteBotAlias)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/DeleteBotAlias)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/models.lex.v2-2020-08-07/DeleteBotAlias)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/models.lex.v2-2020-08-07/DeleteBotAlias)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/models.lex.v2-2020-08-07/DeleteBotAlias)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/models.lex.v2-2020-08-07/DeleteBotAlias)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/DeleteBotAlias)
# DeleteBotAnalyzerRecommendation
Permanently deletes the recommendations and analysis results for a specific bot analysis request. This operation is provided for GDPR compliance and cannot be undone.
After deletion, the analysis results cannot be retrieved. The analysis request ID will still appear in the history list, but attempting to describe the recommendations will return a `ResourceNotFoundException`.
## Request Syntax
```
DELETE /bots/botId/botanalyzer/botAnalyzerRequestId/ HTTP/1.1
```
## URI Request Parameters
The request uses the following URI parameters.
** [botAnalyzerRequestId](#API_DeleteBotAnalyzerRecommendation_RequestSyntax) **
The unique identifier of the analysis request whose recommendations should be deleted.
Length Constraints: Fixed length of 36.
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}`
Required: Yes
** [botId](#API_DeleteBotAnalyzerRecommendation_RequestSyntax) **
The unique identifier of the bot.
Length Constraints: Fixed length of 10.
Pattern: `^[0-9a-zA-Z]+$`
Required: Yes
## Request Body
The request does not have a request body.
## Response Syntax
```
HTTP/1.1 204
```
## Response Elements
If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** InternalServerException **
The service encountered an unexpected condition. Try your request again.
HTTP Status Code: 500
** ResourceNotFoundException **
You asked to describe a resource that doesn't exist. Check the resource that you are requesting and try again.
HTTP Status Code: 404
** ThrottlingException **
Your request rate is too high. Reduce the frequency of requests.
** retryAfterSeconds **
The number of seconds after which the user can invoke the API again.
HTTP Status Code: 429
** ValidationException **
One of the input parameters in your request isn't valid. Check the parameters and try your request again.
HTTP Status Code: 400
## Examples
### Example request
This example illustrates one usage of DeleteBotAnalyzerRecommendation.
```
DELETE https://models-v2-lex.us-east-1.amazonaws.com/bots//botanalyzer//
```
### Example response
This example illustrates one usage of DeleteBotAnalyzerRecommendation.
```
HTTP/1.1 204 No Content
```
## See Also
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/models.lex.v2-2020-08-07/DeleteBotAnalyzerRecommendation)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/models.lex.v2-2020-08-07/DeleteBotAnalyzerRecommendation)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/DeleteBotAnalyzerRecommendation)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/models.lex.v2-2020-08-07/DeleteBotAnalyzerRecommendation)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/DeleteBotAnalyzerRecommendation)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/models.lex.v2-2020-08-07/DeleteBotAnalyzerRecommendation)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/models.lex.v2-2020-08-07/DeleteBotAnalyzerRecommendation)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/models.lex.v2-2020-08-07/DeleteBotAnalyzerRecommendation)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/models.lex.v2-2020-08-07/DeleteBotAnalyzerRecommendation)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/DeleteBotAnalyzerRecommendation)
# DeleteBotLocale
Removes a locale from a bot.
When you delete a locale, all intents, slots, and slot types defined for the locale are also deleted.
## Request Syntax
```
DELETE /bots/botId/botversions/botVersion/botlocales/localeId/ HTTP/1.1
```
## URI Request Parameters
The request uses the following URI parameters.
** [botId](#API_DeleteBotLocale_RequestSyntax) **
The unique identifier of the bot that contains the locale.
Length Constraints: Fixed length of 10.
Pattern: `^[0-9a-zA-Z]+$`
Required: Yes
** [botVersion](#API_DeleteBotLocale_RequestSyntax) **
The version of the bot that contains the locale.
Length Constraints: Fixed length of 5.
Pattern: `^DRAFT$`
Required: Yes
** [localeId](#API_DeleteBotLocale_RequestSyntax) **
The identifier of the language and locale that will be deleted. The string must match one of the supported locales. For more information, see [Supported languages](https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html).
Required: Yes
## Request Body
The request does not have a request body.
## Response Syntax
```
HTTP/1.1 202
Content-type: application/json
{
"botId": "string",
"botLocaleStatus": "string",
"botVersion": "string",
"localeId": "string"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 202 response.
The following data is returned in JSON format by the service.
** [botId](#API_DeleteBotLocale_ResponseSyntax) **
The identifier of the bot that contained the deleted locale.
Type: String
Length Constraints: Fixed length of 10.
Pattern: `^[0-9a-zA-Z]+$`
** [botLocaleStatus](#API_DeleteBotLocale_ResponseSyntax) **
The status of deleting the bot locale. The locale first enters the `Deleting` status. Once the locale is deleted it no longer appears in the list of locales for the bot.
Type: String
Valid Values: `Creating | Building | Built | ReadyExpressTesting | Failed | Deleting | NotBuilt | Importing | Processing`
** [botVersion](#API_DeleteBotLocale_ResponseSyntax) **
The version of the bot that contained the deleted locale.
Type: String
Length Constraints: Fixed length of 5.
Pattern: `^DRAFT$`
** [localeId](#API_DeleteBotLocale_ResponseSyntax) **
The language and locale of the deleted locale.
Type: String
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** ConflictException **
The action that you tried to perform couldn't be completed because the resource is in a conflicting state. For example, deleting a bot that is in the CREATING state. Try your request again.
HTTP Status Code: 409
** InternalServerException **
The service encountered an unexpected condition. Try your request again.
HTTP Status Code: 500
** PreconditionFailedException **
Your request couldn't be completed because one or more request fields aren't valid. Check the fields in your request and try again.
HTTP Status Code: 412
** ServiceQuotaExceededException **
You have reached a quota for your bot.
HTTP Status Code: 402
** ThrottlingException **
Your request rate is too high. Reduce the frequency of requests.
** retryAfterSeconds **
The number of seconds after which the user can invoke the API again.
HTTP Status Code: 429
** ValidationException **
One of the input parameters in your request isn't valid. Check the parameters and try your request again.
HTTP Status Code: 400
## See Also
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/models.lex.v2-2020-08-07/DeleteBotLocale)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/models.lex.v2-2020-08-07/DeleteBotLocale)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/DeleteBotLocale)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/models.lex.v2-2020-08-07/DeleteBotLocale)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/DeleteBotLocale)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/models.lex.v2-2020-08-07/DeleteBotLocale)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/models.lex.v2-2020-08-07/DeleteBotLocale)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/models.lex.v2-2020-08-07/DeleteBotLocale)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/models.lex.v2-2020-08-07/DeleteBotLocale)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/DeleteBotLocale)
# DeleteBotReplica
The action to delete the replicated bot in the secondary region.
## Request Syntax
```
DELETE /bots/botId/replicas/replicaRegion/ HTTP/1.1
```
## URI Request Parameters
The request uses the following URI parameters.
** [botId](#API_DeleteBotReplica_RequestSyntax) **
The unique ID of the replicated bot to be deleted from the secondary region
Length Constraints: Fixed length of 10.
Pattern: `^[0-9a-zA-Z]+$`
Required: Yes
** [replicaRegion](#API_DeleteBotReplica_RequestSyntax) **
The secondary region of the replicated bot that will be deleted.
Length Constraints: Minimum length of 2. Maximum length of 25.
Required: Yes
## Request Body
The request does not have a request body.
## Response Syntax
```
HTTP/1.1 202
Content-type: application/json
{
"botId": "string",
"botReplicaStatus": "string",
"replicaRegion": "string"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 202 response.
The following data is returned in JSON format by the service.
** [botId](#API_DeleteBotReplica_ResponseSyntax) **
The unique bot ID of the replicated bot generated.
Type: String
Length Constraints: Fixed length of 10.
Pattern: `^[0-9a-zA-Z]+$`
** [botReplicaStatus](#API_DeleteBotReplica_ResponseSyntax) **
The operational status of the replicated bot generated.
Type: String
Valid Values: `Enabling | Enabled | Deleting | Failed`
** [replicaRegion](#API_DeleteBotReplica_ResponseSyntax) **
The region of the replicated bot generated.
Type: String
Length Constraints: Minimum length of 2. Maximum length of 25.
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** ConflictException **
The action that you tried to perform couldn't be completed because the resource is in a conflicting state. For example, deleting a bot that is in the CREATING state. Try your request again.
HTTP Status Code: 409
** InternalServerException **
The service encountered an unexpected condition. Try your request again.
HTTP Status Code: 500
** PreconditionFailedException **
Your request couldn't be completed because one or more request fields aren't valid. Check the fields in your request and try again.
HTTP Status Code: 412
** ServiceQuotaExceededException **
You have reached a quota for your bot.
HTTP Status Code: 402
** ThrottlingException **
Your request rate is too high. Reduce the frequency of requests.
** retryAfterSeconds **
The number of seconds after which the user can invoke the API again.
HTTP Status Code: 429
** ValidationException **
One of the input parameters in your request isn't valid. Check the parameters and try your request again.
HTTP Status Code: 400
## Examples
### This example illustrates one example input of DeleteBotReplica.
This example illustrates one usage of DeleteBotReplica.
```
DELETE https://models-v2-lex.us-east-1.amazonaws.com/bots/BOT1234567/replicas/us-west-2
{
"replicaRegion": "us-west-2"
}
```
### This example illustrates one example response of DeleteBotReplica.
This example illustrates one usage of DeleteBotReplica.
```
{
"botId": "BOT1234567",
"botReplicaStatus": "Deleting",
"replicaRegion": "us-west-2"
}
```
## See Also
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/models.lex.v2-2020-08-07/DeleteBotReplica)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/models.lex.v2-2020-08-07/DeleteBotReplica)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/DeleteBotReplica)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/models.lex.v2-2020-08-07/DeleteBotReplica)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/DeleteBotReplica)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/models.lex.v2-2020-08-07/DeleteBotReplica)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/models.lex.v2-2020-08-07/DeleteBotReplica)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/models.lex.v2-2020-08-07/DeleteBotReplica)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/models.lex.v2-2020-08-07/DeleteBotReplica)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/DeleteBotReplica)
# DeleteBotVersion
Deletes a specific version of a bot. To delete all versions of a bot, use the [DeleteBot](https://docs.aws.amazon.com/lexv2/latest/APIReference/API_DeleteBot.html) operation.
## Request Syntax
```
DELETE /bots/botId/botversions/botVersion/?skipResourceInUseCheck=skipResourceInUseCheck HTTP/1.1
```
## URI Request Parameters
The request uses the following URI parameters.
** [botId](#API_DeleteBotVersion_RequestSyntax) **
The identifier of the bot that contains the version.
Length Constraints: Fixed length of 10.
Pattern: `^[0-9a-zA-Z]+$`
Required: Yes
** [botVersion](#API_DeleteBotVersion_RequestSyntax) **
The version of the bot to delete.
Length Constraints: Minimum length of 1. Maximum length of 5.
Pattern: `^[0-9]+$`
Required: Yes
** [skipResourceInUseCheck](#API_DeleteBotVersion_RequestSyntax) **
By default, Amazon Lex checks if any other resource, such as an alias or bot network, is using the bot version before it is deleted and throws a `ResourceInUseException` exception if the version is being used by another resource. Set this parameter to `true` to skip this check and remove the version even if it is being used by another resource.
## Request Body
The request does not have a request body.
## Response Syntax
```
HTTP/1.1 202
Content-type: application/json
{
"botId": "string",
"botStatus": "string",
"botVersion": "string"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 202 response.
The following data is returned in JSON format by the service.
** [botId](#API_DeleteBotVersion_ResponseSyntax) **
The identifier of the bot that is being deleted.
Type: String
Length Constraints: Fixed length of 10.
Pattern: `^[0-9a-zA-Z]+$`
** [botStatus](#API_DeleteBotVersion_ResponseSyntax) **
The current status of the bot.
Type: String
Valid Values: `Creating | Available | Inactive | Deleting | Failed | Versioning | Importing | Updating`
** [botVersion](#API_DeleteBotVersion_ResponseSyntax) **
The version of the bot that is being deleted.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 5.
Pattern: `^[0-9]+$`
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** ConflictException **
The action that you tried to perform couldn't be completed because the resource is in a conflicting state. For example, deleting a bot that is in the CREATING state. Try your request again.
HTTP Status Code: 409
** InternalServerException **
The service encountered an unexpected condition. Try your request again.
HTTP Status Code: 500
** PreconditionFailedException **
Your request couldn't be completed because one or more request fields aren't valid. Check the fields in your request and try again.
HTTP Status Code: 412
** ServiceQuotaExceededException **
You have reached a quota for your bot.
HTTP Status Code: 402
** ThrottlingException **
Your request rate is too high. Reduce the frequency of requests.
** retryAfterSeconds **
The number of seconds after which the user can invoke the API again.
HTTP Status Code: 429
** ValidationException **
One of the input parameters in your request isn't valid. Check the parameters and try your request again.
HTTP Status Code: 400
## See Also
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/models.lex.v2-2020-08-07/DeleteBotVersion)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/models.lex.v2-2020-08-07/DeleteBotVersion)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/DeleteBotVersion)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/models.lex.v2-2020-08-07/DeleteBotVersion)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/DeleteBotVersion)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/models.lex.v2-2020-08-07/DeleteBotVersion)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/models.lex.v2-2020-08-07/DeleteBotVersion)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/models.lex.v2-2020-08-07/DeleteBotVersion)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/models.lex.v2-2020-08-07/DeleteBotVersion)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/DeleteBotVersion)
# DeleteCustomVocabulary
Removes a custom vocabulary from the specified locale in the specified bot.
## Request Syntax
```
DELETE /bots/botId/botversions/botVersion/botlocales/localeId/customvocabulary HTTP/1.1
```
## URI Request Parameters
The request uses the following URI parameters.
** [botId](#API_DeleteCustomVocabulary_RequestSyntax) **
The unique identifier of the bot to remove the custom vocabulary from.
Length Constraints: Fixed length of 10.
Pattern: `^[0-9a-zA-Z]+$`
Required: Yes
** [botVersion](#API_DeleteCustomVocabulary_RequestSyntax) **
The version of the bot to remove the custom vocabulary from.
Length Constraints: Fixed length of 5.
Pattern: `^DRAFT$`
Required: Yes
** [localeId](#API_DeleteCustomVocabulary_RequestSyntax) **
The locale identifier for the locale that contains the custom vocabulary to remove.
Required: Yes
## Request Body
The request does not have a request body.
## Response Syntax
```
HTTP/1.1 202
Content-type: application/json
{
"botId": "string",
"botVersion": "string",
"customVocabularyStatus": "string",
"localeId": "string"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 202 response.
The following data is returned in JSON format by the service.
** [botId](#API_DeleteCustomVocabulary_ResponseSyntax) **
The identifier of the bot that the custom vocabulary was removed from.
Type: String
Length Constraints: Fixed length of 10.
Pattern: `^[0-9a-zA-Z]+$`
** [botVersion](#API_DeleteCustomVocabulary_ResponseSyntax) **
The version of the bot that the custom vocabulary was removed from.
Type: String
Length Constraints: Fixed length of 5.
Pattern: `^DRAFT$`
** [customVocabularyStatus](#API_DeleteCustomVocabulary_ResponseSyntax) **
The status of removing the custom vocabulary.
Type: String
Valid Values: `Ready | Deleting | Exporting | Importing | Creating`
** [localeId](#API_DeleteCustomVocabulary_ResponseSyntax) **
The locale identifier for the locale that the custom vocabulary was removed from.
Type: String
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** ConflictException **
The action that you tried to perform couldn't be completed because the resource is in a conflicting state. For example, deleting a bot that is in the CREATING state. Try your request again.
HTTP Status Code: 409
** InternalServerException **
The service encountered an unexpected condition. Try your request again.
HTTP Status Code: 500
** PreconditionFailedException **
Your request couldn't be completed because one or more request fields aren't valid. Check the fields in your request and try again.
HTTP Status Code: 412
** ServiceQuotaExceededException **
You have reached a quota for your bot.
HTTP Status Code: 402
** ThrottlingException **
Your request rate is too high. Reduce the frequency of requests.
** retryAfterSeconds **
The number of seconds after which the user can invoke the API again.
HTTP Status Code: 429
** ValidationException **
One of the input parameters in your request isn't valid. Check the parameters and try your request again.
HTTP Status Code: 400
## See Also
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/models.lex.v2-2020-08-07/DeleteCustomVocabulary)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/models.lex.v2-2020-08-07/DeleteCustomVocabulary)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/DeleteCustomVocabulary)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/models.lex.v2-2020-08-07/DeleteCustomVocabulary)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/DeleteCustomVocabulary)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/models.lex.v2-2020-08-07/DeleteCustomVocabulary)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/models.lex.v2-2020-08-07/DeleteCustomVocabulary)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/models.lex.v2-2020-08-07/DeleteCustomVocabulary)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/models.lex.v2-2020-08-07/DeleteCustomVocabulary)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/DeleteCustomVocabulary)
# DeleteExport
Removes a previous export and the associated files stored in an S3 bucket.
## Request Syntax
```
DELETE /exports/exportId/ HTTP/1.1
```
## URI Request Parameters
The request uses the following URI parameters.
** [exportId](#API_DeleteExport_RequestSyntax) **
The unique identifier of the export to delete.
Length Constraints: Fixed length of 10.
Pattern: `^[0-9a-zA-Z]+$`
Required: Yes
## Request Body
The request does not have a request body.
## Response Syntax
```
HTTP/1.1 202
Content-type: application/json
{
"exportId": "string",
"exportStatus": "string"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 202 response.
The following data is returned in JSON format by the service.
** [exportId](#API_DeleteExport_ResponseSyntax) **
The unique identifier of the deleted export.
Type: String
Length Constraints: Fixed length of 10.
Pattern: `^[0-9a-zA-Z]+$`
** [exportStatus](#API_DeleteExport_ResponseSyntax) **
The current status of the deletion. When the deletion is complete, the export will no longer be returned by the [ListExports](https://docs.aws.amazon.com/lexv2/latest/APIReference/API_ListExports.html) operation and calls to the [ DescribeExport](https://docs.aws.amazon.com/lexv2/latest/APIReference/API_DescribeExport.html) operation with the export identifier will fail.
Type: String
Valid Values: `InProgress | Completed | Failed | Deleting`
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** InternalServerException **
The service encountered an unexpected condition. Try your request again.
HTTP Status Code: 500
** PreconditionFailedException **
Your request couldn't be completed because one or more request fields aren't valid. Check the fields in your request and try again.
HTTP Status Code: 412
** ServiceQuotaExceededException **
You have reached a quota for your bot.
HTTP Status Code: 402
** ThrottlingException **
Your request rate is too high. Reduce the frequency of requests.
** retryAfterSeconds **
The number of seconds after which the user can invoke the API again.
HTTP Status Code: 429
** ValidationException **
One of the input parameters in your request isn't valid. Check the parameters and try your request again.
HTTP Status Code: 400
## See Also
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/models.lex.v2-2020-08-07/DeleteExport)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/models.lex.v2-2020-08-07/DeleteExport)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/DeleteExport)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/models.lex.v2-2020-08-07/DeleteExport)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/DeleteExport)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/models.lex.v2-2020-08-07/DeleteExport)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/models.lex.v2-2020-08-07/DeleteExport)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/models.lex.v2-2020-08-07/DeleteExport)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/models.lex.v2-2020-08-07/DeleteExport)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/DeleteExport)
# DeleteImport
Removes a previous import and the associated file stored in an S3 bucket.
## Request Syntax
```
DELETE /imports/importId/ HTTP/1.1
```
## URI Request Parameters
The request uses the following URI parameters.
** [importId](#API_DeleteImport_RequestSyntax) **
The unique identifier of the import to delete.
Length Constraints: Fixed length of 10.
Pattern: `^[0-9a-zA-Z]+$`
Required: Yes
## Request Body
The request does not have a request body.
## Response Syntax
```
HTTP/1.1 202
Content-type: application/json
{
"importId": "string",
"importStatus": "string"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 202 response.
The following data is returned in JSON format by the service.
** [importId](#API_DeleteImport_ResponseSyntax) **
The unique identifier of the deleted import.
Type: String
Length Constraints: Fixed length of 10.
Pattern: `^[0-9a-zA-Z]+$`
** [importStatus](#API_DeleteImport_ResponseSyntax) **
The current status of the deletion. When the deletion is complete, the import will no longer be returned by the [ListImports](https://docs.aws.amazon.com/lexv2/latest/APIReference/API_ListImports.html) operation and calls to the [DescribeImport](https://docs.aws.amazon.com/lexv2/latest/APIReference/API_DescribeImport.html) operation with the import identifier will fail.
Type: String
Valid Values: `InProgress | Completed | Failed | Deleting`
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** InternalServerException **
The service encountered an unexpected condition. Try your request again.
HTTP Status Code: 500
** PreconditionFailedException **
Your request couldn't be completed because one or more request fields aren't valid. Check the fields in your request and try again.
HTTP Status Code: 412
** ServiceQuotaExceededException **
You have reached a quota for your bot.
HTTP Status Code: 402
** ThrottlingException **
Your request rate is too high. Reduce the frequency of requests.
** retryAfterSeconds **
The number of seconds after which the user can invoke the API again.
HTTP Status Code: 429
** ValidationException **
One of the input parameters in your request isn't valid. Check the parameters and try your request again.
HTTP Status Code: 400
## See Also
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/models.lex.v2-2020-08-07/DeleteImport)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/models.lex.v2-2020-08-07/DeleteImport)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/DeleteImport)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/models.lex.v2-2020-08-07/DeleteImport)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/DeleteImport)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/models.lex.v2-2020-08-07/DeleteImport)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/models.lex.v2-2020-08-07/DeleteImport)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/models.lex.v2-2020-08-07/DeleteImport)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/models.lex.v2-2020-08-07/DeleteImport)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/DeleteImport)
# DeleteIntent
Removes the specified intent.
Deleting an intent also deletes the slots associated with the intent.
## Request Syntax
```
DELETE /bots/botId/botversions/botVersion/botlocales/localeId/intents/intentId/ HTTP/1.1
```
## URI Request Parameters
The request uses the following URI parameters.
** [botId](#API_DeleteIntent_RequestSyntax) **
The identifier of the bot associated with the intent.
Length Constraints: Fixed length of 10.
Pattern: `^[0-9a-zA-Z]+$`
Required: Yes
** [botVersion](#API_DeleteIntent_RequestSyntax) **
The version of the bot associated with the intent.
Length Constraints: Fixed length of 5.
Pattern: `^DRAFT$`
Required: Yes
** [intentId](#API_DeleteIntent_RequestSyntax) **
The unique identifier of the intent to delete.
Length Constraints: Fixed length of 10.
Pattern: `^[0-9a-zA-Z]+$`
Required: Yes
** [localeId](#API_DeleteIntent_RequestSyntax) **
The identifier of the language and locale where the bot will be deleted. The string must match one of the supported locales. For more information, see [Supported languages](https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html).
Required: Yes
## Request Body
The request does not have a request body.
## Response Syntax
```
HTTP/1.1 204
```
## Response Elements
If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** ConflictException **
The action that you tried to perform couldn't be completed because the resource is in a conflicting state. For example, deleting a bot that is in the CREATING state. Try your request again.
HTTP Status Code: 409
** InternalServerException **
The service encountered an unexpected condition. Try your request again.
HTTP Status Code: 500
** PreconditionFailedException **
Your request couldn't be completed because one or more request fields aren't valid. Check the fields in your request and try again.
HTTP Status Code: 412
** ServiceQuotaExceededException **
You have reached a quota for your bot.
HTTP Status Code: 402
** ThrottlingException **
Your request rate is too high. Reduce the frequency of requests.
** retryAfterSeconds **
The number of seconds after which the user can invoke the API again.
HTTP Status Code: 429
** ValidationException **
One of the input parameters in your request isn't valid. Check the parameters and try your request again.
HTTP Status Code: 400
## See Also
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/models.lex.v2-2020-08-07/DeleteIntent)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/models.lex.v2-2020-08-07/DeleteIntent)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/DeleteIntent)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/models.lex.v2-2020-08-07/DeleteIntent)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/DeleteIntent)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/models.lex.v2-2020-08-07/DeleteIntent)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/models.lex.v2-2020-08-07/DeleteIntent)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/models.lex.v2-2020-08-07/DeleteIntent)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/models.lex.v2-2020-08-07/DeleteIntent)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/DeleteIntent)
# DeleteResourcePolicy
Removes an existing policy from a bot or bot alias. If the resource doesn't have a policy attached, Amazon Lex returns an exception.
## Request Syntax
```
DELETE /policy/resourceArn/?expectedRevisionId=expectedRevisionId HTTP/1.1
```
## URI Request Parameters
The request uses the following URI parameters.
** [expectedRevisionId](#API_DeleteResourcePolicy_RequestSyntax) **
The identifier of the revision to edit. If this ID doesn't match the current revision number, Amazon Lex returns an exception
If you don't specify a revision ID, Amazon Lex will delete the current policy.
Length Constraints: Minimum length of 1. Maximum length of 5.
Pattern: `^[0-9]+$`
** [resourceArn](#API_DeleteResourcePolicy_RequestSyntax) **
The Amazon Resource Name (ARN) of the bot or bot alias that has the resource policy attached.
Length Constraints: Minimum length of 1. Maximum length of 1011.
Required: Yes
## Request Body
The request does not have a request body.
## Response Syntax
```
HTTP/1.1 204
Content-type: application/json
{
"resourceArn": "string",
"revisionId": "string"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 204 response.
The following data is returned in JSON format by the service.
** [resourceArn](#API_DeleteResourcePolicy_ResponseSyntax) **
The Amazon Resource Name (ARN) of the bot or bot alias that the resource policy was deleted from.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1011.
** [revisionId](#API_DeleteResourcePolicy_ResponseSyntax) **
The current revision of the resource policy. Use the revision ID to make sure that you are updating the most current version of a resource policy when you add a policy statement to a resource, delete a resource, or update a resource.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 5.
Pattern: `^[0-9]+$`
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** InternalServerException **
The service encountered an unexpected condition. Try your request again.
HTTP Status Code: 500
** PreconditionFailedException **
Your request couldn't be completed because one or more request fields aren't valid. Check the fields in your request and try again.
HTTP Status Code: 412
** ResourceNotFoundException **
You asked to describe a resource that doesn't exist. Check the resource that you are requesting and try again.
HTTP Status Code: 404
** ThrottlingException **
Your request rate is too high. Reduce the frequency of requests.
** retryAfterSeconds **
The number of seconds after which the user can invoke the API again.
HTTP Status Code: 429
## See Also
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/models.lex.v2-2020-08-07/DeleteResourcePolicy)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/models.lex.v2-2020-08-07/DeleteResourcePolicy)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/DeleteResourcePolicy)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/models.lex.v2-2020-08-07/DeleteResourcePolicy)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/DeleteResourcePolicy)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/models.lex.v2-2020-08-07/DeleteResourcePolicy)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/models.lex.v2-2020-08-07/DeleteResourcePolicy)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/models.lex.v2-2020-08-07/DeleteResourcePolicy)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/models.lex.v2-2020-08-07/DeleteResourcePolicy)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/DeleteResourcePolicy)
# DeleteResourcePolicyStatement
Deletes a policy statement from a resource policy. If you delete the last statement from a policy, the policy is deleted. If you specify a statement ID that doesn't exist in the policy, or if the bot or bot alias doesn't have a policy attached, Amazon Lex returns an exception.
You need to add the `DeleteResourcePolicy` or `UpdateResourcePolicy` action to the bot role in order to call the API.
## Request Syntax
```
DELETE /policy/resourceArn/statements/statementId/?expectedRevisionId=expectedRevisionId HTTP/1.1
```
## URI Request Parameters
The request uses the following URI parameters.
** [expectedRevisionId](#API_DeleteResourcePolicyStatement_RequestSyntax) **
The identifier of the revision of the policy to delete the statement from. If this revision ID doesn't match the current revision ID, Amazon Lex throws an exception.
If you don't specify a revision, Amazon Lex removes the current contents of the statement.
Length Constraints: Minimum length of 1. Maximum length of 5.
Pattern: `^[0-9]+$`
** [resourceArn](#API_DeleteResourcePolicyStatement_RequestSyntax) **
The Amazon Resource Name (ARN) of the bot or bot alias that the resource policy is attached to.
Length Constraints: Minimum length of 1. Maximum length of 1011.
Required: Yes
** [statementId](#API_DeleteResourcePolicyStatement_RequestSyntax) **
The name of the statement (SID) to delete from the policy.
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern: `^([0-9a-zA-Z][_-]?){1,100}$`
Required: Yes
## Request Body
The request does not have a request body.
## Response Syntax
```
HTTP/1.1 204
Content-type: application/json
{
"resourceArn": "string",
"revisionId": "string"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 204 response.
The following data is returned in JSON format by the service.
** [resourceArn](#API_DeleteResourcePolicyStatement_ResponseSyntax) **
The Amazon Resource Name (ARN) of the bot or bot alias that the resource policy statement was removed from.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1011.
** [revisionId](#API_DeleteResourcePolicyStatement_ResponseSyntax) **
The current revision of the resource policy. Use the revision ID to make sure that you are updating the most current version of a resource policy when you add a policy statement to a resource, delete a resource, or update a resource.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 5.
Pattern: `^[0-9]+$`
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** InternalServerException **
The service encountered an unexpected condition. Try your request again.
HTTP Status Code: 500
** PreconditionFailedException **
Your request couldn't be completed because one or more request fields aren't valid. Check the fields in your request and try again.
HTTP Status Code: 412
** ResourceNotFoundException **
You asked to describe a resource that doesn't exist. Check the resource that you are requesting and try again.
HTTP Status Code: 404
** ThrottlingException **
Your request rate is too high. Reduce the frequency of requests.
** retryAfterSeconds **
The number of seconds after which the user can invoke the API again.
HTTP Status Code: 429
## See Also
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/models.lex.v2-2020-08-07/DeleteResourcePolicyStatement)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/models.lex.v2-2020-08-07/DeleteResourcePolicyStatement)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/DeleteResourcePolicyStatement)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/models.lex.v2-2020-08-07/DeleteResourcePolicyStatement)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/DeleteResourcePolicyStatement)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/models.lex.v2-2020-08-07/DeleteResourcePolicyStatement)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/models.lex.v2-2020-08-07/DeleteResourcePolicyStatement)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/models.lex.v2-2020-08-07/DeleteResourcePolicyStatement)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/models.lex.v2-2020-08-07/DeleteResourcePolicyStatement)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/DeleteResourcePolicyStatement)
# DeleteSlot
Deletes the specified slot from an intent.
## Request Syntax
```
DELETE /bots/botId/botversions/botVersion/botlocales/localeId/intents/intentId/slots/slotId/ HTTP/1.1
```
## URI Request Parameters
The request uses the following URI parameters.
** [botId](#API_DeleteSlot_RequestSyntax) **
The identifier of the bot associated with the slot to delete.
Length Constraints: Fixed length of 10.
Pattern: `^[0-9a-zA-Z]+$`
Required: Yes
** [botVersion](#API_DeleteSlot_RequestSyntax) **
The version of the bot associated with the slot to delete.
Length Constraints: Fixed length of 5.
Pattern: `^DRAFT$`
Required: Yes
** [intentId](#API_DeleteSlot_RequestSyntax) **
The identifier of the intent associated with the slot.
Length Constraints: Fixed length of 10.
Pattern: `^[0-9a-zA-Z]+$`
Required: Yes
** [localeId](#API_DeleteSlot_RequestSyntax) **
The identifier of the language and locale that the slot will be deleted from. The string must match one of the supported locales. For more information, see [Supported languages](https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html).
Required: Yes
** [slotId](#API_DeleteSlot_RequestSyntax) **
The identifier of the slot to delete.
Length Constraints: Fixed length of 10.
Pattern: `^[0-9a-zA-Z]+$`
Required: Yes
## Request Body
The request does not have a request body.
## Response Syntax
```
HTTP/1.1 204
```
## Response Elements
If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** ConflictException **
The action that you tried to perform couldn't be completed because the resource is in a conflicting state. For example, deleting a bot that is in the CREATING state. Try your request again.
HTTP Status Code: 409
** InternalServerException **
The service encountered an unexpected condition. Try your request again.
HTTP Status Code: 500
** PreconditionFailedException **
Your request couldn't be completed because one or more request fields aren't valid. Check the fields in your request and try again.
HTTP Status Code: 412
** ServiceQuotaExceededException **
You have reached a quota for your bot.
HTTP Status Code: 402
** ThrottlingException **
Your request rate is too high. Reduce the frequency of requests.
** retryAfterSeconds **
The number of seconds after which the user can invoke the API again.
HTTP Status Code: 429
** ValidationException **
One of the input parameters in your request isn't valid. Check the parameters and try your request again.
HTTP Status Code: 400
## See Also
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/models.lex.v2-2020-08-07/DeleteSlot)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/models.lex.v2-2020-08-07/DeleteSlot)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/DeleteSlot)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/models.lex.v2-2020-08-07/DeleteSlot)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/DeleteSlot)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/models.lex.v2-2020-08-07/DeleteSlot)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/models.lex.v2-2020-08-07/DeleteSlot)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/models.lex.v2-2020-08-07/DeleteSlot)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/models.lex.v2-2020-08-07/DeleteSlot)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/DeleteSlot)
# DeleteSlotType
Deletes a slot type from a bot locale.
If a slot is using the slot type, Amazon Lex throws a `ResourceInUseException` exception. To avoid the exception, set the `skipResourceInUseCheck` parameter to `true`.
## Request Syntax
```
DELETE /bots/botId/botversions/botVersion/botlocales/localeId/slottypes/slotTypeId/?skipResourceInUseCheck=skipResourceInUseCheck HTTP/1.1
```
## URI Request Parameters
The request uses the following URI parameters.
** [botId](#API_DeleteSlotType_RequestSyntax) **
The identifier of the bot associated with the slot type.
Length Constraints: Fixed length of 10.
Pattern: `^[0-9a-zA-Z]+$`
Required: Yes
** [botVersion](#API_DeleteSlotType_RequestSyntax) **
The version of the bot associated with the slot type.
Length Constraints: Fixed length of 5.
Pattern: `^DRAFT$`
Required: Yes
** [localeId](#API_DeleteSlotType_RequestSyntax) **
The identifier of the language and locale that the slot type will be deleted from. The string must match one of the supported locales. For more information, see [Supported languages](https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html).
Required: Yes
** [skipResourceInUseCheck](#API_DeleteSlotType_RequestSyntax) **
By default, the `DeleteSlotType` operations throws a `ResourceInUseException` exception if you try to delete a slot type used by a slot. Set the `skipResourceInUseCheck` parameter to `true` to skip this check and remove the slot type even if a slot uses it.
** [slotTypeId](#API_DeleteSlotType_RequestSyntax) **
The identifier of the slot type to delete.
Length Constraints: Fixed length of 10.
Pattern: `^[0-9a-zA-Z]+$`
Required: Yes
## Request Body
The request does not have a request body.
## Response Syntax
```
HTTP/1.1 204
```
## Response Elements
If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** ConflictException **
The action that you tried to perform couldn't be completed because the resource is in a conflicting state. For example, deleting a bot that is in the CREATING state. Try your request again.
HTTP Status Code: 409
** InternalServerException **
The service encountered an unexpected condition. Try your request again.
HTTP Status Code: 500
** PreconditionFailedException **
Your request couldn't be completed because one or more request fields aren't valid. Check the fields in your request and try again.
HTTP Status Code: 412
** ServiceQuotaExceededException **
You have reached a quota for your bot.
HTTP Status Code: 402
** ThrottlingException **
Your request rate is too high. Reduce the frequency of requests.
** retryAfterSeconds **
The number of seconds after which the user can invoke the API again.
HTTP Status Code: 429
** ValidationException **
One of the input parameters in your request isn't valid. Check the parameters and try your request again.
HTTP Status Code: 400
## See Also
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/models.lex.v2-2020-08-07/DeleteSlotType)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/models.lex.v2-2020-08-07/DeleteSlotType)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/DeleteSlotType)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/models.lex.v2-2020-08-07/DeleteSlotType)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/DeleteSlotType)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/models.lex.v2-2020-08-07/DeleteSlotType)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/models.lex.v2-2020-08-07/DeleteSlotType)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/models.lex.v2-2020-08-07/DeleteSlotType)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/models.lex.v2-2020-08-07/DeleteSlotType)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/DeleteSlotType)
# DeleteTestSet
The action to delete the selected test set.
## Request Syntax
```
DELETE /testsets/testSetId HTTP/1.1
```
## URI Request Parameters
The request uses the following URI parameters.
** [testSetId](#API_DeleteTestSet_RequestSyntax) **
The test set Id of the test set to be deleted.
Length Constraints: Fixed length of 10.
Pattern: `^[0-9a-zA-Z]+$`
Required: Yes
## Request Body
The request does not have a request body.
## Response Syntax
```
HTTP/1.1 204
```
## Response Elements
If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** ConflictException **
The action that you tried to perform couldn't be completed because the resource is in a conflicting state. For example, deleting a bot that is in the CREATING state. Try your request again.
HTTP Status Code: 409
** InternalServerException **
The service encountered an unexpected condition. Try your request again.
HTTP Status Code: 500
** PreconditionFailedException **
Your request couldn't be completed because one or more request fields aren't valid. Check the fields in your request and try again.
HTTP Status Code: 412
** ServiceQuotaExceededException **
You have reached a quota for your bot.
HTTP Status Code: 402
** ThrottlingException **
Your request rate is too high. Reduce the frequency of requests.
** retryAfterSeconds **
The number of seconds after which the user can invoke the API again.
HTTP Status Code: 429
** ValidationException **
One of the input parameters in your request isn't valid. Check the parameters and try your request again.
HTTP Status Code: 400
## See Also
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/models.lex.v2-2020-08-07/DeleteTestSet)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/models.lex.v2-2020-08-07/DeleteTestSet)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/DeleteTestSet)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/models.lex.v2-2020-08-07/DeleteTestSet)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/DeleteTestSet)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/models.lex.v2-2020-08-07/DeleteTestSet)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/models.lex.v2-2020-08-07/DeleteTestSet)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/models.lex.v2-2020-08-07/DeleteTestSet)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/models.lex.v2-2020-08-07/DeleteTestSet)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/DeleteTestSet)
# DeleteUtterances
Deletes stored utterances.
Amazon Lex stores the utterances that users send to your bot. Utterances are stored for 15 days for use with the [ListAggregatedUtterances](https://docs.aws.amazon.com/lexv2/latest/APIReference/API_ListAggregatedUtterances.html) 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 utterances for a specific session. 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 `ListAggregatedUtterances` operation are deleted after 15 days.
## Request Syntax
```
DELETE /bots/botId/utterances/?localeId=localeId&sessionId=sessionId HTTP/1.1
```
## URI Request Parameters
The request uses the following URI parameters.
** [botId](#API_DeleteUtterances_RequestSyntax) **
The unique identifier of the bot that contains the utterances.
Length Constraints: Fixed length of 10.
Pattern: `^[0-9a-zA-Z]+$`
Required: Yes
** [localeId](#API_DeleteUtterances_RequestSyntax) **
The identifier of the language and locale where the utterances were collected. The string must match one of the supported locales. For more information, see [Supported languages](https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html).
** [sessionId](#API_DeleteUtterances_RequestSyntax) **
The unique identifier of the session with the user. The ID is returned in the response from the [RecognizeText](https://docs.aws.amazon.com/lexv2/latest/APIReference/API_runtime_RecognizeText.html) and [RecognizeUtterance](https://docs.aws.amazon.com/lexv2/latest/APIReference/API_runtime_RecognizeUtterance.html) operations.
Length Constraints: Minimum length of 2. Maximum length of 100.
Pattern: `[0-9a-zA-Z._:-]+`
## Request Body
The request does not have a request body.
## Response Syntax
```
HTTP/1.1 204
```
## Response Elements
If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** InternalServerException **
The service encountered an unexpected condition. Try your request again.
HTTP Status Code: 500
** ThrottlingException **
Your request rate is too high. Reduce the frequency of requests.
** retryAfterSeconds **
The number of seconds after which the user can invoke the API again.
HTTP Status Code: 429
** ValidationException **
One of the input parameters in your request isn't valid. Check the parameters and try your request again.
HTTP Status Code: 400
## See Also
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/models.lex.v2-2020-08-07/DeleteUtterances)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/models.lex.v2-2020-08-07/DeleteUtterances)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/DeleteUtterances)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/models.lex.v2-2020-08-07/DeleteUtterances)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/DeleteUtterances)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/models.lex.v2-2020-08-07/DeleteUtterances)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/models.lex.v2-2020-08-07/DeleteUtterances)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/models.lex.v2-2020-08-07/DeleteUtterances)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/models.lex.v2-2020-08-07/DeleteUtterances)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/DeleteUtterances)
# DescribeBot
Provides metadata information about a bot.
## Request Syntax
```
GET /bots/botId/ HTTP/1.1
```
## URI Request Parameters
The request uses the following URI parameters.
** [botId](#API_DescribeBot_RequestSyntax) **
The unique identifier of the bot to describe.
Length Constraints: Fixed length of 10.
Pattern: `^[0-9a-zA-Z]+$`
Required: Yes
## Request Body
The request does not have a request body.
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"botId": "string",
"botMembers": [
{
"botMemberAliasId": "string",
"botMemberAliasName": "string",
"botMemberId": "string",
"botMemberName": "string",
"botMemberVersion": "string"
}
],
"botName": "string",
"botStatus": "string",
"botType": "string",
"creationDateTime": number,
"dataPrivacy": {
"childDirected": boolean
},
"description": "string",
"errorLogSettings": {
"enabled": boolean
},
"failureReasons": [ "string" ],
"idleSessionTTLInSeconds": number,
"lastUpdatedDateTime": number,
"roleArn": "string"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [botId](#API_DescribeBot_ResponseSyntax) **
The unique identifier of the bot.
Type: String
Length Constraints: Fixed length of 10.
Pattern: `^[0-9a-zA-Z]+$`
** [botMembers](#API_DescribeBot_ResponseSyntax) **
The list of bots in the network that was described.
Type: Array of [BotMember](API_BotMember.md) objects
Array Members: Minimum number of 0 items. Maximum number of 10 items.
** [botName](#API_DescribeBot_ResponseSyntax) **
The name of the bot.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern: `^([0-9a-zA-Z][_-]?){1,100}$`
** [botStatus](#API_DescribeBot_ResponseSyntax) **
The current status of the bot. When the status is `Available` the bot is ready to be used in conversations with users.
Type: String
Valid Values: `Creating | Available | Inactive | Deleting | Failed | Versioning | Importing | Updating`
** [botType](#API_DescribeBot_ResponseSyntax) **
The type of the bot that was described.
Type: String
Valid Values: `Bot | BotNetwork`
** [creationDateTime](#API_DescribeBot_ResponseSyntax) **
A timestamp of the date and time that the bot was created.
Type: Timestamp
** [dataPrivacy](#API_DescribeBot_ResponseSyntax) **
Settings for managing data privacy of the bot and its conversations with users.
Type: [DataPrivacy](API_DataPrivacy.md) object
** [description](#API_DescribeBot_ResponseSyntax) **
The description of the bot.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 2000.
** [errorLogSettings](#API_DescribeBot_ResponseSyntax) **
Contains the configuration for error logging that specifies where and how bot errors are recorded, including destinations like CloudWatch Logs.
Type: [ErrorLogSettings](API_ErrorLogSettings.md) object
** [failureReasons](#API_DescribeBot_ResponseSyntax) **
If the `botStatus` is `Failed`, this contains a list of reasons that the bot couldn't be built.
Type: Array of strings
** [idleSessionTTLInSeconds](#API_DescribeBot_ResponseSyntax) **
The maximum time in seconds that Amazon Lex retains the data gathered in a conversation.
Type: Integer
Valid Range: Minimum value of 60. Maximum value of 86400.
** [lastUpdatedDateTime](#API_DescribeBot_ResponseSyntax) **
A timestamp of the date and time that the bot was last updated.
Type: Timestamp
** [roleArn](#API_DescribeBot_ResponseSyntax) **
The Amazon Resource Name (ARN) of an IAM role that has permission to access the bot.
Type: String
Length Constraints: Minimum length of 32. Maximum length of 2048.
Pattern: `^arn:aws:iam::[0-9]{12}:role/.*$`
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** InternalServerException **
The service encountered an unexpected condition. Try your request again.
HTTP Status Code: 500
** ResourceNotFoundException **
You asked to describe a resource that doesn't exist. Check the resource that you are requesting and try again.
HTTP Status Code: 404
** ServiceQuotaExceededException **
You have reached a quota for your bot.
HTTP Status Code: 402
** ThrottlingException **
Your request rate is too high. Reduce the frequency of requests.
** retryAfterSeconds **
The number of seconds after which the user can invoke the API again.
HTTP Status Code: 429
** ValidationException **
One of the input parameters in your request isn't valid. Check the parameters and try your request again.
HTTP Status Code: 400
## See Also
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/models.lex.v2-2020-08-07/DescribeBot)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/models.lex.v2-2020-08-07/DescribeBot)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/DescribeBot)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/models.lex.v2-2020-08-07/DescribeBot)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/DescribeBot)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/models.lex.v2-2020-08-07/DescribeBot)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/models.lex.v2-2020-08-07/DescribeBot)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/models.lex.v2-2020-08-07/DescribeBot)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/models.lex.v2-2020-08-07/DescribeBot)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/DescribeBot)
# DescribeBotAlias
Get information about a specific bot alias.
## Request Syntax
```
GET /bots/botId/botaliases/botAliasId/ HTTP/1.1
```
## URI Request Parameters
The request uses the following URI parameters.
** [botAliasId](#API_DescribeBotAlias_RequestSyntax) **
The identifier of the bot alias to describe.
Length Constraints: Fixed length of 10.
Pattern: `^(\bTSTALIASID\b|[0-9a-zA-Z]+)$`
Required: Yes
** [botId](#API_DescribeBotAlias_RequestSyntax) **
The identifier of the bot associated with the bot alias to describe.
Length Constraints: Fixed length of 10.
Pattern: `^[0-9a-zA-Z]+$`
Required: Yes
## Request Body
The request does not have a request body.
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"botAliasHistoryEvents": [
{
"botVersion": "string",
"endDate": number,
"startDate": number
}
],
"botAliasId": "string",
"botAliasLocaleSettings": {
"string" : {
"codeHookSpecification": {
"lambdaCodeHook": {
"codeHookInterfaceVersion": "string",
"lambdaARN": "string"
}
},
"enabled": boolean
}
},
"botAliasName": "string",
"botAliasStatus": "string",
"botId": "string",
"botVersion": "string",
"conversationLogSettings": {
"audioLogSettings": [
{
"destination": {
"s3Bucket": {
"kmsKeyArn": "string",
"logPrefix": "string",
"s3BucketArn": "string"
}
},
"enabled": boolean,
"selectiveLoggingEnabled": boolean
}
],
"textLogSettings": [
{
"destination": {
"cloudWatch": {
"cloudWatchLogGroupArn": "string",
"logPrefix": "string"
}
},
"enabled": boolean,
"selectiveLoggingEnabled": boolean
}
]
},
"creationDateTime": number,
"description": "string",
"lastUpdatedDateTime": number,
"parentBotNetworks": [
{
"botId": "string",
"botVersion": "string"
}
],
"sentimentAnalysisSettings": {
"detectSentiment": boolean
}
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [botAliasHistoryEvents](#API_DescribeBotAlias_ResponseSyntax) **
A list of events that affect a bot alias. For example, an event is recorded when the version that the alias points to changes.
Type: Array of [BotAliasHistoryEvent](API_BotAliasHistoryEvent.md) objects
** [botAliasId](#API_DescribeBotAlias_ResponseSyntax) **
The identifier of the bot alias.
Type: String
Length Constraints: Fixed length of 10.
Pattern: `^(\bTSTALIASID\b|[0-9a-zA-Z]+)$`
** [botAliasLocaleSettings](#API_DescribeBotAlias_ResponseSyntax) **
The locale settings that are unique to the alias.
Type: String to [BotAliasLocaleSettings](API_BotAliasLocaleSettings.md) object map
Map Entries: Maximum number of items.
** [botAliasName](#API_DescribeBotAlias_ResponseSyntax) **
The name of the bot alias.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern: `^([0-9a-zA-Z][_-]?){1,100}$`
** [botAliasStatus](#API_DescribeBotAlias_ResponseSyntax) **
The current status of the alias. When the alias is `Available`, the alias is ready for use with your bot.
Type: String
Valid Values: `Creating | Available | Deleting | Failed`
** [botId](#API_DescribeBotAlias_ResponseSyntax) **
The identifier of the bot associated with the bot alias.
Type: String
Length Constraints: Fixed length of 10.
Pattern: `^[0-9a-zA-Z]+$`
** [botVersion](#API_DescribeBotAlias_ResponseSyntax) **
The version of the bot associated with the bot alias.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 5.
Pattern: `^(DRAFT|[0-9]+)$`
** [conversationLogSettings](#API_DescribeBotAlias_ResponseSyntax) **
Specifics of how Amazon Lex logs text and audio conversations with the bot associated with the alias.
Type: [ConversationLogSettings](API_ConversationLogSettings.md) object
** [creationDateTime](#API_DescribeBotAlias_ResponseSyntax) **
A timestamp of the date and time that the alias was created.
Type: Timestamp
** [description](#API_DescribeBotAlias_ResponseSyntax) **
The description of the bot alias.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 2000.
** [lastUpdatedDateTime](#API_DescribeBotAlias_ResponseSyntax) **
A timestamp of the date and time that the alias was last updated.
Type: Timestamp
** [parentBotNetworks](#API_DescribeBotAlias_ResponseSyntax) **
A list of the networks to which the bot alias you described belongs.
Type: Array of [ParentBotNetwork](API_ParentBotNetwork.md) objects
Array Members: Minimum number of 0 items. Maximum number of 30 items.
** [sentimentAnalysisSettings](#API_DescribeBotAlias_ResponseSyntax) **
Determines whether Amazon Lex will use Amazon Comprehend to detect the sentiment of user utterances.
Type: [SentimentAnalysisSettings](API_SentimentAnalysisSettings.md) object
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** InternalServerException **
The service encountered an unexpected condition. Try your request again.
HTTP Status Code: 500
** ResourceNotFoundException **
You asked to describe a resource that doesn't exist. Check the resource that you are requesting and try again.
HTTP Status Code: 404
** ServiceQuotaExceededException **
You have reached a quota for your bot.
HTTP Status Code: 402
** ThrottlingException **
Your request rate is too high. Reduce the frequency of requests.
** retryAfterSeconds **
The number of seconds after which the user can invoke the API again.
HTTP Status Code: 429
** ValidationException **
One of the input parameters in your request isn't valid. Check the parameters and try your request again.
HTTP Status Code: 400
## See Also
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/models.lex.v2-2020-08-07/DescribeBotAlias)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/models.lex.v2-2020-08-07/DescribeBotAlias)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/DescribeBotAlias)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/models.lex.v2-2020-08-07/DescribeBotAlias)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/DescribeBotAlias)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/models.lex.v2-2020-08-07/DescribeBotAlias)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/models.lex.v2-2020-08-07/DescribeBotAlias)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/models.lex.v2-2020-08-07/DescribeBotAlias)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/models.lex.v2-2020-08-07/DescribeBotAlias)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/DescribeBotAlias)
# DescribeBotAnalyzerRecommendation
Retrieves the analysis results and recommendations for bot optimization. The analysis must be in `Available` status before recommendations can be retrieved.
Recommendations are returned with pagination support. Each recommendation includes the issue location, priority level, detailed description, and proposed fix.
## Request Syntax
```
POST /bots/botId/botanalyzer/describe/botAnalyzerRequestId/ HTTP/1.1
Content-type: application/json
{
"maxResults": number,
"nextToken": "string"
}
```
## URI Request Parameters
The request uses the following URI parameters.
** [botAnalyzerRequestId](#API_DescribeBotAnalyzerRecommendation_RequestSyntax) **
The unique identifier of the analysis request.
Length Constraints: Fixed length of 36.
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}`
Required: Yes
** [botId](#API_DescribeBotAnalyzerRecommendation_RequestSyntax) **
The unique identifier of the bot.
Length Constraints: Fixed length of 10.
Pattern: `^[0-9a-zA-Z]+$`
Required: Yes
## Request Body
The request accepts the following data in JSON format.
** [maxResults](#API_DescribeBotAnalyzerRecommendation_RequestSyntax) **
The maximum number of recommendations to return in the response. The default is 5.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 1000.
Required: No
** [nextToken](#API_DescribeBotAnalyzerRecommendation_RequestSyntax) **
If the response from a previous request was truncated, the `nextToken` value is used to retrieve the next page of recommendations.
Type: String
Required: No
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"botAnalyzerRecommendationList": [
{
"issueDescription": "string",
"issueLocation": {
"botLocale": "string",
"intentId": "string",
"slotId": "string"
},
"priority": "string",
"proposedFix": "string"
}
],
"botAnalyzerStatus": "string",
"botId": "string",
"botVersion": "string",
"creationDateTime": number,
"localeId": "string",
"nextToken": "string"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [botAnalyzerRecommendationList](#API_DescribeBotAnalyzerRecommendation_ResponseSyntax) **
A list of recommendations for optimizing your bot configuration. Each recommendation includes the issue location, priority, description, and proposed fix.
Type: Array of [BotAnalyzerRecommendation](API_BotAnalyzerRecommendation.md) objects
** [botAnalyzerStatus](#API_DescribeBotAnalyzerRecommendation_ResponseSyntax) **
The current status of the analysis.
Valid Values: `Processing | Available | Failed | Stopping | Stopped`
Type: String
Valid Values: `Processing | Available | Failed | Stopping | Stopped`
** [botId](#API_DescribeBotAnalyzerRecommendation_ResponseSyntax) **
The unique identifier of the bot.
Type: String
Length Constraints: Fixed length of 10.
Pattern: `^[0-9a-zA-Z]+$`
** [botVersion](#API_DescribeBotAnalyzerRecommendation_ResponseSyntax) **
The version of the bot that was analyzed.
Type: String
Length Constraints: Fixed length of 5.
Pattern: `^DRAFT$`
** [creationDateTime](#API_DescribeBotAnalyzerRecommendation_ResponseSyntax) **
The date and time when the analysis was initiated.
Type: Timestamp
** [localeId](#API_DescribeBotAnalyzerRecommendation_ResponseSyntax) **
The locale identifier of the bot locale that was analyzed.
Type: String
** [nextToken](#API_DescribeBotAnalyzerRecommendation_ResponseSyntax) **
If the response is truncated, this token can be used in a subsequent request to retrieve the next page of recommendations.
Type: String
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** InternalServerException **
The service encountered an unexpected condition. Try your request again.
HTTP Status Code: 500
** ResourceNotFoundException **
You asked to describe a resource that doesn't exist. Check the resource that you are requesting and try again.
HTTP Status Code: 404
** ThrottlingException **
Your request rate is too high. Reduce the frequency of requests.
** retryAfterSeconds **
The number of seconds after which the user can invoke the API again.
HTTP Status Code: 429
** ValidationException **
One of the input parameters in your request isn't valid. Check the parameters and try your request again.
HTTP Status Code: 400
## Examples
### Example request
This example illustrates one usage of DescribeBotAnalyzerRecommendation.
```
POST https://models-v2-lex.us-east-1.amazonaws.com/bots//botanalyzer/describe//
Payload:
{
"nextToken": ""
}
```
### Example response
This example illustrates one usage of DescribeBotAnalyzerRecommendation.
```
{
"botId": "",
"localeId": "en_US",
"botVersion": "DRAFT",
"creationDateTime": 1729570423.948,
"botAnalyzerStatus": "Available",
"botAnalyzerRecommendationList": [
{
"issueLocation": {
"botLocale": "en_US",
"intentId": "BookHotel",
"slotId": null
},
"priority": "High",
"issueDescription": "Intent 'BookHotel' has overlapping utterances with 'ReserveRoom' intent that may cause routing confusion",
"proposedFix": "Consider consolidating these intents or making utterances more distinct. For example, use 'book a hotel room' vs 'reserve a conference room'"
}
],
"nextToken": ""
}
```
## See Also
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/models.lex.v2-2020-08-07/DescribeBotAnalyzerRecommendation)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/models.lex.v2-2020-08-07/DescribeBotAnalyzerRecommendation)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/DescribeBotAnalyzerRecommendation)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/models.lex.v2-2020-08-07/DescribeBotAnalyzerRecommendation)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/DescribeBotAnalyzerRecommendation)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/models.lex.v2-2020-08-07/DescribeBotAnalyzerRecommendation)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/models.lex.v2-2020-08-07/DescribeBotAnalyzerRecommendation)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/models.lex.v2-2020-08-07/DescribeBotAnalyzerRecommendation)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/models.lex.v2-2020-08-07/DescribeBotAnalyzerRecommendation)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/DescribeBotAnalyzerRecommendation)
# DescribeBotLocale
Describes the settings that a bot has for a specific locale.
## Request Syntax
```
GET /bots/botId/botversions/botVersion/botlocales/localeId/ HTTP/1.1
```
## URI Request Parameters
The request uses the following URI parameters.
** [botId](#API_DescribeBotLocale_RequestSyntax) **
The identifier of the bot associated with the locale.
Length Constraints: Fixed length of 10.
Pattern: `^[0-9a-zA-Z]+$`
Required: Yes
** [botVersion](#API_DescribeBotLocale_RequestSyntax) **
The version of the bot associated with the locale.
Length Constraints: Minimum length of 1. Maximum length of 5.
Pattern: `^(DRAFT|[0-9]+)$`
Required: Yes
** [localeId](#API_DescribeBotLocale_RequestSyntax) **
The unique identifier of the locale to describe. The string must match one of the supported locales. For more information, see [Supported languages](https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html).
Required: Yes
## Request Body
The request does not have a request body.
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"botId": "string",
"botLocaleHistoryEvents": [
{
"event": "string",
"eventDate": number
}
],
"botLocaleStatus": "string",
"botVersion": "string",
"creationDateTime": number,
"description": "string",
"failureReasons": [ "string" ],
"generativeAISettings": {
"buildtimeSettings": {
"descriptiveBotBuilder": {
"bedrockModelSpecification": {
"customPrompt": "string",
"guardrail": {
"identifier": "string",
"version": "string"
},
"modelArn": "string",
"traceStatus": "string"
},
"enabled": boolean
},
"sampleUtteranceGeneration": {
"bedrockModelSpecification": {
"customPrompt": "string",
"guardrail": {
"identifier": "string",
"version": "string"
},
"modelArn": "string",
"traceStatus": "string"
},
"enabled": boolean
}
},
"runtimeSettings": {
"nluImprovement": {
"assistedNluMode": "string",
"enabled": boolean,
"intentDisambiguationSettings": {
"customDisambiguationMessage": "string",
"enabled": boolean,
"maxDisambiguationIntents": number
}
},
"slotResolutionImprovement": {
"bedrockModelSpecification": {
"customPrompt": "string",
"guardrail": {
"identifier": "string",
"version": "string"
},
"modelArn": "string",
"traceStatus": "string"
},
"enabled": boolean
}
}
},
"intentsCount": number,
"lastBuildSubmittedDateTime": number,
"lastUpdatedDateTime": number,
"localeId": "string",
"localeName": "string",
"nluIntentConfidenceThreshold": number,
"recommendedActions": [ "string" ],
"slotTypesCount": number,
"speechDetectionSensitivity": "string",
"speechRecognitionSettings": {
"speechModelConfig": {
"deepgramConfig": {
"apiTokenSecretArn": "string",
"modelId": "string"
}
},
"speechModelPreference": "string"
},
"unifiedSpeechSettings": {
"speechFoundationModel": {
"modelArn": "string",
"voiceId": "string"
}
},
"voiceSettings": {
"engine": "string",
"voiceId": "string"
}
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [botId](#API_DescribeBotLocale_ResponseSyntax) **
The identifier of the bot associated with the locale.
Type: String
Length Constraints: Fixed length of 10.
Pattern: `^[0-9a-zA-Z]+$`
** [botLocaleHistoryEvents](#API_DescribeBotLocale_ResponseSyntax) **
History of changes, such as when a locale is used in an alias, that have taken place for the locale.
Type: Array of [BotLocaleHistoryEvent](API_BotLocaleHistoryEvent.md) objects
** [botLocaleStatus](#API_DescribeBotLocale_ResponseSyntax) **
The status of the bot. If the status is `Failed`, the reasons for the failure are listed in the `failureReasons` field.
Type: String
Valid Values: `Creating | Building | Built | ReadyExpressTesting | Failed | Deleting | NotBuilt | Importing | Processing`
** [botVersion](#API_DescribeBotLocale_ResponseSyntax) **
The version of the bot associated with the locale.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 5.
Pattern: `^(DRAFT|[0-9]+)$`
** [creationDateTime](#API_DescribeBotLocale_ResponseSyntax) **
The date and time that the locale was created.
Type: Timestamp
** [description](#API_DescribeBotLocale_ResponseSyntax) **
The description of the locale.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 2000.
** [failureReasons](#API_DescribeBotLocale_ResponseSyntax) **
if `botLocaleStatus` is `Failed`, Amazon Lex explains why it failed to build the bot.
Type: Array of strings
** [generativeAISettings](#API_DescribeBotLocale_ResponseSyntax) **
Contains settings for Amazon Bedrock's generative AI features for your bot locale.
Type: [GenerativeAISettings](API_GenerativeAISettings.md) object
** [intentsCount](#API_DescribeBotLocale_ResponseSyntax) **
The number of intents defined for the locale.
Type: Integer
** [lastBuildSubmittedDateTime](#API_DescribeBotLocale_ResponseSyntax) **
The date and time that the locale was last submitted for building.
Type: Timestamp
** [lastUpdatedDateTime](#API_DescribeBotLocale_ResponseSyntax) **
The date and time that the locale was last updated.
Type: Timestamp
** [localeId](#API_DescribeBotLocale_ResponseSyntax) **
The unique identifier of the described locale.
Type: String
** [localeName](#API_DescribeBotLocale_ResponseSyntax) **
The name of the locale.
Type: String
** [nluIntentConfidenceThreshold](#API_DescribeBotLocale_ResponseSyntax) **
The confidence threshold where Amazon Lex inserts the `AMAZON.FallbackIntent` and `AMAZON.KendraSearchIntent` intents in the list of possible intents for an utterance.
Type: Double
Valid Range: Minimum value of 0. Maximum value of 1.
** [recommendedActions](#API_DescribeBotLocale_ResponseSyntax) **
Recommended actions to take to resolve an error in the `failureReasons` field.
Type: Array of strings
** [slotTypesCount](#API_DescribeBotLocale_ResponseSyntax) **
The number of slot types defined for the locale.
Type: Integer
** [speechDetectionSensitivity](#API_DescribeBotLocale_ResponseSyntax) **
The sensitivity level for voice activity detection (VAD) configured for the bot locale.
Type: String
Valid Values: `Default | HighNoiseTolerance | MaximumNoiseTolerance`
** [speechRecognitionSettings](#API_DescribeBotLocale_ResponseSyntax) **
The speech-to-text settings configured for the bot locale.
Type: [SpeechRecognitionSettings](API_SpeechRecognitionSettings.md) object
** [unifiedSpeechSettings](#API_DescribeBotLocale_ResponseSyntax) **
The unified speech settings configured for the bot locale.
Type: [UnifiedSpeechSettings](API_UnifiedSpeechSettings.md) object
** [voiceSettings](#API_DescribeBotLocale_ResponseSyntax) **
The Amazon Polly voice Amazon Lex uses for voice interaction with the user.
Type: [VoiceSettings](API_VoiceSettings.md) object
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** InternalServerException **
The service encountered an unexpected condition. Try your request again.
HTTP Status Code: 500
** ResourceNotFoundException **
You asked to describe a resource that doesn't exist. Check the resource that you are requesting and try again.
HTTP Status Code: 404
** ServiceQuotaExceededException **
You have reached a quota for your bot.
HTTP Status Code: 402
** ThrottlingException **
Your request rate is too high. Reduce the frequency of requests.
** retryAfterSeconds **
The number of seconds after which the user can invoke the API again.
HTTP Status Code: 429
** ValidationException **
One of the input parameters in your request isn't valid. Check the parameters and try your request again.
HTTP Status Code: 400
## See Also
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/models.lex.v2-2020-08-07/DescribeBotLocale)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/models.lex.v2-2020-08-07/DescribeBotLocale)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/DescribeBotLocale)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/models.lex.v2-2020-08-07/DescribeBotLocale)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/DescribeBotLocale)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/models.lex.v2-2020-08-07/DescribeBotLocale)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/models.lex.v2-2020-08-07/DescribeBotLocale)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/models.lex.v2-2020-08-07/DescribeBotLocale)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/models.lex.v2-2020-08-07/DescribeBotLocale)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/DescribeBotLocale)
# DescribeBotRecommendation
Provides metadata information about a bot recommendation. This information will enable you to get a description on the request inputs, to download associated transcripts after processing is complete, and to download intents and slot-types generated by the bot recommendation.
## Request Syntax
```
GET /bots/botId/botversions/botVersion/botlocales/localeId/botrecommendations/botRecommendationId/ HTTP/1.1
```
## URI Request Parameters
The request uses the following URI parameters.
** [botId](#API_DescribeBotRecommendation_RequestSyntax) **
The unique identifier of the bot associated with the bot recommendation.
Length Constraints: Fixed length of 10.
Pattern: `^[0-9a-zA-Z]+$`
Required: Yes
** [botRecommendationId](#API_DescribeBotRecommendation_RequestSyntax) **
The identifier of the bot recommendation to describe.
Length Constraints: Fixed length of 10.
Pattern: `^[0-9a-zA-Z]+$`
Required: Yes
** [botVersion](#API_DescribeBotRecommendation_RequestSyntax) **
The version of the bot associated with the bot recommendation.
Length Constraints: Fixed length of 5.
Pattern: `^DRAFT$`
Required: Yes
** [localeId](#API_DescribeBotRecommendation_RequestSyntax) **
The identifier of the language and locale of the bot recommendation to describe. The string must match one of the supported locales. For more information, see [Supported languages](https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html).
Required: Yes
## Request Body
The request does not have a request body.
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"botId": "string",
"botRecommendationId": "string",
"botRecommendationResults": {
"associatedTranscriptsUrl": "string",
"botLocaleExportUrl": "string",
"statistics": {
"intents": {
"discoveredIntentCount": number
},
"slotTypes": {
"discoveredSlotTypeCount": number
}
}
},
"botRecommendationStatus": "string",
"botVersion": "string",
"creationDateTime": number,
"encryptionSetting": {
"associatedTranscriptsPassword": "string",
"botLocaleExportPassword": "string",
"kmsKeyArn": "string"
},
"failureReasons": [ "string" ],
"lastUpdatedDateTime": number,
"localeId": "string",
"transcriptSourceSetting": {
"s3BucketTranscriptSource": {
"kmsKeyArn": "string",
"pathFormat": {
"objectPrefixes": [ "string" ]
},
"s3BucketName": "string",
"transcriptFilter": {
"lexTranscriptFilter": {
"dateRangeFilter": {
"endDateTime": number,
"startDateTime": number
}
}
},
"transcriptFormat": "string"
}
}
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [botId](#API_DescribeBotRecommendation_ResponseSyntax) **
The identifier of the bot associated with the bot recommendation.
Type: String
Length Constraints: Fixed length of 10.
Pattern: `^[0-9a-zA-Z]+$`
** [botRecommendationId](#API_DescribeBotRecommendation_ResponseSyntax) **
The identifier of the bot recommendation being described.
Type: String
Length Constraints: Fixed length of 10.
Pattern: `^[0-9a-zA-Z]+$`
** [botRecommendationResults](#API_DescribeBotRecommendation_ResponseSyntax) **
The object representing the URL of the bot definition, the URL of the associated transcript and a statistical summary of the bot recommendation results.
Type: [BotRecommendationResults](API_BotRecommendationResults.md) object
** [botRecommendationStatus](#API_DescribeBotRecommendation_ResponseSyntax) **
The status of the bot recommendation. If the status is Failed, then the reasons for the failure are listed in the failureReasons field.
Type: String
Valid Values: `Processing | Deleting | Deleted | Downloading | Updating | Available | Failed | Stopping | Stopped`
** [botVersion](#API_DescribeBotRecommendation_ResponseSyntax) **
The version of the bot associated with the bot recommendation.
Type: String
Length Constraints: Fixed length of 5.
Pattern: `^DRAFT$`
** [creationDateTime](#API_DescribeBotRecommendation_ResponseSyntax) **
The date and time that the bot recommendation was created.
Type: Timestamp
** [encryptionSetting](#API_DescribeBotRecommendation_ResponseSyntax) **
The object representing the passwords that were used to encrypt the data related to the bot recommendation results, as well as the KMS key ARN used to encrypt the associated metadata.
Type: [EncryptionSetting](API_EncryptionSetting.md) object
** [failureReasons](#API_DescribeBotRecommendation_ResponseSyntax) **
If botRecommendationStatus is Failed, Amazon Lex explains why.
Type: Array of strings
** [lastUpdatedDateTime](#API_DescribeBotRecommendation_ResponseSyntax) **
The date and time that the bot recommendation was last updated.
Type: Timestamp
** [localeId](#API_DescribeBotRecommendation_ResponseSyntax) **
The identifier of the language and locale of the bot recommendation to describe.
Type: String
** [transcriptSourceSetting](#API_DescribeBotRecommendation_ResponseSyntax) **
The object representing the Amazon S3 bucket containing the transcript, as well as the associated metadata.
Type: [TranscriptSourceSetting](API_TranscriptSourceSetting.md) object
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** InternalServerException **
The service encountered an unexpected condition. Try your request again.
HTTP Status Code: 500
** ResourceNotFoundException **
You asked to describe a resource that doesn't exist. Check the resource that you are requesting and try again.
HTTP Status Code: 404
** ThrottlingException **
Your request rate is too high. Reduce the frequency of requests.
** retryAfterSeconds **
The number of seconds after which the user can invoke the API again.
HTTP Status Code: 429
** ValidationException **
One of the input parameters in your request isn't valid. Check the parameters and try your request again.
HTTP Status Code: 400
## See Also
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/models.lex.v2-2020-08-07/DescribeBotRecommendation)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/models.lex.v2-2020-08-07/DescribeBotRecommendation)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/DescribeBotRecommendation)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/models.lex.v2-2020-08-07/DescribeBotRecommendation)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/DescribeBotRecommendation)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/models.lex.v2-2020-08-07/DescribeBotRecommendation)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/models.lex.v2-2020-08-07/DescribeBotRecommendation)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/models.lex.v2-2020-08-07/DescribeBotRecommendation)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/models.lex.v2-2020-08-07/DescribeBotRecommendation)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/DescribeBotRecommendation)
# DescribeBotReplica
Monitors the bot replication status through the UI console.
## Request Syntax
```
GET /bots/botId/replicas/replicaRegion/ HTTP/1.1
```
## URI Request Parameters
The request uses the following URI parameters.
** [botId](#API_DescribeBotReplica_RequestSyntax) **
The request for the unique bot ID of the replicated bot being monitored.
Length Constraints: Fixed length of 10.
Pattern: `^[0-9a-zA-Z]+$`
Required: Yes
** [replicaRegion](#API_DescribeBotReplica_RequestSyntax) **
The request for the region of the replicated bot being monitored.
Length Constraints: Minimum length of 2. Maximum length of 25.
Required: Yes
## Request Body
The request does not have a request body.
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"botId": "string",
"botReplicaStatus": "string",
"creationDateTime": number,
"failureReasons": [ "string" ],
"replicaRegion": "string",
"sourceRegion": "string"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [botId](#API_DescribeBotReplica_ResponseSyntax) **
The unique bot ID of the replicated bot being monitored.
Type: String
Length Constraints: Fixed length of 10.
Pattern: `^[0-9a-zA-Z]+$`
** [botReplicaStatus](#API_DescribeBotReplica_ResponseSyntax) **
The operational status of the replicated bot being monitored.
Type: String
Valid Values: `Enabling | Enabled | Deleting | Failed`
** [creationDateTime](#API_DescribeBotReplica_ResponseSyntax) **
The creation date and time of the replicated bot being monitored.
Type: Timestamp
** [failureReasons](#API_DescribeBotReplica_ResponseSyntax) **
The failure reasons the bot being monitored failed to replicate.
Type: Array of strings
** [replicaRegion](#API_DescribeBotReplica_ResponseSyntax) **
The region of the replicated bot being monitored.
Type: String
Length Constraints: Minimum length of 2. Maximum length of 25.
** [sourceRegion](#API_DescribeBotReplica_ResponseSyntax) **
The source region of the replicated bot being monitored.
Type: String
Length Constraints: Minimum length of 2. Maximum length of 25.
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** InternalServerException **
The service encountered an unexpected condition. Try your request again.
HTTP Status Code: 500
** ResourceNotFoundException **
You asked to describe a resource that doesn't exist. Check the resource that you are requesting and try again.
HTTP Status Code: 404
** ServiceQuotaExceededException **
You have reached a quota for your bot.
HTTP Status Code: 402
** ThrottlingException **
Your request rate is too high. Reduce the frequency of requests.
** retryAfterSeconds **
The number of seconds after which the user can invoke the API again.
HTTP Status Code: 429
** ValidationException **
One of the input parameters in your request isn't valid. Check the parameters and try your request again.
HTTP Status Code: 400
## Examples
### This example illustrates one example input of DescribeBotReplica
This example illustrates one usage of DescribeBotReplica.
```
GET https://models-v2-lex.us-east-1.amazonaws.com/bots/BOT1234567/replicas/us-west-2
{
"replicaRegion": "us-west-2"
}
```
### This example illustrates one example response of DescribeBotReplica.
This example illustrates one usage of DescribeBotReplica.
```
{
"botId": "BOT1234567",
"botReplicaStatus": "Enabled",
"creationDateTime": 1.706821927692E9,
"failureReasons": null,
"replicaRegion": "us-west-2",
"sourceRegion": "us-east-1"
}
```
## See Also
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/models.lex.v2-2020-08-07/DescribeBotReplica)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/models.lex.v2-2020-08-07/DescribeBotReplica)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/DescribeBotReplica)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/models.lex.v2-2020-08-07/DescribeBotReplica)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/DescribeBotReplica)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/models.lex.v2-2020-08-07/DescribeBotReplica)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/models.lex.v2-2020-08-07/DescribeBotReplica)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/models.lex.v2-2020-08-07/DescribeBotReplica)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/models.lex.v2-2020-08-07/DescribeBotReplica)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/DescribeBotReplica)
# DescribeBotResourceGeneration
Returns information about a request to generate a bot through natural language description, made through the `StartBotResource` API. Use the `generatedBotLocaleUrl` to retrieve the Amazon S3 object containing the bot locale configuration. You can then modify and import this configuration.
## Request Syntax
```
GET /bots/botId/botversions/botVersion/botlocales/localeId/generations/generationId HTTP/1.1
```
## URI Request Parameters
The request uses the following URI parameters.
** [botId](#API_DescribeBotResourceGeneration_RequestSyntax) **
The unique identifier of the bot for which to return the generation details.
Length Constraints: Fixed length of 10.
Pattern: `^[0-9a-zA-Z]+$`
Required: Yes
** [botVersion](#API_DescribeBotResourceGeneration_RequestSyntax) **
The version of the bot for which to return the generation details.
Length Constraints: Minimum length of 1. Maximum length of 5.
Pattern: `^(DRAFT|[0-9]+)$`
Required: Yes
** [generationId](#API_DescribeBotResourceGeneration_RequestSyntax) **
The unique identifier of the generation request for which to return the generation details.
Length Constraints: Fixed length of 10.
Pattern: `^[0-9a-zA-Z]+$`
Required: Yes
** [localeId](#API_DescribeBotResourceGeneration_RequestSyntax) **
The locale of the bot for which to return the generation details.
Required: Yes
## Request Body
The request does not have a request body.
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"botId": "string",
"botVersion": "string",
"creationDateTime": number,
"failureReasons": [ "string" ],
"generatedBotLocaleUrl": "string",
"generationId": "string",
"generationInputPrompt": "string",
"generationStatus": "string",
"lastUpdatedDateTime": number,
"localeId": "string",
"modelArn": "string"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [botId](#API_DescribeBotResourceGeneration_ResponseSyntax) **
The unique identifier of the bot for which the generation request was made.
Type: String
Length Constraints: Fixed length of 10.
Pattern: `^[0-9a-zA-Z]+$`
** [botVersion](#API_DescribeBotResourceGeneration_ResponseSyntax) **
The version of the bot for which the generation request was made.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 5.
Pattern: `^(DRAFT|[0-9]+)$`
** [creationDateTime](#API_DescribeBotResourceGeneration_ResponseSyntax) **
The date and time at which the item was generated.
Type: Timestamp
** [failureReasons](#API_DescribeBotResourceGeneration_ResponseSyntax) **
A list of reasons why the generation of bot resources through natural language description failed.
Type: Array of strings
** [generatedBotLocaleUrl](#API_DescribeBotResourceGeneration_ResponseSyntax) **
The Amazon S3 location of the generated bot locale configuration.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
** [generationId](#API_DescribeBotResourceGeneration_ResponseSyntax) **
The generation ID for which to return the generation details.
Type: String
Length Constraints: Fixed length of 10.
Pattern: `^[0-9a-zA-Z]+$`
** [generationInputPrompt](#API_DescribeBotResourceGeneration_ResponseSyntax) **
The prompt used in the generation request.
Type: String
Length Constraints: Minimum length of 100. Maximum length of 2000.
** [generationStatus](#API_DescribeBotResourceGeneration_ResponseSyntax) **
The status of the generation request.
Type: String
Valid Values: `Failed | Complete | InProgress`
** [lastUpdatedDateTime](#API_DescribeBotResourceGeneration_ResponseSyntax) **
The date and time at which the generated item was updated.
Type: Timestamp
** [localeId](#API_DescribeBotResourceGeneration_ResponseSyntax) **
The locale of the bot for which the generation request was made.
Type: String
** [modelArn](#API_DescribeBotResourceGeneration_ResponseSyntax) **
The ARN of the model used to generate the bot resources.
Type: String
Pattern: `^arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}::foundation-model\/[a-z0-9-]{1,63}[.]{1}([a-z0-9-]{1,63}[.]){0,2}[a-z0-9-]{1,63}([:][a-z0-9-]{1,63}){0,2}$`
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** InternalServerException **
The service encountered an unexpected condition. Try your request again.
HTTP Status Code: 500
** ResourceNotFoundException **
You asked to describe a resource that doesn't exist. Check the resource that you are requesting and try again.
HTTP Status Code: 404
** ThrottlingException **
Your request rate is too high. Reduce the frequency of requests.
** retryAfterSeconds **
The number of seconds after which the user can invoke the API again.
HTTP Status Code: 429
** ValidationException **
One of the input parameters in your request isn't valid. Check the parameters and try your request again.
HTTP Status Code: 400
## Examples
### Example request
This example illustrates one usage of DescribeBotResourceGeneration.
```
GET https://models-v2-lex.us-east-1.amazonaws.com/bots/BOT1234567/botversions/DRAFT/botlocales/en_GB/generations/GEN1234567
```
### Example response
This example illustrates one usage of DescribeBotResourceGeneration.
```
{
"botId": "BOT1234567",
"botVersion": "DRAFT",
"creationDateTime": 1.699570064977E9,
"failureReasons": null,
"generatedBotLocaleUrl": "https://lex-botresourcegenerations-us-east-1-prod.s3.amazonaws.com/901559830335/BOT1234567/DRAFT/en_GB/GEN1234567/generated-LexJson-54481014-ef11-42a5-a3e6-eac6062044b9.zip",
"generationId": "GEN1234567",
"generationInputPrompt": "We want a bot to help customers order food (using item id, quantity, size), check order status, and cancel an order. Use Order ID for indexing order.",
"generationStatus": "Complete",
"lastUpdatedDateTime": 1.699570064977E9,
"localeId": "en_GB",
"modelArn ": null
}
```
## See Also
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/models.lex.v2-2020-08-07/DescribeBotResourceGeneration)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/models.lex.v2-2020-08-07/DescribeBotResourceGeneration)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/DescribeBotResourceGeneration)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/models.lex.v2-2020-08-07/DescribeBotResourceGeneration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/DescribeBotResourceGeneration)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/models.lex.v2-2020-08-07/DescribeBotResourceGeneration)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/models.lex.v2-2020-08-07/DescribeBotResourceGeneration)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/models.lex.v2-2020-08-07/DescribeBotResourceGeneration)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/models.lex.v2-2020-08-07/DescribeBotResourceGeneration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/DescribeBotResourceGeneration)
# DescribeBotVersion
Provides metadata about a version of a bot.
## Request Syntax
```
GET /bots/botId/botversions/botVersion/ HTTP/1.1
```
## URI Request Parameters
The request uses the following URI parameters.
** [botId](#API_DescribeBotVersion_RequestSyntax) **
The identifier of the bot containing the version to return metadata for.
Length Constraints: Fixed length of 10.
Pattern: `^[0-9a-zA-Z]+$`
Required: Yes
** [botVersion](#API_DescribeBotVersion_RequestSyntax) **
The version of the bot to return metadata for.
Length Constraints: Minimum length of 1. Maximum length of 5.
Pattern: `^[0-9]+$`
Required: Yes
## Request Body
The request does not have a request body.
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"botId": "string",
"botMembers": [
{
"botMemberAliasId": "string",
"botMemberAliasName": "string",
"botMemberId": "string",
"botMemberName": "string",
"botMemberVersion": "string"
}
],
"botName": "string",
"botStatus": "string",
"botType": "string",
"botVersion": "string",
"creationDateTime": number,
"dataPrivacy": {
"childDirected": boolean
},
"description": "string",
"failureReasons": [ "string" ],
"idleSessionTTLInSeconds": number,
"parentBotNetworks": [
{
"botId": "string",
"botVersion": "string"
}
],
"roleArn": "string"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [botId](#API_DescribeBotVersion_ResponseSyntax) **
The identifier of the bot that contains the version.
Type: String
Length Constraints: Fixed length of 10.
Pattern: `^[0-9a-zA-Z]+$`
** [botMembers](#API_DescribeBotVersion_ResponseSyntax) **
The members of bot network in the version that was described.
Type: Array of [BotMember](API_BotMember.md) objects
Array Members: Minimum number of 0 items. Maximum number of 10 items.
** [botName](#API_DescribeBotVersion_ResponseSyntax) **
The name of the bot that contains the version.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern: `^([0-9a-zA-Z][_-]?){1,100}$`
** [botStatus](#API_DescribeBotVersion_ResponseSyntax) **
The current status of the bot. When the status is `Available`, the bot version is ready for use.
Type: String
Valid Values: `Creating | Available | Inactive | Deleting | Failed | Versioning | Importing | Updating`
** [botType](#API_DescribeBotVersion_ResponseSyntax) **
The type of the bot in the version that was described.
Type: String
Valid Values: `Bot | BotNetwork`
** [botVersion](#API_DescribeBotVersion_ResponseSyntax) **
The version of the bot that was described.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 5.
Pattern: `^[0-9]+$`
** [creationDateTime](#API_DescribeBotVersion_ResponseSyntax) **
A timestamp of the date and time that the bot version was created.
Type: Timestamp
** [dataPrivacy](#API_DescribeBotVersion_ResponseSyntax) **
Data privacy settings for the bot version.
Type: [DataPrivacy](API_DataPrivacy.md) object
** [description](#API_DescribeBotVersion_ResponseSyntax) **
The description specified for the bot.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 2000.
** [failureReasons](#API_DescribeBotVersion_ResponseSyntax) **
If the `botStatus` is `Failed`, this contains a list of reasons that the version couldn't be built.
Type: Array of strings
** [idleSessionTTLInSeconds](#API_DescribeBotVersion_ResponseSyntax) **
The number of seconds that a session with the bot remains active before it is discarded by Amazon Lex.
Type: Integer
Valid Range: Minimum value of 60. Maximum value of 86400.
** [parentBotNetworks](#API_DescribeBotVersion_ResponseSyntax) **
A list of the networks to which the bot version you described belongs.
Type: Array of [ParentBotNetwork](API_ParentBotNetwork.md) objects
Array Members: Minimum number of 0 items. Maximum number of 30 items.
** [roleArn](#API_DescribeBotVersion_ResponseSyntax) **
The Amazon Resource Name (ARN) of an IAM role that has permission to access the bot version.
Type: String
Length Constraints: Minimum length of 32. Maximum length of 2048.
Pattern: `^arn:aws:iam::[0-9]{12}:role/.*$`
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** InternalServerException **
The service encountered an unexpected condition. Try your request again.
HTTP Status Code: 500
** ResourceNotFoundException **
You asked to describe a resource that doesn't exist. Check the resource that you are requesting and try again.
HTTP Status Code: 404
** ServiceQuotaExceededException **
You have reached a quota for your bot.
HTTP Status Code: 402
** ThrottlingException **
Your request rate is too high. Reduce the frequency of requests.
** retryAfterSeconds **
The number of seconds after which the user can invoke the API again.
HTTP Status Code: 429
** ValidationException **
One of the input parameters in your request isn't valid. Check the parameters and try your request again.
HTTP Status Code: 400
## See Also
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/models.lex.v2-2020-08-07/DescribeBotVersion)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/models.lex.v2-2020-08-07/DescribeBotVersion)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/DescribeBotVersion)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/models.lex.v2-2020-08-07/DescribeBotVersion)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/DescribeBotVersion)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/models.lex.v2-2020-08-07/DescribeBotVersion)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/models.lex.v2-2020-08-07/DescribeBotVersion)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/models.lex.v2-2020-08-07/DescribeBotVersion)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/models.lex.v2-2020-08-07/DescribeBotVersion)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/DescribeBotVersion)
# DescribeCustomVocabularyMetadata
Provides metadata information about a custom vocabulary.
## Request Syntax
```
GET /bots/botId/botversions/botVersion/botlocales/localeId/customvocabulary/DEFAULT/metadata HTTP/1.1
```
## URI Request Parameters
The request uses the following URI parameters.
** [botId](#API_DescribeCustomVocabularyMetadata_RequestSyntax) **
The unique identifier of the bot that contains the custom vocabulary.
Length Constraints: Fixed length of 10.
Pattern: `^[0-9a-zA-Z]+$`
Required: Yes
** [botVersion](#API_DescribeCustomVocabularyMetadata_RequestSyntax) **
The bot version of the bot to return metadata for.
Length Constraints: Minimum length of 1. Maximum length of 5.
Pattern: `^(DRAFT|[0-9]+)$`
Required: Yes
** [localeId](#API_DescribeCustomVocabularyMetadata_RequestSyntax) **
The locale to return the custom vocabulary information for. The locale must be `en_GB`.
Required: Yes
## Request Body
The request does not have a request body.
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"botId": "string",
"botVersion": "string",
"creationDateTime": number,
"customVocabularyStatus": "string",
"lastUpdatedDateTime": number,
"localeId": "string"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [botId](#API_DescribeCustomVocabularyMetadata_ResponseSyntax) **
The identifier of the bot that contains the custom vocabulary.
Type: String
Length Constraints: Fixed length of 10.
Pattern: `^[0-9a-zA-Z]+$`
** [botVersion](#API_DescribeCustomVocabularyMetadata_ResponseSyntax) **
The version of the bot that contains the custom vocabulary to describe.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 5.
Pattern: `^(DRAFT|[0-9]+)$`
** [creationDateTime](#API_DescribeCustomVocabularyMetadata_ResponseSyntax) **
The date and time that the custom vocabulary was created.
Type: Timestamp
** [customVocabularyStatus](#API_DescribeCustomVocabularyMetadata_ResponseSyntax) **
The status of the custom vocabulary. If the status is `Ready` the custom vocabulary is ready to use.
Type: String
Valid Values: `Ready | Deleting | Exporting | Importing | Creating`
** [lastUpdatedDateTime](#API_DescribeCustomVocabularyMetadata_ResponseSyntax) **
The date and time that the custom vocabulary was last updated.
Type: Timestamp
** [localeId](#API_DescribeCustomVocabularyMetadata_ResponseSyntax) **
The locale that contains the custom vocabulary to describe.
Type: String
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** InternalServerException **
The service encountered an unexpected condition. Try your request again.
HTTP Status Code: 500
** ResourceNotFoundException **
You asked to describe a resource that doesn't exist. Check the resource that you are requesting and try again.
HTTP Status Code: 404
** ServiceQuotaExceededException **
You have reached a quota for your bot.
HTTP Status Code: 402
** ThrottlingException **
Your request rate is too high. Reduce the frequency of requests.
** retryAfterSeconds **
The number of seconds after which the user can invoke the API again.
HTTP Status Code: 429
** ValidationException **
One of the input parameters in your request isn't valid. Check the parameters and try your request again.
HTTP Status Code: 400
## See Also
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/models.lex.v2-2020-08-07/DescribeCustomVocabularyMetadata)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/models.lex.v2-2020-08-07/DescribeCustomVocabularyMetadata)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/DescribeCustomVocabularyMetadata)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/models.lex.v2-2020-08-07/DescribeCustomVocabularyMetadata)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/DescribeCustomVocabularyMetadata)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/models.lex.v2-2020-08-07/DescribeCustomVocabularyMetadata)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/models.lex.v2-2020-08-07/DescribeCustomVocabularyMetadata)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/models.lex.v2-2020-08-07/DescribeCustomVocabularyMetadata)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/models.lex.v2-2020-08-07/DescribeCustomVocabularyMetadata)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/DescribeCustomVocabularyMetadata)
# DescribeExport
Gets information about a specific export.
## Request Syntax
```
GET /exports/exportId/ HTTP/1.1
```
## URI Request Parameters
The request uses the following URI parameters.
** [exportId](#API_DescribeExport_RequestSyntax) **
The unique identifier of the export to describe.
Length Constraints: Fixed length of 10.
Pattern: `^[0-9a-zA-Z]+$`
Required: Yes
## Request Body
The request does not have a request body.
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"creationDateTime": number,
"downloadUrl": "string",
"exportId": "string",
"exportStatus": "string",
"failureReasons": [ "string" ],
"fileFormat": "string",
"lastUpdatedDateTime": number,
"resourceSpecification": {
"botExportSpecification": {
"botId": "string",
"botVersion": "string"
},
"botLocaleExportSpecification": {
"botId": "string",
"botVersion": "string",
"localeId": "string"
},
"customVocabularyExportSpecification": {
"botId": "string",
"botVersion": "string",
"localeId": "string"
},
"testSetExportSpecification": {
"testSetId": "string"
}
}
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [creationDateTime](#API_DescribeExport_ResponseSyntax) **
The date and time that the export was created.
Type: Timestamp
** [downloadUrl](#API_DescribeExport_ResponseSyntax) **
A pre-signed S3 URL that points to the bot or bot locale archive. The URL is only available for 5 minutes after calling the `DescribeExport` operation.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
** [exportId](#API_DescribeExport_ResponseSyntax) **
The unique identifier of the described export.
Type: String
Length Constraints: Fixed length of 10.
Pattern: `^[0-9a-zA-Z]+$`
** [exportStatus](#API_DescribeExport_ResponseSyntax) **
The status of the export. When the status is `Complete` the export archive file is available for download.
Type: String
Valid Values: `InProgress | Completed | Failed | Deleting`
** [failureReasons](#API_DescribeExport_ResponseSyntax) **
If the `exportStatus` is failed, contains one or more reasons why the export could not be completed.
Type: Array of strings
** [fileFormat](#API_DescribeExport_ResponseSyntax) **
The file format used in the files that describe the resource.
Type: String
Valid Values: `LexJson | TSV | CSV`
** [lastUpdatedDateTime](#API_DescribeExport_ResponseSyntax) **
The last date and time that the export was updated.
Type: Timestamp
** [resourceSpecification](#API_DescribeExport_ResponseSyntax) **
The bot, bot ID, and optional locale ID of the exported bot or bot locale.
Type: [ExportResourceSpecification](API_ExportResourceSpecification.md) object
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** InternalServerException **
The service encountered an unexpected condition. Try your request again.
HTTP Status Code: 500
** ResourceNotFoundException **
You asked to describe a resource that doesn't exist. Check the resource that you are requesting and try again.
HTTP Status Code: 404
** ThrottlingException **
Your request rate is too high. Reduce the frequency of requests.
** retryAfterSeconds **
The number of seconds after which the user can invoke the API again.
HTTP Status Code: 429
** ValidationException **
One of the input parameters in your request isn't valid. Check the parameters and try your request again.
HTTP Status Code: 400
## See Also
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/models.lex.v2-2020-08-07/DescribeExport)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/models.lex.v2-2020-08-07/DescribeExport)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/DescribeExport)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/models.lex.v2-2020-08-07/DescribeExport)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/DescribeExport)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/models.lex.v2-2020-08-07/DescribeExport)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/models.lex.v2-2020-08-07/DescribeExport)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/models.lex.v2-2020-08-07/DescribeExport)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/models.lex.v2-2020-08-07/DescribeExport)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/DescribeExport)
# DescribeImport
Gets information about a specific import.
## Request Syntax
```
GET /imports/importId/ HTTP/1.1
```
## URI Request Parameters
The request uses the following URI parameters.
** [importId](#API_DescribeImport_RequestSyntax) **
The unique identifier of the import to describe.
Length Constraints: Fixed length of 10.
Pattern: `^[0-9a-zA-Z]+$`
Required: Yes
## Request Body
The request does not have a request body.
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"creationDateTime": number,
"failureReasons": [ "string" ],
"importedResourceId": "string",
"importedResourceName": "string",
"importId": "string",
"importStatus": "string",
"lastUpdatedDateTime": number,
"mergeStrategy": "string",
"resourceSpecification": {
"botImportSpecification": {
"botName": "string",
"botTags": {
"string" : "string"
},
"dataPrivacy": {
"childDirected": boolean
},
"errorLogSettings": {
"enabled": boolean
},
"idleSessionTTLInSeconds": number,
"roleArn": "string",
"testBotAliasTags": {
"string" : "string"
}
},
"botLocaleImportSpecification": {
"botId": "string",
"botVersion": "string",
"localeId": "string",
"nluIntentConfidenceThreshold": number,
"speechDetectionSensitivity": "string",
"speechRecognitionSettings": {
"speechModelConfig": {
"deepgramConfig": {
"apiTokenSecretArn": "string",
"modelId": "string"
}
},
"speechModelPreference": "string"
},
"unifiedSpeechSettings": {
"speechFoundationModel": {
"modelArn": "string",
"voiceId": "string"
}
},
"voiceSettings": {
"engine": "string",
"voiceId": "string"
}
},
"customVocabularyImportSpecification": {
"botId": "string",
"botVersion": "string",
"localeId": "string"
},
"testSetImportResourceSpecification": {
"description": "string",
"importInputLocation": {
"s3BucketName": "string",
"s3Path": "string"
},
"modality": "string",
"roleArn": "string",
"storageLocation": {
"kmsKeyArn": "string",
"s3BucketName": "string",
"s3Path": "string"
},
"testSetName": "string",
"testSetTags": {
"string" : "string"
}
}
}
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [creationDateTime](#API_DescribeImport_ResponseSyntax) **
The date and time that the import was created.
Type: Timestamp
** [failureReasons](#API_DescribeImport_ResponseSyntax) **
If the `importStatus` field is `Failed`, this provides one or more reasons for the failure.
Type: Array of strings
** [importedResourceId](#API_DescribeImport_ResponseSyntax) **
The unique identifier that Amazon Lex assigned to the resource created by the import.
Type: String
Length Constraints: Minimum length of 5. Maximum length of 10.
Pattern: `^([0-9a-zA-Z_])+$`
** [importedResourceName](#API_DescribeImport_ResponseSyntax) **
The name of the imported resource.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern: `^([0-9a-zA-Z][_-]?){1,100}$`
** [importId](#API_DescribeImport_ResponseSyntax) **
The unique identifier of the described import.
Type: String
Length Constraints: Fixed length of 10.
Pattern: `^[0-9a-zA-Z]+$`
** [importStatus](#API_DescribeImport_ResponseSyntax) **
The status of the import process. When the status is `Completed` the resource is imported and ready for use.
Type: String
Valid Values: `InProgress | Completed | Failed | Deleting`
** [lastUpdatedDateTime](#API_DescribeImport_ResponseSyntax) **
The date and time that the import was last updated.
Type: Timestamp
** [mergeStrategy](#API_DescribeImport_ResponseSyntax) **
The strategy used when there was a name conflict between the imported resource and an existing resource. When the merge strategy is `FailOnConflict` existing resources are not overwritten and the import fails.
Type: String
Valid Values: `Overwrite | FailOnConflict | Append`
** [resourceSpecification](#API_DescribeImport_ResponseSyntax) **
The specifications of the imported bot, bot locale, or custom vocabulary.
Type: [ImportResourceSpecification](API_ImportResourceSpecification.md) object
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** InternalServerException **
The service encountered an unexpected condition. Try your request again.
HTTP Status Code: 500
** ResourceNotFoundException **
You asked to describe a resource that doesn't exist. Check the resource that you are requesting and try again.
HTTP Status Code: 404
** ThrottlingException **
Your request rate is too high. Reduce the frequency of requests.
** retryAfterSeconds **
The number of seconds after which the user can invoke the API again.
HTTP Status Code: 429
** ValidationException **
One of the input parameters in your request isn't valid. Check the parameters and try your request again.
HTTP Status Code: 400
## See Also
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/models.lex.v2-2020-08-07/DescribeImport)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/models.lex.v2-2020-08-07/DescribeImport)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/DescribeImport)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/models.lex.v2-2020-08-07/DescribeImport)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/DescribeImport)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/models.lex.v2-2020-08-07/DescribeImport)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/models.lex.v2-2020-08-07/DescribeImport)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/models.lex.v2-2020-08-07/DescribeImport)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/models.lex.v2-2020-08-07/DescribeImport)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/DescribeImport)
# DescribeIntent
Returns metadata about an intent.
## Request Syntax
```
GET /bots/botId/botversions/botVersion/botlocales/localeId/intents/intentId/ HTTP/1.1
```
## URI Request Parameters
The request uses the following URI parameters.
** [botId](#API_DescribeIntent_RequestSyntax) **
The identifier of the bot associated with the intent.
Length Constraints: Fixed length of 10.
Pattern: `^[0-9a-zA-Z]+$`
Required: Yes
** [botVersion](#API_DescribeIntent_RequestSyntax) **
The version of the bot associated with the intent.
Length Constraints: Minimum length of 1. Maximum length of 5.
Pattern: `^(DRAFT|[0-9]+)$`
Required: Yes
** [intentId](#API_DescribeIntent_RequestSyntax) **
The identifier of the intent to describe.
Length Constraints: Fixed length of 10.
Pattern: `^[0-9a-zA-Z]+$`
Required: Yes
** [localeId](#API_DescribeIntent_RequestSyntax) **
The identifier of the language and locale of the intent to describe. The string must match one of the supported locales. For more information, see [Supported languages](https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html).
Required: Yes
## Request Body
The request does not have a request body.
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"botId": "string",
"botVersion": "string",
"creationDateTime": number,
"description": "string",
"dialogCodeHook": {
"enabled": boolean
},
"fulfillmentCodeHook": {
"active": boolean,
"enabled": boolean,
"fulfillmentUpdatesSpecification": {
"active": boolean,
"startResponse": {
"allowInterrupt": boolean,
"delayInSeconds": number,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
},
"timeoutInSeconds": number,
"updateResponse": {
"allowInterrupt": boolean,
"frequencyInSeconds": number,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
}
},
"postFulfillmentStatusSpecification": {
"failureConditional": {
"active": boolean,
"conditionalBranches": [
{
"condition": {
"expressionString": "string"
},
"name": "string",
"nextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"response": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
}
}
],
"defaultBranch": {
"nextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"response": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
}
}
},
"failureNextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"failureResponse": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
},
"successConditional": {
"active": boolean,
"conditionalBranches": [
{
"condition": {
"expressionString": "string"
},
"name": "string",
"nextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"response": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
}
}
],
"defaultBranch": {
"nextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"response": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
}
}
},
"successNextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"successResponse": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
},
"timeoutConditional": {
"active": boolean,
"conditionalBranches": [
{
"condition": {
"expressionString": "string"
},
"name": "string",
"nextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"response": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
}
}
],
"defaultBranch": {
"nextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"response": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
}
}
},
"timeoutNextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"timeoutResponse": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
}
}
},
"initialResponseSetting": {
"codeHook": {
"active": boolean,
"enableCodeHookInvocation": boolean,
"invocationLabel": "string",
"postCodeHookSpecification": {
"failureConditional": {
"active": boolean,
"conditionalBranches": [
{
"condition": {
"expressionString": "string"
},
"name": "string",
"nextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"response": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
}
}
],
"defaultBranch": {
"nextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"response": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
}
}
},
"failureNextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"failureResponse": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
},
"successConditional": {
"active": boolean,
"conditionalBranches": [
{
"condition": {
"expressionString": "string"
},
"name": "string",
"nextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"response": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
}
}
],
"defaultBranch": {
"nextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"response": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
}
}
},
"successNextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"successResponse": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
},
"timeoutConditional": {
"active": boolean,
"conditionalBranches": [
{
"condition": {
"expressionString": "string"
},
"name": "string",
"nextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"response": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
}
}
],
"defaultBranch": {
"nextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"response": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
}
}
},
"timeoutNextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"timeoutResponse": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
}
}
},
"conditional": {
"active": boolean,
"conditionalBranches": [
{
"condition": {
"expressionString": "string"
},
"name": "string",
"nextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"response": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
}
}
],
"defaultBranch": {
"nextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"response": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
}
}
},
"initialResponse": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
},
"nextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
}
},
"inputContexts": [
{
"name": "string"
}
],
"intentClosingSetting": {
"active": boolean,
"closingResponse": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
},
"conditional": {
"active": boolean,
"conditionalBranches": [
{
"condition": {
"expressionString": "string"
},
"name": "string",
"nextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"response": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
}
}
],
"defaultBranch": {
"nextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"response": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
}
}
},
"nextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
}
},
"intentConfirmationSetting": {
"active": boolean,
"codeHook": {
"active": boolean,
"enableCodeHookInvocation": boolean,
"invocationLabel": "string",
"postCodeHookSpecification": {
"failureConditional": {
"active": boolean,
"conditionalBranches": [
{
"condition": {
"expressionString": "string"
},
"name": "string",
"nextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"response": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
}
}
],
"defaultBranch": {
"nextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"response": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
}
}
},
"failureNextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"failureResponse": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
},
"successConditional": {
"active": boolean,
"conditionalBranches": [
{
"condition": {
"expressionString": "string"
},
"name": "string",
"nextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"response": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
}
}
],
"defaultBranch": {
"nextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"response": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
}
}
},
"successNextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"successResponse": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
},
"timeoutConditional": {
"active": boolean,
"conditionalBranches": [
{
"condition": {
"expressionString": "string"
},
"name": "string",
"nextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"response": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
}
}
],
"defaultBranch": {
"nextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"response": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
}
}
},
"timeoutNextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"timeoutResponse": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
}
}
},
"confirmationConditional": {
"active": boolean,
"conditionalBranches": [
{
"condition": {
"expressionString": "string"
},
"name": "string",
"nextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"response": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
}
}
],
"defaultBranch": {
"nextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"response": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
}
}
},
"confirmationNextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"confirmationResponse": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
},
"declinationConditional": {
"active": boolean,
"conditionalBranches": [
{
"condition": {
"expressionString": "string"
},
"name": "string",
"nextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"response": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
}
}
],
"defaultBranch": {
"nextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"response": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
}
}
},
"declinationNextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"declinationResponse": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
},
"elicitationCodeHook": {
"enableCodeHookInvocation": boolean,
"invocationLabel": "string"
},
"failureConditional": {
"active": boolean,
"conditionalBranches": [
{
"condition": {
"expressionString": "string"
},
"name": "string",
"nextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"response": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
}
}
],
"defaultBranch": {
"nextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"response": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
}
}
},
"failureNextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"failureResponse": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
},
"promptSpecification": {
"allowInterrupt": boolean,
"maxRetries": number,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
],
"messageSelectionStrategy": "string",
"promptAttemptsSpecification": {
"string" : {
"allowedInputTypes": {
"allowAudioInput": boolean,
"allowDTMFInput": boolean
},
"allowInterrupt": boolean,
"audioAndDTMFInputSpecification": {
"audioSpecification": {
"endTimeoutMs": number,
"maxLengthMs": number
},
"dtmfSpecification": {
"deletionCharacter": "string",
"endCharacter": "string",
"endTimeoutMs": number,
"maxLength": number
},
"startTimeoutMs": number
},
"textInputSpecification": {
"startTimeoutMs": number
}
}
}
}
},
"intentDisplayName": "string",
"intentId": "string",
"intentName": "string",
"kendraConfiguration": {
"kendraIndex": "string",
"queryFilterString": "string",
"queryFilterStringEnabled": boolean
},
"lastUpdatedDateTime": number,
"localeId": "string",
"outputContexts": [
{
"name": "string",
"timeToLiveInSeconds": number,
"turnsToLive": number
}
],
"parentIntentSignature": "string",
"qInConnectIntentConfiguration": {
"qInConnectAssistantConfiguration": {
"assistantArn": "string"
}
},
"qnAIntentConfiguration": {
"bedrockModelConfiguration": {
"customPrompt": "string",
"guardrail": {
"identifier": "string",
"version": "string"
},
"modelArn": "string",
"traceStatus": "string"
},
"dataSourceConfiguration": {
"bedrockKnowledgeStoreConfiguration": {
"bedrockKnowledgeBaseArn": "string",
"exactResponse": boolean,
"exactResponseFields": {
"answerField": "string"
}
},
"kendraConfiguration": {
"exactResponse": boolean,
"kendraIndex": "string",
"queryFilterString": "string",
"queryFilterStringEnabled": boolean
},
"opensearchConfiguration": {
"domainEndpoint": "string",
"exactResponse": boolean,
"exactResponseFields": {
"answerField": "string",
"questionField": "string"
},
"includeFields": [ "string" ],
"indexName": "string"
}
}
},
"sampleUtterances": [
{
"utterance": "string"
}
],
"slotPriorities": [
{
"priority": number,
"slotId": "string"
}
]
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [botId](#API_DescribeIntent_ResponseSyntax) **
The identifier of the bot associated with the intent.
Type: String
Length Constraints: Fixed length of 10.
Pattern: `^[0-9a-zA-Z]+$`
** [botVersion](#API_DescribeIntent_ResponseSyntax) **
The version of the bot associated with the intent.
Type: String
Length Constraints: Fixed length of 5.
Pattern: `^DRAFT$`
** [creationDateTime](#API_DescribeIntent_ResponseSyntax) **
A timestamp of the date and time that the intent was created.
Type: Timestamp
** [description](#API_DescribeIntent_ResponseSyntax) **
The description of the intent.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 2000.
** [dialogCodeHook](#API_DescribeIntent_ResponseSyntax) **
The Lambda function called during each turn of a conversation with the intent.
Type: [DialogCodeHookSettings](API_DialogCodeHookSettings.md) object
** [fulfillmentCodeHook](#API_DescribeIntent_ResponseSyntax) **
The Lambda function called when the intent is complete and ready for fulfillment.
Type: [FulfillmentCodeHookSettings](API_FulfillmentCodeHookSettings.md) object
** [initialResponseSetting](#API_DescribeIntent_ResponseSyntax) **
Configuration setting for a response sent to the user before Amazon Lex starts eliciting slots.
Type: [InitialResponseSetting](API_InitialResponseSetting.md) object
** [inputContexts](#API_DescribeIntent_ResponseSyntax) **
A list of contexts that must be active for the intent to be considered for sending to the user.
Type: Array of [InputContext](API_InputContext.md) objects
Array Members: Minimum number of 0 items. Maximum number of 5 items.
** [intentClosingSetting](#API_DescribeIntent_ResponseSyntax) **
The response that Amazon Lex sends to when the intent is closed.
Type: [IntentClosingSetting](API_IntentClosingSetting.md) object
** [intentConfirmationSetting](#API_DescribeIntent_ResponseSyntax) **
Prompts that Amazon Lex sends to the user to confirm completion of an intent.
Type: [IntentConfirmationSetting](API_IntentConfirmationSetting.md) object
** [intentDisplayName](#API_DescribeIntent_ResponseSyntax) **
The display name specified for the intent.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
** [intentId](#API_DescribeIntent_ResponseSyntax) **
The unique identifier assigned to the intent when it was created.
Type: String
Length Constraints: Fixed length of 10.
Pattern: `^[0-9a-zA-Z]+$`
** [intentName](#API_DescribeIntent_ResponseSyntax) **
The name specified for the intent.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern: `^([0-9a-zA-Z][_-]?){1,100}$`
** [kendraConfiguration](#API_DescribeIntent_ResponseSyntax) **
Configuration information required to use the `AMAZON.KendraSearchIntent` intent.
Type: [KendraConfiguration](API_KendraConfiguration.md) object
** [lastUpdatedDateTime](#API_DescribeIntent_ResponseSyntax) **
A timestamp of the date and time that the intent was last updated.
Type: Timestamp
** [localeId](#API_DescribeIntent_ResponseSyntax) **
The language and locale specified for the intent.
Type: String
** [outputContexts](#API_DescribeIntent_ResponseSyntax) **
A list of contexts that are activated 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_DescribeIntent_ResponseSyntax) **
The identifier of the built-in intent that this intent is derived from, if any.
Type: String
** [qInConnectIntentConfiguration](#API_DescribeIntent_ResponseSyntax) **
Qinconnect intent configuration details for the describe intent response.
Type: [QInConnectIntentConfiguration](API_QInConnectIntentConfiguration.md) object
** [qnAIntentConfiguration](#API_DescribeIntent_ResponseSyntax) **
Details about the configuration of the built-in `Amazon.QnAIntent`.
Type: [QnAIntentConfiguration](API_QnAIntentConfiguration.md) object
** [sampleUtterances](#API_DescribeIntent_ResponseSyntax) **
User utterances that trigger this intent.
Type: Array of [SampleUtterance](API_SampleUtterance.md) objects
** [slotPriorities](#API_DescribeIntent_ResponseSyntax) **
The list that determines the priority that slots should be elicited from the user.
Type: Array of [SlotPriority](API_SlotPriority.md) objects
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** InternalServerException **
The service encountered an unexpected condition. Try your request again.
HTTP Status Code: 500
** ResourceNotFoundException **
You asked to describe a resource that doesn't exist. Check the resource that you are requesting and try again.
HTTP Status Code: 404
** ServiceQuotaExceededException **
You have reached a quota for your bot.
HTTP Status Code: 402
** ThrottlingException **
Your request rate is too high. Reduce the frequency of requests.
** retryAfterSeconds **
The number of seconds after which the user can invoke the API again.
HTTP Status Code: 429
** ValidationException **
One of the input parameters in your request isn't valid. Check the parameters and try your request again.
HTTP Status Code: 400
## See Also
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/models.lex.v2-2020-08-07/DescribeIntent)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/models.lex.v2-2020-08-07/DescribeIntent)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/DescribeIntent)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/models.lex.v2-2020-08-07/DescribeIntent)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/DescribeIntent)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/models.lex.v2-2020-08-07/DescribeIntent)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/models.lex.v2-2020-08-07/DescribeIntent)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/models.lex.v2-2020-08-07/DescribeIntent)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/models.lex.v2-2020-08-07/DescribeIntent)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/DescribeIntent)
# DescribeResourcePolicy
Gets the resource policy and policy revision for a bot or bot alias.
## Request Syntax
```
GET /policy/resourceArn/ HTTP/1.1
```
## URI Request Parameters
The request uses the following URI parameters.
** [resourceArn](#API_DescribeResourcePolicy_RequestSyntax) **
The Amazon Resource Name (ARN) of the bot or bot alias that the resource policy is attached to.
Length Constraints: Minimum length of 1. Maximum length of 1011.
Required: Yes
## Request Body
The request does not have a request body.
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"policy": "string",
"resourceArn": "string",
"revisionId": "string"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [policy](#API_DescribeResourcePolicy_ResponseSyntax) **
The JSON structure that contains the resource policy. For more information about the contents of a JSON policy document, see [ IAM JSON policy reference ](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies.html).
Type: String
Length Constraints: Minimum length of 2.
** [resourceArn](#API_DescribeResourcePolicy_ResponseSyntax) **
The Amazon Resource Name (ARN) of the bot or bot alias that the resource policy is attached to.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1011.
** [revisionId](#API_DescribeResourcePolicy_ResponseSyntax) **
The current revision of the resource policy. Use the revision ID to make sure that you are updating the most current version of a resource policy when you add a policy statement to a resource, delete a resource, or update a resource.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 5.
Pattern: `^[0-9]+$`
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** InternalServerException **
The service encountered an unexpected condition. Try your request again.
HTTP Status Code: 500
** ResourceNotFoundException **
You asked to describe a resource that doesn't exist. Check the resource that you are requesting and try again.
HTTP Status Code: 404
** ThrottlingException **
Your request rate is too high. Reduce the frequency of requests.
** retryAfterSeconds **
The number of seconds after which the user can invoke the API again.
HTTP Status Code: 429
## See Also
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/models.lex.v2-2020-08-07/DescribeResourcePolicy)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/models.lex.v2-2020-08-07/DescribeResourcePolicy)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/DescribeResourcePolicy)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/models.lex.v2-2020-08-07/DescribeResourcePolicy)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/DescribeResourcePolicy)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/models.lex.v2-2020-08-07/DescribeResourcePolicy)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/models.lex.v2-2020-08-07/DescribeResourcePolicy)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/models.lex.v2-2020-08-07/DescribeResourcePolicy)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/models.lex.v2-2020-08-07/DescribeResourcePolicy)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/DescribeResourcePolicy)
# DescribeSlot
Gets metadata information about a slot.
## Request Syntax
```
GET /bots/botId/botversions/botVersion/botlocales/localeId/intents/intentId/slots/slotId/ HTTP/1.1
```
## URI Request Parameters
The request uses the following URI parameters.
** [botId](#API_DescribeSlot_RequestSyntax) **
The identifier of the bot associated with the slot.
Length Constraints: Fixed length of 10.
Pattern: `^[0-9a-zA-Z]+$`
Required: Yes
** [botVersion](#API_DescribeSlot_RequestSyntax) **
The version of the bot associated with the slot.
Length Constraints: Minimum length of 1. Maximum length of 5.
Pattern: `^(DRAFT|[0-9]+)$`
Required: Yes
** [intentId](#API_DescribeSlot_RequestSyntax) **
The identifier of the intent that contains the slot.
Length Constraints: Fixed length of 10.
Pattern: `^[0-9a-zA-Z]+$`
Required: Yes
** [localeId](#API_DescribeSlot_RequestSyntax) **
The identifier of the language and locale of the slot to describe. The string must match one of the supported locales. For more information, see [Supported languages](https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html).
Required: Yes
** [slotId](#API_DescribeSlot_RequestSyntax) **
The unique identifier for the slot.
Length Constraints: Fixed length of 10.
Pattern: `^[0-9a-zA-Z]+$`
Required: Yes
## Request Body
The request does not have a request body.
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"botId": "string",
"botVersion": "string",
"creationDateTime": number,
"description": "string",
"intentId": "string",
"lastUpdatedDateTime": number,
"localeId": "string",
"multipleValuesSetting": {
"allowMultipleValues": boolean
},
"obfuscationSetting": {
"obfuscationSettingType": "string"
},
"slotId": "string",
"slotName": "string",
"slotTypeId": "string",
"subSlotSetting": {
"expression": "string",
"slotSpecifications": {
"string" : {
"slotTypeId": "string",
"valueElicitationSetting": {
"defaultValueSpecification": {
"defaultValueList": [
{
"defaultValue": "string"
}
]
},
"promptSpecification": {
"allowInterrupt": boolean,
"maxRetries": number,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
],
"messageSelectionStrategy": "string",
"promptAttemptsSpecification": {
"string" : {
"allowedInputTypes": {
"allowAudioInput": boolean,
"allowDTMFInput": boolean
},
"allowInterrupt": boolean,
"audioAndDTMFInputSpecification": {
"audioSpecification": {
"endTimeoutMs": number,
"maxLengthMs": number
},
"dtmfSpecification": {
"deletionCharacter": "string",
"endCharacter": "string",
"endTimeoutMs": number,
"maxLength": number
},
"startTimeoutMs": number
},
"textInputSpecification": {
"startTimeoutMs": number
}
}
}
},
"sampleUtterances": [
{
"utterance": "string"
}
],
"waitAndContinueSpecification": {
"active": boolean,
"continueResponse": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
},
"stillWaitingResponse": {
"allowInterrupt": boolean,
"frequencyInSeconds": number,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
],
"timeoutInSeconds": number
},
"waitingResponse": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
}
}
}
}
}
},
"valueElicitationSetting": {
"defaultValueSpecification": {
"defaultValueList": [
{
"defaultValue": "string"
}
]
},
"promptSpecification": {
"allowInterrupt": boolean,
"maxRetries": number,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
],
"messageSelectionStrategy": "string",
"promptAttemptsSpecification": {
"string" : {
"allowedInputTypes": {
"allowAudioInput": boolean,
"allowDTMFInput": boolean
},
"allowInterrupt": boolean,
"audioAndDTMFInputSpecification": {
"audioSpecification": {
"endTimeoutMs": number,
"maxLengthMs": number
},
"dtmfSpecification": {
"deletionCharacter": "string",
"endCharacter": "string",
"endTimeoutMs": number,
"maxLength": number
},
"startTimeoutMs": number
},
"textInputSpecification": {
"startTimeoutMs": number
}
}
}
},
"sampleUtterances": [
{
"utterance": "string"
}
],
"slotCaptureSetting": {
"captureConditional": {
"active": boolean,
"conditionalBranches": [
{
"condition": {
"expressionString": "string"
},
"name": "string",
"nextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"response": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
}
}
],
"defaultBranch": {
"nextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"response": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
}
}
},
"captureNextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"captureResponse": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
},
"codeHook": {
"active": boolean,
"enableCodeHookInvocation": boolean,
"invocationLabel": "string",
"postCodeHookSpecification": {
"failureConditional": {
"active": boolean,
"conditionalBranches": [
{
"condition": {
"expressionString": "string"
},
"name": "string",
"nextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"response": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
}
}
],
"defaultBranch": {
"nextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"response": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
}
}
},
"failureNextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"failureResponse": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
},
"successConditional": {
"active": boolean,
"conditionalBranches": [
{
"condition": {
"expressionString": "string"
},
"name": "string",
"nextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"response": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
}
}
],
"defaultBranch": {
"nextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"response": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
}
}
},
"successNextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"successResponse": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
},
"timeoutConditional": {
"active": boolean,
"conditionalBranches": [
{
"condition": {
"expressionString": "string"
},
"name": "string",
"nextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"response": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
}
}
],
"defaultBranch": {
"nextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"response": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
}
}
},
"timeoutNextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"timeoutResponse": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
}
}
},
"elicitationCodeHook": {
"enableCodeHookInvocation": boolean,
"invocationLabel": "string"
},
"failureConditional": {
"active": boolean,
"conditionalBranches": [
{
"condition": {
"expressionString": "string"
},
"name": "string",
"nextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"response": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
}
}
],
"defaultBranch": {
"nextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"response": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
}
}
},
"failureNextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"failureResponse": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
}
},
"slotConstraint": "string",
"slotResolutionSetting": {
"slotResolutionStrategy": "string"
},
"waitAndContinueSpecification": {
"active": boolean,
"continueResponse": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
},
"stillWaitingResponse": {
"allowInterrupt": boolean,
"frequencyInSeconds": number,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
],
"timeoutInSeconds": number
},
"waitingResponse": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
}
}
}
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [botId](#API_DescribeSlot_ResponseSyntax) **
The identifier of the bot associated with the slot.
Type: String
Length Constraints: Fixed length of 10.
Pattern: `^[0-9a-zA-Z]+$`
** [botVersion](#API_DescribeSlot_ResponseSyntax) **
The version of the bot associated with the slot.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 5.
Pattern: `^(DRAFT|[0-9]+)$`
** [creationDateTime](#API_DescribeSlot_ResponseSyntax) **
A timestamp of the date and time that the slot was created.
Type: Timestamp
** [description](#API_DescribeSlot_ResponseSyntax) **
The description specified for the slot.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 2000.
** [intentId](#API_DescribeSlot_ResponseSyntax) **
The identifier of the intent associated with the slot.
Type: String
Length Constraints: Fixed length of 10.
Pattern: `^[0-9a-zA-Z]+$`
** [lastUpdatedDateTime](#API_DescribeSlot_ResponseSyntax) **
A timestamp of the date and time that the slot was last updated.
Type: Timestamp
** [localeId](#API_DescribeSlot_ResponseSyntax) **
The language and locale specified for the slot.
Type: String
** [multipleValuesSetting](#API_DescribeSlot_ResponseSyntax) **
Indicates whether the slot accepts multiple values in a single utterance.
If the `multipleValuesSetting` is not set, the default value is `false`.
Type: [MultipleValuesSetting](API_MultipleValuesSetting.md) object
** [obfuscationSetting](#API_DescribeSlot_ResponseSyntax) **
Whether slot values are shown in Amazon CloudWatch logs. If the value is `None`, the actual value of the slot is shown in logs.
Type: [ObfuscationSetting](API_ObfuscationSetting.md) object
** [slotId](#API_DescribeSlot_ResponseSyntax) **
The unique identifier generated for the slot.
Type: String
Length Constraints: Fixed length of 10.
Pattern: `^[0-9a-zA-Z]+$`
** [slotName](#API_DescribeSlot_ResponseSyntax) **
The name specified for the slot.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern: `^([0-9a-zA-Z][_-]?){1,100}$`
** [slotTypeId](#API_DescribeSlot_ResponseSyntax) **
The identifier of the slot type that determines the values entered into the slot.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 25.
Pattern: `^((AMAZON\.)[a-zA-Z_]+?|[0-9a-zA-Z]+)$`
** [subSlotSetting](#API_DescribeSlot_ResponseSyntax) **
Specifications for the constituent sub slots and the expression for the composite slot.
Type: [SubSlotSetting](API_SubSlotSetting.md) object
** [valueElicitationSetting](#API_DescribeSlot_ResponseSyntax) **
Prompts that Amazon Lex uses to elicit a value for the slot.
Type: [SlotValueElicitationSetting](API_SlotValueElicitationSetting.md) object
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** InternalServerException **
The service encountered an unexpected condition. Try your request again.
HTTP Status Code: 500
** ResourceNotFoundException **
You asked to describe a resource that doesn't exist. Check the resource that you are requesting and try again.
HTTP Status Code: 404
** ServiceQuotaExceededException **
You have reached a quota for your bot.
HTTP Status Code: 402
** ThrottlingException **
Your request rate is too high. Reduce the frequency of requests.
** retryAfterSeconds **
The number of seconds after which the user can invoke the API again.
HTTP Status Code: 429
** ValidationException **
One of the input parameters in your request isn't valid. Check the parameters and try your request again.
HTTP Status Code: 400
## See Also
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/models.lex.v2-2020-08-07/DescribeSlot)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/models.lex.v2-2020-08-07/DescribeSlot)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/DescribeSlot)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/models.lex.v2-2020-08-07/DescribeSlot)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/DescribeSlot)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/models.lex.v2-2020-08-07/DescribeSlot)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/models.lex.v2-2020-08-07/DescribeSlot)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/models.lex.v2-2020-08-07/DescribeSlot)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/models.lex.v2-2020-08-07/DescribeSlot)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/DescribeSlot)
# DescribeSlotType
Gets metadata information about a slot type.
## Request Syntax
```
GET /bots/botId/botversions/botVersion/botlocales/localeId/slottypes/slotTypeId/ HTTP/1.1
```
## URI Request Parameters
The request uses the following URI parameters.
** [botId](#API_DescribeSlotType_RequestSyntax) **
The identifier of the bot associated with the slot type.
Length Constraints: Fixed length of 10.
Pattern: `^[0-9a-zA-Z]+$`
Required: Yes
** [botVersion](#API_DescribeSlotType_RequestSyntax) **
The version of the bot associated with the slot type.
Length Constraints: Minimum length of 1. Maximum length of 5.
Pattern: `^(DRAFT|[0-9]+)$`
Required: Yes
** [localeId](#API_DescribeSlotType_RequestSyntax) **
The identifier of the language and locale of the slot type to describe. The string must match one of the supported locales. For more information, see [Supported languages](https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html).
Required: Yes
** [slotTypeId](#API_DescribeSlotType_RequestSyntax) **
The identifier of the slot type.
Length Constraints: Fixed length of 10.
Pattern: `^[0-9a-zA-Z]+$`
Required: Yes
## Request Body
The request does not have a request body.
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"botId": "string",
"botVersion": "string",
"compositeSlotTypeSetting": {
"subSlots": [
{
"name": "string",
"slotTypeId": "string"
}
]
},
"creationDateTime": number,
"description": "string",
"externalSourceSetting": {
"grammarSlotTypeSetting": {
"source": {
"kmsKeyArn": "string",
"s3BucketName": "string",
"s3ObjectKey": "string"
}
}
},
"lastUpdatedDateTime": number,
"localeId": "string",
"parentSlotTypeSignature": "string",
"slotTypeId": "string",
"slotTypeName": "string",
"slotTypeValues": [
{
"sampleValue": {
"value": "string"
},
"synonyms": [
{
"value": "string"
}
]
}
],
"valueSelectionSetting": {
"advancedRecognitionSetting": {
"audioRecognitionStrategy": "string"
},
"regexFilter": {
"pattern": "string"
},
"resolutionStrategy": "string"
}
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [botId](#API_DescribeSlotType_ResponseSyntax) **
The identifier of the bot associated with the slot type.
Type: String
Length Constraints: Fixed length of 10.
Pattern: `^[0-9a-zA-Z]+$`
** [botVersion](#API_DescribeSlotType_ResponseSyntax) **
The version of the bot associated with the slot type.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 5.
Pattern: `^(DRAFT|[0-9]+)$`
** [compositeSlotTypeSetting](#API_DescribeSlotType_ResponseSyntax) **
Specifications for a composite slot type.
Type: [CompositeSlotTypeSetting](API_CompositeSlotTypeSetting.md) object
** [creationDateTime](#API_DescribeSlotType_ResponseSyntax) **
A timestamp of the date and time that the slot type was created.
Type: Timestamp
** [description](#API_DescribeSlotType_ResponseSyntax) **
The description specified for the slot type.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 2000.
** [externalSourceSetting](#API_DescribeSlotType_ResponseSyntax) **
Provides information about the external source of the slot type's definition.
Type: [ExternalSourceSetting](API_ExternalSourceSetting.md) object
** [lastUpdatedDateTime](#API_DescribeSlotType_ResponseSyntax) **
A timestamp of the date and time that the slot type was last updated.
Type: Timestamp
** [localeId](#API_DescribeSlotType_ResponseSyntax) **
The language and locale specified for the slot type.
Type: String
** [parentSlotTypeSignature](#API_DescribeSlotType_ResponseSyntax) **
The built in slot type used as a parent to this slot type.
Type: String
** [slotTypeId](#API_DescribeSlotType_ResponseSyntax) **
The unique identifier for the slot type.
Type: String
Length Constraints: Fixed length of 10.
Pattern: `^[0-9a-zA-Z]+$`
** [slotTypeName](#API_DescribeSlotType_ResponseSyntax) **
The name specified for the slot type.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern: `^([0-9a-zA-Z][_-]?){1,100}$`
** [slotTypeValues](#API_DescribeSlotType_ResponseSyntax) **
The values that the slot type can take. Includes any synonyms for the slot type values.
Type: Array of [SlotTypeValue](API_SlotTypeValue.md) objects
Array Members: Minimum number of 1 item. Maximum number of 10000 items.
** [valueSelectionSetting](#API_DescribeSlotType_ResponseSyntax) **
The strategy that Amazon Lex uses to choose a value from a list of possible values.
Type: [SlotValueSelectionSetting](API_SlotValueSelectionSetting.md) object
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** InternalServerException **
The service encountered an unexpected condition. Try your request again.
HTTP Status Code: 500
** ResourceNotFoundException **
You asked to describe a resource that doesn't exist. Check the resource that you are requesting and try again.
HTTP Status Code: 404
** ServiceQuotaExceededException **
You have reached a quota for your bot.
HTTP Status Code: 402
** ThrottlingException **
Your request rate is too high. Reduce the frequency of requests.
** retryAfterSeconds **
The number of seconds after which the user can invoke the API again.
HTTP Status Code: 429
** ValidationException **
One of the input parameters in your request isn't valid. Check the parameters and try your request again.
HTTP Status Code: 400
## See Also
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/models.lex.v2-2020-08-07/DescribeSlotType)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/models.lex.v2-2020-08-07/DescribeSlotType)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/DescribeSlotType)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/models.lex.v2-2020-08-07/DescribeSlotType)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/DescribeSlotType)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/models.lex.v2-2020-08-07/DescribeSlotType)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/models.lex.v2-2020-08-07/DescribeSlotType)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/models.lex.v2-2020-08-07/DescribeSlotType)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/models.lex.v2-2020-08-07/DescribeSlotType)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/DescribeSlotType)
# DescribeTestExecution
Gets metadata information about the test execution.
## Request Syntax
```
GET /testexecutions/testExecutionId HTTP/1.1
```
## URI Request Parameters
The request uses the following URI parameters.
** [testExecutionId](#API_DescribeTestExecution_RequestSyntax) **
The execution Id of the test set execution.
Length Constraints: Fixed length of 10.
Pattern: `^[0-9a-zA-Z]+$`
Required: Yes
## Request Body
The request does not have a request body.
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"apiMode": "string",
"creationDateTime": number,
"failureReasons": [ "string" ],
"lastUpdatedDateTime": number,
"target": {
"botAliasTarget": {
"botAliasId": "string",
"botId": "string",
"localeId": "string"
}
},
"testExecutionId": "string",
"testExecutionModality": "string",
"testExecutionStatus": "string",
"testSetId": "string",
"testSetName": "string"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [apiMode](#API_DescribeTestExecution_ResponseSyntax) **
Indicates whether we use streaming or non-streaming APIs are used for the test set execution. For streaming, `StartConversation` Amazon Lex Runtime API is used. Whereas for non-streaming, `RecognizeUtterance` and `RecognizeText` Amazon Lex Runtime API is used.
Type: String
Valid Values: `Streaming | NonStreaming`
** [creationDateTime](#API_DescribeTestExecution_ResponseSyntax) **
The execution creation date and time for the test set execution.
Type: Timestamp
** [failureReasons](#API_DescribeTestExecution_ResponseSyntax) **
Reasons for the failure of the test set execution.
Type: Array of strings
** [lastUpdatedDateTime](#API_DescribeTestExecution_ResponseSyntax) **
The date and time of the last update for the execution.
Type: Timestamp
** [target](#API_DescribeTestExecution_ResponseSyntax) **
The target bot for the test set execution details.
Type: [TestExecutionTarget](API_TestExecutionTarget.md) object
** [testExecutionId](#API_DescribeTestExecution_ResponseSyntax) **
The execution Id for the test set execution.
Type: String
Length Constraints: Fixed length of 10.
Pattern: `^[0-9a-zA-Z]+$`
** [testExecutionModality](#API_DescribeTestExecution_ResponseSyntax) **
Indicates whether test set is audio or text.
Type: String
Valid Values: `Text | Audio`
** [testExecutionStatus](#API_DescribeTestExecution_ResponseSyntax) **
The test execution status for the test execution.
Type: String
Valid Values: `Pending | Waiting | InProgress | Completed | Failed | Stopping | Stopped`
** [testSetId](#API_DescribeTestExecution_ResponseSyntax) **
The test set Id for the test set execution.
Type: String
Length Constraints: Fixed length of 10.
Pattern: `^[0-9a-zA-Z]+$`
** [testSetName](#API_DescribeTestExecution_ResponseSyntax) **
The test set name of the test set execution.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern: `^([0-9a-zA-Z][_-]?){1,100}$`
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** InternalServerException **
The service encountered an unexpected condition. Try your request again.
HTTP Status Code: 500
** ResourceNotFoundException **
You asked to describe a resource that doesn't exist. Check the resource that you are requesting and try again.
HTTP Status Code: 404
** ServiceQuotaExceededException **
You have reached a quota for your bot.
HTTP Status Code: 402
** ThrottlingException **
Your request rate is too high. Reduce the frequency of requests.
** retryAfterSeconds **
The number of seconds after which the user can invoke the API again.
HTTP Status Code: 429
** ValidationException **
One of the input parameters in your request isn't valid. Check the parameters and try your request again.
HTTP Status Code: 400
## See Also
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/models.lex.v2-2020-08-07/DescribeTestExecution)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/models.lex.v2-2020-08-07/DescribeTestExecution)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/DescribeTestExecution)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/models.lex.v2-2020-08-07/DescribeTestExecution)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/DescribeTestExecution)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/models.lex.v2-2020-08-07/DescribeTestExecution)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/models.lex.v2-2020-08-07/DescribeTestExecution)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/models.lex.v2-2020-08-07/DescribeTestExecution)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/models.lex.v2-2020-08-07/DescribeTestExecution)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/DescribeTestExecution)
# DescribeTestSet
Gets metadata information about the test set.
## Request Syntax
```
GET /testsets/testSetId HTTP/1.1
```
## URI Request Parameters
The request uses the following URI parameters.
** [testSetId](#API_DescribeTestSet_RequestSyntax) **
The test set Id for the test set request.
Length Constraints: Fixed length of 10.
Pattern: `^[0-9a-zA-Z]+$`
Required: Yes
## Request Body
The request does not have a request body.
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"creationDateTime": number,
"description": "string",
"lastUpdatedDateTime": number,
"modality": "string",
"numTurns": number,
"roleArn": "string",
"status": "string",
"storageLocation": {
"kmsKeyArn": "string",
"s3BucketName": "string",
"s3Path": "string"
},
"testSetId": "string",
"testSetName": "string"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [creationDateTime](#API_DescribeTestSet_ResponseSyntax) **
The creation date and time for the test set data.
Type: Timestamp
** [description](#API_DescribeTestSet_ResponseSyntax) **
The description of the test set.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 2000.
** [lastUpdatedDateTime](#API_DescribeTestSet_ResponseSyntax) **
The date and time for the last update of the test set data.
Type: Timestamp
** [modality](#API_DescribeTestSet_ResponseSyntax) **
Indicates whether the test set is audio or text data.
Type: String
Valid Values: `Text | Audio`
** [numTurns](#API_DescribeTestSet_ResponseSyntax) **
The total number of agent and user turn in the test set.
Type: Integer
** [roleArn](#API_DescribeTestSet_ResponseSyntax) **
The roleARN used for any operation in the test set to access resources in the AWS account.
Type: String
Length Constraints: Minimum length of 32. Maximum length of 2048.
Pattern: `^arn:aws:iam::[0-9]{12}:role/.*$`
** [status](#API_DescribeTestSet_ResponseSyntax) **
The status of the test set.
Type: String
Valid Values: `Importing | PendingAnnotation | Deleting | ValidationError | Ready`
** [storageLocation](#API_DescribeTestSet_ResponseSyntax) **
The Amazon S3 storage location for the test set data.
Type: [TestSetStorageLocation](API_TestSetStorageLocation.md) object
** [testSetId](#API_DescribeTestSet_ResponseSyntax) **
The test set Id for the test set response.
Type: String
Length Constraints: Fixed length of 10.
Pattern: `^[0-9a-zA-Z]+$`
** [testSetName](#API_DescribeTestSet_ResponseSyntax) **
The test set name of the test set.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern: `^([0-9a-zA-Z][_-]?){1,100}$`
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** InternalServerException **
The service encountered an unexpected condition. Try your request again.
HTTP Status Code: 500
** ResourceNotFoundException **
You asked to describe a resource that doesn't exist. Check the resource that you are requesting and try again.
HTTP Status Code: 404
** ServiceQuotaExceededException **
You have reached a quota for your bot.
HTTP Status Code: 402
** ThrottlingException **
Your request rate is too high. Reduce the frequency of requests.
** retryAfterSeconds **
The number of seconds after which the user can invoke the API again.
HTTP Status Code: 429
** ValidationException **
One of the input parameters in your request isn't valid. Check the parameters and try your request again.
HTTP Status Code: 400
## See Also
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/models.lex.v2-2020-08-07/DescribeTestSet)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/models.lex.v2-2020-08-07/DescribeTestSet)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/DescribeTestSet)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/models.lex.v2-2020-08-07/DescribeTestSet)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/DescribeTestSet)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/models.lex.v2-2020-08-07/DescribeTestSet)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/models.lex.v2-2020-08-07/DescribeTestSet)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/models.lex.v2-2020-08-07/DescribeTestSet)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/models.lex.v2-2020-08-07/DescribeTestSet)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/DescribeTestSet)
# DescribeTestSetDiscrepancyReport
Gets metadata information about the test set discrepancy report.
## Request Syntax
```
GET /testsetdiscrepancy/testSetDiscrepancyReportId HTTP/1.1
```
## URI Request Parameters
The request uses the following URI parameters.
** [testSetDiscrepancyReportId](#API_DescribeTestSetDiscrepancyReport_RequestSyntax) **
The unique identifier of the test set discrepancy report.
Length Constraints: Fixed length of 10.
Pattern: `^[0-9a-zA-Z]+$`
Required: Yes
## Request Body
The request does not have a request body.
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"creationDateTime": number,
"failureReasons": [ "string" ],
"lastUpdatedDataTime": number,
"target": {
"botAliasTarget": {
"botAliasId": "string",
"botId": "string",
"localeId": "string"
}
},
"testSetDiscrepancyRawOutputUrl": "string",
"testSetDiscrepancyReportId": "string",
"testSetDiscrepancyReportStatus": "string",
"testSetDiscrepancyTopErrors": {
"intentDiscrepancies": [
{
"errorMessage": "string",
"intentName": "string"
}
],
"slotDiscrepancies": [
{
"errorMessage": "string",
"intentName": "string",
"slotName": "string"
}
]
},
"testSetId": "string"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [creationDateTime](#API_DescribeTestSetDiscrepancyReport_ResponseSyntax) **
The time and date of creation for the test set discrepancy report.
Type: Timestamp
** [failureReasons](#API_DescribeTestSetDiscrepancyReport_ResponseSyntax) **
The failure report for the test set discrepancy report generation action.
Type: Array of strings
** [lastUpdatedDataTime](#API_DescribeTestSetDiscrepancyReport_ResponseSyntax) **
The date and time of the last update for the test set discrepancy report.
Type: Timestamp
** [target](#API_DescribeTestSetDiscrepancyReport_ResponseSyntax) **
The target bot location for the test set discrepancy report.
Type: [TestSetDiscrepancyReportResourceTarget](API_TestSetDiscrepancyReportResourceTarget.md) object
** [testSetDiscrepancyRawOutputUrl](#API_DescribeTestSetDiscrepancyReport_ResponseSyntax) **
Pre-signed Amazon S3 URL to download the test set discrepancy report.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
** [testSetDiscrepancyReportId](#API_DescribeTestSetDiscrepancyReport_ResponseSyntax) **
The unique identifier of the test set discrepancy report to describe.
Type: String
Length Constraints: Fixed length of 10.
Pattern: `^[0-9a-zA-Z]+$`
** [testSetDiscrepancyReportStatus](#API_DescribeTestSetDiscrepancyReport_ResponseSyntax) **
The status for the test set discrepancy report.
Type: String
Valid Values: `InProgress | Completed | Failed`
** [testSetDiscrepancyTopErrors](#API_DescribeTestSetDiscrepancyReport_ResponseSyntax) **
The top 200 error results from the test set discrepancy report.
Type: [TestSetDiscrepancyErrors](API_TestSetDiscrepancyErrors.md) object
** [testSetId](#API_DescribeTestSetDiscrepancyReport_ResponseSyntax) **
The test set Id for the test set discrepancy report.
Type: String
Length Constraints: Fixed length of 10.
Pattern: `^[0-9a-zA-Z]+$`
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** InternalServerException **
The service encountered an unexpected condition. Try your request again.
HTTP Status Code: 500
** ResourceNotFoundException **
You asked to describe a resource that doesn't exist. Check the resource that you are requesting and try again.
HTTP Status Code: 404
** ServiceQuotaExceededException **
You have reached a quota for your bot.
HTTP Status Code: 402
** ThrottlingException **
Your request rate is too high. Reduce the frequency of requests.
** retryAfterSeconds **
The number of seconds after which the user can invoke the API again.
HTTP Status Code: 429
** ValidationException **
One of the input parameters in your request isn't valid. Check the parameters and try your request again.
HTTP Status Code: 400
## See Also
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/models.lex.v2-2020-08-07/DescribeTestSetDiscrepancyReport)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/models.lex.v2-2020-08-07/DescribeTestSetDiscrepancyReport)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/DescribeTestSetDiscrepancyReport)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/models.lex.v2-2020-08-07/DescribeTestSetDiscrepancyReport)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/DescribeTestSetDiscrepancyReport)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/models.lex.v2-2020-08-07/DescribeTestSetDiscrepancyReport)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/models.lex.v2-2020-08-07/DescribeTestSetDiscrepancyReport)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/models.lex.v2-2020-08-07/DescribeTestSetDiscrepancyReport)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/models.lex.v2-2020-08-07/DescribeTestSetDiscrepancyReport)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/DescribeTestSetDiscrepancyReport)
# DescribeTestSetGeneration
Gets metadata information about the test set generation.
## Request Syntax
```
GET /testsetgenerations/testSetGenerationId HTTP/1.1
```
## URI Request Parameters
The request uses the following URI parameters.
** [testSetGenerationId](#API_DescribeTestSetGeneration_RequestSyntax) **
The unique identifier of the test set generation.
Length Constraints: Fixed length of 10.
Pattern: `^[0-9a-zA-Z]+$`
Required: Yes
## Request Body
The request does not have a request body.
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"creationDateTime": number,
"description": "string",
"failureReasons": [ "string" ],
"generationDataSource": {
"conversationLogsDataSource": {
"botAliasId": "string",
"botId": "string",
"filter": {
"endTime": number,
"inputMode": "string",
"startTime": number
},
"localeId": "string"
}
},
"lastUpdatedDateTime": number,
"roleArn": "string",
"storageLocation": {
"kmsKeyArn": "string",
"s3BucketName": "string",
"s3Path": "string"
},
"testSetGenerationId": "string",
"testSetGenerationStatus": "string",
"testSetId": "string",
"testSetName": "string"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [creationDateTime](#API_DescribeTestSetGeneration_ResponseSyntax) **
The creation date and time for the test set generation.
Type: Timestamp
** [description](#API_DescribeTestSetGeneration_ResponseSyntax) **
The test set description for the test set generation.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 2000.
** [failureReasons](#API_DescribeTestSetGeneration_ResponseSyntax) **
The reasons the test set generation failed.
Type: Array of strings
** [generationDataSource](#API_DescribeTestSetGeneration_ResponseSyntax) **
The data source of the test set used for the test set generation.
Type: [TestSetGenerationDataSource](API_TestSetGenerationDataSource.md) object
** [lastUpdatedDateTime](#API_DescribeTestSetGeneration_ResponseSyntax) **
The date and time of the last update for the test set generation.
Type: Timestamp
** [roleArn](#API_DescribeTestSetGeneration_ResponseSyntax) **
The roleARN of the test set used for the test set generation.
Type: String
Length Constraints: Minimum length of 32. Maximum length of 2048.
Pattern: `^arn:aws:iam::[0-9]{12}:role/.*$`
** [storageLocation](#API_DescribeTestSetGeneration_ResponseSyntax) **
The Amazon S3 storage location for the test set generation.
Type: [TestSetStorageLocation](API_TestSetStorageLocation.md) object
** [testSetGenerationId](#API_DescribeTestSetGeneration_ResponseSyntax) **
The unique identifier of the test set generation.
Type: String
Length Constraints: Fixed length of 10.
Pattern: `^[0-9a-zA-Z]+$`
** [testSetGenerationStatus](#API_DescribeTestSetGeneration_ResponseSyntax) **
The status for the test set generation.
Type: String
Valid Values: `Generating | Ready | Failed | Pending`
** [testSetId](#API_DescribeTestSetGeneration_ResponseSyntax) **
The unique identifier for the test set created for the generated test set.
Type: String
Length Constraints: Fixed length of 10.
Pattern: `^[0-9a-zA-Z]+$`
** [testSetName](#API_DescribeTestSetGeneration_ResponseSyntax) **
The test set name for the generated test set.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern: `^([0-9a-zA-Z][_-]?){1,100}$`
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** InternalServerException **
The service encountered an unexpected condition. Try your request again.
HTTP Status Code: 500
** ResourceNotFoundException **
You asked to describe a resource that doesn't exist. Check the resource that you are requesting and try again.
HTTP Status Code: 404
** ServiceQuotaExceededException **
You have reached a quota for your bot.
HTTP Status Code: 402
** ThrottlingException **
Your request rate is too high. Reduce the frequency of requests.
** retryAfterSeconds **
The number of seconds after which the user can invoke the API again.
HTTP Status Code: 429
** ValidationException **
One of the input parameters in your request isn't valid. Check the parameters and try your request again.
HTTP Status Code: 400
## See Also
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/models.lex.v2-2020-08-07/DescribeTestSetGeneration)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/models.lex.v2-2020-08-07/DescribeTestSetGeneration)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/DescribeTestSetGeneration)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/models.lex.v2-2020-08-07/DescribeTestSetGeneration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/DescribeTestSetGeneration)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/models.lex.v2-2020-08-07/DescribeTestSetGeneration)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/models.lex.v2-2020-08-07/DescribeTestSetGeneration)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/models.lex.v2-2020-08-07/DescribeTestSetGeneration)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/models.lex.v2-2020-08-07/DescribeTestSetGeneration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/DescribeTestSetGeneration)
# GenerateBotElement
Generates sample utterances for an intent.
## Request Syntax
```
POST /bots/botId/botversions/botVersion/botlocales/localeId/generate HTTP/1.1
Content-type: application/json
{
"intentId": "string"
}
```
## URI Request Parameters
The request uses the following URI parameters.
** [botId](#API_GenerateBotElement_RequestSyntax) **
The bot unique Id for the bot request to generate utterances.
Length Constraints: Fixed length of 10.
Pattern: `^[0-9a-zA-Z]+$`
Required: Yes
** [botVersion](#API_GenerateBotElement_RequestSyntax) **
The bot version for the bot request to generate utterances.
Length Constraints: Minimum length of 1. Maximum length of 5.
Pattern: `^(DRAFT|[0-9]+)$`
Required: Yes
** [localeId](#API_GenerateBotElement_RequestSyntax) **
The unique locale Id for the bot request to generate utterances.
Required: Yes
## Request Body
The request accepts the following data in JSON format.
** [intentId](#API_GenerateBotElement_RequestSyntax) **
The intent unique Id for the bot request to generate utterances.
Type: String
Length Constraints: Fixed length of 10.
Pattern: `^[0-9a-zA-Z]+$`
Required: Yes
## Response Syntax
```
HTTP/1.1 202
Content-type: application/json
{
"botId": "string",
"botVersion": "string",
"intentId": "string",
"localeId": "string",
"sampleUtterances": [
{
"utterance": "string"
}
]
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 202 response.
The following data is returned in JSON format by the service.
** [botId](#API_GenerateBotElement_ResponseSyntax) **
The unique bot Id for the bot which received the response.
Type: String
Length Constraints: Fixed length of 10.
Pattern: `^[0-9a-zA-Z]+$`
** [botVersion](#API_GenerateBotElement_ResponseSyntax) **
The unique bot version for the bot which received the response.
Type: String
Length Constraints: Fixed length of 5.
Pattern: `^DRAFT$`
** [intentId](#API_GenerateBotElement_ResponseSyntax) **
The unique intent Id for the bot which received the response.
Type: String
Length Constraints: Fixed length of 10.
Pattern: `^[0-9a-zA-Z]+$`
** [localeId](#API_GenerateBotElement_ResponseSyntax) **
The unique locale Id for the bot which received the response.
Type: String
** [sampleUtterances](#API_GenerateBotElement_ResponseSyntax) **
The sample utterances for the bot which received the response.
Type: Array of [SampleUtterance](API_SampleUtterance.md) objects
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** ConflictException **
The action that you tried to perform couldn't be completed because the resource is in a conflicting state. For example, deleting a bot that is in the CREATING state. Try your request again.
HTTP Status Code: 409
** ConflictException **
The action that you tried to perform couldn't be completed because the resource is in a conflicting state. For example, deleting a bot that is in the CREATING state. Try your request again.
HTTP Status Code: 409
** InternalServerException **
The service encountered an unexpected condition. Try your request again.
HTTP Status Code: 500
** PreconditionFailedException **
Your request couldn't be completed because one or more request fields aren't valid. Check the fields in your request and try again.
HTTP Status Code: 412
** ResourceNotFoundException **
You asked to describe a resource that doesn't exist. Check the resource that you are requesting and try again.
HTTP Status Code: 404
** ServiceQuotaExceededException **
You have reached a quota for your bot.
HTTP Status Code: 402
** ThrottlingException **
Your request rate is too high. Reduce the frequency of requests.
** retryAfterSeconds **
The number of seconds after which the user can invoke the API again.
HTTP Status Code: 429
** ValidationException **
One of the input parameters in your request isn't valid. Check the parameters and try your request again.
HTTP Status Code: 400
## Examples
### Example request
This example illustrates one usage of GenerateBotElement.
```
POST https://models-v2-lex.us-east-1.amazonaws.com/bots/BOT1234567/botversions/DRAFT/botlocales/en_US/generate
Payload:
{
"intentId":"INTENT1234"
}
```
### Example response
This example illustrates one usage of GenerateBotElement.
```
{
"botId": "BOT1234567",
"botVersion": "DRAFT",
"intentId": "INTENT1234",
"localeId": "en_US",
"sampleUtterances": [{
"utterance": "I need to cancel my order {OrderId} due to {CancellationReason}"
}, {
"utterance": "Please cancel order {OrderId} as {CancellationReason}"
}, {
"utterance": "{OrderId} requires cancellation because of {CancellationReason}"
}, {
"utterance": "Cancel order {OrderId} . {CancellationReason}"
}, {
"utterance": "I have to cancel my order {OrderId} . The reason is {CancellationReason}"
}]
}
```
## See Also
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/models.lex.v2-2020-08-07/GenerateBotElement)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/models.lex.v2-2020-08-07/GenerateBotElement)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/GenerateBotElement)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/models.lex.v2-2020-08-07/GenerateBotElement)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/GenerateBotElement)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/models.lex.v2-2020-08-07/GenerateBotElement)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/models.lex.v2-2020-08-07/GenerateBotElement)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/models.lex.v2-2020-08-07/GenerateBotElement)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/models.lex.v2-2020-08-07/GenerateBotElement)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/GenerateBotElement)
# GetTestExecutionArtifactsUrl
The pre-signed Amazon S3 URL to download the test execution result artifacts.
## Request Syntax
```
GET /testexecutions/testExecutionId/artifacturl HTTP/1.1
```
## URI Request Parameters
The request uses the following URI parameters.
** [testExecutionId](#API_GetTestExecutionArtifactsUrl_RequestSyntax) **
The unique identifier of the completed test execution.
Length Constraints: Fixed length of 10.
Pattern: `^[0-9a-zA-Z]+$`
Required: Yes
## Request Body
The request does not have a request body.
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"downloadArtifactsUrl": "string",
"testExecutionId": "string"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [downloadArtifactsUrl](#API_GetTestExecutionArtifactsUrl_ResponseSyntax) **
The pre-signed Amazon S3 URL to download completed test execution.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
** [testExecutionId](#API_GetTestExecutionArtifactsUrl_ResponseSyntax) **
The unique identifier of the completed test execution.
Type: String
Length Constraints: Fixed length of 10.
Pattern: `^[0-9a-zA-Z]+$`
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** InternalServerException **
The service encountered an unexpected condition. Try your request again.
HTTP Status Code: 500
** ResourceNotFoundException **
You asked to describe a resource that doesn't exist. Check the resource that you are requesting and try again.
HTTP Status Code: 404
** ServiceQuotaExceededException **
You have reached a quota for your bot.
HTTP Status Code: 402
** ThrottlingException **
Your request rate is too high. Reduce the frequency of requests.
** retryAfterSeconds **
The number of seconds after which the user can invoke the API again.
HTTP Status Code: 429
** ValidationException **
One of the input parameters in your request isn't valid. Check the parameters and try your request again.
HTTP Status Code: 400
## See Also
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/models.lex.v2-2020-08-07/GetTestExecutionArtifactsUrl)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/models.lex.v2-2020-08-07/GetTestExecutionArtifactsUrl)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/GetTestExecutionArtifactsUrl)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/models.lex.v2-2020-08-07/GetTestExecutionArtifactsUrl)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/GetTestExecutionArtifactsUrl)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/models.lex.v2-2020-08-07/GetTestExecutionArtifactsUrl)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/models.lex.v2-2020-08-07/GetTestExecutionArtifactsUrl)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/models.lex.v2-2020-08-07/GetTestExecutionArtifactsUrl)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/models.lex.v2-2020-08-07/GetTestExecutionArtifactsUrl)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/GetTestExecutionArtifactsUrl)
# ListAggregatedUtterances
Provides a list of utterances that users have sent to the bot.
Utterances are aggregated by the text of the utterance. For example, all instances where customers used the phrase "I want to order pizza" are aggregated into the same line in the response.
You can see both detected utterances and missed utterances. A detected utterance is where the bot properly recognized the utterance and activated the associated intent. A missed utterance was not recognized by the bot and didn't activate an intent.
Utterances can be aggregated for a bot alias or for a bot version, but not both at the same time.
Utterances 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.
## Request Syntax
```
POST /bots/botId/aggregatedutterances/ HTTP/1.1
Content-type: application/json
{
"aggregationDuration": {
"relativeAggregationDuration": {
"timeDimension": "string",
"timeValue": number
}
},
"botAliasId": "string",
"botVersion": "string",
"filters": [
{
"name": "string",
"operator": "string",
"values": [ "string" ]
}
],
"localeId": "string",
"maxResults": number,
"nextToken": "string",
"sortBy": {
"attribute": "string",
"order": "string"
}
}
```
## URI Request Parameters
The request uses the following URI parameters.
** [botId](#API_ListAggregatedUtterances_RequestSyntax) **
The unique identifier of the bot associated with this request.
Length Constraints: Fixed length of 10.
Pattern: `^[0-9a-zA-Z]+$`
Required: Yes
## Request Body
The request accepts the following data in JSON format.
** [aggregationDuration](#API_ListAggregatedUtterances_RequestSyntax) **
The time window for aggregating the utterance information. You can specify a time between one hour and two weeks.
Type: [UtteranceAggregationDuration](API_UtteranceAggregationDuration.md) object
Required: Yes
** [botAliasId](#API_ListAggregatedUtterances_RequestSyntax) **
The identifier of the bot alias associated with this request. If you specify the bot alias, you can't specify the bot version.
Type: String
Length Constraints: Fixed length of 10.
Pattern: `^(\bTSTALIASID\b|[0-9a-zA-Z]+)$`
Required: No
** [botVersion](#API_ListAggregatedUtterances_RequestSyntax) **
The identifier of the bot version associated with this request. If you specify the bot version, you can't specify the bot alias.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 5.
Pattern: `^(DRAFT|[0-9]+)$`
Required: No
** [filters](#API_ListAggregatedUtterances_RequestSyntax) **
Provides the specification of a filter used to limit the utterances in the response to only those that match the filter specification. You can only specify one filter and one string to filter on.
Type: Array of [AggregatedUtterancesFilter](API_AggregatedUtterancesFilter.md) objects
Array Members: Fixed number of 1 item.
Required: No
** [localeId](#API_ListAggregatedUtterances_RequestSyntax) **
The identifier of the language and locale where the utterances were collected. For more information, see [Supported languages](https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html).
Type: String
Required: Yes
** [maxResults](#API_ListAggregatedUtterances_RequestSyntax) **
The maximum number of utterances to return in each page of results. If there are fewer results than the maximum page size, only the actual number of results are returned. If you don't specify the `maxResults` parameter, 1,000 results are returned.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 1000.
Required: No
** [nextToken](#API_ListAggregatedUtterances_RequestSyntax) **
If the response from the `ListAggregatedUtterances` operation contains more results that specified in the `maxResults` parameter, a token is returned in the response. Use that token in the `nextToken` parameter to return the next page of results.
Type: String
Required: No
** [sortBy](#API_ListAggregatedUtterances_RequestSyntax) **
Specifies sorting parameters for the list of utterances. You can sort by the hit count, the missed count, or the number of distinct sessions the utterance appeared in.
Type: [AggregatedUtterancesSortBy](API_AggregatedUtterancesSortBy.md) object
Required: No
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"aggregatedUtterancesSummaries": [
{
"containsDataFromDeletedResources": boolean,
"hitCount": number,
"missedCount": number,
"utterance": "string",
"utteranceFirstRecordedInAggregationDuration": number,
"utteranceLastRecordedInAggregationDuration": number
}
],
"aggregationDuration": {
"relativeAggregationDuration": {
"timeDimension": "string",
"timeValue": number
}
},
"aggregationLastRefreshedDateTime": number,
"aggregationWindowEndTime": number,
"aggregationWindowStartTime": number,
"botAliasId": "string",
"botId": "string",
"botVersion": "string",
"localeId": "string",
"nextToken": "string"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [aggregatedUtterancesSummaries](#API_ListAggregatedUtterances_ResponseSyntax) **
Summaries of the aggregated utterance data. Each response contains information about the number of times that the utterance was seen during the time period, whether it was detected or missed, and when it was seen during the time period.
Type: Array of [AggregatedUtterancesSummary](API_AggregatedUtterancesSummary.md) objects
** [aggregationDuration](#API_ListAggregatedUtterances_ResponseSyntax) **
The time period used to aggregate the utterance data.
Type: [UtteranceAggregationDuration](API_UtteranceAggregationDuration.md) object
** [aggregationLastRefreshedDateTime](#API_ListAggregatedUtterances_ResponseSyntax) **
The last date and time that the aggregated data was collected. The time period depends on the length of the aggregation window.
+ **Hours** - for 1 hour time window, every half hour; otherwise every hour.
+ **Days** - every 6 hours
+ **Weeks** - for a one week time window, every 12 hours; otherwise, every day
Type: Timestamp
** [aggregationWindowEndTime](#API_ListAggregatedUtterances_ResponseSyntax) **
The date and time that the aggregation window ends. Only data collected between the start time and the end time are returned in the results.
Type: Timestamp
** [aggregationWindowStartTime](#API_ListAggregatedUtterances_ResponseSyntax) **
The date and time that the aggregation window begins. Only data collected after this time is returned in the results.
Type: Timestamp
** [botAliasId](#API_ListAggregatedUtterances_ResponseSyntax) **
The identifier of the bot alias that contains the utterances. If you specified the bot version, the bot alias ID isn't returned.
Type: String
Length Constraints: Fixed length of 10.
Pattern: `^(\bTSTALIASID\b|[0-9a-zA-Z]+)$`
** [botId](#API_ListAggregatedUtterances_ResponseSyntax) **
The identifier of the bot that contains the utterances.
Type: String
Length Constraints: Fixed length of 10.
Pattern: `^[0-9a-zA-Z]+$`
** [botVersion](#API_ListAggregatedUtterances_ResponseSyntax) **
The identifier of the bot version that contains the utterances. If you specified the bot alias, the bot version isn't returned.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 5.
Pattern: `^(DRAFT|[0-9]+)$`
** [localeId](#API_ListAggregatedUtterances_ResponseSyntax) **
The identifier of the language and locale that the utterances are in.
Type: String
** [nextToken](#API_ListAggregatedUtterances_ResponseSyntax) **
A token that indicates whether there are more results to return in a response to the `ListAggregatedUtterances` operation. If the `nextToken` field is present, you send the contents as the `nextToken` parameter of a `ListAggregatedUtterances` operation request to get the next page of results.
Type: String
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** InternalServerException **
The service encountered an unexpected condition. Try your request again.
HTTP Status Code: 500
** PreconditionFailedException **
Your request couldn't be completed because one or more request fields aren't valid. Check the fields in your request and try again.
HTTP Status Code: 412
** ThrottlingException **
Your request rate is too high. Reduce the frequency of requests.
** retryAfterSeconds **
The number of seconds after which the user can invoke the API again.
HTTP Status Code: 429
** ValidationException **
One of the input parameters in your request isn't valid. Check the parameters and try your request again.
HTTP Status Code: 400
## See Also
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/models.lex.v2-2020-08-07/ListAggregatedUtterances)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/models.lex.v2-2020-08-07/ListAggregatedUtterances)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/ListAggregatedUtterances)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/models.lex.v2-2020-08-07/ListAggregatedUtterances)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/ListAggregatedUtterances)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/models.lex.v2-2020-08-07/ListAggregatedUtterances)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/models.lex.v2-2020-08-07/ListAggregatedUtterances)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/models.lex.v2-2020-08-07/ListAggregatedUtterances)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/models.lex.v2-2020-08-07/ListAggregatedUtterances)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/ListAggregatedUtterances)
# ListBotAliases
Gets a list of aliases for the specified bot.
## Request Syntax
```
POST /bots/botId/botaliases/ HTTP/1.1
Content-type: application/json
{
"maxResults": number,
"nextToken": "string"
}
```
## URI Request Parameters
The request uses the following URI parameters.
** [botId](#API_ListBotAliases_RequestSyntax) **
The identifier of the bot to list aliases for.
Length Constraints: Fixed length of 10.
Pattern: `^[0-9a-zA-Z]+$`
Required: Yes
## Request Body
The request accepts the following data in JSON format.
** [maxResults](#API_ListBotAliases_RequestSyntax) **
The maximum number of aliases to return in each page of results. If there are fewer results than the max page size, only the actual number of results are returned.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 1000.
Required: No
** [nextToken](#API_ListBotAliases_RequestSyntax) **
If the response from the `ListBotAliases` operation contains more results than specified in the `maxResults` parameter, a token is returned in the response. Use that token in the `nextToken` parameter to return the next page of results.
Type: String
Required: No
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"botAliasSummaries": [
{
"botAliasId": "string",
"botAliasName": "string",
"botAliasStatus": "string",
"botVersion": "string",
"creationDateTime": number,
"description": "string",
"lastUpdatedDateTime": number
}
],
"botId": "string",
"nextToken": "string"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [botAliasSummaries](#API_ListBotAliases_ResponseSyntax) **
Summary information for the bot aliases that meet the filter criteria specified in the request. The length of the list is specified in the `maxResults` parameter of the request. If there are more aliases available, the `nextToken` field contains a token to get the next page of results.
Type: Array of [BotAliasSummary](API_BotAliasSummary.md) objects
** [botId](#API_ListBotAliases_ResponseSyntax) **
The identifier of the bot associated with the aliases.
Type: String
Length Constraints: Fixed length of 10.
Pattern: `^[0-9a-zA-Z]+$`
** [nextToken](#API_ListBotAliases_ResponseSyntax) **
A token that indicates whether there are more results to return in a response to the `ListBotAliases` operation. If the `nextToken` field is present, you send the contents as the `nextToken` parameter of a `ListBotAliases` operation request to get the next page of results.
Type: String
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** InternalServerException **
The service encountered an unexpected condition. Try your request again.
HTTP Status Code: 500
** ServiceQuotaExceededException **
You have reached a quota for your bot.
HTTP Status Code: 402
** ThrottlingException **
Your request rate is too high. Reduce the frequency of requests.
** retryAfterSeconds **
The number of seconds after which the user can invoke the API again.
HTTP Status Code: 429
** ValidationException **
One of the input parameters in your request isn't valid. Check the parameters and try your request again.
HTTP Status Code: 400
## See Also
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/models.lex.v2-2020-08-07/ListBotAliases)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/models.lex.v2-2020-08-07/ListBotAliases)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/ListBotAliases)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/models.lex.v2-2020-08-07/ListBotAliases)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/ListBotAliases)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/models.lex.v2-2020-08-07/ListBotAliases)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/models.lex.v2-2020-08-07/ListBotAliases)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/models.lex.v2-2020-08-07/ListBotAliases)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/models.lex.v2-2020-08-07/ListBotAliases)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/ListBotAliases)
# ListBotAliasReplicas
The action to list the replicated bots created from the source bot alias.
## Request Syntax
```
POST /bots/botId/replicas/replicaRegion/botaliases/ HTTP/1.1
Content-type: application/json
{
"maxResults": number,
"nextToken": "string"
}
```
## URI Request Parameters
The request uses the following URI parameters.
** [botId](#API_ListBotAliasReplicas_RequestSyntax) **
The request for the unique bot ID of the replicated bot created from the source bot alias.
Length Constraints: Fixed length of 10.
Pattern: `^[0-9a-zA-Z]+$`
Required: Yes
** [replicaRegion](#API_ListBotAliasReplicas_RequestSyntax) **
The request for the secondary region of the replicated bot created from the source bot alias.
Length Constraints: Minimum length of 2. Maximum length of 25.
Required: Yes
## Request Body
The request accepts the following data in JSON format.
** [maxResults](#API_ListBotAliasReplicas_RequestSyntax) **
The request for maximum results to list the replicated bots created from the source bot alias.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 1000.
Required: No
** [nextToken](#API_ListBotAliasReplicas_RequestSyntax) **
The request for the next token for the replicated bot created from the source bot alias.
Type: String
Required: No
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"botAliasReplicaSummaries": [
{
"botAliasId": "string",
"botAliasReplicationStatus": "string",
"botVersion": "string",
"creationDateTime": number,
"failureReasons": [ "string" ],
"lastUpdatedDateTime": number
}
],
"botId": "string",
"nextToken": "string",
"replicaRegion": "string",
"sourceRegion": "string"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [botAliasReplicaSummaries](#API_ListBotAliasReplicas_ResponseSyntax) **
The summary information of the replicated bot created from the source bot alias.
Type: Array of [BotAliasReplicaSummary](API_BotAliasReplicaSummary.md) objects
** [botId](#API_ListBotAliasReplicas_ResponseSyntax) **
The unique bot ID of the replicated bot created from the source bot alias.
Type: String
Length Constraints: Fixed length of 10.
Pattern: `^[0-9a-zA-Z]+$`
** [nextToken](#API_ListBotAliasReplicas_ResponseSyntax) **
The next token for the replicated bots created from the source bot alias.
Type: String
** [replicaRegion](#API_ListBotAliasReplicas_ResponseSyntax) **
The secondary region of the replicated bot created from the source bot alias.
Type: String
Length Constraints: Minimum length of 2. Maximum length of 25.
** [sourceRegion](#API_ListBotAliasReplicas_ResponseSyntax) **
The source region of the replicated bot created from the source bot alias.
Type: String
Length Constraints: Minimum length of 2. Maximum length of 25.
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** InternalServerException **
The service encountered an unexpected condition. Try your request again.
HTTP Status Code: 500
** ServiceQuotaExceededException **
You have reached a quota for your bot.
HTTP Status Code: 402
** ThrottlingException **
Your request rate is too high. Reduce the frequency of requests.
** retryAfterSeconds **
The number of seconds after which the user can invoke the API again.
HTTP Status Code: 429
** ValidationException **
One of the input parameters in your request isn't valid. Check the parameters and try your request again.
HTTP Status Code: 400
## Examples
### This example illustrates one example input of ListBotAliasReplicas.
This example illustrates one usage of ListBotAliasReplicas.
```
POST https://models-v2-lex.us-east-1.amazonaws.com/bots/BOT1234567/replicas/us-west-2/botaliases
{
"replicaRegion": "us-west-2",
"maxResults": 50
}
```
### This example illustrates one example response of ListBotAliasReplicas.
This example illustrates one usage of ListBotAliasReplicas.
```
{
"botAliasReplicaSummaries": [{
"botAliasId": "ALIAS12345",
"botAliasReplicationStatus": "Available",
"botVersion": "0000000001",
"creationDateTime": 1.706822183021E9,
"failureReasons": [],
"lastUpdatedDateTime": 1.706822187379E9
}],
"botId": "BOT1234567",
"nextToken": null,
"replicaRegion": "us-west-2",
"sourceRegion": "us-east-1"
}
```
## See Also
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/models.lex.v2-2020-08-07/ListBotAliasReplicas)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/models.lex.v2-2020-08-07/ListBotAliasReplicas)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/ListBotAliasReplicas)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/models.lex.v2-2020-08-07/ListBotAliasReplicas)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/ListBotAliasReplicas)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/models.lex.v2-2020-08-07/ListBotAliasReplicas)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/models.lex.v2-2020-08-07/ListBotAliasReplicas)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/models.lex.v2-2020-08-07/ListBotAliasReplicas)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/models.lex.v2-2020-08-07/ListBotAliasReplicas)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/ListBotAliasReplicas)
# ListBotAnalyzerHistory
Retrieves a list of historical bot analysis executions for a specific bot. You can filter the results by locale and bot version.
The history includes all analysis executions regardless of their status, allowing you to track past analyses and their outcomes.
## Request Syntax
```
POST /bots/botId/botanalyzer/history/ HTTP/1.1
Content-type: application/json
{
"botVersion": "string",
"localeId": "string",
"maxResults": number,
"nextToken": "string"
}
```
## URI Request Parameters
The request uses the following URI parameters.
** [botId](#API_ListBotAnalyzerHistory_RequestSyntax) **
The unique identifier of the bot.
Length Constraints: Fixed length of 10.
Pattern: `^[0-9a-zA-Z]+$`
Required: Yes
## Request Body
The request accepts the following data in JSON format.
** [botVersion](#API_ListBotAnalyzerHistory_RequestSyntax) **
The bot version to filter the history. If not specified, defaults to `DRAFT`.
Type: String
Length Constraints: Fixed length of 5.
Pattern: `^DRAFT$`
Required: No
** [localeId](#API_ListBotAnalyzerHistory_RequestSyntax) **
The locale identifier to filter the history. If not specified, returns history for all locales.
Type: String
Required: No
** [maxResults](#API_ListBotAnalyzerHistory_RequestSyntax) **
The maximum number of history entries to return in the response. The default is 10.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 1000.
Required: No
** [nextToken](#API_ListBotAnalyzerHistory_RequestSyntax) **
If the response from a previous request was truncated, the `nextToken` value is used to retrieve the next page of history entries.
Type: String
Required: No
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"botAnalyzerHistoryList": [
{
"botAnalyzerRequestId": "string",
"botAnalyzerStatus": "string",
"creationDateTime": number
}
],
"botId": "string",
"botVersion": "string",
"localeId": "string",
"nextToken": "string"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [botAnalyzerHistoryList](#API_ListBotAnalyzerHistory_ResponseSyntax) **
A list of historical analysis executions, ordered by creation date with the most recent first.
Type: Array of [BotAnalyzerHistorySummary](API_BotAnalyzerHistorySummary.md) objects
** [botId](#API_ListBotAnalyzerHistory_ResponseSyntax) **
The unique identifier of the bot.
Type: String
Length Constraints: Fixed length of 10.
Pattern: `^[0-9a-zA-Z]+$`
** [botVersion](#API_ListBotAnalyzerHistory_ResponseSyntax) **
The bot version used to filter the history.
Type: String
Length Constraints: Fixed length of 5.
Pattern: `^DRAFT$`
** [localeId](#API_ListBotAnalyzerHistory_ResponseSyntax) **
The locale identifier used to filter the history.
Type: String
** [nextToken](#API_ListBotAnalyzerHistory_ResponseSyntax) **
If the response is truncated, this token can be used in a subsequent request to retrieve the next page of history entries.
Type: String
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** InternalServerException **
The service encountered an unexpected condition. Try your request again.
HTTP Status Code: 500
** ResourceNotFoundException **
You asked to describe a resource that doesn't exist. Check the resource that you are requesting and try again.
HTTP Status Code: 404
** ThrottlingException **
Your request rate is too high. Reduce the frequency of requests.
** retryAfterSeconds **
The number of seconds after which the user can invoke the API again.
HTTP Status Code: 429
** ValidationException **
One of the input parameters in your request isn't valid. Check the parameters and try your request again.
HTTP Status Code: 400
## Examples
### Example request
This example illustrates one usage of ListBotAnalyzerHistory.
```
POST https://models-v2-lex.us-east-1.amazonaws.com/bots//botanalyzer/history/
Payload:
{
"localeId": "en_US",
"botVersion": "DRAFT"
}
```
### Example response
This example illustrates one usage of ListBotAnalyzerHistory.
```
{
"botId": "",
"localeId": "en_US",
"botVersion": "DRAFT",
"botAnalyzerHistoryList": [
{
"botAnalyzerStatus": "Available",
"creationDateTime": 1729570423.948,
"botAnalyzerRequestId": ""
},
{
"botAnalyzerStatus": "Failed",
"creationDateTime": 1729484530.123,
"botAnalyzerRequestId": ""
}
],
"nextToken": ""
}
```
## See Also
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/models.lex.v2-2020-08-07/ListBotAnalyzerHistory)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/models.lex.v2-2020-08-07/ListBotAnalyzerHistory)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/ListBotAnalyzerHistory)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/models.lex.v2-2020-08-07/ListBotAnalyzerHistory)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/ListBotAnalyzerHistory)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/models.lex.v2-2020-08-07/ListBotAnalyzerHistory)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/models.lex.v2-2020-08-07/ListBotAnalyzerHistory)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/models.lex.v2-2020-08-07/ListBotAnalyzerHistory)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/models.lex.v2-2020-08-07/ListBotAnalyzerHistory)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/ListBotAnalyzerHistory)
# ListBotLocales
Gets a list of locales for the specified bot.
## Request Syntax
```
POST /bots/botId/botversions/botVersion/botlocales/ HTTP/1.1
Content-type: application/json
{
"filters": [
{
"name": "string",
"operator": "string",
"values": [ "string" ]
}
],
"maxResults": number,
"nextToken": "string",
"sortBy": {
"attribute": "string",
"order": "string"
}
}
```
## URI Request Parameters
The request uses the following URI parameters.
** [botId](#API_ListBotLocales_RequestSyntax) **
The identifier of the bot to list locales for.
Length Constraints: Fixed length of 10.
Pattern: `^[0-9a-zA-Z]+$`
Required: Yes
** [botVersion](#API_ListBotLocales_RequestSyntax) **
The version of the bot to list locales for.
Length Constraints: Minimum length of 1. Maximum length of 5.
Pattern: `^(DRAFT|[0-9]+)$`
Required: Yes
## Request Body
The request accepts the following data in JSON format.
** [filters](#API_ListBotLocales_RequestSyntax) **
Provides the specification for a filter used to limit the response to only those locales that match the filter specification. You can only specify one filter and one value to filter on.
Type: Array of [BotLocaleFilter](API_BotLocaleFilter.md) objects
Array Members: Fixed number of 1 item.
Required: No
** [maxResults](#API_ListBotLocales_RequestSyntax) **
The maximum number of aliases to return in each page of results. If there are fewer results than the max page size, only the actual number of results are returned.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 1000.
Required: No
** [nextToken](#API_ListBotLocales_RequestSyntax) **
If the response from the `ListBotLocales` operation contains more results than specified in the `maxResults` parameter, a token is returned in the response. Use that token as the `nextToken` parameter to return the next page of results.
Type: String
Required: No
** [sortBy](#API_ListBotLocales_RequestSyntax) **
Specifies sorting parameters for the list of locales. You can sort by locale name in ascending or descending order.
Type: [BotLocaleSortBy](API_BotLocaleSortBy.md) object
Required: No
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"botId": "string",
"botLocaleSummaries": [
{
"botLocaleStatus": "string",
"description": "string",
"lastBuildSubmittedDateTime": number,
"lastUpdatedDateTime": number,
"localeId": "string",
"localeName": "string"
}
],
"botVersion": "string",
"nextToken": "string"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [botId](#API_ListBotLocales_ResponseSyntax) **
The identifier of the bot to list locales for.
Type: String
Length Constraints: Fixed length of 10.
Pattern: `^[0-9a-zA-Z]+$`
** [botLocaleSummaries](#API_ListBotLocales_ResponseSyntax) **
Summary information for the locales that meet the filter criteria specified in the request. The length of the list is specified in the `maxResults` parameter of the request. If there are more locales available, the `nextToken` field contains a token to get the next page of results.
Type: Array of [BotLocaleSummary](API_BotLocaleSummary.md) objects
** [botVersion](#API_ListBotLocales_ResponseSyntax) **
The version of the bot.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 5.
Pattern: `^(DRAFT|[0-9]+)$`
** [nextToken](#API_ListBotLocales_ResponseSyntax) **
A token that indicates whether there are more results to return in a response to the `ListBotLocales` operation. If the `nextToken` field is present, you send the contents as the `nextToken` parameter of a `ListBotLocales` operation request to get the next page of results.
Type: String
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** InternalServerException **
The service encountered an unexpected condition. Try your request again.
HTTP Status Code: 500
** ServiceQuotaExceededException **
You have reached a quota for your bot.
HTTP Status Code: 402
** ThrottlingException **
Your request rate is too high. Reduce the frequency of requests.
** retryAfterSeconds **
The number of seconds after which the user can invoke the API again.
HTTP Status Code: 429
** ValidationException **
One of the input parameters in your request isn't valid. Check the parameters and try your request again.
HTTP Status Code: 400
## See Also
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/models.lex.v2-2020-08-07/ListBotLocales)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/models.lex.v2-2020-08-07/ListBotLocales)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/ListBotLocales)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/models.lex.v2-2020-08-07/ListBotLocales)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/ListBotLocales)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/models.lex.v2-2020-08-07/ListBotLocales)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/models.lex.v2-2020-08-07/ListBotLocales)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/models.lex.v2-2020-08-07/ListBotLocales)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/models.lex.v2-2020-08-07/ListBotLocales)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/ListBotLocales)
# ListBotRecommendations
Get a list of bot recommendations that meet the specified criteria.
## Request Syntax
```
POST /bots/botId/botversions/botVersion/botlocales/localeId/botrecommendations/ HTTP/1.1
Content-type: application/json
{
"maxResults": number,
"nextToken": "string"
}
```
## URI Request Parameters
The request uses the following URI parameters.
** [botId](#API_ListBotRecommendations_RequestSyntax) **
The unique identifier of the bot that contains the bot recommendation list.
Length Constraints: Fixed length of 10.
Pattern: `^[0-9a-zA-Z]+$`
Required: Yes
** [botVersion](#API_ListBotRecommendations_RequestSyntax) **
The version of the bot that contains the bot recommendation list.
Length Constraints: Fixed length of 5.
Pattern: `^DRAFT$`
Required: Yes
** [localeId](#API_ListBotRecommendations_RequestSyntax) **
The identifier of the language and locale of the bot recommendation list.
Required: Yes
## Request Body
The request accepts the following data in JSON format.
** [maxResults](#API_ListBotRecommendations_RequestSyntax) **
The maximum number of bot recommendations to return in each page of results. If there are fewer results than the max page size, only the actual number of results are returned.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 1000.
Required: No
** [nextToken](#API_ListBotRecommendations_RequestSyntax) **
If the response from the ListBotRecommendation operation contains more results than specified in the maxResults parameter, a token is returned in the response. Use that token in the nextToken parameter to return the next page of results.
Type: String
Required: No
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"botId": "string",
"botRecommendationSummaries": [
{
"botRecommendationId": "string",
"botRecommendationStatus": "string",
"creationDateTime": number,
"lastUpdatedDateTime": number
}
],
"botVersion": "string",
"localeId": "string",
"nextToken": "string"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [botId](#API_ListBotRecommendations_ResponseSyntax) **
The unique identifier of the bot that contains the bot recommendation list.
Type: String
Length Constraints: Fixed length of 10.
Pattern: `^[0-9a-zA-Z]+$`
** [botRecommendationSummaries](#API_ListBotRecommendations_ResponseSyntax) **
Summary information for the bot recommendations that meet the filter specified in this request. The length of the list is specified in the maxResults parameter of the request. If there are more bot recommendations available, the nextToken field contains a token to get the next page of results.
Type: Array of [BotRecommendationSummary](API_BotRecommendationSummary.md) objects
** [botVersion](#API_ListBotRecommendations_ResponseSyntax) **
The version of the bot that contains the bot recommendation list.
Type: String
Length Constraints: Fixed length of 5.
Pattern: `^DRAFT$`
** [localeId](#API_ListBotRecommendations_ResponseSyntax) **
The identifier of the language and locale of the bot recommendation list.
Type: String
** [nextToken](#API_ListBotRecommendations_ResponseSyntax) **
A token that indicates whether there are more results to return in a response to the ListBotRecommendations operation. If the nextToken field is present, you send the contents as the nextToken parameter of a ListBotRecommendations operation request to get the next page of results.
Type: String
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** InternalServerException **
The service encountered an unexpected condition. Try your request again.
HTTP Status Code: 500
** ResourceNotFoundException **
You asked to describe a resource that doesn't exist. Check the resource that you are requesting and try again.
HTTP Status Code: 404
** ThrottlingException **
Your request rate is too high. Reduce the frequency of requests.
** retryAfterSeconds **
The number of seconds after which the user can invoke the API again.
HTTP Status Code: 429
** ValidationException **
One of the input parameters in your request isn't valid. Check the parameters and try your request again.
HTTP Status Code: 400
## See Also
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/models.lex.v2-2020-08-07/ListBotRecommendations)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/models.lex.v2-2020-08-07/ListBotRecommendations)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/ListBotRecommendations)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/models.lex.v2-2020-08-07/ListBotRecommendations)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/ListBotRecommendations)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/models.lex.v2-2020-08-07/ListBotRecommendations)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/models.lex.v2-2020-08-07/ListBotRecommendations)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/models.lex.v2-2020-08-07/ListBotRecommendations)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/models.lex.v2-2020-08-07/ListBotRecommendations)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/ListBotRecommendations)
# ListBotReplicas
The action to list the replicated bots.
## Request Syntax
```
POST /bots/botId/replicas/ HTTP/1.1
```
## URI Request Parameters
The request uses the following URI parameters.
** [botId](#API_ListBotReplicas_RequestSyntax) **
The request for the unique bot IDs in the list of replicated bots.
Length Constraints: Fixed length of 10.
Pattern: `^[0-9a-zA-Z]+$`
Required: Yes
## Request Body
The request does not have a request body.
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"botId": "string",
"botReplicaSummaries": [
{
"botReplicaStatus": "string",
"creationDateTime": number,
"failureReasons": [ "string" ],
"replicaRegion": "string"
}
],
"sourceRegion": "string"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [botId](#API_ListBotReplicas_ResponseSyntax) **
the unique bot IDs in the list of replicated bots.
Type: String
Length Constraints: Fixed length of 10.
Pattern: `^[0-9a-zA-Z]+$`
** [botReplicaSummaries](#API_ListBotReplicas_ResponseSyntax) **
The summary details for the replicated bots.
Type: Array of [BotReplicaSummary](API_BotReplicaSummary.md) objects
** [sourceRegion](#API_ListBotReplicas_ResponseSyntax) **
The source region of the source bots in the list of replicated bots.
Type: String
Length Constraints: Minimum length of 2. Maximum length of 25.
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** InternalServerException **
The service encountered an unexpected condition. Try your request again.
HTTP Status Code: 500
** ServiceQuotaExceededException **
You have reached a quota for your bot.
HTTP Status Code: 402
** ThrottlingException **
Your request rate is too high. Reduce the frequency of requests.
** retryAfterSeconds **
The number of seconds after which the user can invoke the API again.
HTTP Status Code: 429
** ValidationException **
One of the input parameters in your request isn't valid. Check the parameters and try your request again.
HTTP Status Code: 400
## Examples
### This example illustrates one example input of ListBotReplicas.
This example illustrates one usage of ListBotReplicas.
```
POST https://models-v2-lex.us-east-1.amazonaws.com/bots/BOT1234567/replicas/
{
}
```
### This example illustrates one example response of ListBotReplicas.
This example illustrates one usage of ListBotReplicas.
```
{
"botId": "BOT1234567",
"botReplicaSummaries": [{
"botReplicaStatus": "Enabled",
"creationDateTime": 1.706821927692E9,
"failureReasons": null,
"replicaRegion": "us-west-2"
}],
"sourceRegion": "us-east-1"
}
```
## See Also
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/models.lex.v2-2020-08-07/ListBotReplicas)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/models.lex.v2-2020-08-07/ListBotReplicas)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/ListBotReplicas)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/models.lex.v2-2020-08-07/ListBotReplicas)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/ListBotReplicas)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/models.lex.v2-2020-08-07/ListBotReplicas)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/models.lex.v2-2020-08-07/ListBotReplicas)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/models.lex.v2-2020-08-07/ListBotReplicas)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/models.lex.v2-2020-08-07/ListBotReplicas)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/ListBotReplicas)
# ListBotResourceGenerations
Lists the generation requests made for a bot locale.
## Request Syntax
```
POST /bots/botId/botversions/botVersion/botlocales/localeId/generations HTTP/1.1
Content-type: application/json
{
"maxResults": number,
"nextToken": "string",
"sortBy": {
"attribute": "string",
"order": "string"
}
}
```
## URI Request Parameters
The request uses the following URI parameters.
** [botId](#API_ListBotResourceGenerations_RequestSyntax) **
The unique identifier of the bot whose generation requests you want to view.
Length Constraints: Fixed length of 10.
Pattern: `^[0-9a-zA-Z]+$`
Required: Yes
** [botVersion](#API_ListBotResourceGenerations_RequestSyntax) **
The version of the bot whose generation requests you want to view.
Length Constraints: Minimum length of 1. Maximum length of 5.
Pattern: `^(DRAFT|[0-9]+)$`
Required: Yes
** [localeId](#API_ListBotResourceGenerations_RequestSyntax) **
The locale of the bot whose generation requests you want to view.
Required: Yes
## Request Body
The request accepts the following data in JSON format.
** [maxResults](#API_ListBotResourceGenerations_RequestSyntax) **
The maximum number of results to return in the response.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 1000.
Required: No
** [nextToken](#API_ListBotResourceGenerations_RequestSyntax) **
If the total number of results is greater than the number specified in the `maxResults`, the response returns a token in the `nextToken` field. Use this token when making a request to return the next batch of results.
Type: String
Required: No
** [sortBy](#API_ListBotResourceGenerations_RequestSyntax) **
An object containing information about the attribute and the method by which to sort the results
Type: [GenerationSortBy](API_GenerationSortBy.md) object
Required: No
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"botId": "string",
"botVersion": "string",
"generationSummaries": [
{
"creationDateTime": number,
"generationId": "string",
"generationStatus": "string",
"lastUpdatedDateTime": number
}
],
"localeId": "string",
"nextToken": "string"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [botId](#API_ListBotResourceGenerations_ResponseSyntax) **
The unique identifier of the bot for which the generation requests were made.
Type: String
Length Constraints: Fixed length of 10.
Pattern: `^[0-9a-zA-Z]+$`
** [botVersion](#API_ListBotResourceGenerations_ResponseSyntax) **
The version of the bot for which the generation requests were made.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 5.
Pattern: `^(DRAFT|[0-9]+)$`
** [generationSummaries](#API_ListBotResourceGenerations_ResponseSyntax) **
A list of objects, each containing information about a generation request for the bot locale.
Type: Array of [GenerationSummary](API_GenerationSummary.md) objects
** [localeId](#API_ListBotResourceGenerations_ResponseSyntax) **
The locale of the bot for which the generation requests were made.
Type: String
** [nextToken](#API_ListBotResourceGenerations_ResponseSyntax) **
If the total number of results is greater than the number specified in the `maxResults`, the response returns a token in the `nextToken` field. Use this token when making a request to return the next batch of results.
Type: String
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** InternalServerException **
The service encountered an unexpected condition. Try your request again.
HTTP Status Code: 500
** ResourceNotFoundException **
You asked to describe a resource that doesn't exist. Check the resource that you are requesting and try again.
HTTP Status Code: 404
** ThrottlingException **
Your request rate is too high. Reduce the frequency of requests.
** retryAfterSeconds **
The number of seconds after which the user can invoke the API again.
HTTP Status Code: 429
** ValidationException **
One of the input parameters in your request isn't valid. Check the parameters and try your request again.
HTTP Status Code: 400
## Examples
### Example request
This example illustrates one usage of ListBotResourceGenerations.
```
POST https://models-v2-lex.us-east-1.amazonaws.com/bots/BOT1234567/botversions/DRAFT/botlocales/en_GB/generations
Payload:
{
"sortBy": {
"attribute": "lastUpdatedTime",
"order": "Descending"
},
"maxResults": 1
}
```
### Example response
This example illustrates one usage of ListBotResourceGenerations.
```
{
"botId": "BOT1234567",
"botVersion": "DRAFT",
"generationSummaries": [{
"creationDateTime": 1.699570064977E9,
"generationId": "GEN1234567",
"generationStatus": "Complete",
"lastUpdatedDateTime": 1.699570064977E9
}],
"localeId": "en_GB",
"nextToken": null
}
```
## See Also
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/models.lex.v2-2020-08-07/ListBotResourceGenerations)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/models.lex.v2-2020-08-07/ListBotResourceGenerations)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/ListBotResourceGenerations)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/models.lex.v2-2020-08-07/ListBotResourceGenerations)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/ListBotResourceGenerations)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/models.lex.v2-2020-08-07/ListBotResourceGenerations)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/models.lex.v2-2020-08-07/ListBotResourceGenerations)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/models.lex.v2-2020-08-07/ListBotResourceGenerations)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/models.lex.v2-2020-08-07/ListBotResourceGenerations)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/ListBotResourceGenerations)
# ListBots
Gets a list of available bots.
## Request Syntax
```
POST /bots/ HTTP/1.1
Content-type: application/json
{
"filters": [
{
"name": "string",
"operator": "string",
"values": [ "string" ]
}
],
"maxResults": number,
"nextToken": "string",
"sortBy": {
"attribute": "string",
"order": "string"
}
}
```
## URI Request Parameters
The request does not use any URI parameters.
## Request Body
The request accepts the following data in JSON format.
** [filters](#API_ListBots_RequestSyntax) **
Provides the specification of a filter used to limit the bots in the response to only those that match the filter specification. You can only specify one filter and one string to filter on.
Type: Array of [BotFilter](API_BotFilter.md) objects
Array Members: Minimum number of 1 item. Maximum number of 2 items.
Required: No
** [maxResults](#API_ListBots_RequestSyntax) **
The maximum number of bots to return in each page of results. If there are fewer results than the maximum page size, only the actual number of results are returned.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 1000.
Required: No
** [nextToken](#API_ListBots_RequestSyntax) **
If the response from the `ListBots` operation contains more results than specified in the `maxResults` parameter, a token is returned in the response.
Use the returned token in the `nextToken` parameter of a `ListBots` request to return the next page of results. For a complete set of results, call the `ListBots` operation until the `nextToken` returned in the response is null.
Type: String
Required: No
** [sortBy](#API_ListBots_RequestSyntax) **
Specifies sorting parameters for the list of bots. You can specify that the list be sorted by bot name in ascending or descending order.
Type: [BotSortBy](API_BotSortBy.md) object
Required: No
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"botSummaries": [
{
"botId": "string",
"botName": "string",
"botStatus": "string",
"botType": "string",
"description": "string",
"lastUpdatedDateTime": number,
"latestBotVersion": "string"
}
],
"nextToken": "string"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [botSummaries](#API_ListBots_ResponseSyntax) **
Summary information for the bots that meet the filter criteria specified in the request. The length of the list is specified in the `maxResults` parameter of the request. If there are more bots available, the `nextToken` field contains a token to the next page of results.
Type: Array of [BotSummary](API_BotSummary.md) objects
** [nextToken](#API_ListBots_ResponseSyntax) **
A token that indicates whether there are more results to return in a response to the `ListBots` operation. If the `nextToken` field is present, you send the contents as the `nextToken` parameter of a `ListBots` operation request to get the next page of results.
Type: String
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** InternalServerException **
The service encountered an unexpected condition. Try your request again.
HTTP Status Code: 500
** ServiceQuotaExceededException **
You have reached a quota for your bot.
HTTP Status Code: 402
** ThrottlingException **
Your request rate is too high. Reduce the frequency of requests.
** retryAfterSeconds **
The number of seconds after which the user can invoke the API again.
HTTP Status Code: 429
** ValidationException **
One of the input parameters in your request isn't valid. Check the parameters and try your request again.
HTTP Status Code: 400
## See Also
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/models.lex.v2-2020-08-07/ListBots)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/models.lex.v2-2020-08-07/ListBots)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/ListBots)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/models.lex.v2-2020-08-07/ListBots)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/ListBots)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/models.lex.v2-2020-08-07/ListBots)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/models.lex.v2-2020-08-07/ListBots)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/models.lex.v2-2020-08-07/ListBots)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/models.lex.v2-2020-08-07/ListBots)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/ListBots)
# ListBotVersionReplicas
Contains information about all the versions replication statuses applicable for Global Resiliency.
## Request Syntax
```
POST /bots/botId/replicas/replicaRegion/botversions/ HTTP/1.1
Content-type: application/json
{
"maxResults": number,
"nextToken": "string",
"sortBy": {
"attribute": "string",
"order": "string"
}
}
```
## URI Request Parameters
The request uses the following URI parameters.
** [botId](#API_ListBotVersionReplicas_RequestSyntax) **
The request for the unique ID in the list of replicated bots.
Length Constraints: Fixed length of 10.
Pattern: `^[0-9a-zA-Z]+$`
Required: Yes
** [replicaRegion](#API_ListBotVersionReplicas_RequestSyntax) **
The request for the region used in the list of replicated bots.
Length Constraints: Minimum length of 2. Maximum length of 25.
Required: Yes
## Request Body
The request accepts the following data in JSON format.
** [maxResults](#API_ListBotVersionReplicas_RequestSyntax) **
The maximum results given in the list of replicated bots.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 1000.
Required: No
** [nextToken](#API_ListBotVersionReplicas_RequestSyntax) **
The next token given in the list of replicated bots.
Type: String
Required: No
** [sortBy](#API_ListBotVersionReplicas_RequestSyntax) **
The requested sort category for the list of replicated bots.
Type: [BotVersionReplicaSortBy](API_BotVersionReplicaSortBy.md) object
Required: No
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"botId": "string",
"botVersionReplicaSummaries": [
{
"botVersion": "string",
"botVersionReplicationStatus": "string",
"creationDateTime": number,
"failureReasons": [ "string" ]
}
],
"nextToken": "string",
"replicaRegion": "string",
"sourceRegion": "string"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [botId](#API_ListBotVersionReplicas_ResponseSyntax) **
The unique ID of the bots in the list of replicated bots.
Type: String
Length Constraints: Fixed length of 10.
Pattern: `^[0-9a-zA-Z]+$`
** [botVersionReplicaSummaries](#API_ListBotVersionReplicas_ResponseSyntax) **
The information summary used for the replicated bots in the list of replicated bots.
Type: Array of [BotVersionReplicaSummary](API_BotVersionReplicaSummary.md) objects
** [nextToken](#API_ListBotVersionReplicas_ResponseSyntax) **
The next token used for the replicated bots in the list of replicated bots.
Type: String
** [replicaRegion](#API_ListBotVersionReplicas_ResponseSyntax) **
The region used for the replicated bots in the list of replicated bots.
Type: String
Length Constraints: Minimum length of 2. Maximum length of 25.
** [sourceRegion](#API_ListBotVersionReplicas_ResponseSyntax) **
The source region used for the bots in the list of replicated bots.
Type: String
Length Constraints: Minimum length of 2. Maximum length of 25.
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** InternalServerException **
The service encountered an unexpected condition. Try your request again.
HTTP Status Code: 500
** ServiceQuotaExceededException **
You have reached a quota for your bot.
HTTP Status Code: 402
** ThrottlingException **
Your request rate is too high. Reduce the frequency of requests.
** retryAfterSeconds **
The number of seconds after which the user can invoke the API again.
HTTP Status Code: 429
** ValidationException **
One of the input parameters in your request isn't valid. Check the parameters and try your request again.
HTTP Status Code: 400
## Examples
### This example illustrates one example input of ListBotVersionReplicas.
This example illustrates one usage of ListBotVersionReplicas.
```
POST https://models-v2-lex.us-east-1.amazonaws.com/bots/BOT1234567/replicas/us-west-2/botversions
{
"replicaRegion": "us-west-2",
"maxResults": 50,
"sortBy": {
"attribute" : "BotVersion",
"order" : "Ascending"
}
}
```
### This example illustrates one example response of ListBotVersionReplicas.
This example illustrates one usage of ListBotVersionReplicas.
```
{
"botId": "BOT1234567",
"botVersionReplicaSummaries": [{
"botVersion": "0000000001",
"botVersionReplicationStatus": "Available",
"creationDateTime": 1.706822064378E9,
"failureReasons": []
}],
"nextToken": null,
"replicaRegion": "us-west-2",
"sourceRegion": "us-east-1"
}
```
## See Also
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/models.lex.v2-2020-08-07/ListBotVersionReplicas)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/models.lex.v2-2020-08-07/ListBotVersionReplicas)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/ListBotVersionReplicas)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/models.lex.v2-2020-08-07/ListBotVersionReplicas)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/ListBotVersionReplicas)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/models.lex.v2-2020-08-07/ListBotVersionReplicas)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/models.lex.v2-2020-08-07/ListBotVersionReplicas)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/models.lex.v2-2020-08-07/ListBotVersionReplicas)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/models.lex.v2-2020-08-07/ListBotVersionReplicas)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/ListBotVersionReplicas)
# ListBotVersions
Gets information about all of the versions of a bot.
The `ListBotVersions` operation returns a summary of each version of a bot. For example, if a bot has three numbered versions, the `ListBotVersions` operation returns for summaries, one for each numbered version and one for the `DRAFT` version.
The `ListBotVersions` operation always returns at least one version, the `DRAFT` version.
## Request Syntax
```
POST /bots/botId/botversions/ HTTP/1.1
Content-type: application/json
{
"maxResults": number,
"nextToken": "string",
"sortBy": {
"attribute": "string",
"order": "string"
}
}
```
## URI Request Parameters
The request uses the following URI parameters.
** [botId](#API_ListBotVersions_RequestSyntax) **
The identifier of the bot to list versions for.
Length Constraints: Fixed length of 10.
Pattern: `^[0-9a-zA-Z]+$`
Required: Yes
## Request Body
The request accepts the following data in JSON format.
** [maxResults](#API_ListBotVersions_RequestSyntax) **
The maximum number of versions to return in each page of results. If there are fewer results than the max page size, only the actual number of results are returned.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 1000.
Required: No
** [nextToken](#API_ListBotVersions_RequestSyntax) **
If the response to the `ListBotVersion` operation contains more results than specified in the `maxResults` parameter, a token is returned in the response. Use that token in the `nextToken` parameter to return the next page of results.
Type: String
Required: No
** [sortBy](#API_ListBotVersions_RequestSyntax) **
Specifies sorting parameters for the list of versions. You can specify that the list be sorted by version name in either ascending or descending order.
Type: [BotVersionSortBy](API_BotVersionSortBy.md) object
Required: No
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"botId": "string",
"botVersionSummaries": [
{
"botName": "string",
"botStatus": "string",
"botVersion": "string",
"creationDateTime": number,
"description": "string"
}
],
"nextToken": "string"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [botId](#API_ListBotVersions_ResponseSyntax) **
The identifier of the bot to list versions for.
Type: String
Length Constraints: Fixed length of 10.
Pattern: `^[0-9a-zA-Z]+$`
** [botVersionSummaries](#API_ListBotVersions_ResponseSyntax) **
Summary information for the bot versions that meet the filter criteria specified in the request. The length of the list is specified in the `maxResults` parameter of the request. If there are more versions available, the `nextToken` field contains a token to get the next page of results.
Type: Array of [BotVersionSummary](API_BotVersionSummary.md) objects
** [nextToken](#API_ListBotVersions_ResponseSyntax) **
A token that indicates whether there are more results to return in a response to the `ListBotVersions` operation. If the `nextToken` field is present, you send the contents as the `nextToken` parameter of a `ListBotAliases` operation request to get the next page of results.
Type: String
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** InternalServerException **
The service encountered an unexpected condition. Try your request again.
HTTP Status Code: 500
** ServiceQuotaExceededException **
You have reached a quota for your bot.
HTTP Status Code: 402
** ThrottlingException **
Your request rate is too high. Reduce the frequency of requests.
** retryAfterSeconds **
The number of seconds after which the user can invoke the API again.
HTTP Status Code: 429
** ValidationException **
One of the input parameters in your request isn't valid. Check the parameters and try your request again.
HTTP Status Code: 400
## See Also
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/models.lex.v2-2020-08-07/ListBotVersions)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/models.lex.v2-2020-08-07/ListBotVersions)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/ListBotVersions)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/models.lex.v2-2020-08-07/ListBotVersions)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/ListBotVersions)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/models.lex.v2-2020-08-07/ListBotVersions)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/models.lex.v2-2020-08-07/ListBotVersions)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/models.lex.v2-2020-08-07/ListBotVersions)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/models.lex.v2-2020-08-07/ListBotVersions)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/ListBotVersions)
# ListBuiltInIntents
Gets a list of built-in intents provided by Amazon Lex that you can use in your bot.
To use a built-in intent as a the base for your own intent, include the built-in intent signature in the `parentIntentSignature` parameter when you call the `CreateIntent` operation. For more information, see [CreateIntent](https://docs.aws.amazon.com/lexv2/latest/APIReference/API_CreateIntent.html).
## Request Syntax
```
POST /builtins/locales/localeId/intents/ HTTP/1.1
Content-type: application/json
{
"maxResults": number,
"nextToken": "string",
"sortBy": {
"attribute": "string",
"order": "string"
}
}
```
## URI Request Parameters
The request uses the following URI parameters.
** [localeId](#API_ListBuiltInIntents_RequestSyntax) **
The identifier of the language and locale of the intents to list. The string must match one of the supported locales. For more information, see [Supported languages](https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html).
Required: Yes
## Request Body
The request accepts the following data in JSON format.
** [maxResults](#API_ListBuiltInIntents_RequestSyntax) **
The maximum number of built-in intents to return in each page of results. If there are fewer results than the max page size, only the actual number of results are returned.
Type: Integer
Valid Range: Fixed value of 20.
Required: No
** [nextToken](#API_ListBuiltInIntents_RequestSyntax) **
If the response from the `ListBuiltInIntents` operation contains more results than specified in the `maxResults` parameter, a token is returned in the response. Use that token in the `nextToken` parameter to return the next page of results.
Type: String
Required: No
** [sortBy](#API_ListBuiltInIntents_RequestSyntax) **
Specifies sorting parameters for the list of built-in intents. You can specify that the list be sorted by the built-in intent signature in either ascending or descending order.
Type: [BuiltInIntentSortBy](API_BuiltInIntentSortBy.md) object
Required: No
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"builtInIntentSummaries": [
{
"description": "string",
"intentSignature": "string"
}
],
"localeId": "string",
"nextToken": "string"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [builtInIntentSummaries](#API_ListBuiltInIntents_ResponseSyntax) **
Summary information for the built-in intents that meet the filter criteria specified in the request. The length of the list is specified in the `maxResults` parameter of the request. If there are more intents available, the `nextToken` field contains a token to get the next page of results.
Type: Array of [BuiltInIntentSummary](API_BuiltInIntentSummary.md) objects
** [localeId](#API_ListBuiltInIntents_ResponseSyntax) **
The language and locale of the intents in the list.
Type: String
** [nextToken](#API_ListBuiltInIntents_ResponseSyntax) **
A token that indicates whether there are more results to return in a response to the `ListBuiltInIntents` operation. If the `nextToken` field is present, you send the contents as the `nextToken` parameter of a `ListBotAliases` operation request to get the next page of results.
Type: String
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** InternalServerException **
The service encountered an unexpected condition. Try your request again.
HTTP Status Code: 500
** ServiceQuotaExceededException **
You have reached a quota for your bot.
HTTP Status Code: 402
** ThrottlingException **
Your request rate is too high. Reduce the frequency of requests.
** retryAfterSeconds **
The number of seconds after which the user can invoke the API again.
HTTP Status Code: 429
** ValidationException **
One of the input parameters in your request isn't valid. Check the parameters and try your request again.
HTTP Status Code: 400
## See Also
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/models.lex.v2-2020-08-07/ListBuiltInIntents)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/models.lex.v2-2020-08-07/ListBuiltInIntents)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/ListBuiltInIntents)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/models.lex.v2-2020-08-07/ListBuiltInIntents)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/ListBuiltInIntents)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/models.lex.v2-2020-08-07/ListBuiltInIntents)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/models.lex.v2-2020-08-07/ListBuiltInIntents)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/models.lex.v2-2020-08-07/ListBuiltInIntents)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/models.lex.v2-2020-08-07/ListBuiltInIntents)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/ListBuiltInIntents)
# ListBuiltInSlotTypes
Gets a list of built-in slot types that meet the specified criteria.
## Request Syntax
```
POST /builtins/locales/localeId/slottypes/ HTTP/1.1
Content-type: application/json
{
"maxResults": number,
"nextToken": "string",
"sortBy": {
"attribute": "string",
"order": "string"
}
}
```
## URI Request Parameters
The request uses the following URI parameters.
** [localeId](#API_ListBuiltInSlotTypes_RequestSyntax) **
The identifier of the language and locale of the slot types to list. The string must match one of the supported locales. For more information, see [Supported languages](https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html).
Required: Yes
## Request Body
The request accepts the following data in JSON format.
** [maxResults](#API_ListBuiltInSlotTypes_RequestSyntax) **
The maximum number of built-in slot types to return in each page of results. If there are fewer results than the max page size, only the actual number of results are returned.
Type: Integer
Valid Range: Fixed value of 20.
Required: No
** [nextToken](#API_ListBuiltInSlotTypes_RequestSyntax) **
If the response from the `ListBuiltInSlotTypes` operation contains more results than specified in the `maxResults` parameter, a token is returned in the response. Use that token in the `nextToken` parameter to return the next page of results.
Type: String
Required: No
** [sortBy](#API_ListBuiltInSlotTypes_RequestSyntax) **
Determines the sort order for the response from the `ListBuiltInSlotTypes` operation. You can choose to sort by the slot type signature in either ascending or descending order.
Type: [BuiltInSlotTypeSortBy](API_BuiltInSlotTypeSortBy.md) object
Required: No
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"builtInSlotTypeSummaries": [
{
"description": "string",
"slotTypeSignature": "string"
}
],
"localeId": "string",
"nextToken": "string"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [builtInSlotTypeSummaries](#API_ListBuiltInSlotTypes_ResponseSyntax) **
Summary information for the built-in slot types that meet the filter criteria specified in the request. The length of the list is specified in the `maxResults` parameter of the request. If there are more slot types available, the `nextToken` field contains a token to get the next page of results.
Type: Array of [BuiltInSlotTypeSummary](API_BuiltInSlotTypeSummary.md) objects
** [localeId](#API_ListBuiltInSlotTypes_ResponseSyntax) **
The language and locale of the slot types in the list.
Type: String
** [nextToken](#API_ListBuiltInSlotTypes_ResponseSyntax) **
A token that indicates whether there are more results to return in a response to the `ListBuiltInSlotTypes` operation. If the `nextToken` field is present, you send the contents as the `nextToken` parameter of a `LIstBuiltInSlotTypes` operation request to get the next page of results.
Type: String
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** InternalServerException **
The service encountered an unexpected condition. Try your request again.
HTTP Status Code: 500
** ServiceQuotaExceededException **
You have reached a quota for your bot.
HTTP Status Code: 402
** ThrottlingException **
Your request rate is too high. Reduce the frequency of requests.
** retryAfterSeconds **
The number of seconds after which the user can invoke the API again.
HTTP Status Code: 429
** ValidationException **
One of the input parameters in your request isn't valid. Check the parameters and try your request again.
HTTP Status Code: 400
## See Also
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/models.lex.v2-2020-08-07/ListBuiltInSlotTypes)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/models.lex.v2-2020-08-07/ListBuiltInSlotTypes)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/ListBuiltInSlotTypes)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/models.lex.v2-2020-08-07/ListBuiltInSlotTypes)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/ListBuiltInSlotTypes)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/models.lex.v2-2020-08-07/ListBuiltInSlotTypes)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/models.lex.v2-2020-08-07/ListBuiltInSlotTypes)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/models.lex.v2-2020-08-07/ListBuiltInSlotTypes)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/models.lex.v2-2020-08-07/ListBuiltInSlotTypes)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/ListBuiltInSlotTypes)
# ListCustomVocabularyItems
Paginated list of custom vocabulary items for a given bot locale's custom vocabulary.
## Request Syntax
```
POST /bots/botId/botversions/botVersion/botlocales/localeId/customvocabulary/DEFAULT/list HTTP/1.1
Content-type: application/json
{
"maxResults": number,
"nextToken": "string"
}
```
## URI Request Parameters
The request uses the following URI parameters.
** [botId](#API_ListCustomVocabularyItems_RequestSyntax) **
The identifier of the version of the bot associated with this custom vocabulary.
Length Constraints: Fixed length of 10.
Pattern: `^[0-9a-zA-Z]+$`
Required: Yes
** [botVersion](#API_ListCustomVocabularyItems_RequestSyntax) **
The bot version of the bot to the list custom vocabulary request.
Length Constraints: Minimum length of 1. Maximum length of 5.
Pattern: `^(DRAFT|[0-9]+)$`
Required: Yes
** [localeId](#API_ListCustomVocabularyItems_RequestSyntax) **
The identifier of the language and locale where this custom vocabulary is used. The string must match one of the supported locales. For more information, see Supported languages (https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html).
Required: Yes
## Request Body
The request accepts the following data in JSON format.
** [maxResults](#API_ListCustomVocabularyItems_RequestSyntax) **
The maximum number of items returned by the list operation.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 1000.
Required: No
** [nextToken](#API_ListCustomVocabularyItems_RequestSyntax) **
The nextToken identifier to the list custom vocabulary request.
Type: String
Required: No
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"botId": "string",
"botVersion": "string",
"customVocabularyItems": [
{
"displayAs": "string",
"itemId": "string",
"phrase": "string",
"weight": number
}
],
"localeId": "string",
"nextToken": "string"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [botId](#API_ListCustomVocabularyItems_ResponseSyntax) **
The identifier of the bot associated with this custom vocabulary.
Type: String
Length Constraints: Fixed length of 10.
Pattern: `^[0-9a-zA-Z]+$`
** [botVersion](#API_ListCustomVocabularyItems_ResponseSyntax) **
The identifier of the version of the bot associated with this custom vocabulary.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 5.
Pattern: `^(DRAFT|[0-9]+)$`
** [customVocabularyItems](#API_ListCustomVocabularyItems_ResponseSyntax) **
The custom vocabulary items from the list custom vocabulary response.
Type: Array of [CustomVocabularyItem](API_CustomVocabularyItem.md) objects
** [localeId](#API_ListCustomVocabularyItems_ResponseSyntax) **
The identifier of the language and locale where this custom vocabulary is used. The string must match one of the supported locales. For more information, see [ Supported Languages ](https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html).
Type: String
** [nextToken](#API_ListCustomVocabularyItems_ResponseSyntax) **
The nextToken identifier to the list custom vocabulary response.
Type: String
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** InternalServerException **
The service encountered an unexpected condition. Try your request again.
HTTP Status Code: 500
** ResourceNotFoundException **
You asked to describe a resource that doesn't exist. Check the resource that you are requesting and try again.
HTTP Status Code: 404
** ServiceQuotaExceededException **
You have reached a quota for your bot.
HTTP Status Code: 402
** ThrottlingException **
Your request rate is too high. Reduce the frequency of requests.
** retryAfterSeconds **
The number of seconds after which the user can invoke the API again.
HTTP Status Code: 429
** ValidationException **
One of the input parameters in your request isn't valid. Check the parameters and try your request again.
HTTP Status Code: 400
## See Also
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/models.lex.v2-2020-08-07/ListCustomVocabularyItems)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/models.lex.v2-2020-08-07/ListCustomVocabularyItems)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/ListCustomVocabularyItems)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/models.lex.v2-2020-08-07/ListCustomVocabularyItems)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/ListCustomVocabularyItems)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/models.lex.v2-2020-08-07/ListCustomVocabularyItems)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/models.lex.v2-2020-08-07/ListCustomVocabularyItems)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/models.lex.v2-2020-08-07/ListCustomVocabularyItems)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/models.lex.v2-2020-08-07/ListCustomVocabularyItems)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/ListCustomVocabularyItems)
# ListExports
Lists the exports for a bot, bot locale, or custom vocabulary. Exports are kept in the list for 7 days.
## Request Syntax
```
POST /exports/ HTTP/1.1
Content-type: application/json
{
"botId": "string",
"botVersion": "string",
"filters": [
{
"name": "string",
"operator": "string",
"values": [ "string" ]
}
],
"localeId": "string",
"maxResults": number,
"nextToken": "string",
"sortBy": {
"attribute": "string",
"order": "string"
}
}
```
## URI Request Parameters
The request does not use any URI parameters.
## Request Body
The request accepts the following data in JSON format.
** [botId](#API_ListExports_RequestSyntax) **
The unique identifier that Amazon Lex assigned to the bot.
Type: String
Length Constraints: Fixed length of 10.
Pattern: `^[0-9a-zA-Z]+$`
Required: No
** [botVersion](#API_ListExports_RequestSyntax) **
The version of the bot to list exports for.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 5.
Pattern: `^(DRAFT|[0-9]+)$`
Required: No
** [filters](#API_ListExports_RequestSyntax) **
Provides the specification of a filter used to limit the exports in the response to only those that match the filter specification. You can only specify one filter and one string to filter on.
Type: Array of [ExportFilter](API_ExportFilter.md) objects
Array Members: Fixed number of 1 item.
Required: No
** [localeId](#API_ListExports_RequestSyntax) **
Specifies the resources that should be exported. If you don't specify a resource type in the `filters` parameter, both bot locales and custom vocabularies are exported.
Type: String
Required: No
** [maxResults](#API_ListExports_RequestSyntax) **
The maximum number of exports to return in each page of results. If there are fewer results than the max page size, only the actual number of results are returned.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 1000.
Required: No
** [nextToken](#API_ListExports_RequestSyntax) **
If the response from the `ListExports` operation contains more results that specified in the `maxResults` parameter, a token is returned in the response.
Use the returned token in the `nextToken` parameter of a `ListExports` request to return the next page of results. For a complete set of results, call the `ListExports` operation until the `nextToken` returned in the response is null.
Type: String
Required: No
** [sortBy](#API_ListExports_RequestSyntax) **
Determines the field that the list of exports is sorted by. You can sort by the `LastUpdatedDateTime` field in ascending or descending order.
Type: [ExportSortBy](API_ExportSortBy.md) object
Required: No
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"botId": "string",
"botVersion": "string",
"exportSummaries": [
{
"creationDateTime": number,
"exportId": "string",
"exportStatus": "string",
"fileFormat": "string",
"lastUpdatedDateTime": number,
"resourceSpecification": {
"botExportSpecification": {
"botId": "string",
"botVersion": "string"
},
"botLocaleExportSpecification": {
"botId": "string",
"botVersion": "string",
"localeId": "string"
},
"customVocabularyExportSpecification": {
"botId": "string",
"botVersion": "string",
"localeId": "string"
},
"testSetExportSpecification": {
"testSetId": "string"
}
}
}
],
"localeId": "string",
"nextToken": "string"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [botId](#API_ListExports_ResponseSyntax) **
The unique identifier assigned to the bot by Amazon Lex.
Type: String
Length Constraints: Fixed length of 10.
Pattern: `^[0-9a-zA-Z]+$`
** [botVersion](#API_ListExports_ResponseSyntax) **
The version of the bot that was exported.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 5.
Pattern: `^(DRAFT|[0-9]+)$`
** [exportSummaries](#API_ListExports_ResponseSyntax) **
Summary information for the exports that meet the filter criteria specified in the request. The length of the list is specified in the `maxResults` parameter. If there are more exports available, the `nextToken` field contains a token to get the next page of results.
Type: Array of [ExportSummary](API_ExportSummary.md) objects
** [localeId](#API_ListExports_ResponseSyntax) **
The locale specified in the request.
Type: String
** [nextToken](#API_ListExports_ResponseSyntax) **
A token that indicates whether there are more results to return in a response to the `ListExports` operation. If the `nextToken` field is present, you send the contents as the `nextToken` parameter of a `ListExports` operation request to get the next page of results.
Type: String
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** InternalServerException **
The service encountered an unexpected condition. Try your request again.
HTTP Status Code: 500
** ThrottlingException **
Your request rate is too high. Reduce the frequency of requests.
** retryAfterSeconds **
The number of seconds after which the user can invoke the API again.
HTTP Status Code: 429
** ValidationException **
One of the input parameters in your request isn't valid. Check the parameters and try your request again.
HTTP Status Code: 400
## See Also
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/models.lex.v2-2020-08-07/ListExports)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/models.lex.v2-2020-08-07/ListExports)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/ListExports)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/models.lex.v2-2020-08-07/ListExports)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/ListExports)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/models.lex.v2-2020-08-07/ListExports)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/models.lex.v2-2020-08-07/ListExports)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/models.lex.v2-2020-08-07/ListExports)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/models.lex.v2-2020-08-07/ListExports)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/ListExports)
# ListImports
Lists the imports for a bot, bot locale, or custom vocabulary. Imports are kept in the list for 7 days.
## Request Syntax
```
POST /imports/ HTTP/1.1
Content-type: application/json
{
"botId": "string",
"botVersion": "string",
"filters": [
{
"name": "string",
"operator": "string",
"values": [ "string" ]
}
],
"localeId": "string",
"maxResults": number,
"nextToken": "string",
"sortBy": {
"attribute": "string",
"order": "string"
}
}
```
## URI Request Parameters
The request does not use any URI parameters.
## Request Body
The request accepts the following data in JSON format.
** [botId](#API_ListImports_RequestSyntax) **
The unique identifier that Amazon Lex assigned to the bot.
Type: String
Length Constraints: Fixed length of 10.
Pattern: `^[0-9a-zA-Z]+$`
Required: No
** [botVersion](#API_ListImports_RequestSyntax) **
The version of the bot to list imports for.
Type: String
Length Constraints: Fixed length of 5.
Pattern: `^DRAFT$`
Required: No
** [filters](#API_ListImports_RequestSyntax) **
Provides the specification of a filter used to limit the bots in the response to only those that match the filter specification. You can only specify one filter and one string to filter on.
Type: Array of [ImportFilter](API_ImportFilter.md) objects
Array Members: Fixed number of 1 item.
Required: No
** [localeId](#API_ListImports_RequestSyntax) **
Specifies the locale that should be present in the list. If you don't specify a resource type in the `filters` parameter, the list contains both bot locales and custom vocabularies.
Type: String
Required: No
** [maxResults](#API_ListImports_RequestSyntax) **
The maximum number of imports to return in each page of results. If there are fewer results than the max page size, only the actual number of results are returned.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 1000.
Required: No
** [nextToken](#API_ListImports_RequestSyntax) **
If the response from the `ListImports` operation contains more results than specified in the `maxResults` parameter, a token is returned in the response.
Use the returned token in the `nextToken` parameter of a `ListImports` request to return the next page of results. For a complete set of results, call the `ListImports` operation until the `nextToken` returned in the response is null.
Type: String
Required: No
** [sortBy](#API_ListImports_RequestSyntax) **
Determines the field that the list of imports is sorted by. You can sort by the `LastUpdatedDateTime` field in ascending or descending order.
Type: [ImportSortBy](API_ImportSortBy.md) object
Required: No
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"botId": "string",
"botVersion": "string",
"importSummaries": [
{
"creationDateTime": number,
"importedResourceId": "string",
"importedResourceName": "string",
"importedResourceType": "string",
"importId": "string",
"importStatus": "string",
"lastUpdatedDateTime": number,
"mergeStrategy": "string"
}
],
"localeId": "string",
"nextToken": "string"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [botId](#API_ListImports_ResponseSyntax) **
The unique identifier assigned by Amazon Lex to the bot.
Type: String
Length Constraints: Fixed length of 10.
Pattern: `^[0-9a-zA-Z]+$`
** [botVersion](#API_ListImports_ResponseSyntax) **
The version of the bot that was imported. It will always be `DRAFT`.
Type: String
Length Constraints: Fixed length of 5.
Pattern: `^DRAFT$`
** [importSummaries](#API_ListImports_ResponseSyntax) **
Summary information for the imports that meet the filter criteria specified in the request. The length of the list is specified in the `maxResults` parameter. If there are more imports available, the `nextToken` field contains a token to get the next page of results.
Type: Array of [ImportSummary](API_ImportSummary.md) objects
** [localeId](#API_ListImports_ResponseSyntax) **
The locale specified in the request.
Type: String
** [nextToken](#API_ListImports_ResponseSyntax) **
A token that indicates whether there are more results to return in a response to the `ListImports` operation. If the `nextToken` field is present, you send the contents as the `nextToken` parameter of a `ListImports` operation request to get the next page of results.
Type: String
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** InternalServerException **
The service encountered an unexpected condition. Try your request again.
HTTP Status Code: 500
** ThrottlingException **
Your request rate is too high. Reduce the frequency of requests.
** retryAfterSeconds **
The number of seconds after which the user can invoke the API again.
HTTP Status Code: 429
** ValidationException **
One of the input parameters in your request isn't valid. Check the parameters and try your request again.
HTTP Status Code: 400
## See Also
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/models.lex.v2-2020-08-07/ListImports)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/models.lex.v2-2020-08-07/ListImports)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/ListImports)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/models.lex.v2-2020-08-07/ListImports)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/ListImports)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/models.lex.v2-2020-08-07/ListImports)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/models.lex.v2-2020-08-07/ListImports)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/models.lex.v2-2020-08-07/ListImports)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/models.lex.v2-2020-08-07/ListImports)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/ListImports)
# ListIntentMetrics
Retrieves summary metrics for the intents in your bot. The following fields are required:
+ `metrics` – A list of [AnalyticsIntentMetric](https://docs.aws.amazon.com/lexv2/latest/APIReference/API_AnalyticsIntentMetric.html) objects. In each object, use the `name` field to specify the metric to calculate, the `statistic` field to specify whether to calculate the `Sum`, `Average`, or `Max` number, and the `order` field to specify whether to sort the results in `Ascending` or `Descending` order.
+ `startDateTime` and `endDateTime` – Define a time range for which you want to retrieve results.
Of the optional fields, you can organize the results in the following ways:
+ Use the `filters` field to filter the results, the `groupBy` field to specify categories by which to group the results, and the `binBy` field to specify time intervals by which to group the results.
+ Use the `maxResults` field to limit the number of results to return in a single response and the `nextToken` field to return the next batch of results if the response does not return the full set of results.
Note that an `order` field exists in both `binBy` and `metrics`. You can specify only one `order` in a given request.
## Request Syntax
```
POST /bots/botId/analytics/intentmetrics HTTP/1.1
Content-type: application/json
{
"binBy": [
{
"interval": "string",
"name": "string",
"order": "string"
}
],
"endDateTime": number,
"filters": [
{
"name": "string",
"operator": "string",
"values": [ "string" ]
}
],
"groupBy": [
{
"name": "string"
}
],
"maxResults": number,
"metrics": [
{
"name": "string",
"order": "string",
"statistic": "string"
}
],
"nextToken": "string",
"startDateTime": number
}
```
## URI Request Parameters
The request uses the following URI parameters.
** [botId](#API_ListIntentMetrics_RequestSyntax) **
The identifier for the bot for which you want to retrieve intent metrics.
Length Constraints: Fixed length of 10.
Pattern: `^[0-9a-zA-Z]+$`
Required: Yes
## Request Body
The request accepts the following data in JSON format.
** [binBy](#API_ListIntentMetrics_RequestSyntax) **
A list of objects, each of which contains specifications for organizing the results by time.
Type: Array of [AnalyticsBinBySpecification](API_AnalyticsBinBySpecification.md) objects
Array Members: Fixed number of 1 item.
Required: No
** [endDateTime](#API_ListIntentMetrics_RequestSyntax) **
The date and time that marks the end of the range of time for which you want to see intent metrics.
Type: Timestamp
Required: Yes
** [filters](#API_ListIntentMetrics_RequestSyntax) **
A list of objects, each of which describes a condition by which you want to filter the results.
Type: Array of [AnalyticsIntentFilter](API_AnalyticsIntentFilter.md) objects
Array Members: Minimum number of 1 item. Maximum number of 9 items.
Required: No
** [groupBy](#API_ListIntentMetrics_RequestSyntax) **
A list of objects, each of which specifies how to group the results. You can group by the following criteria:
+ `IntentName` – The name of the intent.
+ `IntentEndState` – The final state of the intent. The possible end states are detailed in [Key definitions](https://docs.aws.amazon.com/analytics-key-definitions-intents) in the user guide.
Type: Array of [AnalyticsIntentGroupBySpecification](API_AnalyticsIntentGroupBySpecification.md) objects
Array Members: Minimum number of 1 item. Maximum number of 3 items.
Required: No
** [maxResults](#API_ListIntentMetrics_RequestSyntax) **
The maximum number of results to return in each page of results. If there are fewer results than the maximum page size, only the actual number of results are returned.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 1000.
Required: No
** [metrics](#API_ListIntentMetrics_RequestSyntax) **
A list of objects, each of which contains a metric you want to list, the statistic for the metric you want to return, and the order by which to organize the results.
Type: Array of [AnalyticsIntentMetric](API_AnalyticsIntentMetric.md) objects
Array Members: Minimum number of 1 item. Maximum number of 5 items.
Required: Yes
** [nextToken](#API_ListIntentMetrics_RequestSyntax) **
If the response from the ListIntentMetrics operation contains more results than specified in the maxResults parameter, a token is returned in the response.
Use the returned token in the nextToken parameter of a ListIntentMetrics request to return the next page of results. For a complete set of results, call the ListIntentMetrics operation until the nextToken returned in the response is null.
Type: String
Required: No
** [startDateTime](#API_ListIntentMetrics_RequestSyntax) **
The timestamp that marks the beginning of the range of time for which you want to see intent metrics.
Type: Timestamp
Required: Yes
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"botId": "string",
"nextToken": "string",
"results": [
{
"binKeys": [
{
"name": "string",
"value": number
}
],
"groupByKeys": [
{
"name": "string",
"value": "string"
}
],
"metricsResults": [
{
"name": "string",
"statistic": "string",
"value": number
}
]
}
]
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [botId](#API_ListIntentMetrics_ResponseSyntax) **
The identifier for the bot for which you retrieved intent metrics.
Type: String
Length Constraints: Fixed length of 10.
Pattern: `^[0-9a-zA-Z]+$`
** [nextToken](#API_ListIntentMetrics_ResponseSyntax) **
If the response from the ListIntentMetrics operation contains more results than specified in the maxResults parameter, a token is returned in the response.
Use the returned token in the nextToken parameter of a ListIntentMetrics request to return the next page of results. For a complete set of results, call the ListIntentMetrics operation until the nextToken returned in the response is null.
Type: String
** [results](#API_ListIntentMetrics_ResponseSyntax) **
The results for the intent metrics.
Type: Array of [AnalyticsIntentResult](API_AnalyticsIntentResult.md) objects
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** InternalServerException **
The service encountered an unexpected condition. Try your request again.
HTTP Status Code: 500
** PreconditionFailedException **
Your request couldn't be completed because one or more request fields aren't valid. Check the fields in your request and try again.
HTTP Status Code: 412
** ServiceQuotaExceededException **
You have reached a quota for your bot.
HTTP Status Code: 402
** ThrottlingException **
Your request rate is too high. Reduce the frequency of requests.
** retryAfterSeconds **
The number of seconds after which the user can invoke the API again.
HTTP Status Code: 429
** ValidationException **
One of the input parameters in your request isn't valid. Check the parameters and try your request again.
HTTP Status Code: 400
## See Also
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/models.lex.v2-2020-08-07/ListIntentMetrics)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/models.lex.v2-2020-08-07/ListIntentMetrics)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/ListIntentMetrics)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/models.lex.v2-2020-08-07/ListIntentMetrics)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/ListIntentMetrics)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/models.lex.v2-2020-08-07/ListIntentMetrics)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/models.lex.v2-2020-08-07/ListIntentMetrics)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/models.lex.v2-2020-08-07/ListIntentMetrics)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/models.lex.v2-2020-08-07/ListIntentMetrics)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/ListIntentMetrics)
# ListIntentPaths
Retrieves summary statistics for a path of intents that users take over sessions with your bot. The following fields are required:
+ `startDateTime` and `endDateTime` – Define a time range for which you want to retrieve results.
+ `intentPath` – Define an order of intents for which you want to retrieve metrics. Separate intents in the path with a forward slash. For example, populate the `intentPath` field with `/BookCar/BookHotel` to see details about how many times users invoked the `BookCar` and `BookHotel` intents in that order.
Use the optional `filters` field to filter the results.
## Request Syntax
```
POST /bots/botId/analytics/intentpaths HTTP/1.1
Content-type: application/json
{
"endDateTime": number,
"filters": [
{
"name": "string",
"operator": "string",
"values": [ "string" ]
}
],
"intentPath": "string",
"startDateTime": number
}
```
## URI Request Parameters
The request uses the following URI parameters.
** [botId](#API_ListIntentPaths_RequestSyntax) **
The identifier for the bot for which you want to retrieve intent path metrics.
Length Constraints: Fixed length of 10.
Pattern: `^[0-9a-zA-Z]+$`
Required: Yes
## Request Body
The request accepts the following data in JSON format.
** [endDateTime](#API_ListIntentPaths_RequestSyntax) **
The date and time that marks the end of the range of time for which you want to see intent path metrics.
Type: Timestamp
Required: Yes
** [filters](#API_ListIntentPaths_RequestSyntax) **
A list of objects, each describes a condition by which you want to filter the results.
Type: Array of [AnalyticsPathFilter](API_AnalyticsPathFilter.md) objects
Array Members: Minimum number of 1 item. Maximum number of 5 items.
Required: No
** [intentPath](#API_ListIntentPaths_RequestSyntax) **
The intent path for which you want to retrieve metrics. Use a forward slash to separate intents in the path. For example:
+ /BookCar
+ /BookCar/BookHotel
+ /BookHotel/BookCar
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Required: Yes
** [startDateTime](#API_ListIntentPaths_RequestSyntax) **
The date and time that marks the beginning of the range of time for which you want to see intent path metrics.
Type: Timestamp
Required: Yes
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"nodeSummaries": [
{
"intentCount": number,
"intentLevel": number,
"intentName": "string",
"intentPath": "string",
"nodeType": "string"
}
]
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [nodeSummaries](#API_ListIntentPaths_ResponseSyntax) **
A list of objects, each of which contains information about a node in the intent path for which you requested metrics.
Type: Array of [AnalyticsIntentNodeSummary](API_AnalyticsIntentNodeSummary.md) objects
Array Members: Minimum number of 1 item. Maximum number of 100 items.
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** InternalServerException **
The service encountered an unexpected condition. Try your request again.
HTTP Status Code: 500
** PreconditionFailedException **
Your request couldn't be completed because one or more request fields aren't valid. Check the fields in your request and try again.
HTTP Status Code: 412
** ServiceQuotaExceededException **
You have reached a quota for your bot.
HTTP Status Code: 402
** ThrottlingException **
Your request rate is too high. Reduce the frequency of requests.
** retryAfterSeconds **
The number of seconds after which the user can invoke the API again.
HTTP Status Code: 429
** ValidationException **
One of the input parameters in your request isn't valid. Check the parameters and try your request again.
HTTP Status Code: 400
## See Also
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/models.lex.v2-2020-08-07/ListIntentPaths)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/models.lex.v2-2020-08-07/ListIntentPaths)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/ListIntentPaths)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/models.lex.v2-2020-08-07/ListIntentPaths)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/ListIntentPaths)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/models.lex.v2-2020-08-07/ListIntentPaths)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/models.lex.v2-2020-08-07/ListIntentPaths)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/models.lex.v2-2020-08-07/ListIntentPaths)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/models.lex.v2-2020-08-07/ListIntentPaths)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/ListIntentPaths)
# ListIntents
Get a list of intents that meet the specified criteria.
## Request Syntax
```
POST /bots/botId/botversions/botVersion/botlocales/localeId/intents/ HTTP/1.1
Content-type: application/json
{
"filters": [
{
"name": "string",
"operator": "string",
"values": [ "string" ]
}
],
"maxResults": number,
"nextToken": "string",
"sortBy": {
"attribute": "string",
"order": "string"
}
}
```
## URI Request Parameters
The request uses the following URI parameters.
** [botId](#API_ListIntents_RequestSyntax) **
The unique identifier of the bot that contains the intent.
Length Constraints: Fixed length of 10.
Pattern: `^[0-9a-zA-Z]+$`
Required: Yes
** [botVersion](#API_ListIntents_RequestSyntax) **
The version of the bot that contains the intent.
Length Constraints: Minimum length of 1. Maximum length of 5.
Pattern: `^(DRAFT|[0-9]+)$`
Required: Yes
** [localeId](#API_ListIntents_RequestSyntax) **
The identifier of the language and locale of the intents to list. The string must match one of the supported locales. For more information, see [Supported languages](https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html).
Required: Yes
## Request Body
The request accepts the following data in JSON format.
** [filters](#API_ListIntents_RequestSyntax) **
Provides the specification of a filter used to limit the intents in the response to only those that match the filter specification. You can only specify one filter and only one string to filter on.
Type: Array of [IntentFilter](API_IntentFilter.md) objects
Array Members: Fixed number of 1 item.
Required: No
** [maxResults](#API_ListIntents_RequestSyntax) **
The maximum number of intents to return in each page of results. If there are fewer results than the max page size, only the actual number of results are returned.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 1000.
Required: No
** [nextToken](#API_ListIntents_RequestSyntax) **
If the response from the `ListIntents` operation contains more results than specified in the `maxResults` parameter, a token is returned in the response.
Use the returned token in the `nextToken` parameter of a `ListIntents` request to return the next page of results. For a complete set of results, call the `ListIntents` operation until the `nextToken` returned in the response is null.
Type: String
Required: No
** [sortBy](#API_ListIntents_RequestSyntax) **
Determines the sort order for the response from the `ListIntents` operation. You can choose to sort by the intent name or last updated date in either ascending or descending order.
Type: [IntentSortBy](API_IntentSortBy.md) object
Required: No
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"botId": "string",
"botVersion": "string",
"intentSummaries": [
{
"description": "string",
"inputContexts": [
{
"name": "string"
}
],
"intentDisplayName": "string",
"intentId": "string",
"intentName": "string",
"lastUpdatedDateTime": number,
"outputContexts": [
{
"name": "string",
"timeToLiveInSeconds": number,
"turnsToLive": number
}
],
"parentIntentSignature": "string"
}
],
"localeId": "string",
"nextToken": "string"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [botId](#API_ListIntents_ResponseSyntax) **
The identifier of the bot that contains the intent.
Type: String
Length Constraints: Fixed length of 10.
Pattern: `^[0-9a-zA-Z]+$`
** [botVersion](#API_ListIntents_ResponseSyntax) **
The version of the bot that contains the intent.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 5.
Pattern: `^(DRAFT|[0-9]+)$`
** [intentSummaries](#API_ListIntents_ResponseSyntax) **
Summary information for the intents that meet the filter criteria specified in the request. The length of the list is specified in the `maxResults` parameter of the request. If there are more intents available, the `nextToken` field contains a token to get the next page of results.
Type: Array of [IntentSummary](API_IntentSummary.md) objects
** [localeId](#API_ListIntents_ResponseSyntax) **
The language and locale of the intents in the list.
Type: String
** [nextToken](#API_ListIntents_ResponseSyntax) **
A token that indicates whether there are more results to return in a response to the `ListIntents` operation. If the `nextToken` field is present, you send the contents as the `nextToken` parameter of a `ListIntents` operation request to get the next page of results.
Type: String
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** InternalServerException **
The service encountered an unexpected condition. Try your request again.
HTTP Status Code: 500
** ServiceQuotaExceededException **
You have reached a quota for your bot.
HTTP Status Code: 402
** ThrottlingException **
Your request rate is too high. Reduce the frequency of requests.
** retryAfterSeconds **
The number of seconds after which the user can invoke the API again.
HTTP Status Code: 429
** ValidationException **
One of the input parameters in your request isn't valid. Check the parameters and try your request again.
HTTP Status Code: 400
## See Also
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/models.lex.v2-2020-08-07/ListIntents)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/models.lex.v2-2020-08-07/ListIntents)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/ListIntents)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/models.lex.v2-2020-08-07/ListIntents)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/ListIntents)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/models.lex.v2-2020-08-07/ListIntents)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/models.lex.v2-2020-08-07/ListIntents)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/models.lex.v2-2020-08-07/ListIntents)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/models.lex.v2-2020-08-07/ListIntents)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/ListIntents)
# ListIntentStageMetrics
Retrieves summary metrics for the stages within intents in your bot. The following fields are required:
+ `metrics` – A list of [AnalyticsIntentStageMetric](https://docs.aws.amazon.com/lexv2/latest/APIReference/API_AnalyticsIntentStageMetric.html) objects. In each object, use the `name` field to specify the metric to calculate, the `statistic` field to specify whether to calculate the `Sum`, `Average`, or `Max` number, and the `order` field to specify whether to sort the results in `Ascending` or `Descending` order.
+ `startDateTime` and `endDateTime` – Define a time range for which you want to retrieve results.
Of the optional fields, you can organize the results in the following ways:
+ Use the `filters` field to filter the results, the `groupBy` field to specify categories by which to group the results, and the `binBy` field to specify time intervals by which to group the results.
+ Use the `maxResults` field to limit the number of results to return in a single response and the `nextToken` field to return the next batch of results if the response does not return the full set of results.
Note that an `order` field exists in both `binBy` and `metrics`. You can only specify one `order` in a given request.
## Request Syntax
```
POST /bots/botId/analytics/intentstagemetrics HTTP/1.1
Content-type: application/json
{
"binBy": [
{
"interval": "string",
"name": "string",
"order": "string"
}
],
"endDateTime": number,
"filters": [
{
"name": "string",
"operator": "string",
"values": [ "string" ]
}
],
"groupBy": [
{
"name": "string"
}
],
"maxResults": number,
"metrics": [
{
"name": "string",
"order": "string",
"statistic": "string"
}
],
"nextToken": "string",
"startDateTime": number
}
```
## URI Request Parameters
The request uses the following URI parameters.
** [botId](#API_ListIntentStageMetrics_RequestSyntax) **
The identifier for the bot for which you want to retrieve intent stage metrics.
Length Constraints: Fixed length of 10.
Pattern: `^[0-9a-zA-Z]+$`
Required: Yes
## Request Body
The request accepts the following data in JSON format.
** [binBy](#API_ListIntentStageMetrics_RequestSyntax) **
A list of objects, each of which contains specifications for organizing the results by time.
Type: Array of [AnalyticsBinBySpecification](API_AnalyticsBinBySpecification.md) objects
Array Members: Fixed number of 1 item.
Required: No
** [endDateTime](#API_ListIntentStageMetrics_RequestSyntax) **
The date and time that marks the end of the range of time for which you want to see intent stage metrics.
Type: Timestamp
Required: Yes
** [filters](#API_ListIntentStageMetrics_RequestSyntax) **
A list of objects, each of which describes a condition by which you want to filter the results.
Type: Array of [AnalyticsIntentStageFilter](API_AnalyticsIntentStageFilter.md) objects
Array Members: Minimum number of 1 item. Maximum number of 9 items.
Required: No
** [groupBy](#API_ListIntentStageMetrics_RequestSyntax) **
A list of objects, each of which specifies how to group the results. You can group by the following criteria:
+ `IntentStageName` – The name of the intent stage.
+ `SwitchedToIntent` – The intent to which the conversation was switched (if any).
Type: Array of [AnalyticsIntentStageGroupBySpecification](API_AnalyticsIntentStageGroupBySpecification.md) objects
Array Members: Minimum number of 1 item. Maximum number of 2 items.
Required: No
** [maxResults](#API_ListIntentStageMetrics_RequestSyntax) **
The maximum number of results to return in each page of results. If there are fewer results than the maximum page size, only the actual number of results are returned.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 1000.
Required: No
** [metrics](#API_ListIntentStageMetrics_RequestSyntax) **
A list of objects, each of which contains a metric you want to list, the statistic for the metric you want to return, and the method by which to organize the results.
Type: Array of [AnalyticsIntentStageMetric](API_AnalyticsIntentStageMetric.md) objects
Array Members: Minimum number of 1 item. Maximum number of 5 items.
Required: Yes
** [nextToken](#API_ListIntentStageMetrics_RequestSyntax) **
If the response from the ListIntentStageMetrics operation contains more results than specified in the maxResults parameter, a token is returned in the response.
Use the returned token in the nextToken parameter of a ListIntentStageMetrics request to return the next page of results. For a complete set of results, call the ListIntentStageMetrics operation until the nextToken returned in the response is null.
Type: String
Required: No
** [startDateTime](#API_ListIntentStageMetrics_RequestSyntax) **
The date and time that marks the beginning of the range of time for which you want to see intent stage metrics.
Type: Timestamp
Required: Yes
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"botId": "string",
"nextToken": "string",
"results": [
{
"binKeys": [
{
"name": "string",
"value": number
}
],
"groupByKeys": [
{
"name": "string",
"value": "string"
}
],
"metricsResults": [
{
"name": "string",
"statistic": "string",
"value": number
}
]
}
]
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [botId](#API_ListIntentStageMetrics_ResponseSyntax) **
The identifier for the bot for which you retrieved intent stage metrics.
Type: String
Length Constraints: Fixed length of 10.
Pattern: `^[0-9a-zA-Z]+$`
** [nextToken](#API_ListIntentStageMetrics_ResponseSyntax) **
If the response from the ListIntentStageMetrics operation contains more results than specified in the maxResults parameter, a token is returned in the response.
Use the returned token in the nextToken parameter of a ListIntentStageMetrics request to return the next page of results. For a complete set of results, call the ListIntentStageMetrics operation until the nextToken returned in the response is null.
Type: String
** [results](#API_ListIntentStageMetrics_ResponseSyntax) **
The results for the intent stage metrics.
Type: Array of [AnalyticsIntentStageResult](API_AnalyticsIntentStageResult.md) objects
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** InternalServerException **
The service encountered an unexpected condition. Try your request again.
HTTP Status Code: 500
** PreconditionFailedException **
Your request couldn't be completed because one or more request fields aren't valid. Check the fields in your request and try again.
HTTP Status Code: 412
** ServiceQuotaExceededException **
You have reached a quota for your bot.
HTTP Status Code: 402
** ThrottlingException **
Your request rate is too high. Reduce the frequency of requests.
** retryAfterSeconds **
The number of seconds after which the user can invoke the API again.
HTTP Status Code: 429
** ValidationException **
One of the input parameters in your request isn't valid. Check the parameters and try your request again.
HTTP Status Code: 400
## See Also
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/models.lex.v2-2020-08-07/ListIntentStageMetrics)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/models.lex.v2-2020-08-07/ListIntentStageMetrics)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/ListIntentStageMetrics)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/models.lex.v2-2020-08-07/ListIntentStageMetrics)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/ListIntentStageMetrics)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/models.lex.v2-2020-08-07/ListIntentStageMetrics)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/models.lex.v2-2020-08-07/ListIntentStageMetrics)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/models.lex.v2-2020-08-07/ListIntentStageMetrics)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/models.lex.v2-2020-08-07/ListIntentStageMetrics)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/ListIntentStageMetrics)
# ListRecommendedIntents
Gets a list of recommended intents provided by the bot recommendation that you can use in your bot. Intents in the response are ordered by relevance.
## Request Syntax
```
POST /bots/botId/botversions/botVersion/botlocales/localeId/botrecommendations/botRecommendationId/intents HTTP/1.1
Content-type: application/json
{
"maxResults": number,
"nextToken": "string"
}
```
## URI Request Parameters
The request uses the following URI parameters.
** [botId](#API_ListRecommendedIntents_RequestSyntax) **
The unique identifier of the bot associated with the recommended intents.
Length Constraints: Fixed length of 10.
Pattern: `^[0-9a-zA-Z]+$`
Required: Yes
** [botRecommendationId](#API_ListRecommendedIntents_RequestSyntax) **
The identifier of the bot recommendation that contains the recommended intents.
Length Constraints: Fixed length of 10.
Pattern: `^[0-9a-zA-Z]+$`
Required: Yes
** [botVersion](#API_ListRecommendedIntents_RequestSyntax) **
The version of the bot that contains the recommended intents.
Length Constraints: Fixed length of 5.
Pattern: `^DRAFT$`
Required: Yes
** [localeId](#API_ListRecommendedIntents_RequestSyntax) **
The identifier of the language and locale of the recommended intents.
Required: Yes
## Request Body
The request accepts the following data in JSON format.
** [maxResults](#API_ListRecommendedIntents_RequestSyntax) **
The maximum number of bot recommendations to return in each page of results. If there are fewer results than the max page size, only the actual number of results are returned.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 1000.
Required: No
** [nextToken](#API_ListRecommendedIntents_RequestSyntax) **
If the response from the ListRecommendedIntents operation contains more results than specified in the maxResults parameter, a token is returned in the response. Use that token in the nextToken parameter to return the next page of results.
Type: String
Required: No
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"botId": "string",
"botRecommendationId": "string",
"botVersion": "string",
"localeId": "string",
"nextToken": "string",
"summaryList": [
{
"intentId": "string",
"intentName": "string",
"sampleUtterancesCount": number
}
]
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [botId](#API_ListRecommendedIntents_ResponseSyntax) **
The unique identifier of the bot associated with the recommended intent.
Type: String
Length Constraints: Fixed length of 10.
Pattern: `^[0-9a-zA-Z]+$`
** [botRecommendationId](#API_ListRecommendedIntents_ResponseSyntax) **
The identifier of the bot recommendation that contains the recommended intent.
Type: String
Length Constraints: Fixed length of 10.
Pattern: `^[0-9a-zA-Z]+$`
** [botVersion](#API_ListRecommendedIntents_ResponseSyntax) **
The version of the bot that contains the intent.
Type: String
Length Constraints: Fixed length of 5.
Pattern: `^DRAFT$`
** [localeId](#API_ListRecommendedIntents_ResponseSyntax) **
The identifier of the language and locale of the intents to list. The string must match one of the supported locales. For more information, see [Supported languages](https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html).
Type: String
** [nextToken](#API_ListRecommendedIntents_ResponseSyntax) **
A token that indicates whether there are more results to return in a response to the ListRecommendedIntents operation. If the nextToken field is present, you send the contents as the nextToken parameter of a ListRecommendedIntents operation request to get the next page of results.
Type: String
** [summaryList](#API_ListRecommendedIntents_ResponseSyntax) **
Summary information for the intents that meet the filter criteria specified in the request. The length of the list is specified in the maxResults parameter of the request. If there are more intents available, the nextToken field contains a token to get the next page of results.
Type: Array of [RecommendedIntentSummary](API_RecommendedIntentSummary.md) objects
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** InternalServerException **
The service encountered an unexpected condition. Try your request again.
HTTP Status Code: 500
** ResourceNotFoundException **
You asked to describe a resource that doesn't exist. Check the resource that you are requesting and try again.
HTTP Status Code: 404
** ServiceQuotaExceededException **
You have reached a quota for your bot.
HTTP Status Code: 402
** ThrottlingException **
Your request rate is too high. Reduce the frequency of requests.
** retryAfterSeconds **
The number of seconds after which the user can invoke the API again.
HTTP Status Code: 429
** ValidationException **
One of the input parameters in your request isn't valid. Check the parameters and try your request again.
HTTP Status Code: 400
## See Also
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/models.lex.v2-2020-08-07/ListRecommendedIntents)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/models.lex.v2-2020-08-07/ListRecommendedIntents)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/ListRecommendedIntents)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/models.lex.v2-2020-08-07/ListRecommendedIntents)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/ListRecommendedIntents)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/models.lex.v2-2020-08-07/ListRecommendedIntents)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/models.lex.v2-2020-08-07/ListRecommendedIntents)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/models.lex.v2-2020-08-07/ListRecommendedIntents)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/models.lex.v2-2020-08-07/ListRecommendedIntents)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/ListRecommendedIntents)
# ListSessionAnalyticsData
Retrieves a list of metadata for individual user sessions with your bot. The `startDateTime` and `endDateTime` fields are required. These fields define a time range for which you want to retrieve results. Of the optional fields, you can organize the results in the following ways:
+ Use the `filters` field to filter the results and the `sortBy` field to specify the values by which to sort the results.
+ Use the `maxResults` field to limit the number of results to return in a single response and the `nextToken` field to return the next batch of results if the response does not return the full set of results.
## Request Syntax
```
POST /bots/botId/analytics/sessions HTTP/1.1
Content-type: application/json
{
"endDateTime": number,
"filters": [
{
"name": "string",
"operator": "string",
"values": [ "string" ]
}
],
"maxResults": number,
"nextToken": "string",
"sortBy": {
"name": "string",
"order": "string"
},
"startDateTime": number
}
```
## URI Request Parameters
The request uses the following URI parameters.
** [botId](#API_ListSessionAnalyticsData_RequestSyntax) **
The identifier for the bot for which you want to retrieve session analytics.
Length Constraints: Fixed length of 10.
Pattern: `^[0-9a-zA-Z]+$`
Required: Yes
## Request Body
The request accepts the following data in JSON format.
** [endDateTime](#API_ListSessionAnalyticsData_RequestSyntax) **
The date and time that marks the end of the range of time for which you want to see session analytics.
Type: Timestamp
Required: Yes
** [filters](#API_ListSessionAnalyticsData_RequestSyntax) **
A list of objects, each of which describes a condition by which you want to filter the results.
Type: Array of [AnalyticsSessionFilter](API_AnalyticsSessionFilter.md) objects
Array Members: Minimum number of 1 item. Maximum number of 10 items.
Required: No
** [maxResults](#API_ListSessionAnalyticsData_RequestSyntax) **
The maximum number of results to return in each page of results. If there are fewer results than the maximum page size, only the actual number of results are returned.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 1000.
Required: No
** [nextToken](#API_ListSessionAnalyticsData_RequestSyntax) **
If the response from the ListSessionAnalyticsData operation contains more results than specified in the maxResults parameter, a token is returned in the response.
Use the returned token in the nextToken parameter of a ListSessionAnalyticsData request to return the next page of results. For a complete set of results, call the ListSessionAnalyticsData operation until the nextToken returned in the response is null.
Type: String
Required: No
** [sortBy](#API_ListSessionAnalyticsData_RequestSyntax) **
An object specifying the measure and method by which to sort the session analytics data.
Type: [SessionDataSortBy](API_SessionDataSortBy.md) object
Required: No
** [startDateTime](#API_ListSessionAnalyticsData_RequestSyntax) **
The date and time that marks the beginning of the range of time for which you want to see session analytics.
Type: Timestamp
Required: Yes
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"botId": "string",
"nextToken": "string",
"sessions": [
{
"botAliasId": "string",
"botVersion": "string",
"channel": "string",
"conversationDurationSeconds": number,
"conversationEndState": "string",
"conversationEndTime": number,
"conversationStartTime": number,
"invokedIntentSamples": [
{
"intentName": "string"
}
],
"localeId": "string",
"mode": "string",
"numberOfTurns": number,
"originatingRequestId": "string",
"sessionId": "string"
}
]
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [botId](#API_ListSessionAnalyticsData_ResponseSyntax) **
The unique identifier of the bot that the sessions belong to.
Type: String
Length Constraints: Fixed length of 10.
Pattern: `^[0-9a-zA-Z]+$`
** [nextToken](#API_ListSessionAnalyticsData_ResponseSyntax) **
If the response from the ListSessionAnalyticsData operation contains more results than specified in the maxResults parameter, a token is returned in the response.
Use the returned token in the nextToken parameter of a ListSessionAnalyticsData request to return the next page of results. For a complete set of results, call the ListSessionAnalyticsData operation until the nextToken returned in the response is null.
Type: String
** [sessions](#API_ListSessionAnalyticsData_ResponseSyntax) **
A list of objects, each of which contains information about a session with the bot.
Type: Array of [SessionSpecification](API_SessionSpecification.md) objects
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** InternalServerException **
The service encountered an unexpected condition. Try your request again.
HTTP Status Code: 500
** PreconditionFailedException **
Your request couldn't be completed because one or more request fields aren't valid. Check the fields in your request and try again.
HTTP Status Code: 412
** ServiceQuotaExceededException **
You have reached a quota for your bot.
HTTP Status Code: 402
** ThrottlingException **
Your request rate is too high. Reduce the frequency of requests.
** retryAfterSeconds **
The number of seconds after which the user can invoke the API again.
HTTP Status Code: 429
** ValidationException **
One of the input parameters in your request isn't valid. Check the parameters and try your request again.
HTTP Status Code: 400
## See Also
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/models.lex.v2-2020-08-07/ListSessionAnalyticsData)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/models.lex.v2-2020-08-07/ListSessionAnalyticsData)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/ListSessionAnalyticsData)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/models.lex.v2-2020-08-07/ListSessionAnalyticsData)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/ListSessionAnalyticsData)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/models.lex.v2-2020-08-07/ListSessionAnalyticsData)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/models.lex.v2-2020-08-07/ListSessionAnalyticsData)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/models.lex.v2-2020-08-07/ListSessionAnalyticsData)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/models.lex.v2-2020-08-07/ListSessionAnalyticsData)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/ListSessionAnalyticsData)
# ListSessionMetrics
Retrieves summary metrics for the user sessions with your bot. The following fields are required:
+ `metrics` – A list of [AnalyticsSessionMetric](https://docs.aws.amazon.com/lexv2/latest/APIReference/API_AnalyticsSessionMetric.html) objects. In each object, use the `name` field to specify the metric to calculate, the `statistic` field to specify whether to calculate the `Sum`, `Average`, or `Max` number, and the `order` field to specify whether to sort the results in `Ascending` or `Descending` order.
+ `startDateTime` and `endDateTime` – Define a time range for which you want to retrieve results.
Of the optional fields, you can organize the results in the following ways:
+ Use the `filters` field to filter the results, the `groupBy` field to specify categories by which to group the results, and the `binBy` field to specify time intervals by which to group the results.
+ Use the `maxResults` field to limit the number of results to return in a single response and the `nextToken` field to return the next batch of results if the response does not return the full set of results.
Note that an `order` field exists in both `binBy` and `metrics`. Currently, you can specify it in either field, but not in both.
## Request Syntax
```
POST /bots/botId/analytics/sessionmetrics HTTP/1.1
Content-type: application/json
{
"binBy": [
{
"interval": "string",
"name": "string",
"order": "string"
}
],
"endDateTime": number,
"filters": [
{
"name": "string",
"operator": "string",
"values": [ "string" ]
}
],
"groupBy": [
{
"name": "string"
}
],
"maxResults": number,
"metrics": [
{
"name": "string",
"order": "string",
"statistic": "string"
}
],
"nextToken": "string",
"startDateTime": number
}
```
## URI Request Parameters
The request uses the following URI parameters.
** [botId](#API_ListSessionMetrics_RequestSyntax) **
The identifier for the bot for which you want to retrieve session metrics.
Length Constraints: Fixed length of 10.
Pattern: `^[0-9a-zA-Z]+$`
Required: Yes
## Request Body
The request accepts the following data in JSON format.
** [binBy](#API_ListSessionMetrics_RequestSyntax) **
A list of objects, each of which contains specifications for organizing the results by time.
Type: Array of [AnalyticsBinBySpecification](API_AnalyticsBinBySpecification.md) objects
Array Members: Fixed number of 1 item.
Required: No
** [endDateTime](#API_ListSessionMetrics_RequestSyntax) **
The date and time that marks the end of the range of time for which you want to see session metrics.
Type: Timestamp
Required: Yes
** [filters](#API_ListSessionMetrics_RequestSyntax) **
A list of objects, each of which describes a condition by which you want to filter the results.
Type: Array of [AnalyticsSessionFilter](API_AnalyticsSessionFilter.md) objects
Array Members: Minimum number of 1 item. Maximum number of 10 items.
Required: No
** [groupBy](#API_ListSessionMetrics_RequestSyntax) **
A list of objects, each of which specifies how to group the results. You can group by the following criteria:
+ `ConversationEndState` – The final state of the conversation. The possible end states are detailed in [Key definitions](https://docs.aws.amazon.com/analytics-key-definitions-conversations) in the user guide.
+ `LocaleId` – The unique identifier of the bot locale.
Type: Array of [AnalyticsSessionGroupBySpecification](API_AnalyticsSessionGroupBySpecification.md) objects
Array Members: Minimum number of 1 item. Maximum number of 2 items.
Required: No
** [maxResults](#API_ListSessionMetrics_RequestSyntax) **
The maximum number of results to return in each page of results. If there are fewer results than the maximum page size, only the actual number of results are returned.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 1000.
Required: No
** [metrics](#API_ListSessionMetrics_RequestSyntax) **
A list of objects, each of which contains a metric you want to list, the statistic for the metric you want to return, and the method by which to organize the results.
Type: Array of [AnalyticsSessionMetric](API_AnalyticsSessionMetric.md) objects
Array Members: Minimum number of 1 item. Maximum number of 7 items.
Required: Yes
** [nextToken](#API_ListSessionMetrics_RequestSyntax) **
If the response from the ListSessionMetrics operation contains more results than specified in the maxResults parameter, a token is returned in the response.
Use the returned token in the nextToken parameter of a ListSessionMetrics request to return the next page of results. For a complete set of results, call the ListSessionMetrics operation until the nextToken returned in the response is null.
Type: String
Required: No
** [startDateTime](#API_ListSessionMetrics_RequestSyntax) **
The date and time that marks the beginning of the range of time for which you want to see session metrics.
Type: Timestamp
Required: Yes
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"botId": "string",
"nextToken": "string",
"results": [
{
"binKeys": [
{
"name": "string",
"value": number
}
],
"groupByKeys": [
{
"name": "string",
"value": "string"
}
],
"metricsResults": [
{
"name": "string",
"statistic": "string",
"value": number
}
]
}
]
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [botId](#API_ListSessionMetrics_ResponseSyntax) **
The identifier for the bot for which you retrieved session metrics.
Type: String
Length Constraints: Fixed length of 10.
Pattern: `^[0-9a-zA-Z]+$`
** [nextToken](#API_ListSessionMetrics_ResponseSyntax) **
If the response from the ListSessionMetrics operation contains more results than specified in the maxResults parameter, a token is returned in the response.
Use the returned token in the nextToken parameter of a ListSessionMetrics request to return the next page of results. For a complete set of results, call the ListSessionMetrics operation until the nextToken returned in the response is null.
Type: String
** [results](#API_ListSessionMetrics_ResponseSyntax) **
The results for the session metrics.
Type: Array of [AnalyticsSessionResult](API_AnalyticsSessionResult.md) objects
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** InternalServerException **
The service encountered an unexpected condition. Try your request again.
HTTP Status Code: 500
** PreconditionFailedException **
Your request couldn't be completed because one or more request fields aren't valid. Check the fields in your request and try again.
HTTP Status Code: 412
** ServiceQuotaExceededException **
You have reached a quota for your bot.
HTTP Status Code: 402
** ThrottlingException **
Your request rate is too high. Reduce the frequency of requests.
** retryAfterSeconds **
The number of seconds after which the user can invoke the API again.
HTTP Status Code: 429
** ValidationException **
One of the input parameters in your request isn't valid. Check the parameters and try your request again.
HTTP Status Code: 400
## See Also
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/models.lex.v2-2020-08-07/ListSessionMetrics)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/models.lex.v2-2020-08-07/ListSessionMetrics)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/ListSessionMetrics)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/models.lex.v2-2020-08-07/ListSessionMetrics)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/ListSessionMetrics)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/models.lex.v2-2020-08-07/ListSessionMetrics)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/models.lex.v2-2020-08-07/ListSessionMetrics)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/models.lex.v2-2020-08-07/ListSessionMetrics)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/models.lex.v2-2020-08-07/ListSessionMetrics)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/ListSessionMetrics)
# ListSlots
Gets a list of slots that match the specified criteria.
## Request Syntax
```
POST /bots/botId/botversions/botVersion/botlocales/localeId/intents/intentId/slots/ HTTP/1.1
Content-type: application/json
{
"filters": [
{
"name": "string",
"operator": "string",
"values": [ "string" ]
}
],
"maxResults": number,
"nextToken": "string",
"sortBy": {
"attribute": "string",
"order": "string"
}
}
```
## URI Request Parameters
The request uses the following URI parameters.
** [botId](#API_ListSlots_RequestSyntax) **
The identifier of the bot that contains the slot.
Length Constraints: Fixed length of 10.
Pattern: `^[0-9a-zA-Z]+$`
Required: Yes
** [botVersion](#API_ListSlots_RequestSyntax) **
The version of the bot that contains the slot.
Length Constraints: Minimum length of 1. Maximum length of 5.
Pattern: `^(DRAFT|[0-9]+)$`
Required: Yes
** [intentId](#API_ListSlots_RequestSyntax) **
The unique identifier of the intent that contains the slot.
Length Constraints: Fixed length of 10.
Pattern: `^[0-9a-zA-Z]+$`
Required: Yes
** [localeId](#API_ListSlots_RequestSyntax) **
The identifier of the language and locale of the slots to list. The string must match one of the supported locales. For more information, see [Supported languages](https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html).
Required: Yes
## Request Body
The request accepts the following data in JSON format.
** [filters](#API_ListSlots_RequestSyntax) **
Provides the specification of a filter used to limit the slots in the response to only those that match the filter specification. You can only specify one filter and only one string to filter on.
Type: Array of [SlotFilter](API_SlotFilter.md) objects
Array Members: Fixed number of 1 item.
Required: No
** [maxResults](#API_ListSlots_RequestSyntax) **
The maximum number of slots to return in each page of results. If there are fewer results than the max page size, only the actual number of results are returned.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 1000.
Required: No
** [nextToken](#API_ListSlots_RequestSyntax) **
If the response from the `ListSlots` operation contains more results than specified in the `maxResults` parameter, a token is returned in the response. Use that token in the `nextToken` parameter to return the next page of results.
Type: String
Required: No
** [sortBy](#API_ListSlots_RequestSyntax) **
Determines the sort order for the response from the `ListSlots` operation. You can choose to sort by the slot name or last updated date in either ascending or descending order.
Type: [SlotSortBy](API_SlotSortBy.md) object
Required: No
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"botId": "string",
"botVersion": "string",
"intentId": "string",
"localeId": "string",
"nextToken": "string",
"slotSummaries": [
{
"description": "string",
"lastUpdatedDateTime": number,
"slotConstraint": "string",
"slotId": "string",
"slotName": "string",
"slotTypeId": "string",
"valueElicitationPromptSpecification": {
"allowInterrupt": boolean,
"maxRetries": number,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
],
"messageSelectionStrategy": "string",
"promptAttemptsSpecification": {
"string" : {
"allowedInputTypes": {
"allowAudioInput": boolean,
"allowDTMFInput": boolean
},
"allowInterrupt": boolean,
"audioAndDTMFInputSpecification": {
"audioSpecification": {
"endTimeoutMs": number,
"maxLengthMs": number
},
"dtmfSpecification": {
"deletionCharacter": "string",
"endCharacter": "string",
"endTimeoutMs": number,
"maxLength": number
},
"startTimeoutMs": number
},
"textInputSpecification": {
"startTimeoutMs": number
}
}
}
}
}
]
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [botId](#API_ListSlots_ResponseSyntax) **
The identifier of the bot that contains the slots.
Type: String
Length Constraints: Fixed length of 10.
Pattern: `^[0-9a-zA-Z]+$`
** [botVersion](#API_ListSlots_ResponseSyntax) **
The version of the bot that contains the slots.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 5.
Pattern: `^(DRAFT|[0-9]+)$`
** [intentId](#API_ListSlots_ResponseSyntax) **
The identifier of the intent that contains the slots.
Type: String
Length Constraints: Fixed length of 10.
Pattern: `^[0-9a-zA-Z]+$`
** [localeId](#API_ListSlots_ResponseSyntax) **
The language and locale of the slots in the list.
Type: String
** [nextToken](#API_ListSlots_ResponseSyntax) **
A token that indicates whether there are more results to return in a response to the `ListSlots` operation. If the `nextToken` field is present, you send the contents as the `nextToken` parameter of a `ListSlots` operation request to get the next page of results.
Type: String
** [slotSummaries](#API_ListSlots_ResponseSyntax) **
Summary information for the slots that meet the filter criteria specified in the request. The length of the list is specified in the `maxResults` parameter of the request. If there are more slots available, the `nextToken` field contains a token to get the next page of results.
Type: Array of [SlotSummary](API_SlotSummary.md) objects
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** InternalServerException **
The service encountered an unexpected condition. Try your request again.
HTTP Status Code: 500
** ServiceQuotaExceededException **
You have reached a quota for your bot.
HTTP Status Code: 402
** ThrottlingException **
Your request rate is too high. Reduce the frequency of requests.
** retryAfterSeconds **
The number of seconds after which the user can invoke the API again.
HTTP Status Code: 429
** ValidationException **
One of the input parameters in your request isn't valid. Check the parameters and try your request again.
HTTP Status Code: 400
## See Also
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/models.lex.v2-2020-08-07/ListSlots)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/models.lex.v2-2020-08-07/ListSlots)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/ListSlots)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/models.lex.v2-2020-08-07/ListSlots)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/ListSlots)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/models.lex.v2-2020-08-07/ListSlots)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/models.lex.v2-2020-08-07/ListSlots)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/models.lex.v2-2020-08-07/ListSlots)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/models.lex.v2-2020-08-07/ListSlots)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/ListSlots)
# ListSlotTypes
Gets a list of slot types that match the specified criteria.
## Request Syntax
```
POST /bots/botId/botversions/botVersion/botlocales/localeId/slottypes/ HTTP/1.1
Content-type: application/json
{
"filters": [
{
"name": "string",
"operator": "string",
"values": [ "string" ]
}
],
"maxResults": number,
"nextToken": "string",
"sortBy": {
"attribute": "string",
"order": "string"
}
}
```
## URI Request Parameters
The request uses the following URI parameters.
** [botId](#API_ListSlotTypes_RequestSyntax) **
The unique identifier of the bot that contains the slot types.
Length Constraints: Fixed length of 10.
Pattern: `^[0-9a-zA-Z]+$`
Required: Yes
** [botVersion](#API_ListSlotTypes_RequestSyntax) **
The version of the bot that contains the slot type.
Length Constraints: Minimum length of 1. Maximum length of 5.
Pattern: `^(DRAFT|[0-9]+)$`
Required: Yes
** [localeId](#API_ListSlotTypes_RequestSyntax) **
The identifier of the language and locale of the slot types to list. The string must match one of the supported locales. For more information, see [Supported languages](https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html).
Required: Yes
## Request Body
The request accepts the following data in JSON format.
** [filters](#API_ListSlotTypes_RequestSyntax) **
Provides the specification of a filter used to limit the slot types in the response to only those that match the filter specification. You can only specify one filter and only one string to filter on.
Type: Array of [SlotTypeFilter](API_SlotTypeFilter.md) objects
Array Members: Fixed number of 1 item.
Required: No
** [maxResults](#API_ListSlotTypes_RequestSyntax) **
The maximum number of slot types to return in each page of results. If there are fewer results than the max page size, only the actual number of results are returned.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 1000.
Required: No
** [nextToken](#API_ListSlotTypes_RequestSyntax) **
If the response from the `ListSlotTypes` operation contains more results than specified in the `maxResults` parameter, a token is returned in the response. Use that token in the `nextToken` parameter to return the next page of results.
Type: String
Required: No
** [sortBy](#API_ListSlotTypes_RequestSyntax) **
Determines the sort order for the response from the `ListSlotTypes` operation. You can choose to sort by the slot type name or last updated date in either ascending or descending order.
Type: [SlotTypeSortBy](API_SlotTypeSortBy.md) object
Required: No
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"botId": "string",
"botVersion": "string",
"localeId": "string",
"nextToken": "string",
"slotTypeSummaries": [
{
"description": "string",
"lastUpdatedDateTime": number,
"parentSlotTypeSignature": "string",
"slotTypeCategory": "string",
"slotTypeId": "string",
"slotTypeName": "string"
}
]
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [botId](#API_ListSlotTypes_ResponseSyntax) **
The identifier of the bot that contains the slot types.
Type: String
Length Constraints: Fixed length of 10.
Pattern: `^[0-9a-zA-Z]+$`
** [botVersion](#API_ListSlotTypes_ResponseSyntax) **
The version of the bot that contains the slot types.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 5.
Pattern: `^(DRAFT|[0-9]+)$`
** [localeId](#API_ListSlotTypes_ResponseSyntax) **
The language and local of the slot types in the list.
Type: String
** [nextToken](#API_ListSlotTypes_ResponseSyntax) **
A token that indicates whether there are more results to return in a response to the `ListSlotTypes` operation. If the `nextToken` field is present, you send the contents as the `nextToken` parameter of a `ListSlotTypes` operation request to get the next page of results.
Type: String
** [slotTypeSummaries](#API_ListSlotTypes_ResponseSyntax) **
Summary information for the slot types that meet the filter criteria specified in the request. The length of the list is specified in the `maxResults` parameter of the request. If there are more slot types available, the `nextToken` field contains a token to get the next page of results.
Type: Array of [SlotTypeSummary](API_SlotTypeSummary.md) objects
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** InternalServerException **
The service encountered an unexpected condition. Try your request again.
HTTP Status Code: 500
** ServiceQuotaExceededException **
You have reached a quota for your bot.
HTTP Status Code: 402
** ThrottlingException **
Your request rate is too high. Reduce the frequency of requests.
** retryAfterSeconds **
The number of seconds after which the user can invoke the API again.
HTTP Status Code: 429
** ValidationException **
One of the input parameters in your request isn't valid. Check the parameters and try your request again.
HTTP Status Code: 400
## See Also
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/models.lex.v2-2020-08-07/ListSlotTypes)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/models.lex.v2-2020-08-07/ListSlotTypes)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/ListSlotTypes)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/models.lex.v2-2020-08-07/ListSlotTypes)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/ListSlotTypes)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/models.lex.v2-2020-08-07/ListSlotTypes)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/models.lex.v2-2020-08-07/ListSlotTypes)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/models.lex.v2-2020-08-07/ListSlotTypes)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/models.lex.v2-2020-08-07/ListSlotTypes)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/ListSlotTypes)
# ListTagsForResource
Gets a list of tags associated with a resource. Only bots, bot aliases, and bot channels can have tags associated with them.
## Request Syntax
```
GET /tags/resourceARN HTTP/1.1
```
## URI Request Parameters
The request uses the following URI parameters.
** [resourceARN](#API_ListTagsForResource_RequestSyntax) **
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
The request does not have a request body.
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"tags": {
"string" : "string"
}
}
```
## Response Elements
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) **
The tags associated with a resource.
Type: String to string map
Map Entries: Minimum number of 0 items. Maximum number of 200 items.
Key Length Constraints: Minimum length of 1. Maximum length of 128.
Value Length Constraints: Minimum length of 0. Maximum length of 256.
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** InternalServerException **
The service encountered an unexpected condition. Try your request again.
HTTP Status Code: 500
** ResourceNotFoundException **
You asked to describe a resource that doesn't exist. Check the resource that you are requesting and try again.
HTTP Status Code: 404
** ThrottlingException **
Your request rate is too high. Reduce the frequency of requests.
** retryAfterSeconds **
The number of seconds after which the user can invoke the API again.
HTTP Status Code: 429
** ValidationException **
One of the input parameters in your request isn't valid. Check the parameters and try your request again.
HTTP Status Code: 400
## See Also
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/models.lex.v2-2020-08-07/ListTagsForResource)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/models.lex.v2-2020-08-07/ListTagsForResource)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/ListTagsForResource)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/models.lex.v2-2020-08-07/ListTagsForResource)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/ListTagsForResource)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/models.lex.v2-2020-08-07/ListTagsForResource)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/models.lex.v2-2020-08-07/ListTagsForResource)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/models.lex.v2-2020-08-07/ListTagsForResource)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/models.lex.v2-2020-08-07/ListTagsForResource)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/ListTagsForResource)
# ListTestExecutionResultItems
Gets a list of test execution result items.
## Request Syntax
```
POST /testexecutions/testExecutionId/results HTTP/1.1
Content-type: application/json
{
"maxResults": number,
"nextToken": "string",
"resultFilterBy": {
"conversationLevelTestResultsFilterBy": {
"endToEndResult": "string"
},
"resultTypeFilter": "string"
}
}
```
## URI Request Parameters
The request uses the following URI parameters.
** [testExecutionId](#API_ListTestExecutionResultItems_RequestSyntax) **
The unique identifier of the test execution to list the result items.
Length Constraints: Fixed length of 10.
Pattern: `^[0-9a-zA-Z]+$`
Required: Yes
## Request Body
The request accepts the following data in JSON format.
** [maxResults](#API_ListTestExecutionResultItems_RequestSyntax) **
The maximum number of test execution result items to return in each page. If there are fewer results than the max page size, only the actual number of results are returned.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 1000.
Required: No
** [nextToken](#API_ListTestExecutionResultItems_RequestSyntax) **
If the response from the `ListTestExecutionResultItems` operation contains more results than specified in the `maxResults` parameter, a token is returned in the response. Use that token in the `nextToken` parameter to return the next page of results.
Type: String
Required: No
** [resultFilterBy](#API_ListTestExecutionResultItems_RequestSyntax) **
The filter for the list of results from the test set execution.
Type: [TestExecutionResultFilterBy](API_TestExecutionResultFilterBy.md) object
Required: Yes
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"nextToken": "string",
"testExecutionResults": {
"conversationLevelTestResults": {
"items": [
{
"conversationId": "string",
"endToEndResult": "string",
"intentClassificationResults": [
{
"intentName": "string",
"matchResult": "string"
}
],
"slotResolutionResults": [
{
"intentName": "string",
"matchResult": "string",
"slotName": "string"
}
],
"speechTranscriptionResult": "string"
}
]
},
"intentClassificationTestResults": {
"items": [
{
"intentName": "string",
"multiTurnConversation": boolean,
"resultCounts": {
"intentMatchResultCounts": {
"string" : number
},
"speechTranscriptionResultCounts": {
"string" : number
},
"totalResultCount": number
}
}
]
},
"intentLevelSlotResolutionTestResults": {
"items": [
{
"intentName": "string",
"multiTurnConversation": boolean,
"slotResolutionResults": [
{
"resultCounts": {
"slotMatchResultCounts": {
"string" : number
},
"speechTranscriptionResultCounts": {
"string" : number
},
"totalResultCount": number
},
"slotName": "string"
}
]
}
]
},
"overallTestResults": {
"items": [
{
"endToEndResultCounts": {
"string" : number
},
"multiTurnConversation": boolean,
"speechTranscriptionResultCounts": {
"string" : number
},
"totalResultCount": number
}
]
},
"utteranceLevelTestResults": {
"items": [
{
"conversationId": "string",
"recordNumber": number,
"turnResult": {
"agent": {
"actualAgentPrompt": "string",
"actualElicitedSlot": "string",
"actualIntent": "string",
"errorDetails": {
"errorCode": "string",
"errorMessage": "string"
},
"expectedAgentPrompt": "string"
},
"user": {
"actualOutput": {
"activeContexts": [
{
"name": "string"
}
],
"intent": {
"name": "string",
"slots": {
"string" : {
"subSlots": {
"string" : "UserTurnSlotOutput"
},
"value": "string",
"values": [
"UserTurnSlotOutput"
]
}
}
},
"transcript": "string"
},
"conversationLevelResult": {
"endToEndResult": "string",
"speechTranscriptionResult": "string"
},
"endToEndResult": "string",
"errorDetails": {
"errorCode": "string",
"errorMessage": "string"
},
"expectedOutput": {
"activeContexts": [
{
"name": "string"
}
],
"intent": {
"name": "string",
"slots": {
"string" : {
"subSlots": {
"string" : "UserTurnSlotOutput"
},
"value": "string",
"values": [
"UserTurnSlotOutput"
]
}
}
},
"transcript": "string"
},
"input": {
"requestAttributes": {
"string" : "string"
},
"sessionState": {
"activeContexts": [
{
"name": "string"
}
],
"runtimeHints": {
"slotHints": {
"string" : {
"string" : {
"runtimeHintValues": [
{
"phrase": "string"
}
],
"subSlotHints": {
"string" : "RuntimeHintDetails"
}
}
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"utteranceInput": {
"audioInput": {
"audioFileS3Location": "string"
},
"textInput": "string"
}
},
"intentMatchResult": "string",
"slotMatchResult": "string",
"speechTranscriptionResult": "string"
}
}
}
]
}
}
}
```
## Response Elements
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_ListTestExecutionResultItems_ResponseSyntax) **
A token that indicates whether there are more results to return in a response to the `ListTestExecutionResultItems` operation. If the `nextToken` field is present, you send the contents as the `nextToken` parameter of a `ListTestExecutionResultItems` operation request to get the next page of results.
Type: String
** [testExecutionResults](#API_ListTestExecutionResultItems_ResponseSyntax) **
The list of results from the test execution.
Type: [TestExecutionResultItems](API_TestExecutionResultItems.md) object
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** InternalServerException **
The service encountered an unexpected condition. Try your request again.
HTTP Status Code: 500
** ResourceNotFoundException **
You asked to describe a resource that doesn't exist. Check the resource that you are requesting and try again.
HTTP Status Code: 404
** ServiceQuotaExceededException **
You have reached a quota for your bot.
HTTP Status Code: 402
** ThrottlingException **
Your request rate is too high. Reduce the frequency of requests.
** retryAfterSeconds **
The number of seconds after which the user can invoke the API again.
HTTP Status Code: 429
** ValidationException **
One of the input parameters in your request isn't valid. Check the parameters and try your request again.
HTTP Status Code: 400
## See Also
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/models.lex.v2-2020-08-07/ListTestExecutionResultItems)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/models.lex.v2-2020-08-07/ListTestExecutionResultItems)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/ListTestExecutionResultItems)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/models.lex.v2-2020-08-07/ListTestExecutionResultItems)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/ListTestExecutionResultItems)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/models.lex.v2-2020-08-07/ListTestExecutionResultItems)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/models.lex.v2-2020-08-07/ListTestExecutionResultItems)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/models.lex.v2-2020-08-07/ListTestExecutionResultItems)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/models.lex.v2-2020-08-07/ListTestExecutionResultItems)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/ListTestExecutionResultItems)
# ListTestExecutions
The list of test set executions.
## Request Syntax
```
POST /testexecutions HTTP/1.1
Content-type: application/json
{
"maxResults": number,
"nextToken": "string",
"sortBy": {
"attribute": "string",
"order": "string"
}
}
```
## URI Request Parameters
The request does not use any URI parameters.
## Request Body
The request accepts the following data in JSON format.
** [maxResults](#API_ListTestExecutions_RequestSyntax) **
The maximum number of test executions to return in each page. If there are fewer results than the max page size, only the actual number of results are returned.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 1000.
Required: No
** [nextToken](#API_ListTestExecutions_RequestSyntax) **
If the response from the ListTestExecutions operation contains more results than specified in the maxResults parameter, a token is returned in the response. Use that token in the nextToken parameter to return the next page of results.
Type: String
Required: No
** [sortBy](#API_ListTestExecutions_RequestSyntax) **
The sort order of the test set executions.
Type: [TestExecutionSortBy](API_TestExecutionSortBy.md) object
Required: No
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"nextToken": "string",
"testExecutions": [
{
"apiMode": "string",
"creationDateTime": number,
"lastUpdatedDateTime": number,
"target": {
"botAliasTarget": {
"botAliasId": "string",
"botId": "string",
"localeId": "string"
}
},
"testExecutionId": "string",
"testExecutionModality": "string",
"testExecutionStatus": "string",
"testSetId": "string",
"testSetName": "string"
}
]
}
```
## Response Elements
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_ListTestExecutions_ResponseSyntax) **
A token that indicates whether there are more results to return in a response to the ListTestExecutions operation. If the nextToken field is present, you send the contents as the nextToken parameter of a ListTestExecutions operation request to get the next page of results.
Type: String
** [testExecutions](#API_ListTestExecutions_ResponseSyntax) **
The list of test executions.
Type: Array of [TestExecutionSummary](API_TestExecutionSummary.md) objects
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** InternalServerException **
The service encountered an unexpected condition. Try your request again.
HTTP Status Code: 500
** ServiceQuotaExceededException **
You have reached a quota for your bot.
HTTP Status Code: 402
** ThrottlingException **
Your request rate is too high. Reduce the frequency of requests.
** retryAfterSeconds **
The number of seconds after which the user can invoke the API again.
HTTP Status Code: 429
** ValidationException **
One of the input parameters in your request isn't valid. Check the parameters and try your request again.
HTTP Status Code: 400
## See Also
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/models.lex.v2-2020-08-07/ListTestExecutions)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/models.lex.v2-2020-08-07/ListTestExecutions)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/ListTestExecutions)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/models.lex.v2-2020-08-07/ListTestExecutions)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/ListTestExecutions)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/models.lex.v2-2020-08-07/ListTestExecutions)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/models.lex.v2-2020-08-07/ListTestExecutions)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/models.lex.v2-2020-08-07/ListTestExecutions)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/models.lex.v2-2020-08-07/ListTestExecutions)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/ListTestExecutions)
# ListTestSetRecords
The list of test set records.
## Request Syntax
```
POST /testsets/testSetId/records HTTP/1.1
Content-type: application/json
{
"maxResults": number,
"nextToken": "string"
}
```
## URI Request Parameters
The request uses the following URI parameters.
** [testSetId](#API_ListTestSetRecords_RequestSyntax) **
The identifier of the test set to list its test set records.
Length Constraints: Fixed length of 10.
Pattern: `^[0-9a-zA-Z]+$`
Required: Yes
## Request Body
The request accepts the following data in JSON format.
** [maxResults](#API_ListTestSetRecords_RequestSyntax) **
The maximum number of test set records to return in each page. If there are fewer records than the max page size, only the actual number of records are returned.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 1000.
Required: No
** [nextToken](#API_ListTestSetRecords_RequestSyntax) **
If the response from the ListTestSetRecords operation contains more results than specified in the maxResults parameter, a token is returned in the response. Use that token in the nextToken parameter to return the next page of results.
Type: String
Required: No
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"nextToken": "string",
"testSetRecords": [
{
"conversationId": "string",
"recordNumber": number,
"turnNumber": number,
"turnSpecification": {
"agentTurn": {
"agentPrompt": "string"
},
"userTurn": {
"expected": {
"activeContexts": [
{
"name": "string"
}
],
"intent": {
"name": "string",
"slots": {
"string" : {
"subSlots": {
"string" : "UserTurnSlotOutput"
},
"value": "string",
"values": [
"UserTurnSlotOutput"
]
}
}
},
"transcript": "string"
},
"input": {
"requestAttributes": {
"string" : "string"
},
"sessionState": {
"activeContexts": [
{
"name": "string"
}
],
"runtimeHints": {
"slotHints": {
"string" : {
"string" : {
"runtimeHintValues": [
{
"phrase": "string"
}
],
"subSlotHints": {
"string" : "RuntimeHintDetails"
}
}
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"utteranceInput": {
"audioInput": {
"audioFileS3Location": "string"
},
"textInput": "string"
}
}
}
}
}
]
}
```
## Response Elements
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_ListTestSetRecords_ResponseSyntax) **
A token that indicates whether there are more records to return in a response to the ListTestSetRecords operation. If the nextToken field is present, you send the contents as the nextToken parameter of a ListTestSetRecords operation request to get the next page of records.
Type: String
** [testSetRecords](#API_ListTestSetRecords_ResponseSyntax) **
The list of records from the test set.
Type: Array of [TestSetTurnRecord](API_TestSetTurnRecord.md) objects
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** InternalServerException **
The service encountered an unexpected condition. Try your request again.
HTTP Status Code: 500
** ResourceNotFoundException **
You asked to describe a resource that doesn't exist. Check the resource that you are requesting and try again.
HTTP Status Code: 404
** ServiceQuotaExceededException **
You have reached a quota for your bot.
HTTP Status Code: 402
** ThrottlingException **
Your request rate is too high. Reduce the frequency of requests.
** retryAfterSeconds **
The number of seconds after which the user can invoke the API again.
HTTP Status Code: 429
** ValidationException **
One of the input parameters in your request isn't valid. Check the parameters and try your request again.
HTTP Status Code: 400
## See Also
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/models.lex.v2-2020-08-07/ListTestSetRecords)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/models.lex.v2-2020-08-07/ListTestSetRecords)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/ListTestSetRecords)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/models.lex.v2-2020-08-07/ListTestSetRecords)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/ListTestSetRecords)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/models.lex.v2-2020-08-07/ListTestSetRecords)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/models.lex.v2-2020-08-07/ListTestSetRecords)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/models.lex.v2-2020-08-07/ListTestSetRecords)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/models.lex.v2-2020-08-07/ListTestSetRecords)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/ListTestSetRecords)
# ListTestSets
The list of the test sets
## Request Syntax
```
POST /testsets HTTP/1.1
Content-type: application/json
{
"maxResults": number,
"nextToken": "string",
"sortBy": {
"attribute": "string",
"order": "string"
}
}
```
## URI Request Parameters
The request does not use any URI parameters.
## Request Body
The request accepts the following data in JSON format.
** [maxResults](#API_ListTestSets_RequestSyntax) **
The maximum number of test sets to return in each page. If there are fewer results than the max page size, only the actual number of results are returned.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 1000.
Required: No
** [nextToken](#API_ListTestSets_RequestSyntax) **
If the response from the ListTestSets operation contains more results than specified in the maxResults parameter, a token is returned in the response. Use that token in the nextToken parameter to return the next page of results.
Type: String
Required: No
** [sortBy](#API_ListTestSets_RequestSyntax) **
The sort order for the list of test sets.
Type: [TestSetSortBy](API_TestSetSortBy.md) object
Required: No
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"nextToken": "string",
"testSets": [
{
"creationDateTime": number,
"description": "string",
"lastUpdatedDateTime": number,
"modality": "string",
"numTurns": number,
"roleArn": "string",
"status": "string",
"storageLocation": {
"kmsKeyArn": "string",
"s3BucketName": "string",
"s3Path": "string"
},
"testSetId": "string",
"testSetName": "string"
}
]
}
```
## Response Elements
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_ListTestSets_ResponseSyntax) **
A token that indicates whether there are more results to return in a response to the ListTestSets operation. If the nextToken field is present, you send the contents as the nextToken parameter of a ListTestSets operation request to get the next page of results.
Type: String
** [testSets](#API_ListTestSets_ResponseSyntax) **
The selected test sets in a list of test sets.
Type: Array of [TestSetSummary](API_TestSetSummary.md) objects
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** InternalServerException **
The service encountered an unexpected condition. Try your request again.
HTTP Status Code: 500
** ServiceQuotaExceededException **
You have reached a quota for your bot.
HTTP Status Code: 402
** ThrottlingException **
Your request rate is too high. Reduce the frequency of requests.
** retryAfterSeconds **
The number of seconds after which the user can invoke the API again.
HTTP Status Code: 429
** ValidationException **
One of the input parameters in your request isn't valid. Check the parameters and try your request again.
HTTP Status Code: 400
## See Also
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/models.lex.v2-2020-08-07/ListTestSets)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/models.lex.v2-2020-08-07/ListTestSets)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/ListTestSets)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/models.lex.v2-2020-08-07/ListTestSets)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/ListTestSets)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/models.lex.v2-2020-08-07/ListTestSets)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/models.lex.v2-2020-08-07/ListTestSets)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/models.lex.v2-2020-08-07/ListTestSets)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/models.lex.v2-2020-08-07/ListTestSets)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/ListTestSets)
# ListUtteranceAnalyticsData
**Note**
To use this API operation, your IAM role must have permissions to perform the [ListAggregatedUtterances](https://docs.aws.amazon.com/lexv2/latest/APIReference/API_ListAggregatedUtterances.html) operation, which provides access to utterance-related analytics. See [Viewing utterance statistics](https://docs.aws.amazon.com/lexv2/latest/dg/monitoring-utterances.html) for the IAM policy to apply to the IAM role.
Retrieves a list of metadata for individual user utterances to your bot. The following fields are required:
+ `startDateTime` and `endDateTime` – Define a time range for which you want to retrieve results.
Of the optional fields, you can organize the results in the following ways:
+ Use the `filters` field to filter the results and the `sortBy` field to specify the values by which to sort the results.
+ Use the `maxResults` field to limit the number of results to return in a single response and the `nextToken` field to return the next batch of results if the response does not return the full set of results.
## Request Syntax
```
POST /bots/botId/analytics/utterances HTTP/1.1
Content-type: application/json
{
"endDateTime": number,
"filters": [
{
"name": "string",
"operator": "string",
"values": [ "string" ]
}
],
"maxResults": number,
"nextToken": "string",
"sortBy": {
"name": "string",
"order": "string"
},
"startDateTime": number
}
```
## URI Request Parameters
The request uses the following URI parameters.
** [botId](#API_ListUtteranceAnalyticsData_RequestSyntax) **
The identifier for the bot for which you want to retrieve utterance analytics.
Length Constraints: Fixed length of 10.
Pattern: `^[0-9a-zA-Z]+$`
Required: Yes
## Request Body
The request accepts the following data in JSON format.
** [endDateTime](#API_ListUtteranceAnalyticsData_RequestSyntax) **
The date and time that marks the end of the range of time for which you want to see utterance analytics.
Type: Timestamp
Required: Yes
** [filters](#API_ListUtteranceAnalyticsData_RequestSyntax) **
A list of objects, each of which describes a condition by which you want to filter the results.
Type: Array of [AnalyticsUtteranceFilter](API_AnalyticsUtteranceFilter.md) objects
Array Members: Minimum number of 1 item. Maximum number of 9 items.
Required: No
** [maxResults](#API_ListUtteranceAnalyticsData_RequestSyntax) **
The maximum number of results to return in each page of results. If there are fewer results than the maximum page size, only the actual number of results are returned.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 1000.
Required: No
** [nextToken](#API_ListUtteranceAnalyticsData_RequestSyntax) **
If the response from the ListUtteranceAnalyticsData operation contains more results than specified in the maxResults parameter, a token is returned in the response.
Use the returned token in the nextToken parameter of a ListUtteranceAnalyticsData request to return the next page of results. For a complete set of results, call the ListUtteranceAnalyticsData operation until the nextToken returned in the response is null.
Type: String
Required: No
** [sortBy](#API_ListUtteranceAnalyticsData_RequestSyntax) **
An object specifying the measure and method by which to sort the utterance analytics data.
Type: [UtteranceDataSortBy](API_UtteranceDataSortBy.md) object
Required: No
** [startDateTime](#API_ListUtteranceAnalyticsData_RequestSyntax) **
The date and time that marks the beginning of the range of time for which you want to see utterance analytics.
Type: Timestamp
Required: Yes
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"botId": "string",
"nextToken": "string",
"utterances": [
{
"associatedIntentName": "string",
"associatedSlotName": "string",
"audioVoiceDurationMillis": number,
"botAliasId": "string",
"botResponseAudioVoiceId": "string",
"botResponses": [
{
"content": "string",
"contentType": "string",
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
}
}
],
"botVersion": "string",
"channel": "string",
"conversationEndTime": number,
"conversationStartTime": number,
"dialogActionType": "string",
"inputType": "string",
"intentState": "string",
"localeId": "string",
"mode": "string",
"outputType": "string",
"sessionId": "string",
"slotsFilledInSession": "string",
"utterance": "string",
"utteranceRequestId": "string",
"utteranceTimestamp": number,
"utteranceUnderstood": boolean
}
]
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [botId](#API_ListUtteranceAnalyticsData_ResponseSyntax) **
The unique identifier of the bot that the utterances belong to.
Type: String
Length Constraints: Fixed length of 10.
Pattern: `^[0-9a-zA-Z]+$`
** [nextToken](#API_ListUtteranceAnalyticsData_ResponseSyntax) **
If the response from the ListUtteranceAnalyticsData operation contains more results than specified in the maxResults parameter, a token is returned in the response.
Use the returned token in the nextToken parameter of a ListUtteranceAnalyticsData request to return the next page of results. For a complete set of results, call the ListUtteranceAnalyticsData operation until the nextToken returned in the response is null.
Type: String
** [utterances](#API_ListUtteranceAnalyticsData_ResponseSyntax) **
A list of objects, each of which contains information about an utterance in a user session with your bot.
Type: Array of [UtteranceSpecification](API_UtteranceSpecification.md) objects
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** InternalServerException **
The service encountered an unexpected condition. Try your request again.
HTTP Status Code: 500
** PreconditionFailedException **
Your request couldn't be completed because one or more request fields aren't valid. Check the fields in your request and try again.
HTTP Status Code: 412
** ServiceQuotaExceededException **
You have reached a quota for your bot.
HTTP Status Code: 402
** ThrottlingException **
Your request rate is too high. Reduce the frequency of requests.
** retryAfterSeconds **
The number of seconds after which the user can invoke the API again.
HTTP Status Code: 429
** ValidationException **
One of the input parameters in your request isn't valid. Check the parameters and try your request again.
HTTP Status Code: 400
## See Also
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/models.lex.v2-2020-08-07/ListUtteranceAnalyticsData)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/models.lex.v2-2020-08-07/ListUtteranceAnalyticsData)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/ListUtteranceAnalyticsData)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/models.lex.v2-2020-08-07/ListUtteranceAnalyticsData)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/ListUtteranceAnalyticsData)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/models.lex.v2-2020-08-07/ListUtteranceAnalyticsData)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/models.lex.v2-2020-08-07/ListUtteranceAnalyticsData)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/models.lex.v2-2020-08-07/ListUtteranceAnalyticsData)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/models.lex.v2-2020-08-07/ListUtteranceAnalyticsData)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/ListUtteranceAnalyticsData)
# ListUtteranceMetrics
**Note**
To use this API operation, your IAM role must have permissions to perform the [ListAggregatedUtterances](https://docs.aws.amazon.com/lexv2/latest/APIReference/API_ListAggregatedUtterances.html) operation, which provides access to utterance-related analytics. See [Viewing utterance statistics](https://docs.aws.amazon.com/lexv2/latest/dg/monitoring-utterances.html) for the IAM policy to apply to the IAM role.
Retrieves summary metrics for the utterances in your bot. The following fields are required:
+ `metrics` – A list of [AnalyticsUtteranceMetric](https://docs.aws.amazon.com/lexv2/latest/APIReference/API_AnalyticsUtteranceMetric.html) objects. In each object, use the `name` field to specify the metric to calculate, the `statistic` field to specify whether to calculate the `Sum`, `Average`, or `Max` number, and the `order` field to specify whether to sort the results in `Ascending` or `Descending` order.
+ `startDateTime` and `endDateTime` – Define a time range for which you want to retrieve results.
Of the optional fields, you can organize the results in the following ways:
+ Use the `filters` field to filter the results, the `groupBy` field to specify categories by which to group the results, and the `binBy` field to specify time intervals by which to group the results.
+ Use the `maxResults` field to limit the number of results to return in a single response and the `nextToken` field to return the next batch of results if the response does not return the full set of results.
Note that an `order` field exists in both `binBy` and `metrics`. Currently, you can specify it in either field, but not in both.
## Request Syntax
```
POST /bots/botId/analytics/utterancemetrics HTTP/1.1
Content-type: application/json
{
"attributes": [
{
"name": "string"
}
],
"binBy": [
{
"interval": "string",
"name": "string",
"order": "string"
}
],
"endDateTime": number,
"filters": [
{
"name": "string",
"operator": "string",
"values": [ "string" ]
}
],
"groupBy": [
{
"name": "string"
}
],
"maxResults": number,
"metrics": [
{
"name": "string",
"order": "string",
"statistic": "string"
}
],
"nextToken": "string",
"startDateTime": number
}
```
## URI Request Parameters
The request uses the following URI parameters.
** [botId](#API_ListUtteranceMetrics_RequestSyntax) **
The identifier for the bot for which you want to retrieve utterance metrics.
Length Constraints: Fixed length of 10.
Pattern: `^[0-9a-zA-Z]+$`
Required: Yes
## Request Body
The request accepts the following data in JSON format.
** [attributes](#API_ListUtteranceMetrics_RequestSyntax) **
A list containing attributes related to the utterance that you want the response to return. The following attributes are possible:
+ `LastUsedIntent` – The last used intent at the time of the utterance.
Type: Array of [AnalyticsUtteranceAttribute](API_AnalyticsUtteranceAttribute.md) objects
Array Members: Fixed number of 1 item.
Required: No
** [binBy](#API_ListUtteranceMetrics_RequestSyntax) **
A list of objects, each of which contains specifications for organizing the results by time.
Type: Array of [AnalyticsBinBySpecification](API_AnalyticsBinBySpecification.md) objects
Array Members: Fixed number of 1 item.
Required: No
** [endDateTime](#API_ListUtteranceMetrics_RequestSyntax) **
The date and time that marks the end of the range of time for which you want to see utterance metrics.
Type: Timestamp
Required: Yes
** [filters](#API_ListUtteranceMetrics_RequestSyntax) **
A list of objects, each of which describes a condition by which you want to filter the results.
Type: Array of [AnalyticsUtteranceFilter](API_AnalyticsUtteranceFilter.md) objects
Array Members: Minimum number of 1 item. Maximum number of 9 items.
Required: No
** [groupBy](#API_ListUtteranceMetrics_RequestSyntax) **
A list of objects, each of which specifies how to group the results. You can group by the following criteria:
+ `UtteranceText` – The transcription of the utterance.
+ `UtteranceState` – The state of the utterance. The possible states are detailed in [Key definitions](https://docs.aws.amazon.com/analytics-key-definitions-utterances) in the user guide.
Type: Array of [AnalyticsUtteranceGroupBySpecification](API_AnalyticsUtteranceGroupBySpecification.md) objects
Array Members: Minimum number of 1 item. Maximum number of 2 items.
Required: No
** [maxResults](#API_ListUtteranceMetrics_RequestSyntax) **
The maximum number of results to return in each page of results. If there are fewer results than the maximum page size, only the actual number of results are returned.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 1000.
Required: No
** [metrics](#API_ListUtteranceMetrics_RequestSyntax) **
A list of objects, each of which contains a metric you want to list, the statistic for the metric you want to return, and the method by which to organize the results.
Type: Array of [AnalyticsUtteranceMetric](API_AnalyticsUtteranceMetric.md) objects
Array Members: Minimum number of 1 item. Maximum number of 4 items.
Required: Yes
** [nextToken](#API_ListUtteranceMetrics_RequestSyntax) **
If the response from the ListUtteranceMetrics operation contains more results than specified in the maxResults parameter, a token is returned in the response.
Use the returned token in the nextToken parameter of a ListUtteranceMetrics request to return the next page of results. For a complete set of results, call the ListUtteranceMetrics operation until the nextToken returned in the response is null.
Type: String
Required: No
** [startDateTime](#API_ListUtteranceMetrics_RequestSyntax) **
The date and time that marks the beginning of the range of time for which you want to see utterance metrics.
Type: Timestamp
Required: Yes
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"botId": "string",
"nextToken": "string",
"results": [
{
"attributeResults": [
{
"lastUsedIntent": "string"
}
],
"binKeys": [
{
"name": "string",
"value": number
}
],
"groupByKeys": [
{
"name": "string",
"value": "string"
}
],
"metricsResults": [
{
"name": "string",
"statistic": "string",
"value": number
}
]
}
]
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [botId](#API_ListUtteranceMetrics_ResponseSyntax) **
The identifier for the bot for which you retrieved utterance metrics.
Type: String
Length Constraints: Fixed length of 10.
Pattern: `^[0-9a-zA-Z]+$`
** [nextToken](#API_ListUtteranceMetrics_ResponseSyntax) **
If the response from the ListUtteranceMetrics operation contains more results than specified in the maxResults parameter, a token is returned in the response.
Use the returned token in the nextToken parameter of a ListUtteranceMetrics request to return the next page of results. For a complete set of results, call the ListUtteranceMetrics operation until the nextToken returned in the response is null.
Type: String
** [results](#API_ListUtteranceMetrics_ResponseSyntax) **
The results for the utterance metrics.
Type: Array of [AnalyticsUtteranceResult](API_AnalyticsUtteranceResult.md) objects
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** InternalServerException **
The service encountered an unexpected condition. Try your request again.
HTTP Status Code: 500
** PreconditionFailedException **
Your request couldn't be completed because one or more request fields aren't valid. Check the fields in your request and try again.
HTTP Status Code: 412
** ServiceQuotaExceededException **
You have reached a quota for your bot.
HTTP Status Code: 402
** ThrottlingException **
Your request rate is too high. Reduce the frequency of requests.
** retryAfterSeconds **
The number of seconds after which the user can invoke the API again.
HTTP Status Code: 429
** ValidationException **
One of the input parameters in your request isn't valid. Check the parameters and try your request again.
HTTP Status Code: 400
## See Also
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/models.lex.v2-2020-08-07/ListUtteranceMetrics)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/models.lex.v2-2020-08-07/ListUtteranceMetrics)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/ListUtteranceMetrics)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/models.lex.v2-2020-08-07/ListUtteranceMetrics)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/ListUtteranceMetrics)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/models.lex.v2-2020-08-07/ListUtteranceMetrics)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/models.lex.v2-2020-08-07/ListUtteranceMetrics)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/models.lex.v2-2020-08-07/ListUtteranceMetrics)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/models.lex.v2-2020-08-07/ListUtteranceMetrics)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/ListUtteranceMetrics)
# SearchAssociatedTranscripts
Search for associated transcripts that meet the specified criteria.
## Request Syntax
```
POST /bots/botId/botversions/botVersion/botlocales/localeId/botrecommendations/botRecommendationId/associatedtranscripts HTTP/1.1
Content-type: application/json
{
"filters": [
{
"name": "string",
"values": [ "string" ]
}
],
"maxResults": number,
"nextIndex": number,
"searchOrder": "string"
}
```
## URI Request Parameters
The request uses the following URI parameters.
** [botId](#API_SearchAssociatedTranscripts_RequestSyntax) **
The unique identifier of the bot associated with the transcripts that you are searching.
Length Constraints: Fixed length of 10.
Pattern: `^[0-9a-zA-Z]+$`
Required: Yes
** [botRecommendationId](#API_SearchAssociatedTranscripts_RequestSyntax) **
The unique identifier of the bot recommendation associated with the transcripts to search.
Length Constraints: Fixed length of 10.
Pattern: `^[0-9a-zA-Z]+$`
Required: Yes
** [botVersion](#API_SearchAssociatedTranscripts_RequestSyntax) **
The version of the bot containing the transcripts that you are searching.
Length Constraints: Minimum length of 1. Maximum length of 5.
Pattern: `^(DRAFT|[0-9]+)$`
Required: Yes
** [localeId](#API_SearchAssociatedTranscripts_RequestSyntax) **
The identifier of the language and locale of the transcripts to search. The string must match one of the supported locales. For more information, see [Supported languages](https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html)
Required: Yes
## Request Body
The request accepts the following data in JSON format.
** [filters](#API_SearchAssociatedTranscripts_RequestSyntax) **
A list of filter objects.
Type: Array of [AssociatedTranscriptFilter](API_AssociatedTranscriptFilter.md) objects
Array Members: Fixed number of 1 item.
Required: Yes
** [maxResults](#API_SearchAssociatedTranscripts_RequestSyntax) **
The maximum number of bot recommendations to return in each page of results. If there are fewer results than the max page size, only the actual number of results are returned.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 1000.
Required: No
** [nextIndex](#API_SearchAssociatedTranscripts_RequestSyntax) **
If the response from the SearchAssociatedTranscriptsRequest operation contains more results than specified in the maxResults parameter, an index is returned in the response. Use that index in the nextIndex parameter to return the next page of results.
Type: Integer
Valid Range: Minimum value of 0. Maximum value of 10000000.
Required: No
** [searchOrder](#API_SearchAssociatedTranscripts_RequestSyntax) **
How SearchResults are ordered. Valid values are Ascending or Descending. The default is Descending.
Type: String
Valid Values: `Ascending | Descending`
Required: No
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"associatedTranscripts": [
{
"transcript": "string"
}
],
"botId": "string",
"botRecommendationId": "string",
"botVersion": "string",
"localeId": "string",
"nextIndex": number,
"totalResults": number
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [associatedTranscripts](#API_SearchAssociatedTranscripts_ResponseSyntax) **
The object that contains the associated transcript that meet the criteria you specified.
Type: Array of [AssociatedTranscript](API_AssociatedTranscript.md) objects
** [botId](#API_SearchAssociatedTranscripts_ResponseSyntax) **
The unique identifier of the bot associated with the transcripts that you are searching.
Type: String
Length Constraints: Fixed length of 10.
Pattern: `^[0-9a-zA-Z]+$`
** [botRecommendationId](#API_SearchAssociatedTranscripts_ResponseSyntax) **
The unique identifier of the bot recommendation associated with the transcripts to search.
Type: String
Length Constraints: Fixed length of 10.
Pattern: `^[0-9a-zA-Z]+$`
** [botVersion](#API_SearchAssociatedTranscripts_ResponseSyntax) **
The version of the bot containing the transcripts that you are searching.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 5.
Pattern: `^(DRAFT|[0-9]+)$`
** [localeId](#API_SearchAssociatedTranscripts_ResponseSyntax) **
The identifier of the language and locale of the transcripts to search. The string must match one of the supported locales. For more information, see [Supported languages](https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html)
Type: String
** [nextIndex](#API_SearchAssociatedTranscripts_ResponseSyntax) **
A index that indicates whether there are more results to return in a response to the SearchAssociatedTranscripts operation. If the nextIndex field is present, you send the contents as the nextIndex parameter of a SearchAssociatedTranscriptsRequest operation to get the next page of results.
Type: Integer
Valid Range: Minimum value of 0. Maximum value of 10000000.
** [totalResults](#API_SearchAssociatedTranscripts_ResponseSyntax) **
The total number of transcripts returned by the search.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 1000.
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** InternalServerException **
The service encountered an unexpected condition. Try your request again.
HTTP Status Code: 500
** ResourceNotFoundException **
You asked to describe a resource that doesn't exist. Check the resource that you are requesting and try again.
HTTP Status Code: 404
** ServiceQuotaExceededException **
You have reached a quota for your bot.
HTTP Status Code: 402
** ThrottlingException **
Your request rate is too high. Reduce the frequency of requests.
** retryAfterSeconds **
The number of seconds after which the user can invoke the API again.
HTTP Status Code: 429
** ValidationException **
One of the input parameters in your request isn't valid. Check the parameters and try your request again.
HTTP Status Code: 400
## See Also
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/models.lex.v2-2020-08-07/SearchAssociatedTranscripts)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/models.lex.v2-2020-08-07/SearchAssociatedTranscripts)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/SearchAssociatedTranscripts)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/models.lex.v2-2020-08-07/SearchAssociatedTranscripts)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/SearchAssociatedTranscripts)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/models.lex.v2-2020-08-07/SearchAssociatedTranscripts)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/models.lex.v2-2020-08-07/SearchAssociatedTranscripts)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/models.lex.v2-2020-08-07/SearchAssociatedTranscripts)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/models.lex.v2-2020-08-07/SearchAssociatedTranscripts)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/SearchAssociatedTranscripts)
# StartBotAnalyzer
Initiates an asynchronous analysis of your bot configuration using AI-powered analysis to identify potential issues and recommend improvements based on AWS best practices.
The analysis examines your bot's configuration, including intents, utterances, slots, and conversation flows, to provide actionable recommendations for optimization.
## Request Syntax
```
POST /bots/botId/botanalyzer/ HTTP/1.1
Content-type: application/json
{
"analysisScope": "string",
"botVersion": "string",
"localeId": "string"
}
```
## URI Request Parameters
The request uses the following URI parameters.
** [botId](#API_StartBotAnalyzer_RequestSyntax) **
The unique identifier of the bot to analyze.
Length Constraints: Fixed length of 10.
Pattern: `^[0-9a-zA-Z]+$`
Required: Yes
## Request Body
The request accepts the following data in JSON format.
** [analysisScope](#API_StartBotAnalyzer_RequestSyntax) **
The scope of analysis to perform. Currently only `BotLocale` scope is supported.
Valid Values: `BotLocale`
Type: String
Valid Values: `BotLocale`
Required: Yes
** [botVersion](#API_StartBotAnalyzer_RequestSyntax) **
The version of the bot to analyze. Defaults to `DRAFT` if not specified.
Type: String
Length Constraints: Fixed length of 5.
Pattern: `^DRAFT$`
Required: No
** [localeId](#API_StartBotAnalyzer_RequestSyntax) **
The locale identifier for the bot locale to analyze. Required when `analysisScope` is `BotLocale`.
Type: String
Required: No
## Response Syntax
```
HTTP/1.1 202
Content-type: application/json
{
"botAnalyzerRequestId": "string",
"botAnalyzerStatus": "string",
"botId": "string",
"botVersion": "string",
"creationDateTime": number,
"localeId": "string"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 202 response.
The following data is returned in JSON format by the service.
** [botAnalyzerRequestId](#API_StartBotAnalyzer_ResponseSyntax) **
A unique identifier for this analysis request. Use this identifier to check the status and retrieve results.
Type: String
Length Constraints: Fixed length of 36.
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}`
** [botAnalyzerStatus](#API_StartBotAnalyzer_ResponseSyntax) **
The current status of the analysis. The initial status is `Processing`.
Valid Values: `Processing | Available | Failed | Stopping | Stopped`
Type: String
Valid Values: `Processing | Available | Failed | Stopping | Stopped`
** [botId](#API_StartBotAnalyzer_ResponseSyntax) **
The unique identifier of the bot being analyzed.
Type: String
Length Constraints: Fixed length of 10.
Pattern: `^[0-9a-zA-Z]+$`
** [botVersion](#API_StartBotAnalyzer_ResponseSyntax) **
The version of the bot being analyzed.
Type: String
Length Constraints: Fixed length of 5.
Pattern: `^DRAFT$`
** [creationDateTime](#API_StartBotAnalyzer_ResponseSyntax) **
The date and time when the analysis was initiated.
Type: Timestamp
** [localeId](#API_StartBotAnalyzer_ResponseSyntax) **
The locale identifier of the bot locale being analyzed.
Type: String
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** ConflictException **
The action that you tried to perform couldn't be completed because the resource is in a conflicting state. For example, deleting a bot that is in the CREATING state. Try your request again.
HTTP Status Code: 409
** InternalServerException **
The service encountered an unexpected condition. Try your request again.
HTTP Status Code: 500
** ResourceNotFoundException **
You asked to describe a resource that doesn't exist. Check the resource that you are requesting and try again.
HTTP Status Code: 404
** ThrottlingException **
Your request rate is too high. Reduce the frequency of requests.
** retryAfterSeconds **
The number of seconds after which the user can invoke the API again.
HTTP Status Code: 429
** ValidationException **
One of the input parameters in your request isn't valid. Check the parameters and try your request again.
HTTP Status Code: 400
## Examples
### Example request
This example illustrates one usage of StartBotAnalyzer.
```
POST https://models-v2-lex.us-east-1.amazonaws.com/bots//botanalyzer/
Payload:
{
"analysisScope": "BotLocale",
"botId": "",
"localeId": "en_US",
"botVersion": "DRAFT"
}
```
### Example response
This example illustrates one usage of StartBotAnalyzer.
```
{
"botId": "",
"botVersion": "DRAFT",
"localeId": "en_US",
"botAnalyzerStatus": "Processing",
"creationDateTime": 1729570423.948,
"botAnalyzerRequestId": ""
}
```
## See Also
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/models.lex.v2-2020-08-07/StartBotAnalyzer)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/models.lex.v2-2020-08-07/StartBotAnalyzer)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/StartBotAnalyzer)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/models.lex.v2-2020-08-07/StartBotAnalyzer)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/StartBotAnalyzer)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/models.lex.v2-2020-08-07/StartBotAnalyzer)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/models.lex.v2-2020-08-07/StartBotAnalyzer)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/models.lex.v2-2020-08-07/StartBotAnalyzer)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/models.lex.v2-2020-08-07/StartBotAnalyzer)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/StartBotAnalyzer)
# StartBotRecommendation
Use this to provide your transcript data, and to start the bot recommendation process.
## Request Syntax
```
PUT /bots/botId/botversions/botVersion/botlocales/localeId/botrecommendations/ HTTP/1.1
Content-type: application/json
{
"encryptionSetting": {
"associatedTranscriptsPassword": "string",
"botLocaleExportPassword": "string",
"kmsKeyArn": "string"
},
"transcriptSourceSetting": {
"s3BucketTranscriptSource": {
"kmsKeyArn": "string",
"pathFormat": {
"objectPrefixes": [ "string" ]
},
"s3BucketName": "string",
"transcriptFilter": {
"lexTranscriptFilter": {
"dateRangeFilter": {
"endDateTime": number,
"startDateTime": number
}
}
},
"transcriptFormat": "string"
}
}
}
```
## URI Request Parameters
The request uses the following URI parameters.
** [botId](#API_StartBotRecommendation_RequestSyntax) **
The unique identifier of the bot containing the bot recommendation.
Length Constraints: Fixed length of 10.
Pattern: `^[0-9a-zA-Z]+$`
Required: Yes
** [botVersion](#API_StartBotRecommendation_RequestSyntax) **
The version of the bot containing the bot recommendation.
Length Constraints: Fixed length of 5.
Pattern: `^DRAFT$`
Required: Yes
** [localeId](#API_StartBotRecommendation_RequestSyntax) **
The identifier of the language and locale of the bot recommendation to start. The string must match one of the supported locales. For more information, see [Supported languages](https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html)
Required: Yes
## Request Body
The request accepts the following data in JSON format.
** [encryptionSetting](#API_StartBotRecommendation_RequestSyntax) **
The object representing the passwords that will be used to encrypt the data related to the bot recommendation results, as well as the AWS KMS key ARN used to encrypt the associated metadata.
Type: [EncryptionSetting](API_EncryptionSetting.md) object
Required: No
** [transcriptSourceSetting](#API_StartBotRecommendation_RequestSyntax) **
The object representing the Amazon S3 bucket containing the transcript, as well as the associated metadata.
Type: [TranscriptSourceSetting](API_TranscriptSourceSetting.md) object
Required: Yes
## Response Syntax
```
HTTP/1.1 202
Content-type: application/json
{
"botId": "string",
"botRecommendationId": "string",
"botRecommendationStatus": "string",
"botVersion": "string",
"creationDateTime": number,
"encryptionSetting": {
"associatedTranscriptsPassword": "string",
"botLocaleExportPassword": "string",
"kmsKeyArn": "string"
},
"localeId": "string",
"transcriptSourceSetting": {
"s3BucketTranscriptSource": {
"kmsKeyArn": "string",
"pathFormat": {
"objectPrefixes": [ "string" ]
},
"s3BucketName": "string",
"transcriptFilter": {
"lexTranscriptFilter": {
"dateRangeFilter": {
"endDateTime": number,
"startDateTime": number
}
}
},
"transcriptFormat": "string"
}
}
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 202 response.
The following data is returned in JSON format by the service.
** [botId](#API_StartBotRecommendation_ResponseSyntax) **
The unique identifier of the bot containing the bot recommendation.
Type: String
Length Constraints: Fixed length of 10.
Pattern: `^[0-9a-zA-Z]+$`
** [botRecommendationId](#API_StartBotRecommendation_ResponseSyntax) **
The identifier of the bot recommendation that you have created.
Type: String
Length Constraints: Fixed length of 10.
Pattern: `^[0-9a-zA-Z]+$`
** [botRecommendationStatus](#API_StartBotRecommendation_ResponseSyntax) **
The status of the bot recommendation.
If the status is Failed, then the reasons for the failure are listed in the failureReasons field.
Type: String
Valid Values: `Processing | Deleting | Deleted | Downloading | Updating | Available | Failed | Stopping | Stopped`
** [botVersion](#API_StartBotRecommendation_ResponseSyntax) **
The version of the bot containing the bot recommendation.
Type: String
Length Constraints: Fixed length of 5.
Pattern: `^DRAFT$`
** [creationDateTime](#API_StartBotRecommendation_ResponseSyntax) **
A timestamp of the date and time that the bot recommendation was created.
Type: Timestamp
** [encryptionSetting](#API_StartBotRecommendation_ResponseSyntax) **
The object representing the passwords that were used to encrypt the data related to the bot recommendation results, as well as the AWS KMS key ARN used to encrypt the associated metadata.
Type: [EncryptionSetting](API_EncryptionSetting.md) object
** [localeId](#API_StartBotRecommendation_ResponseSyntax) **
The identifier of the language and locale of the bot recommendation to start. The string must match one of the supported locales. For more information, see [Supported languages](https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html)
Type: String
** [transcriptSourceSetting](#API_StartBotRecommendation_ResponseSyntax) **
The object representing the Amazon S3 bucket containing the transcript, as well as the associated metadata.
Type: [TranscriptSourceSetting](API_TranscriptSourceSetting.md) object
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** ConflictException **
The action that you tried to perform couldn't be completed because the resource is in a conflicting state. For example, deleting a bot that is in the CREATING state. Try your request again.
HTTP Status Code: 409
** ConflictException **
The action that you tried to perform couldn't be completed because the resource is in a conflicting state. For example, deleting a bot that is in the CREATING state. Try your request again.
HTTP Status Code: 409
** InternalServerException **
The service encountered an unexpected condition. Try your request again.
HTTP Status Code: 500
** PreconditionFailedException **
Your request couldn't be completed because one or more request fields aren't valid. Check the fields in your request and try again.
HTTP Status Code: 412
** ResourceNotFoundException **
You asked to describe a resource that doesn't exist. Check the resource that you are requesting and try again.
HTTP Status Code: 404
** ServiceQuotaExceededException **
You have reached a quota for your bot.
HTTP Status Code: 402
** ThrottlingException **
Your request rate is too high. Reduce the frequency of requests.
** retryAfterSeconds **
The number of seconds after which the user can invoke the API again.
HTTP Status Code: 429
** ValidationException **
One of the input parameters in your request isn't valid. Check the parameters and try your request again.
HTTP Status Code: 400
## See Also
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/models.lex.v2-2020-08-07/StartBotRecommendation)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/models.lex.v2-2020-08-07/StartBotRecommendation)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/StartBotRecommendation)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/models.lex.v2-2020-08-07/StartBotRecommendation)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/StartBotRecommendation)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/models.lex.v2-2020-08-07/StartBotRecommendation)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/models.lex.v2-2020-08-07/StartBotRecommendation)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/models.lex.v2-2020-08-07/StartBotRecommendation)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/models.lex.v2-2020-08-07/StartBotRecommendation)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/StartBotRecommendation)
# StartBotResourceGeneration
Starts a request for the descriptive bot builder to generate a bot locale configuration based on the prompt you provide it. After you make this call, use the `DescribeBotResourceGeneration` operation to check on the status of the generation and for the `generatedBotLocaleUrl` when the generation is complete. Use that value to retrieve the Amazon S3 object containing the bot locale configuration. You can then modify and import this configuration.
## Request Syntax
```
PUT /bots/botId/botversions/botVersion/botlocales/localeId/startgeneration HTTP/1.1
Content-type: application/json
{
"generationInputPrompt": "string"
}
```
## URI Request Parameters
The request uses the following URI parameters.
** [botId](#API_StartBotResourceGeneration_RequestSyntax) **
The unique identifier of the bot for which to generate intents and slot types.
Length Constraints: Fixed length of 10.
Pattern: `^[0-9a-zA-Z]+$`
Required: Yes
** [botVersion](#API_StartBotResourceGeneration_RequestSyntax) **
The version of the bot for which to generate intents and slot types.
Length Constraints: Minimum length of 1. Maximum length of 5.
Pattern: `^(DRAFT|[0-9]+)$`
Required: Yes
** [localeId](#API_StartBotResourceGeneration_RequestSyntax) **
The locale of the bot for which to generate intents and slot types.
Required: Yes
## Request Body
The request accepts the following data in JSON format.
** [generationInputPrompt](#API_StartBotResourceGeneration_RequestSyntax) **
The prompt to generate intents and slot types for the bot locale. Your description should be both *detailed* and *precise* to help generate appropriate and sufficient intents for your bot. Include a list of actions to improve the intent creation process.
Type: String
Length Constraints: Minimum length of 100. Maximum length of 2000.
Required: Yes
## Response Syntax
```
HTTP/1.1 202
Content-type: application/json
{
"botId": "string",
"botVersion": "string",
"creationDateTime": number,
"generationId": "string",
"generationInputPrompt": "string",
"generationStatus": "string",
"localeId": "string"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 202 response.
The following data is returned in JSON format by the service.
** [botId](#API_StartBotResourceGeneration_ResponseSyntax) **
The unique identifier of the bot for which the generation request was made.
Type: String
Length Constraints: Fixed length of 10.
Pattern: `^[0-9a-zA-Z]+$`
** [botVersion](#API_StartBotResourceGeneration_ResponseSyntax) **
The version of the bot for which the generation request was made.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 5.
Pattern: `^(DRAFT|[0-9]+)$`
** [creationDateTime](#API_StartBotResourceGeneration_ResponseSyntax) **
The date and time at which the generation request was made.
Type: Timestamp
** [generationId](#API_StartBotResourceGeneration_ResponseSyntax) **
The unique identifier of the generation request.
Type: String
Length Constraints: Fixed length of 10.
Pattern: `^[0-9a-zA-Z]+$`
** [generationInputPrompt](#API_StartBotResourceGeneration_ResponseSyntax) **
The prompt that was used generate intents and slot types for the bot locale.
Type: String
Length Constraints: Minimum length of 100. Maximum length of 2000.
** [generationStatus](#API_StartBotResourceGeneration_ResponseSyntax) **
The status of the generation request.
Type: String
Valid Values: `Failed | Complete | InProgress`
** [localeId](#API_StartBotResourceGeneration_ResponseSyntax) **
The locale of the bot for which the generation request was made.
Type: String
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** ConflictException **
The action that you tried to perform couldn't be completed because the resource is in a conflicting state. For example, deleting a bot that is in the CREATING state. Try your request again.
HTTP Status Code: 409
** InternalServerException **
The service encountered an unexpected condition. Try your request again.
HTTP Status Code: 500
** PreconditionFailedException **
Your request couldn't be completed because one or more request fields aren't valid. Check the fields in your request and try again.
HTTP Status Code: 412
** ServiceQuotaExceededException **
You have reached a quota for your bot.
HTTP Status Code: 402
** ThrottlingException **
Your request rate is too high. Reduce the frequency of requests.
** retryAfterSeconds **
The number of seconds after which the user can invoke the API again.
HTTP Status Code: 429
** ValidationException **
One of the input parameters in your request isn't valid. Check the parameters and try your request again.
HTTP Status Code: 400
## Examples
### Example request
This example illustrates one usage of StartBotResourceGeneration.
```
PUT https://models-v2-lex.us-east-1.amazonaws.com/bots/BOT1234567/botversions/DRAFT/botlocales/en_GB/startgeneration
Payload:
{
"generationInputPrompt": "We want a bot to help customers order food (using item id, quantity, size), check order status, and cancel an order. Use Order ID for indexing order."
}
```
### Example response
This example illustrates one usage of StartBotResourceGeneration.
```
{
"botId": "BOT1234567",
"botVersion": "DRAFT",
"creationDateTime": 1.699570064977E9,
"generationId": "GEN1234567",
"generationInputPrompt": null,
"generationStatus": "InProgress",
"localeId": "en_GB"
}
```
## See Also
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/models.lex.v2-2020-08-07/StartBotResourceGeneration)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/models.lex.v2-2020-08-07/StartBotResourceGeneration)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/StartBotResourceGeneration)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/models.lex.v2-2020-08-07/StartBotResourceGeneration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/StartBotResourceGeneration)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/models.lex.v2-2020-08-07/StartBotResourceGeneration)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/models.lex.v2-2020-08-07/StartBotResourceGeneration)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/models.lex.v2-2020-08-07/StartBotResourceGeneration)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/models.lex.v2-2020-08-07/StartBotResourceGeneration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/StartBotResourceGeneration)
# StartImport
Starts importing a bot, bot locale, or custom vocabulary from a zip archive that you uploaded to an S3 bucket.
## Request Syntax
```
PUT /imports/ HTTP/1.1
Content-type: application/json
{
"filePassword": "string",
"importId": "string",
"mergeStrategy": "string",
"resourceSpecification": {
"botImportSpecification": {
"botName": "string",
"botTags": {
"string" : "string"
},
"dataPrivacy": {
"childDirected": boolean
},
"errorLogSettings": {
"enabled": boolean
},
"idleSessionTTLInSeconds": number,
"roleArn": "string",
"testBotAliasTags": {
"string" : "string"
}
},
"botLocaleImportSpecification": {
"botId": "string",
"botVersion": "string",
"localeId": "string",
"nluIntentConfidenceThreshold": number,
"speechDetectionSensitivity": "string",
"speechRecognitionSettings": {
"speechModelConfig": {
"deepgramConfig": {
"apiTokenSecretArn": "string",
"modelId": "string"
}
},
"speechModelPreference": "string"
},
"unifiedSpeechSettings": {
"speechFoundationModel": {
"modelArn": "string",
"voiceId": "string"
}
},
"voiceSettings": {
"engine": "string",
"voiceId": "string"
}
},
"customVocabularyImportSpecification": {
"botId": "string",
"botVersion": "string",
"localeId": "string"
},
"testSetImportResourceSpecification": {
"description": "string",
"importInputLocation": {
"s3BucketName": "string",
"s3Path": "string"
},
"modality": "string",
"roleArn": "string",
"storageLocation": {
"kmsKeyArn": "string",
"s3BucketName": "string",
"s3Path": "string"
},
"testSetName": "string",
"testSetTags": {
"string" : "string"
}
}
}
}
```
## URI Request Parameters
The request does not use any URI parameters.
## Request Body
The request accepts the following data in JSON format.
** [filePassword](#API_StartImport_RequestSyntax) **
The password used to encrypt the zip archive that contains the resource definition. You should always encrypt the zip archive to protect it during transit between your site and Amazon Lex.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Required: No
** [importId](#API_StartImport_RequestSyntax) **
The unique identifier for the import. It is included in the response from the [CreateUploadUrl](https://docs.aws.amazon.com/lexv2/latest/APIReference/API_CreateUploadUrl.html) operation.
Type: String
Length Constraints: Fixed length of 10.
Pattern: `^[0-9a-zA-Z]+$`
Required: Yes
** [mergeStrategy](#API_StartImport_RequestSyntax) **
The strategy to use when there is a name conflict between the imported resource and an existing resource. When the merge strategy is `FailOnConflict` existing resources are not overwritten and the import fails.
Type: String
Valid Values: `Overwrite | FailOnConflict | Append`
Required: Yes
** [resourceSpecification](#API_StartImport_RequestSyntax) **
Parameters for creating the bot, bot locale or custom vocabulary.
Type: [ImportResourceSpecification](API_ImportResourceSpecification.md) object
Required: Yes
## Response Syntax
```
HTTP/1.1 202
Content-type: application/json
{
"creationDateTime": number,
"importId": "string",
"importStatus": "string",
"mergeStrategy": "string",
"resourceSpecification": {
"botImportSpecification": {
"botName": "string",
"botTags": {
"string" : "string"
},
"dataPrivacy": {
"childDirected": boolean
},
"errorLogSettings": {
"enabled": boolean
},
"idleSessionTTLInSeconds": number,
"roleArn": "string",
"testBotAliasTags": {
"string" : "string"
}
},
"botLocaleImportSpecification": {
"botId": "string",
"botVersion": "string",
"localeId": "string",
"nluIntentConfidenceThreshold": number,
"speechDetectionSensitivity": "string",
"speechRecognitionSettings": {
"speechModelConfig": {
"deepgramConfig": {
"apiTokenSecretArn": "string",
"modelId": "string"
}
},
"speechModelPreference": "string"
},
"unifiedSpeechSettings": {
"speechFoundationModel": {
"modelArn": "string",
"voiceId": "string"
}
},
"voiceSettings": {
"engine": "string",
"voiceId": "string"
}
},
"customVocabularyImportSpecification": {
"botId": "string",
"botVersion": "string",
"localeId": "string"
},
"testSetImportResourceSpecification": {
"description": "string",
"importInputLocation": {
"s3BucketName": "string",
"s3Path": "string"
},
"modality": "string",
"roleArn": "string",
"storageLocation": {
"kmsKeyArn": "string",
"s3BucketName": "string",
"s3Path": "string"
},
"testSetName": "string",
"testSetTags": {
"string" : "string"
}
}
}
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 202 response.
The following data is returned in JSON format by the service.
** [creationDateTime](#API_StartImport_ResponseSyntax) **
The date and time that the import request was created.
Type: Timestamp
** [importId](#API_StartImport_ResponseSyntax) **
A unique identifier for the import.
Type: String
Length Constraints: Fixed length of 10.
Pattern: `^[0-9a-zA-Z]+$`
** [importStatus](#API_StartImport_ResponseSyntax) **
The current status of the import. When the status is `Complete` the bot, bot alias, or custom vocabulary is ready to use.
Type: String
Valid Values: `InProgress | Completed | Failed | Deleting`
** [mergeStrategy](#API_StartImport_ResponseSyntax) **
The strategy used when there was a name conflict between the imported resource and an existing resource. When the merge strategy is `FailOnConflict` existing resources are not overwritten and the import fails.
Type: String
Valid Values: `Overwrite | FailOnConflict | Append`
** [resourceSpecification](#API_StartImport_ResponseSyntax) **
The parameters used when importing the resource.
Type: [ImportResourceSpecification](API_ImportResourceSpecification.md) object
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** ConflictException **
The action that you tried to perform couldn't be completed because the resource is in a conflicting state. For example, deleting a bot that is in the CREATING state. Try your request again.
HTTP Status Code: 409
** InternalServerException **
The service encountered an unexpected condition. Try your request again.
HTTP Status Code: 500
** ResourceNotFoundException **
You asked to describe a resource that doesn't exist. Check the resource that you are requesting and try again.
HTTP Status Code: 404
** ServiceQuotaExceededException **
You have reached a quota for your bot.
HTTP Status Code: 402
** ThrottlingException **
Your request rate is too high. Reduce the frequency of requests.
** retryAfterSeconds **
The number of seconds after which the user can invoke the API again.
HTTP Status Code: 429
** ValidationException **
One of the input parameters in your request isn't valid. Check the parameters and try your request again.
HTTP Status Code: 400
## See Also
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/models.lex.v2-2020-08-07/StartImport)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/models.lex.v2-2020-08-07/StartImport)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/StartImport)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/models.lex.v2-2020-08-07/StartImport)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/StartImport)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/models.lex.v2-2020-08-07/StartImport)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/models.lex.v2-2020-08-07/StartImport)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/models.lex.v2-2020-08-07/StartImport)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/models.lex.v2-2020-08-07/StartImport)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/StartImport)
# StartTestExecution
The action to start test set execution.
## Request Syntax
```
POST /testsets/testSetId/testexecutions HTTP/1.1
Content-type: application/json
{
"apiMode": "string",
"target": {
"botAliasTarget": {
"botAliasId": "string",
"botId": "string",
"localeId": "string"
}
},
"testExecutionModality": "string"
}
```
## URI Request Parameters
The request uses the following URI parameters.
** [testSetId](#API_StartTestExecution_RequestSyntax) **
The test set Id for the test set execution.
Length Constraints: Fixed length of 10.
Pattern: `^[0-9a-zA-Z]+$`
Required: Yes
## Request Body
The request accepts the following data in JSON format.
** [apiMode](#API_StartTestExecution_RequestSyntax) **
Indicates whether we use streaming or non-streaming APIs for the test set execution. For streaming, StartConversation Runtime API is used. Whereas, for non-streaming, RecognizeUtterance and RecognizeText Amazon Lex Runtime API are used.
Type: String
Valid Values: `Streaming | NonStreaming`
Required: Yes
** [target](#API_StartTestExecution_RequestSyntax) **
The target bot for the test set execution.
Type: [TestExecutionTarget](API_TestExecutionTarget.md) object
Required: Yes
** [testExecutionModality](#API_StartTestExecution_RequestSyntax) **
Indicates whether audio or text is used.
Type: String
Valid Values: `Text | Audio`
Required: No
## Response Syntax
```
HTTP/1.1 202
Content-type: application/json
{
"apiMode": "string",
"creationDateTime": number,
"target": {
"botAliasTarget": {
"botAliasId": "string",
"botId": "string",
"localeId": "string"
}
},
"testExecutionId": "string",
"testExecutionModality": "string",
"testSetId": "string"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 202 response.
The following data is returned in JSON format by the service.
** [apiMode](#API_StartTestExecution_ResponseSyntax) **
Indicates whether we use streaming or non-streaming APIs for the test set execution. For streaming, StartConversation Amazon Lex Runtime API is used. Whereas for non-streaming, RecognizeUtterance and RecognizeText Amazon Lex Runtime API are used.
Type: String
Valid Values: `Streaming | NonStreaming`
** [creationDateTime](#API_StartTestExecution_ResponseSyntax) **
The creation date and time for the test set execution.
Type: Timestamp
** [target](#API_StartTestExecution_ResponseSyntax) **
The target bot for the test set execution.
Type: [TestExecutionTarget](API_TestExecutionTarget.md) object
** [testExecutionId](#API_StartTestExecution_ResponseSyntax) **
The unique identifier of the test set execution.
Type: String
Length Constraints: Fixed length of 10.
Pattern: `^[0-9a-zA-Z]+$`
** [testExecutionModality](#API_StartTestExecution_ResponseSyntax) **
Indicates whether audio or text is used.
Type: String
Valid Values: `Text | Audio`
** [testSetId](#API_StartTestExecution_ResponseSyntax) **
The test set Id for the test set execution.
Type: String
Length Constraints: Fixed length of 10.
Pattern: `^[0-9a-zA-Z]+$`
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** ConflictException **
The action that you tried to perform couldn't be completed because the resource is in a conflicting state. For example, deleting a bot that is in the CREATING state. Try your request again.
HTTP Status Code: 409
** InternalServerException **
The service encountered an unexpected condition. Try your request again.
HTTP Status Code: 500
** ResourceNotFoundException **
You asked to describe a resource that doesn't exist. Check the resource that you are requesting and try again.
HTTP Status Code: 404
** ServiceQuotaExceededException **
You have reached a quota for your bot.
HTTP Status Code: 402
** ThrottlingException **
Your request rate is too high. Reduce the frequency of requests.
** retryAfterSeconds **
The number of seconds after which the user can invoke the API again.
HTTP Status Code: 429
** ValidationException **
One of the input parameters in your request isn't valid. Check the parameters and try your request again.
HTTP Status Code: 400
## See Also
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/models.lex.v2-2020-08-07/StartTestExecution)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/models.lex.v2-2020-08-07/StartTestExecution)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/StartTestExecution)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/models.lex.v2-2020-08-07/StartTestExecution)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/StartTestExecution)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/models.lex.v2-2020-08-07/StartTestExecution)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/models.lex.v2-2020-08-07/StartTestExecution)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/models.lex.v2-2020-08-07/StartTestExecution)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/models.lex.v2-2020-08-07/StartTestExecution)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/StartTestExecution)
# StartTestSetGeneration
The action to start the generation of test set.
## Request Syntax
```
PUT /testsetgenerations HTTP/1.1
Content-type: application/json
{
"description": "string",
"generationDataSource": {
"conversationLogsDataSource": {
"botAliasId": "string",
"botId": "string",
"filter": {
"endTime": number,
"inputMode": "string",
"startTime": number
},
"localeId": "string"
}
},
"roleArn": "string",
"storageLocation": {
"kmsKeyArn": "string",
"s3BucketName": "string",
"s3Path": "string"
},
"testSetName": "string",
"testSetTags": {
"string" : "string"
}
}
```
## URI Request Parameters
The request does not use any URI parameters.
## Request Body
The request accepts the following data in JSON format.
** [description](#API_StartTestSetGeneration_RequestSyntax) **
The test set description for the test set generation request.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 2000.
Required: No
** [generationDataSource](#API_StartTestSetGeneration_RequestSyntax) **
The data source for the test set generation.
Type: [TestSetGenerationDataSource](API_TestSetGenerationDataSource.md) object
Required: Yes
** [roleArn](#API_StartTestSetGeneration_RequestSyntax) **
The roleARN used for any operation in the test set to access resources in the AWS account.
Type: String
Length Constraints: Minimum length of 32. Maximum length of 2048.
Pattern: `^arn:aws:iam::[0-9]{12}:role/.*$`
Required: Yes
** [storageLocation](#API_StartTestSetGeneration_RequestSyntax) **
The Amazon S3 storage location for the test set generation.
Type: [TestSetStorageLocation](API_TestSetStorageLocation.md) object
Required: Yes
** [testSetName](#API_StartTestSetGeneration_RequestSyntax) **
The test set name for the test set generation request.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern: `^([0-9a-zA-Z][_-]?){1,100}$`
Required: Yes
** [testSetTags](#API_StartTestSetGeneration_RequestSyntax) **
A list of tags to add to the test set. You can only add tags when you import/generate a new test set. You can't use the `UpdateTestSet` operation to update tags. To update tags, use the `TagResource` operation.
Type: String to string map
Map Entries: Minimum number of 0 items. Maximum number of 200 items.
Key Length Constraints: Minimum length of 1. Maximum length of 128.
Value Length Constraints: Minimum length of 0. Maximum length of 256.
Required: No
## Response Syntax
```
HTTP/1.1 202
Content-type: application/json
{
"creationDateTime": number,
"description": "string",
"generationDataSource": {
"conversationLogsDataSource": {
"botAliasId": "string",
"botId": "string",
"filter": {
"endTime": number,
"inputMode": "string",
"startTime": number
},
"localeId": "string"
}
},
"roleArn": "string",
"storageLocation": {
"kmsKeyArn": "string",
"s3BucketName": "string",
"s3Path": "string"
},
"testSetGenerationId": "string",
"testSetGenerationStatus": "string",
"testSetName": "string",
"testSetTags": {
"string" : "string"
}
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 202 response.
The following data is returned in JSON format by the service.
** [creationDateTime](#API_StartTestSetGeneration_ResponseSyntax) **
The creation date and time for the test set generation.
Type: Timestamp
** [description](#API_StartTestSetGeneration_ResponseSyntax) **
The description used for the test set generation.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 2000.
** [generationDataSource](#API_StartTestSetGeneration_ResponseSyntax) **
The data source for the test set generation.
Type: [TestSetGenerationDataSource](API_TestSetGenerationDataSource.md) object
** [roleArn](#API_StartTestSetGeneration_ResponseSyntax) **
The roleARN used for any operation in the test set to access resources in the AWS account.
Type: String
Length Constraints: Minimum length of 32. Maximum length of 2048.
Pattern: `^arn:aws:iam::[0-9]{12}:role/.*$`
** [storageLocation](#API_StartTestSetGeneration_ResponseSyntax) **
The Amazon S3 storage location for the test set generation.
Type: [TestSetStorageLocation](API_TestSetStorageLocation.md) object
** [testSetGenerationId](#API_StartTestSetGeneration_ResponseSyntax) **
The unique identifier of the test set generation to describe.
Type: String
Length Constraints: Fixed length of 10.
Pattern: `^[0-9a-zA-Z]+$`
** [testSetGenerationStatus](#API_StartTestSetGeneration_ResponseSyntax) **
The status for the test set generation.
Type: String
Valid Values: `Generating | Ready | Failed | Pending`
** [testSetName](#API_StartTestSetGeneration_ResponseSyntax) **
The test set name used for the test set generation.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern: `^([0-9a-zA-Z][_-]?){1,100}$`
** [testSetTags](#API_StartTestSetGeneration_ResponseSyntax) **
A list of tags that was used for the test set that is being generated.
Type: String to string map
Map Entries: Minimum number of 0 items. Maximum number of 200 items.
Key Length Constraints: Minimum length of 1. Maximum length of 128.
Value Length Constraints: Minimum length of 0. Maximum length of 256.
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** ConflictException **
The action that you tried to perform couldn't be completed because the resource is in a conflicting state. For example, deleting a bot that is in the CREATING state. Try your request again.
HTTP Status Code: 409
** InternalServerException **
The service encountered an unexpected condition. Try your request again.
HTTP Status Code: 500
** ResourceNotFoundException **
You asked to describe a resource that doesn't exist. Check the resource that you are requesting and try again.
HTTP Status Code: 404
** ServiceQuotaExceededException **
You have reached a quota for your bot.
HTTP Status Code: 402
** ThrottlingException **
Your request rate is too high. Reduce the frequency of requests.
** retryAfterSeconds **
The number of seconds after which the user can invoke the API again.
HTTP Status Code: 429
** ValidationException **
One of the input parameters in your request isn't valid. Check the parameters and try your request again.
HTTP Status Code: 400
## See Also
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/models.lex.v2-2020-08-07/StartTestSetGeneration)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/models.lex.v2-2020-08-07/StartTestSetGeneration)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/StartTestSetGeneration)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/models.lex.v2-2020-08-07/StartTestSetGeneration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/StartTestSetGeneration)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/models.lex.v2-2020-08-07/StartTestSetGeneration)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/models.lex.v2-2020-08-07/StartTestSetGeneration)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/models.lex.v2-2020-08-07/StartTestSetGeneration)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/models.lex.v2-2020-08-07/StartTestSetGeneration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/StartTestSetGeneration)
# StopBotAnalyzer
Cancels an ongoing bot analysis execution. Once stopped, the analysis cannot be resumed and no recommendations will be generated.
## Request Syntax
```
PUT /bots/botId/botanalyzer/botAnalyzerRequestId/stop/ HTTP/1.1
```
## URI Request Parameters
The request uses the following URI parameters.
** [botAnalyzerRequestId](#API_StopBotAnalyzer_RequestSyntax) **
The unique identifier of the analysis request to stop.
Length Constraints: Fixed length of 36.
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}`
Required: Yes
** [botId](#API_StopBotAnalyzer_RequestSyntax) **
The unique identifier of the bot.
Length Constraints: Fixed length of 10.
Pattern: `^[0-9a-zA-Z]+$`
Required: Yes
## Request Body
The request does not have a request body.
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"botAnalyzerRequestId": "string",
"botAnalyzerStatus": "string",
"botId": "string",
"botVersion": "string",
"localeId": "string"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [botAnalyzerRequestId](#API_StopBotAnalyzer_ResponseSyntax) **
The unique identifier of the analysis request.
Type: String
Length Constraints: Fixed length of 36.
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}`
** [botAnalyzerStatus](#API_StopBotAnalyzer_ResponseSyntax) **
The updated status of the analysis. The status will be `Stopping` and will eventually transition to `Stopped`.
Valid Values: `Processing | Available | Failed | Stopping | Stopped`
Type: String
Valid Values: `Processing | Available | Failed | Stopping | Stopped`
** [botId](#API_StopBotAnalyzer_ResponseSyntax) **
The unique identifier of the bot.
Type: String
Length Constraints: Fixed length of 10.
Pattern: `^[0-9a-zA-Z]+$`
** [botVersion](#API_StopBotAnalyzer_ResponseSyntax) **
The version of the bot.
Type: String
Length Constraints: Fixed length of 5.
Pattern: `^DRAFT$`
** [localeId](#API_StopBotAnalyzer_ResponseSyntax) **
The locale identifier of the bot locale.
Type: String
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** InternalServerException **
The service encountered an unexpected condition. Try your request again.
HTTP Status Code: 500
** ResourceNotFoundException **
You asked to describe a resource that doesn't exist. Check the resource that you are requesting and try again.
HTTP Status Code: 404
** ThrottlingException **
Your request rate is too high. Reduce the frequency of requests.
** retryAfterSeconds **
The number of seconds after which the user can invoke the API again.
HTTP Status Code: 429
** ValidationException **
One of the input parameters in your request isn't valid. Check the parameters and try your request again.
HTTP Status Code: 400
## Examples
### Example request
This example illustrates one usage of StopBotAnalyzer.
```
PUT https://models-v2-lex.us-east-1.amazonaws.com/bots//botanalyzer//stop/
```
### Example response
This example illustrates one usage of StopBotAnalyzer.
```
{
"botId": "",
"botVersion": "DRAFT",
"localeId": "en_US",
"botAnalyzerStatus": "Stopping",
"botAnalyzerRequestId": ""
}
```
## See Also
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/models.lex.v2-2020-08-07/StopBotAnalyzer)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/models.lex.v2-2020-08-07/StopBotAnalyzer)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/StopBotAnalyzer)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/models.lex.v2-2020-08-07/StopBotAnalyzer)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/StopBotAnalyzer)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/models.lex.v2-2020-08-07/StopBotAnalyzer)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/models.lex.v2-2020-08-07/StopBotAnalyzer)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/models.lex.v2-2020-08-07/StopBotAnalyzer)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/models.lex.v2-2020-08-07/StopBotAnalyzer)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/StopBotAnalyzer)
# StopBotRecommendation
Stop an already running Bot Recommendation request.
## Request Syntax
```
PUT /bots/botId/botversions/botVersion/botlocales/localeId/botrecommendations/botRecommendationId/stopbotrecommendation HTTP/1.1
```
## URI Request Parameters
The request uses the following URI parameters.
** [botId](#API_StopBotRecommendation_RequestSyntax) **
The unique identifier of the bot containing the bot recommendation to be stopped.
Length Constraints: Fixed length of 10.
Pattern: `^[0-9a-zA-Z]+$`
Required: Yes
** [botRecommendationId](#API_StopBotRecommendation_RequestSyntax) **
The unique identifier of the bot recommendation to be stopped.
Length Constraints: Fixed length of 10.
Pattern: `^[0-9a-zA-Z]+$`
Required: Yes
** [botVersion](#API_StopBotRecommendation_RequestSyntax) **
The version of the bot containing the bot recommendation.
Length Constraints: Fixed length of 5.
Pattern: `^DRAFT$`
Required: Yes
** [localeId](#API_StopBotRecommendation_RequestSyntax) **
The identifier of the language and locale of the bot recommendation to stop. The string must match one of the supported locales. For more information, see [Supported languages](https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html)
Required: Yes
## Request Body
The request does not have a request body.
## Response Syntax
```
HTTP/1.1 202
Content-type: application/json
{
"botId": "string",
"botRecommendationId": "string",
"botRecommendationStatus": "string",
"botVersion": "string",
"localeId": "string"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 202 response.
The following data is returned in JSON format by the service.
** [botId](#API_StopBotRecommendation_ResponseSyntax) **
The unique identifier of the bot containing the bot recommendation that is being stopped.
Type: String
Length Constraints: Fixed length of 10.
Pattern: `^[0-9a-zA-Z]+$`
** [botRecommendationId](#API_StopBotRecommendation_ResponseSyntax) **
The unique identifier of the bot recommendation that is being stopped.
Type: String
Length Constraints: Fixed length of 10.
Pattern: `^[0-9a-zA-Z]+$`
** [botRecommendationStatus](#API_StopBotRecommendation_ResponseSyntax) **
The status of the bot recommendation. If the status is Failed, then the reasons for the failure are listed in the failureReasons field.
Type: String
Valid Values: `Processing | Deleting | Deleted | Downloading | Updating | Available | Failed | Stopping | Stopped`
** [botVersion](#API_StopBotRecommendation_ResponseSyntax) **
The version of the bot containing the recommendation that is being stopped.
Type: String
Length Constraints: Fixed length of 5.
Pattern: `^DRAFT$`
** [localeId](#API_StopBotRecommendation_ResponseSyntax) **
The identifier of the language and locale of the bot response to stop. The string must match one of the supported locales. For more information, see [Supported languages](https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html)
Type: String
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** ConflictException **
The action that you tried to perform couldn't be completed because the resource is in a conflicting state. For example, deleting a bot that is in the CREATING state. Try your request again.
HTTP Status Code: 409
** ConflictException **
The action that you tried to perform couldn't be completed because the resource is in a conflicting state. For example, deleting a bot that is in the CREATING state. Try your request again.
HTTP Status Code: 409
** InternalServerException **
The service encountered an unexpected condition. Try your request again.
HTTP Status Code: 500
** PreconditionFailedException **
Your request couldn't be completed because one or more request fields aren't valid. Check the fields in your request and try again.
HTTP Status Code: 412
** ResourceNotFoundException **
You asked to describe a resource that doesn't exist. Check the resource that you are requesting and try again.
HTTP Status Code: 404
** ServiceQuotaExceededException **
You have reached a quota for your bot.
HTTP Status Code: 402
** ThrottlingException **
Your request rate is too high. Reduce the frequency of requests.
** retryAfterSeconds **
The number of seconds after which the user can invoke the API again.
HTTP Status Code: 429
** ValidationException **
One of the input parameters in your request isn't valid. Check the parameters and try your request again.
HTTP Status Code: 400
## See Also
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/models.lex.v2-2020-08-07/StopBotRecommendation)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/models.lex.v2-2020-08-07/StopBotRecommendation)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/StopBotRecommendation)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/models.lex.v2-2020-08-07/StopBotRecommendation)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/StopBotRecommendation)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/models.lex.v2-2020-08-07/StopBotRecommendation)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/models.lex.v2-2020-08-07/StopBotRecommendation)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/models.lex.v2-2020-08-07/StopBotRecommendation)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/models.lex.v2-2020-08-07/StopBotRecommendation)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/StopBotRecommendation)
# TagResource
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
```
POST /tags/resourceARN HTTP/1.1
Content-type: application/json
{
"tags": {
"string" : "string"
}
}
```
## URI Request Parameters
The request uses the following URI parameters.
** [resourceARN](#API_TagResource_RequestSyntax) **
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
The request accepts the following data in JSON format.
** [tags](#API_TagResource_RequestSyntax) **
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: String to string map
Map Entries: Minimum number of 0 items. Maximum number of 200 items.
Key Length Constraints: Minimum length of 1. Maximum length of 128.
Value Length Constraints: Minimum length of 0. Maximum length of 256.
Required: Yes
## Response Syntax
```
HTTP/1.1 200
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** InternalServerException **
The service encountered an unexpected condition. Try your request again.
HTTP Status Code: 500
** ResourceNotFoundException **
You asked to describe a resource that doesn't exist. Check the resource that you are requesting and try again.
HTTP Status Code: 404
** ThrottlingException **
Your request rate is too high. Reduce the frequency of requests.
** retryAfterSeconds **
The number of seconds after which the user can invoke the API again.
HTTP Status Code: 429
** ValidationException **
One of the input parameters in your request isn't valid. Check the parameters and try your request again.
HTTP Status Code: 400
## See Also
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/models.lex.v2-2020-08-07/TagResource)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/models.lex.v2-2020-08-07/TagResource)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/TagResource)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/models.lex.v2-2020-08-07/TagResource)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/TagResource)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/models.lex.v2-2020-08-07/TagResource)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/models.lex.v2-2020-08-07/TagResource)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/models.lex.v2-2020-08-07/TagResource)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/models.lex.v2-2020-08-07/TagResource)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/TagResource)
# UntagResource
Removes tags from a bot, bot alias, or bot channel.
## Request Syntax
```
DELETE /tags/resourceARN?tagKeys=tagKeys HTTP/1.1
```
## URI Request Parameters
The request uses the following URI parameters.
** [resourceARN](#API_UntagResource_RequestSyntax) **
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 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
The request does not have a request body.
## Response Syntax
```
HTTP/1.1 200
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** InternalServerException **
The service encountered an unexpected condition. Try your request again.
HTTP Status Code: 500
** ResourceNotFoundException **
You asked to describe a resource that doesn't exist. Check the resource that you are requesting and try again.
HTTP Status Code: 404
** ThrottlingException **
Your request rate is too high. Reduce the frequency of requests.
** retryAfterSeconds **
The number of seconds after which the user can invoke the API again.
HTTP Status Code: 429
** ValidationException **
One of the input parameters in your request isn't valid. Check the parameters and try your request again.
HTTP Status Code: 400
## See Also
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/models.lex.v2-2020-08-07/UntagResource)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/models.lex.v2-2020-08-07/UntagResource)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/UntagResource)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/models.lex.v2-2020-08-07/UntagResource)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/UntagResource)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/models.lex.v2-2020-08-07/UntagResource)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/models.lex.v2-2020-08-07/UntagResource)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/models.lex.v2-2020-08-07/UntagResource)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/models.lex.v2-2020-08-07/UntagResource)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/UntagResource)
# UpdateBot
Updates the configuration of an existing bot.
## Request Syntax
```
PUT /bots/botId/ HTTP/1.1
Content-type: application/json
{
"botMembers": [
{
"botMemberAliasId": "string",
"botMemberAliasName": "string",
"botMemberId": "string",
"botMemberName": "string",
"botMemberVersion": "string"
}
],
"botName": "string",
"botType": "string",
"dataPrivacy": {
"childDirected": boolean
},
"description": "string",
"errorLogSettings": {
"enabled": boolean
},
"idleSessionTTLInSeconds": number,
"roleArn": "string"
}
```
## URI Request Parameters
The request uses the following URI parameters.
** [botId](#API_UpdateBot_RequestSyntax) **
The unique identifier of the bot to update. This identifier is returned by the [CreateBot](https://docs.aws.amazon.com/lexv2/latest/APIReference/API_CreateBot.html) operation.
Length Constraints: Fixed length of 10.
Pattern: `^[0-9a-zA-Z]+$`
Required: Yes
## Request Body
The request accepts the following data in JSON format.
** [botMembers](#API_UpdateBot_RequestSyntax) **
The list of bot members in the network associated with the update action.
Type: Array of [BotMember](API_BotMember.md) objects
Array Members: Minimum number of 0 items. Maximum number of 10 items.
Required: No
** [botName](#API_UpdateBot_RequestSyntax) **
The new name of the bot. The name must be unique in the account that creates the bot.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern: `^([0-9a-zA-Z][_-]?){1,100}$`
Required: Yes
** [botType](#API_UpdateBot_RequestSyntax) **
The type of the bot to be updated.
Type: String
Valid Values: `Bot | BotNetwork`
Required: No
** [dataPrivacy](#API_UpdateBot_RequestSyntax) **
Provides information on additional privacy protections Amazon Lex should use with the bot's data.
Type: [DataPrivacy](API_DataPrivacy.md) object
Required: Yes
** [description](#API_UpdateBot_RequestSyntax) **
A description of the bot.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 2000.
Required: No
** [errorLogSettings](#API_UpdateBot_RequestSyntax) **
Allows you to modify how Amazon Lex logs errors during bot interactions, including destinations for error logs and the types of errors to be captured.
Type: [ErrorLogSettings](API_ErrorLogSettings.md) object
Required: No
** [idleSessionTTLInSeconds](#API_UpdateBot_RequestSyntax) **
The time, in seconds, that Amazon Lex should keep information about a user's conversation with the bot.
A user interaction 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.
You can specify between 60 (1 minute) and 86,400 (24 hours) seconds.
Type: Integer
Valid Range: Minimum value of 60. Maximum value of 86400.
Required: Yes
** [roleArn](#API_UpdateBot_RequestSyntax) **
The Amazon Resource Name (ARN) of an IAM role that has permissions to access the bot.
Type: String
Length Constraints: Minimum length of 32. Maximum length of 2048.
Pattern: `^arn:aws:iam::[0-9]{12}:role/.*$`
Required: Yes
## Response Syntax
```
HTTP/1.1 202
Content-type: application/json
{
"botId": "string",
"botMembers": [
{
"botMemberAliasId": "string",
"botMemberAliasName": "string",
"botMemberId": "string",
"botMemberName": "string",
"botMemberVersion": "string"
}
],
"botName": "string",
"botStatus": "string",
"botType": "string",
"creationDateTime": number,
"dataPrivacy": {
"childDirected": boolean
},
"description": "string",
"errorLogSettings": {
"enabled": boolean
},
"idleSessionTTLInSeconds": number,
"lastUpdatedDateTime": number,
"roleArn": "string"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 202 response.
The following data is returned in JSON format by the service.
** [botId](#API_UpdateBot_ResponseSyntax) **
The unique identifier of the bot that was updated.
Type: String
Length Constraints: Fixed length of 10.
Pattern: `^[0-9a-zA-Z]+$`
** [botMembers](#API_UpdateBot_ResponseSyntax) **
The list of bot members in the network that was updated.
Type: Array of [BotMember](API_BotMember.md) objects
Array Members: Minimum number of 0 items. Maximum number of 10 items.
** [botName](#API_UpdateBot_ResponseSyntax) **
The name of the bot after the update.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern: `^([0-9a-zA-Z][_-]?){1,100}$`
** [botStatus](#API_UpdateBot_ResponseSyntax) **
Shows the current status of the bot. The bot is first in the `Creating` status. Once the bot is read for use, it changes to the `Available` status. After the bot is created, you can use the `DRAFT` version of the bot.
Type: String
Valid Values: `Creating | Available | Inactive | Deleting | Failed | Versioning | Importing | Updating`
** [botType](#API_UpdateBot_ResponseSyntax) **
The type of the bot that was updated.
Type: String
Valid Values: `Bot | BotNetwork`
** [creationDateTime](#API_UpdateBot_ResponseSyntax) **
A timestamp of the date and time that the bot was created.
Type: Timestamp
** [dataPrivacy](#API_UpdateBot_ResponseSyntax) **
The data privacy settings for the bot after the update.
Type: [DataPrivacy](API_DataPrivacy.md) object
** [description](#API_UpdateBot_ResponseSyntax) **
The description of the bot after the update.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 2000.
** [errorLogSettings](#API_UpdateBot_ResponseSyntax) **
Settings for managing error logs within the response of an update bot operation.
Type: [ErrorLogSettings](API_ErrorLogSettings.md) object
** [idleSessionTTLInSeconds](#API_UpdateBot_ResponseSyntax) **
The session timeout, in seconds, for the bot after the update.
Type: Integer
Valid Range: Minimum value of 60. Maximum value of 86400.
** [lastUpdatedDateTime](#API_UpdateBot_ResponseSyntax) **
A timestamp of the date and time that the bot was last updated.
Type: Timestamp
** [roleArn](#API_UpdateBot_ResponseSyntax) **
The Amazon Resource Name (ARN) of the IAM role used by the bot after the update.
Type: String
Length Constraints: Minimum length of 32. Maximum length of 2048.
Pattern: `^arn:aws:iam::[0-9]{12}:role/.*$`
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** ConflictException **
The action that you tried to perform couldn't be completed because the resource is in a conflicting state. For example, deleting a bot that is in the CREATING state. Try your request again.
HTTP Status Code: 409
** InternalServerException **
The service encountered an unexpected condition. Try your request again.
HTTP Status Code: 500
** PreconditionFailedException **
Your request couldn't be completed because one or more request fields aren't valid. Check the fields in your request and try again.
HTTP Status Code: 412
** ServiceQuotaExceededException **
You have reached a quota for your bot.
HTTP Status Code: 402
** ThrottlingException **
Your request rate is too high. Reduce the frequency of requests.
** retryAfterSeconds **
The number of seconds after which the user can invoke the API again.
HTTP Status Code: 429
** ValidationException **
One of the input parameters in your request isn't valid. Check the parameters and try your request again.
HTTP Status Code: 400
## See Also
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/models.lex.v2-2020-08-07/UpdateBot)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/models.lex.v2-2020-08-07/UpdateBot)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/UpdateBot)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/models.lex.v2-2020-08-07/UpdateBot)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/UpdateBot)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/models.lex.v2-2020-08-07/UpdateBot)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/models.lex.v2-2020-08-07/UpdateBot)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/models.lex.v2-2020-08-07/UpdateBot)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/models.lex.v2-2020-08-07/UpdateBot)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/UpdateBot)
# UpdateBotAlias
Updates the configuration of an existing bot alias.
## Request Syntax
```
PUT /bots/botId/botaliases/botAliasId/ HTTP/1.1
Content-type: application/json
{
"botAliasLocaleSettings": {
"string" : {
"codeHookSpecification": {
"lambdaCodeHook": {
"codeHookInterfaceVersion": "string",
"lambdaARN": "string"
}
},
"enabled": boolean
}
},
"botAliasName": "string",
"botVersion": "string",
"conversationLogSettings": {
"audioLogSettings": [
{
"destination": {
"s3Bucket": {
"kmsKeyArn": "string",
"logPrefix": "string",
"s3BucketArn": "string"
}
},
"enabled": boolean,
"selectiveLoggingEnabled": boolean
}
],
"textLogSettings": [
{
"destination": {
"cloudWatch": {
"cloudWatchLogGroupArn": "string",
"logPrefix": "string"
}
},
"enabled": boolean,
"selectiveLoggingEnabled": boolean
}
]
},
"description": "string",
"sentimentAnalysisSettings": {
"detectSentiment": boolean
}
}
```
## URI Request Parameters
The request uses the following URI parameters.
** [botAliasId](#API_UpdateBotAlias_RequestSyntax) **
The unique identifier of the bot alias.
Length Constraints: Fixed length of 10.
Pattern: `^(\bTSTALIASID\b|[0-9a-zA-Z]+)$`
Required: Yes
** [botId](#API_UpdateBotAlias_RequestSyntax) **
The identifier of the bot with the updated alias.
Length Constraints: Fixed length of 10.
Pattern: `^[0-9a-zA-Z]+$`
Required: Yes
## Request Body
The request accepts the following data in JSON format.
** [botAliasLocaleSettings](#API_UpdateBotAlias_RequestSyntax) **
The new Lambda functions to use in each locale for the bot alias.
Type: String to [BotAliasLocaleSettings](API_BotAliasLocaleSettings.md) object map
Map Entries: Maximum number of items.
Required: No
** [botAliasName](#API_UpdateBotAlias_RequestSyntax) **
The new name to assign to the bot alias.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern: `^([0-9a-zA-Z][_-]?){1,100}$`
Required: Yes
** [botVersion](#API_UpdateBotAlias_RequestSyntax) **
The new bot version to assign to the bot alias.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 5.
Pattern: `^(DRAFT|[0-9]+)$`
Required: No
** [conversationLogSettings](#API_UpdateBotAlias_RequestSyntax) **
The new settings for storing conversation logs in Amazon CloudWatch Logs and Amazon S3 buckets.
Type: [ConversationLogSettings](API_ConversationLogSettings.md) object
Required: No
** [description](#API_UpdateBotAlias_RequestSyntax) **
The new description to assign to the bot alias.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 2000.
Required: No
** [sentimentAnalysisSettings](#API_UpdateBotAlias_RequestSyntax) **
Determines whether Amazon Lex will use Amazon Comprehend to detect the sentiment of user utterances.
Type: [SentimentAnalysisSettings](API_SentimentAnalysisSettings.md) object
Required: No
## Response Syntax
```
HTTP/1.1 202
Content-type: application/json
{
"botAliasId": "string",
"botAliasLocaleSettings": {
"string" : {
"codeHookSpecification": {
"lambdaCodeHook": {
"codeHookInterfaceVersion": "string",
"lambdaARN": "string"
}
},
"enabled": boolean
}
},
"botAliasName": "string",
"botAliasStatus": "string",
"botId": "string",
"botVersion": "string",
"conversationLogSettings": {
"audioLogSettings": [
{
"destination": {
"s3Bucket": {
"kmsKeyArn": "string",
"logPrefix": "string",
"s3BucketArn": "string"
}
},
"enabled": boolean,
"selectiveLoggingEnabled": boolean
}
],
"textLogSettings": [
{
"destination": {
"cloudWatch": {
"cloudWatchLogGroupArn": "string",
"logPrefix": "string"
}
},
"enabled": boolean,
"selectiveLoggingEnabled": boolean
}
]
},
"creationDateTime": number,
"description": "string",
"lastUpdatedDateTime": number,
"sentimentAnalysisSettings": {
"detectSentiment": boolean
}
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 202 response.
The following data is returned in JSON format by the service.
** [botAliasId](#API_UpdateBotAlias_ResponseSyntax) **
The identifier of the updated bot alias.
Type: String
Length Constraints: Fixed length of 10.
Pattern: `^(\bTSTALIASID\b|[0-9a-zA-Z]+)$`
** [botAliasLocaleSettings](#API_UpdateBotAlias_ResponseSyntax) **
The updated Lambda functions to use in each locale for the bot alias.
Type: String to [BotAliasLocaleSettings](API_BotAliasLocaleSettings.md) object map
Map Entries: Maximum number of items.
** [botAliasName](#API_UpdateBotAlias_ResponseSyntax) **
The updated name of the bot alias.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern: `^([0-9a-zA-Z][_-]?){1,100}$`
** [botAliasStatus](#API_UpdateBotAlias_ResponseSyntax) **
The current status of the bot alias. When the status is `Available` the alias is ready for use.
Type: String
Valid Values: `Creating | Available | Deleting | Failed`
** [botId](#API_UpdateBotAlias_ResponseSyntax) **
The identifier of the bot with the updated alias.
Type: String
Length Constraints: Fixed length of 10.
Pattern: `^[0-9a-zA-Z]+$`
** [botVersion](#API_UpdateBotAlias_ResponseSyntax) **
The updated version of the bot that the alias points to.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 5.
Pattern: `^(DRAFT|[0-9]+)$`
** [conversationLogSettings](#API_UpdateBotAlias_ResponseSyntax) **
The updated settings for storing conversation logs in Amazon CloudWatch Logs and Amazon S3 buckets.
Type: [ConversationLogSettings](API_ConversationLogSettings.md) object
** [creationDateTime](#API_UpdateBotAlias_ResponseSyntax) **
A timestamp of the date and time that the bot was created.
Type: Timestamp
** [description](#API_UpdateBotAlias_ResponseSyntax) **
The updated description of the bot alias.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 2000.
** [lastUpdatedDateTime](#API_UpdateBotAlias_ResponseSyntax) **
A timestamp of the date and time that the bot was last updated.
Type: Timestamp
** [sentimentAnalysisSettings](#API_UpdateBotAlias_ResponseSyntax) **
Determines whether Amazon Lex will use Amazon Comprehend to detect the sentiment of user utterances.
Type: [SentimentAnalysisSettings](API_SentimentAnalysisSettings.md) object
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** ConflictException **
The action that you tried to perform couldn't be completed because the resource is in a conflicting state. For example, deleting a bot that is in the CREATING state. Try your request again.
HTTP Status Code: 409
** InternalServerException **
The service encountered an unexpected condition. Try your request again.
HTTP Status Code: 500
** PreconditionFailedException **
Your request couldn't be completed because one or more request fields aren't valid. Check the fields in your request and try again.
HTTP Status Code: 412
** ServiceQuotaExceededException **
You have reached a quota for your bot.
HTTP Status Code: 402
** ThrottlingException **
Your request rate is too high. Reduce the frequency of requests.
** retryAfterSeconds **
The number of seconds after which the user can invoke the API again.
HTTP Status Code: 429
** ValidationException **
One of the input parameters in your request isn't valid. Check the parameters and try your request again.
HTTP Status Code: 400
## See Also
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/models.lex.v2-2020-08-07/UpdateBotAlias)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/models.lex.v2-2020-08-07/UpdateBotAlias)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/UpdateBotAlias)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/models.lex.v2-2020-08-07/UpdateBotAlias)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/UpdateBotAlias)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/models.lex.v2-2020-08-07/UpdateBotAlias)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/models.lex.v2-2020-08-07/UpdateBotAlias)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/models.lex.v2-2020-08-07/UpdateBotAlias)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/models.lex.v2-2020-08-07/UpdateBotAlias)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/UpdateBotAlias)
# UpdateBotLocale
Updates the settings that a bot has for a specific locale.
## Request Syntax
```
PUT /bots/botId/botversions/botVersion/botlocales/localeId/ HTTP/1.1
Content-type: application/json
{
"description": "string",
"generativeAISettings": {
"buildtimeSettings": {
"descriptiveBotBuilder": {
"bedrockModelSpecification": {
"customPrompt": "string",
"guardrail": {
"identifier": "string",
"version": "string"
},
"modelArn": "string",
"traceStatus": "string"
},
"enabled": boolean
},
"sampleUtteranceGeneration": {
"bedrockModelSpecification": {
"customPrompt": "string",
"guardrail": {
"identifier": "string",
"version": "string"
},
"modelArn": "string",
"traceStatus": "string"
},
"enabled": boolean
}
},
"runtimeSettings": {
"nluImprovement": {
"assistedNluMode": "string",
"enabled": boolean,
"intentDisambiguationSettings": {
"customDisambiguationMessage": "string",
"enabled": boolean,
"maxDisambiguationIntents": number
}
},
"slotResolutionImprovement": {
"bedrockModelSpecification": {
"customPrompt": "string",
"guardrail": {
"identifier": "string",
"version": "string"
},
"modelArn": "string",
"traceStatus": "string"
},
"enabled": boolean
}
}
},
"nluIntentConfidenceThreshold": number,
"speechDetectionSensitivity": "string",
"speechRecognitionSettings": {
"speechModelConfig": {
"deepgramConfig": {
"apiTokenSecretArn": "string",
"modelId": "string"
}
},
"speechModelPreference": "string"
},
"unifiedSpeechSettings": {
"speechFoundationModel": {
"modelArn": "string",
"voiceId": "string"
}
},
"voiceSettings": {
"engine": "string",
"voiceId": "string"
}
}
```
## URI Request Parameters
The request uses the following URI parameters.
** [botId](#API_UpdateBotLocale_RequestSyntax) **
The unique identifier of the bot that contains the locale.
Length Constraints: Fixed length of 10.
Pattern: `^[0-9a-zA-Z]+$`
Required: Yes
** [botVersion](#API_UpdateBotLocale_RequestSyntax) **
The version of the bot that contains the locale to be updated. The version can only be the `DRAFT` version.
Length Constraints: Fixed length of 5.
Pattern: `^DRAFT$`
Required: Yes
** [localeId](#API_UpdateBotLocale_RequestSyntax) **
The identifier of the language and locale to update. The string must match one of the supported locales. For more information, see [Supported languages](https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html).
Required: Yes
## Request Body
The request accepts the following data in JSON format.
** [description](#API_UpdateBotLocale_RequestSyntax) **
The new description of the locale.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 2000.
Required: No
** [generativeAISettings](#API_UpdateBotLocale_RequestSyntax) **
Contains settings for generative AI features powered by Amazon Bedrock for your bot locale. Use this object to turn generative AI features on and off. Pricing may differ if you turn a feature on. For more information, see LINK.
Type: [GenerativeAISettings](API_GenerativeAISettings.md) object
Required: No
** [nluIntentConfidenceThreshold](#API_UpdateBotLocale_RequestSyntax) **
The new confidence threshold where Amazon Lex inserts the `AMAZON.FallbackIntent` and `AMAZON.KendraSearchIntent` intents in the list of possible intents for an utterance.
Type: Double
Valid Range: Minimum value of 0. Maximum value of 1.
Required: Yes
** [speechDetectionSensitivity](#API_UpdateBotLocale_RequestSyntax) **
The new sensitivity level for voice activity detection (VAD) in the bot locale. This setting helps optimize speech recognition accuracy by adjusting how the system responds to background noise during voice interactions.
Type: String
Valid Values: `Default | HighNoiseTolerance | MaximumNoiseTolerance`
Required: No
** [speechRecognitionSettings](#API_UpdateBotLocale_RequestSyntax) **
Updated speech-to-text settings to apply to the bot locale.
Type: [SpeechRecognitionSettings](API_SpeechRecognitionSettings.md) object
Required: No
** [unifiedSpeechSettings](#API_UpdateBotLocale_RequestSyntax) **
Updated unified speech settings to apply to the bot locale.
Type: [UnifiedSpeechSettings](API_UnifiedSpeechSettings.md) object
Required: No
** [voiceSettings](#API_UpdateBotLocale_RequestSyntax) **
The new Amazon Polly voice Amazon Lex should use for voice interaction with the user.
Type: [VoiceSettings](API_VoiceSettings.md) object
Required: No
## Response Syntax
```
HTTP/1.1 202
Content-type: application/json
{
"botId": "string",
"botLocaleStatus": "string",
"botVersion": "string",
"creationDateTime": number,
"description": "string",
"failureReasons": [ "string" ],
"generativeAISettings": {
"buildtimeSettings": {
"descriptiveBotBuilder": {
"bedrockModelSpecification": {
"customPrompt": "string",
"guardrail": {
"identifier": "string",
"version": "string"
},
"modelArn": "string",
"traceStatus": "string"
},
"enabled": boolean
},
"sampleUtteranceGeneration": {
"bedrockModelSpecification": {
"customPrompt": "string",
"guardrail": {
"identifier": "string",
"version": "string"
},
"modelArn": "string",
"traceStatus": "string"
},
"enabled": boolean
}
},
"runtimeSettings": {
"nluImprovement": {
"assistedNluMode": "string",
"enabled": boolean,
"intentDisambiguationSettings": {
"customDisambiguationMessage": "string",
"enabled": boolean,
"maxDisambiguationIntents": number
}
},
"slotResolutionImprovement": {
"bedrockModelSpecification": {
"customPrompt": "string",
"guardrail": {
"identifier": "string",
"version": "string"
},
"modelArn": "string",
"traceStatus": "string"
},
"enabled": boolean
}
}
},
"lastUpdatedDateTime": number,
"localeId": "string",
"localeName": "string",
"nluIntentConfidenceThreshold": number,
"recommendedActions": [ "string" ],
"speechDetectionSensitivity": "string",
"speechRecognitionSettings": {
"speechModelConfig": {
"deepgramConfig": {
"apiTokenSecretArn": "string",
"modelId": "string"
}
},
"speechModelPreference": "string"
},
"unifiedSpeechSettings": {
"speechFoundationModel": {
"modelArn": "string",
"voiceId": "string"
}
},
"voiceSettings": {
"engine": "string",
"voiceId": "string"
}
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 202 response.
The following data is returned in JSON format by the service.
** [botId](#API_UpdateBotLocale_ResponseSyntax) **
The identifier of the bot that contains the updated locale.
Type: String
Length Constraints: Fixed length of 10.
Pattern: `^[0-9a-zA-Z]+$`
** [botLocaleStatus](#API_UpdateBotLocale_ResponseSyntax) **
The current status of the locale. When the bot status is `Built` the locale is ready for use.
Type: String
Valid Values: `Creating | Building | Built | ReadyExpressTesting | Failed | Deleting | NotBuilt | Importing | Processing`
** [botVersion](#API_UpdateBotLocale_ResponseSyntax) **
The version of the bot that contains the updated locale.
Type: String
Length Constraints: Fixed length of 5.
Pattern: `^DRAFT$`
** [creationDateTime](#API_UpdateBotLocale_ResponseSyntax) **
A timestamp of the date and time that the locale was created.
Type: Timestamp
** [description](#API_UpdateBotLocale_ResponseSyntax) **
The updated description of the locale.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 2000.
** [failureReasons](#API_UpdateBotLocale_ResponseSyntax) **
If the `botLocaleStatus` is `Failed`, the `failureReasons` field lists the errors that occurred while building the bot.
Type: Array of strings
** [generativeAISettings](#API_UpdateBotLocale_ResponseSyntax) **
Contains settings for generative AI features powered by Amazon Bedrock for your bot locale.
Type: [GenerativeAISettings](API_GenerativeAISettings.md) object
** [lastUpdatedDateTime](#API_UpdateBotLocale_ResponseSyntax) **
A timestamp of the date and time that the locale was last updated.
Type: Timestamp
** [localeId](#API_UpdateBotLocale_ResponseSyntax) **
The language and locale of the updated bot locale.
Type: String
** [localeName](#API_UpdateBotLocale_ResponseSyntax) **
The updated locale name for the locale.
Type: String
** [nluIntentConfidenceThreshold](#API_UpdateBotLocale_ResponseSyntax) **
The updated confidence threshold for inserting the `AMAZON.FallbackIntent` and `AMAZON.KendraSearchIntent` intents in the list of possible intents for an utterance.
Type: Double
Valid Range: Minimum value of 0. Maximum value of 1.
** [recommendedActions](#API_UpdateBotLocale_ResponseSyntax) **
Recommended actions to take to resolve an error in the `failureReasons` field.
Type: Array of strings
** [speechDetectionSensitivity](#API_UpdateBotLocale_ResponseSyntax) **
The updated sensitivity level for voice activity detection (VAD) in the bot locale.
Type: String
Valid Values: `Default | HighNoiseTolerance | MaximumNoiseTolerance`
** [speechRecognitionSettings](#API_UpdateBotLocale_ResponseSyntax) **
The updated speech-to-text settings for the bot locale.
Type: [SpeechRecognitionSettings](API_SpeechRecognitionSettings.md) object
** [unifiedSpeechSettings](#API_UpdateBotLocale_ResponseSyntax) **
The updated unified speech settings for the bot locale.
Type: [UnifiedSpeechSettings](API_UnifiedSpeechSettings.md) object
** [voiceSettings](#API_UpdateBotLocale_ResponseSyntax) **
The updated Amazon Polly voice to use for voice interaction with the user.
Type: [VoiceSettings](API_VoiceSettings.md) object
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** ConflictException **
The action that you tried to perform couldn't be completed because the resource is in a conflicting state. For example, deleting a bot that is in the CREATING state. Try your request again.
HTTP Status Code: 409
** InternalServerException **
The service encountered an unexpected condition. Try your request again.
HTTP Status Code: 500
** PreconditionFailedException **
Your request couldn't be completed because one or more request fields aren't valid. Check the fields in your request and try again.
HTTP Status Code: 412
** ServiceQuotaExceededException **
You have reached a quota for your bot.
HTTP Status Code: 402
** ThrottlingException **
Your request rate is too high. Reduce the frequency of requests.
** retryAfterSeconds **
The number of seconds after which the user can invoke the API again.
HTTP Status Code: 429
** ValidationException **
One of the input parameters in your request isn't valid. Check the parameters and try your request again.
HTTP Status Code: 400
## See Also
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/models.lex.v2-2020-08-07/UpdateBotLocale)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/models.lex.v2-2020-08-07/UpdateBotLocale)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/UpdateBotLocale)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/models.lex.v2-2020-08-07/UpdateBotLocale)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/UpdateBotLocale)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/models.lex.v2-2020-08-07/UpdateBotLocale)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/models.lex.v2-2020-08-07/UpdateBotLocale)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/models.lex.v2-2020-08-07/UpdateBotLocale)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/models.lex.v2-2020-08-07/UpdateBotLocale)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/UpdateBotLocale)
# UpdateBotRecommendation
Updates an existing bot recommendation request.
## Request Syntax
```
PUT /bots/botId/botversions/botVersion/botlocales/localeId/botrecommendations/botRecommendationId/ HTTP/1.1
Content-type: application/json
{
"encryptionSetting": {
"associatedTranscriptsPassword": "string",
"botLocaleExportPassword": "string",
"kmsKeyArn": "string"
}
}
```
## URI Request Parameters
The request uses the following URI parameters.
** [botId](#API_UpdateBotRecommendation_RequestSyntax) **
The unique identifier of the bot containing the bot recommendation to be updated.
Length Constraints: Fixed length of 10.
Pattern: `^[0-9a-zA-Z]+$`
Required: Yes
** [botRecommendationId](#API_UpdateBotRecommendation_RequestSyntax) **
The unique identifier of the bot recommendation to be updated.
Length Constraints: Fixed length of 10.
Pattern: `^[0-9a-zA-Z]+$`
Required: Yes
** [botVersion](#API_UpdateBotRecommendation_RequestSyntax) **
The version of the bot containing the bot recommendation to be updated.
Length Constraints: Fixed length of 5.
Pattern: `^DRAFT$`
Required: Yes
** [localeId](#API_UpdateBotRecommendation_RequestSyntax) **
The identifier of the language and locale of the bot recommendation to update. The string must match one of the supported locales. For more information, see [Supported languages](https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html)
Required: Yes
## Request Body
The request accepts the following data in JSON format.
** [encryptionSetting](#API_UpdateBotRecommendation_RequestSyntax) **
The object representing the passwords that will be used to encrypt the data related to the bot recommendation results, as well as the AWS KMS key ARN used to encrypt the associated metadata.
Type: [EncryptionSetting](API_EncryptionSetting.md) object
Required: Yes
## Response Syntax
```
HTTP/1.1 202
Content-type: application/json
{
"botId": "string",
"botRecommendationId": "string",
"botRecommendationStatus": "string",
"botVersion": "string",
"creationDateTime": number,
"encryptionSetting": {
"associatedTranscriptsPassword": "string",
"botLocaleExportPassword": "string",
"kmsKeyArn": "string"
},
"lastUpdatedDateTime": number,
"localeId": "string",
"transcriptSourceSetting": {
"s3BucketTranscriptSource": {
"kmsKeyArn": "string",
"pathFormat": {
"objectPrefixes": [ "string" ]
},
"s3BucketName": "string",
"transcriptFilter": {
"lexTranscriptFilter": {
"dateRangeFilter": {
"endDateTime": number,
"startDateTime": number
}
}
},
"transcriptFormat": "string"
}
}
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 202 response.
The following data is returned in JSON format by the service.
** [botId](#API_UpdateBotRecommendation_ResponseSyntax) **
The unique identifier of the bot containing the bot recommendation that has been updated.
Type: String
Length Constraints: Fixed length of 10.
Pattern: `^[0-9a-zA-Z]+$`
** [botRecommendationId](#API_UpdateBotRecommendation_ResponseSyntax) **
The unique identifier of the bot recommendation to be updated.
Type: String
Length Constraints: Fixed length of 10.
Pattern: `^[0-9a-zA-Z]+$`
** [botRecommendationStatus](#API_UpdateBotRecommendation_ResponseSyntax) **
The status of the bot recommendation.
If the status is Failed, then the reasons for the failure are listed in the failureReasons field.
Type: String
Valid Values: `Processing | Deleting | Deleted | Downloading | Updating | Available | Failed | Stopping | Stopped`
** [botVersion](#API_UpdateBotRecommendation_ResponseSyntax) **
The version of the bot containing the bot recommendation that has been updated.
Type: String
Length Constraints: Fixed length of 5.
Pattern: `^DRAFT$`
** [creationDateTime](#API_UpdateBotRecommendation_ResponseSyntax) **
A timestamp of the date and time that the bot recommendation was created.
Type: Timestamp
** [encryptionSetting](#API_UpdateBotRecommendation_ResponseSyntax) **
The object representing the passwords that were used to encrypt the data related to the bot recommendation results, as well as the AWS KMS key ARN used to encrypt the associated metadata.
Type: [EncryptionSetting](API_EncryptionSetting.md) object
** [lastUpdatedDateTime](#API_UpdateBotRecommendation_ResponseSyntax) **
A timestamp of the date and time that the bot recommendation was last updated.
Type: Timestamp
** [localeId](#API_UpdateBotRecommendation_ResponseSyntax) **
The identifier of the language and locale of the bot recommendation to update. The string must match one of the supported locales. For more information, see [Supported languages](https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html)
Type: String
** [transcriptSourceSetting](#API_UpdateBotRecommendation_ResponseSyntax) **
The object representing the Amazon S3 bucket containing the transcript, as well as the associated metadata.
Type: [TranscriptSourceSetting](API_TranscriptSourceSetting.md) object
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** ConflictException **
The action that you tried to perform couldn't be completed because the resource is in a conflicting state. For example, deleting a bot that is in the CREATING state. Try your request again.
HTTP Status Code: 409
** ConflictException **
The action that you tried to perform couldn't be completed because the resource is in a conflicting state. For example, deleting a bot that is in the CREATING state. Try your request again.
HTTP Status Code: 409
** InternalServerException **
The service encountered an unexpected condition. Try your request again.
HTTP Status Code: 500
** PreconditionFailedException **
Your request couldn't be completed because one or more request fields aren't valid. Check the fields in your request and try again.
HTTP Status Code: 412
** ResourceNotFoundException **
You asked to describe a resource that doesn't exist. Check the resource that you are requesting and try again.
HTTP Status Code: 404
** ServiceQuotaExceededException **
You have reached a quota for your bot.
HTTP Status Code: 402
** ThrottlingException **
Your request rate is too high. Reduce the frequency of requests.
** retryAfterSeconds **
The number of seconds after which the user can invoke the API again.
HTTP Status Code: 429
** ValidationException **
One of the input parameters in your request isn't valid. Check the parameters and try your request again.
HTTP Status Code: 400
## See Also
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/models.lex.v2-2020-08-07/UpdateBotRecommendation)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/models.lex.v2-2020-08-07/UpdateBotRecommendation)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/UpdateBotRecommendation)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/models.lex.v2-2020-08-07/UpdateBotRecommendation)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/UpdateBotRecommendation)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/models.lex.v2-2020-08-07/UpdateBotRecommendation)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/models.lex.v2-2020-08-07/UpdateBotRecommendation)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/models.lex.v2-2020-08-07/UpdateBotRecommendation)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/models.lex.v2-2020-08-07/UpdateBotRecommendation)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/UpdateBotRecommendation)
# UpdateExport
Updates the password used to protect an export zip archive.
The password is not required. If you don't supply a password, Amazon Lex generates a zip file that is not protected by a password. This is the archive that is available at the pre-signed S3 URL provided by the [DescribeExport](https://docs.aws.amazon.com/lexv2/latest/APIReference/API_DescribeExport.html) operation.
## Request Syntax
```
PUT /exports/exportId/ HTTP/1.1
Content-type: application/json
{
"filePassword": "string"
}
```
## URI Request Parameters
The request uses the following URI parameters.
** [exportId](#API_UpdateExport_RequestSyntax) **
The unique identifier Amazon Lex assigned to the export.
Length Constraints: Fixed length of 10.
Pattern: `^[0-9a-zA-Z]+$`
Required: Yes
## Request Body
The request accepts the following data in JSON format.
** [filePassword](#API_UpdateExport_RequestSyntax) **
The new password to use to encrypt the export zip archive.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Required: No
## Response Syntax
```
HTTP/1.1 202
Content-type: application/json
{
"creationDateTime": number,
"exportId": "string",
"exportStatus": "string",
"fileFormat": "string",
"lastUpdatedDateTime": number,
"resourceSpecification": {
"botExportSpecification": {
"botId": "string",
"botVersion": "string"
},
"botLocaleExportSpecification": {
"botId": "string",
"botVersion": "string",
"localeId": "string"
},
"customVocabularyExportSpecification": {
"botId": "string",
"botVersion": "string",
"localeId": "string"
},
"testSetExportSpecification": {
"testSetId": "string"
}
}
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 202 response.
The following data is returned in JSON format by the service.
** [creationDateTime](#API_UpdateExport_ResponseSyntax) **
The date and time that the export was created.
Type: Timestamp
** [exportId](#API_UpdateExport_ResponseSyntax) **
The unique identifier Amazon Lex assigned to the export.
Type: String
Length Constraints: Fixed length of 10.
Pattern: `^[0-9a-zA-Z]+$`
** [exportStatus](#API_UpdateExport_ResponseSyntax) **
The status of the export. When the status is `Completed` the export archive is available for download.
Type: String
Valid Values: `InProgress | Completed | Failed | Deleting`
** [fileFormat](#API_UpdateExport_ResponseSyntax) **
The file format used for the files that define the resource. The `TSV` format is required to export a custom vocabulary only; otherwise use `LexJson` format.
Type: String
Valid Values: `LexJson | TSV | CSV`
** [lastUpdatedDateTime](#API_UpdateExport_ResponseSyntax) **
The date and time that the export was last updated.
Type: Timestamp
** [resourceSpecification](#API_UpdateExport_ResponseSyntax) **
A description of the type of resource that was exported, either a bot or a bot locale.
Type: [ExportResourceSpecification](API_ExportResourceSpecification.md) object
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** ConflictException **
The action that you tried to perform couldn't be completed because the resource is in a conflicting state. For example, deleting a bot that is in the CREATING state. Try your request again.
HTTP Status Code: 409
** InternalServerException **
The service encountered an unexpected condition. Try your request again.
HTTP Status Code: 500
** ResourceNotFoundException **
You asked to describe a resource that doesn't exist. Check the resource that you are requesting and try again.
HTTP Status Code: 404
** ServiceQuotaExceededException **
You have reached a quota for your bot.
HTTP Status Code: 402
** ThrottlingException **
Your request rate is too high. Reduce the frequency of requests.
** retryAfterSeconds **
The number of seconds after which the user can invoke the API again.
HTTP Status Code: 429
** ValidationException **
One of the input parameters in your request isn't valid. Check the parameters and try your request again.
HTTP Status Code: 400
## See Also
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/models.lex.v2-2020-08-07/UpdateExport)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/models.lex.v2-2020-08-07/UpdateExport)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/UpdateExport)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/models.lex.v2-2020-08-07/UpdateExport)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/UpdateExport)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/models.lex.v2-2020-08-07/UpdateExport)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/models.lex.v2-2020-08-07/UpdateExport)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/models.lex.v2-2020-08-07/UpdateExport)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/models.lex.v2-2020-08-07/UpdateExport)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/UpdateExport)
# UpdateIntent
Updates the settings for an intent.
## Request Syntax
```
PUT /bots/botId/botversions/botVersion/botlocales/localeId/intents/intentId/ HTTP/1.1
Content-type: application/json
{
"description": "string",
"dialogCodeHook": {
"enabled": boolean
},
"fulfillmentCodeHook": {
"active": boolean,
"enabled": boolean,
"fulfillmentUpdatesSpecification": {
"active": boolean,
"startResponse": {
"allowInterrupt": boolean,
"delayInSeconds": number,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
},
"timeoutInSeconds": number,
"updateResponse": {
"allowInterrupt": boolean,
"frequencyInSeconds": number,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
}
},
"postFulfillmentStatusSpecification": {
"failureConditional": {
"active": boolean,
"conditionalBranches": [
{
"condition": {
"expressionString": "string"
},
"name": "string",
"nextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"response": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
}
}
],
"defaultBranch": {
"nextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"response": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
}
}
},
"failureNextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"failureResponse": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
},
"successConditional": {
"active": boolean,
"conditionalBranches": [
{
"condition": {
"expressionString": "string"
},
"name": "string",
"nextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"response": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
}
}
],
"defaultBranch": {
"nextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"response": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
}
}
},
"successNextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"successResponse": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
},
"timeoutConditional": {
"active": boolean,
"conditionalBranches": [
{
"condition": {
"expressionString": "string"
},
"name": "string",
"nextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"response": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
}
}
],
"defaultBranch": {
"nextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"response": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
}
}
},
"timeoutNextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"timeoutResponse": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
}
}
},
"initialResponseSetting": {
"codeHook": {
"active": boolean,
"enableCodeHookInvocation": boolean,
"invocationLabel": "string",
"postCodeHookSpecification": {
"failureConditional": {
"active": boolean,
"conditionalBranches": [
{
"condition": {
"expressionString": "string"
},
"name": "string",
"nextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"response": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
}
}
],
"defaultBranch": {
"nextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"response": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
}
}
},
"failureNextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"failureResponse": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
},
"successConditional": {
"active": boolean,
"conditionalBranches": [
{
"condition": {
"expressionString": "string"
},
"name": "string",
"nextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"response": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
}
}
],
"defaultBranch": {
"nextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"response": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
}
}
},
"successNextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"successResponse": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
},
"timeoutConditional": {
"active": boolean,
"conditionalBranches": [
{
"condition": {
"expressionString": "string"
},
"name": "string",
"nextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"response": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
}
}
],
"defaultBranch": {
"nextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"response": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
}
}
},
"timeoutNextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"timeoutResponse": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
}
}
},
"conditional": {
"active": boolean,
"conditionalBranches": [
{
"condition": {
"expressionString": "string"
},
"name": "string",
"nextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"response": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
}
}
],
"defaultBranch": {
"nextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"response": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
}
}
},
"initialResponse": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
},
"nextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
}
},
"inputContexts": [
{
"name": "string"
}
],
"intentClosingSetting": {
"active": boolean,
"closingResponse": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
},
"conditional": {
"active": boolean,
"conditionalBranches": [
{
"condition": {
"expressionString": "string"
},
"name": "string",
"nextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"response": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
}
}
],
"defaultBranch": {
"nextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"response": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
}
}
},
"nextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
}
},
"intentConfirmationSetting": {
"active": boolean,
"codeHook": {
"active": boolean,
"enableCodeHookInvocation": boolean,
"invocationLabel": "string",
"postCodeHookSpecification": {
"failureConditional": {
"active": boolean,
"conditionalBranches": [
{
"condition": {
"expressionString": "string"
},
"name": "string",
"nextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"response": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
}
}
],
"defaultBranch": {
"nextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"response": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
}
}
},
"failureNextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"failureResponse": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
},
"successConditional": {
"active": boolean,
"conditionalBranches": [
{
"condition": {
"expressionString": "string"
},
"name": "string",
"nextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"response": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
}
}
],
"defaultBranch": {
"nextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"response": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
}
}
},
"successNextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"successResponse": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
},
"timeoutConditional": {
"active": boolean,
"conditionalBranches": [
{
"condition": {
"expressionString": "string"
},
"name": "string",
"nextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"response": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
}
}
],
"defaultBranch": {
"nextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"response": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
}
}
},
"timeoutNextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"timeoutResponse": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
}
}
},
"confirmationConditional": {
"active": boolean,
"conditionalBranches": [
{
"condition": {
"expressionString": "string"
},
"name": "string",
"nextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"response": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
}
}
],
"defaultBranch": {
"nextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"response": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
}
}
},
"confirmationNextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"confirmationResponse": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
},
"declinationConditional": {
"active": boolean,
"conditionalBranches": [
{
"condition": {
"expressionString": "string"
},
"name": "string",
"nextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"response": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
}
}
],
"defaultBranch": {
"nextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"response": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
}
}
},
"declinationNextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"declinationResponse": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
},
"elicitationCodeHook": {
"enableCodeHookInvocation": boolean,
"invocationLabel": "string"
},
"failureConditional": {
"active": boolean,
"conditionalBranches": [
{
"condition": {
"expressionString": "string"
},
"name": "string",
"nextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"response": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
}
}
],
"defaultBranch": {
"nextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"response": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
}
}
},
"failureNextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"failureResponse": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
},
"promptSpecification": {
"allowInterrupt": boolean,
"maxRetries": number,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
],
"messageSelectionStrategy": "string",
"promptAttemptsSpecification": {
"string" : {
"allowedInputTypes": {
"allowAudioInput": boolean,
"allowDTMFInput": boolean
},
"allowInterrupt": boolean,
"audioAndDTMFInputSpecification": {
"audioSpecification": {
"endTimeoutMs": number,
"maxLengthMs": number
},
"dtmfSpecification": {
"deletionCharacter": "string",
"endCharacter": "string",
"endTimeoutMs": number,
"maxLength": number
},
"startTimeoutMs": number
},
"textInputSpecification": {
"startTimeoutMs": number
}
}
}
}
},
"intentDisplayName": "string",
"intentName": "string",
"kendraConfiguration": {
"kendraIndex": "string",
"queryFilterString": "string",
"queryFilterStringEnabled": boolean
},
"outputContexts": [
{
"name": "string",
"timeToLiveInSeconds": number,
"turnsToLive": number
}
],
"parentIntentSignature": "string",
"qInConnectIntentConfiguration": {
"qInConnectAssistantConfiguration": {
"assistantArn": "string"
}
},
"qnAIntentConfiguration": {
"bedrockModelConfiguration": {
"customPrompt": "string",
"guardrail": {
"identifier": "string",
"version": "string"
},
"modelArn": "string",
"traceStatus": "string"
},
"dataSourceConfiguration": {
"bedrockKnowledgeStoreConfiguration": {
"bedrockKnowledgeBaseArn": "string",
"exactResponse": boolean,
"exactResponseFields": {
"answerField": "string"
}
},
"kendraConfiguration": {
"exactResponse": boolean,
"kendraIndex": "string",
"queryFilterString": "string",
"queryFilterStringEnabled": boolean
},
"opensearchConfiguration": {
"domainEndpoint": "string",
"exactResponse": boolean,
"exactResponseFields": {
"answerField": "string",
"questionField": "string"
},
"includeFields": [ "string" ],
"indexName": "string"
}
}
},
"sampleUtterances": [
{
"utterance": "string"
}
],
"slotPriorities": [
{
"priority": number,
"slotId": "string"
}
]
}
```
## URI Request Parameters
The request uses the following URI parameters.
** [botId](#API_UpdateIntent_RequestSyntax) **
The identifier of the bot that contains the intent.
Length Constraints: Fixed length of 10.
Pattern: `^[0-9a-zA-Z]+$`
Required: Yes
** [botVersion](#API_UpdateIntent_RequestSyntax) **
The version of the bot that contains the intent. Must be `DRAFT`.
Length Constraints: Fixed length of 5.
Pattern: `^DRAFT$`
Required: Yes
** [intentId](#API_UpdateIntent_RequestSyntax) **
The unique identifier of the intent to update.
Length Constraints: Fixed length of 10.
Pattern: `^[0-9a-zA-Z]+$`
Required: Yes
** [localeId](#API_UpdateIntent_RequestSyntax) **
The identifier of the language and locale where this intent is used. The string must match one of the supported locales. For more information, see [Supported languages](https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html).
Required: Yes
## Request Body
The request accepts the following data in JSON format.
** [description](#API_UpdateIntent_RequestSyntax) **
The new description of the intent.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 2000.
Required: No
** [dialogCodeHook](#API_UpdateIntent_RequestSyntax) **
The new Lambda function to use between each turn of the conversation with the bot.
Type: [DialogCodeHookSettings](API_DialogCodeHookSettings.md) object
Required: No
** [fulfillmentCodeHook](#API_UpdateIntent_RequestSyntax) **
The new Lambda function to call when all of the intents required slots are provided and the intent is ready for fulfillment.
Type: [FulfillmentCodeHookSettings](API_FulfillmentCodeHookSettings.md) object
Required: No
** [initialResponseSetting](#API_UpdateIntent_RequestSyntax) **
Configuration settings for a response sent to the user before Amazon Lex starts eliciting slots.
Type: [InitialResponseSetting](API_InitialResponseSetting.md) object
Required: No
** [inputContexts](#API_UpdateIntent_RequestSyntax) **
A new list of contexts that must be active in order for Amazon Lex to consider the intent.
Type: Array of [InputContext](API_InputContext.md) objects
Array Members: Minimum number of 0 items. Maximum number of 5 items.
Required: No
** [intentClosingSetting](#API_UpdateIntent_RequestSyntax) **
The new response that Amazon Lex sends the user when the intent is closed.
Type: [IntentClosingSetting](API_IntentClosingSetting.md) object
Required: No
** [intentConfirmationSetting](#API_UpdateIntent_RequestSyntax) **
New prompts that Amazon Lex sends to the user to confirm the completion of an intent.
Type: [IntentConfirmationSetting](API_IntentConfirmationSetting.md) object
Required: No
** [intentDisplayName](#API_UpdateIntent_RequestSyntax) **
The new display name for the intent.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Required: No
** [intentName](#API_UpdateIntent_RequestSyntax) **
The new name for the intent.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern: `^([0-9a-zA-Z][_-]?){1,100}$`
Required: Yes
** [kendraConfiguration](#API_UpdateIntent_RequestSyntax) **
New configuration settings for connecting to an Amazon Kendra index.
Type: [KendraConfiguration](API_KendraConfiguration.md) object
Required: No
** [outputContexts](#API_UpdateIntent_RequestSyntax) **
A new list of contexts that Amazon Lex 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_UpdateIntent_RequestSyntax) **
The signature of the new built-in intent to use as the parent of this intent.
Type: String
Required: No
** [qInConnectIntentConfiguration](#API_UpdateIntent_RequestSyntax) **
Qinconnect intent configuration details for the update intent request.
Type: [QInConnectIntentConfiguration](API_QInConnectIntentConfiguration.md) object
Required: No
** [qnAIntentConfiguration](#API_UpdateIntent_RequestSyntax) **
Specifies the configuration of the built-in `Amazon.QnAIntent`. The `AMAZON.QnAIntent` intent is called when Amazon Lex can't determine another intent to invoke. If you specify this field, you can't specify the `kendraConfiguration` field.
Type: [QnAIntentConfiguration](API_QnAIntentConfiguration.md) object
Required: No
** [sampleUtterances](#API_UpdateIntent_RequestSyntax) **
New utterances used to invoke the intent.
Type: Array of [SampleUtterance](API_SampleUtterance.md) objects
Required: No
** [slotPriorities](#API_UpdateIntent_RequestSyntax) **
A new list of slots and their priorities that are contained by the intent.
Type: Array of [SlotPriority](API_SlotPriority.md) objects
Required: No
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"botId": "string",
"botVersion": "string",
"creationDateTime": number,
"description": "string",
"dialogCodeHook": {
"enabled": boolean
},
"fulfillmentCodeHook": {
"active": boolean,
"enabled": boolean,
"fulfillmentUpdatesSpecification": {
"active": boolean,
"startResponse": {
"allowInterrupt": boolean,
"delayInSeconds": number,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
},
"timeoutInSeconds": number,
"updateResponse": {
"allowInterrupt": boolean,
"frequencyInSeconds": number,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
}
},
"postFulfillmentStatusSpecification": {
"failureConditional": {
"active": boolean,
"conditionalBranches": [
{
"condition": {
"expressionString": "string"
},
"name": "string",
"nextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"response": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
}
}
],
"defaultBranch": {
"nextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"response": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
}
}
},
"failureNextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"failureResponse": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
},
"successConditional": {
"active": boolean,
"conditionalBranches": [
{
"condition": {
"expressionString": "string"
},
"name": "string",
"nextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"response": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
}
}
],
"defaultBranch": {
"nextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"response": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
}
}
},
"successNextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"successResponse": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
},
"timeoutConditional": {
"active": boolean,
"conditionalBranches": [
{
"condition": {
"expressionString": "string"
},
"name": "string",
"nextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"response": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
}
}
],
"defaultBranch": {
"nextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"response": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
}
}
},
"timeoutNextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"timeoutResponse": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
}
}
},
"initialResponseSetting": {
"codeHook": {
"active": boolean,
"enableCodeHookInvocation": boolean,
"invocationLabel": "string",
"postCodeHookSpecification": {
"failureConditional": {
"active": boolean,
"conditionalBranches": [
{
"condition": {
"expressionString": "string"
},
"name": "string",
"nextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"response": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
}
}
],
"defaultBranch": {
"nextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"response": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
}
}
},
"failureNextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"failureResponse": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
},
"successConditional": {
"active": boolean,
"conditionalBranches": [
{
"condition": {
"expressionString": "string"
},
"name": "string",
"nextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"response": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
}
}
],
"defaultBranch": {
"nextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"response": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
}
}
},
"successNextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"successResponse": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
},
"timeoutConditional": {
"active": boolean,
"conditionalBranches": [
{
"condition": {
"expressionString": "string"
},
"name": "string",
"nextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"response": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
}
}
],
"defaultBranch": {
"nextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"response": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
}
}
},
"timeoutNextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"timeoutResponse": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
}
}
},
"conditional": {
"active": boolean,
"conditionalBranches": [
{
"condition": {
"expressionString": "string"
},
"name": "string",
"nextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"response": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
}
}
],
"defaultBranch": {
"nextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"response": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
}
}
},
"initialResponse": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
},
"nextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
}
},
"inputContexts": [
{
"name": "string"
}
],
"intentClosingSetting": {
"active": boolean,
"closingResponse": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
},
"conditional": {
"active": boolean,
"conditionalBranches": [
{
"condition": {
"expressionString": "string"
},
"name": "string",
"nextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"response": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
}
}
],
"defaultBranch": {
"nextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"response": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
}
}
},
"nextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
}
},
"intentConfirmationSetting": {
"active": boolean,
"codeHook": {
"active": boolean,
"enableCodeHookInvocation": boolean,
"invocationLabel": "string",
"postCodeHookSpecification": {
"failureConditional": {
"active": boolean,
"conditionalBranches": [
{
"condition": {
"expressionString": "string"
},
"name": "string",
"nextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"response": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
}
}
],
"defaultBranch": {
"nextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"response": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
}
}
},
"failureNextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"failureResponse": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
},
"successConditional": {
"active": boolean,
"conditionalBranches": [
{
"condition": {
"expressionString": "string"
},
"name": "string",
"nextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"response": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
}
}
],
"defaultBranch": {
"nextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"response": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
}
}
},
"successNextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"successResponse": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
},
"timeoutConditional": {
"active": boolean,
"conditionalBranches": [
{
"condition": {
"expressionString": "string"
},
"name": "string",
"nextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"response": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
}
}
],
"defaultBranch": {
"nextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"response": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
}
}
},
"timeoutNextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"timeoutResponse": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
}
}
},
"confirmationConditional": {
"active": boolean,
"conditionalBranches": [
{
"condition": {
"expressionString": "string"
},
"name": "string",
"nextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"response": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
}
}
],
"defaultBranch": {
"nextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"response": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
}
}
},
"confirmationNextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"confirmationResponse": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
},
"declinationConditional": {
"active": boolean,
"conditionalBranches": [
{
"condition": {
"expressionString": "string"
},
"name": "string",
"nextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"response": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
}
}
],
"defaultBranch": {
"nextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"response": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
}
}
},
"declinationNextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"declinationResponse": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
},
"elicitationCodeHook": {
"enableCodeHookInvocation": boolean,
"invocationLabel": "string"
},
"failureConditional": {
"active": boolean,
"conditionalBranches": [
{
"condition": {
"expressionString": "string"
},
"name": "string",
"nextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"response": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
}
}
],
"defaultBranch": {
"nextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"response": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
}
}
},
"failureNextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"failureResponse": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
},
"promptSpecification": {
"allowInterrupt": boolean,
"maxRetries": number,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
],
"messageSelectionStrategy": "string",
"promptAttemptsSpecification": {
"string" : {
"allowedInputTypes": {
"allowAudioInput": boolean,
"allowDTMFInput": boolean
},
"allowInterrupt": boolean,
"audioAndDTMFInputSpecification": {
"audioSpecification": {
"endTimeoutMs": number,
"maxLengthMs": number
},
"dtmfSpecification": {
"deletionCharacter": "string",
"endCharacter": "string",
"endTimeoutMs": number,
"maxLength": number
},
"startTimeoutMs": number
},
"textInputSpecification": {
"startTimeoutMs": number
}
}
}
}
},
"intentDisplayName": "string",
"intentId": "string",
"intentName": "string",
"kendraConfiguration": {
"kendraIndex": "string",
"queryFilterString": "string",
"queryFilterStringEnabled": boolean
},
"lastUpdatedDateTime": number,
"localeId": "string",
"outputContexts": [
{
"name": "string",
"timeToLiveInSeconds": number,
"turnsToLive": number
}
],
"parentIntentSignature": "string",
"qInConnectIntentConfiguration": {
"qInConnectAssistantConfiguration": {
"assistantArn": "string"
}
},
"qnAIntentConfiguration": {
"bedrockModelConfiguration": {
"customPrompt": "string",
"guardrail": {
"identifier": "string",
"version": "string"
},
"modelArn": "string",
"traceStatus": "string"
},
"dataSourceConfiguration": {
"bedrockKnowledgeStoreConfiguration": {
"bedrockKnowledgeBaseArn": "string",
"exactResponse": boolean,
"exactResponseFields": {
"answerField": "string"
}
},
"kendraConfiguration": {
"exactResponse": boolean,
"kendraIndex": "string",
"queryFilterString": "string",
"queryFilterStringEnabled": boolean
},
"opensearchConfiguration": {
"domainEndpoint": "string",
"exactResponse": boolean,
"exactResponseFields": {
"answerField": "string",
"questionField": "string"
},
"includeFields": [ "string" ],
"indexName": "string"
}
}
},
"sampleUtterances": [
{
"utterance": "string"
}
],
"slotPriorities": [
{
"priority": number,
"slotId": "string"
}
]
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [botId](#API_UpdateIntent_ResponseSyntax) **
The identifier of the bot that contains the intent.
Type: String
Length Constraints: Fixed length of 10.
Pattern: `^[0-9a-zA-Z]+$`
** [botVersion](#API_UpdateIntent_ResponseSyntax) **
The version of the bot that contains the intent. Will always be `DRAFT`.
Type: String
Length Constraints: Fixed length of 5.
Pattern: `^DRAFT$`
** [creationDateTime](#API_UpdateIntent_ResponseSyntax) **
A timestamp of when the intent was created.
Type: Timestamp
** [description](#API_UpdateIntent_ResponseSyntax) **
The updated description of the intent.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 2000.
** [dialogCodeHook](#API_UpdateIntent_ResponseSyntax) **
The updated Lambda function called during each turn of the conversation with the user.
Type: [DialogCodeHookSettings](API_DialogCodeHookSettings.md) object
** [fulfillmentCodeHook](#API_UpdateIntent_ResponseSyntax) **
The updated Lambda function called when the intent is ready for fulfillment.
Type: [FulfillmentCodeHookSettings](API_FulfillmentCodeHookSettings.md) object
** [initialResponseSetting](#API_UpdateIntent_ResponseSyntax) **
Configuration settings for a response sent to the user before Amazon Lex starts eliciting slots.
Type: [InitialResponseSetting](API_InitialResponseSetting.md) object
** [inputContexts](#API_UpdateIntent_ResponseSyntax) **
The updated list of contexts that must be active for the intent to be considered by Amazon Lex.
Type: Array of [InputContext](API_InputContext.md) objects
Array Members: Minimum number of 0 items. Maximum number of 5 items.
** [intentClosingSetting](#API_UpdateIntent_ResponseSyntax) **
The updated response that Amazon Lex sends the user when the intent is closed.
Type: [IntentClosingSetting](API_IntentClosingSetting.md) object
** [intentConfirmationSetting](#API_UpdateIntent_ResponseSyntax) **
The updated prompts that Amazon Lex sends to the user to confirm the completion of an intent.
Type: [IntentConfirmationSetting](API_IntentConfirmationSetting.md) object
** [intentDisplayName](#API_UpdateIntent_ResponseSyntax) **
The updated display name of the intent.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
** [intentId](#API_UpdateIntent_ResponseSyntax) **
The identifier of the intent that was updated.
Type: String
Length Constraints: Fixed length of 10.
Pattern: `^[0-9a-zA-Z]+$`
** [intentName](#API_UpdateIntent_ResponseSyntax) **
The updated name of the intent.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern: `^([0-9a-zA-Z][_-]?){1,100}$`
** [kendraConfiguration](#API_UpdateIntent_ResponseSyntax) **
The updated configuration for connecting to an Amazon Kendra index with the `AMAZON.KendraSearchIntent` intent.
Type: [KendraConfiguration](API_KendraConfiguration.md) object
** [lastUpdatedDateTime](#API_UpdateIntent_ResponseSyntax) **
A timestamp of the last time that the intent was modified.
Type: Timestamp
** [localeId](#API_UpdateIntent_ResponseSyntax) **
The updated language and locale of the intent.
Type: String
** [outputContexts](#API_UpdateIntent_ResponseSyntax) **
The updated list of contexts that Amazon Lex 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_UpdateIntent_ResponseSyntax) **
The updated built-in intent that is the parent of this intent.
Type: String
** [qInConnectIntentConfiguration](#API_UpdateIntent_ResponseSyntax) **
Qinconnect intent configuration details for the update intent response.
Type: [QInConnectIntentConfiguration](API_QInConnectIntentConfiguration.md) object
** [qnAIntentConfiguration](#API_UpdateIntent_ResponseSyntax) **
Details about the configuration of the built-in `Amazon.QnAIntent`.
Type: [QnAIntentConfiguration](API_QnAIntentConfiguration.md) object
** [sampleUtterances](#API_UpdateIntent_ResponseSyntax) **
The updated list of sample utterances for the intent.
Type: Array of [SampleUtterance](API_SampleUtterance.md) objects
** [slotPriorities](#API_UpdateIntent_ResponseSyntax) **
The updated list of slots and their priorities that are elicited from the user for the intent.
Type: Array of [SlotPriority](API_SlotPriority.md) objects
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** ConflictException **
The action that you tried to perform couldn't be completed because the resource is in a conflicting state. For example, deleting a bot that is in the CREATING state. Try your request again.
HTTP Status Code: 409
** InternalServerException **
The service encountered an unexpected condition. Try your request again.
HTTP Status Code: 500
** PreconditionFailedException **
Your request couldn't be completed because one or more request fields aren't valid. Check the fields in your request and try again.
HTTP Status Code: 412
** ServiceQuotaExceededException **
You have reached a quota for your bot.
HTTP Status Code: 402
** ThrottlingException **
Your request rate is too high. Reduce the frequency of requests.
** retryAfterSeconds **
The number of seconds after which the user can invoke the API again.
HTTP Status Code: 429
** ValidationException **
One of the input parameters in your request isn't valid. Check the parameters and try your request again.
HTTP Status Code: 400
## See Also
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/models.lex.v2-2020-08-07/UpdateIntent)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/models.lex.v2-2020-08-07/UpdateIntent)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/UpdateIntent)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/models.lex.v2-2020-08-07/UpdateIntent)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/UpdateIntent)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/models.lex.v2-2020-08-07/UpdateIntent)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/models.lex.v2-2020-08-07/UpdateIntent)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/models.lex.v2-2020-08-07/UpdateIntent)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/models.lex.v2-2020-08-07/UpdateIntent)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/UpdateIntent)
# UpdateResourcePolicy
Replaces the existing resource policy for a bot or bot alias with a new one. If the policy doesn't exist, Amazon Lex returns an exception.
## Request Syntax
```
PUT /policy/resourceArn/?expectedRevisionId=expectedRevisionId HTTP/1.1
Content-type: application/json
{
"policy": "string"
}
```
## URI Request Parameters
The request uses the following URI parameters.
** [expectedRevisionId](#API_UpdateResourcePolicy_RequestSyntax) **
The identifier of the revision of the policy to update. If this revision ID doesn't match the current revision ID, Amazon Lex throws an exception.
If you don't specify a revision, Amazon Lex overwrites the contents of the policy with the new values.
Length Constraints: Minimum length of 1. Maximum length of 5.
Pattern: `^[0-9]+$`
** [resourceArn](#API_UpdateResourcePolicy_RequestSyntax) **
The Amazon Resource Name (ARN) of the bot or bot alias that the resource policy is attached to.
Length Constraints: Minimum length of 1. Maximum length of 1011.
Required: Yes
## Request Body
The request accepts the following data in JSON format.
** [policy](#API_UpdateResourcePolicy_RequestSyntax) **
A resource policy to add to the resource. The policy is a JSON structure that contains one or more statements that define the policy. The policy must follow the IAM syntax. For more information about the contents of a JSON policy document, see [ IAM JSON policy reference ](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies.html).
If the policy isn't valid, Amazon Lex returns a validation exception.
Type: String
Length Constraints: Minimum length of 2.
Required: Yes
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"resourceArn": "string",
"revisionId": "string"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [resourceArn](#API_UpdateResourcePolicy_ResponseSyntax) **
The Amazon Resource Name (ARN) of the bot or bot alias that the resource policy is attached to.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1011.
** [revisionId](#API_UpdateResourcePolicy_ResponseSyntax) **
The current revision of the resource policy. Use the revision ID to make sure that you are updating the most current version of a resource policy when you add a policy statement to a resource, delete a resource, or update a resource.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 5.
Pattern: `^[0-9]+$`
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** InternalServerException **
The service encountered an unexpected condition. Try your request again.
HTTP Status Code: 500
** PreconditionFailedException **
Your request couldn't be completed because one or more request fields aren't valid. Check the fields in your request and try again.
HTTP Status Code: 412
** ResourceNotFoundException **
You asked to describe a resource that doesn't exist. Check the resource that you are requesting and try again.
HTTP Status Code: 404
** ServiceQuotaExceededException **
You have reached a quota for your bot.
HTTP Status Code: 402
** ThrottlingException **
Your request rate is too high. Reduce the frequency of requests.
** retryAfterSeconds **
The number of seconds after which the user can invoke the API again.
HTTP Status Code: 429
** ValidationException **
One of the input parameters in your request isn't valid. Check the parameters and try your request again.
HTTP Status Code: 400
## See Also
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/models.lex.v2-2020-08-07/UpdateResourcePolicy)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/models.lex.v2-2020-08-07/UpdateResourcePolicy)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/UpdateResourcePolicy)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/models.lex.v2-2020-08-07/UpdateResourcePolicy)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/UpdateResourcePolicy)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/models.lex.v2-2020-08-07/UpdateResourcePolicy)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/models.lex.v2-2020-08-07/UpdateResourcePolicy)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/models.lex.v2-2020-08-07/UpdateResourcePolicy)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/models.lex.v2-2020-08-07/UpdateResourcePolicy)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/UpdateResourcePolicy)
# UpdateSlot
Updates the settings for a slot.
## Request Syntax
```
PUT /bots/botId/botversions/botVersion/botlocales/localeId/intents/intentId/slots/slotId/ HTTP/1.1
Content-type: application/json
{
"description": "string",
"multipleValuesSetting": {
"allowMultipleValues": boolean
},
"obfuscationSetting": {
"obfuscationSettingType": "string"
},
"slotName": "string",
"slotTypeId": "string",
"subSlotSetting": {
"expression": "string",
"slotSpecifications": {
"string" : {
"slotTypeId": "string",
"valueElicitationSetting": {
"defaultValueSpecification": {
"defaultValueList": [
{
"defaultValue": "string"
}
]
},
"promptSpecification": {
"allowInterrupt": boolean,
"maxRetries": number,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
],
"messageSelectionStrategy": "string",
"promptAttemptsSpecification": {
"string" : {
"allowedInputTypes": {
"allowAudioInput": boolean,
"allowDTMFInput": boolean
},
"allowInterrupt": boolean,
"audioAndDTMFInputSpecification": {
"audioSpecification": {
"endTimeoutMs": number,
"maxLengthMs": number
},
"dtmfSpecification": {
"deletionCharacter": "string",
"endCharacter": "string",
"endTimeoutMs": number,
"maxLength": number
},
"startTimeoutMs": number
},
"textInputSpecification": {
"startTimeoutMs": number
}
}
}
},
"sampleUtterances": [
{
"utterance": "string"
}
],
"waitAndContinueSpecification": {
"active": boolean,
"continueResponse": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
},
"stillWaitingResponse": {
"allowInterrupt": boolean,
"frequencyInSeconds": number,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
],
"timeoutInSeconds": number
},
"waitingResponse": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
}
}
}
}
}
},
"valueElicitationSetting": {
"defaultValueSpecification": {
"defaultValueList": [
{
"defaultValue": "string"
}
]
},
"promptSpecification": {
"allowInterrupt": boolean,
"maxRetries": number,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
],
"messageSelectionStrategy": "string",
"promptAttemptsSpecification": {
"string" : {
"allowedInputTypes": {
"allowAudioInput": boolean,
"allowDTMFInput": boolean
},
"allowInterrupt": boolean,
"audioAndDTMFInputSpecification": {
"audioSpecification": {
"endTimeoutMs": number,
"maxLengthMs": number
},
"dtmfSpecification": {
"deletionCharacter": "string",
"endCharacter": "string",
"endTimeoutMs": number,
"maxLength": number
},
"startTimeoutMs": number
},
"textInputSpecification": {
"startTimeoutMs": number
}
}
}
},
"sampleUtterances": [
{
"utterance": "string"
}
],
"slotCaptureSetting": {
"captureConditional": {
"active": boolean,
"conditionalBranches": [
{
"condition": {
"expressionString": "string"
},
"name": "string",
"nextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"response": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
}
}
],
"defaultBranch": {
"nextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"response": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
}
}
},
"captureNextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"captureResponse": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
},
"codeHook": {
"active": boolean,
"enableCodeHookInvocation": boolean,
"invocationLabel": "string",
"postCodeHookSpecification": {
"failureConditional": {
"active": boolean,
"conditionalBranches": [
{
"condition": {
"expressionString": "string"
},
"name": "string",
"nextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"response": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
}
}
],
"defaultBranch": {
"nextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"response": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
}
}
},
"failureNextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"failureResponse": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
},
"successConditional": {
"active": boolean,
"conditionalBranches": [
{
"condition": {
"expressionString": "string"
},
"name": "string",
"nextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"response": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
}
}
],
"defaultBranch": {
"nextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"response": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
}
}
},
"successNextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"successResponse": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
},
"timeoutConditional": {
"active": boolean,
"conditionalBranches": [
{
"condition": {
"expressionString": "string"
},
"name": "string",
"nextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"response": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
}
}
],
"defaultBranch": {
"nextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"response": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
}
}
},
"timeoutNextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"timeoutResponse": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
}
}
},
"elicitationCodeHook": {
"enableCodeHookInvocation": boolean,
"invocationLabel": "string"
},
"failureConditional": {
"active": boolean,
"conditionalBranches": [
{
"condition": {
"expressionString": "string"
},
"name": "string",
"nextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"response": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
}
}
],
"defaultBranch": {
"nextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"response": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
}
}
},
"failureNextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"failureResponse": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
}
},
"slotConstraint": "string",
"slotResolutionSetting": {
"slotResolutionStrategy": "string"
},
"waitAndContinueSpecification": {
"active": boolean,
"continueResponse": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
},
"stillWaitingResponse": {
"allowInterrupt": boolean,
"frequencyInSeconds": number,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
],
"timeoutInSeconds": number
},
"waitingResponse": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
}
}
}
}
```
## URI Request Parameters
The request uses the following URI parameters.
** [botId](#API_UpdateSlot_RequestSyntax) **
The unique identifier of the bot that contains the slot.
Length Constraints: Fixed length of 10.
Pattern: `^[0-9a-zA-Z]+$`
Required: Yes
** [botVersion](#API_UpdateSlot_RequestSyntax) **
The version of the bot that contains the slot. Must always be `DRAFT`.
Length Constraints: Fixed length of 5.
Pattern: `^DRAFT$`
Required: Yes
** [intentId](#API_UpdateSlot_RequestSyntax) **
The identifier of the intent that contains the slot.
Length Constraints: Fixed length of 10.
Pattern: `^[0-9a-zA-Z]+$`
Required: Yes
** [localeId](#API_UpdateSlot_RequestSyntax) **
The identifier of the language and locale that contains the slot. The string must match one of the supported locales. For more information, see [Supported languages](https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html).
Required: Yes
** [slotId](#API_UpdateSlot_RequestSyntax) **
The unique identifier for the slot to update.
Length Constraints: Fixed length of 10.
Pattern: `^[0-9a-zA-Z]+$`
Required: Yes
## Request Body
The request accepts the following data in JSON format.
** [description](#API_UpdateSlot_RequestSyntax) **
The new description for the slot.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 2000.
Required: No
** [multipleValuesSetting](#API_UpdateSlot_RequestSyntax) **
Determines whether the slot accepts multiple values in one response. Multiple value slots are only available in the en-US locale. If you set this value to `true` in any other locale, Amazon Lex throws a `ValidationException`.
If the `multipleValuesSetting` is not set, the default value is `false`.
Type: [MultipleValuesSetting](API_MultipleValuesSetting.md) object
Required: No
** [obfuscationSetting](#API_UpdateSlot_RequestSyntax) **
New settings that determine how slot values are formatted in Amazon CloudWatch logs.
Type: [ObfuscationSetting](API_ObfuscationSetting.md) object
Required: No
** [slotName](#API_UpdateSlot_RequestSyntax) **
The new name for the slot.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern: `^([0-9a-zA-Z][_-]?){1,100}$`
Required: Yes
** [slotTypeId](#API_UpdateSlot_RequestSyntax) **
The unique identifier of the new slot type to associate with this slot.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 25.
Pattern: `^((AMAZON\.)[a-zA-Z_]+?|[0-9a-zA-Z]+)$`
Required: No
** [subSlotSetting](#API_UpdateSlot_RequestSyntax) **
Specifications for the constituent sub slots and the expression for the composite slot.
Type: [SubSlotSetting](API_SubSlotSetting.md) object
Required: No
** [valueElicitationSetting](#API_UpdateSlot_RequestSyntax) **
A new set of prompts that Amazon Lex sends to the user to elicit a response the provides a value for the slot.
Type: [SlotValueElicitationSetting](API_SlotValueElicitationSetting.md) object
Required: Yes
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"botId": "string",
"botVersion": "string",
"creationDateTime": number,
"description": "string",
"intentId": "string",
"lastUpdatedDateTime": number,
"localeId": "string",
"multipleValuesSetting": {
"allowMultipleValues": boolean
},
"obfuscationSetting": {
"obfuscationSettingType": "string"
},
"slotId": "string",
"slotName": "string",
"slotTypeId": "string",
"subSlotSetting": {
"expression": "string",
"slotSpecifications": {
"string" : {
"slotTypeId": "string",
"valueElicitationSetting": {
"defaultValueSpecification": {
"defaultValueList": [
{
"defaultValue": "string"
}
]
},
"promptSpecification": {
"allowInterrupt": boolean,
"maxRetries": number,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
],
"messageSelectionStrategy": "string",
"promptAttemptsSpecification": {
"string" : {
"allowedInputTypes": {
"allowAudioInput": boolean,
"allowDTMFInput": boolean
},
"allowInterrupt": boolean,
"audioAndDTMFInputSpecification": {
"audioSpecification": {
"endTimeoutMs": number,
"maxLengthMs": number
},
"dtmfSpecification": {
"deletionCharacter": "string",
"endCharacter": "string",
"endTimeoutMs": number,
"maxLength": number
},
"startTimeoutMs": number
},
"textInputSpecification": {
"startTimeoutMs": number
}
}
}
},
"sampleUtterances": [
{
"utterance": "string"
}
],
"waitAndContinueSpecification": {
"active": boolean,
"continueResponse": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
},
"stillWaitingResponse": {
"allowInterrupt": boolean,
"frequencyInSeconds": number,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
],
"timeoutInSeconds": number
},
"waitingResponse": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
}
}
}
}
}
},
"valueElicitationSetting": {
"defaultValueSpecification": {
"defaultValueList": [
{
"defaultValue": "string"
}
]
},
"promptSpecification": {
"allowInterrupt": boolean,
"maxRetries": number,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
],
"messageSelectionStrategy": "string",
"promptAttemptsSpecification": {
"string" : {
"allowedInputTypes": {
"allowAudioInput": boolean,
"allowDTMFInput": boolean
},
"allowInterrupt": boolean,
"audioAndDTMFInputSpecification": {
"audioSpecification": {
"endTimeoutMs": number,
"maxLengthMs": number
},
"dtmfSpecification": {
"deletionCharacter": "string",
"endCharacter": "string",
"endTimeoutMs": number,
"maxLength": number
},
"startTimeoutMs": number
},
"textInputSpecification": {
"startTimeoutMs": number
}
}
}
},
"sampleUtterances": [
{
"utterance": "string"
}
],
"slotCaptureSetting": {
"captureConditional": {
"active": boolean,
"conditionalBranches": [
{
"condition": {
"expressionString": "string"
},
"name": "string",
"nextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"response": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
}
}
],
"defaultBranch": {
"nextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"response": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
}
}
},
"captureNextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"captureResponse": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
},
"codeHook": {
"active": boolean,
"enableCodeHookInvocation": boolean,
"invocationLabel": "string",
"postCodeHookSpecification": {
"failureConditional": {
"active": boolean,
"conditionalBranches": [
{
"condition": {
"expressionString": "string"
},
"name": "string",
"nextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"response": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
}
}
],
"defaultBranch": {
"nextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"response": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
}
}
},
"failureNextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"failureResponse": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
},
"successConditional": {
"active": boolean,
"conditionalBranches": [
{
"condition": {
"expressionString": "string"
},
"name": "string",
"nextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"response": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
}
}
],
"defaultBranch": {
"nextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"response": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
}
}
},
"successNextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"successResponse": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
},
"timeoutConditional": {
"active": boolean,
"conditionalBranches": [
{
"condition": {
"expressionString": "string"
},
"name": "string",
"nextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"response": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
}
}
],
"defaultBranch": {
"nextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"response": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
}
}
},
"timeoutNextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"timeoutResponse": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
}
}
},
"elicitationCodeHook": {
"enableCodeHookInvocation": boolean,
"invocationLabel": "string"
},
"failureConditional": {
"active": boolean,
"conditionalBranches": [
{
"condition": {
"expressionString": "string"
},
"name": "string",
"nextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"response": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
}
}
],
"defaultBranch": {
"nextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"response": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
}
}
},
"failureNextStep": {
"dialogAction": {
"slotToElicit": "string",
"suppressNextMessage": boolean,
"type": "string"
},
"intent": {
"name": "string",
"slots": {
"string" : {
"shape": "string",
"value": {
"interpretedValue": "string"
},
"values": [
"SlotValueOverride"
]
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"failureResponse": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
}
},
"slotConstraint": "string",
"slotResolutionSetting": {
"slotResolutionStrategy": "string"
},
"waitAndContinueSpecification": {
"active": boolean,
"continueResponse": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
},
"stillWaitingResponse": {
"allowInterrupt": boolean,
"frequencyInSeconds": number,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
],
"timeoutInSeconds": number
},
"waitingResponse": {
"allowInterrupt": boolean,
"messageGroups": [
{
"message": {
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
},
"variations": [
{
"customPayload": {
"value": "string"
},
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
},
"plainTextMessage": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
}
}
]
}
]
}
}
}
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [botId](#API_UpdateSlot_ResponseSyntax) **
The identifier of the bot that contains the slot.
Type: String
Length Constraints: Fixed length of 10.
Pattern: `^[0-9a-zA-Z]+$`
** [botVersion](#API_UpdateSlot_ResponseSyntax) **
The version of the bot that contains the slot. Will always be `DRAFT`.
Type: String
Length Constraints: Fixed length of 5.
Pattern: `^DRAFT$`
** [creationDateTime](#API_UpdateSlot_ResponseSyntax) **
The timestamp of the date and time that the slot was created.
Type: Timestamp
** [description](#API_UpdateSlot_ResponseSyntax) **
The updated description of the bot.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 2000.
** [intentId](#API_UpdateSlot_ResponseSyntax) **
The intent that contains the slot.
Type: String
Length Constraints: Fixed length of 10.
Pattern: `^[0-9a-zA-Z]+$`
** [lastUpdatedDateTime](#API_UpdateSlot_ResponseSyntax) **
The timestamp of the date and time that the slot was last updated.
Type: Timestamp
** [localeId](#API_UpdateSlot_ResponseSyntax) **
The locale that contains the slot.
Type: String
** [multipleValuesSetting](#API_UpdateSlot_ResponseSyntax) **
Indicates whether the slot accepts multiple values in one response.
Type: [MultipleValuesSetting](API_MultipleValuesSetting.md) object
** [obfuscationSetting](#API_UpdateSlot_ResponseSyntax) **
The updated setting that determines whether the slot value is obfuscated in the Amazon CloudWatch logs.
Type: [ObfuscationSetting](API_ObfuscationSetting.md) object
** [slotId](#API_UpdateSlot_ResponseSyntax) **
The unique identifier of the slot that was updated.
Type: String
Length Constraints: Fixed length of 10.
Pattern: `^[0-9a-zA-Z]+$`
** [slotName](#API_UpdateSlot_ResponseSyntax) **
The updated name of the slot.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern: `^([0-9a-zA-Z][_-]?){1,100}$`
** [slotTypeId](#API_UpdateSlot_ResponseSyntax) **
The updated identifier of the slot type that provides values for the slot.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 25.
Pattern: `^((AMAZON\.)[a-zA-Z_]+?|[0-9a-zA-Z]+)$`
** [subSlotSetting](#API_UpdateSlot_ResponseSyntax) **
Specifications for the constituent sub slots and the expression for the composite slot.
Type: [SubSlotSetting](API_SubSlotSetting.md) object
** [valueElicitationSetting](#API_UpdateSlot_ResponseSyntax) **
The updated prompts that Amazon Lex sends to the user to elicit a response that provides a value for the slot.
Type: [SlotValueElicitationSetting](API_SlotValueElicitationSetting.md) object
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** ConflictException **
The action that you tried to perform couldn't be completed because the resource is in a conflicting state. For example, deleting a bot that is in the CREATING state. Try your request again.
HTTP Status Code: 409
** InternalServerException **
The service encountered an unexpected condition. Try your request again.
HTTP Status Code: 500
** PreconditionFailedException **
Your request couldn't be completed because one or more request fields aren't valid. Check the fields in your request and try again.
HTTP Status Code: 412
** ServiceQuotaExceededException **
You have reached a quota for your bot.
HTTP Status Code: 402
** ThrottlingException **
Your request rate is too high. Reduce the frequency of requests.
** retryAfterSeconds **
The number of seconds after which the user can invoke the API again.
HTTP Status Code: 429
** ValidationException **
One of the input parameters in your request isn't valid. Check the parameters and try your request again.
HTTP Status Code: 400
## See Also
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/models.lex.v2-2020-08-07/UpdateSlot)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/models.lex.v2-2020-08-07/UpdateSlot)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/UpdateSlot)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/models.lex.v2-2020-08-07/UpdateSlot)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/UpdateSlot)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/models.lex.v2-2020-08-07/UpdateSlot)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/models.lex.v2-2020-08-07/UpdateSlot)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/models.lex.v2-2020-08-07/UpdateSlot)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/models.lex.v2-2020-08-07/UpdateSlot)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/UpdateSlot)
# UpdateSlotType
Updates the configuration of an existing slot type.
## Request Syntax
```
PUT /bots/botId/botversions/botVersion/botlocales/localeId/slottypes/slotTypeId/ HTTP/1.1
Content-type: application/json
{
"compositeSlotTypeSetting": {
"subSlots": [
{
"name": "string",
"slotTypeId": "string"
}
]
},
"description": "string",
"externalSourceSetting": {
"grammarSlotTypeSetting": {
"source": {
"kmsKeyArn": "string",
"s3BucketName": "string",
"s3ObjectKey": "string"
}
}
},
"parentSlotTypeSignature": "string",
"slotTypeName": "string",
"slotTypeValues": [
{
"sampleValue": {
"value": "string"
},
"synonyms": [
{
"value": "string"
}
]
}
],
"valueSelectionSetting": {
"advancedRecognitionSetting": {
"audioRecognitionStrategy": "string"
},
"regexFilter": {
"pattern": "string"
},
"resolutionStrategy": "string"
}
}
```
## URI Request Parameters
The request uses the following URI parameters.
** [botId](#API_UpdateSlotType_RequestSyntax) **
The identifier of the bot that contains the slot type.
Length Constraints: Fixed length of 10.
Pattern: `^[0-9a-zA-Z]+$`
Required: Yes
** [botVersion](#API_UpdateSlotType_RequestSyntax) **
The version of the bot that contains the slot type. Must be `DRAFT`.
Length Constraints: Fixed length of 5.
Pattern: `^DRAFT$`
Required: Yes
** [localeId](#API_UpdateSlotType_RequestSyntax) **
The identifier of the language and locale that contains the slot type. The string must match one of the supported locales. For more information, see [Supported languages](https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html).
Required: Yes
** [slotTypeId](#API_UpdateSlotType_RequestSyntax) **
The unique identifier of the slot type to update.
Length Constraints: Fixed length of 10.
Pattern: `^[0-9a-zA-Z]+$`
Required: Yes
## Request Body
The request accepts the following data in JSON format.
** [compositeSlotTypeSetting](#API_UpdateSlotType_RequestSyntax) **
Specifications for a composite slot type.
Type: [CompositeSlotTypeSetting](API_CompositeSlotTypeSetting.md) object
Required: No
** [description](#API_UpdateSlotType_RequestSyntax) **
The new description of the slot type.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 2000.
Required: No
** [externalSourceSetting](#API_UpdateSlotType_RequestSyntax) **
Provides information about the external source of the slot type's definition.
Type: [ExternalSourceSetting](API_ExternalSourceSetting.md) object
Required: No
** [parentSlotTypeSignature](#API_UpdateSlotType_RequestSyntax) **
The new built-in slot type that should be used as the parent of this slot type.
Type: String
Required: No
** [slotTypeName](#API_UpdateSlotType_RequestSyntax) **
The new name of the slot type.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern: `^([0-9a-zA-Z][_-]?){1,100}$`
Required: Yes
** [slotTypeValues](#API_UpdateSlotType_RequestSyntax) **
A new list of values and their optional synonyms that define the values that the slot type can take.
Type: Array of [SlotTypeValue](API_SlotTypeValue.md) objects
Array Members: Minimum number of 1 item. Maximum number of 10000 items.
Required: No
** [valueSelectionSetting](#API_UpdateSlotType_RequestSyntax) **
The strategy that Amazon Lex should use when deciding on a value from the list of slot type values.
Type: [SlotValueSelectionSetting](API_SlotValueSelectionSetting.md) object
Required: No
## Response Syntax
```
HTTP/1.1 202
Content-type: application/json
{
"botId": "string",
"botVersion": "string",
"compositeSlotTypeSetting": {
"subSlots": [
{
"name": "string",
"slotTypeId": "string"
}
]
},
"creationDateTime": number,
"description": "string",
"externalSourceSetting": {
"grammarSlotTypeSetting": {
"source": {
"kmsKeyArn": "string",
"s3BucketName": "string",
"s3ObjectKey": "string"
}
}
},
"lastUpdatedDateTime": number,
"localeId": "string",
"parentSlotTypeSignature": "string",
"slotTypeId": "string",
"slotTypeName": "string",
"slotTypeValues": [
{
"sampleValue": {
"value": "string"
},
"synonyms": [
{
"value": "string"
}
]
}
],
"valueSelectionSetting": {
"advancedRecognitionSetting": {
"audioRecognitionStrategy": "string"
},
"regexFilter": {
"pattern": "string"
},
"resolutionStrategy": "string"
}
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 202 response.
The following data is returned in JSON format by the service.
** [botId](#API_UpdateSlotType_ResponseSyntax) **
The identifier of the bot that contains the slot type.
Type: String
Length Constraints: Fixed length of 10.
Pattern: `^[0-9a-zA-Z]+$`
** [botVersion](#API_UpdateSlotType_ResponseSyntax) **
The version of the bot that contains the slot type. This is always `DRAFT`.
Type: String
Length Constraints: Fixed length of 5.
Pattern: `^DRAFT$`
** [compositeSlotTypeSetting](#API_UpdateSlotType_ResponseSyntax) **
Specifications for a composite slot type.
Type: [CompositeSlotTypeSetting](API_CompositeSlotTypeSetting.md) object
** [creationDateTime](#API_UpdateSlotType_ResponseSyntax) **
The timestamp of the date and time that the slot type was created.
Type: Timestamp
** [description](#API_UpdateSlotType_ResponseSyntax) **
The updated description of the slot type.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 2000.
** [externalSourceSetting](#API_UpdateSlotType_ResponseSyntax) **
Provides information about the external source of the slot type's definition.
Type: [ExternalSourceSetting](API_ExternalSourceSetting.md) object
** [lastUpdatedDateTime](#API_UpdateSlotType_ResponseSyntax) **
A timestamp of the date and time that the slot type was last updated.
Type: Timestamp
** [localeId](#API_UpdateSlotType_ResponseSyntax) **
The language and locale of the updated slot type.
Type: String
** [parentSlotTypeSignature](#API_UpdateSlotType_ResponseSyntax) **
The updated signature of the built-in slot type that is the parent of this slot type.
Type: String
** [slotTypeId](#API_UpdateSlotType_ResponseSyntax) **
The unique identifier of the updated slot type.
Type: String
Length Constraints: Fixed length of 10.
Pattern: `^[0-9a-zA-Z]+$`
** [slotTypeName](#API_UpdateSlotType_ResponseSyntax) **
The updated name of the slot type.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern: `^([0-9a-zA-Z][_-]?){1,100}$`
** [slotTypeValues](#API_UpdateSlotType_ResponseSyntax) **
The updated values that the slot type provides.
Type: Array of [SlotTypeValue](API_SlotTypeValue.md) objects
Array Members: Minimum number of 1 item. Maximum number of 10000 items.
** [valueSelectionSetting](#API_UpdateSlotType_ResponseSyntax) **
The updated strategy that Amazon Lex uses to determine which value to select from the slot type.
Type: [SlotValueSelectionSetting](API_SlotValueSelectionSetting.md) object
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** ConflictException **
The action that you tried to perform couldn't be completed because the resource is in a conflicting state. For example, deleting a bot that is in the CREATING state. Try your request again.
HTTP Status Code: 409
** InternalServerException **
The service encountered an unexpected condition. Try your request again.
HTTP Status Code: 500
** PreconditionFailedException **
Your request couldn't be completed because one or more request fields aren't valid. Check the fields in your request and try again.
HTTP Status Code: 412
** ServiceQuotaExceededException **
You have reached a quota for your bot.
HTTP Status Code: 402
** ThrottlingException **
Your request rate is too high. Reduce the frequency of requests.
** retryAfterSeconds **
The number of seconds after which the user can invoke the API again.
HTTP Status Code: 429
** ValidationException **
One of the input parameters in your request isn't valid. Check the parameters and try your request again.
HTTP Status Code: 400
## See Also
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/models.lex.v2-2020-08-07/UpdateSlotType)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/models.lex.v2-2020-08-07/UpdateSlotType)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/UpdateSlotType)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/models.lex.v2-2020-08-07/UpdateSlotType)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/UpdateSlotType)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/models.lex.v2-2020-08-07/UpdateSlotType)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/models.lex.v2-2020-08-07/UpdateSlotType)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/models.lex.v2-2020-08-07/UpdateSlotType)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/models.lex.v2-2020-08-07/UpdateSlotType)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/UpdateSlotType)
# UpdateTestSet
The action to update the test set.
## Request Syntax
```
PUT /testsets/testSetId HTTP/1.1
Content-type: application/json
{
"description": "string",
"testSetName": "string"
}
```
## URI Request Parameters
The request uses the following URI parameters.
** [testSetId](#API_UpdateTestSet_RequestSyntax) **
The test set Id for which update test operation to be performed.
Length Constraints: Fixed length of 10.
Pattern: `^[0-9a-zA-Z]+$`
Required: Yes
## Request Body
The request accepts the following data in JSON format.
** [description](#API_UpdateTestSet_RequestSyntax) **
The new test set description.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 2000.
Required: No
** [testSetName](#API_UpdateTestSet_RequestSyntax) **
The new test set name.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern: `^([0-9a-zA-Z][_-]?){1,100}$`
Required: Yes
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"creationDateTime": number,
"description": "string",
"lastUpdatedDateTime": number,
"modality": "string",
"numTurns": number,
"roleArn": "string",
"status": "string",
"storageLocation": {
"kmsKeyArn": "string",
"s3BucketName": "string",
"s3Path": "string"
},
"testSetId": "string",
"testSetName": "string"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [creationDateTime](#API_UpdateTestSet_ResponseSyntax) **
The creation date and time for the updated test set.
Type: Timestamp
** [description](#API_UpdateTestSet_ResponseSyntax) **
The test set description for the updated test set.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 2000.
** [lastUpdatedDateTime](#API_UpdateTestSet_ResponseSyntax) **
The date and time of the last update for the updated test set.
Type: Timestamp
** [modality](#API_UpdateTestSet_ResponseSyntax) **
Indicates whether audio or text is used for the updated test set.
Type: String
Valid Values: `Text | Audio`
** [numTurns](#API_UpdateTestSet_ResponseSyntax) **
The number of conversation turns from the updated test set.
Type: Integer
** [roleArn](#API_UpdateTestSet_ResponseSyntax) **
The roleARN used for any operation in the test set to access resources in the AWS account.
Type: String
Length Constraints: Minimum length of 32. Maximum length of 2048.
Pattern: `^arn:aws:iam::[0-9]{12}:role/.*$`
** [status](#API_UpdateTestSet_ResponseSyntax) **
The status for the updated test set.
Type: String
Valid Values: `Importing | PendingAnnotation | Deleting | ValidationError | Ready`
** [storageLocation](#API_UpdateTestSet_ResponseSyntax) **
The Amazon S3 storage location for the updated test set.
Type: [TestSetStorageLocation](API_TestSetStorageLocation.md) object
** [testSetId](#API_UpdateTestSet_ResponseSyntax) **
The test set Id for which update test operation to be performed.
Type: String
Length Constraints: Fixed length of 10.
Pattern: `^[0-9a-zA-Z]+$`
** [testSetName](#API_UpdateTestSet_ResponseSyntax) **
The test set name for the updated test set.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern: `^([0-9a-zA-Z][_-]?){1,100}$`
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** ConflictException **
The action that you tried to perform couldn't be completed because the resource is in a conflicting state. For example, deleting a bot that is in the CREATING state. Try your request again.
HTTP Status Code: 409
** InternalServerException **
The service encountered an unexpected condition. Try your request again.
HTTP Status Code: 500
** PreconditionFailedException **
Your request couldn't be completed because one or more request fields aren't valid. Check the fields in your request and try again.
HTTP Status Code: 412
** ServiceQuotaExceededException **
You have reached a quota for your bot.
HTTP Status Code: 402
** ThrottlingException **
Your request rate is too high. Reduce the frequency of requests.
** retryAfterSeconds **
The number of seconds after which the user can invoke the API again.
HTTP Status Code: 429
** ValidationException **
One of the input parameters in your request isn't valid. Check the parameters and try your request again.
HTTP Status Code: 400
## See Also
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/models.lex.v2-2020-08-07/UpdateTestSet)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/models.lex.v2-2020-08-07/UpdateTestSet)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/UpdateTestSet)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/models.lex.v2-2020-08-07/UpdateTestSet)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/UpdateTestSet)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/models.lex.v2-2020-08-07/UpdateTestSet)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/models.lex.v2-2020-08-07/UpdateTestSet)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/models.lex.v2-2020-08-07/UpdateTestSet)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/models.lex.v2-2020-08-07/UpdateTestSet)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/UpdateTestSet)