LexModelBuildingService / Paginator / GetBots

GetBots

class LexModelBuildingService.Paginator.GetBots

paginator = client.get_paginator('get_bots')

paginate(**kwargs)

Creates an iterator that will paginate through responses from LexModelBuildingService.Client.get_bots().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    nameContains='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• nameContains (string) – Substring to match in bot names. A bot will be returned if any part of its name matches the substring. For example, “xyz” matches both “xyzabc” and “abcxyz.”

• 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

{
    'bots': [
        {
            'name': 'string',
            'description': 'string',
            'status': 'BUILDING'|'READY'|'READY_BASIC_TESTING'|'FAILED'|'NOT_BUILT',
            'lastUpdatedDate': datetime(2015, 1, 1),
            'createdDate': datetime(2015, 1, 1),
            'version': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • bots (list) –

    An array of botMetadata objects, with one entry for each bot.

    • (dict) –

      Provides information about a bot. .

      • name (string) –

        The name of the bot.

      • description (string) –

        A description of the bot.

      • status (string) –

        The status of the bot.

      • lastUpdatedDate (datetime) –

        The date that the bot was updated. When you create a bot, the creation date and last updated date are the same.

      • createdDate (datetime) –

        The date that the bot was created.

      • version (string) –

        The version of the bot. For a new bot, the version is always $LATEST.

  • NextToken (string) –

    A token to resume pagination.