AWS CLI Command Reference

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 ]

update-bot-locale

Description

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

See also: AWS API Documentation

Synopsis

  update-bot-locale
--bot-id <value>
--bot-version <value>
--locale-id <value>
[--description <value>]
--nlu-intent-confidence-threshold <value>
[--voice-settings <value>]
[--generative-ai-settings <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <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"|"long-form"|"generative"
}

--generative-ai-settings (structure)

Contains settings for generative AI features powered by Amazon Bedrock for your bot locale. Use this object to turn generative AI features on and off. Pricing may differ if you turn a feature on. For more information, see LINK.

runtimeSettings -> (structure)

Contains specifications about the Amazon Lex runtime generative AI capabilities from Amazon Bedrock that you can turn on for your bot.

slotResolutionImprovement -> (structure)

An object containing specifications for the assisted slot resolution feature.

enabled -> (boolean)

Specifies whether assisted slot resolution is turned on or off.

bedrockModelSpecification -> (structure)

An object containing information about the Amazon Bedrock model used to assist slot resolution.

modelArn -> (string)

The ARN of the foundation model used in descriptive bot building.

guardrail -> (structure)

The guardrail configuration in the Bedrock model specification details.

identifier -> (string)

The unique guardrail id for the Bedrock guardrail configuration.

version -> (string)

The guardrail version for the Bedrock guardrail configuration.

traceStatus -> (string)

The Bedrock trace status in the Bedrock model specification details.

customPrompt -> (string)

The custom prompt used in the Bedrock model specification details.

buildtimeSettings -> (structure)

Contains specifications about the Amazon Lex build time generative AI capabilities from Amazon Bedrock that you can turn on for your bot.

descriptiveBotBuilder -> (structure)

An object containing specifications for the descriptive bot building feature.

enabled -> (boolean)

Specifies whether the descriptive bot building feature is activated or not.

bedrockModelSpecification -> (structure)

An object containing information about the Amazon Bedrock model used to interpret the prompt used in descriptive bot building.

modelArn -> (string)

The ARN of the foundation model used in descriptive bot building.

guardrail -> (structure)

The guardrail configuration in the Bedrock model specification details.

identifier -> (string)

The unique guardrail id for the Bedrock guardrail configuration.

version -> (string)

The guardrail version for the Bedrock guardrail configuration.

traceStatus -> (string)

The Bedrock trace status in the Bedrock model specification details.

customPrompt -> (string)

The custom prompt used in the Bedrock model specification details.

sampleUtteranceGeneration -> (structure)

Contains specifications for the sample utterance generation feature.

enabled -> (boolean)

Specifies whether to enable sample utterance generation or not.

bedrockModelSpecification -> (structure)

Contains information about the Amazon Bedrock model used to interpret the prompt used in descriptive bot building.

modelArn -> (string)

The ARN of the foundation model used in descriptive bot building.

guardrail -> (structure)

The guardrail configuration in the Bedrock model specification details.

identifier -> (string)

The unique guardrail id for the Bedrock guardrail configuration.

version -> (string)

The guardrail version for the Bedrock guardrail configuration.

traceStatus -> (string)

The Bedrock trace status in the Bedrock model specification details.

customPrompt -> (string)

The custom prompt used in the Bedrock model specification details.

JSON Syntax:

{
  "runtimeSettings": {
    "slotResolutionImprovement": {
      "enabled": true|false,
      "bedrockModelSpecification": {
        "modelArn": "string",
        "guardrail": {
          "identifier": "string",
          "version": "string"
        },
        "traceStatus": "ENABLED"|"DISABLED",
        "customPrompt": "string"
      }
    }
  },
  "buildtimeSettings": {
    "descriptiveBotBuilder": {
      "enabled": true|false,
      "bedrockModelSpecification": {
        "modelArn": "string",
        "guardrail": {
          "identifier": "string",
          "version": "string"
        },
        "traceStatus": "ENABLED"|"DISABLED",
        "customPrompt": "string"
      }
    },
    "sampleUtteranceGeneration": {
      "enabled": true|false,
      "bedrockModelSpecification": {
        "modelArn": "string",
        "guardrail": {
          "identifier": "string",
          "version": "string"
        },
        "traceStatus": "ENABLED"|"DISABLED",
        "customPrompt": "string"
      }
    }
  }
}

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

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command's default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

  • json
  • text
  • table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

  • on
  • off
  • auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

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)

generativeAISettings -> (structure)

Contains settings for generative AI features powered by Amazon Bedrock for your bot locale.

runtimeSettings -> (structure)

Contains specifications about the Amazon Lex runtime generative AI capabilities from Amazon Bedrock that you can turn on for your bot.

slotResolutionImprovement -> (structure)

An object containing specifications for the assisted slot resolution feature.

enabled -> (boolean)

Specifies whether assisted slot resolution is turned on or off.

bedrockModelSpecification -> (structure)

An object containing information about the Amazon Bedrock model used to assist slot resolution.

modelArn -> (string)

The ARN of the foundation model used in descriptive bot building.

guardrail -> (structure)

The guardrail configuration in the Bedrock model specification details.

identifier -> (string)

The unique guardrail id for the Bedrock guardrail configuration.

version -> (string)

The guardrail version for the Bedrock guardrail configuration.

traceStatus -> (string)

The Bedrock trace status in the Bedrock model specification details.

customPrompt -> (string)

The custom prompt used in the Bedrock model specification details.

buildtimeSettings -> (structure)

Contains specifications about the Amazon Lex build time generative AI capabilities from Amazon Bedrock that you can turn on for your bot.

descriptiveBotBuilder -> (structure)

An object containing specifications for the descriptive bot building feature.

enabled -> (boolean)

Specifies whether the descriptive bot building feature is activated or not.

bedrockModelSpecification -> (structure)

An object containing information about the Amazon Bedrock model used to interpret the prompt used in descriptive bot building.

modelArn -> (string)

The ARN of the foundation model used in descriptive bot building.

guardrail -> (structure)

The guardrail configuration in the Bedrock model specification details.

identifier -> (string)

The unique guardrail id for the Bedrock guardrail configuration.

version -> (string)

The guardrail version for the Bedrock guardrail configuration.

traceStatus -> (string)

The Bedrock trace status in the Bedrock model specification details.

customPrompt -> (string)

The custom prompt used in the Bedrock model specification details.

sampleUtteranceGeneration -> (structure)

Contains specifications for the sample utterance generation feature.

enabled -> (boolean)

Specifies whether to enable sample utterance generation or not.

bedrockModelSpecification -> (structure)

Contains information about the Amazon Bedrock model used to interpret the prompt used in descriptive bot building.

modelArn -> (string)

The ARN of the foundation model used in descriptive bot building.

guardrail -> (structure)

The guardrail configuration in the Bedrock model specification details.

identifier -> (string)

The unique guardrail id for the Bedrock guardrail configuration.

version -> (string)

The guardrail version for the Bedrock guardrail configuration.

traceStatus -> (string)

The Bedrock trace status in the Bedrock model specification details.

customPrompt -> (string)

The custom prompt used in the Bedrock model specification details.