Table Of Contents

Feedback

User Guide

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

[ aws . autoscaling ]

describe-auto-scaling-groups

Description

Describes one or more Auto Scaling groups.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

describe-auto-scaling-groups is a paginated operation. Multiple API calls may be issued in order to retrieve the entire data set of results. You can disable pagination by providing the --no-paginate argument. When using --output text and the --query argument on a paginated response, the --query argument must extract data from the results of the following query expressions: AutoScalingGroups

Synopsis

  describe-auto-scaling-groups
[--auto-scaling-group-names <value>]
[--cli-input-json <value>]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]

Options

--auto-scaling-group-names (list)

The names of the Auto Scaling groups. Each name can be a maximum of 1600 characters. By default, you can only specify up to 50 names. You can optionally increase this limit using the MaxRecords parameter.

If you omit this parameter, all Auto Scaling groups are described.

Syntax:

"string" "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.

--starting-token (string)

A token to specify where to start paginating. This is the NextToken from a previously truncated response.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--page-size (integer)

The size of each page to get in the AWS service call. This does not affect the number of items returned in the command's output. Setting a smaller page size results in more calls to the AWS service, retrieving fewer items in each call. This can help prevent the AWS service calls from timing out.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--max-items (integer)

The total number of items to return in the command's output. If the total number of items available is more than the value specified, a NextToken is provided in the command's output. To resume pagination, provide the NextToken value in the starting-token argument of a subsequent command. Do not use the NextToken response element directly outside of the AWS CLI.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--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.

Examples

To get a description of an Auto Scaling group

This example describes the specified Auto Scaling group:

aws autoscaling describe-auto-scaling-groups --auto-scaling-group-name my-auto-scaling-group

This example describes the specified Auto Scaling groups. It allows you to specify up to 100 group names:

aws autoscaling describe-auto-scaling-groups --max-items 100 --auto-scaling-group-name "group1" "group2" "group3" "group4"

This example describes the Auto Scaling groups in the specified region, up to a maximum of 75 groups:

aws autoscaling describe-auto-scaling-groups --max-items 75 --region us-east-1

The following is example output:

{
    "AutoScalingGroups": [
        {
            "AutoScalingGroupARN": "arn:aws:autoscaling:us-west-2:123456789012:autoScalingGroup:930d940e-891e-4781-a11a-7b0acd480f03:autoScalingGroupName/my-auto-scaling-group",
            "HealthCheckGracePeriod": 300,
            "SuspendedProcesses": [],
            "DesiredCapacity": 1,
            "Tags": [],
            "EnabledMetrics": [],
            "LoadBalancerNames": [],
            "AutoScalingGroupName": "my-auto-scaling-group",
            "DefaultCooldown": 300,
            "MinSize": 0,
            "Instances": [
                {
                    "InstanceId": "i-4ba0837f",
                    "AvailabilityZone": "us-west-2c",
                    "HealthStatus": "Healthy",
                    "LifecycleState": "InService",
                    "LaunchConfigurationName": "my-launch-config"
                }
            ],
            "MaxSize": 1,
            "VPCZoneIdentifier": null,
            "TerminationPolicies": [
                "Default"
            ],
            "LaunchConfigurationName": "my-launch-config",
            "CreatedTime": "2013-08-19T20:53:25.584Z",
            "AvailabilityZones": [
                "us-west-2c"
            ],
            "HealthCheckType": "EC2",
            "NewInstancesProtectedFromScaleIn": false
        }
    ]
}

To return a specific number of Auto Scaling groups, use the max-items parameter:

aws autoscaling describe-auto-scaling-groups --max-items 1

If the output includes a NextToken field, there are more groups. To get the additional groups, use the value of this field with the starting-token parameter in a subsequent call as follows:

aws autoscaling describe-auto-scaling-groups --starting-token Z3M3LMPEXAMPLE

Output

AutoScalingGroups -> (list)

The groups.

(structure)

Describes an Auto Scaling group.

AutoScalingGroupName -> (string)

The name of the Auto Scaling group.

AutoScalingGroupARN -> (string)

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

LaunchConfigurationName -> (string)

