@aws-sdk/client-auto-scaling 3.288.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
@@ -29,6 +29,41 @@ export interface DescribeLaunchConfigurationsCommandOutput extends LaunchConfigu
29
29
  * @see {@link DescribeLaunchConfigurationsCommandOutput} for command's `response` shape.
30
30
  * @see {@link AutoScalingClientResolvedConfig | config} for AutoScalingClient's `config` shape.
31
31
  *
32
+ * @example To describe Auto Scaling launch configurations
33
+ * ```javascript
34
+ * // This example describes the specified launch configuration.
35
+ * const input = {
36
+ * "LaunchConfigurationNames": [
37
+ * "my-launch-config"
38
+ * ]
39
+ * };
40
+ * const command = new DescribeLaunchConfigurationsCommand(input);
41
+ * const response = await client.send(command);
42
+ * /* response ==
43
+ * {
44
+ * "LaunchConfigurations": [
45
+ * {
46
+ * "AssociatePublicIpAddress": true,
47
+ * "BlockDeviceMappings": [],
48
+ * "CreatedTime": "2014-05-07T17:39:28.599Z",
49
+ * "EbsOptimized": false,
50
+ * "ImageId": "ami-043a5034",
51
+ * "InstanceMonitoring": {
52
+ * "Enabled": true
53
+ * },
54
+ * "InstanceType": "t1.micro",
55
+ * "LaunchConfigurationARN": "arn:aws:autoscaling:us-west-2:123456789012:launchConfiguration:98d3b196-4cf9-4e88-8ca1-8547c24ced8b:launchConfigurationName/my-launch-config",
56
+ * "LaunchConfigurationName": "my-launch-config",
57
+ * "SecurityGroups": [
58
+ * "sg-67ef0308"
59
+ * ]
60
+ * }
61
+ * ]
62
+ * }
63
+ * *\/
64
+ * // example id: autoscaling-describe-launch-configurations-1
65
+ * ```
66
+ *
32
67
  */
