AmazonAutoScalingClient.CancelInstanceRefresh Method (CancelInstanceRefreshRequest)

Cancels an instance refresh or rollback that is in progress. If an instance refresh or rollback is not in progress, an ActiveInstanceRefreshNotFound error occurs.

This operation is part of the instance refresh feature in Amazon EC2 Auto Scaling, which helps you update instances in your Auto Scaling group after you make configuration changes.

When you cancel an instance refresh, this does not roll back any changes that it made. Use the RollbackInstanceRefresh API to roll back instead.

Note:

For .NET Core this operation is only available in asynchronous form. Please refer to CancelInstanceRefreshAsync.

Namespace: Amazon.AutoScaling
Assembly: AWSSDK.AutoScaling.dll
Version: 3.x.y.z

Syntax

public virtual CancelInstanceRefreshResponse CancelInstanceRefresh(
         CancelInstanceRefreshRequest request
)

Parameters

request: Type: Amazon.AutoScaling.Model.CancelInstanceRefreshRequest

Container for the necessary parameters to execute the CancelInstanceRefresh service method.

Return Value

Type: CancelInstanceRefreshResponse

The response from the CancelInstanceRefresh service method, as returned by AutoScaling.

Exceptions

Exception	Condition
ActiveInstanceRefreshNotFoundException	The request failed because an active instance refresh or rollback for the specified Auto Scaling group was not found.
LimitExceededException	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 in the Amazon EC2 Auto Scaling API Reference.
ResourceContentionException	You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling group, instance, or load balancer).

Examples

This example cancels an instance refresh operation in progress.

To cancel an instance refresh


var client = new AmazonAutoScalingClient();
var response = client.CancelInstanceRefresh(new CancelInstanceRefreshRequest 
{
    AutoScalingGroupName = "my-auto-scaling-group"
});

string instanceRefreshId = response.InstanceRefreshId;

Version Information

.NET Framework:
Supported in: 4.5, 4.0, 3.5

AmazonAutoScalingClient.CancelInstanceRefresh (CancelInstanceRefreshRequest)

Method