Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-14107861793.8 KB

Describes the settings that a bot has for a specific locale.

get/bots/{botId}/botversions/{botVersion}/botlocales/{localeId}/

Path parameters

botIdstring required

The identifier of the bot associated with the locale.

botVersionstring required

The version of the bot associated with the locale.

localeIdstring required

The unique identifier of the locale to describe. The string must match one of the supported locales. For more information, see <a href="https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html">Supported languages</a>.

Response

Success

botIdstring

The identifier of the bot associated with the locale.

botVersionstring

The version of the bot associated with the locale.

localeIdstring

The unique identifier of the described locale.

localeNamestring

The name of the locale.

descriptionstring

The description of the locale.

nluIntentConfidenceThresholdnumber double

The confidence threshold where Amazon Lex inserts the <code>AMAZON.FallbackIntent</code> and <code>AMAZON.KendraSearchIntent</code> intents in the list of possible intents for an utterance.

intentsCountinteger

The number of intents defined for the locale.

slotTypesCountinteger

The number of slot types defined for the locale.

botLocaleStatus'Creating' | 'Building' | 'Built' | 'ReadyExpressTesting' | 'Failed' | 'Deleting' | 'NotBuilt' | 'Importing' | 'Processing'

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

failureReasonsFailureReason[]

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

creationDateTimestring date-time

The date and time that the locale was created.

lastUpdatedDateTimestring date-time

The date and time that the locale was last updated.

lastBuildSubmittedDateTimestring date-time

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

recommendedActionsRecommendedAction[]

Recommended actions to take to resolve an error in the <code>failureReasons</code> field.

speechDetectionSensitivity'Default' | 'HighNoiseTolerance' | 'MaximumNoiseTolerance'

The sensitivity level for voice activity detection (VAD) configured for the bot locale.