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 . chime-sdk-identity ]

describe-app-instance-bot

Description

The AppInstanceBot's information.

See also: AWS API Documentation

Synopsis

  describe-app-instance-bot
--app-instance-bot-arn <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

--app-instance-bot-arn (string)

The ARN of the AppInstanceBot .

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

AppInstanceBot -> (structure)

The detials of the AppInstanceBot .

AppInstanceBotArn -> (string)

The ARN of the AppInstanceBot.

Name -> (string)

The name of the AppInstanceBot.

Configuration -> (structure)

The data processing instructions for an AppInstanceBot.

Lex -> (structure)

The configuration for an Amazon Lex V2 bot.

RespondsTo -> (string)

Warning

Deprecated . Use InvokedBy instead.

Determines whether the Amazon Lex V2 bot responds to all standard messages. Control messages are not supported.

InvokedBy -> (structure)

Specifies the type of message that triggers a bot.

StandardMessages -> (string)

Sets standard messages as the bot trigger. For standard messages:

  • ALL : The bot processes all standard messages.
  • AUTO : The bot responds to ALL messages when the channel has one other non-hidden member, and responds to MENTIONS when the channel has more than one other non-hidden member.
  • MENTIONS : The bot processes all standard messages that have a message attribute with CHIME.mentions and a value of the bot ARN.
  • NONE : The bot processes no standard messages.

TargetedMessages -> (string)

Sets targeted messages as the bot trigger. For targeted messages:

  • ALL : The bot processes all TargetedMessages sent to it. The bot then responds with a targeted message back to the sender.
  • NONE : The bot processes no targeted messages.

LexBotAliasArn -> (string)

The ARN of the Amazon Lex V2 bot's alias. The ARN uses this format: arn:aws:lex:REGION:ACCOUNT:bot-alias/MYBOTID/MYBOTALIAS

LocaleId -> (string)

Identifies the Amazon Lex V2 bot's language and locale. The string must match one of the supported locales in Amazon Lex V2. All of the intents, slot types, and slots used in the bot must have the same locale. For more information, see Supported languages in the Amazon Lex V2 Developer Guide .

WelcomeIntent -> (string)

The name of the welcome intent configured in the Amazon Lex V2 bot.

CreatedTimestamp -> (timestamp)

The time at which the AppInstanceBot was created.

LastUpdatedTimestamp -> (timestamp)

The time at which the AppInstanceBot was last updated.

Metadata -> (string)

The metadata for an AppInstanceBot.