Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

ListRecommendations

Returns a list of recommendations.

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"
         }
      ]
   },
   "includeAllRecommendations": boolean,
   "maxResults": number,
   "nextToken": "string",
   "orderBy": { 
      "dimension": "string",
      "order": "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

The constraints that you want all returned recommendations to match.

Type: Filter object

Required: No

includeAllRecommendations

List of all recommendations for a resource, or a single recommendation if de-duped by resourceId.

Type: Boolean

Required: No

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

orderBy

The ordering of recommendations by a dimension.

Type: OrderBy object

Required: No

Response Syntax


{
   "items": [ 
      { 
         "accountId": "string",
         "actionType": "string",
         "currencyCode": "string",
         "currentResourceSummary": "string",
         "currentResourceType": "string",
         "estimatedMonthlyCost": number,
         "estimatedMonthlySavings": number,
         "estimatedSavingsPercentage": number,
         "implementationEffort": "string",
         "lastRefreshTimestamp": number,
         "recommendationId": "string",
         "recommendationLookbackPeriodInDays": number,
         "recommendedResourceSummary": "string",
         "recommendedResourceType": "string",
         "region": "string",
         "resourceArn": "string",
         "resourceId": "string",
         "restartNeeded": boolean,
         "rollbackPossible": boolean,
         "source": "string",
         "tags": [ 
            { 
               "key": "string",
               "value": "string"
            }
         ]
      }
   ],
   "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.

items

List of all savings recommendations.

Type: Array of Recommendation 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.

fields: The list of fields that are invalid.
reason: The reason for the validation exception.

HTTP Status Code: 400