Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

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

The identifier of the bot associated with the locale.

Length Constraints: Fixed length of 10.

Pattern: ^[0-9a-zA-Z]+$

Required: Yes

botVersion

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

The unique identifier of the locale to describe. The string must match one of the supported locales. For more information, see Supported languages.

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": { 
         "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,
   "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

The identifier of the bot associated with the locale.

Type: String

Length Constraints: Fixed length of 10.

Pattern: ^[0-9a-zA-Z]+$

botLocaleHistoryEvents

History of changes, such as when a locale is used in an alias, that have taken place for the locale.

Type: Array of BotLocaleHistoryEvent objects

botLocaleStatus

The status of the bot. If the status is Failed, the reasons for the failure are listed in the failureReasons field.

Type: String

botVersion

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

The date and time that the locale was created.

Type: Timestamp

description

The description of the locale.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 200.

failureReasons

if botLocaleStatus is Failed, Amazon Lex explains why it failed to build the bot.

Type: Array of strings

generativeAISettings

Contains settings for Amazon Bedrock's generative AI features for your bot locale.

Type: GenerativeAISettings object

intentsCount

The number of intents defined for the locale.

Type: Integer

lastBuildSubmittedDateTime

The date and time that the locale was last submitted for building.

Type: Timestamp

lastUpdatedDateTime

The date and time that the locale was last updated.

Type: Timestamp

localeId

The unique identifier of the described locale.

Type: String

localeName

The name of the locale.

Type: String

nluIntentConfidenceThreshold

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

Recommended actions to take to resolve an error in the failureReasons field.

Type: Array of strings

slotTypesCount

The number of slot types defined for the locale.

Type: Integer

voiceSettings

The Amazon Polly voice Amazon Lex uses for voice interaction with the user.

Type: VoiceSettings object

Errors

For information about the errors that are common to all actions, see Common Errors.

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.

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