LexModelsV2 / Paginator / ListBotAnalyzerHistory

ListBotAnalyzerHistory

class LexModelsV2.Paginator.ListBotAnalyzerHistory

paginator = client.get_paginator('list_bot_analyzer_history')

paginate(**kwargs)

Creates an iterator that will paginate through responses from LexModelsV2.Client.list_bot_analyzer_history().

See also: AWS API Documentation

Request Syntax

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

Parameters:

• botId (string) –

  [REQUIRED]

  The unique identifier of the bot.

• localeId (string) – The locale identifier to filter the history. If not specified, returns history for all locales.

• botVersion (string) – The bot version to filter the history. If not specified, defaults to DRAFT.

• 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

{
    'botId': 'string',
    'localeId': 'string',
    'botVersion': 'string',
    'botAnalyzerHistoryList': [
        {
            'botAnalyzerStatus': 'Processing'|'Available'|'Failed'|'Stopping'|'Stopped',
            'creationDateTime': datetime(2015, 1, 1),
            'botAnalyzerRequestId': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • botId (string) –

    The unique identifier of the bot.

  • localeId (string) –

    The locale identifier used to filter the history.

  • botVersion (string) –

    The bot version used to filter the history.

  • botAnalyzerHistoryList (list) –

    A list of historical analysis executions, ordered by creation date with the most recent first.

    • (dict) –

      Contains summary information about a historical bot analysis execution.

      • botAnalyzerStatus (string) –

        The status of the historical analysis execution.

        Valid Values: Processing | Available | Failed | Stopping | Stopped

      • creationDateTime (datetime) –

        The date and time when the analysis was initiated.

      • botAnalyzerRequestId (string) –

        The unique identifier for the analysis request.

  • NextToken (string) –

    A token to resume pagination.