[ aws . lexv2-models ]

update-bot-locale

Description

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

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

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

Options

--bot-id (string)

The unique identifier of the bot that contains the locale.

--bot-version (string)

The version of the bot that contains the locale to be updated. The version can only be the DRAFT version.

--locale-id (string)

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

--description (string)

The new description of the locale.

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

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

--voice-settings (structure)

The new Amazon Polly voice Amazon Lex should use 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 | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those 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. This may not be specified along with --cli-input-yaml.

--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. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

See ‘aws help’ for descriptions of global parameters.

Output

botId -> (string)

The identifier of the bot that contains the updated locale.

botVersion -> (string)

The version of the bot that contains the updated locale.

localeId -> (string)

The language and locale of the updated bot locale.

localeName -> (string)

The updated locale name for the locale.

description -> (string)

The updated description of the locale.

nluIntentConfidenceThreshold -> (double)

The updated confidence threshold for inserting the AMAZON.FallbackIntent and AMAZON.KendraSearchIntent intents in the list of possible intents for an utterance.

voiceSettings -> (structure)

The updated Amazon Polly voice to use 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 current status of the locale. When the bot status is Built the locale is ready for use.

failureReasons -> (list)

If the botLocaleStatus is Failed , the failureReasons field lists the errors that occurred while building the bot.

(string)

creationDateTime -> (timestamp)

A timestamp of the date and time that the locale was created.

lastUpdatedDateTime -> (timestamp)

A timestamp of the date and time that the locale was last updated.

recommendedActions -> (list)

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

(string)