CostOptimizationHub / Client / list_recommendation_summaries
list_recommendation_summaries#
- CostOptimizationHub.Client.list_recommendation_summaries(**kwargs)#
Returns a concise representation of savings estimates for resources. Also returns de-duped savings across different types of recommendations.
Note
The following filters are not supported for this API:
recommendationIds
,resourceArns
, andresourceIds
.See also: AWS API Documentation
Request Syntax
response = client.list_recommendation_summaries( filter={ 'accountIds': [ 'string', ], 'actionTypes': [ 'Rightsize'|'Stop'|'Upgrade'|'PurchaseSavingsPlans'|'PurchaseReservedInstances'|'MigrateToGraviton', ], 'implementationEfforts': [ 'VeryLow'|'Low'|'Medium'|'High'|'VeryHigh', ], 'recommendationIds': [ 'string', ], 'regions': [ 'string', ], 'resourceArns': [ 'string', ], 'resourceIds': [ 'string', ], 'resourceTypes': [ 'Ec2Instance'|'LambdaFunction'|'EbsVolume'|'EcsService'|'Ec2AutoScalingGroup'|'Ec2InstanceSavingsPlans'|'ComputeSavingsPlans'|'SageMakerSavingsPlans'|'Ec2ReservedInstances'|'RdsReservedInstances'|'OpenSearchReservedInstances'|'RedshiftReservedInstances'|'ElastiCacheReservedInstances', ], 'restartNeeded': True|False, 'rollbackPossible': True|False, 'tags': [ { 'key': 'string', 'value': 'string' }, ] }, groupBy='string', maxResults=123, nextToken='string' )
- Parameters:
filter (dict) –
Describes a filter that returns a more specific list of recommendations. Filters recommendations by different dimensions.
accountIds (list) –
The account that the recommendation is for.
(string) –
actionTypes (list) –
The type of action you can take by adopting the recommendation.
(string) –
implementationEfforts (list) –
The effort required to implement the recommendation.
(string) –
recommendationIds (list) –
The IDs for the recommendations.
(string) –
regions (list) –
The Amazon Web Services Region of the resource.
(string) –
resourceArns (list) –
The Amazon Resource Name (ARN) of the recommendation.
(string) –
resourceIds (list) –
The resource ID of the recommendation.
(string) –
resourceTypes (list) –
The resource type of the recommendation.
(string) –
restartNeeded (boolean) –
Whether or not implementing the recommendation requires a restart.
rollbackPossible (boolean) –
Whether or not implementing the recommendation can be rolled back.
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.
groupBy (string) –
[REQUIRED]
The grouping of recommendations by a dimension.
maxResults (integer) – The maximum number of recommendations that are returned for the request.
nextToken (string) – The token to retrieve the next set of results.
- Return type:
dict
- Returns:
Response Syntax
{ 'currencyCode': 'string', 'estimatedTotalDedupedSavings': 123.0, 'groupBy': 'string', 'items': [ { 'estimatedMonthlySavings': 123.0, 'group': 'string', 'recommendationCount': 123 }, ], 'nextToken': 'string' }
Response Structure
(dict) –
currencyCode (string) –
The currency code used for the recommendation.
estimatedTotalDedupedSavings (float) –
The total overall savings for the aggregated view.
groupBy (string) –
The dimension used to group the recommendations by.
items (list) –
List of all savings recommendations.
(dict) –
The summary of rightsizing recommendations, including de-duped savings from all types of recommendations.
estimatedMonthlySavings (float) –
The estimated total savings resulting from modifications, on a monthly basis.
group (string) –
The grouping of recommendations.
recommendationCount (integer) –
The total number of instance recommendations.
nextToken (string) –
The token to retrieve the next set of results.
Exceptions
CostOptimizationHub.Client.exceptions.ValidationException
CostOptimizationHub.Client.exceptions.InternalServerException
CostOptimizationHub.Client.exceptions.AccessDeniedException
CostOptimizationHub.Client.exceptions.ThrottlingException