Chime / Client / list_bots

list_bots#

Chime.Client.list_bots(**kwargs)#

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

See also: AWS API Documentation

Request Syntax

response = client.list_bots(
    AccountId='string',
    MaxResults=123,
    NextToken='string'
)
Parameters:

  • AccountId (string) –

    [REQUIRED]

    The Amazon Chime account ID.

  • MaxResults (integer) – The maximum number of results to return in a single call. The default is 10.

  • NextToken (string) – The token to use to retrieve the next page of results.

Return type:

dict

Returns:

Response Syntax

{
    'Bots': [
        {
            'BotId': 'string',
            'UserId': 'string',
            'DisplayName': 'string',
            'BotType': 'ChatBot',
            'Disabled': True|False,
            'CreatedTimestamp': datetime(2015, 1, 1),
            'UpdatedTimestamp': datetime(2015, 1, 1),
            'BotEmail': 'string',
            'SecurityToken': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • Bots (list) –

      List of bots and bot details.

      • (dict) –

        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 (datetime) –

          The bot creation timestamp, in ISO 8601 format.

        • UpdatedTimestamp (datetime) –

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

      The token to use to retrieve the next page of results.

Exceptions