Amazon EC2 Auto Scaling
API Reference (API Version 2011-01-01)

The AWS Documentation website is getting a new look!
Try it now and let us know what you think. Switch to the new look >>

You can return to the original look by selecting English in the language selector above.

DescribeAutoScalingGroups

Describes one or more Auto Scaling groups.

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

AutoScalingGroupNames.member.N

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.

Type: Array of strings

Length Constraints: Minimum length of 1. Maximum length of 1600.

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Required: No

MaxRecords

The maximum number of items to return with this call. The default value is 50 and the maximum value is 100.

Type: Integer

Required: No

NextToken

The token for the next set of items to return. (You received this token from a previous call.)

Type: String

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Required: No

Response Elements

The following elements are returned by the service.

AutoScalingGroups.member.N

The groups.

Type: Array of AutoScalingGroup objects

NextToken

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.

Type: String

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Errors

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

InvalidNextToken

The NextToken value is not valid.

HTTP Status Code: 400

ResourceContention

You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling group, instance, or load balancer).

HTTP Status Code: 500

Example

Sample Request

https://autoscaling.amazonaws.com/?Action=DescribeAutoScalingGroups &AutoScalingGroupNames.member.1=my-asg &Version=2011-01-01 &AUTHPARAMS

Sample Response

<DescribeAutoScalingGroupsResponse xmlns="http://autoscaling.amazonaws.com/doc/2011-01-01/"> <DescribeAutoScalingGroupsResult> <AutoScalingGroups> <member> <HealthCheckType>ELB</HealthCheckType> <LoadBalancerNames> <member>my-loadbalancer</member> </LoadBalancerNames> <Instances> <member> <LaunchConfigurationName>my-lc</LaunchConfigurationName> <LifecycleState>InService</LifecycleState> <InstanceId>i-12345678</InstanceId> <ProtectedFromScaleIn>false</ProtectedFromScaleIn> <AvailabilityZone>us-east-1c</AvailabilityZone> </member> </Instances> <TerminationPolicies> <member>Default</member> </TerminationPolicies> <DefaultCooldown>300</DefaultCooldown> <AutoScalingGroupARN>arn:aws:autoscaling:us-east-1:123456789012:autoScalingGroup:12345678-1234-1234-1234-123456789012:autoScalingGroupName/my-asg</AutoScalingGroupARN> <EnabledMetrics /> <AvailabilityZones> <member>us-east-1b</member> <member>us-east-1a</member> </AvailabilityZones> <Tags> <member> <ResourceId>my-asg</ResourceId> <PropagateAtLaunch>true</PropagateAtLaunch> <Value>test</Value> <Key>environment</Key> <ResourceType>auto-scaling-group</ResourceType> </member> </Tags> <LaunchConfigurationName>my-lc</LaunchConfigurationName> <AutoScalingGroupName>my-asg</AutoScalingGroupName> <HealthCheckGracePeriod>300</HealthCheckGracePeriod> <NewInstancesProtectedFromScaleIn>false</NewInstancesProtectedFromScaleIn> <SuspendedProcesses /> <CreatedTime>2015-05-06T17:47:15.107Z</CreatedTime> <MinSize>2</MinSize> <MaxSize>10</MaxSize> <DesiredCapacity>2</DesiredCapacity> <VPCZoneIdentifier>subnet-12345678,subnet-98765432</VPCZoneIdentifier> </member> </AutoScalingGroups> </DescribeAutoScalingGroupsResult> <ResponseMetadata> <RequestId>7c6e177f-f082-11e1-ac58-3714bEXAMPLE</RequestId> </ResponseMetadata> </DescribeAutoScalingGroupsResponse>

See Also

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