RollbackInstanceRefreshCommand

Suggest an Edit

Cancels an instance refresh that is in progress and rolls back any changes that it made. Amazon EC2 Auto Scaling replaces any instances that were replaced during the instance refresh. This restores your Auto Scaling group to the configuration that it was using before the start of the instance refresh.

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.

A rollback is not supported in the following situations:

  • There is no desired configuration specified for the instance refresh.

  • The Auto Scaling group has a launch template that uses an Amazon Web Services Systems Manager parameter instead of an AMI ID for the ImageId property.

  • The Auto Scaling group uses the launch template's $Latest or $Default version.

When you receive a successful response from this operation, Amazon EC2 Auto Scaling immediately begins replacing instances. You can check the status of this operation through the DescribeInstanceRefreshes  API operation.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { AutoScalingClient, RollbackInstanceRefreshCommand } from "@aws-sdk/client-auto-scaling"; // ES Modules import
// const { AutoScalingClient, RollbackInstanceRefreshCommand } = require("@aws-sdk/client-auto-scaling"); // CommonJS import
const client = new AutoScalingClient(config);
const input = { // RollbackInstanceRefreshType
  AutoScalingGroupName: "STRING_VALUE", // required
};
const command = new RollbackInstanceRefreshCommand(input);
const response = await client.send(command);
// { // RollbackInstanceRefreshAnswer
//   InstanceRefreshId: "STRING_VALUE",
// };

RollbackInstanceRefreshCommand Input

See RollbackInstanceRefreshCommandInput for more details

Parameter
Type
Description
AutoScalingGroupName
Required
string | undefined

The name of the Auto Scaling group.

RollbackInstanceRefreshCommand Output

See RollbackInstanceRefreshCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
InstanceRefreshId
string | undefined

The instance refresh ID associated with the request. This is the unique ID assigned to the instance refresh when it was started.

Throws

Name
Fault
Details
ActiveInstanceRefreshNotFoundFault
client

The request failed because an active instance refresh or rollback for the specified Auto Scaling group was not found.

IrreversibleInstanceRefreshFault
client

The request failed because a desired configuration was not found or an incompatible launch template (uses a Systems Manager parameter instead of an AMI ID) or launch template version ($Latest or $Default) is present on the Auto Scaling group.

LimitExceededFault
client

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.

ResourceContentionFault
server

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

AutoScalingServiceException
Base exception class for all service exceptions from AutoScaling service.