Request Parameters Response Elements Errors Examples See Also

DescribeWarmPool

Gets information about a warm pool and its instances.

For more information, see Warm pools for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.

Request Parameters

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

AutoScalingGroupName

The name of the Auto Scaling group.

Type: String

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

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

Required: Yes

MaxRecords

The maximum number of instances to return with this call. The maximum value is 50.

Type: Integer

Required: No

NextToken

The token for the next set of instances 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.

Instances.member.N

The instances that are currently in the warm pool.

Type: Array of Instance objects

NextToken

This string 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]*

WarmPoolConfiguration

The warm pool configuration details.

Type: WarmPoolConfiguration object

Errors

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

InvalidNextToken

The NextToken value is not valid.

message

HTTP Status Code: 400

LimitExceeded

You have already reached a limit for your Amazon EC2 Auto Scaling resources (for example, Auto Scaling groups, launch configurations, or lifecycle hooks). For more information, see DescribeAccountLimits.

message

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

message

HTTP Status Code: 500

Examples

Example

This example illustrates one usage of DescribeWarmPool.

Sample Request


https://autoscaling.amazonaws.com/?Action=DescribeWarmPool
&AutoScalingGroupName=my-asg
&Version=2011-01-01
&AUTHPARAMS

Sample Response


<DescribeWarmPoolResponse xmlns="https://autoscaling.amazonaws.com/doc/2011-01-01/">
  <DescribeWarmPoolResult>
    <WarmPoolConfiguration>
      <MinSize>30</MinSize>
      <MaxGroupPreparedCapacity>0</MaxGroupPreparedCapacity>
      <PoolState>Hibernated</PoolState>
    </WarmPoolConfiguration>
    <Instances />
  </DescribeWarmPoolResult>
  <ResponseMetadata>
    <RequestId>9351b5ea-b4c0-4a88-b873-c51e4EXAMPLE</RequestId>
  </ResponseMetadata>
</DescribeWarmPoolResponse>