PI / Client / list_performance_analysis_report_recommendations

list_performance_analysis_report_recommendations

PI.Client.list_performance_analysis_report_recommendations(**kwargs)

Retrieves recommendations for a performance analysis report.

See also: AWS API Documentation

Request Syntax

response = client.list_performance_analysis_report_recommendations(
    ServiceType='RDS'|'DOCDB',
    Identifier='string',
    AnalysisReportId='string',
    RecommendationIds=[
        'string',
    ],
    MaxResults=123,
    NextToken='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) –

  • MaxResults (integer) – The maximum number of items to return in the response. If more items exist than the specified MaxResults value, a pagination token is included in the response so that the remaining results can be retrieved.

  • NextToken (string) – An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the token, up to the value specified by MaxResults.

Return type:

dict

Returns:

Response Syntax

{
    'Recommendations': [
        {
            'RecommendationId': 'string',
            'RecommendationDescription': 'string',
            'RecommendationDetails': 'string'
        },
    ],
    'NextToken': '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.

    • NextToken (string) –

      An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the token, up to the value specified by MaxResults.

Exceptions