@aws-sdk/client-auto-scaling 3.287.0 → 3.289.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (57) hide show
  1. package/dist-types/commands/AttachInstancesCommand.d.ts +14 -0
  2. package/dist-types/commands/AttachLoadBalancerTargetGroupsCommand.d.ts +14 -0
  3. package/dist-types/commands/AttachLoadBalancersCommand.d.ts +14 -0
  4. package/dist-types/commands/CancelInstanceRefreshCommand.d.ts +16 -0
  5. package/dist-types/commands/CompleteLifecycleActionCommand.d.ts +14 -0
  6. package/dist-types/commands/CreateAutoScalingGroupCommand.d.ts +85 -0
  7. package/dist-types/commands/CreateLaunchConfigurationCommand.d.ts +17 -0
  8. package/dist-types/commands/CreateOrUpdateTagsCommand.d.ts +26 -0
  9. package/dist-types/commands/DeleteAutoScalingGroupCommand.d.ts +23 -0
  10. package/dist-types/commands/DeleteLaunchConfigurationCommand.d.ts +11 -0
  11. package/dist-types/commands/DeleteLifecycleHookCommand.d.ts +12 -0
  12. package/dist-types/commands/DeleteNotificationConfigurationCommand.d.ts +12 -0
  13. package/dist-types/commands/DeletePolicyCommand.d.ts +12 -0
  14. package/dist-types/commands/DeleteScheduledActionCommand.d.ts +12 -0
  15. package/dist-types/commands/DeleteTagsCommand.d.ts +18 -0
  16. package/dist-types/commands/DescribeAccountLimitsCommand.d.ts +17 -0
  17. package/dist-types/commands/DescribeAdjustmentTypesCommand.d.ts +24 -0
  18. package/dist-types/commands/DescribeAutoScalingGroupsCommand.d.ts +53 -0
  19. package/dist-types/commands/DescribeAutoScalingInstancesCommand.d.ts +28 -0
  20. package/dist-types/commands/DescribeAutoScalingNotificationTypesCommand.d.ts +20 -0
  21. package/dist-types/commands/DescribeInstanceRefreshesCommand.d.ts +34 -0
  22. package/dist-types/commands/DescribeLaunchConfigurationsCommand.d.ts +35 -0
  23. package/dist-types/commands/DescribeLifecycleHookTypesCommand.d.ts +17 -0
  24. package/dist-types/commands/DescribeLifecycleHooksCommand.d.ts +27 -0
  25. package/dist-types/commands/DescribeLoadBalancerTargetGroupsCommand.d.ts +21 -0
  26. package/dist-types/commands/DescribeLoadBalancersCommand.d.ts +21 -0
  27. package/dist-types/commands/DescribeMetricCollectionTypesCommand.d.ts +44 -0
  28. package/dist-types/commands/DescribeNotificationConfigurationsCommand.d.ts +29 -0
  29. package/dist-types/commands/DescribePoliciesCommand.d.ts +35 -0
  30. package/dist-types/commands/DescribeScalingActivitiesCommand.d.ts +28 -0
  31. package/dist-types/commands/DescribeScalingProcessTypesCommand.d.ts +39 -0
  32. package/dist-types/commands/DescribeScheduledActionsCommand.d.ts +28 -0
  33. package/dist-types/commands/DescribeTagsCommand.d.ts +38 -0
  34. package/dist-types/commands/DescribeTerminationPolicyTypesCommand.d.ts +20 -0
  35. package/dist-types/commands/DetachInstancesCommand.d.ts +31 -0
  36. package/dist-types/commands/DetachLoadBalancerTargetGroupsCommand.d.ts +14 -0
  37. package/dist-types/commands/DetachLoadBalancersCommand.d.ts +14 -0
  38. package/dist-types/commands/DisableMetricsCollectionCommand.d.ts +14 -0
  39. package/dist-types/commands/EnableMetricsCollectionCommand.d.ts +12 -0
  40. package/dist-types/commands/EnterStandbyCommand.d.ts +31 -0
  41. package/dist-types/commands/ExecutePolicyCommand.d.ts +14 -0
  42. package/dist-types/commands/ExitStandbyCommand.d.ts +30 -0
  43. package/dist-types/commands/PutLifecycleHookCommand.d.ts +15 -0
  44. package/dist-types/commands/PutNotificationConfigurationCommand.d.ts +15 -0
  45. package/dist-types/commands/PutScalingPolicyCommand.d.ts +35 -0
  46. package/dist-types/commands/PutScheduledUpdateGroupActionCommand.d.ts +17 -0
  47. package/dist-types/commands/PutWarmPoolCommand.d.ts +16 -0
  48. package/dist-types/commands/RecordLifecycleActionHeartbeatCommand.d.ts +13 -0
  49. package/dist-types/commands/ResumeProcessesCommand.d.ts +14 -0
  50. package/dist-types/commands/SetDesiredCapacityCommand.d.ts +13 -0
  51. package/dist-types/commands/SetInstanceHealthCommand.d.ts +12 -0
  52. package/dist-types/commands/SetInstanceProtectionCommand.d.ts +30 -0
  53. package/dist-types/commands/StartInstanceRefreshCommand.d.ts +27 -0
  54. package/dist-types/commands/SuspendProcessesCommand.d.ts +14 -0
  55. package/dist-types/commands/TerminateInstanceInAutoScalingGroupCommand.d.ts +12 -0
  56. package/dist-types/commands/UpdateAutoScalingGroupCommand.d.ts +18 -0
  57. package/package.json +30 -30
