GetRecommendationSummaries

class ComputeOptimizer.Paginator.GetRecommendationSummaries

paginator = client.get_paginator('get_recommendation_summaries')

paginate(**kwargs)

Creates an iterator that will paginate through responses from ComputeOptimizer.Client.get_recommendation_summaries().

See also: AWS API Documentation

Request Syntax

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

Parameters

• accountIds (list) --

  The ID of the Amazon Web Services account for which to return recommendation summaries.

  If your account is the management account of an organization, use this parameter to specify the member account for which you want to return recommendation summaries.

  Only one account ID can be specified per request.

  • (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

{
    'recommendationSummaries': [
        {
            'summaries': [
                {
                    'name': 'Underprovisioned'|'Overprovisioned'|'Optimized'|'NotOptimized',
                    'value': 123.0,
                    'reasonCodeSummaries': [
                        {
                            'name': 'MemoryOverprovisioned'|'MemoryUnderprovisioned',
                            'value': 123.0
                        },
                    ]
                },
            ],
            'recommendationResourceType': 'Ec2Instance'|'AutoScalingGroup'|'EbsVolume'|'LambdaFunction'|'EcsService',
            'accountId': 'string',
            'savingsOpportunity': {
                'savingsOpportunityPercentage': 123.0,
                'estimatedMonthlySavings': {
                    'currency': 'USD'|'CNY',
                    'value': 123.0
                }
            },
            'currentPerformanceRiskRatings': {
                'high': 123,
                'medium': 123,
                'low': 123,
                'veryLow': 123
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) --

  • recommendationSummaries (list) --

    An array of objects that summarize a recommendation.

    • (dict) --

      A summary of a recommendation.

      • summaries (list) --

        An array of objects that describe a recommendation summary.

        • (dict) --

          The summary of a recommendation.

          • name (string) --

            The finding classification of the recommendation.

          • value (float) --

            The value of the recommendation summary.

          • reasonCodeSummaries (list) --

            An array of objects that summarize a finding reason code.

            • (dict) --

              A summary of a finding reason code.

              • name (string) --

                The name of the finding reason code.

              • value (float) --

                The value of the finding reason code summary.

      • recommendationResourceType (string) --

        The resource type that the recommendation summary applies to.

      • accountId (string) --

        The Amazon Web Services account ID of the recommendation summary.

      • savingsOpportunity (dict) --

        An object that describes the savings opportunity for a given resource type. Savings opportunity includes the estimated monthly savings amount and percentage.

        • savingsOpportunityPercentage (float) --

          The estimated monthly savings possible as a percentage of monthly cost by adopting Compute Optimizer recommendations for a given resource.

        • estimatedMonthlySavings (dict) --

          An object that describes the estimated monthly savings amount possible, based on On-Demand instance pricing, by adopting Compute Optimizer recommendations for a given resource.

          • currency (string) --

            The currency of the estimated monthly savings.

          • value (float) --

            The value of the estimated monthly savings.

      • currentPerformanceRiskRatings (dict) --

        An object that describes the performance risk ratings for a given resource type.

        • high (integer) --

          A count of the applicable resource types with a high performance risk rating.

        • medium (integer) --

          A count of the applicable resource types with a medium performance risk rating.

        • low (integer) --

          A count of the applicable resource types with a low performance risk rating.

        • veryLow (integer) --

          A count of the applicable resource types with a very low performance risk rating.

  • NextToken (string) --

    A token to resume pagination.