list-bots¶

Description¶

Lists the bots associated with the administrator’s Amazon Chime Enterprise account ID.

Synopsis¶

  list-bots
--account-id <value>
[--max-results <value>]
[--next-token <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--cli-auto-prompt <value>]

Options¶

--account-id (string)

The Amazon Chime account ID.

--max-results (integer)

The maximum number of results to return in a single call. The default is 10.

--next-token (string)

The token to use to retrieve 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.

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

See ‘aws help’ for descriptions of global parameters.

Examples¶

To retrieve a list of bots

The following list-bots example lists the bots associated with the specified Amazon Chime Enterprise account.

aws chime list-bots \
    --account-id 12a3456b-7c89-012d-3456-78901e23fg45

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 Use Chat Bots with Amazon Chime in the Amazon Chime Developer Guide.

Output¶

Bots -> (list)

List of bots and bot details.

(structure)

A resource that allows Enterprise account administrators to configure an interface to receive events from Amazon Chime.

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.

NextToken -> (string)