@@ -38,6 +38,20 @@ export interface AttachInstancesCommandOutput extends __MetadataBearer {
38
38
  * @see {@link AttachInstancesCommandOutput} for command's `response` shape.
39
39
  * @see {@link AutoScalingClientResolvedConfig | config} for AutoScalingClient's `config` shape.
40
40
  *
41
+ * @example To attach an instance to an Auto Scaling group
42
+ * ```javascript
43
+ * // This example attaches the specified instance to the specified Auto Scaling group.
44
+ * const input = {
45
+ * "AutoScalingGroupName": "my-auto-scaling-group",
46
+ * "InstanceIds": [
47
+ * "i-93633f9b"
48
+ * ]
49
+ * };
50
+ * const command = new AttachInstancesCommand(input);
51
+ * await client.send(command);
52
+ * // example id: autoscaling-attach-instances-1
53
+ * ```
54
+ *
41
55
  */
42
56
  export declare class AttachInstancesCommand extends $Command<AttachInstancesCommandInput, AttachInstancesCommandOutput, AutoScalingClientResolvedConfig> {
43
57
  readonly input: AttachInstancesCommandInput;
@@ -50,6 +50,20 @@ export interface AttachLoadBalancerTargetGroupsCommandOutput extends AttachLoadB
50
50
  * @see {@link AttachLoadBalancerTargetGroupsCommandOutput} for command's `response` shape.
51
51
  * @see {@link AutoScalingClientResolvedConfig | config} for AutoScalingClient's `config` shape.
52
52
  *
53
+ * @example To attach a target group to an Auto Scaling group
54
+ * ```javascript
55
+ * // This example attaches the specified target group to the specified Auto Scaling group.
56
+ * const input = {
57
+ * "AutoScalingGroupName": "my-auto-scaling-group",
58
+ * "TargetGroupARNs": [
59
+ * "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067"
60
+ * ]
61
+ * };
62
+ * const command = new AttachLoadBalancerTargetGroupsCommand(input);
63
+ * await client.send(command);
64
+ * // example id: autoscaling-attach-load-balancer-target-groups-1
65
+ * ```
66
+ *
53
67
  */
54
68
  export declare class AttachLoadBalancerTargetGroupsCommand extends $Command<AttachLoadBalancerTargetGroupsCommandInput, AttachLoadBalancerTargetGroupsCommandOutput, AutoScalingClientResolvedConfig> {
55
69
  readonly input: AttachLoadBalancerTargetGroupsCommandInput;
@@ -40,6 +40,20 @@ export interface AttachLoadBalancersCommandOutput extends AttachLoadBalancersRes
40
40
  * @see {@link AttachLoadBalancersCommandOutput} for command's `response` shape.
41
41
  * @see {@link AutoScalingClientResolvedConfig | config} for AutoScalingClient's `config` shape.
42
42
  *
43
+ * @example To attach a load balancer to an Auto Scaling group
44
+ * ```javascript
45
+ * // This example attaches the specified load balancer to the specified Auto Scaling group.
46
+ * const input = {
47
+ * "AutoScalingGroupName": "my-auto-scaling-group",
48
+ * "LoadBalancerNames": [
49
+ * "my-load-balancer"
50
+ * ]
51
+ * };
52
+ * const command = new AttachLoadBalancersCommand(input);
53
+ * await client.send(command);
54
+ * // example id: autoscaling-attach-load-balancers-1
55
+ * ```
56
+ *
43
57
  */
44
58
  export declare class AttachLoadBalancersCommand extends $Command<AttachLoadBalancersCommandInput, AttachLoadBalancersCommandOutput, AutoScalingClientResolvedConfig> {
45
59
  readonly input: AttachLoadBalancersCommandInput;
@@ -36,6 +36,22 @@ export interface CancelInstanceRefreshCommandOutput extends CancelInstanceRefres
36
36
  * @see {@link CancelInstanceRefreshCommandOutput} for command's `response` shape.
37
37
  * @see {@link AutoScalingClientResolvedConfig | config} for AutoScalingClient's `config` shape.
38
38
  *
39
+ * @example To cancel an instance refresh
40
+ * ```javascript
41
+ * // This example cancels an instance refresh operation in progress.
42
+ * const input = {
43
+ * "AutoScalingGroupName": "my-auto-scaling-group"
44
+ * };
45
+ * const command = new CancelInstanceRefreshCommand(input);
46
+ * const response = await client.send(command);
47
+ * /* response ==
48
+ * {
49
+ * "InstanceRefreshId": "08b91cf7-8fa6-48af-b6a6-d227f40f1b9b"
50
+ * }
51
+ * *\/
52
+ * // example id: to-cancel-an-instance-refresh-1592960979817
53
+ * ```
54
+ *
39
55
  */
40
56
  export declare class CancelInstanceRefreshCommand extends $Command<CancelInstanceRefreshCommandInput, CancelInstanceRefreshCommandOutput, AutoScalingClientResolvedConfig> {
41
57
  readonly input: CancelInstanceRefreshCommandInput;
@@ -66,6 +66,20 @@ export interface CompleteLifecycleActionCommandOutput extends CompleteLifecycleA
66
66
  * @see {@link CompleteLifecycleActionCommandOutput} for command's `response` shape.
67
67
  * @see {@link AutoScalingClientResolvedConfig | config} for AutoScalingClient's `config` shape.
68
68
  *
69
+ * @example To complete the lifecycle action
70
+ * ```javascript
71
+ * // This example notifies Auto Scaling that the specified lifecycle action is complete so that it can finish launching or terminating the instance.
72
+ * const input = {
73
+ * "AutoScalingGroupName": "my-auto-scaling-group",
74
+ * "LifecycleActionResult": "CONTINUE",
75
+ * "LifecycleActionToken": "bcd2f1b8-9a78-44d3-8a7a-4dd07d7cf635",
76
+ * "LifecycleHookName": "my-lifecycle-hook"
77
+ * };
78
+ * const command = new CompleteLifecycleActionCommand(input);
79
+ * await client.send(command);
80
+ * // example id: autoscaling-complete-lifecycle-action-1
81
+ * ```
82
+ *
69
83
  */
70
84
  export declare class CompleteLifecycleActionCommand extends $Command<CompleteLifecycleActionCommandInput, CompleteLifecycleActionCommandOutput, AutoScalingClientResolvedConfig> {
71
85
  readonly input: CompleteLifecycleActionCommandInput;
@@ -46,6 +46,91 @@ export interface CreateAutoScalingGroupCommandOutput extends __MetadataBearer {
46
46
  * @see {@link CreateAutoScalingGroupCommandOutput} for command's `response` shape.
47
47
  * @see {@link AutoScalingClientResolvedConfig | config} for AutoScalingClient's `config` shape.
48
48
  *
49
+ * @example To create an Auto Scaling group
50
+ * ```javascript
51
+ * // This example creates an Auto Scaling group.
52
+ * const input = {
53
+ * "AutoScalingGroupName": "my-auto-scaling-group",
54
+ * "LaunchTemplate": {
55
+ * "LaunchTemplateName": "my-template-for-auto-scaling",
56
+ * "Version": "$Latest"
57
+ * },
58
+ * "MaxInstanceLifetime": 2592000,
59
+ * "MaxSize": 3,
60
+ * "MinSize": 1,
61
+ * "VPCZoneIdentifier": "subnet-057fa0918fEXAMPLE"
62
+ * };
63
+ * const command = new CreateAutoScalingGroupCommand(input);
64
+ * await client.send(command);
65
+ * // example id: autoscaling-create-auto-scaling-group-1
66
+ * ```
67
+ *
68
+ * @example To create an Auto Scaling group with an attached target group
69
+ * ```javascript
70
+ * // This example creates an Auto Scaling group and attaches the specified target group.
71
+ * const input = {
72
+ * "AutoScalingGroupName": "my-auto-scaling-group",
73
+ * "HealthCheckGracePeriod": 300,
74
+ * "HealthCheckType": "ELB",
75
+ * "LaunchTemplate": {
76
+ * "LaunchTemplateName": "my-template-for-auto-scaling",
77
+ * "Version": "$Latest"
78
+ * },
79
+ * "MaxSize": 3,
80
+ * "MinSize": 1,
81
+ * "TargetGroupARNs": [
82
+ * "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067"
83
+ * ],
84
+ * "VPCZoneIdentifier": "subnet-057fa0918fEXAMPLE, subnet-610acd08EXAMPLE"
85
+ * };
86
+ * const command = new CreateAutoScalingGroupCommand(input);
87
+ * await client.send(command);
88
+ * // example id: autoscaling-create-auto-scaling-group-2
89
+ * ```
90
+ *
91
+ * @example To create an Auto Scaling group with a mixed instances policy
92
+ * ```javascript
93
+ * // This example creates an Auto Scaling group with a mixed instances policy. It specifies the c5.large, c5a.large, and c6g.large instance types and defines a different launch template for the c6g.large instance type.
94
+ * const input = {
95
+ * "AutoScalingGroupName": "my-asg",
96
+ * "DesiredCapacity": 3,
97
+ * "MaxSize": 5,
98
+ * "MinSize": 1,
99
+ * "MixedInstancesPolicy": {
100
+ * "InstancesDistribution": {
101
+ * "OnDemandBaseCapacity": 1,
102
+ * "OnDemandPercentageAboveBaseCapacity": 50,
103
+ * "SpotAllocationStrategy": "capacity-optimized"
104
+ * },
105
+ * "LaunchTemplate": {
106
+ * "LaunchTemplateSpecification": {
107
+ * "LaunchTemplateName": "my-launch-template-for-x86",
108
+ * "Version": "$Latest"
109
+ * },
110
+ * "Overrides": [
111
+ * {
112
+ * "InstanceType": "c6g.large",
113
+ * "LaunchTemplateSpecification": {
114
+ * "LaunchTemplateName": "my-launch-template-for-arm",
115
+ * "Version": "$Latest"
116
+ * }
117
+ * },
118
+ * {
119
+ * "InstanceType": "c5.large"
120
+ * },
121
+ * {
122
+ * "InstanceType": "c5a.large"
123
+ * }
124
+ * ]
125
+ * }
126
+ * },
127
+ * "VPCZoneIdentifier": "subnet-057fa0918fEXAMPLE, subnet-610acd08EXAMPLE"
128
+ * };
129
+ * const command = new CreateAutoScalingGroupCommand(input);
130
+ * await client.send(command);
131
+ * // example id: to-create-an-auto-scaling-group-with-a-mixed-instances-policy-1617815269039
132
+ * ```
133
+ *
49
134
  */
50
135
  export declare class CreateAutoScalingGroupCommand extends $Command<CreateAutoScalingGroupCommandInput, CreateAutoScalingGroupCommandOutput, AutoScalingClientResolvedConfig> {
51
136
  readonly input: CreateAutoScalingGroupCommandInput;
@@ -41,6 +41,23 @@ export interface CreateLaunchConfigurationCommandOutput extends __MetadataBearer
41
41
  * @see {@link CreateLaunchConfigurationCommandOutput} for command's `response` shape.
42
42
  * @see {@link AutoScalingClientResolvedConfig | config} for AutoScalingClient's `config` shape.
43
43
  *
44
+ * @example To create a launch configuration
45
+ * ```javascript
46
+ * // This example creates a launch configuration.
47
+ * const input = {
48
+ * "IamInstanceProfile": "my-iam-role",
49
+ * "ImageId": "ami-12345678",
50
+ * "InstanceType": "m3.medium",
51
+ * "LaunchConfigurationName": "my-launch-config",
52
+ * "SecurityGroups": [
53
+ * "sg-eb2af88e"
54
+ * ]
55
+ * };
56
+ * const command = new CreateLaunchConfigurationCommand(input);
57
+ * await client.send(command);
58
+ * // example id: autoscaling-create-launch-configuration-1
59
+ * ```
60
+ *
44
61
  */
45
62
  export declare class CreateLaunchConfigurationCommand extends $Command<CreateLaunchConfigurationCommandInput, CreateLaunchConfigurationCommandOutput, AutoScalingClientResolvedConfig> {
46
63
  readonly input: CreateLaunchConfigurationCommandInput;
@@ -33,6 +33,32 @@ export interface CreateOrUpdateTagsCommandOutput extends __MetadataBearer {
33
33
  * @see {@link CreateOrUpdateTagsCommandOutput} for command's `response` shape.
34
34
  * @see {@link AutoScalingClientResolvedConfig | config} for AutoScalingClient's `config` shape.
35
35
  *
36
+ * @example To create or update tags for an Auto Scaling group
37
+ * ```javascript
38
+ * // This example adds two tags to the specified Auto Scaling group.
39
+ * const input = {
40
+ * "Tags": [
41
+ * {
42
+ * "Key": "Role",
43
+ * "PropagateAtLaunch": true,
44
+ * "ResourceId": "my-auto-scaling-group",
45
+ * "ResourceType": "auto-scaling-group",
46
+ * "Value": "WebServer"
47
+ * },
48
+ * {
49
+ * "Key": "Dept",
50
+ * "PropagateAtLaunch": true,
51
+ * "ResourceId": "my-auto-scaling-group",
52
+ * "ResourceType": "auto-scaling-group",
53
+ * "Value": "Research"
54
+ * }
55
+ * ]
56
+ * };
57
+ * const command = new CreateOrUpdateTagsCommand(input);
58
+ * await client.send(command);
59
+ * // example id: autoscaling-create-or-update-tags-1
60
+ * ```
61
+ *
36
62
  */
37
63
  export declare class CreateOrUpdateTagsCommand extends $Command<CreateOrUpdateTagsCommandInput, CreateOrUpdateTagsCommandOutput, AutoScalingClientResolvedConfig> {
38
64
  readonly input: CreateOrUpdateTagsCommandInput;
@@ -43,6 +43,29 @@ export interface DeleteAutoScalingGroupCommandOutput extends __MetadataBearer {
43
43
  * @see {@link DeleteAutoScalingGroupCommandOutput} for command's `response` shape.
44
44
  * @see {@link AutoScalingClientResolvedConfig | config} for AutoScalingClient's `config` shape.
45
45
  *
46
+ * @example To delete an Auto Scaling group
47
+ * ```javascript
48
+ * // This example deletes the specified Auto Scaling group.
49
+ * const input = {
50
+ * "AutoScalingGroupName": "my-auto-scaling-group"
51
+ * };
52
+ * const command = new DeleteAutoScalingGroupCommand(input);
53
+ * await client.send(command);
54
+ * // example id: autoscaling-delete-auto-scaling-group-1
55
+ * ```
56
+ *
57
+ * @example To delete an Auto Scaling group and all its instances
58
+ * ```javascript
59
+ * // This example deletes the specified Auto Scaling group and all its instances.
60
+ * const input = {
61
+ * "AutoScalingGroupName": "my-auto-scaling-group",
62
+ * "ForceDelete": true
63
+ * };
64
+ * const command = new DeleteAutoScalingGroupCommand(input);
65
+ * await client.send(command);
66
+ * // example id: autoscaling-delete-auto-scaling-group-2
67
+ * ```
68
+ *
46
69
  */
47
70
  export declare class DeleteAutoScalingGroupCommand extends $Command<DeleteAutoScalingGroupCommandInput, DeleteAutoScalingGroupCommandOutput, AutoScalingClientResolvedConfig> {
48
71
  readonly input: DeleteAutoScalingGroupCommandInput;
@@ -31,6 +31,17 @@ export interface DeleteLaunchConfigurationCommandOutput extends __MetadataBearer
31
31
  * @see {@link DeleteLaunchConfigurationCommandOutput} for command's `response` shape.
32
32
  * @see {@link AutoScalingClientResolvedConfig | config} for AutoScalingClient's `config` shape.
33
33
  *
34
+ * @example To delete a launch configuration
35
+ * ```javascript
36
+ * // This example deletes the specified launch configuration.
37
+ * const input = {
38
+ * "LaunchConfigurationName": "my-launch-config"
39
+ * };
40
+ * const command = new DeleteLaunchConfigurationCommand(input);
41
+ * await client.send(command);
42
+ * // example id: autoscaling-delete-launch-configuration-1
43
+ * ```
44
+ *
34
45
  */
35
46
  export declare class DeleteLaunchConfigurationCommand extends $Command<DeleteLaunchConfigurationCommandInput, DeleteLaunchConfigurationCommandOutput, AutoScalingClientResolvedConfig> {
36
47
  readonly input: DeleteLaunchConfigurationCommandInput;
@@ -32,6 +32,18 @@ export interface DeleteLifecycleHookCommandOutput extends DeleteLifecycleHookAns
32
32
  * @see {@link DeleteLifecycleHookCommandOutput} for command's `response` shape.
33
33
  * @see {@link AutoScalingClientResolvedConfig | config} for AutoScalingClient's `config` shape.
34
34
  *
35
+ * @example To delete a lifecycle hook
36
+ * ```javascript
37
+ * // This example deletes the specified lifecycle hook.
38
+ * const input = {
39
+ * "AutoScalingGroupName": "my-auto-scaling-group",
40
+ * "LifecycleHookName": "my-lifecycle-hook"
41
+ * };
42
+ * const command = new DeleteLifecycleHookCommand(input);
43
+ * await client.send(command);
44
+ * // example id: autoscaling-delete-lifecycle-hook-1
45
+ * ```
46
+ *
35
47
  */
36
48
  export declare class DeleteLifecycleHookCommand extends $Command<DeleteLifecycleHookCommandInput, DeleteLifecycleHookCommandOutput, AutoScalingClientResolvedConfig> {
37
49
  readonly input: DeleteLifecycleHookCommandInput;
@@ -29,6 +29,18 @@ export interface DeleteNotificationConfigurationCommandOutput extends __Metadata
29
29
  * @see {@link DeleteNotificationConfigurationCommandOutput} for command's `response` shape.
30
30
  * @see {@link AutoScalingClientResolvedConfig | config} for AutoScalingClient's `config` shape.
31
31
  *
32
+ * @example To delete an Auto Scaling notification
33
+ * ```javascript
34
+ * // This example deletes the specified notification from the specified Auto Scaling group.
35
+ * const input = {
36
+ * "AutoScalingGroupName": "my-auto-scaling-group",
37
+ * "TopicARN": "arn:aws:sns:us-west-2:123456789012:my-sns-topic"
38
+ * };
39
+ * const command = new DeleteNotificationConfigurationCommand(input);
40
+ * await client.send(command);
41
+ * // example id: autoscaling-delete-notification-configuration-1
42
+ * ```
43
+ *
32
44
  */
33
45
  export declare class DeleteNotificationConfigurationCommand extends $Command<DeleteNotificationConfigurationCommandInput, DeleteNotificationConfigurationCommandOutput, AutoScalingClientResolvedConfig> {
34
46
  readonly input: DeleteNotificationConfigurationCommandInput;
@@ -34,6 +34,18 @@ export interface DeletePolicyCommandOutput extends __MetadataBearer {
34
34
  * @see {@link DeletePolicyCommandOutput} for command's `response` shape.
35
35
  * @see {@link AutoScalingClientResolvedConfig | config} for AutoScalingClient's `config` shape.
36
36
  *
37
+ * @example To delete an Auto Scaling policy
38
+ * ```javascript
39
+ * // This example deletes the specified Auto Scaling policy.
40
+ * const input = {
41
+ * "AutoScalingGroupName": "my-auto-scaling-group",
42
+ * "PolicyName": "my-step-scale-out-policy"
43
+ * };
44
+ * const command = new DeletePolicyCommand(input);
45
+ * await client.send(command);
46
+ * // example id: autoscaling-delete-policy-1
47
+ * ```
48
+ *
37
49
  */
38
50
  export declare class DeletePolicyCommand extends $Command<DeletePolicyCommandInput, DeletePolicyCommandOutput, AutoScalingClientResolvedConfig> {
39
51
  readonly input: DeletePolicyCommandInput;
@@ -29,6 +29,18 @@ export interface DeleteScheduledActionCommandOutput extends __MetadataBearer {
29
29
  * @see {@link DeleteScheduledActionCommandOutput} for command's `response` shape.
30
30
  * @see {@link AutoScalingClientResolvedConfig | config} for AutoScalingClient's `config` shape.
31
31
  *
32
+ * @example To delete a scheduled action from an Auto Scaling group
33
+ * ```javascript
34
+ * // This example deletes the specified scheduled action from the specified Auto Scaling group.
35
+ * const input = {
36
+ * "AutoScalingGroupName": "my-auto-scaling-group",
37
+ * "ScheduledActionName": "my-scheduled-action"
38
+ * };
39
+ * const command = new DeleteScheduledActionCommand(input);
40
+ * await client.send(command);
41
+ * // example id: autoscaling-delete-scheduled-action-1
42
+ * ```
43
+ *
32
44
  */
33
45
  export declare class DeleteScheduledActionCommand extends $Command<DeleteScheduledActionCommandInput, DeleteScheduledActionCommandOutput, AutoScalingClientResolvedConfig> {
34
46
  readonly input: DeleteScheduledActionCommandInput;
@@ -29,6 +29,24 @@ export interface DeleteTagsCommandOutput extends __MetadataBearer {
29
29
  * @see {@link DeleteTagsCommandOutput} for command's `response` shape.
30
30
  * @see {@link AutoScalingClientResolvedConfig | config} for AutoScalingClient's `config` shape.
31
31
  *
32
+ * @example To delete a tag from an Auto Scaling group
33
+ * ```javascript
34
+ * // This example deletes the specified tag from the specified Auto Scaling group.
35
+ * const input = {
36
+ * "Tags": [
37
+ * {
38
+ * "Key": "Dept",
39
+ * "ResourceId": "my-auto-scaling-group",
40
+ * "ResourceType": "auto-scaling-group",
41
+ * "Value": "Research"
42
+ * }
43
+ * ]
44
+ * };
45
+ * const command = new DeleteTagsCommand(input);
46
+ * await client.send(command);
47
+ * // example id: autoscaling-delete-tags-1
48
+ * ```
49
+ *
32
50
  */
33
51
  export declare class DeleteTagsCommand extends $Command<DeleteTagsCommandInput, DeleteTagsCommandOutput, AutoScalingClientResolvedConfig> {
34
52
  readonly input: DeleteTagsCommandInput;
@@ -33,6 +33,23 @@ export interface DescribeAccountLimitsCommandOutput extends DescribeAccountLimit
33
33
  * @see {@link DescribeAccountLimitsCommandOutput} for command's `response` shape.
34
34
  * @see {@link AutoScalingClientResolvedConfig | config} for AutoScalingClient's `config` shape.
35
35
  *
36
+ * @example To describe your Auto Scaling account limits
37
+ * ```javascript
38
+ * // This example describes the Amazon EC2 Auto Scaling service quotas for your account.
39
+ * const input = undefined;
40
+ * const command = new DescribeAccountLimitsCommand(input);
41
+ * const response = await client.send(command);
42
+ * /* response ==
43
+ * {
44
+ * "MaxNumberOfAutoScalingGroups": 20,
45
+ * "MaxNumberOfLaunchConfigurations": 100,
46
+ * "NumberOfAutoScalingGroups": 3,
47
+ * "NumberOfLaunchConfigurations": 5
48
+ * }
49
+ * *\/
50
+ * // example id: autoscaling-describe-account-limits-1
51
+ * ```
52
+ *
36
53
  */
37
54
  export declare class DescribeAccountLimitsCommand extends $Command<DescribeAccountLimitsCommandInput, DescribeAccountLimitsCommandOutput, AutoScalingClientResolvedConfig> {
38
55
  readonly input: DescribeAccountLimitsCommandInput;
@@ -48,6 +48,30 @@ export interface DescribeAdjustmentTypesCommandOutput extends DescribeAdjustment
48
48
  * @see {@link DescribeAdjustmentTypesCommandOutput} for command's `response` shape.
49
49
  * @see {@link AutoScalingClientResolvedConfig | config} for AutoScalingClient's `config` shape.
50
50
  *
51
+ * @example To describe the Amazon EC2 Auto Scaling adjustment types
52
+ * ```javascript
53
+ * // This example describes the available adjustment types.
54
+ * const input = undefined;
55
+ * const command = new DescribeAdjustmentTypesCommand(input);
56
+ * const response = await client.send(command);
57
+ * /* response ==
58
+ * {
59
+ * "AdjustmentTypes": [
60
+ * {
61
+ * "AdjustmentType": "ChangeInCapacity"
62
+ * },
63
+ * {
64
+ * "AdjustmentType": "ExactCapcity"
65
+ * },
66
+ * {
67
+ * "AdjustmentType": "PercentChangeInCapacity"
68
+ * }
69
+ * ]
70
+ * }
71
+ * *\/
72
+ * // example id: autoscaling-describe-adjustment-types-1
73
+ * ```
74
+ *
51
75
  */
52
76
  export declare class DescribeAdjustmentTypesCommand extends $Command<DescribeAdjustmentTypesCommandInput, DescribeAdjustmentTypesCommandOutput, AutoScalingClientResolvedConfig> {
53
77
  readonly input: DescribeAdjustmentTypesCommandInput;
@@ -35,6 +35,59 @@ export interface DescribeAutoScalingGroupsCommandOutput extends AutoScalingGroup
35
35
  * @see {@link DescribeAutoScalingGroupsCommandOutput} for command's `response` shape.
36
36
  * @see {@link AutoScalingClientResolvedConfig | config} for AutoScalingClient's `config` shape.
37
37
  *
38
+ * @example To describe an Auto Scaling group
39
+ * ```javascript
40
+ * // This example describes the specified Auto Scaling group.
41
+ * const input = {
42
+ * "AutoScalingGroupNames": [
43
+ * "my-auto-scaling-group"
44
+ * ]
45
+ * };
46
+ * const command = new DescribeAutoScalingGroupsCommand(input);
47
+ * const response = await client.send(command);
48
+ * /* response ==
49
+ * {
50
+ * "AutoScalingGroups": [
51
+ * {
52
+ * "AutoScalingGroupARN": "arn:aws:autoscaling:us-west-2:123456789012:autoScalingGroup:930d940e-891e-4781-a11a-7b0acd480f03:autoScalingGroupName/my-auto-scaling-group",
53
+ * "AutoScalingGroupName": "my-auto-scaling-group",
54
+ * "AvailabilityZones": [
55
+ * "us-west-2c"
56
+ * ],
57
+ * "CreatedTime": "2013-08-19T20:53:25.584Z",
58
+ * "DefaultCooldown": 300,
59
+ * "DesiredCapacity": 1,
60
+ * "EnabledMetrics": [],
61
+ * "HealthCheckGracePeriod": 300,
62
+ * "HealthCheckType": "EC2",
63
+ * "Instances": [
64
+ * {
65
+ * "AvailabilityZone": "us-west-2c",
66
+ * "HealthStatus": "Healthy",
67
+ * "InstanceId": "i-4ba0837f",
68
+ * "LaunchConfigurationName": "my-launch-config",
69
+ * "LifecycleState": "InService",
70
+ * "ProtectedFromScaleIn": false
71
+ * }
72
+ * ],
73
+ * "LaunchConfigurationName": "my-launch-config",
74
+ * "LoadBalancerNames": [],
75
+ * "MaxSize": 1,
76
+ * "MinSize": 0,
77
+ * "NewInstancesProtectedFromScaleIn": false,
78
+ * "SuspendedProcesses": [],
79
+ * "Tags": [],
80
+ * "TerminationPolicies": [
81
+ * "Default"
82
+ * ],
83
+ * "VPCZoneIdentifier": "subnet-12345678"
84
+ * }
85
+ * ]
86
+ * }
87
+ * *\/
88
+ * // example id: autoscaling-describe-auto-scaling-groups-1
89
+ * ```
90
+ *
38
91
  */
39
92
  export declare class DescribeAutoScalingGroupsCommand extends $Command<DescribeAutoScalingGroupsCommandInput, DescribeAutoScalingGroupsCommandOutput, AutoScalingClientResolvedConfig> {
40
93
  readonly input: DescribeAutoScalingGroupsCommandInput;
@@ -29,6 +29,34 @@ export interface DescribeAutoScalingInstancesCommandOutput extends AutoScalingIn
29
29
  * @see {@link DescribeAutoScalingInstancesCommandOutput} for command's `response` shape.
30
30
  * @see {@link AutoScalingClientResolvedConfig | config} for AutoScalingClient's `config` shape.
31
31
  *
32
+ * @example To describe one or more Auto Scaling instances
33
+ * ```javascript
34
+ * // This example describes the specified Auto Scaling instance.
35
+ * const input = {
36
+ * "InstanceIds": [
37
+ * "i-4ba0837f"
38
+ * ]
39
+ * };
40
+ * const command = new DescribeAutoScalingInstancesCommand(input);
41
+ * const response = await client.send(command);
42
+ * /* response ==
43
+ * {
44
+ * "AutoScalingInstances": [
45
+ * {
46
+ * "AutoScalingGroupName": "my-auto-scaling-group",
47
+ * "AvailabilityZone": "us-west-2c",
48
+ * "HealthStatus": "HEALTHY",
49
+ * "InstanceId": "i-4ba0837f",
50
+ * "LaunchConfigurationName": "my-launch-config",
51
+ * "LifecycleState": "InService",
52
+ * "ProtectedFromScaleIn": false
53
+ * }
54
+ * ]
55
+ * }
56
+ * *\/
57
+ * // example id: autoscaling-describe-auto-scaling-instances-1
58
+ * ```
59
+ *
32
60
  */
33
61
  export declare class DescribeAutoScalingInstancesCommand extends $Command<DescribeAutoScalingInstancesCommandInput, DescribeAutoScalingInstancesCommandOutput, AutoScalingClientResolvedConfig> {
34
62
  readonly input: DescribeAutoScalingInstancesCommandInput;
@@ -29,6 +29,26 @@ export interface DescribeAutoScalingNotificationTypesCommandOutput extends Descr
29
29
  * @see {@link DescribeAutoScalingNotificationTypesCommandOutput} for command's `response` shape.
30
30
  * @see {@link AutoScalingClientResolvedConfig | config} for AutoScalingClient's `config` shape.
31
31
  *
32
+ * @example To describe the Auto Scaling notification types
33
+ * ```javascript
34
+ * // This example describes the available notification types.
35
+ * const input = undefined;
36
+ * const command = new DescribeAutoScalingNotificationTypesCommand(input);
37
+ * const response = await client.send(command);
38
+ * /* response ==
39
+ * {
40
+ * "AutoScalingNotificationTypes": [
41
+ * "autoscaling:EC2_INSTANCE_LAUNCH",
42
+ * "autoscaling:EC2_INSTANCE_LAUNCH_ERROR",
43
+ * "autoscaling:EC2_INSTANCE_TERMINATE",
44
+ * "autoscaling:EC2_INSTANCE_TERMINATE_ERROR",
45
+ * "autoscaling:TEST_NOTIFICATION"
46
+ * ]
47
+ * }
48
+ * *\/
49
+ * // example id: autoscaling-describe-auto-scaling-notification-types-1
50
+ * ```
51
+ *
32
52
  */
33
53
  export declare class DescribeAutoScalingNotificationTypesCommand extends $Command<DescribeAutoScalingNotificationTypesCommandInput, DescribeAutoScalingNotificationTypesCommandOutput, AutoScalingClientResolvedConfig> {
34
54
  readonly input: DescribeAutoScalingNotificationTypesCommandInput;
@@ -38,6 +38,40 @@ export interface DescribeInstanceRefreshesCommandOutput extends DescribeInstance
38
38
  * @see {@link DescribeInstanceRefreshesCommandOutput} for command's `response` shape.
39
39
  * @see {@link AutoScalingClientResolvedConfig | config} for AutoScalingClient's `config` shape.
40
40
  *
41
+ * @example To list instance refreshes
42
+ * ```javascript
43
+ * // This example describes the instance refreshes for the specified Auto Scaling group.
44
+ * const input = {
45
+ * "AutoScalingGroupName": "my-auto-scaling-group"
46
+ * };
47
+ * const command = new DescribeInstanceRefreshesCommand(input);
48
+ * const response = await client.send(command);
49
+ * /* response ==
50
+ * {
51
+ * "InstanceRefreshes": [
52
+ * {
53
+ * "AutoScalingGroupName": "my-auto-scaling-group",
54
+ * "InstanceRefreshId": "08b91cf7-8fa6-48af-b6a6-d227f40f1b9b",
55
+ * "InstancesToUpdate": 5,
56
+ * "PercentageComplete": 0,
57
+ * "StartTime": "2020-06-02T18:11:27Z",
58
+ * "Status": "InProgress"
59
+ * },
60
+ * {
61
+ * "AutoScalingGroupName": "my-auto-scaling-group",
62
+ * "EndTime": "2020-06-02T16:53:37Z",
63
+ * "InstanceRefreshId": "dd7728d0-5bc4-4575-96a3-1b2c52bf8bb1",
64
+ * "InstancesToUpdate": 0,
65
+ * "PercentageComplete": 100,
66
+ * "StartTime": "2020-06-02T16:43:19Z",
67
+ * "Status": "Successful"
68
+ * }
69
+ * ]
70
+ * }
71
+ * *\/
72
+ * // example id: to-list-instance-refreshes-1592959593746
73
+ * ```
74
+ *
41
75
  */
42
76
  export declare class DescribeInstanceRefreshesCommand extends $Command<DescribeInstanceRefreshesCommandInput, DescribeInstanceRefreshesCommandOutput, AutoScalingClientResolvedConfig> {
43
77
  readonly input: DescribeInstanceRefreshesCommandInput;