[ aws . lex-models ]

get-bot-aliases

Description

Returns a list of aliases for a specified Amazon Lex bot.

This operation requires permissions for the lex:GetBotAliases action.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

get-bot-aliases is a paginated operation. Multiple API calls may be issued in order to retrieve the entire data set of results. You can disable pagination by providing the --no-paginate argument. When using --output text and the --query argument on a paginated response, the --query argument must extract data from the results of the following query expressions: BotAliases

Synopsis

  get-bot-aliases
--bot-name <value>
[--name-contains <value>]
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]
[--cli-auto-prompt <value>]

Options

--bot-name (string)

The name of the bot.

--name-contains (string)

Substring to match in bot alias names. An alias will be returned if any part of its name matches the substring. For example, “xyz” matches both “xyzabc” and “abcxyz.”

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

--starting-token (string)

A token to specify where to start paginating. This is the NextToken from a previously truncated response.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--page-size (integer)

The size of each page to get in the AWS service call. This does not affect the number of items returned in the command’s output. Setting a smaller page size results in more calls to the AWS service, retrieving fewer items in each call. This can help prevent the AWS service calls from timing out.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--max-items (integer)

The total number of items to return in the command’s output. If the total number of items available is more than the value specified, a NextToken is provided in the command’s output. To resume pagination, provide the NextToken value in the starting-token argument of a subsequent command. Do not use the NextToken response element directly outside of the AWS CLI.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

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

--cli-auto-prompt (boolean) Automatically prompt for CLI input parameters.

See ‘aws help’ for descriptions of global parameters.

Output

BotAliases -> (list)

An array of BotAliasMetadata objects, each describing a bot alias.

(structure)

Provides information about a bot alias.

name -> (string)

The name of the bot alias.

description -> (string)

A description of the bot alias.

botVersion -> (string)

The version of the Amazon Lex bot to which the alias points.

botName -> (string)

The name of the bot to which the alias points.

lastUpdatedDate -> (timestamp)

The date that the bot alias was updated. When you create a resource, the creation date and last updated date are the same.

createdDate -> (timestamp)

The date that the bot alias was created.

checksum -> (string)

Checksum of the bot alias.

conversationLogs -> (structure)

Settings that determine how Amazon Lex uses conversation logs for the alias.

logSettings -> (list)

The settings for your conversation logs. You can log text, audio, or both.

(structure)

The settings for conversation logs.

logType -> (string)

The type of logging that is enabled.

destination -> (string)

The destination where logs are delivered.

kmsKeyArn -> (string)

The Amazon Resource Name (ARN) of the key used to encrypt audio logs in an S3 bucket.

resourceArn -> (string)

The Amazon Resource Name (ARN) of the CloudWatch Logs log group or S3 bucket where the logs are delivered.

resourcePrefix -> (string)

The resource prefix is the first part of the S3 object key within the S3 bucket that you specified to contain audio logs. For CloudWatch Logs it is the prefix of the log stream name within the log group that you specified.

iamRoleArn -> (string)

The Amazon Resource Name (ARN) of the IAM role used to write your logs to CloudWatch Logs or an S3 bucket.

nextToken -> (string)

A pagination token for fetching next page of aliases. If the response to this call is truncated, Amazon Lex returns a pagination token in the response. To fetch the next page of aliases, specify the pagination token in the next request.