ComputeOptimizerAutomation / Client / list_recommended_action_summaries
list_recommended_action_summaries¶
- ComputeOptimizerAutomation.Client.list_recommended_action_summaries(**kwargs)¶
Provides a summary of recommended actions based on specified filters.
Note
Management accounts and delegated administrators can retrieve recommended actions that include associated member accounts. You can associate a member account using
AssociateAccounts.See also: AWS API Documentation
Request Syntax
response = client.list_recommended_action_summaries( filters=[ { 'name': 'ResourceType'|'RecommendedActionType'|'ResourceId'|'LookBackPeriodInDays'|'CurrentResourceDetailsEbsVolumeType'|'ResourceTagsKey'|'ResourceTagsValue'|'AccountId'|'RestartNeeded', 'values': [ 'string', ] }, ], maxResults=123, nextToken='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) –
maxResults (integer) – The maximum number of recommended action summaries to return in a single response. Valid range is 1-1000.
nextToken (string) – A token used for pagination to retrieve the next set of results when the response is truncated.
- 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 used for pagination. If present, indicates there are more results available and can be used in subsequent requests.
Exceptions
ComputeOptimizerAutomation.Client.exceptions.InvalidParameterValueExceptionComputeOptimizerAutomation.Client.exceptions.ForbiddenExceptionComputeOptimizerAutomation.Client.exceptions.OptInRequiredExceptionComputeOptimizerAutomation.Client.exceptions.ThrottlingExceptionComputeOptimizerAutomation.Client.exceptions.AccessDeniedExceptionComputeOptimizerAutomation.Client.exceptions.InternalServerExceptionComputeOptimizerAutomation.Client.exceptions.ServiceUnavailableException