ListRecommendationSummaries
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, and resourceIds.
Request Syntax
{
"filter": {
"accountIds": [ "string" ],
"actionTypes": [ "string" ],
"implementationEfforts": [ "string" ],
"recommendationIds": [ "string" ],
"regions": [ "string" ],
"resourceArns": [ "string" ],
"resourceIds": [ "string" ],
"resourceTypes": [ "string" ],
"restartNeeded": boolean,
"rollbackPossible": boolean,
"tags": [
{
"key": "string",
"value": "string"
}
]
},
"groupBy": "string",
"maxResults": number,
"nextToken": "string"
}Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- filter
-
Describes a filter that returns a more specific list of recommendations. Filters recommendations by different dimensions.
Type: Filter object
Required: No
- groupBy
-
The grouping of recommendations by a dimension.
Type: String
Required: Yes
- maxResults
-
The maximum number of recommendations that are returned for the request.
Type: Integer
Valid Range: Minimum value of 0. Maximum value of 1000.
Required: No
- nextToken
-
The token to retrieve the next set of results.
Type: String
Required: No
Response Syntax
{
"currencyCode": "string",
"estimatedTotalDedupedSavings": number,
"groupBy": "string",
"items": [
{
"estimatedMonthlySavings": number,
"group": "string",
"recommendationCount": number
}
],
"nextToken": "string"
}Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- currencyCode
-
The currency code used for the recommendation.
Type: String
- estimatedTotalDedupedSavings
-
The total overall savings for the aggregated view.
Type: Double
- groupBy
-
The dimension used to group the recommendations by.
Type: String
- items
-
List of all savings recommendations.
Type: Array of RecommendationSummary objects
- nextToken
-
The token to retrieve the next set of results.
Type: String
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
You are not authorized to use this operation with the given parameters.
HTTP Status Code: 400
- InternalServerException
-
An error on the server occurred during the processing of your request. Try again later.
HTTP Status Code: 500
- ThrottlingException
-
The request was denied due to request throttling.
HTTP Status Code: 400
- ValidationException
-
The input fails to satisfy the constraints specified by an AWS service.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
