forked from aws/aws-sdk-js
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathcloudformation-2010-05-15.normal.json
2291 lines (2291 loc) · 123 KB
/
cloudformation-2010-05-15.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":"2010-05-15",
"endpointPrefix":"cloudformation",
"protocol":"query",
"serviceFullName":"AWS CloudFormation",
"signatureVersion":"v4",
"uid":"cloudformation-2010-05-15",
"xmlNamespace":"http://cloudformation.amazonaws.com/doc/2010-05-15/"
},
"operations":{
"CancelUpdateStack":{
"name":"CancelUpdateStack",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"CancelUpdateStackInput"},
"documentation":"<p>Cancels an update on the specified stack. If the call completes successfully, the stack rolls back the update and reverts to the previous stack configuration.</p> <note> <p>You can cancel only stacks that are in the UPDATE_IN_PROGRESS state.</p> </note>"
},
"ContinueUpdateRollback":{
"name":"ContinueUpdateRollback",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ContinueUpdateRollbackInput"},
"output":{
"shape":"ContinueUpdateRollbackOutput",
"resultWrapper":"ContinueUpdateRollbackResult"
},
"documentation":"<p>For a specified stack that is in the <code>UPDATE_ROLLBACK_FAILED</code> state, continues rolling it back to the <code>UPDATE_ROLLBACK_COMPLETE</code> state. Depending on the cause of the failure, you can manually <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/troubleshooting.html#troubleshooting-errors-update-rollback-failed\"> fix the error</a> and continue the rollback. By continuing the rollback, you can return your stack to a working state (the <code>UPDATE_ROLLBACK_COMPLETE</code> state), and then try to update the stack again.</p> <p>A stack goes into the <code>UPDATE_ROLLBACK_FAILED</code> state when AWS CloudFormation cannot roll back all changes after a failed stack update. For example, you might have a stack that is rolling back to an old database instance that was deleted outside of AWS CloudFormation. Because AWS CloudFormation doesn't know the database was deleted, it assumes that the database instance still exists and attempts to roll back to it, causing the update rollback to fail.</p>"
},
"CreateChangeSet":{
"name":"CreateChangeSet",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"CreateChangeSetInput"},
"output":{
"shape":"CreateChangeSetOutput",
"resultWrapper":"CreateChangeSetResult"
},
"errors":[
{"shape":"AlreadyExistsException"},
{"shape":"InsufficientCapabilitiesException"},
{"shape":"LimitExceededException"}
],
"documentation":"<p>Creates a list of changes for a stack. AWS CloudFormation generates the change set by comparing the template's information with the information that you submit. A change set can help you understand which resources AWS CloudFormation will change, and how it will change them, before you update your stack. Change sets allow you to check before making a change to avoid deleting or replacing critical resources.</p> <p>AWS CloudFormation doesn't make any changes to the stack when you create a change set. To make the specified changes, you must execute the change set by using the <a>ExecuteChangeSet</a> action.</p> <p>After the call successfully completes, AWS CloudFormation starts creating the change set. To check the status of the change set, use the <a>DescribeChangeSet</a> action.</p>"
},
"CreateStack":{
"name":"CreateStack",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"CreateStackInput"},
"output":{
"shape":"CreateStackOutput",
"resultWrapper":"CreateStackResult"
},
"errors":[
{"shape":"LimitExceededException"},
{"shape":"AlreadyExistsException"},
{"shape":"InsufficientCapabilitiesException"}
],
"documentation":"<p>Creates a stack as specified in the template. After the call completes successfully, the stack creation starts. You can check the status of the stack via the <a>DescribeStacks</a> API.</p>"
},
"DeleteChangeSet":{
"name":"DeleteChangeSet",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DeleteChangeSetInput"},
"output":{
"shape":"DeleteChangeSetOutput",
"resultWrapper":"DeleteChangeSetResult"
},
"errors":[
{"shape":"InvalidChangeSetStatusException"}
],
"documentation":"<p>Deletes the specified change set. Deleting change sets ensures that no one executes the wrong change set.</p> <p>If the call successfully completes, AWS CloudFormation successfully deleted the change set.</p>"
},
"DeleteStack":{
"name":"DeleteStack",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DeleteStackInput"},
"documentation":"<p>Deletes a specified stack. Once the call completes successfully, stack deletion starts. Deleted stacks do not show up in the <a>DescribeStacks</a> API if the deletion has been completed successfully.</p>"
},
"DescribeAccountLimits":{
"name":"DescribeAccountLimits",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DescribeAccountLimitsInput"},
"output":{
"shape":"DescribeAccountLimitsOutput",
"resultWrapper":"DescribeAccountLimitsResult"
},
"documentation":"<p>Retrieves your account's AWS CloudFormation limits, such as the maximum number of stacks that you can create in your account.</p>"
},
"DescribeChangeSet":{
"name":"DescribeChangeSet",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DescribeChangeSetInput"},
"output":{
"shape":"DescribeChangeSetOutput",
"resultWrapper":"DescribeChangeSetResult"
},
"errors":[
{"shape":"ChangeSetNotFoundException"}
],
"documentation":"<p>Returns the inputs for the change set and a list of changes that AWS CloudFormation will make if you execute the change set. For more information, see <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-changesets.html\">Updating Stacks Using Change Sets</a> in the AWS CloudFormation User Guide.</p>"
},
"DescribeStackEvents":{
"name":"DescribeStackEvents",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DescribeStackEventsInput"},
"output":{
"shape":"DescribeStackEventsOutput",
"resultWrapper":"DescribeStackEventsResult"
},
"documentation":"<p>Returns all stack related events for a specified stack in reverse chronological order. For more information about a stack's event history, go to <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/concept-stack.html\">Stacks</a> in the AWS CloudFormation User Guide.</p> <note> <p>You can list events for stacks that have failed to create or have been deleted by specifying the unique stack identifier (stack ID).</p> </note>"
},
"DescribeStackResource":{
"name":"DescribeStackResource",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DescribeStackResourceInput"},
"output":{
"shape":"DescribeStackResourceOutput",
"resultWrapper":"DescribeStackResourceResult"
},
"documentation":"<p>Returns a description of the specified resource in the specified stack.</p> <p>For deleted stacks, DescribeStackResource returns resource information for up to 90 days after the stack has been deleted.</p>"
},
"DescribeStackResources":{
"name":"DescribeStackResources",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DescribeStackResourcesInput"},
"output":{
"shape":"DescribeStackResourcesOutput",
"resultWrapper":"DescribeStackResourcesResult"
},
"documentation":"<p>Returns AWS resource descriptions for running and deleted stacks. If <code>StackName</code> is specified, all the associated resources that are part of the stack are returned. If <code>PhysicalResourceId</code> is specified, the associated resources of the stack that the resource belongs to are returned.</p> <note> <p>Only the first 100 resources will be returned. If your stack has more resources than this, you should use <code>ListStackResources</code> instead.</p> </note> <p>For deleted stacks, <code>DescribeStackResources</code> returns resource information for up to 90 days after the stack has been deleted.</p> <p>You must specify either <code>StackName</code> or <code>PhysicalResourceId</code>, but not both. In addition, you can specify <code>LogicalResourceId</code> to filter the returned result. For more information about resources, the <code>LogicalResourceId</code> and <code>PhysicalResourceId</code>, go to the <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/\">AWS CloudFormation User Guide</a>.</p> <note> <p>A <code>ValidationError</code> is returned if you specify both <code>StackName</code> and <code>PhysicalResourceId</code> in the same request.</p> </note>"
},
"DescribeStacks":{
"name":"DescribeStacks",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DescribeStacksInput"},
"output":{
"shape":"DescribeStacksOutput",
"resultWrapper":"DescribeStacksResult"
},
"documentation":"<p>Returns the description for the specified stack; if no stack name was specified, then it returns the description for all the stacks created.</p> <note> <p>If the stack does not exist, an <code>AmazonCloudFormationException</code> is returned.</p> </note>"
},
"EstimateTemplateCost":{
"name":"EstimateTemplateCost",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"EstimateTemplateCostInput"},
"output":{
"shape":"EstimateTemplateCostOutput",
"resultWrapper":"EstimateTemplateCostResult"
},
"documentation":"<p>Returns the estimated monthly cost of a template. The return value is an AWS Simple Monthly Calculator URL with a query string that describes the resources required to run the template.</p>"
},
"ExecuteChangeSet":{
"name":"ExecuteChangeSet",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ExecuteChangeSetInput"},
"output":{
"shape":"ExecuteChangeSetOutput",
"resultWrapper":"ExecuteChangeSetResult"
},
"errors":[
{"shape":"InvalidChangeSetStatusException"},
{"shape":"ChangeSetNotFoundException"},
{"shape":"InsufficientCapabilitiesException"}
],
"documentation":"<p>Updates a stack using the input information that was provided when the specified change set was created. After the call successfully completes, AWS CloudFormation starts updating the stack. Use the <a>DescribeStacks</a> action to view the status of the update.</p> <p>When you execute a change set, AWS CloudFormation deletes all other change sets associated with the stack because they aren't valid for the updated stack.</p> <p>If a stack policy is associated with the stack, AWS CloudFormation enforces the policy during the update. You can't specify a temporary stack policy that overrides the current policy.</p>"
},
"GetStackPolicy":{
"name":"GetStackPolicy",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"GetStackPolicyInput"},
"output":{
"shape":"GetStackPolicyOutput",
"resultWrapper":"GetStackPolicyResult"
},
"documentation":"<p>Returns the stack policy for a specified stack. If a stack doesn't have a policy, a null value is returned.</p>"
},
"GetTemplate":{
"name":"GetTemplate",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"GetTemplateInput"},
"output":{
"shape":"GetTemplateOutput",
"resultWrapper":"GetTemplateResult"
},
"errors":[
{"shape":"ChangeSetNotFoundException"}
],
"documentation":"<p>Returns the template body for a specified stack. You can get the template for running or deleted stacks.</p> <p>For deleted stacks, GetTemplate returns the template for up to 90 days after the stack has been deleted.</p> <note> <p> If the template does not exist, a <code>ValidationError</code> is returned. </p> </note>"
},
"GetTemplateSummary":{
"name":"GetTemplateSummary",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"GetTemplateSummaryInput"},
"output":{
"shape":"GetTemplateSummaryOutput",
"resultWrapper":"GetTemplateSummaryResult"
},
"documentation":"<p>Returns information about a new or existing template. The <code>GetTemplateSummary</code> action is useful for viewing parameter information, such as default parameter values and parameter types, before you create or update a stack.</p> <p>You can use the <code>GetTemplateSummary</code> action when you submit a template, or you can get template information for a running or deleted stack.</p> <p>For deleted stacks, <code>GetTemplateSummary</code> returns the template information for up to 90 days after the stack has been deleted. If the template does not exist, a <code>ValidationError</code> is returned.</p>"
},
"ListChangeSets":{
"name":"ListChangeSets",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ListChangeSetsInput"},
"output":{
"shape":"ListChangeSetsOutput",
"resultWrapper":"ListChangeSetsResult"
},
"documentation":"<p>Returns the ID and status of each active change set for a stack. For example, AWS CloudFormation lists change sets that are in the <code>CREATE_IN_PROGRESS</code> or <code>CREATE_PENDING</code> state.</p>"
},
"ListExports":{
"name":"ListExports",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ListExportsInput"},
"output":{
"shape":"ListExportsOutput",
"resultWrapper":"ListExportsResult"
},
"documentation":"<p>Lists all exported output values in the account and region in which you call this action. Use this action to see the exported output values that you can import into other stacks. To import values, use the <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-importvalue.html\"> <code>Fn::ImportValue</code> </a> function. </p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-stack-exports.html\"> AWS CloudFormation Export Stack Output Values</a>.</p>"
},
"ListImports":{
"name":"ListImports",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ListImportsInput"},
"output":{
"shape":"ListImportsOutput",
"resultWrapper":"ListImportsResult"
},
"documentation":"<p>Lists all stacks that are importing an exported output value. To modify or remove an exported output value, first use this action to see which stacks are using it. To see the exported output values in your account, see <a>ListExports</a>. </p> <p>For more information about importing an exported output value, see the <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-importvalue.html\"> <code>Fn::ImportValue</code> </a> function. </p>"
},
"ListStackResources":{
"name":"ListStackResources",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ListStackResourcesInput"},
"output":{
"shape":"ListStackResourcesOutput",
"resultWrapper":"ListStackResourcesResult"
},
"documentation":"<p>Returns descriptions of all resources of the specified stack.</p> <p>For deleted stacks, ListStackResources returns resource information for up to 90 days after the stack has been deleted.</p>"
},
"ListStacks":{
"name":"ListStacks",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ListStacksInput"},
"output":{
"shape":"ListStacksOutput",
"resultWrapper":"ListStacksResult"
},
"documentation":"<p>Returns the summary information for stacks whose status matches the specified StackStatusFilter. Summary information for stacks that have been deleted is kept for 90 days after the stack is deleted. If no StackStatusFilter is specified, summary information for all stacks is returned (including existing stacks and stacks that have been deleted).</p>"
},
"SetStackPolicy":{
"name":"SetStackPolicy",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"SetStackPolicyInput"},
"documentation":"<p>Sets a stack policy for a specified stack.</p>"
},
"SignalResource":{
"name":"SignalResource",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"SignalResourceInput"},
"documentation":"<p>Sends a signal to the specified resource with a success or failure status. You can use the SignalResource API in conjunction with a creation policy or update policy. AWS CloudFormation doesn't proceed with a stack creation or update until resources receive the required number of signals or the timeout period is exceeded. The SignalResource API is useful in cases where you want to send signals from anywhere other than an Amazon EC2 instance.</p>"
},
"UpdateStack":{
"name":"UpdateStack",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"UpdateStackInput"},
"output":{
"shape":"UpdateStackOutput",
"resultWrapper":"UpdateStackResult"
},
"errors":[
{"shape":"InsufficientCapabilitiesException"}
],
"documentation":"<p>Updates a stack as specified in the template. After the call completes successfully, the stack update starts. You can check the status of the stack via the <a>DescribeStacks</a> action.</p> <p>To get a copy of the template for an existing stack, you can use the <a>GetTemplate</a> action.</p> <p>For more information about creating an update template, updating a stack, and monitoring the progress of the update, see <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks.html\">Updating a Stack</a>.</p>"
},
"ValidateTemplate":{
"name":"ValidateTemplate",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ValidateTemplateInput"},
"output":{
"shape":"ValidateTemplateOutput",
"resultWrapper":"ValidateTemplateResult"
},
"documentation":"<p>Validates a specified template. AWS CloudFormation first checks if the template is valid JSON. If it isn't, AWS CloudFormation checks if the template is valid YAML. If both these checks fail, AWS CloudFormation returns a template validation error.</p>"
}
},
"shapes":{
"AccountLimit":{
"type":"structure",
"members":{
"Name":{
"shape":"LimitName",
"documentation":"<p>The name of the account limit. Currently, the only account limit is <code>StackLimit</code>.</p>"
},
"Value":{
"shape":"LimitValue",
"documentation":"<p>The value that is associated with the account limit name.</p>"
}
},
"documentation":"<p>The AccountLimit data type.</p>"
},
"AccountLimitList":{
"type":"list",
"member":{"shape":"AccountLimit"}
},
"AllowedValue":{"type":"string"},
"AllowedValues":{
"type":"list",
"member":{"shape":"AllowedValue"}
},
"AlreadyExistsException":{
"type":"structure",
"members":{
},
"documentation":"<p>Resource with the name requested already exists.</p>",
"error":{
"code":"AlreadyExistsException",
"httpStatusCode":400,
"senderFault":true
},
"exception":true
},
"CancelUpdateStackInput":{
"type":"structure",
"required":["StackName"],
"members":{
"StackName":{
"shape":"StackName",
"documentation":"<p>The name or the unique stack ID that is associated with the stack.</p>"
}
},
"documentation":"<p>The input for the <a>CancelUpdateStack</a> action.</p>"
},
"Capabilities":{
"type":"list",
"member":{"shape":"Capability"}
},
"CapabilitiesReason":{"type":"string"},
"Capability":{
"type":"string",
"enum":[
"CAPABILITY_IAM",
"CAPABILITY_NAMED_IAM"
]
},
"CausingEntity":{"type":"string"},
"Change":{
"type":"structure",
"members":{
"Type":{
"shape":"ChangeType",
"documentation":"<p>The type of entity that AWS CloudFormation changes. Currently, the only entity type is <code>Resource</code>.</p>"
},
"ResourceChange":{
"shape":"ResourceChange",
"documentation":"<p>A <code>ResourceChange</code> structure that describes the resource and action that AWS CloudFormation will perform.</p>"
}
},
"documentation":"<p>The <code>Change</code> structure describes the changes AWS CloudFormation will perform if you execute the change set.</p>"
},
"ChangeAction":{
"type":"string",
"enum":[
"Add",
"Modify",
"Remove"
]
},
"ChangeSetId":{
"type":"string",
"min":1,
"pattern":"arn:[-a-zA-Z0-9:/]*"
},
"ChangeSetName":{
"type":"string",
"max":128,
"min":1,
"pattern":"[a-zA-Z][-a-zA-Z0-9]*"
},
"ChangeSetNameOrId":{
"type":"string",
"max":1600,
"min":1,
"pattern":"[a-zA-Z][-a-zA-Z0-9]*|arn:[-a-zA-Z0-9:/]*"
},
"ChangeSetNotFoundException":{
"type":"structure",
"members":{
},
"documentation":"<p>The specified change set name or ID doesn't exit. To view valid change sets for a stack, use the <code>ListChangeSets</code> action.</p>",
"error":{
"code":"ChangeSetNotFound",
"httpStatusCode":404,
"senderFault":true
},
"exception":true
},
"ChangeSetStatus":{
"type":"string",
"enum":[
"CREATE_PENDING",
"CREATE_IN_PROGRESS",
"CREATE_COMPLETE",
"DELETE_COMPLETE",
"FAILED"
]
},
"ChangeSetStatusReason":{"type":"string"},
"ChangeSetSummaries":{
"type":"list",
"member":{"shape":"ChangeSetSummary"}
},
"ChangeSetSummary":{
"type":"structure",
"members":{
"StackId":{
"shape":"StackId",
"documentation":"<p>The ID of the stack with which the change set is associated.</p>"
},
"StackName":{
"shape":"StackName",
"documentation":"<p>The name of the stack with which the change set is associated.</p>"
},
"ChangeSetId":{
"shape":"ChangeSetId",
"documentation":"<p>The ID of the change set.</p>"
},
"ChangeSetName":{
"shape":"ChangeSetName",
"documentation":"<p>The name of the change set.</p>"
},
"ExecutionStatus":{
"shape":"ExecutionStatus",
"documentation":"<p>If the change set execution status is <code>AVAILABLE</code>, you can execute the change set. If you can’t execute the change set, the status indicates why. For example, a change set might be in an <code>UNAVAILABLE</code> state because AWS CloudFormation is still creating it or in an <code>OBSOLETE</code> state because the stack was already updated.</p>"
},
"Status":{
"shape":"ChangeSetStatus",
"documentation":"<p>The state of the change set, such as <code>CREATE_IN_PROGRESS</code>, <code>CREATE_COMPLETE</code>, or <code>FAILED</code>.</p>"
},
"StatusReason":{
"shape":"ChangeSetStatusReason",
"documentation":"<p>A description of the change set's status. For example, if your change set is in the <code>FAILED</code> state, AWS CloudFormation shows the error message.</p>"
},
"CreationTime":{
"shape":"CreationTime",
"documentation":"<p>The start time when the change set was created, in UTC.</p>"
},
"Description":{
"shape":"Description",
"documentation":"<p>Descriptive information about the change set.</p>"
}
},
"documentation":"<p>The <code>ChangeSetSummary</code> structure describes a change set, its status, and the stack with which it's associated.</p>"
},
"ChangeSetType":{
"type":"string",
"enum":[
"CREATE",
"UPDATE"
]
},
"ChangeSource":{
"type":"string",
"enum":[
"ResourceReference",
"ParameterReference",
"ResourceAttribute",
"DirectModification",
"Automatic"
]
},
"ChangeType":{
"type":"string",
"enum":["Resource"]
},
"Changes":{
"type":"list",
"member":{"shape":"Change"}
},
"ClientToken":{
"type":"string",
"max":128,
"min":1
},
"ContinueUpdateRollbackInput":{
"type":"structure",
"required":["StackName"],
"members":{
"StackName":{
"shape":"StackNameOrId",
"documentation":"<p>The name or the unique ID of the stack that you want to continue rolling back.</p> <note> <p>Don't specify the name of a nested stack (a stack that was created by using the <code>AWS::CloudFormation::Stack</code> resource). Instead, use this operation on the parent stack (the stack that contains the <code>AWS::CloudFormation::Stack</code> resource).</p> </note>"
},
"RoleARN":{
"shape":"RoleARN",
"documentation":"<p>The Amazon Resource Name (ARN) of an AWS Identity and Access Management (IAM) role that AWS CloudFormation assumes to roll back the stack. AWS CloudFormation uses the role's credentials to make calls on your behalf. AWS CloudFormation always uses this role for all future operations on the stack. As long as users have permission to operate on the stack, AWS CloudFormation uses this role even if the users don't have permission to pass it. Ensure that the role grants least privilege.</p> <p>If you don't specify a value, AWS CloudFormation uses the role that was previously associated with the stack. If no role is available, AWS CloudFormation uses a temporary session that is generated from your user credentials.</p>"
},
"ResourcesToSkip":{
"shape":"ResourcesToSkip",
"documentation":"<p>A list of the logical IDs of the resources that AWS CloudFormation skips during the continue update rollback operation. You can specify only resources that are in the <code>UPDATE_FAILED</code> state because a rollback failed. You can't specify resources that are in the <code>UPDATE_FAILED</code> state for other reasons, for example, because an update was canceled. To check why a resource update failed, use the <a>DescribeStackResources</a> action, and view the resource status reason. </p> <important> <p>Specify this property to skip rolling back resources that AWS CloudFormation can't successfully roll back. We recommend that you <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/troubleshooting.html#troubleshooting-errors-update-rollback-failed\"> troubleshoot</a> resources before skipping them. AWS CloudFormation sets the status of the specified resources to <code>UPDATE_COMPLETE</code> and continues to roll back the stack. After the rollback is complete, the state of the skipped resources will be inconsistent with the state of the resources in the stack template. Before performing another stack update, you must update the stack or resources to be consistent with each other. If you don't, subsequent stack updates might fail, and the stack will become unrecoverable. </p> </important> <p>Specify the minimum number of resources required to successfully roll back your stack. For example, a failed resource update might cause dependent resources to fail. In this case, it might not be necessary to skip the dependent resources. </p> <p>To specify resources in a nested stack, use the following format: <code>NestedStackName.ResourceLogicalID</code>. You can specify a nested stack resource (the logical ID of an <code>AWS::CloudFormation::Stack</code> resource) only if it's in one of the following states: <code>DELETE_IN_PROGRESS</code>, <code>DELETE_COMPLETE</code>, or <code>DELETE_FAILED</code>. </p>"
}
},
"documentation":"<p>The input for the <a>ContinueUpdateRollback</a> action.</p>"
},
"ContinueUpdateRollbackOutput":{
"type":"structure",
"members":{
},
"documentation":"<p>The output for a <a>ContinueUpdateRollback</a> action.</p>"
},
"CreateChangeSetInput":{
"type":"structure",
"required":[
"StackName",
"ChangeSetName"
],
"members":{
"StackName":{
"shape":"StackNameOrId",
"documentation":"<p>The name or the unique ID of the stack for which you are creating a change set. AWS CloudFormation generates the change set by comparing this stack's information with the information that you submit, such as a modified template or different parameter input values.</p>"
},
"TemplateBody":{
"shape":"TemplateBody",
"documentation":"<p>A structure that contains the body of the revised template, with a minimum length of 1 byte and a maximum length of 51,200 bytes. AWS CloudFormation generates the change set by comparing this template with the template of the stack that you specified.</p> <p>Conditional: You must specify only <code>TemplateBody</code> or <code>TemplateURL</code>.</p>"
},
"TemplateURL":{
"shape":"TemplateURL",
"documentation":"<p>The location of the file that contains the revised template. The URL must point to a template (max size: 460,800 bytes) that is located in an S3 bucket. AWS CloudFormation generates the change set by comparing this template with the stack that you specified.</p> <p>Conditional: You must specify only <code>TemplateBody</code> or <code>TemplateURL</code>.</p>"
},
"UsePreviousTemplate":{
"shape":"UsePreviousTemplate",
"documentation":"<p>Whether to reuse the template that is associated with the stack to create the change set.</p>"
},
"Parameters":{
"shape":"Parameters",
"documentation":"<p>A list of <code>Parameter</code> structures that specify input parameters for the change set. For more information, see the <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_Parameter.html\">Parameter</a> data type.</p>"
},
"Capabilities":{
"shape":"Capabilities",
"documentation":"<p>A list of values that you must specify before AWS CloudFormation can update certain stacks. Some stack templates might include resources that can affect permissions in your AWS account, for example, by creating new AWS Identity and Access Management (IAM) users. For those stacks, you must explicitly acknowledge their capabilities by specifying this parameter.</p> <p>The only valid values are <code>CAPABILITY_IAM</code> and <code>CAPABILITY_NAMED_IAM</code>. The following resources require you to specify this parameter: <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-accesskey.html\"> AWS::IAM::AccessKey</a>, <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-group.html\"> AWS::IAM::Group</a>, <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-instanceprofile.html\"> AWS::IAM::InstanceProfile</a>, <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-policy.html\"> AWS::IAM::Policy</a>, <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-role.html\"> AWS::IAM::Role</a>, <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-user.html\"> AWS::IAM::User</a>, and <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-addusertogroup.html\"> AWS::IAM::UserToGroupAddition</a>. If your stack template contains these resources, we recommend that you review all permissions associated with them and edit their permissions if necessary.</p> <p>If you have IAM resources, you can specify either capability. If you have IAM resources with custom names, you must specify <code>CAPABILITY_NAMED_IAM</code>. If you don't specify this parameter, this action returns an <code>InsufficientCapabilities</code> error.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#capabilities\">Acknowledging IAM Resources in AWS CloudFormation Templates</a>.</p>"
},
"ResourceTypes":{
"shape":"ResourceTypes",
"documentation":"<p>The template resource types that you have permissions to work with if you execute this change set, such as <code>AWS::EC2::Instance</code>, <code>AWS::EC2::*</code>, or <code>Custom::MyCustomInstance</code>.</p> <p>If the list of resource types doesn't include a resource type that you're updating, the stack update fails. By default, AWS CloudFormation grants permissions to all resource types. AWS Identity and Access Management (IAM) uses this parameter for condition keys in IAM policies for AWS CloudFormation. For more information, see <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html\">Controlling Access with AWS Identity and Access Management</a> in the AWS CloudFormation User Guide.</p>"
},
"RoleARN":{
"shape":"RoleARN",
"documentation":"<p>The Amazon Resource Name (ARN) of an AWS Identity and Access Management (IAM) role that AWS CloudFormation assumes when executing the change set. AWS CloudFormation uses the role's credentials to make calls on your behalf. AWS CloudFormation uses this role for all future operations on the stack. As long as users have permission to operate on the stack, AWS CloudFormation uses this role even if the users don't have permission to pass it. Ensure that the role grants least privilege.</p> <p>If you don't specify a value, AWS CloudFormation uses the role that was previously associated with the stack. If no role is available, AWS CloudFormation uses a temporary session that is generated from your user credentials.</p>"
},
"NotificationARNs":{
"shape":"NotificationARNs",
"documentation":"<p>The Amazon Resource Names (ARNs) of Amazon Simple Notification Service (Amazon SNS) topics that AWS CloudFormation associates with the stack. To remove all associated notification topics, specify an empty list.</p>"
},
"Tags":{
"shape":"Tags",
"documentation":"<p>Key-value pairs to associate with this stack. AWS CloudFormation also propagates these tags to resources in the stack. You can specify a maximum of 10 tags.</p>"
},
"ChangeSetName":{
"shape":"ChangeSetName",
"documentation":"<p>The name of the change set. The name must be unique among all change sets that are associated with the specified stack.</p> <p>A change set name can contain only alphanumeric, case sensitive characters and hyphens. It must start with an alphabetic character and cannot exceed 128 characters.</p>"
},
"ClientToken":{
"shape":"ClientToken",
"documentation":"<p>A unique identifier for this <code>CreateChangeSet</code> request. Specify this token if you plan to retry requests so that AWS CloudFormation knows that you're not attempting to create another change set with the same name. You might retry <code>CreateChangeSet</code> requests to ensure that AWS CloudFormation successfully received them.</p>"
},
"Description":{
"shape":"Description",
"documentation":"<p>A description to help you identify this change set.</p>"
},
"ChangeSetType":{
"shape":"ChangeSetType",
"documentation":"<p>The type of change set operation. To create a change set for a new stack, specify <code>CREATE</code>. To create a change set for an existing stack, specify <code>UPDATE</code>.</p> <p>If you create a change set for a new stack, AWS Cloudformation creates a stack with a unique stack ID, but no template or resources. The stack will be in the <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-describing-stacks.html#d0e11995\"> <code>REVIEW_IN_PROGRESS</code> </a> state until you execute the change set.</p> <p>By default, AWS CloudFormation specifies <code>UPDATE</code>. You can't use the <code>UPDATE</code> type to create a change set for a new stack or the <code>CREATE</code> type to create a change set for an existing stack.</p>"
}
},
"documentation":"<p>The input for the <a>CreateChangeSet</a> action.</p>"
},
"CreateChangeSetOutput":{
"type":"structure",
"members":{
"Id":{
"shape":"ChangeSetId",
"documentation":"<p>The Amazon Resource Name (ARN) of the change set.</p>"
},
"StackId":{
"shape":"StackId",
"documentation":"<p>The unique ID of the stack.</p>"
}
},
"documentation":"<p>The output for the <a>CreateChangeSet</a> action.</p>"
},
"CreateStackInput":{
"type":"structure",
"required":["StackName"],
"members":{
"StackName":{
"shape":"StackName",
"documentation":"<p>The name that is associated with the stack. The name must be unique in the region in which you are creating the stack.</p> <note> <p>A stack name can contain only alphanumeric characters (case sensitive) and hyphens. It must start with an alphabetic character and cannot be longer than 128 characters.</p> </note>"
},
"TemplateBody":{
"shape":"TemplateBody",
"documentation":"<p>Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes. For more information, go to <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html\">Template Anatomy</a> in the AWS CloudFormation User Guide.</p> <p>Conditional: You must specify either the <code>TemplateBody</code> or the <code>TemplateURL</code> parameter, but not both.</p>"
},
"TemplateURL":{
"shape":"TemplateURL",
"documentation":"<p>Location of file containing the template body. The URL must point to a template (max size: 460,800 bytes) that is located in an Amazon S3 bucket. For more information, go to the <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html\">Template Anatomy</a> in the AWS CloudFormation User Guide.</p> <p>Conditional: You must specify either the <code>TemplateBody</code> or the <code>TemplateURL</code> parameter, but not both.</p>"
},
"Parameters":{
"shape":"Parameters",
"documentation":"<p>A list of <code>Parameter</code> structures that specify input parameters for the stack. For more information, see the <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_Parameter.html\">Parameter</a> data type.</p>"
},
"DisableRollback":{
"shape":"DisableRollback",
"documentation":"<p>Set to <code>true</code> to disable rollback of the stack if stack creation failed. You can specify either <code>DisableRollback</code> or <code>OnFailure</code>, but not both.</p> <p>Default: <code>false</code> </p>"
},
"TimeoutInMinutes":{
"shape":"TimeoutMinutes",
"documentation":"<p>The amount of time that can pass before the stack status becomes CREATE_FAILED; if <code>DisableRollback</code> is not set or is set to <code>false</code>, the stack will be rolled back.</p>"
},
"NotificationARNs":{
"shape":"NotificationARNs",
"documentation":"<p>The Simple Notification Service (SNS) topic ARNs to publish stack related events. You can find your SNS topic ARNs using the <a href=\"https://console.aws.amazon.com/sns\">SNS console</a> or your Command Line Interface (CLI).</p>"
},
"Capabilities":{
"shape":"Capabilities",
"documentation":"<p>A list of values that you must specify before AWS CloudFormation can create certain stacks. Some stack templates might include resources that can affect permissions in your AWS account, for example, by creating new AWS Identity and Access Management (IAM) users. For those stacks, you must explicitly acknowledge their capabilities by specifying this parameter.</p> <p>The only valid values are <code>CAPABILITY_IAM</code> and <code>CAPABILITY_NAMED_IAM</code>. The following resources require you to specify this parameter: <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-accesskey.html\"> AWS::IAM::AccessKey</a>, <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-group.html\"> AWS::IAM::Group</a>, <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-instanceprofile.html\"> AWS::IAM::InstanceProfile</a>, <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-policy.html\"> AWS::IAM::Policy</a>, <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-role.html\"> AWS::IAM::Role</a>, <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-user.html\"> AWS::IAM::User</a>, and <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-addusertogroup.html\"> AWS::IAM::UserToGroupAddition</a>. If your stack template contains these resources, we recommend that you review all permissions associated with them and edit their permissions if necessary.</p> <p>If you have IAM resources, you can specify either capability. If you have IAM resources with custom names, you must specify <code>CAPABILITY_NAMED_IAM</code>. If you don't specify this parameter, this action returns an <code>InsufficientCapabilities</code> error.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#capabilities\">Acknowledging IAM Resources in AWS CloudFormation Templates</a>.</p>"
},
"ResourceTypes":{
"shape":"ResourceTypes",
"documentation":"<p>The template resource types that you have permissions to work with for this create stack action, such as <code>AWS::EC2::Instance</code>, <code>AWS::EC2::*</code>, or <code>Custom::MyCustomInstance</code>. Use the following syntax to describe template resource types: <code>AWS::*</code> (for all AWS resource), <code>Custom::*</code> (for all custom resources), <code>Custom::<i>logical_ID</i> </code> (for a specific custom resource), <code>AWS::<i>service_name</i>::*</code> (for all resources of a particular AWS service), and <code>AWS::<i>service_name</i>::<i>resource_logical_ID</i> </code> (for a specific AWS resource).</p> <p>If the list of resource types doesn't include a resource that you're creating, the stack creation fails. By default, AWS CloudFormation grants permissions to all resource types. AWS Identity and Access Management (IAM) uses this parameter for AWS CloudFormation-specific condition keys in IAM policies. For more information, see <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html\">Controlling Access with AWS Identity and Access Management</a>.</p>"
},
"RoleARN":{
"shape":"RoleARN",
"documentation":"<p>The Amazon Resource Name (ARN) of an AWS Identity and Access Management (IAM) role that AWS CloudFormation assumes to create the stack. AWS CloudFormation uses the role's credentials to make calls on your behalf. AWS CloudFormation always uses this role for all future operations on the stack. As long as users have permission to operate on the stack, AWS CloudFormation uses this role even if the users don't have permission to pass it. Ensure that the role grants least privilege.</p> <p>If you don't specify a value, AWS CloudFormation uses the role that was previously associated with the stack. If no role is available, AWS CloudFormation uses a temporary session that is generated from your user credentials.</p>"
},
"OnFailure":{
"shape":"OnFailure",
"documentation":"<p>Determines what action will be taken if stack creation fails. This must be one of: DO_NOTHING, ROLLBACK, or DELETE. You can specify either <code>OnFailure</code> or <code>DisableRollback</code>, but not both.</p> <p>Default: <code>ROLLBACK</code> </p>"
},
"StackPolicyBody":{
"shape":"StackPolicyBody",
"documentation":"<p>Structure containing the stack policy body. For more information, go to <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/protect-stack-resources.html\"> Prevent Updates to Stack Resources</a> in the <i>AWS CloudFormation User Guide</i>. You can specify either the <code>StackPolicyBody</code> or the <code>StackPolicyURL</code> parameter, but not both.</p>"
},
"StackPolicyURL":{
"shape":"StackPolicyURL",
"documentation":"<p>Location of a file containing the stack policy. The URL must point to a policy (maximum size: 16 KB) located in an S3 bucket in the same region as the stack. You can specify either the <code>StackPolicyBody</code> or the <code>StackPolicyURL</code> parameter, but not both.</p>"
},
"Tags":{
"shape":"Tags",
"documentation":"<p>Key-value pairs to associate with this stack. AWS CloudFormation also propagates these tags to the resources created in the stack. A maximum number of 10 tags can be specified.</p>"
}
},
"documentation":"<p>The input for <a>CreateStack</a> action.</p>"
},
"CreateStackOutput":{
"type":"structure",
"members":{
"StackId":{
"shape":"StackId",
"documentation":"<p>Unique identifier of the stack.</p>"
}
},
"documentation":"<p>The output for a <a>CreateStack</a> action.</p>"
},
"CreationTime":{"type":"timestamp"},
"DeleteChangeSetInput":{
"type":"structure",
"required":["ChangeSetName"],
"members":{
"ChangeSetName":{
"shape":"ChangeSetNameOrId",
"documentation":"<p>The name or Amazon Resource Name (ARN) of the change set that you want to delete.</p>"
},
"StackName":{
"shape":"StackNameOrId",
"documentation":"<p>If you specified the name of a change set to delete, specify the stack name or ID (ARN) that is associated with it.</p>"
}
},
"documentation":"<p>The input for the <a>DeleteChangeSet</a> action.</p>"
},
"DeleteChangeSetOutput":{
"type":"structure",
"members":{
},
"documentation":"<p>The output for the <a>DeleteChangeSet</a> action.</p>"
},
"DeleteStackInput":{
"type":"structure",
"required":["StackName"],
"members":{
"StackName":{
"shape":"StackName",
"documentation":"<p>The name or the unique stack ID that is associated with the stack.</p>"
},
"RetainResources":{
"shape":"RetainResources",
"documentation":"<p>For stacks in the <code>DELETE_FAILED</code> state, a list of resource logical IDs that are associated with the resources you want to retain. During deletion, AWS CloudFormation deletes the stack but does not delete the retained resources.</p> <p>Retaining resources is useful when you cannot delete a resource, such as a non-empty S3 bucket, but you want to delete the stack.</p>"
},
"RoleARN":{
"shape":"RoleARN",
"documentation":"<p>The Amazon Resource Name (ARN) of an AWS Identity and Access Management (IAM) role that AWS CloudFormation assumes to delete the stack. AWS CloudFormation uses the role's credentials to make calls on your behalf.</p> <p>If you don't specify a value, AWS CloudFormation uses the role that was previously associated with the stack. If no role is available, AWS CloudFormation uses a temporary session that is generated from your user credentials.</p>"
}
},
"documentation":"<p>The input for <a>DeleteStack</a> action.</p>"
},
"DeletionTime":{"type":"timestamp"},
"DescribeAccountLimitsInput":{
"type":"structure",
"members":{
"NextToken":{
"shape":"NextToken",
"documentation":"<p>A string that identifies the next page of limits that you want to retrieve.</p>"
}
},
"documentation":"<p>The input for the <a>DescribeAccountLimits</a> action.</p>"
},
"DescribeAccountLimitsOutput":{
"type":"structure",
"members":{
"AccountLimits":{
"shape":"AccountLimitList",
"documentation":"<p>An account limit structure that contain a list of AWS CloudFormation account limits and their values.</p>"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>If the output exceeds 1 MB in size, a string that identifies the next page of limits. If no additional page exists, this value is null.</p>"
}
},
"documentation":"<p>The output for the <a>DescribeAccountLimits</a> action.</p>"
},
"DescribeChangeSetInput":{
"type":"structure",
"required":["ChangeSetName"],
"members":{
"ChangeSetName":{
"shape":"ChangeSetNameOrId",
"documentation":"<p>The name or Amazon Resource Name (ARN) of the change set that you want to describe.</p>"
},
"StackName":{
"shape":"StackNameOrId",
"documentation":"<p>If you specified the name of a change set, specify the stack name or ID (ARN) of the change set you want to describe.</p>"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>A string (provided by the <a>DescribeChangeSet</a> response output) that identifies the next page of information that you want to retrieve.</p>"
}
},
"documentation":"<p>The input for the <a>DescribeChangeSet</a> action.</p>"
},
"DescribeChangeSetOutput":{
"type":"structure",
"members":{
"ChangeSetName":{
"shape":"ChangeSetName",
"documentation":"<p>The name of the change set.</p>"
},
"ChangeSetId":{
"shape":"ChangeSetId",
"documentation":"<p>The ARN of the change set.</p>"
},
"StackId":{
"shape":"StackId",
"documentation":"<p>The ARN of the stack that is associated with the change set.</p>"
},
"StackName":{
"shape":"StackName",
"documentation":"<p>The name of the stack that is associated with the change set.</p>"
},
"Description":{
"shape":"Description",
"documentation":"<p>Information about the change set.</p>"
},
"Parameters":{
"shape":"Parameters",
"documentation":"<p>A list of <code>Parameter</code> structures that describes the input parameters and their values used to create the change set. For more information, see the <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_Parameter.html\">Parameter</a> data type.</p>"
},
"CreationTime":{
"shape":"CreationTime",
"documentation":"<p>The start time when the change set was created, in UTC.</p>"
},
"ExecutionStatus":{
"shape":"ExecutionStatus",
"documentation":"<p>If the change set execution status is <code>AVAILABLE</code>, you can execute the change set. If you can’t execute the change set, the status indicates why. For example, a change set might be in an <code>UNAVAILABLE</code> state because AWS CloudFormation is still creating it or in an <code>OBSOLETE</code> state because the stack was already updated.</p>"
},
"Status":{
"shape":"ChangeSetStatus",
"documentation":"<p>The current status of the change set, such as <code>CREATE_IN_PROGRESS</code>, <code>CREATE_COMPLETE</code>, or <code>FAILED</code>.</p>"
},
"StatusReason":{
"shape":"ChangeSetStatusReason",
"documentation":"<p>A description of the change set's status. For example, if your attempt to create a change set failed, AWS CloudFormation shows the error message.</p>"
},
"NotificationARNs":{
"shape":"NotificationARNs",
"documentation":"<p>The ARNs of the Amazon Simple Notification Service (Amazon SNS) topics that will be associated with the stack if you execute the change set.</p>"
},
"Capabilities":{
"shape":"Capabilities",
"documentation":"<p>If you execute the change set, the list of capabilities that were explicitly acknowledged when the change set was created.</p>"
},
"Tags":{
"shape":"Tags",
"documentation":"<p>If you execute the change set, the tags that will be associated with the stack.</p>"
},
"Changes":{
"shape":"Changes",
"documentation":"<p>A list of <code>Change</code> structures that describes the resources AWS CloudFormation changes if you execute the change set.</p>"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>If the output exceeds 1 MB, a string that identifies the next page of changes. If there is no additional page, this value is null.</p>"
}
},
"documentation":"<p>The output for the <a>DescribeChangeSet</a> action.</p>"
},
"DescribeStackEventsInput":{
"type":"structure",
"members":{
"StackName":{
"shape":"StackName",
"documentation":"<p>The name or the unique stack ID that is associated with the stack, which are not always interchangeable:</p> <ul> <li> <p>Running stacks: You can specify either the stack's name or its unique stack ID.</p> </li> <li> <p>Deleted stacks: You must specify the unique stack ID.</p> </li> </ul> <p>Default: There is no default value.</p>"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>A string that identifies the next page of events that you want to retrieve.</p>"
}
},
"documentation":"<p>The input for <a>DescribeStackEvents</a> action.</p>"
},
"DescribeStackEventsOutput":{
"type":"structure",
"members":{
"StackEvents":{
"shape":"StackEvents",
"documentation":"<p>A list of <code>StackEvents</code> structures.</p>"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>If the output exceeds 1 MB in size, a string that identifies the next page of events. If no additional page exists, this value is null.</p>"
}
},
"documentation":"<p>The output for a <a>DescribeStackEvents</a> action.</p>"
},
"DescribeStackResourceInput":{
"type":"structure",
"required":[
"StackName",
"LogicalResourceId"
],
"members":{
"StackName":{
"shape":"StackName",
"documentation":"<p>The name or the unique stack ID that is associated with the stack, which are not always interchangeable:</p> <ul> <li> <p>Running stacks: You can specify either the stack's name or its unique stack ID.</p> </li> <li> <p>Deleted stacks: You must specify the unique stack ID.</p> </li> </ul> <p>Default: There is no default value.</p>"
},
"LogicalResourceId":{
"shape":"LogicalResourceId",
"documentation":"<p>The logical name of the resource as specified in the template.</p> <p>Default: There is no default value.</p>"
}
},
"documentation":"<p>The input for <a>DescribeStackResource</a> action.</p>"
},
"DescribeStackResourceOutput":{
"type":"structure",
"members":{
"StackResourceDetail":{
"shape":"StackResourceDetail",
"documentation":"<p>A <code>StackResourceDetail</code> structure containing the description of the specified resource in the specified stack.</p>"
}
},
"documentation":"<p>The output for a <a>DescribeStackResource</a> action.</p>"
},
"DescribeStackResourcesInput":{
"type":"structure",
"members":{
"StackName":{
"shape":"StackName",
"documentation":"<p>The name or the unique stack ID that is associated with the stack, which are not always interchangeable:</p> <ul> <li> <p>Running stacks: You can specify either the stack's name or its unique stack ID.</p> </li> <li> <p>Deleted stacks: You must specify the unique stack ID.</p> </li> </ul> <p>Default: There is no default value.</p> <p>Required: Conditional. If you do not specify <code>StackName</code>, you must specify <code>PhysicalResourceId</code>.</p>"
},
"LogicalResourceId":{
"shape":"LogicalResourceId",
"documentation":"<p>The logical name of the resource as specified in the template.</p> <p>Default: There is no default value.</p>"
},
"PhysicalResourceId":{
"shape":"PhysicalResourceId",
"documentation":"<p>The name or unique identifier that corresponds to a physical instance ID of a resource supported by AWS CloudFormation.</p> <p>For example, for an Amazon Elastic Compute Cloud (EC2) instance, <code>PhysicalResourceId</code> corresponds to the <code>InstanceId</code>. You can pass the EC2 <code>InstanceId</code> to <code>DescribeStackResources</code> to find which stack the instance belongs to and what other resources are part of the stack.</p> <p>Required: Conditional. If you do not specify <code>PhysicalResourceId</code>, you must specify <code>StackName</code>.</p> <p>Default: There is no default value.</p>"
}
},
"documentation":"<p>The input for <a>DescribeStackResources</a> action.</p>"
},
"DescribeStackResourcesOutput":{
"type":"structure",
"members":{
"StackResources":{
"shape":"StackResources",
"documentation":"<p>A list of <code>StackResource</code> structures.</p>"
}
},
"documentation":"<p>The output for a <a>DescribeStackResources</a> action.</p>"
},
"DescribeStacksInput":{
"type":"structure",
"members":{
"StackName":{
"shape":"StackName",
"documentation":"<p>The name or the unique stack ID that is associated with the stack, which are not always interchangeable:</p> <ul> <li> <p>Running stacks: You can specify either the stack's name or its unique stack ID.</p> </li> <li> <p>Deleted stacks: You must specify the unique stack ID.</p> </li> </ul> <p>Default: There is no default value.</p>"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>A string that identifies the next page of stacks that you want to retrieve.</p>"
}
},
"documentation":"<p>The input for <a>DescribeStacks</a> action.</p>"
},
"DescribeStacksOutput":{
"type":"structure",
"members":{
"Stacks":{
"shape":"Stacks",
"documentation":"<p>A list of stack structures.</p>"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>If the output exceeds 1 MB in size, a string that identifies the next page of stacks. If no additional page exists, this value is null.</p>"
}
},
"documentation":"<p>The output for a <a>DescribeStacks</a> action.</p>"