forked from aws/aws-sdk-js
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathautoscaling-2011-01-01.normal.json
3415 lines (3415 loc) · 161 KB
/
autoscaling-2011-01-01.normal.json
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
{
"version":"2.0",
"metadata":{
"apiVersion":"2011-01-01",
"endpointPrefix":"autoscaling",
"protocol":"query",
"serviceFullName":"Auto Scaling",
"signatureVersion":"v4",
"uid":"autoscaling-2011-01-01",
"xmlNamespace":"http://autoscaling.amazonaws.com/doc/2011-01-01/"
},
"operations":{
"AttachInstances":{
"name":"AttachInstances",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"AttachInstancesQuery"},
"errors":[
{"shape":"ResourceContentionFault"}
],
"documentation":"<p>Attaches one or more EC2 instances to the specified Auto Scaling group.</p> <p>When you attach instances, Auto Scaling increases the desired capacity of the group by the number of instances being attached. If the number of instances being attached plus the desired capacity of the group exceeds the maximum size of the group, the operation fails.</p> <p>If there is a Classic load balancer attached to your Auto Scaling group, the instances are also registered with the load balancer. If there are target groups attached to your Auto Scaling group, the instances are also registered with the target groups.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/autoscaling/latest/userguide/attach-instance-asg.html\">Attach EC2 Instances to Your Auto Scaling Group</a> in the <i>Auto Scaling User Guide</i>.</p>"
},
"AttachLoadBalancerTargetGroups":{
"name":"AttachLoadBalancerTargetGroups",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"AttachLoadBalancerTargetGroupsType"},
"output":{
"shape":"AttachLoadBalancerTargetGroupsResultType",
"resultWrapper":"AttachLoadBalancerTargetGroupsResult"
},
"errors":[
{"shape":"ResourceContentionFault"}
],
"documentation":"<p>Attaches one or more target groups to the specified Auto Scaling group.</p> <p>To describe the target groups for an Auto Scaling group, use <a>DescribeLoadBalancerTargetGroups</a>. To detach the target group from the Auto Scaling group, use <a>DetachLoadBalancerTargetGroups</a>.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/autoscaling/latest/userguide/attach-load-balancer-asg.html\">Attach a Load Balancer to Your Auto Scaling Group</a> in the <i>Auto Scaling User Guide</i>.</p>"
},
"AttachLoadBalancers":{
"name":"AttachLoadBalancers",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"AttachLoadBalancersType"},
"output":{
"shape":"AttachLoadBalancersResultType",
"resultWrapper":"AttachLoadBalancersResult"
},
"errors":[
{"shape":"ResourceContentionFault"}
],
"documentation":"<p>Attaches one or more Classic load balancers to the specified Auto Scaling group.</p> <p>To attach an Application load balancer instead, see <a>AttachLoadBalancerTargetGroups</a>.</p> <p>To describe the load balancers for an Auto Scaling group, use <a>DescribeLoadBalancers</a>. To detach the load balancer from the Auto Scaling group, use <a>DetachLoadBalancers</a>.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/autoscaling/latest/userguide/attach-load-balancer-asg.html\">Attach a Load Balancer to Your Auto Scaling Group</a> in the <i>Auto Scaling User Guide</i>.</p>"
},
"CompleteLifecycleAction":{
"name":"CompleteLifecycleAction",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"CompleteLifecycleActionType"},
"output":{
"shape":"CompleteLifecycleActionAnswer",
"resultWrapper":"CompleteLifecycleActionResult"
},
"errors":[
{"shape":"ResourceContentionFault"}
],
"documentation":"<p>Completes the lifecycle action for the specified token or instance with the specified result.</p> <p>This step is a part of the procedure for adding a lifecycle hook to an Auto Scaling group:</p> <ol> <li> <p>(Optional) Create a Lambda function and a rule that allows CloudWatch Events to invoke your Lambda function when Auto Scaling launches or terminates instances.</p> </li> <li> <p>(Optional) Create a notification target and an IAM role. The target can be either an Amazon SQS queue or an Amazon SNS topic. The role allows Auto Scaling to publish lifecycle notifications to the target.</p> </li> <li> <p>Create the lifecycle hook. Specify whether the hook is used when the instances launch or terminate.</p> </li> <li> <p>If you need more time, record the lifecycle action heartbeat to keep the instance in a pending state.</p> </li> <li> <p> <b>If you finish before the timeout period ends, complete the lifecycle action.</b> </p> </li> </ol> <p>For more information, see <a href=\"http://docs.aws.amazon.com/autoscaling/latest/userguide/AutoScalingGroupLifecycle.html\">Auto Scaling Lifecycle</a> in the <i>Auto Scaling User Guide</i>.</p>"
},
"CreateAutoScalingGroup":{
"name":"CreateAutoScalingGroup",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"CreateAutoScalingGroupType"},
"errors":[
{"shape":"AlreadyExistsFault"},
{"shape":"LimitExceededFault"},
{"shape":"ResourceContentionFault"}
],
"documentation":"<p>Creates an Auto Scaling group with the specified name and attributes.</p> <p>If you exceed your maximum limit of Auto Scaling groups, which by default is 20 per region, the call fails. For information about viewing and updating this limit, see <a>DescribeAccountLimits</a>.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/autoscaling/latest/userguide/AutoScalingGroup.html\">Auto Scaling Groups</a> in the <i>Auto Scaling User Guide</i>.</p>"
},
"CreateLaunchConfiguration":{
"name":"CreateLaunchConfiguration",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"CreateLaunchConfigurationType"},
"errors":[
{"shape":"AlreadyExistsFault"},
{"shape":"LimitExceededFault"},
{"shape":"ResourceContentionFault"}
],
"documentation":"<p>Creates a launch configuration.</p> <p>If you exceed your maximum limit of launch configurations, which by default is 100 per region, the call fails. For information about viewing and updating this limit, see <a>DescribeAccountLimits</a>.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/autoscaling/latest/userguide/LaunchConfiguration.html\">Launch Configurations</a> in the <i>Auto Scaling User Guide</i>.</p>"
},
"CreateOrUpdateTags":{
"name":"CreateOrUpdateTags",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"CreateOrUpdateTagsType"},
"errors":[
{"shape":"LimitExceededFault"},
{"shape":"AlreadyExistsFault"},
{"shape":"ResourceContentionFault"}
],
"documentation":"<p>Creates or updates tags for the specified Auto Scaling group.</p> <p>When you specify a tag with a key that already exists, the operation overwrites the previous tag definition, and you do not get an error message.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/autoscaling/latest/userguide/autoscaling-tagging.html\">Tagging Auto Scaling Groups and Instances</a> in the <i>Auto Scaling User Guide</i>.</p>"
},
"DeleteAutoScalingGroup":{
"name":"DeleteAutoScalingGroup",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DeleteAutoScalingGroupType"},
"errors":[
{"shape":"ScalingActivityInProgressFault"},
{"shape":"ResourceInUseFault"},
{"shape":"ResourceContentionFault"}
],
"documentation":"<p>Deletes the specified Auto Scaling group.</p> <p>If the group has instances or scaling activities in progress, you must specify the option to force the deletion in order for it to succeed.</p> <p>If the group has policies, deleting the group deletes the policies, the underlying alarm actions, and any alarm that no longer has an associated action.</p> <p>To remove instances from the Auto Scaling group before deleting it, call <a>DetachInstances</a> with the list of instances and the option to decrement the desired capacity so that Auto Scaling does not launch replacement instances.</p> <p>To terminate all instances before deleting the Auto Scaling group, call <a>UpdateAutoScalingGroup</a> and set the minimum size and desired capacity of the Auto Scaling group to zero.</p>"
},
"DeleteLaunchConfiguration":{
"name":"DeleteLaunchConfiguration",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"LaunchConfigurationNameType"},
"errors":[
{"shape":"ResourceInUseFault"},
{"shape":"ResourceContentionFault"}
],
"documentation":"<p>Deletes the specified launch configuration.</p> <p>The launch configuration must not be attached to an Auto Scaling group. When this call completes, the launch configuration is no longer available for use.</p>"
},
"DeleteLifecycleHook":{
"name":"DeleteLifecycleHook",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DeleteLifecycleHookType"},
"output":{
"shape":"DeleteLifecycleHookAnswer",
"resultWrapper":"DeleteLifecycleHookResult"
},
"errors":[
{"shape":"ResourceContentionFault"}
],
"documentation":"<p>Deletes the specified lifecycle hook.</p> <p>If there are any outstanding lifecycle actions, they are completed first (<code>ABANDON</code> for launching instances, <code>CONTINUE</code> for terminating instances).</p>"
},
"DeleteNotificationConfiguration":{
"name":"DeleteNotificationConfiguration",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DeleteNotificationConfigurationType"},
"errors":[
{"shape":"ResourceContentionFault"}
],
"documentation":"<p>Deletes the specified notification.</p>"
},
"DeletePolicy":{
"name":"DeletePolicy",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DeletePolicyType"},
"errors":[
{"shape":"ResourceContentionFault"}
],
"documentation":"<p>Deletes the specified Auto Scaling policy.</p> <p>Deleting a policy deletes the underlying alarm action, but does not delete the alarm, even if it no longer has an associated action.</p>"
},
"DeleteScheduledAction":{
"name":"DeleteScheduledAction",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DeleteScheduledActionType"},
"errors":[
{"shape":"ResourceContentionFault"}
],
"documentation":"<p>Deletes the specified scheduled action.</p>"
},
"DeleteTags":{
"name":"DeleteTags",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DeleteTagsType"},
"errors":[
{"shape":"ResourceContentionFault"}
],
"documentation":"<p>Deletes the specified tags.</p>"
},
"DescribeAccountLimits":{
"name":"DescribeAccountLimits",
"http":{
"method":"POST",
"requestUri":"/"
},
"output":{
"shape":"DescribeAccountLimitsAnswer",
"resultWrapper":"DescribeAccountLimitsResult"
},
"errors":[
{"shape":"ResourceContentionFault"}
],
"documentation":"<p>Describes the current Auto Scaling resource limits for your AWS account.</p> <p>For information about requesting an increase in these limits, see <a href=\"http://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html\">AWS Service Limits</a> in the <i>Amazon Web Services General Reference</i>.</p>"
},
"DescribeAdjustmentTypes":{
"name":"DescribeAdjustmentTypes",
"http":{
"method":"POST",
"requestUri":"/"
},
"output":{
"shape":"DescribeAdjustmentTypesAnswer",
"resultWrapper":"DescribeAdjustmentTypesResult"
},
"errors":[
{"shape":"ResourceContentionFault"}
],
"documentation":"<p>Describes the policy adjustment types for use with <a>PutScalingPolicy</a>.</p>"
},
"DescribeAutoScalingGroups":{
"name":"DescribeAutoScalingGroups",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"AutoScalingGroupNamesType"},
"output":{
"shape":"AutoScalingGroupsType",
"resultWrapper":"DescribeAutoScalingGroupsResult"
},
"errors":[
{"shape":"InvalidNextToken"},
{"shape":"ResourceContentionFault"}
],
"documentation":"<p>Describes one or more Auto Scaling groups.</p>"
},
"DescribeAutoScalingInstances":{
"name":"DescribeAutoScalingInstances",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DescribeAutoScalingInstancesType"},
"output":{
"shape":"AutoScalingInstancesType",
"resultWrapper":"DescribeAutoScalingInstancesResult"
},
"errors":[
{"shape":"InvalidNextToken"},
{"shape":"ResourceContentionFault"}
],
"documentation":"<p>Describes one or more Auto Scaling instances.</p>"
},
"DescribeAutoScalingNotificationTypes":{
"name":"DescribeAutoScalingNotificationTypes",
"http":{
"method":"POST",
"requestUri":"/"
},
"output":{
"shape":"DescribeAutoScalingNotificationTypesAnswer",
"resultWrapper":"DescribeAutoScalingNotificationTypesResult"
},
"errors":[
{"shape":"ResourceContentionFault"}
],
"documentation":"<p>Describes the notification types that are supported by Auto Scaling.</p>"
},
"DescribeLaunchConfigurations":{
"name":"DescribeLaunchConfigurations",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"LaunchConfigurationNamesType"},
"output":{
"shape":"LaunchConfigurationsType",
"resultWrapper":"DescribeLaunchConfigurationsResult"
},
"errors":[
{"shape":"InvalidNextToken"},
{"shape":"ResourceContentionFault"}
],
"documentation":"<p>Describes one or more launch configurations.</p>"
},
"DescribeLifecycleHookTypes":{
"name":"DescribeLifecycleHookTypes",
"http":{
"method":"POST",
"requestUri":"/"
},
"output":{
"shape":"DescribeLifecycleHookTypesAnswer",
"resultWrapper":"DescribeLifecycleHookTypesResult"
},
"errors":[
{"shape":"ResourceContentionFault"}
],
"documentation":"<p>Describes the available types of lifecycle hooks.</p>"
},
"DescribeLifecycleHooks":{
"name":"DescribeLifecycleHooks",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DescribeLifecycleHooksType"},
"output":{
"shape":"DescribeLifecycleHooksAnswer",
"resultWrapper":"DescribeLifecycleHooksResult"
},
"errors":[
{"shape":"ResourceContentionFault"}
],
"documentation":"<p>Describes the lifecycle hooks for the specified Auto Scaling group.</p>"
},
"DescribeLoadBalancerTargetGroups":{
"name":"DescribeLoadBalancerTargetGroups",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DescribeLoadBalancerTargetGroupsRequest"},
"output":{
"shape":"DescribeLoadBalancerTargetGroupsResponse",
"resultWrapper":"DescribeLoadBalancerTargetGroupsResult"
},
"errors":[
{"shape":"ResourceContentionFault"}
],
"documentation":"<p>Describes the target groups for the specified Auto Scaling group.</p>"
},
"DescribeLoadBalancers":{
"name":"DescribeLoadBalancers",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DescribeLoadBalancersRequest"},
"output":{
"shape":"DescribeLoadBalancersResponse",
"resultWrapper":"DescribeLoadBalancersResult"
},
"errors":[
{"shape":"ResourceContentionFault"}
],
"documentation":"<p>Describes the load balancers for the specified Auto Scaling group.</p> <p>Note that this operation describes only Classic load balancers. If you have Application load balancers, use <a>DescribeLoadBalancerTargetGroups</a> instead.</p>"
},
"DescribeMetricCollectionTypes":{
"name":"DescribeMetricCollectionTypes",
"http":{
"method":"POST",
"requestUri":"/"
},
"output":{
"shape":"DescribeMetricCollectionTypesAnswer",
"resultWrapper":"DescribeMetricCollectionTypesResult"
},
"errors":[
{"shape":"ResourceContentionFault"}
],
"documentation":"<p>Describes the available CloudWatch metrics for Auto Scaling.</p> <p>Note that the <code>GroupStandbyInstances</code> metric is not returned by default. You must explicitly request this metric when calling <a>EnableMetricsCollection</a>.</p>"
},
"DescribeNotificationConfigurations":{
"name":"DescribeNotificationConfigurations",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DescribeNotificationConfigurationsType"},
"output":{
"shape":"DescribeNotificationConfigurationsAnswer",
"resultWrapper":"DescribeNotificationConfigurationsResult"
},
"errors":[
{"shape":"InvalidNextToken"},
{"shape":"ResourceContentionFault"}
],
"documentation":"<p>Describes the notification actions associated with the specified Auto Scaling group.</p>"
},
"DescribePolicies":{
"name":"DescribePolicies",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DescribePoliciesType"},
"output":{
"shape":"PoliciesType",
"resultWrapper":"DescribePoliciesResult"
},
"errors":[
{"shape":"InvalidNextToken"},
{"shape":"ResourceContentionFault"}
],
"documentation":"<p>Describes the policies for the specified Auto Scaling group.</p>"
},
"DescribeScalingActivities":{
"name":"DescribeScalingActivities",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DescribeScalingActivitiesType"},
"output":{
"shape":"ActivitiesType",
"resultWrapper":"DescribeScalingActivitiesResult"
},
"errors":[
{"shape":"InvalidNextToken"},
{"shape":"ResourceContentionFault"}
],
"documentation":"<p>Describes one or more scaling activities for the specified Auto Scaling group.</p>"
},
"DescribeScalingProcessTypes":{
"name":"DescribeScalingProcessTypes",
"http":{
"method":"POST",
"requestUri":"/"
},
"output":{
"shape":"ProcessesType",
"resultWrapper":"DescribeScalingProcessTypesResult"
},
"errors":[
{"shape":"ResourceContentionFault"}
],
"documentation":"<p>Describes the scaling process types for use with <a>ResumeProcesses</a> and <a>SuspendProcesses</a>.</p>"
},
"DescribeScheduledActions":{
"name":"DescribeScheduledActions",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DescribeScheduledActionsType"},
"output":{
"shape":"ScheduledActionsType",
"resultWrapper":"DescribeScheduledActionsResult"
},
"errors":[
{"shape":"InvalidNextToken"},
{"shape":"ResourceContentionFault"}
],
"documentation":"<p>Describes the actions scheduled for your Auto Scaling group that haven't run. To describe the actions that have already run, use <a>DescribeScalingActivities</a>.</p>"
},
"DescribeTags":{
"name":"DescribeTags",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DescribeTagsType"},
"output":{
"shape":"TagsType",
"resultWrapper":"DescribeTagsResult"
},
"errors":[
{"shape":"InvalidNextToken"},
{"shape":"ResourceContentionFault"}
],
"documentation":"<p>Describes the specified tags.</p> <p>You can use filters to limit the results. For example, you can query for the tags for a specific Auto Scaling group. You can specify multiple values for a filter. A tag must match at least one of the specified values for it to be included in the results.</p> <p>You can also specify multiple filters. The result includes information for a particular tag only if it matches all the filters. If there's no match, no special message is returned.</p>"
},
"DescribeTerminationPolicyTypes":{
"name":"DescribeTerminationPolicyTypes",
"http":{
"method":"POST",
"requestUri":"/"
},
"output":{
"shape":"DescribeTerminationPolicyTypesAnswer",
"resultWrapper":"DescribeTerminationPolicyTypesResult"
},
"errors":[
{"shape":"ResourceContentionFault"}
],
"documentation":"<p>Describes the termination policies supported by Auto Scaling.</p>"
},
"DetachInstances":{
"name":"DetachInstances",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DetachInstancesQuery"},
"output":{
"shape":"DetachInstancesAnswer",
"resultWrapper":"DetachInstancesResult"
},
"errors":[
{"shape":"ResourceContentionFault"}
],
"documentation":"<p>Removes one or more instances from the specified Auto Scaling group.</p> <p>After the instances are detached, you can manage them independently from the rest of the Auto Scaling group.</p> <p>If you do not specify the option to decrement the desired capacity, Auto Scaling launches instances to replace the ones that are detached.</p> <p>If there is a Classic load balancer attached to the Auto Scaling group, the instances are deregistered from the load balancer. If there are target groups attached to the Auto Scaling group, the instances are deregistered from the target groups.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/autoscaling/latest/userguide/detach-instance-asg.html\">Detach EC2 Instances from Your Auto Scaling Group</a> in the <i>Auto Scaling User Guide</i>.</p>"
},
"DetachLoadBalancerTargetGroups":{
"name":"DetachLoadBalancerTargetGroups",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DetachLoadBalancerTargetGroupsType"},
"output":{
"shape":"DetachLoadBalancerTargetGroupsResultType",
"resultWrapper":"DetachLoadBalancerTargetGroupsResult"
},
"errors":[
{"shape":"ResourceContentionFault"}
],
"documentation":"<p>Detaches one or more target groups from the specified Auto Scaling group.</p>"
},
"DetachLoadBalancers":{
"name":"DetachLoadBalancers",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DetachLoadBalancersType"},
"output":{
"shape":"DetachLoadBalancersResultType",
"resultWrapper":"DetachLoadBalancersResult"
},
"errors":[
{"shape":"ResourceContentionFault"}
],
"documentation":"<p>Detaches one or more Classic load balancers from the specified Auto Scaling group.</p> <p>Note that this operation detaches only Classic load balancers. If you have Application load balancers, use <a>DetachLoadBalancerTargetGroups</a> instead.</p> <p>When you detach a load balancer, it enters the <code>Removing</code> state while deregistering the instances in the group. When all instances are deregistered, then you can no longer describe the load balancer using <a>DescribeLoadBalancers</a>. Note that the instances remain running.</p>"
},
"DisableMetricsCollection":{
"name":"DisableMetricsCollection",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DisableMetricsCollectionQuery"},
"errors":[
{"shape":"ResourceContentionFault"}
],
"documentation":"<p>Disables group metrics for the specified Auto Scaling group.</p>"
},
"EnableMetricsCollection":{
"name":"EnableMetricsCollection",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"EnableMetricsCollectionQuery"},
"errors":[
{"shape":"ResourceContentionFault"}
],
"documentation":"<p>Enables group metrics for the specified Auto Scaling group. For more information, see <a href=\"http://docs.aws.amazon.com/autoscaling/latest/userguide/as-instance-monitoring.html\">Monitoring Your Auto Scaling Groups and Instances</a> in the <i>Auto Scaling User Guide</i>.</p>"
},
"EnterStandby":{
"name":"EnterStandby",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"EnterStandbyQuery"},
"output":{
"shape":"EnterStandbyAnswer",
"resultWrapper":"EnterStandbyResult"
},
"errors":[
{"shape":"ResourceContentionFault"}
],
"documentation":"<p>Moves the specified instances into <code>Standby</code> mode.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/autoscaling/latest/userguide/AutoScalingGroupLifecycle.html\">Auto Scaling Lifecycle</a> in the <i>Auto Scaling User Guide</i>.</p>"
},
"ExecutePolicy":{
"name":"ExecutePolicy",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ExecutePolicyType"},
"errors":[
{"shape":"ScalingActivityInProgressFault"},
{"shape":"ResourceContentionFault"}
],
"documentation":"<p>Executes the specified policy.</p>"
},
"ExitStandby":{
"name":"ExitStandby",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ExitStandbyQuery"},
"output":{
"shape":"ExitStandbyAnswer",
"resultWrapper":"ExitStandbyResult"
},
"errors":[
{"shape":"ResourceContentionFault"}
],
"documentation":"<p>Moves the specified instances out of <code>Standby</code> mode.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/autoscaling/latest/userguide/AutoScalingGroupLifecycle.html\">Auto Scaling Lifecycle</a> in the <i>Auto Scaling User Guide</i>.</p>"
},
"PutLifecycleHook":{
"name":"PutLifecycleHook",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"PutLifecycleHookType"},
"output":{
"shape":"PutLifecycleHookAnswer",
"resultWrapper":"PutLifecycleHookResult"
},
"errors":[
{"shape":"LimitExceededFault"},
{"shape":"ResourceContentionFault"}
],
"documentation":"<p>Creates or updates a lifecycle hook for the specified Auto Scaling Group.</p> <p>A lifecycle hook tells Auto Scaling that you want to perform an action on an instance that is not actively in service; for example, either when the instance launches or before the instance terminates.</p> <p>This step is a part of the procedure for adding a lifecycle hook to an Auto Scaling group:</p> <ol> <li> <p>(Optional) Create a Lambda function and a rule that allows CloudWatch Events to invoke your Lambda function when Auto Scaling launches or terminates instances.</p> </li> <li> <p>(Optional) Create a notification target and an IAM role. The target can be either an Amazon SQS queue or an Amazon SNS topic. The role allows Auto Scaling to publish lifecycle notifications to the target.</p> </li> <li> <p> <b>Create the lifecycle hook. Specify whether the hook is used when the instances launch or terminate.</b> </p> </li> <li> <p>If you need more time, record the lifecycle action heartbeat to keep the instance in a pending state.</p> </li> <li> <p>If you finish before the timeout period ends, complete the lifecycle action.</p> </li> </ol> <p>For more information, see <a href=\"http://docs.aws.amazon.com/autoscaling/latest/userguide/lifecycle-hooks.html\">Auto Scaling Lifecycle Hooks</a> in the <i>Auto Scaling User Guide</i>.</p> <p>If you exceed your maximum limit of lifecycle hooks, which by default is 50 per Auto Scaling group, the call fails. For information about updating this limit, see <a href=\"http://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html\">AWS Service Limits</a> in the <i>Amazon Web Services General Reference</i>.</p>"
},
"PutNotificationConfiguration":{
"name":"PutNotificationConfiguration",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"PutNotificationConfigurationType"},
"errors":[
{"shape":"LimitExceededFault"},
{"shape":"ResourceContentionFault"}
],
"documentation":"<p>Configures an Auto Scaling group to send notifications when specified events take place. Subscribers to the specified topic can have messages delivered to an endpoint such as a web server or an email address.</p> <p>This configuration overwrites any existing configuration.</p> <p>For more information see <a href=\"http://docs.aws.amazon.com/autoscaling/latest/userguide/ASGettingNotifications.html\">Getting SNS Notifications When Your Auto Scaling Group Scales</a> in the <i>Auto Scaling User Guide</i>.</p>"
},
"PutScalingPolicy":{
"name":"PutScalingPolicy",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"PutScalingPolicyType"},
"output":{
"shape":"PolicyARNType",
"resultWrapper":"PutScalingPolicyResult"
},
"errors":[
{"shape":"LimitExceededFault"},
{"shape":"ResourceContentionFault"}
],
"documentation":"<p>Creates or updates a policy for an Auto Scaling group. To update an existing policy, use the existing policy name and set the parameters you want to change. Any existing parameter not changed in an update to an existing policy is not changed in this update request.</p> <p>If you exceed your maximum limit of step adjustments, which by default is 20 per region, the call fails. For information about updating this limit, see <a href=\"http://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html\">AWS Service Limits</a> in the <i>Amazon Web Services General Reference</i>.</p>"
},
"PutScheduledUpdateGroupAction":{
"name":"PutScheduledUpdateGroupAction",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"PutScheduledUpdateGroupActionType"},
"errors":[
{"shape":"AlreadyExistsFault"},
{"shape":"LimitExceededFault"},
{"shape":"ResourceContentionFault"}
],
"documentation":"<p>Creates or updates a scheduled scaling action for an Auto Scaling group. When updating a scheduled scaling action, if you leave a parameter unspecified, the corresponding value remains unchanged.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/autoscaling/latest/userguide/schedule_time.html\">Scheduled Scaling</a> in the <i>Auto Scaling User Guide</i>.</p>"
},
"RecordLifecycleActionHeartbeat":{
"name":"RecordLifecycleActionHeartbeat",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"RecordLifecycleActionHeartbeatType"},
"output":{
"shape":"RecordLifecycleActionHeartbeatAnswer",
"resultWrapper":"RecordLifecycleActionHeartbeatResult"
},
"errors":[
{"shape":"ResourceContentionFault"}
],
"documentation":"<p>Records a heartbeat for the lifecycle action associated with the specified token or instance. This extends the timeout by the length of time defined using <a>PutLifecycleHook</a>.</p> <p>This step is a part of the procedure for adding a lifecycle hook to an Auto Scaling group:</p> <ol> <li> <p>(Optional) Create a Lambda function and a rule that allows CloudWatch Events to invoke your Lambda function when Auto Scaling launches or terminates instances.</p> </li> <li> <p>(Optional) Create a notification target and an IAM role. The target can be either an Amazon SQS queue or an Amazon SNS topic. The role allows Auto Scaling to publish lifecycle notifications to the target.</p> </li> <li> <p>Create the lifecycle hook. Specify whether the hook is used when the instances launch or terminate.</p> </li> <li> <p> <b>If you need more time, record the lifecycle action heartbeat to keep the instance in a pending state.</b> </p> </li> <li> <p>If you finish before the timeout period ends, complete the lifecycle action.</p> </li> </ol> <p>For more information, see <a href=\"http://docs.aws.amazon.com/autoscaling/latest/userguide/AutoScalingGroupLifecycle.html\">Auto Scaling Lifecycle</a> in the <i>Auto Scaling User Guide</i>.</p>"
},
"ResumeProcesses":{
"name":"ResumeProcesses",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ScalingProcessQuery"},
"errors":[
{"shape":"ResourceInUseFault"},
{"shape":"ResourceContentionFault"}
],
"documentation":"<p>Resumes the specified suspended Auto Scaling processes, or all suspended process, for the specified Auto Scaling group.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/autoscaling/latest/userguide/as-suspend-resume-processes.html\">Suspending and Resuming Auto Scaling Processes</a> in the <i>Auto Scaling User Guide</i>.</p>"
},
"SetDesiredCapacity":{
"name":"SetDesiredCapacity",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"SetDesiredCapacityType"},
"errors":[
{"shape":"ScalingActivityInProgressFault"},
{"shape":"ResourceContentionFault"}
],
"documentation":"<p>Sets the size of the specified Auto Scaling group.</p> <p>For more information about desired capacity, see <a href=\"http://docs.aws.amazon.com/autoscaling/latest/userguide/WhatIsAutoScaling.html\">What Is Auto Scaling?</a> in the <i>Auto Scaling User Guide</i>.</p>"
},
"SetInstanceHealth":{
"name":"SetInstanceHealth",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"SetInstanceHealthQuery"},
"errors":[
{"shape":"ResourceContentionFault"}
],
"documentation":"<p>Sets the health status of the specified instance.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/autoscaling/latest/userguide/healthcheck.html\">Health Checks</a> in the <i>Auto Scaling User Guide</i>.</p>"
},
"SetInstanceProtection":{
"name":"SetInstanceProtection",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"SetInstanceProtectionQuery"},
"output":{
"shape":"SetInstanceProtectionAnswer",
"resultWrapper":"SetInstanceProtectionResult"
},
"errors":[
{"shape":"LimitExceededFault"},
{"shape":"ResourceContentionFault"}
],
"documentation":"<p>Updates the instance protection settings of the specified instances.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/autoscaling/latest/userguide/as-instance-termination.html#instance-protection\">Instance Protection</a> in the <i>Auto Scaling User Guide</i>.</p>"
},
"SuspendProcesses":{
"name":"SuspendProcesses",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ScalingProcessQuery"},
"errors":[
{"shape":"ResourceInUseFault"},
{"shape":"ResourceContentionFault"}
],
"documentation":"<p>Suspends the specified Auto Scaling processes, or all processes, for the specified Auto Scaling group.</p> <p>Note that if you suspend either the <code>Launch</code> or <code>Terminate</code> process types, it can prevent other process types from functioning properly.</p> <p>To resume processes that have been suspended, use <a>ResumeProcesses</a>.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/autoscaling/latest/userguide/as-suspend-resume-processes.html\">Suspending and Resuming Auto Scaling Processes</a> in the <i>Auto Scaling User Guide</i>.</p>"
},
"TerminateInstanceInAutoScalingGroup":{
"name":"TerminateInstanceInAutoScalingGroup",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"TerminateInstanceInAutoScalingGroupType"},
"output":{
"shape":"ActivityType",
"resultWrapper":"TerminateInstanceInAutoScalingGroupResult"
},
"errors":[
{"shape":"ScalingActivityInProgressFault"},
{"shape":"ResourceContentionFault"}
],
"documentation":"<p>Terminates the specified instance and optionally adjusts the desired group size.</p> <p>This call simply makes a termination request. The instance is not terminated immediately.</p>"
},
"UpdateAutoScalingGroup":{
"name":"UpdateAutoScalingGroup",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"UpdateAutoScalingGroupType"},
"errors":[
{"shape":"ScalingActivityInProgressFault"},
{"shape":"ResourceContentionFault"}
],
"documentation":"<p>Updates the configuration for the specified Auto Scaling group.</p> <p>To update an Auto Scaling group with a launch configuration with <code>InstanceMonitoring</code> set to <code>False</code>, you must first disable the collection of group metrics. Otherwise, you will get an error. If you have previously enabled the collection of group metrics, you can disable it using <a>DisableMetricsCollection</a>.</p> <p>The new settings are registered upon the completion of this call. Any launch configuration settings take effect on any triggers after this call returns. Scaling activities that are currently in progress aren't affected.</p> <p>Note the following:</p> <ul> <li> <p>If you specify a new value for <code>MinSize</code> without specifying a value for <code>DesiredCapacity</code>, and the new <code>MinSize</code> is larger than the current size of the group, we implicitly call <a>SetDesiredCapacity</a> to set the size of the group to the new value of <code>MinSize</code>.</p> </li> <li> <p>If you specify a new value for <code>MaxSize</code> without specifying a value for <code>DesiredCapacity</code>, and the new <code>MaxSize</code> is smaller than the current size of the group, we implicitly call <a>SetDesiredCapacity</a> to set the size of the group to the new value of <code>MaxSize</code>.</p> </li> <li> <p>All other optional parameters are left unchanged if not specified.</p> </li> </ul>"
}
},
"shapes":{
"Activities":{
"type":"list",
"member":{"shape":"Activity"}
},
"ActivitiesType":{
"type":"structure",
"required":["Activities"],
"members":{
"Activities":{
"shape":"Activities",
"documentation":"<p>The scaling activities. Activities are sorted by start time. Activities still in progress are described first.</p>"
},
"NextToken":{
"shape":"XmlString",
"documentation":"<p>The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.</p>"
}
},
"documentation":"<p>Contains the output of DescribeScalingActivities.</p>"
},
"Activity":{
"type":"structure",
"required":[
"ActivityId",
"AutoScalingGroupName",
"Cause",
"StartTime",
"StatusCode"
],
"members":{
"ActivityId":{
"shape":"XmlString",
"documentation":"<p>The ID of the activity.</p>"
},
"AutoScalingGroupName":{
"shape":"XmlStringMaxLen255",
"documentation":"<p>The name of the Auto Scaling group.</p>"
},
"Description":{
"shape":"XmlString",
"documentation":"<p>A friendly, more verbose description of the activity.</p>"
},
"Cause":{
"shape":"XmlStringMaxLen1023",
"documentation":"<p>The reason the activity began.</p>"
},
"StartTime":{
"shape":"TimestampType",
"documentation":"<p>The start time of the activity.</p>"
},
"EndTime":{
"shape":"TimestampType",
"documentation":"<p>The end time of the activity.</p>"
},
"StatusCode":{
"shape":"ScalingActivityStatusCode",
"documentation":"<p>The current status of the activity.</p>"
},
"StatusMessage":{
"shape":"XmlStringMaxLen255",
"documentation":"<p>A friendly, more verbose description of the activity status.</p>"
},
"Progress":{
"shape":"Progress",
"documentation":"<p>A value between 0 and 100 that indicates the progress of the activity.</p>"
},
"Details":{
"shape":"XmlString",
"documentation":"<p>The details about the activity.</p>"
}
},
"documentation":"<p>Describes scaling activity, which is a long-running process that represents a change to your Auto Scaling group, such as changing its size or replacing an instance.</p>"
},
"ActivityIds":{
"type":"list",
"member":{"shape":"XmlString"}
},
"ActivityType":{
"type":"structure",
"members":{
"Activity":{
"shape":"Activity",
"documentation":"<p>A scaling activity.</p>"
}
},
"documentation":"<p>Contains the output of TerminateInstancesInAutoScalingGroup.</p>"
},
"AdjustmentType":{
"type":"structure",
"members":{
"AdjustmentType":{
"shape":"XmlStringMaxLen255",
"documentation":"<p>The policy adjustment type. The valid values are <code>ChangeInCapacity</code>, <code>ExactCapacity</code>, and <code>PercentChangeInCapacity</code>.</p>"
}
},
"documentation":"<p>Describes a policy adjustment type.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/as-scale-based-on-demand.html\">Dynamic Scaling</a> in the <i>Auto Scaling User Guide</i>.</p>"
},
"AdjustmentTypes":{
"type":"list",
"member":{"shape":"AdjustmentType"}
},
"Alarm":{
"type":"structure",
"members":{
"AlarmName":{
"shape":"XmlStringMaxLen255",
"documentation":"<p>The name of the alarm.</p>"
},
"AlarmARN":{
"shape":"ResourceName",
"documentation":"<p>The Amazon Resource Name (ARN) of the alarm.</p>"
}
},
"documentation":"<p>Describes an alarm.</p>"
},
"Alarms":{
"type":"list",
"member":{"shape":"Alarm"}
},
"AlreadyExistsFault":{
"type":"structure",
"members":{
"message":{
"shape":"XmlStringMaxLen255",
"documentation":"<p/>"
}
},
"documentation":"<p>You already have an Auto Scaling group or launch configuration with this name.</p>",
"error":{
"code":"AlreadyExists",
"httpStatusCode":400,
"senderFault":true
},
"exception":true
},
"AsciiStringMaxLen255":{
"type":"string",
"max":255,
"min":1,
"pattern":"[A-Za-z0-9\\-_\\/]+"
},
"AssociatePublicIpAddress":{"type":"boolean"},
"AttachInstancesQuery":{
"type":"structure",
"required":["AutoScalingGroupName"],
"members":{
"InstanceIds":{
"shape":"InstanceIds",
"documentation":"<p>One or more instance IDs.</p>"
},
"AutoScalingGroupName":{
"shape":"ResourceName",
"documentation":"<p>The name of the group.</p>"
}
},
"documentation":"<p>Contains the parameters for AttachInstances.</p>"
},
"AttachLoadBalancerTargetGroupsResultType":{
"type":"structure",
"members":{
}
},
"AttachLoadBalancerTargetGroupsType":{
"type":"structure",
"required":[
"AutoScalingGroupName",
"TargetGroupARNs"
],
"members":{
"AutoScalingGroupName":{
"shape":"ResourceName",
"documentation":"<p>The name of the Auto Scaling group.</p>"
},
"TargetGroupARNs":{
"shape":"TargetGroupARNs",
"documentation":"<p>The Amazon Resource Names (ARN) of the target groups.</p>"
}
},
"documentation":"<p>Contains the parameters for AttachLoadBalancerTargetGroups.</p>"
},
"AttachLoadBalancersResultType":{
"type":"structure",
"members":{
},
"documentation":"<p>Contains the output of AttachLoadBalancers.</p>"
},
"AttachLoadBalancersType":{
"type":"structure",
"required":[
"AutoScalingGroupName",
"LoadBalancerNames"
],
"members":{
"AutoScalingGroupName":{
"shape":"ResourceName",
"documentation":"<p>The name of the group.</p>"
},
"LoadBalancerNames":{
"shape":"LoadBalancerNames",
"documentation":"<p>One or more load balancer names.</p>"
}
},
"documentation":"<p>Contains the parameters for AttachLoadBalancers.</p>"
},
"AutoScalingGroup":{
"type":"structure",
"required":[
"AutoScalingGroupName",
"MinSize",
"MaxSize",
"DesiredCapacity",
"DefaultCooldown",
"AvailabilityZones",