33
68
  export declare class DescribeLaunchConfigurationsCommand extends $Command<DescribeLaunchConfigurationsCommandInput, DescribeLaunchConfigurationsCommandOutput, AutoScalingClientResolvedConfig> {
34
69
  readonly input: DescribeLaunchConfigurationsCommandInput;
@@ -42,6 +42,23 @@ export interface DescribeLifecycleHookTypesCommandOutput extends DescribeLifecyc
42
42
  * @see {@link DescribeLifecycleHookTypesCommandOutput} for command's `response` shape.
43
43
  * @see {@link AutoScalingClientResolvedConfig | config} for AutoScalingClient's `config` shape.
44
44
  *
45
+ * @example To describe the available types of lifecycle hooks
46
+ * ```javascript
47
+ * // This example describes the available lifecycle hook types.
48
+ * const input = undefined;
49
+ * const command = new DescribeLifecycleHookTypesCommand(input);
50
+ * const response = await client.send(command);
51
+ * /* response ==
52
+ * {
53
+ * "LifecycleHookTypes": [
54
+ * "autoscaling:EC2_INSTANCE_LAUNCHING",
55
+ * "autoscaling:EC2_INSTANCE_TERMINATING"
56
+ * ]
57
+ * }
58
+ * *\/
59
+ * // example id: autoscaling-describe-lifecycle-hook-types-1
60
+ * ```
61
+ *
45
62
  */
46
63
  export declare class DescribeLifecycleHookTypesCommand extends $Command<DescribeLifecycleHookTypesCommandInput, DescribeLifecycleHookTypesCommandOutput, AutoScalingClientResolvedConfig> {
47
64
  readonly input: DescribeLifecycleHookTypesCommandInput;
@@ -29,6 +29,33 @@ export interface DescribeLifecycleHooksCommandOutput extends DescribeLifecycleHo
29
29
  * @see {@link DescribeLifecycleHooksCommandOutput} for command's `response` shape.
30
30
  * @see {@link AutoScalingClientResolvedConfig | config} for AutoScalingClient's `config` shape.
31
31
  *
32
+ * @example To describe your lifecycle hooks
33
+ * ```javascript
34
+ * // This example describes the lifecycle hooks for the specified Auto Scaling group.
35
+ * const input = {
36
+ * "AutoScalingGroupName": "my-auto-scaling-group"
37
+ * };
38
+ * const command = new DescribeLifecycleHooksCommand(input);
39
+ * const response = await client.send(command);
40
+ * /* response ==
41
+ * {
42
+ * "LifecycleHooks": [
43
+ * {
44
+ * "AutoScalingGroupName": "my-auto-scaling-group",
45
+ * "DefaultResult": "ABANDON",
46
+ * "GlobalTimeout": 172800,
47
+ * "HeartbeatTimeout": 3600,
48
+ * "LifecycleHookName": "my-lifecycle-hook",
49
+ * "LifecycleTransition": "autoscaling:EC2_INSTANCE_LAUNCHING",
50
+ * "NotificationTargetARN": "arn:aws:sns:us-west-2:123456789012:my-sns-topic",
51
+ * "RoleARN": "arn:aws:iam::123456789012:role/my-auto-scaling-role"
52
+ * }
53
+ * ]
54
+ * }
55
+ * *\/
56
+ * // example id: autoscaling-describe-lifecycle-hooks-1
57
+ * ```
58
+ *
32
59
  */
33
60
  export declare class DescribeLifecycleHooksCommand extends $Command<DescribeLifecycleHooksCommandInput, DescribeLifecycleHooksCommandOutput, AutoScalingClientResolvedConfig> {
34
61
  readonly input: DescribeLifecycleHooksCommandInput;
@@ -53,6 +53,27 @@ export interface DescribeLoadBalancerTargetGroupsCommandOutput extends DescribeL
53
53
  * @see {@link DescribeLoadBalancerTargetGroupsCommandOutput} for command's `response` shape.
54
54
  * @see {@link AutoScalingClientResolvedConfig | config} for AutoScalingClient's `config` shape.
55
55
  *
56
+ * @example To describe the target groups for an Auto Scaling group
57
+ * ```javascript
58
+ * // This example describes the target groups attached to the specified Auto Scaling group.
59
+ * const input = {
60
+ * "AutoScalingGroupName": "my-auto-scaling-group"
61
+ * };
62
+ * const command = new DescribeLoadBalancerTargetGroupsCommand(input);
63
+ * const response = await client.send(command);
64
+ * /* response ==
65
+ * {
66
+ * "LoadBalancerTargetGroups": [
67
+ * {
68
+ * "LoadBalancerTargetGroupARN": "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067",
69
+ * "State": "Added"
70
+ * }
71
+ * ]
72
+ * }
73
+ * *\/
74
+ * // example id: autoscaling-describe-load-balancer-target-groups-1
75
+ * ```
76
+ *
56
77
  */
57
78
  export declare class DescribeLoadBalancerTargetGroupsCommand extends $Command<DescribeLoadBalancerTargetGroupsCommandInput, DescribeLoadBalancerTargetGroupsCommandOutput, AutoScalingClientResolvedConfig> {
58
79
  readonly input: DescribeLoadBalancerTargetGroupsCommandInput;
@@ -51,6 +51,27 @@ export interface DescribeLoadBalancersCommandOutput extends DescribeLoadBalancer
51
51
  * @see {@link DescribeLoadBalancersCommandOutput} for command's `response` shape.
52
52
  * @see {@link AutoScalingClientResolvedConfig | config} for AutoScalingClient's `config` shape.
53
53
  *
54
+ * @example To describe the load balancers for an Auto Scaling group
55
+ * ```javascript
56
+ * // This example describes the load balancers attached to the specified Auto Scaling group.
57
+ * const input = {
58
+ * "AutoScalingGroupName": "my-auto-scaling-group"
59
+ * };
60
+ * const command = new DescribeLoadBalancersCommand(input);
61
+ * const response = await client.send(command);
62
+ * /* response ==
63
+ * {
64
+ * "LoadBalancers": [
65
+ * {
66
+ * "LoadBalancerName": "my-load-balancer",
67
+ * "State": "Added"
68
+ * }
69
+ * ]
70
+ * }
71
+ * *\/
72
+ * // example id: autoscaling-describe-load-balancers-1
73
+ * ```
74
+ *
54
75
  */
55
76
  export declare class DescribeLoadBalancersCommand extends $Command<DescribeLoadBalancersCommandInput, DescribeLoadBalancersCommandOutput, AutoScalingClientResolvedConfig> {
56
77
  readonly input: DescribeLoadBalancersCommandInput;
@@ -29,6 +29,50 @@ export interface DescribeMetricCollectionTypesCommandOutput extends DescribeMetr
29
29
  * @see {@link DescribeMetricCollectionTypesCommandOutput} 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 metric collection types
33
+ * ```javascript
34
+ * // This example describes the available metric collection types.
35
+ * const input = undefined;
36
+ * const command = new DescribeMetricCollectionTypesCommand(input);
37
+ * const response = await client.send(command);
38
+ * /* response ==
39
+ * {
40
+ * "Granularities": [
41
+ * {
42
+ * "Granularity": "1Minute"
43
+ * }
44
+ * ],
45
+ * "Metrics": [
46
+ * {
47
+ * "Metric": "GroupMinSize"
48
+ * },
49
+ * {
50
+ * "Metric": "GroupMaxSize"
51
+ * },
52
+ * {
53
+ * "Metric": "GroupDesiredCapacity"
54
+ * },
55
+ * {
56
+ * "Metric": "GroupInServiceInstances"
57
+ * },
58
+ * {
59
+ * "Metric": "GroupPendingInstances"
60
+ * },
61
+ * {
62
+ * "Metric": "GroupTerminatingInstances"
63
+ * },
64
+ * {
65
+ * "Metric": "GroupStandbyInstances"
66
+ * },
67
+ * {
68
+ * "Metric": "GroupTotalInstances"
69
+ * }
70
+ * ]
71
+ * }
72
+ * *\/
73
+ * // example id: autoscaling-describe-metric-collection-types-1
74
+ * ```
75
+ *
32
76
  */
33
77
  export declare class DescribeMetricCollectionTypesCommand extends $Command<DescribeMetricCollectionTypesCommandInput, DescribeMetricCollectionTypesCommandOutput, AutoScalingClientResolvedConfig> {
34
78
  readonly input: DescribeMetricCollectionTypesCommandInput;
@@ -30,6 +30,35 @@ export interface DescribeNotificationConfigurationsCommandOutput extends Describ
30
30
  * @see {@link DescribeNotificationConfigurationsCommandOutput} for command's `response` shape.
31
31
  * @see {@link AutoScalingClientResolvedConfig | config} for AutoScalingClient's `config` shape.
32
32
  *
33
+ * @example To describe Auto Scaling notification configurations
34
+ * ```javascript
35
+ * // This example describes the notification configurations for the specified Auto Scaling group.
36
+ * const input = {
37
+ * "AutoScalingGroupNames": [
38
+ * "my-auto-scaling-group"
39
+ * ]
40
+ * };
41
+ * const command = new DescribeNotificationConfigurationsCommand(input);
42
+ * const response = await client.send(command);
43
+ * /* response ==
44
+ * {
45
+ * "NotificationConfigurations": [
46
+ * {
47
+ * "AutoScalingGroupName": "my-auto-scaling-group",
48
+ * "NotificationType": "autoscaling:TEST_NOTIFICATION",
49
+ * "TopicARN": "arn:aws:sns:us-west-2:123456789012:my-sns-topic-2"
50
+ * },
51
+ * {
52
+ * "AutoScalingGroupName": "my-auto-scaling-group",
53
+ * "NotificationType": "autoscaling:TEST_NOTIFICATION",
54
+ * "TopicARN": "arn:aws:sns:us-west-2:123456789012:my-sns-topic"
55
+ * }
56
+ * ]
57
+ * }
58
+ * *\/
59
+ * // example id: autoscaling-describe-notification-configurations-1
60
+ * ```
61
+ *
33
62
  */
34
63
  export declare class DescribeNotificationConfigurationsCommand extends $Command<DescribeNotificationConfigurationsCommandInput, DescribeNotificationConfigurationsCommandOutput, AutoScalingClientResolvedConfig> {
35
64
  readonly input: DescribeNotificationConfigurationsCommandInput;
@@ -29,6 +29,41 @@ export interface DescribePoliciesCommandOutput extends PoliciesType, __MetadataB
29
29
  * @see {@link DescribePoliciesCommandOutput} for command's `response` shape.
30
30
  * @see {@link AutoScalingClientResolvedConfig | config} for AutoScalingClient's `config` shape.
31
31
  *
32
+ * @example To describe scaling policies
33
+ * ```javascript
34
+ * // This example describes the policies for the specified Auto Scaling group.
35
+ * const input = {
36
+ * "AutoScalingGroupName": "my-auto-scaling-group"
37
+ * };
38
+ * const command = new DescribePoliciesCommand(input);
39
+ * const response = await client.send(command);
40
+ * /* response ==
41
+ * {
42
+ * "ScalingPolicies": [
43
+ * {
44
+ * "AdjustmentType": "ChangeInCapacity",
45
+ * "Alarms": [],
46
+ * "AutoScalingGroupName": "my-auto-scaling-group",
47
+ * "PolicyARN": "arn:aws:autoscaling:us-west-2:123456789012:scalingPolicy:2233f3d7-6290-403b-b632-93c553560106:autoScalingGroupName/my-auto-scaling-group:policyName/ScaleIn",
48
+ * "PolicyName": "ScaleIn",
49
+ * "ScalingAdjustment": -1
50
+ * },
51
+ * {
52
+ * "AdjustmentType": "PercentChangeInCapacity",
53
+ * "Alarms": [],
54
+ * "AutoScalingGroupName": "my-auto-scaling-group",
55
+ * "Cooldown": 60,
56
+ * "MinAdjustmentStep": 2,
57
+ * "PolicyARN": "arn:aws:autoscaling:us-west-2:123456789012:scalingPolicy:2b435159-cf77-4e89-8c0e-d63b497baad7:autoScalingGroupName/my-auto-scaling-group:policyName/ScalePercentChange",
58
+ * "PolicyName": "ScalePercentChange",
59
+ * "ScalingAdjustment": 25
60
+ * }
61
+ * ]
62
+ * }
63
+ * *\/
64
+ * // example id: autoscaling-describe-policies-1
65
+ * ```
66
+ *
32
67
  */
33
68
  export declare class DescribePoliciesCommand extends $Command<DescribePoliciesCommandInput, DescribePoliciesCommandOutput, AutoScalingClientResolvedConfig> {
34
69
  readonly input: DescribePoliciesCommandInput;
@@ -37,6 +37,34 @@ export interface DescribeScalingActivitiesCommandOutput extends ActivitiesType,
37
37
  * @see {@link DescribeScalingActivitiesCommandOutput} for command's `response` shape.
38
38
  * @see {@link AutoScalingClientResolvedConfig | config} for AutoScalingClient's `config` shape.
39
39
  *
40
+ * @example To describe the scaling activities for an Auto Scaling group
41
+ * ```javascript
42
+ * // This example describes the scaling activities for the specified Auto Scaling group.
43
+ * const input = {
44
+ * "AutoScalingGroupName": "my-auto-scaling-group"
45
+ * };
46
+ * const command = new DescribeScalingActivitiesCommand(input);
47
+ * const response = await client.send(command);
48
+ * /* response ==
49
+ * {
50
+ * "Activities": [
51
+ * {
52
+ * "ActivityId": "f9f2d65b-f1f2-43e7-b46d-d86756459699",
53
+ * "AutoScalingGroupName": "my-auto-scaling-group",
54
+ * "Cause": "At 2013-08-19T20:53:25Z a user request created an AutoScalingGroup changing the desired capacity from 0 to 1. At 2013-08-19T20:53:29Z an instance was started in response to a difference between desired and actual capacity, increasing the capacity from 0 to 1.",
55
+ * "Description": "Launching a new EC2 instance: i-4ba0837f",
56
+ * "Details": "details",
57
+ * "EndTime": "2013-08-19T20:54:02Z",
58
+ * "Progress": 100,
59
+ * "StartTime": "2013-08-19T20:53:29.930Z",
60
+ * "StatusCode": "Successful"
61
+ * }
62
+ * ]
63
+ * }
64
+ * *\/
65
+ * // example id: autoscaling-describe-scaling-activities-1
66
+ * ```
67
+ *
40
68
  */
41
69
  export declare class DescribeScalingActivitiesCommand extends $Command<DescribeScalingActivitiesCommandInput, DescribeScalingActivitiesCommandOutput, AutoScalingClientResolvedConfig> {
42
70
  readonly input: DescribeScalingActivitiesCommandInput;
@@ -30,6 +30,45 @@ export interface DescribeScalingProcessTypesCommandOutput extends ProcessesType,
30
30
  * @see {@link DescribeScalingProcessTypesCommandOutput} for command's `response` shape.
31
31
  * @see {@link AutoScalingClientResolvedConfig | config} for AutoScalingClient's `config` shape.
32
32
  *
33
+ * @example To describe the Auto Scaling process types
34
+ * ```javascript
35
+ * // This example describes the Auto Scaling process types.
36
+ * const input = undefined;
37
+ * const command = new DescribeScalingProcessTypesCommand(input);
38
+ * const response = await client.send(command);
39
+ * /* response ==
40
+ * {
41
+ * "Processes": [
42
+ * {
43
+ * "ProcessName": "AZRebalance"
44
+ * },
45
+ * {
46
+ * "ProcessName": "AddToLoadBalancer"
47
+ * },
48
+ * {
49
+ * "ProcessName": "AlarmNotification"
50
+ * },
51
+ * {
52
+ * "ProcessName": "HealthCheck"
53
+ * },
54
+ * {
55
+ * "ProcessName": "Launch"
56
+ * },
57
+ * {
58
+ * "ProcessName": "ReplaceUnhealthy"
59
+ * },
60
+ * {
61
+ * "ProcessName": "ScheduledActions"
62
+ * },
63
+ * {
64
+ * "ProcessName": "Terminate"
65
+ * }
66
+ * ]
67
+ * }
68
+ * *\/
69
+ * // example id: autoscaling-describe-scaling-process-types-1
70
+ * ```
71
+ *
33
72
  */
34
73
  export declare class DescribeScalingProcessTypesCommand extends $Command<DescribeScalingProcessTypesCommandInput, DescribeScalingProcessTypesCommandOutput, AutoScalingClientResolvedConfig> {
35
74
  readonly input: DescribeScalingProcessTypesCommandInput;
@@ -32,6 +32,34 @@ export interface DescribeScheduledActionsCommandOutput extends ScheduledActionsT
32
32
  * @see {@link DescribeScheduledActionsCommandOutput} for command's `response` shape.
33
33
  * @see {@link AutoScalingClientResolvedConfig | config} for AutoScalingClient's `config` shape.
34
34
  *
35
+ * @example To describe scheduled actions
36
+ * ```javascript
37
+ * // This example describes the scheduled actions for the specified Auto Scaling group.
38
+ * const input = {
39
+ * "AutoScalingGroupName": "my-auto-scaling-group"
40
+ * };
41
+ * const command = new DescribeScheduledActionsCommand(input);
42
+ * const response = await client.send(command);
43
+ * /* response ==
44
+ * {
45
+ * "ScheduledUpdateGroupActions": [
46
+ * {
47
+ * "AutoScalingGroupName": "my-auto-scaling-group",
48
+ * "DesiredCapacity": 4,
49
+ * "MaxSize": 6,
50
+ * "MinSize": 2,
51
+ * "Recurrence": "30 0 1 12 0",
52
+ * "ScheduledActionARN": "arn:aws:autoscaling:us-west-2:123456789012:scheduledUpdateGroupAction:8e86b655-b2e6-4410-8f29-b4f094d6871c:autoScalingGroupName/my-auto-scaling-group:scheduledActionName/my-scheduled-action",
53
+ * "ScheduledActionName": "my-scheduled-action",
54
+ * "StartTime": "2016-12-01T00:30:00Z",
55
+ * "Time": "2016-12-01T00:30:00Z"
56
+ * }
57
+ * ]
58
+ * }
59
+ * *\/
60
+ * // example id: autoscaling-describe-scheduled-actions-1
61
+ * ```
62
+ *
35
63
  */
36
64
  export declare class DescribeScheduledActionsCommand extends $Command<DescribeScheduledActionsCommandInput, DescribeScheduledActionsCommandOutput, AutoScalingClientResolvedConfig> {
37
65
  readonly input: DescribeScheduledActionsCommandInput;
@@ -37,6 +37,44 @@ export interface DescribeTagsCommandOutput extends TagsType, __MetadataBearer {
37
37
  * @see {@link DescribeTagsCommandOutput} for command's `response` shape.
38
38
  * @see {@link AutoScalingClientResolvedConfig | config} for AutoScalingClient's `config` shape.
39
39
  *
40
+ * @example To describe tags
41
+ * ```javascript
42
+ * // This example describes the tags for the specified Auto Scaling group.
43
+ * const input = {
44
+ * "Filters": [
45
+ * {
46
+ * "Name": "auto-scaling-group",
47
+ * "Values": [
48
+ * "my-auto-scaling-group"
49
+ * ]
50
+ * }
51
+ * ]
52
+ * };
53
+ * const command = new DescribeTagsCommand(input);
54
+ * const response = await client.send(command);
55
+ * /* response ==
56
+ * {
57
+ * "Tags": [
58
+ * {
59
+ * "Key": "Dept",
60
+ * "PropagateAtLaunch": true,
61
+ * "ResourceId": "my-auto-scaling-group",
62
+ * "ResourceType": "auto-scaling-group",
63
+ * "Value": "Research"
64
+ * },
65
+ * {
66
+ * "Key": "Role",
67
+ * "PropagateAtLaunch": true,
68
+ * "ResourceId": "my-auto-scaling-group",
69
+ * "ResourceType": "auto-scaling-group",
70
+ * "Value": "WebServer"
71
+ * }
72
+ * ]
73
+ * }
74
+ * *\/
75
+ * // example id: autoscaling-describe-tags-1
76
+ * ```
77
+ *
40
78
  */
41
79
  export declare class DescribeTagsCommand extends $Command<DescribeTagsCommandInput, DescribeTagsCommandOutput, AutoScalingClientResolvedConfig> {
42
80
  readonly input: DescribeTagsCommandInput;
@@ -32,6 +32,26 @@ export interface DescribeTerminationPolicyTypesCommandOutput extends DescribeTer
32
32
  * @see {@link DescribeTerminationPolicyTypesCommandOutput} for command's `response` shape.
33
33
  * @see {@link AutoScalingClientResolvedConfig | config} for AutoScalingClient's `config` shape.
34
34
  *
35
+ * @example To describe termination policy types
36
+ * ```javascript
37
+ * // This example describes the available termination policy types.
38
+ * const input = undefined;
39
+ * const command = new DescribeTerminationPolicyTypesCommand(input);
40
+ * const response = await client.send(command);
41
+ * /* response ==
42
+ * {
43
+ * "TerminationPolicyTypes": [
44
+ * "ClosestToNextInstanceHour",
45
+ * "Default",
46
+ * "NewestInstance",
47
+ * "OldestInstance",
48
+ * "OldestLaunchConfiguration"
49
+ * ]
50
+ * }
51
+ * *\/
52
+ * // example id: autoscaling-describe-termination-policy-types-1
53
+ * ```
54
+ *
35
55
  */
36
56
  export declare class DescribeTerminationPolicyTypesCommand extends $Command<DescribeTerminationPolicyTypesCommandInput, DescribeTerminationPolicyTypesCommandOutput, AutoScalingClientResolvedConfig> {
37
57
  readonly input: DescribeTerminationPolicyTypesCommandInput;
@@ -38,6 +38,37 @@ export interface DetachInstancesCommandOutput extends DetachInstancesAnswer, __M
38
38
  * @see {@link DetachInstancesCommandOutput} for command's `response` shape.
39
39
  * @see {@link AutoScalingClientResolvedConfig | config} for AutoScalingClient's `config` shape.
40
40
  *
41
+ * @example To detach an instance from an Auto Scaling group
42
+ * ```javascript
43
+ * // This example detaches the specified instance from the specified Auto Scaling group.
44
+ * const input = {
45
+ * "AutoScalingGroupName": "my-auto-scaling-group",
46
+ * "InstanceIds": [
47
+ * "i-93633f9b"
48
+ * ],
49
+ * "ShouldDecrementDesiredCapacity": true
50
+ * };
51
+ * const command = new DetachInstancesCommand(input);
52
+ * const response = await client.send(command);
53
+ * /* response ==
54
+ * {
55
+ * "Activities": [
56
+ * {
57
+ * "ActivityId": "5091cb52-547a-47ce-a236-c9ccbc2cb2c9",
58
+ * "AutoScalingGroupName": "my-auto-scaling-group",
59
+ * "Cause": "At 2015-04-12T15:02:16Z instance i-93633f9b was detached in response to a user request, shrinking the capacity from 2 to 1.",
60
+ * "Description": "Detaching EC2 instance: i-93633f9b",
61
+ * "Details": "details",
62
+ * "Progress": 50,
63
+ * "StartTime": "2015-04-12T15:02:16.179Z",
64
+ * "StatusCode": "InProgress"
65
+ * }
66
+ * ]
67
+ * }
68
+ * *\/
69
+ * // example id: autoscaling-detach-instances-1
70
+ * ```
71
+ *
41
72
  */
42
73
  export declare class DetachInstancesCommand extends $Command<DetachInstancesCommandInput, DetachInstancesCommandOutput, AutoScalingClientResolvedConfig> {
43
74
  readonly input: DetachInstancesCommandInput;
@@ -38,6 +38,20 @@ export interface DetachLoadBalancerTargetGroupsCommandOutput extends DetachLoadB
38
38
  * @see {@link DetachLoadBalancerTargetGroupsCommandOutput} for command's `response` shape.
39
39
  * @see {@link AutoScalingClientResolvedConfig | config} for AutoScalingClient's `config` shape.
40
40
  *
41
+ * @example To detach a target group from an Auto Scaling group
42
+ * ```javascript
43
+ * // This example detaches the specified target group from the specified Auto Scaling group
44
+ * const input = {
45
+ * "AutoScalingGroupName": "my-auto-scaling-group",
46
+ * "TargetGroupARNs": [
47
+ * "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067"
48
+ * ]
49
+ * };
50
+ * const command = new DetachLoadBalancerTargetGroupsCommand(input);
51
+ * await client.send(command);
52
+ * // example id: autoscaling-detach-load-balancer-target-groups-1
53
+ * ```
54
+ *
41
55
  */
42
56
  export declare class DetachLoadBalancerTargetGroupsCommand extends $Command<DetachLoadBalancerTargetGroupsCommandInput, DetachLoadBalancerTargetGroupsCommandOutput, AutoScalingClientResolvedConfig> {
43
57
  readonly input: DetachLoadBalancerTargetGroupsCommandInput;
@@ -34,6 +34,20 @@ export interface DetachLoadBalancersCommandOutput extends DetachLoadBalancersRes
34
34
  * @see {@link DetachLoadBalancersCommandOutput} for command's `response` shape.
35
35
  * @see {@link AutoScalingClientResolvedConfig | config} for AutoScalingClient's `config` shape.
36
36
  *
37
+ * @example To detach a load balancer from an Auto Scaling group
38
+ * ```javascript
39
+ * // This example detaches the specified load balancer from the specified Auto Scaling group.
40
+ * const input = {
41
+ * "AutoScalingGroupName": "my-auto-scaling-group",
42
+ * "LoadBalancerNames": [
43
+ * "my-load-balancer"
44
+ * ]
45
+ * };
46
+ * const command = new DetachLoadBalancersCommand(input);
47
+ * await client.send(command);
48
+ * // example id: autoscaling-detach-load-balancers-1
49
+ * ```
50
+ *
37
51
  */
38
52
  export declare class DetachLoadBalancersCommand extends $Command<DetachLoadBalancersCommandInput, DetachLoadBalancersCommandOutput, AutoScalingClientResolvedConfig> {
39
53
  readonly input: DetachLoadBalancersCommandInput;
@@ -29,6 +29,20 @@ export interface DisableMetricsCollectionCommandOutput extends __MetadataBearer
29
29
  * @see {@link DisableMetricsCollectionCommandOutput} for command's `response` shape.
30
30
  * @see {@link AutoScalingClientResolvedConfig | config} for AutoScalingClient's `config` shape.
31
31
  *
32
+ * @example To disable metrics collection for an Auto Scaling group
33
+ * ```javascript
34
+ * // This example disables collecting data for the GroupDesiredCapacity metric for the specified Auto Scaling group.
35
+ * const input = {
36
+ * "AutoScalingGroupName": "my-auto-scaling-group",
37
+ * "Metrics": [
38
+ * "GroupDesiredCapacity"
39
+ * ]
40
+ * };
41
+ * const command = new DisableMetricsCollectionCommand(input);
42
+ * await client.send(command);
43
+ * // example id: autoscaling-disable-metrics-collection-1
44
+ * ```
45
+ *
32
46
  */
33
47
  export declare class DisableMetricsCollectionCommand extends $Command<DisableMetricsCollectionCommandInput, DisableMetricsCollectionCommandOutput, AutoScalingClientResolvedConfig> {
34
48
  readonly input: DisableMetricsCollectionCommandInput;
@@ -34,6 +34,18 @@ export interface EnableMetricsCollectionCommandOutput extends __MetadataBearer {
34
34
  * @see {@link EnableMetricsCollectionCommandOutput} for command's `response` shape.
35
35
  * @see {@link AutoScalingClientResolvedConfig | config} for AutoScalingClient's `config` shape.
36
36
  *
37
+ * @example To enable metrics collection for an Auto Scaling group
38
+ * ```javascript
39
+ * // This example enables data collection for the specified Auto Scaling group.
40
+ * const input = {
41
+ * "AutoScalingGroupName": "my-auto-scaling-group",
42
+ * "Granularity": "1Minute"
43
+ * };
44
+ * const command = new EnableMetricsCollectionCommand(input);
45
+ * await client.send(command);
46
+ * // example id: autoscaling-enable-metrics-collection-1
47
+ * ```
48
+ *
37
49
  */
38
50
  export declare class EnableMetricsCollectionCommand extends $Command<EnableMetricsCollectionCommandInput, EnableMetricsCollectionCommandOutput, AutoScalingClientResolvedConfig> {
39
51
  readonly input: EnableMetricsCollectionCommandInput;
@@ -38,6 +38,37 @@ export interface EnterStandbyCommandOutput extends EnterStandbyAnswer, __Metadat
38
38
  * @see {@link EnterStandbyCommandOutput} for command's `response` shape.
39
39
  * @see {@link AutoScalingClientResolvedConfig | config} for AutoScalingClient's `config` shape.
40
40
  *
41
+ * @example To move instances into standby mode
42
+ * ```javascript
43
+ * // This example puts the specified instance into standby mode.
44
+ * const input = {
45
+ * "AutoScalingGroupName": "my-auto-scaling-group",
46
+ * "InstanceIds": [
47
+ * "i-93633f9b"
48
+ * ],
49
+ * "ShouldDecrementDesiredCapacity": true
50
+ * };
51
+ * const command = new EnterStandbyCommand(input);
52
+ * const response = await client.send(command);
53
+ * /* response ==
54
+ * {
55
+ * "Activities": [
56
+ * {
57
+ * "ActivityId": "ffa056b4-6ed3-41ba-ae7c-249dfae6eba1",
58
+ * "AutoScalingGroupName": "my-auto-scaling-group",
59
+ * "Cause": "At 2015-04-12T15:10:23Z instance i-93633f9b was moved to standby in response to a user request, shrinking the capacity from 2 to 1.",
60
+ * "Description": "Moving EC2 instance to Standby: i-93633f9b",
61
+ * "Details": "details",
62
+ * "Progress": 50,
63
+ * "StartTime": "2015-04-12T15:10:23.640Z",
64
+ * "StatusCode": "InProgress"
65
+ * }
66
+ * ]
67
+ * }
68
+ * *\/
69
+ * // example id: autoscaling-enter-standby-1
70
+ * ```
71
+ *
41
72
  */
42
73
  export declare class EnterStandbyCommand extends $Command<EnterStandbyCommandInput, EnterStandbyCommandOutput, AutoScalingClientResolvedConfig> {
43
74
  readonly input: EnterStandbyCommandInput;
@@ -30,6 +30,20 @@ export interface ExecutePolicyCommandOutput extends __MetadataBearer {
30
30
  * @see {@link ExecutePolicyCommandOutput} for command's `response` shape.
31
31
  * @see {@link AutoScalingClientResolvedConfig | config} for AutoScalingClient's `config` shape.
32
32
  *
33
+ * @example To execute a scaling policy
34
+ * ```javascript
35
+ * // This example executes the specified policy.
36
+ * const input = {
37
+ * "AutoScalingGroupName": "my-auto-scaling-group",
38
+ * "BreachThreshold": 50,
39
+ * "MetricValue": 59,
40
+ * "PolicyName": "my-step-scale-out-policy"
41
+ * };
42
+ * const command = new ExecutePolicyCommand(input);
43
+ * await client.send(command);
44
+ * // example id: autoscaling-execute-policy-1
45
+ * ```
46
+ *
33
47
  */
34
48
  export declare class ExecutePolicyCommand extends $Command<ExecutePolicyCommandInput, ExecutePolicyCommandOutput, AutoScalingClientResolvedConfig> {
35
49
  readonly input: ExecutePolicyCommandInput;