Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

GetEBSVolumeRecommendations

Returns Amazon Elastic Block Store (Amazon EBS) volume recommendations.

AWS Compute Optimizer generates recommendations for Amazon EBS volumes that meet a specific set of requirements. For more information, see the Supported resources and requirements in the AWS Compute Optimizer User Guide.

Request Syntax


{
   "accountIds": [ "string" ],
   "filters": [ 
      { 
         "name": "string",
         "values": [ "string" ]
      }
   ],
   "maxResults": number,
   "nextToken": "string",
   "volumeArns": [ "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

The ID of the AWS account for which to return volume recommendations.

If your account is the management account of an organization, use this parameter to specify the member account for which you want to return volume recommendations.

Only one account ID can be specified per request.

Type: Array of strings

Required: No

filters

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

Type: Array of EBSFilter objects

Required: No

maxResults

The maximum number of volume 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 1000.

Required: No

nextToken

The token to advance to the next page of volume recommendations.

Type: String

Required: No

volumeArns

The Amazon Resource Name (ARN) of the volumes for which to return recommendations.

Type: Array of strings

Required: No

Response Syntax


{
   "errors": [ 
      { 
         "code": "string",
         "identifier": "string",
         "message": "string"
      }
   ],
   "nextToken": "string",
   "volumeRecommendations": [ 
      { 
         "accountId": "string",
         "currentConfiguration": { 
            "rootVolume": boolean,
            "volumeBaselineIOPS": number,
            "volumeBaselineThroughput": number,
            "volumeBurstIOPS": number,
            "volumeBurstThroughput": number,
            "volumeSize": number,
            "volumeType": "string"
         },
         "currentPerformanceRisk": "string",
         "effectiveRecommendationPreferences": { 
            "savingsEstimationMode": { 
               "source": "string"
            }
         },
         "finding": "string",
         "lastRefreshTimestamp": number,
         "lookBackPeriodInDays": number,
         "tags": [ 
            { 
               "key": "string",
               "value": "string"
            }
         ],
         "utilizationMetrics": [ 
            { 
               "name": "string",
               "statistic": "string",
               "value": number
            }
         ],
         "volumeArn": "string",
         "volumeRecommendationOptions": [ 
            { 
               "configuration": { 
                  "rootVolume": boolean,
                  "volumeBaselineIOPS": number,
                  "volumeBaselineThroughput": number,
                  "volumeBurstIOPS": number,
                  "volumeBurstThroughput": number,
                  "volumeSize": number,
                  "volumeType": "string"
               },
               "performanceRisk": number,
               "rank": number,
               "savingsOpportunity": { 
                  "estimatedMonthlySavings": { 
                     "currency": "string",
                     "value": number
                  },
                  "savingsOpportunityPercentage": number
               },
               "savingsOpportunityAfterDiscounts": { 
                  "estimatedMonthlySavings": { 
                     "currency": "string",
                     "value": number
                  },
                  "savingsOpportunityPercentage": number
               }
            }
         ]
      }
   ]
}

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.

For example, an error is returned if you request recommendations for an unsupported volume.

Type: Array of GetRecommendationError objects

nextToken

The token to use to advance to the next page of volume recommendations.

This value is null when there are no more pages of volume recommendations to return.

Type: String

volumeRecommendations

An array of objects that describe volume recommendations.

Type: Array of VolumeRecommendation objects

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