/
elasticbeanstalk-2010-12-01.normal.json
4522 lines (4522 loc) · 190 KB
/
elasticbeanstalk-2010-12-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": "2010-12-01",
"endpointPrefix": "elasticbeanstalk",
"protocol": "query",
"serviceAbbreviation": "Elastic Beanstalk",
"serviceFullName": "AWS Elastic Beanstalk",
"serviceId": "Elastic Beanstalk",
"signatureVersion": "v4",
"uid": "elasticbeanstalk-2010-12-01",
"xmlNamespace": "http://elasticbeanstalk.amazonaws.com/docs/2010-12-01/"
},
"operations": {
"AbortEnvironmentUpdate": {
"name": "AbortEnvironmentUpdate",
"http": {
"method": "POST",
"requestUri": "/"
},
"input": {
"shape": "AbortEnvironmentUpdateMessage"
},
"errors": [
{
"shape": "InsufficientPrivilegesException"
}
],
"documentation": "<p>Cancels in-progress environment configuration update or application version deployment.</p>"
},
"ApplyEnvironmentManagedAction": {
"name": "ApplyEnvironmentManagedAction",
"http": {
"method": "POST",
"requestUri": "/"
},
"input": {
"shape": "ApplyEnvironmentManagedActionRequest"
},
"output": {
"shape": "ApplyEnvironmentManagedActionResult",
"resultWrapper": "ApplyEnvironmentManagedActionResult"
},
"errors": [
{
"shape": "ElasticBeanstalkServiceException"
},
{
"shape": "ManagedActionInvalidStateException"
}
],
"documentation": "<p>Applies a scheduled managed action immediately. A managed action can be applied only if its status is <code>Scheduled</code>. Get the status and action ID of a managed action with <a>DescribeEnvironmentManagedActions</a>.</p>"
},
"AssociateEnvironmentOperationsRole": {
"name": "AssociateEnvironmentOperationsRole",
"http": {
"method": "POST",
"requestUri": "/"
},
"input": {
"shape": "AssociateEnvironmentOperationsRoleMessage"
},
"errors": [
{
"shape": "InsufficientPrivilegesException"
}
],
"documentation": "<p>Add or change the operations role used by an environment. After this call is made, Elastic Beanstalk uses the associated operations role for permissions to downstream services during subsequent calls acting on this environment. For more information, see <a href=\"https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/iam-operationsrole.html\">Operations roles</a> in the <i>AWS Elastic Beanstalk Developer Guide</i>.</p>"
},
"CheckDNSAvailability": {
"name": "CheckDNSAvailability",
"http": {
"method": "POST",
"requestUri": "/"
},
"input": {
"shape": "CheckDNSAvailabilityMessage"
},
"output": {
"shape": "CheckDNSAvailabilityResultMessage",
"resultWrapper": "CheckDNSAvailabilityResult"
},
"documentation": "<p>Checks if the specified CNAME is available.</p>"
},
"ComposeEnvironments": {
"name": "ComposeEnvironments",
"http": {
"method": "POST",
"requestUri": "/"
},
"input": {
"shape": "ComposeEnvironmentsMessage"
},
"output": {
"shape": "EnvironmentDescriptionsMessage",
"resultWrapper": "ComposeEnvironmentsResult"
},
"errors": [
{
"shape": "TooManyEnvironmentsException"
},
{
"shape": "InsufficientPrivilegesException"
}
],
"documentation": "<p>Create or update a group of environments that each run a separate component of a single application. Takes a list of version labels that specify application source bundles for each of the environments to create or update. The name of each environment and other required information must be included in the source bundles in an environment manifest named <code>env.yaml</code>. See <a href=\"https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/environment-mgmt-compose.html\">Compose Environments</a> for details.</p>"
},
"CreateApplication": {
"name": "CreateApplication",
"http": {
"method": "POST",
"requestUri": "/"
},
"input": {
"shape": "CreateApplicationMessage"
},
"output": {
"shape": "ApplicationDescriptionMessage",
"resultWrapper": "CreateApplicationResult"
},
"errors": [
{
"shape": "TooManyApplicationsException"
}
],
"documentation": "<p>Creates an application that has one configuration template named <code>default</code> and no application versions.</p>"
},
"CreateApplicationVersion": {
"name": "CreateApplicationVersion",
"http": {
"method": "POST",
"requestUri": "/"
},
"input": {
"shape": "CreateApplicationVersionMessage"
},
"output": {
"shape": "ApplicationVersionDescriptionMessage",
"resultWrapper": "CreateApplicationVersionResult"
},
"errors": [
{
"shape": "TooManyApplicationsException"
},
{
"shape": "TooManyApplicationVersionsException"
},
{
"shape": "InsufficientPrivilegesException"
},
{
"shape": "S3LocationNotInServiceRegionException"
},
{
"shape": "CodeBuildNotInServiceRegionException"
}
],
"documentation": "<p>Creates an application version for the specified application. You can create an application version from a source bundle in Amazon S3, a commit in AWS CodeCommit, or the output of an AWS CodeBuild build as follows:</p> <p>Specify a commit in an AWS CodeCommit repository with <code>SourceBuildInformation</code>.</p> <p>Specify a build in an AWS CodeBuild with <code>SourceBuildInformation</code> and <code>BuildConfiguration</code>.</p> <p>Specify a source bundle in S3 with <code>SourceBundle</code> </p> <p>Omit both <code>SourceBuildInformation</code> and <code>SourceBundle</code> to use the default sample application.</p> <note> <p>After you create an application version with a specified Amazon S3 bucket and key location, you can't change that Amazon S3 location. If you change the Amazon S3 location, you receive an exception when you attempt to launch an environment from the application version.</p> </note>"
},
"CreateConfigurationTemplate": {
"name": "CreateConfigurationTemplate",
"http": {
"method": "POST",
"requestUri": "/"
},
"input": {
"shape": "CreateConfigurationTemplateMessage"
},
"output": {
"shape": "ConfigurationSettingsDescription",
"resultWrapper": "CreateConfigurationTemplateResult"
},
"errors": [
{
"shape": "InsufficientPrivilegesException"
},
{
"shape": "TooManyBucketsException"
},
{
"shape": "TooManyConfigurationTemplatesException"
}
],
"documentation": "<p>Creates an AWS Elastic Beanstalk configuration template, associated with a specific Elastic Beanstalk application. You define application configuration settings in a configuration template. You can then use the configuration template to deploy different versions of the application with the same configuration settings.</p> <p>Templates aren't associated with any environment. The <code>EnvironmentName</code> response element is always <code>null</code>.</p> <p>Related Topics</p> <ul> <li> <p> <a>DescribeConfigurationOptions</a> </p> </li> <li> <p> <a>DescribeConfigurationSettings</a> </p> </li> <li> <p> <a>ListAvailableSolutionStacks</a> </p> </li> </ul>"
},
"CreateEnvironment": {
"name": "CreateEnvironment",
"http": {
"method": "POST",
"requestUri": "/"
},
"input": {
"shape": "CreateEnvironmentMessage"
},
"output": {
"shape": "EnvironmentDescription",
"resultWrapper": "CreateEnvironmentResult"
},
"errors": [
{
"shape": "TooManyEnvironmentsException"
},
{
"shape": "InsufficientPrivilegesException"
}
],
"documentation": "<p>Launches an AWS Elastic Beanstalk environment for the specified application using the specified configuration.</p>"
},
"CreatePlatformVersion": {
"name": "CreatePlatformVersion",
"http": {
"method": "POST",
"requestUri": "/"
},
"input": {
"shape": "CreatePlatformVersionRequest"
},
"output": {
"shape": "CreatePlatformVersionResult",
"resultWrapper": "CreatePlatformVersionResult"
},
"errors": [
{
"shape": "InsufficientPrivilegesException"
},
{
"shape": "ElasticBeanstalkServiceException"
},
{
"shape": "TooManyPlatformsException"
}
],
"documentation": "<p>Create a new version of your custom platform.</p>"
},
"CreateStorageLocation": {
"name": "CreateStorageLocation",
"http": {
"method": "POST",
"requestUri": "/"
},
"output": {
"shape": "CreateStorageLocationResultMessage",
"resultWrapper": "CreateStorageLocationResult"
},
"errors": [
{
"shape": "TooManyBucketsException"
},
{
"shape": "S3SubscriptionRequiredException"
},
{
"shape": "InsufficientPrivilegesException"
}
],
"documentation": "<p>Creates a bucket in Amazon S3 to store application versions, logs, and other files used by Elastic Beanstalk environments. The Elastic Beanstalk console and EB CLI call this API the first time you create an environment in a region. If the storage location already exists, <code>CreateStorageLocation</code> still returns the bucket name but does not create a new bucket.</p>"
},
"DeleteApplication": {
"name": "DeleteApplication",
"http": {
"method": "POST",
"requestUri": "/"
},
"input": {
"shape": "DeleteApplicationMessage"
},
"errors": [
{
"shape": "OperationInProgressException"
}
],
"documentation": "<p>Deletes the specified application along with all associated versions and configurations. The application versions will not be deleted from your Amazon S3 bucket.</p> <note> <p>You cannot delete an application that has a running environment.</p> </note>"
},
"DeleteApplicationVersion": {
"name": "DeleteApplicationVersion",
"http": {
"method": "POST",
"requestUri": "/"
},
"input": {
"shape": "DeleteApplicationVersionMessage"
},
"errors": [
{
"shape": "SourceBundleDeletionException"
},
{
"shape": "InsufficientPrivilegesException"
},
{
"shape": "OperationInProgressException"
},
{
"shape": "S3LocationNotInServiceRegionException"
}
],
"documentation": "<p>Deletes the specified version from the specified application.</p> <note> <p>You cannot delete an application version that is associated with a running environment.</p> </note>"
},
"DeleteConfigurationTemplate": {
"name": "DeleteConfigurationTemplate",
"http": {
"method": "POST",
"requestUri": "/"
},
"input": {
"shape": "DeleteConfigurationTemplateMessage"
},
"errors": [
{
"shape": "OperationInProgressException"
}
],
"documentation": "<p>Deletes the specified configuration template.</p> <note> <p>When you launch an environment using a configuration template, the environment gets a copy of the template. You can delete or modify the environment's copy of the template without affecting the running environment.</p> </note>"
},
"DeleteEnvironmentConfiguration": {
"name": "DeleteEnvironmentConfiguration",
"http": {
"method": "POST",
"requestUri": "/"
},
"input": {
"shape": "DeleteEnvironmentConfigurationMessage"
},
"documentation": "<p>Deletes the draft configuration associated with the running environment.</p> <p>Updating a running environment with any configuration changes creates a draft configuration set. You can get the draft configuration using <a>DescribeConfigurationSettings</a> while the update is in progress or if the update fails. The <code>DeploymentStatus</code> for the draft configuration indicates whether the deployment is in process or has failed. The draft configuration remains in existence until it is deleted with this action.</p>"
},
"DeletePlatformVersion": {
"name": "DeletePlatformVersion",
"http": {
"method": "POST",
"requestUri": "/"
},
"input": {
"shape": "DeletePlatformVersionRequest"
},
"output": {
"shape": "DeletePlatformVersionResult",
"resultWrapper": "DeletePlatformVersionResult"
},
"errors": [
{
"shape": "OperationInProgressException"
},
{
"shape": "InsufficientPrivilegesException"
},
{
"shape": "ElasticBeanstalkServiceException"
},
{
"shape": "PlatformVersionStillReferencedException"
}
],
"documentation": "<p>Deletes the specified version of a custom platform.</p>"
},
"DescribeAccountAttributes": {
"name": "DescribeAccountAttributes",
"http": {
"method": "POST",
"requestUri": "/"
},
"output": {
"shape": "DescribeAccountAttributesResult",
"resultWrapper": "DescribeAccountAttributesResult"
},
"errors": [
{
"shape": "InsufficientPrivilegesException"
}
],
"documentation": "<p>Returns attributes related to AWS Elastic Beanstalk that are associated with the calling AWS account.</p> <p>The result currently has one set of attributes—resource quotas.</p>"
},
"DescribeApplicationVersions": {
"name": "DescribeApplicationVersions",
"http": {
"method": "POST",
"requestUri": "/"
},
"input": {
"shape": "DescribeApplicationVersionsMessage"
},
"output": {
"shape": "ApplicationVersionDescriptionsMessage",
"resultWrapper": "DescribeApplicationVersionsResult"
},
"documentation": "<p>Retrieve a list of application versions.</p>"
},
"DescribeApplications": {
"name": "DescribeApplications",
"http": {
"method": "POST",
"requestUri": "/"
},
"input": {
"shape": "DescribeApplicationsMessage"
},
"output": {
"shape": "ApplicationDescriptionsMessage",
"resultWrapper": "DescribeApplicationsResult"
},
"documentation": "<p>Returns the descriptions of existing applications.</p>"
},
"DescribeConfigurationOptions": {
"name": "DescribeConfigurationOptions",
"http": {
"method": "POST",
"requestUri": "/"
},
"input": {
"shape": "DescribeConfigurationOptionsMessage"
},
"output": {
"shape": "ConfigurationOptionsDescription",
"resultWrapper": "DescribeConfigurationOptionsResult"
},
"errors": [
{
"shape": "TooManyBucketsException"
}
],
"documentation": "<p>Describes the configuration options that are used in a particular configuration template or environment, or that a specified solution stack defines. The description includes the values the options, their default values, and an indication of the required action on a running environment if an option value is changed.</p>"
},
"DescribeConfigurationSettings": {
"name": "DescribeConfigurationSettings",
"http": {
"method": "POST",
"requestUri": "/"
},
"input": {
"shape": "DescribeConfigurationSettingsMessage"
},
"output": {
"shape": "ConfigurationSettingsDescriptions",
"resultWrapper": "DescribeConfigurationSettingsResult"
},
"errors": [
{
"shape": "TooManyBucketsException"
}
],
"documentation": "<p>Returns a description of the settings for the specified configuration set, that is, either a configuration template or the configuration set associated with a running environment.</p> <p>When describing the settings for the configuration set associated with a running environment, it is possible to receive two sets of setting descriptions. One is the deployed configuration set, and the other is a draft configuration of an environment that is either in the process of deployment or that failed to deploy.</p> <p>Related Topics</p> <ul> <li> <p> <a>DeleteEnvironmentConfiguration</a> </p> </li> </ul>"
},
"DescribeEnvironmentHealth": {
"name": "DescribeEnvironmentHealth",
"http": {
"method": "POST",
"requestUri": "/"
},
"input": {
"shape": "DescribeEnvironmentHealthRequest"
},
"output": {
"shape": "DescribeEnvironmentHealthResult",
"resultWrapper": "DescribeEnvironmentHealthResult"
},
"errors": [
{
"shape": "InvalidRequestException"
},
{
"shape": "ElasticBeanstalkServiceException"
}
],
"documentation": "<p>Returns information about the overall health of the specified environment. The <b>DescribeEnvironmentHealth</b> operation is only available with AWS Elastic Beanstalk Enhanced Health.</p>"
},
"DescribeEnvironmentManagedActionHistory": {
"name": "DescribeEnvironmentManagedActionHistory",
"http": {
"method": "POST",
"requestUri": "/"
},
"input": {
"shape": "DescribeEnvironmentManagedActionHistoryRequest"
},
"output": {
"shape": "DescribeEnvironmentManagedActionHistoryResult",
"resultWrapper": "DescribeEnvironmentManagedActionHistoryResult"
},
"errors": [
{
"shape": "ElasticBeanstalkServiceException"
}
],
"documentation": "<p>Lists an environment's completed and failed managed actions.</p>"
},
"DescribeEnvironmentManagedActions": {
"name": "DescribeEnvironmentManagedActions",
"http": {
"method": "POST",
"requestUri": "/"
},
"input": {
"shape": "DescribeEnvironmentManagedActionsRequest"
},
"output": {
"shape": "DescribeEnvironmentManagedActionsResult",
"resultWrapper": "DescribeEnvironmentManagedActionsResult"
},
"errors": [
{
"shape": "ElasticBeanstalkServiceException"
}
],
"documentation": "<p>Lists an environment's upcoming and in-progress managed actions.</p>"
},
"DescribeEnvironmentResources": {
"name": "DescribeEnvironmentResources",
"http": {
"method": "POST",
"requestUri": "/"
},
"input": {
"shape": "DescribeEnvironmentResourcesMessage"
},
"output": {
"shape": "EnvironmentResourceDescriptionsMessage",
"resultWrapper": "DescribeEnvironmentResourcesResult"
},
"errors": [
{
"shape": "InsufficientPrivilegesException"
}
],
"documentation": "<p>Returns AWS resources for this environment.</p>"
},
"DescribeEnvironments": {
"name": "DescribeEnvironments",
"http": {
"method": "POST",
"requestUri": "/"
},
"input": {
"shape": "DescribeEnvironmentsMessage"
},
"output": {
"shape": "EnvironmentDescriptionsMessage",
"resultWrapper": "DescribeEnvironmentsResult"
},
"documentation": "<p>Returns descriptions for existing environments.</p>"
},
"DescribeEvents": {
"name": "DescribeEvents",
"http": {
"method": "POST",
"requestUri": "/"
},
"input": {
"shape": "DescribeEventsMessage"
},
"output": {
"shape": "EventDescriptionsMessage",
"resultWrapper": "DescribeEventsResult"
},
"documentation": "<p>Returns list of event descriptions matching criteria up to the last 6 weeks.</p> <note> <p>This action returns the most recent 1,000 events from the specified <code>NextToken</code>.</p> </note>"
},
"DescribeInstancesHealth": {
"name": "DescribeInstancesHealth",
"http": {
"method": "POST",
"requestUri": "/"
},
"input": {
"shape": "DescribeInstancesHealthRequest"
},
"output": {
"shape": "DescribeInstancesHealthResult",
"resultWrapper": "DescribeInstancesHealthResult"
},
"errors": [
{
"shape": "InvalidRequestException"
},
{
"shape": "ElasticBeanstalkServiceException"
}
],
"documentation": "<p>Retrieves detailed information about the health of instances in your AWS Elastic Beanstalk. This operation requires <a href=\"https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/health-enhanced.html\">enhanced health reporting</a>.</p>"
},
"DescribePlatformVersion": {
"name": "DescribePlatformVersion",
"http": {
"method": "POST",
"requestUri": "/"
},
"input": {
"shape": "DescribePlatformVersionRequest"
},
"output": {
"shape": "DescribePlatformVersionResult",
"resultWrapper": "DescribePlatformVersionResult"
},
"errors": [
{
"shape": "InsufficientPrivilegesException"
},
{
"shape": "ElasticBeanstalkServiceException"
}
],
"documentation": "<p>Describes a platform version. Provides full details. Compare to <a>ListPlatformVersions</a>, which provides summary information about a list of platform versions.</p> <p>For definitions of platform version and other platform-related terms, see <a href=\"https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/platforms-glossary.html\">AWS Elastic Beanstalk Platforms Glossary</a>.</p>"
},
"DisassociateEnvironmentOperationsRole": {
"name": "DisassociateEnvironmentOperationsRole",
"http": {
"method": "POST",
"requestUri": "/"
},
"input": {
"shape": "DisassociateEnvironmentOperationsRoleMessage"
},
"errors": [
{
"shape": "InsufficientPrivilegesException"
}
],
"documentation": "<p>Disassociate the operations role from an environment. After this call is made, Elastic Beanstalk uses the caller's permissions for permissions to downstream services during subsequent calls acting on this environment. For more information, see <a href=\"https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/iam-operationsrole.html\">Operations roles</a> in the <i>AWS Elastic Beanstalk Developer Guide</i>.</p>"
},
"ListAvailableSolutionStacks": {
"name": "ListAvailableSolutionStacks",
"http": {
"method": "POST",
"requestUri": "/"
},
"output": {
"shape": "ListAvailableSolutionStacksResultMessage",
"resultWrapper": "ListAvailableSolutionStacksResult"
},
"documentation": "<p>Returns a list of the available solution stack names, with the public version first and then in reverse chronological order.</p>"
},
"ListPlatformBranches": {
"name": "ListPlatformBranches",
"http": {
"method": "POST",
"requestUri": "/"
},
"input": {
"shape": "ListPlatformBranchesRequest"
},
"output": {
"shape": "ListPlatformBranchesResult",
"resultWrapper": "ListPlatformBranchesResult"
},
"documentation": "<p>Lists the platform branches available for your account in an AWS Region. Provides summary information about each platform branch.</p> <p>For definitions of platform branch and other platform-related terms, see <a href=\"https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/platforms-glossary.html\">AWS Elastic Beanstalk Platforms Glossary</a>.</p>"
},
"ListPlatformVersions": {
"name": "ListPlatformVersions",
"http": {
"method": "POST",
"requestUri": "/"
},
"input": {
"shape": "ListPlatformVersionsRequest"
},
"output": {
"shape": "ListPlatformVersionsResult",
"resultWrapper": "ListPlatformVersionsResult"
},
"errors": [
{
"shape": "InsufficientPrivilegesException"
},
{
"shape": "ElasticBeanstalkServiceException"
}
],
"documentation": "<p>Lists the platform versions available for your account in an AWS Region. Provides summary information about each platform version. Compare to <a>DescribePlatformVersion</a>, which provides full details about a single platform version.</p> <p>For definitions of platform version and other platform-related terms, see <a href=\"https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/platforms-glossary.html\">AWS Elastic Beanstalk Platforms Glossary</a>.</p>"
},
"ListTagsForResource": {
"name": "ListTagsForResource",
"http": {
"method": "POST",
"requestUri": "/"
},
"input": {
"shape": "ListTagsForResourceMessage"
},
"output": {
"shape": "ResourceTagsDescriptionMessage",
"resultWrapper": "ListTagsForResourceResult"
},
"errors": [
{
"shape": "InsufficientPrivilegesException"
},
{
"shape": "ResourceNotFoundException"
},
{
"shape": "ResourceTypeNotSupportedException"
}
],
"documentation": "<p>Return the tags applied to an AWS Elastic Beanstalk resource. The response contains a list of tag key-value pairs.</p> <p>Elastic Beanstalk supports tagging of all of its resources. For details about resource tagging, see <a href=\"https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/applications-tagging-resources.html\">Tagging Application Resources</a>.</p>"
},
"RebuildEnvironment": {
"name": "RebuildEnvironment",
"http": {
"method": "POST",
"requestUri": "/"
},
"input": {
"shape": "RebuildEnvironmentMessage"
},
"errors": [
{
"shape": "InsufficientPrivilegesException"
}
],
"documentation": "<p>Deletes and recreates all of the AWS resources (for example: the Auto Scaling group, load balancer, etc.) for a specified environment and forces a restart.</p>"
},
"RequestEnvironmentInfo": {
"name": "RequestEnvironmentInfo",
"http": {
"method": "POST",
"requestUri": "/"
},
"input": {
"shape": "RequestEnvironmentInfoMessage"
},
"documentation": "<p>Initiates a request to compile the specified type of information of the deployed environment.</p> <p> Setting the <code>InfoType</code> to <code>tail</code> compiles the last lines from the application server log files of every Amazon EC2 instance in your environment. </p> <p> Setting the <code>InfoType</code> to <code>bundle</code> compresses the application server log files for every Amazon EC2 instance into a <code>.zip</code> file. Legacy and .NET containers do not support bundle logs. </p> <p> Use <a>RetrieveEnvironmentInfo</a> to obtain the set of logs. </p> <p>Related Topics</p> <ul> <li> <p> <a>RetrieveEnvironmentInfo</a> </p> </li> </ul>"
},
"RestartAppServer": {
"name": "RestartAppServer",
"http": {
"method": "POST",
"requestUri": "/"
},
"input": {
"shape": "RestartAppServerMessage"
},
"documentation": "<p>Causes the environment to restart the application container server running on each Amazon EC2 instance.</p>"
},
"RetrieveEnvironmentInfo": {
"name": "RetrieveEnvironmentInfo",
"http": {
"method": "POST",
"requestUri": "/"
},
"input": {
"shape": "RetrieveEnvironmentInfoMessage"
},
"output": {
"shape": "RetrieveEnvironmentInfoResultMessage",
"resultWrapper": "RetrieveEnvironmentInfoResult"
},
"documentation": "<p>Retrieves the compiled information from a <a>RequestEnvironmentInfo</a> request.</p> <p>Related Topics</p> <ul> <li> <p> <a>RequestEnvironmentInfo</a> </p> </li> </ul>"
},
"SwapEnvironmentCNAMEs": {
"name": "SwapEnvironmentCNAMEs",
"http": {
"method": "POST",
"requestUri": "/"
},
"input": {
"shape": "SwapEnvironmentCNAMEsMessage"
},
"documentation": "<p>Swaps the CNAMEs of two environments.</p>"
},
"TerminateEnvironment": {
"name": "TerminateEnvironment",
"http": {
"method": "POST",
"requestUri": "/"
},
"input": {
"shape": "TerminateEnvironmentMessage"
},
"output": {
"shape": "EnvironmentDescription",
"resultWrapper": "TerminateEnvironmentResult"
},
"errors": [
{
"shape": "InsufficientPrivilegesException"
}
],
"documentation": "<p>Terminates the specified environment.</p>"
},
"UpdateApplication": {
"name": "UpdateApplication",
"http": {
"method": "POST",
"requestUri": "/"
},
"input": {
"shape": "UpdateApplicationMessage"
},
"output": {
"shape": "ApplicationDescriptionMessage",
"resultWrapper": "UpdateApplicationResult"
},
"documentation": "<p>Updates the specified application to have the specified properties.</p> <note> <p>If a property (for example, <code>description</code>) is not provided, the value remains unchanged. To clear these properties, specify an empty string.</p> </note>"
},
"UpdateApplicationResourceLifecycle": {
"name": "UpdateApplicationResourceLifecycle",
"http": {
"method": "POST",
"requestUri": "/"
},
"input": {
"shape": "UpdateApplicationResourceLifecycleMessage"
},
"output": {
"shape": "ApplicationResourceLifecycleDescriptionMessage",
"resultWrapper": "UpdateApplicationResourceLifecycleResult"
},
"errors": [
{
"shape": "InsufficientPrivilegesException"
}
],
"documentation": "<p>Modifies lifecycle settings for an application.</p>"
},
"UpdateApplicationVersion": {
"name": "UpdateApplicationVersion",
"http": {
"method": "POST",
"requestUri": "/"
},
"input": {
"shape": "UpdateApplicationVersionMessage"
},
"output": {
"shape": "ApplicationVersionDescriptionMessage",
"resultWrapper": "UpdateApplicationVersionResult"
},
"documentation": "<p>Updates the specified application version to have the specified properties.</p> <note> <p>If a property (for example, <code>description</code>) is not provided, the value remains unchanged. To clear properties, specify an empty string.</p> </note>"
},
"UpdateConfigurationTemplate": {
"name": "UpdateConfigurationTemplate",
"http": {
"method": "POST",
"requestUri": "/"
},
"input": {
"shape": "UpdateConfigurationTemplateMessage"
},
"output": {
"shape": "ConfigurationSettingsDescription",
"resultWrapper": "UpdateConfigurationTemplateResult"
},
"errors": [
{
"shape": "InsufficientPrivilegesException"
},
{
"shape": "TooManyBucketsException"
}
],
"documentation": "<p>Updates the specified configuration template to have the specified properties or configuration option values.</p> <note> <p>If a property (for example, <code>ApplicationName</code>) is not provided, its value remains unchanged. To clear such properties, specify an empty string.</p> </note> <p>Related Topics</p> <ul> <li> <p> <a>DescribeConfigurationOptions</a> </p> </li> </ul>"
},
"UpdateEnvironment": {
"name": "UpdateEnvironment",
"http": {
"method": "POST",
"requestUri": "/"
},
"input": {
"shape": "UpdateEnvironmentMessage"
},
"output": {
"shape": "EnvironmentDescription",
"resultWrapper": "UpdateEnvironmentResult"
},
"errors": [
{
"shape": "InsufficientPrivilegesException"
},
{
"shape": "TooManyBucketsException"
}
],
"documentation": "<p>Updates the environment description, deploys a new application version, updates the configuration settings to an entirely new configuration template, or updates select configuration option values in the running environment.</p> <p> Attempting to update both the release and configuration is not allowed and AWS Elastic Beanstalk returns an <code>InvalidParameterCombination</code> error. </p> <p> When updating the configuration settings to a new template or individual settings, a draft configuration is created and <a>DescribeConfigurationSettings</a> for this environment returns two setting descriptions with different <code>DeploymentStatus</code> values. </p>"
},
"UpdateTagsForResource": {
"name": "UpdateTagsForResource",
"http": {
"method": "POST",
"requestUri": "/"
},
"input": {
"shape": "UpdateTagsForResourceMessage"
},
"errors": [
{
"shape": "InsufficientPrivilegesException"
},
{
"shape": "OperationInProgressException"
},
{
"shape": "TooManyTagsException"
},
{
"shape": "ResourceNotFoundException"
},
{
"shape": "ResourceTypeNotSupportedException"
}
],
"documentation": "<p>Update the list of tags applied to an AWS Elastic Beanstalk resource. Two lists can be passed: <code>TagsToAdd</code> for tags to add or update, and <code>TagsToRemove</code>.</p> <p>Elastic Beanstalk supports tagging of all of its resources. For details about resource tagging, see <a href=\"https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/applications-tagging-resources.html\">Tagging Application Resources</a>.</p> <p>If you create a custom IAM user policy to control permission to this operation, specify one of the following two virtual actions (or both) instead of the API operation name:</p> <dl> <dt>elasticbeanstalk:AddTags</dt> <dd> <p>Controls permission to call <code>UpdateTagsForResource</code> and pass a list of tags to add in the <code>TagsToAdd</code> parameter.</p> </dd> <dt>elasticbeanstalk:RemoveTags</dt> <dd> <p>Controls permission to call <code>UpdateTagsForResource</code> and pass a list of tag keys to remove in the <code>TagsToRemove</code> parameter.</p> </dd> </dl> <p>For details about creating a custom user policy, see <a href=\"https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/AWSHowTo.iam.managed-policies.html#AWSHowTo.iam.policies\">Creating a Custom User Policy</a>.</p>"
},
"ValidateConfigurationSettings": {
"name": "ValidateConfigurationSettings",
"http": {
"method": "POST",
"requestUri": "/"
},
"input": {
"shape": "ValidateConfigurationSettingsMessage"
},
"output": {
"shape": "ConfigurationSettingsValidationMessages",
"resultWrapper": "ValidateConfigurationSettingsResult"
},
"errors": [
{
"shape": "InsufficientPrivilegesException"
},
{
"shape": "TooManyBucketsException"
}
],
"documentation": "<p>Takes a set of configuration settings and either a configuration template or environment, and determines whether those values are valid.</p> <p>This action returns a list of messages indicating any errors or warnings associated with the selection of option values.</p>"
}
},
"shapes": {
"ARN": {
"type": "string"
},
"AbortEnvironmentUpdateMessage": {
"type": "structure",
"members": {
"EnvironmentId": {
"shape": "EnvironmentId",
"documentation": "<p>This specifies the ID of the environment with the in-progress update that you want to cancel.</p>"
},
"EnvironmentName": {
"shape": "EnvironmentName",
"documentation": "<p>This specifies the name of the environment with the in-progress update that you want to cancel.</p>"
}
},
"documentation": "<p/>"
},
"AbortableOperationInProgress": {
"type": "boolean"
},
"ActionHistoryStatus": {
"type": "string",
"enum": [
"Completed",
"Failed",
"Unknown"
]
},
"ActionStatus": {
"type": "string",
"enum": [
"Scheduled",
"Pending",
"Running",
"Unknown"
]
},
"ActionType": {
"type": "string",
"enum": [
"InstanceRefresh",
"PlatformUpdate",
"Unknown"
]
},
"ApplicationArn": {
"type": "string"
},
"ApplicationDescription": {
"type": "structure",
"members": {
"ApplicationArn": {
"shape": "ApplicationArn",
"documentation": "<p>The Amazon Resource Name (ARN) of the application.</p>"
},
"ApplicationName": {
"shape": "ApplicationName",
"documentation": "<p>The name of the application.</p>"
},
"Description": {
"shape": "Description",
"documentation": "<p>User-defined description of the application.</p>"
},
"DateCreated": {
"shape": "CreationDate",
"documentation": "<p>The date when the application was created.</p>"
},
"DateUpdated": {
"shape": "UpdateDate",
"documentation": "<p>The date when the application was last modified.</p>"
},
"Versions": {
"shape": "VersionLabelsList",
"documentation": "<p>The names of the versions for this application.</p>"
},