Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1471501483.8 KB

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.

put/bots/{botId}/botversions/{botVersion}/botlocales/

Path parameters

botIdstring required

The identifier of the bot to create the locale for.

botVersionstring required

The version of the bot to create the locale for. This can only be the draft version of the bot.

Request body

localeIdstring required

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 <a href="https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html">Supported languages</a>.

descriptionstring

A description of the bot locale. Use this to help identify the bot locale in lists.

nluIntentConfidenceThresholdnumber double required
<p>Determines the threshold where Amazon Lex will insert the <code>AMAZON.FallbackIntent</code>, <code>AMAZON.KendraSearchIntent</code>, or both when returning alternative intents. <code>AMAZON.FallbackIntent</code> and <code>AMAZON.KendraSearchIntent</code> are only inserted if they are configured for the bot.</p> <p>For example, suppose a bot is configured with the confidence threshold of 0.80 and the <code>AMAZON.FallbackIntent</code>. Amazon Lex returns three alternative intents with the following confidence scores: IntentA (0.70), IntentB (0.60), IntentC (0.50). The response from the <code>RecognizeText</code> operation would be:</p> <ul> <li> <p>AMAZON.FallbackIntent</p> </li> <li> <p>IntentA</p> </li> <li> <p>IntentB</p> </li> <li> <p>IntentC</p> </li> </ul>

Response

Success

botIdstring

The specified bot identifier.

botVersionstring

The specified bot version.

localeNamestring

The specified locale name.

localeIdstring

The specified locale identifier.

descriptionstring

The specified description of the bot locale.

nluIntentConfidenceThresholdnumber double

The specified confidence threshold for inserting the <code>AMAZON.FallbackIntent</code> and <code>AMAZON.KendraSearchIntent</code> intents.

botLocaleStatus'Creating' | 'Building' | 'Built' | 'ReadyExpressTesting' | 'Failed' | 'Deleting' | 'NotBuilt' | 'Importing' | 'Processing'
<p>The status of the bot.</p> <p>When the status is <code>Creating</code> the bot locale is being configured. When the status is <code>Building</code> Amazon Lex is building the bot for testing and use.</p> <p>If the status of the bot is <code>ReadyExpressTesting</code>, 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 <code>Built</code>.</p> <p>If there was a problem with building the bot, the status is <code>Failed</code>. If the bot was saved but not built, the status is <code>NotBuilt</code>.</p>
creationDateTimestring date-time

A timestamp specifying the date and time that the bot locale was created.