Note: You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . lexv2-models ]

create-bot-locale

Description

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.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  create-bot-locale
--bot-id <value>
--bot-version <value>
--locale-id <value>
[--description <value>]
--nlu-intent-confidence-threshold <value>
[--voice-settings <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--bot-id (string)

The identifier of the bot to create the locale for.

--bot-version (string)

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

--locale-id (string)

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 Supported languages .

--description (string)

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

--nlu-intent-confidence-threshold (double)

Determines the threshold where Amazon Lex will insert the AMAZON.FallbackIntent , AMAZON.KendraSearchIntent , or both when returning alternative intents. AMAZON.FallbackIntent and AMAZON.KendraSearchIntent are only inserted if they are configured for the bot.

For example, suppose a bot is configured with the confidence threshold of 0.80 and the AMAZON.FallbackIntent . Amazon Lex returns three alternative intents with the following confidence scores: IntentA (0.70), IntentB (0.60), IntentC (0.50). The response from the RecognizeText operation would be:

  • AMAZON.FallbackIntent
  • IntentA
  • IntentB
  • IntentC

--voice-settings (structure)

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

voiceId -> (string)

The identifier of the Amazon Polly voice to use.

engine -> (string)

Indicates the type of Amazon Polly voice that Amazon Lex should use for voice interaction with the user. For more information, see the ` engine parameter of the SynthesizeSpeech operation <https://docs.aws.amazon.com/polly/latest/dg/API_SynthesizeSpeech.html#polly-SynthesizeSpeech-request-Engine>`__ in the Amazon Polly developer guide .

If you do not specify a value, the default is standard .

Shorthand Syntax:

voiceId=string,engine=string

JSON Syntax:

{
  "voiceId": "string",
  "engine": "standard"|"neural"
}

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.

Output

botId -> (string)

The specified bot identifier.

botVersion -> (string)

The specified bot version.

localeName -> (string)

The specified locale name.

localeId -> (string)

The specified locale identifier.

description -> (string)

The specified description of the bot locale.

nluIntentConfidenceThreshold -> (double)

The specified confidence threshold for inserting the AMAZON.FallbackIntent and AMAZON.KendraSearchIntent intents.

voiceSettings -> (structure)

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

voiceId -> (string)

The identifier of the Amazon Polly voice to use.

engine -> (string)

Indicates the type of Amazon Polly voice that Amazon Lex should use for voice interaction with the user. For more information, see the ` engine parameter of the SynthesizeSpeech operation <https://docs.aws.amazon.com/polly/latest/dg/API_SynthesizeSpeech.html#polly-SynthesizeSpeech-request-Engine>`__ in the Amazon Polly developer guide .

If you do not specify a value, the default is standard .

botLocaleStatus -> (string)

The status of the bot.

When the status is Creating the bot locale is being configured. When the status is Building Amazon Lex is building the bot for testing and use.

If the status of the bot is ReadyExpressTesting , 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 Built .

If there was a problem with building the bot, the status is Failed . If the bot was saved but not built, the status is NotBuilt .

creationDateTime -> (timestamp)

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