PI / Paginator / ListPerformanceAnalysisReportRecommendations

ListPerformanceAnalysisReportRecommendations

class PI.Paginator.ListPerformanceAnalysisReportRecommendations

paginator = client.get_paginator('list_performance_analysis_report_recommendations')

paginate(**kwargs)

Creates an iterator that will paginate through responses from PI.Client.list_performance_analysis_report_recommendations().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    ServiceType='RDS'|'DOCDB',
    Identifier='string',
    AnalysisReportId='string',
    RecommendationIds=[
        'string',
    ],
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• ServiceType (string) –

  [REQUIRED]

  The Amazon Web Services service for which Performance Insights returns metrics. Valid value is RDS.

• Identifier (string) –

  [REQUIRED]

  An immutable identifier for a data source that is unique for an Amazon Web Services Region. Performance Insights gathers metrics from this data source. In the console, the identifier is shown as ResourceID. When you call DescribeDBInstances, the identifier is returned as DbiResourceId.

  To use a DB instance as a data source, specify its DbiResourceId value. For example, specify db-ABCDEFGHIJKLMNOPQRSTU1VW2X.

• AnalysisReportId (string) –

  [REQUIRED]

  A unique identifier of the created analysis report. For example, report-12345678901234567

• RecommendationIds (list) –

  A list of recommendation identifiers to filter the results.

  • (string) –

• 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

{
    'Recommendations': [
        {
            'RecommendationId': 'string',
            'RecommendationDescription': 'string',
            'RecommendationDetails': 'string'
        },
    ],

}

Response Structure

• (dict) –

  • Recommendations (list) –

    The list of recommendations for the analysis report.

    • (dict) –

      The list of recommendations for the insight.

      • RecommendationId (string) –

        The unique identifier for the recommendation.

      • RecommendationDescription (string) –

        The recommendation details to help resolve the performance issue. For example, Investigate the following SQLs that contributed to 100% of the total DBLoad during that time period: sql-id

      • RecommendationDetails (string) –

        Detailed information about the recommendation, including steps to resolve the performance issue.