Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

Note: You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . compute-optimizer ]

get-auto-scaling-group-recommendations

Description

Returns Auto Scaling group recommendations.

AWS Compute Optimizer generates recommendations for Amazon EC2 Auto Scaling groups that meet a specific set of requirements. For more information, see the Supported resources and requirements in the AWS Compute Optimizer User Guide .

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  get-auto-scaling-group-recommendations
[--account-ids <value>]
[--auto-scaling-group-arns <value>]
[--next-token <value>]
[--max-results <value>]
[--filters <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--account-ids (list)

The IDs of the AWS accounts for which to return Auto Scaling group recommendations.

If your account is the management account of an organization, use this parameter to specify the member accounts for which you want to return Auto Scaling group recommendations.

Only one account ID can be specified per request.

(string)

Syntax:

"string" "string" ...

--auto-scaling-group-arns (list)

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

(string)

Syntax:

"string" "string" ...

--next-token (string)

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

--max-results (integer)

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

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

--filters (list)

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

(structure)

Describes a filter that returns a more specific list of recommendations.

This filter is used with the GetAutoScalingGroupRecommendations and GetEC2InstanceRecommendations actions.

name -> (string)

The name of the filter.

Specify Finding to return recommendations with a specific finding classification (e.g., Overprovisioned ).

Specify RecommendationSourceType to return recommendations of a specific resource type (e.g., AutoScalingGroup ).

values -> (list)

The value of the filter.

The valid values for this parameter are as follows, depending on what you specify for the name parameter and the resource type that you wish to filter results for:

  • Specify Optimized or NotOptimized if you specified the name parameter as Finding and you want to filter results for Auto Scaling groups.
  • Specify Underprovisioned , Overprovisioned , or Optimized if you specified the name parameter as Finding and you want to filter results for EC2 instances.
  • Specify Ec2Instance or AutoScalingGroup if you specified the name parameter as RecommendationSourceType .

(string)

Shorthand Syntax:

name=string,values=string,string ...

JSON Syntax:

[
  {
    "name": "Finding"|"RecommendationSourceType",
    "values": ["string", ...]
  }
  ...
]

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.

Output

nextToken -> (string)

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.

autoScalingGroupRecommendations -> (list)

An array of objects that describe Auto Scaling group recommendations.

(structure)

Describes an Auto Scaling group recommendation.

accountId -> (string)

The AWS account ID of the Auto Scaling group.

autoScalingGroupArn -> (string)

The Amazon Resource Name (ARN) of the Auto Scaling group.

autoScalingGroupName -> (string)

The name of the Auto Scaling group.

finding -> (string)

The finding classification for the Auto Scaling group.

Findings for Auto Scaling groups include:

  • **NotOptimized ** —An Auto Scaling group is considered not optimized when AWS Compute Optimizer identifies a recommendation that can provide better performance for your workload.
  • **Optimized ** —An Auto Scaling group is considered optimized when Compute Optimizer determines that the group is correctly provisioned to run your workload based on the chosen instance type. For optimized resources, Compute Optimizer might recommend a new generation instance type.

utilizationMetrics -> (list)

An array of objects that describe the utilization metrics of the Auto Scaling group.

(structure)

Describes a utilization metric of a resource, such as an Amazon EC2 instance.

Compare the utilization metric data of your resource against its projected utilization metric data to determine the performance difference between your current resource and the recommended option.

name -> (string)

The name of the utilization metric.

The following utilization metrics are available:

  • Cpu - The percentage of allocated EC2 compute units that are currently in use on the instance. This metric identifies the processing power required to run an application on the instance. Depending on the instance type, tools in your operating system can show a lower percentage than CloudWatch when the instance is not allocated a full processor core. Units: Percent
  • Memory - The percentage of memory that is currently in use on the instance. This metric identifies the amount of memory required to run an application on the instance. Units: Percent

Note

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 .

  • EBS_READ_OPS_PER_SECOND - The completed read operations from all EBS volumes attached to the instance in a specified period of time. Unit: Count
  • EBS_WRITE_OPS_PER_SECOND - The completed write operations to all EBS volumes attached to the instance in a specified period of time. Unit: Count
  • EBS_READ_BYTES_PER_SECOND - The bytes read from all EBS volumes attached to the instance in a specified period of time. Unit: Bytes
  • EBS_WRITE_BYTES_PER_SECOND - The bytes written to all EBS volumes attached to the instance in a specified period of time. Unit: Bytes

statistic -> (string)

The statistic of the utilization metric.

The following statistics are available:

  • Average - This is the value of Sum / SampleCount during the specified period, or the average value observed during the specified period.
  • Maximum - The highest value observed during the specified period. Use this value to determine high volumes of activity for your application.

value -> (double)

The value of the utilization metric.

lookBackPeriodInDays -> (double)

The number of days for which utilization metrics were analyzed for the Auto Scaling group.

currentConfiguration -> (structure)

An array of objects that describe the current configuration of the Auto Scaling group.

desiredCapacity -> (integer)

The desired capacity, or number of instances, for the Auto Scaling group.

minSize -> (integer)

The minimum size, or minimum number of instances, for the Auto Scaling group.

maxSize -> (integer)

The maximum size, or maximum number of instances, for the Auto Scaling group.

instanceType -> (string)

The instance type for the Auto Scaling group.

recommendationOptions -> (list)

An array of objects that describe the recommendation options for the Auto Scaling group.

(structure)

Describes a recommendation option for an Auto Scaling group.

configuration -> (structure)

An array of objects that describe an Auto Scaling group configuration.

desiredCapacity -> (integer)

The desired capacity, or number of instances, for the Auto Scaling group.

minSize -> (integer)

The minimum size, or minimum number of instances, for the Auto Scaling group.

maxSize -> (integer)

The maximum size, or maximum number of instances, for the Auto Scaling group.

instanceType -> (string)

The instance type for the Auto Scaling group.

projectedUtilizationMetrics -> (list)

An array of objects that describe the projected utilization metrics of the Auto Scaling group recommendation option.

Note

The Cpu and Memory metrics are the only projected utilization metrics returned. 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 .

(structure)

Describes a utilization metric of a resource, such as an Amazon EC2 instance.

Compare the utilization metric data of your resource against its projected utilization metric data to determine the performance difference between your current resource and the recommended option.

name -> (string)

The name of the utilization metric.

The following utilization metrics are available:

  • Cpu - The percentage of allocated EC2 compute units that are currently in use on the instance. This metric identifies the processing power required to run an application on the instance. Depending on the instance type, tools in your operating system can show a lower percentage than CloudWatch when the instance is not allocated a full processor core. Units: Percent
  • Memory - The percentage of memory that is currently in use on the instance. This metric identifies the amount of memory required to run an application on the instance. Units: Percent

Note

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 .

  • EBS_READ_OPS_PER_SECOND - The completed read operations from all EBS volumes attached to the instance in a specified period of time. Unit: Count
  • EBS_WRITE_OPS_PER_SECOND - The completed write operations to all EBS volumes attached to the instance in a specified period of time. Unit: Count
  • EBS_READ_BYTES_PER_SECOND - The bytes read from all EBS volumes attached to the instance in a specified period of time. Unit: Bytes
  • EBS_WRITE_BYTES_PER_SECOND - The bytes written to all EBS volumes attached to the instance in a specified period of time. Unit: Bytes

statistic -> (string)

The statistic of the utilization metric.

The following statistics are available:

  • Average - This is the value of Sum / SampleCount during the specified period, or the average value observed during the specified period.
  • Maximum - The highest value observed during the specified period. Use this value to determine high volumes of activity for your application.

value -> (double)

The value of the utilization metric.

performanceRisk -> (double)

The performance risk of the Auto Scaling group configuration recommendation.

Performance risk is the likelihood of the recommended instance type not meeting the performance requirement of your workload.

The lowest performance risk is categorized as 0 , and the highest as 5 .

rank -> (integer)

The rank of the Auto Scaling group recommendation option.

The top recommendation option is ranked as 1 .

lastRefreshTimestamp -> (timestamp)

The time stamp of when the Auto Scaling group recommendation was last refreshed.

errors -> (list)

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.

(structure)

Describes an error experienced when getting recommendations.

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

identifier -> (string)

The ID of the error.

code -> (string)

The error code.

message -> (string)

The message, or reason, for the error.