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 ]

describe-bot-locale

Description

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

See also: AWS API Documentation

Synopsis

  describe-bot-locale
--bot-id <value>
--bot-version <value>
--locale-id <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 identifier of the bot associated with the locale.

--bot-version (string)

The identifier of the version of the bot associated with the locale.

--locale-id (string)

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

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

--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 associated with the locale.

botVersion -> (string)

The identifier of the version of the bot associated with the locale.

localeId -> (string)

The unique identifier of the described locale.

localeName -> (string)

The name of the locale.

description -> (string)

The description of the locale.

nluIntentConfidenceThreshold -> (double)

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

voiceSettings -> (structure)

The Amazon Polly voice 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 .

intentsCount -> (integer)

The number of intents defined for the locale.

slotTypesCount -> (integer)

The number of slot types defined for the locale.

botLocaleStatus -> (string)

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

failureReasons -> (list)

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

(string)

creationDateTime -> (timestamp)

The date and time that the locale was created.

lastUpdatedDateTime -> (timestamp)

The date and time that the locale was last updated.

lastBuildSubmittedDateTime -> (timestamp)

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

botLocaleHistoryEvents -> (list)

History of changes, such as when a locale is used in an alias, that have taken place for the locale.

(structure)

Provides information about an event that occurred affecting the bot locale.

event -> (string)

A description of the event that occurred.

eventDate -> (timestamp)

A timestamp of the date and time that the event occurred.

recommendedActions -> (list)

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

(string)