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 . lex-models ]

get-bot-channel-association

Description

Returns information about the association between an Amazon Lex bot and a messaging platform.

This operation requires permissions for the lex:GetBotChannelAssociation action.

See also: AWS API Documentation

Synopsis

  get-bot-channel-association
--name <value>
--bot-name <value>
--bot-alias <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

--name (string)

The name of the association between the bot and the channel. The name is case sensitive.

--bot-name (string)

The name of the Amazon Lex bot.

--bot-alias (string)

An alias pointing to the specific version of the Amazon Lex bot to which this association is being made.

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

name -> (string)

The name of the association between the bot and the channel.

description -> (string)

A description of the association between the bot and the channel.

botAlias -> (string)

An alias pointing to the specific version of the Amazon Lex bot to which this association is being made.

botName -> (string)

The name of the Amazon Lex bot.

createdDate -> (timestamp)

The date that the association between the bot and the channel was created.

type -> (string)

The type of the messaging platform.

botConfiguration -> (map)

Provides information that the messaging platform needs to communicate with the Amazon Lex bot.

key -> (string)

value -> (string)

status -> (string)

The status of the bot channel.

  • CREATED - The channel has been created and is ready for use.
  • IN_PROGRESS - Channel creation is in progress.
  • FAILED - There was an error creating the channel. For information about the reason for the failure, see the failureReason field.

failureReason -> (string)

If status is FAILED , Amazon Lex provides the reason that it failed to create the association.