ComputeOptimizerAutomation / Paginator / ListRecommendedActionSummaries

ListRecommendedActionSummaries

class ComputeOptimizerAutomation.Paginator.ListRecommendedActionSummaries

paginator = client.get_paginator('list_recommended_action_summaries')

paginate(**kwargs)

Creates an iterator that will paginate through responses from ComputeOptimizerAutomation.Client.list_recommended_action_summaries().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    filters=[
        {
            'name': 'ResourceType'|'RecommendedActionType'|'ResourceId'|'LookBackPeriodInDays'|'CurrentResourceDetailsEbsVolumeType'|'ResourceTagsKey'|'ResourceTagsValue'|'AccountId'|'RestartNeeded',
            'values': [
                'string',
            ]
        },
    ],
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• filters (list) –

  A list of filters to apply when retrieving recommended action summaries. Filters can be based on resource type, action type, account ID, and other criteria.

  • (dict) –

    A filter used to narrow down recommended action results based on specific criteria.

    • name (string) – [REQUIRED]

      The name of the filter field to apply.

    • values (list) – [REQUIRED]

      List of filter values to match against the specified filter name. Used to narrow down recommended actions based on specific criteria.

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

{
    'recommendedActionSummaries': [
        {
            'key': 'string',
            'total': {
                'recommendedActionCount': 123,
                'estimatedMonthlySavings': {
                    'currency': 'string',
                    'beforeDiscountSavings': 123.0,
                    'afterDiscountSavings': 123.0,
                    'savingsEstimationMode': 'BeforeDiscount'|'AfterDiscount'
                }
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • recommendedActionSummaries (list) –

    The summary of recommended actions that match the specified criteria.

    • (dict) –

      Summary information about recommended actions, grouped by specific criteria with totals and counts.

      • key (string) –

        The grouping key used to categorize the recommended actions in this summary.

      • total (dict) –

        Aggregate totals for the recommended actions in this group, including count and estimated savings.

        • recommendedActionCount (integer) –

          The total number of recommended actions in this group.

        • estimatedMonthlySavings (dict) –

          Contains information about estimated monthly cost savings.

          • currency (string) –

            The currency of the estimated savings.

          • beforeDiscountSavings (float) –

            The estimated monthly savings before applying any discounts.

          • afterDiscountSavings (float) –

            The estimated monthly savings after applying any discounts.

          • savingsEstimationMode (string) –

            The mode used to calculate savings, either BeforeDiscount or AfterDiscount.

  • NextToken (string) –

    A token to resume pagination.