Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

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,
   "metrics": [ "string" ],
   "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 to be returned for the request.

Type: Integer

Valid Range: Minimum value of 0. Maximum value of 1000.

Required: No

metrics

Additional metrics to be returned for the request. The only valid value is savingsPercentage.

Type: Array of strings

Array Members: Minimum number of 1 item. Maximum number of 100 items.

Valid Values: SavingsPercentage

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
      }
   ],
   "metrics": { 
      "savingsPercentage": "string"
   },
   "nextToken": "string"
}