@aws-sdk/client-auto-scaling 3.267.0 → 3.271.0

package/dist-types/commands/RollbackInstanceRefreshCommand.d.ts

@@ -0,0 +1,59 @@
+import { EndpointParameterInstructions } from "@aws-sdk/middleware-endpoint";
+import { Command as $Command } from "@aws-sdk/smithy-client";
+import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
+import { AutoScalingClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../AutoScalingClient";
+import { RollbackInstanceRefreshAnswer, RollbackInstanceRefreshType } from "../models/models_0";
+export interface RollbackInstanceRefreshCommandInput extends RollbackInstanceRefreshType {
+}
+export interface RollbackInstanceRefreshCommandOutput extends RollbackInstanceRefreshAnswer, __MetadataBearer {
+}
+/**
+ * <p>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. </p>
+ *          <p>This operation is part of the <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-instance-refresh.html">instance refresh
+ *                 feature</a> in Amazon EC2 Auto Scaling, which helps you update instances in your Auto Scaling group
+ *             after you make configuration changes.</p>
+ *          <p>A rollback is not supported in the following situations: </p>
+ *          <ul>
+ *             <li>
+ *                <p>There is no desired configuration specified for the instance refresh.</p>
+ *             </li>
+ *             <li>
+ *                <p>The Auto Scaling group has a launch template that uses an Amazon Web Services Systems Manager
+ *                     parameter instead of an AMI ID for the <code>ImageId</code> property.</p>
+ *             </li>
+ *             <li>
+ *                <p>The Auto Scaling group uses the launch template's <code>$Latest</code> or
+ *                         <code>$Default</code> version.</p>
+ *             </li>
+ *          </ul>
+ *          <p>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 <a>DescribeInstanceRefreshes</a> API operation. </p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * 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 command = new RollbackInstanceRefreshCommand(input);
+ * const response = await client.send(command);
+ * ```
+ *
+ * @see {@link RollbackInstanceRefreshCommandInput} for command's `input` shape.
+ * @see {@link RollbackInstanceRefreshCommandOutput} for command's `response` shape.
+ * @see {@link AutoScalingClientResolvedConfig | config} for AutoScalingClient's `config` shape.
+ *
+ */
+export declare class RollbackInstanceRefreshCommand extends $Command<RollbackInstanceRefreshCommandInput, RollbackInstanceRefreshCommandOutput, AutoScalingClientResolvedConfig> {
+    readonly input: RollbackInstanceRefreshCommandInput;
+    static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    constructor(input: RollbackInstanceRefreshCommandInput);
+    /**
+     * @internal
+     */
+    resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: AutoScalingClientResolvedConfig, options?: __HttpHandlerOptions): Handler<RollbackInstanceRefreshCommandInput, RollbackInstanceRefreshCommandOutput>;
+    private serialize;
+    private deserialize;
+}

package/dist-types/commands/StartInstanceRefreshCommand.d.ts

@@ -8,21 +8,30 @@ export interface StartInstanceRefreshCommandInput extends StartInstanceRefreshTy
 export interface StartInstanceRefreshCommandOutput extends StartInstanceRefreshAnswer, __MetadataBearer {
 }
 /**
- * <p>Starts a new instance refresh operation. An instance refresh performs a rolling
- *             replacement of all or some instances in an Auto Scaling group. Each instance is terminated first
- *             and then replaced, which temporarily reduces the capacity available within your Auto Scaling
- *             group.</p>
+ * <p>Starts an instance refresh. During an instance refresh, Amazon EC2 Auto Scaling performs a rolling
+ *             update of instances in an Auto Scaling group. Instances are terminated first and then replaced,
+ *             which temporarily reduces the capacity available within your Auto Scaling group.</p>
  *          <p>This operation is part of the <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-instance-refresh.html">instance refresh
  *                 feature</a> in Amazon EC2 Auto Scaling, which helps you update instances in your Auto Scaling group.
  *             This feature is helpful, for example, when you have a new AMI or a new user data script.
  *             You just need to create a new launch template that specifies the new AMI or user data
  *             script. Then start an instance refresh to immediately begin the process of updating
  *             instances in the group. </p>
- *          <p>If the call succeeds, it creates a new instance refresh request with a unique ID that
- *             you can use to track its progress. To query its status, call the <a>DescribeInstanceRefreshes</a> API. To describe the instance refreshes that
+ *          <p>If successful, the request's response contains a unique ID that you can use to track
+ *             the progress of the instance refresh. To query its status, call the <a>DescribeInstanceRefreshes</a> API. To describe the instance refreshes that
  *             have already run, call the <a>DescribeInstanceRefreshes</a> API. To cancel an
- *             instance refresh operation in progress, use the <a>CancelInstanceRefresh</a>
+ *             instance refresh that is in progress, use the <a>CancelInstanceRefresh</a>
  *             API. </p>
+ *          <p>An instance refresh might fail for several reasons, such as EC2 launch failures,
+ *             misconfigured health checks, or not ignoring or allowing the termination of instances
+ *             that are in <code>Standby</code> state or protected from scale in. You can monitor for
+ *             failed EC2 launches using the scaling activities. To find the scaling activities, call
+ *             the <a>DescribeScalingActivities</a> API.</p>
+ *          <p>If you enable auto rollback, your Auto Scaling group will be rolled back automatically when
+ *             the instance refresh fails. You can enable this feature before starting an instance
+ *             refresh by specifying the <code>AutoRollback</code> property in the instance refresh
+ *             preferences. Otherwise, to roll back an instance refresh before it finishes, use the
+ *                 <a>RollbackInstanceRefresh</a> API. </p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

package/dist-types/commands/index.d.ts

@@ -55,6 +55,7 @@ export * from "./PutScheduledUpdateGroupActionCommand";
 export * from "./PutWarmPoolCommand";
 export * from "./RecordLifecycleActionHeartbeatCommand";
 export * from "./ResumeProcessesCommand";
+export * from "./RollbackInstanceRefreshCommand";
 export * from "./SetDesiredCapacityCommand";
 export * from "./SetInstanceHealthCommand";
 export * from "./SetInstanceProtectionCommand";

package/dist-types/endpoint/EndpointParameters.d.ts

@@ -12,7 +12,7 @@ export declare const resolveClientEndpointParameters: <T>(options: T & ClientInp
     defaultSigningName: string;
 };
 export interface EndpointParameters extends __EndpointParameters {
-    Region: string;
+    Region?: string;
     UseDualStack?: boolean;
     UseFIPS?: boolean;
     Endpoint?: string;