elasticbeanstalk.d.ts
139 KB
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
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
import {Request} from '../lib/request';
import {Response} from '../lib/response';
import {AWSError} from '../lib/error';
import {Service} from '../lib/service';
import {WaiterConfiguration} from '../lib/service';
import {ServiceConfigurationOptions} from '../lib/service';
import {ConfigBase as Config} from '../lib/config-base';
interface Blob {}
declare class ElasticBeanstalk extends Service {
/**
* Constructs a service object. This object has one method for each API operation.
*/
constructor(options?: ElasticBeanstalk.Types.ClientConfiguration)
config: Config & ElasticBeanstalk.Types.ClientConfiguration;
/**
* Cancels in-progress environment configuration update or application version deployment.
*/
abortEnvironmentUpdate(params: ElasticBeanstalk.Types.AbortEnvironmentUpdateMessage, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Cancels in-progress environment configuration update or application version deployment.
*/
abortEnvironmentUpdate(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Applies a scheduled managed action immediately. A managed action can be applied only if its status is Scheduled. Get the status and action ID of a managed action with DescribeEnvironmentManagedActions.
*/
applyEnvironmentManagedAction(params: ElasticBeanstalk.Types.ApplyEnvironmentManagedActionRequest, callback?: (err: AWSError, data: ElasticBeanstalk.Types.ApplyEnvironmentManagedActionResult) => void): Request<ElasticBeanstalk.Types.ApplyEnvironmentManagedActionResult, AWSError>;
/**
* Applies a scheduled managed action immediately. A managed action can be applied only if its status is Scheduled. Get the status and action ID of a managed action with DescribeEnvironmentManagedActions.
*/
applyEnvironmentManagedAction(callback?: (err: AWSError, data: ElasticBeanstalk.Types.ApplyEnvironmentManagedActionResult) => void): Request<ElasticBeanstalk.Types.ApplyEnvironmentManagedActionResult, AWSError>;
/**
* 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 Operations roles in the AWS Elastic Beanstalk Developer Guide.
*/
associateEnvironmentOperationsRole(params: ElasticBeanstalk.Types.AssociateEnvironmentOperationsRoleMessage, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* 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 Operations roles in the AWS Elastic Beanstalk Developer Guide.
*/
associateEnvironmentOperationsRole(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Checks if the specified CNAME is available.
*/
checkDNSAvailability(params: ElasticBeanstalk.Types.CheckDNSAvailabilityMessage, callback?: (err: AWSError, data: ElasticBeanstalk.Types.CheckDNSAvailabilityResultMessage) => void): Request<ElasticBeanstalk.Types.CheckDNSAvailabilityResultMessage, AWSError>;
/**
* Checks if the specified CNAME is available.
*/
checkDNSAvailability(callback?: (err: AWSError, data: ElasticBeanstalk.Types.CheckDNSAvailabilityResultMessage) => void): Request<ElasticBeanstalk.Types.CheckDNSAvailabilityResultMessage, AWSError>;
/**
* 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 env.yaml. See Compose Environments for details.
*/
composeEnvironments(params: ElasticBeanstalk.Types.ComposeEnvironmentsMessage, callback?: (err: AWSError, data: ElasticBeanstalk.Types.EnvironmentDescriptionsMessage) => void): Request<ElasticBeanstalk.Types.EnvironmentDescriptionsMessage, AWSError>;
/**
* 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 env.yaml. See Compose Environments for details.
*/
composeEnvironments(callback?: (err: AWSError, data: ElasticBeanstalk.Types.EnvironmentDescriptionsMessage) => void): Request<ElasticBeanstalk.Types.EnvironmentDescriptionsMessage, AWSError>;
/**
* Creates an application that has one configuration template named default and no application versions.
*/
createApplication(params: ElasticBeanstalk.Types.CreateApplicationMessage, callback?: (err: AWSError, data: ElasticBeanstalk.Types.ApplicationDescriptionMessage) => void): Request<ElasticBeanstalk.Types.ApplicationDescriptionMessage, AWSError>;
/**
* Creates an application that has one configuration template named default and no application versions.
*/
createApplication(callback?: (err: AWSError, data: ElasticBeanstalk.Types.ApplicationDescriptionMessage) => void): Request<ElasticBeanstalk.Types.ApplicationDescriptionMessage, AWSError>;
/**
* 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: Specify a commit in an AWS CodeCommit repository with SourceBuildInformation. Specify a build in an AWS CodeBuild with SourceBuildInformation and BuildConfiguration. Specify a source bundle in S3 with SourceBundle Omit both SourceBuildInformation and SourceBundle to use the default sample application. 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.
*/
createApplicationVersion(params: ElasticBeanstalk.Types.CreateApplicationVersionMessage, callback?: (err: AWSError, data: ElasticBeanstalk.Types.ApplicationVersionDescriptionMessage) => void): Request<ElasticBeanstalk.Types.ApplicationVersionDescriptionMessage, AWSError>;
/**
* 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: Specify a commit in an AWS CodeCommit repository with SourceBuildInformation. Specify a build in an AWS CodeBuild with SourceBuildInformation and BuildConfiguration. Specify a source bundle in S3 with SourceBundle Omit both SourceBuildInformation and SourceBundle to use the default sample application. 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.
*/
createApplicationVersion(callback?: (err: AWSError, data: ElasticBeanstalk.Types.ApplicationVersionDescriptionMessage) => void): Request<ElasticBeanstalk.Types.ApplicationVersionDescriptionMessage, AWSError>;
/**
* 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. Templates aren't associated with any environment. The EnvironmentName response element is always null. Related Topics DescribeConfigurationOptions DescribeConfigurationSettings ListAvailableSolutionStacks
*/
createConfigurationTemplate(params: ElasticBeanstalk.Types.CreateConfigurationTemplateMessage, callback?: (err: AWSError, data: ElasticBeanstalk.Types.ConfigurationSettingsDescription) => void): Request<ElasticBeanstalk.Types.ConfigurationSettingsDescription, AWSError>;
/**
* 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. Templates aren't associated with any environment. The EnvironmentName response element is always null. Related Topics DescribeConfigurationOptions DescribeConfigurationSettings ListAvailableSolutionStacks
*/
createConfigurationTemplate(callback?: (err: AWSError, data: ElasticBeanstalk.Types.ConfigurationSettingsDescription) => void): Request<ElasticBeanstalk.Types.ConfigurationSettingsDescription, AWSError>;
/**
* Launches an AWS Elastic Beanstalk environment for the specified application using the specified configuration.
*/
createEnvironment(params: ElasticBeanstalk.Types.CreateEnvironmentMessage, callback?: (err: AWSError, data: ElasticBeanstalk.Types.EnvironmentDescription) => void): Request<ElasticBeanstalk.Types.EnvironmentDescription, AWSError>;
/**
* Launches an AWS Elastic Beanstalk environment for the specified application using the specified configuration.
*/
createEnvironment(callback?: (err: AWSError, data: ElasticBeanstalk.Types.EnvironmentDescription) => void): Request<ElasticBeanstalk.Types.EnvironmentDescription, AWSError>;
/**
* Create a new version of your custom platform.
*/
createPlatformVersion(params: ElasticBeanstalk.Types.CreatePlatformVersionRequest, callback?: (err: AWSError, data: ElasticBeanstalk.Types.CreatePlatformVersionResult) => void): Request<ElasticBeanstalk.Types.CreatePlatformVersionResult, AWSError>;
/**
* Create a new version of your custom platform.
*/
createPlatformVersion(callback?: (err: AWSError, data: ElasticBeanstalk.Types.CreatePlatformVersionResult) => void): Request<ElasticBeanstalk.Types.CreatePlatformVersionResult, AWSError>;
/**
* 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, CreateStorageLocation still returns the bucket name but does not create a new bucket.
*/
createStorageLocation(callback?: (err: AWSError, data: ElasticBeanstalk.Types.CreateStorageLocationResultMessage) => void): Request<ElasticBeanstalk.Types.CreateStorageLocationResultMessage, AWSError>;
/**
* Deletes the specified application along with all associated versions and configurations. The application versions will not be deleted from your Amazon S3 bucket. You cannot delete an application that has a running environment.
*/
deleteApplication(params: ElasticBeanstalk.Types.DeleteApplicationMessage, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Deletes the specified application along with all associated versions and configurations. The application versions will not be deleted from your Amazon S3 bucket. You cannot delete an application that has a running environment.
*/
deleteApplication(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Deletes the specified version from the specified application. You cannot delete an application version that is associated with a running environment.
*/
deleteApplicationVersion(params: ElasticBeanstalk.Types.DeleteApplicationVersionMessage, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Deletes the specified version from the specified application. You cannot delete an application version that is associated with a running environment.
*/
deleteApplicationVersion(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Deletes the specified configuration template. 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.
*/
deleteConfigurationTemplate(params: ElasticBeanstalk.Types.DeleteConfigurationTemplateMessage, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Deletes the specified configuration template. 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.
*/
deleteConfigurationTemplate(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Deletes the draft configuration associated with the running environment. Updating a running environment with any configuration changes creates a draft configuration set. You can get the draft configuration using DescribeConfigurationSettings while the update is in progress or if the update fails. The DeploymentStatus 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.
*/
deleteEnvironmentConfiguration(params: ElasticBeanstalk.Types.DeleteEnvironmentConfigurationMessage, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Deletes the draft configuration associated with the running environment. Updating a running environment with any configuration changes creates a draft configuration set. You can get the draft configuration using DescribeConfigurationSettings while the update is in progress or if the update fails. The DeploymentStatus 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.
*/
deleteEnvironmentConfiguration(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Deletes the specified version of a custom platform.
*/
deletePlatformVersion(params: ElasticBeanstalk.Types.DeletePlatformVersionRequest, callback?: (err: AWSError, data: ElasticBeanstalk.Types.DeletePlatformVersionResult) => void): Request<ElasticBeanstalk.Types.DeletePlatformVersionResult, AWSError>;
/**
* Deletes the specified version of a custom platform.
*/
deletePlatformVersion(callback?: (err: AWSError, data: ElasticBeanstalk.Types.DeletePlatformVersionResult) => void): Request<ElasticBeanstalk.Types.DeletePlatformVersionResult, AWSError>;
/**
* Returns attributes related to AWS Elastic Beanstalk that are associated with the calling AWS account. The result currently has one set of attributes—resource quotas.
*/
describeAccountAttributes(callback?: (err: AWSError, data: ElasticBeanstalk.Types.DescribeAccountAttributesResult) => void): Request<ElasticBeanstalk.Types.DescribeAccountAttributesResult, AWSError>;
/**
* Retrieve a list of application versions.
*/
describeApplicationVersions(params: ElasticBeanstalk.Types.DescribeApplicationVersionsMessage, callback?: (err: AWSError, data: ElasticBeanstalk.Types.ApplicationVersionDescriptionsMessage) => void): Request<ElasticBeanstalk.Types.ApplicationVersionDescriptionsMessage, AWSError>;
/**
* Retrieve a list of application versions.
*/
describeApplicationVersions(callback?: (err: AWSError, data: ElasticBeanstalk.Types.ApplicationVersionDescriptionsMessage) => void): Request<ElasticBeanstalk.Types.ApplicationVersionDescriptionsMessage, AWSError>;
/**
* Returns the descriptions of existing applications.
*/
describeApplications(params: ElasticBeanstalk.Types.DescribeApplicationsMessage, callback?: (err: AWSError, data: ElasticBeanstalk.Types.ApplicationDescriptionsMessage) => void): Request<ElasticBeanstalk.Types.ApplicationDescriptionsMessage, AWSError>;
/**
* Returns the descriptions of existing applications.
*/
describeApplications(callback?: (err: AWSError, data: ElasticBeanstalk.Types.ApplicationDescriptionsMessage) => void): Request<ElasticBeanstalk.Types.ApplicationDescriptionsMessage, AWSError>;
/**
* 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.
*/
describeConfigurationOptions(params: ElasticBeanstalk.Types.DescribeConfigurationOptionsMessage, callback?: (err: AWSError, data: ElasticBeanstalk.Types.ConfigurationOptionsDescription) => void): Request<ElasticBeanstalk.Types.ConfigurationOptionsDescription, AWSError>;
/**
* 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.
*/
describeConfigurationOptions(callback?: (err: AWSError, data: ElasticBeanstalk.Types.ConfigurationOptionsDescription) => void): Request<ElasticBeanstalk.Types.ConfigurationOptionsDescription, AWSError>;
/**
* 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. 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. Related Topics DeleteEnvironmentConfiguration
*/
describeConfigurationSettings(params: ElasticBeanstalk.Types.DescribeConfigurationSettingsMessage, callback?: (err: AWSError, data: ElasticBeanstalk.Types.ConfigurationSettingsDescriptions) => void): Request<ElasticBeanstalk.Types.ConfigurationSettingsDescriptions, AWSError>;
/**
* 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. 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. Related Topics DeleteEnvironmentConfiguration
*/
describeConfigurationSettings(callback?: (err: AWSError, data: ElasticBeanstalk.Types.ConfigurationSettingsDescriptions) => void): Request<ElasticBeanstalk.Types.ConfigurationSettingsDescriptions, AWSError>;
/**
* Returns information about the overall health of the specified environment. The DescribeEnvironmentHealth operation is only available with AWS Elastic Beanstalk Enhanced Health.
*/
describeEnvironmentHealth(params: ElasticBeanstalk.Types.DescribeEnvironmentHealthRequest, callback?: (err: AWSError, data: ElasticBeanstalk.Types.DescribeEnvironmentHealthResult) => void): Request<ElasticBeanstalk.Types.DescribeEnvironmentHealthResult, AWSError>;
/**
* Returns information about the overall health of the specified environment. The DescribeEnvironmentHealth operation is only available with AWS Elastic Beanstalk Enhanced Health.
*/
describeEnvironmentHealth(callback?: (err: AWSError, data: ElasticBeanstalk.Types.DescribeEnvironmentHealthResult) => void): Request<ElasticBeanstalk.Types.DescribeEnvironmentHealthResult, AWSError>;
/**
* Lists an environment's completed and failed managed actions.
*/
describeEnvironmentManagedActionHistory(params: ElasticBeanstalk.Types.DescribeEnvironmentManagedActionHistoryRequest, callback?: (err: AWSError, data: ElasticBeanstalk.Types.DescribeEnvironmentManagedActionHistoryResult) => void): Request<ElasticBeanstalk.Types.DescribeEnvironmentManagedActionHistoryResult, AWSError>;
/**
* Lists an environment's completed and failed managed actions.
*/
describeEnvironmentManagedActionHistory(callback?: (err: AWSError, data: ElasticBeanstalk.Types.DescribeEnvironmentManagedActionHistoryResult) => void): Request<ElasticBeanstalk.Types.DescribeEnvironmentManagedActionHistoryResult, AWSError>;
/**
* Lists an environment's upcoming and in-progress managed actions.
*/
describeEnvironmentManagedActions(params: ElasticBeanstalk.Types.DescribeEnvironmentManagedActionsRequest, callback?: (err: AWSError, data: ElasticBeanstalk.Types.DescribeEnvironmentManagedActionsResult) => void): Request<ElasticBeanstalk.Types.DescribeEnvironmentManagedActionsResult, AWSError>;
/**
* Lists an environment's upcoming and in-progress managed actions.
*/
describeEnvironmentManagedActions(callback?: (err: AWSError, data: ElasticBeanstalk.Types.DescribeEnvironmentManagedActionsResult) => void): Request<ElasticBeanstalk.Types.DescribeEnvironmentManagedActionsResult, AWSError>;
/**
* Returns AWS resources for this environment.
*/
describeEnvironmentResources(params: ElasticBeanstalk.Types.DescribeEnvironmentResourcesMessage, callback?: (err: AWSError, data: ElasticBeanstalk.Types.EnvironmentResourceDescriptionsMessage) => void): Request<ElasticBeanstalk.Types.EnvironmentResourceDescriptionsMessage, AWSError>;
/**
* Returns AWS resources for this environment.
*/
describeEnvironmentResources(callback?: (err: AWSError, data: ElasticBeanstalk.Types.EnvironmentResourceDescriptionsMessage) => void): Request<ElasticBeanstalk.Types.EnvironmentResourceDescriptionsMessage, AWSError>;
/**
* Returns descriptions for existing environments.
*/
describeEnvironments(params: ElasticBeanstalk.Types.DescribeEnvironmentsMessage, callback?: (err: AWSError, data: ElasticBeanstalk.Types.EnvironmentDescriptionsMessage) => void): Request<ElasticBeanstalk.Types.EnvironmentDescriptionsMessage, AWSError>;
/**
* Returns descriptions for existing environments.
*/
describeEnvironments(callback?: (err: AWSError, data: ElasticBeanstalk.Types.EnvironmentDescriptionsMessage) => void): Request<ElasticBeanstalk.Types.EnvironmentDescriptionsMessage, AWSError>;
/**
* Returns list of event descriptions matching criteria up to the last 6 weeks. This action returns the most recent 1,000 events from the specified NextToken.
*/
describeEvents(params: ElasticBeanstalk.Types.DescribeEventsMessage, callback?: (err: AWSError, data: ElasticBeanstalk.Types.EventDescriptionsMessage) => void): Request<ElasticBeanstalk.Types.EventDescriptionsMessage, AWSError>;
/**
* Returns list of event descriptions matching criteria up to the last 6 weeks. This action returns the most recent 1,000 events from the specified NextToken.
*/
describeEvents(callback?: (err: AWSError, data: ElasticBeanstalk.Types.EventDescriptionsMessage) => void): Request<ElasticBeanstalk.Types.EventDescriptionsMessage, AWSError>;
/**
* Retrieves detailed information about the health of instances in your AWS Elastic Beanstalk. This operation requires enhanced health reporting.
*/
describeInstancesHealth(params: ElasticBeanstalk.Types.DescribeInstancesHealthRequest, callback?: (err: AWSError, data: ElasticBeanstalk.Types.DescribeInstancesHealthResult) => void): Request<ElasticBeanstalk.Types.DescribeInstancesHealthResult, AWSError>;
/**
* Retrieves detailed information about the health of instances in your AWS Elastic Beanstalk. This operation requires enhanced health reporting.
*/
describeInstancesHealth(callback?: (err: AWSError, data: ElasticBeanstalk.Types.DescribeInstancesHealthResult) => void): Request<ElasticBeanstalk.Types.DescribeInstancesHealthResult, AWSError>;
/**
* Describes a platform version. Provides full details. Compare to ListPlatformVersions, which provides summary information about a list of platform versions. For definitions of platform version and other platform-related terms, see AWS Elastic Beanstalk Platforms Glossary.
*/
describePlatformVersion(params: ElasticBeanstalk.Types.DescribePlatformVersionRequest, callback?: (err: AWSError, data: ElasticBeanstalk.Types.DescribePlatformVersionResult) => void): Request<ElasticBeanstalk.Types.DescribePlatformVersionResult, AWSError>;
/**
* Describes a platform version. Provides full details. Compare to ListPlatformVersions, which provides summary information about a list of platform versions. For definitions of platform version and other platform-related terms, see AWS Elastic Beanstalk Platforms Glossary.
*/
describePlatformVersion(callback?: (err: AWSError, data: ElasticBeanstalk.Types.DescribePlatformVersionResult) => void): Request<ElasticBeanstalk.Types.DescribePlatformVersionResult, AWSError>;
/**
* 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 Operations roles in the AWS Elastic Beanstalk Developer Guide.
*/
disassociateEnvironmentOperationsRole(params: ElasticBeanstalk.Types.DisassociateEnvironmentOperationsRoleMessage, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* 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 Operations roles in the AWS Elastic Beanstalk Developer Guide.
*/
disassociateEnvironmentOperationsRole(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Returns a list of the available solution stack names, with the public version first and then in reverse chronological order.
*/
listAvailableSolutionStacks(callback?: (err: AWSError, data: ElasticBeanstalk.Types.ListAvailableSolutionStacksResultMessage) => void): Request<ElasticBeanstalk.Types.ListAvailableSolutionStacksResultMessage, AWSError>;
/**
* Lists the platform branches available for your account in an AWS Region. Provides summary information about each platform branch. For definitions of platform branch and other platform-related terms, see AWS Elastic Beanstalk Platforms Glossary.
*/
listPlatformBranches(params: ElasticBeanstalk.Types.ListPlatformBranchesRequest, callback?: (err: AWSError, data: ElasticBeanstalk.Types.ListPlatformBranchesResult) => void): Request<ElasticBeanstalk.Types.ListPlatformBranchesResult, AWSError>;
/**
* Lists the platform branches available for your account in an AWS Region. Provides summary information about each platform branch. For definitions of platform branch and other platform-related terms, see AWS Elastic Beanstalk Platforms Glossary.
*/
listPlatformBranches(callback?: (err: AWSError, data: ElasticBeanstalk.Types.ListPlatformBranchesResult) => void): Request<ElasticBeanstalk.Types.ListPlatformBranchesResult, AWSError>;
/**
* Lists the platform versions available for your account in an AWS Region. Provides summary information about each platform version. Compare to DescribePlatformVersion, which provides full details about a single platform version. For definitions of platform version and other platform-related terms, see AWS Elastic Beanstalk Platforms Glossary.
*/
listPlatformVersions(params: ElasticBeanstalk.Types.ListPlatformVersionsRequest, callback?: (err: AWSError, data: ElasticBeanstalk.Types.ListPlatformVersionsResult) => void): Request<ElasticBeanstalk.Types.ListPlatformVersionsResult, AWSError>;
/**
* Lists the platform versions available for your account in an AWS Region. Provides summary information about each platform version. Compare to DescribePlatformVersion, which provides full details about a single platform version. For definitions of platform version and other platform-related terms, see AWS Elastic Beanstalk Platforms Glossary.
*/
listPlatformVersions(callback?: (err: AWSError, data: ElasticBeanstalk.Types.ListPlatformVersionsResult) => void): Request<ElasticBeanstalk.Types.ListPlatformVersionsResult, AWSError>;
/**
* Return the tags applied to an AWS Elastic Beanstalk resource. The response contains a list of tag key-value pairs. Elastic Beanstalk supports tagging of all of its resources. For details about resource tagging, see Tagging Application Resources.
*/
listTagsForResource(params: ElasticBeanstalk.Types.ListTagsForResourceMessage, callback?: (err: AWSError, data: ElasticBeanstalk.Types.ResourceTagsDescriptionMessage) => void): Request<ElasticBeanstalk.Types.ResourceTagsDescriptionMessage, AWSError>;
/**
* Return the tags applied to an AWS Elastic Beanstalk resource. The response contains a list of tag key-value pairs. Elastic Beanstalk supports tagging of all of its resources. For details about resource tagging, see Tagging Application Resources.
*/
listTagsForResource(callback?: (err: AWSError, data: ElasticBeanstalk.Types.ResourceTagsDescriptionMessage) => void): Request<ElasticBeanstalk.Types.ResourceTagsDescriptionMessage, AWSError>;
/**
* 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.
*/
rebuildEnvironment(params: ElasticBeanstalk.Types.RebuildEnvironmentMessage, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* 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.
*/
rebuildEnvironment(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Initiates a request to compile the specified type of information of the deployed environment. Setting the InfoType to tail compiles the last lines from the application server log files of every Amazon EC2 instance in your environment. Setting the InfoType to bundle compresses the application server log files for every Amazon EC2 instance into a .zip file. Legacy and .NET containers do not support bundle logs. Use RetrieveEnvironmentInfo to obtain the set of logs. Related Topics RetrieveEnvironmentInfo
*/
requestEnvironmentInfo(params: ElasticBeanstalk.Types.RequestEnvironmentInfoMessage, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Initiates a request to compile the specified type of information of the deployed environment. Setting the InfoType to tail compiles the last lines from the application server log files of every Amazon EC2 instance in your environment. Setting the InfoType to bundle compresses the application server log files for every Amazon EC2 instance into a .zip file. Legacy and .NET containers do not support bundle logs. Use RetrieveEnvironmentInfo to obtain the set of logs. Related Topics RetrieveEnvironmentInfo
*/
requestEnvironmentInfo(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Causes the environment to restart the application container server running on each Amazon EC2 instance.
*/
restartAppServer(params: ElasticBeanstalk.Types.RestartAppServerMessage, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Causes the environment to restart the application container server running on each Amazon EC2 instance.
*/
restartAppServer(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Retrieves the compiled information from a RequestEnvironmentInfo request. Related Topics RequestEnvironmentInfo
*/
retrieveEnvironmentInfo(params: ElasticBeanstalk.Types.RetrieveEnvironmentInfoMessage, callback?: (err: AWSError, data: ElasticBeanstalk.Types.RetrieveEnvironmentInfoResultMessage) => void): Request<ElasticBeanstalk.Types.RetrieveEnvironmentInfoResultMessage, AWSError>;
/**
* Retrieves the compiled information from a RequestEnvironmentInfo request. Related Topics RequestEnvironmentInfo
*/
retrieveEnvironmentInfo(callback?: (err: AWSError, data: ElasticBeanstalk.Types.RetrieveEnvironmentInfoResultMessage) => void): Request<ElasticBeanstalk.Types.RetrieveEnvironmentInfoResultMessage, AWSError>;
/**
* Swaps the CNAMEs of two environments.
*/
swapEnvironmentCNAMEs(params: ElasticBeanstalk.Types.SwapEnvironmentCNAMEsMessage, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Swaps the CNAMEs of two environments.
*/
swapEnvironmentCNAMEs(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Terminates the specified environment.
*/
terminateEnvironment(params: ElasticBeanstalk.Types.TerminateEnvironmentMessage, callback?: (err: AWSError, data: ElasticBeanstalk.Types.EnvironmentDescription) => void): Request<ElasticBeanstalk.Types.EnvironmentDescription, AWSError>;
/**
* Terminates the specified environment.
*/
terminateEnvironment(callback?: (err: AWSError, data: ElasticBeanstalk.Types.EnvironmentDescription) => void): Request<ElasticBeanstalk.Types.EnvironmentDescription, AWSError>;
/**
* Updates the specified application to have the specified properties. If a property (for example, description) is not provided, the value remains unchanged. To clear these properties, specify an empty string.
*/
updateApplication(params: ElasticBeanstalk.Types.UpdateApplicationMessage, callback?: (err: AWSError, data: ElasticBeanstalk.Types.ApplicationDescriptionMessage) => void): Request<ElasticBeanstalk.Types.ApplicationDescriptionMessage, AWSError>;
/**
* Updates the specified application to have the specified properties. If a property (for example, description) is not provided, the value remains unchanged. To clear these properties, specify an empty string.
*/
updateApplication(callback?: (err: AWSError, data: ElasticBeanstalk.Types.ApplicationDescriptionMessage) => void): Request<ElasticBeanstalk.Types.ApplicationDescriptionMessage, AWSError>;
/**
* Modifies lifecycle settings for an application.
*/
updateApplicationResourceLifecycle(params: ElasticBeanstalk.Types.UpdateApplicationResourceLifecycleMessage, callback?: (err: AWSError, data: ElasticBeanstalk.Types.ApplicationResourceLifecycleDescriptionMessage) => void): Request<ElasticBeanstalk.Types.ApplicationResourceLifecycleDescriptionMessage, AWSError>;
/**
* Modifies lifecycle settings for an application.
*/
updateApplicationResourceLifecycle(callback?: (err: AWSError, data: ElasticBeanstalk.Types.ApplicationResourceLifecycleDescriptionMessage) => void): Request<ElasticBeanstalk.Types.ApplicationResourceLifecycleDescriptionMessage, AWSError>;
/**
* Updates the specified application version to have the specified properties. If a property (for example, description) is not provided, the value remains unchanged. To clear properties, specify an empty string.
*/
updateApplicationVersion(params: ElasticBeanstalk.Types.UpdateApplicationVersionMessage, callback?: (err: AWSError, data: ElasticBeanstalk.Types.ApplicationVersionDescriptionMessage) => void): Request<ElasticBeanstalk.Types.ApplicationVersionDescriptionMessage, AWSError>;
/**
* Updates the specified application version to have the specified properties. If a property (for example, description) is not provided, the value remains unchanged. To clear properties, specify an empty string.
*/
updateApplicationVersion(callback?: (err: AWSError, data: ElasticBeanstalk.Types.ApplicationVersionDescriptionMessage) => void): Request<ElasticBeanstalk.Types.ApplicationVersionDescriptionMessage, AWSError>;
/**
* Updates the specified configuration template to have the specified properties or configuration option values. If a property (for example, ApplicationName) is not provided, its value remains unchanged. To clear such properties, specify an empty string. Related Topics DescribeConfigurationOptions
*/
updateConfigurationTemplate(params: ElasticBeanstalk.Types.UpdateConfigurationTemplateMessage, callback?: (err: AWSError, data: ElasticBeanstalk.Types.ConfigurationSettingsDescription) => void): Request<ElasticBeanstalk.Types.ConfigurationSettingsDescription, AWSError>;
/**
* Updates the specified configuration template to have the specified properties or configuration option values. If a property (for example, ApplicationName) is not provided, its value remains unchanged. To clear such properties, specify an empty string. Related Topics DescribeConfigurationOptions
*/
updateConfigurationTemplate(callback?: (err: AWSError, data: ElasticBeanstalk.Types.ConfigurationSettingsDescription) => void): Request<ElasticBeanstalk.Types.ConfigurationSettingsDescription, AWSError>;
/**
* 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. Attempting to update both the release and configuration is not allowed and AWS Elastic Beanstalk returns an InvalidParameterCombination error. When updating the configuration settings to a new template or individual settings, a draft configuration is created and DescribeConfigurationSettings for this environment returns two setting descriptions with different DeploymentStatus values.
*/
updateEnvironment(params: ElasticBeanstalk.Types.UpdateEnvironmentMessage, callback?: (err: AWSError, data: ElasticBeanstalk.Types.EnvironmentDescription) => void): Request<ElasticBeanstalk.Types.EnvironmentDescription, AWSError>;
/**
* 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. Attempting to update both the release and configuration is not allowed and AWS Elastic Beanstalk returns an InvalidParameterCombination error. When updating the configuration settings to a new template or individual settings, a draft configuration is created and DescribeConfigurationSettings for this environment returns two setting descriptions with different DeploymentStatus values.
*/
updateEnvironment(callback?: (err: AWSError, data: ElasticBeanstalk.Types.EnvironmentDescription) => void): Request<ElasticBeanstalk.Types.EnvironmentDescription, AWSError>;
/**
* Update the list of tags applied to an AWS Elastic Beanstalk resource. Two lists can be passed: TagsToAdd for tags to add or update, and TagsToRemove. Elastic Beanstalk supports tagging of all of its resources. For details about resource tagging, see Tagging Application Resources. 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: elasticbeanstalk:AddTags Controls permission to call UpdateTagsForResource and pass a list of tags to add in the TagsToAdd parameter. elasticbeanstalk:RemoveTags Controls permission to call UpdateTagsForResource and pass a list of tag keys to remove in the TagsToRemove parameter. For details about creating a custom user policy, see Creating a Custom User Policy.
*/
updateTagsForResource(params: ElasticBeanstalk.Types.UpdateTagsForResourceMessage, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Update the list of tags applied to an AWS Elastic Beanstalk resource. Two lists can be passed: TagsToAdd for tags to add or update, and TagsToRemove. Elastic Beanstalk supports tagging of all of its resources. For details about resource tagging, see Tagging Application Resources. 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: elasticbeanstalk:AddTags Controls permission to call UpdateTagsForResource and pass a list of tags to add in the TagsToAdd parameter. elasticbeanstalk:RemoveTags Controls permission to call UpdateTagsForResource and pass a list of tag keys to remove in the TagsToRemove parameter. For details about creating a custom user policy, see Creating a Custom User Policy.
*/
updateTagsForResource(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Takes a set of configuration settings and either a configuration template or environment, and determines whether those values are valid. This action returns a list of messages indicating any errors or warnings associated with the selection of option values.
*/
validateConfigurationSettings(params: ElasticBeanstalk.Types.ValidateConfigurationSettingsMessage, callback?: (err: AWSError, data: ElasticBeanstalk.Types.ConfigurationSettingsValidationMessages) => void): Request<ElasticBeanstalk.Types.ConfigurationSettingsValidationMessages, AWSError>;
/**
* Takes a set of configuration settings and either a configuration template or environment, and determines whether those values are valid. This action returns a list of messages indicating any errors or warnings associated with the selection of option values.
*/
validateConfigurationSettings(callback?: (err: AWSError, data: ElasticBeanstalk.Types.ConfigurationSettingsValidationMessages) => void): Request<ElasticBeanstalk.Types.ConfigurationSettingsValidationMessages, AWSError>;
/**
* Waits for the environmentExists state by periodically calling the underlying ElasticBeanstalk.describeEnvironmentsoperation every 20 seconds (at most 20 times).
*/
waitFor(state: "environmentExists", params: ElasticBeanstalk.Types.DescribeEnvironmentsMessage & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: ElasticBeanstalk.Types.EnvironmentDescriptionsMessage) => void): Request<ElasticBeanstalk.Types.EnvironmentDescriptionsMessage, AWSError>;
/**
* Waits for the environmentExists state by periodically calling the underlying ElasticBeanstalk.describeEnvironmentsoperation every 20 seconds (at most 20 times).
*/
waitFor(state: "environmentExists", callback?: (err: AWSError, data: ElasticBeanstalk.Types.EnvironmentDescriptionsMessage) => void): Request<ElasticBeanstalk.Types.EnvironmentDescriptionsMessage, AWSError>;
/**
* Waits for the environmentUpdated state by periodically calling the underlying ElasticBeanstalk.describeEnvironmentsoperation every 20 seconds (at most 20 times).
*/
waitFor(state: "environmentUpdated", params: ElasticBeanstalk.Types.DescribeEnvironmentsMessage & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: ElasticBeanstalk.Types.EnvironmentDescriptionsMessage) => void): Request<ElasticBeanstalk.Types.EnvironmentDescriptionsMessage, AWSError>;
/**
* Waits for the environmentUpdated state by periodically calling the underlying ElasticBeanstalk.describeEnvironmentsoperation every 20 seconds (at most 20 times).
*/
waitFor(state: "environmentUpdated", callback?: (err: AWSError, data: ElasticBeanstalk.Types.EnvironmentDescriptionsMessage) => void): Request<ElasticBeanstalk.Types.EnvironmentDescriptionsMessage, AWSError>;
/**
* Waits for the environmentTerminated state by periodically calling the underlying ElasticBeanstalk.describeEnvironmentsoperation every 20 seconds (at most 20 times).
*/
waitFor(state: "environmentTerminated", params: ElasticBeanstalk.Types.DescribeEnvironmentsMessage & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: ElasticBeanstalk.Types.EnvironmentDescriptionsMessage) => void): Request<ElasticBeanstalk.Types.EnvironmentDescriptionsMessage, AWSError>;
/**
* Waits for the environmentTerminated state by periodically calling the underlying ElasticBeanstalk.describeEnvironmentsoperation every 20 seconds (at most 20 times).
*/
waitFor(state: "environmentTerminated", callback?: (err: AWSError, data: ElasticBeanstalk.Types.EnvironmentDescriptionsMessage) => void): Request<ElasticBeanstalk.Types.EnvironmentDescriptionsMessage, AWSError>;
}
declare namespace ElasticBeanstalk {
export type ARN = string;
export interface AbortEnvironmentUpdateMessage {
/**
* This specifies the ID of the environment with the in-progress update that you want to cancel.
*/
EnvironmentId?: EnvironmentId;
/**
* This specifies the name of the environment with the in-progress update that you want to cancel.
*/
EnvironmentName?: EnvironmentName;
}
export type AbortableOperationInProgress = boolean;
export type ActionHistoryStatus = "Completed"|"Failed"|"Unknown"|string;
export type ActionStatus = "Scheduled"|"Pending"|"Running"|"Unknown"|string;
export type ActionType = "InstanceRefresh"|"PlatformUpdate"|"Unknown"|string;
export type ApplicationArn = string;
export interface ApplicationDescription {
/**
* The Amazon Resource Name (ARN) of the application.
*/
ApplicationArn?: ApplicationArn;
/**
* The name of the application.
*/
ApplicationName?: ApplicationName;
/**
* User-defined description of the application.
*/
Description?: Description;
/**
* The date when the application was created.
*/
DateCreated?: CreationDate;
/**
* The date when the application was last modified.
*/
DateUpdated?: UpdateDate;
/**
* The names of the versions for this application.
*/
Versions?: VersionLabelsList;
/**
* The names of the configuration templates associated with this application.
*/
ConfigurationTemplates?: ConfigurationTemplateNamesList;
/**
* The lifecycle settings for the application.
*/
ResourceLifecycleConfig?: ApplicationResourceLifecycleConfig;
}
export type ApplicationDescriptionList = ApplicationDescription[];
export interface ApplicationDescriptionMessage {
/**
* The ApplicationDescription of the application.
*/
Application?: ApplicationDescription;
}
export interface ApplicationDescriptionsMessage {
/**
* This parameter contains a list of ApplicationDescription.
*/
Applications?: ApplicationDescriptionList;
}
export interface ApplicationMetrics {
/**
* The amount of time that the metrics cover (usually 10 seconds). For example, you might have 5 requests (request_count) within the most recent time slice of 10 seconds (duration).
*/
Duration?: NullableInteger;
/**
* Average number of requests handled by the web server per second over the last 10 seconds.
*/
RequestCount?: RequestCount;
/**
* Represents the percentage of requests over the last 10 seconds that resulted in each type of status code response.
*/
StatusCodes?: StatusCodes;
/**
* Represents the average latency for the slowest X percent of requests over the last 10 seconds. Latencies are in seconds with one millisecond resolution.
*/
Latency?: Latency;
}
export type ApplicationName = string;
export type ApplicationNamesList = ApplicationName[];
export interface ApplicationResourceLifecycleConfig {
/**
* The ARN of an IAM service role that Elastic Beanstalk has permission to assume. The ServiceRole property is required the first time that you provide a VersionLifecycleConfig for the application in one of the supporting calls (CreateApplication or UpdateApplicationResourceLifecycle). After you provide it once, in either one of the calls, Elastic Beanstalk persists the Service Role with the application, and you don't need to specify it again in subsequent UpdateApplicationResourceLifecycle calls. You can, however, specify it in subsequent calls to change the Service Role to another value.
*/
ServiceRole?: String;
/**
* Defines lifecycle settings for application versions.
*/
VersionLifecycleConfig?: ApplicationVersionLifecycleConfig;
}
export interface ApplicationResourceLifecycleDescriptionMessage {
/**
* The name of the application.
*/
ApplicationName?: ApplicationName;
/**
* The lifecycle configuration.
*/
ResourceLifecycleConfig?: ApplicationResourceLifecycleConfig;
}
export type ApplicationVersionArn = string;
export interface ApplicationVersionDescription {
/**
* The Amazon Resource Name (ARN) of the application version.
*/
ApplicationVersionArn?: ApplicationVersionArn;
/**
* The name of the application to which the application version belongs.
*/
ApplicationName?: ApplicationName;
/**
* The description of the application version.
*/
Description?: Description;
/**
* A unique identifier for the application version.
*/
VersionLabel?: VersionLabel;
/**
* If the version's source code was retrieved from AWS CodeCommit, the location of the source code for the application version.
*/
SourceBuildInformation?: SourceBuildInformation;
/**
* Reference to the artifact from the AWS CodeBuild build.
*/
BuildArn?: String;
/**
* The storage location of the application version's source bundle in Amazon S3.
*/
SourceBundle?: S3Location;
/**
* The creation date of the application version.
*/
DateCreated?: CreationDate;
/**
* The last modified date of the application version.
*/
DateUpdated?: UpdateDate;
/**
* The processing status of the application version. Reflects the state of the application version during its creation. Many of the values are only applicable if you specified True for the Process parameter of the CreateApplicationVersion action. The following list describes the possible values. Unprocessed – Application version wasn't pre-processed or validated. Elastic Beanstalk will validate configuration files during deployment of the application version to an environment. Processing – Elastic Beanstalk is currently processing the application version. Building – Application version is currently undergoing an AWS CodeBuild build. Processed – Elastic Beanstalk was successfully pre-processed and validated. Failed – Either the AWS CodeBuild build failed or configuration files didn't pass validation. This application version isn't usable.
*/
Status?: ApplicationVersionStatus;
}
export type ApplicationVersionDescriptionList = ApplicationVersionDescription[];
export interface ApplicationVersionDescriptionMessage {
/**
* The ApplicationVersionDescription of the application version.
*/
ApplicationVersion?: ApplicationVersionDescription;
}
export interface ApplicationVersionDescriptionsMessage {
/**
* List of ApplicationVersionDescription objects sorted in order of creation.
*/
ApplicationVersions?: ApplicationVersionDescriptionList;
/**
* In a paginated request, the token that you can pass in a subsequent request to get the next response page.
*/
NextToken?: Token;
}
export interface ApplicationVersionLifecycleConfig {
/**
* Specify a max count rule to restrict the number of application versions that are retained for an application.
*/
MaxCountRule?: MaxCountRule;
/**
* Specify a max age rule to restrict the length of time that application versions are retained for an application.
*/
MaxAgeRule?: MaxAgeRule;
}
export type ApplicationVersionProccess = boolean;
export type ApplicationVersionStatus = "Processed"|"Unprocessed"|"Failed"|"Processing"|"Building"|string;
export interface ApplyEnvironmentManagedActionRequest {
/**
* The name of the target environment.
*/
EnvironmentName?: String;
/**
* The environment ID of the target environment.
*/
EnvironmentId?: String;
/**
* The action ID of the scheduled managed action to execute.
*/
ActionId: String;
}
export interface ApplyEnvironmentManagedActionResult {
/**
* The action ID of the managed action.
*/
ActionId?: String;
/**
* A description of the managed action.
*/
ActionDescription?: String;
/**
* The type of managed action.
*/
ActionType?: ActionType;
/**
* The status of the managed action.
*/
Status?: String;
}
export interface AssociateEnvironmentOperationsRoleMessage {
/**
* The name of the environment to which to set the operations role.
*/
EnvironmentName: EnvironmentName;
/**
* The Amazon Resource Name (ARN) of an existing IAM role to be used as the environment's operations role.
*/
OperationsRole: OperationsRole;
}
export type AutoCreateApplication = boolean;
export interface AutoScalingGroup {
/**
* The name of the AutoScalingGroup .
*/
Name?: ResourceId;
}
export type AutoScalingGroupList = AutoScalingGroup[];
export type AvailableSolutionStackDetailsList = SolutionStackDescription[];
export type AvailableSolutionStackNamesList = SolutionStackName[];
export type BoxedBoolean = boolean;
export type BoxedInt = number;
export type BranchName = string;
export type BranchOrder = number;
export interface BuildConfiguration {
/**
* The name of the artifact of the CodeBuild build. If provided, Elastic Beanstalk stores the build artifact in the S3 location S3-bucket/resources/application-name/codebuild/codebuild-version-label-artifact-name.zip. If not provided, Elastic Beanstalk stores the build artifact in the S3 location S3-bucket/resources/application-name/codebuild/codebuild-version-label.zip.
*/
ArtifactName?: String;
/**
* The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that enables AWS CodeBuild to interact with dependent AWS services on behalf of the AWS account.
*/
CodeBuildServiceRole: NonEmptyString;
/**
* Information about the compute resources the build project will use. BUILD_GENERAL1_SMALL: Use up to 3 GB memory and 2 vCPUs for builds BUILD_GENERAL1_MEDIUM: Use up to 7 GB memory and 4 vCPUs for builds BUILD_GENERAL1_LARGE: Use up to 15 GB memory and 8 vCPUs for builds
*/
ComputeType?: ComputeType;
/**
* The ID of the Docker image to use for this build project.
*/
Image: NonEmptyString;
/**
* How long in minutes, from 5 to 480 (8 hours), for AWS CodeBuild to wait until timing out any related build that does not get marked as completed. The default is 60 minutes.
*/
TimeoutInMinutes?: BoxedInt;
}
export interface Builder {
/**
* The ARN of the builder.
*/
ARN?: ARN;
}
export interface CPUUtilization {
/**
* Percentage of time that the CPU has spent in the User state over the last 10 seconds.
*/
User?: NullableDouble;
/**
* Available on Linux environments only. Percentage of time that the CPU has spent in the Nice state over the last 10 seconds.
*/
Nice?: NullableDouble;
/**
* Available on Linux environments only. Percentage of time that the CPU has spent in the System state over the last 10 seconds.
*/
System?: NullableDouble;
/**
* Percentage of time that the CPU has spent in the Idle state over the last 10 seconds.
*/
Idle?: NullableDouble;
/**
* Available on Linux environments only. Percentage of time that the CPU has spent in the I/O Wait state over the last 10 seconds.
*/
IOWait?: NullableDouble;
/**
* Available on Linux environments only. Percentage of time that the CPU has spent in the IRQ state over the last 10 seconds.
*/
IRQ?: NullableDouble;
/**
* Available on Linux environments only. Percentage of time that the CPU has spent in the SoftIRQ state over the last 10 seconds.
*/
SoftIRQ?: NullableDouble;
/**
* Available on Windows environments only. Percentage of time that the CPU has spent in the Privileged state over the last 10 seconds.
*/
Privileged?: NullableDouble;
}
export type Cause = string;
export type Causes = Cause[];
export interface CheckDNSAvailabilityMessage {
/**
* The prefix used when this CNAME is reserved.
*/
CNAMEPrefix: DNSCnamePrefix;
}
export interface CheckDNSAvailabilityResultMessage {
/**
* Indicates if the specified CNAME is available: true : The CNAME is available. false : The CNAME is not available.
*/
Available?: CnameAvailability;
/**
* The fully qualified CNAME to reserve when CreateEnvironment is called with the provided prefix.
*/
FullyQualifiedCNAME?: DNSCname;
}
export type CnameAvailability = boolean;
export interface ComposeEnvironmentsMessage {
/**
* The name of the application to which the specified source bundles belong.
*/
ApplicationName?: ApplicationName;
/**
* The name of the group to which the target environments belong. Specify a group name only if the environment name defined in each target environment's manifest ends with a + (plus) character. See Environment Manifest (env.yaml) for details.
*/
GroupName?: GroupName;
/**
* A list of version labels, specifying one or more application source bundles that belong to the target application. Each source bundle must include an environment manifest that specifies the name of the environment and the name of the solution stack to use, and optionally can specify environment links to create.
*/
VersionLabels?: VersionLabels;
}
export type ComputeType = "BUILD_GENERAL1_SMALL"|"BUILD_GENERAL1_MEDIUM"|"BUILD_GENERAL1_LARGE"|string;
export type ConfigurationDeploymentStatus = "deployed"|"pending"|"failed"|string;
export type ConfigurationOptionDefaultValue = string;
export interface ConfigurationOptionDescription {
/**
* A unique namespace identifying the option's associated AWS resource.
*/
Namespace?: OptionNamespace;
/**
* The name of the configuration option.
*/
Name?: ConfigurationOptionName;
/**
* The default value for this configuration option.
*/
DefaultValue?: ConfigurationOptionDefaultValue;
/**
* An indication of which action is required if the value for this configuration option changes: NoInterruption : There is no interruption to the environment or application availability. RestartEnvironment : The environment is entirely restarted, all AWS resources are deleted and recreated, and the environment is unavailable during the process. RestartApplicationServer : The environment is available the entire time. However, a short application outage occurs when the application servers on the running Amazon EC2 instances are restarted.
*/
ChangeSeverity?: ConfigurationOptionSeverity;
/**
* An indication of whether the user defined this configuration option: true : This configuration option was defined by the user. It is a valid choice for specifying if this as an Option to Remove when updating configuration settings. false : This configuration was not defined by the user. Constraint: You can remove only UserDefined options from a configuration. Valid Values: true | false
*/
UserDefined?: UserDefinedOption;
/**
* An indication of which type of values this option has and whether it is allowable to select one or more than one of the possible values: Scalar : Values for this option are a single selection from the possible values, or an unformatted string, or numeric value governed by the MIN/MAX/Regex constraints. List : Values for this option are multiple selections from the possible values. Boolean : Values for this option are either true or false . Json : Values for this option are a JSON representation of a ConfigDocument.
*/
ValueType?: ConfigurationOptionValueType;
/**
* If specified, values for the configuration option are selected from this list.
*/
ValueOptions?: ConfigurationOptionPossibleValues;
/**
* If specified, the configuration option must be a numeric value greater than this value.
*/
MinValue?: OptionRestrictionMinValue;
/**
* If specified, the configuration option must be a numeric value less than this value.
*/
MaxValue?: OptionRestrictionMaxValue;
/**
* If specified, the configuration option must be a string value no longer than this value.
*/
MaxLength?: OptionRestrictionMaxLength;
/**
* If specified, the configuration option must be a string value that satisfies this regular expression.
*/
Regex?: OptionRestrictionRegex;
}
export type ConfigurationOptionDescriptionsList = ConfigurationOptionDescription[];
export type ConfigurationOptionName = string;
export type ConfigurationOptionPossibleValue = string;
export type ConfigurationOptionPossibleValues = ConfigurationOptionPossibleValue[];
export interface ConfigurationOptionSetting {
/**
* A unique resource name for the option setting. Use it for a time–based scaling configuration option.
*/
ResourceName?: ResourceName;
/**
* A unique namespace that identifies the option's associated AWS resource.
*/
Namespace?: OptionNamespace;
/**
* The name of the configuration option.
*/
OptionName?: ConfigurationOptionName;
/**
* The current value for the configuration option.
*/
Value?: ConfigurationOptionValue;
}
export type ConfigurationOptionSettingsList = ConfigurationOptionSetting[];
export type ConfigurationOptionSeverity = string;
export type ConfigurationOptionValue = string;
export type ConfigurationOptionValueType = "Scalar"|"List"|string;
export interface ConfigurationOptionsDescription {
/**
* The name of the solution stack these configuration options belong to.
*/
SolutionStackName?: SolutionStackName;
/**
* The ARN of the platform version.
*/
PlatformArn?: PlatformArn;
/**
* A list of ConfigurationOptionDescription.
*/
Options?: ConfigurationOptionDescriptionsList;
}
export interface ConfigurationSettingsDescription {
/**
* The name of the solution stack this configuration set uses.
*/
SolutionStackName?: SolutionStackName;
/**
* The ARN of the platform version.
*/
PlatformArn?: PlatformArn;
/**
* The name of the application associated with this configuration set.
*/
ApplicationName?: ApplicationName;
/**
* If not null, the name of the configuration template for this configuration set.
*/
TemplateName?: ConfigurationTemplateName;
/**
* Describes this configuration set.
*/
Description?: Description;
/**
* If not null, the name of the environment for this configuration set.
*/
EnvironmentName?: EnvironmentName;
/**
* If this configuration set is associated with an environment, the DeploymentStatus parameter indicates the deployment status of this configuration set: null: This configuration is not associated with a running environment. pending: This is a draft configuration that is not deployed to the associated environment but is in the process of deploying. deployed: This is the configuration that is currently deployed to the associated running environment. failed: This is a draft configuration that failed to successfully deploy.
*/
DeploymentStatus?: ConfigurationDeploymentStatus;
/**
* The date (in UTC time) when this configuration set was created.
*/
DateCreated?: CreationDate;
/**
* The date (in UTC time) when this configuration set was last modified.
*/
DateUpdated?: UpdateDate;
/**
* A list of the configuration options and their values in this configuration set.
*/
OptionSettings?: ConfigurationOptionSettingsList;
}
export type ConfigurationSettingsDescriptionList = ConfigurationSettingsDescription[];
export interface ConfigurationSettingsDescriptions {
/**
* A list of ConfigurationSettingsDescription.
*/
ConfigurationSettings?: ConfigurationSettingsDescriptionList;
}
export interface ConfigurationSettingsValidationMessages {
/**
* A list of ValidationMessage.
*/
Messages?: ValidationMessagesList;
}
export type ConfigurationTemplateName = string;
export type ConfigurationTemplateNamesList = ConfigurationTemplateName[];
export interface CreateApplicationMessage {
/**
* The name of the application. Must be unique within your account.
*/
ApplicationName: ApplicationName;
/**
* Your description of the application.
*/
Description?: Description;
/**
* Specifies an application resource lifecycle configuration to prevent your application from accumulating too many versions.
*/
ResourceLifecycleConfig?: ApplicationResourceLifecycleConfig;
/**
* Specifies the tags applied to the application. Elastic Beanstalk applies these tags only to the application. Environments that you create in the application don't inherit the tags.
*/
Tags?: Tags;
}
export interface CreateApplicationVersionMessage {
/**
* The name of the application. If no application is found with this name, and AutoCreateApplication is false, returns an InvalidParameterValue error.
*/
ApplicationName: ApplicationName;
/**
* A label identifying this version. Constraint: Must be unique per application. If an application version already exists with this label for the specified application, AWS Elastic Beanstalk returns an InvalidParameterValue error.
*/
VersionLabel: VersionLabel;
/**
* A description of this application version.
*/
Description?: Description;
/**
* Specify a commit in an AWS CodeCommit Git repository to use as the source code for the application version.
*/
SourceBuildInformation?: SourceBuildInformation;
/**
* The Amazon S3 bucket and key that identify the location of the source bundle for this version. The Amazon S3 bucket must be in the same region as the environment. Specify a source bundle in S3 or a commit in an AWS CodeCommit repository (with SourceBuildInformation), but not both. If neither SourceBundle nor SourceBuildInformation are provided, Elastic Beanstalk uses a sample application.
*/
SourceBundle?: S3Location;
/**
* Settings for an AWS CodeBuild build.
*/
BuildConfiguration?: BuildConfiguration;
/**
* Set to true to create an application with the specified name if it doesn't already exist.
*/
AutoCreateApplication?: AutoCreateApplication;
/**
* Pre-processes and validates the environment manifest (env.yaml) and configuration files (*.config files in the .ebextensions folder) in the source bundle. Validating configuration files can identify issues prior to deploying the application version to an environment. You must turn processing on for application versions that you create using AWS CodeBuild or AWS CodeCommit. For application versions built from a source bundle in Amazon S3, processing is optional. The Process option validates Elastic Beanstalk configuration files. It doesn't validate your application's configuration files, like proxy server or Docker configuration.
*/
Process?: ApplicationVersionProccess;
/**
* Specifies the tags applied to the application version. Elastic Beanstalk applies these tags only to the application version. Environments that use the application version don't inherit the tags.
*/
Tags?: Tags;
}
export interface CreateConfigurationTemplateMessage {
/**
* The name of the Elastic Beanstalk application to associate with this configuration template.
*/
ApplicationName: ApplicationName;
/**
* The name of the configuration template. Constraint: This name must be unique per application.
*/
TemplateName: ConfigurationTemplateName;
/**
* The name of an Elastic Beanstalk solution stack (platform version) that this configuration uses. For example, 64bit Amazon Linux 2013.09 running Tomcat 7 Java 7. A solution stack specifies the operating system, runtime, and application server for a configuration template. It also determines the set of configuration options as well as the possible and default values. For more information, see Supported Platforms in the AWS Elastic Beanstalk Developer Guide. You must specify SolutionStackName if you don't specify PlatformArn, EnvironmentId, or SourceConfiguration. Use the ListAvailableSolutionStacks API to obtain a list of available solution stacks.
*/
SolutionStackName?: SolutionStackName;
/**
* The Amazon Resource Name (ARN) of the custom platform. For more information, see Custom Platforms in the AWS Elastic Beanstalk Developer Guide. If you specify PlatformArn, then don't specify SolutionStackName.
*/
PlatformArn?: PlatformArn;
/**
* An Elastic Beanstalk configuration template to base this one on. If specified, Elastic Beanstalk uses the configuration values from the specified configuration template to create a new configuration. Values specified in OptionSettings override any values obtained from the SourceConfiguration. You must specify SourceConfiguration if you don't specify PlatformArn, EnvironmentId, or SolutionStackName. Constraint: If both solution stack name and source configuration are specified, the solution stack of the source configuration template must match the specified solution stack name.
*/
SourceConfiguration?: SourceConfiguration;
/**
* The ID of an environment whose settings you want to use to create the configuration template. You must specify EnvironmentId if you don't specify PlatformArn, SolutionStackName, or SourceConfiguration.
*/
EnvironmentId?: EnvironmentId;
/**
* An optional description for this configuration.
*/
Description?: Description;
/**
* Option values for the Elastic Beanstalk configuration, such as the instance type. If specified, these values override the values obtained from the solution stack or the source configuration template. For a complete list of Elastic Beanstalk configuration options, see Option Values in the AWS Elastic Beanstalk Developer Guide.
*/
OptionSettings?: ConfigurationOptionSettingsList;
/**
* Specifies the tags applied to the configuration template.
*/
Tags?: Tags;
}
export interface CreateEnvironmentMessage {
/**
* The name of the application that is associated with this environment.
*/
ApplicationName: ApplicationName;
/**
* A unique name for the environment. Constraint: Must be from 4 to 40 characters in length. The name can contain only letters, numbers, and hyphens. It can't start or end with a hyphen. This name must be unique within a region in your account. If the specified name already exists in the region, Elastic Beanstalk returns an InvalidParameterValue error. If you don't specify the CNAMEPrefix parameter, the environment name becomes part of the CNAME, and therefore part of the visible URL for your application.
*/
EnvironmentName?: EnvironmentName;
/**
* The name of the group to which the target environment belongs. Specify a group name only if the environment's name is specified in an environment manifest and not with the environment name parameter. See Environment Manifest (env.yaml) for details.
*/
GroupName?: GroupName;
/**
* Your description for this environment.
*/
Description?: Description;
/**
* If specified, the environment attempts to use this value as the prefix for the CNAME in your Elastic Beanstalk environment URL. If not specified, the CNAME is generated automatically by appending a random alphanumeric string to the environment name.
*/
CNAMEPrefix?: DNSCnamePrefix;
/**
* Specifies the tier to use in creating this environment. The environment tier that you choose determines whether Elastic Beanstalk provisions resources to support a web application that handles HTTP(S) requests or a web application that handles background-processing tasks.
*/
Tier?: EnvironmentTier;
/**
* Specifies the tags applied to resources in the environment.
*/
Tags?: Tags;
/**
* The name of the application version to deploy. Default: If not specified, Elastic Beanstalk attempts to deploy the sample application.
*/
VersionLabel?: VersionLabel;
/**
* The name of the Elastic Beanstalk configuration template to use with the environment. If you specify TemplateName, then don't specify SolutionStackName.
*/
TemplateName?: ConfigurationTemplateName;
/**
* The name of an Elastic Beanstalk solution stack (platform version) to use with the environment. If specified, Elastic Beanstalk sets the configuration values to the default values associated with the specified solution stack. For a list of current solution stacks, see Elastic Beanstalk Supported Platforms in the AWS Elastic Beanstalk Platforms guide. If you specify SolutionStackName, don't specify PlatformArn or TemplateName.
*/
SolutionStackName?: SolutionStackName;
/**
* The Amazon Resource Name (ARN) of the custom platform to use with the environment. For more information, see Custom Platforms in the AWS Elastic Beanstalk Developer Guide. If you specify PlatformArn, don't specify SolutionStackName.
*/
PlatformArn?: PlatformArn;
/**
* If specified, AWS Elastic Beanstalk sets the specified configuration options to the requested value in the configuration set for the new environment. These override the values obtained from the solution stack or the configuration template.
*/
OptionSettings?: ConfigurationOptionSettingsList;
/**
* A list of custom user-defined configuration options to remove from the configuration set for this new environment.
*/
OptionsToRemove?: OptionsSpecifierList;
/**
* The Amazon Resource Name (ARN) of an existing IAM role to be used as the environment's operations role. If specified, Elastic Beanstalk uses the operations role for permissions to downstream services during this call and during subsequent calls acting on this environment. To specify an operations role, you must have the iam:PassRole permission for the role. For more information, see Operations roles in the AWS Elastic Beanstalk Developer Guide.
*/
OperationsRole?: OperationsRole;
}
export interface CreatePlatformVersionRequest {
/**
* The name of your custom platform.
*/
PlatformName: PlatformName;
/**
* The number, such as 1.0.2, for the new platform version.
*/
PlatformVersion: PlatformVersion;
/**
* The location of the platform definition archive in Amazon S3.
*/
PlatformDefinitionBundle: S3Location;
/**
* The name of the builder environment.
*/
EnvironmentName?: EnvironmentName;
/**
* The configuration option settings to apply to the builder environment.
*/
OptionSettings?: ConfigurationOptionSettingsList;
/**
* Specifies the tags applied to the new platform version. Elastic Beanstalk applies these tags only to the platform version. Environments that you create using the platform version don't inherit the tags.
*/
Tags?: Tags;
}
export interface CreatePlatformVersionResult {
/**
* Detailed information about the new version of the custom platform.
*/
PlatformSummary?: PlatformSummary;
/**
* The builder used to create the custom platform.
*/
Builder?: Builder;
}
export interface CreateStorageLocationResultMessage {
/**
* The name of the Amazon S3 bucket created.
*/
S3Bucket?: S3Bucket;
}
export type CreationDate = Date;
export interface CustomAmi {
/**
* The type of virtualization used to create the custom AMI.
*/
VirtualizationType?: VirtualizationType;
/**
* THe ID of the image used to create the custom AMI.
*/
ImageId?: ImageId;
}
export type CustomAmiList = CustomAmi[];
export type DNSCname = string;
export type DNSCnamePrefix = string;
export interface DeleteApplicationMessage {
/**
* The name of the application to delete.
*/
ApplicationName: ApplicationName;
/**
* When set to true, running environments will be terminated before deleting the application.
*/
TerminateEnvByForce?: TerminateEnvForce;
}
export interface DeleteApplicationVersionMessage {
/**
* The name of the application to which the version belongs.
*/
ApplicationName: ApplicationName;
/**
* The label of the version to delete.
*/
VersionLabel: VersionLabel;
/**
* Set to true to delete the source bundle from your storage bucket. Otherwise, the application version is deleted only from Elastic Beanstalk and the source bundle remains in Amazon S3.
*/
DeleteSourceBundle?: DeleteSourceBundle;
}
export interface DeleteConfigurationTemplateMessage {
/**
* The name of the application to delete the configuration template from.
*/
ApplicationName: ApplicationName;
/**
* The name of the configuration template to delete.
*/
TemplateName: ConfigurationTemplateName;
}
export interface DeleteEnvironmentConfigurationMessage {
/**
* The name of the application the environment is associated with.
*/
ApplicationName: ApplicationName;
/**
* The name of the environment to delete the draft configuration from.
*/
EnvironmentName: EnvironmentName;
}
export interface DeletePlatformVersionRequest {
/**
* The ARN of the version of the custom platform.
*/
PlatformArn?: PlatformArn;
}
export interface DeletePlatformVersionResult {
/**
* Detailed information about the version of the custom platform.
*/
PlatformSummary?: PlatformSummary;
}
export type DeleteSourceBundle = boolean;
export interface Deployment {
/**
* The version label of the application version in the deployment.
*/
VersionLabel?: String;
/**
* The ID of the deployment. This number increases by one each time that you deploy source code or change instance configuration settings.
*/
DeploymentId?: NullableLong;
/**
* The status of the deployment: In Progress : The deployment is in progress. Deployed : The deployment succeeded. Failed : The deployment failed.
*/
Status?: String;
/**
* For in-progress deployments, the time that the deployment started. For completed deployments, the time that the deployment ended.
*/
DeploymentTime?: DeploymentTimestamp;
}
export type DeploymentTimestamp = Date;
export interface DescribeAccountAttributesResult {
/**
* The Elastic Beanstalk resource quotas associated with the calling AWS account.
*/
ResourceQuotas?: ResourceQuotas;
}
export interface DescribeApplicationVersionsMessage {
/**
* Specify an application name to show only application versions for that application.
*/
ApplicationName?: ApplicationName;
/**
* Specify a version label to show a specific application version.
*/
VersionLabels?: VersionLabelsList;
/**
* For a paginated request. Specify a maximum number of application versions to include in each response. If no MaxRecords is specified, all available application versions are retrieved in a single response.
*/
MaxRecords?: MaxRecords;
/**
* For a paginated request. Specify a token from a previous response page to retrieve the next response page. All other parameter values must be identical to the ones specified in the initial request. If no NextToken is specified, the first page is retrieved.
*/
NextToken?: Token;
}
export interface DescribeApplicationsMessage {
/**
* If specified, AWS Elastic Beanstalk restricts the returned descriptions to only include those with the specified names.
*/
ApplicationNames?: ApplicationNamesList;
}
export interface DescribeConfigurationOptionsMessage {
/**
* The name of the application associated with the configuration template or environment. Only needed if you want to describe the configuration options associated with either the configuration template or environment.
*/
ApplicationName?: ApplicationName;
/**
* The name of the configuration template whose configuration options you want to describe.
*/
TemplateName?: ConfigurationTemplateName;
/**
* The name of the environment whose configuration options you want to describe.
*/
EnvironmentName?: EnvironmentName;
/**
* The name of the solution stack whose configuration options you want to describe.
*/
SolutionStackName?: SolutionStackName;
/**
* The ARN of the custom platform.
*/
PlatformArn?: PlatformArn;
/**
* If specified, restricts the descriptions to only the specified options.
*/
Options?: OptionsSpecifierList;
}
export interface DescribeConfigurationSettingsMessage {
/**
* The application for the environment or configuration template.
*/
ApplicationName: ApplicationName;
/**
* The name of the configuration template to describe. Conditional: You must specify either this parameter or an EnvironmentName, but not both. If you specify both, AWS Elastic Beanstalk returns an InvalidParameterCombination error. If you do not specify either, AWS Elastic Beanstalk returns a MissingRequiredParameter error.
*/
TemplateName?: ConfigurationTemplateName;
/**
* The name of the environment to describe. Condition: You must specify either this or a TemplateName, but not both. If you specify both, AWS Elastic Beanstalk returns an InvalidParameterCombination error. If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error.
*/
EnvironmentName?: EnvironmentName;
}
export interface DescribeEnvironmentHealthRequest {
/**
* Specify the environment by name. You must specify either this or an EnvironmentName, or both.
*/
EnvironmentName?: EnvironmentName;
/**
* Specify the environment by ID. You must specify either this or an EnvironmentName, or both.
*/
EnvironmentId?: EnvironmentId;
/**
* Specify the response elements to return. To retrieve all attributes, set to All. If no attribute names are specified, returns the name of the environment.
*/
AttributeNames?: EnvironmentHealthAttributes;
}
export interface DescribeEnvironmentHealthResult {
/**
* The environment's name.
*/
EnvironmentName?: EnvironmentName;
/**
* The health status of the environment. For example, Ok.
*/
HealthStatus?: String;
/**
* The environment's operational status. Ready, Launching, Updating, Terminating, or Terminated.
*/
Status?: EnvironmentHealth;
/**
* The health color of the environment.
*/
Color?: String;
/**
* Descriptions of the data that contributed to the environment's current health status.
*/
Causes?: Causes;
/**
* Application request metrics for the environment.
*/
ApplicationMetrics?: ApplicationMetrics;
/**
* Summary health information for the instances in the environment.
*/
InstancesHealth?: InstanceHealthSummary;
/**
* The date and time that the health information was retrieved.
*/
RefreshedAt?: RefreshedAt;
}
export interface DescribeEnvironmentManagedActionHistoryRequest {
/**
* The environment ID of the target environment.
*/
EnvironmentId?: EnvironmentId;
/**
* The name of the target environment.
*/
EnvironmentName?: EnvironmentName;
/**
* The pagination token returned by a previous request.
*/
NextToken?: String;
/**
* The maximum number of items to return for a single request.
*/
MaxItems?: Integer;
}
export interface DescribeEnvironmentManagedActionHistoryResult {
/**
* A list of completed and failed managed actions.
*/
ManagedActionHistoryItems?: ManagedActionHistoryItems;
/**
* A pagination token that you pass to DescribeEnvironmentManagedActionHistory to get the next page of results.
*/
NextToken?: String;
}
export interface DescribeEnvironmentManagedActionsRequest {
/**
* The name of the target environment.
*/
EnvironmentName?: String;
/**
* The environment ID of the target environment.
*/
EnvironmentId?: String;
/**
* To show only actions with a particular status, specify a status.
*/
Status?: ActionStatus;
}
export interface DescribeEnvironmentManagedActionsResult {
/**
* A list of upcoming and in-progress managed actions.
*/
ManagedActions?: ManagedActions;
}
export interface DescribeEnvironmentResourcesMessage {
/**
* The ID of the environment to retrieve AWS resource usage data. Condition: You must specify either this or an EnvironmentName, or both. If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error.
*/
EnvironmentId?: EnvironmentId;
/**
* The name of the environment to retrieve AWS resource usage data. Condition: You must specify either this or an EnvironmentId, or both. If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error.
*/
EnvironmentName?: EnvironmentName;
}
export interface DescribeEnvironmentsMessage {
/**
* If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that are associated with this application.
*/
ApplicationName?: ApplicationName;
/**
* If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that are associated with this application version.
*/
VersionLabel?: VersionLabel;
/**
* If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that have the specified IDs.
*/
EnvironmentIds?: EnvironmentIdList;
/**
* If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that have the specified names.
*/
EnvironmentNames?: EnvironmentNamesList;
/**
* Indicates whether to include deleted environments: true: Environments that have been deleted after IncludedDeletedBackTo are displayed. false: Do not include deleted environments.
*/
IncludeDeleted?: IncludeDeleted;
/**
* If specified when IncludeDeleted is set to true, then environments deleted after this date are displayed.
*/
IncludedDeletedBackTo?: IncludeDeletedBackTo;
/**
* For a paginated request. Specify a maximum number of environments to include in each response. If no MaxRecords is specified, all available environments are retrieved in a single response.
*/
MaxRecords?: MaxRecords;
/**
* For a paginated request. Specify a token from a previous response page to retrieve the next response page. All other parameter values must be identical to the ones specified in the initial request. If no NextToken is specified, the first page is retrieved.
*/
NextToken?: Token;
}
export interface DescribeEventsMessage {
/**
* If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those associated with this application.
*/
ApplicationName?: ApplicationName;
/**
* If specified, AWS Elastic Beanstalk restricts the returned descriptions to those associated with this application version.
*/
VersionLabel?: VersionLabel;
/**
* If specified, AWS Elastic Beanstalk restricts the returned descriptions to those that are associated with this environment configuration.
*/
TemplateName?: ConfigurationTemplateName;
/**
* If specified, AWS Elastic Beanstalk restricts the returned descriptions to those associated with this environment.
*/
EnvironmentId?: EnvironmentId;
/**
* If specified, AWS Elastic Beanstalk restricts the returned descriptions to those associated with this environment.
*/
EnvironmentName?: EnvironmentName;
/**
* The ARN of a custom platform version. If specified, AWS Elastic Beanstalk restricts the returned descriptions to those associated with this custom platform version.
*/
PlatformArn?: PlatformArn;
/**
* If specified, AWS Elastic Beanstalk restricts the described events to include only those associated with this request ID.
*/
RequestId?: RequestId;
/**
* If specified, limits the events returned from this call to include only those with the specified severity or higher.
*/
Severity?: EventSeverity;
/**
* If specified, AWS Elastic Beanstalk restricts the returned descriptions to those that occur on or after this time.
*/
StartTime?: TimeFilterStart;
/**
* If specified, AWS Elastic Beanstalk restricts the returned descriptions to those that occur up to, but not including, the EndTime.
*/
EndTime?: TimeFilterEnd;
/**
* Specifies the maximum number of events that can be returned, beginning with the most recent event.
*/
MaxRecords?: MaxRecords;
/**
* Pagination token. If specified, the events return the next batch of results.
*/
NextToken?: Token;
}
export interface DescribeInstancesHealthRequest {
/**
* Specify the AWS Elastic Beanstalk environment by name.
*/
EnvironmentName?: EnvironmentName;
/**
* Specify the AWS Elastic Beanstalk environment by ID.
*/
EnvironmentId?: EnvironmentId;
/**
* Specifies the response elements you wish to receive. To retrieve all attributes, set to All. If no attribute names are specified, returns a list of instances.
*/
AttributeNames?: InstancesHealthAttributes;
/**
* Specify the pagination token returned by a previous call.
*/
NextToken?: NextToken;
}
export interface DescribeInstancesHealthResult {
/**
* Detailed health information about each instance. The output differs slightly between Linux and Windows environments. There is a difference in the members that are supported under the <CPUUtilization> type.
*/
InstanceHealthList?: InstanceHealthList;
/**
* The date and time that the health information was retrieved.
*/
RefreshedAt?: RefreshedAt;
/**
* Pagination token for the next page of results, if available.
*/
NextToken?: NextToken;
}
export interface DescribePlatformVersionRequest {
/**
* The ARN of the platform version.
*/
PlatformArn?: PlatformArn;
}
export interface DescribePlatformVersionResult {
/**
* Detailed information about the platform version.
*/
PlatformDescription?: PlatformDescription;
}
export type Description = string;
export interface DisassociateEnvironmentOperationsRoleMessage {
/**
* The name of the environment from which to disassociate the operations role.
*/
EnvironmentName: EnvironmentName;
}
export type Ec2InstanceId = string;
export type EndpointURL = string;
export type EnvironmentArn = string;
export interface EnvironmentDescription {
/**
* The name of this environment.
*/
EnvironmentName?: EnvironmentName;
/**
* The ID of this environment.
*/
EnvironmentId?: EnvironmentId;
/**
* The name of the application associated with this environment.
*/
ApplicationName?: ApplicationName;
/**
* The application version deployed in this environment.
*/
VersionLabel?: VersionLabel;
/**
* The name of the SolutionStack deployed with this environment.
*/
SolutionStackName?: SolutionStackName;
/**
* The ARN of the platform version.
*/
PlatformArn?: PlatformArn;
/**
* The name of the configuration template used to originally launch this environment.
*/
TemplateName?: ConfigurationTemplateName;
/**
* Describes this environment.
*/
Description?: Description;
/**
* For load-balanced, autoscaling environments, the URL to the LoadBalancer. For single-instance environments, the IP address of the instance.
*/
EndpointURL?: EndpointURL;
/**
* The URL to the CNAME for this environment.
*/
CNAME?: DNSCname;
/**
* The creation date for this environment.
*/
DateCreated?: CreationDate;
/**
* The last modified date for this environment.
*/
DateUpdated?: UpdateDate;
/**
* The current operational status of the environment: Launching: Environment is in the process of initial deployment. Updating: Environment is in the process of updating its configuration settings or application version. Ready: Environment is available to have an action performed on it, such as update or terminate. Terminating: Environment is in the shut-down process. Terminated: Environment is not running.
*/
Status?: EnvironmentStatus;
/**
* Indicates if there is an in-progress environment configuration update or application version deployment that you can cancel. true: There is an update in progress. false: There are no updates currently in progress.
*/
AbortableOperationInProgress?: AbortableOperationInProgress;
/**
* Describes the health status of the environment. AWS Elastic Beanstalk indicates the failure levels for a running environment: Red: Indicates the environment is not responsive. Occurs when three or more consecutive failures occur for an environment. Yellow: Indicates that something is wrong. Occurs when two consecutive failures occur for an environment. Green: Indicates the environment is healthy and fully functional. Grey: Default health for a new environment. The environment is not fully launched and health checks have not started or health checks are suspended during an UpdateEnvironment or RestartEnvironment request. Default: Grey
*/
Health?: EnvironmentHealth;
/**
* Returns the health status of the application running in your environment. For more information, see Health Colors and Statuses.
*/
HealthStatus?: EnvironmentHealthStatus;
/**
* The description of the AWS resources used by this environment.
*/
Resources?: EnvironmentResourcesDescription;
/**
* Describes the current tier of this environment.
*/
Tier?: EnvironmentTier;
/**
* A list of links to other environments in the same group.
*/
EnvironmentLinks?: EnvironmentLinks;
/**
* The environment's Amazon Resource Name (ARN), which can be used in other API requests that require an ARN.
*/
EnvironmentArn?: EnvironmentArn;
/**
* The Amazon Resource Name (ARN) of the environment's operations role. For more information, see Operations roles in the AWS Elastic Beanstalk Developer Guide.
*/
OperationsRole?: OperationsRole;
}
export type EnvironmentDescriptionsList = EnvironmentDescription[];
export interface EnvironmentDescriptionsMessage {
/**
* Returns an EnvironmentDescription list.
*/
Environments?: EnvironmentDescriptionsList;
/**
* In a paginated request, the token that you can pass in a subsequent request to get the next response page.
*/
NextToken?: Token;
}
export type EnvironmentHealth = "Green"|"Yellow"|"Red"|"Grey"|string;
export type EnvironmentHealthAttribute = "Status"|"Color"|"Causes"|"ApplicationMetrics"|"InstancesHealth"|"All"|"HealthStatus"|"RefreshedAt"|string;
export type EnvironmentHealthAttributes = EnvironmentHealthAttribute[];
export type EnvironmentHealthStatus = "NoData"|"Unknown"|"Pending"|"Ok"|"Info"|"Warning"|"Degraded"|"Severe"|"Suspended"|string;
export type EnvironmentId = string;
export type EnvironmentIdList = EnvironmentId[];
export interface EnvironmentInfoDescription {
/**
* The type of information retrieved.
*/
InfoType?: EnvironmentInfoType;
/**
* The Amazon EC2 Instance ID for this information.
*/
Ec2InstanceId?: Ec2InstanceId;
/**
* The time stamp when this information was retrieved.
*/
SampleTimestamp?: SampleTimestamp;
/**
* The retrieved information. Currently contains a presigned Amazon S3 URL. The files are deleted after 15 minutes. Anyone in possession of this URL can access the files before they are deleted. Make the URL available only to trusted parties.
*/
Message?: Message;
}
export type EnvironmentInfoDescriptionList = EnvironmentInfoDescription[];
export type EnvironmentInfoType = "tail"|"bundle"|string;
export interface EnvironmentLink {
/**
* The name of the link.
*/
LinkName?: String;
/**
* The name of the linked environment (the dependency).
*/
EnvironmentName?: String;
}
export type EnvironmentLinks = EnvironmentLink[];
export type EnvironmentName = string;
export type EnvironmentNamesList = EnvironmentName[];
export interface EnvironmentResourceDescription {
/**
* The name of the environment.
*/
EnvironmentName?: EnvironmentName;
/**
* The AutoScalingGroups used by this environment.
*/
AutoScalingGroups?: AutoScalingGroupList;
/**
* The Amazon EC2 instances used by this environment.
*/
Instances?: InstanceList;
/**
* The Auto Scaling launch configurations in use by this environment.
*/
LaunchConfigurations?: LaunchConfigurationList;
/**
* The Amazon EC2 launch templates in use by this environment.
*/
LaunchTemplates?: LaunchTemplateList;
/**
* The LoadBalancers in use by this environment.
*/
LoadBalancers?: LoadBalancerList;
/**
* The AutoScaling triggers in use by this environment.
*/
Triggers?: TriggerList;
/**
* The queues used by this environment.
*/
Queues?: QueueList;
}
export interface EnvironmentResourceDescriptionsMessage {
/**
* A list of EnvironmentResourceDescription.
*/
EnvironmentResources?: EnvironmentResourceDescription;
}
export interface EnvironmentResourcesDescription {
/**
* Describes the LoadBalancer.
*/
LoadBalancer?: LoadBalancerDescription;
}
export type EnvironmentStatus = "Launching"|"Updating"|"Ready"|"Terminating"|"Terminated"|string;
export interface EnvironmentTier {
/**
* The name of this environment tier. Valid values: For Web server tier – WebServer For Worker tier – Worker
*/
Name?: String;
/**
* The type of this environment tier. Valid values: For Web server tier – Standard For Worker tier – SQS/HTTP
*/
Type?: String;
/**
* The version of this environment tier. When you don't set a value to it, Elastic Beanstalk uses the latest compatible worker tier version. This member is deprecated. Any specific version that you set may become out of date. We recommend leaving it unspecified.
*/
Version?: String;
}
export type EventDate = Date;
export interface EventDescription {
/**
* The date when the event occurred.
*/
EventDate?: EventDate;
/**
* The event message.
*/
Message?: EventMessage;
/**
* The application associated with the event.
*/
ApplicationName?: ApplicationName;
/**
* The release label for the application version associated with this event.
*/
VersionLabel?: VersionLabel;
/**
* The name of the configuration associated with this event.
*/
TemplateName?: ConfigurationTemplateName;
/**
* The name of the environment associated with this event.
*/
EnvironmentName?: EnvironmentName;
/**
* The ARN of the platform version.
*/
PlatformArn?: PlatformArn;
/**
* The web service request ID for the activity of this event.
*/
RequestId?: RequestId;
/**
* The severity level of this event.
*/
Severity?: EventSeverity;
}
export type EventDescriptionList = EventDescription[];
export interface EventDescriptionsMessage {
/**
* A list of EventDescription.
*/
Events?: EventDescriptionList;
/**
* If returned, this indicates that there are more results to obtain. Use this token in the next DescribeEvents call to get the next batch of events.
*/
NextToken?: Token;
}
export type EventMessage = string;
export type EventSeverity = "TRACE"|"DEBUG"|"INFO"|"WARN"|"ERROR"|"FATAL"|string;
export type FailureType = "UpdateCancelled"|"CancellationFailed"|"RollbackFailed"|"RollbackSuccessful"|"InternalFailure"|"InvalidEnvironmentState"|"PermissionsError"|string;
export type FileTypeExtension = string;
export type ForceTerminate = boolean;
export type GroupName = string;
export type ImageId = string;
export type IncludeDeleted = boolean;
export type IncludeDeletedBackTo = Date;
export interface Instance {
/**
* The ID of the Amazon EC2 instance.
*/
Id?: ResourceId;
}
export type InstanceHealthList = SingleInstanceHealth[];
export interface InstanceHealthSummary {
/**
* Grey. AWS Elastic Beanstalk and the health agent are reporting no data on an instance.
*/
NoData?: NullableInteger;
/**
* Grey. AWS Elastic Beanstalk and the health agent are reporting an insufficient amount of data on an instance.
*/
Unknown?: NullableInteger;
/**
* Grey. An operation is in progress on an instance within the command timeout.
*/
Pending?: NullableInteger;
/**
* Green. An instance is passing health checks and the health agent is not reporting any problems.
*/
Ok?: NullableInteger;
/**
* Green. An operation is in progress on an instance.
*/
Info?: NullableInteger;
/**
* Yellow. The health agent is reporting a moderate number of request failures or other issues for an instance or environment.
*/
Warning?: NullableInteger;
/**
* Red. The health agent is reporting a high number of request failures or other issues for an instance or environment.
*/
Degraded?: NullableInteger;
/**
* Red. The health agent is reporting a very high number of request failures or other issues for an instance or environment.
*/
Severe?: NullableInteger;
}
export type InstanceId = string;
export type InstanceList = Instance[];
export type InstancesHealthAttribute = "HealthStatus"|"Color"|"Causes"|"ApplicationMetrics"|"RefreshedAt"|"LaunchedAt"|"System"|"Deployment"|"AvailabilityZone"|"InstanceType"|"All"|string;
export type InstancesHealthAttributes = InstancesHealthAttribute[];
export type Integer = number;
export interface Latency {
/**
* The average latency for the slowest 0.1 percent of requests over the last 10 seconds.
*/
P999?: NullableDouble;
/**
* The average latency for the slowest 1 percent of requests over the last 10 seconds.
*/
P99?: NullableDouble;
/**
* The average latency for the slowest 5 percent of requests over the last 10 seconds.
*/
P95?: NullableDouble;
/**
* The average latency for the slowest 10 percent of requests over the last 10 seconds.
*/
P90?: NullableDouble;
/**
* The average latency for the slowest 15 percent of requests over the last 10 seconds.
*/
P85?: NullableDouble;
/**
* The average latency for the slowest 25 percent of requests over the last 10 seconds.
*/
P75?: NullableDouble;
/**
* The average latency for the slowest 50 percent of requests over the last 10 seconds.
*/
P50?: NullableDouble;
/**
* The average latency for the slowest 90 percent of requests over the last 10 seconds.
*/
P10?: NullableDouble;
}
export interface LaunchConfiguration {
/**
* The name of the launch configuration.
*/
Name?: ResourceId;
}
export type LaunchConfigurationList = LaunchConfiguration[];
export interface LaunchTemplate {
/**
* The ID of the launch template.
*/
Id?: ResourceId;
}
export type LaunchTemplateList = LaunchTemplate[];
export type LaunchedAt = Date;
export interface ListAvailableSolutionStacksResultMessage {
/**
* A list of available solution stacks.
*/
SolutionStacks?: AvailableSolutionStackNamesList;
/**
* A list of available solution stacks and their SolutionStackDescription.
*/
SolutionStackDetails?: AvailableSolutionStackDetailsList;
}
export interface ListPlatformBranchesRequest {
/**
* Criteria for restricting the resulting list of platform branches. The filter is evaluated as a logical conjunction (AND) of the separate SearchFilter terms. The following list shows valid attribute values for each of the SearchFilter terms. Most operators take a single value. The in and not_in operators can take multiple values. Attribute = BranchName: Operator: = | != | begins_with | ends_with | contains | in | not_in Attribute = LifecycleState: Operator: = | != | in | not_in Values: beta | supported | deprecated | retired Attribute = PlatformName: Operator: = | != | begins_with | ends_with | contains | in | not_in Attribute = TierType: Operator: = | != Values: WebServer/Standard | Worker/SQS/HTTP Array size: limited to 10 SearchFilter objects. Within each SearchFilter item, the Values array is limited to 10 items.
*/
Filters?: SearchFilters;
/**
* The maximum number of platform branch values returned in one call.
*/
MaxRecords?: PlatformBranchMaxRecords;
/**
* For a paginated request. Specify a token from a previous response page to retrieve the next response page. All other parameter values must be identical to the ones specified in the initial request. If no NextToken is specified, the first page is retrieved.
*/
NextToken?: Token;
}
export interface ListPlatformBranchesResult {
/**
* Summary information about the platform branches.
*/
PlatformBranchSummaryList?: PlatformBranchSummaryList;
/**
* In a paginated request, if this value isn't null, it's the token that you can pass in a subsequent request to get the next response page.
*/
NextToken?: Token;
}
export interface ListPlatformVersionsRequest {
/**
* Criteria for restricting the resulting list of platform versions. The filter is interpreted as a logical conjunction (AND) of the separate PlatformFilter terms.
*/
Filters?: PlatformFilters;
/**
* The maximum number of platform version values returned in one call.
*/
MaxRecords?: PlatformMaxRecords;
/**
* For a paginated request. Specify a token from a previous response page to retrieve the next response page. All other parameter values must be identical to the ones specified in the initial request. If no NextToken is specified, the first page is retrieved.
*/
NextToken?: Token;
}
export interface ListPlatformVersionsResult {
/**
* Summary information about the platform versions.
*/
PlatformSummaryList?: PlatformSummaryList;
/**
* In a paginated request, if this value isn't null, it's the token that you can pass in a subsequent request to get the next response page.
*/
NextToken?: Token;
}
export interface ListTagsForResourceMessage {
/**
* The Amazon Resource Name (ARN) of the resouce for which a tag list is requested. Must be the ARN of an Elastic Beanstalk resource.
*/
ResourceArn: ResourceArn;
}
export interface Listener {
/**
* The protocol that is used by the Listener.
*/
Protocol?: String;
/**
* The port that is used by the Listener.
*/
Port?: Integer;
}
export type LoadAverage = LoadAverageValue[];
export type LoadAverageValue = number;
export interface LoadBalancer {
/**
* The name of the LoadBalancer.
*/
Name?: ResourceId;
}
export interface LoadBalancerDescription {
/**
* The name of the LoadBalancer.
*/
LoadBalancerName?: String;
/**
* The domain name of the LoadBalancer.
*/
Domain?: String;
/**
* A list of Listeners used by the LoadBalancer.
*/
Listeners?: LoadBalancerListenersDescription;
}
export type LoadBalancerList = LoadBalancer[];
export type LoadBalancerListenersDescription = Listener[];
export type Maintainer = string;
export interface ManagedAction {
/**
* A unique identifier for the managed action.
*/
ActionId?: String;
/**
* A description of the managed action.
*/
ActionDescription?: String;
/**
* The type of managed action.
*/
ActionType?: ActionType;
/**
* The status of the managed action. If the action is Scheduled, you can apply it immediately with ApplyEnvironmentManagedAction.
*/
Status?: ActionStatus;
/**
* The start time of the maintenance window in which the managed action will execute.
*/
WindowStartTime?: Timestamp;
}
export interface ManagedActionHistoryItem {
/**
* A unique identifier for the managed action.
*/
ActionId?: String;
/**
* The type of the managed action.
*/
ActionType?: ActionType;
/**
* A description of the managed action.
*/
ActionDescription?: String;
/**
* If the action failed, the type of failure.
*/
FailureType?: FailureType;
/**
* The status of the action.
*/
Status?: ActionHistoryStatus;
/**
* If the action failed, a description of the failure.
*/
FailureDescription?: String;
/**
* The date and time that the action started executing.
*/
ExecutedTime?: Timestamp;
/**
* The date and time that the action finished executing.
*/
FinishedTime?: Timestamp;
}
export type ManagedActionHistoryItems = ManagedActionHistoryItem[];
export type ManagedActions = ManagedAction[];
export interface MaxAgeRule {
/**
* Specify true to apply the rule, or false to disable it.
*/
Enabled: BoxedBoolean;
/**
* Specify the number of days to retain an application versions.
*/
MaxAgeInDays?: BoxedInt;
/**
* Set to true to delete a version's source bundle from Amazon S3 when Elastic Beanstalk deletes the application version.
*/
DeleteSourceFromS3?: BoxedBoolean;
}
export interface MaxCountRule {
/**
* Specify true to apply the rule, or false to disable it.
*/
Enabled: BoxedBoolean;
/**
* Specify the maximum number of application versions to retain.
*/
MaxCount?: BoxedInt;
/**
* Set to true to delete a version's source bundle from Amazon S3 when Elastic Beanstalk deletes the application version.
*/
DeleteSourceFromS3?: BoxedBoolean;
}
export type MaxRecords = number;
export type Message = string;
export type NextToken = string;
export type NonEmptyString = string;
export type NullableDouble = number;
export type NullableInteger = number;
export type NullableLong = number;
export type OperatingSystemName = string;
export type OperatingSystemVersion = string;
export type OperationsRole = string;
export type OptionNamespace = string;
export type OptionRestrictionMaxLength = number;
export type OptionRestrictionMaxValue = number;
export type OptionRestrictionMinValue = number;
export interface OptionRestrictionRegex {
/**
* The regular expression pattern that a string configuration option value with this restriction must match.
*/
Pattern?: RegexPattern;
/**
* A unique name representing this regular expression.
*/
Label?: RegexLabel;
}
export interface OptionSpecification {
/**
* A unique resource name for a time-based scaling configuration option.
*/
ResourceName?: ResourceName;
/**
* A unique namespace identifying the option's associated AWS resource.
*/
Namespace?: OptionNamespace;
/**
* The name of the configuration option.
*/
OptionName?: ConfigurationOptionName;
}
export type OptionsSpecifierList = OptionSpecification[];
export type PlatformArn = string;
export type PlatformBranchLifecycleState = string;
export type PlatformBranchMaxRecords = number;
export interface PlatformBranchSummary {
/**
* The name of the platform to which this platform branch belongs.
*/
PlatformName?: PlatformName;
/**
* The name of the platform branch.
*/
BranchName?: BranchName;
/**
* The support life cycle state of the platform branch. Possible values: beta | supported | deprecated | retired
*/
LifecycleState?: PlatformBranchLifecycleState;
/**
* An ordinal number that designates the order in which platform branches have been added to a platform. This can be helpful, for example, if your code calls the ListPlatformBranches action and then displays a list of platform branches. A larger BranchOrder value designates a newer platform branch within the platform.
*/
BranchOrder?: BranchOrder;
/**
* The environment tiers that platform versions in this branch support. Possible values: WebServer/Standard | Worker/SQS/HTTP
*/
SupportedTierList?: SupportedTierList;
}
export type PlatformBranchSummaryList = PlatformBranchSummary[];
export type PlatformCategory = string;
export interface PlatformDescription {
/**
* The ARN of the platform version.
*/
PlatformArn?: PlatformArn;
/**
* The AWS account ID of the person who created the platform version.
*/
PlatformOwner?: PlatformOwner;
/**
* The name of the platform version.
*/
PlatformName?: PlatformName;
/**
* The version of the platform version.
*/
PlatformVersion?: PlatformVersion;
/**
* The name of the solution stack used by the platform version.
*/
SolutionStackName?: SolutionStackName;
/**
* The status of the platform version.
*/
PlatformStatus?: PlatformStatus;
/**
* The date when the platform version was created.
*/
DateCreated?: CreationDate;
/**
* The date when the platform version was last updated.
*/
DateUpdated?: UpdateDate;
/**
* The category of the platform version.
*/
PlatformCategory?: PlatformCategory;
/**
* The description of the platform version.
*/
Description?: Description;
/**
* Information about the maintainer of the platform version.
*/
Maintainer?: Maintainer;
/**
* The operating system used by the platform version.
*/
OperatingSystemName?: OperatingSystemName;
/**
* The version of the operating system used by the platform version.
*/
OperatingSystemVersion?: OperatingSystemVersion;
/**
* The programming languages supported by the platform version.
*/
ProgrammingLanguages?: PlatformProgrammingLanguages;
/**
* The frameworks supported by the platform version.
*/
Frameworks?: PlatformFrameworks;
/**
* The custom AMIs supported by the platform version.
*/
CustomAmiList?: CustomAmiList;
/**
* The tiers supported by the platform version.
*/
SupportedTierList?: SupportedTierList;
/**
* The additions supported by the platform version.
*/
SupportedAddonList?: SupportedAddonList;
/**
* The state of the platform version in its lifecycle. Possible values: Recommended | null If a null value is returned, the platform version isn't the recommended one for its branch. Each platform branch has a single recommended platform version, typically the most recent one.
*/
PlatformLifecycleState?: PlatformLifecycleState;
/**
* The platform branch to which the platform version belongs.
*/
PlatformBranchName?: BranchName;
/**
* The state of the platform version's branch in its lifecycle. Possible values: Beta | Supported | Deprecated | Retired
*/
PlatformBranchLifecycleState?: PlatformBranchLifecycleState;
}
export interface PlatformFilter {
/**
* The platform version attribute to which the filter values are applied. Valid values: PlatformName | PlatformVersion | PlatformStatus | PlatformBranchName | PlatformLifecycleState | PlatformOwner | SupportedTier | SupportedAddon | ProgrammingLanguageName | OperatingSystemName
*/
Type?: PlatformFilterType;
/**
* The operator to apply to the Type with each of the Values. Valid values: = | != | < | <= | > | >= | contains | begins_with | ends_with
*/
Operator?: PlatformFilterOperator;
/**
* The list of values applied to the filtering platform version attribute. Only one value is supported for all current operators. The following list shows valid filter values for some filter attributes. PlatformStatus: Creating | Failed | Ready | Deleting | Deleted PlatformLifecycleState: recommended SupportedTier: WebServer/Standard | Worker/SQS/HTTP SupportedAddon: Log/S3 | Monitoring/Healthd | WorkerDaemon/SQSD
*/
Values?: PlatformFilterValueList;
}
export type PlatformFilterOperator = string;
export type PlatformFilterType = string;
export type PlatformFilterValue = string;
export type PlatformFilterValueList = PlatformFilterValue[];
export type PlatformFilters = PlatformFilter[];
export interface PlatformFramework {
/**
* The name of the framework.
*/
Name?: String;
/**
* The version of the framework.
*/
Version?: String;
}
export type PlatformFrameworks = PlatformFramework[];
export type PlatformLifecycleState = string;
export type PlatformMaxRecords = number;
export type PlatformName = string;
export type PlatformOwner = string;
export interface PlatformProgrammingLanguage {
/**
* The name of the programming language.
*/
Name?: String;
/**
* The version of the programming language.
*/
Version?: String;
}
export type PlatformProgrammingLanguages = PlatformProgrammingLanguage[];
export type PlatformStatus = "Creating"|"Failed"|"Ready"|"Deleting"|"Deleted"|string;
export interface PlatformSummary {
/**
* The ARN of the platform version.
*/
PlatformArn?: PlatformArn;
/**
* The AWS account ID of the person who created the platform version.
*/
PlatformOwner?: PlatformOwner;
/**
* The status of the platform version. You can create an environment from the platform version once it is ready.
*/
PlatformStatus?: PlatformStatus;
/**
* The category of platform version.
*/
PlatformCategory?: PlatformCategory;
/**
* The operating system used by the platform version.
*/
OperatingSystemName?: OperatingSystemName;
/**
* The version of the operating system used by the platform version.
*/
OperatingSystemVersion?: OperatingSystemVersion;
/**
* The tiers in which the platform version runs.
*/
SupportedTierList?: SupportedTierList;
/**
* The additions associated with the platform version.
*/
SupportedAddonList?: SupportedAddonList;
/**
* The state of the platform version in its lifecycle. Possible values: recommended | empty If an empty value is returned, the platform version is supported but isn't the recommended one for its branch.
*/
PlatformLifecycleState?: PlatformLifecycleState;
/**
* The version string of the platform version.
*/
PlatformVersion?: PlatformVersion;
/**
* The platform branch to which the platform version belongs.
*/
PlatformBranchName?: BranchName;
/**
* The state of the platform version's branch in its lifecycle. Possible values: beta | supported | deprecated | retired
*/
PlatformBranchLifecycleState?: PlatformBranchLifecycleState;
}
export type PlatformSummaryList = PlatformSummary[];
export type PlatformVersion = string;
export interface Queue {
/**
* The name of the queue.
*/
Name?: String;
/**
* The URL of the queue.
*/
URL?: String;
}
export type QueueList = Queue[];
export interface RebuildEnvironmentMessage {
/**
* The ID of the environment to rebuild. Condition: You must specify either this or an EnvironmentName, or both. If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error.
*/
EnvironmentId?: EnvironmentId;
/**
* The name of the environment to rebuild. Condition: You must specify either this or an EnvironmentId, or both. If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error.
*/
EnvironmentName?: EnvironmentName;
}
export type RefreshedAt = Date;
export type RegexLabel = string;
export type RegexPattern = string;
export type RequestCount = number;
export interface RequestEnvironmentInfoMessage {
/**
* The ID of the environment of the requested data. If no such environment is found, RequestEnvironmentInfo returns an InvalidParameterValue error. Condition: You must specify either this or an EnvironmentName, or both. If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error.
*/
EnvironmentId?: EnvironmentId;
/**
* The name of the environment of the requested data. If no such environment is found, RequestEnvironmentInfo returns an InvalidParameterValue error. Condition: You must specify either this or an EnvironmentId, or both. If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error.
*/
EnvironmentName?: EnvironmentName;
/**
* The type of information to request.
*/
InfoType: EnvironmentInfoType;
}
export type RequestId = string;
export type ResourceArn = string;
export type ResourceId = string;
export type ResourceName = string;
export interface ResourceQuota {
/**
* The maximum number of instances of this Elastic Beanstalk resource type that an AWS account can use.
*/
Maximum?: BoxedInt;
}
export interface ResourceQuotas {
/**
* The quota for applications in the AWS account.
*/
ApplicationQuota?: ResourceQuota;
/**
* The quota for application versions in the AWS account.
*/
ApplicationVersionQuota?: ResourceQuota;
/**
* The quota for environments in the AWS account.
*/
EnvironmentQuota?: ResourceQuota;
/**
* The quota for configuration templates in the AWS account.
*/
ConfigurationTemplateQuota?: ResourceQuota;
/**
* The quota for custom platforms in the AWS account.
*/
CustomPlatformQuota?: ResourceQuota;
}
export interface ResourceTagsDescriptionMessage {
/**
* The Amazon Resource Name (ARN) of the resource for which a tag list was requested.
*/
ResourceArn?: ResourceArn;
/**
* A list of tag key-value pairs.
*/
ResourceTags?: TagList;
}
export interface RestartAppServerMessage {
/**
* The ID of the environment to restart the server for. Condition: You must specify either this or an EnvironmentName, or both. If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error.
*/
EnvironmentId?: EnvironmentId;
/**
* The name of the environment to restart the server for. Condition: You must specify either this or an EnvironmentId, or both. If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error.
*/
EnvironmentName?: EnvironmentName;
}
export interface RetrieveEnvironmentInfoMessage {
/**
* The ID of the data's environment. If no such environment is found, returns an InvalidParameterValue error. Condition: You must specify either this or an EnvironmentName, or both. If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error.
*/
EnvironmentId?: EnvironmentId;
/**
* The name of the data's environment. If no such environment is found, returns an InvalidParameterValue error. Condition: You must specify either this or an EnvironmentId, or both. If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error.
*/
EnvironmentName?: EnvironmentName;
/**
* The type of information to retrieve.
*/
InfoType: EnvironmentInfoType;
}
export interface RetrieveEnvironmentInfoResultMessage {
/**
* The EnvironmentInfoDescription of the environment.
*/
EnvironmentInfo?: EnvironmentInfoDescriptionList;
}
export type S3Bucket = string;
export type S3Key = string;
export interface S3Location {
/**
* The Amazon S3 bucket where the data is located.
*/
S3Bucket?: S3Bucket;
/**
* The Amazon S3 key where the data is located.
*/
S3Key?: S3Key;
}
export type SampleTimestamp = Date;
export interface SearchFilter {
/**
* The result attribute to which the filter values are applied. Valid values vary by API action.
*/
Attribute?: SearchFilterAttribute;
/**
* The operator to apply to the Attribute with each of the Values. Valid values vary by Attribute.
*/
Operator?: SearchFilterOperator;
/**
* The list of values applied to the Attribute and Operator attributes. Number of values and valid values vary by Attribute.
*/
Values?: SearchFilterValues;
}
export type SearchFilterAttribute = string;
export type SearchFilterOperator = string;
export type SearchFilterValue = string;
export type SearchFilterValues = SearchFilterValue[];
export type SearchFilters = SearchFilter[];
export interface SingleInstanceHealth {
/**
* The ID of the Amazon EC2 instance.
*/
InstanceId?: InstanceId;
/**
* Returns the health status of the specified instance. For more information, see Health Colors and Statuses.
*/
HealthStatus?: String;
/**
* Represents the color indicator that gives you information about the health of the EC2 instance. For more information, see Health Colors and Statuses.
*/
Color?: String;
/**
* Represents the causes, which provide more information about the current health status.
*/
Causes?: Causes;
/**
* The time at which the EC2 instance was launched.
*/
LaunchedAt?: LaunchedAt;
/**
* Request metrics from your application.
*/
ApplicationMetrics?: ApplicationMetrics;
/**
* Operating system metrics from the instance.
*/
System?: SystemStatus;
/**
* Information about the most recent deployment to an instance.
*/
Deployment?: Deployment;
/**
* The availability zone in which the instance runs.
*/
AvailabilityZone?: String;
/**
* The instance's type.
*/
InstanceType?: String;
}
export interface SolutionStackDescription {
/**
* The name of the solution stack.
*/
SolutionStackName?: SolutionStackName;
/**
* The permitted file types allowed for a solution stack.
*/
PermittedFileTypes?: SolutionStackFileTypeList;
}
export type SolutionStackFileTypeList = FileTypeExtension[];
export type SolutionStackName = string;
export interface SourceBuildInformation {
/**
* The type of repository. Git Zip
*/
SourceType: SourceType;
/**
* Location where the repository is stored. CodeCommit S3
*/
SourceRepository: SourceRepository;
/**
* The location of the source code, as a formatted string, depending on the value of SourceRepository For CodeCommit, the format is the repository name and commit ID, separated by a forward slash. For example, my-git-repo/265cfa0cf6af46153527f55d6503ec030551f57a. For S3, the format is the S3 bucket name and object key, separated by a forward slash. For example, my-s3-bucket/Folders/my-source-file.
*/
SourceLocation: SourceLocation;
}
export interface SourceConfiguration {
/**
* The name of the application associated with the configuration.
*/
ApplicationName?: ApplicationName;
/**
* The name of the configuration template.
*/
TemplateName?: ConfigurationTemplateName;
}
export type SourceLocation = string;
export type SourceRepository = "CodeCommit"|"S3"|string;
export type SourceType = "Git"|"Zip"|string;
export interface StatusCodes {
/**
* The percentage of requests over the last 10 seconds that resulted in a 2xx (200, 201, etc.) status code.
*/
Status2xx?: NullableInteger;
/**
* The percentage of requests over the last 10 seconds that resulted in a 3xx (300, 301, etc.) status code.
*/
Status3xx?: NullableInteger;
/**
* The percentage of requests over the last 10 seconds that resulted in a 4xx (400, 401, etc.) status code.
*/
Status4xx?: NullableInteger;
/**
* The percentage of requests over the last 10 seconds that resulted in a 5xx (500, 501, etc.) status code.
*/
Status5xx?: NullableInteger;
}
export type String = string;
export type SupportedAddon = string;
export type SupportedAddonList = SupportedAddon[];
export type SupportedTier = string;
export type SupportedTierList = SupportedTier[];
export interface SwapEnvironmentCNAMEsMessage {
/**
* The ID of the source environment. Condition: You must specify at least the SourceEnvironmentID or the SourceEnvironmentName. You may also specify both. If you specify the SourceEnvironmentId, you must specify the DestinationEnvironmentId.
*/
SourceEnvironmentId?: EnvironmentId;
/**
* The name of the source environment. Condition: You must specify at least the SourceEnvironmentID or the SourceEnvironmentName. You may also specify both. If you specify the SourceEnvironmentName, you must specify the DestinationEnvironmentName.
*/
SourceEnvironmentName?: EnvironmentName;
/**
* The ID of the destination environment. Condition: You must specify at least the DestinationEnvironmentID or the DestinationEnvironmentName. You may also specify both. You must specify the SourceEnvironmentId with the DestinationEnvironmentId.
*/
DestinationEnvironmentId?: EnvironmentId;
/**
* The name of the destination environment. Condition: You must specify at least the DestinationEnvironmentID or the DestinationEnvironmentName. You may also specify both. You must specify the SourceEnvironmentName with the DestinationEnvironmentName.
*/
DestinationEnvironmentName?: EnvironmentName;
}
export interface SystemStatus {
/**
* CPU utilization metrics for the instance.
*/
CPUUtilization?: CPUUtilization;
/**
* Load average in the last 1-minute, 5-minute, and 15-minute periods. For more information, see Operating System Metrics.
*/
LoadAverage?: LoadAverage;
}
export interface Tag {
/**
* The key of the tag.
*/
Key?: TagKey;
/**
* The value of the tag.
*/
Value?: TagValue;
}
export type TagKey = string;
export type TagKeyList = TagKey[];
export type TagList = Tag[];
export type TagValue = string;
export type Tags = Tag[];
export type TerminateEnvForce = boolean;
export interface TerminateEnvironmentMessage {
/**
* The ID of the environment to terminate. Condition: You must specify either this or an EnvironmentName, or both. If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error.
*/
EnvironmentId?: EnvironmentId;
/**
* The name of the environment to terminate. Condition: You must specify either this or an EnvironmentId, or both. If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error.
*/
EnvironmentName?: EnvironmentName;
/**
* Indicates whether the associated AWS resources should shut down when the environment is terminated: true: The specified environment as well as the associated AWS resources, such as Auto Scaling group and LoadBalancer, are terminated. false: AWS Elastic Beanstalk resource management is removed from the environment, but the AWS resources continue to operate. For more information, see the AWS Elastic Beanstalk User Guide. Default: true Valid Values: true | false
*/
TerminateResources?: TerminateEnvironmentResources;
/**
* Terminates the target environment even if another environment in the same group is dependent on it.
*/
ForceTerminate?: ForceTerminate;
}
export type TerminateEnvironmentResources = boolean;
export type TimeFilterEnd = Date;
export type TimeFilterStart = Date;
export type Timestamp = Date;
export type Token = string;
export interface Trigger {
/**
* The name of the trigger.
*/
Name?: ResourceId;
}
export type TriggerList = Trigger[];
export interface UpdateApplicationMessage {
/**
* The name of the application to update. If no such application is found, UpdateApplication returns an InvalidParameterValue error.
*/
ApplicationName: ApplicationName;
/**
* A new description for the application. Default: If not specified, AWS Elastic Beanstalk does not update the description.
*/
Description?: Description;
}
export interface UpdateApplicationResourceLifecycleMessage {
/**
* The name of the application.
*/
ApplicationName: ApplicationName;
/**
* The lifecycle configuration.
*/
ResourceLifecycleConfig: ApplicationResourceLifecycleConfig;
}
export interface UpdateApplicationVersionMessage {
/**
* The name of the application associated with this version. If no application is found with this name, UpdateApplication returns an InvalidParameterValue error.
*/
ApplicationName: ApplicationName;
/**
* The name of the version to update. If no application version is found with this label, UpdateApplication returns an InvalidParameterValue error.
*/
VersionLabel: VersionLabel;
/**
* A new description for this version.
*/
Description?: Description;
}
export interface UpdateConfigurationTemplateMessage {
/**
* The name of the application associated with the configuration template to update. If no application is found with this name, UpdateConfigurationTemplate returns an InvalidParameterValue error.
*/
ApplicationName: ApplicationName;
/**
* The name of the configuration template to update. If no configuration template is found with this name, UpdateConfigurationTemplate returns an InvalidParameterValue error.
*/
TemplateName: ConfigurationTemplateName;
/**
* A new description for the configuration.
*/
Description?: Description;
/**
* A list of configuration option settings to update with the new specified option value.
*/
OptionSettings?: ConfigurationOptionSettingsList;
/**
* A list of configuration options to remove from the configuration set. Constraint: You can remove only UserDefined configuration options.
*/
OptionsToRemove?: OptionsSpecifierList;
}
export type UpdateDate = Date;
export interface UpdateEnvironmentMessage {
/**
* The name of the application with which the environment is associated.
*/
ApplicationName?: ApplicationName;
/**
* The ID of the environment to update. If no environment with this ID exists, AWS Elastic Beanstalk returns an InvalidParameterValue error. Condition: You must specify either this or an EnvironmentName, or both. If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error.
*/
EnvironmentId?: EnvironmentId;
/**
* The name of the environment to update. If no environment with this name exists, AWS Elastic Beanstalk returns an InvalidParameterValue error. Condition: You must specify either this or an EnvironmentId, or both. If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error.
*/
EnvironmentName?: EnvironmentName;
/**
* The name of the group to which the target environment belongs. Specify a group name only if the environment's name is specified in an environment manifest and not with the environment name or environment ID parameters. See Environment Manifest (env.yaml) for details.
*/
GroupName?: GroupName;
/**
* If this parameter is specified, AWS Elastic Beanstalk updates the description of this environment.
*/
Description?: Description;
/**
* This specifies the tier to use to update the environment. Condition: At this time, if you change the tier version, name, or type, AWS Elastic Beanstalk returns InvalidParameterValue error.
*/
Tier?: EnvironmentTier;
/**
* If this parameter is specified, AWS Elastic Beanstalk deploys the named application version to the environment. If no such application version is found, returns an InvalidParameterValue error.
*/
VersionLabel?: VersionLabel;
/**
* If this parameter is specified, AWS Elastic Beanstalk deploys this configuration template to the environment. If no such configuration template is found, AWS Elastic Beanstalk returns an InvalidParameterValue error.
*/
TemplateName?: ConfigurationTemplateName;
/**
* This specifies the platform version that the environment will run after the environment is updated.
*/
SolutionStackName?: SolutionStackName;
/**
* The ARN of the platform, if used.
*/
PlatformArn?: PlatformArn;
/**
* If specified, AWS Elastic Beanstalk updates the configuration set associated with the running environment and sets the specified configuration options to the requested value.
*/
OptionSettings?: ConfigurationOptionSettingsList;
/**
* A list of custom user-defined configuration options to remove from the configuration set for this environment.
*/
OptionsToRemove?: OptionsSpecifierList;
}
export interface UpdateTagsForResourceMessage {
/**
* The Amazon Resource Name (ARN) of the resouce to be updated. Must be the ARN of an Elastic Beanstalk resource.
*/
ResourceArn: ResourceArn;
/**
* A list of tags to add or update. If a key of an existing tag is added, the tag's value is updated. Specify at least one of these parameters: TagsToAdd, TagsToRemove.
*/
TagsToAdd?: TagList;
/**
* A list of tag keys to remove. If a tag key doesn't exist, it is silently ignored. Specify at least one of these parameters: TagsToAdd, TagsToRemove.
*/
TagsToRemove?: TagKeyList;
}
export type UserDefinedOption = boolean;
export interface ValidateConfigurationSettingsMessage {
/**
* The name of the application that the configuration template or environment belongs to.
*/
ApplicationName: ApplicationName;
/**
* The name of the configuration template to validate the settings against. Condition: You cannot specify both this and an environment name.
*/
TemplateName?: ConfigurationTemplateName;
/**
* The name of the environment to validate the settings against. Condition: You cannot specify both this and a configuration template name.
*/
EnvironmentName?: EnvironmentName;
/**
* A list of the options and desired values to evaluate.
*/
OptionSettings: ConfigurationOptionSettingsList;
}
export interface ValidationMessage {
/**
* A message describing the error or warning.
*/
Message?: ValidationMessageString;
/**
* An indication of the severity of this message: error: This message indicates that this is not a valid setting for an option. warning: This message is providing information you should take into account.
*/
Severity?: ValidationSeverity;
/**
* The namespace to which the option belongs.
*/
Namespace?: OptionNamespace;
/**
* The name of the option.
*/
OptionName?: ConfigurationOptionName;
}
export type ValidationMessageString = string;
export type ValidationMessagesList = ValidationMessage[];
export type ValidationSeverity = "error"|"warning"|string;
export type VersionLabel = string;
export type VersionLabels = VersionLabel[];
export type VersionLabelsList = VersionLabel[];
export type VirtualizationType = string;
/**
* A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
*/
export type apiVersion = "2010-12-01"|"latest"|string;
export interface ClientApiVersions {
/**
* A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
*/
apiVersion?: apiVersion;
}
export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions;
/**
* Contains interfaces for use with the ElasticBeanstalk client.
*/
export import Types = ElasticBeanstalk;
}
export = ElasticBeanstalk;