[ aws . lexv2-models ]

list-bot-locales

Description

Gets a list of locales for the specified bot.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  list-bot-locales
--bot-id <value>
--bot-version <value>
[--sort-by <value>]
[--filters <value>]
[--max-results <value>]
[--next-token <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--bot-id (string)

The identifier of the bot to list locales for.

--bot-version (string)

The version of the bot to list locales for.

--sort-by (structure)

Specifies sorting parameters for the list of locales. You can sort by locale name in ascending or descending order.

attribute -> (string)

The bot locale attribute to sort by.

order -> (string)

Specifies whether to sort the bot locales in ascending or descending order.

Shorthand Syntax:

attribute=string,order=string

JSON Syntax:

{
  "attribute": "BotLocaleName",
  "order": "Ascending"|"Descending"
}

--filters (list)

Provides the specification for a filter used to limit the response to only those locales that match the filter specification. You can only specify one filter and one value to filter on.

(structure)

Filters responses returned by the ListBotLocales operation.

name -> (string)

The name of the field to filter the list of bots.

values -> (list)

The value to use for filtering the list of bots.

(string)

operator -> (string)

The operator to use for the filter. Specify EQ when the ListBotLocales operation should return only aliases that equal the specified value. Specify CO when the ListBotLocales operation should return aliases that contain the specified value.

Shorthand Syntax:

name=string,values=string,string,operator=string ...

JSON Syntax:

[
  {
    "name": "BotLocaleName",
    "values": ["string", ...],
    "operator": "CO"|"EQ"
  }
  ...
]

--max-results (integer)

The maximum number of aliases to return in each page of results. If there are fewer results than the max page size, only the actual number of results are returned.

--next-token (string)

If the response from the ListBotLocales operation contains more results than specified in the maxResults parameter, a token is returned in the response. Use that token as the nextToken parameter to return the next page of results.

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

See ‘aws help’ for descriptions of global parameters.

Output

botId -> (string)

The identifier of the bot to list locales for.

botVersion -> (string)

The version of the bot.

nextToken -> (string)

A token that indicates whether there are more results to return in a response to the ListBotLocales operation. If the nextToken field is present, you send the contents as the nextToken parameter of a ListBotLocales operation request to get the next page of results.

botLocaleSummaries -> (list)

Summary information for the locales that meet the filter criteria specified in the request. The length of the list is specified in the maxResults parameter of the request. If there are more locales available, the nextToken field contains a token to get the next page of results.

(structure)

Summary information about bot locales returned by the ListBotLocales operation.

localeId -> (string)

The language and locale of the bot locale.

localeName -> (string)

The name of the bot locale.

description -> (string)

The description of the bot locale.

botLocaleStatus -> (string)

The current status of the bot locale. When the status is Built the locale is ready for use.

lastUpdatedDateTime -> (timestamp)

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

lastBuildSubmittedDateTime -> (timestamp)

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