GetAutoScalingGroupRecommendations - AWS Compute Optimizer

GetAutoScalingGroupRecommendations

Returns Auto Scaling group recommendations.

AWS Compute Optimizer currently generates recommendations for Auto Scaling groups that are configured to run instances of the M, C, R, T, and X instance families. The service does not generate recommendations for Auto Scaling groups that have a scaling policy attached to them, or that do not have the same values for desired, minimum, and maximum capacity. In order for Compute Optimizer to analyze your Auto Scaling groups, they must be of a fixed size. For more information, see the AWS Compute Optimizer User Guide.

Request Syntax

{ "accountIds": [ "string" ], "autoScalingGroupArns": [ "string" ], "filters": [ { "name": "string", "values": [ "string" ] } ], "maxResults": number, "nextToken": "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 AWS account IDs for which to return Auto Scaling group recommendations.

Only one account ID can be specified per request.

Type: Array of strings

Required: No

autoScalingGroupArns

The Amazon Resource Name (ARN) of the Auto Scaling groups for which to return recommendations.

Type: Array of strings

Required: No

filters

An array of objects that describe a filter that returns a more specific list of Auto Scaling group recommendations.

Type: Array of Filter objects

Required: No

maxResults

The maximum number of Auto Scaling group recommendations to return with a single call.

To retrieve the remaining results, make another call with the returned NextToken value.

Type: Integer

Required: No

nextToken

The token to advance to the next page of Auto Scaling group recommendations.

Type: String

Required: No

Response Syntax

{ "autoScalingGroupRecommendations": [ { "accountId": "string", "autoScalingGroupArn": "string", "autoScalingGroupName": "string", "currentConfiguration": { "desiredCapacity": number, "instanceType": "string", "maxSize": number, "minSize": number }, "finding": "string", "lastRefreshTimestamp": number, "lookBackPeriodInDays": number, "recommendationOptions": [ { "configuration": { "desiredCapacity": number, "instanceType": "string", "maxSize": number, "minSize": number }, "performanceRisk": number, "projectedUtilizationMetrics": [ { "name": "string", "statistic": "string", "value": number } ], "rank": number } ], "utilizationMetrics": [ { "name": "string", "statistic": "string", "value": number } ] } ], "errors": [ { "code": "string", "identifier": "string", "message": "string" } ], "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.

autoScalingGroupRecommendations

An array of objects that describe Auto Scaling group recommendations.

Type: Array of AutoScalingGroupRecommendation objects

errors

An array of objects that describe errors of the request.

For example, an error is returned if you request recommendations for an unsupported Auto Scaling group.

Type: Array of GetRecommendationError objects

nextToken

The token to use to advance to the next page of Auto Scaling group recommendations.

This value is null when there are no more pages of Auto Scaling group 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

The request processing has failed because of an unknown error, exception, or failure.

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

You must opt in to the service to perform this action.

HTTP Status Code: 400

ResourceNotFoundException

The specified resource was not found.

HTTP Status Code: 400

ServiceUnavailableException

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

HTTP Status Code: 500

ThrottlingException

The limit on the number of requests per second was exceeded.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: