# Amazon Lex V2 API Reference
This document provides detailed information about the Amazon Lex V2 API actions and their parameters.
For information about the IAM access control permissions you need to use this API, see [Identity-based policies for Amazon Lex](https://docs.aws.amazon.com/lexv2/latest/dg/security_iam_service-with-iam.html).
If you use a custom HTTP client to call Amazon Lex Model Building V2 operations, you must set the "Content-Type" HTTP header to "application/x-amz-json-1.1". Otherwise, you receive an HTTP 404 - UnknownOperationException in the response.
Amazon Lex Model Building V2 operations return the responses with the "application/x-amz-json-1.1" content type.
You can use [AWS SDKs](https://aws.amazon.com/tools/#sdk) to access Amazon Lex V2 APIs using your favorite programming language. The SDKs automatically perform useful tasks for you, such as:
+ Cryptographically sign your service requests
+ Retry requests
+ Handle error responses
The following resources provide additional information about the Amazon Lex V2 API.
+ *AWS General Reference*
+ [Amazon Lex V2 Endpoints for each region](https://docs.aws.amazon.com/general/latest/gr/lex.html).
+ *AWS Command Line Interface*
+ [ Amazon Lex Model Building V2 CLI commands](https://docs.aws.amazon.com/cli/latest/reference/lexv2-models/index.html).
+ [ Amazon Lex Runtime V2 CLI commands](https://docs.aws.amazon.com/cli/latest/reference/lexv2-runtime/index.html).
**Topics**
+ [
# Actions
](API_Operations.md)
+ [
# Data Types
](API_Types.md)
+ [
# Common Parameters
](CommonParameters.md)
+ [
# Common Error Types
](CommonErrors.md)
# Actions
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)
The following actions are supported by Amazon Lex Runtime V2:
+ [DeleteSession](API_runtime_DeleteSession.md)
+ [GetSession](API_runtime_GetSession.md)
+ [PutSession](API_runtime_PutSession.md)
+ [RecognizeText](API_runtime_RecognizeText.md)
+ [RecognizeUtterance](API_runtime_RecognizeUtterance.md)
+ [StartConversation](API_runtime_StartConversation.md)
# 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)
# Amazon Lex Runtime V2
The following actions are supported by Amazon Lex Runtime V2:
+ [DeleteSession](API_runtime_DeleteSession.md)
+ [GetSession](API_runtime_GetSession.md)
+ [PutSession](API_runtime_PutSession.md)
+ [RecognizeText](API_runtime_RecognizeText.md)
+ [RecognizeUtterance](API_runtime_RecognizeUtterance.md)
+ [StartConversation](API_runtime_StartConversation.md)
# DeleteSession
Removes session information for a specified bot, alias, and user ID.
You can use this operation to restart a conversation with a bot. When you remove a session, the entire history of the session is removed so that you can start again.
You don't need to delete a session. Sessions have a time limit and will expire. Set the session time limit when you create the bot. The default is 5 minutes, but you can specify anything between 1 minute and 24 hours.
If you specify a bot or alias ID that doesn't exist, you receive a `BadRequestException.`
If the locale doesn't exist in the bot, or if the locale hasn't been enables for the alias, you receive a `BadRequestException`.
## Request Syntax
```
DELETE /bots/botId/botAliases/botAliasId/botLocales/localeId/sessions/sessionId HTTP/1.1
```
## URI Request Parameters
The request uses the following URI parameters.
** [botAliasId](#API_runtime_DeleteSession_RequestSyntax) **
The alias identifier in use for the bot that contains the session data.
Required: Yes
** [botId](#API_runtime_DeleteSession_RequestSyntax) **
The identifier of the bot that contains the session data.
Length Constraints: Fixed length of 10.
Pattern: `^[0-9a-zA-Z]+$`
Required: Yes
** [localeId](#API_runtime_DeleteSession_RequestSyntax) **
The locale where the session is in use.
Length Constraints: Minimum length of 1.
Required: Yes
** [sessionId](#API_runtime_DeleteSession_RequestSyntax) **
The identifier of the session to delete.
Length Constraints: Minimum length of 2. Maximum length of 100.
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
{
"botAliasId": "string",
"botId": "string",
"localeId": "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.
** [botAliasId](#API_runtime_DeleteSession_ResponseSyntax) **
The alias identifier in use for the bot that contained the session data.
Type: String
** [botId](#API_runtime_DeleteSession_ResponseSyntax) **
The identifier of the bot that contained the session data.
Type: String
Length Constraints: Fixed length of 10.
Pattern: `^[0-9a-zA-Z]+$`
** [localeId](#API_runtime_DeleteSession_ResponseSyntax) **
The locale where the session was used.
Type: String
Length Constraints: Minimum length of 1.
** [sessionId](#API_runtime_DeleteSession_ResponseSyntax) **
The identifier of the deleted session.
Type: String
Length Constraints: Minimum length of 2. Maximum length of 100.
Pattern: `[0-9a-zA-Z._:-]+`
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** AccessDeniedException **
HTTP Status Code: 403
** ConflictException **
HTTP Status Code: 409
** InternalServerException **
HTTP Status Code: 500
** ResourceNotFoundException **
HTTP Status Code: 404
** ThrottlingException **
HTTP Status Code: 429
** ValidationException **
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/runtime.lex.v2-2020-08-07/DeleteSession)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/runtime.lex.v2-2020-08-07/DeleteSession)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/runtime.lex.v2-2020-08-07/DeleteSession)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/runtime.lex.v2-2020-08-07/DeleteSession)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/runtime.lex.v2-2020-08-07/DeleteSession)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/runtime.lex.v2-2020-08-07/DeleteSession)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/runtime.lex.v2-2020-08-07/DeleteSession)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/runtime.lex.v2-2020-08-07/DeleteSession)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/runtime.lex.v2-2020-08-07/DeleteSession)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/runtime.lex.v2-2020-08-07/DeleteSession)
# GetSession
Returns session information for a specified bot, alias, and user.
For example, you can use this operation to retrieve session information for a user that has left a long-running session in use.
If the bot, alias, or session identifier doesn't exist, Amazon Lex V2 returns a `BadRequestException`. If the locale doesn't exist or is not enabled for the alias, you receive a `BadRequestException`.
## Request Syntax
```
GET /bots/botId/botAliases/botAliasId/botLocales/localeId/sessions/sessionId HTTP/1.1
```
## URI Request Parameters
The request uses the following URI parameters.
** [botAliasId](#API_runtime_GetSession_RequestSyntax) **
The alias identifier in use for the bot that contains the session data.
Required: Yes
** [botId](#API_runtime_GetSession_RequestSyntax) **
The identifier of the bot that contains the session data.
Length Constraints: Fixed length of 10.
Pattern: `^[0-9a-zA-Z]+$`
Required: Yes
** [localeId](#API_runtime_GetSession_RequestSyntax) **
The locale where the session is in use.
Length Constraints: Minimum length of 1.
Required: Yes
** [sessionId](#API_runtime_GetSession_RequestSyntax) **
The identifier of the session to return.
Length Constraints: Minimum length of 2. Maximum length of 100.
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
{
"interpretations": [
{
"intent": {
"confirmationState": "string",
"name": "string",
"slots": {
"string" : {
"shape": "string",
"subSlots": {
"string" : "Slot"
},
"value": {
"interpretedValue": "string",
"originalValue": "string",
"resolvedValues": [ "string" ]
},
"values": [
"Slot"
]
}
},
"state": "string"
},
"interpretationSource": "string",
"nluConfidence": {
"score": number
},
"sentimentResponse": {
"sentiment": "string",
"sentimentScore": {
"mixed": number,
"negative": number,
"neutral": number,
"positive": number
}
}
}
],
"messages": [
{
"content": "string",
"contentType": "string",
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
}
}
],
"sessionId": "string",
"sessionState": {
"activeContexts": [
{
"contextAttributes": {
"string" : "string"
},
"name": "string",
"timeToLive": {
"timeToLiveInSeconds": number,
"turnsToLive": number
}
}
],
"dialogAction": {
"slotElicitationStyle": "string",
"slotToElicit": "string",
"subSlotToElicit": {
"name": "string",
"subSlotToElicit": "ElicitSubSlot"
},
"type": "string"
},
"intent": {
"confirmationState": "string",
"name": "string",
"slots": {
"string" : {
"shape": "string",
"subSlots": {
"string" : "Slot"
},
"value": {
"interpretedValue": "string",
"originalValue": "string",
"resolvedValues": [ "string" ]
},
"values": [
"Slot"
]
}
},
"state": "string"
},
"originatingRequestId": "string",
"runtimeHints": {
"slotHints": {
"string" : {
"string" : {
"runtimeHintValues": [
{
"phrase": "string"
}
],
"subSlotHints": {
"string" : "RuntimeHintDetails"
}
}
}
}
},
"sessionAttributes": {
"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.
** [interpretations](#API_runtime_GetSession_ResponseSyntax) **
A list of intents that Amazon Lex V2 determined might satisfy the user's utterance.
Each interpretation includes the intent, a score that indicates how confident Amazon Lex V2 is that the interpretation is the correct one, and an optional sentiment response that indicates the sentiment expressed in the utterance.
Type: Array of [Interpretation](API_runtime_Interpretation.md) objects
Array Members: Maximum number of 5 items.
** [messages](#API_runtime_GetSession_ResponseSyntax) **
A list of messages that were last sent to the user. The messages are ordered based on the order that your returned the messages from your Lambda function or the order that messages are defined in the bot.
Type: Array of [Message](API_runtime_Message.md) objects
Array Members: Maximum number of 10 items.
** [sessionId](#API_runtime_GetSession_ResponseSyntax) **
The identifier of the returned session.
Type: String
Length Constraints: Minimum length of 1.
** [sessionState](#API_runtime_GetSession_ResponseSyntax) **
Represents the current state of the dialog between the user and the bot.
You can use this to determine the progress of the conversation and what the next action might be.
Type: [SessionState](API_runtime_SessionState.md) object
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** AccessDeniedException **
HTTP Status Code: 403
** InternalServerException **
HTTP Status Code: 500
** ResourceNotFoundException **
HTTP Status Code: 404
** ThrottlingException **
HTTP Status Code: 429
** ValidationException **
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/runtime.lex.v2-2020-08-07/GetSession)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/runtime.lex.v2-2020-08-07/GetSession)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/runtime.lex.v2-2020-08-07/GetSession)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/runtime.lex.v2-2020-08-07/GetSession)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/runtime.lex.v2-2020-08-07/GetSession)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/runtime.lex.v2-2020-08-07/GetSession)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/runtime.lex.v2-2020-08-07/GetSession)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/runtime.lex.v2-2020-08-07/GetSession)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/runtime.lex.v2-2020-08-07/GetSession)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/runtime.lex.v2-2020-08-07/GetSession)
# PutSession
Creates a new session or modifies an existing session with an Amazon Lex V2 bot. Use this operation to enable your application to set the state of the bot.
## Request Syntax
```
POST /bots/botId/botAliases/botAliasId/botLocales/localeId/sessions/sessionId HTTP/1.1
ResponseContentType: responseContentType
Content-type: application/json
{
"messages": [
{
"content": "string",
"contentType": "string",
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
}
}
],
"requestAttributes": {
"string" : "string"
},
"sessionState": {
"activeContexts": [
{
"contextAttributes": {
"string" : "string"
},
"name": "string",
"timeToLive": {
"timeToLiveInSeconds": number,
"turnsToLive": number
}
}
],
"dialogAction": {
"slotElicitationStyle": "string",
"slotToElicit": "string",
"subSlotToElicit": {
"name": "string",
"subSlotToElicit": "ElicitSubSlot"
},
"type": "string"
},
"intent": {
"confirmationState": "string",
"name": "string",
"slots": {
"string" : {
"shape": "string",
"subSlots": {
"string" : "Slot"
},
"value": {
"interpretedValue": "string",
"originalValue": "string",
"resolvedValues": [ "string" ]
},
"values": [
"Slot"
]
}
},
"state": "string"
},
"originatingRequestId": "string",
"runtimeHints": {
"slotHints": {
"string" : {
"string" : {
"runtimeHintValues": [
{
"phrase": "string"
}
],
"subSlotHints": {
"string" : "RuntimeHintDetails"
}
}
}
}
},
"sessionAttributes": {
"string" : "string"
}
}
}
```
## URI Request Parameters
The request uses the following URI parameters.
** [botAliasId](#API_runtime_PutSession_RequestSyntax) **
The alias identifier of the bot that receives the session data.
Required: Yes
** [botId](#API_runtime_PutSession_RequestSyntax) **
The identifier of the bot that receives the session data.
Length Constraints: Fixed length of 10.
Pattern: `^[0-9a-zA-Z]+$`
Required: Yes
** [localeId](#API_runtime_PutSession_RequestSyntax) **
The locale where the session is in use.
Length Constraints: Minimum length of 1.
Required: Yes
** [responseContentType](#API_runtime_PutSession_RequestSyntax) **
The message that Amazon Lex V2 returns in the response can be either text or speech depending on the value of this parameter.
+ If the value is `text/plain; charset=utf-8`, Amazon Lex V2 returns text in the response.
Length Constraints: Minimum length of 1.
** [sessionId](#API_runtime_PutSession_RequestSyntax) **
The identifier of the session that receives the session data.
Length Constraints: Minimum length of 2. Maximum length of 100.
Pattern: `[0-9a-zA-Z._:-]+`
Required: Yes
## Request Body
The request accepts the following data in JSON format.
** [messages](#API_runtime_PutSession_RequestSyntax) **
A list of messages to send to the user. Messages are sent in the order that they are defined in the list.
Type: Array of [Message](API_runtime_Message.md) objects
Array Members: Maximum number of 10 items.
Required: No
** [requestAttributes](#API_runtime_PutSession_RequestSyntax) **
Request-specific information passed between Amazon Lex V2 and the client application.
The namespace `x-amz-lex:` is reserved for special attributes. Don't create any request attributes with the prefix `x-amz-lex:`.
Type: String to string map
Key Length Constraints: Minimum length of 1.
Required: No
** [sessionState](#API_runtime_PutSession_RequestSyntax) **
Sets the state of the session with the user. You can use this to set the current intent, attributes, context, and dialog action. Use the dialog action to determine the next step that Amazon Lex V2 should use in the conversation with the user.
Type: [SessionState](API_runtime_SessionState.md) object
Required: Yes
## Response Syntax
```
HTTP/1.1 200
Content-Type: contentType
x-amz-lex-messages: messages
x-amz-lex-session-state: sessionState
x-amz-lex-request-attributes: requestAttributes
x-amz-lex-session-id: sessionId
audioStream
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The response returns the following HTTP headers.
** [contentType](#API_runtime_PutSession_ResponseSyntax) **
The type of response. Same as the type specified in the `responseContentType` field in the request.
Length Constraints: Minimum length of 1.
** [messages](#API_runtime_PutSession_ResponseSyntax) **
A list of messages that were last sent to the user. The messages are ordered based on how you return the messages from you Lambda function or the order that the messages are defined in the bot.
Length Constraints: Minimum length of 1.
** [requestAttributes](#API_runtime_PutSession_ResponseSyntax) **
A base-64-encoded gzipped field that provides request-specific information passed between the client application and Amazon Lex V2. These are the same as the `requestAttribute` parameter in the call to the `PutSession` operation.
Length Constraints: Minimum length of 1.
** [sessionId](#API_runtime_PutSession_ResponseSyntax) **
The identifier of the session that received the data.
Length Constraints: Minimum length of 2. Maximum length of 100.
Pattern: `[0-9a-zA-Z._:-]+`
** [sessionState](#API_runtime_PutSession_ResponseSyntax) **
A base-64-encoded gzipped field that represents the current state of the dialog between the user and the bot. Use this to determine the progress of the conversation and what the next action may be.
Length Constraints: Minimum length of 1.
The response returns the following as the HTTP body.
** [audioStream](#API_runtime_PutSession_ResponseSyntax) **
If the requested content type was audio, the audio version of the message to convey to the user.
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** AccessDeniedException **
HTTP Status Code: 403
** BadGatewayException **
HTTP Status Code: 502
** ConflictException **
HTTP Status Code: 409
** DependencyFailedException **
HTTP Status Code: 424
** InternalServerException **
HTTP Status Code: 500
** ResourceNotFoundException **
HTTP Status Code: 404
** ThrottlingException **
HTTP Status Code: 429
** ValidationException **
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/runtime.lex.v2-2020-08-07/PutSession)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/runtime.lex.v2-2020-08-07/PutSession)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/runtime.lex.v2-2020-08-07/PutSession)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/runtime.lex.v2-2020-08-07/PutSession)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/runtime.lex.v2-2020-08-07/PutSession)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/runtime.lex.v2-2020-08-07/PutSession)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/runtime.lex.v2-2020-08-07/PutSession)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/runtime.lex.v2-2020-08-07/PutSession)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/runtime.lex.v2-2020-08-07/PutSession)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/runtime.lex.v2-2020-08-07/PutSession)
# RecognizeText
Sends user input to Amazon Lex V2. Client applications use this API to send requests to Amazon Lex V2 at runtime. Amazon Lex V2 then interprets the user input using the machine learning model that it build for the bot.
In response, Amazon Lex V2 returns the next message to convey to the user and an optional response card to display.
If the optional post-fulfillment response is specified, the messages are returned as follows. For more information, see [PostFulfillmentStatusSpecification](https://docs.aws.amazon.com/lexv2/latest/dg/API_PostFulfillmentStatusSpecification.html).
+ **Success message** - Returned if the Lambda function completes successfully and the intent state is fulfilled or ready fulfillment if the message is present.
+ **Failed message** - The failed message is returned if the Lambda function throws an exception or if the Lambda function returns a failed intent state without a message.
+ **Timeout message** - If you don't configure a timeout message and a timeout, and the Lambda function doesn't return within 30 seconds, the timeout message is returned. If you configure a timeout, the timeout message is returned when the period times out.
For more information, see [Completion message](https://docs.aws.amazon.com/lexv2/latest/dg/streaming-progress.html#progress-complete.html).
## Request Syntax
```
POST /bots/botId/botAliases/botAliasId/botLocales/localeId/sessions/sessionId/text HTTP/1.1
Content-type: application/json
{
"requestAttributes": {
"string" : "string"
},
"sessionState": {
"activeContexts": [
{
"contextAttributes": {
"string" : "string"
},
"name": "string",
"timeToLive": {
"timeToLiveInSeconds": number,
"turnsToLive": number
}
}
],
"dialogAction": {
"slotElicitationStyle": "string",
"slotToElicit": "string",
"subSlotToElicit": {
"name": "string",
"subSlotToElicit": "ElicitSubSlot"
},
"type": "string"
},
"intent": {
"confirmationState": "string",
"name": "string",
"slots": {
"string" : {
"shape": "string",
"subSlots": {
"string" : "Slot"
},
"value": {
"interpretedValue": "string",
"originalValue": "string",
"resolvedValues": [ "string" ]
},
"values": [
"Slot"
]
}
},
"state": "string"
},
"originatingRequestId": "string",
"runtimeHints": {
"slotHints": {
"string" : {
"string" : {
"runtimeHintValues": [
{
"phrase": "string"
}
],
"subSlotHints": {
"string" : "RuntimeHintDetails"
}
}
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"text": "string"
}
```
## URI Request Parameters
The request uses the following URI parameters.
** [botAliasId](#API_runtime_RecognizeText_RequestSyntax) **
The alias identifier in use for the bot that processes the request.
Required: Yes
** [botId](#API_runtime_RecognizeText_RequestSyntax) **
The identifier of the bot that processes the request.
Length Constraints: Fixed length of 10.
Pattern: `^[0-9a-zA-Z]+$`
Required: Yes
** [localeId](#API_runtime_RecognizeText_RequestSyntax) **
The locale where the session is in use.
Length Constraints: Minimum length of 1.
Required: Yes
** [sessionId](#API_runtime_RecognizeText_RequestSyntax) **
The identifier of the user session that is having the conversation.
Length Constraints: Minimum length of 2. Maximum length of 100.
Pattern: `[0-9a-zA-Z._:-]+`
Required: Yes
## Request Body
The request accepts the following data in JSON format.
** [requestAttributes](#API_runtime_RecognizeText_RequestSyntax) **
Request-specific information passed between the client application and Amazon Lex V2
The namespace `x-amz-lex:` is reserved for special attributes. Don't create any request attributes with the prefix `x-amz-lex:`.
Type: String to string map
Key Length Constraints: Minimum length of 1.
Required: No
** [sessionState](#API_runtime_RecognizeText_RequestSyntax) **
The current state of the dialog between the user and the bot.
Type: [SessionState](API_runtime_SessionState.md) object
Required: No
** [text](#API_runtime_RecognizeText_RequestSyntax) **
The text that the user entered. Amazon Lex V2 interprets this text.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Required: Yes
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"interpretations": [
{
"intent": {
"confirmationState": "string",
"name": "string",
"slots": {
"string" : {
"shape": "string",
"subSlots": {
"string" : "Slot"
},
"value": {
"interpretedValue": "string",
"originalValue": "string",
"resolvedValues": [ "string" ]
},
"values": [
"Slot"
]
}
},
"state": "string"
},
"interpretationSource": "string",
"nluConfidence": {
"score": number
},
"sentimentResponse": {
"sentiment": "string",
"sentimentScore": {
"mixed": number,
"negative": number,
"neutral": number,
"positive": number
}
}
}
],
"messages": [
{
"content": "string",
"contentType": "string",
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
}
}
],
"recognizedBotMember": {
"botId": "string",
"botName": "string"
},
"requestAttributes": {
"string" : "string"
},
"sessionId": "string",
"sessionState": {
"activeContexts": [
{
"contextAttributes": {
"string" : "string"
},
"name": "string",
"timeToLive": {
"timeToLiveInSeconds": number,
"turnsToLive": number
}
}
],
"dialogAction": {
"slotElicitationStyle": "string",
"slotToElicit": "string",
"subSlotToElicit": {
"name": "string",
"subSlotToElicit": "ElicitSubSlot"
},
"type": "string"
},
"intent": {
"confirmationState": "string",
"name": "string",
"slots": {
"string" : {
"shape": "string",
"subSlots": {
"string" : "Slot"
},
"value": {
"interpretedValue": "string",
"originalValue": "string",
"resolvedValues": [ "string" ]
},
"values": [
"Slot"
]
}
},
"state": "string"
},
"originatingRequestId": "string",
"runtimeHints": {
"slotHints": {
"string" : {
"string" : {
"runtimeHintValues": [
{
"phrase": "string"
}
],
"subSlotHints": {
"string" : "RuntimeHintDetails"
}
}
}
}
},
"sessionAttributes": {
"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.
** [interpretations](#API_runtime_RecognizeText_ResponseSyntax) **
A list of intents that Amazon Lex V2 determined might satisfy the user's utterance.
Each interpretation includes the intent, a score that indicates now confident Amazon Lex V2 is that the interpretation is the correct one, and an optional sentiment response that indicates the sentiment expressed in the utterance.
Type: Array of [Interpretation](API_runtime_Interpretation.md) objects
Array Members: Maximum number of 5 items.
** [messages](#API_runtime_RecognizeText_ResponseSyntax) **
A list of messages last sent to the user. The messages are ordered based on the order that you returned the messages from your Lambda function or the order that the messages are defined in the bot.
Type: Array of [Message](API_runtime_Message.md) objects
Array Members: Maximum number of 10 items.
** [recognizedBotMember](#API_runtime_RecognizeText_ResponseSyntax) **
The bot member that recognized the text.
Type: [RecognizedBotMember](API_runtime_RecognizedBotMember.md) object
** [requestAttributes](#API_runtime_RecognizeText_ResponseSyntax) **
The attributes sent in the request.
Type: String to string map
Key Length Constraints: Minimum length of 1.
** [sessionId](#API_runtime_RecognizeText_ResponseSyntax) **
The identifier of the session in use.
Type: String
Length Constraints: Minimum length of 2. Maximum length of 100.
Pattern: `[0-9a-zA-Z._:-]+`
** [sessionState](#API_runtime_RecognizeText_ResponseSyntax) **
Represents the current state of the dialog between the user and the bot.
Use this to determine the progress of the conversation and what the next action may be.
Type: [SessionState](API_runtime_SessionState.md) object
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** AccessDeniedException **
HTTP Status Code: 403
** BadGatewayException **
HTTP Status Code: 502
** ConflictException **
HTTP Status Code: 409
** DependencyFailedException **
HTTP Status Code: 424
** InternalServerException **
HTTP Status Code: 500
** ResourceNotFoundException **
HTTP Status Code: 404
** ThrottlingException **
HTTP Status Code: 429
** ValidationException **
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/runtime.lex.v2-2020-08-07/RecognizeText)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/runtime.lex.v2-2020-08-07/RecognizeText)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/runtime.lex.v2-2020-08-07/RecognizeText)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/runtime.lex.v2-2020-08-07/RecognizeText)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/runtime.lex.v2-2020-08-07/RecognizeText)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/runtime.lex.v2-2020-08-07/RecognizeText)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/runtime.lex.v2-2020-08-07/RecognizeText)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/runtime.lex.v2-2020-08-07/RecognizeText)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/runtime.lex.v2-2020-08-07/RecognizeText)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/runtime.lex.v2-2020-08-07/RecognizeText)
# RecognizeUtterance
Sends user input to Amazon Lex V2. You can send text or speech. Clients use this API to send text and audio requests to Amazon Lex V2 at runtime. Amazon Lex V2 interprets the user input using the machine learning model built for the bot.
The following request fields must be compressed with gzip and then base64 encoded before you send them to Amazon Lex V2.
+ requestAttributes
+ sessionState
The following response fields are compressed using gzip and then base64 encoded by Amazon Lex V2. Before you can use these fields, you must decode and decompress them.
+ inputTranscript
+ interpretations
+ messages
+ requestAttributes
+ sessionState
The example contains a Java application that compresses and encodes a Java object to send to Amazon Lex V2, and a second that decodes and decompresses a response from Amazon Lex V2.
If the optional post-fulfillment response is specified, the messages are returned as follows. For more information, see [PostFulfillmentStatusSpecification](https://docs.aws.amazon.com/lexv2/latest/dg/API_PostFulfillmentStatusSpecification.html).
+ **Success message** - Returned if the Lambda function completes successfully and the intent state is fulfilled or ready fulfillment if the message is present.
+ **Failed message** - The failed message is returned if the Lambda function throws an exception or if the Lambda function returns a failed intent state without a message.
+ **Timeout message** - If you don't configure a timeout message and a timeout, and the Lambda function doesn't return within 30 seconds, the timeout message is returned. If you configure a timeout, the timeout message is returned when the period times out.
For more information, see [Completion message](https://docs.aws.amazon.com/lexv2/latest/dg/streaming-progress.html#progress-complete.html).
## Request Syntax
```
POST /bots/botId/botAliases/botAliasId/botLocales/localeId/sessions/sessionId/utterance HTTP/1.1
x-amz-lex-session-state: sessionState
x-amz-lex-request-attributes: requestAttributes
Content-Type: requestContentType
Response-Content-Type: responseContentType
inputStream
```
## URI Request Parameters
The request uses the following URI parameters.
** [botAliasId](#API_runtime_RecognizeUtterance_RequestSyntax) **
The alias identifier in use for the bot that should receive the request.
Required: Yes
** [botId](#API_runtime_RecognizeUtterance_RequestSyntax) **
The identifier of the bot that should receive the request.
Length Constraints: Fixed length of 10.
Pattern: `^[0-9a-zA-Z]+$`
Required: Yes
** [localeId](#API_runtime_RecognizeUtterance_RequestSyntax) **
The locale where the session is in use.
Length Constraints: Minimum length of 1.
Required: Yes
** [requestAttributes](#API_runtime_RecognizeUtterance_RequestSyntax) **
Request-specific information passed between the client application and Amazon Lex V2
The namespace `x-amz-lex:` is reserved for special attributes. Don't create any request attributes for prefix `x-amz-lex:`.
The `requestAttributes` field must be compressed using gzip and then base64 encoded before sending to Amazon Lex V2.
** [requestContentType](#API_runtime_RecognizeUtterance_RequestSyntax) **
Indicates the format for audio input or that the content is text. The header must start with one of the following prefixes:
+ PCM format, audio data must be in little-endian byte order.
+ audio/l16; rate=16000; channels=1
+ audio/x-l16; sample-rate=16000; channel-count=1
+ audio/lpcm; sample-rate=8000; sample-size-bits=16; channel-count=1; is-big-endian=false
+ Opus format
+ audio/x-cbr-opus-with-preamble;preamble-size=0;bit-rate=256000;frame-size-milliseconds=4
+ Text format
+ text/plain; charset=utf-8
Length Constraints: Minimum length of 1.
Required: Yes
** [responseContentType](#API_runtime_RecognizeUtterance_RequestSyntax) **
The message that Amazon Lex V2 returns in the response can be either text or speech based on the `responseContentType` value.
+ If the value is `text/plain;charset=utf-8`, Amazon Lex V2 returns text in the response.
+ If the value begins with `audio/`, Amazon Lex V2 returns speech in the response. Amazon Lex V2 uses Amazon Polly to generate the speech using the configuration that you specified in the `responseContentType` parameter. For example, if you specify `audio/mpeg` as the value, Amazon Lex V2 returns speech in the MPEG format.
+ If the value is `audio/pcm`, the speech returned is `audio/pcm` at 16 KHz in 16-bit, little-endian format.
+ The following are the accepted values:
+ audio/mpeg
+ audio/ogg
+ audio/pcm (16 KHz)
+ audio/\$1 (defaults to mpeg)
+ text/plain; charset=utf-8
Length Constraints: Minimum length of 1.
** [sessionId](#API_runtime_RecognizeUtterance_RequestSyntax) **
The identifier of the session in use.
Length Constraints: Minimum length of 2. Maximum length of 100.
Pattern: `[0-9a-zA-Z._:-]+`
Required: Yes
** [sessionState](#API_runtime_RecognizeUtterance_RequestSyntax) **
Sets the state of the session with the user. You can use this to set the current intent, attributes, context, and dialog action. Use the dialog action to determine the next step that Amazon Lex V2 should use in the conversation with the user.
The `sessionState` field must be compressed using gzip and then base64 encoded before sending to Amazon Lex V2.
## Request Body
The request accepts the following binary data.
** [inputStream](#API_runtime_RecognizeUtterance_RequestSyntax) **
User input in PCM or Opus audio format or text format as described in the `requestContentType` parameter.
## Response Syntax
```
HTTP/1.1 200
x-amz-lex-input-mode: inputMode
Content-Type: contentType
x-amz-lex-messages: messages
x-amz-lex-interpretations: interpretations
x-amz-lex-session-state: sessionState
x-amz-lex-request-attributes: requestAttributes
x-amz-lex-session-id: sessionId
x-amz-lex-input-transcript: inputTranscript
x-amz-lex-recognized-bot-member: recognizedBotMember
audioStream
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The response returns the following HTTP headers.
** [contentType](#API_runtime_RecognizeUtterance_ResponseSyntax) **
Content type as specified in the `responseContentType` in the request.
Length Constraints: Minimum length of 1.
** [inputMode](#API_runtime_RecognizeUtterance_ResponseSyntax) **
Indicates whether the input mode to the operation was text, speech, or from a touch-tone keypad.
Length Constraints: Minimum length of 1.
** [inputTranscript](#API_runtime_RecognizeUtterance_ResponseSyntax) **
The text used to process the request.
If the input was an audio stream, the `inputTranscript` field contains the text extracted from the audio stream. This is the text that is actually processed to recognize intents and slot values. You can use this information to determine if Amazon Lex V2 is correctly processing the audio that you send.
The `inputTranscript` field is compressed with gzip and then base64 encoded. Before you can use the contents of the field, you must decode and decompress the contents. See the example for a simple function to decode and decompress the contents.
Length Constraints: Minimum length of 1.
** [interpretations](#API_runtime_RecognizeUtterance_ResponseSyntax) **
A list of intents that Amazon Lex V2 determined might satisfy the user's utterance.
Each interpretation includes the intent, a score that indicates how confident Amazon Lex V2 is that the interpretation is the correct one, and an optional sentiment response that indicates the sentiment expressed in the utterance.
The `interpretations` field is compressed with gzip and then base64 encoded. Before you can use the contents of the field, you must decode and decompress the contents. See the example for a simple function to decode and decompress the contents.
Length Constraints: Minimum length of 1.
** [messages](#API_runtime_RecognizeUtterance_ResponseSyntax) **
A list of messages that were last sent to the user. The messages are ordered based on the order that you returned the messages from your Lambda function or the order that the messages are defined in the bot.
The `messages` field is compressed with gzip and then base64 encoded. Before you can use the contents of the field, you must decode and decompress the contents. See the example for a simple function to decode and decompress the contents.
Length Constraints: Minimum length of 1.
** [recognizedBotMember](#API_runtime_RecognizeUtterance_ResponseSyntax) **
The bot member that recognized the utterance.
Length Constraints: Minimum length of 1.
** [requestAttributes](#API_runtime_RecognizeUtterance_ResponseSyntax) **
The attributes sent in the request.
The `requestAttributes` field is compressed with gzip and then base64 encoded. Before you can use the contents of the field, you must decode and decompress the contents.
Length Constraints: Minimum length of 1.
** [sessionId](#API_runtime_RecognizeUtterance_ResponseSyntax) **
The identifier of the session in use.
Length Constraints: Minimum length of 2. Maximum length of 100.
Pattern: `[0-9a-zA-Z._:-]+`
** [sessionState](#API_runtime_RecognizeUtterance_ResponseSyntax) **
Represents the current state of the dialog between the user and the bot.
Use this to determine the progress of the conversation and what the next action might be.
The `sessionState` field is compressed with gzip and then base64 encoded. Before you can use the contents of the field, you must decode and decompress the contents. See the example for a simple function to decode and decompress the contents.
Length Constraints: Minimum length of 1.
The response returns the following as the HTTP body.
** [audioStream](#API_runtime_RecognizeUtterance_ResponseSyntax) **
The prompt or statement to send to the user. This is based on the bot configuration and context. For example, if Amazon Lex V2 did not understand the user intent, it sends the `clarificationPrompt` configured for the bot. If the intent requires confirmation before taking the fulfillment action, it sends the `confirmationPrompt`. Another example: Suppose that the Lambda function successfully fulfilled the intent, and sent a message to convey to the user. Then Amazon Lex V2 sends that message in the response.
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** AccessDeniedException **
HTTP Status Code: 403
** BadGatewayException **
HTTP Status Code: 502
** ConflictException **
HTTP Status Code: 409
** DependencyFailedException **
HTTP Status Code: 424
** InternalServerException **
HTTP Status Code: 500
** ResourceNotFoundException **
HTTP Status Code: 404
** ThrottlingException **
HTTP Status Code: 429
** ValidationException **
HTTP Status Code: 400
## Examples
### Encode and decode a field
The following example provides two functions, one to compress a string with gzip and then base64 encode it and one to decode and decompress a string.
```
package com.amazonaws.deepsense.util;
import com.amazonaws.deepsense.runtime.conversation.serialize.RuntimeSdkSerializer;
import com.fasterxml.jackson.annotation.JsonInclude;
import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.core.type.TypeReference;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.fasterxml.jackson.databind.SerializationFeature;
import com.google.common.base.Preconditions;
import java.io.IOException;
import java.util.Base64;
public class CompressionAndEncoding {
private CompressionAndEncoding() {
}
/**
* Given a generic object
* 1. Serialize the object using jackson
* 2. Compress the serialized object
* 3. Base64 encode the compressed data
*/
public static String compressAndEncodeBase64(Object object) {
if (object == null) {
return null;
}
String objectAsString = GsonSerializer.serialize(object);
byte[] compressedString = Compressions.compress(objectAsString);
return Base64.getEncoder().encodeToString(compressedString);
}
/**
* Given a base64 encoded, compressed, serialized object
* 1. Base64 decodes the data
* 2. Decompresses the base64 decoded data
* 3. Converts the serialized object into a proper POJO
*/
public static T decodeBase64AndDecompress(String objectAsString, TypeReference typeRef) {
if (objectAsString == null) {
return null;
}
Preconditions.checkNotNull(typeRef, "Serialization class can't be null.");
byte[] decodedBytes = Base64.getDecoder().decode(objectAsString);
String decompressedObjectAsString = Compressions.uncompress(decodedBytes);
try {
return RuntimeSdkSerializer.instance().readValue(decompressedObjectAsString, typeRef);
} catch (IOException e) {
throw new RuntimeException(String.format("Unable to deserialize string %s", decompressedObjectAsString), e);
}
}
}
```
## 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/runtime.lex.v2-2020-08-07/RecognizeUtterance)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/runtime.lex.v2-2020-08-07/RecognizeUtterance)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/runtime.lex.v2-2020-08-07/RecognizeUtterance)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/runtime.lex.v2-2020-08-07/RecognizeUtterance)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/runtime.lex.v2-2020-08-07/RecognizeUtterance)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/runtime.lex.v2-2020-08-07/RecognizeUtterance)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/runtime.lex.v2-2020-08-07/RecognizeUtterance)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/runtime.lex.v2-2020-08-07/RecognizeUtterance)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/runtime.lex.v2-2020-08-07/RecognizeUtterance)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/runtime.lex.v2-2020-08-07/RecognizeUtterance)
# StartConversation
Starts an HTTP/2 bidirectional event stream that enables you to send audio, text, or DTMF input in real time. After your application starts a conversation, users send input to Amazon Lex V2 as a stream of events. Amazon Lex V2 processes the incoming events and responds with streaming text or audio events.
Audio input must be in the following format: `audio/lpcm sample-rate=8000 sample-size-bits=16 channel-count=1; is-big-endian=false`.
If the optional post-fulfillment response is specified, the messages are returned as follows. For more information, see [PostFulfillmentStatusSpecification](https://docs.aws.amazon.com/lexv2/latest/dg/API_PostFulfillmentStatusSpecification.html).
+ **Success message** - Returned if the Lambda function completes successfully and the intent state is fulfilled or ready fulfillment if the message is present.
+ **Failed message** - The failed message is returned if the Lambda function throws an exception or if the Lambda function returns a failed intent state without a message.
+ **Timeout message** - If you don't configure a timeout message and a timeout, and the Lambda function doesn't return within 30 seconds, the timeout message is returned. If you configure a timeout, the timeout message is returned when the period times out.
For more information, see [Completion message](https://docs.aws.amazon.com/lexv2/latest/dg/streaming-progress.html#progress-complete.html).
If the optional update message is configured, it is played at the specified frequency while the Lambda function is running and the update message state is active. If the fulfillment update message is not active, the Lambda function runs with a 30 second timeout.
For more information, see [Update message ](https://docs.aws.amazon.com/lexv2/latest/dg/streaming-progress.html#progress-update.html)
The `StartConversation` operation is supported only in the following SDKs:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/runtime.lex.v2-2020-08-07/StartConversation)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/runtime.lex.v2-2020-08-07/StartConversation)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/runtime.lex.v2-2020-08-07/StartConversation)
## Request Syntax
```
POST /bots/botId/botAliases/botAliasId/botLocales/localeId/sessions/sessionId/conversation HTTP/1.1
x-amz-lex-conversation-mode: conversationMode
Content-type: application/json
{
"AudioInputEvent": {
"audioChunk": blob,
"clientTimestampMillis": number,
"contentType": "string",
"eventId": "string"
},
"ConfigurationEvent": {
"clientTimestampMillis": number,
"disablePlayback": boolean,
"eventId": "string",
"requestAttributes": {
"string" : "string"
},
"responseContentType": "string",
"sessionState": {
"activeContexts": [
{
"contextAttributes": {
"string" : "string"
},
"name": "string",
"timeToLive": {
"timeToLiveInSeconds": number,
"turnsToLive": number
}
}
],
"dialogAction": {
"slotElicitationStyle": "string",
"slotToElicit": "string",
"subSlotToElicit": {
"name": "string",
"subSlotToElicit": "ElicitSubSlot"
},
"type": "string"
},
"intent": {
"confirmationState": "string",
"name": "string",
"slots": {
"string" : {
"shape": "string",
"subSlots": {
"string" : "Slot"
},
"value": {
"interpretedValue": "string",
"originalValue": "string",
"resolvedValues": [ "string" ]
},
"values": [
"Slot"
]
}
},
"state": "string"
},
"originatingRequestId": "string",
"runtimeHints": {
"slotHints": {
"string" : {
"string" : {
"runtimeHintValues": [
{
"phrase": "string"
}
],
"subSlotHints": {
"string" : "RuntimeHintDetails"
}
}
}
}
},
"sessionAttributes": {
"string" : "string"
}
},
"welcomeMessages": [
{
"content": "string",
"contentType": "string",
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
}
}
]
},
"DisconnectionEvent": {
"clientTimestampMillis": number,
"eventId": "string"
},
"DTMFInputEvent": {
"clientTimestampMillis": number,
"eventId": "string",
"inputCharacter": "string"
},
"PlaybackCompletionEvent": {
"clientTimestampMillis": number,
"eventId": "string"
},
"TextInputEvent": {
"clientTimestampMillis": number,
"eventId": "string",
"text": "string"
}
}
```
## URI Request Parameters
The request uses the following URI parameters.
** [botAliasId](#API_runtime_StartConversation_RequestSyntax) **
The alias identifier in use for the bot that processes the request.
Required: Yes
** [botId](#API_runtime_StartConversation_RequestSyntax) **
The identifier of the bot to process the request.
Length Constraints: Fixed length of 10.
Pattern: `^[0-9a-zA-Z]+$`
Required: Yes
** [conversationMode](#API_runtime_StartConversation_RequestSyntax) **
The conversation type that you are using the Amazon Lex V2. If the conversation mode is `AUDIO` you can send both audio and DTMF information. If the mode is `TEXT` you can only send text.
Valid Values: `AUDIO | TEXT`
** [localeId](#API_runtime_StartConversation_RequestSyntax) **
The locale where the session is in use.
Length Constraints: Minimum length of 1.
Required: Yes
** [sessionId](#API_runtime_StartConversation_RequestSyntax) **
The identifier of the user session that is having the conversation.
Length Constraints: Minimum length of 2. Maximum length of 100.
Pattern: `[0-9a-zA-Z._:-]+`
Required: Yes
## Request Body
The request accepts the following data in JSON format.
** [AudioInputEvent](#API_runtime_StartConversation_RequestSyntax) **
Speech audio sent from your client application to Amazon Lex V2. Audio starts accumulating when Amazon Lex V2 identifies a voice and continues until a natural pause in the speech is found before processing.
Type: [AudioInputEvent](API_runtime_AudioInputEvent.md) object
Required: No
** [ConfigurationEvent](#API_runtime_StartConversation_RequestSyntax) **
Configuration information sent from your client application to Amazon Lex V2
Type: [ConfigurationEvent](API_runtime_ConfigurationEvent.md) object
Required: No
** [DisconnectionEvent](#API_runtime_StartConversation_RequestSyntax) **
Event sent from the client application to indicate to Amazon Lex V2 that the conversation is over.
Type: [DisconnectionEvent](API_runtime_DisconnectionEvent.md) object
Required: No
** [DTMFInputEvent](#API_runtime_StartConversation_RequestSyntax) **
DTMF information sent to Amazon Lex V2 by your application. Amazon Lex V2 accumulates the DMTF information from when the user sends the first character and ends
+ when there's a pause longer that the value configured for the end timeout.
+ when there's a digit that is the configured end character.
+ when Amazon Lex V2 accumulates characters equal to the maximum DTMF character configuration.
Type: [DTMFInputEvent](API_runtime_DTMFInputEvent.md) object
Required: No
** [PlaybackCompletionEvent](#API_runtime_StartConversation_RequestSyntax) **
Event sent from the client application to Amazon Lex V2 to indicate that it has finished playing audio and that Amazon Lex V2 should start listening for user input.
Type: [PlaybackCompletionEvent](API_runtime_PlaybackCompletionEvent.md) object
Required: No
** [TextInputEvent](#API_runtime_StartConversation_RequestSyntax) **
Text sent from your client application to Amazon Lex V2. Each `TextInputEvent` is processed individually.
Type: [TextInputEvent](API_runtime_TextInputEvent.md) object
Required: No
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"AccessDeniedException": {
},
"AudioResponseEvent": {
"audioChunk": blob,
"contentType": "string",
"eventId": "string"
},
"BadGatewayException": {
},
"ConflictException": {
},
"DependencyFailedException": {
},
"HeartbeatEvent": {
"eventId": "string"
},
"IntentResultEvent": {
"eventId": "string",
"inputMode": "string",
"interpretations": [
{
"intent": {
"confirmationState": "string",
"name": "string",
"slots": {
"string" : {
"shape": "string",
"subSlots": {
"string" : "Slot"
},
"value": {
"interpretedValue": "string",
"originalValue": "string",
"resolvedValues": [ "string" ]
},
"values": [
"Slot"
]
}
},
"state": "string"
},
"interpretationSource": "string",
"nluConfidence": {
"score": number
},
"sentimentResponse": {
"sentiment": "string",
"sentimentScore": {
"mixed": number,
"negative": number,
"neutral": number,
"positive": number
}
}
}
],
"recognizedBotMember": {
"botId": "string",
"botName": "string"
},
"requestAttributes": {
"string" : "string"
},
"sessionId": "string",
"sessionState": {
"activeContexts": [
{
"contextAttributes": {
"string" : "string"
},
"name": "string",
"timeToLive": {
"timeToLiveInSeconds": number,
"turnsToLive": number
}
}
],
"dialogAction": {
"slotElicitationStyle": "string",
"slotToElicit": "string",
"subSlotToElicit": {
"name": "string",
"subSlotToElicit": "ElicitSubSlot"
},
"type": "string"
},
"intent": {
"confirmationState": "string",
"name": "string",
"slots": {
"string" : {
"shape": "string",
"subSlots": {
"string" : "Slot"
},
"value": {
"interpretedValue": "string",
"originalValue": "string",
"resolvedValues": [ "string" ]
},
"values": [
"Slot"
]
}
},
"state": "string"
},
"originatingRequestId": "string",
"runtimeHints": {
"slotHints": {
"string" : {
"string" : {
"runtimeHintValues": [
{
"phrase": "string"
}
],
"subSlotHints": {
"string" : "RuntimeHintDetails"
}
}
}
}
},
"sessionAttributes": {
"string" : "string"
}
}
},
"InternalServerException": {
},
"PlaybackInterruptionEvent": {
"causedByEventId": "string",
"eventId": "string",
"eventReason": "string"
},
"ResourceNotFoundException": {
},
"TextResponseEvent": {
"eventId": "string",
"messages": [
{
"content": "string",
"contentType": "string",
"imageResponseCard": {
"buttons": [
{
"text": "string",
"value": "string"
}
],
"imageUrl": "string",
"subtitle": "string",
"title": "string"
}
}
]
},
"ThrottlingException": {
},
"TranscriptEvent": {
"eventId": "string",
"transcript": "string"
},
"ValidationException": {
}
}
```
## 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.
** [AccessDeniedException](#API_runtime_StartConversation_ResponseSyntax) **
Exception thrown when the credentials passed with the request are invalid or expired. Also thrown when the credentials in the request do not have permission to access the `StartConversation` operation.
Type: Exception
HTTP Status Code: 403
** [AudioResponseEvent](#API_runtime_StartConversation_ResponseSyntax) **
An event sent from Amazon Lex V2 to your client application containing audio to play to the user.
Type: [AudioResponseEvent](API_runtime_AudioResponseEvent.md) object
** [BadGatewayException](#API_runtime_StartConversation_ResponseSyntax) **
Type: Exception
HTTP Status Code: 502
** [ConflictException](#API_runtime_StartConversation_ResponseSyntax) **
Exception thrown when two clients are using the same AWS account, Amazon Lex V2 bot, and session ID.
Type: Exception
HTTP Status Code: 409
** [DependencyFailedException](#API_runtime_StartConversation_ResponseSyntax) **
Type: Exception
HTTP Status Code: 424
** [HeartbeatEvent](#API_runtime_StartConversation_ResponseSyntax) **
Event that Amazon Lex V2 sends to indicate that the stream is still open between the client application and Amazon Lex V2
Type: [HeartbeatEvent](API_runtime_HeartbeatEvent.md) object
** [IntentResultEvent](#API_runtime_StartConversation_ResponseSyntax) **
Event sent from Amazon Lex V2 to the client application containing the current state of the conversation between the user and Amazon Lex V2.
Type: [IntentResultEvent](API_runtime_IntentResultEvent.md) object
** [InternalServerException](#API_runtime_StartConversation_ResponseSyntax) **
An error occurred with Amazon Lex V2.
Type: Exception
HTTP Status Code: 500
** [PlaybackInterruptionEvent](#API_runtime_StartConversation_ResponseSyntax) **
Event sent from Amazon Lex V2 to indicate to the client application should stop playback of audio. For example, if the client is playing a prompt that asks for the user's telephone number, the user might start to say the phone number before the prompt is complete. Amazon Lex V2 sends this event to the client application to indicate that the user is responding and that Amazon Lex V2 is processing their input.
Type: [PlaybackInterruptionEvent](API_runtime_PlaybackInterruptionEvent.md) object
** [ResourceNotFoundException](#API_runtime_StartConversation_ResponseSyntax) **
Exception thrown if one of the input parameters points to a resource that does not exist. For example, if the bot ID specified does not exist.
Type: Exception
HTTP Status Code: 404
** [TextResponseEvent](#API_runtime_StartConversation_ResponseSyntax) **
The event sent from Amazon Lex V2 to your application with text to present to the user.
Type: [TextResponseEvent](API_runtime_TextResponseEvent.md) object
** [ThrottlingException](#API_runtime_StartConversation_ResponseSyntax) **
Exception thrown when your application exceeds the maximum number of concurrent requests.
Type: Exception
HTTP Status Code: 429
** [TranscriptEvent](#API_runtime_StartConversation_ResponseSyntax) **
Event sent from Amazon Lex V2 to your client application that contains a transcript of voice audio.
Type: [TranscriptEvent](API_runtime_TranscriptEvent.md) object
** [ValidationException](#API_runtime_StartConversation_ResponseSyntax) **
Exception thrown when one or more parameters could not be validated. The `message` contains the name of the field that isn't valid.
Type: Exception
HTTP Status Code: 400
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** AccessDeniedException **
HTTP Status Code: 403
** InternalServerException **
HTTP Status Code: 500
** ThrottlingException **
HTTP Status Code: 429
** ValidationException **
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/runtime.lex.v2-2020-08-07/StartConversation)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/runtime.lex.v2-2020-08-07/StartConversation)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/runtime.lex.v2-2020-08-07/StartConversation)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/runtime.lex.v2-2020-08-07/StartConversation)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/runtime.lex.v2-2020-08-07/StartConversation)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/runtime.lex.v2-2020-08-07/StartConversation)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/runtime.lex.v2-2020-08-07/StartConversation)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/runtime.lex.v2-2020-08-07/StartConversation)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/runtime.lex.v2-2020-08-07/StartConversation)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/runtime.lex.v2-2020-08-07/StartConversation)
# Data Types
The following data types are supported by Amazon Lex Model Building V2:
+ [ActiveContext](API_ActiveContext.md)
+ [AdvancedRecognitionSetting](API_AdvancedRecognitionSetting.md)
+ [AgentTurnResult](API_AgentTurnResult.md)
+ [AgentTurnSpecification](API_AgentTurnSpecification.md)
+ [AggregatedUtterancesFilter](API_AggregatedUtterancesFilter.md)
+ [AggregatedUtterancesSortBy](API_AggregatedUtterancesSortBy.md)
+ [AggregatedUtterancesSummary](API_AggregatedUtterancesSummary.md)
+ [AllowedInputTypes](API_AllowedInputTypes.md)
+ [AnalyticsBinBySpecification](API_AnalyticsBinBySpecification.md)
+ [AnalyticsBinKey](API_AnalyticsBinKey.md)
+ [AnalyticsIntentFilter](API_AnalyticsIntentFilter.md)
+ [AnalyticsIntentGroupByKey](API_AnalyticsIntentGroupByKey.md)
+ [AnalyticsIntentGroupBySpecification](API_AnalyticsIntentGroupBySpecification.md)
+ [AnalyticsIntentMetric](API_AnalyticsIntentMetric.md)
+ [AnalyticsIntentMetricResult](API_AnalyticsIntentMetricResult.md)
+ [AnalyticsIntentNodeSummary](API_AnalyticsIntentNodeSummary.md)
+ [AnalyticsIntentResult](API_AnalyticsIntentResult.md)
+ [AnalyticsIntentStageFilter](API_AnalyticsIntentStageFilter.md)
+ [AnalyticsIntentStageGroupByKey](API_AnalyticsIntentStageGroupByKey.md)
+ [AnalyticsIntentStageGroupBySpecification](API_AnalyticsIntentStageGroupBySpecification.md)
+ [AnalyticsIntentStageMetric](API_AnalyticsIntentStageMetric.md)
+ [AnalyticsIntentStageMetricResult](API_AnalyticsIntentStageMetricResult.md)
+ [AnalyticsIntentStageResult](API_AnalyticsIntentStageResult.md)
+ [AnalyticsPathFilter](API_AnalyticsPathFilter.md)
+ [AnalyticsSessionFilter](API_AnalyticsSessionFilter.md)
+ [AnalyticsSessionGroupByKey](API_AnalyticsSessionGroupByKey.md)
+ [AnalyticsSessionGroupBySpecification](API_AnalyticsSessionGroupBySpecification.md)
+ [AnalyticsSessionMetric](API_AnalyticsSessionMetric.md)
+ [AnalyticsSessionMetricResult](API_AnalyticsSessionMetricResult.md)
+ [AnalyticsSessionResult](API_AnalyticsSessionResult.md)
+ [AnalyticsUtteranceAttribute](API_AnalyticsUtteranceAttribute.md)
+ [AnalyticsUtteranceAttributeResult](API_AnalyticsUtteranceAttributeResult.md)
+ [AnalyticsUtteranceFilter](API_AnalyticsUtteranceFilter.md)
+ [AnalyticsUtteranceGroupByKey](API_AnalyticsUtteranceGroupByKey.md)
+ [AnalyticsUtteranceGroupBySpecification](API_AnalyticsUtteranceGroupBySpecification.md)
+ [AnalyticsUtteranceMetric](API_AnalyticsUtteranceMetric.md)
+ [AnalyticsUtteranceMetricResult](API_AnalyticsUtteranceMetricResult.md)
+ [AnalyticsUtteranceResult](API_AnalyticsUtteranceResult.md)
+ [AssociatedTranscript](API_AssociatedTranscript.md)
+ [AssociatedTranscriptFilter](API_AssociatedTranscriptFilter.md)
+ [AudioAndDTMFInputSpecification](API_AudioAndDTMFInputSpecification.md)
+ [AudioLogDestination](API_AudioLogDestination.md)
+ [AudioLogSetting](API_AudioLogSetting.md)
+ [AudioSpecification](API_AudioSpecification.md)
+ [BedrockGuardrailConfiguration](API_BedrockGuardrailConfiguration.md)
+ [BedrockKnowledgeStoreConfiguration](API_BedrockKnowledgeStoreConfiguration.md)
+ [BedrockKnowledgeStoreExactResponseFields](API_BedrockKnowledgeStoreExactResponseFields.md)
+ [BedrockModelSpecification](API_BedrockModelSpecification.md)
+ [BotAliasHistoryEvent](API_BotAliasHistoryEvent.md)
+ [BotAliasLocaleSettings](API_BotAliasLocaleSettings.md)
+ [BotAliasReplicaSummary](API_BotAliasReplicaSummary.md)
+ [BotAliasSummary](API_BotAliasSummary.md)
+ [BotAliasTestExecutionTarget](API_BotAliasTestExecutionTarget.md)
+ [BotAnalyzerHistorySummary](API_BotAnalyzerHistorySummary.md)
+ [BotAnalyzerRecommendation](API_BotAnalyzerRecommendation.md)
+ [BotExportSpecification](API_BotExportSpecification.md)
+ [BotFilter](API_BotFilter.md)
+ [BotImportSpecification](API_BotImportSpecification.md)
+ [BotLocaleExportSpecification](API_BotLocaleExportSpecification.md)
+ [BotLocaleFilter](API_BotLocaleFilter.md)
+ [BotLocaleHistoryEvent](API_BotLocaleHistoryEvent.md)
+ [BotLocaleImportSpecification](API_BotLocaleImportSpecification.md)
+ [BotLocaleSortBy](API_BotLocaleSortBy.md)
+ [BotLocaleSummary](API_BotLocaleSummary.md)
+ [BotMember](API_BotMember.md)
+ [BotRecommendationResults](API_BotRecommendationResults.md)
+ [BotRecommendationResultStatistics](API_BotRecommendationResultStatistics.md)
+ [BotRecommendationSummary](API_BotRecommendationSummary.md)
+ [BotReplicaSummary](API_BotReplicaSummary.md)
+ [BotSortBy](API_BotSortBy.md)
+ [BotSummary](API_BotSummary.md)
+ [BotVersionLocaleDetails](API_BotVersionLocaleDetails.md)
+ [BotVersionReplicaSortBy](API_BotVersionReplicaSortBy.md)
+ [BotVersionReplicaSummary](API_BotVersionReplicaSummary.md)
+ [BotVersionSortBy](API_BotVersionSortBy.md)
+ [BotVersionSummary](API_BotVersionSummary.md)
+ [BuildtimeSettings](API_BuildtimeSettings.md)
+ [BuiltInIntentSortBy](API_BuiltInIntentSortBy.md)
+ [BuiltInIntentSummary](API_BuiltInIntentSummary.md)
+ [BuiltInSlotTypeSortBy](API_BuiltInSlotTypeSortBy.md)
+ [BuiltInSlotTypeSummary](API_BuiltInSlotTypeSummary.md)
+ [Button](API_Button.md)
+ [CloudWatchLogGroupLogDestination](API_CloudWatchLogGroupLogDestination.md)
+ [CodeHookSpecification](API_CodeHookSpecification.md)
+ [CompositeSlotTypeSetting](API_CompositeSlotTypeSetting.md)
+ [Condition](API_Condition.md)
+ [ConditionalBranch](API_ConditionalBranch.md)
+ [ConditionalSpecification](API_ConditionalSpecification.md)
+ [ConversationLevelIntentClassificationResultItem](API_ConversationLevelIntentClassificationResultItem.md)
+ [ConversationLevelResultDetail](API_ConversationLevelResultDetail.md)
+ [ConversationLevelSlotResolutionResultItem](API_ConversationLevelSlotResolutionResultItem.md)
+ [ConversationLevelTestResultItem](API_ConversationLevelTestResultItem.md)
+ [ConversationLevelTestResults](API_ConversationLevelTestResults.md)
+ [ConversationLevelTestResultsFilterBy](API_ConversationLevelTestResultsFilterBy.md)
+ [ConversationLogsDataSource](API_ConversationLogsDataSource.md)
+ [ConversationLogsDataSourceFilterBy](API_ConversationLogsDataSourceFilterBy.md)
+ [ConversationLogSettings](API_ConversationLogSettings.md)
+ [CustomPayload](API_CustomPayload.md)
+ [CustomVocabularyEntryId](API_CustomVocabularyEntryId.md)
+ [CustomVocabularyExportSpecification](API_CustomVocabularyExportSpecification.md)
+ [CustomVocabularyImportSpecification](API_CustomVocabularyImportSpecification.md)
+ [CustomVocabularyItem](API_CustomVocabularyItem.md)
+ [DataPrivacy](API_DataPrivacy.md)
+ [DataSourceConfiguration](API_DataSourceConfiguration.md)
+ [DateRangeFilter](API_DateRangeFilter.md)
+ [DeepgramSpeechModelConfig](API_DeepgramSpeechModelConfig.md)
+ [DefaultConditionalBranch](API_DefaultConditionalBranch.md)
+ [DescriptiveBotBuilderSpecification](API_DescriptiveBotBuilderSpecification.md)
+ [DialogAction](API_DialogAction.md)
+ [DialogCodeHookInvocationSetting](API_DialogCodeHookInvocationSetting.md)
+ [DialogCodeHookSettings](API_DialogCodeHookSettings.md)
+ [DialogState](API_DialogState.md)
+ [DTMFSpecification](API_DTMFSpecification.md)
+ [ElicitationCodeHookInvocationSetting](API_ElicitationCodeHookInvocationSetting.md)
+ [EncryptionSetting](API_EncryptionSetting.md)
+ [ErrorLogSettings](API_ErrorLogSettings.md)
+ [ExactResponseFields](API_ExactResponseFields.md)
+ [ExecutionErrorDetails](API_ExecutionErrorDetails.md)
+ [ExportFilter](API_ExportFilter.md)
+ [ExportResourceSpecification](API_ExportResourceSpecification.md)
+ [ExportSortBy](API_ExportSortBy.md)
+ [ExportSummary](API_ExportSummary.md)
+ [ExternalSourceSetting](API_ExternalSourceSetting.md)
+ [FailedCustomVocabularyItem](API_FailedCustomVocabularyItem.md)
+ [FulfillmentCodeHookSettings](API_FulfillmentCodeHookSettings.md)
+ [FulfillmentStartResponseSpecification](API_FulfillmentStartResponseSpecification.md)
+ [FulfillmentUpdateResponseSpecification](API_FulfillmentUpdateResponseSpecification.md)
+ [FulfillmentUpdatesSpecification](API_FulfillmentUpdatesSpecification.md)
+ [GenerationSortBy](API_GenerationSortBy.md)
+ [GenerationSummary](API_GenerationSummary.md)
+ [GenerativeAISettings](API_GenerativeAISettings.md)
+ [GrammarSlotTypeSetting](API_GrammarSlotTypeSetting.md)
+ [GrammarSlotTypeSource](API_GrammarSlotTypeSource.md)
+ [ImageResponseCard](API_ImageResponseCard.md)
+ [ImportFilter](API_ImportFilter.md)
+ [ImportResourceSpecification](API_ImportResourceSpecification.md)
+ [ImportSortBy](API_ImportSortBy.md)
+ [ImportSummary](API_ImportSummary.md)
+ [InitialResponseSetting](API_InitialResponseSetting.md)
+ [InputContext](API_InputContext.md)
+ [InputSessionStateSpecification](API_InputSessionStateSpecification.md)
+ [IntentClassificationTestResultItem](API_IntentClassificationTestResultItem.md)
+ [IntentClassificationTestResultItemCounts](API_IntentClassificationTestResultItemCounts.md)
+ [IntentClassificationTestResults](API_IntentClassificationTestResults.md)
+ [IntentClosingSetting](API_IntentClosingSetting.md)
+ [IntentConfirmationSetting](API_IntentConfirmationSetting.md)
+ [IntentDisambiguationSettings](API_IntentDisambiguationSettings.md)
+ [IntentFilter](API_IntentFilter.md)
+ [IntentLevelSlotResolutionTestResultItem](API_IntentLevelSlotResolutionTestResultItem.md)
+ [IntentLevelSlotResolutionTestResults](API_IntentLevelSlotResolutionTestResults.md)
+ [IntentOverride](API_IntentOverride.md)
+ [IntentSortBy](API_IntentSortBy.md)
+ [IntentStatistics](API_IntentStatistics.md)
+ [IntentSummary](API_IntentSummary.md)
+ [InvokedIntentSample](API_InvokedIntentSample.md)
+ [IssueLocation](API_IssueLocation.md)
+ [KendraConfiguration](API_KendraConfiguration.md)
+ [LambdaCodeHook](API_LambdaCodeHook.md)
+ [LexTranscriptFilter](API_LexTranscriptFilter.md)
+ [Message](API_Message.md)
+ [MessageGroup](API_MessageGroup.md)
+ [MultipleValuesSetting](API_MultipleValuesSetting.md)
+ [NewCustomVocabularyItem](API_NewCustomVocabularyItem.md)
+ [NluImprovementSpecification](API_NluImprovementSpecification.md)
+ [ObfuscationSetting](API_ObfuscationSetting.md)
+ [OpensearchConfiguration](API_OpensearchConfiguration.md)
+ [OutputContext](API_OutputContext.md)
+ [OverallTestResultItem](API_OverallTestResultItem.md)
+ [OverallTestResults](API_OverallTestResults.md)
+ [ParentBotNetwork](API_ParentBotNetwork.md)
+ [PathFormat](API_PathFormat.md)
+ [PlainTextMessage](API_PlainTextMessage.md)
+ [PostDialogCodeHookInvocationSpecification](API_PostDialogCodeHookInvocationSpecification.md)
+ [PostFulfillmentStatusSpecification](API_PostFulfillmentStatusSpecification.md)
+ [Principal](API_Principal.md)
+ [PromptAttemptSpecification](API_PromptAttemptSpecification.md)
+ [PromptSpecification](API_PromptSpecification.md)
+ [QInConnectAssistantConfiguration](API_QInConnectAssistantConfiguration.md)
+ [QInConnectIntentConfiguration](API_QInConnectIntentConfiguration.md)
+ [QnAIntentConfiguration](API_QnAIntentConfiguration.md)
+ [QnAKendraConfiguration](API_QnAKendraConfiguration.md)
+ [RecommendedIntentSummary](API_RecommendedIntentSummary.md)
+ [RelativeAggregationDuration](API_RelativeAggregationDuration.md)
+ [ResponseSpecification](API_ResponseSpecification.md)
+ [RuntimeHintDetails](API_RuntimeHintDetails.md)
+ [RuntimeHints](API_RuntimeHints.md)
+ [RuntimeHintValue](API_RuntimeHintValue.md)
+ [RuntimeSettings](API_RuntimeSettings.md)
+ [S3BucketLogDestination](API_S3BucketLogDestination.md)
+ [S3BucketTranscriptSource](API_S3BucketTranscriptSource.md)
+ [SampleUtterance](API_SampleUtterance.md)
+ [SampleUtteranceGenerationSpecification](API_SampleUtteranceGenerationSpecification.md)
+ [SampleValue](API_SampleValue.md)
+ [SentimentAnalysisSettings](API_SentimentAnalysisSettings.md)
+ [SessionDataSortBy](API_SessionDataSortBy.md)
+ [SessionSpecification](API_SessionSpecification.md)
+ [SlotCaptureSetting](API_SlotCaptureSetting.md)
+ [SlotDefaultValue](API_SlotDefaultValue.md)
+ [SlotDefaultValueSpecification](API_SlotDefaultValueSpecification.md)
+ [SlotFilter](API_SlotFilter.md)
+ [SlotPriority](API_SlotPriority.md)
+ [SlotResolutionImprovementSpecification](API_SlotResolutionImprovementSpecification.md)
+ [SlotResolutionSetting](API_SlotResolutionSetting.md)
+ [SlotResolutionTestResultItem](API_SlotResolutionTestResultItem.md)
+ [SlotResolutionTestResultItemCounts](API_SlotResolutionTestResultItemCounts.md)
+ [SlotSortBy](API_SlotSortBy.md)
+ [SlotSummary](API_SlotSummary.md)
+ [SlotTypeFilter](API_SlotTypeFilter.md)
+ [SlotTypeSortBy](API_SlotTypeSortBy.md)
+ [SlotTypeStatistics](API_SlotTypeStatistics.md)
+ [SlotTypeSummary](API_SlotTypeSummary.md)
+ [SlotTypeValue](API_SlotTypeValue.md)
+ [SlotValue](API_SlotValue.md)
+ [SlotValueElicitationSetting](API_SlotValueElicitationSetting.md)
+ [SlotValueOverride](API_SlotValueOverride.md)
+ [SlotValueRegexFilter](API_SlotValueRegexFilter.md)
+ [SlotValueSelectionSetting](API_SlotValueSelectionSetting.md)
+ [Specifications](API_Specifications.md)
+ [SpeechFoundationModel](API_SpeechFoundationModel.md)
+ [SpeechModelConfig](API_SpeechModelConfig.md)
+ [SpeechRecognitionSettings](API_SpeechRecognitionSettings.md)
+ [SSMLMessage](API_SSMLMessage.md)
+ [StillWaitingResponseSpecification](API_StillWaitingResponseSpecification.md)
+ [SubSlotSetting](API_SubSlotSetting.md)
+ [SubSlotTypeComposition](API_SubSlotTypeComposition.md)
+ [SubSlotValueElicitationSetting](API_SubSlotValueElicitationSetting.md)
+ [TestExecutionResultFilterBy](API_TestExecutionResultFilterBy.md)
+ [TestExecutionResultItems](API_TestExecutionResultItems.md)
+ [TestExecutionSortBy](API_TestExecutionSortBy.md)
+ [TestExecutionSummary](API_TestExecutionSummary.md)
+ [TestExecutionTarget](API_TestExecutionTarget.md)
+ [TestSetDiscrepancyErrors](API_TestSetDiscrepancyErrors.md)
+ [TestSetDiscrepancyReportBotAliasTarget](API_TestSetDiscrepancyReportBotAliasTarget.md)
+ [TestSetDiscrepancyReportResourceTarget](API_TestSetDiscrepancyReportResourceTarget.md)
+ [TestSetExportSpecification](API_TestSetExportSpecification.md)
+ [TestSetGenerationDataSource](API_TestSetGenerationDataSource.md)
+ [TestSetImportInputLocation](API_TestSetImportInputLocation.md)
+ [TestSetImportResourceSpecification](API_TestSetImportResourceSpecification.md)
+ [TestSetIntentDiscrepancyItem](API_TestSetIntentDiscrepancyItem.md)
+ [TestSetSlotDiscrepancyItem](API_TestSetSlotDiscrepancyItem.md)
+ [TestSetSortBy](API_TestSetSortBy.md)
+ [TestSetStorageLocation](API_TestSetStorageLocation.md)
+ [TestSetSummary](API_TestSetSummary.md)
+ [TestSetTurnRecord](API_TestSetTurnRecord.md)
+ [TestSetTurnResult](API_TestSetTurnResult.md)
+ [TextInputSpecification](API_TextInputSpecification.md)
+ [TextLogDestination](API_TextLogDestination.md)
+ [TextLogSetting](API_TextLogSetting.md)
+ [TranscriptFilter](API_TranscriptFilter.md)
+ [TranscriptSourceSetting](API_TranscriptSourceSetting.md)
+ [TurnSpecification](API_TurnSpecification.md)
+ [UnifiedSpeechSettings](API_UnifiedSpeechSettings.md)
+ [UserTurnInputSpecification](API_UserTurnInputSpecification.md)
+ [UserTurnIntentOutput](API_UserTurnIntentOutput.md)
+ [UserTurnOutputSpecification](API_UserTurnOutputSpecification.md)
+ [UserTurnResult](API_UserTurnResult.md)
+ [UserTurnSlotOutput](API_UserTurnSlotOutput.md)
+ [UserTurnSpecification](API_UserTurnSpecification.md)
+ [UtteranceAggregationDuration](API_UtteranceAggregationDuration.md)
+ [UtteranceAudioInputSpecification](API_UtteranceAudioInputSpecification.md)
+ [UtteranceBotResponse](API_UtteranceBotResponse.md)
+ [UtteranceDataSortBy](API_UtteranceDataSortBy.md)
+ [UtteranceInputSpecification](API_UtteranceInputSpecification.md)
+ [UtteranceLevelTestResultItem](API_UtteranceLevelTestResultItem.md)
+ [UtteranceLevelTestResults](API_UtteranceLevelTestResults.md)
+ [UtteranceSpecification](API_UtteranceSpecification.md)
+ [VoiceSettings](API_VoiceSettings.md)
+ [WaitAndContinueSpecification](API_WaitAndContinueSpecification.md)
The following data types are supported by Amazon Lex Runtime V2:
+ [ActiveContext](API_runtime_ActiveContext.md)
+ [ActiveContextTimeToLive](API_runtime_ActiveContextTimeToLive.md)
+ [AudioInputEvent](API_runtime_AudioInputEvent.md)
+ [AudioResponseEvent](API_runtime_AudioResponseEvent.md)
+ [Button](API_runtime_Button.md)
+ [ConfidenceScore](API_runtime_ConfidenceScore.md)
+ [ConfigurationEvent](API_runtime_ConfigurationEvent.md)
+ [DialogAction](API_runtime_DialogAction.md)
+ [DisconnectionEvent](API_runtime_DisconnectionEvent.md)
+ [DTMFInputEvent](API_runtime_DTMFInputEvent.md)
+ [ElicitSubSlot](API_runtime_ElicitSubSlot.md)
+ [HeartbeatEvent](API_runtime_HeartbeatEvent.md)
+ [ImageResponseCard](API_runtime_ImageResponseCard.md)
+ [Intent](API_runtime_Intent.md)
+ [IntentResultEvent](API_runtime_IntentResultEvent.md)
+ [Interpretation](API_runtime_Interpretation.md)
+ [Message](API_runtime_Message.md)
+ [PlaybackCompletionEvent](API_runtime_PlaybackCompletionEvent.md)
+ [PlaybackInterruptionEvent](API_runtime_PlaybackInterruptionEvent.md)
+ [RecognizedBotMember](API_runtime_RecognizedBotMember.md)
+ [RuntimeHintDetails](API_runtime_RuntimeHintDetails.md)
+ [RuntimeHints](API_runtime_RuntimeHints.md)
+ [RuntimeHintValue](API_runtime_RuntimeHintValue.md)
+ [SentimentResponse](API_runtime_SentimentResponse.md)
+ [SentimentScore](API_runtime_SentimentScore.md)
+ [SessionState](API_runtime_SessionState.md)
+ [Slot](API_runtime_Slot.md)
+ [StartConversationRequestEventStream](API_runtime_StartConversationRequestEventStream.md)
+ [StartConversationResponseEventStream](API_runtime_StartConversationResponseEventStream.md)
+ [TextInputEvent](API_runtime_TextInputEvent.md)
+ [TextResponseEvent](API_runtime_TextResponseEvent.md)
+ [TranscriptEvent](API_runtime_TranscriptEvent.md)
+ [Value](API_runtime_Value.md)
# Amazon Lex Model Building V2
The following data types are supported by Amazon Lex Model Building V2:
+ [ActiveContext](API_ActiveContext.md)
+ [AdvancedRecognitionSetting](API_AdvancedRecognitionSetting.md)
+ [AgentTurnResult](API_AgentTurnResult.md)
+ [AgentTurnSpecification](API_AgentTurnSpecification.md)
+ [AggregatedUtterancesFilter](API_AggregatedUtterancesFilter.md)
+ [AggregatedUtterancesSortBy](API_AggregatedUtterancesSortBy.md)
+ [AggregatedUtterancesSummary](API_AggregatedUtterancesSummary.md)
+ [AllowedInputTypes](API_AllowedInputTypes.md)
+ [AnalyticsBinBySpecification](API_AnalyticsBinBySpecification.md)
+ [AnalyticsBinKey](API_AnalyticsBinKey.md)
+ [AnalyticsIntentFilter](API_AnalyticsIntentFilter.md)
+ [AnalyticsIntentGroupByKey](API_AnalyticsIntentGroupByKey.md)
+ [AnalyticsIntentGroupBySpecification](API_AnalyticsIntentGroupBySpecification.md)
+ [AnalyticsIntentMetric](API_AnalyticsIntentMetric.md)
+ [AnalyticsIntentMetricResult](API_AnalyticsIntentMetricResult.md)
+ [AnalyticsIntentNodeSummary](API_AnalyticsIntentNodeSummary.md)
+ [AnalyticsIntentResult](API_AnalyticsIntentResult.md)
+ [AnalyticsIntentStageFilter](API_AnalyticsIntentStageFilter.md)
+ [AnalyticsIntentStageGroupByKey](API_AnalyticsIntentStageGroupByKey.md)
+ [AnalyticsIntentStageGroupBySpecification](API_AnalyticsIntentStageGroupBySpecification.md)
+ [AnalyticsIntentStageMetric](API_AnalyticsIntentStageMetric.md)
+ [AnalyticsIntentStageMetricResult](API_AnalyticsIntentStageMetricResult.md)
+ [AnalyticsIntentStageResult](API_AnalyticsIntentStageResult.md)
+ [AnalyticsPathFilter](API_AnalyticsPathFilter.md)
+ [AnalyticsSessionFilter](API_AnalyticsSessionFilter.md)
+ [AnalyticsSessionGroupByKey](API_AnalyticsSessionGroupByKey.md)
+ [AnalyticsSessionGroupBySpecification](API_AnalyticsSessionGroupBySpecification.md)
+ [AnalyticsSessionMetric](API_AnalyticsSessionMetric.md)
+ [AnalyticsSessionMetricResult](API_AnalyticsSessionMetricResult.md)
+ [AnalyticsSessionResult](API_AnalyticsSessionResult.md)
+ [AnalyticsUtteranceAttribute](API_AnalyticsUtteranceAttribute.md)
+ [AnalyticsUtteranceAttributeResult](API_AnalyticsUtteranceAttributeResult.md)
+ [AnalyticsUtteranceFilter](API_AnalyticsUtteranceFilter.md)
+ [AnalyticsUtteranceGroupByKey](API_AnalyticsUtteranceGroupByKey.md)
+ [AnalyticsUtteranceGroupBySpecification](API_AnalyticsUtteranceGroupBySpecification.md)
+ [AnalyticsUtteranceMetric](API_AnalyticsUtteranceMetric.md)
+ [AnalyticsUtteranceMetricResult](API_AnalyticsUtteranceMetricResult.md)
+ [AnalyticsUtteranceResult](API_AnalyticsUtteranceResult.md)
+ [AssociatedTranscript](API_AssociatedTranscript.md)
+ [AssociatedTranscriptFilter](API_AssociatedTranscriptFilter.md)
+ [AudioAndDTMFInputSpecification](API_AudioAndDTMFInputSpecification.md)
+ [AudioLogDestination](API_AudioLogDestination.md)
+ [AudioLogSetting](API_AudioLogSetting.md)
+ [AudioSpecification](API_AudioSpecification.md)
+ [BedrockGuardrailConfiguration](API_BedrockGuardrailConfiguration.md)
+ [BedrockKnowledgeStoreConfiguration](API_BedrockKnowledgeStoreConfiguration.md)
+ [BedrockKnowledgeStoreExactResponseFields](API_BedrockKnowledgeStoreExactResponseFields.md)
+ [BedrockModelSpecification](API_BedrockModelSpecification.md)
+ [BotAliasHistoryEvent](API_BotAliasHistoryEvent.md)
+ [BotAliasLocaleSettings](API_BotAliasLocaleSettings.md)
+ [BotAliasReplicaSummary](API_BotAliasReplicaSummary.md)
+ [BotAliasSummary](API_BotAliasSummary.md)
+ [BotAliasTestExecutionTarget](API_BotAliasTestExecutionTarget.md)
+ [BotAnalyzerHistorySummary](API_BotAnalyzerHistorySummary.md)
+ [BotAnalyzerRecommendation](API_BotAnalyzerRecommendation.md)
+ [BotExportSpecification](API_BotExportSpecification.md)
+ [BotFilter](API_BotFilter.md)
+ [BotImportSpecification](API_BotImportSpecification.md)
+ [BotLocaleExportSpecification](API_BotLocaleExportSpecification.md)
+ [BotLocaleFilter](API_BotLocaleFilter.md)
+ [BotLocaleHistoryEvent](API_BotLocaleHistoryEvent.md)
+ [BotLocaleImportSpecification](API_BotLocaleImportSpecification.md)
+ [BotLocaleSortBy](API_BotLocaleSortBy.md)
+ [BotLocaleSummary](API_BotLocaleSummary.md)
+ [BotMember](API_BotMember.md)
+ [BotRecommendationResults](API_BotRecommendationResults.md)
+ [BotRecommendationResultStatistics](API_BotRecommendationResultStatistics.md)
+ [BotRecommendationSummary](API_BotRecommendationSummary.md)
+ [BotReplicaSummary](API_BotReplicaSummary.md)
+ [BotSortBy](API_BotSortBy.md)
+ [BotSummary](API_BotSummary.md)
+ [BotVersionLocaleDetails](API_BotVersionLocaleDetails.md)
+ [BotVersionReplicaSortBy](API_BotVersionReplicaSortBy.md)
+ [BotVersionReplicaSummary](API_BotVersionReplicaSummary.md)
+ [BotVersionSortBy](API_BotVersionSortBy.md)
+ [BotVersionSummary](API_BotVersionSummary.md)
+ [BuildtimeSettings](API_BuildtimeSettings.md)
+ [BuiltInIntentSortBy](API_BuiltInIntentSortBy.md)
+ [BuiltInIntentSummary](API_BuiltInIntentSummary.md)
+ [BuiltInSlotTypeSortBy](API_BuiltInSlotTypeSortBy.md)
+ [BuiltInSlotTypeSummary](API_BuiltInSlotTypeSummary.md)
+ [Button](API_Button.md)
+ [CloudWatchLogGroupLogDestination](API_CloudWatchLogGroupLogDestination.md)
+ [CodeHookSpecification](API_CodeHookSpecification.md)
+ [CompositeSlotTypeSetting](API_CompositeSlotTypeSetting.md)
+ [Condition](API_Condition.md)
+ [ConditionalBranch](API_ConditionalBranch.md)
+ [ConditionalSpecification](API_ConditionalSpecification.md)
+ [ConversationLevelIntentClassificationResultItem](API_ConversationLevelIntentClassificationResultItem.md)
+ [ConversationLevelResultDetail](API_ConversationLevelResultDetail.md)
+ [ConversationLevelSlotResolutionResultItem](API_ConversationLevelSlotResolutionResultItem.md)
+ [ConversationLevelTestResultItem](API_ConversationLevelTestResultItem.md)
+ [ConversationLevelTestResults](API_ConversationLevelTestResults.md)
+ [ConversationLevelTestResultsFilterBy](API_ConversationLevelTestResultsFilterBy.md)
+ [ConversationLogsDataSource](API_ConversationLogsDataSource.md)
+ [ConversationLogsDataSourceFilterBy](API_ConversationLogsDataSourceFilterBy.md)
+ [ConversationLogSettings](API_ConversationLogSettings.md)
+ [CustomPayload](API_CustomPayload.md)
+ [CustomVocabularyEntryId](API_CustomVocabularyEntryId.md)
+ [CustomVocabularyExportSpecification](API_CustomVocabularyExportSpecification.md)
+ [CustomVocabularyImportSpecification](API_CustomVocabularyImportSpecification.md)
+ [CustomVocabularyItem](API_CustomVocabularyItem.md)
+ [DataPrivacy](API_DataPrivacy.md)
+ [DataSourceConfiguration](API_DataSourceConfiguration.md)
+ [DateRangeFilter](API_DateRangeFilter.md)
+ [DeepgramSpeechModelConfig](API_DeepgramSpeechModelConfig.md)
+ [DefaultConditionalBranch](API_DefaultConditionalBranch.md)
+ [DescriptiveBotBuilderSpecification](API_DescriptiveBotBuilderSpecification.md)
+ [DialogAction](API_DialogAction.md)
+ [DialogCodeHookInvocationSetting](API_DialogCodeHookInvocationSetting.md)
+ [DialogCodeHookSettings](API_DialogCodeHookSettings.md)
+ [DialogState](API_DialogState.md)
+ [DTMFSpecification](API_DTMFSpecification.md)
+ [ElicitationCodeHookInvocationSetting](API_ElicitationCodeHookInvocationSetting.md)
+ [EncryptionSetting](API_EncryptionSetting.md)
+ [ErrorLogSettings](API_ErrorLogSettings.md)
+ [ExactResponseFields](API_ExactResponseFields.md)
+ [ExecutionErrorDetails](API_ExecutionErrorDetails.md)
+ [ExportFilter](API_ExportFilter.md)
+ [ExportResourceSpecification](API_ExportResourceSpecification.md)
+ [ExportSortBy](API_ExportSortBy.md)
+ [ExportSummary](API_ExportSummary.md)
+ [ExternalSourceSetting](API_ExternalSourceSetting.md)
+ [FailedCustomVocabularyItem](API_FailedCustomVocabularyItem.md)
+ [FulfillmentCodeHookSettings](API_FulfillmentCodeHookSettings.md)
+ [FulfillmentStartResponseSpecification](API_FulfillmentStartResponseSpecification.md)
+ [FulfillmentUpdateResponseSpecification](API_FulfillmentUpdateResponseSpecification.md)
+ [FulfillmentUpdatesSpecification](API_FulfillmentUpdatesSpecification.md)
+ [GenerationSortBy](API_GenerationSortBy.md)
+ [GenerationSummary](API_GenerationSummary.md)
+ [GenerativeAISettings](API_GenerativeAISettings.md)
+ [GrammarSlotTypeSetting](API_GrammarSlotTypeSetting.md)
+ [GrammarSlotTypeSource](API_GrammarSlotTypeSource.md)
+ [ImageResponseCard](API_ImageResponseCard.md)
+ [ImportFilter](API_ImportFilter.md)
+ [ImportResourceSpecification](API_ImportResourceSpecification.md)
+ [ImportSortBy](API_ImportSortBy.md)
+ [ImportSummary](API_ImportSummary.md)
+ [InitialResponseSetting](API_InitialResponseSetting.md)
+ [InputContext](API_InputContext.md)
+ [InputSessionStateSpecification](API_InputSessionStateSpecification.md)
+ [IntentClassificationTestResultItem](API_IntentClassificationTestResultItem.md)
+ [IntentClassificationTestResultItemCounts](API_IntentClassificationTestResultItemCounts.md)
+ [IntentClassificationTestResults](API_IntentClassificationTestResults.md)
+ [IntentClosingSetting](API_IntentClosingSetting.md)
+ [IntentConfirmationSetting](API_IntentConfirmationSetting.md)
+ [IntentDisambiguationSettings](API_IntentDisambiguationSettings.md)
+ [IntentFilter](API_IntentFilter.md)
+ [IntentLevelSlotResolutionTestResultItem](API_IntentLevelSlotResolutionTestResultItem.md)
+ [IntentLevelSlotResolutionTestResults](API_IntentLevelSlotResolutionTestResults.md)
+ [IntentOverride](API_IntentOverride.md)
+ [IntentSortBy](API_IntentSortBy.md)
+ [IntentStatistics](API_IntentStatistics.md)
+ [IntentSummary](API_IntentSummary.md)
+ [InvokedIntentSample](API_InvokedIntentSample.md)
+ [IssueLocation](API_IssueLocation.md)
+ [KendraConfiguration](API_KendraConfiguration.md)
+ [LambdaCodeHook](API_LambdaCodeHook.md)
+ [LexTranscriptFilter](API_LexTranscriptFilter.md)
+ [Message](API_Message.md)
+ [MessageGroup](API_MessageGroup.md)
+ [MultipleValuesSetting](API_MultipleValuesSetting.md)
+ [NewCustomVocabularyItem](API_NewCustomVocabularyItem.md)
+ [NluImprovementSpecification](API_NluImprovementSpecification.md)
+ [ObfuscationSetting](API_ObfuscationSetting.md)
+ [OpensearchConfiguration](API_OpensearchConfiguration.md)
+ [OutputContext](API_OutputContext.md)
+ [OverallTestResultItem](API_OverallTestResultItem.md)
+ [OverallTestResults](API_OverallTestResults.md)
+ [ParentBotNetwork](API_ParentBotNetwork.md)
+ [PathFormat](API_PathFormat.md)
+ [PlainTextMessage](API_PlainTextMessage.md)
+ [PostDialogCodeHookInvocationSpecification](API_PostDialogCodeHookInvocationSpecification.md)
+ [PostFulfillmentStatusSpecification](API_PostFulfillmentStatusSpecification.md)
+ [Principal](API_Principal.md)
+ [PromptAttemptSpecification](API_PromptAttemptSpecification.md)
+ [PromptSpecification](API_PromptSpecification.md)
+ [QInConnectAssistantConfiguration](API_QInConnectAssistantConfiguration.md)
+ [QInConnectIntentConfiguration](API_QInConnectIntentConfiguration.md)
+ [QnAIntentConfiguration](API_QnAIntentConfiguration.md)
+ [QnAKendraConfiguration](API_QnAKendraConfiguration.md)
+ [RecommendedIntentSummary](API_RecommendedIntentSummary.md)
+ [RelativeAggregationDuration](API_RelativeAggregationDuration.md)
+ [ResponseSpecification](API_ResponseSpecification.md)
+ [RuntimeHintDetails](API_RuntimeHintDetails.md)
+ [RuntimeHints](API_RuntimeHints.md)
+ [RuntimeHintValue](API_RuntimeHintValue.md)
+ [RuntimeSettings](API_RuntimeSettings.md)
+ [S3BucketLogDestination](API_S3BucketLogDestination.md)
+ [S3BucketTranscriptSource](API_S3BucketTranscriptSource.md)
+ [SampleUtterance](API_SampleUtterance.md)
+ [SampleUtteranceGenerationSpecification](API_SampleUtteranceGenerationSpecification.md)
+ [SampleValue](API_SampleValue.md)
+ [SentimentAnalysisSettings](API_SentimentAnalysisSettings.md)
+ [SessionDataSortBy](API_SessionDataSortBy.md)
+ [SessionSpecification](API_SessionSpecification.md)
+ [SlotCaptureSetting](API_SlotCaptureSetting.md)
+ [SlotDefaultValue](API_SlotDefaultValue.md)
+ [SlotDefaultValueSpecification](API_SlotDefaultValueSpecification.md)
+ [SlotFilter](API_SlotFilter.md)
+ [SlotPriority](API_SlotPriority.md)
+ [SlotResolutionImprovementSpecification](API_SlotResolutionImprovementSpecification.md)
+ [SlotResolutionSetting](API_SlotResolutionSetting.md)
+ [SlotResolutionTestResultItem](API_SlotResolutionTestResultItem.md)
+ [SlotResolutionTestResultItemCounts](API_SlotResolutionTestResultItemCounts.md)
+ [SlotSortBy](API_SlotSortBy.md)
+ [SlotSummary](API_SlotSummary.md)
+ [SlotTypeFilter](API_SlotTypeFilter.md)
+ [SlotTypeSortBy](API_SlotTypeSortBy.md)
+ [SlotTypeStatistics](API_SlotTypeStatistics.md)
+ [SlotTypeSummary](API_SlotTypeSummary.md)
+ [SlotTypeValue](API_SlotTypeValue.md)
+ [SlotValue](API_SlotValue.md)
+ [SlotValueElicitationSetting](API_SlotValueElicitationSetting.md)
+ [SlotValueOverride](API_SlotValueOverride.md)
+ [SlotValueRegexFilter](API_SlotValueRegexFilter.md)
+ [SlotValueSelectionSetting](API_SlotValueSelectionSetting.md)
+ [Specifications](API_Specifications.md)
+ [SpeechFoundationModel](API_SpeechFoundationModel.md)
+ [SpeechModelConfig](API_SpeechModelConfig.md)
+ [SpeechRecognitionSettings](API_SpeechRecognitionSettings.md)
+ [SSMLMessage](API_SSMLMessage.md)
+ [StillWaitingResponseSpecification](API_StillWaitingResponseSpecification.md)
+ [SubSlotSetting](API_SubSlotSetting.md)
+ [SubSlotTypeComposition](API_SubSlotTypeComposition.md)
+ [SubSlotValueElicitationSetting](API_SubSlotValueElicitationSetting.md)
+ [TestExecutionResultFilterBy](API_TestExecutionResultFilterBy.md)
+ [TestExecutionResultItems](API_TestExecutionResultItems.md)
+ [TestExecutionSortBy](API_TestExecutionSortBy.md)
+ [TestExecutionSummary](API_TestExecutionSummary.md)
+ [TestExecutionTarget](API_TestExecutionTarget.md)
+ [TestSetDiscrepancyErrors](API_TestSetDiscrepancyErrors.md)
+ [TestSetDiscrepancyReportBotAliasTarget](API_TestSetDiscrepancyReportBotAliasTarget.md)
+ [TestSetDiscrepancyReportResourceTarget](API_TestSetDiscrepancyReportResourceTarget.md)
+ [TestSetExportSpecification](API_TestSetExportSpecification.md)
+ [TestSetGenerationDataSource](API_TestSetGenerationDataSource.md)
+ [TestSetImportInputLocation](API_TestSetImportInputLocation.md)
+ [TestSetImportResourceSpecification](API_TestSetImportResourceSpecification.md)
+ [TestSetIntentDiscrepancyItem](API_TestSetIntentDiscrepancyItem.md)
+ [TestSetSlotDiscrepancyItem](API_TestSetSlotDiscrepancyItem.md)
+ [TestSetSortBy](API_TestSetSortBy.md)
+ [TestSetStorageLocation](API_TestSetStorageLocation.md)
+ [TestSetSummary](API_TestSetSummary.md)
+ [TestSetTurnRecord](API_TestSetTurnRecord.md)
+ [TestSetTurnResult](API_TestSetTurnResult.md)
+ [TextInputSpecification](API_TextInputSpecification.md)
+ [TextLogDestination](API_TextLogDestination.md)
+ [TextLogSetting](API_TextLogSetting.md)
+ [TranscriptFilter](API_TranscriptFilter.md)
+ [TranscriptSourceSetting](API_TranscriptSourceSetting.md)
+ [TurnSpecification](API_TurnSpecification.md)
+ [UnifiedSpeechSettings](API_UnifiedSpeechSettings.md)
+ [UserTurnInputSpecification](API_UserTurnInputSpecification.md)
+ [UserTurnIntentOutput](API_UserTurnIntentOutput.md)
+ [UserTurnOutputSpecification](API_UserTurnOutputSpecification.md)
+ [UserTurnResult](API_UserTurnResult.md)
+ [UserTurnSlotOutput](API_UserTurnSlotOutput.md)
+ [UserTurnSpecification](API_UserTurnSpecification.md)
+ [UtteranceAggregationDuration](API_UtteranceAggregationDuration.md)
+ [UtteranceAudioInputSpecification](API_UtteranceAudioInputSpecification.md)
+ [UtteranceBotResponse](API_UtteranceBotResponse.md)
+ [UtteranceDataSortBy](API_UtteranceDataSortBy.md)
+ [UtteranceInputSpecification](API_UtteranceInputSpecification.md)
+ [UtteranceLevelTestResultItem](API_UtteranceLevelTestResultItem.md)
+ [UtteranceLevelTestResults](API_UtteranceLevelTestResults.md)
+ [UtteranceSpecification](API_UtteranceSpecification.md)
+ [VoiceSettings](API_VoiceSettings.md)
+ [WaitAndContinueSpecification](API_WaitAndContinueSpecification.md)
# ActiveContext
The active context used in the test execution.
## Contents
** name **
The name of active context.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern: `^([A-Za-z]_?)+$`
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/ActiveContext)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/ActiveContext)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/ActiveContext)
# AdvancedRecognitionSetting
Provides settings that enable advanced recognition settings for slot values.
## Contents
** audioRecognitionStrategy **
Enables using the slot values as a custom vocabulary for recognizing user utterances.
Type: String
Valid Values: `UseSlotValuesAsCustomVocabulary`
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/AdvancedRecognitionSetting)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/AdvancedRecognitionSetting)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/AdvancedRecognitionSetting)
# AgentTurnResult
The information about the agent turn in a test set execution.
## Contents
** expectedAgentPrompt **
The expected agent prompt for the agent turn in a test set execution.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Required: Yes
** actualAgentPrompt **
The actual agent prompt for the agent turn in a test set execution.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Required: No
** actualElicitedSlot **
The actual elicited slot for the agent turn in a test set execution.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern: `^([0-9a-zA-Z][_.-]?)+$`
Required: No
** actualIntent **
The actual intent for the agent turn in a test set execution.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern: `^([0-9a-zA-Z][_-]?){1,100}$`
Required: No
** errorDetails **
Details about an error in an execution of a test set.
Type: [ExecutionErrorDetails](API_ExecutionErrorDetails.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/AgentTurnResult)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/AgentTurnResult)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/AgentTurnResult)
# AgentTurnSpecification
The specification of an agent turn.
## Contents
** agentPrompt **
The agent prompt for the agent turn in a test set.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/AgentTurnSpecification)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/AgentTurnSpecification)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/AgentTurnSpecification)
# AggregatedUtterancesFilter
Filters responses returned by the `ListAggregatedUtterances` operation.
## Contents
** name **
The name of the field to filter the utterance list.
Type: String
Valid Values: `Utterance`
Required: Yes
** operator **
The operator to use for the filter. Specify `EQ` when the `ListAggregatedUtterances` operation should return only utterances that equal the specified value. Specify `CO` when the `ListAggregatedUtterances` operation should return utterances that contain the specified value.
Type: String
Valid Values: `CO | EQ`
Required: Yes
** values **
The value to use for filtering the list of bots.
Type: Array of strings
Array Members: Fixed number of 1 item.
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern: `^[0-9a-zA-Z_()\s-]+$`
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/AggregatedUtterancesFilter)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/AggregatedUtterancesFilter)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/AggregatedUtterancesFilter)
# AggregatedUtterancesSortBy
Specifies attributes for sorting a list of utterances.
## Contents
** attribute **
The utterance attribute to sort by.
Type: String
Valid Values: `HitCount | MissedCount`
Required: Yes
** order **
Specifies whether to sort the aggregated utterances in ascending or descending order.
Type: String
Valid Values: `Ascending | Descending`
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/AggregatedUtterancesSortBy)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/AggregatedUtterancesSortBy)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/AggregatedUtterancesSortBy)
# AggregatedUtterancesSummary
Provides summary information for aggregated utterances. The `ListAggregatedUtterances` operations combines all instances of the same utterance into a single aggregated summary.
## Contents
** containsDataFromDeletedResources **
Aggregated utterance data may contain utterances from versions of your bot that have since been deleted. When the aggregated contains this kind of data, this field is set to true.
Type: Boolean
Required: No
** hitCount **
The number of times that the utterance was detected by Amazon Lex during the time period. When an utterance is detected, it activates an intent or a slot.
Type: Integer
Required: No
** missedCount **
The number of times that the utterance was missed by Amazon Lex An utterance is missed when it doesn't activate an intent or slot.
Type: Integer
Required: No
** utterance **
The text of the utterance. If the utterance was used with the `RecognizeUtterance` operation, the text is the transcription of the audio utterance.
Type: String
Required: No
** utteranceFirstRecordedInAggregationDuration **
The date and time that the utterance was first recorded in the time window for aggregation. An utterance may have been sent to Amazon Lex before that time, but only utterances within the time window are counted.
Type: Timestamp
Required: No
** utteranceLastRecordedInAggregationDuration **
The last date and time that an utterance was recorded in the time window for aggregation. An utterance may be sent to Amazon Lex after that time, but only utterances within the time window are counted.
Type: Timestamp
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/AggregatedUtterancesSummary)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/AggregatedUtterancesSummary)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/AggregatedUtterancesSummary)
# AllowedInputTypes
Specifies the allowed input types.
## Contents
** allowAudioInput **
Indicates whether audio input is allowed.
Type: Boolean
Required: Yes
** allowDTMFInput **
Indicates whether DTMF input is allowed.
Type: Boolean
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/AllowedInputTypes)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/AllowedInputTypes)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/AllowedInputTypes)
# AnalyticsBinBySpecification
Contains the time metric, interval, and method by which to bin the analytics data.
## Contents
** interval **
Specifies the interval of time by which to bin the analytics data.
Type: String
Valid Values: `OneHour | OneDay`
Required: Yes
** name **
Specifies the time metric by which to bin the analytics data.
Type: String
Valid Values: `ConversationStartTime | UtteranceTimestamp`
Required: Yes
** order **
Specifies whether to bin the analytics data in ascending or descending order. If this field is left blank, the default order is by the key of the bin in descending order.
Type: String
Valid Values: `Ascending | Descending`
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/AnalyticsBinBySpecification)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/AnalyticsBinBySpecification)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/AnalyticsBinBySpecification)
# AnalyticsBinKey
An object containing the criterion by which to bin the results and the value that defines that bin.
## Contents
** name **
The criterion by which to bin the results.
Type: String
Valid Values: `ConversationStartTime | UtteranceTimestamp`
Required: No
** value **
The value of the criterion that defines the bin.
Type: Long
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/AnalyticsBinKey)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/AnalyticsBinKey)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/AnalyticsBinKey)
# AnalyticsIntentFilter
Contains fields describing a condition by which to filter the intents. The expression may be understood as `name` `operator` `values`. For example:
+ `IntentName CO Book` – The intent name contains the string "Book."
+ `BotVersion EQ 2` – The bot version is equal to two.
The operators that each filter supports are listed below:
+ `BotAlias` – `EQ`.
+ `BotVersion` – `EQ`.
+ `LocaleId` – `EQ`.
+ `Modality` – `EQ`.
+ `Channel` – `EQ`.
+ `SessionId` – `EQ`.
+ `OriginatingRequestId` – `EQ`.
+ `IntentName` – `EQ`, `CO`.
+ `IntentEndState` – `EQ`, `CO`.
## Contents
** name **
The category by which to filter the intents. The descriptions for each option are as follows:
+ `BotAlias` – The name of the bot alias.
+ `BotVersion` – The version of the bot.
+ `LocaleId` – The locale of the bot.
+ `Modality` – The modality of the session with the bot (audio, DTMF, or text).
+ `Channel` – The channel that the bot is integrated with.
+ `SessionId` – The identifier of the session with the bot.
+ `OriginatingRequestId` – The identifier of the first request in a session.
+ `IntentName` – The name of the intent.
+ `IntentEndState` – The final state of the intent.
Type: String
Valid Values: `BotAliasId | BotVersion | LocaleId | Modality | Channel | SessionId | OriginatingRequestId | IntentName | IntentEndState`
Required: Yes
** operator **
The operation by which to filter the category. The following operations are possible:
+ `CO` – Contains
+ `EQ` – Equals
+ `GT` – Greater than
+ `LT` – Less than
The operators that each filter supports are listed below:
+ `BotAlias` – `EQ`.
+ `BotVersion` – `EQ`.
+ `LocaleId` – `EQ`.
+ `Modality` – `EQ`.
+ `Channel` – `EQ`.
+ `SessionId` – `EQ`.
+ `OriginatingRequestId` – `EQ`.
+ `IntentName` – `EQ`, `CO`.
+ `IntentEndState` – `EQ`, `CO`.
Type: String
Valid Values: `EQ | GT | LT`
Required: Yes
** values **
An array containing the values of the category by which to apply the operator to filter the results. You can provide multiple values if the operator is `EQ` or `CO`. If you provide multiple values, you filter for results that equal/contain any of the values. For example, if the `name`, `operator`, and `values` fields are `Modality`, `EQ`, and `[Speech, Text]`, the operation filters for results where the modality was either `Speech` or `Text`.
Type: Array of strings
Array Members: Minimum number of 1 item. Maximum number of 5 items.
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/AnalyticsIntentFilter)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/AnalyticsIntentFilter)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/AnalyticsIntentFilter)
# AnalyticsIntentGroupByKey
Contains the category by which the intent analytics were grouped and a member of that category.
## Contents
** name **
A category by which the intent analytics were grouped.
Type: String
Valid Values: `IntentName | IntentEndState | IntentLevel`
Required: No
** value **
A member of the category by which the intent analytics were grouped.
Type: String
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/AnalyticsIntentGroupByKey)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/AnalyticsIntentGroupByKey)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/AnalyticsIntentGroupByKey)
# AnalyticsIntentGroupBySpecification
Contains the category by which to group the intents.
## Contents
** name **
Specifies whether to group the intent stages by their name or their end state.
Type: String
Valid Values: `IntentName | IntentEndState | IntentLevel`
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/AnalyticsIntentGroupBySpecification)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/AnalyticsIntentGroupBySpecification)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/AnalyticsIntentGroupBySpecification)
# AnalyticsIntentMetric
Contains the metric and the summary statistic you want to calculate, and the order in which to sort the results, for the intents in the bot.
## Contents
** name **
The metric for which you want to get intent summary statistics.
+ `Count` – The number of times the intent was invoked.
+ `Success` – The number of times the intent succeeded.
+ `Failure` – The number of times the intent failed.
+ `Switched` – The number of times there was a switch to a different intent.
+ `Dropped` – The number of times the user dropped the intent.
Type: String
Valid Values: `Count | Success | Failure | Switched | Dropped`
Required: Yes
** statistic **
The summary statistic to calculate.
+ `Sum` – The total count for the category you provide in `name`.
+ `Average` – The total count divided by the number of intents in the category you provide in `name`.
+ `Max` – The highest count in the category you provide in `name`.
Type: String
Valid Values: `Sum | Avg | Max`
Required: Yes
** order **
Specifies whether to sort the results in ascending or descending order.
Type: String
Valid Values: `Ascending | Descending`
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/AnalyticsIntentMetric)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/AnalyticsIntentMetric)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/AnalyticsIntentMetric)
# AnalyticsIntentMetricResult
An object containing the results for the intent metric you requested.
## Contents
** name **
The metric that you requested. See [Key definitions](https://docs.aws.amazon.com/lexv2/latest/dg/analytics-key-definitions.html) for more details about these metrics.
+ `Count` – The number of times the intent was invoked.
+ `Success` – The number of times the intent succeeded.
+ `Failure` – The number of times the intent failed.
+ `Switched` – The number of times there was a switch to a different intent.
+ `Dropped` – The number of times the user dropped the intent.
Type: String
Valid Values: `Count | Success | Failure | Switched | Dropped`
Required: No
** statistic **
The statistic that you requested to calculate.
+ `Sum` – The total count for the category you provide in `name`.
+ `Average` – The total count divided by the number of intents in the category you provide in `name`.
+ `Max` – The highest count in the category you provide in `name`.
Type: String
Valid Values: `Sum | Avg | Max`
Required: No
** value **
The value of the summary statistic for the metric that you requested.
Type: Double
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/AnalyticsIntentMetricResult)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/AnalyticsIntentMetricResult)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/AnalyticsIntentMetricResult)
# AnalyticsIntentNodeSummary
An object containing information about the requested path.
## Contents
** intentCount **
The total number of sessions that follow the given path to the given intent.
Type: Integer
Required: No
** intentLevel **
The number of intents up to and including the requested path.
Type: Integer
Valid Range: Minimum value of 0. Maximum value of 100.
Required: No
** intentName **
The name of the intent at the end of the requested path.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern: `^([0-9a-zA-Z][_-]?){1,100}$`
Required: No
** intentPath **
The path.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Required: No
** nodeType **
Specifies whether the node is the end of a path (`Exit`) or not (`Inner`).
Type: String
Valid Values: `Inner | Exit`
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/AnalyticsIntentNodeSummary)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/AnalyticsIntentNodeSummary)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/AnalyticsIntentNodeSummary)
# AnalyticsIntentResult
An object containing the results for the intent metrics you requested and the bin and/or group(s) they refer to, if applicable.
## Contents
** binKeys **
A list of objects containing the criteria you requested for binning results and the values of the bins.
Type: Array of [AnalyticsBinKey](API_AnalyticsBinKey.md) objects
Array Members: Fixed number of 1 item.
Required: No
** groupByKeys **
A list of objects containing the criteria you requested for grouping results and the values of the groups.
Type: Array of [AnalyticsIntentGroupByKey](API_AnalyticsIntentGroupByKey.md) objects
Required: No
** metricsResults **
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 [AnalyticsIntentMetricResult](API_AnalyticsIntentMetricResult.md) objects
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/AnalyticsIntentResult)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/AnalyticsIntentResult)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/AnalyticsIntentResult)
# AnalyticsIntentStageFilter
Contains fields describing a condition by which to filter the intent stages. The expression may be understood as `name` `operator` `values`. For example:
+ `IntentName CO Book` – The intent name contains the string "Book."
+ `BotVersion EQ 2` – The bot version is equal to two.
The operators that each filter supports are listed below:
+ `BotAlias` – `EQ`.
+ `BotVersion` – `EQ`.
+ `LocaleId` – `EQ`.
+ `Modality` – `EQ`.
+ `Channel` – `EQ`.
+ `SessionId` – `EQ`.
+ `OriginatingRequestId` – `EQ`.
+ `IntentName` – `EQ`, `CO`.
+ `IntentStageName` – `EQ`, `CO`.
## Contents
** name **
The category by which to filter the intent stages. The descriptions for each option are as follows:
+ `BotAlias` – The name of the bot alias.
+ `BotVersion` – The version of the bot.
+ `LocaleId` – The locale of the bot.
+ `Modality` – The modality of the session with the bot (audio, DTMF, or text).
+ `Channel` – The channel that the bot is integrated with.
+ `SessionId` – The identifier of the session with the bot.
+ `OriginatingRequestId` – The identifier of the first request in a session.
+ `IntentName` – The name of the intent.
+ `IntentStageName` – The stage in the intent.
Type: String
Valid Values: `BotAliasId | BotVersion | LocaleId | Modality | Channel | SessionId | OriginatingRequestId | IntentName | IntentStageName`
Required: Yes
** operator **
The operation by which to filter the category. The following operations are possible:
+ `CO` – Contains
+ `EQ` – Equals
+ `GT` – Greater than
+ `LT` – Less than
The operators that each filter supports are listed below:
+ `BotAlias` – `EQ`.
+ `BotVersion` – `EQ`.
+ `LocaleId` – `EQ`.
+ `Modality` – `EQ`.
+ `Channel` – `EQ`.
+ `SessionId` – `EQ`.
+ `OriginatingRequestId` – `EQ`.
+ `IntentName` – `EQ`, `CO`.
+ `IntentStageName` – `EQ`, `CO`.
Type: String
Valid Values: `EQ | GT | LT`
Required: Yes
** values **
An array containing the values of the category by which to apply the operator to filter the results. You can provide multiple values if the operator is `EQ` or `CO`. If you provide multiple values, you filter for results that equal/contain any of the values. For example, if the `name`, `operator`, and `values` fields are `Modality`, `EQ`, and `[Speech, Text]`, the operation filters for results where the modality was either `Speech` or `Text`.
Type: Array of strings
Array Members: Minimum number of 1 item. Maximum number of 5 items.
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/AnalyticsIntentStageFilter)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/AnalyticsIntentStageFilter)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/AnalyticsIntentStageFilter)
# AnalyticsIntentStageGroupByKey
Contains the category by which the intent stage analytics and the values for that category were grouped.
## Contents
** name **
A category by which the intent stage analytics were grouped.
Type: String
Valid Values: `IntentStageName | SwitchedToIntent`
Required: No
** value **
A member of the category by which the intent stage analytics were grouped.
Type: String
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/AnalyticsIntentStageGroupByKey)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/AnalyticsIntentStageGroupByKey)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/AnalyticsIntentStageGroupByKey)
# AnalyticsIntentStageGroupBySpecification
Contains the category by which to group the intent stages.
## Contents
** name **
Specifies whether to group the intent stages by their name or the intent to which the session was switched.
Type: String
Valid Values: `IntentStageName | SwitchedToIntent`
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/AnalyticsIntentStageGroupBySpecification)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/AnalyticsIntentStageGroupBySpecification)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/AnalyticsIntentStageGroupBySpecification)
# AnalyticsIntentStageMetric
Contains the metric and the summary statistic you want to calculate, and the order in which to sort the results, for the intent stages across the user sessions with the bot.
## Contents
** name **
The metric for which you want to get intent stage summary statistics. See [Key definitions](https://docs.aws.amazon.com/lexv2/latest/dg/analytics-key-definitions.html) for more details about these metrics.
+ `Count` – The number of times the intent stage occurred.
+ `Success` – The number of times the intent stage succeeded.
+ `Failure` – The number of times the intent stage failed.
+ `Dropped` – The number of times the user dropped the intent stage.
+ `Retry` – The number of times the bot tried to elicit a response from the user at this stage.
Type: String
Valid Values: `Count | Success | Failed | Dropped | Retry`
Required: Yes
** statistic **
The summary statistic to calculate.
+ `Sum` – The total count for the category you provide in `name`.
+ `Average` – The total count divided by the number of intent stages in the category you provide in `name`.
+ `Max` – The highest count in the category you provide in `name`.
Type: String
Valid Values: `Sum | Avg | Max`
Required: Yes
** order **
Specifies whether to sort the results in ascending or descending order of the summary statistic (`value` in the response).
Type: String
Valid Values: `Ascending | Descending`
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/AnalyticsIntentStageMetric)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/AnalyticsIntentStageMetric)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/AnalyticsIntentStageMetric)
# AnalyticsIntentStageMetricResult
An object containing the results for an intent stage metric you requested.
## Contents
** name **
The metric that you requested.
+ `Count` – The number of times the intent stage occurred.
+ `Success` – The number of times the intent stage succeeded.
+ `Failure` – The number of times the intent stage failed.
+ `Dropped` – The number of times the user dropped the intent stage.
+ `Retry` – The number of times the bot tried to elicit a response from the user at this stage.
Type: String
Valid Values: `Count | Success | Failed | Dropped | Retry`
Required: No
** statistic **
The summary statistic that you requested to calculate.
+ `Sum` – The total count for the category you provide in `name`.
+ `Average` – The total count divided by the number of intent stages in the category you provide in `name`.
+ `Max` – The highest count in the category you provide in `name`.
Type: String
Valid Values: `Sum | Avg | Max`
Required: No
** value **
The value of the summary statistic for the metric that you requested.
Type: Double
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/AnalyticsIntentStageMetricResult)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/AnalyticsIntentStageMetricResult)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/AnalyticsIntentStageMetricResult)
# AnalyticsIntentStageResult
An object containing the results for the intent stage metrics you requested and the bin and/or group they refer to, if applicable.
## Contents
** binKeys **
A list of objects containing the criteria you requested for binning results and the values of the bins.
Type: Array of [AnalyticsBinKey](API_AnalyticsBinKey.md) objects
Array Members: Fixed number of 1 item.
Required: No
** groupByKeys **
A list of objects containing the criteria you requested for grouping results and the values of the bins.
Type: Array of [AnalyticsIntentStageGroupByKey](API_AnalyticsIntentStageGroupByKey.md) objects
Required: No
** metricsResults **
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 [AnalyticsIntentStageMetricResult](API_AnalyticsIntentStageMetricResult.md) objects
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/AnalyticsIntentStageResult)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/AnalyticsIntentStageResult)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/AnalyticsIntentStageResult)
# AnalyticsPathFilter
Contains fields describing a condition by which to filter the paths. The expression may be understood as `name` `operator` `values`. For example:
+ `LocaleId EQ en` – The locale is "en".
+ `BotVersion EQ 2` – The bot version is equal to two.
The operators that each filter supports are listed below:
+ `BotAlias` – `EQ`.
+ `BotVersion` – `EQ`.
+ `LocaleId` – `EQ`.
+ `Modality` – `EQ`.
+ `Channel` – `EQ`.
## Contents
** name **
The category by which to filter the intent paths. The descriptions for each option are as follows:
+ `BotAlias` – The name of the bot alias.
+ `BotVersion` – The version of the bot.
+ `LocaleId` – The locale of the bot.
+ `Modality` – The modality of the session with the bot (audio, DTMF, or text).
+ `Channel` – The channel that the bot is integrated with.
Type: String
Valid Values: `BotAliasId | BotVersion | LocaleId | Modality | Channel`
Required: Yes
** operator **
The operation by which to filter the category. The following operations are possible:
+ `CO` – Contains
+ `EQ` – Equals
+ `GT` – Greater than
+ `LT` – Less than
The operators that each filter supports are listed below:
+ `BotAlias` – `EQ`.
+ `BotVersion` – `EQ`.
+ `LocaleId` – `EQ`.
+ `Modality` – `EQ`.
+ `Channel` – `EQ`.
Type: String
Valid Values: `EQ | GT | LT`
Required: Yes
** values **
An array containing the values of the category by which to apply the operator to filter the results. You can provide multiple values if the operator is `EQ` or `CO`. If you provide multiple values, you filter for results that equal/contain any of the values. For example, if the `name`, `operator`, and `values` fields are `Modality`, `EQ`, and `[Speech, Text]`, the operation filters for results where the modality was either `Speech` or `Text`.
Type: Array of strings
Array Members: Minimum number of 1 item. Maximum number of 5 items.
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/AnalyticsPathFilter)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/AnalyticsPathFilter)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/AnalyticsPathFilter)
# AnalyticsSessionFilter
Contains fields describing a condition by which to filter the sessions. The expression may be understood as `name` `operator` `values`. For example:
+ `LocaleId EQ en` – The locale is "en".
+ `Duration GT 200` – The duration is greater than 200 seconds.
The operators that each filter supports are listed below:
+ `BotAlias` – `EQ`.
+ `BotVersion` – `EQ`.
+ `LocaleId` – `EQ`.
+ `Modality` – `EQ`.
+ `Channel` – `EQ`.
+ `Duration` – `EQ`, `GT`, `LT`.
+ `conversationEndState` – `EQ`, `CO`.
+ `SessionId` – `EQ`.
+ `OriginatingRequestId` – `EQ`.
+ `IntentPath` – `EQ`.
## Contents
** name **
The category by which to filter the sessions. The descriptions for each option are as follows:
+ `BotAlias` – The name of the bot alias.
+ `BotVersion` – The version of the bot.
+ `LocaleId` – The locale of the bot.
+ `Modality` – The modality of the session with the bot (audio, DTMF, or text).
+ `Channel` – The channel that the bot is integrated with.
+ `Duration` – The duration of the session.
+ `conversationEndState` – The final state of the session.
+ `SessionId` – The identifier of the session with the bot.
+ `OriginatingRequestId` – The identifier of the first request in a session.
+ `IntentPath` – The order of intents taken in a session.
Type: String
Valid Values: `BotAliasId | BotVersion | LocaleId | Modality | Channel | Duration | ConversationEndState | SessionId | OriginatingRequestId | IntentPath`
Required: Yes
** operator **
The operation by which to filter the category. The following operations are possible:
+ `CO` – Contains
+ `EQ` – Equals
+ `GT` – Greater than
+ `LT` – Less than
The operators that each filter supports are listed below:
+ `BotAlias` – `EQ`.
+ `BotVersion` – `EQ`.
+ `LocaleId` – `EQ`.
+ `Modality` – `EQ`.
+ `Channel` – `EQ`.
+ `Duration` – `EQ`, `GT`, `LT`.
+ `conversationEndState` – `EQ`, `CO`.
+ `SessionId` – `EQ`.
+ `OriginatingRequestId` – `EQ`.
+ `IntentPath` – `EQ`.
Type: String
Valid Values: `EQ | GT | LT`
Required: Yes
** values **
An array containing the values of the category by which to apply the operator to filter the results. You can provide multiple values if the operator is `EQ` or `CO`. If you provide multiple values, you filter for results that equal/contain any of the values. For example, if the `name`, `operator`, and `values` fields are `Modality`, `EQ`, and `[Speech, Text]`, the operation filters for results where the modality was either `Speech` or `Text`.
Type: Array of strings
Array Members: Minimum number of 1 item. Maximum number of 5 items.
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/AnalyticsSessionFilter)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/AnalyticsSessionFilter)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/AnalyticsSessionFilter)
# AnalyticsSessionGroupByKey
Contains the category by which the session analytics were grouped and a member of that category.
## Contents
** name **
The category by which the session analytics were grouped.
Type: String
Valid Values: `ConversationEndState | LocaleId`
Required: No
** value **
A member of the category by which the session analytics were grouped.
Type: String
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/AnalyticsSessionGroupByKey)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/AnalyticsSessionGroupByKey)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/AnalyticsSessionGroupByKey)
# AnalyticsSessionGroupBySpecification
Contains the category by which to group the sessions.
## Contents
** name **
Specifies whether to group the session by their end state or their locale.
Type: String
Valid Values: `ConversationEndState | LocaleId`
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/AnalyticsSessionGroupBySpecification)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/AnalyticsSessionGroupBySpecification)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/AnalyticsSessionGroupBySpecification)
# AnalyticsSessionMetric
Contains the metric and the summary statistic you want to calculate, and the order in which to sort the results, for the user sessions with the bot.
## Contents
** name **
The metric for which you want to get session summary statistics.
+ `Count` – The number of sessions.
+ `Success` – The number of sessions that succeeded.
+ `Failure` – The number of sessions that failed.
+ `Dropped` – The number of sessions that the user dropped.
+ `Duration` – The duration of sessions.
+ `TurnsPerSession` – The number of turns in the sessions.
+ `Concurrency` – The number of sessions occurring in the same period of time.
Type: String
Valid Values: `Count | Success | Failure | Dropped | Duration | TurnsPerConversation | Concurrency`
Required: Yes
** statistic **
The summary statistic to calculate.
+ `Sum` – The total count for the category you provide in `name`.
+ `Average` – The total count divided by the number of sessions in the category you provide in `name`.
+ `Max` – The highest count in the category you provide in `name`.
Type: String
Valid Values: `Sum | Avg | Max`
Required: Yes
** order **
Specifies whether to sort the results in ascending or descending order.
Type: String
Valid Values: `Ascending | Descending`
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/AnalyticsSessionMetric)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/AnalyticsSessionMetric)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/AnalyticsSessionMetric)
# AnalyticsSessionMetricResult
An object containing the results for a session metric you requested.
## Contents
** name **
The metric that you requested.
+ `Count` – The number of sessions.
+ `Success` – The number of sessions that succeeded.
+ `Failure` – The number of sessions that failed.
+ `Dropped` – The number of sessions that the user dropped.
+ `Duration` – The duration of sessions.
+ `TurnPersession` – The number of turns in the sessions.
+ `Concurrency` – The number of sessions occurring in the same period of time.
Type: String
Valid Values: `Count | Success | Failure | Dropped | Duration | TurnsPerConversation | Concurrency`
Required: No
** statistic **
The summary statistic that you requested to calculate.
+ `Sum` – The total count for the category you provide in `name`.
+ `Average` – The total count divided by the number of sessions in the category you provide in `name`.
+ `Max` – The highest count in the category you provide in `name`.
Type: String
Valid Values: `Sum | Avg | Max`
Required: No
** value **
The value of the summary statistic for the metric that you requested.
Type: Double
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/AnalyticsSessionMetricResult)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/AnalyticsSessionMetricResult)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/AnalyticsSessionMetricResult)
# AnalyticsSessionResult
An object containing the results for the session metrics you requested and the bin and/or group(s) they refer to, if applicable.
## Contents
** binKeys **
A list of objects containing the criteria you requested for binning results and the values of the bins.
Type: Array of [AnalyticsBinKey](API_AnalyticsBinKey.md) objects
Array Members: Fixed number of 1 item.
Required: No
** groupByKeys **
A list of objects containing the criteria you requested for grouping results and the values of the bins.
Type: Array of [AnalyticsSessionGroupByKey](API_AnalyticsSessionGroupByKey.md) objects
Required: No
** metricsResults **
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 [AnalyticsSessionMetricResult](API_AnalyticsSessionMetricResult.md) objects
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/AnalyticsSessionResult)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/AnalyticsSessionResult)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/AnalyticsSessionResult)
# AnalyticsUtteranceAttribute
An object that specifies the last used intent at the time of the utterance as an attribute to return.
## Contents
** name **
An attribute to return. The only available attribute is the intent that the bot mapped the utterance to.
Type: String
Valid Values: `LastUsedIntent`
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/AnalyticsUtteranceAttribute)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/AnalyticsUtteranceAttribute)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/AnalyticsUtteranceAttribute)
# AnalyticsUtteranceAttributeResult
An object containing the intent that the bot mapped the utterance to.
## Contents
** lastUsedIntent **
The intent that the bot mapped the utterance to.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern: `^([0-9a-zA-Z][_-]?){1,100}$`
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/AnalyticsUtteranceAttributeResult)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/AnalyticsUtteranceAttributeResult)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/AnalyticsUtteranceAttributeResult)
# AnalyticsUtteranceFilter
Contains fields describing a condition by which to filter the utterances. The expression may be understood as `name` `operator` `values`. For example:
+ `LocaleId EQ Book` – The locale is the string "en".
+ `UtteranceText CO help` – The text of the utterance contains the string "help".
The operators that each filter supports are listed below:
+ `BotAlias` – `EQ`.
+ `BotVersion` – `EQ`.
+ `LocaleId` – `EQ`.
+ `Modality` – `EQ`.
+ `Channel` – `EQ`.
+ `SessionId` – `EQ`.
+ `OriginatingRequestId` – `EQ`.
+ `UtteranceState` – `EQ`.
+ `UtteranceText` – `EQ`, `CO`.
## Contents
** name **
The category by which to filter the utterances. The descriptions for each option are as follows:
+ `BotAlias` – The name of the bot alias.
+ `BotVersion` – The version of the bot.
+ `LocaleId` – The locale of the bot.
+ `Modality` – The modality of the session with the bot (audio, DTMF, or text).
+ `Channel` – The channel that the bot is integrated with.
+ `SessionId` – The identifier of the session with the bot.
+ `OriginatingRequestId` – The identifier of the first request in a session.
+ `UtteranceState` – The state of the utterance.
+ `UtteranceText` – The text in the utterance.
Type: String
Valid Values: `BotAliasId | BotVersion | LocaleId | Modality | Channel | SessionId | OriginatingRequestId | UtteranceState | UtteranceText`
Required: Yes
** operator **
The operation by which to filter the category. The following operations are possible:
+ `CO` – Contains
+ `EQ` – Equals
+ `GT` – Greater than
+ `LT` – Less than
The operators that each filter supports are listed below:
+ `BotAlias` – `EQ`.
+ `BotVersion` – `EQ`.
+ `LocaleId` – `EQ`.
+ `Modality` – `EQ`.
+ `Channel` – `EQ`.
+ `SessionId` – `EQ`.
+ `OriginatingRequestId` – `EQ`.
+ `UtteranceState` – `EQ`.
+ `UtteranceText` – `EQ`, `CO`.
Type: String
Valid Values: `EQ | GT | LT`
Required: Yes
** values **
An array containing the values of the category by which to apply the operator to filter the results. You can provide multiple values if the operator is `EQ` or `CO`. If you provide multiple values, you filter for results that equal/contain any of the values. For example, if the `name`, `operator`, and `values` fields are `Modality`, `EQ`, and `[Speech, Text]`, the operation filters for results where the modality was either `Speech` or `Text`.
Type: Array of strings
Array Members: Minimum number of 1 item. Maximum number of 5 items.
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/AnalyticsUtteranceFilter)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/AnalyticsUtteranceFilter)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/AnalyticsUtteranceFilter)
# AnalyticsUtteranceGroupByKey
Contains the category by which the utterance analytics were grouped and the values for that category.
## Contents
** name **
The category by which the utterance analytics were grouped.
Type: String
Valid Values: `UtteranceText | UtteranceState`
Required: No
** value **
A member of the category by which the utterance analytics were grouped.
Type: String
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/AnalyticsUtteranceGroupByKey)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/AnalyticsUtteranceGroupByKey)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/AnalyticsUtteranceGroupByKey)
# AnalyticsUtteranceGroupBySpecification
Contains the category by which to group the utterances.
## Contents
** name **
Specifies whether to group the utterances by their text or their state.
Type: String
Valid Values: `UtteranceText | UtteranceState`
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/AnalyticsUtteranceGroupBySpecification)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/AnalyticsUtteranceGroupBySpecification)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/AnalyticsUtteranceGroupBySpecification)
# AnalyticsUtteranceMetric
Contains the metric and the summary statistic you want to calculate, and the order in which to sort the results, for the utterances across the user sessions with the bot.
## Contents
** name **
The metric for which you want to get utterance summary statistics.
+ `Count` – The number of utterances.
+ `Missed` – The number of utterances that Amazon Lex failed to recognize.
+ `Detected` – The number of utterances that Amazon Lex managed to detect.
+ `UtteranceTimestamp` – The date and time of the utterance.
Type: String
Valid Values: `Count | Missed | Detected | UtteranceTimestamp`
Required: Yes
** statistic **
The summary statistic to calculate.
+ `Sum` – The total count for the category you provide in `name`.
+ `Average` – The total count divided by the number of utterances in the category you provide in `name`.
+ `Max` – The highest count in the category you provide in `name`.
Type: String
Valid Values: `Sum | Avg | Max`
Required: Yes
** order **
Specifies whether to sort the results in ascending or descending order.
Type: String
Valid Values: `Ascending | Descending`
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/AnalyticsUtteranceMetric)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/AnalyticsUtteranceMetric)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/AnalyticsUtteranceMetric)
# AnalyticsUtteranceMetricResult
An object containing the results for the utterance metric you requested.
## Contents
** name **
The metric that you requested.
+ `Count` – The number of utterances.
+ `Missed` – The number of utterances that Amazon Lex failed to recognize.
+ `Detected` – The number of utterances that Amazon Lex managed to detect.
+ `UtteranceTimestamp` – The date and time of the utterance.
Type: String
Valid Values: `Count | Missed | Detected | UtteranceTimestamp`
Required: No
** statistic **
The summary statistic that you requested to calculate.
+ `Sum` – The total count for the category you provide in `name`.
+ `Average` – The total count divided by the number of utterances in the category you provide in `name`.
+ `Max` – The highest count in the category you provide in `name`.
Type: String
Valid Values: `Sum | Avg | Max`
Required: No
** value **
The value of the summary statistic for the metric that you requested.
Type: Double
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/AnalyticsUtteranceMetricResult)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/AnalyticsUtteranceMetricResult)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/AnalyticsUtteranceMetricResult)
# AnalyticsUtteranceResult
An object containing the results for the utterance metrics you requested and the bin and/or group(s) they refer to, if applicable.
## Contents
** attributeResults **
A list of objects containing information about the last used intent at the time of an utterance.
Type: Array of [AnalyticsUtteranceAttributeResult](API_AnalyticsUtteranceAttributeResult.md) objects
Required: No
** binKeys **
A list of objects containing the criteria you requested for binning results and the values of the bins.
Type: Array of [AnalyticsBinKey](API_AnalyticsBinKey.md) objects
Array Members: Fixed number of 1 item.
Required: No
** groupByKeys **
A list of objects containing the criteria you requested for grouping results and the values of the bins.
Type: Array of [AnalyticsUtteranceGroupByKey](API_AnalyticsUtteranceGroupByKey.md) objects
Required: No
** metricsResults **
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 [AnalyticsUtteranceMetricResult](API_AnalyticsUtteranceMetricResult.md) objects
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/AnalyticsUtteranceResult)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/AnalyticsUtteranceResult)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/AnalyticsUtteranceResult)
# AssociatedTranscript
The object containing information that associates the recommended intent/slot type with a conversation.
## Contents
** transcript **
The content of the transcript that meets the search filter criteria. For the JSON format of the transcript, see [Output transcript format](https://docs.aws.amazon.com/lexv2/latest/dg/designing-output-format.html).
Type: String
Length Constraints: Minimum length of 1. Maximum length of 6000000.
Pattern: `.*`
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/AssociatedTranscript)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/AssociatedTranscript)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/AssociatedTranscript)
# AssociatedTranscriptFilter
Filters to search for the associated transcript.
## Contents
** name **
The name of the field to use for filtering. The allowed names are IntentId and SlotTypeId.
Type: String
Valid Values: `IntentId | SlotTypeId`
Required: Yes
** values **
The values to use to filter the transcript.
Type: Array of strings
Array Members: Fixed number of 1 item.
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern: `^[0-9a-zA-Z_()\s-]+$`
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/AssociatedTranscriptFilter)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/AssociatedTranscriptFilter)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/AssociatedTranscriptFilter)
# AudioAndDTMFInputSpecification
Specifies the audio and DTMF input specification.
## Contents
** startTimeoutMs **
Time for which a bot waits before assuming that the customer isn't going to speak or press a key. This timeout is shared between Audio and DTMF inputs.
Type: Integer
Valid Range: Minimum value of 1.
Required: Yes
** audioSpecification **
Specifies the settings on audio input.
Type: [AudioSpecification](API_AudioSpecification.md) object
Required: No
** dtmfSpecification **
Specifies the settings on DTMF input.
Type: [DTMFSpecification](API_DTMFSpecification.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/AudioAndDTMFInputSpecification)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/AudioAndDTMFInputSpecification)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/AudioAndDTMFInputSpecification)
# AudioLogDestination
The location of audio log files collected when conversation logging is enabled for a bot.
## Contents
** s3Bucket **
The Amazon S3 bucket where the audio log files are stored. The IAM role specified in the `roleArn` parameter of the [CreateBot](https://docs.aws.amazon.com/lexv2/latest/APIReference/API_CreateBot.html) operation must have permission to write to this bucket.
Type: [S3BucketLogDestination](API_S3BucketLogDestination.md) object
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/AudioLogDestination)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/AudioLogDestination)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/AudioLogDestination)
# AudioLogSetting
Settings for logging audio of conversations between Amazon Lex and a user. You specify whether to log audio and the Amazon S3 bucket where the audio file is stored.
## Contents
** destination **
The location of audio log files collected when conversation logging is enabled for a bot.
Type: [AudioLogDestination](API_AudioLogDestination.md) object
Required: Yes
** enabled **
Determines whether audio logging in enabled for the bot.
Type: Boolean
Required: Yes
** selectiveLoggingEnabled **
The option to enable selective conversation log capture for audio.
Type: Boolean
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/AudioLogSetting)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/AudioLogSetting)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/AudioLogSetting)
# AudioSpecification
Specifies the audio input specifications.
## Contents
** endTimeoutMs **
Time for which a bot waits after the customer stops speaking to assume the utterance is finished.
Type: Integer
Valid Range: Minimum value of 1.
Required: Yes
** maxLengthMs **
Time for how long Amazon Lex waits before speech input is truncated and the speech is returned to application.
Type: Integer
Valid Range: Minimum value of 1.
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/AudioSpecification)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/AudioSpecification)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/AudioSpecification)
# BedrockGuardrailConfiguration
The details on the Bedrock guardrail configuration.
## Contents
** identifier **
The unique guardrail id for the Bedrock guardrail configuration.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: `^(([a-z0-9]+)|(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:guardrail/[a-z0-9]+))$`
Required: Yes
** version **
The guardrail version for the Bedrock guardrail configuration.
Type: String
Pattern: `^(([1-9][0-9]{0,7})|(DRAFT))$`
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/BedrockGuardrailConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/BedrockGuardrailConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/BedrockGuardrailConfiguration)
# BedrockKnowledgeStoreConfiguration
Contains details about the configuration of a Amazon Bedrock knowledge base.
## Contents
** bedrockKnowledgeBaseArn **
The base ARN of the knowledge base used.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 200.
Pattern: `^arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,40}:[0-9]{12}:knowledge-base\/[A-Za-z0-9]{10}$|^[A-Za-z0-9]{10}$`
Required: Yes
** exactResponse **
Specifies whether to return an exact response, or to return an answer generated by the model, using the fields you specify from the database.
Type: Boolean
Required: No
** exactResponseFields **
Contains the names of the fields used for an exact response to the user.
Type: [BedrockKnowledgeStoreExactResponseFields](API_BedrockKnowledgeStoreExactResponseFields.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/BedrockKnowledgeStoreConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/BedrockKnowledgeStoreConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/BedrockKnowledgeStoreConfiguration)
# BedrockKnowledgeStoreExactResponseFields
The exact response fields given by the Bedrock knowledge store.
## Contents
** answerField **
The answer field used for an exact response from Bedrock Knowledge Store.
Type: String
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/BedrockKnowledgeStoreExactResponseFields)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/BedrockKnowledgeStoreExactResponseFields)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/BedrockKnowledgeStoreExactResponseFields)
# BedrockModelSpecification
Contains information about the Amazon Bedrock model used to interpret the prompt used in descriptive bot building.
## Contents
** modelArn **
The ARN of the foundation model used in descriptive bot building.
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}$`
Required: Yes
** customPrompt **
The custom prompt used in the Bedrock model specification details.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 4000.
Required: No
** guardrail **
The guardrail configuration in the Bedrock model specification details.
Type: [BedrockGuardrailConfiguration](API_BedrockGuardrailConfiguration.md) object
Required: No
** traceStatus **
The Bedrock trace status in the Bedrock model specification details.
Type: String
Valid Values: `ENABLED | DISABLED`
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/BedrockModelSpecification)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/BedrockModelSpecification)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/BedrockModelSpecification)
# BotAliasHistoryEvent
Provides a record of an event that affects a bot alias. For example, when the version of a bot that the alias points to changes.
## Contents
** botVersion **
The version of the bot that was used in the event.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 5.
Pattern: `^(DRAFT|[0-9]+)$`
Required: No
** endDate **
The date and time that the event ended.
Type: Timestamp
Required: No
** startDate **
The date and time that the event started.
Type: Timestamp
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/BotAliasHistoryEvent)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/BotAliasHistoryEvent)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/BotAliasHistoryEvent)
# BotAliasLocaleSettings
Specifies settings that are unique to a locale. For example, you can use different Lambda function depending on the bot's locale.
## Contents
** enabled **
Determines whether the locale is enabled for the bot. If the value is `false`, the locale isn't available for use.
Type: Boolean
Required: Yes
** codeHookSpecification **
Specifies the Lambda function that should be used in the locale.
Type: [CodeHookSpecification](API_CodeHookSpecification.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/BotAliasLocaleSettings)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/BotAliasLocaleSettings)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/BotAliasLocaleSettings)
# BotAliasReplicaSummary
Contains information about all the aliases replication statuses applicable for global resiliency.
## Contents
** botAliasId **
The bot alias ID for all the alias bot replications.
Type: String
Length Constraints: Fixed length of 10.
Pattern: `^(\bTSTALIASID\b|[0-9a-zA-Z]+)$`
Required: No
** botAliasReplicationStatus **
The replication statuses for all the alias bot replications.
Type: String
Valid Values: `Creating | Updating | Available | Deleting | Failed`
Required: No
** botVersion **
The bot version for all the alias bot replications.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 5.
Pattern: `^(DRAFT|[0-9]+)$`
Required: No
** creationDateTime **
The creation time and date for all the alias bot replications.
Type: Timestamp
Required: No
** failureReasons **
The reasons for failure for the aliases bot replications.
Type: Array of strings
Required: No
** lastUpdatedDateTime **
The last time and date updated for all the alias bot replications.
Type: Timestamp
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/BotAliasReplicaSummary)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/BotAliasReplicaSummary)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/BotAliasReplicaSummary)
# BotAliasSummary
Summary information about bot aliases returned from the [ListBotAliases](https://docs.aws.amazon.com/lexv2/latest/APIReference/API_ListBotAliases.html) operation.
## Contents
** botAliasId **
The unique identifier assigned to the bot alias. You can use this ID to get detailed information about the alias using the [DescribeBotAlias](https://docs.aws.amazon.com/lexv2/latest/APIReference/API_DescribeBotAlias.html) operation.
Type: String
Length Constraints: Fixed length of 10.
Pattern: `^(\bTSTALIASID\b|[0-9a-zA-Z]+)$`
Required: No
** botAliasName **
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}$`
Required: No
** botAliasStatus **
The current state of the bot alias. If the status is `Available`, the alias is ready for use.
Type: String
Valid Values: `Creating | Available | Deleting | Failed`
Required: No
** botVersion **
The version of the bot that the bot alias references.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 5.
Pattern: `^(DRAFT|[0-9]+)$`
Required: No
** creationDateTime **
A timestamp of the date and time that the bot alias was created.
Type: Timestamp
Required: No
** description **
The description of the bot alias.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 2000.
Required: No
** lastUpdatedDateTime **
A timestamp of the date and time that the bot alias was last updated.
Type: Timestamp
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/BotAliasSummary)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/BotAliasSummary)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/BotAliasSummary)
# BotAliasTestExecutionTarget
The target Amazon S3 location for the test set execution using a bot alias.
## Contents
** botAliasId **
The bot alias Id of the bot alias used in the test set execution.
Type: String
Length Constraints: Fixed length of 10.
Pattern: `^(\bTSTALIASID\b|[0-9a-zA-Z]+)$`
Required: Yes
** botId **
The bot Id of the bot alias used in the test set execution.
Type: String
Length Constraints: Fixed length of 10.
Pattern: `^[0-9a-zA-Z]+$`
Required: Yes
** localeId **
The locale Id of the bot alias used in the test set execution.
Type: String
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/BotAliasTestExecutionTarget)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/BotAliasTestExecutionTarget)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/BotAliasTestExecutionTarget)
# BotAnalyzerHistorySummary
Contains summary information about a historical bot analysis execution.
## Contents
** botAnalyzerRequestId **
The unique identifier for 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}`
Required: Yes
** botAnalyzerStatus **
The status of the historical analysis execution.
Valid Values: `Processing | Available | Failed | Stopping | Stopped`
Type: String
Valid Values: `Processing | Available | Failed | Stopping | Stopped`
Required: Yes
** creationDateTime **
The date and time when the analysis was initiated.
Type: Timestamp
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/BotAnalyzerHistorySummary)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/BotAnalyzerHistorySummary)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/BotAnalyzerHistorySummary)
# BotAnalyzerRecommendation
Contains a recommendation for bot optimization identified by the Bot Analyzer.
## Contents
** issueDescription **
A detailed description of the identified configuration issue.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 2000.
Required: Yes
** issueLocation **
The location information for the identified issue within the bot configuration.
Type: [IssueLocation](API_IssueLocation.md) object
Required: Yes
** priority **
The priority level of the recommendation.
Valid Values: `High | Medium | Low`
Type: String
Valid Values: `High | Medium | Low`
Required: Yes
** proposedFix **
The recommended solution to address the identified issue.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 2000.
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/BotAnalyzerRecommendation)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/BotAnalyzerRecommendation)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/BotAnalyzerRecommendation)
# BotExportSpecification
Provides the identity of a the bot that was exported.
## Contents
** botId **
The identifier of the bot assigned by Amazon Lex.
Type: String
Length Constraints: Fixed length of 10.
Pattern: `^[0-9a-zA-Z]+$`
Required: Yes
** botVersion **
The version of the bot that was exported. This will be either `DRAFT` or the version number.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 5.
Pattern: `^(DRAFT|[0-9]+)$`
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/BotExportSpecification)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/BotExportSpecification)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/BotExportSpecification)
# BotFilter
Filters the responses returned by the `ListBots` operation.
## Contents
** name **
The name of the field to filter the list of bots.
Type: String
Valid Values: `BotName | BotType`
Required: Yes
** operator **
The operator to use for the filter. Specify `EQ` when the `ListBots` operation should return only aliases that equal the specified value. Specify `CO` when the `ListBots` operation should return aliases that contain the specified value.
Type: String
Valid Values: `CO | EQ | NE`
Required: Yes
** values **
The value to use for filtering the list of bots.
Type: Array of strings
Array Members: Fixed number of 1 item.
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern: `^[0-9a-zA-Z_()\s-]+$`
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/BotFilter)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/BotFilter)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/BotFilter)
# BotImportSpecification
Provides the bot parameters required for importing a bot.
## Contents
** botName **
The name that Amazon Lex should use for the bot.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern: `^([0-9a-zA-Z][_-]?){1,100}$`
Required: Yes
** dataPrivacy **
By default, data stored by Amazon Lex is encrypted. The `DataPrivacy` structure provides settings that determine how Amazon Lex handles special cases of securing the data for your bot.
Type: [DataPrivacy](API_DataPrivacy.md) object
Required: Yes
** roleArn **
The Amazon Resource Name (ARN) of the IAM role used to build and run the bot.
Type: String
Length Constraints: Minimum length of 32. Maximum length of 2048.
Pattern: `^arn:aws:iam::[0-9]{12}:role/.*$`
Required: Yes
** botTags **
A list of tags to add to the bot. You can only add tags when you import 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
** errorLogSettings **
Allows you to configure destinations where error logs will be published during the bot import process.
Type: [ErrorLogSettings](API_ErrorLogSettings.md) object
Required: No
** idleSessionTTLInSeconds **
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: No
** testBotAliasTags **
A list of tags to add to the test alias for a bot. You can only add tags when you import 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
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/BotImportSpecification)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/BotImportSpecification)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/BotImportSpecification)
# BotLocaleExportSpecification
Provides the bot locale parameters required for exporting a bot locale.
## Contents
** botId **
The identifier of the bot to create the locale for.
Type: String
Length Constraints: Fixed length of 10.
Pattern: `^[0-9a-zA-Z]+$`
Required: Yes
** botVersion **
The version of the bot to export.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 5.
Pattern: `^(DRAFT|[0-9]+)$`
Required: Yes
** localeId **
The identifier of the language and locale to export. The string must match one of the locales in the bot.
Type: String
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/BotLocaleExportSpecification)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/BotLocaleExportSpecification)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/BotLocaleExportSpecification)
# BotLocaleFilter
Filters responses returned by the `ListBotLocales` operation.
## Contents
** name **
The name of the field to filter the list of bots.
Type: String
Valid Values: `BotLocaleName`
Required: Yes
** operator **
The operator to use for the filter. Specify `EQ` when the `ListBotLocales` operation should return only aliases that equal the specified value. Specify `CO` when the `ListBotLocales` operation should return aliases that contain the specified value.
Type: String
Valid Values: `CO | EQ`
Required: Yes
** values **
The value to use for filtering the list of bots.
Type: Array of strings
Array Members: Fixed number of 1 item.
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern: `^[0-9a-zA-Z_()\s-]+$`
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/BotLocaleFilter)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/BotLocaleFilter)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/BotLocaleFilter)
# BotLocaleHistoryEvent
Provides information about an event that occurred affecting the bot locale.
## Contents
** event **
A description of the event that occurred.
Type: String
Required: Yes
** eventDate **
A timestamp of the date and time that the event occurred.
Type: Timestamp
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/BotLocaleHistoryEvent)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/BotLocaleHistoryEvent)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/BotLocaleHistoryEvent)
# BotLocaleImportSpecification
Provides the bot locale parameters required for importing a bot locale.
## Contents
** botId **
The identifier of the bot to import the locale to.
Type: String
Length Constraints: Fixed length of 10.
Pattern: `^[0-9a-zA-Z]+$`
Required: Yes
** botVersion **
The version of the bot to import the locale to. This can only be the `DRAFT` version of the bot.
Type: String
Length Constraints: Fixed length of 5.
Pattern: `^DRAFT$`
Required: Yes
** localeId **
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 **
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 `PostText` operation would be:
+ `AMAZON.FallbackIntent`
+ `IntentA`
+ `IntentB`
+ `IntentC`
Type: Double
Valid Range: Minimum value of 0. Maximum value of 1.
Required: No
** speechDetectionSensitivity **
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 **
Speech-to-text settings to apply when importing the bot locale configuration.
Type: [SpeechRecognitionSettings](API_SpeechRecognitionSettings.md) object
Required: No
** unifiedSpeechSettings **
Unified speech settings to apply when importing the bot locale configuration.
Type: [UnifiedSpeechSettings](API_UnifiedSpeechSettings.md) object
Required: No
** voiceSettings **
Defines settings for using an Amazon Polly voice to communicate with a user.
Valid values include:
+ `standard`
+ `neural`
+ `long-form`
+ `generative`
Type: [VoiceSettings](API_VoiceSettings.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/BotLocaleImportSpecification)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/BotLocaleImportSpecification)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/BotLocaleImportSpecification)
# BotLocaleSortBy
Specifies attributes for sorting a list of bot locales.
## Contents
** attribute **
The bot locale attribute to sort by.
Type: String
Valid Values: `BotLocaleName`
Required: Yes
** order **
Specifies whether to sort the bot locales in ascending or descending order.
Type: String
Valid Values: `Ascending | Descending`
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/BotLocaleSortBy)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/BotLocaleSortBy)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/BotLocaleSortBy)
# BotLocaleSummary
Summary information about bot locales returned by the [ListBotLocales](https://docs.aws.amazon.com/lexv2/latest/APIReference/API_ListBotLocales.html) operation.
## Contents
** botLocaleStatus **
The current status of the bot locale. When the status is `Built` the locale is ready for use.
Type: String
Valid Values: `Creating | Building | Built | ReadyExpressTesting | Failed | Deleting | NotBuilt | Importing | Processing`
Required: No
** description **
The description of the bot locale.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 2000.
Required: No
** lastBuildSubmittedDateTime **
A timestamp of the date and time that the bot locale was last built.
Type: Timestamp
Required: No
** lastUpdatedDateTime **
A timestamp of the date and time that the bot locale was last updated.
Type: Timestamp
Required: No
** localeId **
The language and locale of the bot locale.
Type: String
Required: No
** localeName **
The name of the bot locale.
Type: String
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/BotLocaleSummary)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/BotLocaleSummary)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/BotLocaleSummary)
# BotMember
A bot that is a member of a network of bots.
## Contents
** botMemberAliasId **
The alias ID of a bot that is a member of this network of bots.
Type: String
Length Constraints: Fixed length of 10.
Pattern: `^(\bTSTALIASID\b|[0-9a-zA-Z]+)$`
Required: Yes
** botMemberAliasName **
The alias name of a bot that is a member of this network of bots.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern: `^(\bAmazonLexTestAlias\b|[0-9a-zA-Z][_-]?)+$`
Required: Yes
** botMemberId **
The unique ID of a bot that is a member of this network of bots.
Type: String
Length Constraints: Fixed length of 10.
Pattern: `^[0-9a-zA-Z]+$`
Required: Yes
** botMemberName **
The unique name of a bot that is a member of this network of bots.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern: `^([0-9a-zA-Z][_-]?){1,100}$`
Required: Yes
** botMemberVersion **
The version of a bot that is a member of this network of bots.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 5.
Pattern: `^(DRAFT|[0-9]+)$`
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/BotMember)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/BotMember)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/BotMember)
# BotRecommendationResults
The object representing the URL of the bot definition, the URL of the associated transcript, and a statistical summary of the bot recommendation results.
## Contents
** associatedTranscriptsUrl **
The presigned url link of the associated transcript.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Required: No
** botLocaleExportUrl **
The presigned URL link of the recommended bot definition.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Required: No
** statistics **
The statistical summary of the bot recommendation results.
Type: [BotRecommendationResultStatistics](API_BotRecommendationResultStatistics.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/BotRecommendationResults)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/BotRecommendationResults)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/BotRecommendationResults)
# BotRecommendationResultStatistics
A statistical summary of the bot recommendation results.
## Contents
** intents **
Statistical information about about the intents associated with the bot recommendation results.
Type: [IntentStatistics](API_IntentStatistics.md) object
Required: No
** slotTypes **
Statistical information about the slot types associated with the bot recommendation results.
Type: [SlotTypeStatistics](API_SlotTypeStatistics.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/BotRecommendationResultStatistics)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/BotRecommendationResultStatistics)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/BotRecommendationResultStatistics)
# BotRecommendationSummary
A summary of the bot recommendation.
## Contents
** botRecommendationId **
The unique identifier of the bot recommendation to be updated.
Type: String
Length Constraints: Fixed length of 10.
Pattern: `^[0-9a-zA-Z]+$`
Required: Yes
** botRecommendationStatus **
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`
Required: Yes
** creationDateTime **
A timestamp of the date and time that the bot recommendation was created.
Type: Timestamp
Required: No
** lastUpdatedDateTime **
A timestamp of the date and time that the bot recommendation was last updated.
Type: Timestamp
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/BotRecommendationSummary)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/BotRecommendationSummary)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/BotRecommendationSummary)
# BotReplicaSummary
Contains summary information about all the replication statuses applicable for global resiliency.
## Contents
** botReplicaStatus **
The operation status for the replicated bot applicable.
Type: String
Valid Values: `Enabling | Enabled | Deleting | Failed`
Required: No
** creationDateTime **
The creation time and date for the replicated bots.
Type: Timestamp
Required: No
** failureReasons **
The reasons for the failure for the replicated bot.
Type: Array of strings
Required: No
** replicaRegion **
The replica region used in the replication statuses summary.
Type: String
Length Constraints: Minimum length of 2. Maximum length of 25.
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/BotReplicaSummary)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/BotReplicaSummary)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/BotReplicaSummary)
# BotSortBy
Specifies attributes for sorting a list of bots.
## Contents
** attribute **
The attribute to use to sort the list of bots.
Type: String
Valid Values: `BotName`
Required: Yes
** order **
The order to sort the list. You can choose ascending or descending.
Type: String
Valid Values: `Ascending | Descending`
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/BotSortBy)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/BotSortBy)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/BotSortBy)
# BotSummary
Summary information about a bot returned by the [ListBots](https://docs.aws.amazon.com/lexv2/latest/APIReference/API_ListBots.html) operation.
## Contents
** botId **
The unique identifier assigned to the bot. Use this ID to get detailed information about the bot with the [DescribeBot](https://docs.aws.amazon.com/lexv2/latest/APIReference/API_DescribeBot.html) operation.
Type: String
Length Constraints: Fixed length of 10.
Pattern: `^[0-9a-zA-Z]+$`
Required: No
** botName **
The name of the bot.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern: `^([0-9a-zA-Z][_-]?){1,100}$`
Required: No
** botStatus **
The current status of the bot. When the status is `Available` the bot is ready for use.
Type: String
Valid Values: `Creating | Available | Inactive | Deleting | Failed | Versioning | Importing | Updating`
Required: No
** botType **
The type of the bot.
Type: String
Valid Values: `Bot | BotNetwork`
Required: No
** description **
The description of the bot.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 2000.
Required: No
** lastUpdatedDateTime **
The date and time that the bot was last updated.
Type: Timestamp
Required: No
** latestBotVersion **
The latest numerical version in use for the bot.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 5.
Pattern: `^[0-9]+$`
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/BotSummary)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/BotSummary)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/BotSummary)
# BotVersionLocaleDetails
The version of a bot used for a bot locale.
## Contents
** sourceBotVersion **
The version of a bot used for a bot locale.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 5.
Pattern: `^(DRAFT|[0-9]+)$`
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/BotVersionLocaleDetails)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/BotVersionLocaleDetails)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/BotVersionLocaleDetails)
# BotVersionReplicaSortBy
The sort category for the version replicated bots.
## Contents
** attribute **
The attribute of the sort category for the version replicated bots.
Type: String
Valid Values: `BotVersion`
Required: Yes
** order **
The order of the sort category for the version replicated bots.
Type: String
Valid Values: `Ascending | Descending`
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/BotVersionReplicaSortBy)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/BotVersionReplicaSortBy)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/BotVersionReplicaSortBy)
# BotVersionReplicaSummary
Contains summary information for all the version replication statuses applicable for Global resiliency.
## Contents
** botVersion **
The bot version for the summary information for all the version replication statuses.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 5.
Pattern: `^(DRAFT|[0-9]+)$`
Required: No
** botVersionReplicationStatus **
The version replication status for all the replicated bots.
Type: String
Valid Values: `Creating | Available | Deleting | Failed`
Required: No
** creationDateTime **
The creation date and time of the replication status for all the replicated bots.
Type: Timestamp
Required: No
** failureReasons **
The reasons for replication failure for all the replicated bots.
Type: Array of strings
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/BotVersionReplicaSummary)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/BotVersionReplicaSummary)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/BotVersionReplicaSummary)
# BotVersionSortBy
Specifies attributes for sorting a list of bot versions.
## Contents
** attribute **
The attribute to use to sort the list of versions.
Type: String
Valid Values: `BotVersion`
Required: Yes
** order **
The order to sort the list. You can specify ascending or descending order.
Type: String
Valid Values: `Ascending | Descending`
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/BotVersionSortBy)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/BotVersionSortBy)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/BotVersionSortBy)
# BotVersionSummary
Summary information about a bot version returned by the [ListBotVersions](https://docs.aws.amazon.com/lexv2/latest/APIReference/API_ListBotVersions.html) operation.
## Contents
** botName **
The name of the bot associated with the version.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern: `^([0-9a-zA-Z][_-]?){1,100}$`
Required: No
** botStatus **
The status of the bot. When the status is available, the version of the bot is ready for use.
Type: String
Valid Values: `Creating | Available | Inactive | Deleting | Failed | Versioning | Importing | Updating`
Required: No
** botVersion **
The numeric version of the bot, or `DRAFT` to indicate that this is the version of the bot that can be updated..
Type: String
Length Constraints: Minimum length of 1. Maximum length of 5.
Pattern: `^(DRAFT|[0-9]+)$`
Required: No
** creationDateTime **
A timestamp of the date and time that the version was created.
Type: Timestamp
Required: No
** description **
The description of the version.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 2000.
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/BotVersionSummary)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/BotVersionSummary)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/BotVersionSummary)
# BuildtimeSettings
Contains specifications about the Amazon Lex build time generative AI capabilities from Amazon Bedrock that you can turn on for your bot.
## Contents
** descriptiveBotBuilder **
An object containing specifications for the descriptive bot building feature.
Type: [DescriptiveBotBuilderSpecification](API_DescriptiveBotBuilderSpecification.md) object
Required: No
** sampleUtteranceGeneration **
Contains specifications for the sample utterance generation feature.
Type: [SampleUtteranceGenerationSpecification](API_SampleUtteranceGenerationSpecification.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/BuildtimeSettings)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/BuildtimeSettings)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/BuildtimeSettings)
# BuiltInIntentSortBy
Specifies attributes for sorting a list of built-in intents.
## Contents
** attribute **
The attribute to use to sort the list of built-in intents.
Type: String
Valid Values: `IntentSignature`
Required: Yes
** order **
The order to sort the list. You can specify ascending or descending order.
Type: String
Valid Values: `Ascending | Descending`
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/BuiltInIntentSortBy)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/BuiltInIntentSortBy)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/BuiltInIntentSortBy)
# BuiltInIntentSummary
Provides summary information about a built-in intent for the [ ListBuiltInIntents ](https://docs.aws.amazon.com/lexv2/latest/APIReference/API_ListBuiltInIntents.html) operation.
## Contents
** description **
The description of the intent.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 2000.
Required: No
** intentSignature **
The signature of the built-in intent. Use this to specify the parent intent of a derived intent.
Type: String
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/BuiltInIntentSummary)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/BuiltInIntentSummary)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/BuiltInIntentSummary)
# BuiltInSlotTypeSortBy
Specifies attributes for sorting a list of built-in slot types.
## Contents
** attribute **
The attribute to use to sort the list of built-in intents.
Type: String
Valid Values: `SlotTypeSignature`
Required: Yes
** order **
The order to sort the list. You can choose ascending or descending.
Type: String
Valid Values: `Ascending | Descending`
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/BuiltInSlotTypeSortBy)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/BuiltInSlotTypeSortBy)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/BuiltInSlotTypeSortBy)
# BuiltInSlotTypeSummary
Provides summary information about a built-in slot type for the [ ListBuiltInSlotTypes ](https://docs.aws.amazon.com/lexv2/latest/APIReference/API_ListBuiltInSlotTypes.html) operation.
## Contents
** description **
The description of the built-in slot type.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 2000.
Required: No
** slotTypeSignature **
The signature of the built-in slot type. Use this to specify the parent slot type of a derived slot type.
Type: String
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/BuiltInSlotTypeSummary)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/BuiltInSlotTypeSummary)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/BuiltInSlotTypeSummary)
# Button
Describes a button to use on a response card used to gather slot values from a user.
## Contents
** text **
The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 50.
Required: Yes
** value **
The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 50.
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/Button)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/Button)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/Button)
# CloudWatchLogGroupLogDestination
The Amazon CloudWatch Logs log group where the text and metadata logs are delivered. The log group must exist before you enable logging.
## Contents
** cloudWatchLogGroupArn **
The Amazon Resource Name (ARN) of the log group where text and metadata logs are delivered.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: `^arn:[\w\-]+:logs:[\w\-]+:[\d]{12}:log-group:[\.\-_/#A-Za-z0-9]{1,512}(?::\*)?$`
Required: Yes
** logPrefix **
The prefix of the log stream name within the log group that you specified
Type: String
Length Constraints: Maximum length of 1024.
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/CloudWatchLogGroupLogDestination)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/CloudWatchLogGroupLogDestination)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/CloudWatchLogGroupLogDestination)
# CodeHookSpecification
Contains information about code hooks that Amazon Lex calls during a conversation.
## Contents
** lambdaCodeHook **
Specifies a Lambda function that verifies requests to a bot or fulfills the user's request to a bot.
Type: [LambdaCodeHook](API_LambdaCodeHook.md) object
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/CodeHookSpecification)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/CodeHookSpecification)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/CodeHookSpecification)
# CompositeSlotTypeSetting
A composite slot is a combination of two or more slots that capture multiple pieces of information in a single user input.
## Contents
** subSlots **
Subslots in the composite slot.
Type: Array of [SubSlotTypeComposition](API_SubSlotTypeComposition.md) objects
Array Members: Minimum number of 0 items. Maximum number of 6 items.
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/CompositeSlotTypeSetting)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/CompositeSlotTypeSetting)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/CompositeSlotTypeSetting)
# Condition
Provides an expression that evaluates to true or false.
## Contents
** expressionString **
The expression string that is evaluated.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/Condition)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/Condition)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/Condition)
# ConditionalBranch
A set of actions that Amazon Lex should run if the condition is matched.
## Contents
** condition **
Contains the expression to evaluate. If the condition is true, the branch's actions are taken.
Type: [Condition](API_Condition.md) object
Required: Yes
** name **
The name of the branch.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern: `^([0-9a-zA-Z][_-]?){1,100}$`
Required: Yes
** nextStep **
The next step in the conversation.
Type: [DialogState](API_DialogState.md) object
Required: Yes
** response **
Specifies a list of message groups that Amazon Lex uses to respond the user input.
Type: [ResponseSpecification](API_ResponseSpecification.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/ConditionalBranch)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/ConditionalBranch)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/ConditionalBranch)
# ConditionalSpecification
Provides a list of conditional branches. Branches are evaluated in the order that they are entered in the list. The first branch with a condition that evaluates to true is executed. The last branch in the list is the default branch. The default branch should not have any condition expression. The default branch is executed if no other branch has a matching condition.
## Contents
** active **
Determines whether a conditional branch is active. When `active` is false, the conditions are not evaluated.
Type: Boolean
Required: Yes
** conditionalBranches **
A list of conditional branches. A conditional branch is made up of a condition, a response and a next step. The response and next step are executed when the condition is true.
Type: Array of [ConditionalBranch](API_ConditionalBranch.md) objects
Array Members: Minimum number of 1 item. Maximum number of 4 items.
Required: Yes
** defaultBranch **
The conditional branch that should be followed when the conditions for other branches are not satisfied. A conditional branch is made up of a condition, a response and a next step.
Type: [DefaultConditionalBranch](API_DefaultConditionalBranch.md) object
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/ConditionalSpecification)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/ConditionalSpecification)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/ConditionalSpecification)
# ConversationLevelIntentClassificationResultItem
The item listing the evaluation of intent level success or failure.
## Contents
** intentName **
The intent name used in the evaluation of intent level success or failure.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern: `^([0-9a-zA-Z][_-]?){1,100}$`
Required: Yes
** matchResult **
The number of times the specific intent is used in the evaluation of intent level success or failure.
Type: String
Valid Values: `Matched | Mismatched | ExecutionError`
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/ConversationLevelIntentClassificationResultItem)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/ConversationLevelIntentClassificationResultItem)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/ConversationLevelIntentClassificationResultItem)
# ConversationLevelResultDetail
The conversation level details of the conversation used in the test set.
## Contents
** endToEndResult **
The success or failure of the streaming of the conversation.
Type: String
Valid Values: `Matched | Mismatched | ExecutionError`
Required: Yes
** speechTranscriptionResult **
The speech transcription success or failure details of the conversation.
Type: String
Valid Values: `Matched | Mismatched | ExecutionError`
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/ConversationLevelResultDetail)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/ConversationLevelResultDetail)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/ConversationLevelResultDetail)
# ConversationLevelSlotResolutionResultItem
The slots used for the slot resolution in the conversation.
## Contents
** intentName **
The intents used in the slots list for the slot resolution details.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern: `^([0-9a-zA-Z][_-]?){1,100}$`
Required: Yes
** matchResult **
The number of matching slots used in the slots listings for the slot resolution evaluation.
Type: String
Valid Values: `Matched | Mismatched | ExecutionError`
Required: Yes
** slotName **
The slot name in the slots list for the slot resolution details.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern: `^([0-9a-zA-Z][_.-]?)+$`
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/ConversationLevelSlotResolutionResultItem)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/ConversationLevelSlotResolutionResultItem)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/ConversationLevelSlotResolutionResultItem)
# ConversationLevelTestResultItem
The test result evaluation item at the conversation level.
## Contents
** conversationId **
The conversation Id of the test result evaluation item.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 50.
Pattern: `^([0-9a-zA-Z][_-]?)+$`
Required: Yes
** endToEndResult **
The end-to-end success or failure of the test result evaluation item.
Type: String
Valid Values: `Matched | Mismatched | ExecutionError`
Required: Yes
** intentClassificationResults **
The intent classification of the test result evaluation item.
Type: Array of [ConversationLevelIntentClassificationResultItem](API_ConversationLevelIntentClassificationResultItem.md) objects
Required: Yes
** slotResolutionResults **
The slot success or failure of the test result evaluation item.
Type: Array of [ConversationLevelSlotResolutionResultItem](API_ConversationLevelSlotResolutionResultItem.md) objects
Required: Yes
** speechTranscriptionResult **
The speech transcription success or failure of the test result evaluation item.
Type: String
Valid Values: `Matched | Mismatched | ExecutionError`
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/ConversationLevelTestResultItem)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/ConversationLevelTestResultItem)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/ConversationLevelTestResultItem)
# ConversationLevelTestResults
The test set results data at the conversation level.
## Contents
** items **
The item list in the test set results data at the conversation level.
Type: Array of [ConversationLevelTestResultItem](API_ConversationLevelTestResultItem.md) objects
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/ConversationLevelTestResults)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/ConversationLevelTestResults)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/ConversationLevelTestResults)
# ConversationLevelTestResultsFilterBy
The selection to filter the test set results data at the conversation level.
## Contents
** endToEndResult **
The selection of matched or mismatched end-to-end status to filter test set results data at the conversation level.
Type: String
Valid Values: `Matched | Mismatched | ExecutionError`
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/ConversationLevelTestResultsFilterBy)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/ConversationLevelTestResultsFilterBy)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/ConversationLevelTestResultsFilterBy)
# ConversationLogsDataSource
The data source that uses conversation logs.
## Contents
** botAliasId **
The bot alias Id from the conversation logs.
Type: String
Length Constraints: Fixed length of 10.
Pattern: `^(\bTSTALIASID\b|[0-9a-zA-Z]+)$`
Required: Yes
** botId **
The bot Id from the conversation logs.
Type: String
Length Constraints: Fixed length of 10.
Pattern: `^[0-9a-zA-Z]+$`
Required: Yes
** filter **
The filter for the data source of the conversation log.
Type: [ConversationLogsDataSourceFilterBy](API_ConversationLogsDataSourceFilterBy.md) object
Required: Yes
** localeId **
The locale Id of the conversation log.
Type: String
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/ConversationLogsDataSource)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/ConversationLogsDataSource)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/ConversationLogsDataSource)
# ConversationLogsDataSourceFilterBy
The selected data source to filter the conversation log.
## Contents
** endTime **
The end time for the conversation log.
Type: Timestamp
Required: Yes
** inputMode **
The selection to filter by input mode for the conversation logs.
Type: String
Valid Values: `Speech | Text`
Required: Yes
** startTime **
The start time for the conversation log.
Type: Timestamp
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/ConversationLogsDataSourceFilterBy)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/ConversationLogsDataSourceFilterBy)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/ConversationLogsDataSourceFilterBy)
# ConversationLogSettings
Configures conversation logging that saves audio, text, and metadata for the conversations with your users.
## Contents
** audioLogSettings **
The Amazon S3 settings for logging audio to an S3 bucket.
Type: Array of [AudioLogSetting](API_AudioLogSetting.md) objects
Array Members: Fixed number of 1 item.
Required: No
** textLogSettings **
The Amazon CloudWatch Logs settings for logging text and metadata.
Type: Array of [TextLogSetting](API_TextLogSetting.md) objects
Array Members: Fixed number of 1 item.
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/ConversationLogSettings)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/ConversationLogSettings)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/ConversationLogSettings)
# CustomPayload
A custom response string that Amazon Lex sends to your application. You define the content and structure the string.
## Contents
** value **
The string that is sent to your application.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1000.
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/CustomPayload)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/CustomPayload)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/CustomPayload)
# CustomVocabularyEntryId
The unique entry identifier for the custom vocabulary items.
## Contents
** itemId **
The unique item identifier for the custom vocabulary items.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 32.
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/CustomVocabularyEntryId)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/CustomVocabularyEntryId)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/CustomVocabularyEntryId)
# CustomVocabularyExportSpecification
Provides the parameters required for exporting a custom vocabulary.
## Contents
** botId **
The identifier of the bot that contains the custom vocabulary to export.
Type: String
Length Constraints: Fixed length of 10.
Pattern: `^[0-9a-zA-Z]+$`
Required: Yes
** botVersion **
The version of the bot that contains the custom vocabulary to export.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 5.
Pattern: `^(DRAFT|[0-9]+)$`
Required: Yes
** localeId **
The locale of the bot that contains the custom vocabulary to export.
Type: String
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/CustomVocabularyExportSpecification)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/CustomVocabularyExportSpecification)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/CustomVocabularyExportSpecification)
# CustomVocabularyImportSpecification
Provides the parameters required for importing a custom vocabulary.
## Contents
** botId **
The identifier of the bot to import the custom vocabulary to.
Type: String
Length Constraints: Fixed length of 10.
Pattern: `^[0-9a-zA-Z]+$`
Required: Yes
** botVersion **
The version of the bot to import the custom vocabulary to.
Type: String
Length Constraints: Fixed length of 5.
Pattern: `^DRAFT$`
Required: Yes
** localeId **
The identifier of the local to import the custom vocabulary to. The value must be `en_GB`.
Type: String
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/CustomVocabularyImportSpecification)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/CustomVocabularyImportSpecification)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/CustomVocabularyImportSpecification)
# CustomVocabularyItem
The unique custom vocabulary item from the custom vocabulary list.
## Contents
** itemId **
The unique item identifer for the custom vocabulary item from the custom vocabulary list.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 32.
Required: Yes
** phrase **
The unique phrase for the custom vocabulary item from the custom vocabulary list.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Required: Yes
** displayAs **
The DisplayAs value for the custom vocabulary item from the custom vocabulary list.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Required: No
** weight **
The weight assigned for the custom vocabulary item from the custom vocabulary list.
Type: Integer
Valid Range: Minimum value of 0. Maximum value of 3.
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/CustomVocabularyItem)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/CustomVocabularyItem)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/CustomVocabularyItem)
# DataPrivacy
By default, data stored by Amazon Lex is encrypted. The `DataPrivacy` structure provides settings that determine how Amazon Lex handles special cases of securing the data for your bot.
## Contents
** childDirected **
For each Amazon Lex bot created with the Amazon Lex Model Building Service, you must specify whether your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to the Children's Online Privacy Protection Act (COPPA) by specifying `true` or `false` in the `childDirected` field. By specifying `true` in the `childDirected` field, you confirm that your use of Amazon Lex **is** related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA. By specifying `false` in the `childDirected` field, you confirm that your use of Amazon Lex **is not** related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA. You may not specify a default value for the `childDirected` field that does not accurately reflect whether your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA. If your use of Amazon Lex relates to a website, program, or other application that is directed in whole or in part, to children under age 13, you must obtain any required verifiable parental consent under COPPA. For information regarding the use of Amazon Lex in connection with websites, programs, or other applications that are directed or targeted, in whole or in part, to children under age 13, see the [Amazon Lex FAQ](http://aws.amazon.com/lex/faqs#data-security).
Type: Boolean
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/DataPrivacy)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/DataPrivacy)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/DataPrivacy)
# DataSourceConfiguration
Contains details about the configuration of the knowledge store used for the `AMAZON.QnAIntent`. You must have already created the knowledge store and indexed the documents within it.
## Contents
** bedrockKnowledgeStoreConfiguration **
Contains details about the configuration of the Amazon Bedrock knowledge base used for the `AMAZON.QnAIntent`. To set up a knowledge base, follow the steps at [Building a knowledge base](https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base.html).
Type: [BedrockKnowledgeStoreConfiguration](API_BedrockKnowledgeStoreConfiguration.md) object
Required: No
** kendraConfiguration **
Contains details about the configuration of the Amazon Kendra index used for the `AMAZON.QnAIntent`. To create a Amazon Kendra index, follow the steps at [Creating an index](https://docs.aws.amazon.com/kendra/latest/dg/create-index.html).
Type: [QnAKendraConfiguration](API_QnAKendraConfiguration.md) object
Required: No
** opensearchConfiguration **
Contains details about the configuration of the Amazon OpenSearch Service database used for the `AMAZON.QnAIntent`. To create a domain, follow the steps at [Creating and managing Amazon OpenSearch Service domains](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/createupdatedomains.html).
Type: [OpensearchConfiguration](API_OpensearchConfiguration.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/DataSourceConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/DataSourceConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/DataSourceConfiguration)
# DateRangeFilter
The object used for specifying the data range that the customer wants Amazon Lex to read through in the input transcripts.
## Contents
** endDateTime **
A timestamp indicating the end date for the date range filter.
Type: Timestamp
Required: Yes
** startDateTime **
A timestamp indicating the start date for the date range filter.
Type: Timestamp
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/DateRangeFilter)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/DateRangeFilter)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/DateRangeFilter)
# DeepgramSpeechModelConfig
Configuration settings for integrating Deepgram speech-to-text models with Amazon Lex.
## Contents
** apiTokenSecretArn **
The Amazon Resource Name (ARN) of the Secrets Manager secret that contains the Deepgram API token.
Type: String
Length Constraints: Minimum length of 20. Maximum length of 2048.
Pattern: `^arn:aws[A-Za-z-]*:secretsmanager:[a-z0-9-]{1,20}:[0-9]{12}:secret:[A-Za-z0-9/_+=.@-]{1,512}-[A-Za-z0-9]{6}$`
Required: Yes
** modelId **
The identifier of the Deepgram speech-to-text model to use for processing speech input.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 32.
Pattern: `[A-Za-z0-9-_]+`
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/DeepgramSpeechModelConfig)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/DeepgramSpeechModelConfig)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/DeepgramSpeechModelConfig)
# DefaultConditionalBranch
A set of actions that Amazon Lex should run if none of the other conditions are met.
## Contents
** nextStep **
The next step in the conversation.
Type: [DialogState](API_DialogState.md) object
Required: No
** response **
Specifies a list of message groups that Amazon Lex uses to respond the user input.
Type: [ResponseSpecification](API_ResponseSpecification.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/DefaultConditionalBranch)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/DefaultConditionalBranch)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/DefaultConditionalBranch)
# DescriptiveBotBuilderSpecification
Contains specifications for the descriptive bot building feature.
## Contents
** enabled **
Specifies whether the descriptive bot building feature is activated or not.
Type: Boolean
Required: Yes
** bedrockModelSpecification **
An object containing information about the Amazon Bedrock model used to interpret the prompt used in descriptive bot building.
Type: [BedrockModelSpecification](API_BedrockModelSpecification.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/DescriptiveBotBuilderSpecification)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/DescriptiveBotBuilderSpecification)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/DescriptiveBotBuilderSpecification)
# DialogAction
Defines the action that the bot executes at runtime when the conversation reaches this step.
## Contents
** type **
The action that the bot should execute.
Type: String
Valid Values: `ElicitIntent | StartIntent | ElicitSlot | EvaluateConditional | InvokeDialogCodeHook | ConfirmIntent | FulfillIntent | CloseIntent | EndConversation`
Required: Yes
** slotToElicit **
If the dialog action is `ElicitSlot`, defines the slot to elicit from the user.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern: `^([0-9a-zA-Z][_-]?){1,100}$`
Required: No
** suppressNextMessage **
When true the next message for the intent is not used.
Type: Boolean
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/DialogAction)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/DialogAction)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/DialogAction)
# DialogCodeHookInvocationSetting
Settings that specify the dialog code hook that is called by Amazon Lex at a step of the conversation.
## Contents
** active **
Determines whether a dialog code hook is used when the intent is activated.
Type: Boolean
Required: Yes
** enableCodeHookInvocation **
Indicates whether a Lambda function should be invoked for the dialog.
Type: Boolean
Required: Yes
** postCodeHookSpecification **
Contains the responses and actions that Amazon Lex takes after the Lambda function is complete.
Type: [PostDialogCodeHookInvocationSpecification](API_PostDialogCodeHookInvocationSpecification.md) object
Required: Yes
** invocationLabel **
A label that indicates the dialog step from which the dialog code hook is happening.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern: `^([0-9a-zA-Z][_-]?){1,100}$`
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/DialogCodeHookInvocationSetting)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/DialogCodeHookInvocationSetting)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/DialogCodeHookInvocationSetting)
# DialogCodeHookSettings
Settings that determine the Lambda function that Amazon Lex uses for processing user responses.
## Contents
** enabled **
Enables the dialog code hook so that it processes user requests.
Type: Boolean
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/DialogCodeHookSettings)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/DialogCodeHookSettings)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/DialogCodeHookSettings)
# DialogState
The current state of the conversation with the user.
## Contents
** dialogAction **
Defines the action that the bot executes at runtime when the conversation reaches this step.
Type: [DialogAction](API_DialogAction.md) object
Required: No
** intent **
Override settings to configure the intent state.
Type: [IntentOverride](API_IntentOverride.md) object
Required: No
** sessionAttributes **
Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
Type: String to string map
Key Length Constraints: Minimum length of 1.
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/DialogState)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/DialogState)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/DialogState)
# DTMFSpecification
Specifies the DTMF input specifications.
## Contents
** deletionCharacter **
The DTMF character that clears the accumulated DTMF digits and immediately ends the input.
Type: String
Pattern: `^[A-D0-9#*]{1}$`
Required: Yes
** endCharacter **
The DTMF character that immediately ends input. If the user does not press this character, the input ends after the end timeout.
Type: String
Pattern: `^[A-D0-9#*]{1}$`
Required: Yes
** endTimeoutMs **
How long the bot should wait after the last DTMF character input before assuming that the input has concluded.
Type: Integer
Valid Range: Minimum value of 1.
Required: Yes
** maxLength **
The maximum number of DTMF digits allowed in an utterance.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 1024.
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/DTMFSpecification)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/DTMFSpecification)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/DTMFSpecification)
# ElicitationCodeHookInvocationSetting
Settings that specify the dialog code hook that is called by Amazon Lex between eliciting slot values.
## Contents
** enableCodeHookInvocation **
Indicates whether a Lambda function should be invoked for the dialog.
Type: Boolean
Required: Yes
** invocationLabel **
A label that indicates the dialog step from which the dialog code hook is happening.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern: `^([0-9a-zA-Z][_-]?){1,100}$`
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/ElicitationCodeHookInvocationSetting)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/ElicitationCodeHookInvocationSetting)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/ElicitationCodeHookInvocationSetting)
# EncryptionSetting
The object representing the passwords that were used to encrypt the data related to the bot recommendation, as well as the AWS KMS key ARN used to encrypt the associated metadata.
## Contents
** associatedTranscriptsPassword **
The password used to encrypt the associated transcript file.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 1024.
Required: No
** botLocaleExportPassword **
The password used to encrypt the recommended bot recommendation file.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 1024.
Required: No
** kmsKeyArn **
The AWS KMS key ARN used to encrypt the metadata associated with the bot recommendation.
Type: String
Length Constraints: Minimum length of 20. Maximum length of 2048.
Pattern: `^arn:[\w\-]+:kms:[\w\-]+:[\d]{12}:(?:key\/[\w\-]+|alias\/[a-zA-Z0-9:\/_\-]{1,256})$`
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/EncryptionSetting)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/EncryptionSetting)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/EncryptionSetting)
# ErrorLogSettings
Settings parameters for the error logs, whether it is enabled or disabled.
## Contents
** enabled **
Settings parameters for the error logs, when it is enabled.
Type: Boolean
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/ErrorLogSettings)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/ErrorLogSettings)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/ErrorLogSettings)
# ExactResponseFields
Contains the names of the fields used for an exact response to the user.
## Contents
** answerField **
The name of the field that contains the answer to the query made to the OpenSearch Service database.
Type: String
Required: Yes
** questionField **
The name of the field that contains the query made to the OpenSearch Service database.
Type: String
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/ExactResponseFields)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/ExactResponseFields)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/ExactResponseFields)
# ExecutionErrorDetails
Details about an error in an execution of a test set.
## Contents
** errorCode **
The error code for the error.
Type: String
Length Constraints: Minimum length of 1.
Required: Yes
** errorMessage **
The message describing the error.
Type: String
Length Constraints: Minimum length of 1.
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/ExecutionErrorDetails)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/ExecutionErrorDetails)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/ExecutionErrorDetails)
# ExportFilter
Filters the response form the [ListExports](https://docs.aws.amazon.com/lexv2/latest/APIReference/API_ListExports.html) operation
## Contents
** name **
The name of the field to use for filtering.
Type: String
Valid Values: `ExportResourceType`
Required: Yes
** operator **
The operator to use for the filter. Specify EQ when the `ListExports` operation should return only resource types that equal the specified value. Specify CO when the `ListExports` operation should return resource types that contain the specified value.
Type: String
Valid Values: `CO | EQ`
Required: Yes
** values **
The values to use to filter the response. The values must be `Bot`, `BotLocale`, or `CustomVocabulary`.
Type: Array of strings
Array Members: Fixed number of 1 item.
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern: `^[0-9a-zA-Z_()\s-]+$`
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/ExportFilter)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/ExportFilter)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/ExportFilter)
# ExportResourceSpecification
Provides information about the bot or bot locale that you want to export. You can specify the `botExportSpecification` or the `botLocaleExportSpecification`, but not both.
## Contents
** botExportSpecification **
Parameters for exporting a bot.
Type: [BotExportSpecification](API_BotExportSpecification.md) object
Required: No
** botLocaleExportSpecification **
Parameters for exporting a bot locale.
Type: [BotLocaleExportSpecification](API_BotLocaleExportSpecification.md) object
Required: No
** customVocabularyExportSpecification **
The parameters required to export a custom vocabulary.
Type: [CustomVocabularyExportSpecification](API_CustomVocabularyExportSpecification.md) object
Required: No
** testSetExportSpecification **
Specifications for the test set that is exported as a resource.
Type: [TestSetExportSpecification](API_TestSetExportSpecification.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/ExportResourceSpecification)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/ExportResourceSpecification)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/ExportResourceSpecification)
# ExportSortBy
Provides information about sorting a list of exports.
## Contents
** attribute **
The export field to use for sorting.
Type: String
Valid Values: `LastUpdatedDateTime`
Required: Yes
** order **
The order to sort the list.
Type: String
Valid Values: `Ascending | Descending`
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/ExportSortBy)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/ExportSortBy)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/ExportSortBy)
# ExportSummary
Provides summary information about an export in an export list.
## Contents
** creationDateTime **
The date and time that the export was created.
Type: Timestamp
Required: No
** exportId **
The unique identifier that Amazon Lex assigned to the export.
Type: String
Length Constraints: Fixed length of 10.
Pattern: `^[0-9a-zA-Z]+$`
Required: No
** exportStatus **
The status of the export. When the status is `Completed` the export is ready to download.
Type: String
Valid Values: `InProgress | Completed | Failed | Deleting`
Required: No
** fileFormat **
The file format used in the export files.
Type: String
Valid Values: `LexJson | TSV | CSV`
Required: No
** lastUpdatedDateTime **
The date and time that the export was last updated.
Type: Timestamp
Required: No
** resourceSpecification **
Information about the bot or bot locale that was exported.
Type: [ExportResourceSpecification](API_ExportResourceSpecification.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/ExportSummary)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/ExportSummary)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/ExportSummary)
# ExternalSourceSetting
Provides information about the external source of the slot type's definition.
## Contents
** grammarSlotTypeSetting **
Settings required for a slot type based on a grammar that you provide.
Type: [GrammarSlotTypeSetting](API_GrammarSlotTypeSetting.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/ExternalSourceSetting)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/ExternalSourceSetting)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/ExternalSourceSetting)
# FailedCustomVocabularyItem
The unique failed custom vocabulary item from the custom vocabulary list.
## Contents
** errorCode **
The unique error code for the failed custom vocabulary item from the custom vocabulary list.
Type: String
Valid Values: `DUPLICATE_INPUT | RESOURCE_DOES_NOT_EXIST | RESOURCE_ALREADY_EXISTS | INTERNAL_SERVER_FAILURE`
Required: No
** errorMessage **
The error message for the failed custom vocabulary item from the custom vocabulary list.
Type: String
Required: No
** itemId **
The unique item identifer for the failed custom vocabulary item from the custom vocabulary list.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 32.
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/FailedCustomVocabularyItem)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/FailedCustomVocabularyItem)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/FailedCustomVocabularyItem)
# FulfillmentCodeHookSettings
Determines if a Lambda function should be invoked for a specific intent.
## Contents
** enabled **
Indicates whether a Lambda function should be invoked to fulfill a specific intent.
Type: Boolean
Required: Yes
** active **
Determines whether the fulfillment code hook is used. When `active` is false, the code hook doesn't run.
Type: Boolean
Required: No
** fulfillmentUpdatesSpecification **
Provides settings for update messages sent to the user for long-running Lambda fulfillment functions. Fulfillment updates can be used only with streaming conversations.
Type: [FulfillmentUpdatesSpecification](API_FulfillmentUpdatesSpecification.md) object
Required: No
** postFulfillmentStatusSpecification **
Provides settings for messages sent to the user for after the Lambda fulfillment function completes. Post-fulfillment messages can be sent for both streaming and non-streaming conversations.
Type: [PostFulfillmentStatusSpecification](API_PostFulfillmentStatusSpecification.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/FulfillmentCodeHookSettings)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/FulfillmentCodeHookSettings)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/FulfillmentCodeHookSettings)
# FulfillmentStartResponseSpecification
Provides settings for a message that is sent to the user when a fulfillment Lambda function starts running.
## Contents
** delayInSeconds **
The delay between when the Lambda fulfillment function starts running and the start message is played. If the Lambda function returns before the delay is over, the start message isn't played.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 900.
Required: Yes
** messageGroups **
1 - 5 message groups that contain start messages. Amazon Lex chooses one of the messages to play to the user.
Type: Array of [MessageGroup](API_MessageGroup.md) objects
Array Members: Minimum number of 1 item. Maximum number of 5 items.
Required: Yes
** allowInterrupt **
Determines whether the user can interrupt the start message while it is playing.
Type: Boolean
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/FulfillmentStartResponseSpecification)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/FulfillmentStartResponseSpecification)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/FulfillmentStartResponseSpecification)
# FulfillmentUpdateResponseSpecification
Provides settings for a message that is sent periodically to the user while a fulfillment Lambda function is running.
## Contents
** frequencyInSeconds **
The frequency that a message is sent to the user. When the period ends, Amazon Lex chooses a message from the message groups and plays it to the user. If the fulfillment Lambda returns before the first period ends, an update message is not played to the user.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 900.
Required: Yes
** messageGroups **
1 - 5 message groups that contain update messages. Amazon Lex chooses one of the messages to play to the user.
Type: Array of [MessageGroup](API_MessageGroup.md) objects
Array Members: Minimum number of 1 item. Maximum number of 5 items.
Required: Yes
** allowInterrupt **
Determines whether the user can interrupt an update message while it is playing.
Type: Boolean
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/FulfillmentUpdateResponseSpecification)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/FulfillmentUpdateResponseSpecification)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/FulfillmentUpdateResponseSpecification)
# FulfillmentUpdatesSpecification
Provides information for updating the user on the progress of fulfilling an intent.
## Contents
** active **
Determines whether fulfillment updates are sent to the user. When this field is true, updates are sent.
If the `active` field is set to true, the `startResponse`, `updateResponse`, and `timeoutInSeconds` fields are required.
Type: Boolean
Required: Yes
** startResponse **
Provides configuration information for the message sent to users when the fulfillment Lambda functions starts running.
Type: [FulfillmentStartResponseSpecification](API_FulfillmentStartResponseSpecification.md) object
Required: No
** timeoutInSeconds **
The length of time that the fulfillment Lambda function should run before it times out.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 900.
Required: No
** updateResponse **
Provides configuration information for messages sent periodically to the user while the fulfillment Lambda function is running.
Type: [FulfillmentUpdateResponseSpecification](API_FulfillmentUpdateResponseSpecification.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/FulfillmentUpdatesSpecification)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/FulfillmentUpdatesSpecification)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/FulfillmentUpdatesSpecification)
# GenerationSortBy
Specifies the attribute and method by which to sort the generation request information.
## Contents
** attribute **
The attribute by which to sort the generation request information. You can sort by the following attributes.
+ `creationStartTime` – The time at which the generation request was created.
+ `lastUpdatedTime` – The time at which the generation request was last updated.
Type: String
Valid Values: `creationStartTime | lastUpdatedTime`
Required: Yes
** order **
The order by which to sort the generation request information.
Type: String
Valid Values: `Ascending | Descending`
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/GenerationSortBy)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/GenerationSortBy)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/GenerationSortBy)
# GenerationSummary
Contains information about a generation request made for the bot locale.
## Contents
** creationDateTime **
The date and time at which the generation request was made.
Type: Timestamp
Required: No
** generationId **
The unique identifier of the generation request.
Type: String
Length Constraints: Fixed length of 10.
Pattern: `^[0-9a-zA-Z]+$`
Required: No
** generationStatus **
The status of the generation request.
Type: String
Valid Values: `Failed | Complete | InProgress`
Required: No
** lastUpdatedDateTime **
The date and time at which the generation request was last updated.
Type: Timestamp
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/GenerationSummary)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/GenerationSummary)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/GenerationSummary)
# GenerativeAISettings
Contains specifications about the generative AI capabilities from Amazon Bedrock that you can turn on for your bot.
## Contents
** buildtimeSettings **
Contains specifications about the Amazon Lex build time generative AI capabilities from Amazon Bedrock that you can turn on for your bot.
Type: [BuildtimeSettings](API_BuildtimeSettings.md) object
Required: No
** runtimeSettings **
Contains specifications about the Amazon Lex runtime generative AI capabilities from Amazon Bedrock that you can turn on for your bot.
Type: [RuntimeSettings](API_RuntimeSettings.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/GenerativeAISettings)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/GenerativeAISettings)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/GenerativeAISettings)
# GrammarSlotTypeSetting
Settings requried for a slot type based on a grammar that you provide.
## Contents
** source **
The source of the grammar used to create the slot type.
Type: [GrammarSlotTypeSource](API_GrammarSlotTypeSource.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/GrammarSlotTypeSetting)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/GrammarSlotTypeSetting)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/GrammarSlotTypeSetting)
# GrammarSlotTypeSource
Describes the Amazon S3 bucket name and location for the grammar that is the source for the slot type.
## Contents
** s3BucketName **
The name of the Amazon S3 bucket that contains the grammar source.
Type: String
Length Constraints: Minimum length of 3. Maximum length of 63.
Pattern: `^[a-z0-9][\.\-a-z0-9]{1,61}[a-z0-9]$`
Required: Yes
** s3ObjectKey **
The path to the grammar in the Amazon S3 bucket.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Pattern: `[\.\-\!\*\_\'\(\)a-zA-Z0-9][\.\-\!\*\_\'\(\)\/a-zA-Z0-9]*$`
Required: Yes
** kmsKeyArn **
The AWS KMS key required to decrypt the contents of the grammar, if any.
Type: String
Length Constraints: Minimum length of 20. Maximum length of 2048.
Pattern: `^arn:[\w\-]+:kms:[\w\-]+:[\d]{12}:(?:key\/[\w\-]+|alias\/[a-zA-Z0-9:\/_\-]{1,256})$`
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/GrammarSlotTypeSource)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/GrammarSlotTypeSource)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/GrammarSlotTypeSource)
# ImageResponseCard
A card that is shown to the user by a messaging platform. You define the contents of the card, the card is displayed by the platform.
When you use a response card, the response from the user is constrained to the text associated with a button on the card.
## Contents
** title **
The title to display on the response card. The format of the title is determined by the platform displaying the response card.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 250.
Required: Yes
** buttons **
A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.
Type: Array of [Button](API_Button.md) objects
Array Members: Minimum number of 0 items. Maximum number of 5 items.
Required: No
** imageUrl **
The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 250.
Required: No
** subtitle **
The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 250.
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/ImageResponseCard)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/ImageResponseCard)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/ImageResponseCard)
# ImportFilter
Filters the response from the [ListImports](https://docs.aws.amazon.com/lexv2/latest/APIReference/API_ListImports.html) operation.
## Contents
** name **
The name of the field to use for filtering.
Type: String
Valid Values: `ImportResourceType`
Required: Yes
** operator **
The operator to use for the filter. Specify EQ when the `ListImports` operation should return only resource types that equal the specified value. Specify CO when the `ListImports` operation should return resource types that contain the specified value.
Type: String
Valid Values: `CO | EQ`
Required: Yes
** values **
The values to use to filter the response. The values must be `Bot`, `BotLocale`, or `CustomVocabulary`.
Type: Array of strings
Array Members: Fixed number of 1 item.
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern: `^[0-9a-zA-Z_()\s-]+$`
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/ImportFilter)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/ImportFilter)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/ImportFilter)
# ImportResourceSpecification
Provides information about the bot or bot locale that you want to import. You can specify the `botImportSpecification` or the `botLocaleImportSpecification`, but not both.
## Contents
** botImportSpecification **
Parameters for importing a bot.
Type: [BotImportSpecification](API_BotImportSpecification.md) object
Required: No
** botLocaleImportSpecification **
Parameters for importing a bot locale.
Type: [BotLocaleImportSpecification](API_BotLocaleImportSpecification.md) object
Required: No
** customVocabularyImportSpecification **
Provides the parameters required for importing a custom vocabulary.
Type: [CustomVocabularyImportSpecification](API_CustomVocabularyImportSpecification.md) object
Required: No
** testSetImportResourceSpecification **
Specifications for the test set that is imported.
Type: [TestSetImportResourceSpecification](API_TestSetImportResourceSpecification.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/ImportResourceSpecification)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/ImportResourceSpecification)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/ImportResourceSpecification)
# ImportSortBy
Provides information for sorting a list of imports.
## Contents
** attribute **
The export field to use for sorting.
Type: String
Valid Values: `LastUpdatedDateTime`
Required: Yes
** order **
The order to sort the list.
Type: String
Valid Values: `Ascending | Descending`
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/ImportSortBy)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/ImportSortBy)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/ImportSortBy)
# ImportSummary
Provides summary information about an import in an import list.
## Contents
** creationDateTime **
The date and time that the import was created.
Type: Timestamp
Required: No
** importedResourceId **
The unique identifier that Amazon Lex assigned to the imported resource.
Type: String
Length Constraints: Minimum length of 5. Maximum length of 10.
Pattern: `^([0-9a-zA-Z_])+$`
Required: No
** importedResourceName **
The name that you gave the imported resource.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern: `^([0-9a-zA-Z][_-]?){1,100}$`
Required: No
** importedResourceType **
The type of resource that was imported.
Type: String
Valid Values: `Bot | BotLocale | CustomVocabulary | TestSet`
Required: No
** importId **
The unique identifier that Amazon Lex assigned to the import.
Type: String
Length Constraints: Fixed length of 10.
Pattern: `^[0-9a-zA-Z]+$`
Required: No
** importStatus **
The status of the resource. When the status is `Completed` the resource is ready to build.
Type: String
Valid Values: `InProgress | Completed | Failed | Deleting`
Required: No
** lastUpdatedDateTime **
The date and time that the import was last updated.
Type: Timestamp
Required: No
** mergeStrategy **
The strategy used to merge existing bot or bot locale definitions with the imported definition.
Type: String
Valid Values: `Overwrite | FailOnConflict | Append`
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/ImportSummary)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/ImportSummary)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/ImportSummary)
# InitialResponseSetting
Configuration setting for a response sent to the user before Amazon Lex starts eliciting slots.
## Contents
** codeHook **
Settings that specify the dialog code hook that is called by Amazon Lex at a step of the conversation.
Type: [DialogCodeHookInvocationSetting](API_DialogCodeHookInvocationSetting.md) object
Required: No
** conditional **
Provides a list of conditional branches. Branches are evaluated in the order that they are entered in the list. The first branch with a condition that evaluates to true is executed. The last branch in the list is the default branch. The default branch should not have any condition expression. The default branch is executed if no other branch has a matching condition.
Type: [ConditionalSpecification](API_ConditionalSpecification.md) object
Required: No
** initialResponse **
Specifies a list of message groups that Amazon Lex uses to respond the user input.
Type: [ResponseSpecification](API_ResponseSpecification.md) object
Required: No
** nextStep **
The next step in the conversation.
Type: [DialogState](API_DialogState.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/InitialResponseSetting)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/InitialResponseSetting)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/InitialResponseSetting)
# InputContext
A context that must be active for an intent to be selected by Amazon Lex.
## Contents
** name **
The name of the context.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern: `^([0-9a-zA-Z][_-]?){1,100}$`
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/InputContext)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/InputContext)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/InputContext)
# InputSessionStateSpecification
Specifications for the current state of the dialog between the user and the bot in the test set.
## Contents
** activeContexts **
Active contexts for the session state.
Type: Array of [ActiveContext](API_ActiveContext.md) objects
Array Members: Minimum number of 0 items. Maximum number of 20 items.
Required: No
** runtimeHints **
Runtime hints for the session state.
Type: [RuntimeHints](API_RuntimeHints.md) object
Required: No
** sessionAttributes **
Session attributes for the session state.
Type: String to string map
Key Length Constraints: Minimum length of 1.
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/InputSessionStateSpecification)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/InputSessionStateSpecification)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/InputSessionStateSpecification)
# IntentClassificationTestResultItem
Information for an intent that is classified by the test workbench.
## Contents
** intentName **
The name of the intent.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern: `^([0-9a-zA-Z][_-]?){1,100}$`
Required: Yes
** multiTurnConversation **
Indicates whether the conversation involves multiple turns or not.
Type: Boolean
Required: Yes
** resultCounts **
The result of the intent classification test.
Type: [IntentClassificationTestResultItemCounts](API_IntentClassificationTestResultItemCounts.md) object
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/IntentClassificationTestResultItem)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/IntentClassificationTestResultItem)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/IntentClassificationTestResultItem)
# IntentClassificationTestResultItemCounts
The number of items in the intent classification test.
## Contents
** intentMatchResultCounts **
The number of matched and mismatched results for intent recognition for the intent.
Type: String to integer map
Valid Keys: `Matched | Mismatched | ExecutionError`
Required: Yes
** totalResultCount **
The total number of results in the intent classification test.
Type: Integer
Required: Yes
** speechTranscriptionResultCounts **
The number of matched, mismatched, and execution error results for speech transcription for the intent.
Type: String to integer map
Valid Keys: `Matched | Mismatched | ExecutionError`
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/IntentClassificationTestResultItemCounts)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/IntentClassificationTestResultItemCounts)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/IntentClassificationTestResultItemCounts)
# IntentClassificationTestResults
Information for the results of the intent classification test.
## Contents
** items **
A list of the results for the intent classification test.
Type: Array of [IntentClassificationTestResultItem](API_IntentClassificationTestResultItem.md) objects
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/IntentClassificationTestResults)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/IntentClassificationTestResults)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/IntentClassificationTestResults)
# IntentClosingSetting
Provides a statement the Amazon Lex conveys to the user when the intent is successfully fulfilled.
## Contents
** active **
Specifies whether an intent's closing response is used. When this field is false, the closing response isn't sent to the user. If the `active` field isn't specified, the default is true.
Type: Boolean
Required: No
** closingResponse **
The response that Amazon Lex sends to the user when the intent is complete.
Type: [ResponseSpecification](API_ResponseSpecification.md) object
Required: No
** conditional **
A list of conditional branches associated with the intent's closing response. These branches are executed when the `nextStep` attribute is set to `EvalutateConditional`.
Type: [ConditionalSpecification](API_ConditionalSpecification.md) object
Required: No
** nextStep **
Specifies the next step that the bot executes after playing the intent's closing response.
Type: [DialogState](API_DialogState.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/IntentClosingSetting)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/IntentClosingSetting)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/IntentClosingSetting)
# IntentConfirmationSetting
Provides a prompt for making sure that the user is ready for the intent to be fulfilled.
## Contents
** promptSpecification **
Prompts the user to confirm the intent. This question should have a yes or no answer.
Amazon Lex uses this prompt to ensure that the user acknowledges that the intent is ready for fulfillment. For example, with the `OrderPizza` intent, you might want to confirm that the order is correct before placing it. For other intents, such as intents that simply respond to user questions, you might not need to ask the user for confirmation before providing the information.
Type: [PromptSpecification](API_PromptSpecification.md) object
Required: Yes
** active **
Specifies whether the intent's confirmation is sent to the user. When this field is false, confirmation and declination responses aren't sent. If the `active` field isn't specified, the default is true.
Type: Boolean
Required: No
** codeHook **
The `DialogCodeHookInvocationSetting` object associated with intent's confirmation step. The dialog code hook is triggered based on these invocation settings when the confirmation next step or declination next step or failure next step is `InvokeDialogCodeHook`.
Type: [DialogCodeHookInvocationSetting](API_DialogCodeHookInvocationSetting.md) object
Required: No
** confirmationConditional **
A list of conditional branches to evaluate after the intent is closed.
Type: [ConditionalSpecification](API_ConditionalSpecification.md) object
Required: No
** confirmationNextStep **
Specifies the next step that the bot executes when the customer confirms the intent.
Type: [DialogState](API_DialogState.md) object
Required: No
** confirmationResponse **
Specifies a list of message groups that Amazon Lex uses to respond the user input.
Type: [ResponseSpecification](API_ResponseSpecification.md) object
Required: No
** declinationConditional **
A list of conditional branches to evaluate after the intent is declined.
Type: [ConditionalSpecification](API_ConditionalSpecification.md) object
Required: No
** declinationNextStep **
Specifies the next step that the bot executes when the customer declines the intent.
Type: [DialogState](API_DialogState.md) object
Required: No
** declinationResponse **
When the user answers "no" to the question defined in `promptSpecification`, Amazon Lex responds with this response to acknowledge that the intent was canceled.
Type: [ResponseSpecification](API_ResponseSpecification.md) object
Required: No
** elicitationCodeHook **
The `DialogCodeHookInvocationSetting` used when the code hook is invoked during confirmation prompt retries.
Type: [ElicitationCodeHookInvocationSetting](API_ElicitationCodeHookInvocationSetting.md) object
Required: No
** failureConditional **
Provides a list of conditional branches. Branches are evaluated in the order that they are entered in the list. The first branch with a condition that evaluates to true is executed. The last branch in the list is the default branch. The default branch should not have any condition expression. The default branch is executed if no other branch has a matching condition.
Type: [ConditionalSpecification](API_ConditionalSpecification.md) object
Required: No
** failureNextStep **
The next step to take in the conversation if the confirmation step fails.
Type: [DialogState](API_DialogState.md) object
Required: No
** failureResponse **
Specifies a list of message groups that Amazon Lex uses to respond the user input.
Type: [ResponseSpecification](API_ResponseSpecification.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/IntentConfirmationSetting)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/IntentConfirmationSetting)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/IntentConfirmationSetting)
# IntentDisambiguationSettings
Configures the Intent Disambiguation feature that helps resolve ambiguous user inputs when multiple intents could match. When enabled, the system presents clarifying questions to users, helping them specify their exact intent for improved conversation accuracy.
## Contents
** enabled **
Determines whether the Intent Disambiguation feature is enabled. When set to `true`, Amazon Lex will present disambiguation options to users when multiple intents could match their input, with the default being `false`.
Type: Boolean
Required: Yes
** customDisambiguationMessage **
Provides a custom message that will be displayed before presenting the disambiguation options to users. This message helps set the context for users and can be customized to match your bot's tone and brand. If not specified, a default message will be used.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1000.
Required: No
** maxDisambiguationIntents **
Specifies the maximum number of intent options (2-5) to present to users when disambiguation is needed. This setting determines how many intent options will be shown to users when the system detects ambiguous input. The default value is 3.
Type: Integer
Valid Range: Minimum value of 2. Maximum value of 5.
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/IntentDisambiguationSettings)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/IntentDisambiguationSettings)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/IntentDisambiguationSettings)
# IntentFilter
Filters the response from the `ListIntents` operation.
## Contents
** name **
The name of the field to use for the filter.
Type: String
Valid Values: `IntentName`
Required: Yes
** operator **
The operator to use for the filter. Specify `EQ` when the `ListIntents` operation should return only aliases that equal the specified value. Specify `CO` when the `ListIntents` operation should return aliases that contain the specified value.
Type: String
Valid Values: `CO | EQ`
Required: Yes
** values **
The value to use for the filter.
Type: Array of strings
Array Members: Fixed number of 1 item.
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern: `^[0-9a-zA-Z_()\s-]+$`
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/IntentFilter)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/IntentFilter)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/IntentFilter)
# IntentLevelSlotResolutionTestResultItem
Information about intent-level slot resolution in a test result.
## Contents
** intentName **
The name of the intent that was recognized.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern: `^([0-9a-zA-Z][_-]?){1,100}$`
Required: Yes
** multiTurnConversation **
Indicates whether the conversation involves multiple turns or not.
Type: Boolean
Required: Yes
** slotResolutionResults **
The results for the slot resolution in the test execution result.
Type: Array of [SlotResolutionTestResultItem](API_SlotResolutionTestResultItem.md) objects
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/IntentLevelSlotResolutionTestResultItem)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/IntentLevelSlotResolutionTestResultItem)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/IntentLevelSlotResolutionTestResultItem)
# IntentLevelSlotResolutionTestResults
Indicates the success or failure of slots at the intent level.
## Contents
** items **
Indicates the items for the slot level resolution for the intents.
Type: Array of [IntentLevelSlotResolutionTestResultItem](API_IntentLevelSlotResolutionTestResultItem.md) objects
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/IntentLevelSlotResolutionTestResults)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/IntentLevelSlotResolutionTestResults)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/IntentLevelSlotResolutionTestResults)
# IntentOverride
Override settings to configure the intent state.
## Contents
** name **
The name of the intent. Only required when you're switching intents.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern: `^([0-9a-zA-Z][_-]?){1,100}$`
Required: No
** slots **
A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
Type: String to [SlotValueOverride](API_SlotValueOverride.md) object map
Key Length Constraints: Minimum length of 1. Maximum length of 100.
Key Pattern: `^([0-9a-zA-Z][_-]?){1,100}$`
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/IntentOverride)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/IntentOverride)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/IntentOverride)
# IntentSortBy
Specifies attributes for sorting a list of intents.
## Contents
** attribute **
The attribute to use to sort the list of intents.
Type: String
Valid Values: `IntentName | LastUpdatedDateTime`
Required: Yes
** order **
The order to sort the list. You can choose ascending or descending.
Type: String
Valid Values: `Ascending | Descending`
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/IntentSortBy)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/IntentSortBy)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/IntentSortBy)
# IntentStatistics
The object that contains the statistical summary of recommended intents associated with the bot recommendation.
## Contents
** discoveredIntentCount **
The number of recommended intents associated with the bot recommendation.
Type: Integer
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/IntentStatistics)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/IntentStatistics)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/IntentStatistics)
# IntentSummary
Summary information about an intent returned by the `ListIntents` operation.
## Contents
** description **
The description of the intent.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 2000.
Required: No
** inputContexts **
The input contexts that must be active for this intent to be considered for recognition.
Type: Array of [InputContext](API_InputContext.md) objects
Array Members: Minimum number of 0 items. Maximum number of 5 items.
Required: No
** intentDisplayName **
The display name of the intent.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Required: No
** intentId **
The unique identifier assigned to the intent. Use this ID to get detailed information about the intent with the `DescribeIntent` operation.
Type: String
Length Constraints: Fixed length of 10.
Pattern: `^[0-9a-zA-Z]+$`
Required: No
** intentName **
The name of the intent.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern: `^([0-9a-zA-Z][_-]?){1,100}$`
Required: No
** lastUpdatedDateTime **
The timestamp of the date and time that the intent was last updated.
Type: Timestamp
Required: No
** outputContexts **
The output contexts that are activated when this 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 **
If this intent is derived from a built-in intent, the name of the parent intent.
Type: String
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/IntentSummary)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/IntentSummary)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/IntentSummary)
# InvokedIntentSample
An object containing the name of an intent that was invoked.
## Contents
** intentName **
The name of an intent that was invoked.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern: `^([0-9a-zA-Z][_-]?){1,100}$`
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/InvokedIntentSample)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/InvokedIntentSample)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/InvokedIntentSample)
# IssueLocation
Specifies the location of an identified issue within the bot configuration.
## Contents
** botLocale **
The locale identifier where the issue was found.
Type: String
Required: No
** intentId **
The intent identifier where the issue was found, if applicable.
Type: String
Length Constraints: Fixed length of 10.
Pattern: `^[0-9a-zA-Z]+$`
Required: No
** slotId **
The slot identifier where the issue was found, if applicable.
Type: String
Length Constraints: Fixed length of 10.
Pattern: `^[0-9a-zA-Z]+$`
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/IssueLocation)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/IssueLocation)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/IssueLocation)
# KendraConfiguration
Provides configuration information for the `AMAZON.KendraSearchIntent` intent. When you use this intent, Amazon Lex searches the specified Amazon Kendra index and returns documents from the index that match the user's utterance.
## Contents
** kendraIndex **
The Amazon Resource Name (ARN) of the Amazon Kendra index that you want the `AMAZON.KendraSearchIntent` intent to search. The index must be in the same account and Region as the Amazon Lex bot.
Type: String
Length Constraints: Minimum length of 32. Maximum length of 2048.
Pattern: `^arn:aws:kendra:[a-z]+-[a-z]+-[0-9]:[0-9]{12}:index\/[a-zA-Z0-9][a-zA-Z0-9_-]*$`
Required: Yes
** queryFilterString **
A query filter that Amazon Lex sends to Amazon Kendra to filter the response from a query. The filter is in the format defined by Amazon Kendra. For more information, see [Filtering queries](https://docs.aws.amazon.com/kendra/latest/dg/filtering.html).
Type: String
Length Constraints: Minimum length of 1. Maximum length of 5000.
Required: No
** queryFilterStringEnabled **
Determines whether the `AMAZON.KendraSearchIntent` intent uses a custom query string to query the Amazon Kendra index.
Type: Boolean
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/KendraConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/KendraConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/KendraConfiguration)
# LambdaCodeHook
Specifies a Lambda function that verifies requests to a bot or fulfills the user's request to a bot.
## Contents
** codeHookInterfaceVersion **
The version of the request-response that you want Amazon Lex to use to invoke your Lambda function.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 5.
Required: Yes
** lambdaARN **
The Amazon Resource Name (ARN) of the Lambda function.
Type: String
Length Constraints: Minimum length of 20. Maximum length of 2048.
Pattern: `arn:aws:lambda:[a-z]+-[a-z]+-[0-9]:[0-9]{12}:function:[a-zA-Z0-9-_]+(/[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})?(:[a-zA-Z0-9-_]+)?`
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/LambdaCodeHook)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/LambdaCodeHook)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/LambdaCodeHook)
# LexTranscriptFilter
The object that contains transcript filter details that are associated with a bot recommendation.
## Contents
** dateRangeFilter **
The object that contains a date range filter that will be applied to the transcript. Specify this object if you want Amazon Lex to only read the files that are within the date range.
Type: [DateRangeFilter](API_DateRangeFilter.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/LexTranscriptFilter)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/LexTranscriptFilter)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/LexTranscriptFilter)
# Message
The object that provides message text and its type.
## Contents
** customPayload **
A message in a custom format defined by the client application.
Type: [CustomPayload](API_CustomPayload.md) object
Required: No
** imageResponseCard **
A message that defines a response card that the client application can show to the user.
Type: [ImageResponseCard](API_ImageResponseCard.md) object
Required: No
** plainTextMessage **
A message in plain text format.
Type: [PlainTextMessage](API_PlainTextMessage.md) object
Required: No
** ssmlMessage **
A message in Speech Synthesis Markup Language (SSML).
Type: [SSMLMessage](API_SSMLMessage.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/Message)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/Message)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/Message)
# MessageGroup
Provides one or more messages that Amazon Lex should send to the user.
## Contents
** message **
The primary message that Amazon Lex should send to the user.
Type: [Message](API_Message.md) object
Required: Yes
** variations **
Message variations to send to the user. When variations are defined, Amazon Lex chooses the primary message or one of the variations to send to the user.
Type: Array of [Message](API_Message.md) objects
Array Members: Minimum number of 0 items. Maximum number of 2 items.
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/MessageGroup)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/MessageGroup)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/MessageGroup)
# MultipleValuesSetting
Indicates whether a slot can return multiple values.
## Contents
** allowMultipleValues **
Indicates whether a slot can return multiple values. When `true`, the slot may return more than one value in a response. When `false`, the slot returns only a single value.
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 `allowMutlipleValues` is not set, the default value is `false`.
Type: Boolean
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/MultipleValuesSetting)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/MultipleValuesSetting)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/MultipleValuesSetting)
# NewCustomVocabularyItem
The new custom vocabulary item from the custom vocabulary list.
## Contents
** phrase **
The unique phrase for the new custom vocabulary item from the custom vocabulary list.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Required: Yes
** displayAs **
The display as value assigned to the new custom vocabulary item from the custom vocabulary list.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Required: No
** weight **
The weight assigned to the new custom vocabulary item from the custom vocabulary list.
Type: Integer
Valid Range: Minimum value of 0. Maximum value of 3.
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/NewCustomVocabularyItem)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/NewCustomVocabularyItem)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/NewCustomVocabularyItem)
# NluImprovementSpecification
Configures the Assisted Natural Language Understanding (NLU) feature for your bot. This specification determines whether enhanced intent recognition and utterance understanding capabilities are active.
## Contents
** enabled **
Determines whether the Assisted NLU feature is enabled for the bot. When set to `true`, Amazon Lex uses advanced models to improve intent recognition and slot resolution, with the default being `false`.
Type: Boolean
Required: Yes
** assistedNluMode **
Specifies the mode for Assisted NLU operation. Use `Primary` to make Assisted NLU the primary intent recognition method, or `Fallback` to use it only when standard NLU confidence is low.
Type: String
Valid Values: `Primary | Fallback`
Required: No
** intentDisambiguationSettings **
An object containing specifications for the Intent Disambiguation feature within the Assisted NLU settings. These settings determine how the bot handles ambiguous user inputs that could match multiple intents.
Type: [IntentDisambiguationSettings](API_IntentDisambiguationSettings.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/NluImprovementSpecification)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/NluImprovementSpecification)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/NluImprovementSpecification)
# ObfuscationSetting
Determines whether Amazon Lex obscures slot values in conversation logs.
## Contents
** obfuscationSettingType **
Value that determines whether Amazon Lex obscures slot values in conversation logs. The default is to obscure the values.
Type: String
Valid Values: `None | DefaultObfuscation`
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/ObfuscationSetting)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/ObfuscationSetting)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/ObfuscationSetting)
# OpensearchConfiguration
Contains details about the configuration of the Amazon OpenSearch Service database used for the `AMAZON.QnAIntent`.
## Contents
** domainEndpoint **
The endpoint of the Amazon OpenSearch Service domain.
Type: String
Pattern: `^(http|https):\/\/+[^\s]+[\w]`
Required: Yes
** indexName **
The name of the Amazon OpenSearch Service index.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern: `^(?![_-])[a-z0-9][a-z0-9_\-]{0,254}$`
Required: Yes
** exactResponse **
Specifies whether to return an exact response or to return an answer generated by the model using the fields you specify from the database.
Type: Boolean
Required: No
** exactResponseFields **
Contains the names of the fields used for an exact response to the user.
Type: [ExactResponseFields](API_ExactResponseFields.md) object
Required: No
** includeFields **
Contains a list of fields from the Amazon OpenSearch Service that the model can use to generate the answer to the query.
Type: Array of strings
Array Members: Minimum number of 1 item. Maximum number of 5 items.
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/OpensearchConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/OpensearchConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/OpensearchConfiguration)
# OutputContext
Describes a session context that is activated when an intent is fulfilled.
## Contents
** name **
The name of the output context.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern: `^([0-9a-zA-Z][_-]?){1,100}$`
Required: Yes
** timeToLiveInSeconds **
The amount of time, in seconds, that the output context should remain active. The time is figured from the first time the context is sent to the user.
Type: Integer
Valid Range: Minimum value of 5. Maximum value of 86400.
Required: Yes
** turnsToLive **
The number of conversation turns that the output context should remain active. The number of turns is counted from the first time that the context is sent to the user.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 20.
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/OutputContext)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/OutputContext)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/OutputContext)
# OverallTestResultItem
Information about the overall results for a test execution result.
## Contents
** endToEndResultCounts **
The number of results that succeeded.
Type: String to integer map
Valid Keys: `Matched | Mismatched | ExecutionError`
Required: Yes
** multiTurnConversation **
Indicates whether the conversation contains multiple turns or not.
Type: Boolean
Required: Yes
** totalResultCount **
The total number of overall results in the result of the test execution.
Type: Integer
Required: Yes
** speechTranscriptionResultCounts **
The number of speech transcription results in the overall test.
Type: String to integer map
Valid Keys: `Matched | Mismatched | ExecutionError`
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/OverallTestResultItem)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/OverallTestResultItem)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/OverallTestResultItem)
# OverallTestResults
Information about the overall test results.
## Contents
** items **
A list of the overall test results.
Type: Array of [OverallTestResultItem](API_OverallTestResultItem.md) objects
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/OverallTestResults)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/OverallTestResults)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/OverallTestResults)
# ParentBotNetwork
A network of bots.
## Contents
** botId **
The identifier of the network of bots assigned by Amazon Lex.
Type: String
Length Constraints: Fixed length of 10.
Pattern: `^[0-9a-zA-Z]+$`
Required: Yes
** botVersion **
The version of the network of bots.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 5.
Pattern: `^(DRAFT|[0-9]+)$`
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/ParentBotNetwork)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/ParentBotNetwork)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/ParentBotNetwork)
# PathFormat
The object that contains a path format that will be applied when Amazon Lex reads the transcript file in the bucket you provide. Specify this object if you only want Lex to read a subset of files in your Amazon S3 bucket.
## Contents
** objectPrefixes **
A list of Amazon S3 prefixes that points to sub-folders in the Amazon S3 bucket. Specify this list if you only want Lex to read the files under this set of sub-folders.
Type: Array of strings
Array Members: Minimum number of 1 item. Maximum number of 2 items.
Length Constraints: Minimum length of 1.
Pattern: `^[\/]?+[a-zA-Z0-9!_.*'()-]+(\/[a-zA-Z0-9!_.*'()-]+)*$`
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/PathFormat)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/PathFormat)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/PathFormat)
# PlainTextMessage
Defines an ASCII text message to send to the user.
## Contents
** value **
The message to send to the user.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1000.
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/PlainTextMessage)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/PlainTextMessage)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/PlainTextMessage)
# PostDialogCodeHookInvocationSpecification
Specifies next steps to run after the dialog code hook finishes.
## Contents
** failureConditional **
A list of conditional branches to evaluate after the dialog code hook throws an exception or returns with the `State` field of the `Intent` object set to `Failed`.
Type: [ConditionalSpecification](API_ConditionalSpecification.md) object
Required: No
** failureNextStep **
Specifies the next step the bot runs after the dialog code hook throws an exception or returns with the `State` field of the `Intent` object set to `Failed`.
Type: [DialogState](API_DialogState.md) object
Required: No
** failureResponse **
Specifies a list of message groups that Amazon Lex uses to respond the user input.
Type: [ResponseSpecification](API_ResponseSpecification.md) object
Required: No
** successConditional **
A list of conditional branches to evaluate after the dialog code hook finishes successfully.
Type: [ConditionalSpecification](API_ConditionalSpecification.md) object
Required: No
** successNextStep **
Specifics the next step the bot runs after the dialog code hook finishes successfully.
Type: [DialogState](API_DialogState.md) object
Required: No
** successResponse **
Specifies a list of message groups that Amazon Lex uses to respond the user input.
Type: [ResponseSpecification](API_ResponseSpecification.md) object
Required: No
** timeoutConditional **
A list of conditional branches to evaluate if the code hook times out.
Type: [ConditionalSpecification](API_ConditionalSpecification.md) object
Required: No
** timeoutNextStep **
Specifies the next step that the bot runs when the code hook times out.
Type: [DialogState](API_DialogState.md) object
Required: No
** timeoutResponse **
Specifies a list of message groups that Amazon Lex uses to respond the user input.
Type: [ResponseSpecification](API_ResponseSpecification.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/PostDialogCodeHookInvocationSpecification)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/PostDialogCodeHookInvocationSpecification)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/PostDialogCodeHookInvocationSpecification)
# PostFulfillmentStatusSpecification
Provides a setting that determines whether the post-fulfillment response is sent to the user. For more information, see [https://docs.aws.amazon.com/lexv2/latest/dg/streaming-progress.html#progress-complete](https://docs.aws.amazon.com/lexv2/latest/dg/streaming-progress.html#progress-complete)
## Contents
** failureConditional **
A list of conditional branches to evaluate after the fulfillment code hook throws an exception or returns with the `State` field of the `Intent` object set to `Failed`.
Type: [ConditionalSpecification](API_ConditionalSpecification.md) object
Required: No
** failureNextStep **
Specifies the next step the bot runs after the fulfillment code hook throws an exception or returns with the `State` field of the `Intent` object set to `Failed`.
Type: [DialogState](API_DialogState.md) object
Required: No
** failureResponse **
Specifies a list of message groups that Amazon Lex uses to respond the user input.
Type: [ResponseSpecification](API_ResponseSpecification.md) object
Required: No
** successConditional **
A list of conditional branches to evaluate after the fulfillment code hook finishes successfully.
Type: [ConditionalSpecification](API_ConditionalSpecification.md) object
Required: No
** successNextStep **
Specifies the next step in the conversation that Amazon Lex invokes when the fulfillment code hook completes successfully.
Type: [DialogState](API_DialogState.md) object
Required: No
** successResponse **
Specifies a list of message groups that Amazon Lex uses to respond the user input.
Type: [ResponseSpecification](API_ResponseSpecification.md) object
Required: No
** timeoutConditional **
A list of conditional branches to evaluate if the fulfillment code hook times out.
Type: [ConditionalSpecification](API_ConditionalSpecification.md) object
Required: No
** timeoutNextStep **
Specifies the next step that the bot runs when the fulfillment code hook times out.
Type: [DialogState](API_DialogState.md) object
Required: No
** timeoutResponse **
Specifies a list of message groups that Amazon Lex uses to respond the user input.
Type: [ResponseSpecification](API_ResponseSpecification.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/PostFulfillmentStatusSpecification)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/PostFulfillmentStatusSpecification)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/PostFulfillmentStatusSpecification)
# Principal
The IAM principal that you allowing or denying access to an Amazon Lex action. You must provide a `service` or an `arn`, but not both in the same statement. For more information, see [ AWS JSON policy elements: Principal ](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements_principal.html).
## Contents
** arn **
The Amazon Resource Name (ARN) of the principal.
Type: String
Length Constraints: Minimum length of 30. Maximum length of 1024.
Pattern: `^arn:aws:iam::[0-9]{12}:(root|(user|role)/.*)$`
Required: No
** service **
The name of the AWS service that should allowed or denied access to an Amazon Lex action.
Type: String
Length Constraints: Minimum length of 15. Maximum length of 1024.
Pattern: `^[0-9a-zA-Z_.]+$`
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/Principal)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/Principal)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/Principal)
# PromptAttemptSpecification
Specifies the settings on a prompt attempt.
## Contents
** allowedInputTypes **
Indicates the allowed input types of the prompt attempt.
Type: [AllowedInputTypes](API_AllowedInputTypes.md) object
Required: Yes
** allowInterrupt **
Indicates whether the user can interrupt a speech prompt attempt from the bot.
Type: Boolean
Required: No
** audioAndDTMFInputSpecification **
Specifies the settings on audio and DTMF input.
Type: [AudioAndDTMFInputSpecification](API_AudioAndDTMFInputSpecification.md) object
Required: No
** textInputSpecification **
Specifies the settings on text input.
Type: [TextInputSpecification](API_TextInputSpecification.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/PromptAttemptSpecification)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/PromptAttemptSpecification)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/PromptAttemptSpecification)
# PromptSpecification
Specifies a list of message groups that Amazon Lex sends to a user to elicit a response.
## Contents
** maxRetries **
The maximum number of times the bot tries to elicit a response from the user using this prompt.
Type: Integer
Valid Range: Minimum value of 0. Maximum value of 5.
Required: Yes
** messageGroups **
A collection of messages that Amazon Lex can send to the user. Amazon Lex chooses the actual message to send at runtime.
Type: Array of [MessageGroup](API_MessageGroup.md) objects
Array Members: Minimum number of 1 item. Maximum number of 5 items.
Required: Yes
** allowInterrupt **
Indicates whether the user can interrupt a speech prompt from the bot.
Type: Boolean
Required: No
** messageSelectionStrategy **
Indicates how a message is selected from a message group among retries.
Type: String
Valid Values: `Random | Ordered`
Required: No
** promptAttemptsSpecification **
Specifies the advanced settings on each attempt of the prompt.
Type: String to [PromptAttemptSpecification](API_PromptAttemptSpecification.md) object map
Valid Keys: `Initial | Retry1 | Retry2 | Retry3 | Retry4 | Retry5`
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/PromptSpecification)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/PromptSpecification)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/PromptSpecification)
# QInConnectAssistantConfiguration
The configuration details of the Qinconnect assistant.
## Contents
** assistantArn **
The assistant Arn details of the Qinconnect assistant configuration.
Type: String
Pattern: `^arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}$`
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/QInConnectAssistantConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/QInConnectAssistantConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/QInConnectAssistantConfiguration)
# QInConnectIntentConfiguration
The configuration details of the Qinconnect intent.
## Contents
** qInConnectAssistantConfiguration **
The Qinconnect assistant configuration details of the Qinconnect intent.
Type: [QInConnectAssistantConfiguration](API_QInConnectAssistantConfiguration.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/QInConnectIntentConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/QInConnectIntentConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/QInConnectIntentConfiguration)
# QnAIntentConfiguration
Details about the the configuration of the built-in `Amazon.QnAIntent`.
## Contents
** bedrockModelConfiguration **
Contains information about the Amazon Bedrock model used to interpret the prompt used in descriptive bot building.
Type: [BedrockModelSpecification](API_BedrockModelSpecification.md) object
Required: No
** dataSourceConfiguration **
Contains details about the configuration of the data source used for the `AMAZON.QnAIntent`.
Type: [DataSourceConfiguration](API_DataSourceConfiguration.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/QnAIntentConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/QnAIntentConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/QnAIntentConfiguration)
# QnAKendraConfiguration
Contains details about the configuration of the Amazon Kendra index used for the `AMAZON.QnAIntent`.
## Contents
** kendraIndex **
The ARN of the Amazon Kendra index to use.
Type: String
Length Constraints: Minimum length of 32. Maximum length of 2048.
Pattern: `^arn:aws:kendra:[a-z]+-[a-z]+-[0-9]:[0-9]{12}:index\/[a-zA-Z0-9][a-zA-Z0-9_-]*$`
Required: Yes
** exactResponse **
Specifies whether to return an exact response from the Amazon Kendra index or to let the Amazon Bedrock model you select generate a response based on the results. To use this feature, you must first add FAQ questions to your index by following the steps at [Adding frequently asked questions (FAQs) to an index](https://docs.aws.amazon.com/kendra/latest/dg/in-creating-faq.html).
Type: Boolean
Required: No
** queryFilterString **
Contains the Amazon Kendra filter string to use if enabled. For more information on the Amazon Kendra search filter JSON format, see [Using document attributes to filter search results](https://docs.aws.amazon.com/kendra/latest/dg/filtering.html#search-filtering).
Type: String
Length Constraints: Minimum length of 1. Maximum length of 5000.
Required: No
** queryFilterStringEnabled **
Specifies whether to enable an Amazon Kendra filter string or not.
Type: Boolean
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/QnAKendraConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/QnAKendraConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/QnAKendraConfiguration)
# RecommendedIntentSummary
An object that contains a summary of a recommended intent.
## Contents
** intentId **
The unique identifier of a recommended intent associated with the bot recommendation.
Type: String
Length Constraints: Fixed length of 10.
Pattern: `^[0-9a-zA-Z]+$`
Required: No
** intentName **
The name of a recommended intent associated with the bot recommendation.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern: `^([0-9a-zA-Z][_-]?){1,100}$`
Required: No
** sampleUtterancesCount **
The count of sample utterances of a recommended intent that is associated with a bot recommendation.
Type: Integer
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/RecommendedIntentSummary)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/RecommendedIntentSummary)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/RecommendedIntentSummary)
# RelativeAggregationDuration
Specifies the time window that utterance statistics are returned for. The time window is always relative to the last time that the that utterances were aggregated. For example, if the `ListAggregatedUtterances` operation is called at 1600, the time window is set to 1 hour, and the last refresh time was 1530, only utterances made between 1430 and 1530 are returned.
You can choose the time window that statistics should be returned for.
+ **Hours** - You can request utterance statistics for 1, 3, 6, 12, or 24 hour time windows. Statistics are refreshed every half hour for 1 hour time windows, and hourly for the other time windows.
+ **Days** - You can request utterance statistics for 3 days. Statistics are refreshed every 6 hours.
+ **Weeks** - You can see statistics for one or two weeks. Statistics are refreshed every 12 hours for one week time windows, and once per day for two week time windows.
## Contents
** timeDimension **
The type of time period that the `timeValue` field represents.
Type: String
Valid Values: `Hours | Days | Weeks`
Required: Yes
** timeValue **
The period of the time window to gather statistics for. The valid value depends on the setting of the `timeDimension` field.
+ `Hours` - 1/3/6/12/24
+ `Days` - 3
+ `Weeks` - 1/2
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 24.
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/RelativeAggregationDuration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/RelativeAggregationDuration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/RelativeAggregationDuration)
# ResponseSpecification
Specifies a list of message groups that Amazon Lex uses to respond the user input.
## Contents
** messageGroups **
A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
Type: Array of [MessageGroup](API_MessageGroup.md) objects
Array Members: Minimum number of 1 item. Maximum number of 5 items.
Required: Yes
** allowInterrupt **
Indicates whether the user can interrupt a speech response from Amazon Lex.
Type: Boolean
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/ResponseSpecification)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/ResponseSpecification)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/ResponseSpecification)
# RuntimeHintDetails
Provides an array of phrases that should be given preference when resolving values for a slot.
## Contents
** runtimeHintValues **
One or more strings that Amazon Lex should look for in the input to the bot. Each phrase is given preference when deciding on slot values.
Type: Array of [RuntimeHintValue](API_RuntimeHintValue.md) objects
Array Members: Minimum number of 1 item. Maximum number of 100 items.
Required: No
** subSlotHints **
A map of constituent sub slot names inside a composite slot in the intent and the phrases that should be added for each sub slot. Inside each composite slot hints, this structure provides a mechanism to add granular sub slot phrases. Only sub slot hints are supported for composite slots. The intent name, composite slot name and the constituent sub slot names must exist.
Type: String to [RuntimeHintDetails](#API_RuntimeHintDetails) object map
Key Length Constraints: Minimum length of 1. Maximum length of 100.
Key Pattern: `^([0-9a-zA-Z][_-]?){1,100}$`
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/RuntimeHintDetails)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/RuntimeHintDetails)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/RuntimeHintDetails)
# RuntimeHints
You can provide Amazon Lex with hints to the phrases that a customer is likely to use for a slot. When a slot with hints is resolved, the phrases in the runtime hints are preferred in the resolution. You can provide hints for a maximum of 100 intents. You can provide a maximum of 100 slots.
Before you can use runtime hints with an existing bot, you must first rebuild the bot.
For more information, see [Using runtime hints to improve recognition of slot values](https://docs.aws.amazon.com/lexv2/latest/dg/using-hints.html).
## Contents
** slotHints **
A list of the slots in the intent that should have runtime hints added, and the phrases that should be added for each slot.
The first level of the `slotHints` map is the name of the intent. The second level is the name of the slot within the intent. For more information, see [Using hints to improve accuracy](https://docs.aws.amazon.com/lexv2/latest/dg/using-hints.html).
The intent name and slot name must exist.
Type: String to string to [RuntimeHintDetails](API_RuntimeHintDetails.md) object map map
Key Length Constraints: Minimum length of 1. Maximum length of 100.
Key Pattern: `^([0-9a-zA-Z][_-]?){1,100}$`
Key Length Constraints: Minimum length of 1. Maximum length of 100.
Key Pattern: `^([0-9a-zA-Z][_-]?){1,100}$`
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/RuntimeHints)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/RuntimeHints)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/RuntimeHints)
# RuntimeHintValue
Provides the phrase that Amazon Lex should look for in the user's input to the bot.
## Contents
** phrase **
The phrase that Amazon Lex should look for in the user's input to the bot.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 140.
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/RuntimeHintValue)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/RuntimeHintValue)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/RuntimeHintValue)
# RuntimeSettings
Contains specifications about the Amazon Lex runtime generative AI capabilities from Amazon Bedrock that you can turn on for your bot.
## Contents
** nluImprovement **
An object containing specifications for the Assisted NLU feature within the bot's runtime settings. These settings determine how the bot processes and interprets user utterances during conversations.
Type: [NluImprovementSpecification](API_NluImprovementSpecification.md) object
Required: No
** slotResolutionImprovement **
An object containing specifications for the assisted slot resolution feature.
Type: [SlotResolutionImprovementSpecification](API_SlotResolutionImprovementSpecification.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/RuntimeSettings)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/RuntimeSettings)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/RuntimeSettings)
# S3BucketLogDestination
Specifies an Amazon S3 bucket for logging audio conversations
## Contents
** logPrefix **
The S3 prefix to assign to audio log files.
Type: String
Length Constraints: Maximum length of 1024.
Required: Yes
** s3BucketArn **
The Amazon Resource Name (ARN) of an Amazon S3 bucket where audio log files are stored.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: `^arn:[\w\-]+:s3:::[a-z0-9][\.\-a-z0-9]{1,61}[a-z0-9]$`
Required: Yes
** kmsKeyArn **
The Amazon Resource Name (ARN) of an AWS Key Management Service (KMS) key for encrypting audio log files stored in an S3 bucket.
Type: String
Length Constraints: Minimum length of 20. Maximum length of 2048.
Pattern: `^arn:[\w\-]+:kms:[\w\-]+:[\d]{12}:(?:key\/[\w\-]+|alias\/[a-zA-Z0-9:\/_\-]{1,256})$`
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/S3BucketLogDestination)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/S3BucketLogDestination)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/S3BucketLogDestination)
# S3BucketTranscriptSource
The object representing the Amazon S3 bucket containing the transcript, as well as the associated metadata.
## Contents
** s3BucketName **
The name of the bucket containing the transcript and the associated metadata.
Type: String
Length Constraints: Minimum length of 3. Maximum length of 63.
Pattern: `^[a-z0-9][\.\-a-z0-9]{1,61}[a-z0-9]$`
Required: Yes
** transcriptFormat **
The format of the transcript content. Currently, Genie only supports the Amazon Lex transcript format.
Type: String
Valid Values: `Lex`
Required: Yes
** kmsKeyArn **
The ARN of the KMS key that customer use to encrypt their Amazon S3 bucket. Only use this field if your bucket is encrypted using a customer managed KMS key.
Type: String
Length Constraints: Minimum length of 20. Maximum length of 2048.
Pattern: `^arn:[\w\-]+:kms:[\w\-]+:[\d]{12}:(?:key\/[\w\-]+|alias\/[a-zA-Z0-9:\/_\-]{1,256})$`
Required: No
** pathFormat **
The object that contains a path format that will be applied when Amazon Lex reads the transcript file in the bucket you provide. Specify this object if you only want Lex to read a subset of files in your Amazon S3 bucket.
Type: [PathFormat](API_PathFormat.md) object
Required: No
** transcriptFilter **
The object that contains the filter which will be applied when Amazon Lex reads through the Amazon S3 bucket. Specify this object if you want Amazon Lex to read only a subset of the Amazon S3 bucket based on the filter you provide.
Type: [TranscriptFilter](API_TranscriptFilter.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/S3BucketTranscriptSource)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/S3BucketTranscriptSource)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/S3BucketTranscriptSource)
# SampleUtterance
A sample utterance that invokes an intent or respond to a slot elicitation prompt.
## Contents
** utterance **
The sample utterance that Amazon Lex uses to build its machine-learning model to recognize intents.
Type: String
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/SampleUtterance)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/SampleUtterance)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/SampleUtterance)
# SampleUtteranceGenerationSpecification
Contains specifications for the sample utterance generation feature.
## Contents
** enabled **
Specifies whether to enable sample utterance generation or not.
Type: Boolean
Required: Yes
** bedrockModelSpecification **
Contains information about the Amazon Bedrock model used to interpret the prompt used in descriptive bot building.
Type: [BedrockModelSpecification](API_BedrockModelSpecification.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/SampleUtteranceGenerationSpecification)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/SampleUtteranceGenerationSpecification)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/SampleUtteranceGenerationSpecification)
# SampleValue
Defines one of the values for a slot type.
## Contents
** value **
The value that can be used for a slot type.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 140.
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/SampleValue)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/SampleValue)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/SampleValue)
# SentimentAnalysisSettings
Determines whether Amazon Lex will use Amazon Comprehend to detect the sentiment of user utterances.
## Contents
** detectSentiment **
Sets whether Amazon Lex uses Amazon Comprehend to detect the sentiment of user utterances.
Type: Boolean
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/SentimentAnalysisSettings)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/SentimentAnalysisSettings)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/SentimentAnalysisSettings)
# SessionDataSortBy
An object specifying the measure and method by which to sort the session analytics data.
## Contents
** name **
The measure by which to sort the session analytics data.
+ `conversationStartTime` – The date and time when the conversation began. A conversation is defined as a unique combination of a `sessionId` and an `originatingRequestId`.
+ `numberOfTurns` – The number of turns that the session took.
+ `conversationDurationSeconds` – The duration of the conversation in seconds.
Type: String
Valid Values: `ConversationStartTime | NumberOfTurns | Duration`
Required: Yes
** order **
Specifies whether to sort the results in ascending or descending order.
Type: String
Valid Values: `Ascending | Descending`
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/SessionDataSortBy)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/SessionDataSortBy)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/SessionDataSortBy)
# SessionSpecification
An object containing information about a specific session.
## Contents
** botAliasId **
The identifier of the alias of the bot that the session was held with.
Type: String
Length Constraints: Fixed length of 10.
Pattern: `^(\bTSTALIASID\b|[0-9a-zA-Z]+)$`
Required: No
** botVersion **
The version of the bot that the session was held with.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 5.
Pattern: `^[0-9]+$`
Required: No
** channel **
The channel that is integrated with the bot that the session was held with.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 50.
Required: No
** conversationDurationSeconds **
The duration of the conversation in seconds. A conversation is defined as a unique combination of a `sessionId` and an `originatingRequestId`.
Type: Long
Required: No
** conversationEndState **
The final state of the conversation. A conversation is defined as a unique combination of a `sessionId` and an `originatingRequestId`.
Type: String
Valid Values: `Success | Failure | Dropped`
Required: No
** conversationEndTime **
The date and time when the conversation ended. A conversation is defined as a unique combination of a `sessionId` and an `originatingRequestId`.
Type: Timestamp
Required: No
** conversationStartTime **
The date and time when the conversation began. A conversation is defined as a unique combination of a `sessionId` and an `originatingRequestId`.
Type: Timestamp
Required: No
** invokedIntentSamples **
A list of objects containing the name of an intent that was invoked.
Type: Array of [InvokedIntentSample](API_InvokedIntentSample.md) objects
Required: No
** localeId **
The locale of the bot that the session was held with.
Type: String
Required: No
** mode **
The mode of the session. The possible values are as follows:
+ `Speech` – The session was spoken.
+ `Text` – The session was written.
+ `DTMF` – The session used a touch-tone keypad (Dual Tone Multi-Frequency).
+ `MultiMode` – The session used multiple modes.
Type: String
Valid Values: `Speech | Text | DTMF | MultiMode`
Required: No
** numberOfTurns **
The number of turns that the session took.
Type: Long
Required: No
** originatingRequestId **
The identifier of the first request in a session.
Type: String
Required: No
** sessionId **
The identifier of the session.
Type: String
Pattern: `[0-9a-zA-Z._:-]`
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/SessionSpecification)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/SessionSpecification)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/SessionSpecification)
# SlotCaptureSetting
Settings used when Amazon Lex successfully captures a slot value from a user.
## Contents
** captureConditional **
A list of conditional branches to evaluate after the slot value is captured.
Type: [ConditionalSpecification](API_ConditionalSpecification.md) object
Required: No
** captureNextStep **
Specifies the next step that the bot runs when the slot value is captured before the code hook times out.
Type: [DialogState](API_DialogState.md) object
Required: No
** captureResponse **
Specifies a list of message groups that Amazon Lex uses to respond the user input.
Type: [ResponseSpecification](API_ResponseSpecification.md) object
Required: No
** codeHook **
Code hook called after Amazon Lex successfully captures a slot value.
Type: [DialogCodeHookInvocationSetting](API_DialogCodeHookInvocationSetting.md) object
Required: No
** elicitationCodeHook **
Code hook called when Amazon Lex doesn't capture a slot value.
Type: [ElicitationCodeHookInvocationSetting](API_ElicitationCodeHookInvocationSetting.md) object
Required: No
** failureConditional **
A list of conditional branches to evaluate when the slot value isn't captured.
Type: [ConditionalSpecification](API_ConditionalSpecification.md) object
Required: No
** failureNextStep **
Specifies the next step that the bot runs when the slot value code is not recognized.
Type: [DialogState](API_DialogState.md) object
Required: No
** failureResponse **
Specifies a list of message groups that Amazon Lex uses to respond the user input.
Type: [ResponseSpecification](API_ResponseSpecification.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/SlotCaptureSetting)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/SlotCaptureSetting)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/SlotCaptureSetting)
# SlotDefaultValue
Specifies the default value to use when a user doesn't provide a value for a slot.
## Contents
** defaultValue **
The default value to use when a user doesn't provide a value for a slot.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 202.
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/SlotDefaultValue)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/SlotDefaultValue)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/SlotDefaultValue)
# SlotDefaultValueSpecification
Defines a list of values that Amazon Lex should use as the default value for a slot.
## Contents
** defaultValueList **
A list of default values. Amazon Lex chooses the default value to use in the order that they are presented in the list.
Type: Array of [SlotDefaultValue](API_SlotDefaultValue.md) objects
Array Members: Minimum number of 0 items. Maximum number of 10 items.
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/SlotDefaultValueSpecification)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/SlotDefaultValueSpecification)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/SlotDefaultValueSpecification)
# SlotFilter
Filters the response from the `ListSlots` operation.
## Contents
** name **
The name of the field to use for filtering.
Type: String
Valid Values: `SlotName`
Required: Yes
** operator **
The operator to use for the filter. Specify `EQ` when the `ListSlots` operation should return only aliases that equal the specified value. Specify `CO` when the `ListSlots` operation should return aliases that contain the specified value.
Type: String
Valid Values: `CO | EQ`
Required: Yes
** values **
The value to use to filter the response.
Type: Array of strings
Array Members: Fixed number of 1 item.
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern: `^[0-9a-zA-Z_()\s-]+$`
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/SlotFilter)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/SlotFilter)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/SlotFilter)
# SlotPriority
Sets the priority that Amazon Lex should use when eliciting slot values from a user.
## Contents
** priority **
The priority that Amazon Lex should apply to the slot.
Type: Integer
Valid Range: Minimum value of 0. Maximum value of 100.
Required: Yes
** slotId **
The unique identifier of the slot.
Type: String
Length Constraints: Fixed length of 10.
Pattern: `^[0-9a-zA-Z]+$`
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/SlotPriority)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/SlotPriority)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/SlotPriority)
# SlotResolutionImprovementSpecification
Contains specifications for the assisted slot resolution feature.
## Contents
** enabled **
Specifies whether assisted slot resolution is turned on or off.
Type: Boolean
Required: Yes
** bedrockModelSpecification **
An object containing information about the Amazon Bedrock model used to assist slot resolution.
Type: [BedrockModelSpecification](API_BedrockModelSpecification.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/SlotResolutionImprovementSpecification)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/SlotResolutionImprovementSpecification)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/SlotResolutionImprovementSpecification)
# SlotResolutionSetting
Contains information about whether assisted slot resolution is turned on for the slot or not.
## Contents
** slotResolutionStrategy **
Specifies whether assisted slot resolution is turned on for the slot or not. If the value is `EnhancedFallback`, assisted slot resolution is activated when Amazon Lex defaults to the `AMAZON.FallbackIntent`. If the value is `Default`, assisted slot resolution is turned off.
Type: String
Valid Values: `EnhancedFallback | Default`
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/SlotResolutionSetting)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/SlotResolutionSetting)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/SlotResolutionSetting)
# SlotResolutionTestResultItem
Information about the success and failure rate of slot resolution in the results of a test execution.
## Contents
** resultCounts **
A result for slot resolution in the results of a test execution.
Type: [SlotResolutionTestResultItemCounts](API_SlotResolutionTestResultItemCounts.md) object
Required: Yes
** slotName **
The name of the slot.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern: `^([0-9a-zA-Z][_.-]?)+$`
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/SlotResolutionTestResultItem)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/SlotResolutionTestResultItem)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/SlotResolutionTestResultItem)
# SlotResolutionTestResultItemCounts
Information about the counts for a slot resolution in the results of a test execution.
## Contents
** slotMatchResultCounts **
The number of matched and mismatched results for slot resolution for the slot.
Type: String to integer map
Valid Keys: `Matched | Mismatched | ExecutionError`
Required: Yes
** totalResultCount **
The total number of results.
Type: Integer
Required: Yes
** speechTranscriptionResultCounts **
The number of matched, mismatched and execution error results for speech transcription for the slot.
Type: String to integer map
Valid Keys: `Matched | Mismatched | ExecutionError`
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/SlotResolutionTestResultItemCounts)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/SlotResolutionTestResultItemCounts)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/SlotResolutionTestResultItemCounts)
# SlotSortBy
Specifies attributes for sorting a list of bots.
## Contents
** attribute **
The attribute to use to sort the list.
Type: String
Valid Values: `SlotName | LastUpdatedDateTime`
Required: Yes
** order **
The order to sort the list. You can choose ascending or descending.
Type: String
Valid Values: `Ascending | Descending`
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/SlotSortBy)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/SlotSortBy)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/SlotSortBy)
# SlotSummary
Summary information about a slot, a value that the bot elicits from the user.
## Contents
** description **
The description of the slot.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 2000.
Required: No
** lastUpdatedDateTime **
The timestamp of the last date and time that the slot was updated.
Type: Timestamp
Required: No
** slotConstraint **
Whether the slot is required or optional. An intent is complete when all required slots are filled.
Type: String
Valid Values: `Required | Optional`
Required: No
** slotId **
The unique identifier of the slot.
Type: String
Length Constraints: Fixed length of 10.
Pattern: `^[0-9a-zA-Z]+$`
Required: No
** slotName **
The name given to the slot.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern: `^([0-9a-zA-Z][_-]?){1,100}$`
Required: No
** slotTypeId **
The unique identifier for the slot type that defines the 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]+)$`
Required: No
** valueElicitationPromptSpecification **
Prompts that are sent to the user to elicit a value for the slot.
Type: [PromptSpecification](API_PromptSpecification.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/SlotSummary)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/SlotSummary)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/SlotSummary)
# SlotTypeFilter
Filters the response from the `ListSlotTypes` operation.
## Contents
** name **
The name of the field to use for filtering.
Type: String
Valid Values: `SlotTypeName | ExternalSourceType`
Required: Yes
** operator **
The operator to use for the filter. Specify `EQ` when the `ListSlotTypes` operation should return only aliases that equal the specified value. Specify `CO` when the `ListSlotTypes` operation should return aliases that contain the specified value.
Type: String
Valid Values: `CO | EQ`
Required: Yes
** values **
The value to use to filter the response.
Type: Array of strings
Array Members: Fixed number of 1 item.
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern: `^[0-9a-zA-Z_()\s-]+$`
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/SlotTypeFilter)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/SlotTypeFilter)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/SlotTypeFilter)
# SlotTypeSortBy
Specifies attributes for sorting a list of slot types.
## Contents
** attribute **
The attribute to use to sort the list of slot types.
Type: String
Valid Values: `SlotTypeName | LastUpdatedDateTime`
Required: Yes
** order **
The order to sort the list. You can say ascending or descending.
Type: String
Valid Values: `Ascending | Descending`
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/SlotTypeSortBy)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/SlotTypeSortBy)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/SlotTypeSortBy)
# SlotTypeStatistics
The object that contains the statistical summary of the recommended slot type associated with the bot recommendation.
## Contents
** discoveredSlotTypeCount **
The number of recommended slot types associated with the bot recommendation.
Type: Integer
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/SlotTypeStatistics)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/SlotTypeStatistics)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/SlotTypeStatistics)
# SlotTypeSummary
Provides summary information about a slot type.
## Contents
** description **
The description of the slot type.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 2000.
Required: No
** lastUpdatedDateTime **
A timestamp of the date and time that the slot type was last updated.
Type: Timestamp
Required: No
** parentSlotTypeSignature **
If the slot type is derived from a built-on slot type, the name of the parent slot type.
Type: String
Required: No
** slotTypeCategory **
Indicates the type of the slot type.
+ `Custom` - A slot type that you created using custom values. For more information, see [Creating custom slot types](https://docs.aws.amazon.com/lexv2/latest/dg/custom-slot-types.html).
+ `Extended` - A slot type created by extending the `AMAZON.AlphaNumeric` built-in slot type. For more information, see [https://docs.aws.amazon.com/lexv2/latest/dg/built-in-slot-alphanumerice.html](https://docs.aws.amazon.com/lexv2/latest/dg/built-in-slot-alphanumerice.html).
+ `ExternalGrammar` - A slot type using a custom GRXML grammar to define values. For more information, see [Using a custom grammar slot type](https://docs.aws.amazon.com/lexv2/latest/dg/building-grxml.html).
Type: String
Valid Values: `Custom | Extended | ExternalGrammar | Composite`
Required: No
** slotTypeId **
The unique identifier assigned to the slot type.
Type: String
Length Constraints: Fixed length of 10.
Pattern: `^[0-9a-zA-Z]+$`
Required: No
** slotTypeName **
The 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: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/SlotTypeSummary)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/SlotTypeSummary)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/SlotTypeSummary)
# SlotTypeValue
Each slot type can have a set of values. Each `SlotTypeValue` represents a value that the slot type can take.
## Contents
** sampleValue **
The value of the slot type entry.
Type: [SampleValue](API_SampleValue.md) object
Required: No
** synonyms **
Additional values related to the slot type entry.
Type: Array of [SampleValue](API_SampleValue.md) objects
Array Members: Minimum number of 1 item. Maximum number of 10000 items.
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/SlotTypeValue)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/SlotTypeValue)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/SlotTypeValue)
# SlotValue
The value to set in a slot.
## Contents
** interpretedValue **
The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the `resolvedValues` list.
Type: String
Length Constraints: Minimum length of 1.
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/SlotValue)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/SlotValue)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/SlotValue)
# SlotValueElicitationSetting
Specifies the elicitation setting details eliciting a slot.
## Contents
** slotConstraint **
Specifies whether the slot is required or optional.
Type: String
Valid Values: `Required | Optional`
Required: Yes
** defaultValueSpecification **
A list of default values for a slot. Default values are used when Amazon Lex hasn't determined a value for a slot. You can specify default values from context variables, session attributes, and defined values.
Type: [SlotDefaultValueSpecification](API_SlotDefaultValueSpecification.md) object
Required: No
** promptSpecification **
The prompt that Amazon Lex uses to elicit the slot value from the user.
Type: [PromptSpecification](API_PromptSpecification.md) object
Required: No
** sampleUtterances **
If you know a specific pattern that users might respond to an Amazon Lex request for a slot value, you can provide those utterances to improve accuracy. This is optional. In most cases, Amazon Lex is capable of understanding user utterances.
Type: Array of [SampleUtterance](API_SampleUtterance.md) objects
Required: No
** slotCaptureSetting **
Specifies the settings that Amazon Lex uses when a slot value is successfully entered by a user.
Type: [SlotCaptureSetting](API_SlotCaptureSetting.md) object
Required: No
** slotResolutionSetting **
An object containing information about whether assisted slot resolution is turned on for the slot or not.
Type: [SlotResolutionSetting](API_SlotResolutionSetting.md) object
Required: No
** waitAndContinueSpecification **
Specifies the prompts that Amazon Lex uses while a bot is waiting for customer input.
Type: [WaitAndContinueSpecification](API_WaitAndContinueSpecification.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/SlotValueElicitationSetting)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/SlotValueElicitationSetting)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/SlotValueElicitationSetting)
# SlotValueOverride
The slot values that Amazon Lex uses when it sets slot values in a dialog step.
## Contents
** shape **
When the shape value is `List`, it indicates that the `values` field contains a list of slot values. When the value is `Scalar`, it indicates that the `value` field contains a single value.
Type: String
Valid Values: `Scalar | List`
Required: No
** value **
The current value of the slot.
Type: [SlotValue](API_SlotValue.md) object
Required: No
** values **
A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
Type: Array of [SlotValueOverride](#API_SlotValueOverride) objects
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/SlotValueOverride)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/SlotValueOverride)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/SlotValueOverride)
# SlotValueRegexFilter
Provides a regular expression used to validate the value of a slot.
## Contents
** pattern **
A regular expression used to validate the value of a slot.
Use a standard regular expression. Amazon Lex supports the following characters in the regular expression:
+ A-Z, a-z
+ 0-9
+ Unicode characters ("\$1u")
Represent Unicode characters with four digits, for example "\$1u0041" or "\$1u005A".
The following regular expression operators are not supported:
+ Infinite repeaters: \$1, \$1, or \$1x,\$1 with no upper bound.
+ Wild card (.)
Type: String
Length Constraints: Minimum length of 1. Maximum length of 300.
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/SlotValueRegexFilter)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/SlotValueRegexFilter)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/SlotValueRegexFilter)
# SlotValueSelectionSetting
Contains settings used by Amazon Lex to select a slot value.
## Contents
** resolutionStrategy **
Determines the slot resolution strategy that Amazon Lex uses to return slot type values. The field can be set to one of the following values:
+ `ORIGINAL_VALUE` - Returns the value entered by the user, if the user value is similar to the slot value.
+ `TOP_RESOLUTION` - If there is a resolution list for the slot, return the first value in the resolution list as the slot type value. If there is no resolution list, null is returned.
If you don't specify the `valueSelectionStrategy`, the default is `ORIGINAL_VALUE`.
Type: String
Valid Values: `OriginalValue | TopResolution | Concatenation`
Required: Yes
** advancedRecognitionSetting **
Provides settings that enable advanced recognition settings for slot values. You can use this to enable using slot values as a custom vocabulary for recognizing user utterances.
Type: [AdvancedRecognitionSetting](API_AdvancedRecognitionSetting.md) object
Required: No
** regexFilter **
A regular expression used to validate the value of a slot.
Type: [SlotValueRegexFilter](API_SlotValueRegexFilter.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/SlotValueSelectionSetting)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/SlotValueSelectionSetting)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/SlotValueSelectionSetting)
# Specifications
Subslot specifications.
## Contents
** slotTypeId **
The unique identifier assigned to the slot type.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 25.
Pattern: `^((AMAZON\.)[a-zA-Z_]+?|[0-9a-zA-Z]+)$`
Required: Yes
** valueElicitationSetting **
Specifies the elicitation setting details for constituent sub slots of a composite slot.
Type: [SubSlotValueElicitationSetting](API_SubSlotValueElicitationSetting.md) object
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/Specifications)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/Specifications)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/Specifications)
# SpeechFoundationModel
Configuration for a foundation model used for speech synthesis and recognition capabilities.
## Contents
** modelArn **
The Amazon Resource Name (ARN) of the foundation model used for speech processing.
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}$`
Required: Yes
** voiceId **
The identifier of the voice to use for speech synthesis with the foundation model.
Type: String
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/SpeechFoundationModel)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/SpeechFoundationModel)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/SpeechFoundationModel)
# SpeechModelConfig
Configuration settings that define which speech-to-text model to use for processing speech input.
## Contents
** deepgramConfig **
Configuration settings for using Deepgram as the speech-to-text provider.
Type: [DeepgramSpeechModelConfig](API_DeepgramSpeechModelConfig.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/SpeechModelConfig)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/SpeechModelConfig)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/SpeechModelConfig)
# SpeechRecognitionSettings
Settings that control how Amazon Lex processes and recognizes speech input from users.
## Contents
** speechModelConfig **
Configuration settings for the selected speech-to-text model.
Type: [SpeechModelConfig](API_SpeechModelConfig.md) object
Required: No
** speechModelPreference **
The speech-to-text model to use.
Type: String
Valid Values: `Standard | Neural | Deepgram`
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/SpeechRecognitionSettings)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/SpeechRecognitionSettings)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/SpeechRecognitionSettings)
# SSMLMessage
Defines a Speech Synthesis Markup Language (SSML) prompt.
## Contents
** value **
The SSML text that defines the prompt.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1000.
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/SSMLMessage)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/SSMLMessage)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/SSMLMessage)
# StillWaitingResponseSpecification
Defines the messages that Amazon Lex sends to a user to remind them that the bot is waiting for a response.
## Contents
** frequencyInSeconds **
How often a message should be sent to the user. Minimum of 1 second, maximum of 5 minutes.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 300.
Required: Yes
** messageGroups **
One or more message groups, each containing one or more messages, that define the prompts that Amazon Lex sends to the user.
Type: Array of [MessageGroup](API_MessageGroup.md) objects
Array Members: Minimum number of 1 item. Maximum number of 5 items.
Required: Yes
** timeoutInSeconds **
If Amazon Lex waits longer than this length of time for a response, it will stop sending messages.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 900.
Required: Yes
** allowInterrupt **
Indicates that the user can interrupt the response by speaking while the message is being played.
Type: Boolean
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/StillWaitingResponseSpecification)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/StillWaitingResponseSpecification)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/StillWaitingResponseSpecification)
# SubSlotSetting
Specifications for the constituent sub slots and the expression for the composite slot.
## Contents
** expression **
The expression text for defining the constituent sub slots in the composite slot using logical AND and OR operators.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 640.
Pattern: `[0-9A-Za-z_\-\s\(\)]+`
Required: No
** slotSpecifications **
Specifications for the constituent sub slots of a composite slot.
Type: String to [Specifications](API_Specifications.md) object map
Map Entries: Minimum number of 0 items. Maximum number of 6 items.
Key Length Constraints: Minimum length of 1. Maximum length of 100.
Key Pattern: `^([0-9a-zA-Z][_-]?){1,100}$`
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/SubSlotSetting)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/SubSlotSetting)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/SubSlotSetting)
# SubSlotTypeComposition
Subslot type composition.
## Contents
** name **
Name of a constituent sub slot inside a composite slot.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern: `^([0-9a-zA-Z][_-]?){1,100}$`
Required: Yes
** slotTypeId **
The unique identifier assigned to a slot type. This refers to either a built-in slot type or the unique slotTypeId of a custom slot type.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 25.
Pattern: `^((AMAZON\.)[a-zA-Z_]+?|[0-9a-zA-Z]+)$`
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/SubSlotTypeComposition)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/SubSlotTypeComposition)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/SubSlotTypeComposition)
# SubSlotValueElicitationSetting
Subslot elicitation settings.
`DefaultValueSpecification` is a list of default values for a constituent sub slot in a composite slot. Default values are used when Amazon Lex hasn't determined a value for a slot. You can specify default values from context variables, session attributes, and defined values. This is similar to `DefaultValueSpecification` for slots.
`PromptSpecification` is the prompt that Amazon Lex uses to elicit the sub slot value from the user. This is similar to `PromptSpecification` for slots.
## Contents
** promptSpecification **
Specifies a list of message groups that Amazon Lex sends to a user to elicit a response.
Type: [PromptSpecification](API_PromptSpecification.md) object
Required: Yes
** defaultValueSpecification **
Defines a list of values that Amazon Lex should use as the default value for a slot.
Type: [SlotDefaultValueSpecification](API_SlotDefaultValueSpecification.md) object
Required: No
** sampleUtterances **
If you know a specific pattern that users might respond to an Amazon Lex request for a sub slot value, you can provide those utterances to improve accuracy. This is optional. In most cases Amazon Lex is capable of understanding user utterances. This is similar to `SampleUtterances` for slots.
Type: Array of [SampleUtterance](API_SampleUtterance.md) objects
Required: No
** waitAndContinueSpecification **
Specifies the prompts that Amazon Lex uses while a bot is waiting for customer input.
Type: [WaitAndContinueSpecification](API_WaitAndContinueSpecification.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/SubSlotValueElicitationSetting)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/SubSlotValueElicitationSetting)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/SubSlotValueElicitationSetting)
# TestExecutionResultFilterBy
Contains information about the method by which to filter the results of the test execution.
## Contents
** resultTypeFilter **
Specifies which results to filter. See [Test result details">Test results details](https://docs.aws.amazon.com/lexv2/latest/dg/test-results-details-test-set.html) for details about different types of results.
Type: String
Valid Values: `OverallTestResults | ConversationLevelTestResults | IntentClassificationTestResults | SlotResolutionTestResults | UtteranceLevelResults`
Required: Yes
** conversationLevelTestResultsFilterBy **
Contains information about the method for filtering Conversation level test results.
Type: [ConversationLevelTestResultsFilterBy](API_ConversationLevelTestResultsFilterBy.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/TestExecutionResultFilterBy)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/TestExecutionResultFilterBy)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/TestExecutionResultFilterBy)
# TestExecutionResultItems
Contains the results of the test execution, grouped by type of results. See [Test result details">Test results details](https://docs.aws.amazon.com/lexv2/latest/dg/test-results-details-test-set.html) for details about different types of results.
## Contents
** conversationLevelTestResults **
Results related to conversations in the test set, including metrics about success and failure of conversations and intent and slot failures.
Type: [ConversationLevelTestResults](API_ConversationLevelTestResults.md) object
Required: No
** intentClassificationTestResults **
Intent recognition results aggregated by intent name. The aggregated results contain success and failure rates of intent recognition, speech transcriptions, and end-to-end conversations.
Type: [IntentClassificationTestResults](API_IntentClassificationTestResults.md) object
Required: No
** intentLevelSlotResolutionTestResults **
Slot resolution results aggregated by intent and slot name. The aggregated results contain success and failure rates of slot resolution, speech transcriptions, and end-to-end conversations
Type: [IntentLevelSlotResolutionTestResults](API_IntentLevelSlotResolutionTestResults.md) object
Required: No
** overallTestResults **
Overall results for the test execution, including the breakdown of conversations and single-input utterances.
Type: [OverallTestResults](API_OverallTestResults.md) object
Required: No
** utteranceLevelTestResults **
Results related to utterances in the test set.
Type: [UtteranceLevelTestResults](API_UtteranceLevelTestResults.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/TestExecutionResultItems)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/TestExecutionResultItems)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/TestExecutionResultItems)
# TestExecutionSortBy
Contains information about the method by which to sort the instances of test executions you have carried out.
## Contents
** attribute **
Specifies whether to sort the test set executions by the date and time at which the test sets were created.
Type: String
Valid Values: `TestSetName | CreationDateTime`
Required: Yes
** order **
Specifies whether to sort in ascending or descending order.
Type: String
Valid Values: `Ascending | Descending`
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/TestExecutionSortBy)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/TestExecutionSortBy)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/TestExecutionSortBy)
# TestExecutionSummary
Summarizes metadata about the test execution.
## Contents
** apiMode **
Specifies whether the API mode for the test execution is streaming or non-streaming.
Type: String
Valid Values: `Streaming | NonStreaming`
Required: No
** creationDateTime **
The date and time at which the test execution was created.
Type: Timestamp
Required: No
** lastUpdatedDateTime **
The date and time at which the test execution was last updated.
Type: Timestamp
Required: No
** target **
Contains information about the bot used for the test execution..
Type: [TestExecutionTarget](API_TestExecutionTarget.md) object
Required: No
** testExecutionId **
The unique identifier of the test execution.
Type: String
Length Constraints: Fixed length of 10.
Pattern: `^[0-9a-zA-Z]+$`
Required: No
** testExecutionModality **
Specifies whether the data used for the test execution is written or spoken.
Type: String
Valid Values: `Text | Audio`
Required: No
** testExecutionStatus **
The current status of the test execution.
Type: String
Valid Values: `Pending | Waiting | InProgress | Completed | Failed | Stopping | Stopped`
Required: No
** testSetId **
The unique identifier of the test set used in the test execution.
Type: String
Length Constraints: Fixed length of 10.
Pattern: `^[0-9a-zA-Z]+$`
Required: No
** testSetName **
The name of the test set used in the test execution.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern: `^([0-9a-zA-Z][_-]?){1,100}$`
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/TestExecutionSummary)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/TestExecutionSummary)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/TestExecutionSummary)
# TestExecutionTarget
Contains information about the bot used for the test execution.
## Contents
** botAliasTarget **
Contains information about the bot alias used for the test execution.
Type: [BotAliasTestExecutionTarget](API_BotAliasTestExecutionTarget.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/TestExecutionTarget)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/TestExecutionTarget)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/TestExecutionTarget)
# TestSetDiscrepancyErrors
Contains details about the errors in the test set discrepancy report
## Contents
** intentDiscrepancies **
Contains information about discrepancies found for intents between the test set and the bot.
Type: Array of [TestSetIntentDiscrepancyItem](API_TestSetIntentDiscrepancyItem.md) objects
Required: Yes
** slotDiscrepancies **
Contains information about discrepancies found for slots between the test set and the bot.
Type: Array of [TestSetSlotDiscrepancyItem](API_TestSetSlotDiscrepancyItem.md) objects
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/TestSetDiscrepancyErrors)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/TestSetDiscrepancyErrors)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/TestSetDiscrepancyErrors)
# TestSetDiscrepancyReportBotAliasTarget
Contains information about the bot alias used for the test set discrepancy report.
## Contents
** botAliasId **
The unique identifier for the bot associated with the bot alias.
Type: String
Length Constraints: Fixed length of 10.
Pattern: `^(\bTSTALIASID\b|[0-9a-zA-Z]+)$`
Required: Yes
** botId **
The unique identifier for the bot alias.
Type: String
Length Constraints: Fixed length of 10.
Pattern: `^[0-9a-zA-Z]+$`
Required: Yes
** localeId **
The unique identifier of the locale associated with the bot alias.
Type: String
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/TestSetDiscrepancyReportBotAliasTarget)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/TestSetDiscrepancyReportBotAliasTarget)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/TestSetDiscrepancyReportBotAliasTarget)
# TestSetDiscrepancyReportResourceTarget
Contains information about the resource used for the test set discrepancy report.
## Contents
** botAliasTarget **
Contains information about the bot alias used as the resource for the test set discrepancy report.
Type: [TestSetDiscrepancyReportBotAliasTarget](API_TestSetDiscrepancyReportBotAliasTarget.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/TestSetDiscrepancyReportResourceTarget)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/TestSetDiscrepancyReportResourceTarget)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/TestSetDiscrepancyReportResourceTarget)
# TestSetExportSpecification
Contains information about the test set that is exported.
## Contents
** testSetId **
The unique identifier of the test set.
Type: String
Length Constraints: Fixed length of 10.
Pattern: `^[0-9a-zA-Z]+$`
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/TestSetExportSpecification)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/TestSetExportSpecification)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/TestSetExportSpecification)
# TestSetGenerationDataSource
Contains information about the data source from which the test set is generated.
## Contents
** conversationLogsDataSource **
Contains information about the bot from which the conversation logs are sourced.
Type: [ConversationLogsDataSource](API_ConversationLogsDataSource.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/TestSetGenerationDataSource)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/TestSetGenerationDataSource)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/TestSetGenerationDataSource)
# TestSetImportInputLocation
Contains information about the Amazon S3 location from which the test set is imported.
## Contents
** s3BucketName **
The name of the Amazon S3 bucket.
Type: String
Length Constraints: Minimum length of 3. Maximum length of 63.
Pattern: `^[a-z0-9][\.\-a-z0-9]{1,61}[a-z0-9]$`
Required: Yes
** s3Path **
The path inside the Amazon S3 bucket pointing to the test-set CSV file.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Pattern: `[\.\-\!\*\_\'\(\)a-zA-Z0-9][\.\-\!\*\_\'\(\)\/a-zA-Z0-9]*$`
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/TestSetImportInputLocation)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/TestSetImportInputLocation)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/TestSetImportInputLocation)
# TestSetImportResourceSpecification
Contains information about the test set that is imported.
## Contents
** importInputLocation **
Contains information about the input location from where test-set should be imported.
Type: [TestSetImportInputLocation](API_TestSetImportInputLocation.md) object
Required: Yes
** modality **
Specifies whether the test-set being imported contains written or spoken data.
Type: String
Valid Values: `Text | Audio`
Required: Yes
** roleArn **
The Amazon Resource Name (ARN) of an IAM role that has permission to access the test set.
Type: String
Length Constraints: Minimum length of 32. Maximum length of 2048.
Pattern: `^arn:aws:iam::[0-9]{12}:role/.*$`
Required: Yes
** storageLocation **
Contains information about the location that Amazon Lex uses to store the test-set.
Type: [TestSetStorageLocation](API_TestSetStorageLocation.md) object
Required: Yes
** testSetName **
The name of the test set.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern: `^([0-9a-zA-Z][_-]?){1,100}$`
Required: Yes
** description **
The description of the test set.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 2000.
Required: No
** testSetTags **
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
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/TestSetImportResourceSpecification)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/TestSetImportResourceSpecification)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/TestSetImportResourceSpecification)
# TestSetIntentDiscrepancyItem
Contains information about discrepancy in an intent information between the test set and the bot.
## Contents
** errorMessage **
The error message for a discrepancy for an intent between the test set and the bot.
Type: String
Required: Yes
** intentName **
The name of the intent in the discrepancy report.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern: `^([0-9a-zA-Z][_-]?){1,100}$`
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/TestSetIntentDiscrepancyItem)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/TestSetIntentDiscrepancyItem)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/TestSetIntentDiscrepancyItem)
# TestSetSlotDiscrepancyItem
Contains information about discrepancy in a slot information between the test set and the bot.
## Contents
** errorMessage **
The error message for a discrepancy for an intent between the test set and the bot.
Type: String
Required: Yes
** intentName **
The name of the intent associated with the slot in the discrepancy report.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern: `^([0-9a-zA-Z][_-]?){1,100}$`
Required: Yes
** slotName **
The name of the slot in the discrepancy report.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern: `^([0-9a-zA-Z][_-]?){1,100}$`
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/TestSetSlotDiscrepancyItem)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/TestSetSlotDiscrepancyItem)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/TestSetSlotDiscrepancyItem)
# TestSetSortBy
Contains information about the methods by which to sort the test set.
## Contents
** attribute **
Specifies whether to sort the test sets by name or by the time they were last updated.
Type: String
Valid Values: `TestSetName | LastUpdatedDateTime`
Required: Yes
** order **
Specifies whether to sort in ascending or descending order.
Type: String
Valid Values: `Ascending | Descending`
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/TestSetSortBy)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/TestSetSortBy)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/TestSetSortBy)
# TestSetStorageLocation
Contains information about the location in which the test set is stored.
## Contents
** s3BucketName **
The name of the Amazon S3 bucket in which the test set is stored.
Type: String
Length Constraints: Minimum length of 3. Maximum length of 63.
Pattern: `^[a-z0-9][\.\-a-z0-9]{1,61}[a-z0-9]$`
Required: Yes
** s3Path **
The path inside the Amazon S3 bucket where the test set is stored.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Pattern: `[\.\-\!\*\_\'\(\)a-zA-Z0-9][\.\-\!\*\_\'\(\)\/a-zA-Z0-9]*$`
Required: Yes
** kmsKeyArn **
The Amazon Resource Name (ARN) of an AWS Key Management Service (KMS) key for encrypting the test set.
Type: String
Length Constraints: Minimum length of 20. Maximum length of 2048.
Pattern: `^arn:[\w\-]+:kms:[\w\-]+:[\d]{12}:(?:key\/[\w\-]+|alias\/[a-zA-Z0-9:\/_\-]{1,256})$`
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/TestSetStorageLocation)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/TestSetStorageLocation)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/TestSetStorageLocation)
# TestSetSummary
Contains summary information about the test set.
## Contents
** creationDateTime **
The date and time at which the test set was created.
Type: Timestamp
Required: No
** description **
The description of the test set.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 2000.
Required: No
** lastUpdatedDateTime **
The date and time at which the test set was last updated.
Type: Timestamp
Required: No
** modality **
Specifies whether the test set contains written or spoken data.
Type: String
Valid Values: `Text | Audio`
Required: No
** numTurns **
The number of turns in the test set.
Type: Integer
Required: No
** roleArn **
The Amazon Resource Name (ARN) of an IAM role that has permission to access the test set.
Type: String
Length Constraints: Minimum length of 32. Maximum length of 2048.
Pattern: `^arn:aws:iam::[0-9]{12}:role/.*$`
Required: No
** status **
The status of the test set.
Type: String
Valid Values: `Importing | PendingAnnotation | Deleting | ValidationError | Ready`
Required: No
** storageLocation **
Contains information about the location at which the test set is stored.
Type: [TestSetStorageLocation](API_TestSetStorageLocation.md) object
Required: No
** testSetId **
The unique identifier of the test set.
Type: String
Length Constraints: Fixed length of 10.
Pattern: `^[0-9a-zA-Z]+$`
Required: No
** testSetName **
The name of the test set.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern: `^([0-9a-zA-Z][_-]?){1,100}$`
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/TestSetSummary)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/TestSetSummary)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/TestSetSummary)
# TestSetTurnRecord
Contains information about a turn in a test set.
## Contents
** recordNumber **
The record number associated with the turn.
Type: Long
Valid Range: Minimum value of 1. Maximum value of 200000.
Required: Yes
** turnSpecification **
Contains information about the agent or user turn depending upon type of turn.
Type: [TurnSpecification](API_TurnSpecification.md) object
Required: Yes
** conversationId **
The unique identifier for the conversation associated with the turn.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 50.
Pattern: `^([0-9a-zA-Z][_-]?)+$`
Required: No
** turnNumber **
The number of turns that has elapsed up to that turn.
Type: Integer
Valid Range: Minimum value of 0. Maximum value of 30.
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/TestSetTurnRecord)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/TestSetTurnRecord)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/TestSetTurnRecord)
# TestSetTurnResult
Contains information about the results of the analysis of a turn in the test set.
## Contents
** agent **
Contains information about the agent messages in the turn.
Type: [AgentTurnResult](API_AgentTurnResult.md) object
Required: No
** user **
Contains information about the user messages in the turn.
Type: [UserTurnResult](API_UserTurnResult.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/TestSetTurnResult)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/TestSetTurnResult)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/TestSetTurnResult)
# TextInputSpecification
Specifies the text input specifications.
## Contents
** startTimeoutMs **
Time for which a bot waits before re-prompting a customer for text input.
Type: Integer
Valid Range: Minimum value of 1.
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/TextInputSpecification)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/TextInputSpecification)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/TextInputSpecification)
# TextLogDestination
Defines the Amazon CloudWatch Logs destination log group for conversation text logs.
## Contents
** cloudWatch **
Defines the Amazon CloudWatch Logs log group where text and metadata logs are delivered.
Type: [CloudWatchLogGroupLogDestination](API_CloudWatchLogGroupLogDestination.md) object
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/TextLogDestination)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/TextLogDestination)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/TextLogDestination)
# TextLogSetting
Defines settings to enable text conversation logs.
## Contents
** destination **
Defines the Amazon CloudWatch Logs destination log group for conversation text logs.
Type: [TextLogDestination](API_TextLogDestination.md) object
Required: Yes
** enabled **
Determines whether conversation logs should be stored for an alias.
Type: Boolean
Required: Yes
** selectiveLoggingEnabled **
The option to enable selective conversation log capture for text.
Type: Boolean
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/TextLogSetting)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/TextLogSetting)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/TextLogSetting)
# TranscriptFilter
The object representing the filter that Amazon Lex will use to select the appropriate transcript.
## Contents
** lexTranscriptFilter **
The object representing the filter that Amazon Lex will use to select the appropriate transcript when the transcript format is the Amazon Lex format.
Type: [LexTranscriptFilter](API_LexTranscriptFilter.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/TranscriptFilter)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/TranscriptFilter)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/TranscriptFilter)
# TranscriptSourceSetting
Indicates the setting of the location where the transcript is stored.
## Contents
** s3BucketTranscriptSource **
Indicates the setting of the Amazon S3 bucket where the transcript is stored.
Type: [S3BucketTranscriptSource](API_S3BucketTranscriptSource.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/TranscriptSourceSetting)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/TranscriptSourceSetting)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/TranscriptSourceSetting)
# TurnSpecification
Contains information about the messages in the turn.
## Contents
** agentTurn **
Contains information about the agent messages in the turn.
Type: [AgentTurnSpecification](API_AgentTurnSpecification.md) object
Required: No
** userTurn **
Contains information about the user messages in the turn.
Type: [UserTurnSpecification](API_UserTurnSpecification.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/TurnSpecification)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/TurnSpecification)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/TurnSpecification)
# UnifiedSpeechSettings
Unified configuration settings that combine speech recognition and synthesis capabilities.
## Contents
** speechFoundationModel **
The foundation model configuration to use for unified speech processing capabilities.
Type: [SpeechFoundationModel](API_SpeechFoundationModel.md) object
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/UnifiedSpeechSettings)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/UnifiedSpeechSettings)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/UnifiedSpeechSettings)
# UserTurnInputSpecification
Contains information about the user messages in the turn in the input.
## Contents
** utteranceInput **
The utterance input in the user turn.
Type: [UtteranceInputSpecification](API_UtteranceInputSpecification.md) object
Required: Yes
** requestAttributes **
Request attributes of the user turn.
Type: String to string map
Key Length Constraints: Minimum length of 1.
Required: No
** sessionState **
Contains information about the session state in the input.
Type: [InputSessionStateSpecification](API_InputSessionStateSpecification.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/UserTurnInputSpecification)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/UserTurnInputSpecification)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/UserTurnInputSpecification)
# UserTurnIntentOutput
Contains information about the intent that is output for the turn by the test execution.
## Contents
** name **
The name of the intent.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern: `^([0-9a-zA-Z][_-]?){1,100}$`
Required: Yes
** slots **
The slots associated with the intent.
Type: String to [UserTurnSlotOutput](API_UserTurnSlotOutput.md) object map
Key Length Constraints: Minimum length of 1. Maximum length of 100.
Key Pattern: `^([0-9a-zA-Z][_-]?){1,100}$`
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/UserTurnIntentOutput)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/UserTurnIntentOutput)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/UserTurnIntentOutput)
# UserTurnOutputSpecification
Contains results that are output for the user turn by the test execution.
## Contents
** intent **
Contains information about the intent.
Type: [UserTurnIntentOutput](API_UserTurnIntentOutput.md) object
Required: Yes
** activeContexts **
The contexts that are active in the turn.
Type: Array of [ActiveContext](API_ActiveContext.md) objects
Array Members: Minimum number of 0 items. Maximum number of 20 items.
Required: No
** transcript **
The transcript that is output for the user turn by the test execution.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/UserTurnOutputSpecification)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/UserTurnOutputSpecification)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/UserTurnOutputSpecification)
# UserTurnResult
Contains the results for the user turn by the test execution.
## Contents
** expectedOutput **
Contains information about the expected output for the user turn.
Type: [UserTurnOutputSpecification](API_UserTurnOutputSpecification.md) object
Required: Yes
** input **
Contains information about the user messages in the turn in the input.
Type: [UserTurnInputSpecification](API_UserTurnInputSpecification.md) object
Required: Yes
** actualOutput **
Contains information about the actual output for the user turn.
Type: [UserTurnOutputSpecification](API_UserTurnOutputSpecification.md) object
Required: No
** conversationLevelResult **
Contains information about the results related to the conversation associated with the user turn.
Type: [ConversationLevelResultDetail](API_ConversationLevelResultDetail.md) object
Required: No
** endToEndResult **
Specifies whether the expected and actual outputs match or not, or if there is an error in execution.
Type: String
Valid Values: `Matched | Mismatched | ExecutionError`
Required: No
** errorDetails **
Details about an error in an execution of a test set.
Type: [ExecutionErrorDetails](API_ExecutionErrorDetails.md) object
Required: No
** intentMatchResult **
Specifies whether the expected and actual intents match or not.
Type: String
Valid Values: `Matched | Mismatched | ExecutionError`
Required: No
** slotMatchResult **
Specifies whether the expected and actual slots match or not.
Type: String
Valid Values: `Matched | Mismatched | ExecutionError`
Required: No
** speechTranscriptionResult **
Specifies whether the expected and actual speech transcriptions match or not, or if there is an error in execution.
Type: String
Valid Values: `Matched | Mismatched | ExecutionError`
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/UserTurnResult)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/UserTurnResult)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/UserTurnResult)
# UserTurnSlotOutput
Contains information about a slot output by the test set execution.
## Contents
** subSlots **
A list of items mapping the name of the subslots to information about those subslots.
Type: String to [UserTurnSlotOutput](#API_UserTurnSlotOutput) object map
Key Length Constraints: Minimum length of 1. Maximum length of 100.
Key Pattern: `^([0-9a-zA-Z][_-]?){1,100}$`
Required: No
** value **
The value output by the slot recognition.
Type: String
Length Constraints: Minimum length of 1.
Required: No
** values **
Values that are output by the slot recognition.
Type: Array of [UserTurnSlotOutput](#API_UserTurnSlotOutput) objects
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/UserTurnSlotOutput)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/UserTurnSlotOutput)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/UserTurnSlotOutput)
# UserTurnSpecification
Contains information about the expected and input values for the user turn.
## Contents
** expected **
Contains results about the expected output for the user turn.
Type: [UserTurnOutputSpecification](API_UserTurnOutputSpecification.md) object
Required: Yes
** input **
Contains information about the user messages in the turn in the input.
Type: [UserTurnInputSpecification](API_UserTurnInputSpecification.md) object
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/UserTurnSpecification)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/UserTurnSpecification)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/UserTurnSpecification)
# UtteranceAggregationDuration
Provides parameters for setting the time window and duration for aggregating utterance data.
## Contents
** relativeAggregationDuration **
The desired time window for aggregating utterances.
Type: [RelativeAggregationDuration](API_RelativeAggregationDuration.md) object
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/UtteranceAggregationDuration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/UtteranceAggregationDuration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/UtteranceAggregationDuration)
# UtteranceAudioInputSpecification
Contains information about the audio for an utterance.
## Contents
** audioFileS3Location **
Amazon S3 file pointing to the audio.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Pattern: `^s3://([a-z0-9\\.-]+)/(.+)$`
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/UtteranceAudioInputSpecification)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/UtteranceAudioInputSpecification)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/UtteranceAudioInputSpecification)
# UtteranceBotResponse
An object that contains a response to the utterance from the bot.
## Contents
** content **
The text of the response to the utterance from the bot.
Type: String
Required: No
** contentType **
The type of the response. The following values are possible:
+ `PlainText` – A plain text string.
+ `CustomPayload` – A response string that you can customize to include data or metadata for your application.
+ `SSML` – A string that includes Speech Synthesis Markup Language to customize the audio response.
+ `ImageResponseCard` – An image with buttons that the customer can select. See [ImageResponseCard](https://docs.aws.amazon.com/lexv2/latest/APIReference/API_runtime_ImageResponseCard.html) for more information.
Type: String
Valid Values: `PlainText | CustomPayload | SSML | ImageResponseCard`
Required: No
** imageResponseCard **
A card that is shown to the user by a messaging platform. You define the contents of the card, the card is displayed by the platform.
When you use a response card, the response from the user is constrained to the text associated with a button on the card.
Type: [ImageResponseCard](API_ImageResponseCard.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/UtteranceBotResponse)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/UtteranceBotResponse)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/UtteranceBotResponse)
# UtteranceDataSortBy
An object specifying the measure and method by which to sort the utterance data.
## Contents
** name **
The measure by which to sort the utterance analytics data.
+ `Count` – The number of utterances.
+ `UtteranceTimestamp` – The date and time of the utterance.
Type: String
Valid Values: `UtteranceTimestamp`
Required: Yes
** order **
Specifies whether to sort the results in ascending or descending order.
Type: String
Valid Values: `Ascending | Descending`
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/UtteranceDataSortBy)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/UtteranceDataSortBy)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/UtteranceDataSortBy)
# UtteranceInputSpecification
Contains information about input of an utterance.
## Contents
** audioInput **
Contains information about the audio input for an utterance.
Type: [UtteranceAudioInputSpecification](API_UtteranceAudioInputSpecification.md) object
Required: No
** textInput **
A text input transcription of the utterance. It is only applicable for test-sets containing text data.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/UtteranceInputSpecification)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/UtteranceInputSpecification)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/UtteranceInputSpecification)
# UtteranceLevelTestResultItem
Contains information about multiple utterances in the results of a test set execution.
## Contents
** recordNumber **
The record number of the result.
Type: Long
Valid Range: Minimum value of 1. Maximum value of 200000.
Required: Yes
** turnResult **
Contains information about the turn associated with the result.
Type: [TestSetTurnResult](API_TestSetTurnResult.md) object
Required: Yes
** conversationId **
The unique identifier for the conversation associated with the result.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 50.
Pattern: `^([0-9a-zA-Z][_-]?)+$`
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/UtteranceLevelTestResultItem)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/UtteranceLevelTestResultItem)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/UtteranceLevelTestResultItem)
# UtteranceLevelTestResults
Contains information about the utterances in the results of the test set execution.
## Contents
** items **
Contains information about an utterance in the results of the test set execution.
Type: Array of [UtteranceLevelTestResultItem](API_UtteranceLevelTestResultItem.md) objects
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/UtteranceLevelTestResults)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/UtteranceLevelTestResults)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/UtteranceLevelTestResults)
# UtteranceSpecification
An object containing information about a specific utterance.
## Contents
** associatedIntentName **
The name of the intent that the utterance is associated to.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern: `^([0-9a-zA-Z][_-]?){1,100}$`
Required: No
** associatedSlotName **
The name of the slot that the utterance is associated to.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern: `^([0-9a-zA-Z][_-]?){1,100}$`
Required: No
** audioVoiceDurationMillis **
The duration in milliseconds of the audio associated with the utterance.
Type: Long
Required: No
** botAliasId **
The identifier of the alias of the bot that the utterance was made to.
Type: String
Length Constraints: Fixed length of 10.
Pattern: `^(\bTSTALIASID\b|[0-9a-zA-Z]+)$`
Required: No
** botResponseAudioVoiceId **
The identifier for the audio of the bot response.
Type: String
Required: No
** botResponses **
A list of objects containing information about the bot response to the utterance.
Type: Array of [UtteranceBotResponse](API_UtteranceBotResponse.md) objects
Required: No
** botVersion **
The version of the bot that the utterance was made to.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 5.
Pattern: `^[0-9]+$`
Required: No
** channel **
The channel that is integrated with the bot that the utterance was made to.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 50.
Required: No
** conversationEndTime **
The date and time when the conversation in which the utterance took place ended. A conversation is defined as a unique combination of a `sessionId` and an `originatingRequestId`.
Type: Timestamp
Required: No
** conversationStartTime **
The date and time when the conversation in which the utterance took place began. A conversation is defined as a unique combination of a `sessionId` and an `originatingRequestId`.
Type: Timestamp
Required: No
** dialogActionType **
The type of dialog action that the utterance is associated to. See the `type` field in [DialogAction](https://docs.aws.amazon.com/lexv2/latest/APIReference/API_runtime_DialogAction.html) for more information.
Type: String
Required: No
** inputType **
The input type of the utterance. The possible values are as follows:
+ PCM format: audio data must be in little-endian byte order.
+ `audio/l16; rate=16000; channels=1`
+ `audio/x-l16; sample-rate=16000; channel-count=1`
+ `audio/lpcm; sample-rate=8000; sample-size-bits=16; channel-count=1; is-big-endian=false`
+ Opus format
+ `audio/x-cbr-opus-with-preamble;preamble-size=0;bit-rate=256000;frame-size-milliseconds=4`
+ Text format
+ `text/plain; charset=utf-8`
Type: String
Required: No
** intentState **
The state of the intent that the utterance is associated to.
Type: String
Valid Values: `Failed | Fulfilled | InProgress | ReadyForFulfillment | Waiting | FulfillmentInProgress`
Required: No
** localeId **
The locale of the bot that the utterance was made to.
Type: String
Required: No
** mode **
The mode of the session. The possible values are as follows:
+ `Speech` – The session consisted of spoken dialogue.
+ `Text` – The session consisted of written dialogue.
+ `DTMF` – The session consisted of touch-tone keypad (Dual Tone Multi-Frequency) key presses.
+ `MultiMode` – The session consisted of multiple modes.
Type: String
Valid Values: `Speech | Text | DTMF | MultiMode`
Required: No
** outputType **
The output type of the utterance. The possible values are as follows:
+ `audio/mpeg`
+ `audio/ogg`
+ `audio/pcm (16 KHz)`
+ `audio/` (defaults to `mpeg`)
+ `text/plain; charset=utf-8`
Type: String
Required: No
** sessionId **
The identifier of the session that the utterance was made in.
Type: String
Pattern: `[0-9a-zA-Z._:-]`
Required: No
** slotsFilledInSession **
The slots that have been filled in the session by the time of the utterance.
Type: String
Required: No
** utterance **
The text of the utterance.
Type: String
Required: No
** utteranceRequestId **
The identifier of the request associated with the utterance.
Type: String
Length Constraints: Fixed length of 10.
Pattern: `^[0-9a-zA-Z]+$`
Required: No
** utteranceTimestamp **
The date and time when the utterance took place.
Type: Timestamp
Required: No
** utteranceUnderstood **
Specifies whether the bot understood the utterance or not.
Type: Boolean
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/UtteranceSpecification)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/UtteranceSpecification)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/UtteranceSpecification)
# VoiceSettings
Defines settings for using an Amazon Polly voice to communicate with a user.
Valid values include:
+ `standard`
+ `neural`
+ `long-form`
+ `generative`
## Contents
** voiceId **
The identifier of the Amazon Polly voice to use.
Type: String
Required: Yes
** engine **
Indicates the type of Amazon Polly voice that Amazon Lex should use for voice interaction with the user. For more information, see the [`engine` parameter of the `SynthesizeSpeech` operation](https://docs.aws.amazon.com/polly/latest/dg/API_SynthesizeSpeech.html#polly-SynthesizeSpeech-request-Engine) in the *Amazon Polly developer guide*.
If you do not specify a value, the default is `standard`.
Type: String
Valid Values: `standard | neural | long-form | generative`
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/VoiceSettings)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/VoiceSettings)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/VoiceSettings)
# WaitAndContinueSpecification
Specifies the prompts that Amazon Lex uses while a bot is waiting for customer input.
## Contents
** continueResponse **
The response that Amazon Lex sends to indicate that the bot is ready to continue the conversation.
Type: [ResponseSpecification](API_ResponseSpecification.md) object
Required: Yes
** waitingResponse **
The response that Amazon Lex sends to indicate that the bot is waiting for the conversation to continue.
Type: [ResponseSpecification](API_ResponseSpecification.md) object
Required: Yes
** active **
Specifies whether the bot will wait for a user to respond. When this field is false, wait and continue responses for a slot aren't used. If the `active` field isn't specified, the default is true.
Type: Boolean
Required: No
** stillWaitingResponse **
A response that Amazon Lex sends periodically to the user to indicate that the bot is still waiting for input from the user.
Type: [StillWaitingResponseSpecification](API_StillWaitingResponseSpecification.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/models.lex.v2-2020-08-07/WaitAndContinueSpecification)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/models.lex.v2-2020-08-07/WaitAndContinueSpecification)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/models.lex.v2-2020-08-07/WaitAndContinueSpecification)
# Amazon Lex Runtime V2
The following data types are supported by Amazon Lex Runtime V2:
+ [ActiveContext](API_runtime_ActiveContext.md)
+ [ActiveContextTimeToLive](API_runtime_ActiveContextTimeToLive.md)
+ [AudioInputEvent](API_runtime_AudioInputEvent.md)
+ [AudioResponseEvent](API_runtime_AudioResponseEvent.md)
+ [Button](API_runtime_Button.md)
+ [ConfidenceScore](API_runtime_ConfidenceScore.md)
+ [ConfigurationEvent](API_runtime_ConfigurationEvent.md)
+ [DialogAction](API_runtime_DialogAction.md)
+ [DisconnectionEvent](API_runtime_DisconnectionEvent.md)
+ [DTMFInputEvent](API_runtime_DTMFInputEvent.md)
+ [ElicitSubSlot](API_runtime_ElicitSubSlot.md)
+ [HeartbeatEvent](API_runtime_HeartbeatEvent.md)
+ [ImageResponseCard](API_runtime_ImageResponseCard.md)
+ [Intent](API_runtime_Intent.md)
+ [IntentResultEvent](API_runtime_IntentResultEvent.md)
+ [Interpretation](API_runtime_Interpretation.md)
+ [Message](API_runtime_Message.md)
+ [PlaybackCompletionEvent](API_runtime_PlaybackCompletionEvent.md)
+ [PlaybackInterruptionEvent](API_runtime_PlaybackInterruptionEvent.md)
+ [RecognizedBotMember](API_runtime_RecognizedBotMember.md)
+ [RuntimeHintDetails](API_runtime_RuntimeHintDetails.md)
+ [RuntimeHints](API_runtime_RuntimeHints.md)
+ [RuntimeHintValue](API_runtime_RuntimeHintValue.md)
+ [SentimentResponse](API_runtime_SentimentResponse.md)
+ [SentimentScore](API_runtime_SentimentScore.md)
+ [SessionState](API_runtime_SessionState.md)
+ [Slot](API_runtime_Slot.md)
+ [StartConversationRequestEventStream](API_runtime_StartConversationRequestEventStream.md)
+ [StartConversationResponseEventStream](API_runtime_StartConversationResponseEventStream.md)
+ [TextInputEvent](API_runtime_TextInputEvent.md)
+ [TextResponseEvent](API_runtime_TextResponseEvent.md)
+ [TranscriptEvent](API_runtime_TranscriptEvent.md)
+ [Value](API_runtime_Value.md)
# ActiveContext
Contains information about the contexts that a user is using in a session. You can configure Amazon Lex V2 to set a context when an intent is fulfilled, or you can set a context using the [PutSession](API_runtime_PutSession.md), [RecognizeText](API_runtime_RecognizeText.md), or [RecognizeUtterance](API_runtime_RecognizeUtterance.md) operations.
Use a context to indicate to Amazon Lex V2 intents that should be used as follow-up intents. For example, if the active context is `order-fulfilled`, only intents that have `order-fulfilled` configured as a trigger are considered for follow up.
## Contents
** contextAttributes **
A list of contexts active for the request. A context can be activated when a previous intent is fulfilled, or by including the context in the request.
If you don't specify a list of contexts, Amazon Lex V2 will use the current list of contexts for the session. If you specify an empty list, all contexts for the session are cleared.
Type: String to string map
Map Entries: Minimum number of 0 items. Maximum number of 10 items.
Key Length Constraints: Minimum length of 1. Maximum length of 100.
Value Length Constraints: Minimum length of 1. Maximum length of 1024.
Required: Yes
** name **
The name of the context.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern: `^([A-Za-z0-9]_?)+$`
Required: Yes
** timeToLive **
Indicates the number of turns or seconds that the context is active. Once the time to live expires, the context is no longer returned in a response.
Type: [ActiveContextTimeToLive](API_runtime_ActiveContextTimeToLive.md) object
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/runtime.lex.v2-2020-08-07/ActiveContext)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/runtime.lex.v2-2020-08-07/ActiveContext)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/runtime.lex.v2-2020-08-07/ActiveContext)
# ActiveContextTimeToLive
The time that a context is active. You can specify the time to live in seconds or in conversation turns.
## Contents
** timeToLiveInSeconds **
The number of seconds that the context is active. You can specify between 5 and 86400 seconds (24 hours).
Type: Integer
Valid Range: Minimum value of 5. Maximum value of 86400.
Required: Yes
** turnsToLive **
The number of turns that the context is active. You can specify up to 20 turns. Each request and response from the bot is a turn.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 20.
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/runtime.lex.v2-2020-08-07/ActiveContextTimeToLive)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/runtime.lex.v2-2020-08-07/ActiveContextTimeToLive)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/runtime.lex.v2-2020-08-07/ActiveContextTimeToLive)
# AudioInputEvent
Represents a chunk of audio sent from the client application to Amazon Lex V2. The audio is all or part of an utterance from the user.
Amazon Lex V2 accumulates audio chunks until it recognizes a natural pause in speech before processing the input.
## Contents
** contentType **
The encoding used for the audio chunk. You must use 8 KHz PCM 16-bit mono-channel little-endian format. The value of the field should be:
`audio/lpcm; sample-rate=8000; sample-size-bits=16; channel-count=1; is-big-endian=false`
Type: String
Length Constraints: Minimum length of 1.
Required: Yes
** audioChunk **
An encoded stream of audio.
Type: Base64-encoded binary data object
Required: No
** clientTimestampMillis **
A timestamp set by the client of the date and time that the event was sent to Amazon Lex V2.
Type: Long
Required: No
** eventId **
A unique identifier that your application assigns to the event. You can use this to identify events in logs.
Type: String
Length Constraints: Minimum length of 2. Maximum length of 100.
Pattern: `[0-9a-zA-Z._:-]+`
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/runtime.lex.v2-2020-08-07/AudioInputEvent)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/runtime.lex.v2-2020-08-07/AudioInputEvent)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/runtime.lex.v2-2020-08-07/AudioInputEvent)
# AudioResponseEvent
An event sent from Amazon Lex V2 to your client application containing audio to play to the user.
## Contents
** audioChunk **
A chunk of the audio to play.
Type: Base64-encoded binary data object
Required: No
** contentType **
The encoding of the audio chunk. This is the same as the encoding configure in the `contentType` field of the `ConfigurationEvent`.
Type: String
Length Constraints: Minimum length of 1.
Required: No
** eventId **
A unique identifier of the event sent by Amazon Lex V2. The identifier is in the form `RESPONSE-N`, where N is a number starting with one and incremented for each event sent by Amazon Lex V2 in the current session.
Type: String
Length Constraints: Minimum length of 2. Maximum length of 100.
Pattern: `[0-9a-zA-Z._:-]+`
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/runtime.lex.v2-2020-08-07/AudioResponseEvent)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/runtime.lex.v2-2020-08-07/AudioResponseEvent)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/runtime.lex.v2-2020-08-07/AudioResponseEvent)
# Button
A button that appears on a response card show to the user.
## Contents
** text **
The text that is displayed on the button.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 50.
Required: Yes
** value **
The value returned to Amazon Lex V2 when a user chooses the button.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 50.
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/runtime.lex.v2-2020-08-07/Button)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/runtime.lex.v2-2020-08-07/Button)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/runtime.lex.v2-2020-08-07/Button)
# ConfidenceScore
Provides a score that indicates the confidence that Amazon Lex V2 has that an intent is the one that satisfies the user's intent.
## Contents
** score **
A score that indicates how confident Amazon Lex V2 is that an intent satisfies the user's intent. Ranges between 0.00 and 1.00. Higher scores indicate higher confidence.
Type: Double
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/runtime.lex.v2-2020-08-07/ConfidenceScore)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/runtime.lex.v2-2020-08-07/ConfidenceScore)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/runtime.lex.v2-2020-08-07/ConfidenceScore)
# ConfigurationEvent
The initial event sent from the application to Amazon Lex V2 to configure the conversation, including session and request attributes and the response content type.
## Contents
** responseContentType **
The message that Amazon Lex V2 returns in the response can be either text or speech based on the `responseContentType` value.
+ If the value is `text/plain;charset=utf-8`, Amazon Lex V2 returns text in the response.
+ If the value begins with `audio/`, Amazon Lex V2 returns speech in the response. Amazon Lex V2 uses Amazon Polly to generate the speech using the configuration that you specified in the `requestContentType` parameter. For example, if you specify `audio/mpeg` as the value, Amazon Lex V2 returns speech in the MPEG format.
+ If the value is `audio/pcm`, the speech returned is audio/pcm in 16-bit, little-endian format.
+ The following are the accepted values:
+ audio/mpeg
+ audio/ogg
+ audio/pcm
+ audio/\$1 (defaults to mpeg)
+ text/plain; charset=utf-8
Type: String
Length Constraints: Minimum length of 1.
Required: Yes
** clientTimestampMillis **
A timestamp set by the client of the date and time that the event was sent to Amazon Lex V2.
Type: Long
Required: No
** disablePlayback **
Determines whether Amazon Lex V2 should send audio responses to the client application.
Set this field to false when the client is operating in a playback mode where audio responses are played to the user. If the client isn't operating in playback mode, such as a text chat application, set this to true so that Amazon Lex V2 doesn't wait for the prompt to finish playing on the client.
Type: Boolean
Required: No
** eventId **
A unique identifier that your application assigns to the event. You can use this to identify events in logs.
Type: String
Length Constraints: Minimum length of 2. Maximum length of 100.
Pattern: `[0-9a-zA-Z._:-]+`
Required: No
** requestAttributes **
Request-specific information passed between the client application and Amazon Lex V2.
The namespace `x-amz-lex:` is reserved for special attributes. Don't create any request attributes for prefix `x-amz-lex:`.
Type: String to string map
Key Length Constraints: Minimum length of 1.
Required: No
** sessionState **
The state of the user's session with Amazon Lex V2.
Type: [SessionState](API_runtime_SessionState.md) object
Required: No
** welcomeMessages **
A list of messages to send to the user.
If you set the `welcomeMessage` field, you must also set the [https://docs.aws.amazon.com/lexv2/latest/dg/API_runtime_DialogAction.html](https://docs.aws.amazon.com/lexv2/latest/dg/API_runtime_DialogAction.html) structure's [https://docs.aws.amazon.com/lexv2/latest/dg/API_runtime_DialogAction.html#lexv2-Type-runtime_DialogAction-type](https://docs.aws.amazon.com/lexv2/latest/dg/API_runtime_DialogAction.html#lexv2-Type-runtime_DialogAction-type) field.
Type: Array of [Message](API_runtime_Message.md) objects
Array Members: Maximum number of 10 items.
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/runtime.lex.v2-2020-08-07/ConfigurationEvent)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/runtime.lex.v2-2020-08-07/ConfigurationEvent)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/runtime.lex.v2-2020-08-07/ConfigurationEvent)
# DialogAction
The next action that Amazon Lex V2 should take.
## Contents
** type **
The next action that the bot should take in its interaction with the user. The following values are possible:
+ `Close` – Indicates that there will not be a response from the user. For example, the statement "Your order has been placed" does not require a response.
+ `ConfirmIntent` – The next action is asking the user if the intent is complete and ready to be fulfilled. This is a yes/no question such as "Place the order?"
+ `Delegate` – The next action is determined by Amazon Lex V2.
+ `ElicitIntent` – The next action is to elicit an intent from the user.
+ `ElicitSlot` – The next action is to elicit a slot value from the user.
Type: String
Valid Values: `Close | ConfirmIntent | Delegate | ElicitIntent | ElicitSlot | None`
Required: Yes
** slotElicitationStyle **
Configures the slot to use spell-by-letter or spell-by-word style. When you use a style on a slot, users can spell out their input to make it clear to your bot.
+ Spell by letter - "b" "o" "b"
+ Spell by word - "b as in boy" "o as in oscar" "b as in boy"
For more information, see [ Using spelling to enter slot values ](https://docs.aws.amazon.com/lexv2/latest/dg/spelling-styles.html).
Type: String
Valid Values: `Default | SpellByLetter | SpellByWord`
Required: No
** slotToElicit **
The name of the slot that should be elicited from the user.
Type: String
Length Constraints: Minimum length of 1.
Required: No
** subSlotToElicit **
The name of the constituent sub slot of the composite slot specified in slotToElicit that should be elicited from the user.
Type: [ElicitSubSlot](API_runtime_ElicitSubSlot.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/runtime.lex.v2-2020-08-07/DialogAction)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/runtime.lex.v2-2020-08-07/DialogAction)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/runtime.lex.v2-2020-08-07/DialogAction)
# DisconnectionEvent
A notification from the client that it is disconnecting from Amazon Lex V2. Sending a `DisconnectionEvent` event is optional, but can help identify a conversation in logs.
## Contents
** clientTimestampMillis **
A timestamp set by the client of the date and time that the event was sent to Amazon Lex V2.
Type: Long
Required: No
** eventId **
A unique identifier that your application assigns to the event. You can use this to identify events in logs.
Type: String
Length Constraints: Minimum length of 2. Maximum length of 100.
Pattern: `[0-9a-zA-Z._:-]+`
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/runtime.lex.v2-2020-08-07/DisconnectionEvent)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/runtime.lex.v2-2020-08-07/DisconnectionEvent)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/runtime.lex.v2-2020-08-07/DisconnectionEvent)
# DTMFInputEvent
A DTMF character sent from the client application. DTMF characters are typically sent from a phone keypad to represent numbers. For example, you can have Amazon Lex V2 process a credit card number input from a phone.
## Contents
** inputCharacter **
The DTMF character that the user pressed. The allowed characters are A - D, 0 - 9, \$1 and \$1.
Type: String
Length Constraints: Fixed length of 1.
Pattern: `^[A-D0-9#*]{1}$`
Required: Yes
** clientTimestampMillis **
A timestamp set by the client of the date and time that the event was sent to Amazon Lex V2.
Type: Long
Required: No
** eventId **
A unique identifier that your application assigns to the event. You can use this to identify events in logs.
Type: String
Length Constraints: Minimum length of 2. Maximum length of 100.
Pattern: `[0-9a-zA-Z._:-]+`
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/runtime.lex.v2-2020-08-07/DTMFInputEvent)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/runtime.lex.v2-2020-08-07/DTMFInputEvent)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/runtime.lex.v2-2020-08-07/DTMFInputEvent)
# ElicitSubSlot
The specific constituent sub slot of the composite slot to elicit in dialog action.
## Contents
** name **
The name of the slot that should be elicited from the user.
Type: String
Length Constraints: Minimum length of 1.
Required: Yes
** subSlotToElicit **
The field is not supported.
Type: [ElicitSubSlot](#API_runtime_ElicitSubSlot) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/runtime.lex.v2-2020-08-07/ElicitSubSlot)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/runtime.lex.v2-2020-08-07/ElicitSubSlot)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/runtime.lex.v2-2020-08-07/ElicitSubSlot)
# HeartbeatEvent
Event that Amazon Lex V2 sends to indicate that the stream is still open between the client application and Amazon Lex V2
## Contents
** eventId **
A unique identifier of the event sent by Amazon Lex V2. The identifier is in the form `RESPONSE-N`, where N is a number starting with one and incremented for each event sent by Amazon Lex V2 in the current session.
Type: String
Length Constraints: Minimum length of 2. Maximum length of 100.
Pattern: `[0-9a-zA-Z._:-]+`
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/runtime.lex.v2-2020-08-07/HeartbeatEvent)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/runtime.lex.v2-2020-08-07/HeartbeatEvent)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/runtime.lex.v2-2020-08-07/HeartbeatEvent)
# ImageResponseCard
A card that is shown to the user by a messaging platform. You define the contents of the card, the card is displayed by the platform.
When you use a response card, the response from the user is constrained to the text associated with a button on the card.
## Contents
** title **
The title to display on the response card. The format of the title is determined by the platform displaying the response card.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 250.
Required: Yes
** buttons **
A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.
Type: Array of [Button](API_runtime_Button.md) objects
Array Members: Minimum number of 0 items. Maximum number of 5 items.
Required: No
** imageUrl **
The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 250.
Required: No
** subtitle **
The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 250.
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/runtime.lex.v2-2020-08-07/ImageResponseCard)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/runtime.lex.v2-2020-08-07/ImageResponseCard)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/runtime.lex.v2-2020-08-07/ImageResponseCard)
# Intent
The current intent that Amazon Lex V2 is attempting to fulfill.
## Contents
** name **
The name of the intent.
Type: String
Length Constraints: Minimum length of 1.
Required: Yes
** confirmationState **
Indicates whether the intent has been `Confirmed`, `Denied`, or `None` if the confirmation stage has not yet been reached.
Type: String
Valid Values: `Confirmed | Denied | None`
Required: No
** slots **
A map of all of the slots for the intent. The name of the slot maps to the value of the slot. If a slot has not been filled, the value is null.
Type: String to [Slot](API_runtime_Slot.md) object map
Key Length Constraints: Minimum length of 1.
Required: No
** state **
Indicates the fulfillment state for the intent. The meanings of each value are as follows:
+ `Failed` – The bot failed to fulfill the intent.
+ `Fulfilled` – The bot has completed fulfillment of the intent.
+ `FulfillmentInProgress` – The bot is in the middle of fulfilling the intent.
+ `InProgress` – The bot is in the middle of eliciting the slot values that are necessary to fulfill the intent.
+ `ReadyForFulfillment` – The bot has elicited all the slot values for the intent and is ready to fulfill the intent.
+ `Waiting` – The bot is waiting for a response from the user (limited to streaming conversations).
Type: String
Valid Values: `Failed | Fulfilled | InProgress | ReadyForFulfillment | Waiting | FulfillmentInProgress`
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/runtime.lex.v2-2020-08-07/Intent)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/runtime.lex.v2-2020-08-07/Intent)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/runtime.lex.v2-2020-08-07/Intent)
# IntentResultEvent
Contains the current state of the conversation between the client application and Amazon Lex V2.
## Contents
** eventId **
A unique identifier of the event sent by Amazon Lex V2. The identifier is in the form `RESPONSE-N`, where N is a number starting with one and incremented for each event sent by Amazon Lex V2 in the current session.
Type: String
Length Constraints: Minimum length of 2. Maximum length of 100.
Pattern: `[0-9a-zA-Z._:-]+`
Required: No
** inputMode **
Indicates whether the input to the operation was text, speech, or from a touch-tone keypad.
Type: String
Valid Values: `Text | Speech | DTMF`
Required: No
** interpretations **
A list of intents that Amazon Lex V2 determined might satisfy the user's utterance.
Each interpretation includes the intent, a score that indicates how confident Amazon Lex V2 is that the interpretation is the correct one, and an optional sentiment response that indicates the sentiment expressed in the utterance.
Type: Array of [Interpretation](API_runtime_Interpretation.md) objects
Array Members: Maximum number of 5 items.
Required: No
** recognizedBotMember **
The bot member that is processing the intent.
Type: [RecognizedBotMember](API_runtime_RecognizedBotMember.md) object
Required: No
** requestAttributes **
The attributes sent in the request.
Type: String to string map
Key Length Constraints: Minimum length of 1.
Required: No
** sessionId **
The identifier of the session in use.
Type: String
Length Constraints: Minimum length of 2. Maximum length of 100.
Pattern: `[0-9a-zA-Z._:-]+`
Required: No
** sessionState **
The state of the user's session with Amazon Lex V2.
Type: [SessionState](API_runtime_SessionState.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/runtime.lex.v2-2020-08-07/IntentResultEvent)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/runtime.lex.v2-2020-08-07/IntentResultEvent)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/runtime.lex.v2-2020-08-07/IntentResultEvent)
# Interpretation
An object containing information about an intent that Amazon Lex V2 determined might satisfy the user's utterance. The intents are ordered by the confidence score.
## Contents
** intent **
A list of intents that might satisfy the user's utterance. The intents are ordered by the confidence score.
Type: [Intent](API_runtime_Intent.md) object
Required: No
** interpretationSource **
Specifies the service that interpreted the input.
Type: String
Valid Values: `Bedrock | Lex`
Required: No
** nluConfidence **
Determines the threshold where Amazon Lex V2 will insert the `AMAZON.FallbackIntent`, `AMAZON.KendraSearchIntent`, or both when returning alternative intents in a response. `AMAZON.FallbackIntent` and `AMAZON.KendraSearchIntent` are only inserted if they are configured for the bot.
Type: [ConfidenceScore](API_runtime_ConfidenceScore.md) object
Required: No
** sentimentResponse **
The sentiment expressed in an utterance.
When the bot is configured to send utterances to Amazon Comprehend for sentiment analysis, this field contains the result of the analysis.
Type: [SentimentResponse](API_runtime_SentimentResponse.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/runtime.lex.v2-2020-08-07/Interpretation)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/runtime.lex.v2-2020-08-07/Interpretation)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/runtime.lex.v2-2020-08-07/Interpretation)
# Message
Container for text that is returned to the customer..
## Contents
** contentType **
Indicates the type of response.
Type: String
Valid Values: `CustomPayload | ImageResponseCard | PlainText | SSML`
Required: Yes
** content **
The text of the message.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Required: No
** imageResponseCard **
A card that is shown to the user by a messaging platform. You define the contents of the card, the card is displayed by the platform.
When you use a response card, the response from the user is constrained to the text associated with a button on the card.
Type: [ImageResponseCard](API_runtime_ImageResponseCard.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/runtime.lex.v2-2020-08-07/Message)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/runtime.lex.v2-2020-08-07/Message)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/runtime.lex.v2-2020-08-07/Message)
# PlaybackCompletionEvent
Event sent from the client application to Amazon Lex V2 to indicate that playback of audio is complete and that Amazon Lex V2 should start processing the user's input.
## Contents
** clientTimestampMillis **
A timestamp set by the client of the date and time that the event was sent to Amazon Lex V2.
Type: Long
Required: No
** eventId **
A unique identifier that your application assigns to the event. You can use this to identify events in logs.
Type: String
Length Constraints: Minimum length of 2. Maximum length of 100.
Pattern: `[0-9a-zA-Z._:-]+`
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/runtime.lex.v2-2020-08-07/PlaybackCompletionEvent)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/runtime.lex.v2-2020-08-07/PlaybackCompletionEvent)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/runtime.lex.v2-2020-08-07/PlaybackCompletionEvent)
# PlaybackInterruptionEvent
Event sent from Amazon Lex V2 to indicate to the client application should stop playback of audio. For example, if the client is playing a prompt that asks for the user's telephone number, the user might start to say the phone number before the prompt is complete. Amazon Lex V2 sends this event to the client application to indicate that the user is responding and that Amazon Lex V2 is processing their input.
## Contents
** causedByEventId **
The identifier of the event that contained the audio, DTMF, or text that caused the interruption.
Type: String
Length Constraints: Minimum length of 2. Maximum length of 100.
Pattern: `[0-9a-zA-Z._:-]+`
Required: No
** eventId **
A unique identifier of the event sent by Amazon Lex V2. The identifier is in the form `RESPONSE-N`, where N is a number starting with one and incremented for each event sent by Amazon Lex V2 in the current session.
Type: String
Length Constraints: Minimum length of 2. Maximum length of 100.
Pattern: `[0-9a-zA-Z._:-]+`
Required: No
** eventReason **
Indicates the type of user input that Amazon Lex V2 detected.
Type: String
Valid Values: `DTMF_START_DETECTED | TEXT_DETECTED | VOICE_START_DETECTED`
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/runtime.lex.v2-2020-08-07/PlaybackInterruptionEvent)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/runtime.lex.v2-2020-08-07/PlaybackInterruptionEvent)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/runtime.lex.v2-2020-08-07/PlaybackInterruptionEvent)
# RecognizedBotMember
The bot member that processes the request.
## Contents
** botId **
The identifier of the bot member that processes the request.
Type: String
Length Constraints: Fixed length of 10.
Pattern: `^[0-9a-zA-Z]+$`
Required: Yes
** botName **
The name of the bot member that processes the request.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern: `^([0-9a-zA-Z][_-]?)+$`
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/runtime.lex.v2-2020-08-07/RecognizedBotMember)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/runtime.lex.v2-2020-08-07/RecognizedBotMember)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/runtime.lex.v2-2020-08-07/RecognizedBotMember)
# RuntimeHintDetails
Provides an array of phrases that should be given preference when resolving values for a slot.
## Contents
** runtimeHintValues **
One or more strings that Amazon Lex V2 should look for in the input to the bot. Each phrase is given preference when deciding on slot values.
Type: Array of [RuntimeHintValue](API_runtime_RuntimeHintValue.md) objects
Array Members: Minimum number of 1 item. Maximum number of 100 items.
Required: No
** subSlotHints **
A map of constituent sub slot names inside a composite slot in the intent and the phrases that should be added for each sub slot. Inside each composite slot hints, this structure provides a mechanism to add granular sub slot phrases. Only sub slot hints are supported for composite slots. The intent name, composite slot name and the constituent sub slot names must exist.
Type: String to [RuntimeHintDetails](#API_runtime_RuntimeHintDetails) object map
Key Length Constraints: Minimum length of 1. Maximum length of 100.
Key Pattern: `^([0-9a-zA-Z][_-]?)+$`
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/runtime.lex.v2-2020-08-07/RuntimeHintDetails)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/runtime.lex.v2-2020-08-07/RuntimeHintDetails)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/runtime.lex.v2-2020-08-07/RuntimeHintDetails)
# RuntimeHints
You can provide Amazon Lex V2 with hints to the phrases that a customer is likely to use for a slot. When a slot with hints is resolved, the phrases in the runtime hints are preferred in the resolution. You can provide hints for a maximum of 100 intents. You can provide a maximum of 100 slots.
Before you can use runtime hints with an existing bot, you must first rebuild the bot.
For more information, see [Using runtime hints to improve recognition of slot values](https://docs.aws.amazon.com/lexv2/latest/dg/using-hints.html).
## Contents
** slotHints **
A list of the slots in the intent that should have runtime hints added, and the phrases that should be added for each slot.
The first level of the `slotHints` map is the name of the intent. The second level is the name of the slot within the intent. For more information, see [Using hints to improve accuracy](https://docs.aws.amazon.com/lexv2/latest/dg/using-hints.html).
The intent name and slot name must exist.
Type: String to string to [RuntimeHintDetails](API_runtime_RuntimeHintDetails.md) object map map
Key Length Constraints: Minimum length of 1. Maximum length of 100.
Key Pattern: `^([0-9a-zA-Z][_-]?)+$`
Key Length Constraints: Minimum length of 1. Maximum length of 100.
Key Pattern: `^([0-9a-zA-Z][_-]?)+$`
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/runtime.lex.v2-2020-08-07/RuntimeHints)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/runtime.lex.v2-2020-08-07/RuntimeHints)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/runtime.lex.v2-2020-08-07/RuntimeHints)
# RuntimeHintValue
Provides the phrase that Amazon Lex V2 should look for in the user's input to the bot.
## Contents
** phrase **
The phrase that Amazon Lex V2 should look for in the user's input to the bot.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 140.
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/runtime.lex.v2-2020-08-07/RuntimeHintValue)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/runtime.lex.v2-2020-08-07/RuntimeHintValue)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/runtime.lex.v2-2020-08-07/RuntimeHintValue)
# SentimentResponse
Provides information about the sentiment expressed in a user's response in a conversation. Sentiments are determined using Amazon Comprehend. Sentiments are only returned if they are enabled for the bot.
For more information, see [ Determine Sentiment ](https://docs.aws.amazon.com/comprehend/latest/dg/how-sentiment.html) in the *Amazon Comprehend developer guide*.
## Contents
** sentiment **
The overall sentiment expressed in the user's response. This is the sentiment most likely expressed by the user based on the analysis by Amazon Comprehend.
Type: String
Valid Values: `MIXED | NEGATIVE | NEUTRAL | POSITIVE`
Required: No
** sentimentScore **
The individual sentiment responses for the utterance.
Type: [SentimentScore](API_runtime_SentimentScore.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/runtime.lex.v2-2020-08-07/SentimentResponse)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/runtime.lex.v2-2020-08-07/SentimentResponse)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/runtime.lex.v2-2020-08-07/SentimentResponse)
# SentimentScore
The individual sentiment responses for the utterance.
## Contents
** mixed **
The level of confidence that Amazon Comprehend has in the accuracy of its detection of the `MIXED` sentiment.
Type: Double
Required: No
** negative **
The level of confidence that Amazon Comprehend has in the accuracy of its detection of the `NEGATIVE` sentiment.
Type: Double
Required: No
** neutral **
The level of confidence that Amazon Comprehend has in the accuracy of its detection of the `NEUTRAL` sentiment.
Type: Double
Required: No
** positive **
The level of confidence that Amazon Comprehend has in the accuracy of its detection of the `POSITIVE` sentiment.
Type: Double
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/runtime.lex.v2-2020-08-07/SentimentScore)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/runtime.lex.v2-2020-08-07/SentimentScore)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/runtime.lex.v2-2020-08-07/SentimentScore)
# SessionState
The state of the user's session with Amazon Lex V2.
## Contents
** activeContexts **
One or more contexts that indicate to Amazon Lex V2 the context of a request. When a context is active, Amazon Lex V2 considers intents with the matching context as a trigger as the next intent in a session.
Type: Array of [ActiveContext](API_runtime_ActiveContext.md) objects
Array Members: Minimum number of 0 items. Maximum number of 20 items.
Required: No
** dialogAction **
The next step that Amazon Lex V2 should take in the conversation with a user.
Type: [DialogAction](API_runtime_DialogAction.md) object
Required: No
** intent **
The active intent that Amazon Lex V2 is processing.
Type: [Intent](API_runtime_Intent.md) object
Required: No
** originatingRequestId **
A unique identifier for a specific request.
Type: String
Length Constraints: Minimum length of 1.
Required: No
** runtimeHints **
Hints for phrases that a customer is likely to use for a slot. Amazon Lex V2 uses the hints to help determine the correct value of a slot.
Type: [RuntimeHints](API_runtime_RuntimeHints.md) object
Required: No
** sessionAttributes **
Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex V2 and a client application.
Type: String to string map
Key Length Constraints: Minimum length of 1.
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/runtime.lex.v2-2020-08-07/SessionState)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/runtime.lex.v2-2020-08-07/SessionState)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/runtime.lex.v2-2020-08-07/SessionState)
# Slot
A value that Amazon Lex V2 uses to fulfill an intent.
## Contents
** shape **
When the `shape` value is `List`, it indicates that the `values` field contains a list of slot values. When the value is `Scalar`, it indicates that the `value` field contains a single value.
Type: String
Valid Values: `Scalar | List | Composite`
Required: No
** subSlots **
The constituent sub slots of a composite slot.
Type: String to [Slot](#API_runtime_Slot) object map
Key Length Constraints: Minimum length of 1.
Required: No
** value **
The current value of the slot.
Type: [Value](API_runtime_Value.md) object
Required: No
** values **
A list of one or more values that the user provided for the slot. For example, if a for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
Type: Array of [Slot](#API_runtime_Slot) objects
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/runtime.lex.v2-2020-08-07/Slot)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/runtime.lex.v2-2020-08-07/Slot)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/runtime.lex.v2-2020-08-07/Slot)
# StartConversationRequestEventStream
Represents a stream of events between your application and Amazon Lex V2.
## Contents
** AudioInputEvent **
Speech audio sent from your client application to Amazon Lex V2. Audio starts accumulating when Amazon Lex V2 identifies a voice and continues until a natural pause in the speech is found before processing.
Type: [AudioInputEvent](API_runtime_AudioInputEvent.md) object
Required: No
** ConfigurationEvent **
Configuration information sent from your client application to Amazon Lex V2
Type: [ConfigurationEvent](API_runtime_ConfigurationEvent.md) object
Required: No
** DisconnectionEvent **
Event sent from the client application to indicate to Amazon Lex V2 that the conversation is over.
Type: [DisconnectionEvent](API_runtime_DisconnectionEvent.md) object
Required: No
** DTMFInputEvent **
DTMF information sent to Amazon Lex V2 by your application. Amazon Lex V2 accumulates the DMTF information from when the user sends the first character and ends
+ when there's a pause longer that the value configured for the end timeout.
+ when there's a digit that is the configured end character.
+ when Amazon Lex V2 accumulates characters equal to the maximum DTMF character configuration.
Type: [DTMFInputEvent](API_runtime_DTMFInputEvent.md) object
Required: No
** PlaybackCompletionEvent **
Event sent from the client application to Amazon Lex V2 to indicate that it has finished playing audio and that Amazon Lex V2 should start listening for user input.
Type: [PlaybackCompletionEvent](API_runtime_PlaybackCompletionEvent.md) object
Required: No
** TextInputEvent **
Text sent from your client application to Amazon Lex V2. Each `TextInputEvent` is processed individually.
Type: [TextInputEvent](API_runtime_TextInputEvent.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/runtime.lex.v2-2020-08-07/StartConversationRequestEventStream)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/runtime.lex.v2-2020-08-07/StartConversationRequestEventStream)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/runtime.lex.v2-2020-08-07/StartConversationRequestEventStream)
# StartConversationResponseEventStream
Represents a stream of events between Amazon Lex V2 and your application.
## Contents
** AccessDeniedException **
Exception thrown when the credentials passed with the request are invalid or expired. Also thrown when the credentials in the request do not have permission to access the `StartConversation` operation.
Type: Exception
HTTP Status Code: 403
Required: No
** AudioResponseEvent **
An event sent from Amazon Lex V2 to your client application containing audio to play to the user.
Type: [AudioResponseEvent](API_runtime_AudioResponseEvent.md) object
Required: No
** BadGatewayException **
Type: Exception
HTTP Status Code: 502
Required: No
** ConflictException **
Exception thrown when two clients are using the same AWS account, Amazon Lex V2 bot, and session ID.
Type: Exception
HTTP Status Code: 409
Required: No
** DependencyFailedException **
Type: Exception
HTTP Status Code: 424
Required: No
** HeartbeatEvent **
Event that Amazon Lex V2 sends to indicate that the stream is still open between the client application and Amazon Lex V2
Type: [HeartbeatEvent](API_runtime_HeartbeatEvent.md) object
Required: No
** IntentResultEvent **
Event sent from Amazon Lex V2 to the client application containing the current state of the conversation between the user and Amazon Lex V2.
Type: [IntentResultEvent](API_runtime_IntentResultEvent.md) object
Required: No
** InternalServerException **
An error occurred with Amazon Lex V2.
Type: Exception
HTTP Status Code: 500
Required: No
** PlaybackInterruptionEvent **
Event sent from Amazon Lex V2 to indicate to the client application should stop playback of audio. For example, if the client is playing a prompt that asks for the user's telephone number, the user might start to say the phone number before the prompt is complete. Amazon Lex V2 sends this event to the client application to indicate that the user is responding and that Amazon Lex V2 is processing their input.
Type: [PlaybackInterruptionEvent](API_runtime_PlaybackInterruptionEvent.md) object
Required: No
** ResourceNotFoundException **
Exception thrown if one of the input parameters points to a resource that does not exist. For example, if the bot ID specified does not exist.
Type: Exception
HTTP Status Code: 404
Required: No
** TextResponseEvent **
The event sent from Amazon Lex V2 to your application with text to present to the user.
Type: [TextResponseEvent](API_runtime_TextResponseEvent.md) object
Required: No
** ThrottlingException **
Exception thrown when your application exceeds the maximum number of concurrent requests.
Type: Exception
HTTP Status Code: 429
Required: No
** TranscriptEvent **
Event sent from Amazon Lex V2 to your client application that contains a transcript of voice audio.
Type: [TranscriptEvent](API_runtime_TranscriptEvent.md) object
Required: No
** ValidationException **
Exception thrown when one or more parameters could not be validated. The `message` contains the name of the field that isn't valid.
Type: Exception
HTTP Status Code: 400
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/runtime.lex.v2-2020-08-07/StartConversationResponseEventStream)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/runtime.lex.v2-2020-08-07/StartConversationResponseEventStream)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/runtime.lex.v2-2020-08-07/StartConversationResponseEventStream)
# TextInputEvent
The event sent from your client application to Amazon Lex V2 with text input from the user.
## Contents
** text **
The text from the user. Amazon Lex V2 processes this as a complete statement.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Required: Yes
** clientTimestampMillis **
A timestamp set by the client of the date and time that the event was sent to Amazon Lex V2.
Type: Long
Required: No
** eventId **
A unique identifier that your application assigns to the event. You can use this to identify events in logs.
Type: String
Length Constraints: Minimum length of 2. Maximum length of 100.
Pattern: `[0-9a-zA-Z._:-]+`
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/runtime.lex.v2-2020-08-07/TextInputEvent)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/runtime.lex.v2-2020-08-07/TextInputEvent)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/runtime.lex.v2-2020-08-07/TextInputEvent)
# TextResponseEvent
The event sent from Amazon Lex V2 to your application with text to present to the user.
## Contents
** eventId **
A unique identifier of the event sent by Amazon Lex V2. The identifier is in the form `RESPONSE-N`, where N is a number starting with one and incremented for each event sent by Amazon Lex V2 in the current session.
Type: String
Length Constraints: Minimum length of 2. Maximum length of 100.
Pattern: `[0-9a-zA-Z._:-]+`
Required: No
** messages **
A list of messages to send to the user. Messages are ordered based on the order that you returned the messages from your Lambda function or the order that the messages are defined in the bot.
Type: Array of [Message](API_runtime_Message.md) objects
Array Members: Maximum number of 10 items.
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/runtime.lex.v2-2020-08-07/TextResponseEvent)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/runtime.lex.v2-2020-08-07/TextResponseEvent)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/runtime.lex.v2-2020-08-07/TextResponseEvent)
# TranscriptEvent
Event sent from Amazon Lex V2 to your client application that contains a transcript of voice audio.
## Contents
** eventId **
A unique identifier of the event sent by Amazon Lex V2. The identifier is in the form `RESPONSE-N`, where N is a number starting with one and incremented for each event sent by Amazon Lex V2 in the current session.
Type: String
Length Constraints: Minimum length of 2. Maximum length of 100.
Pattern: `[0-9a-zA-Z._:-]+`
Required: No
** transcript **
The transcript of the voice audio from the user.
Type: String
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/runtime.lex.v2-2020-08-07/TranscriptEvent)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/runtime.lex.v2-2020-08-07/TranscriptEvent)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/runtime.lex.v2-2020-08-07/TranscriptEvent)
# Value
Information about the value provided for a slot and Amazon Lex V2's interpretation.
## Contents
** interpretedValue **
The value that Amazon Lex V2 determines for the slot, given the user input. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex V2 choose the first value in the `resolvedValues` list.
Type: String
Length Constraints: Minimum length of 1.
Required: Yes
** originalValue **
The part of the user's response to the slot elicitation that Amazon Lex V2 determines is relevant to the slot value.
Type: String
Length Constraints: Minimum length of 1.
Required: No
** resolvedValues **
A list of values that Amazon Lex V2 determines are possible resolutions for the user input. The first value matches the `interpretedValue`.
Type: Array of strings
Length Constraints: Minimum length of 1.
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/runtime.lex.v2-2020-08-07/Value)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/runtime.lex.v2-2020-08-07/Value)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/runtime.lex.v2-2020-08-07/Value)
# Common Parameters
The following list contains the parameters that all actions use for signing Signature Version 4 requests with a query string. Any action-specific parameters are listed in the topic for that action. For more information about Signature Version 4, see [Signing AWS API requests](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html) in the *IAM User Guide*.
**X-Amz-Algorithm**
The hash algorithm that you used to create the request signature.
Condition: Specify this parameter when you include authentication information in a query string instead of in the HTTP authorization header.
Type: string
Valid Values: `AWS4-HMAC-SHA256`
Required: Conditional
**X-Amz-Credential**
The credential scope value, which is a string that includes your access key, the date, the region you are targeting, the service you are requesting, and a termination string ("aws4\$1request"). The value is expressed in the following format: *access\$1key*/*YYYYMMDD*/*region*/*service*/aws4\$1request.
For more information, see [Create a signed AWS API request](https://docs.aws.amazon.com/IAM/latest/UserGuide/create-signed-request.html) in the *IAM User Guide*.
Condition: Specify this parameter when you include authentication information in a query string instead of in the HTTP authorization header.
Type: string
Required: Conditional
**X-Amz-Date**
The date that is used to create the signature. The format must be ISO 8601 basic format (YYYYMMDD'T'HHMMSS'Z'). For example, the following date time is a valid X-Amz-Date value: `20120325T120000Z`.
Condition: X-Amz-Date is optional for all requests; it can be used to override the date used for signing requests. If the Date header is specified in the ISO 8601 basic format, X-Amz-Date is not required. When X-Amz-Date is used, it always overrides the value of the Date header. For more information, see [Elements of an AWS API request signature](https://docs.aws.amazon.com/IAM/latest/UserGuide/signing-elements.html) in the *IAM User Guide*.
Type: string
Required: Conditional
**X-Amz-Security-Token**
The temporary security token that was obtained through a call to AWS Security Token Service (AWS STS). For a list of services that support temporary security credentials from AWS STS, see [AWS services that work with IAM](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-services-that-work-with-iam.html) in the *IAM User Guide*.
Condition: If you're using temporary security credentials from AWS STS, you must include the security token.
Type: string
Required: Conditional
**X-Amz-Signature**
Specifies the hex-encoded signature that was calculated from the string to sign and the derived signing key.
Condition: Specify this parameter when you include authentication information in a query string instead of in the HTTP authorization header.
Type: string
Required: Conditional
**X-Amz-SignedHeaders**
Specifies all the HTTP headers that were included as part of the canonical request. For more information about specifying signed headers, see [Create a signed AWS API request](https://docs.aws.amazon.com/IAM/latest/UserGuide/create-signed-request.html) in the *IAM User Guide*.
Condition: Specify this parameter when you include authentication information in a query string instead of in the HTTP authorization header.
Type: string
Required: Conditional
# Common Error Types
This section lists common error types that this AWS service may return. Not all services return all error types listed here. For errors specific to an API action for this service, see the topic for that API action.
**AccessDeniedException**
You don't have permission to perform this action. Verify that your IAM policy includes the required permissions.
HTTP Status Code: 403
**ExpiredTokenException**
The security token included in the request has expired. Request a new security token and try again.
HTTP Status Code: 403
**IncompleteSignature**
The request signature doesn't conform to AWS standards. Verify that you're using valid AWS credentials and that your request is properly formatted. If you're using an SDK, ensure it's up to date.
HTTP Status Code: 403
**InternalFailure**
The request can't be processed right now because of an internal server issue. Try again later. If the problem persists, contact AWS Support.
HTTP Status Code: 500
**MalformedHttpRequestException**
The request body can't be processed. This typically happens when the request body can't be decompressed using the specified content encoding algorithm. Verify that the content encoding header matches the compression format used.
HTTP Status Code: 400
**NotAuthorized**
You don't have permissions to perform this action. Verify that your IAM policy includes the required permissions.
HTTP Status Code: 401
**OptInRequired**
Your AWS account needs a subscription for this service. Verify that you've enabled the service in your account.
HTTP Status Code: 403
**RequestAbortedException**
The request was aborted before a response could be returned. This typically happens when the client closes the connection.
HTTP Status Code: 400
**RequestEntityTooLargeException**
The request entity is too large. Reduce the size of the request body and try again.
HTTP Status Code: 413
**RequestTimeoutException**
The request timed out. The server didn't receive the complete request within the expected time frame. Try again.
HTTP Status Code: 408
**ServiceUnavailable**
The service is temporarily unavailable. Try again later.
HTTP Status Code: 503
**ThrottlingException**
Your request rate is too high. The AWS SDKs automatically retry requests that receive this exception. Reduce the frequency of requests.
HTTP Status Code: 400
**UnknownOperationException**
The action or operation isn't recognized. Verify that the action name is spelled correctly and that it's supported by the API version you're using.
HTTP Status Code: 404
**UnrecognizedClientException**
The X.509 certificate or AWS access key ID you provided doesn't exist in our records. Verify that you're using valid credentials and that they haven't expired.
HTTP Status Code: 403
**ValidationError**
The input doesn't meet the required format or constraints. Check that all required parameters are included and that values are valid.
HTTP Status Code: 400