The name of the associated launch configuration.

LaunchTemplate -> (structure)

The launch template for the group.

LaunchTemplateId -> (string)

The ID of the launch template. You must specify either a template ID or a template name.

LaunchTemplateName -> (string)

The name of the launch template. You must specify either a template name or a template ID.

Version -> (string)

The version number, $Latest , or $Default . If the value is $Latest , Amazon EC2 Auto Scaling selects the latest version of the launch template when launching instances. If the value is $Default , Amazon EC2 Auto Scaling selects the default version of the launch template when launching instances. The default value is $Default .

MixedInstancesPolicy -> (structure)

The mixed instances policy for the group.

LaunchTemplate -> (structure)

The launch template and overrides.

This parameter is required when creating an Auto Scaling group with a mixed instances policy, but is not required when updating the group.

LaunchTemplateSpecification -> (structure)

The launch template to use. You must specify either the launch template ID or launch template name in the request.

LaunchTemplateId -> (string)

The ID of the launch template. You must specify either a template ID or a template name.

LaunchTemplateName -> (string)

The name of the launch template. You must specify either a template name or a template ID.

Version -> (string)

The version number, $Latest , or $Default . If the value is $Latest , Amazon EC2 Auto Scaling selects the latest version of the launch template when launching instances. If the value is $Default , Amazon EC2 Auto Scaling selects the default version of the launch template when launching instances. The default value is $Default .

Overrides -> (list)

Any parameters that you specify override the same parameters in the launch template. Currently, the only supported override is instance type.

You must specify between 2 and 20 overrides.

(structure)

Describes an override for a launch template.

InstanceType -> (string)

The instance type.

For information about available instance types, see Available Instance Types in the Amazon Elastic Compute Cloud User Guide.

InstancesDistribution -> (structure)

The instances distribution to use.

If you leave this parameter unspecified when creating the group, the default values are used.

OnDemandAllocationStrategy -> (string)

Indicates how to allocate instance types to fulfill On-Demand capacity.

The only valid value is prioritized , which is also the default value. This strategy uses the order of instance type overrides for the LaunchTemplate to define the launch priority of each instance type. The first instance type in the array is prioritized higher than the last. If all your On-Demand capacity cannot be fulfilled using your highest priority instance, then the Auto Scaling groups launches the remaining capacity using the second priority instance type, and so on.

OnDemandBaseCapacity -> (integer)

The minimum amount of the Auto Scaling group's capacity that must be fulfilled by On-Demand Instances. This base portion is provisioned first as your group scales.

The default value is 0 . If you leave this parameter set to 0 , On-Demand Instances are launched as a percentage of the Auto Scaling group's desired capacity, per the OnDemandPercentageAboveBaseCapacity setting.

OnDemandPercentageAboveBaseCapacity -> (integer)

Controls the percentages of On-Demand Instances and Spot Instances for your additional capacity beyond OnDemandBaseCapacity .

The range is 0–100. The default value is 100 . If you leave this parameter set to 100 , the percentages are 100% for On-Demand Instances and 0% for Spot Instances.

SpotAllocationStrategy -> (string)

Indicates how to allocate Spot capacity across Spot pools.

The only valid value is lowest-price , which is also the default value. The Auto Scaling group selects the cheapest Spot pools and evenly allocates your Spot capacity across the number of Spot pools that you specify.

SpotInstancePools -> (integer)

The number of Spot pools to use to allocate your Spot capacity. The Spot pools are determined from the different instance types in the Overrides array of LaunchTemplate .

The range is 1–20 and the default is 2.

SpotMaxPrice -> (string)

The maximum price per unit hour that you are willing to pay for a Spot Instance. If you leave the value of this parameter blank (which is the default), the maximum Spot price is set at the On-Demand price.

To remove a value that you previously set, include the parameter but leave the value blank.

MinSize -> (integer)

The minimum size of the group.

MaxSize -> (integer)

The maximum size of the group.

DesiredCapacity -> (integer)

The desired size of the group.

DefaultCooldown -> (integer)

The amount of time, in seconds, after a scaling activity completes before another scaling activity can start.

