GetEC2RecommendationProjectedMetrics - AWS Compute Optimizer

GetEC2RecommendationProjectedMetrics

Returns the projected utilization metrics of Amazon EC2 instance recommendations.

Request Syntax

{ "endTime": number, "instanceArn": "string", "period": number, "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.

endTime

The time stamp of the last projected metrics data point to return.

Type: Timestamp

Required: Yes

instanceArn

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

Type: String

Required: Yes

period

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

Type: Integer

Required: Yes

startTime

The time stamp of the first projected metrics data point to return.

Type: Timestamp

Required: Yes

stat

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.

recommendedOptionProjectedMetrics

An array of objects that describe a projected metrics.

Type: Array of RecommendedOptionProjectedMetric 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

An invalid or out-of-range value was supplied for the input parameter.

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: