# GetEC2InstanceRecommendations
<a name="API_GetEC2InstanceRecommendations"></a>

Returns Amazon EC2 instance recommendations.

 Amazon 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](https://docs.amazonaws.cn/compute-optimizer/latest/ug/requirements.html) in the * Amazon Compute Optimizer User Guide*.

## Request Syntax
<a name="API_GetEC2InstanceRecommendations_RequestSyntax"></a>

```
{
   "accountIds": [ "string" ],
   "filters": [ 
      { 
         "name": "string",
         "values": [ "string" ]
      }
   ],
   "instanceArns": [ "string" ],
   "maxResults": number,
   "nextToken": "string",
   "recommendationPreferences": { 
      "cpuVendorArchitectures": [ "string" ]
   }
}
```

## Request Parameters
<a name="API_GetEC2InstanceRecommendations_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [accountIds](#API_GetEC2InstanceRecommendations_RequestSyntax) **   <a name="computeoptimizer-GetEC2InstanceRecommendations-request-accountIds"></a>
The ID of the Amazon 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](#API_GetEC2InstanceRecommendations_RequestSyntax) **   <a name="computeoptimizer-GetEC2InstanceRecommendations-request-filters"></a>
An array of objects to specify a filter that returns a more specific list of instance recommendations.  
Type: Array of [Filter](API_Filter.md) objects  
Required: No

 ** [instanceArns](#API_GetEC2InstanceRecommendations_RequestSyntax) **   <a name="computeoptimizer-GetEC2InstanceRecommendations-request-instanceArns"></a>
The Amazon Resource Name (ARN) of the instances for which to return recommendations.  
Type: Array of strings  
Required: No

 ** [maxResults](#API_GetEC2InstanceRecommendations_RequestSyntax) **   <a name="computeoptimizer-GetEC2InstanceRecommendations-request-maxResults"></a>
The maximum number of instance 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](#API_GetEC2InstanceRecommendations_RequestSyntax) **   <a name="computeoptimizer-GetEC2InstanceRecommendations-request-nextToken"></a>
The token to advance to the next page of instance recommendations.  
Type: String  
Required: No

 ** [recommendationPreferences](#API_GetEC2InstanceRecommendations_RequestSyntax) **   <a name="computeoptimizer-GetEC2InstanceRecommendations-request-recommendationPreferences"></a>
An object to specify the preferences for the Amazon EC2 instance recommendations to return in the response.  
Type: [RecommendationPreferences](API_RecommendationPreferences.md) object  
Required: No

## Response Syntax
<a name="API_GetEC2InstanceRecommendations_ResponseSyntax"></a>

```
{
   "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
<a name="API_GetEC2InstanceRecommendations_ResponseElements"></a>

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](#API_GetEC2InstanceRecommendations_ResponseSyntax) **   <a name="computeoptimizer-GetEC2InstanceRecommendations-response-errors"></a>
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](API_GetRecommendationError.md) objects

 ** [instanceRecommendations](#API_GetEC2InstanceRecommendations_ResponseSyntax) **   <a name="computeoptimizer-GetEC2InstanceRecommendations-response-instanceRecommendations"></a>
An array of objects that describe instance recommendations.  
Type: Array of [InstanceRecommendation](API_InstanceRecommendation.md) objects

 ** [nextToken](#API_GetEC2InstanceRecommendations_ResponseSyntax) **   <a name="computeoptimizer-GetEC2InstanceRecommendations-response-nextToken"></a>
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
<a name="API_GetEC2InstanceRecommendations_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** 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) Amazon access key ID or X.509 certificate.  
HTTP Status Code: 400

 ** OptInRequiredException **   
The account is not opted in to Amazon 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
<a name="API_GetEC2InstanceRecommendations_SeeAlso"></a>

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon Command Line Interface V2](https://docs.amazonaws.cn/goto/cli2/compute-optimizer-2019-11-01/GetEC2InstanceRecommendations) 
+  [Amazon SDK for .NET V4](https://docs.amazonaws.cn/goto/DotNetSDKV4/compute-optimizer-2019-11-01/GetEC2InstanceRecommendations) 
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/compute-optimizer-2019-11-01/GetEC2InstanceRecommendations) 
+  [Amazon SDK for Go v2](https://docs.amazonaws.cn/goto/SdkForGoV2/compute-optimizer-2019-11-01/GetEC2InstanceRecommendations) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/compute-optimizer-2019-11-01/GetEC2InstanceRecommendations) 
+  [Amazon SDK for JavaScript V3](https://docs.amazonaws.cn/goto/SdkForJavaScriptV3/compute-optimizer-2019-11-01/GetEC2InstanceRecommendations) 
+  [Amazon SDK for Kotlin](https://docs.amazonaws.cn/goto/SdkForKotlin/compute-optimizer-2019-11-01/GetEC2InstanceRecommendations) 
+  [Amazon SDK for PHP V3](https://docs.amazonaws.cn/goto/SdkForPHPV3/compute-optimizer-2019-11-01/GetEC2InstanceRecommendations) 
+  [Amazon SDK for Python](https://docs.amazonaws.cn/goto/boto3/compute-optimizer-2019-11-01/GetEC2InstanceRecommendations) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/compute-optimizer-2019-11-01/GetEC2InstanceRecommendations)