Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

GetIdleRecommendations

Returns idle resource recommendations. AWS Compute Optimizer generates recommendations for idle resources that meet a specific set of requirements. For more information, see Resource requirements in the AWS Compute Optimizer User Guide

Request Syntax


{
   "accountIds": [ "string" ],
   "filters": [ 
      { 
         "name": "string",
         "values": [ "string" ]
      }
   ],
   "maxResults": number,
   "nextToken": "string",
   "orderBy": { 
      "dimension": "string",
      "order": "string"
   },
   "resourceArns": [ "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.

accountIds

Return the idle resource recommendations to the specified AWS account IDs.

If your account is the management account or the delegated administrator of an organization, use this parameter to return the idle resource recommendations to specific member accounts.

You can only specify one account ID per request.

Type: Array of strings

Required: No

filters

An array of objects to specify a filter that returns a more specific list of idle resource recommendations.

Type: Array of IdleRecommendationFilter objects

Required: No

maxResults

The maximum number of idle resource recommendations to return with a single request.

To retrieve the remaining results, make another request with the returned nextToken value.

Type: Integer

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

Required: No

nextToken

The token to advance to the next page of idle resource recommendations.

Type: String

Required: No

orderBy

The order to sort the idle resource recommendations.

Type: OrderBy object

Required: No

resourceArns

The ARN that identifies the idle resource.

Type: Array of strings

Required: No

Response Syntax


{
   "errors": [ 
      { 
         "code": "string",
         "identifier": "string",
         "message": "string",
         "resourceType": "string"
      }
   ],
   "idleRecommendations": [ 
      { 
         "accountId": "string",
         "finding": "string",
         "findingDescription": "string",
         "lastRefreshTimestamp": number,
         "lookBackPeriodInDays": number,
         "resourceArn": "string",
         "resourceId": "string",
         "resourceType": "string",
         "savingsOpportunity": { 
            "estimatedMonthlySavings": { 
               "currency": "string",
               "value": number
            },
            "savingsOpportunityPercentage": number
         },
         "savingsOpportunityAfterDiscounts": { 
            "estimatedMonthlySavings": { 
               "currency": "string",
               "value": number
            },
            "savingsOpportunityPercentage": number
         },
         "tags": [ 
            { 
               "key": "string",
               "value": "string"
            }
         ],
         "utilizationMetrics": [ 
            { 
               "name": "string",
               "statistic": "string",
               "value": 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.

errors

An array of objects that describe errors of the request.

Type: Array of IdleRecommendationError objects

idleRecommendations

An array of objects that describe the idle resource recommendations.

Type: Array of IdleRecommendation objects

nextToken

The token to advance to the next page of idle resource recommendations.

Type: String

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

You do not have sufficient access to perform this action.

HTTP Status Code: 400

InternalServerException

An internal error has occurred. Try your call again.

HTTP Status Code: 500

InvalidParameterValueException

The value supplied for the input parameter is out of range or not valid.

HTTP Status Code: 400

MissingAuthenticationToken

The request must contain either a valid (registered) AWS access key ID or X.509 certificate.

HTTP Status Code: 400

OptInRequiredException

The account is not opted in to AWS Compute Optimizer.

HTTP Status Code: 400

ResourceNotFoundException

A resource that is required for the action doesn't exist.

HTTP Status Code: 400

ServiceUnavailableException

The request has failed due to a temporary failure of the server.

HTTP Status Code: 500

ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 400