GetEC2InstanceRecommendations
Returns Amazon EC2 instance recommendations.
AWS Compute Optimizer generates recommendations for Amazon Elastic Compute Cloud (Amazon EC2) instances 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" ]
}
],
"instanceArns": [ "string" ],
"maxResults": number,
"nextToken": "string",
"recommendationPreferences": {
"cpuVendorArchitectures": [ "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 instance 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 instance 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 instance recommendations.
Type: Array of Filter objects
Required: No
- instanceArns
-
The Amazon Resource Name (ARN) of the instances for which to return recommendations.
Type: Array of strings
Required: No
- maxResults
-
The maximum number of instance recommendations to return with a single request.
To retrieve the remaining results, make another request with the returned
nextTokenvalue.Type: Integer
Valid Range: Minimum value of 0. Maximum value of 1000.
Required: No
- nextToken
-
The token to advance to the next page of instance recommendations.
Type: String
Required: No
- recommendationPreferences
-
An object to specify the preferences for the Amazon EC2 instance recommendations to return in the response.
Type: RecommendationPreferences object
Required: No
Response Syntax
{
"errors": [
{
"code": "string",
"identifier": "string",
"message": "string"
}
],
"instanceRecommendations": [
{
"accountId": "string",
"currentInstanceGpuInfo": {
"gpus": [
{
"gpuCount": number,
"gpuMemorySizeInMiB": number
}
]
},
"currentInstanceType": "string",
"currentPerformanceRisk": "string",
"effectiveRecommendationPreferences": {
"cpuVendorArchitectures": [ "string" ],
"enhancedInfrastructureMetrics": "string",
"externalMetricsPreference": {
"source": "string"
},
"inferredWorkloadTypes": "string",
"lookBackPeriod": "string",
"preferredResources": [
{
"effectiveIncludeList": [ "string" ],
"excludeList": [ "string" ],
"includeList": [ "string" ],
"name": "string"
}
],
"savingsEstimationMode": {
"source": "string"
},
"utilizationPreferences": [
{
"metricName": "string",
"metricParameters": {
"headroom": "string",
"threshold": "string"
}
}
]
},
"externalMetricStatus": {
"statusCode": "string",
"statusReason": "string"
},
"finding": "string",
"findingReasonCodes": [ "string" ],
"idle": "string",
"inferredWorkloadTypes": [ "string" ],
"instanceArn": "string",
"instanceName": "string",
"instanceState": "string",
"lastRefreshTimestamp": number,
"lookBackPeriodInDays": number,
"recommendationOptions": [
{
"instanceGpuInfo": {
"gpus": [
{
"gpuCount": number,
"gpuMemorySizeInMiB": number
}
]
},
"instanceType": "string",
"migrationEffort": "string",
"performanceRisk": number,
"platformDifferences": [ "string" ],
"projectedUtilizationMetrics": [
{
"name": "string",
"statistic": "string",
"value": number
}
],
"rank": number,
"savingsOpportunity": {
"estimatedMonthlySavings": {
"currency": "string",
"value": number
},
"savingsOpportunityPercentage": number
},
"savingsOpportunityAfterDiscounts": {
"estimatedMonthlySavings": {
"currency": "string",
"value": number
},
"savingsOpportunityPercentage": number
}
}
],
"recommendationSources": [
{
"recommendationSourceArn": "string",
"recommendationSourceType": "string"
}
],
"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.
For example, an error is returned if you request recommendations for an instance of an unsupported instance family.
Type: Array of GetRecommendationError objects
- instanceRecommendations
-
An array of objects that describe instance recommendations.
Type: Array of InstanceRecommendation objects
- nextToken
-
The token to use to advance to the next page of instance recommendations.
This value is null when there are no more pages of instance recommendations to return.
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
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
