Connect / Paginator / ListBots

ListBots

class Connect.Paginator.ListBots

paginator = client.get_paginator('list_bots')

paginate(**kwargs)

Creates an iterator that will paginate through responses from Connect.Client.list_bots().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    InstanceId='string',
    LexVersion='V1'|'V2',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• InstanceId (string) –

  [REQUIRED]

  The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

• LexVersion (string) –

  [REQUIRED]

  The version of Amazon Lex or Amazon Lex V2.

• PaginationConfig (dict) –

  A dictionary that provides parameters to control pagination.

  • MaxItems (integer) –

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • PageSize (integer) –

    The size of each page.

  • StartingToken (string) –

    A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:

dict

Returns:

Response Syntax

{
    'LexBots': [
        {
            'LexBot': {
                'Name': 'string',
                'LexRegion': 'string'
            },
            'LexV2Bot': {
                'AliasArn': 'string'
            }
        },
    ],

}

Response Structure

• (dict) –

  • LexBots (list) –

    The names and Amazon Web Services Regions of the Amazon Lex or Amazon Lex V2 bots associated with the specified instance.

    • (dict) –

      Configuration information of an Amazon Lex or Amazon Lex V2 bot.

      • LexBot (dict) –

        Configuration information of an Amazon Lex bot.

        • Name (string) –

          The name of the Amazon Lex bot.

        • LexRegion (string) –

          The Amazon Web Services Region where the Amazon Lex bot was created.

      • LexV2Bot (dict) –

        Configuration information of an Amazon Lex V2 bot.

        • AliasArn (string) –

          The Amazon Resource Name (ARN) of the Amazon Lex V2 bot.