emr.d.ts
130 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
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';
interface Blob {}
declare class EMR extends Service {
/**
* Constructs a service object. This object has one method for each API operation.
*/
constructor(options?: EMR.Types.ClientConfiguration)
config: Config & EMR.Types.ClientConfiguration;
/**
* Adds an instance fleet to a running cluster. The instance fleet configuration is available only in Amazon EMR versions 4.8.0 and later, excluding 5.0.x.
*/
addInstanceFleet(params: EMR.Types.AddInstanceFleetInput, callback?: (err: AWSError, data: EMR.Types.AddInstanceFleetOutput) => void): Request<EMR.Types.AddInstanceFleetOutput, AWSError>;
/**
* Adds an instance fleet to a running cluster. The instance fleet configuration is available only in Amazon EMR versions 4.8.0 and later, excluding 5.0.x.
*/
addInstanceFleet(callback?: (err: AWSError, data: EMR.Types.AddInstanceFleetOutput) => void): Request<EMR.Types.AddInstanceFleetOutput, AWSError>;
/**
* Adds one or more instance groups to a running cluster.
*/
addInstanceGroups(params: EMR.Types.AddInstanceGroupsInput, callback?: (err: AWSError, data: EMR.Types.AddInstanceGroupsOutput) => void): Request<EMR.Types.AddInstanceGroupsOutput, AWSError>;
/**
* Adds one or more instance groups to a running cluster.
*/
addInstanceGroups(callback?: (err: AWSError, data: EMR.Types.AddInstanceGroupsOutput) => void): Request<EMR.Types.AddInstanceGroupsOutput, AWSError>;
/**
* AddJobFlowSteps adds new steps to a running cluster. A maximum of 256 steps are allowed in each job flow. If your cluster is long-running (such as a Hive data warehouse) or complex, you may require more than 256 steps to process your data. You can bypass the 256-step limitation in various ways, including using SSH to connect to the master node and submitting queries directly to the software running on the master node, such as Hive and Hadoop. For more information on how to do this, see Add More than 256 Steps to a Cluster in the Amazon EMR Management Guide. A step specifies the location of a JAR file stored either on the master node of the cluster or in Amazon S3. Each step is performed by the main function of the main class of the JAR file. The main class can be specified either in the manifest of the JAR or by using the MainFunction parameter of the step. Amazon EMR executes each step in the order listed. For a step to be considered complete, the main function must exit with a zero exit code and all Hadoop jobs started while the step was running must have completed and run successfully. You can only add steps to a cluster that is in one of the following states: STARTING, BOOTSTRAPPING, RUNNING, or WAITING.
*/
addJobFlowSteps(params: EMR.Types.AddJobFlowStepsInput, callback?: (err: AWSError, data: EMR.Types.AddJobFlowStepsOutput) => void): Request<EMR.Types.AddJobFlowStepsOutput, AWSError>;
/**
* AddJobFlowSteps adds new steps to a running cluster. A maximum of 256 steps are allowed in each job flow. If your cluster is long-running (such as a Hive data warehouse) or complex, you may require more than 256 steps to process your data. You can bypass the 256-step limitation in various ways, including using SSH to connect to the master node and submitting queries directly to the software running on the master node, such as Hive and Hadoop. For more information on how to do this, see Add More than 256 Steps to a Cluster in the Amazon EMR Management Guide. A step specifies the location of a JAR file stored either on the master node of the cluster or in Amazon S3. Each step is performed by the main function of the main class of the JAR file. The main class can be specified either in the manifest of the JAR or by using the MainFunction parameter of the step. Amazon EMR executes each step in the order listed. For a step to be considered complete, the main function must exit with a zero exit code and all Hadoop jobs started while the step was running must have completed and run successfully. You can only add steps to a cluster that is in one of the following states: STARTING, BOOTSTRAPPING, RUNNING, or WAITING.
*/
addJobFlowSteps(callback?: (err: AWSError, data: EMR.Types.AddJobFlowStepsOutput) => void): Request<EMR.Types.AddJobFlowStepsOutput, AWSError>;
/**
* Adds tags to an Amazon EMR resource. Tags make it easier to associate clusters in various ways, such as grouping clusters to track your Amazon EMR resource allocation costs. For more information, see Tag Clusters.
*/
addTags(params: EMR.Types.AddTagsInput, callback?: (err: AWSError, data: EMR.Types.AddTagsOutput) => void): Request<EMR.Types.AddTagsOutput, AWSError>;
/**
* Adds tags to an Amazon EMR resource. Tags make it easier to associate clusters in various ways, such as grouping clusters to track your Amazon EMR resource allocation costs. For more information, see Tag Clusters.
*/
addTags(callback?: (err: AWSError, data: EMR.Types.AddTagsOutput) => void): Request<EMR.Types.AddTagsOutput, AWSError>;
/**
* Cancels a pending step or steps in a running cluster. Available only in Amazon EMR versions 4.8.0 and later, excluding version 5.0.0. A maximum of 256 steps are allowed in each CancelSteps request. CancelSteps is idempotent but asynchronous; it does not guarantee a step will be canceled, even if the request is successfully submitted. You can only cancel steps that are in a PENDING state.
*/
cancelSteps(params: EMR.Types.CancelStepsInput, callback?: (err: AWSError, data: EMR.Types.CancelStepsOutput) => void): Request<EMR.Types.CancelStepsOutput, AWSError>;
/**
* Cancels a pending step or steps in a running cluster. Available only in Amazon EMR versions 4.8.0 and later, excluding version 5.0.0. A maximum of 256 steps are allowed in each CancelSteps request. CancelSteps is idempotent but asynchronous; it does not guarantee a step will be canceled, even if the request is successfully submitted. You can only cancel steps that are in a PENDING state.
*/
cancelSteps(callback?: (err: AWSError, data: EMR.Types.CancelStepsOutput) => void): Request<EMR.Types.CancelStepsOutput, AWSError>;
/**
* Creates a security configuration, which is stored in the service and can be specified when a cluster is created.
*/
createSecurityConfiguration(params: EMR.Types.CreateSecurityConfigurationInput, callback?: (err: AWSError, data: EMR.Types.CreateSecurityConfigurationOutput) => void): Request<EMR.Types.CreateSecurityConfigurationOutput, AWSError>;
/**
* Creates a security configuration, which is stored in the service and can be specified when a cluster is created.
*/
createSecurityConfiguration(callback?: (err: AWSError, data: EMR.Types.CreateSecurityConfigurationOutput) => void): Request<EMR.Types.CreateSecurityConfigurationOutput, AWSError>;
/**
* Deletes a security configuration.
*/
deleteSecurityConfiguration(params: EMR.Types.DeleteSecurityConfigurationInput, callback?: (err: AWSError, data: EMR.Types.DeleteSecurityConfigurationOutput) => void): Request<EMR.Types.DeleteSecurityConfigurationOutput, AWSError>;
/**
* Deletes a security configuration.
*/
deleteSecurityConfiguration(callback?: (err: AWSError, data: EMR.Types.DeleteSecurityConfigurationOutput) => void): Request<EMR.Types.DeleteSecurityConfigurationOutput, AWSError>;
/**
* Provides cluster-level details including status, hardware and software configuration, VPC settings, and so on.
*/
describeCluster(params: EMR.Types.DescribeClusterInput, callback?: (err: AWSError, data: EMR.Types.DescribeClusterOutput) => void): Request<EMR.Types.DescribeClusterOutput, AWSError>;
/**
* Provides cluster-level details including status, hardware and software configuration, VPC settings, and so on.
*/
describeCluster(callback?: (err: AWSError, data: EMR.Types.DescribeClusterOutput) => void): Request<EMR.Types.DescribeClusterOutput, AWSError>;
/**
* This API is deprecated and will eventually be removed. We recommend you use ListClusters, DescribeCluster, ListSteps, ListInstanceGroups and ListBootstrapActions instead. DescribeJobFlows returns a list of job flows that match all of the supplied parameters. The parameters can include a list of job flow IDs, job flow states, and restrictions on job flow creation date and time. Regardless of supplied parameters, only job flows created within the last two months are returned. If no parameters are supplied, then job flows matching either of the following criteria are returned: Job flows created and completed in the last two weeks Job flows created within the last two months that are in one of the following states: RUNNING, WAITING, SHUTTING_DOWN, STARTING Amazon EMR can return a maximum of 512 job flow descriptions.
*/
describeJobFlows(params: EMR.Types.DescribeJobFlowsInput, callback?: (err: AWSError, data: EMR.Types.DescribeJobFlowsOutput) => void): Request<EMR.Types.DescribeJobFlowsOutput, AWSError>;
/**
* This API is deprecated and will eventually be removed. We recommend you use ListClusters, DescribeCluster, ListSteps, ListInstanceGroups and ListBootstrapActions instead. DescribeJobFlows returns a list of job flows that match all of the supplied parameters. The parameters can include a list of job flow IDs, job flow states, and restrictions on job flow creation date and time. Regardless of supplied parameters, only job flows created within the last two months are returned. If no parameters are supplied, then job flows matching either of the following criteria are returned: Job flows created and completed in the last two weeks Job flows created within the last two months that are in one of the following states: RUNNING, WAITING, SHUTTING_DOWN, STARTING Amazon EMR can return a maximum of 512 job flow descriptions.
*/
describeJobFlows(callback?: (err: AWSError, data: EMR.Types.DescribeJobFlowsOutput) => void): Request<EMR.Types.DescribeJobFlowsOutput, AWSError>;
/**
* Provides the details of a security configuration by returning the configuration JSON.
*/
describeSecurityConfiguration(params: EMR.Types.DescribeSecurityConfigurationInput, callback?: (err: AWSError, data: EMR.Types.DescribeSecurityConfigurationOutput) => void): Request<EMR.Types.DescribeSecurityConfigurationOutput, AWSError>;
/**
* Provides the details of a security configuration by returning the configuration JSON.
*/
describeSecurityConfiguration(callback?: (err: AWSError, data: EMR.Types.DescribeSecurityConfigurationOutput) => void): Request<EMR.Types.DescribeSecurityConfigurationOutput, AWSError>;
/**
* Provides more detail about the cluster step.
*/
describeStep(params: EMR.Types.DescribeStepInput, callback?: (err: AWSError, data: EMR.Types.DescribeStepOutput) => void): Request<EMR.Types.DescribeStepOutput, AWSError>;
/**
* Provides more detail about the cluster step.
*/
describeStep(callback?: (err: AWSError, data: EMR.Types.DescribeStepOutput) => void): Request<EMR.Types.DescribeStepOutput, AWSError>;
/**
* Returns the Amazon EMR block public access configuration for your AWS account in the current Region. For more information see Configure Block Public Access for Amazon EMR in the Amazon EMR Management Guide.
*/
getBlockPublicAccessConfiguration(params: EMR.Types.GetBlockPublicAccessConfigurationInput, callback?: (err: AWSError, data: EMR.Types.GetBlockPublicAccessConfigurationOutput) => void): Request<EMR.Types.GetBlockPublicAccessConfigurationOutput, AWSError>;
/**
* Returns the Amazon EMR block public access configuration for your AWS account in the current Region. For more information see Configure Block Public Access for Amazon EMR in the Amazon EMR Management Guide.
*/
getBlockPublicAccessConfiguration(callback?: (err: AWSError, data: EMR.Types.GetBlockPublicAccessConfigurationOutput) => void): Request<EMR.Types.GetBlockPublicAccessConfigurationOutput, AWSError>;
/**
* Provides information about the bootstrap actions associated with a cluster.
*/
listBootstrapActions(params: EMR.Types.ListBootstrapActionsInput, callback?: (err: AWSError, data: EMR.Types.ListBootstrapActionsOutput) => void): Request<EMR.Types.ListBootstrapActionsOutput, AWSError>;
/**
* Provides information about the bootstrap actions associated with a cluster.
*/
listBootstrapActions(callback?: (err: AWSError, data: EMR.Types.ListBootstrapActionsOutput) => void): Request<EMR.Types.ListBootstrapActionsOutput, AWSError>;
/**
* Provides the status of all clusters visible to this AWS account. Allows you to filter the list of clusters based on certain criteria; for example, filtering by cluster creation date and time or by status. This call returns a maximum of 50 clusters per call, but returns a marker to track the paging of the cluster list across multiple ListClusters calls.
*/
listClusters(params: EMR.Types.ListClustersInput, callback?: (err: AWSError, data: EMR.Types.ListClustersOutput) => void): Request<EMR.Types.ListClustersOutput, AWSError>;
/**
* Provides the status of all clusters visible to this AWS account. Allows you to filter the list of clusters based on certain criteria; for example, filtering by cluster creation date and time or by status. This call returns a maximum of 50 clusters per call, but returns a marker to track the paging of the cluster list across multiple ListClusters calls.
*/
listClusters(callback?: (err: AWSError, data: EMR.Types.ListClustersOutput) => void): Request<EMR.Types.ListClustersOutput, AWSError>;
/**
* Lists all available details about the instance fleets in a cluster. The instance fleet configuration is available only in Amazon EMR versions 4.8.0 and later, excluding 5.0.x versions.
*/
listInstanceFleets(params: EMR.Types.ListInstanceFleetsInput, callback?: (err: AWSError, data: EMR.Types.ListInstanceFleetsOutput) => void): Request<EMR.Types.ListInstanceFleetsOutput, AWSError>;
/**
* Lists all available details about the instance fleets in a cluster. The instance fleet configuration is available only in Amazon EMR versions 4.8.0 and later, excluding 5.0.x versions.
*/
listInstanceFleets(callback?: (err: AWSError, data: EMR.Types.ListInstanceFleetsOutput) => void): Request<EMR.Types.ListInstanceFleetsOutput, AWSError>;
/**
* Provides all available details about the instance groups in a cluster.
*/
listInstanceGroups(params: EMR.Types.ListInstanceGroupsInput, callback?: (err: AWSError, data: EMR.Types.ListInstanceGroupsOutput) => void): Request<EMR.Types.ListInstanceGroupsOutput, AWSError>;
/**
* Provides all available details about the instance groups in a cluster.
*/
listInstanceGroups(callback?: (err: AWSError, data: EMR.Types.ListInstanceGroupsOutput) => void): Request<EMR.Types.ListInstanceGroupsOutput, AWSError>;
/**
* Provides information for all active EC2 instances and EC2 instances terminated in the last 30 days, up to a maximum of 2,000. EC2 instances in any of the following states are considered active: AWAITING_FULFILLMENT, PROVISIONING, BOOTSTRAPPING, RUNNING.
*/
listInstances(params: EMR.Types.ListInstancesInput, callback?: (err: AWSError, data: EMR.Types.ListInstancesOutput) => void): Request<EMR.Types.ListInstancesOutput, AWSError>;
/**
* Provides information for all active EC2 instances and EC2 instances terminated in the last 30 days, up to a maximum of 2,000. EC2 instances in any of the following states are considered active: AWAITING_FULFILLMENT, PROVISIONING, BOOTSTRAPPING, RUNNING.
*/
listInstances(callback?: (err: AWSError, data: EMR.Types.ListInstancesOutput) => void): Request<EMR.Types.ListInstancesOutput, AWSError>;
/**
* Lists all the security configurations visible to this account, providing their creation dates and times, and their names. This call returns a maximum of 50 clusters per call, but returns a marker to track the paging of the cluster list across multiple ListSecurityConfigurations calls.
*/
listSecurityConfigurations(params: EMR.Types.ListSecurityConfigurationsInput, callback?: (err: AWSError, data: EMR.Types.ListSecurityConfigurationsOutput) => void): Request<EMR.Types.ListSecurityConfigurationsOutput, AWSError>;
/**
* Lists all the security configurations visible to this account, providing their creation dates and times, and their names. This call returns a maximum of 50 clusters per call, but returns a marker to track the paging of the cluster list across multiple ListSecurityConfigurations calls.
*/
listSecurityConfigurations(callback?: (err: AWSError, data: EMR.Types.ListSecurityConfigurationsOutput) => void): Request<EMR.Types.ListSecurityConfigurationsOutput, AWSError>;
/**
* Provides a list of steps for the cluster in reverse order unless you specify stepIds with the request of filter by StepStates. You can specify a maximum of ten stepIDs.
*/
listSteps(params: EMR.Types.ListStepsInput, callback?: (err: AWSError, data: EMR.Types.ListStepsOutput) => void): Request<EMR.Types.ListStepsOutput, AWSError>;
/**
* Provides a list of steps for the cluster in reverse order unless you specify stepIds with the request of filter by StepStates. You can specify a maximum of ten stepIDs.
*/
listSteps(callback?: (err: AWSError, data: EMR.Types.ListStepsOutput) => void): Request<EMR.Types.ListStepsOutput, AWSError>;
/**
* Modifies the number of steps that can be executed concurrently for the cluster specified using ClusterID.
*/
modifyCluster(params: EMR.Types.ModifyClusterInput, callback?: (err: AWSError, data: EMR.Types.ModifyClusterOutput) => void): Request<EMR.Types.ModifyClusterOutput, AWSError>;
/**
* Modifies the number of steps that can be executed concurrently for the cluster specified using ClusterID.
*/
modifyCluster(callback?: (err: AWSError, data: EMR.Types.ModifyClusterOutput) => void): Request<EMR.Types.ModifyClusterOutput, AWSError>;
/**
* Modifies the target On-Demand and target Spot capacities for the instance fleet with the specified InstanceFleetID within the cluster specified using ClusterID. The call either succeeds or fails atomically. The instance fleet configuration is available only in Amazon EMR versions 4.8.0 and later, excluding 5.0.x versions.
*/
modifyInstanceFleet(params: EMR.Types.ModifyInstanceFleetInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Modifies the target On-Demand and target Spot capacities for the instance fleet with the specified InstanceFleetID within the cluster specified using ClusterID. The call either succeeds or fails atomically. The instance fleet configuration is available only in Amazon EMR versions 4.8.0 and later, excluding 5.0.x versions.
*/
modifyInstanceFleet(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* ModifyInstanceGroups modifies the number of nodes and configuration settings of an instance group. The input parameters include the new target instance count for the group and the instance group ID. The call will either succeed or fail atomically.
*/
modifyInstanceGroups(params: EMR.Types.ModifyInstanceGroupsInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* ModifyInstanceGroups modifies the number of nodes and configuration settings of an instance group. The input parameters include the new target instance count for the group and the instance group ID. The call will either succeed or fail atomically.
*/
modifyInstanceGroups(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Creates or updates an automatic scaling policy for a core instance group or task instance group in an Amazon EMR cluster. The automatic scaling policy defines how an instance group dynamically adds and terminates EC2 instances in response to the value of a CloudWatch metric.
*/
putAutoScalingPolicy(params: EMR.Types.PutAutoScalingPolicyInput, callback?: (err: AWSError, data: EMR.Types.PutAutoScalingPolicyOutput) => void): Request<EMR.Types.PutAutoScalingPolicyOutput, AWSError>;
/**
* Creates or updates an automatic scaling policy for a core instance group or task instance group in an Amazon EMR cluster. The automatic scaling policy defines how an instance group dynamically adds and terminates EC2 instances in response to the value of a CloudWatch metric.
*/
putAutoScalingPolicy(callback?: (err: AWSError, data: EMR.Types.PutAutoScalingPolicyOutput) => void): Request<EMR.Types.PutAutoScalingPolicyOutput, AWSError>;
/**
* Creates or updates an Amazon EMR block public access configuration for your AWS account in the current Region. For more information see Configure Block Public Access for Amazon EMR in the Amazon EMR Management Guide.
*/
putBlockPublicAccessConfiguration(params: EMR.Types.PutBlockPublicAccessConfigurationInput, callback?: (err: AWSError, data: EMR.Types.PutBlockPublicAccessConfigurationOutput) => void): Request<EMR.Types.PutBlockPublicAccessConfigurationOutput, AWSError>;
/**
* Creates or updates an Amazon EMR block public access configuration for your AWS account in the current Region. For more information see Configure Block Public Access for Amazon EMR in the Amazon EMR Management Guide.
*/
putBlockPublicAccessConfiguration(callback?: (err: AWSError, data: EMR.Types.PutBlockPublicAccessConfigurationOutput) => void): Request<EMR.Types.PutBlockPublicAccessConfigurationOutput, AWSError>;
/**
* Removes an automatic scaling policy from a specified instance group within an EMR cluster.
*/
removeAutoScalingPolicy(params: EMR.Types.RemoveAutoScalingPolicyInput, callback?: (err: AWSError, data: EMR.Types.RemoveAutoScalingPolicyOutput) => void): Request<EMR.Types.RemoveAutoScalingPolicyOutput, AWSError>;
/**
* Removes an automatic scaling policy from a specified instance group within an EMR cluster.
*/
removeAutoScalingPolicy(callback?: (err: AWSError, data: EMR.Types.RemoveAutoScalingPolicyOutput) => void): Request<EMR.Types.RemoveAutoScalingPolicyOutput, AWSError>;
/**
* Removes tags from an Amazon EMR resource. Tags make it easier to associate clusters in various ways, such as grouping clusters to track your Amazon EMR resource allocation costs. For more information, see Tag Clusters. The following example removes the stack tag with value Prod from a cluster:
*/
removeTags(params: EMR.Types.RemoveTagsInput, callback?: (err: AWSError, data: EMR.Types.RemoveTagsOutput) => void): Request<EMR.Types.RemoveTagsOutput, AWSError>;
/**
* Removes tags from an Amazon EMR resource. Tags make it easier to associate clusters in various ways, such as grouping clusters to track your Amazon EMR resource allocation costs. For more information, see Tag Clusters. The following example removes the stack tag with value Prod from a cluster:
*/
removeTags(callback?: (err: AWSError, data: EMR.Types.RemoveTagsOutput) => void): Request<EMR.Types.RemoveTagsOutput, AWSError>;
/**
* RunJobFlow creates and starts running a new cluster (job flow). The cluster runs the steps specified. After the steps complete, the cluster stops and the HDFS partition is lost. To prevent loss of data, configure the last step of the job flow to store results in Amazon S3. If the JobFlowInstancesConfig KeepJobFlowAliveWhenNoSteps parameter is set to TRUE, the cluster transitions to the WAITING state rather than shutting down after the steps have completed. For additional protection, you can set the JobFlowInstancesConfig TerminationProtected parameter to TRUE to lock the cluster and prevent it from being terminated by API call, user intervention, or in the event of a job flow error. A maximum of 256 steps are allowed in each job flow. If your cluster is long-running (such as a Hive data warehouse) or complex, you may require more than 256 steps to process your data. You can bypass the 256-step limitation in various ways, including using the SSH shell to connect to the master node and submitting queries directly to the software running on the master node, such as Hive and Hadoop. For more information on how to do this, see Add More than 256 Steps to a Cluster in the Amazon EMR Management Guide. For long running clusters, we recommend that you periodically store your results. The instance fleets configuration is available only in Amazon EMR versions 4.8.0 and later, excluding 5.0.x versions. The RunJobFlow request can contain InstanceFleets parameters or InstanceGroups parameters, but not both.
*/
runJobFlow(params: EMR.Types.RunJobFlowInput, callback?: (err: AWSError, data: EMR.Types.RunJobFlowOutput) => void): Request<EMR.Types.RunJobFlowOutput, AWSError>;
/**
* RunJobFlow creates and starts running a new cluster (job flow). The cluster runs the steps specified. After the steps complete, the cluster stops and the HDFS partition is lost. To prevent loss of data, configure the last step of the job flow to store results in Amazon S3. If the JobFlowInstancesConfig KeepJobFlowAliveWhenNoSteps parameter is set to TRUE, the cluster transitions to the WAITING state rather than shutting down after the steps have completed. For additional protection, you can set the JobFlowInstancesConfig TerminationProtected parameter to TRUE to lock the cluster and prevent it from being terminated by API call, user intervention, or in the event of a job flow error. A maximum of 256 steps are allowed in each job flow. If your cluster is long-running (such as a Hive data warehouse) or complex, you may require more than 256 steps to process your data. You can bypass the 256-step limitation in various ways, including using the SSH shell to connect to the master node and submitting queries directly to the software running on the master node, such as Hive and Hadoop. For more information on how to do this, see Add More than 256 Steps to a Cluster in the Amazon EMR Management Guide. For long running clusters, we recommend that you periodically store your results. The instance fleets configuration is available only in Amazon EMR versions 4.8.0 and later, excluding 5.0.x versions. The RunJobFlow request can contain InstanceFleets parameters or InstanceGroups parameters, but not both.
*/
runJobFlow(callback?: (err: AWSError, data: EMR.Types.RunJobFlowOutput) => void): Request<EMR.Types.RunJobFlowOutput, AWSError>;
/**
* SetTerminationProtection locks a cluster (job flow) so the EC2 instances in the cluster cannot be terminated by user intervention, an API call, or in the event of a job-flow error. The cluster still terminates upon successful completion of the job flow. Calling SetTerminationProtection on a cluster is similar to calling the Amazon EC2 DisableAPITermination API on all EC2 instances in a cluster. SetTerminationProtection is used to prevent accidental termination of a cluster and to ensure that in the event of an error, the instances persist so that you can recover any data stored in their ephemeral instance storage. To terminate a cluster that has been locked by setting SetTerminationProtection to true, you must first unlock the job flow by a subsequent call to SetTerminationProtection in which you set the value to false. For more information, seeManaging Cluster Termination in the Amazon EMR Management Guide.
*/
setTerminationProtection(params: EMR.Types.SetTerminationProtectionInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* SetTerminationProtection locks a cluster (job flow) so the EC2 instances in the cluster cannot be terminated by user intervention, an API call, or in the event of a job-flow error. The cluster still terminates upon successful completion of the job flow. Calling SetTerminationProtection on a cluster is similar to calling the Amazon EC2 DisableAPITermination API on all EC2 instances in a cluster. SetTerminationProtection is used to prevent accidental termination of a cluster and to ensure that in the event of an error, the instances persist so that you can recover any data stored in their ephemeral instance storage. To terminate a cluster that has been locked by setting SetTerminationProtection to true, you must first unlock the job flow by a subsequent call to SetTerminationProtection in which you set the value to false. For more information, seeManaging Cluster Termination in the Amazon EMR Management Guide.
*/
setTerminationProtection(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Sets the Cluster$VisibleToAllUsers value, which determines whether the cluster is visible to all IAM users of the AWS account associated with the cluster. Only the IAM user who created the cluster or the AWS account root user can call this action. The default value, true, indicates that all IAM users in the AWS account can perform cluster actions if they have the proper IAM policy permissions. If set to false, only the IAM user that created the cluster can perform actions. This action works on running clusters. You can override the default true setting when you create a cluster by using the VisibleToAllUsers parameter with RunJobFlow.
*/
setVisibleToAllUsers(params: EMR.Types.SetVisibleToAllUsersInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Sets the Cluster$VisibleToAllUsers value, which determines whether the cluster is visible to all IAM users of the AWS account associated with the cluster. Only the IAM user who created the cluster or the AWS account root user can call this action. The default value, true, indicates that all IAM users in the AWS account can perform cluster actions if they have the proper IAM policy permissions. If set to false, only the IAM user that created the cluster can perform actions. This action works on running clusters. You can override the default true setting when you create a cluster by using the VisibleToAllUsers parameter with RunJobFlow.
*/
setVisibleToAllUsers(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* TerminateJobFlows shuts a list of clusters (job flows) down. When a job flow is shut down, any step not yet completed is canceled and the EC2 instances on which the cluster is running are stopped. Any log files not already saved are uploaded to Amazon S3 if a LogUri was specified when the cluster was created. The maximum number of clusters allowed is 10. The call to TerminateJobFlows is asynchronous. Depending on the configuration of the cluster, it may take up to 1-5 minutes for the cluster to completely terminate and release allocated resources, such as Amazon EC2 instances.
*/
terminateJobFlows(params: EMR.Types.TerminateJobFlowsInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* TerminateJobFlows shuts a list of clusters (job flows) down. When a job flow is shut down, any step not yet completed is canceled and the EC2 instances on which the cluster is running are stopped. Any log files not already saved are uploaded to Amazon S3 if a LogUri was specified when the cluster was created. The maximum number of clusters allowed is 10. The call to TerminateJobFlows is asynchronous. Depending on the configuration of the cluster, it may take up to 1-5 minutes for the cluster to completely terminate and release allocated resources, such as Amazon EC2 instances.
*/
terminateJobFlows(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Waits for the clusterRunning state by periodically calling the underlying EMR.describeClusteroperation every 30 seconds (at most 60 times).
*/
waitFor(state: "clusterRunning", params: EMR.Types.DescribeClusterInput & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: EMR.Types.DescribeClusterOutput) => void): Request<EMR.Types.DescribeClusterOutput, AWSError>;
/**
* Waits for the clusterRunning state by periodically calling the underlying EMR.describeClusteroperation every 30 seconds (at most 60 times).
*/
waitFor(state: "clusterRunning", callback?: (err: AWSError, data: EMR.Types.DescribeClusterOutput) => void): Request<EMR.Types.DescribeClusterOutput, AWSError>;
/**
* Waits for the stepComplete state by periodically calling the underlying EMR.describeStepoperation every 30 seconds (at most 60 times).
*/
waitFor(state: "stepComplete", params: EMR.Types.DescribeStepInput & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: EMR.Types.DescribeStepOutput) => void): Request<EMR.Types.DescribeStepOutput, AWSError>;
/**
* Waits for the stepComplete state by periodically calling the underlying EMR.describeStepoperation every 30 seconds (at most 60 times).
*/
waitFor(state: "stepComplete", callback?: (err: AWSError, data: EMR.Types.DescribeStepOutput) => void): Request<EMR.Types.DescribeStepOutput, AWSError>;
/**
* Waits for the clusterTerminated state by periodically calling the underlying EMR.describeClusteroperation every 30 seconds (at most 60 times).
*/
waitFor(state: "clusterTerminated", params: EMR.Types.DescribeClusterInput & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: EMR.Types.DescribeClusterOutput) => void): Request<EMR.Types.DescribeClusterOutput, AWSError>;
/**
* Waits for the clusterTerminated state by periodically calling the underlying EMR.describeClusteroperation every 30 seconds (at most 60 times).
*/
waitFor(state: "clusterTerminated", callback?: (err: AWSError, data: EMR.Types.DescribeClusterOutput) => void): Request<EMR.Types.DescribeClusterOutput, AWSError>;
}
declare namespace EMR {
export type ActionOnFailure = "TERMINATE_JOB_FLOW"|"TERMINATE_CLUSTER"|"CANCEL_AND_WAIT"|"CONTINUE"|string;
export interface AddInstanceFleetInput {
/**
* The unique identifier of the cluster.
*/
ClusterId: XmlStringMaxLen256;
/**
* Specifies the configuration of the instance fleet.
*/
InstanceFleet: InstanceFleetConfig;
}
export interface AddInstanceFleetOutput {
/**
* The unique identifier of the cluster.
*/
ClusterId?: XmlStringMaxLen256;
/**
* The unique identifier of the instance fleet.
*/
InstanceFleetId?: InstanceFleetId;
/**
* The Amazon Resource Name of the cluster.
*/
ClusterArn?: ArnType;
}
export interface AddInstanceGroupsInput {
/**
* Instance groups to add.
*/
InstanceGroups: InstanceGroupConfigList;
/**
* Job flow in which to add the instance groups.
*/
JobFlowId: XmlStringMaxLen256;
}
export interface AddInstanceGroupsOutput {
/**
* The job flow ID in which the instance groups are added.
*/
JobFlowId?: XmlStringMaxLen256;
/**
* Instance group IDs of the newly created instance groups.
*/
InstanceGroupIds?: InstanceGroupIdsList;
/**
* The Amazon Resource Name of the cluster.
*/
ClusterArn?: ArnType;
}
export interface AddJobFlowStepsInput {
/**
* A string that uniquely identifies the job flow. This identifier is returned by RunJobFlow and can also be obtained from ListClusters.
*/
JobFlowId: XmlStringMaxLen256;
/**
* A list of StepConfig to be executed by the job flow.
*/
Steps: StepConfigList;
}
export interface AddJobFlowStepsOutput {
/**
* The identifiers of the list of steps added to the job flow.
*/
StepIds?: StepIdsList;
}
export interface AddTagsInput {
/**
* The Amazon EMR resource identifier to which tags will be added. This value must be a cluster identifier.
*/
ResourceId: ResourceId;
/**
* A list of tags to associate with a cluster and propagate to EC2 instances. Tags are user-defined key/value pairs that consist of a required key string with a maximum of 128 characters, and an optional value string with a maximum of 256 characters.
*/
Tags: TagList;
}
export interface AddTagsOutput {
}
export type AdjustmentType = "CHANGE_IN_CAPACITY"|"PERCENT_CHANGE_IN_CAPACITY"|"EXACT_CAPACITY"|string;
export interface Application {
/**
* The name of the application.
*/
Name?: String;
/**
* The version of the application.
*/
Version?: String;
/**
* Arguments for Amazon EMR to pass to the application.
*/
Args?: StringList;
/**
* This option is for advanced users only. This is meta information about third-party applications that third-party vendors use for testing purposes.
*/
AdditionalInfo?: StringMap;
}
export type ApplicationList = Application[];
export type ArnType = string;
export interface AutoScalingPolicy {
/**
* The upper and lower EC2 instance limits for an automatic scaling policy. Automatic scaling activity will not cause an instance group to grow above or below these limits.
*/
Constraints: ScalingConstraints;
/**
* The scale-in and scale-out rules that comprise the automatic scaling policy.
*/
Rules: ScalingRuleList;
}
export interface AutoScalingPolicyDescription {
/**
* The status of an automatic scaling policy.
*/
Status?: AutoScalingPolicyStatus;
/**
* The upper and lower EC2 instance limits for an automatic scaling policy. Automatic scaling activity will not cause an instance group to grow above or below these limits.
*/
Constraints?: ScalingConstraints;
/**
* The scale-in and scale-out rules that comprise the automatic scaling policy.
*/
Rules?: ScalingRuleList;
}
export type AutoScalingPolicyState = "PENDING"|"ATTACHING"|"ATTACHED"|"DETACHING"|"DETACHED"|"FAILED"|string;
export interface AutoScalingPolicyStateChangeReason {
/**
* The code indicating the reason for the change in status.USER_REQUEST indicates that the scaling policy status was changed by a user. PROVISION_FAILURE indicates that the status change was because the policy failed to provision. CLEANUP_FAILURE indicates an error.
*/
Code?: AutoScalingPolicyStateChangeReasonCode;
/**
* A friendly, more verbose message that accompanies an automatic scaling policy state change.
*/
Message?: String;
}
export type AutoScalingPolicyStateChangeReasonCode = "USER_REQUEST"|"PROVISION_FAILURE"|"CLEANUP_FAILURE"|string;
export interface AutoScalingPolicyStatus {
/**
* Indicates the status of the automatic scaling policy.
*/
State?: AutoScalingPolicyState;
/**
* The reason for a change in status.
*/
StateChangeReason?: AutoScalingPolicyStateChangeReason;
}
export interface BlockPublicAccessConfiguration {
/**
* Indicates whether EMR block public access is enabled (true) or disabled (false). By default, the value is false for accounts that have created EMR clusters before July 2019. For accounts created after this, the default is true.
*/
BlockPublicSecurityGroupRules: Boolean;
/**
* Specifies ports and port ranges that are permitted to have security group rules that allow inbound traffic from all public sources. For example, if Port 23 (Telnet) is specified for PermittedPublicSecurityGroupRuleRanges, Amazon EMR allows cluster creation if a security group associated with the cluster has a rule that allows inbound traffic on Port 23 from IPv4 0.0.0.0/0 or IPv6 port ::/0 as the source. By default, Port 22, which is used for SSH access to the cluster EC2 instances, is in the list of PermittedPublicSecurityGroupRuleRanges.
*/
PermittedPublicSecurityGroupRuleRanges?: PortRanges;
}
export interface BlockPublicAccessConfigurationMetadata {
/**
* The date and time that the configuration was created.
*/
CreationDateTime: _Date;
/**
* The Amazon Resource Name that created or last modified the configuration.
*/
CreatedByArn: ArnType;
}
export type Boolean = boolean;
export type BooleanObject = boolean;
export interface BootstrapActionConfig {
/**
* The name of the bootstrap action.
*/
Name: XmlStringMaxLen256;
/**
* The script run by the bootstrap action.
*/
ScriptBootstrapAction: ScriptBootstrapActionConfig;
}
export type BootstrapActionConfigList = BootstrapActionConfig[];
export interface BootstrapActionDetail {
/**
* A description of the bootstrap action.
*/
BootstrapActionConfig?: BootstrapActionConfig;
}
export type BootstrapActionDetailList = BootstrapActionDetail[];
export interface CancelStepsInfo {
/**
* The encrypted StepId of a step.
*/
StepId?: StepId;
/**
* The status of a CancelSteps Request. The value may be SUBMITTED or FAILED.
*/
Status?: CancelStepsRequestStatus;
/**
* The reason for the failure if the CancelSteps request fails.
*/
Reason?: String;
}
export type CancelStepsInfoList = CancelStepsInfo[];
export interface CancelStepsInput {
/**
* The ClusterID for which specified steps will be canceled. Use RunJobFlow and ListClusters to get ClusterIDs.
*/
ClusterId: XmlStringMaxLen256;
/**
* The list of StepIDs to cancel. Use ListSteps to get steps and their states for the specified cluster.
*/
StepIds: StepIdsList;
/**
* The option to choose for cancelling RUNNING steps. By default, the value is SEND_INTERRUPT.
*/
StepCancellationOption?: StepCancellationOption;
}
export interface CancelStepsOutput {
/**
* A list of CancelStepsInfo, which shows the status of specified cancel requests for each StepID specified.
*/
CancelStepsInfoList?: CancelStepsInfoList;
}
export type CancelStepsRequestStatus = "SUBMITTED"|"FAILED"|string;
export interface CloudWatchAlarmDefinition {
/**
* Determines how the metric specified by MetricName is compared to the value specified by Threshold.
*/
ComparisonOperator: ComparisonOperator;
/**
* The number of periods, in five-minute increments, during which the alarm condition must exist before the alarm triggers automatic scaling activity. The default value is 1.
*/
EvaluationPeriods?: Integer;
/**
* The name of the CloudWatch metric that is watched to determine an alarm condition.
*/
MetricName: String;
/**
* The namespace for the CloudWatch metric. The default is AWS/ElasticMapReduce.
*/
Namespace?: String;
/**
* The period, in seconds, over which the statistic is applied. EMR CloudWatch metrics are emitted every five minutes (300 seconds), so if an EMR CloudWatch metric is specified, specify 300.
*/
Period: Integer;
/**
* The statistic to apply to the metric associated with the alarm. The default is AVERAGE.
*/
Statistic?: Statistic;
/**
* The value against which the specified statistic is compared.
*/
Threshold: NonNegativeDouble;
/**
* The unit of measure associated with the CloudWatch metric being watched. The value specified for Unit must correspond to the units specified in the CloudWatch metric.
*/
Unit?: Unit;
/**
* A CloudWatch metric dimension.
*/
Dimensions?: MetricDimensionList;
}
export interface Cluster {
/**
* The unique identifier for the cluster.
*/
Id?: ClusterId;
/**
* The name of the cluster.
*/
Name?: String;
/**
* The current status details about the cluster.
*/
Status?: ClusterStatus;
/**
* Provides information about the EC2 instances in a cluster grouped by category. For example, key name, subnet ID, IAM instance profile, and so on.
*/
Ec2InstanceAttributes?: Ec2InstanceAttributes;
/**
* The instance fleet configuration is available only in Amazon EMR versions 4.8.0 and later, excluding 5.0.x versions. The instance group configuration of the cluster. A value of INSTANCE_GROUP indicates a uniform instance group configuration. A value of INSTANCE_FLEET indicates an instance fleets configuration.
*/
InstanceCollectionType?: InstanceCollectionType;
/**
* The path to the Amazon S3 location where logs for this cluster are stored.
*/
LogUri?: String;
/**
* The AMI version requested for this cluster.
*/
RequestedAmiVersion?: String;
/**
* The AMI version running on this cluster.
*/
RunningAmiVersion?: String;
/**
* The Amazon EMR release label, which determines the version of open-source application packages installed on the cluster. Release labels are in the form emr-x.x.x, where x.x.x is an Amazon EMR release version such as emr-5.14.0. For more information about Amazon EMR release versions and included application versions and features, see https://docs.aws.amazon.com/emr/latest/ReleaseGuide/. The release label applies only to Amazon EMR releases version 4.0 and later. Earlier versions use AmiVersion.
*/
ReleaseLabel?: String;
/**
* Specifies whether the cluster should terminate after completing all steps.
*/
AutoTerminate?: Boolean;
/**
* Indicates whether Amazon EMR will lock the cluster to prevent the EC2 instances from being terminated by an API call or user intervention, or in the event of a cluster error.
*/
TerminationProtected?: Boolean;
/**
* Indicates whether the cluster is visible to all IAM users of the AWS account associated with the cluster. The default value, true, indicates that all IAM users in the AWS account can perform cluster actions if they have the proper IAM policy permissions. If this value is false, only the IAM user that created the cluster can perform actions. This value can be changed on a running cluster by using the SetVisibleToAllUsers action. You can override the default value of true when you create a cluster by using the VisibleToAllUsers parameter of the RunJobFlow action.
*/
VisibleToAllUsers?: Boolean;
/**
* The applications installed on this cluster.
*/
Applications?: ApplicationList;
/**
* A list of tags associated with a cluster.
*/
Tags?: TagList;
/**
* The IAM role that will be assumed by the Amazon EMR service to access AWS resources on your behalf.
*/
ServiceRole?: String;
/**
* An approximation of the cost of the cluster, represented in m1.small/hours. This value is incremented one time for every hour an m1.small instance runs. Larger instances are weighted more, so an EC2 instance that is roughly four times more expensive would result in the normalized instance hours being incremented by four. This result is only an approximation and does not reflect the actual billing rate.
*/
NormalizedInstanceHours?: Integer;
/**
* The DNS name of the master node. If the cluster is on a private subnet, this is the private DNS name. On a public subnet, this is the public DNS name.
*/
MasterPublicDnsName?: String;
/**
* Applies only to Amazon EMR releases 4.x and later. The list of Configurations supplied to the EMR cluster.
*/
Configurations?: ConfigurationList;
/**
* The name of the security configuration applied to the cluster.
*/
SecurityConfiguration?: XmlString;
/**
* An IAM role for automatic scaling policies. The default role is EMR_AutoScaling_DefaultRole. The IAM role provides permissions that the automatic scaling feature requires to launch and terminate EC2 instances in an instance group.
*/
AutoScalingRole?: XmlString;
/**
* The way that individual Amazon EC2 instances terminate when an automatic scale-in activity occurs or an instance group is resized. TERMINATE_AT_INSTANCE_HOUR indicates that Amazon EMR terminates nodes at the instance-hour boundary, regardless of when the request to terminate the instance was submitted. This option is only available with Amazon EMR 5.1.0 and later and is the default for clusters created using that version. TERMINATE_AT_TASK_COMPLETION indicates that Amazon EMR blacklists and drains tasks from nodes before terminating the Amazon EC2 instances, regardless of the instance-hour boundary. With either behavior, Amazon EMR removes the least active nodes first and blocks instance termination if it could lead to HDFS corruption. TERMINATE_AT_TASK_COMPLETION is available only in Amazon EMR version 4.1.0 and later, and is the default for versions of Amazon EMR earlier than 5.1.0.
*/
ScaleDownBehavior?: ScaleDownBehavior;
/**
* Available only in Amazon EMR version 5.7.0 and later. The ID of a custom Amazon EBS-backed Linux AMI if the cluster uses a custom AMI.
*/
CustomAmiId?: XmlStringMaxLen256;
/**
* The size, in GiB, of the EBS root device volume of the Linux AMI that is used for each EC2 instance. Available in Amazon EMR version 4.x and later.
*/
EbsRootVolumeSize?: Integer;
/**
* Applies only when CustomAmiID is used. Specifies the type of updates that are applied from the Amazon Linux AMI package repositories when an instance boots using the AMI.
*/
RepoUpgradeOnBoot?: RepoUpgradeOnBoot;
/**
* Attributes for Kerberos configuration when Kerberos authentication is enabled using a security configuration. For more information see Use Kerberos Authentication in the EMR Management Guide.
*/
KerberosAttributes?: KerberosAttributes;
/**
* The Amazon Resource Name of the cluster.
*/
ClusterArn?: ArnType;
/**
* Specifies the number of steps that can be executed concurrently.
*/
StepConcurrencyLevel?: Integer;
/**
* The Amazon Resource Name (ARN) of the Outpost where the cluster is launched.
*/
OutpostArn?: OptionalArnType;
}
export type ClusterId = string;
export type ClusterState = "STARTING"|"BOOTSTRAPPING"|"RUNNING"|"WAITING"|"TERMINATING"|"TERMINATED"|"TERMINATED_WITH_ERRORS"|string;
export interface ClusterStateChangeReason {
/**
* The programmatic code for the state change reason.
*/
Code?: ClusterStateChangeReasonCode;
/**
* The descriptive message for the state change reason.
*/
Message?: String;
}
export type ClusterStateChangeReasonCode = "INTERNAL_ERROR"|"VALIDATION_ERROR"|"INSTANCE_FAILURE"|"INSTANCE_FLEET_TIMEOUT"|"BOOTSTRAP_FAILURE"|"USER_REQUEST"|"STEP_FAILURE"|"ALL_STEPS_COMPLETED"|string;
export type ClusterStateList = ClusterState[];
export interface ClusterStatus {
/**
* The current state of the cluster.
*/
State?: ClusterState;
/**
* The reason for the cluster status change.
*/
StateChangeReason?: ClusterStateChangeReason;
/**
* A timeline that represents the status of a cluster over the lifetime of the cluster.
*/
Timeline?: ClusterTimeline;
}
export interface ClusterSummary {
/**
* The unique identifier for the cluster.
*/
Id?: ClusterId;
/**
* The name of the cluster.
*/
Name?: String;
/**
* The details about the current status of the cluster.
*/
Status?: ClusterStatus;
/**
* An approximation of the cost of the cluster, represented in m1.small/hours. This value is incremented one time for every hour an m1.small instance runs. Larger instances are weighted more, so an EC2 instance that is roughly four times more expensive would result in the normalized instance hours being incremented by four. This result is only an approximation and does not reflect the actual billing rate.
*/
NormalizedInstanceHours?: Integer;
/**
* The Amazon Resource Name of the cluster.
*/
ClusterArn?: ArnType;
/**
* The Amazon Resource Name (ARN) of the Outpost where the cluster is launched.
*/
OutpostArn?: OptionalArnType;
}
export type ClusterSummaryList = ClusterSummary[];
export interface ClusterTimeline {
/**
* The creation date and time of the cluster.
*/
CreationDateTime?: _Date;
/**
* The date and time when the cluster was ready to execute steps.
*/
ReadyDateTime?: _Date;
/**
* The date and time when the cluster was terminated.
*/
EndDateTime?: _Date;
}
export interface Command {
/**
* The name of the command.
*/
Name?: String;
/**
* The Amazon S3 location of the command script.
*/
ScriptPath?: String;
/**
* Arguments for Amazon EMR to pass to the command for execution.
*/
Args?: StringList;
}
export type CommandList = Command[];
export type ComparisonOperator = "GREATER_THAN_OR_EQUAL"|"GREATER_THAN"|"LESS_THAN"|"LESS_THAN_OR_EQUAL"|string;
export interface Configuration {
/**
* The classification within a configuration.
*/
Classification?: String;
/**
* A list of additional configurations to apply within a configuration object.
*/
Configurations?: ConfigurationList;
/**
* A set of properties specified within a configuration classification.
*/
Properties?: StringMap;
}
export type ConfigurationList = Configuration[];
export interface CreateSecurityConfigurationInput {
/**
* The name of the security configuration.
*/
Name: XmlString;
/**
* The security configuration details in JSON format. For JSON parameters and examples, see Use Security Configurations to Set Up Cluster Security in the Amazon EMR Management Guide.
*/
SecurityConfiguration: String;
}
export interface CreateSecurityConfigurationOutput {
/**
* The name of the security configuration.
*/
Name: XmlString;
/**
* The date and time the security configuration was created.
*/
CreationDateTime: _Date;
}
export type _Date = Date;
export interface DeleteSecurityConfigurationInput {
/**
* The name of the security configuration.
*/
Name: XmlString;
}
export interface DeleteSecurityConfigurationOutput {
}
export interface DescribeClusterInput {
/**
* The identifier of the cluster to describe.
*/
ClusterId: ClusterId;
}
export interface DescribeClusterOutput {
/**
* This output contains the details for the requested cluster.
*/
Cluster?: Cluster;
}
export interface DescribeJobFlowsInput {
/**
* Return only job flows created after this date and time.
*/
CreatedAfter?: _Date;
/**
* Return only job flows created before this date and time.
*/
CreatedBefore?: _Date;
/**
* Return only job flows whose job flow ID is contained in this list.
*/
JobFlowIds?: XmlStringList;
/**
* Return only job flows whose state is contained in this list.
*/
JobFlowStates?: JobFlowExecutionStateList;
}
export interface DescribeJobFlowsOutput {
/**
* A list of job flows matching the parameters supplied.
*/
JobFlows?: JobFlowDetailList;
}
export interface DescribeSecurityConfigurationInput {
/**
* The name of the security configuration.
*/
Name: XmlString;
}
export interface DescribeSecurityConfigurationOutput {
/**
* The name of the security configuration.
*/
Name?: XmlString;
/**
* The security configuration details in JSON format.
*/
SecurityConfiguration?: String;
/**
* The date and time the security configuration was created
*/
CreationDateTime?: _Date;
}
export interface DescribeStepInput {
/**
* The identifier of the cluster with steps to describe.
*/
ClusterId: ClusterId;
/**
* The identifier of the step to describe.
*/
StepId: StepId;
}
export interface DescribeStepOutput {
/**
* The step details for the requested step identifier.
*/
Step?: Step;
}
export type EC2InstanceIdsList = InstanceId[];
export type EC2InstanceIdsToTerminateList = InstanceId[];
export interface EbsBlockDevice {
/**
* EBS volume specifications such as volume type, IOPS, and size (GiB) that will be requested for the EBS volume attached to an EC2 instance in the cluster.
*/
VolumeSpecification?: VolumeSpecification;
/**
* The device name that is exposed to the instance, such as /dev/sdh.
*/
Device?: String;
}
export interface EbsBlockDeviceConfig {
/**
* EBS volume specifications such as volume type, IOPS, and size (GiB) that will be requested for the EBS volume attached to an EC2 instance in the cluster.
*/
VolumeSpecification: VolumeSpecification;
/**
* Number of EBS volumes with a specific volume configuration that will be associated with every instance in the instance group
*/
VolumesPerInstance?: Integer;
}
export type EbsBlockDeviceConfigList = EbsBlockDeviceConfig[];
export type EbsBlockDeviceList = EbsBlockDevice[];
export interface EbsConfiguration {
/**
* An array of Amazon EBS volume specifications attached to a cluster instance.
*/
EbsBlockDeviceConfigs?: EbsBlockDeviceConfigList;
/**
* Indicates whether an Amazon EBS volume is EBS-optimized.
*/
EbsOptimized?: BooleanObject;
}
export interface EbsVolume {
/**
* The device name that is exposed to the instance, such as /dev/sdh.
*/
Device?: String;
/**
* The volume identifier of the EBS volume.
*/
VolumeId?: String;
}
export type EbsVolumeList = EbsVolume[];
export interface Ec2InstanceAttributes {
/**
* The name of the Amazon EC2 key pair to use when connecting with SSH into the master node as a user named "hadoop".
*/
Ec2KeyName?: String;
/**
* Set this parameter to the identifier of the Amazon VPC subnet where you want the cluster to launch. If you do not specify this value, and your account supports EC2-Classic, the cluster launches in EC2-Classic.
*/
Ec2SubnetId?: String;
/**
* Applies to clusters configured with the instance fleets option. Specifies the unique identifier of one or more Amazon EC2 subnets in which to launch EC2 cluster instances. Subnets must exist within the same VPC. Amazon EMR chooses the EC2 subnet with the best fit from among the list of RequestedEc2SubnetIds, and then launches all cluster instances within that Subnet. If this value is not specified, and the account and Region support EC2-Classic networks, the cluster launches instances in the EC2-Classic network and uses RequestedEc2AvailabilityZones instead of this setting. If EC2-Classic is not supported, and no Subnet is specified, Amazon EMR chooses the subnet for you. RequestedEc2SubnetIDs and RequestedEc2AvailabilityZones cannot be specified together.
*/
RequestedEc2SubnetIds?: XmlStringMaxLen256List;
/**
* The Availability Zone in which the cluster will run.
*/
Ec2AvailabilityZone?: String;
/**
* Applies to clusters configured with the instance fleets option. Specifies one or more Availability Zones in which to launch EC2 cluster instances when the EC2-Classic network configuration is supported. Amazon EMR chooses the Availability Zone with the best fit from among the list of RequestedEc2AvailabilityZones, and then launches all cluster instances within that Availability Zone. If you do not specify this value, Amazon EMR chooses the Availability Zone for you. RequestedEc2SubnetIDs and RequestedEc2AvailabilityZones cannot be specified together.
*/
RequestedEc2AvailabilityZones?: XmlStringMaxLen256List;
/**
* The IAM role that was specified when the cluster was launched. The EC2 instances of the cluster assume this role.
*/
IamInstanceProfile?: String;
/**
* The identifier of the Amazon EC2 security group for the master node.
*/
EmrManagedMasterSecurityGroup?: String;
/**
* The identifier of the Amazon EC2 security group for the core and task nodes.
*/
EmrManagedSlaveSecurityGroup?: String;
/**
* The identifier of the Amazon EC2 security group for the Amazon EMR service to access clusters in VPC private subnets.
*/
ServiceAccessSecurityGroup?: String;
/**
* A list of additional Amazon EC2 security group IDs for the master node.
*/
AdditionalMasterSecurityGroups?: StringList;
/**
* A list of additional Amazon EC2 security group IDs for the core and task nodes.
*/
AdditionalSlaveSecurityGroups?: StringList;
}
export interface FailureDetails {
/**
* The reason for the step failure. In the case where the service cannot successfully determine the root cause of the failure, it returns "Unknown Error" as a reason.
*/
Reason?: String;
/**
* The descriptive message including the error the EMR service has identified as the cause of step failure. This is text from an error log that describes the root cause of the failure.
*/
Message?: String;
/**
* The path to the log file where the step failure root cause was originally recorded.
*/
LogFile?: String;
}
export interface GetBlockPublicAccessConfigurationInput {
}
export interface GetBlockPublicAccessConfigurationOutput {
/**
* A configuration for Amazon EMR block public access. The configuration applies to all clusters created in your account for the current Region. The configuration specifies whether block public access is enabled. If block public access is enabled, security groups associated with the cluster cannot have rules that allow inbound traffic from 0.0.0.0/0 or ::/0 on a port, unless the port is specified as an exception using PermittedPublicSecurityGroupRuleRanges in the BlockPublicAccessConfiguration. By default, Port 22 (SSH) is an exception, and public access is allowed on this port. You can change this by updating the block public access configuration to remove the exception.
*/
BlockPublicAccessConfiguration: BlockPublicAccessConfiguration;
/**
* Properties that describe the AWS principal that created the BlockPublicAccessConfiguration using the PutBlockPublicAccessConfiguration action as well as the date and time that the configuration was created. Each time a configuration for block public access is updated, Amazon EMR updates this metadata.
*/
BlockPublicAccessConfigurationMetadata: BlockPublicAccessConfigurationMetadata;
}
export interface HadoopJarStepConfig {
/**
* A list of Java properties that are set when the step runs. You can use these properties to pass key value pairs to your main function.
*/
Properties?: KeyValueList;
/**
* A path to a JAR file run during the step.
*/
Jar: XmlString;
/**
* The name of the main class in the specified Java file. If not specified, the JAR file should specify a Main-Class in its manifest file.
*/
MainClass?: XmlString;
/**
* A list of command line arguments passed to the JAR file's main function when executed.
*/
Args?: XmlStringList;
}
export interface HadoopStepConfig {
/**
* The path to the JAR file that runs during the step.
*/
Jar?: String;
/**
* The list of Java properties that are set when the step runs. You can use these properties to pass key value pairs to your main function.
*/
Properties?: StringMap;
/**
* The name of the main class in the specified Java file. If not specified, the JAR file should specify a main class in its manifest file.
*/
MainClass?: String;
/**
* The list of command line arguments to pass to the JAR file's main function for execution.
*/
Args?: StringList;
}
export interface Instance {
/**
* The unique identifier for the instance in Amazon EMR.
*/
Id?: InstanceId;
/**
* The unique identifier of the instance in Amazon EC2.
*/
Ec2InstanceId?: InstanceId;
/**
* The public DNS name of the instance.
*/
PublicDnsName?: String;
/**
* The public IP address of the instance.
*/
PublicIpAddress?: String;
/**
* The private DNS name of the instance.
*/
PrivateDnsName?: String;
/**
* The private IP address of the instance.
*/
PrivateIpAddress?: String;
/**
* The current status of the instance.
*/
Status?: InstanceStatus;
/**
* The identifier of the instance group to which this instance belongs.
*/
InstanceGroupId?: String;
/**
* The unique identifier of the instance fleet to which an EC2 instance belongs.
*/
InstanceFleetId?: InstanceFleetId;
/**
* The instance purchasing option. Valid values are ON_DEMAND or SPOT.
*/
Market?: MarketType;
/**
* The EC2 instance type, for example m3.xlarge.
*/
InstanceType?: InstanceType;
/**
* The list of EBS volumes that are attached to this instance.
*/
EbsVolumes?: EbsVolumeList;
}
export type InstanceCollectionType = "INSTANCE_FLEET"|"INSTANCE_GROUP"|string;
export interface InstanceFleet {
/**
* The unique identifier of the instance fleet.
*/
Id?: InstanceFleetId;
/**
* A friendly name for the instance fleet.
*/
Name?: XmlStringMaxLen256;
/**
* The current status of the instance fleet.
*/
Status?: InstanceFleetStatus;
/**
* The node type that the instance fleet hosts. Valid values are MASTER, CORE, or TASK.
*/
InstanceFleetType?: InstanceFleetType;
/**
* The target capacity of On-Demand units for the instance fleet, which determines how many On-Demand instances to provision. When the instance fleet launches, Amazon EMR tries to provision On-Demand instances as specified by InstanceTypeConfig. Each instance configuration has a specified WeightedCapacity. When an On-Demand instance is provisioned, the WeightedCapacity units count toward the target capacity. Amazon EMR provisions instances until the target capacity is totally fulfilled, even if this results in an overage. For example, if there are 2 units remaining to fulfill capacity, and Amazon EMR can only provision an instance with a WeightedCapacity of 5 units, the instance is provisioned, and the target capacity is exceeded by 3 units. You can use InstanceFleet$ProvisionedOnDemandCapacity to determine the Spot capacity units that have been provisioned for the instance fleet. If not specified or set to 0, only Spot instances are provisioned for the instance fleet using TargetSpotCapacity. At least one of TargetSpotCapacity and TargetOnDemandCapacity should be greater than 0. For a master instance fleet, only one of TargetSpotCapacity and TargetOnDemandCapacity can be specified, and its value must be 1.
*/
TargetOnDemandCapacity?: WholeNumber;
/**
* The target capacity of Spot units for the instance fleet, which determines how many Spot instances to provision. When the instance fleet launches, Amazon EMR tries to provision Spot instances as specified by InstanceTypeConfig. Each instance configuration has a specified WeightedCapacity. When a Spot instance is provisioned, the WeightedCapacity units count toward the target capacity. Amazon EMR provisions instances until the target capacity is totally fulfilled, even if this results in an overage. For example, if there are 2 units remaining to fulfill capacity, and Amazon EMR can only provision an instance with a WeightedCapacity of 5 units, the instance is provisioned, and the target capacity is exceeded by 3 units. You can use InstanceFleet$ProvisionedSpotCapacity to determine the Spot capacity units that have been provisioned for the instance fleet. If not specified or set to 0, only On-Demand instances are provisioned for the instance fleet. At least one of TargetSpotCapacity and TargetOnDemandCapacity should be greater than 0. For a master instance fleet, only one of TargetSpotCapacity and TargetOnDemandCapacity can be specified, and its value must be 1.
*/
TargetSpotCapacity?: WholeNumber;
/**
* The number of On-Demand units that have been provisioned for the instance fleet to fulfill TargetOnDemandCapacity. This provisioned capacity might be less than or greater than TargetOnDemandCapacity.
*/
ProvisionedOnDemandCapacity?: WholeNumber;
/**
* The number of Spot units that have been provisioned for this instance fleet to fulfill TargetSpotCapacity. This provisioned capacity might be less than or greater than TargetSpotCapacity.
*/
ProvisionedSpotCapacity?: WholeNumber;
/**
* The specification for the instance types that comprise an instance fleet. Up to five unique instance specifications may be defined for each instance fleet.
*/
InstanceTypeSpecifications?: InstanceTypeSpecificationList;
/**
* Describes the launch specification for an instance fleet.
*/
LaunchSpecifications?: InstanceFleetProvisioningSpecifications;
}
export interface InstanceFleetConfig {
/**
* The friendly name of the instance fleet.
*/
Name?: XmlStringMaxLen256;
/**
* The node type that the instance fleet hosts. Valid values are MASTER,CORE,and TASK.
*/
InstanceFleetType: InstanceFleetType;
/**
* The target capacity of On-Demand units for the instance fleet, which determines how many On-Demand instances to provision. When the instance fleet launches, Amazon EMR tries to provision On-Demand instances as specified by InstanceTypeConfig. Each instance configuration has a specified WeightedCapacity. When an On-Demand instance is provisioned, the WeightedCapacity units count toward the target capacity. Amazon EMR provisions instances until the target capacity is totally fulfilled, even if this results in an overage. For example, if there are 2 units remaining to fulfill capacity, and Amazon EMR can only provision an instance with a WeightedCapacity of 5 units, the instance is provisioned, and the target capacity is exceeded by 3 units. If not specified or set to 0, only Spot instances are provisioned for the instance fleet using TargetSpotCapacity. At least one of TargetSpotCapacity and TargetOnDemandCapacity should be greater than 0. For a master instance fleet, only one of TargetSpotCapacity and TargetOnDemandCapacity can be specified, and its value must be 1.
*/
TargetOnDemandCapacity?: WholeNumber;
/**
* The target capacity of Spot units for the instance fleet, which determines how many Spot instances to provision. When the instance fleet launches, Amazon EMR tries to provision Spot instances as specified by InstanceTypeConfig. Each instance configuration has a specified WeightedCapacity. When a Spot instance is provisioned, the WeightedCapacity units count toward the target capacity. Amazon EMR provisions instances until the target capacity is totally fulfilled, even if this results in an overage. For example, if there are 2 units remaining to fulfill capacity, and Amazon EMR can only provision an instance with a WeightedCapacity of 5 units, the instance is provisioned, and the target capacity is exceeded by 3 units. If not specified or set to 0, only On-Demand instances are provisioned for the instance fleet. At least one of TargetSpotCapacity and TargetOnDemandCapacity should be greater than 0. For a master instance fleet, only one of TargetSpotCapacity and TargetOnDemandCapacity can be specified, and its value must be 1.
*/
TargetSpotCapacity?: WholeNumber;
/**
* The instance type configurations that define the EC2 instances in the instance fleet.
*/
InstanceTypeConfigs?: InstanceTypeConfigList;
/**
* The launch specification for the instance fleet.
*/
LaunchSpecifications?: InstanceFleetProvisioningSpecifications;
}
export type InstanceFleetConfigList = InstanceFleetConfig[];
export type InstanceFleetId = string;
export type InstanceFleetList = InstanceFleet[];
export interface InstanceFleetModifyConfig {
/**
* A unique identifier for the instance fleet.
*/
InstanceFleetId: InstanceFleetId;
/**
* The target capacity of On-Demand units for the instance fleet. For more information see InstanceFleetConfig$TargetOnDemandCapacity.
*/
TargetOnDemandCapacity?: WholeNumber;
/**
* The target capacity of Spot units for the instance fleet. For more information, see InstanceFleetConfig$TargetSpotCapacity.
*/
TargetSpotCapacity?: WholeNumber;
}
export interface InstanceFleetProvisioningSpecifications {
/**
* The launch specification for Spot instances in the fleet, which determines the defined duration and provisioning timeout behavior.
*/
SpotSpecification: SpotProvisioningSpecification;
}
export type InstanceFleetState = "PROVISIONING"|"BOOTSTRAPPING"|"RUNNING"|"RESIZING"|"SUSPENDED"|"TERMINATING"|"TERMINATED"|string;
export interface InstanceFleetStateChangeReason {
/**
* A code corresponding to the reason the state change occurred.
*/
Code?: InstanceFleetStateChangeReasonCode;
/**
* An explanatory message.
*/
Message?: String;
}
export type InstanceFleetStateChangeReasonCode = "INTERNAL_ERROR"|"VALIDATION_ERROR"|"INSTANCE_FAILURE"|"CLUSTER_TERMINATED"|string;
export interface InstanceFleetStatus {
/**
* A code representing the instance fleet status. PROVISIONING—The instance fleet is provisioning EC2 resources and is not yet ready to run jobs. BOOTSTRAPPING—EC2 instances and other resources have been provisioned and the bootstrap actions specified for the instances are underway. RUNNING—EC2 instances and other resources are running. They are either executing jobs or waiting to execute jobs. RESIZING—A resize operation is underway. EC2 instances are either being added or removed. SUSPENDED—A resize operation could not complete. Existing EC2 instances are running, but instances can't be added or removed. TERMINATING—The instance fleet is terminating EC2 instances. TERMINATED—The instance fleet is no longer active, and all EC2 instances have been terminated.
*/
State?: InstanceFleetState;
/**
* Provides status change reason details for the instance fleet.
*/
StateChangeReason?: InstanceFleetStateChangeReason;
/**
* Provides historical timestamps for the instance fleet, including the time of creation, the time it became ready to run jobs, and the time of termination.
*/
Timeline?: InstanceFleetTimeline;
}
export interface InstanceFleetTimeline {
/**
* The time and date the instance fleet was created.
*/
CreationDateTime?: _Date;
/**
* The time and date the instance fleet was ready to run jobs.
*/
ReadyDateTime?: _Date;
/**
* The time and date the instance fleet terminated.
*/
EndDateTime?: _Date;
}
export type InstanceFleetType = "MASTER"|"CORE"|"TASK"|string;
export interface InstanceGroup {
/**
* The identifier of the instance group.
*/
Id?: InstanceGroupId;
/**
* The name of the instance group.
*/
Name?: String;
/**
* The marketplace to provision instances for this group. Valid values are ON_DEMAND or SPOT.
*/
Market?: MarketType;
/**
* The type of the instance group. Valid values are MASTER, CORE or TASK.
*/
InstanceGroupType?: InstanceGroupType;
/**
* The bid price for each EC2 Spot instance type as defined by InstanceType. Expressed in USD. If neither BidPrice nor BidPriceAsPercentageOfOnDemandPrice is provided, BidPriceAsPercentageOfOnDemandPrice defaults to 100%.
*/
BidPrice?: String;
/**
* The EC2 instance type for all instances in the instance group.
*/
InstanceType?: InstanceType;
/**
* The target number of instances for the instance group.
*/
RequestedInstanceCount?: Integer;
/**
* The number of instances currently running in this instance group.
*/
RunningInstanceCount?: Integer;
/**
* The current status of the instance group.
*/
Status?: InstanceGroupStatus;
/**
* Amazon EMR releases 4.x or later. The list of configurations supplied for an EMR cluster instance group. You can specify a separate configuration for each instance group (master, core, and task).
*/
Configurations?: ConfigurationList;
/**
* The version number of the requested configuration specification for this instance group.
*/
ConfigurationsVersion?: Long;
/**
* A list of configurations that were successfully applied for an instance group last time.
*/
LastSuccessfullyAppliedConfigurations?: ConfigurationList;
/**
* The version number of a configuration specification that was successfully applied for an instance group last time.
*/
LastSuccessfullyAppliedConfigurationsVersion?: Long;
/**
* The EBS block devices that are mapped to this instance group.
*/
EbsBlockDevices?: EbsBlockDeviceList;
/**
* If the instance group is EBS-optimized. An Amazon EBS-optimized instance uses an optimized configuration stack and provides additional, dedicated capacity for Amazon EBS I/O.
*/
EbsOptimized?: BooleanObject;
/**
* Policy for customizing shrink operations.
*/
ShrinkPolicy?: ShrinkPolicy;
/**
* An automatic scaling policy for a core instance group or task instance group in an Amazon EMR cluster. The automatic scaling policy defines how an instance group dynamically adds and terminates EC2 instances in response to the value of a CloudWatch metric. See PutAutoScalingPolicy.
*/
AutoScalingPolicy?: AutoScalingPolicyDescription;
}
export interface InstanceGroupConfig {
/**
* Friendly name given to the instance group.
*/
Name?: XmlStringMaxLen256;
/**
* Market type of the EC2 instances used to create a cluster node.
*/
Market?: MarketType;
/**
* The role of the instance group in the cluster.
*/
InstanceRole: InstanceRoleType;
/**
* The bid price for each EC2 Spot instance type as defined by InstanceType. Expressed in USD. If neither BidPrice nor BidPriceAsPercentageOfOnDemandPrice is provided, BidPriceAsPercentageOfOnDemandPrice defaults to 100%.
*/
BidPrice?: XmlStringMaxLen256;
/**
* The EC2 instance type for all instances in the instance group.
*/
InstanceType: InstanceType;
/**
* Target number of instances for the instance group.
*/
InstanceCount: Integer;
/**
* Amazon EMR releases 4.x or later. The list of configurations supplied for an EMR cluster instance group. You can specify a separate configuration for each instance group (master, core, and task).
*/
Configurations?: ConfigurationList;
/**
* EBS configurations that will be attached to each EC2 instance in the instance group.
*/
EbsConfiguration?: EbsConfiguration;
/**
* An automatic scaling policy for a core instance group or task instance group in an Amazon EMR cluster. The automatic scaling policy defines how an instance group dynamically adds and terminates EC2 instances in response to the value of a CloudWatch metric. See PutAutoScalingPolicy.
*/
AutoScalingPolicy?: AutoScalingPolicy;
}
export type InstanceGroupConfigList = InstanceGroupConfig[];
export interface InstanceGroupDetail {
/**
* Unique identifier for the instance group.
*/
InstanceGroupId?: XmlStringMaxLen256;
/**
* Friendly name for the instance group.
*/
Name?: XmlStringMaxLen256;
/**
* Market type of the EC2 instances used to create a cluster node.
*/
Market: MarketType;
/**
* Instance group role in the cluster
*/
InstanceRole: InstanceRoleType;
/**
* The bid price for each EC2 Spot instance type as defined by InstanceType. Expressed in USD. If neither BidPrice nor BidPriceAsPercentageOfOnDemandPrice is provided, BidPriceAsPercentageOfOnDemandPrice defaults to 100%.
*/
BidPrice?: XmlStringMaxLen256;
/**
* EC2 instance type.
*/
InstanceType: InstanceType;
/**
* Target number of instances to run in the instance group.
*/
InstanceRequestCount: Integer;
/**
* Actual count of running instances.
*/
InstanceRunningCount: Integer;
/**
* State of instance group. The following values are deprecated: STARTING, TERMINATED, and FAILED.
*/
State: InstanceGroupState;
/**
* Details regarding the state of the instance group.
*/
LastStateChangeReason?: XmlString;
/**
* The date/time the instance group was created.
*/
CreationDateTime: _Date;
/**
* The date/time the instance group was started.
*/
StartDateTime?: _Date;
/**
* The date/time the instance group was available to the cluster.
*/
ReadyDateTime?: _Date;
/**
* The date/time the instance group was terminated.
*/
EndDateTime?: _Date;
}
export type InstanceGroupDetailList = InstanceGroupDetail[];
export type InstanceGroupId = string;
export type InstanceGroupIdsList = XmlStringMaxLen256[];
export type InstanceGroupList = InstanceGroup[];
export interface InstanceGroupModifyConfig {
/**
* Unique ID of the instance group to expand or shrink.
*/
InstanceGroupId: XmlStringMaxLen256;
/**
* Target size for the instance group.
*/
InstanceCount?: Integer;
/**
* The EC2 InstanceIds to terminate. After you terminate the instances, the instance group will not return to its original requested size.
*/
EC2InstanceIdsToTerminate?: EC2InstanceIdsToTerminateList;
/**
* Policy for customizing shrink operations.
*/
ShrinkPolicy?: ShrinkPolicy;
/**
* A list of new or modified configurations to apply for an instance group.
*/
Configurations?: ConfigurationList;
}
export type InstanceGroupModifyConfigList = InstanceGroupModifyConfig[];
export type InstanceGroupState = "PROVISIONING"|"BOOTSTRAPPING"|"RUNNING"|"RECONFIGURING"|"RESIZING"|"SUSPENDED"|"TERMINATING"|"TERMINATED"|"ARRESTED"|"SHUTTING_DOWN"|"ENDED"|string;
export interface InstanceGroupStateChangeReason {
/**
* The programmable code for the state change reason.
*/
Code?: InstanceGroupStateChangeReasonCode;
/**
* The status change reason description.
*/
Message?: String;
}
export type InstanceGroupStateChangeReasonCode = "INTERNAL_ERROR"|"VALIDATION_ERROR"|"INSTANCE_FAILURE"|"CLUSTER_TERMINATED"|string;
export interface InstanceGroupStatus {
/**
* The current state of the instance group.
*/
State?: InstanceGroupState;
/**
* The status change reason details for the instance group.
*/
StateChangeReason?: InstanceGroupStateChangeReason;
/**
* The timeline of the instance group status over time.
*/
Timeline?: InstanceGroupTimeline;
}
export interface InstanceGroupTimeline {
/**
* The creation date and time of the instance group.
*/
CreationDateTime?: _Date;
/**
* The date and time when the instance group became ready to perform tasks.
*/
ReadyDateTime?: _Date;
/**
* The date and time when the instance group terminated.
*/
EndDateTime?: _Date;
}
export type InstanceGroupType = "MASTER"|"CORE"|"TASK"|string;
export type InstanceGroupTypeList = InstanceGroupType[];
export type InstanceId = string;
export type InstanceList = Instance[];
export interface InstanceResizePolicy {
/**
* Specific list of instances to be terminated when shrinking an instance group.
*/
InstancesToTerminate?: EC2InstanceIdsList;
/**
* Specific list of instances to be protected when shrinking an instance group.
*/
InstancesToProtect?: EC2InstanceIdsList;
/**
* Decommissioning timeout override for the specific list of instances to be terminated.
*/
InstanceTerminationTimeout?: Integer;
}
export type InstanceRoleType = "MASTER"|"CORE"|"TASK"|string;
export type InstanceState = "AWAITING_FULFILLMENT"|"PROVISIONING"|"BOOTSTRAPPING"|"RUNNING"|"TERMINATED"|string;
export interface InstanceStateChangeReason {
/**
* The programmable code for the state change reason.
*/
Code?: InstanceStateChangeReasonCode;
/**
* The status change reason description.
*/
Message?: String;
}
export type InstanceStateChangeReasonCode = "INTERNAL_ERROR"|"VALIDATION_ERROR"|"INSTANCE_FAILURE"|"BOOTSTRAP_FAILURE"|"CLUSTER_TERMINATED"|string;
export type InstanceStateList = InstanceState[];
export interface InstanceStatus {
/**
* The current state of the instance.
*/
State?: InstanceState;
/**
* The details of the status change reason for the instance.
*/
StateChangeReason?: InstanceStateChangeReason;
/**
* The timeline of the instance status over time.
*/
Timeline?: InstanceTimeline;
}
export interface InstanceTimeline {
/**
* The creation date and time of the instance.
*/
CreationDateTime?: _Date;
/**
* The date and time when the instance was ready to perform tasks.
*/
ReadyDateTime?: _Date;
/**
* The date and time when the instance was terminated.
*/
EndDateTime?: _Date;
}
export type InstanceType = string;
export interface InstanceTypeConfig {
/**
* An EC2 instance type, such as m3.xlarge.
*/
InstanceType: InstanceType;
/**
* The number of units that a provisioned instance of this type provides toward fulfilling the target capacities defined in InstanceFleetConfig. This value is 1 for a master instance fleet, and must be 1 or greater for core and task instance fleets. Defaults to 1 if not specified.
*/
WeightedCapacity?: WholeNumber;
/**
* The bid price for each EC2 Spot instance type as defined by InstanceType. Expressed in USD. If neither BidPrice nor BidPriceAsPercentageOfOnDemandPrice is provided, BidPriceAsPercentageOfOnDemandPrice defaults to 100%.
*/
BidPrice?: XmlStringMaxLen256;
/**
* The bid price, as a percentage of On-Demand price, for each EC2 Spot instance as defined by InstanceType. Expressed as a number (for example, 20 specifies 20%). If neither BidPrice nor BidPriceAsPercentageOfOnDemandPrice is provided, BidPriceAsPercentageOfOnDemandPrice defaults to 100%.
*/
BidPriceAsPercentageOfOnDemandPrice?: NonNegativeDouble;
/**
* The configuration of Amazon Elastic Block Storage (EBS) attached to each instance as defined by InstanceType.
*/
EbsConfiguration?: EbsConfiguration;
/**
* A configuration classification that applies when provisioning cluster instances, which can include configurations for applications and software that run on the cluster.
*/
Configurations?: ConfigurationList;
}
export type InstanceTypeConfigList = InstanceTypeConfig[];
export interface InstanceTypeSpecification {
/**
* The EC2 instance type, for example m3.xlarge.
*/
InstanceType?: InstanceType;
/**
* The number of units that a provisioned instance of this type provides toward fulfilling the target capacities defined in InstanceFleetConfig. Capacity values represent performance characteristics such as vCPUs, memory, or I/O. If not specified, the default value is 1.
*/
WeightedCapacity?: WholeNumber;
/**
* The bid price for each EC2 Spot instance type as defined by InstanceType. Expressed in USD.
*/
BidPrice?: XmlStringMaxLen256;
/**
* The bid price, as a percentage of On-Demand price, for each EC2 Spot instance as defined by InstanceType. Expressed as a number (for example, 20 specifies 20%).
*/
BidPriceAsPercentageOfOnDemandPrice?: NonNegativeDouble;
/**
* A configuration classification that applies when provisioning cluster instances, which can include configurations for applications and software bundled with Amazon EMR.
*/
Configurations?: ConfigurationList;
/**
* The configuration of Amazon Elastic Block Storage (EBS) attached to each instance as defined by InstanceType.
*/
EbsBlockDevices?: EbsBlockDeviceList;
/**
* Evaluates to TRUE when the specified InstanceType is EBS-optimized.
*/
EbsOptimized?: BooleanObject;
}
export type InstanceTypeSpecificationList = InstanceTypeSpecification[];
export type Integer = number;
export interface JobFlowDetail {
/**
* The job flow identifier.
*/
JobFlowId: XmlStringMaxLen256;
/**
* The name of the job flow.
*/
Name: XmlStringMaxLen256;
/**
* The location in Amazon S3 where log files for the job are stored.
*/
LogUri?: XmlString;
/**
* Applies only to Amazon EMR AMI versions 3.x and 2.x. For Amazon EMR releases 4.0 and later, ReleaseLabel is used. To specify a custom AMI, use CustomAmiID.
*/
AmiVersion?: XmlStringMaxLen256;
/**
* Describes the execution status of the job flow.
*/
ExecutionStatusDetail: JobFlowExecutionStatusDetail;
/**
* Describes the Amazon EC2 instances of the job flow.
*/
Instances: JobFlowInstancesDetail;
/**
* A list of steps run by the job flow.
*/
Steps?: StepDetailList;
/**
* A list of the bootstrap actions run by the job flow.
*/
BootstrapActions?: BootstrapActionDetailList;
/**
* A list of strings set by third party software when the job flow is launched. If you are not using third party software to manage the job flow this value is empty.
*/
SupportedProducts?: SupportedProductsList;
/**
* Indicates whether the cluster is visible to all IAM users of the AWS account associated with the cluster. The default value, true, indicates that all IAM users in the AWS account can perform cluster actions if they have the proper IAM policy permissions. If this value is false, only the IAM user that created the cluster can perform actions. This value can be changed on a running cluster by using the SetVisibleToAllUsers action. You can override the default value of true when you create a cluster by using the VisibleToAllUsers parameter of the RunJobFlow action.
*/
VisibleToAllUsers?: Boolean;
/**
* The IAM role that was specified when the job flow was launched. The EC2 instances of the job flow assume this role.
*/
JobFlowRole?: XmlString;
/**
* The IAM role that will be assumed by the Amazon EMR service to access AWS resources on your behalf.
*/
ServiceRole?: XmlString;
/**
* An IAM role for automatic scaling policies. The default role is EMR_AutoScaling_DefaultRole. The IAM role provides a way for the automatic scaling feature to get the required permissions it needs to launch and terminate EC2 instances in an instance group.
*/
AutoScalingRole?: XmlString;
/**
* The way that individual Amazon EC2 instances terminate when an automatic scale-in activity occurs or an instance group is resized. TERMINATE_AT_INSTANCE_HOUR indicates that Amazon EMR terminates nodes at the instance-hour boundary, regardless of when the request to terminate the instance was submitted. This option is only available with Amazon EMR 5.1.0 and later and is the default for clusters created using that version. TERMINATE_AT_TASK_COMPLETION indicates that Amazon EMR blacklists and drains tasks from nodes before terminating the Amazon EC2 instances, regardless of the instance-hour boundary. With either behavior, Amazon EMR removes the least active nodes first and blocks instance termination if it could lead to HDFS corruption. TERMINATE_AT_TASK_COMPLETION available only in Amazon EMR version 4.1.0 and later, and is the default for versions of Amazon EMR earlier than 5.1.0.
*/
ScaleDownBehavior?: ScaleDownBehavior;
}
export type JobFlowDetailList = JobFlowDetail[];
export type JobFlowExecutionState = "STARTING"|"BOOTSTRAPPING"|"RUNNING"|"WAITING"|"SHUTTING_DOWN"|"TERMINATED"|"COMPLETED"|"FAILED"|string;
export type JobFlowExecutionStateList = JobFlowExecutionState[];
export interface JobFlowExecutionStatusDetail {
/**
* The state of the job flow.
*/
State: JobFlowExecutionState;
/**
* The creation date and time of the job flow.
*/
CreationDateTime: _Date;
/**
* The start date and time of the job flow.
*/
StartDateTime?: _Date;
/**
* The date and time when the job flow was ready to start running bootstrap actions.
*/
ReadyDateTime?: _Date;
/**
* The completion date and time of the job flow.
*/
EndDateTime?: _Date;
/**
* Description of the job flow last changed state.
*/
LastStateChangeReason?: XmlString;
}
export interface JobFlowInstancesConfig {
/**
* The EC2 instance type of the master node.
*/
MasterInstanceType?: InstanceType;
/**
* The EC2 instance type of the core and task nodes.
*/
SlaveInstanceType?: InstanceType;
/**
* The number of EC2 instances in the cluster.
*/
InstanceCount?: Integer;
/**
* Configuration for the instance groups in a cluster.
*/
InstanceGroups?: InstanceGroupConfigList;
/**
* The instance fleet configuration is available only in Amazon EMR versions 4.8.0 and later, excluding 5.0.x versions. Describes the EC2 instances and instance configurations for clusters that use the instance fleet configuration.
*/
InstanceFleets?: InstanceFleetConfigList;
/**
* The name of the EC2 key pair that can be used to ssh to the master node as the user called "hadoop."
*/
Ec2KeyName?: XmlStringMaxLen256;
/**
* The Availability Zone in which the cluster runs.
*/
Placement?: PlacementType;
/**
* Specifies whether the cluster should remain available after completing all steps.
*/
KeepJobFlowAliveWhenNoSteps?: Boolean;
/**
* Specifies whether to lock the cluster to prevent the Amazon EC2 instances from being terminated by API call, user intervention, or in the event of a job-flow error.
*/
TerminationProtected?: Boolean;
/**
* Applies only to Amazon EMR release versions earlier than 4.0. The Hadoop version for the cluster. Valid inputs are "0.18" (deprecated), "0.20" (deprecated), "0.20.205" (deprecated), "1.0.3", "2.2.0", or "2.4.0". If you do not set this value, the default of 0.18 is used, unless the AmiVersion parameter is set in the RunJobFlow call, in which case the default version of Hadoop for that AMI version is used.
*/
HadoopVersion?: XmlStringMaxLen256;
/**
* Applies to clusters that use the uniform instance group configuration. To launch the cluster in Amazon Virtual Private Cloud (Amazon VPC), set this parameter to the identifier of the Amazon VPC subnet where you want the cluster to launch. If you do not specify this value and your account supports EC2-Classic, the cluster launches in EC2-Classic.
*/
Ec2SubnetId?: XmlStringMaxLen256;
/**
* Applies to clusters that use the instance fleet configuration. When multiple EC2 subnet IDs are specified, Amazon EMR evaluates them and launches instances in the optimal subnet. The instance fleet configuration is available only in Amazon EMR versions 4.8.0 and later, excluding 5.0.x versions.
*/
Ec2SubnetIds?: XmlStringMaxLen256List;
/**
* The identifier of the Amazon EC2 security group for the master node.
*/
EmrManagedMasterSecurityGroup?: XmlStringMaxLen256;
/**
* The identifier of the Amazon EC2 security group for the core and task nodes.
*/
EmrManagedSlaveSecurityGroup?: XmlStringMaxLen256;
/**
* The identifier of the Amazon EC2 security group for the Amazon EMR service to access clusters in VPC private subnets.
*/
ServiceAccessSecurityGroup?: XmlStringMaxLen256;
/**
* A list of additional Amazon EC2 security group IDs for the master node.
*/
AdditionalMasterSecurityGroups?: SecurityGroupsList;
/**
* A list of additional Amazon EC2 security group IDs for the core and task nodes.
*/
AdditionalSlaveSecurityGroups?: SecurityGroupsList;
}
export interface JobFlowInstancesDetail {
/**
* The Amazon EC2 master node instance type.
*/
MasterInstanceType: InstanceType;
/**
* The DNS name of the master node. If the cluster is on a private subnet, this is the private DNS name. On a public subnet, this is the public DNS name.
*/
MasterPublicDnsName?: XmlString;
/**
* The Amazon EC2 instance identifier of the master node.
*/
MasterInstanceId?: XmlString;
/**
* The Amazon EC2 core and task node instance type.
*/
SlaveInstanceType: InstanceType;
/**
* The number of Amazon EC2 instances in the cluster. If the value is 1, the same instance serves as both the master and core and task node. If the value is greater than 1, one instance is the master node and all others are core and task nodes.
*/
InstanceCount: Integer;
/**
* Details about the instance groups in a cluster.
*/
InstanceGroups?: InstanceGroupDetailList;
/**
* An approximation of the cost of the cluster, represented in m1.small/hours. This value is incremented one time for every hour that an m1.small runs. Larger instances are weighted more, so an Amazon EC2 instance that is roughly four times more expensive would result in the normalized instance hours being incremented by four. This result is only an approximation and does not reflect the actual billing rate.
*/
NormalizedInstanceHours?: Integer;
/**
* The name of an Amazon EC2 key pair that can be used to ssh to the master node.
*/
Ec2KeyName?: XmlStringMaxLen256;
/**
* For clusters launched within Amazon Virtual Private Cloud, this is the identifier of the subnet where the cluster was launched.
*/
Ec2SubnetId?: XmlStringMaxLen256;
/**
* The Amazon EC2 Availability Zone for the cluster.
*/
Placement?: PlacementType;
/**
* Specifies whether the cluster should remain available after completing all steps.
*/
KeepJobFlowAliveWhenNoSteps?: Boolean;
/**
* Specifies whether the Amazon EC2 instances in the cluster are protected from termination by API calls, user intervention, or in the event of a job-flow error.
*/
TerminationProtected?: Boolean;
/**
* The Hadoop version for the cluster.
*/
HadoopVersion?: XmlStringMaxLen256;
}
export interface KerberosAttributes {
/**
* The name of the Kerberos realm to which all nodes in a cluster belong. For example, EC2.INTERNAL.
*/
Realm: XmlStringMaxLen256;
/**
* The password used within the cluster for the kadmin service on the cluster-dedicated KDC, which maintains Kerberos principals, password policies, and keytabs for the cluster.
*/
KdcAdminPassword: XmlStringMaxLen256;
/**
* Required only when establishing a cross-realm trust with a KDC in a different realm. The cross-realm principal password, which must be identical across realms.
*/
CrossRealmTrustPrincipalPassword?: XmlStringMaxLen256;
/**
* Required only when establishing a cross-realm trust with an Active Directory domain. A user with sufficient privileges to join resources to the domain.
*/
ADDomainJoinUser?: XmlStringMaxLen256;
/**
* The Active Directory password for ADDomainJoinUser.
*/
ADDomainJoinPassword?: XmlStringMaxLen256;
}
export interface KeyValue {
/**
* The unique identifier of a key value pair.
*/
Key?: XmlString;
/**
* The value part of the identified key.
*/
Value?: XmlString;
}
export type KeyValueList = KeyValue[];
export interface ListBootstrapActionsInput {
/**
* The cluster identifier for the bootstrap actions to list.
*/
ClusterId: ClusterId;
/**
* The pagination token that indicates the next set of results to retrieve.
*/
Marker?: Marker;
}
export interface ListBootstrapActionsOutput {
/**
* The bootstrap actions associated with the cluster.
*/
BootstrapActions?: CommandList;
/**
* The pagination token that indicates the next set of results to retrieve.
*/
Marker?: Marker;
}
export interface ListClustersInput {
/**
* The creation date and time beginning value filter for listing clusters.
*/
CreatedAfter?: _Date;
/**
* The creation date and time end value filter for listing clusters.
*/
CreatedBefore?: _Date;
/**
* The cluster state filters to apply when listing clusters.
*/
ClusterStates?: ClusterStateList;
/**
* The pagination token that indicates the next set of results to retrieve.
*/
Marker?: Marker;
}
export interface ListClustersOutput {
/**
* The list of clusters for the account based on the given filters.
*/
Clusters?: ClusterSummaryList;
/**
* The pagination token that indicates the next set of results to retrieve.
*/
Marker?: Marker;
}
export interface ListInstanceFleetsInput {
/**
* The unique identifier of the cluster.
*/
ClusterId: ClusterId;
/**
* The pagination token that indicates the next set of results to retrieve.
*/
Marker?: Marker;
}
export interface ListInstanceFleetsOutput {
/**
* The list of instance fleets for the cluster and given filters.
*/
InstanceFleets?: InstanceFleetList;
/**
* The pagination token that indicates the next set of results to retrieve.
*/
Marker?: Marker;
}
export interface ListInstanceGroupsInput {
/**
* The identifier of the cluster for which to list the instance groups.
*/
ClusterId: ClusterId;
/**
* The pagination token that indicates the next set of results to retrieve.
*/
Marker?: Marker;
}
export interface ListInstanceGroupsOutput {
/**
* The list of instance groups for the cluster and given filters.
*/
InstanceGroups?: InstanceGroupList;
/**
* The pagination token that indicates the next set of results to retrieve.
*/
Marker?: Marker;
}
export interface ListInstancesInput {
/**
* The identifier of the cluster for which to list the instances.
*/
ClusterId: ClusterId;
/**
* The identifier of the instance group for which to list the instances.
*/
InstanceGroupId?: InstanceGroupId;
/**
* The type of instance group for which to list the instances.
*/
InstanceGroupTypes?: InstanceGroupTypeList;
/**
* The unique identifier of the instance fleet.
*/
InstanceFleetId?: InstanceFleetId;
/**
* The node type of the instance fleet. For example MASTER, CORE, or TASK.
*/
InstanceFleetType?: InstanceFleetType;
/**
* A list of instance states that will filter the instances returned with this request.
*/
InstanceStates?: InstanceStateList;
/**
* The pagination token that indicates the next set of results to retrieve.
*/
Marker?: Marker;
}
export interface ListInstancesOutput {
/**
* The list of instances for the cluster and given filters.
*/
Instances?: InstanceList;
/**
* The pagination token that indicates the next set of results to retrieve.
*/
Marker?: Marker;
}
export interface ListSecurityConfigurationsInput {
/**
* The pagination token that indicates the set of results to retrieve.
*/
Marker?: Marker;
}
export interface ListSecurityConfigurationsOutput {
/**
* The creation date and time, and name, of each security configuration.
*/
SecurityConfigurations?: SecurityConfigurationList;
/**
* A pagination token that indicates the next set of results to retrieve. Include the marker in the next ListSecurityConfiguration call to retrieve the next page of results, if required.
*/
Marker?: Marker;
}
export interface ListStepsInput {
/**
* The identifier of the cluster for which to list the steps.
*/
ClusterId: ClusterId;
/**
* The filter to limit the step list based on certain states.
*/
StepStates?: StepStateList;
/**
* The filter to limit the step list based on the identifier of the steps. You can specify a maximum of ten Step IDs. The character constraint applies to the overall length of the array.
*/
StepIds?: XmlStringList;
/**
* The pagination token that indicates the next set of results to retrieve.
*/
Marker?: Marker;
}
export interface ListStepsOutput {
/**
* The filtered list of steps for the cluster.
*/
Steps?: StepSummaryList;
/**
* The pagination token that indicates the next set of results to retrieve.
*/
Marker?: Marker;
}
export type Long = number;
export type Marker = string;
export type MarketType = "ON_DEMAND"|"SPOT"|string;
export interface MetricDimension {
/**
* The dimension name.
*/
Key?: String;
/**
* The dimension value.
*/
Value?: String;
}
export type MetricDimensionList = MetricDimension[];
export interface ModifyClusterInput {
/**
* The unique identifier of the cluster.
*/
ClusterId: String;
/**
* The number of steps that can be executed concurrently. You can specify a maximum of 256 steps.
*/
StepConcurrencyLevel?: Integer;
}
export interface ModifyClusterOutput {
/**
* The number of steps that can be executed concurrently.
*/
StepConcurrencyLevel?: Integer;
}
export interface ModifyInstanceFleetInput {
/**
* The unique identifier of the cluster.
*/
ClusterId: ClusterId;
/**
* The unique identifier of the instance fleet.
*/
InstanceFleet: InstanceFleetModifyConfig;
}
export interface ModifyInstanceGroupsInput {
/**
* The ID of the cluster to which the instance group belongs.
*/
ClusterId?: ClusterId;
/**
* Instance groups to change.
*/
InstanceGroups?: InstanceGroupModifyConfigList;
}
export type NewSupportedProductsList = SupportedProductConfig[];
export type NonNegativeDouble = number;
export type OptionalArnType = string;
export interface PlacementType {
/**
* The Amazon EC2 Availability Zone for the cluster. AvailabilityZone is used for uniform instance groups, while AvailabilityZones (plural) is used for instance fleets.
*/
AvailabilityZone?: XmlString;
/**
* When multiple Availability Zones are specified, Amazon EMR evaluates them and launches instances in the optimal Availability Zone. AvailabilityZones is used for instance fleets, while AvailabilityZone (singular) is used for uniform instance groups. The instance fleet configuration is available only in Amazon EMR versions 4.8.0 and later, excluding 5.0.x versions.
*/
AvailabilityZones?: XmlStringMaxLen256List;
}
export type Port = number;
export interface PortRange {
/**
* The smallest port number in a specified range of port numbers.
*/
MinRange: Port;
/**
* The smallest port number in a specified range of port numbers.
*/
MaxRange?: Port;
}
export type PortRanges = PortRange[];
export interface PutAutoScalingPolicyInput {
/**
* Specifies the ID of a cluster. The instance group to which the automatic scaling policy is applied is within this cluster.
*/
ClusterId: ClusterId;
/**
* Specifies the ID of the instance group to which the automatic scaling policy is applied.
*/
InstanceGroupId: InstanceGroupId;
/**
* Specifies the definition of the automatic scaling policy.
*/
AutoScalingPolicy: AutoScalingPolicy;
}
export interface PutAutoScalingPolicyOutput {
/**
* Specifies the ID of a cluster. The instance group to which the automatic scaling policy is applied is within this cluster.
*/
ClusterId?: ClusterId;
/**
* Specifies the ID of the instance group to which the scaling policy is applied.
*/
InstanceGroupId?: InstanceGroupId;
/**
* The automatic scaling policy definition.
*/
AutoScalingPolicy?: AutoScalingPolicyDescription;
/**
* The Amazon Resource Name of the cluster.
*/
ClusterArn?: ArnType;
}
export interface PutBlockPublicAccessConfigurationInput {
/**
* A configuration for Amazon EMR block public access. The configuration applies to all clusters created in your account for the current Region. The configuration specifies whether block public access is enabled. If block public access is enabled, security groups associated with the cluster cannot have rules that allow inbound traffic from 0.0.0.0/0 or ::/0 on a port, unless the port is specified as an exception using PermittedPublicSecurityGroupRuleRanges in the BlockPublicAccessConfiguration. By default, Port 22 (SSH) is an exception, and public access is allowed on this port. You can change this by updating BlockPublicSecurityGroupRules to remove the exception.
*/
BlockPublicAccessConfiguration: BlockPublicAccessConfiguration;
}
export interface PutBlockPublicAccessConfigurationOutput {
}
export interface RemoveAutoScalingPolicyInput {
/**
* Specifies the ID of a cluster. The instance group to which the automatic scaling policy is applied is within this cluster.
*/
ClusterId: ClusterId;
/**
* Specifies the ID of the instance group to which the scaling policy is applied.
*/
InstanceGroupId: InstanceGroupId;
}
export interface RemoveAutoScalingPolicyOutput {
}
export interface RemoveTagsInput {
/**
* The Amazon EMR resource identifier from which tags will be removed. This value must be a cluster identifier.
*/
ResourceId: ResourceId;
/**
* A list of tag keys to remove from a resource.
*/
TagKeys: StringList;
}
export interface RemoveTagsOutput {
}
export type RepoUpgradeOnBoot = "SECURITY"|"NONE"|string;
export type ResourceId = string;
export interface RunJobFlowInput {
/**
* The name of the job flow.
*/
Name: XmlStringMaxLen256;
/**
* The location in Amazon S3 to write the log files of the job flow. If a value is not provided, logs are not created.
*/
LogUri?: XmlString;
/**
* A JSON string for selecting additional features.
*/
AdditionalInfo?: XmlString;
/**
* Applies only to Amazon EMR AMI versions 3.x and 2.x. For Amazon EMR releases 4.0 and later, ReleaseLabel is used. To specify a custom AMI, use CustomAmiID.
*/
AmiVersion?: XmlStringMaxLen256;
/**
* The Amazon EMR release label, which determines the version of open-source application packages installed on the cluster. Release labels are in the form emr-x.x.x, where x.x.x is an Amazon EMR release version such as emr-5.14.0. For more information about Amazon EMR release versions and included application versions and features, see https://docs.aws.amazon.com/emr/latest/ReleaseGuide/. The release label applies only to Amazon EMR releases version 4.0 and later. Earlier versions use AmiVersion.
*/
ReleaseLabel?: XmlStringMaxLen256;
/**
* A specification of the number and type of Amazon EC2 instances.
*/
Instances: JobFlowInstancesConfig;
/**
* A list of steps to run.
*/
Steps?: StepConfigList;
/**
* A list of bootstrap actions to run before Hadoop starts on the cluster nodes.
*/
BootstrapActions?: BootstrapActionConfigList;
/**
* For Amazon EMR releases 3.x and 2.x. For Amazon EMR releases 4.x and later, use Applications. A list of strings that indicates third-party software to use. For more information, see the Amazon EMR Developer Guide. Currently supported values are: "mapr-m3" - launch the job flow using MapR M3 Edition. "mapr-m5" - launch the job flow using MapR M5 Edition.
*/
SupportedProducts?: SupportedProductsList;
/**
* For Amazon EMR releases 3.x and 2.x. For Amazon EMR releases 4.x and later, use Applications. A list of strings that indicates third-party software to use with the job flow that accepts a user argument list. EMR accepts and forwards the argument list to the corresponding installation script as bootstrap action arguments. For more information, see "Launch a Job Flow on the MapR Distribution for Hadoop" in the Amazon EMR Developer Guide. Supported values are: "mapr-m3" - launch the cluster using MapR M3 Edition. "mapr-m5" - launch the cluster using MapR M5 Edition. "mapr" with the user arguments specifying "--edition,m3" or "--edition,m5" - launch the job flow using MapR M3 or M5 Edition respectively. "mapr-m7" - launch the cluster using MapR M7 Edition. "hunk" - launch the cluster with the Hunk Big Data Analtics Platform. "hue"- launch the cluster with Hue installed. "spark" - launch the cluster with Apache Spark installed. "ganglia" - launch the cluster with the Ganglia Monitoring System installed.
*/
NewSupportedProducts?: NewSupportedProductsList;
/**
* Applies to Amazon EMR releases 4.0 and later. A case-insensitive list of applications for Amazon EMR to install and configure when launching the cluster. For a list of applications available for each Amazon EMR release version, see the Amazon EMR Release Guide.
*/
Applications?: ApplicationList;
/**
* For Amazon EMR releases 4.0 and later. The list of configurations supplied for the EMR cluster you are creating.
*/
Configurations?: ConfigurationList;
/**
* A value of true indicates that all IAM users in the AWS account can perform cluster actions if they have the proper IAM policy permissions. This is the default. A value of false indicates that only the IAM user who created the cluster can perform actions.
*/
VisibleToAllUsers?: Boolean;
/**
* Also called instance profile and EC2 role. An IAM role for an EMR cluster. The EC2 instances of the cluster assume this role. The default role is EMR_EC2_DefaultRole. In order to use the default role, you must have already created it using the CLI or console.
*/
JobFlowRole?: XmlString;
/**
* The IAM role that will be assumed by the Amazon EMR service to access AWS resources on your behalf.
*/
ServiceRole?: XmlString;
/**
* A list of tags to associate with a cluster and propagate to Amazon EC2 instances.
*/
Tags?: TagList;
/**
* The name of a security configuration to apply to the cluster.
*/
SecurityConfiguration?: XmlString;
/**
* An IAM role for automatic scaling policies. The default role is EMR_AutoScaling_DefaultRole. The IAM role provides permissions that the automatic scaling feature requires to launch and terminate EC2 instances in an instance group.
*/
AutoScalingRole?: XmlString;
/**
* Specifies the way that individual Amazon EC2 instances terminate when an automatic scale-in activity occurs or an instance group is resized. TERMINATE_AT_INSTANCE_HOUR indicates that Amazon EMR terminates nodes at the instance-hour boundary, regardless of when the request to terminate the instance was submitted. This option is only available with Amazon EMR 5.1.0 and later and is the default for clusters created using that version. TERMINATE_AT_TASK_COMPLETION indicates that Amazon EMR blacklists and drains tasks from nodes before terminating the Amazon EC2 instances, regardless of the instance-hour boundary. With either behavior, Amazon EMR removes the least active nodes first and blocks instance termination if it could lead to HDFS corruption. TERMINATE_AT_TASK_COMPLETION available only in Amazon EMR version 4.1.0 and later, and is the default for versions of Amazon EMR earlier than 5.1.0.
*/
ScaleDownBehavior?: ScaleDownBehavior;
/**
* Available only in Amazon EMR version 5.7.0 and later. The ID of a custom Amazon EBS-backed Linux AMI. If specified, Amazon EMR uses this AMI when it launches cluster EC2 instances. For more information about custom AMIs in Amazon EMR, see Using a Custom AMI in the Amazon EMR Management Guide. If omitted, the cluster uses the base Linux AMI for the ReleaseLabel specified. For Amazon EMR versions 2.x and 3.x, use AmiVersion instead. For information about creating a custom AMI, see Creating an Amazon EBS-Backed Linux AMI in the Amazon Elastic Compute Cloud User Guide for Linux Instances. For information about finding an AMI ID, see Finding a Linux AMI.
*/
CustomAmiId?: XmlStringMaxLen256;
/**
* The size, in GiB, of the EBS root device volume of the Linux AMI that is used for each EC2 instance. Available in Amazon EMR version 4.x and later.
*/
EbsRootVolumeSize?: Integer;
/**
* Applies only when CustomAmiID is used. Specifies which updates from the Amazon Linux AMI package repositories to apply automatically when the instance boots using the AMI. If omitted, the default is SECURITY, which indicates that only security updates are applied. If NONE is specified, no updates are applied, and all updates must be applied manually.
*/
RepoUpgradeOnBoot?: RepoUpgradeOnBoot;
/**
* Attributes for Kerberos configuration when Kerberos authentication is enabled using a security configuration. For more information see Use Kerberos Authentication in the EMR Management Guide.
*/
KerberosAttributes?: KerberosAttributes;
/**
* Specifies the number of steps that can be executed concurrently. The default value is 1. The maximum value is 256.
*/
StepConcurrencyLevel?: Integer;
}
export interface RunJobFlowOutput {
/**
* An unique identifier for the job flow.
*/
JobFlowId?: XmlStringMaxLen256;
/**
* The Amazon Resource Name of the cluster.
*/
ClusterArn?: ArnType;
}
export type ScaleDownBehavior = "TERMINATE_AT_INSTANCE_HOUR"|"TERMINATE_AT_TASK_COMPLETION"|string;
export interface ScalingAction {
/**
* Not available for instance groups. Instance groups use the market type specified for the group.
*/
Market?: MarketType;
/**
* The type of adjustment the automatic scaling activity makes when triggered, and the periodicity of the adjustment.
*/
SimpleScalingPolicyConfiguration: SimpleScalingPolicyConfiguration;
}
export interface ScalingConstraints {
/**
* The lower boundary of EC2 instances in an instance group below which scaling activities are not allowed to shrink. Scale-in activities will not terminate instances below this boundary.
*/
MinCapacity: Integer;
/**
* The upper boundary of EC2 instances in an instance group beyond which scaling activities are not allowed to grow. Scale-out activities will not add instances beyond this boundary.
*/
MaxCapacity: Integer;
}
export interface ScalingRule {
/**
* The name used to identify an automatic scaling rule. Rule names must be unique within a scaling policy.
*/
Name: String;
/**
* A friendly, more verbose description of the automatic scaling rule.
*/
Description?: String;
/**
* The conditions that trigger an automatic scaling activity.
*/
Action: ScalingAction;
/**
* The CloudWatch alarm definition that determines when automatic scaling activity is triggered.
*/
Trigger: ScalingTrigger;
}
export type ScalingRuleList = ScalingRule[];
export interface ScalingTrigger {
/**
* The definition of a CloudWatch metric alarm. When the defined alarm conditions are met along with other trigger parameters, scaling activity begins.
*/
CloudWatchAlarmDefinition: CloudWatchAlarmDefinition;
}
export interface ScriptBootstrapActionConfig {
/**
* Location of the script to run during a bootstrap action. Can be either a location in Amazon S3 or on a local file system.
*/
Path: XmlString;
/**
* A list of command line arguments to pass to the bootstrap action script.
*/
Args?: XmlStringList;
}
export type SecurityConfigurationList = SecurityConfigurationSummary[];
export interface SecurityConfigurationSummary {
/**
* The name of the security configuration.
*/
Name?: XmlString;
/**
* The date and time the security configuration was created.
*/
CreationDateTime?: _Date;
}
export type SecurityGroupsList = XmlStringMaxLen256[];
export interface SetTerminationProtectionInput {
/**
* A list of strings that uniquely identify the clusters to protect. This identifier is returned by RunJobFlow and can also be obtained from DescribeJobFlows .
*/
JobFlowIds: XmlStringList;
/**
* A Boolean that indicates whether to protect the cluster and prevent the Amazon EC2 instances in the cluster from shutting down due to API calls, user intervention, or job-flow error.
*/
TerminationProtected: Boolean;
}
export interface SetVisibleToAllUsersInput {
/**
* The unique identifier of the job flow (cluster).
*/
JobFlowIds: XmlStringList;
/**
* A value of true indicates that all IAM users in the AWS account can perform cluster actions if they have the proper IAM policy permissions. This is the default. A value of false indicates that only the IAM user who created the cluster can perform actions.
*/
VisibleToAllUsers: Boolean;
}
export interface ShrinkPolicy {
/**
* The desired timeout for decommissioning an instance. Overrides the default YARN decommissioning timeout.
*/
DecommissionTimeout?: Integer;
/**
* Custom policy for requesting termination protection or termination of specific instances when shrinking an instance group.
*/
InstanceResizePolicy?: InstanceResizePolicy;
}
export interface SimpleScalingPolicyConfiguration {
/**
* The way in which EC2 instances are added (if ScalingAdjustment is a positive number) or terminated (if ScalingAdjustment is a negative number) each time the scaling activity is triggered. CHANGE_IN_CAPACITY is the default. CHANGE_IN_CAPACITY indicates that the EC2 instance count increments or decrements by ScalingAdjustment, which should be expressed as an integer. PERCENT_CHANGE_IN_CAPACITY indicates the instance count increments or decrements by the percentage specified by ScalingAdjustment, which should be expressed as an integer. For example, 20 indicates an increase in 20% increments of cluster capacity. EXACT_CAPACITY indicates the scaling activity results in an instance group with the number of EC2 instances specified by ScalingAdjustment, which should be expressed as a positive integer.
*/
AdjustmentType?: AdjustmentType;
/**
* The amount by which to scale in or scale out, based on the specified AdjustmentType. A positive value adds to the instance group's EC2 instance count while a negative number removes instances. If AdjustmentType is set to EXACT_CAPACITY, the number should only be a positive integer. If AdjustmentType is set to PERCENT_CHANGE_IN_CAPACITY, the value should express the percentage as an integer. For example, -20 indicates a decrease in 20% increments of cluster capacity.
*/
ScalingAdjustment: Integer;
/**
* The amount of time, in seconds, after a scaling activity completes before any further trigger-related scaling activities can start. The default value is 0.
*/
CoolDown?: Integer;
}
export interface SpotProvisioningSpecification {
/**
* The spot provisioning timeout period in minutes. If Spot instances are not provisioned within this time period, the TimeOutAction is taken. Minimum value is 5 and maximum value is 1440. The timeout applies only during initial provisioning, when the cluster is first created.
*/
TimeoutDurationMinutes: WholeNumber;
/**
* The action to take when TargetSpotCapacity has not been fulfilled when the TimeoutDurationMinutes has expired; that is, when all Spot instances could not be provisioned within the Spot provisioning timeout. Valid values are TERMINATE_CLUSTER and SWITCH_TO_ON_DEMAND. SWITCH_TO_ON_DEMAND specifies that if no Spot instances are available, On-Demand Instances should be provisioned to fulfill any remaining Spot capacity.
*/
TimeoutAction: SpotProvisioningTimeoutAction;
/**
* The defined duration for Spot instances (also known as Spot blocks) in minutes. When specified, the Spot instance does not terminate before the defined duration expires, and defined duration pricing for Spot instances applies. Valid values are 60, 120, 180, 240, 300, or 360. The duration period starts as soon as a Spot instance receives its instance ID. At the end of the duration, Amazon EC2 marks the Spot instance for termination and provides a Spot instance termination notice, which gives the instance a two-minute warning before it terminates.
*/
BlockDurationMinutes?: WholeNumber;
}
export type SpotProvisioningTimeoutAction = "SWITCH_TO_ON_DEMAND"|"TERMINATE_CLUSTER"|string;
export type Statistic = "SAMPLE_COUNT"|"AVERAGE"|"SUM"|"MINIMUM"|"MAXIMUM"|string;
export interface Step {
/**
* The identifier of the cluster step.
*/
Id?: StepId;
/**
* The name of the cluster step.
*/
Name?: String;
/**
* The Hadoop job configuration of the cluster step.
*/
Config?: HadoopStepConfig;
/**
* The action to take when the cluster step fails. Possible values are TERMINATE_CLUSTER, CANCEL_AND_WAIT, and CONTINUE. TERMINATE_JOB_FLOW is provided for backward compatibility. We recommend using TERMINATE_CLUSTER instead.
*/
ActionOnFailure?: ActionOnFailure;
/**
* The current execution status details of the cluster step.
*/
Status?: StepStatus;
}
export type StepCancellationOption = "SEND_INTERRUPT"|"TERMINATE_PROCESS"|string;
export interface StepConfig {
/**
* The name of the step.
*/
Name: XmlStringMaxLen256;
/**
* The action to take when the cluster step fails. Possible values are TERMINATE_CLUSTER, CANCEL_AND_WAIT, and CONTINUE. TERMINATE_JOB_FLOW is provided for backward compatibility. We recommend using TERMINATE_CLUSTER instead.
*/
ActionOnFailure?: ActionOnFailure;
/**
* The JAR file used for the step.
*/
HadoopJarStep: HadoopJarStepConfig;
}
export type StepConfigList = StepConfig[];
export interface StepDetail {
/**
* The step configuration.
*/
StepConfig: StepConfig;
/**
* The description of the step status.
*/
ExecutionStatusDetail: StepExecutionStatusDetail;
}
export type StepDetailList = StepDetail[];
export type StepExecutionState = "PENDING"|"RUNNING"|"CONTINUE"|"COMPLETED"|"CANCELLED"|"FAILED"|"INTERRUPTED"|string;
export interface StepExecutionStatusDetail {
/**
* The state of the step.
*/
State: StepExecutionState;
/**
* The creation date and time of the step.
*/
CreationDateTime: _Date;
/**
* The start date and time of the step.
*/
StartDateTime?: _Date;
/**
* The completion date and time of the step.
*/
EndDateTime?: _Date;
/**
* A description of the step's current state.
*/
LastStateChangeReason?: XmlString;
}
export type StepId = string;
export type StepIdsList = XmlStringMaxLen256[];
export type StepState = "PENDING"|"CANCEL_PENDING"|"RUNNING"|"COMPLETED"|"CANCELLED"|"FAILED"|"INTERRUPTED"|string;
export interface StepStateChangeReason {
/**
* The programmable code for the state change reason. Note: Currently, the service provides no code for the state change.
*/
Code?: StepStateChangeReasonCode;
/**
* The descriptive message for the state change reason.
*/
Message?: String;
}
export type StepStateChangeReasonCode = "NONE"|string;
export type StepStateList = StepState[];
export interface StepStatus {
/**
* The execution state of the cluster step.
*/
State?: StepState;
/**
* The reason for the step execution status change.
*/
StateChangeReason?: StepStateChangeReason;
/**
* The details for the step failure including reason, message, and log file path where the root cause was identified.
*/
FailureDetails?: FailureDetails;
/**
* The timeline of the cluster step status over time.
*/
Timeline?: StepTimeline;
}
export interface StepSummary {
/**
* The identifier of the cluster step.
*/
Id?: StepId;
/**
* The name of the cluster step.
*/
Name?: String;
/**
* The Hadoop job configuration of the cluster step.
*/
Config?: HadoopStepConfig;
/**
* The action to take when the cluster step fails. Possible values are TERMINATE_CLUSTER, CANCEL_AND_WAIT, and CONTINUE. TERMINATE_JOB_FLOW is available for backward compatibility. We recommend using TERMINATE_CLUSTER instead.
*/
ActionOnFailure?: ActionOnFailure;
/**
* The current execution status details of the cluster step.
*/
Status?: StepStatus;
}
export type StepSummaryList = StepSummary[];
export interface StepTimeline {
/**
* The date and time when the cluster step was created.
*/
CreationDateTime?: _Date;
/**
* The date and time when the cluster step execution started.
*/
StartDateTime?: _Date;
/**
* The date and time when the cluster step execution completed or failed.
*/
EndDateTime?: _Date;
}
export type String = string;
export type StringList = String[];
export type StringMap = {[key: string]: String};
export interface SupportedProductConfig {
/**
* The name of the product configuration.
*/
Name?: XmlStringMaxLen256;
/**
* The list of user-supplied arguments.
*/
Args?: XmlStringList;
}
export type SupportedProductsList = XmlStringMaxLen256[];
export interface Tag {
/**
* A user-defined key, which is the minimum required information for a valid tag. For more information, see Tag .
*/
Key?: String;
/**
* A user-defined value, which is optional in a tag. For more information, see Tag Clusters.
*/
Value?: String;
}
export type TagList = Tag[];
export interface TerminateJobFlowsInput {
/**
* A list of job flows to be shutdown.
*/
JobFlowIds: XmlStringList;
}
export type Unit = "NONE"|"SECONDS"|"MICRO_SECONDS"|"MILLI_SECONDS"|"BYTES"|"KILO_BYTES"|"MEGA_BYTES"|"GIGA_BYTES"|"TERA_BYTES"|"BITS"|"KILO_BITS"|"MEGA_BITS"|"GIGA_BITS"|"TERA_BITS"|"PERCENT"|"COUNT"|"BYTES_PER_SECOND"|"KILO_BYTES_PER_SECOND"|"MEGA_BYTES_PER_SECOND"|"GIGA_BYTES_PER_SECOND"|"TERA_BYTES_PER_SECOND"|"BITS_PER_SECOND"|"KILO_BITS_PER_SECOND"|"MEGA_BITS_PER_SECOND"|"GIGA_BITS_PER_SECOND"|"TERA_BITS_PER_SECOND"|"COUNT_PER_SECOND"|string;
export interface VolumeSpecification {
/**
* The volume type. Volume types supported are gp2, io1, standard.
*/
VolumeType: String;
/**
* The number of I/O operations per second (IOPS) that the volume supports.
*/
Iops?: Integer;
/**
* The volume size, in gibibytes (GiB). This can be a number from 1 - 1024. If the volume type is EBS-optimized, the minimum value is 10.
*/
SizeInGB: Integer;
}
export type WholeNumber = number;
export type XmlString = string;
export type XmlStringList = XmlString[];
export type XmlStringMaxLen256 = string;
export type XmlStringMaxLen256List = XmlStringMaxLen256[];
/**
* 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 = "2009-03-31"|"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 EMR client.
*/
export import Types = EMR;
}
export = EMR;