AvailabilityZones -> (list)

One or more Availability Zones for the group.

(string)

LoadBalancerNames -> (list)

One or more load balancers associated with the group.

(string)

TargetGroupARNs -> (list)

The Amazon Resource Names (ARN) of the target groups for your load balancer.

(string)

HealthCheckType -> (string)

The service to use for the health checks. The valid values are EC2 and ELB . If you configure an Auto Scaling group to use ELB health checks, it considers the instance unhealthy if it fails either the EC2 status checks or the load balancer health checks.

HealthCheckGracePeriod -> (integer)

The amount of time, in seconds, that Amazon EC2 Auto Scaling waits before checking the health status of an EC2 instance that has come into service.

Instances -> (list)

The EC2 instances associated with the group.

(structure)

Describes an EC2 instance.

InstanceId -> (string)

The ID of the instance.

AvailabilityZone -> (string)

The Availability Zone in which the instance is running.

LifecycleState -> (string)

A description of the current lifecycle state. The Quarantined state is not used.

HealthStatus -> (string)

The last reported health status of the instance. "Healthy" means that the instance is healthy and should remain in service. "Unhealthy" means that the instance is unhealthy and that Amazon EC2 Auto Scaling should terminate and replace it.

LaunchConfigurationName -> (string)

The launch configuration associated with the instance.

LaunchTemplate -> (structure)

The launch template for the instance.

LaunchTemplateId -> (string)

The ID of the launch template. You must specify either a template ID or a template name.

LaunchTemplateName -> (string)

The name of the launch template. You must specify either a template name or a template ID.

Version -> (string)

The version number, $Latest , or $Default . If the value is $Latest , Amazon EC2 Auto Scaling selects the latest version of the launch template when launching instances. If the value is $Default , Amazon EC2 Auto Scaling selects the default version of the launch template when launching instances. The default value is $Default .

ProtectedFromScaleIn -> (boolean)

Indicates whether the instance is protected from termination by Amazon EC2 Auto Scaling when scaling in.

CreatedTime -> (timestamp)

The date and time the group was created.

SuspendedProcesses -> (list)

The suspended processes associated with the group.

(structure)

Describes an automatic scaling process that has been suspended. For more information, see ProcessType .

ProcessName -> (string)

The name of the suspended process.

SuspensionReason -> (string)

The reason that the process was suspended.

PlacementGroup -> (string)

The name of the placement group into which to launch your instances, if any.

VPCZoneIdentifier -> (string)

One or more subnet IDs, if applicable, separated by commas.

EnabledMetrics -> (list)

The metrics enabled for the group.

(structure)

Describes an enabled metric.

Metric -> (string)

One of the following metrics:

  • GroupMinSize
  • GroupMaxSize
  • GroupDesiredCapacity
  • GroupInServiceInstances
  • GroupPendingInstances
  • GroupStandbyInstances
  • GroupTerminatingInstances
  • GroupTotalInstances

Granularity -> (string)

The granularity of the metric. The only valid value is 1Minute .

Status -> (string)

The current state of the group when DeleteAutoScalingGroup is in progress.

Tags -> (list)

The tags for the group.

(structure)

Describes a tag for an Auto Scaling group.

ResourceId -> (string)

The name of the group.

ResourceType -> (string)

The type of resource. The only supported value is auto-scaling-group .

Key -> (string)

The tag key.

Value -> (string)

The tag value.

PropagateAtLaunch -> (boolean)

Determines whether the tag is added to new instances as they are launched in the group.

TerminationPolicies -> (list)

The termination policies for the group.

(string)

NewInstancesProtectedFromScaleIn -> (boolean)

Indicates whether newly launched instances are protected from termination by Amazon EC2 Auto Scaling when scaling in.

ServiceLinkedRoleARN -> (string)

The Amazon Resource Name (ARN) of the service-linked role that the Auto Scaling group uses to call other AWS services on your behalf.

NextToken -> (string)

A string that indicates that the response contains more items than can be returned in a single response. To receive additional items, specify this string for the NextToken value when requesting the next set of items. This value is null when there are no more items to return.