@aws-sdk/client-auto-scaling 3.50.0 → 3.53.0

package/dist-types/models/models_0.d.ts

@@ -1,4 +1,5 @@
-import { MetadataBearer as $MetadataBearer, SmithyException as __SmithyException } from "@aws-sdk/types";
+import { ExceptionOptionType as __ExceptionOptionType } from "@aws-sdk/smithy-client";
+import { AutoScalingServiceException as __BaseException } from "./AutoScalingServiceException";
 /**
  * <p>Specifies the minimum and maximum for the <code>AcceleratorCount</code> object when
  *             you specify <a>InstanceRequirements</a> for an Auto Scaling group.</p>
@@ -63,10 +64,13 @@ export declare enum AcceleratorType {
  * <p>The request failed because an active instance refresh for the specified Auto Scaling group was
  *             not found. </p>
  */
-export interface ActiveInstanceRefreshNotFoundFault extends __SmithyException, $MetadataBearer {
-    name: "ActiveInstanceRefreshNotFoundFault";
-    $fault: "client";
-    message?: string;
+export declare class ActiveInstanceRefreshNotFoundFault extends __BaseException {
+    readonly name: "ActiveInstanceRefreshNotFoundFault";
+    readonly $fault: "client";
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<ActiveInstanceRefreshNotFoundFault, __BaseException>);
 }
 export declare enum ScalingActivityStatusCode {
     Cancelled = "Cancelled",
@@ -213,13 +217,13 @@ export declare namespace Alarm {
 /**
  * <p>You already have an Auto Scaling group or launch configuration with this name.</p>
  */
-export interface AlreadyExistsFault extends __SmithyException, $MetadataBearer {
-    name: "AlreadyExistsFault";
-    $fault: "client";
+export declare class AlreadyExistsFault extends __BaseException {
+    readonly name: "AlreadyExistsFault";
+    readonly $fault: "client";
     /**
-     * <p></p>
+     * @internal
      */
-    message?: string;
+    constructor(opts: __ExceptionOptionType<AlreadyExistsFault, __BaseException>);
 }
 export interface AttachInstancesQuery {
     /**
@@ -241,21 +245,24 @@ export declare namespace AttachInstancesQuery {
  * <p>You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling group,
  *             instance, or load balancer).</p>
  */
-export interface ResourceContentionFault extends __SmithyException, $MetadataBearer {
-    name: "ResourceContentionFault";
-    $fault: "server";
+export declare class ResourceContentionFault extends __BaseException {
+    readonly name: "ResourceContentionFault";
+    readonly $fault: "server";
     /**
-     * <p></p>
+     * @internal
      */
-    message?: string;
+    constructor(opts: __ExceptionOptionType<ResourceContentionFault, __BaseException>);
 }
 /**
  * <p>The service-linked role is not yet ready for use.</p>
  */
-export interface ServiceLinkedRoleFailure extends __SmithyException, $MetadataBearer {
-    name: "ServiceLinkedRoleFailure";
-    $fault: "server";
-    message?: string;
+export declare class ServiceLinkedRoleFailure extends __BaseException {
+    readonly name: "ServiceLinkedRoleFailure";
+    readonly $fault: "server";
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<ServiceLinkedRoleFailure, __BaseException>);
 }
 export interface AttachLoadBalancersResultType {
 }
@@ -455,13 +462,13 @@ export declare namespace BatchPutScheduledUpdateGroupActionType {
  *             more information, see <a href="https://docs.aws.amazon.com/autoscaling/ec2/APIReference/API_DescribeAccountLimits.html">DescribeAccountLimits</a> in the <i>Amazon EC2 Auto Scaling API
  *             Reference</i>.</p>
  */
-export interface LimitExceededFault extends __SmithyException, $MetadataBearer {
-    name: "LimitExceededFault";
-    $fault: "client";
+export declare class LimitExceededFault extends __BaseException {
+    readonly name: "LimitExceededFault";
+    readonly $fault: "client";
     /**
-     * <p></p>
+     * @internal
      */
-    message?: string;
+    constructor(opts: __ExceptionOptionType<LimitExceededFault, __BaseException>);
 }
 export interface CancelInstanceRefreshAnswer {
     /**
@@ -616,7 +623,9 @@ export interface LifecycleHookSpecification {
     NotificationTargetARN?: string;
     /**
      * <p>The ARN of the IAM role that allows the Auto Scaling group to publish to the specified
-     *             notification target, for example, an Amazon SNS topic or an Amazon SQS queue.</p>
+     *             notification target.</p>
+     *         <p>Valid only if the notification target is an Amazon SNS topic or an Amazon SQS queue. Required
+     *             for new lifecycle hooks, but optional when updating existing hooks.</p>
      */
     RoleARN?: string;
 }
@@ -932,6 +941,9 @@ export interface InstanceRequirements {
      *             attributes, we will exclude instance types whose price is higher than your threshold.
      *             The parameter accepts an integer, which Amazon EC2 Auto Scaling interprets as a percentage. To turn off
      *             price protection, specify a high value, such as <code>999999</code>. </p>
+     *         <p>If you set <code>DesiredCapacityType</code> to <code>vcpu</code> or
+     *                 <code>memory-mib</code>, the price protection threshold is applied based on the per
+     *             vCPU or per memory price instead of the per instance price. </p>
      *         <p>Default: <code>100</code>
      *          </p>
      */
@@ -943,6 +955,9 @@ export interface InstanceRequirements {
      *             your attributes, we will exclude instance types whose price is higher than your
      *             threshold. The parameter accepts an integer, which Amazon EC2 Auto Scaling interprets as a percentage.
      *             To turn off price protection, specify a high value, such as <code>999999</code>. </p>
+     *         <p>If you set <code>DesiredCapacityType</code> to <code>vcpu</code> or
+     *                 <code>memory-mib</code>, the price protection threshold is applied based on the per
+     *             vCPU or per memory price instead of the per instance price. </p>
      *         <p>Default: <code>20</code>
      *          </p>
      */
@@ -1118,17 +1133,15 @@ export interface LaunchTemplateOverrides {
      *             overage. For example, if there are two units remaining to fulfill capacity, and Amazon EC2 Auto Scaling
      *             can only launch an instance with a <code>WeightedCapacity</code> of five units, the
      *             instance is launched, and the desired capacity is exceeded by three units. For more
-     *             information, see <a href="https://docs.aws.amazon.com/ec2-auto-scaling-mixed-instances-groups-instance-weighting.html">Instance weighting for
-     *                 Amazon EC2 Auto Scaling</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>. Value must be in the
-     *             range of 1–999.</p>
+     *             information, see <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-mixed-instances-groups-instance-weighting.html">Configuring instance weighting for Amazon EC2 Auto Scaling</a> in the
+     *                 <i>Amazon EC2 Auto Scaling User Guide</i>. Value must be in the range of 1–999.</p>
      */
     WeightedCapacity?: string;
     /**
-     * <p>Provides the launch template to be used when launching the instance type specified in
-     *                 <code>InstanceType</code>. For example, some instance types might require a launch
-     *             template with a different AMI. If not provided, Amazon EC2 Auto Scaling uses the launch template that's
-     *             defined for your mixed instances policy. For more information, see <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-mixed-instances-groups-launch-template-overrides.html">Specifying a
-     *                 different launch template for an instance type</a> in the
+     * <p>Provides a launch template for the specified instance type or instance requirements.
+     *             For example, some instance types might require a launch template with a different AMI.
+     *             If not provided, Amazon EC2 Auto Scaling uses the launch template that's defined for your mixed
+     *             instances policy. For more information, see <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-mixed-instances-groups-launch-template-overrides.html">Specifying a different launch template for an instance type</a> in the
      *                 <i>Amazon EC2 Auto Scaling User Guide</i>. </p>
      */
     LaunchTemplateSpecification?: LaunchTemplateSpecification;
@@ -1258,9 +1271,9 @@ export interface CreateAutoScalingGroupType {
      *
      *
      *
-     *         <p>For more information, see <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-mixed-instances-groups.html">Auto Scaling groups with multiple
-     *                 instance types and purchase options</a> in the <i>Amazon EC2 Auto Scaling User
-     *                 Guide</i>.</p>
+     *         <p>For more information, see <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-mixed-instances-groups.html">Auto Scaling
+     *                 groups with multiple instance types and purchase options</a> in the
+     *                 <i>Amazon EC2 Auto Scaling User Guide</i>.</p>
      */
     MixedInstancesPolicy?: MixedInstancesPolicy;
     /**
@@ -1335,7 +1348,7 @@ export interface CreateAutoScalingGroupType {
      *             of an EC2 instance that has come into service and marking it unhealthy due to a failed
      *             health check. The default value is <code>0</code>. For more information, see <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/healthcheck.html#health-check-grace-period">Health
      *                 check grace period</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>
-     *         <p>Conditional: Required if you are adding an <code>ELB</code> health check.</p>
+     *         <p>Required if you are adding an <code>ELB</code> health check.</p>
      */
     HealthCheckGracePeriod?: number;
     /**
@@ -1832,13 +1845,13 @@ export declare namespace CreateOrUpdateTagsType {
 /**
  * <p>The operation can't be performed because the resource is in use.</p>
  */
-export interface ResourceInUseFault extends __SmithyException, $MetadataBearer {
-    name: "ResourceInUseFault";
-    $fault: "client";
+export declare class ResourceInUseFault extends __BaseException {
+    readonly name: "ResourceInUseFault";
+    readonly $fault: "client";
     /**
-     * <p></p>
+     * @internal
      */
-    message?: string;
+    constructor(opts: __ExceptionOptionType<ResourceInUseFault, __BaseException>);
 }
 export interface DeleteAutoScalingGroupType {
     /**
@@ -1862,13 +1875,13 @@ export declare namespace DeleteAutoScalingGroupType {
  * <p>The operation can't be performed because there are scaling activities in
  *             progress.</p>
  */
-export interface ScalingActivityInProgressFault extends __SmithyException, $MetadataBearer {
-    name: "ScalingActivityInProgressFault";
-    $fault: "client";
+export declare class ScalingActivityInProgressFault extends __BaseException {
+    readonly name: "ScalingActivityInProgressFault";
+    readonly $fault: "client";
     /**
-     * <p></p>
+     * @internal
      */
-    message?: string;
+    constructor(opts: __ExceptionOptionType<ScalingActivityInProgressFault, __BaseException>);
 }
 export interface LaunchConfigurationNameType {
     /**
@@ -2278,6 +2291,7 @@ export declare enum LifecycleState {
     TERMINATING = "Terminating",
     TERMINATING_PROCEED = "Terminating:Proceed",
     TERMINATING_WAIT = "Terminating:Wait",
+    WARMED_HIBERNATED = "Warmed:Hibernated",
     WARMED_PENDING = "Warmed:Pending",
     WARMED_PENDING_PROCEED = "Warmed:Pending:Proceed",
     WARMED_PENDING_WAIT = "Warmed:Pending:Wait",
@@ -2395,7 +2409,26 @@ export declare namespace TagDescription {
      */
     const filterSensitiveLog: (obj: TagDescription) => any;
 }
+/**
+ * <p>Describes an instance reuse policy for a warm pool. </p>
+ *         <p>For more information, see <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-warm-pools.html">Warm pools for
+ *                 Amazon EC2 Auto Scaling</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>
+ */
+export interface InstanceReusePolicy {
+    /**
+     * <p>Specifies whether instances in the Auto Scaling group can be returned to the warm pool on
+     *             scale in. </p>
+     */
+    ReuseOnScaleIn?: boolean;
+}
+export declare namespace InstanceReusePolicy {
+    /**
+     * @internal
+     */
+    const filterSensitiveLog: (obj: InstanceReusePolicy) => any;
+}
 export declare enum WarmPoolState {
+    Hibernated = "Hibernated",
     Running = "Running",
     Stopped = "Stopped"
 }
@@ -2423,6 +2456,10 @@ export interface WarmPoolConfiguration {
      * <p>The status of a warm pool that is marked for deletion.</p>
      */
     Status?: WarmPoolStatus | string;
+    /**
+     * <p>The instance reuse policy.</p>
+     */
+    InstanceReusePolicy?: InstanceReusePolicy;
 }
 export declare namespace WarmPoolConfiguration {
     /**
@@ -2608,13 +2645,13 @@ export declare namespace AutoScalingGroupsType {
 /**
  * <p>The <code>NextToken</code> value is not valid.</p>
  */
-export interface InvalidNextToken extends __SmithyException, $MetadataBearer {
-    name: "InvalidNextToken";
-    $fault: "client";
+export declare class InvalidNextToken extends __BaseException {
+    readonly name: "InvalidNextToken";
+    readonly $fault: "client";
     /**
-     * <p></p>
+     * @internal
      */
-    message?: string;
+    constructor(opts: __ExceptionOptionType<InvalidNextToken, __BaseException>);
 }
 /**
  * <p>Describes an EC2 instance associated with an Auto Scaling group.</p>
@@ -3211,9 +3248,10 @@ export declare namespace LaunchConfigurationsType {
     const filterSensitiveLog: (obj: LaunchConfigurationsType) => any;
 }
 /**
- * <p>Describes a lifecycle hook, which enables an Auto Scaling group to be aware of events in the
- *             Auto Scaling instance lifecycle, and then perform a custom action when the corresponding
- *             lifecycle event occurs.</p>
+ * <p>Describes a lifecycle hook. A lifecycle hook lets you create solutions that are aware
+ *             of events in the Auto Scaling instance lifecycle, and then perform a custom action on instances
+ *             when the corresponding lifecycle event
+ *             occurs.</p>
  */
 export interface LifecycleHook {
     /**
@@ -3245,7 +3283,7 @@ export interface LifecycleHook {
     NotificationTargetARN?: string;
     /**
      * <p>The ARN of the IAM role that allows the Auto Scaling group to publish to the specified
-     *             notification target.</p>
+     *             notification target (an Amazon SNS topic or an Amazon SQS queue).</p>
      */
     RoleARN?: string;
     /**
@@ -4428,18 +4466,18 @@ export interface PredefinedMetricSpecification {
      *             </li>
      *             <li>
      *                 <p>
-     *                   <code>ASGAverageNetworkIn</code> - Average number of bytes received on all
-     *                     network interfaces by the Auto Scaling group.</p>
+     *                   <code>ASGAverageNetworkIn</code> - Average number of bytes received (per
+     *                     instance per minute) for the Auto Scaling group.</p>
      *             </li>
      *             <li>
      *                 <p>
-     *                   <code>ASGAverageNetworkOut</code> - Average number of bytes sent out on all
-     *                     network interfaces by the Auto Scaling group.</p>
+     *                   <code>ASGAverageNetworkOut</code> - Average number of bytes sent out (per
+     *                     instance per minute) for the Auto Scaling group.</p>
      *             </li>
      *             <li>
      *                 <p>
-     *                   <code>ALBRequestCountPerTarget</code> - Number of requests completed per
-     *                     target in an Application Load Balancer target group.</p>
+     *                   <code>ALBRequestCountPerTarget</code> - Average Application Load Balancer request count (per
+     *                     target per minute) for your Auto Scaling group.</p>
      *             </li>
      *          </ul>
      */
@@ -4491,6 +4529,13 @@ export interface TargetTrackingConfiguration {
     CustomizedMetricSpecification?: CustomizedMetricSpecification;
     /**
      * <p>The target value for the metric.</p>
+     *         <note>
+     *             <p>Some metrics are based on a count instead of a percentage, such as the request
+     *                 count for an Application Load Balancer or the number of messages in an SQS queue. If the scaling policy
+     *                 specifies one of these metrics, specify the target utilization as the optimal
+     *                 average request or message count per instance during any one-minute interval.
+     *             </p>
+     *         </note>
      */
     TargetValue: number | undefined;
     /**
@@ -4808,14 +4853,12 @@ export interface ScheduledUpdateGroupAction {
     Time?: Date;
     /**
      * <p>The date and time in UTC for this action to start. For example,
-     *                 <code>"2019-06-01T00:00:00Z"</code>.
-     *             </p>
+     *                 <code>"2019-06-01T00:00:00Z"</code>. </p>
      */
     StartTime?: Date;
     /**
      * <p>The date and time in UTC for the recurring schedule to end. For example,
-     *                 <code>"2019-06-01T00:00:00Z"</code>.
-     *             </p>
+     *                 <code>"2019-06-01T00:00:00Z"</code>. </p>
      */
     EndTime?: Date;
     /**
@@ -5532,8 +5575,9 @@ export interface PutLifecycleHookType {
     LifecycleTransition?: string;
     /**
      * <p>The ARN of the IAM role that allows the Auto Scaling group to publish to the specified
-     *             notification target, for example, an Amazon SNS topic or an Amazon SQS queue.</p>
-     *         <p>Required for new lifecycle hooks, but optional when updating existing hooks.</p>
+     *             notification target.</p>
+     *         <p>Valid only if the notification target is an Amazon SNS topic or an Amazon SQS queue. Required
+     *             for new lifecycle hooks, but optional when updating existing hooks.</p>
      */
     RoleARN?: string;
     /**
@@ -5891,6 +5935,12 @@ export interface PutWarmPoolType {
      *             Default is <code>Stopped</code>.</p>
      */
     PoolState?: WarmPoolState | string;
+    /**
+     * <p>Indicates whether instances in the Auto Scaling group can be returned to the warm pool on
+     *             scale in. The default is to terminate instances in the Auto Scaling group when the group scales
+     *             in.</p>
+     */
+    InstanceReusePolicy?: InstanceReusePolicy;
 }
 export declare namespace PutWarmPoolType {
     /**
@@ -6081,10 +6131,13 @@ export declare namespace SetInstanceProtectionQuery {
  * <p>The request failed because an active instance refresh operation already exists for the
  *             specified Auto Scaling group.</p>
  */
-export interface InstanceRefreshInProgressFault extends __SmithyException, $MetadataBearer {
-    name: "InstanceRefreshInProgressFault";
-    $fault: "client";
-    message?: string;
+export declare class InstanceRefreshInProgressFault extends __BaseException {
+    readonly name: "InstanceRefreshInProgressFault";
+    readonly $fault: "client";
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<InstanceRefreshInProgressFault, __BaseException>);
 }
 export interface StartInstanceRefreshAnswer {
     /**
@@ -6178,9 +6231,9 @@ export interface UpdateAutoScalingGroupType {
     LaunchTemplate?: LaunchTemplateSpecification;
     /**
      * <p>An embedded object that specifies a mixed instances policy. For more information, see
-     *                 <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-mixed-instances-groups.html">Auto Scaling groups with multiple
-     *                 instance types and purchase options</a> in the <i>Amazon EC2 Auto Scaling User
-     *                 Guide</i>.</p>
+     *                 <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-mixed-instances-groups.html">Auto Scaling
+     *                 groups with multiple instance types and purchase options</a> in the
+     *                 <i>Amazon EC2 Auto Scaling User Guide</i>.</p>
      */
     MixedInstancesPolicy?: MixedInstancesPolicy;
     /**
@@ -6229,7 +6282,7 @@ export interface UpdateAutoScalingGroupType {
      *             of an EC2 instance that has come into service and marking it unhealthy due to a failed
      *             health check. The default value is <code>0</code>. For more information, see <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/healthcheck.html#health-check-grace-period">Health
      *                 check grace period</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>
-     *         <p>Conditional: Required if you are adding an <code>ELB</code> health check.</p>
+     *         <p>Required if you are adding an <code>ELB</code> health check.</p>
      */
     HealthCheckGracePeriod?: number;
     /**