Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

[ aws . chime ]

get-bot

Description

Retrieves details for the specified bot, such as bot email address, bot type, status, and display name.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  get-bot
--account-id <value>
--bot-id <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--account-id (string)

The Amazon Chime account ID.

--bot-id (string)

The bot ID.

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

See 'aws help' for descriptions of global parameters.

Examples

To retrieve details about a bot

The following get-bot example displays the details for the specified bot.

aws chime get-bot \
    --account-id 12a3456b-7c89-012d-3456-78901e23fg45 \
    --bot-id 123abcd4-5ef6-789g-0h12-34j56789012k

Output:

{
    "Bot": {
        "BotId": "123abcd4-5ef6-789g-0h12-34j56789012k",
        "UserId": "123abcd4-5ef6-789g-0h12-34j56789012k",
        "DisplayName": "myBot (Bot)",
        "BotType": "ChatBot",
        "Disabled": false,
        "CreatedTimestamp": "2019-09-09T18:05:56.749Z",
        "UpdatedTimestamp": "2019-09-09T18:05:56.749Z",
        "BotEmail": "myBot-chimebot@example.com",
        "SecurityToken": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY"
    }
}

For more information, see Update Chat Bots in the Amazon Chime Developer Guide.

Output

Bot -> (structure)

The chat bot details.

BotId -> (string)

The bot ID.

UserId -> (string)

The unique ID for the bot user.

DisplayName -> (string)

The bot display name.

BotType -> (string)

The bot type.

Disabled -> (boolean)

When true, the bot is stopped from running in your account.

CreatedTimestamp -> (timestamp)

The bot creation timestamp, in ISO 8601 format.

UpdatedTimestamp -> (timestamp)

The updated bot timestamp, in ISO 8601 format.

BotEmail -> (string)

The bot email address.

SecurityToken -> (string)

The security token used to authenticate Amazon Chime with the outgoing event endpoint.