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

DetachInstances

Removes one or more instances from the specified Auto Scaling group.

After the instances are detached, you can manage them independent of the Auto Scaling group.

If you do not specify the option to decrement the desired capacity, Auto Scaling launches instances to replace the ones that are detached.

If there is a Classic Load Balancer attached to the Auto Scaling group, the instances are deregistered from the load balancer. If there are target groups attached to the Auto Scaling group, the instances are deregistered from the target groups.

For more information, see Detach EC2 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 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 instance IDs.

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

If True, the Auto Scaling group decrements the desired capacity value by the number of instances detached.

Type: Boolean

Required: Yes

Response Elements

The following element is returned by the service.

Activities.member.N

The activities related to detaching the instances from the Auto Scaling group.

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=DetachInstances &AutoScalingGroupName=my-asg &InstanceIds.member.1=i-12345678 &ShouldDecrementDesiredCapacity=true &Version=2011-01-01 &AUTHPARAMS

Sample Response

Copy
<DetachInstancesResponse xmlns="http://autoscaling.amazonaws.com/doc/2011-01-01/"> <DetachInstancesResult> <Activities> <member> <ActivityId>12345678-1234-1234-1234-123456789012</ActivityId> <AutoScalingGroupName>my-asg</AutoScalingGroupName> <Description>Detaching EC2 instance: i-12345678</Description> <Cause>At 2015-06-14T00:07:30Z instance i-12345678 was detached in response to a user request, shrinking the capacity from 4 to 3.</Cause> <Progress>50</Progress> <StartTime>2015-06-14T00:07:30.280Z</StartTime> <Details>{"Availability Zone":"us-east-1a","SubnetID":"subnet-12345678"}</Details> <StatusCode>InProgress</StatusCode> </member> </Activities> </DetachInstancesResult> <ResponseMetadata> <RequestId>7c6e177f-f082-11e1-ac58-3714bEXAMPLE</RequestId> </ResponseMetadata> </DetachInstancesResponse>

See Also

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