DescribeBotLocale - Amazon Lex

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 identifier of 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" ], "intentsCount": number, "lastBuildSubmittedDateTime": number, "lastUpdatedDateTime": number, "localeId": "string", "localeName": "string", "nluIntentConfidenceThreshold": number, "slotTypesCount": number, "voiceSettings": { "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

Valid Values: Creating | Building | Built | ReadyExpressTesting | Failed | Deleting | NotBuilt | Importing

botVersion

The identifier of 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

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.

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

HTTP Status Code: 500

ResourceNotFoundException

HTTP Status Code: 404

ServiceQuotaExceededException

HTTP Status Code: 402

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: