CostOptimizationHub / Paginator / ListRecommendationSummaries
ListRecommendationSummaries#
- class CostOptimizationHub.Paginator.ListRecommendationSummaries#
paginator = client.get_paginator('list_recommendation_summaries')
- paginate(**kwargs)#
Creates an iterator that will paginate through responses from
CostOptimizationHub.Client.list_recommendation_summaries()
.See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate( filter={ 'restartNeeded': True|False, 'rollbackPossible': True|False, 'implementationEfforts': [ 'VeryLow'|'Low'|'Medium'|'High'|'VeryHigh', ], 'accountIds': [ 'string', ], 'regions': [ 'string', ], 'resourceTypes': [ 'Ec2Instance'|'LambdaFunction'|'EbsVolume'|'EcsService'|'Ec2AutoScalingGroup'|'Ec2InstanceSavingsPlans'|'ComputeSavingsPlans'|'SageMakerSavingsPlans'|'Ec2ReservedInstances'|'RdsReservedInstances'|'OpenSearchReservedInstances'|'RedshiftReservedInstances'|'ElastiCacheReservedInstances'|'RdsDbInstanceStorage'|'RdsDbInstance', ], 'actionTypes': [ 'Rightsize'|'Stop'|'Upgrade'|'PurchaseSavingsPlans'|'PurchaseReservedInstances'|'MigrateToGraviton'|'Delete', ], 'tags': [ { 'key': 'string', 'value': 'string' }, ], 'resourceIds': [ 'string', ], 'resourceArns': [ 'string', ], 'recommendationIds': [ 'string', ] }, groupBy='string', metrics=[ 'SavingsPercentage', ], PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } )
- Parameters:
filter (dict) –
Describes a filter that returns a more specific list of recommendations. Filters recommendations by different dimensions.
restartNeeded (boolean) –
Whether or not implementing the recommendation requires a restart.
rollbackPossible (boolean) –
Whether or not implementing the recommendation can be rolled back.
implementationEfforts (list) –
The effort required to implement the recommendation.
(string) –
accountIds (list) –
The account that the recommendation is for.
(string) –
regions (list) –
The Amazon Web Services Region of the resource.
(string) –
resourceTypes (list) –
The resource type of the recommendation.
(string) –
actionTypes (list) –
The type of action you can take by adopting the recommendation.
(string) –
tags (list) –
A list of tags assigned to the recommendation.
(dict) –
The tag structure that contains a tag key and value.
key (string) –
The key that’s associated with the tag.
value (string) –
The value that’s associated with the tag.
resourceIds (list) –
The resource ID of the recommendation.
(string) –
resourceArns (list) –
The Amazon Resource Name (ARN) of the recommendation.
(string) –
recommendationIds (list) –
The IDs for the recommendations.
(string) –
groupBy (string) –
[REQUIRED]
The grouping of recommendations by a dimension.
metrics (list) –
Additional metrics to be returned for the request. The only valid value is
savingsPercentage
.(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
{ 'estimatedTotalDedupedSavings': 123.0, 'items': [ { 'group': 'string', 'estimatedMonthlySavings': 123.0, 'recommendationCount': 123 }, ], 'groupBy': 'string', 'currencyCode': 'string', 'metrics': { 'savingsPercentage': 'string' }, 'NextToken': 'string' }
Response Structure
(dict) –
estimatedTotalDedupedSavings (float) –
The total overall savings for the aggregated view.
items (list) –
A list of all savings recommendations.
(dict) –
The summary of rightsizing recommendations, including de-duped savings from all types of recommendations.
group (string) –
The grouping of recommendations.
estimatedMonthlySavings (float) –
The estimated total savings resulting from modifications, on a monthly basis.
recommendationCount (integer) –
The total number of instance recommendations.
groupBy (string) –
The dimension used to group the recommendations by.
currencyCode (string) –
The currency code used for the recommendation.
metrics (dict) –
The results or descriptions for the additional metrics, based on whether the metrics were or were not requested.
savingsPercentage (string) –
The savings percentage based on your Amazon Web Services spend over the past 30 days.
Note
Savings percentage is only supported when filtering by Region, account ID, or tags.
NextToken (string) –
A token to resume pagination.