# 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) **   <a name="lexv2-DescribeBotLocale-request-uri-botId"></a>
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) **   <a name="lexv2-DescribeBotLocale-request-uri-botVersion"></a>
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) **   <a name="lexv2-DescribeBotLocale-request-uri-localeId"></a>
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) **   <a name="lexv2-DescribeBotLocale-response-botId"></a>
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) **   <a name="lexv2-DescribeBotLocale-response-botLocaleHistoryEvents"></a>
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) **   <a name="lexv2-DescribeBotLocale-response-botLocaleStatus"></a>
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) **   <a name="lexv2-DescribeBotLocale-response-botVersion"></a>
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) **   <a name="lexv2-DescribeBotLocale-response-creationDateTime"></a>
The date and time that the locale was created.  
Type: Timestamp

 ** [description](#API_DescribeBotLocale_ResponseSyntax) **   <a name="lexv2-DescribeBotLocale-response-description"></a>
The description of the locale.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 2000.

 ** [failureReasons](#API_DescribeBotLocale_ResponseSyntax) **   <a name="lexv2-DescribeBotLocale-response-failureReasons"></a>
if `botLocaleStatus` is `Failed`, Amazon Lex explains why it failed to build the bot.  
Type: Array of strings

 ** [generativeAISettings](#API_DescribeBotLocale_ResponseSyntax) **   <a name="lexv2-DescribeBotLocale-response-generativeAISettings"></a>
Contains settings for Amazon Bedrock's generative AI features for your bot locale.  
Type: [GenerativeAISettings](API_GenerativeAISettings.md) object

 ** [intentsCount](#API_DescribeBotLocale_ResponseSyntax) **   <a name="lexv2-DescribeBotLocale-response-intentsCount"></a>
The number of intents defined for the locale.  
Type: Integer

 ** [lastBuildSubmittedDateTime](#API_DescribeBotLocale_ResponseSyntax) **   <a name="lexv2-DescribeBotLocale-response-lastBuildSubmittedDateTime"></a>
The date and time that the locale was last submitted for building.  
Type: Timestamp

 ** [lastUpdatedDateTime](#API_DescribeBotLocale_ResponseSyntax) **   <a name="lexv2-DescribeBotLocale-response-lastUpdatedDateTime"></a>
The date and time that the locale was last updated.  
Type: Timestamp

 ** [localeId](#API_DescribeBotLocale_ResponseSyntax) **   <a name="lexv2-DescribeBotLocale-response-localeId"></a>
The unique identifier of the described locale.  
Type: String

 ** [localeName](#API_DescribeBotLocale_ResponseSyntax) **   <a name="lexv2-DescribeBotLocale-response-localeName"></a>
The name of the locale.  
Type: String

 ** [nluIntentConfidenceThreshold](#API_DescribeBotLocale_ResponseSyntax) **   <a name="lexv2-DescribeBotLocale-response-nluIntentConfidenceThreshold"></a>
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) **   <a name="lexv2-DescribeBotLocale-response-recommendedActions"></a>
Recommended actions to take to resolve an error in the `failureReasons` field.  
Type: Array of strings

 ** [slotTypesCount](#API_DescribeBotLocale_ResponseSyntax) **   <a name="lexv2-DescribeBotLocale-response-slotTypesCount"></a>
The number of slot types defined for the locale.  
Type: Integer

 ** [speechDetectionSensitivity](#API_DescribeBotLocale_ResponseSyntax) **   <a name="lexv2-DescribeBotLocale-response-speechDetectionSensitivity"></a>
The sensitivity level for voice activity detection (VAD) configured for the bot locale.  
Type: String  
Valid Values: `Default | HighNoiseTolerance | MaximumNoiseTolerance` 

 ** [speechRecognitionSettings](#API_DescribeBotLocale_ResponseSyntax) **   <a name="lexv2-DescribeBotLocale-response-speechRecognitionSettings"></a>
The speech-to-text settings configured for the bot locale.  
Type: [SpeechRecognitionSettings](API_SpeechRecognitionSettings.md) object

 ** [unifiedSpeechSettings](#API_DescribeBotLocale_ResponseSyntax) **   <a name="lexv2-DescribeBotLocale-response-unifiedSpeechSettings"></a>
The unified speech settings configured for the bot locale.  
Type: [UnifiedSpeechSettings](API_UnifiedSpeechSettings.md) object

 ** [voiceSettings](#API_DescribeBotLocale_ResponseSyntax) **   <a name="lexv2-DescribeBotLocale-response-voiceSettings"></a>
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)