Menu
Auto Scaling
API Reference (API Version 2011-01-01)

EnterStandby

Moves the specified instances into the standby state.

For more information, see Temporarily Removing Instances from Your Auto Scaling Group in the 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 1600.

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

Required: Yes

InstanceIds.member.N

One or more instances to move into Standby mode. You must specify at least one instance ID.

Type: Array of strings

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

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

Required: No

ShouldDecrementDesiredCapacity

Specifies whether the instances moved to Standby mode count as part of the Auto Scaling group's desired capacity. If set, the desired capacity for the Auto Scaling group decrements by the number of instances moved to Standby mode.

Type: Boolean

Required: Yes

Response Elements

The following element is returned by the service.

Activities.member.N

The activities related to moving instances into Standby mode.

Type: Array of Activity objects

Errors

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

ResourceContention

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

HTTP Status Code: 500

Example

Sample Request

Copy
https://autoscaling.amazonaws.com/?Action=EnterStandby &AutoScalingGroupName=my-asg &InstanceIds.member.1=i-12345678 &ShouldDecrementDesiredCapacity=true &Version=2011-01-01 &AUTHPARAMS

Sample Response

Copy
<EnterStandbyResponse xmlns="http://autoscaling.amazonaws.com/doc/2011-01-01/"> <EnterStandbyResult> <Activities> <member> <ActivityId>12345678-1234-1234-1234-123456789012</ActivityId> <AutoScalingGroupName>my-asg</AutoScalingGroupName> <Description>Moving EC2 instance to Standby: i-12345678</Description> <Progress>50</Progress> <Cause>At 2015-06-13T22:35:50Z instance i-5b73d709 was moved to standby in response to a user request, shrinking the capacity from 4 to 3.</Cause> <StartTime>2015-06-13T22:35:50.884Z</StartTime> <Details>{"Availability Zone":"us-east-1a","SubnetID":"subnet-12345678"}</Details> <StatusCode>InProgress</StatusCode> </member> </Activities> </EnterStandbyResult> <ResponseMetadata> <RequestId>7c6e177f-f082-11e1-ac58-3714bEXAMPLE</RequestId> </ResponseMetadata> </EnterStandbyResponse>

See Also

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