LexModelsV2 / Paginator / DescribeBotAnalyzerRecommendation

DescribeBotAnalyzerRecommendation

class LexModelsV2.Paginator.DescribeBotAnalyzerRecommendation

paginator = client.get_paginator('describe_bot_analyzer_recommendation')

paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

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

Parameters:

• botId (string) –

  [REQUIRED]

  The unique identifier of the bot.

• botAnalyzerRequestId (string) –

  [REQUIRED]

  The unique identifier of the analysis request.

• 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',
    'botVersion': 'string',
    'localeId': 'string',
    'botAnalyzerStatus': 'Processing'|'Available'|'Failed'|'Stopping'|'Stopped',
    'creationDateTime': datetime(2015, 1, 1),
    'botAnalyzerRecommendationList': [
        {
            'issueLocation': {
                'botLocale': 'string',
                'intentId': 'string',
                'slotId': 'string'
            },
            'priority': 'High'|'Medium'|'Low',
            'issueDescription': 'string',
            'proposedFix': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • botId (string) –

    The unique identifier of the bot.

  • botVersion (string) –

    The version of the bot that was analyzed.

  • localeId (string) –

    The locale identifier of the bot locale that was analyzed.

  • botAnalyzerStatus (string) –

    The current status of the analysis.

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

  • creationDateTime (datetime) –

    The date and time when the analysis was initiated.

  • botAnalyzerRecommendationList (list) –

    A list of recommendations for optimizing your bot configuration. Each recommendation includes the issue location, priority, description, and proposed fix.

    • (dict) –

      Contains a recommendation for bot optimization identified by the Bot Analyzer.

      • issueLocation (dict) –

        The location information for the identified issue within the bot configuration.

        • botLocale (string) –

          The locale identifier where the issue was found.

        • intentId (string) –

          The intent identifier where the issue was found, if applicable.

        • slotId (string) –

          The slot identifier where the issue was found, if applicable.

      • priority (string) –

        The priority level of the recommendation.

        Valid Values: High | Medium | Low

      • issueDescription (string) –

        A detailed description of the identified configuration issue.

      • proposedFix (string) –

        The recommended solution to address the identified issue.

  • NextToken (string) –

    A token to resume pagination.