GetEC2RecommendationProjectedMetrics - AWS Compute Optimizer


Returns the projected utilization metrics of Amazon EC2 instance recommendations.


The Cpu and Memory metrics are the only projected utilization metrics returned when you run this action. Additionally, the Memory metric is returned only for resources that have the unified CloudWatch agent installed on them. For more information, see Enabling Memory Utilization with the CloudWatch Agent.

Request Syntax

{ "endTime": number, "instanceArn": "string", "period": number, "recommendationPreferences": { "cpuVendorArchitectures": [ "string" ] }, "startTime": number, "stat": "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.


The timestamp of the last projected metrics data point to return.

Type: Timestamp

Required: Yes


The Amazon Resource Name (ARN) of the instances for which to return recommendation projected metrics.

Type: String

Required: Yes


The granularity, in seconds, of the projected metrics data points.

Type: Integer

Required: Yes


An object to specify the preferences for the Amazon EC2 recommendation projected metrics to return in the response.

Type: RecommendationPreferences object

Required: No


The timestamp of the first projected metrics data point to return.

Type: Timestamp

Required: Yes


The statistic of the projected metrics.

Type: String

Valid Values: Maximum | Average

Required: Yes

Response Syntax

{ "recommendedOptionProjectedMetrics": [ { "projectedMetrics": [ { "name": "string", "timestamps": [ number ], "values": [ number ] } ], "rank": number, "recommendedInstanceType": "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.


An array of objects that describes projected metrics.

Type: Array of RecommendedOptionProjectedMetric objects


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


You do not have sufficient access to perform this action.

HTTP Status Code: 400


An internal error has occurred. Try your call again.

HTTP Status Code: 500


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

HTTP Status Code: 400


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

HTTP Status Code: 400


The account is not opted in to AWS Compute Optimizer.

HTTP Status Code: 400


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

HTTP Status Code: 400


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

HTTP Status Code: 500


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: