ssm.d.ts
425 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
2883
2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
2930
2931
2932
2933
2934
2935
2936
2937
2938
2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
2951
2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
3035
3036
3037
3038
3039
3040
3041
3042
3043
3044
3045
3046
3047
3048
3049
3050
3051
3052
3053
3054
3055
3056
3057
3058
3059
3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
3076
3077
3078
3079
3080
3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
3097
3098
3099
3100
3101
3102
3103
3104
3105
3106
3107
3108
3109
3110
3111
3112
3113
3114
3115
3116
3117
3118
3119
3120
3121
3122
3123
3124
3125
3126
3127
3128
3129
3130
3131
3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
3149
3150
3151
3152
3153
3154
3155
3156
3157
3158
3159
3160
3161
3162
3163
3164
3165
3166
3167
3168
3169
3170
3171
3172
3173
3174
3175
3176
3177
3178
3179
3180
3181
3182
3183
3184
3185
3186
3187
3188
3189
3190
3191
3192
3193
3194
3195
3196
3197
3198
3199
3200
3201
3202
3203
3204
3205
3206
3207
3208
3209
3210
3211
3212
3213
3214
3215
3216
3217
3218
3219
3220
3221
3222
3223
3224
3225
3226
3227
3228
3229
3230
3231
3232
3233
3234
3235
3236
3237
3238
3239
3240
3241
3242
3243
3244
3245
3246
3247
3248
3249
3250
3251
3252
3253
3254
3255
3256
3257
3258
3259
3260
3261
3262
3263
3264
3265
3266
3267
3268
3269
3270
3271
3272
3273
3274
3275
3276
3277
3278
3279
3280
3281
3282
3283
3284
3285
3286
3287
3288
3289
3290
3291
3292
3293
3294
3295
3296
3297
3298
3299
3300
3301
3302
3303
3304
3305
3306
3307
3308
3309
3310
3311
3312
3313
3314
3315
3316
3317
3318
3319
3320
3321
3322
3323
3324
3325
3326
3327
3328
3329
3330
3331
3332
3333
3334
3335
3336
3337
3338
3339
3340
3341
3342
3343
3344
3345
3346
3347
3348
3349
3350
3351
3352
3353
3354
3355
3356
3357
3358
3359
3360
3361
3362
3363
3364
3365
3366
3367
3368
3369
3370
3371
3372
3373
3374
3375
3376
3377
3378
3379
3380
3381
3382
3383
3384
3385
3386
3387
3388
3389
3390
3391
3392
3393
3394
3395
3396
3397
3398
3399
3400
3401
3402
3403
3404
3405
3406
3407
3408
3409
3410
3411
3412
3413
3414
3415
3416
3417
3418
3419
3420
3421
3422
3423
3424
3425
3426
3427
3428
3429
3430
3431
3432
3433
3434
3435
3436
3437
3438
3439
3440
3441
3442
3443
3444
3445
3446
3447
3448
3449
3450
3451
3452
3453
3454
3455
3456
3457
3458
3459
3460
3461
3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
3492
3493
3494
3495
3496
3497
3498
3499
3500
3501
3502
3503
3504
3505
3506
3507
3508
3509
3510
3511
3512
3513
3514
3515
3516
3517
3518
3519
3520
3521
3522
3523
3524
3525
3526
3527
3528
3529
3530
3531
3532
3533
3534
3535
3536
3537
3538
3539
3540
3541
3542
3543
3544
3545
3546
3547
3548
3549
3550
3551
3552
3553
3554
3555
3556
3557
3558
3559
3560
3561
3562
3563
3564
3565
3566
3567
3568
3569
3570
3571
3572
3573
3574
3575
3576
3577
3578
3579
3580
3581
3582
3583
3584
3585
3586
3587
3588
3589
3590
3591
3592
3593
3594
3595
3596
3597
3598
3599
3600
3601
3602
3603
3604
3605
3606
3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
3634
3635
3636
3637
3638
3639
3640
3641
3642
3643
3644
3645
3646
3647
3648
3649
3650
3651
3652
3653
3654
3655
3656
3657
3658
3659
3660
3661
3662
3663
3664
3665
3666
3667
3668
3669
3670
3671
3672
3673
3674
3675
3676
3677
3678
3679
3680
3681
3682
3683
3684
3685
3686
3687
3688
3689
3690
3691
3692
3693
3694
3695
3696
3697
3698
3699
3700
3701
3702
3703
3704
3705
3706
3707
3708
3709
3710
3711
3712
3713
3714
3715
3716
3717
3718
3719
3720
3721
3722
3723
3724
3725
3726
3727
3728
3729
3730
3731
3732
3733
3734
3735
3736
3737
3738
3739
3740
3741
3742
3743
3744
3745
3746
3747
3748
3749
3750
3751
3752
3753
3754
3755
3756
3757
3758
3759
3760
3761
3762
3763
3764
3765
3766
3767
3768
3769
3770
3771
3772
3773
3774
3775
3776
3777
3778
3779
3780
3781
3782
3783
3784
3785
3786
3787
3788
3789
3790
3791
3792
3793
3794
3795
3796
3797
3798
3799
3800
3801
3802
3803
3804
3805
3806
3807
3808
3809
3810
3811
3812
3813
3814
3815
3816
3817
3818
3819
3820
3821
3822
3823
3824
3825
3826
3827
3828
3829
3830
3831
3832
3833
3834
3835
3836
3837
3838
3839
3840
3841
3842
3843
3844
3845
3846
3847
3848
3849
3850
3851
3852
3853
3854
3855
3856
3857
3858
3859
3860
3861
3862
3863
3864
3865
3866
3867
3868
3869
3870
3871
3872
3873
3874
3875
3876
3877
3878
3879
3880
3881
3882
3883
3884
3885
3886
3887
3888
3889
3890
3891
3892
3893
3894
3895
3896
3897
3898
3899
3900
3901
3902
3903
3904
3905
3906
3907
3908
3909
3910
3911
3912
3913
3914
3915
3916
3917
3918
3919
3920
3921
3922
3923
3924
3925
3926
3927
3928
3929
3930
3931
3932
3933
3934
3935
3936
3937
3938
3939
3940
3941
3942
3943
3944
3945
3946
3947
3948
3949
3950
3951
3952
3953
3954
3955
3956
3957
3958
3959
3960
3961
3962
3963
3964
3965
3966
3967
3968
3969
3970
3971
3972
3973
3974
3975
3976
3977
3978
3979
3980
3981
3982
3983
3984
3985
3986
3987
3988
3989
3990
3991
3992
3993
3994
3995
3996
3997
3998
3999
4000
4001
4002
4003
4004
4005
4006
4007
4008
4009
4010
4011
4012
4013
4014
4015
4016
4017
4018
4019
4020
4021
4022
4023
4024
4025
4026
4027
4028
4029
4030
4031
4032
4033
4034
4035
4036
4037
4038
4039
4040
4041
4042
4043
4044
4045
4046
4047
4048
4049
4050
4051
4052
4053
4054
4055
4056
4057
4058
4059
4060
4061
4062
4063
4064
4065
4066
4067
4068
4069
4070
4071
4072
4073
4074
4075
4076
4077
4078
4079
4080
4081
4082
4083
4084
4085
4086
4087
4088
4089
4090
4091
4092
4093
4094
4095
4096
4097
4098
4099
4100
4101
4102
4103
4104
4105
4106
4107
4108
4109
4110
4111
4112
4113
4114
4115
4116
4117
4118
4119
4120
4121
4122
4123
4124
4125
4126
4127
4128
4129
4130
4131
4132
4133
4134
4135
4136
4137
4138
4139
4140
4141
4142
4143
4144
4145
4146
4147
4148
4149
4150
4151
4152
4153
4154
4155
4156
4157
4158
4159
4160
4161
4162
4163
4164
4165
4166
4167
4168
4169
4170
4171
4172
4173
4174
4175
4176
4177
4178
4179
4180
4181
4182
4183
4184
4185
4186
4187
4188
4189
4190
4191
4192
4193
4194
4195
4196
4197
4198
4199
4200
4201
4202
4203
4204
4205
4206
4207
4208
4209
4210
4211
4212
4213
4214
4215
4216
4217
4218
4219
4220
4221
4222
4223
4224
4225
4226
4227
4228
4229
4230
4231
4232
4233
4234
4235
4236
4237
4238
4239
4240
4241
4242
4243
4244
4245
4246
4247
4248
4249
4250
4251
4252
4253
4254
4255
4256
4257
4258
4259
4260
4261
4262
4263
4264
4265
4266
4267
4268
4269
4270
4271
4272
4273
4274
4275
4276
4277
4278
4279
4280
4281
4282
4283
4284
4285
4286
4287
4288
4289
4290
4291
4292
4293
4294
4295
4296
4297
4298
4299
4300
4301
4302
4303
4304
4305
4306
4307
4308
4309
4310
4311
4312
4313
4314
4315
4316
4317
4318
4319
4320
4321
4322
4323
4324
4325
4326
4327
4328
4329
4330
4331
4332
4333
4334
4335
4336
4337
4338
4339
4340
4341
4342
4343
4344
4345
4346
4347
4348
4349
4350
4351
4352
4353
4354
4355
4356
4357
4358
4359
4360
4361
4362
4363
4364
4365
4366
4367
4368
4369
4370
4371
4372
4373
4374
4375
4376
4377
4378
4379
4380
4381
4382
4383
4384
4385
4386
4387
4388
4389
4390
4391
4392
4393
4394
4395
4396
4397
4398
4399
4400
4401
4402
4403
4404
4405
4406
4407
4408
4409
4410
4411
4412
4413
4414
4415
4416
4417
4418
4419
4420
4421
4422
4423
4424
4425
4426
4427
4428
4429
4430
4431
4432
4433
4434
4435
4436
4437
4438
4439
4440
4441
4442
4443
4444
4445
4446
4447
4448
4449
4450
4451
4452
4453
4454
4455
4456
4457
4458
4459
4460
4461
4462
4463
4464
4465
4466
4467
4468
4469
4470
4471
4472
4473
4474
4475
4476
4477
4478
4479
4480
4481
4482
4483
4484
4485
4486
4487
4488
4489
4490
4491
4492
4493
4494
4495
4496
4497
4498
4499
4500
4501
4502
4503
4504
4505
4506
4507
4508
4509
4510
4511
4512
4513
4514
4515
4516
4517
4518
4519
4520
4521
4522
4523
4524
4525
4526
4527
4528
4529
4530
4531
4532
4533
4534
4535
4536
4537
4538
4539
4540
4541
4542
4543
4544
4545
4546
4547
4548
4549
4550
4551
4552
4553
4554
4555
4556
4557
4558
4559
4560
4561
4562
4563
4564
4565
4566
4567
4568
4569
4570
4571
4572
4573
4574
4575
4576
4577
4578
4579
4580
4581
4582
4583
4584
4585
4586
4587
4588
4589
4590
4591
4592
4593
4594
4595
4596
4597
4598
4599
4600
4601
4602
4603
4604
4605
4606
4607
4608
4609
4610
4611
4612
4613
4614
4615
4616
4617
4618
4619
4620
4621
4622
4623
4624
4625
4626
4627
4628
4629
4630
4631
4632
4633
4634
4635
4636
4637
4638
4639
4640
4641
4642
4643
4644
4645
4646
4647
4648
4649
4650
4651
4652
4653
4654
4655
4656
4657
4658
4659
4660
4661
4662
4663
4664
4665
4666
4667
4668
4669
4670
4671
4672
4673
4674
4675
4676
4677
4678
4679
4680
4681
4682
4683
4684
4685
4686
4687
4688
4689
4690
4691
4692
4693
4694
4695
4696
4697
4698
4699
4700
4701
4702
4703
4704
4705
4706
4707
4708
4709
4710
4711
4712
4713
4714
4715
4716
4717
4718
4719
4720
4721
4722
4723
4724
4725
4726
4727
4728
4729
4730
4731
4732
4733
4734
4735
4736
4737
4738
4739
4740
4741
4742
4743
4744
4745
4746
4747
4748
4749
4750
4751
4752
4753
4754
4755
4756
4757
4758
4759
4760
4761
4762
4763
4764
4765
4766
4767
4768
4769
4770
4771
4772
4773
4774
4775
4776
4777
4778
4779
4780
4781
4782
4783
4784
4785
4786
4787
4788
4789
4790
4791
4792
4793
4794
4795
4796
4797
4798
4799
4800
4801
4802
4803
4804
4805
4806
4807
4808
4809
4810
4811
4812
4813
4814
4815
4816
4817
4818
4819
4820
4821
4822
4823
4824
4825
4826
4827
4828
4829
4830
4831
4832
4833
4834
4835
4836
4837
4838
4839
4840
4841
4842
4843
4844
4845
4846
4847
4848
4849
4850
4851
4852
4853
4854
4855
4856
4857
4858
4859
4860
4861
4862
4863
4864
4865
4866
4867
4868
4869
4870
4871
4872
4873
4874
4875
4876
4877
4878
4879
4880
4881
4882
4883
4884
4885
4886
4887
4888
4889
4890
4891
4892
4893
4894
4895
4896
4897
4898
4899
4900
4901
4902
4903
4904
4905
4906
4907
4908
4909
4910
4911
4912
4913
4914
4915
4916
4917
4918
4919
4920
4921
4922
4923
4924
4925
4926
4927
4928
4929
4930
4931
4932
4933
4934
4935
4936
4937
4938
4939
4940
4941
4942
4943
4944
4945
4946
4947
4948
4949
4950
4951
4952
4953
4954
4955
4956
4957
4958
4959
4960
4961
4962
4963
4964
4965
4966
4967
4968
4969
4970
4971
4972
4973
4974
4975
4976
4977
4978
4979
4980
4981
4982
4983
4984
4985
4986
4987
4988
4989
4990
4991
4992
4993
4994
4995
4996
4997
4998
4999
5000
5001
5002
5003
5004
5005
5006
5007
5008
5009
5010
5011
5012
5013
5014
5015
5016
5017
5018
5019
5020
5021
5022
5023
5024
5025
5026
5027
5028
5029
5030
5031
5032
5033
5034
5035
5036
5037
5038
5039
5040
5041
5042
5043
5044
5045
5046
5047
5048
5049
5050
5051
5052
5053
5054
5055
5056
5057
5058
5059
5060
5061
5062
5063
5064
5065
5066
5067
5068
5069
5070
5071
5072
5073
5074
5075
5076
5077
5078
5079
5080
5081
5082
5083
5084
5085
5086
5087
5088
5089
5090
5091
5092
5093
5094
5095
5096
5097
5098
5099
5100
5101
5102
5103
5104
5105
5106
5107
5108
5109
5110
5111
5112
5113
5114
5115
5116
5117
5118
5119
5120
5121
5122
5123
5124
5125
5126
5127
5128
5129
5130
5131
5132
5133
5134
5135
5136
5137
5138
5139
5140
5141
5142
5143
5144
5145
5146
5147
5148
5149
5150
5151
5152
5153
5154
5155
5156
5157
5158
5159
5160
5161
5162
5163
5164
5165
5166
5167
5168
5169
5170
5171
5172
5173
5174
5175
5176
5177
5178
5179
5180
5181
5182
5183
5184
5185
5186
5187
5188
5189
5190
5191
5192
5193
5194
5195
5196
5197
5198
5199
5200
5201
5202
5203
5204
5205
5206
5207
5208
5209
5210
5211
5212
5213
5214
5215
5216
5217
5218
5219
5220
5221
5222
5223
5224
5225
5226
5227
5228
5229
5230
5231
5232
5233
5234
5235
5236
5237
5238
5239
5240
5241
5242
5243
5244
5245
5246
5247
5248
5249
5250
5251
5252
5253
5254
5255
5256
5257
5258
5259
5260
5261
5262
5263
5264
5265
5266
5267
5268
5269
5270
5271
5272
5273
5274
5275
5276
5277
5278
5279
5280
5281
5282
5283
5284
5285
5286
5287
5288
5289
5290
5291
5292
5293
5294
5295
5296
5297
5298
5299
5300
5301
5302
5303
5304
5305
5306
5307
5308
5309
5310
5311
5312
5313
5314
5315
5316
5317
5318
5319
5320
5321
5322
5323
5324
5325
5326
5327
5328
5329
5330
5331
5332
5333
5334
5335
5336
5337
5338
5339
5340
5341
5342
5343
5344
5345
5346
5347
5348
5349
5350
5351
5352
5353
5354
5355
5356
5357
5358
5359
5360
5361
5362
5363
5364
5365
5366
5367
5368
5369
5370
5371
5372
5373
5374
5375
5376
5377
5378
5379
5380
5381
5382
5383
5384
5385
5386
5387
5388
5389
5390
5391
5392
5393
5394
5395
5396
5397
5398
5399
5400
5401
5402
5403
5404
5405
5406
5407
5408
5409
5410
5411
5412
5413
5414
5415
5416
5417
5418
5419
5420
5421
5422
5423
5424
5425
5426
5427
5428
5429
5430
5431
5432
5433
5434
5435
5436
5437
5438
5439
5440
5441
5442
5443
5444
5445
5446
5447
5448
5449
5450
5451
5452
5453
5454
5455
5456
5457
5458
5459
5460
5461
5462
5463
5464
5465
5466
5467
5468
5469
5470
5471
5472
5473
5474
5475
5476
5477
5478
5479
5480
5481
5482
5483
5484
5485
5486
5487
5488
5489
5490
5491
5492
5493
5494
5495
5496
5497
5498
5499
5500
5501
5502
5503
5504
5505
5506
5507
5508
5509
5510
5511
5512
5513
5514
5515
5516
5517
5518
5519
5520
5521
5522
5523
5524
5525
5526
5527
5528
5529
5530
5531
5532
5533
5534
5535
5536
5537
5538
5539
5540
5541
5542
5543
5544
5545
5546
5547
5548
5549
5550
5551
5552
5553
5554
5555
5556
5557
5558
5559
5560
5561
5562
5563
5564
5565
5566
5567
5568
5569
5570
5571
5572
5573
5574
5575
5576
5577
5578
5579
5580
5581
5582
5583
5584
5585
5586
5587
5588
5589
5590
5591
5592
5593
5594
5595
5596
5597
5598
5599
5600
5601
5602
5603
5604
5605
5606
5607
5608
5609
5610
5611
5612
5613
5614
5615
5616
5617
5618
5619
5620
5621
5622
5623
5624
5625
5626
5627
5628
5629
5630
5631
5632
5633
5634
5635
5636
5637
5638
5639
5640
5641
5642
5643
5644
5645
5646
5647
5648
5649
5650
5651
5652
5653
5654
5655
5656
5657
5658
5659
5660
5661
5662
5663
5664
5665
5666
5667
5668
5669
5670
5671
5672
5673
5674
5675
5676
5677
5678
5679
5680
5681
5682
5683
5684
5685
5686
5687
5688
5689
5690
5691
5692
5693
5694
5695
5696
5697
5698
5699
5700
5701
5702
5703
5704
5705
5706
5707
5708
5709
5710
5711
5712
5713
5714
5715
5716
5717
5718
5719
5720
5721
5722
5723
5724
5725
5726
5727
5728
5729
5730
5731
5732
5733
5734
5735
5736
5737
5738
5739
5740
5741
5742
5743
5744
5745
5746
5747
5748
5749
5750
5751
5752
5753
5754
5755
5756
5757
5758
5759
5760
5761
5762
5763
5764
5765
5766
5767
5768
5769
5770
5771
5772
5773
5774
5775
5776
5777
5778
5779
5780
5781
5782
5783
5784
5785
5786
5787
5788
5789
5790
5791
5792
5793
5794
5795
5796
5797
5798
5799
5800
5801
5802
5803
5804
5805
5806
5807
5808
5809
5810
5811
5812
5813
5814
5815
5816
5817
5818
5819
5820
5821
5822
5823
5824
5825
5826
5827
5828
5829
5830
5831
5832
5833
5834
5835
5836
5837
5838
5839
5840
5841
5842
5843
5844
5845
5846
5847
5848
5849
5850
5851
5852
5853
5854
5855
5856
5857
5858
5859
5860
5861
5862
5863
5864
5865
5866
5867
5868
5869
5870
5871
5872
5873
5874
5875
5876
5877
5878
5879
5880
5881
5882
5883
5884
5885
5886
5887
5888
5889
5890
5891
5892
5893
5894
5895
5896
5897
5898
5899
5900
5901
5902
5903
5904
5905
5906
5907
5908
5909
5910
5911
5912
5913
5914
5915
5916
5917
5918
5919
5920
5921
5922
5923
5924
5925
5926
5927
5928
5929
5930
5931
5932
5933
5934
5935
5936
5937
5938
5939
5940
5941
5942
5943
5944
5945
5946
5947
5948
5949
5950
5951
5952
5953
5954
5955
5956
5957
5958
5959
5960
5961
5962
5963
5964
5965
5966
5967
5968
5969
5970
5971
5972
5973
5974
5975
5976
5977
5978
5979
5980
5981
5982
5983
5984
5985
5986
5987
5988
5989
5990
5991
5992
5993
5994
5995
5996
5997
5998
5999
6000
6001
6002
6003
6004
6005
6006
6007
6008
6009
6010
6011
6012
6013
6014
6015
6016
6017
6018
6019
6020
6021
6022
6023
6024
6025
6026
6027
6028
6029
6030
6031
6032
6033
6034
6035
6036
6037
6038
6039
6040
6041
6042
6043
6044
6045
6046
6047
6048
6049
6050
6051
6052
6053
6054
6055
6056
6057
6058
6059
6060
6061
6062
6063
6064
6065
6066
6067
6068
6069
6070
6071
6072
6073
6074
6075
6076
6077
6078
6079
6080
6081
6082
6083
6084
6085
6086
6087
6088
6089
6090
6091
6092
6093
6094
6095
6096
6097
6098
6099
6100
6101
6102
6103
6104
6105
6106
6107
6108
6109
6110
6111
6112
6113
6114
6115
6116
6117
6118
6119
6120
6121
6122
6123
6124
6125
6126
6127
6128
6129
6130
6131
6132
6133
6134
6135
6136
6137
6138
6139
6140
6141
6142
6143
6144
6145
6146
6147
6148
6149
6150
6151
6152
6153
6154
6155
6156
6157
6158
6159
6160
6161
6162
6163
6164
6165
6166
6167
6168
6169
6170
6171
6172
6173
6174
6175
6176
6177
6178
6179
6180
6181
6182
6183
6184
6185
6186
6187
6188
6189
6190
6191
6192
6193
6194
6195
6196
6197
6198
6199
6200
6201
6202
6203
6204
6205
6206
6207
6208
6209
6210
6211
6212
6213
6214
6215
6216
6217
6218
6219
6220
6221
6222
6223
6224
6225
6226
6227
6228
6229
6230
6231
6232
6233
6234
6235
6236
6237
6238
6239
6240
6241
6242
6243
6244
6245
6246
6247
6248
6249
6250
6251
6252
6253
6254
6255
6256
6257
6258
6259
6260
6261
6262
6263
6264
6265
6266
6267
6268
6269
6270
6271
6272
6273
6274
6275
6276
6277
6278
6279
6280
6281
6282
6283
6284
6285
6286
6287
6288
6289
6290
6291
6292
6293
6294
6295
6296
6297
6298
6299
6300
6301
6302
6303
6304
6305
6306
6307
6308
6309
6310
6311
6312
6313
6314
6315
6316
6317
6318
6319
6320
6321
6322
6323
6324
6325
6326
6327
6328
6329
6330
6331
6332
6333
6334
6335
6336
6337
6338
6339
6340
6341
6342
6343
6344
6345
6346
6347
6348
6349
6350
6351
6352
6353
6354
6355
6356
6357
6358
6359
6360
6361
6362
6363
6364
6365
6366
6367
6368
6369
6370
6371
6372
6373
6374
6375
6376
6377
6378
6379
6380
6381
6382
6383
6384
6385
6386
6387
6388
6389
6390
6391
6392
6393
6394
6395
6396
6397
6398
6399
6400
6401
6402
6403
6404
6405
6406
6407
6408
6409
6410
6411
6412
6413
6414
6415
6416
6417
6418
6419
6420
6421
6422
6423
6424
6425
6426
6427
6428
6429
6430
6431
6432
6433
6434
6435
6436
6437
6438
6439
6440
6441
6442
6443
6444
6445
6446
6447
6448
6449
6450
6451
6452
6453
6454
6455
6456
6457
6458
6459
6460
6461
6462
6463
6464
6465
6466
6467
6468
6469
6470
6471
6472
6473
6474
6475
6476
6477
6478
6479
6480
6481
6482
6483
6484
6485
6486
6487
6488
6489
6490
6491
6492
6493
6494
6495
6496
6497
6498
6499
6500
6501
6502
6503
6504
6505
6506
6507
6508
6509
6510
6511
6512
6513
6514
6515
6516
6517
6518
6519
6520
6521
6522
6523
6524
6525
6526
6527
6528
6529
6530
6531
6532
6533
6534
6535
6536
6537
6538
6539
6540
6541
6542
6543
6544
6545
6546
6547
6548
6549
6550
6551
6552
6553
6554
6555
6556
6557
6558
6559
6560
6561
6562
6563
6564
6565
6566
6567
6568
6569
6570
6571
6572
6573
6574
6575
6576
6577
6578
6579
6580
6581
6582
6583
6584
6585
6586
6587
6588
6589
6590
6591
6592
6593
6594
6595
6596
6597
6598
6599
6600
6601
6602
6603
6604
6605
6606
6607
6608
6609
6610
6611
6612
6613
6614
6615
6616
6617
6618
6619
6620
6621
6622
6623
6624
6625
6626
6627
6628
6629
6630
6631
6632
6633
6634
6635
6636
6637
6638
6639
6640
6641
6642
6643
6644
6645
6646
6647
6648
6649
6650
6651
6652
6653
6654
6655
6656
6657
6658
6659
6660
6661
6662
6663
6664
6665
6666
6667
6668
6669
6670
6671
6672
6673
6674
6675
6676
6677
6678
6679
6680
6681
6682
6683
6684
6685
6686
6687
6688
6689
6690
6691
6692
6693
6694
6695
6696
6697
6698
6699
6700
6701
6702
6703
6704
6705
6706
6707
6708
6709
6710
6711
6712
6713
6714
6715
6716
6717
6718
6719
6720
6721
6722
6723
6724
6725
6726
6727
6728
6729
6730
6731
6732
6733
6734
6735
6736
6737
6738
6739
6740
6741
6742
6743
6744
6745
6746
6747
6748
6749
6750
6751
6752
6753
6754
6755
6756
6757
6758
6759
6760
6761
6762
6763
6764
6765
6766
6767
6768
6769
6770
6771
6772
6773
6774
6775
6776
6777
6778
6779
6780
6781
6782
6783
6784
6785
6786
6787
6788
6789
6790
6791
6792
6793
6794
6795
6796
6797
6798
6799
6800
6801
6802
6803
6804
6805
6806
6807
6808
6809
6810
6811
6812
6813
6814
6815
6816
6817
6818
6819
6820
6821
6822
6823
6824
6825
6826
6827
6828
6829
6830
6831
6832
6833
6834
6835
6836
6837
6838
6839
6840
6841
6842
6843
6844
6845
6846
6847
6848
6849
6850
6851
6852
6853
6854
6855
6856
6857
6858
6859
6860
6861
6862
6863
6864
6865
6866
6867
6868
6869
6870
6871
6872
6873
6874
6875
6876
6877
6878
6879
6880
6881
6882
6883
6884
6885
6886
6887
6888
6889
6890
6891
6892
6893
6894
6895
6896
6897
6898
6899
6900
6901
6902
6903
6904
6905
6906
6907
6908
6909
6910
6911
6912
6913
6914
6915
6916
6917
6918
6919
6920
6921
6922
6923
6924
6925
6926
6927
6928
6929
6930
6931
6932
6933
6934
6935
6936
6937
6938
6939
6940
6941
6942
6943
6944
6945
6946
6947
6948
6949
6950
6951
6952
6953
6954
6955
6956
6957
6958
6959
6960
6961
6962
6963
6964
6965
6966
6967
6968
6969
6970
6971
6972
6973
6974
6975
6976
6977
6978
6979
6980
6981
6982
6983
6984
6985
6986
6987
6988
6989
6990
6991
6992
6993
6994
6995
6996
6997
6998
6999
7000
7001
7002
7003
7004
7005
7006
7007
7008
7009
7010
7011
7012
7013
7014
7015
7016
7017
7018
7019
7020
7021
7022
7023
7024
7025
7026
7027
7028
7029
7030
7031
7032
7033
7034
7035
7036
7037
7038
7039
7040
7041
7042
7043
7044
7045
7046
7047
7048
7049
7050
7051
7052
7053
7054
7055
7056
7057
7058
7059
7060
7061
7062
7063
7064
7065
7066
7067
7068
7069
7070
7071
7072
7073
7074
7075
7076
7077
7078
7079
7080
7081
7082
7083
7084
7085
7086
7087
7088
7089
7090
7091
7092
7093
7094
7095
7096
7097
7098
7099
7100
7101
7102
7103
7104
7105
7106
7107
7108
7109
7110
7111
7112
7113
7114
7115
7116
7117
7118
7119
7120
7121
7122
7123
7124
7125
7126
7127
7128
7129
7130
7131
7132
7133
7134
7135
7136
7137
7138
7139
7140
7141
7142
7143
7144
7145
7146
7147
7148
7149
7150
7151
7152
7153
7154
7155
7156
7157
7158
7159
7160
7161
7162
7163
7164
7165
7166
7167
7168
7169
7170
7171
7172
7173
7174
7175
7176
7177
7178
7179
7180
7181
7182
7183
7184
7185
7186
7187
7188
7189
7190
7191
7192
7193
7194
7195
7196
7197
7198
7199
7200
7201
7202
7203
7204
7205
7206
7207
7208
7209
7210
7211
7212
7213
7214
7215
7216
7217
7218
7219
7220
7221
7222
7223
7224
7225
7226
7227
7228
7229
7230
7231
7232
7233
7234
7235
7236
7237
7238
7239
7240
7241
7242
7243
7244
7245
7246
7247
7248
7249
7250
7251
7252
7253
7254
7255
7256
7257
7258
7259
7260
7261
7262
7263
7264
7265
7266
7267
7268
7269
7270
7271
7272
7273
7274
7275
7276
7277
7278
7279
7280
7281
7282
7283
7284
7285
7286
7287
7288
7289
7290
7291
7292
7293
7294
7295
7296
7297
7298
7299
7300
7301
7302
7303
7304
7305
7306
7307
7308
7309
7310
7311
7312
7313
7314
7315
7316
7317
7318
7319
7320
7321
7322
7323
7324
7325
7326
7327
7328
7329
7330
7331
7332
7333
7334
7335
7336
7337
7338
7339
7340
7341
7342
7343
7344
7345
7346
7347
7348
7349
7350
7351
7352
7353
7354
7355
7356
7357
7358
7359
7360
7361
7362
7363
7364
7365
7366
7367
7368
7369
7370
7371
7372
7373
7374
7375
7376
7377
7378
7379
7380
7381
7382
7383
7384
7385
7386
7387
7388
7389
7390
7391
7392
7393
7394
7395
7396
7397
7398
7399
7400
7401
7402
7403
7404
7405
7406
7407
7408
7409
7410
7411
7412
7413
7414
7415
7416
7417
7418
7419
7420
7421
7422
7423
7424
7425
7426
7427
7428
7429
7430
7431
7432
7433
7434
7435
7436
7437
7438
7439
7440
7441
7442
7443
7444
7445
7446
7447
7448
7449
7450
7451
7452
7453
7454
7455
7456
7457
7458
7459
7460
7461
7462
7463
7464
7465
7466
7467
7468
7469
7470
7471
7472
7473
7474
7475
7476
7477
7478
7479
7480
7481
7482
7483
7484
7485
7486
7487
7488
7489
7490
7491
7492
7493
7494
7495
7496
7497
7498
7499
7500
7501
7502
7503
7504
7505
7506
7507
7508
7509
7510
7511
7512
7513
7514
7515
7516
7517
7518
7519
7520
7521
7522
7523
7524
7525
7526
7527
7528
7529
7530
7531
7532
7533
7534
7535
7536
7537
7538
7539
7540
7541
7542
7543
7544
7545
7546
7547
7548
7549
7550
7551
7552
7553
7554
7555
7556
7557
7558
7559
7560
7561
7562
7563
7564
7565
7566
7567
7568
7569
7570
7571
7572
7573
7574
7575
7576
7577
7578
7579
7580
7581
7582
7583
7584
7585
7586
7587
7588
7589
7590
7591
7592
7593
7594
7595
7596
7597
7598
7599
7600
7601
7602
7603
7604
7605
7606
7607
7608
7609
7610
7611
7612
7613
7614
7615
7616
7617
7618
7619
7620
7621
7622
7623
7624
7625
7626
7627
7628
7629
7630
7631
7632
7633
7634
7635
7636
7637
7638
7639
7640
7641
7642
7643
7644
7645
7646
7647
7648
7649
7650
7651
7652
7653
7654
7655
7656
7657
7658
7659
7660
7661
7662
7663
7664
7665
7666
7667
7668
7669
7670
7671
7672
7673
7674
7675
7676
7677
7678
7679
7680
7681
7682
7683
7684
7685
7686
7687
7688
7689
7690
7691
7692
7693
7694
7695
7696
7697
7698
7699
7700
7701
7702
7703
7704
7705
7706
7707
7708
7709
7710
7711
7712
7713
7714
7715
7716
7717
7718
7719
7720
7721
7722
7723
7724
7725
7726
7727
7728
7729
7730
7731
7732
7733
7734
7735
7736
7737
7738
7739
7740
7741
7742
7743
7744
7745
7746
7747
7748
7749
7750
7751
7752
7753
7754
7755
7756
7757
7758
7759
7760
7761
7762
7763
7764
7765
7766
7767
7768
7769
7770
7771
7772
7773
7774
7775
7776
7777
7778
7779
7780
7781
7782
7783
7784
7785
7786
7787
7788
7789
7790
7791
7792
7793
7794
7795
7796
7797
7798
7799
7800
7801
7802
7803
7804
7805
7806
7807
7808
7809
7810
7811
7812
7813
7814
7815
7816
7817
7818
7819
7820
7821
7822
7823
7824
7825
7826
7827
7828
7829
7830
7831
7832
7833
7834
7835
7836
7837
7838
7839
7840
7841
7842
7843
7844
7845
7846
7847
7848
7849
7850
7851
7852
7853
7854
7855
7856
7857
7858
7859
7860
7861
7862
7863
7864
7865
7866
7867
7868
7869
7870
7871
7872
7873
7874
7875
7876
7877
7878
7879
7880
7881
7882
7883
7884
7885
7886
7887
7888
7889
7890
7891
7892
7893
7894
7895
7896
7897
7898
7899
7900
7901
7902
7903
7904
7905
7906
7907
7908
7909
7910
7911
7912
7913
7914
7915
7916
7917
7918
7919
7920
7921
7922
7923
7924
7925
7926
7927
7928
7929
7930
7931
7932
7933
7934
7935
7936
7937
7938
7939
7940
7941
7942
7943
7944
7945
7946
7947
7948
7949
7950
7951
7952
7953
7954
7955
7956
7957
7958
7959
7960
7961
7962
7963
7964
7965
7966
7967
7968
7969
7970
7971
7972
7973
7974
7975
7976
7977
7978
7979
7980
7981
7982
7983
7984
7985
7986
7987
7988
7989
7990
7991
7992
7993
7994
7995
7996
7997
7998
7999
8000
8001
8002
8003
8004
8005
8006
8007
8008
8009
8010
8011
8012
8013
8014
8015
8016
8017
8018
8019
8020
8021
8022
8023
8024
8025
8026
8027
8028
8029
8030
8031
8032
8033
8034
8035
8036
8037
8038
8039
8040
8041
8042
8043
8044
8045
8046
8047
8048
8049
8050
8051
8052
8053
8054
8055
8056
8057
8058
8059
8060
8061
8062
8063
8064
8065
8066
8067
8068
8069
8070
8071
8072
8073
8074
8075
8076
8077
8078
8079
8080
8081
8082
8083
8084
8085
8086
8087
8088
8089
8090
8091
8092
8093
8094
8095
8096
8097
8098
8099
8100
8101
8102
8103
8104
8105
8106
8107
8108
8109
8110
8111
8112
8113
8114
8115
8116
8117
8118
8119
8120
8121
8122
8123
8124
8125
8126
8127
8128
8129
8130
8131
8132
8133
8134
8135
8136
8137
8138
8139
8140
8141
8142
8143
8144
8145
8146
8147
8148
8149
8150
8151
8152
8153
8154
8155
8156
8157
8158
8159
8160
8161
8162
8163
8164
8165
8166
8167
8168
8169
8170
8171
8172
8173
8174
8175
8176
8177
8178
8179
8180
8181
8182
8183
8184
8185
8186
8187
8188
8189
8190
8191
8192
8193
8194
8195
8196
8197
8198
8199
8200
8201
8202
8203
8204
8205
8206
8207
8208
8209
8210
8211
8212
8213
8214
8215
8216
8217
8218
8219
8220
8221
8222
8223
8224
8225
8226
8227
8228
8229
8230
8231
8232
8233
8234
8235
8236
8237
8238
8239
8240
8241
8242
8243
8244
8245
8246
8247
8248
8249
8250
8251
8252
8253
8254
8255
8256
8257
8258
8259
8260
8261
8262
8263
8264
8265
8266
8267
8268
8269
8270
8271
8272
8273
8274
8275
8276
8277
8278
8279
8280
8281
8282
8283
8284
8285
8286
8287
8288
8289
8290
8291
8292
8293
8294
8295
8296
8297
8298
8299
8300
8301
8302
8303
8304
8305
8306
8307
8308
8309
8310
8311
8312
8313
8314
8315
8316
8317
8318
8319
8320
8321
8322
8323
8324
8325
8326
8327
8328
8329
8330
8331
8332
8333
8334
8335
8336
8337
8338
8339
8340
8341
8342
8343
8344
8345
8346
8347
8348
8349
8350
8351
8352
8353
8354
8355
8356
8357
8358
8359
8360
8361
8362
8363
8364
8365
8366
8367
8368
8369
8370
8371
8372
8373
8374
8375
8376
8377
8378
8379
8380
8381
8382
8383
8384
8385
8386
8387
8388
8389
8390
8391
8392
8393
8394
8395
8396
8397
8398
8399
8400
8401
8402
8403
8404
8405
8406
8407
8408
8409
8410
8411
8412
8413
8414
8415
8416
8417
8418
8419
8420
8421
8422
8423
8424
8425
8426
8427
8428
8429
8430
8431
8432
8433
8434
8435
8436
8437
8438
8439
8440
8441
8442
8443
8444
8445
8446
8447
8448
8449
8450
8451
8452
8453
8454
8455
8456
8457
8458
8459
8460
8461
8462
8463
8464
8465
8466
8467
8468
8469
8470
8471
8472
8473
8474
8475
8476
8477
8478
8479
8480
8481
8482
8483
8484
8485
8486
8487
8488
import {Request} from '../lib/request';
import {Response} from '../lib/response';
import {AWSError} from '../lib/error';
import {Service} from '../lib/service';
import {ServiceConfigurationOptions} from '../lib/service';
import {ConfigBase as Config} from '../lib/config';
interface Blob {}
declare class SSM extends Service {
/**
* Constructs a service object. This object has one method for each API operation.
*/
constructor(options?: SSM.Types.ClientConfiguration)
config: Config & SSM.Types.ClientConfiguration;
/**
* Adds or overwrites one or more tags for the specified resource. Tags are metadata that you can assign to your documents, managed instances, maintenance windows, Parameter Store parameters, and patch baselines. Tags enable you to categorize your resources in different ways, for example, by purpose, owner, or environment. Each tag consists of a key and an optional value, both of which you define. For example, you could define a set of tags for your account's managed instances that helps you track each instance's owner and stack level. For example: Key=Owner and Value=DbAdmin, SysAdmin, or Dev. Or Key=Stack and Value=Production, Pre-Production, or Test. Each resource can have a maximum of 50 tags. We recommend that you devise a set of tag keys that meets your needs for each resource type. Using a consistent set of tag keys makes it easier for you to manage your resources. You can search and filter the resources based on the tags you add. Tags don't have any semantic meaning to Amazon EC2 and are interpreted strictly as a string of characters. For more information about tags, see Tagging Your Amazon EC2 Resources in the Amazon EC2 User Guide.
*/
addTagsToResource(params: SSM.Types.AddTagsToResourceRequest, callback?: (err: AWSError, data: SSM.Types.AddTagsToResourceResult) => void): Request<SSM.Types.AddTagsToResourceResult, AWSError>;
/**
* Adds or overwrites one or more tags for the specified resource. Tags are metadata that you can assign to your documents, managed instances, maintenance windows, Parameter Store parameters, and patch baselines. Tags enable you to categorize your resources in different ways, for example, by purpose, owner, or environment. Each tag consists of a key and an optional value, both of which you define. For example, you could define a set of tags for your account's managed instances that helps you track each instance's owner and stack level. For example: Key=Owner and Value=DbAdmin, SysAdmin, or Dev. Or Key=Stack and Value=Production, Pre-Production, or Test. Each resource can have a maximum of 50 tags. We recommend that you devise a set of tag keys that meets your needs for each resource type. Using a consistent set of tag keys makes it easier for you to manage your resources. You can search and filter the resources based on the tags you add. Tags don't have any semantic meaning to Amazon EC2 and are interpreted strictly as a string of characters. For more information about tags, see Tagging Your Amazon EC2 Resources in the Amazon EC2 User Guide.
*/
addTagsToResource(callback?: (err: AWSError, data: SSM.Types.AddTagsToResourceResult) => void): Request<SSM.Types.AddTagsToResourceResult, AWSError>;
/**
* Attempts to cancel the command specified by the Command ID. There is no guarantee that the command will be terminated and the underlying process stopped.
*/
cancelCommand(params: SSM.Types.CancelCommandRequest, callback?: (err: AWSError, data: SSM.Types.CancelCommandResult) => void): Request<SSM.Types.CancelCommandResult, AWSError>;
/**
* Attempts to cancel the command specified by the Command ID. There is no guarantee that the command will be terminated and the underlying process stopped.
*/
cancelCommand(callback?: (err: AWSError, data: SSM.Types.CancelCommandResult) => void): Request<SSM.Types.CancelCommandResult, AWSError>;
/**
* Stops a maintenance window execution that is already in progress and cancels any tasks in the window that have not already starting running. (Tasks already in progress will continue to completion.)
*/
cancelMaintenanceWindowExecution(params: SSM.Types.CancelMaintenanceWindowExecutionRequest, callback?: (err: AWSError, data: SSM.Types.CancelMaintenanceWindowExecutionResult) => void): Request<SSM.Types.CancelMaintenanceWindowExecutionResult, AWSError>;
/**
* Stops a maintenance window execution that is already in progress and cancels any tasks in the window that have not already starting running. (Tasks already in progress will continue to completion.)
*/
cancelMaintenanceWindowExecution(callback?: (err: AWSError, data: SSM.Types.CancelMaintenanceWindowExecutionResult) => void): Request<SSM.Types.CancelMaintenanceWindowExecutionResult, AWSError>;
/**
* Registers your on-premises server or virtual machine with Amazon EC2 so that you can manage these resources using Run Command. An on-premises server or virtual machine that has been registered with EC2 is called a managed instance. For more information about activations, see Setting Up AWS Systems Manager for Hybrid Environments.
*/
createActivation(params: SSM.Types.CreateActivationRequest, callback?: (err: AWSError, data: SSM.Types.CreateActivationResult) => void): Request<SSM.Types.CreateActivationResult, AWSError>;
/**
* Registers your on-premises server or virtual machine with Amazon EC2 so that you can manage these resources using Run Command. An on-premises server or virtual machine that has been registered with EC2 is called a managed instance. For more information about activations, see Setting Up AWS Systems Manager for Hybrid Environments.
*/
createActivation(callback?: (err: AWSError, data: SSM.Types.CreateActivationResult) => void): Request<SSM.Types.CreateActivationResult, AWSError>;
/**
* Associates the specified Systems Manager document with the specified instances or targets. When you associate a document with one or more instances using instance IDs or tags, SSM Agent running on the instance processes the document and configures the instance as specified. If you associate a document with an instance that already has an associated document, the system returns the AssociationAlreadyExists exception.
*/
createAssociation(params: SSM.Types.CreateAssociationRequest, callback?: (err: AWSError, data: SSM.Types.CreateAssociationResult) => void): Request<SSM.Types.CreateAssociationResult, AWSError>;
/**
* Associates the specified Systems Manager document with the specified instances or targets. When you associate a document with one or more instances using instance IDs or tags, SSM Agent running on the instance processes the document and configures the instance as specified. If you associate a document with an instance that already has an associated document, the system returns the AssociationAlreadyExists exception.
*/
createAssociation(callback?: (err: AWSError, data: SSM.Types.CreateAssociationResult) => void): Request<SSM.Types.CreateAssociationResult, AWSError>;
/**
* Associates the specified Systems Manager document with the specified instances or targets. When you associate a document with one or more instances using instance IDs or tags, SSM Agent running on the instance processes the document and configures the instance as specified. If you associate a document with an instance that already has an associated document, the system returns the AssociationAlreadyExists exception.
*/
createAssociationBatch(params: SSM.Types.CreateAssociationBatchRequest, callback?: (err: AWSError, data: SSM.Types.CreateAssociationBatchResult) => void): Request<SSM.Types.CreateAssociationBatchResult, AWSError>;
/**
* Associates the specified Systems Manager document with the specified instances or targets. When you associate a document with one or more instances using instance IDs or tags, SSM Agent running on the instance processes the document and configures the instance as specified. If you associate a document with an instance that already has an associated document, the system returns the AssociationAlreadyExists exception.
*/
createAssociationBatch(callback?: (err: AWSError, data: SSM.Types.CreateAssociationBatchResult) => void): Request<SSM.Types.CreateAssociationBatchResult, AWSError>;
/**
* Creates a Systems Manager document. After you create a document, you can use CreateAssociation to associate it with one or more running instances.
*/
createDocument(params: SSM.Types.CreateDocumentRequest, callback?: (err: AWSError, data: SSM.Types.CreateDocumentResult) => void): Request<SSM.Types.CreateDocumentResult, AWSError>;
/**
* Creates a Systems Manager document. After you create a document, you can use CreateAssociation to associate it with one or more running instances.
*/
createDocument(callback?: (err: AWSError, data: SSM.Types.CreateDocumentResult) => void): Request<SSM.Types.CreateDocumentResult, AWSError>;
/**
* Creates a new maintenance window. The value you specify for Duration determines the specific end time for the maintenance window based on the time it begins. No maintenance window tasks are permitted to start after the resulting endtime minus the number of hours you specify for Cutoff. For example, if the maintenance window starts at 3 PM, the duration is three hours, and the value you specify for Cutoff is one hour, no maintenance window tasks can start after 5 PM.
*/
createMaintenanceWindow(params: SSM.Types.CreateMaintenanceWindowRequest, callback?: (err: AWSError, data: SSM.Types.CreateMaintenanceWindowResult) => void): Request<SSM.Types.CreateMaintenanceWindowResult, AWSError>;
/**
* Creates a new maintenance window. The value you specify for Duration determines the specific end time for the maintenance window based on the time it begins. No maintenance window tasks are permitted to start after the resulting endtime minus the number of hours you specify for Cutoff. For example, if the maintenance window starts at 3 PM, the duration is three hours, and the value you specify for Cutoff is one hour, no maintenance window tasks can start after 5 PM.
*/
createMaintenanceWindow(callback?: (err: AWSError, data: SSM.Types.CreateMaintenanceWindowResult) => void): Request<SSM.Types.CreateMaintenanceWindowResult, AWSError>;
/**
* Creates a new OpsItem. You must have permission in AWS Identity and Access Management (IAM) to create a new OpsItem. For more information, see Getting Started with OpsCenter in the AWS Systems Manager User Guide. Operations engineers and IT professionals use OpsCenter to view, investigate, and remediate operational issues impacting the performance and health of their AWS resources. For more information, see AWS Systems Manager OpsCenter in the AWS Systems Manager User Guide.
*/
createOpsItem(params: SSM.Types.CreateOpsItemRequest, callback?: (err: AWSError, data: SSM.Types.CreateOpsItemResponse) => void): Request<SSM.Types.CreateOpsItemResponse, AWSError>;
/**
* Creates a new OpsItem. You must have permission in AWS Identity and Access Management (IAM) to create a new OpsItem. For more information, see Getting Started with OpsCenter in the AWS Systems Manager User Guide. Operations engineers and IT professionals use OpsCenter to view, investigate, and remediate operational issues impacting the performance and health of their AWS resources. For more information, see AWS Systems Manager OpsCenter in the AWS Systems Manager User Guide.
*/
createOpsItem(callback?: (err: AWSError, data: SSM.Types.CreateOpsItemResponse) => void): Request<SSM.Types.CreateOpsItemResponse, AWSError>;
/**
* Creates a patch baseline. For information about valid key and value pairs in PatchFilters for each supported operating system type, see PatchFilter.
*/
createPatchBaseline(params: SSM.Types.CreatePatchBaselineRequest, callback?: (err: AWSError, data: SSM.Types.CreatePatchBaselineResult) => void): Request<SSM.Types.CreatePatchBaselineResult, AWSError>;
/**
* Creates a patch baseline. For information about valid key and value pairs in PatchFilters for each supported operating system type, see PatchFilter.
*/
createPatchBaseline(callback?: (err: AWSError, data: SSM.Types.CreatePatchBaselineResult) => void): Request<SSM.Types.CreatePatchBaselineResult, AWSError>;
/**
* A resource data sync helps you view data from multiple sources in a single location. Systems Manager offers two types of resource data sync: SyncToDestination and SyncFromSource. You can configure Systems Manager Inventory to use the SyncToDestination type to synchronize Inventory data from multiple AWS Regions to a single Amazon S3 bucket. For more information, see Configuring Resource Data Sync for Inventory in the AWS Systems Manager User Guide. You can configure Systems Manager Explorer to use the SyncToDestination type to synchronize operational work items (OpsItems) and operational data (OpsData) from multiple AWS Regions to a single Amazon S3 bucket. You can also configure Explorer to use the SyncFromSource type. This type synchronizes OpsItems and OpsData from multiple AWS accounts and Regions by using AWS Organizations. For more information, see Setting Up Explorer to Display Data from Multiple Accounts and Regions in the AWS Systems Manager User Guide. A resource data sync is an asynchronous operation that returns immediately. After a successful initial sync is completed, the system continuously syncs data. To check the status of a sync, use the ListResourceDataSync. By default, data is not encrypted in Amazon S3. We strongly recommend that you enable encryption in Amazon S3 to ensure secure data storage. We also recommend that you secure access to the Amazon S3 bucket by creating a restrictive bucket policy.
*/
createResourceDataSync(params: SSM.Types.CreateResourceDataSyncRequest, callback?: (err: AWSError, data: SSM.Types.CreateResourceDataSyncResult) => void): Request<SSM.Types.CreateResourceDataSyncResult, AWSError>;
/**
* A resource data sync helps you view data from multiple sources in a single location. Systems Manager offers two types of resource data sync: SyncToDestination and SyncFromSource. You can configure Systems Manager Inventory to use the SyncToDestination type to synchronize Inventory data from multiple AWS Regions to a single Amazon S3 bucket. For more information, see Configuring Resource Data Sync for Inventory in the AWS Systems Manager User Guide. You can configure Systems Manager Explorer to use the SyncToDestination type to synchronize operational work items (OpsItems) and operational data (OpsData) from multiple AWS Regions to a single Amazon S3 bucket. You can also configure Explorer to use the SyncFromSource type. This type synchronizes OpsItems and OpsData from multiple AWS accounts and Regions by using AWS Organizations. For more information, see Setting Up Explorer to Display Data from Multiple Accounts and Regions in the AWS Systems Manager User Guide. A resource data sync is an asynchronous operation that returns immediately. After a successful initial sync is completed, the system continuously syncs data. To check the status of a sync, use the ListResourceDataSync. By default, data is not encrypted in Amazon S3. We strongly recommend that you enable encryption in Amazon S3 to ensure secure data storage. We also recommend that you secure access to the Amazon S3 bucket by creating a restrictive bucket policy.
*/
createResourceDataSync(callback?: (err: AWSError, data: SSM.Types.CreateResourceDataSyncResult) => void): Request<SSM.Types.CreateResourceDataSyncResult, AWSError>;
/**
* Deletes an activation. You are not required to delete an activation. If you delete an activation, you can no longer use it to register additional managed instances. Deleting an activation does not de-register managed instances. You must manually de-register managed instances.
*/
deleteActivation(params: SSM.Types.DeleteActivationRequest, callback?: (err: AWSError, data: SSM.Types.DeleteActivationResult) => void): Request<SSM.Types.DeleteActivationResult, AWSError>;
/**
* Deletes an activation. You are not required to delete an activation. If you delete an activation, you can no longer use it to register additional managed instances. Deleting an activation does not de-register managed instances. You must manually de-register managed instances.
*/
deleteActivation(callback?: (err: AWSError, data: SSM.Types.DeleteActivationResult) => void): Request<SSM.Types.DeleteActivationResult, AWSError>;
/**
* Disassociates the specified Systems Manager document from the specified instance. When you disassociate a document from an instance, it does not change the configuration of the instance. To change the configuration state of an instance after you disassociate a document, you must create a new document with the desired configuration and associate it with the instance.
*/
deleteAssociation(params: SSM.Types.DeleteAssociationRequest, callback?: (err: AWSError, data: SSM.Types.DeleteAssociationResult) => void): Request<SSM.Types.DeleteAssociationResult, AWSError>;
/**
* Disassociates the specified Systems Manager document from the specified instance. When you disassociate a document from an instance, it does not change the configuration of the instance. To change the configuration state of an instance after you disassociate a document, you must create a new document with the desired configuration and associate it with the instance.
*/
deleteAssociation(callback?: (err: AWSError, data: SSM.Types.DeleteAssociationResult) => void): Request<SSM.Types.DeleteAssociationResult, AWSError>;
/**
* Deletes the Systems Manager document and all instance associations to the document. Before you delete the document, we recommend that you use DeleteAssociation to disassociate all instances that are associated with the document.
*/
deleteDocument(params: SSM.Types.DeleteDocumentRequest, callback?: (err: AWSError, data: SSM.Types.DeleteDocumentResult) => void): Request<SSM.Types.DeleteDocumentResult, AWSError>;
/**
* Deletes the Systems Manager document and all instance associations to the document. Before you delete the document, we recommend that you use DeleteAssociation to disassociate all instances that are associated with the document.
*/
deleteDocument(callback?: (err: AWSError, data: SSM.Types.DeleteDocumentResult) => void): Request<SSM.Types.DeleteDocumentResult, AWSError>;
/**
* Delete a custom inventory type, or the data associated with a custom Inventory type. Deleting a custom inventory type is also referred to as deleting a custom inventory schema.
*/
deleteInventory(params: SSM.Types.DeleteInventoryRequest, callback?: (err: AWSError, data: SSM.Types.DeleteInventoryResult) => void): Request<SSM.Types.DeleteInventoryResult, AWSError>;
/**
* Delete a custom inventory type, or the data associated with a custom Inventory type. Deleting a custom inventory type is also referred to as deleting a custom inventory schema.
*/
deleteInventory(callback?: (err: AWSError, data: SSM.Types.DeleteInventoryResult) => void): Request<SSM.Types.DeleteInventoryResult, AWSError>;
/**
* Deletes a maintenance window.
*/
deleteMaintenanceWindow(params: SSM.Types.DeleteMaintenanceWindowRequest, callback?: (err: AWSError, data: SSM.Types.DeleteMaintenanceWindowResult) => void): Request<SSM.Types.DeleteMaintenanceWindowResult, AWSError>;
/**
* Deletes a maintenance window.
*/
deleteMaintenanceWindow(callback?: (err: AWSError, data: SSM.Types.DeleteMaintenanceWindowResult) => void): Request<SSM.Types.DeleteMaintenanceWindowResult, AWSError>;
/**
* Delete a parameter from the system.
*/
deleteParameter(params: SSM.Types.DeleteParameterRequest, callback?: (err: AWSError, data: SSM.Types.DeleteParameterResult) => void): Request<SSM.Types.DeleteParameterResult, AWSError>;
/**
* Delete a parameter from the system.
*/
deleteParameter(callback?: (err: AWSError, data: SSM.Types.DeleteParameterResult) => void): Request<SSM.Types.DeleteParameterResult, AWSError>;
/**
* Delete a list of parameters.
*/
deleteParameters(params: SSM.Types.DeleteParametersRequest, callback?: (err: AWSError, data: SSM.Types.DeleteParametersResult) => void): Request<SSM.Types.DeleteParametersResult, AWSError>;
/**
* Delete a list of parameters.
*/
deleteParameters(callback?: (err: AWSError, data: SSM.Types.DeleteParametersResult) => void): Request<SSM.Types.DeleteParametersResult, AWSError>;
/**
* Deletes a patch baseline.
*/
deletePatchBaseline(params: SSM.Types.DeletePatchBaselineRequest, callback?: (err: AWSError, data: SSM.Types.DeletePatchBaselineResult) => void): Request<SSM.Types.DeletePatchBaselineResult, AWSError>;
/**
* Deletes a patch baseline.
*/
deletePatchBaseline(callback?: (err: AWSError, data: SSM.Types.DeletePatchBaselineResult) => void): Request<SSM.Types.DeletePatchBaselineResult, AWSError>;
/**
* Deletes a Resource Data Sync configuration. After the configuration is deleted, changes to data on managed instances are no longer synced to or from the target. Deleting a sync configuration does not delete data.
*/
deleteResourceDataSync(params: SSM.Types.DeleteResourceDataSyncRequest, callback?: (err: AWSError, data: SSM.Types.DeleteResourceDataSyncResult) => void): Request<SSM.Types.DeleteResourceDataSyncResult, AWSError>;
/**
* Deletes a Resource Data Sync configuration. After the configuration is deleted, changes to data on managed instances are no longer synced to or from the target. Deleting a sync configuration does not delete data.
*/
deleteResourceDataSync(callback?: (err: AWSError, data: SSM.Types.DeleteResourceDataSyncResult) => void): Request<SSM.Types.DeleteResourceDataSyncResult, AWSError>;
/**
* Removes the server or virtual machine from the list of registered servers. You can reregister the instance again at any time. If you don't plan to use Run Command on the server, we suggest uninstalling SSM Agent first.
*/
deregisterManagedInstance(params: SSM.Types.DeregisterManagedInstanceRequest, callback?: (err: AWSError, data: SSM.Types.DeregisterManagedInstanceResult) => void): Request<SSM.Types.DeregisterManagedInstanceResult, AWSError>;
/**
* Removes the server or virtual machine from the list of registered servers. You can reregister the instance again at any time. If you don't plan to use Run Command on the server, we suggest uninstalling SSM Agent first.
*/
deregisterManagedInstance(callback?: (err: AWSError, data: SSM.Types.DeregisterManagedInstanceResult) => void): Request<SSM.Types.DeregisterManagedInstanceResult, AWSError>;
/**
* Removes a patch group from a patch baseline.
*/
deregisterPatchBaselineForPatchGroup(params: SSM.Types.DeregisterPatchBaselineForPatchGroupRequest, callback?: (err: AWSError, data: SSM.Types.DeregisterPatchBaselineForPatchGroupResult) => void): Request<SSM.Types.DeregisterPatchBaselineForPatchGroupResult, AWSError>;
/**
* Removes a patch group from a patch baseline.
*/
deregisterPatchBaselineForPatchGroup(callback?: (err: AWSError, data: SSM.Types.DeregisterPatchBaselineForPatchGroupResult) => void): Request<SSM.Types.DeregisterPatchBaselineForPatchGroupResult, AWSError>;
/**
* Removes a target from a maintenance window.
*/
deregisterTargetFromMaintenanceWindow(params: SSM.Types.DeregisterTargetFromMaintenanceWindowRequest, callback?: (err: AWSError, data: SSM.Types.DeregisterTargetFromMaintenanceWindowResult) => void): Request<SSM.Types.DeregisterTargetFromMaintenanceWindowResult, AWSError>;
/**
* Removes a target from a maintenance window.
*/
deregisterTargetFromMaintenanceWindow(callback?: (err: AWSError, data: SSM.Types.DeregisterTargetFromMaintenanceWindowResult) => void): Request<SSM.Types.DeregisterTargetFromMaintenanceWindowResult, AWSError>;
/**
* Removes a task from a maintenance window.
*/
deregisterTaskFromMaintenanceWindow(params: SSM.Types.DeregisterTaskFromMaintenanceWindowRequest, callback?: (err: AWSError, data: SSM.Types.DeregisterTaskFromMaintenanceWindowResult) => void): Request<SSM.Types.DeregisterTaskFromMaintenanceWindowResult, AWSError>;
/**
* Removes a task from a maintenance window.
*/
deregisterTaskFromMaintenanceWindow(callback?: (err: AWSError, data: SSM.Types.DeregisterTaskFromMaintenanceWindowResult) => void): Request<SSM.Types.DeregisterTaskFromMaintenanceWindowResult, AWSError>;
/**
* Describes details about the activation, such as the date and time the activation was created, its expiration date, the IAM role assigned to the instances in the activation, and the number of instances registered by using this activation.
*/
describeActivations(params: SSM.Types.DescribeActivationsRequest, callback?: (err: AWSError, data: SSM.Types.DescribeActivationsResult) => void): Request<SSM.Types.DescribeActivationsResult, AWSError>;
/**
* Describes details about the activation, such as the date and time the activation was created, its expiration date, the IAM role assigned to the instances in the activation, and the number of instances registered by using this activation.
*/
describeActivations(callback?: (err: AWSError, data: SSM.Types.DescribeActivationsResult) => void): Request<SSM.Types.DescribeActivationsResult, AWSError>;
/**
* Describes the association for the specified target or instance. If you created the association by using the Targets parameter, then you must retrieve the association by using the association ID. If you created the association by specifying an instance ID and a Systems Manager document, then you retrieve the association by specifying the document name and the instance ID.
*/
describeAssociation(params: SSM.Types.DescribeAssociationRequest, callback?: (err: AWSError, data: SSM.Types.DescribeAssociationResult) => void): Request<SSM.Types.DescribeAssociationResult, AWSError>;
/**
* Describes the association for the specified target or instance. If you created the association by using the Targets parameter, then you must retrieve the association by using the association ID. If you created the association by specifying an instance ID and a Systems Manager document, then you retrieve the association by specifying the document name and the instance ID.
*/
describeAssociation(callback?: (err: AWSError, data: SSM.Types.DescribeAssociationResult) => void): Request<SSM.Types.DescribeAssociationResult, AWSError>;
/**
* Use this API action to view information about a specific execution of a specific association.
*/
describeAssociationExecutionTargets(params: SSM.Types.DescribeAssociationExecutionTargetsRequest, callback?: (err: AWSError, data: SSM.Types.DescribeAssociationExecutionTargetsResult) => void): Request<SSM.Types.DescribeAssociationExecutionTargetsResult, AWSError>;
/**
* Use this API action to view information about a specific execution of a specific association.
*/
describeAssociationExecutionTargets(callback?: (err: AWSError, data: SSM.Types.DescribeAssociationExecutionTargetsResult) => void): Request<SSM.Types.DescribeAssociationExecutionTargetsResult, AWSError>;
/**
* Use this API action to view all executions for a specific association ID.
*/
describeAssociationExecutions(params: SSM.Types.DescribeAssociationExecutionsRequest, callback?: (err: AWSError, data: SSM.Types.DescribeAssociationExecutionsResult) => void): Request<SSM.Types.DescribeAssociationExecutionsResult, AWSError>;
/**
* Use this API action to view all executions for a specific association ID.
*/
describeAssociationExecutions(callback?: (err: AWSError, data: SSM.Types.DescribeAssociationExecutionsResult) => void): Request<SSM.Types.DescribeAssociationExecutionsResult, AWSError>;
/**
* Provides details about all active and terminated Automation executions.
*/
describeAutomationExecutions(params: SSM.Types.DescribeAutomationExecutionsRequest, callback?: (err: AWSError, data: SSM.Types.DescribeAutomationExecutionsResult) => void): Request<SSM.Types.DescribeAutomationExecutionsResult, AWSError>;
/**
* Provides details about all active and terminated Automation executions.
*/
describeAutomationExecutions(callback?: (err: AWSError, data: SSM.Types.DescribeAutomationExecutionsResult) => void): Request<SSM.Types.DescribeAutomationExecutionsResult, AWSError>;
/**
* Information about all active and terminated step executions in an Automation workflow.
*/
describeAutomationStepExecutions(params: SSM.Types.DescribeAutomationStepExecutionsRequest, callback?: (err: AWSError, data: SSM.Types.DescribeAutomationStepExecutionsResult) => void): Request<SSM.Types.DescribeAutomationStepExecutionsResult, AWSError>;
/**
* Information about all active and terminated step executions in an Automation workflow.
*/
describeAutomationStepExecutions(callback?: (err: AWSError, data: SSM.Types.DescribeAutomationStepExecutionsResult) => void): Request<SSM.Types.DescribeAutomationStepExecutionsResult, AWSError>;
/**
* Lists all patches eligible to be included in a patch baseline.
*/
describeAvailablePatches(params: SSM.Types.DescribeAvailablePatchesRequest, callback?: (err: AWSError, data: SSM.Types.DescribeAvailablePatchesResult) => void): Request<SSM.Types.DescribeAvailablePatchesResult, AWSError>;
/**
* Lists all patches eligible to be included in a patch baseline.
*/
describeAvailablePatches(callback?: (err: AWSError, data: SSM.Types.DescribeAvailablePatchesResult) => void): Request<SSM.Types.DescribeAvailablePatchesResult, AWSError>;
/**
* Describes the specified Systems Manager document.
*/
describeDocument(params: SSM.Types.DescribeDocumentRequest, callback?: (err: AWSError, data: SSM.Types.DescribeDocumentResult) => void): Request<SSM.Types.DescribeDocumentResult, AWSError>;
/**
* Describes the specified Systems Manager document.
*/
describeDocument(callback?: (err: AWSError, data: SSM.Types.DescribeDocumentResult) => void): Request<SSM.Types.DescribeDocumentResult, AWSError>;
/**
* Describes the permissions for a Systems Manager document. If you created the document, you are the owner. If a document is shared, it can either be shared privately (by specifying a user's AWS account ID) or publicly (All).
*/
describeDocumentPermission(params: SSM.Types.DescribeDocumentPermissionRequest, callback?: (err: AWSError, data: SSM.Types.DescribeDocumentPermissionResponse) => void): Request<SSM.Types.DescribeDocumentPermissionResponse, AWSError>;
/**
* Describes the permissions for a Systems Manager document. If you created the document, you are the owner. If a document is shared, it can either be shared privately (by specifying a user's AWS account ID) or publicly (All).
*/
describeDocumentPermission(callback?: (err: AWSError, data: SSM.Types.DescribeDocumentPermissionResponse) => void): Request<SSM.Types.DescribeDocumentPermissionResponse, AWSError>;
/**
* All associations for the instance(s).
*/
describeEffectiveInstanceAssociations(params: SSM.Types.DescribeEffectiveInstanceAssociationsRequest, callback?: (err: AWSError, data: SSM.Types.DescribeEffectiveInstanceAssociationsResult) => void): Request<SSM.Types.DescribeEffectiveInstanceAssociationsResult, AWSError>;
/**
* All associations for the instance(s).
*/
describeEffectiveInstanceAssociations(callback?: (err: AWSError, data: SSM.Types.DescribeEffectiveInstanceAssociationsResult) => void): Request<SSM.Types.DescribeEffectiveInstanceAssociationsResult, AWSError>;
/**
* Retrieves the current effective patches (the patch and the approval state) for the specified patch baseline. Note that this API applies only to Windows patch baselines.
*/
describeEffectivePatchesForPatchBaseline(params: SSM.Types.DescribeEffectivePatchesForPatchBaselineRequest, callback?: (err: AWSError, data: SSM.Types.DescribeEffectivePatchesForPatchBaselineResult) => void): Request<SSM.Types.DescribeEffectivePatchesForPatchBaselineResult, AWSError>;
/**
* Retrieves the current effective patches (the patch and the approval state) for the specified patch baseline. Note that this API applies only to Windows patch baselines.
*/
describeEffectivePatchesForPatchBaseline(callback?: (err: AWSError, data: SSM.Types.DescribeEffectivePatchesForPatchBaselineResult) => void): Request<SSM.Types.DescribeEffectivePatchesForPatchBaselineResult, AWSError>;
/**
* The status of the associations for the instance(s).
*/
describeInstanceAssociationsStatus(params: SSM.Types.DescribeInstanceAssociationsStatusRequest, callback?: (err: AWSError, data: SSM.Types.DescribeInstanceAssociationsStatusResult) => void): Request<SSM.Types.DescribeInstanceAssociationsStatusResult, AWSError>;
/**
* The status of the associations for the instance(s).
*/
describeInstanceAssociationsStatus(callback?: (err: AWSError, data: SSM.Types.DescribeInstanceAssociationsStatusResult) => void): Request<SSM.Types.DescribeInstanceAssociationsStatusResult, AWSError>;
/**
* Describes one or more of your instances. You can use this to get information about instances like the operating system platform, the SSM Agent version (Linux), status etc. If you specify one or more instance IDs, it returns information for those instances. If you do not specify instance IDs, it returns information for all your instances. If you specify an instance ID that is not valid or an instance that you do not own, you receive an error. The IamRole field for this API action is the Amazon Identity and Access Management (IAM) role assigned to on-premises instances. This call does not return the IAM role for Amazon EC2 instances.
*/
describeInstanceInformation(params: SSM.Types.DescribeInstanceInformationRequest, callback?: (err: AWSError, data: SSM.Types.DescribeInstanceInformationResult) => void): Request<SSM.Types.DescribeInstanceInformationResult, AWSError>;
/**
* Describes one or more of your instances. You can use this to get information about instances like the operating system platform, the SSM Agent version (Linux), status etc. If you specify one or more instance IDs, it returns information for those instances. If you do not specify instance IDs, it returns information for all your instances. If you specify an instance ID that is not valid or an instance that you do not own, you receive an error. The IamRole field for this API action is the Amazon Identity and Access Management (IAM) role assigned to on-premises instances. This call does not return the IAM role for Amazon EC2 instances.
*/
describeInstanceInformation(callback?: (err: AWSError, data: SSM.Types.DescribeInstanceInformationResult) => void): Request<SSM.Types.DescribeInstanceInformationResult, AWSError>;
/**
* Retrieves the high-level patch state of one or more instances.
*/
describeInstancePatchStates(params: SSM.Types.DescribeInstancePatchStatesRequest, callback?: (err: AWSError, data: SSM.Types.DescribeInstancePatchStatesResult) => void): Request<SSM.Types.DescribeInstancePatchStatesResult, AWSError>;
/**
* Retrieves the high-level patch state of one or more instances.
*/
describeInstancePatchStates(callback?: (err: AWSError, data: SSM.Types.DescribeInstancePatchStatesResult) => void): Request<SSM.Types.DescribeInstancePatchStatesResult, AWSError>;
/**
* Retrieves the high-level patch state for the instances in the specified patch group.
*/
describeInstancePatchStatesForPatchGroup(params: SSM.Types.DescribeInstancePatchStatesForPatchGroupRequest, callback?: (err: AWSError, data: SSM.Types.DescribeInstancePatchStatesForPatchGroupResult) => void): Request<SSM.Types.DescribeInstancePatchStatesForPatchGroupResult, AWSError>;
/**
* Retrieves the high-level patch state for the instances in the specified patch group.
*/
describeInstancePatchStatesForPatchGroup(callback?: (err: AWSError, data: SSM.Types.DescribeInstancePatchStatesForPatchGroupResult) => void): Request<SSM.Types.DescribeInstancePatchStatesForPatchGroupResult, AWSError>;
/**
* Retrieves information about the patches on the specified instance and their state relative to the patch baseline being used for the instance.
*/
describeInstancePatches(params: SSM.Types.DescribeInstancePatchesRequest, callback?: (err: AWSError, data: SSM.Types.DescribeInstancePatchesResult) => void): Request<SSM.Types.DescribeInstancePatchesResult, AWSError>;
/**
* Retrieves information about the patches on the specified instance and their state relative to the patch baseline being used for the instance.
*/
describeInstancePatches(callback?: (err: AWSError, data: SSM.Types.DescribeInstancePatchesResult) => void): Request<SSM.Types.DescribeInstancePatchesResult, AWSError>;
/**
* Describes a specific delete inventory operation.
*/
describeInventoryDeletions(params: SSM.Types.DescribeInventoryDeletionsRequest, callback?: (err: AWSError, data: SSM.Types.DescribeInventoryDeletionsResult) => void): Request<SSM.Types.DescribeInventoryDeletionsResult, AWSError>;
/**
* Describes a specific delete inventory operation.
*/
describeInventoryDeletions(callback?: (err: AWSError, data: SSM.Types.DescribeInventoryDeletionsResult) => void): Request<SSM.Types.DescribeInventoryDeletionsResult, AWSError>;
/**
* Retrieves the individual task executions (one per target) for a particular task run as part of a maintenance window execution.
*/
describeMaintenanceWindowExecutionTaskInvocations(params: SSM.Types.DescribeMaintenanceWindowExecutionTaskInvocationsRequest, callback?: (err: AWSError, data: SSM.Types.DescribeMaintenanceWindowExecutionTaskInvocationsResult) => void): Request<SSM.Types.DescribeMaintenanceWindowExecutionTaskInvocationsResult, AWSError>;
/**
* Retrieves the individual task executions (one per target) for a particular task run as part of a maintenance window execution.
*/
describeMaintenanceWindowExecutionTaskInvocations(callback?: (err: AWSError, data: SSM.Types.DescribeMaintenanceWindowExecutionTaskInvocationsResult) => void): Request<SSM.Types.DescribeMaintenanceWindowExecutionTaskInvocationsResult, AWSError>;
/**
* For a given maintenance window execution, lists the tasks that were run.
*/
describeMaintenanceWindowExecutionTasks(params: SSM.Types.DescribeMaintenanceWindowExecutionTasksRequest, callback?: (err: AWSError, data: SSM.Types.DescribeMaintenanceWindowExecutionTasksResult) => void): Request<SSM.Types.DescribeMaintenanceWindowExecutionTasksResult, AWSError>;
/**
* For a given maintenance window execution, lists the tasks that were run.
*/
describeMaintenanceWindowExecutionTasks(callback?: (err: AWSError, data: SSM.Types.DescribeMaintenanceWindowExecutionTasksResult) => void): Request<SSM.Types.DescribeMaintenanceWindowExecutionTasksResult, AWSError>;
/**
* Lists the executions of a maintenance window. This includes information about when the maintenance window was scheduled to be active, and information about tasks registered and run with the maintenance window.
*/
describeMaintenanceWindowExecutions(params: SSM.Types.DescribeMaintenanceWindowExecutionsRequest, callback?: (err: AWSError, data: SSM.Types.DescribeMaintenanceWindowExecutionsResult) => void): Request<SSM.Types.DescribeMaintenanceWindowExecutionsResult, AWSError>;
/**
* Lists the executions of a maintenance window. This includes information about when the maintenance window was scheduled to be active, and information about tasks registered and run with the maintenance window.
*/
describeMaintenanceWindowExecutions(callback?: (err: AWSError, data: SSM.Types.DescribeMaintenanceWindowExecutionsResult) => void): Request<SSM.Types.DescribeMaintenanceWindowExecutionsResult, AWSError>;
/**
* Retrieves information about upcoming executions of a maintenance window.
*/
describeMaintenanceWindowSchedule(params: SSM.Types.DescribeMaintenanceWindowScheduleRequest, callback?: (err: AWSError, data: SSM.Types.DescribeMaintenanceWindowScheduleResult) => void): Request<SSM.Types.DescribeMaintenanceWindowScheduleResult, AWSError>;
/**
* Retrieves information about upcoming executions of a maintenance window.
*/
describeMaintenanceWindowSchedule(callback?: (err: AWSError, data: SSM.Types.DescribeMaintenanceWindowScheduleResult) => void): Request<SSM.Types.DescribeMaintenanceWindowScheduleResult, AWSError>;
/**
* Lists the targets registered with the maintenance window.
*/
describeMaintenanceWindowTargets(params: SSM.Types.DescribeMaintenanceWindowTargetsRequest, callback?: (err: AWSError, data: SSM.Types.DescribeMaintenanceWindowTargetsResult) => void): Request<SSM.Types.DescribeMaintenanceWindowTargetsResult, AWSError>;
/**
* Lists the targets registered with the maintenance window.
*/
describeMaintenanceWindowTargets(callback?: (err: AWSError, data: SSM.Types.DescribeMaintenanceWindowTargetsResult) => void): Request<SSM.Types.DescribeMaintenanceWindowTargetsResult, AWSError>;
/**
* Lists the tasks in a maintenance window.
*/
describeMaintenanceWindowTasks(params: SSM.Types.DescribeMaintenanceWindowTasksRequest, callback?: (err: AWSError, data: SSM.Types.DescribeMaintenanceWindowTasksResult) => void): Request<SSM.Types.DescribeMaintenanceWindowTasksResult, AWSError>;
/**
* Lists the tasks in a maintenance window.
*/
describeMaintenanceWindowTasks(callback?: (err: AWSError, data: SSM.Types.DescribeMaintenanceWindowTasksResult) => void): Request<SSM.Types.DescribeMaintenanceWindowTasksResult, AWSError>;
/**
* Retrieves the maintenance windows in an AWS account.
*/
describeMaintenanceWindows(params: SSM.Types.DescribeMaintenanceWindowsRequest, callback?: (err: AWSError, data: SSM.Types.DescribeMaintenanceWindowsResult) => void): Request<SSM.Types.DescribeMaintenanceWindowsResult, AWSError>;
/**
* Retrieves the maintenance windows in an AWS account.
*/
describeMaintenanceWindows(callback?: (err: AWSError, data: SSM.Types.DescribeMaintenanceWindowsResult) => void): Request<SSM.Types.DescribeMaintenanceWindowsResult, AWSError>;
/**
* Retrieves information about the maintenance window targets or tasks that an instance is associated with.
*/
describeMaintenanceWindowsForTarget(params: SSM.Types.DescribeMaintenanceWindowsForTargetRequest, callback?: (err: AWSError, data: SSM.Types.DescribeMaintenanceWindowsForTargetResult) => void): Request<SSM.Types.DescribeMaintenanceWindowsForTargetResult, AWSError>;
/**
* Retrieves information about the maintenance window targets or tasks that an instance is associated with.
*/
describeMaintenanceWindowsForTarget(callback?: (err: AWSError, data: SSM.Types.DescribeMaintenanceWindowsForTargetResult) => void): Request<SSM.Types.DescribeMaintenanceWindowsForTargetResult, AWSError>;
/**
* Query a set of OpsItems. You must have permission in AWS Identity and Access Management (IAM) to query a list of OpsItems. For more information, see Getting Started with OpsCenter in the AWS Systems Manager User Guide. Operations engineers and IT professionals use OpsCenter to view, investigate, and remediate operational issues impacting the performance and health of their AWS resources. For more information, see AWS Systems Manager OpsCenter in the AWS Systems Manager User Guide.
*/
describeOpsItems(params: SSM.Types.DescribeOpsItemsRequest, callback?: (err: AWSError, data: SSM.Types.DescribeOpsItemsResponse) => void): Request<SSM.Types.DescribeOpsItemsResponse, AWSError>;
/**
* Query a set of OpsItems. You must have permission in AWS Identity and Access Management (IAM) to query a list of OpsItems. For more information, see Getting Started with OpsCenter in the AWS Systems Manager User Guide. Operations engineers and IT professionals use OpsCenter to view, investigate, and remediate operational issues impacting the performance and health of their AWS resources. For more information, see AWS Systems Manager OpsCenter in the AWS Systems Manager User Guide.
*/
describeOpsItems(callback?: (err: AWSError, data: SSM.Types.DescribeOpsItemsResponse) => void): Request<SSM.Types.DescribeOpsItemsResponse, AWSError>;
/**
* Get information about a parameter. Request results are returned on a best-effort basis. If you specify MaxResults in the request, the response includes information up to the limit specified. The number of items returned, however, can be between zero and the value of MaxResults. If the service reaches an internal limit while processing the results, it stops the operation and returns the matching values up to that point and a NextToken. You can specify the NextToken in a subsequent call to get the next set of results.
*/
describeParameters(params: SSM.Types.DescribeParametersRequest, callback?: (err: AWSError, data: SSM.Types.DescribeParametersResult) => void): Request<SSM.Types.DescribeParametersResult, AWSError>;
/**
* Get information about a parameter. Request results are returned on a best-effort basis. If you specify MaxResults in the request, the response includes information up to the limit specified. The number of items returned, however, can be between zero and the value of MaxResults. If the service reaches an internal limit while processing the results, it stops the operation and returns the matching values up to that point and a NextToken. You can specify the NextToken in a subsequent call to get the next set of results.
*/
describeParameters(callback?: (err: AWSError, data: SSM.Types.DescribeParametersResult) => void): Request<SSM.Types.DescribeParametersResult, AWSError>;
/**
* Lists the patch baselines in your AWS account.
*/
describePatchBaselines(params: SSM.Types.DescribePatchBaselinesRequest, callback?: (err: AWSError, data: SSM.Types.DescribePatchBaselinesResult) => void): Request<SSM.Types.DescribePatchBaselinesResult, AWSError>;
/**
* Lists the patch baselines in your AWS account.
*/
describePatchBaselines(callback?: (err: AWSError, data: SSM.Types.DescribePatchBaselinesResult) => void): Request<SSM.Types.DescribePatchBaselinesResult, AWSError>;
/**
* Returns high-level aggregated patch compliance state for a patch group.
*/
describePatchGroupState(params: SSM.Types.DescribePatchGroupStateRequest, callback?: (err: AWSError, data: SSM.Types.DescribePatchGroupStateResult) => void): Request<SSM.Types.DescribePatchGroupStateResult, AWSError>;
/**
* Returns high-level aggregated patch compliance state for a patch group.
*/
describePatchGroupState(callback?: (err: AWSError, data: SSM.Types.DescribePatchGroupStateResult) => void): Request<SSM.Types.DescribePatchGroupStateResult, AWSError>;
/**
* Lists all patch groups that have been registered with patch baselines.
*/
describePatchGroups(params: SSM.Types.DescribePatchGroupsRequest, callback?: (err: AWSError, data: SSM.Types.DescribePatchGroupsResult) => void): Request<SSM.Types.DescribePatchGroupsResult, AWSError>;
/**
* Lists all patch groups that have been registered with patch baselines.
*/
describePatchGroups(callback?: (err: AWSError, data: SSM.Types.DescribePatchGroupsResult) => void): Request<SSM.Types.DescribePatchGroupsResult, AWSError>;
/**
* Lists the properties of available patches organized by product, product family, classification, severity, and other properties of available patches. You can use the reported properties in the filters you specify in requests for actions such as CreatePatchBaseline, UpdatePatchBaseline, DescribeAvailablePatches, and DescribePatchBaselines. The following section lists the properties that can be used in filters for each major operating system type: WINDOWS Valid properties: PRODUCT, PRODUCT_FAMILY, CLASSIFICATION, MSRC_SEVERITY AMAZON_LINUX Valid properties: PRODUCT, CLASSIFICATION, SEVERITY AMAZON_LINUX_2 Valid properties: PRODUCT, CLASSIFICATION, SEVERITY UBUNTU Valid properties: PRODUCT, PRIORITY REDHAT_ENTERPRISE_LINUX Valid properties: PRODUCT, CLASSIFICATION, SEVERITY SUSE Valid properties: PRODUCT, CLASSIFICATION, SEVERITY CENTOS Valid properties: PRODUCT, CLASSIFICATION, SEVERITY
*/
describePatchProperties(params: SSM.Types.DescribePatchPropertiesRequest, callback?: (err: AWSError, data: SSM.Types.DescribePatchPropertiesResult) => void): Request<SSM.Types.DescribePatchPropertiesResult, AWSError>;
/**
* Lists the properties of available patches organized by product, product family, classification, severity, and other properties of available patches. You can use the reported properties in the filters you specify in requests for actions such as CreatePatchBaseline, UpdatePatchBaseline, DescribeAvailablePatches, and DescribePatchBaselines. The following section lists the properties that can be used in filters for each major operating system type: WINDOWS Valid properties: PRODUCT, PRODUCT_FAMILY, CLASSIFICATION, MSRC_SEVERITY AMAZON_LINUX Valid properties: PRODUCT, CLASSIFICATION, SEVERITY AMAZON_LINUX_2 Valid properties: PRODUCT, CLASSIFICATION, SEVERITY UBUNTU Valid properties: PRODUCT, PRIORITY REDHAT_ENTERPRISE_LINUX Valid properties: PRODUCT, CLASSIFICATION, SEVERITY SUSE Valid properties: PRODUCT, CLASSIFICATION, SEVERITY CENTOS Valid properties: PRODUCT, CLASSIFICATION, SEVERITY
*/
describePatchProperties(callback?: (err: AWSError, data: SSM.Types.DescribePatchPropertiesResult) => void): Request<SSM.Types.DescribePatchPropertiesResult, AWSError>;
/**
* Retrieves a list of all active sessions (both connected and disconnected) or terminated sessions from the past 30 days.
*/
describeSessions(params: SSM.Types.DescribeSessionsRequest, callback?: (err: AWSError, data: SSM.Types.DescribeSessionsResponse) => void): Request<SSM.Types.DescribeSessionsResponse, AWSError>;
/**
* Retrieves a list of all active sessions (both connected and disconnected) or terminated sessions from the past 30 days.
*/
describeSessions(callback?: (err: AWSError, data: SSM.Types.DescribeSessionsResponse) => void): Request<SSM.Types.DescribeSessionsResponse, AWSError>;
/**
* Get detailed information about a particular Automation execution.
*/
getAutomationExecution(params: SSM.Types.GetAutomationExecutionRequest, callback?: (err: AWSError, data: SSM.Types.GetAutomationExecutionResult) => void): Request<SSM.Types.GetAutomationExecutionResult, AWSError>;
/**
* Get detailed information about a particular Automation execution.
*/
getAutomationExecution(callback?: (err: AWSError, data: SSM.Types.GetAutomationExecutionResult) => void): Request<SSM.Types.GetAutomationExecutionResult, AWSError>;
/**
* Gets the state of the AWS Systems Manager Change Calendar at an optional, specified time. If you specify a time, GetCalendarState returns the state of the calendar at a specific time, and returns the next time that the Change Calendar state will transition. If you do not specify a time, GetCalendarState assumes the current time. Change Calendar entries have two possible states: OPEN or CLOSED. For more information about Systems Manager Change Calendar, see AWS Systems Manager Change Calendar in the AWS Systems Manager User Guide.
*/
getCalendarState(params: SSM.Types.GetCalendarStateRequest, callback?: (err: AWSError, data: SSM.Types.GetCalendarStateResponse) => void): Request<SSM.Types.GetCalendarStateResponse, AWSError>;
/**
* Gets the state of the AWS Systems Manager Change Calendar at an optional, specified time. If you specify a time, GetCalendarState returns the state of the calendar at a specific time, and returns the next time that the Change Calendar state will transition. If you do not specify a time, GetCalendarState assumes the current time. Change Calendar entries have two possible states: OPEN or CLOSED. For more information about Systems Manager Change Calendar, see AWS Systems Manager Change Calendar in the AWS Systems Manager User Guide.
*/
getCalendarState(callback?: (err: AWSError, data: SSM.Types.GetCalendarStateResponse) => void): Request<SSM.Types.GetCalendarStateResponse, AWSError>;
/**
* Returns detailed information about command execution for an invocation or plugin.
*/
getCommandInvocation(params: SSM.Types.GetCommandInvocationRequest, callback?: (err: AWSError, data: SSM.Types.GetCommandInvocationResult) => void): Request<SSM.Types.GetCommandInvocationResult, AWSError>;
/**
* Returns detailed information about command execution for an invocation or plugin.
*/
getCommandInvocation(callback?: (err: AWSError, data: SSM.Types.GetCommandInvocationResult) => void): Request<SSM.Types.GetCommandInvocationResult, AWSError>;
/**
* Retrieves the Session Manager connection status for an instance to determine whether it is connected and ready to receive Session Manager connections.
*/
getConnectionStatus(params: SSM.Types.GetConnectionStatusRequest, callback?: (err: AWSError, data: SSM.Types.GetConnectionStatusResponse) => void): Request<SSM.Types.GetConnectionStatusResponse, AWSError>;
/**
* Retrieves the Session Manager connection status for an instance to determine whether it is connected and ready to receive Session Manager connections.
*/
getConnectionStatus(callback?: (err: AWSError, data: SSM.Types.GetConnectionStatusResponse) => void): Request<SSM.Types.GetConnectionStatusResponse, AWSError>;
/**
* Retrieves the default patch baseline. Note that Systems Manager supports creating multiple default patch baselines. For example, you can create a default patch baseline for each operating system. If you do not specify an operating system value, the default patch baseline for Windows is returned.
*/
getDefaultPatchBaseline(params: SSM.Types.GetDefaultPatchBaselineRequest, callback?: (err: AWSError, data: SSM.Types.GetDefaultPatchBaselineResult) => void): Request<SSM.Types.GetDefaultPatchBaselineResult, AWSError>;
/**
* Retrieves the default patch baseline. Note that Systems Manager supports creating multiple default patch baselines. For example, you can create a default patch baseline for each operating system. If you do not specify an operating system value, the default patch baseline for Windows is returned.
*/
getDefaultPatchBaseline(callback?: (err: AWSError, data: SSM.Types.GetDefaultPatchBaselineResult) => void): Request<SSM.Types.GetDefaultPatchBaselineResult, AWSError>;
/**
* Retrieves the current snapshot for the patch baseline the instance uses. This API is primarily used by the AWS-RunPatchBaseline Systems Manager document.
*/
getDeployablePatchSnapshotForInstance(params: SSM.Types.GetDeployablePatchSnapshotForInstanceRequest, callback?: (err: AWSError, data: SSM.Types.GetDeployablePatchSnapshotForInstanceResult) => void): Request<SSM.Types.GetDeployablePatchSnapshotForInstanceResult, AWSError>;
/**
* Retrieves the current snapshot for the patch baseline the instance uses. This API is primarily used by the AWS-RunPatchBaseline Systems Manager document.
*/
getDeployablePatchSnapshotForInstance(callback?: (err: AWSError, data: SSM.Types.GetDeployablePatchSnapshotForInstanceResult) => void): Request<SSM.Types.GetDeployablePatchSnapshotForInstanceResult, AWSError>;
/**
* Gets the contents of the specified Systems Manager document.
*/
getDocument(params: SSM.Types.GetDocumentRequest, callback?: (err: AWSError, data: SSM.Types.GetDocumentResult) => void): Request<SSM.Types.GetDocumentResult, AWSError>;
/**
* Gets the contents of the specified Systems Manager document.
*/
getDocument(callback?: (err: AWSError, data: SSM.Types.GetDocumentResult) => void): Request<SSM.Types.GetDocumentResult, AWSError>;
/**
* Query inventory information.
*/
getInventory(params: SSM.Types.GetInventoryRequest, callback?: (err: AWSError, data: SSM.Types.GetInventoryResult) => void): Request<SSM.Types.GetInventoryResult, AWSError>;
/**
* Query inventory information.
*/
getInventory(callback?: (err: AWSError, data: SSM.Types.GetInventoryResult) => void): Request<SSM.Types.GetInventoryResult, AWSError>;
/**
* Return a list of inventory type names for the account, or return a list of attribute names for a specific Inventory item type.
*/
getInventorySchema(params: SSM.Types.GetInventorySchemaRequest, callback?: (err: AWSError, data: SSM.Types.GetInventorySchemaResult) => void): Request<SSM.Types.GetInventorySchemaResult, AWSError>;
/**
* Return a list of inventory type names for the account, or return a list of attribute names for a specific Inventory item type.
*/
getInventorySchema(callback?: (err: AWSError, data: SSM.Types.GetInventorySchemaResult) => void): Request<SSM.Types.GetInventorySchemaResult, AWSError>;
/**
* Retrieves a maintenance window.
*/
getMaintenanceWindow(params: SSM.Types.GetMaintenanceWindowRequest, callback?: (err: AWSError, data: SSM.Types.GetMaintenanceWindowResult) => void): Request<SSM.Types.GetMaintenanceWindowResult, AWSError>;
/**
* Retrieves a maintenance window.
*/
getMaintenanceWindow(callback?: (err: AWSError, data: SSM.Types.GetMaintenanceWindowResult) => void): Request<SSM.Types.GetMaintenanceWindowResult, AWSError>;
/**
* Retrieves details about a specific a maintenance window execution.
*/
getMaintenanceWindowExecution(params: SSM.Types.GetMaintenanceWindowExecutionRequest, callback?: (err: AWSError, data: SSM.Types.GetMaintenanceWindowExecutionResult) => void): Request<SSM.Types.GetMaintenanceWindowExecutionResult, AWSError>;
/**
* Retrieves details about a specific a maintenance window execution.
*/
getMaintenanceWindowExecution(callback?: (err: AWSError, data: SSM.Types.GetMaintenanceWindowExecutionResult) => void): Request<SSM.Types.GetMaintenanceWindowExecutionResult, AWSError>;
/**
* Retrieves the details about a specific task run as part of a maintenance window execution.
*/
getMaintenanceWindowExecutionTask(params: SSM.Types.GetMaintenanceWindowExecutionTaskRequest, callback?: (err: AWSError, data: SSM.Types.GetMaintenanceWindowExecutionTaskResult) => void): Request<SSM.Types.GetMaintenanceWindowExecutionTaskResult, AWSError>;
/**
* Retrieves the details about a specific task run as part of a maintenance window execution.
*/
getMaintenanceWindowExecutionTask(callback?: (err: AWSError, data: SSM.Types.GetMaintenanceWindowExecutionTaskResult) => void): Request<SSM.Types.GetMaintenanceWindowExecutionTaskResult, AWSError>;
/**
* Retrieves information about a specific task running on a specific target.
*/
getMaintenanceWindowExecutionTaskInvocation(params: SSM.Types.GetMaintenanceWindowExecutionTaskInvocationRequest, callback?: (err: AWSError, data: SSM.Types.GetMaintenanceWindowExecutionTaskInvocationResult) => void): Request<SSM.Types.GetMaintenanceWindowExecutionTaskInvocationResult, AWSError>;
/**
* Retrieves information about a specific task running on a specific target.
*/
getMaintenanceWindowExecutionTaskInvocation(callback?: (err: AWSError, data: SSM.Types.GetMaintenanceWindowExecutionTaskInvocationResult) => void): Request<SSM.Types.GetMaintenanceWindowExecutionTaskInvocationResult, AWSError>;
/**
* Lists the tasks in a maintenance window.
*/
getMaintenanceWindowTask(params: SSM.Types.GetMaintenanceWindowTaskRequest, callback?: (err: AWSError, data: SSM.Types.GetMaintenanceWindowTaskResult) => void): Request<SSM.Types.GetMaintenanceWindowTaskResult, AWSError>;
/**
* Lists the tasks in a maintenance window.
*/
getMaintenanceWindowTask(callback?: (err: AWSError, data: SSM.Types.GetMaintenanceWindowTaskResult) => void): Request<SSM.Types.GetMaintenanceWindowTaskResult, AWSError>;
/**
* Get information about an OpsItem by using the ID. You must have permission in AWS Identity and Access Management (IAM) to view information about an OpsItem. For more information, see Getting Started with OpsCenter in the AWS Systems Manager User Guide. Operations engineers and IT professionals use OpsCenter to view, investigate, and remediate operational issues impacting the performance and health of their AWS resources. For more information, see AWS Systems Manager OpsCenter in the AWS Systems Manager User Guide.
*/
getOpsItem(params: SSM.Types.GetOpsItemRequest, callback?: (err: AWSError, data: SSM.Types.GetOpsItemResponse) => void): Request<SSM.Types.GetOpsItemResponse, AWSError>;
/**
* Get information about an OpsItem by using the ID. You must have permission in AWS Identity and Access Management (IAM) to view information about an OpsItem. For more information, see Getting Started with OpsCenter in the AWS Systems Manager User Guide. Operations engineers and IT professionals use OpsCenter to view, investigate, and remediate operational issues impacting the performance and health of their AWS resources. For more information, see AWS Systems Manager OpsCenter in the AWS Systems Manager User Guide.
*/
getOpsItem(callback?: (err: AWSError, data: SSM.Types.GetOpsItemResponse) => void): Request<SSM.Types.GetOpsItemResponse, AWSError>;
/**
* View a summary of OpsItems based on specified filters and aggregators.
*/
getOpsSummary(params: SSM.Types.GetOpsSummaryRequest, callback?: (err: AWSError, data: SSM.Types.GetOpsSummaryResult) => void): Request<SSM.Types.GetOpsSummaryResult, AWSError>;
/**
* View a summary of OpsItems based on specified filters and aggregators.
*/
getOpsSummary(callback?: (err: AWSError, data: SSM.Types.GetOpsSummaryResult) => void): Request<SSM.Types.GetOpsSummaryResult, AWSError>;
/**
* Get information about a parameter by using the parameter name. Don't confuse this API action with the GetParameters API action.
*/
getParameter(params: SSM.Types.GetParameterRequest, callback?: (err: AWSError, data: SSM.Types.GetParameterResult) => void): Request<SSM.Types.GetParameterResult, AWSError>;
/**
* Get information about a parameter by using the parameter name. Don't confuse this API action with the GetParameters API action.
*/
getParameter(callback?: (err: AWSError, data: SSM.Types.GetParameterResult) => void): Request<SSM.Types.GetParameterResult, AWSError>;
/**
* Query a list of all parameters used by the AWS account.
*/
getParameterHistory(params: SSM.Types.GetParameterHistoryRequest, callback?: (err: AWSError, data: SSM.Types.GetParameterHistoryResult) => void): Request<SSM.Types.GetParameterHistoryResult, AWSError>;
/**
* Query a list of all parameters used by the AWS account.
*/
getParameterHistory(callback?: (err: AWSError, data: SSM.Types.GetParameterHistoryResult) => void): Request<SSM.Types.GetParameterHistoryResult, AWSError>;
/**
* Get details of a parameter. Don't confuse this API action with the GetParameter API action.
*/
getParameters(params: SSM.Types.GetParametersRequest, callback?: (err: AWSError, data: SSM.Types.GetParametersResult) => void): Request<SSM.Types.GetParametersResult, AWSError>;
/**
* Get details of a parameter. Don't confuse this API action with the GetParameter API action.
*/
getParameters(callback?: (err: AWSError, data: SSM.Types.GetParametersResult) => void): Request<SSM.Types.GetParametersResult, AWSError>;
/**
* Retrieve information about one or more parameters in a specific hierarchy. Request results are returned on a best-effort basis. If you specify MaxResults in the request, the response includes information up to the limit specified. The number of items returned, however, can be between zero and the value of MaxResults. If the service reaches an internal limit while processing the results, it stops the operation and returns the matching values up to that point and a NextToken. You can specify the NextToken in a subsequent call to get the next set of results.
*/
getParametersByPath(params: SSM.Types.GetParametersByPathRequest, callback?: (err: AWSError, data: SSM.Types.GetParametersByPathResult) => void): Request<SSM.Types.GetParametersByPathResult, AWSError>;
/**
* Retrieve information about one or more parameters in a specific hierarchy. Request results are returned on a best-effort basis. If you specify MaxResults in the request, the response includes information up to the limit specified. The number of items returned, however, can be between zero and the value of MaxResults. If the service reaches an internal limit while processing the results, it stops the operation and returns the matching values up to that point and a NextToken. You can specify the NextToken in a subsequent call to get the next set of results.
*/
getParametersByPath(callback?: (err: AWSError, data: SSM.Types.GetParametersByPathResult) => void): Request<SSM.Types.GetParametersByPathResult, AWSError>;
/**
* Retrieves information about a patch baseline.
*/
getPatchBaseline(params: SSM.Types.GetPatchBaselineRequest, callback?: (err: AWSError, data: SSM.Types.GetPatchBaselineResult) => void): Request<SSM.Types.GetPatchBaselineResult, AWSError>;
/**
* Retrieves information about a patch baseline.
*/
getPatchBaseline(callback?: (err: AWSError, data: SSM.Types.GetPatchBaselineResult) => void): Request<SSM.Types.GetPatchBaselineResult, AWSError>;
/**
* Retrieves the patch baseline that should be used for the specified patch group.
*/
getPatchBaselineForPatchGroup(params: SSM.Types.GetPatchBaselineForPatchGroupRequest, callback?: (err: AWSError, data: SSM.Types.GetPatchBaselineForPatchGroupResult) => void): Request<SSM.Types.GetPatchBaselineForPatchGroupResult, AWSError>;
/**
* Retrieves the patch baseline that should be used for the specified patch group.
*/
getPatchBaselineForPatchGroup(callback?: (err: AWSError, data: SSM.Types.GetPatchBaselineForPatchGroupResult) => void): Request<SSM.Types.GetPatchBaselineForPatchGroupResult, AWSError>;
/**
* ServiceSetting is an account-level setting for an AWS service. This setting defines how a user interacts with or uses a service or a feature of a service. For example, if an AWS service charges money to the account based on feature or service usage, then the AWS service team might create a default setting of "false". This means the user can't use this feature unless they change the setting to "true" and intentionally opt in for a paid feature. Services map a SettingId object to a setting value. AWS services teams define the default value for a SettingId. You can't create a new SettingId, but you can overwrite the default value if you have the ssm:UpdateServiceSetting permission for the setting. Use the UpdateServiceSetting API action to change the default setting. Or use the ResetServiceSetting to change the value back to the original value defined by the AWS service team. Query the current service setting for the account.
*/
getServiceSetting(params: SSM.Types.GetServiceSettingRequest, callback?: (err: AWSError, data: SSM.Types.GetServiceSettingResult) => void): Request<SSM.Types.GetServiceSettingResult, AWSError>;
/**
* ServiceSetting is an account-level setting for an AWS service. This setting defines how a user interacts with or uses a service or a feature of a service. For example, if an AWS service charges money to the account based on feature or service usage, then the AWS service team might create a default setting of "false". This means the user can't use this feature unless they change the setting to "true" and intentionally opt in for a paid feature. Services map a SettingId object to a setting value. AWS services teams define the default value for a SettingId. You can't create a new SettingId, but you can overwrite the default value if you have the ssm:UpdateServiceSetting permission for the setting. Use the UpdateServiceSetting API action to change the default setting. Or use the ResetServiceSetting to change the value back to the original value defined by the AWS service team. Query the current service setting for the account.
*/
getServiceSetting(callback?: (err: AWSError, data: SSM.Types.GetServiceSettingResult) => void): Request<SSM.Types.GetServiceSettingResult, AWSError>;
/**
* A parameter label is a user-defined alias to help you manage different versions of a parameter. When you modify a parameter, Systems Manager automatically saves a new version and increments the version number by one. A label can help you remember the purpose of a parameter when there are multiple versions. Parameter labels have the following requirements and restrictions. A version of a parameter can have a maximum of 10 labels. You can't attach the same label to different versions of the same parameter. For example, if version 1 has the label Production, then you can't attach Production to version 2. You can move a label from one version of a parameter to another. You can't create a label when you create a new parameter. You must attach a label to a specific version of a parameter. You can't delete a parameter label. If you no longer want to use a parameter label, then you must move it to a different version of a parameter. A label can have a maximum of 100 characters. Labels can contain letters (case sensitive), numbers, periods (.), hyphens (-), or underscores (_). Labels can't begin with a number, "aws," or "ssm" (not case sensitive). If a label fails to meet these requirements, then the label is not associated with a parameter and the system displays it in the list of InvalidLabels.
*/
labelParameterVersion(params: SSM.Types.LabelParameterVersionRequest, callback?: (err: AWSError, data: SSM.Types.LabelParameterVersionResult) => void): Request<SSM.Types.LabelParameterVersionResult, AWSError>;
/**
* A parameter label is a user-defined alias to help you manage different versions of a parameter. When you modify a parameter, Systems Manager automatically saves a new version and increments the version number by one. A label can help you remember the purpose of a parameter when there are multiple versions. Parameter labels have the following requirements and restrictions. A version of a parameter can have a maximum of 10 labels. You can't attach the same label to different versions of the same parameter. For example, if version 1 has the label Production, then you can't attach Production to version 2. You can move a label from one version of a parameter to another. You can't create a label when you create a new parameter. You must attach a label to a specific version of a parameter. You can't delete a parameter label. If you no longer want to use a parameter label, then you must move it to a different version of a parameter. A label can have a maximum of 100 characters. Labels can contain letters (case sensitive), numbers, periods (.), hyphens (-), or underscores (_). Labels can't begin with a number, "aws," or "ssm" (not case sensitive). If a label fails to meet these requirements, then the label is not associated with a parameter and the system displays it in the list of InvalidLabels.
*/
labelParameterVersion(callback?: (err: AWSError, data: SSM.Types.LabelParameterVersionResult) => void): Request<SSM.Types.LabelParameterVersionResult, AWSError>;
/**
* Retrieves all versions of an association for a specific association ID.
*/
listAssociationVersions(params: SSM.Types.ListAssociationVersionsRequest, callback?: (err: AWSError, data: SSM.Types.ListAssociationVersionsResult) => void): Request<SSM.Types.ListAssociationVersionsResult, AWSError>;
/**
* Retrieves all versions of an association for a specific association ID.
*/
listAssociationVersions(callback?: (err: AWSError, data: SSM.Types.ListAssociationVersionsResult) => void): Request<SSM.Types.ListAssociationVersionsResult, AWSError>;
/**
* Lists the associations for the specified Systems Manager document or instance.
*/
listAssociations(params: SSM.Types.ListAssociationsRequest, callback?: (err: AWSError, data: SSM.Types.ListAssociationsResult) => void): Request<SSM.Types.ListAssociationsResult, AWSError>;
/**
* Lists the associations for the specified Systems Manager document or instance.
*/
listAssociations(callback?: (err: AWSError, data: SSM.Types.ListAssociationsResult) => void): Request<SSM.Types.ListAssociationsResult, AWSError>;
/**
* An invocation is copy of a command sent to a specific instance. A command can apply to one or more instances. A command invocation applies to one instance. For example, if a user runs SendCommand against three instances, then a command invocation is created for each requested instance ID. ListCommandInvocations provide status about command execution.
*/
listCommandInvocations(params: SSM.Types.ListCommandInvocationsRequest, callback?: (err: AWSError, data: SSM.Types.ListCommandInvocationsResult) => void): Request<SSM.Types.ListCommandInvocationsResult, AWSError>;
/**
* An invocation is copy of a command sent to a specific instance. A command can apply to one or more instances. A command invocation applies to one instance. For example, if a user runs SendCommand against three instances, then a command invocation is created for each requested instance ID. ListCommandInvocations provide status about command execution.
*/
listCommandInvocations(callback?: (err: AWSError, data: SSM.Types.ListCommandInvocationsResult) => void): Request<SSM.Types.ListCommandInvocationsResult, AWSError>;
/**
* Lists the commands requested by users of the AWS account.
*/
listCommands(params: SSM.Types.ListCommandsRequest, callback?: (err: AWSError, data: SSM.Types.ListCommandsResult) => void): Request<SSM.Types.ListCommandsResult, AWSError>;
/**
* Lists the commands requested by users of the AWS account.
*/
listCommands(callback?: (err: AWSError, data: SSM.Types.ListCommandsResult) => void): Request<SSM.Types.ListCommandsResult, AWSError>;
/**
* For a specified resource ID, this API action returns a list of compliance statuses for different resource types. Currently, you can only specify one resource ID per call. List results depend on the criteria specified in the filter.
*/
listComplianceItems(params: SSM.Types.ListComplianceItemsRequest, callback?: (err: AWSError, data: SSM.Types.ListComplianceItemsResult) => void): Request<SSM.Types.ListComplianceItemsResult, AWSError>;
/**
* For a specified resource ID, this API action returns a list of compliance statuses for different resource types. Currently, you can only specify one resource ID per call. List results depend on the criteria specified in the filter.
*/
listComplianceItems(callback?: (err: AWSError, data: SSM.Types.ListComplianceItemsResult) => void): Request<SSM.Types.ListComplianceItemsResult, AWSError>;
/**
* Returns a summary count of compliant and non-compliant resources for a compliance type. For example, this call can return State Manager associations, patches, or custom compliance types according to the filter criteria that you specify.
*/
listComplianceSummaries(params: SSM.Types.ListComplianceSummariesRequest, callback?: (err: AWSError, data: SSM.Types.ListComplianceSummariesResult) => void): Request<SSM.Types.ListComplianceSummariesResult, AWSError>;
/**
* Returns a summary count of compliant and non-compliant resources for a compliance type. For example, this call can return State Manager associations, patches, or custom compliance types according to the filter criteria that you specify.
*/
listComplianceSummaries(callback?: (err: AWSError, data: SSM.Types.ListComplianceSummariesResult) => void): Request<SSM.Types.ListComplianceSummariesResult, AWSError>;
/**
* List all versions for a document.
*/
listDocumentVersions(params: SSM.Types.ListDocumentVersionsRequest, callback?: (err: AWSError, data: SSM.Types.ListDocumentVersionsResult) => void): Request<SSM.Types.ListDocumentVersionsResult, AWSError>;
/**
* List all versions for a document.
*/
listDocumentVersions(callback?: (err: AWSError, data: SSM.Types.ListDocumentVersionsResult) => void): Request<SSM.Types.ListDocumentVersionsResult, AWSError>;
/**
* Describes one or more of your Systems Manager documents.
*/
listDocuments(params: SSM.Types.ListDocumentsRequest, callback?: (err: AWSError, data: SSM.Types.ListDocumentsResult) => void): Request<SSM.Types.ListDocumentsResult, AWSError>;
/**
* Describes one or more of your Systems Manager documents.
*/
listDocuments(callback?: (err: AWSError, data: SSM.Types.ListDocumentsResult) => void): Request<SSM.Types.ListDocumentsResult, AWSError>;
/**
* A list of inventory items returned by the request.
*/
listInventoryEntries(params: SSM.Types.ListInventoryEntriesRequest, callback?: (err: AWSError, data: SSM.Types.ListInventoryEntriesResult) => void): Request<SSM.Types.ListInventoryEntriesResult, AWSError>;
/**
* A list of inventory items returned by the request.
*/
listInventoryEntries(callback?: (err: AWSError, data: SSM.Types.ListInventoryEntriesResult) => void): Request<SSM.Types.ListInventoryEntriesResult, AWSError>;
/**
* Returns a resource-level summary count. The summary includes information about compliant and non-compliant statuses and detailed compliance-item severity counts, according to the filter criteria you specify.
*/
listResourceComplianceSummaries(params: SSM.Types.ListResourceComplianceSummariesRequest, callback?: (err: AWSError, data: SSM.Types.ListResourceComplianceSummariesResult) => void): Request<SSM.Types.ListResourceComplianceSummariesResult, AWSError>;
/**
* Returns a resource-level summary count. The summary includes information about compliant and non-compliant statuses and detailed compliance-item severity counts, according to the filter criteria you specify.
*/
listResourceComplianceSummaries(callback?: (err: AWSError, data: SSM.Types.ListResourceComplianceSummariesResult) => void): Request<SSM.Types.ListResourceComplianceSummariesResult, AWSError>;
/**
* Lists your resource data sync configurations. Includes information about the last time a sync attempted to start, the last sync status, and the last time a sync successfully completed. The number of sync configurations might be too large to return using a single call to ListResourceDataSync. You can limit the number of sync configurations returned by using the MaxResults parameter. To determine whether there are more sync configurations to list, check the value of NextToken in the output. If there are more sync configurations to list, you can request them by specifying the NextToken returned in the call to the parameter of a subsequent call.
*/
listResourceDataSync(params: SSM.Types.ListResourceDataSyncRequest, callback?: (err: AWSError, data: SSM.Types.ListResourceDataSyncResult) => void): Request<SSM.Types.ListResourceDataSyncResult, AWSError>;
/**
* Lists your resource data sync configurations. Includes information about the last time a sync attempted to start, the last sync status, and the last time a sync successfully completed. The number of sync configurations might be too large to return using a single call to ListResourceDataSync. You can limit the number of sync configurations returned by using the MaxResults parameter. To determine whether there are more sync configurations to list, check the value of NextToken in the output. If there are more sync configurations to list, you can request them by specifying the NextToken returned in the call to the parameter of a subsequent call.
*/
listResourceDataSync(callback?: (err: AWSError, data: SSM.Types.ListResourceDataSyncResult) => void): Request<SSM.Types.ListResourceDataSyncResult, AWSError>;
/**
* Returns a list of the tags assigned to the specified resource.
*/
listTagsForResource(params: SSM.Types.ListTagsForResourceRequest, callback?: (err: AWSError, data: SSM.Types.ListTagsForResourceResult) => void): Request<SSM.Types.ListTagsForResourceResult, AWSError>;
/**
* Returns a list of the tags assigned to the specified resource.
*/
listTagsForResource(callback?: (err: AWSError, data: SSM.Types.ListTagsForResourceResult) => void): Request<SSM.Types.ListTagsForResourceResult, AWSError>;
/**
* Shares a Systems Manager document publicly or privately. If you share a document privately, you must specify the AWS user account IDs for those people who can use the document. If you share a document publicly, you must specify All as the account ID.
*/
modifyDocumentPermission(params: SSM.Types.ModifyDocumentPermissionRequest, callback?: (err: AWSError, data: SSM.Types.ModifyDocumentPermissionResponse) => void): Request<SSM.Types.ModifyDocumentPermissionResponse, AWSError>;
/**
* Shares a Systems Manager document publicly or privately. If you share a document privately, you must specify the AWS user account IDs for those people who can use the document. If you share a document publicly, you must specify All as the account ID.
*/
modifyDocumentPermission(callback?: (err: AWSError, data: SSM.Types.ModifyDocumentPermissionResponse) => void): Request<SSM.Types.ModifyDocumentPermissionResponse, AWSError>;
/**
* Registers a compliance type and other compliance details on a designated resource. This action lets you register custom compliance details with a resource. This call overwrites existing compliance information on the resource, so you must provide a full list of compliance items each time that you send the request. ComplianceType can be one of the following: ExecutionId: The execution ID when the patch, association, or custom compliance item was applied. ExecutionType: Specify patch, association, or Custom:string. ExecutionTime. The time the patch, association, or custom compliance item was applied to the instance. Id: The patch, association, or custom compliance ID. Title: A title. Status: The status of the compliance item. For example, approved for patches, or Failed for associations. Severity: A patch severity. For example, critical. DocumentName: A SSM document name. For example, AWS-RunPatchBaseline. DocumentVersion: An SSM document version number. For example, 4. Classification: A patch classification. For example, security updates. PatchBaselineId: A patch baseline ID. PatchSeverity: A patch severity. For example, Critical. PatchState: A patch state. For example, InstancesWithFailedPatches. PatchGroup: The name of a patch group. InstalledTime: The time the association, patch, or custom compliance item was applied to the resource. Specify the time by using the following format: yyyy-MM-dd'T'HH:mm:ss'Z'
*/
putComplianceItems(params: SSM.Types.PutComplianceItemsRequest, callback?: (err: AWSError, data: SSM.Types.PutComplianceItemsResult) => void): Request<SSM.Types.PutComplianceItemsResult, AWSError>;
/**
* Registers a compliance type and other compliance details on a designated resource. This action lets you register custom compliance details with a resource. This call overwrites existing compliance information on the resource, so you must provide a full list of compliance items each time that you send the request. ComplianceType can be one of the following: ExecutionId: The execution ID when the patch, association, or custom compliance item was applied. ExecutionType: Specify patch, association, or Custom:string. ExecutionTime. The time the patch, association, or custom compliance item was applied to the instance. Id: The patch, association, or custom compliance ID. Title: A title. Status: The status of the compliance item. For example, approved for patches, or Failed for associations. Severity: A patch severity. For example, critical. DocumentName: A SSM document name. For example, AWS-RunPatchBaseline. DocumentVersion: An SSM document version number. For example, 4. Classification: A patch classification. For example, security updates. PatchBaselineId: A patch baseline ID. PatchSeverity: A patch severity. For example, Critical. PatchState: A patch state. For example, InstancesWithFailedPatches. PatchGroup: The name of a patch group. InstalledTime: The time the association, patch, or custom compliance item was applied to the resource. Specify the time by using the following format: yyyy-MM-dd'T'HH:mm:ss'Z'
*/
putComplianceItems(callback?: (err: AWSError, data: SSM.Types.PutComplianceItemsResult) => void): Request<SSM.Types.PutComplianceItemsResult, AWSError>;
/**
* Bulk update custom inventory items on one more instance. The request adds an inventory item, if it doesn't already exist, or updates an inventory item, if it does exist.
*/
putInventory(params: SSM.Types.PutInventoryRequest, callback?: (err: AWSError, data: SSM.Types.PutInventoryResult) => void): Request<SSM.Types.PutInventoryResult, AWSError>;
/**
* Bulk update custom inventory items on one more instance. The request adds an inventory item, if it doesn't already exist, or updates an inventory item, if it does exist.
*/
putInventory(callback?: (err: AWSError, data: SSM.Types.PutInventoryResult) => void): Request<SSM.Types.PutInventoryResult, AWSError>;
/**
* Add a parameter to the system.
*/
putParameter(params: SSM.Types.PutParameterRequest, callback?: (err: AWSError, data: SSM.Types.PutParameterResult) => void): Request<SSM.Types.PutParameterResult, AWSError>;
/**
* Add a parameter to the system.
*/
putParameter(callback?: (err: AWSError, data: SSM.Types.PutParameterResult) => void): Request<SSM.Types.PutParameterResult, AWSError>;
/**
* Defines the default patch baseline for the relevant operating system. To reset the AWS predefined patch baseline as the default, specify the full patch baseline ARN as the baseline ID value. For example, for CentOS, specify arn:aws:ssm:us-east-2:733109147000:patchbaseline/pb-0574b43a65ea646ed instead of pb-0574b43a65ea646ed.
*/
registerDefaultPatchBaseline(params: SSM.Types.RegisterDefaultPatchBaselineRequest, callback?: (err: AWSError, data: SSM.Types.RegisterDefaultPatchBaselineResult) => void): Request<SSM.Types.RegisterDefaultPatchBaselineResult, AWSError>;
/**
* Defines the default patch baseline for the relevant operating system. To reset the AWS predefined patch baseline as the default, specify the full patch baseline ARN as the baseline ID value. For example, for CentOS, specify arn:aws:ssm:us-east-2:733109147000:patchbaseline/pb-0574b43a65ea646ed instead of pb-0574b43a65ea646ed.
*/
registerDefaultPatchBaseline(callback?: (err: AWSError, data: SSM.Types.RegisterDefaultPatchBaselineResult) => void): Request<SSM.Types.RegisterDefaultPatchBaselineResult, AWSError>;
/**
* Registers a patch baseline for a patch group.
*/
registerPatchBaselineForPatchGroup(params: SSM.Types.RegisterPatchBaselineForPatchGroupRequest, callback?: (err: AWSError, data: SSM.Types.RegisterPatchBaselineForPatchGroupResult) => void): Request<SSM.Types.RegisterPatchBaselineForPatchGroupResult, AWSError>;
/**
* Registers a patch baseline for a patch group.
*/
registerPatchBaselineForPatchGroup(callback?: (err: AWSError, data: SSM.Types.RegisterPatchBaselineForPatchGroupResult) => void): Request<SSM.Types.RegisterPatchBaselineForPatchGroupResult, AWSError>;
/**
* Registers a target with a maintenance window.
*/
registerTargetWithMaintenanceWindow(params: SSM.Types.RegisterTargetWithMaintenanceWindowRequest, callback?: (err: AWSError, data: SSM.Types.RegisterTargetWithMaintenanceWindowResult) => void): Request<SSM.Types.RegisterTargetWithMaintenanceWindowResult, AWSError>;
/**
* Registers a target with a maintenance window.
*/
registerTargetWithMaintenanceWindow(callback?: (err: AWSError, data: SSM.Types.RegisterTargetWithMaintenanceWindowResult) => void): Request<SSM.Types.RegisterTargetWithMaintenanceWindowResult, AWSError>;
/**
* Adds a new task to a maintenance window.
*/
registerTaskWithMaintenanceWindow(params: SSM.Types.RegisterTaskWithMaintenanceWindowRequest, callback?: (err: AWSError, data: SSM.Types.RegisterTaskWithMaintenanceWindowResult) => void): Request<SSM.Types.RegisterTaskWithMaintenanceWindowResult, AWSError>;
/**
* Adds a new task to a maintenance window.
*/
registerTaskWithMaintenanceWindow(callback?: (err: AWSError, data: SSM.Types.RegisterTaskWithMaintenanceWindowResult) => void): Request<SSM.Types.RegisterTaskWithMaintenanceWindowResult, AWSError>;
/**
* Removes tag keys from the specified resource.
*/
removeTagsFromResource(params: SSM.Types.RemoveTagsFromResourceRequest, callback?: (err: AWSError, data: SSM.Types.RemoveTagsFromResourceResult) => void): Request<SSM.Types.RemoveTagsFromResourceResult, AWSError>;
/**
* Removes tag keys from the specified resource.
*/
removeTagsFromResource(callback?: (err: AWSError, data: SSM.Types.RemoveTagsFromResourceResult) => void): Request<SSM.Types.RemoveTagsFromResourceResult, AWSError>;
/**
* ServiceSetting is an account-level setting for an AWS service. This setting defines how a user interacts with or uses a service or a feature of a service. For example, if an AWS service charges money to the account based on feature or service usage, then the AWS service team might create a default setting of "false". This means the user can't use this feature unless they change the setting to "true" and intentionally opt in for a paid feature. Services map a SettingId object to a setting value. AWS services teams define the default value for a SettingId. You can't create a new SettingId, but you can overwrite the default value if you have the ssm:UpdateServiceSetting permission for the setting. Use the GetServiceSetting API action to view the current value. Use the UpdateServiceSetting API action to change the default setting. Reset the service setting for the account to the default value as provisioned by the AWS service team.
*/
resetServiceSetting(params: SSM.Types.ResetServiceSettingRequest, callback?: (err: AWSError, data: SSM.Types.ResetServiceSettingResult) => void): Request<SSM.Types.ResetServiceSettingResult, AWSError>;
/**
* ServiceSetting is an account-level setting for an AWS service. This setting defines how a user interacts with or uses a service or a feature of a service. For example, if an AWS service charges money to the account based on feature or service usage, then the AWS service team might create a default setting of "false". This means the user can't use this feature unless they change the setting to "true" and intentionally opt in for a paid feature. Services map a SettingId object to a setting value. AWS services teams define the default value for a SettingId. You can't create a new SettingId, but you can overwrite the default value if you have the ssm:UpdateServiceSetting permission for the setting. Use the GetServiceSetting API action to view the current value. Use the UpdateServiceSetting API action to change the default setting. Reset the service setting for the account to the default value as provisioned by the AWS service team.
*/
resetServiceSetting(callback?: (err: AWSError, data: SSM.Types.ResetServiceSettingResult) => void): Request<SSM.Types.ResetServiceSettingResult, AWSError>;
/**
* Reconnects a session to an instance after it has been disconnected. Connections can be resumed for disconnected sessions, but not terminated sessions. This command is primarily for use by client machines to automatically reconnect during intermittent network issues. It is not intended for any other use.
*/
resumeSession(params: SSM.Types.ResumeSessionRequest, callback?: (err: AWSError, data: SSM.Types.ResumeSessionResponse) => void): Request<SSM.Types.ResumeSessionResponse, AWSError>;
/**
* Reconnects a session to an instance after it has been disconnected. Connections can be resumed for disconnected sessions, but not terminated sessions. This command is primarily for use by client machines to automatically reconnect during intermittent network issues. It is not intended for any other use.
*/
resumeSession(callback?: (err: AWSError, data: SSM.Types.ResumeSessionResponse) => void): Request<SSM.Types.ResumeSessionResponse, AWSError>;
/**
* Sends a signal to an Automation execution to change the current behavior or status of the execution.
*/
sendAutomationSignal(params: SSM.Types.SendAutomationSignalRequest, callback?: (err: AWSError, data: SSM.Types.SendAutomationSignalResult) => void): Request<SSM.Types.SendAutomationSignalResult, AWSError>;
/**
* Sends a signal to an Automation execution to change the current behavior or status of the execution.
*/
sendAutomationSignal(callback?: (err: AWSError, data: SSM.Types.SendAutomationSignalResult) => void): Request<SSM.Types.SendAutomationSignalResult, AWSError>;
/**
* Runs commands on one or more managed instances.
*/
sendCommand(params: SSM.Types.SendCommandRequest, callback?: (err: AWSError, data: SSM.Types.SendCommandResult) => void): Request<SSM.Types.SendCommandResult, AWSError>;
/**
* Runs commands on one or more managed instances.
*/
sendCommand(callback?: (err: AWSError, data: SSM.Types.SendCommandResult) => void): Request<SSM.Types.SendCommandResult, AWSError>;
/**
* Use this API action to run an association immediately and only one time. This action can be helpful when troubleshooting associations.
*/
startAssociationsOnce(params: SSM.Types.StartAssociationsOnceRequest, callback?: (err: AWSError, data: SSM.Types.StartAssociationsOnceResult) => void): Request<SSM.Types.StartAssociationsOnceResult, AWSError>;
/**
* Use this API action to run an association immediately and only one time. This action can be helpful when troubleshooting associations.
*/
startAssociationsOnce(callback?: (err: AWSError, data: SSM.Types.StartAssociationsOnceResult) => void): Request<SSM.Types.StartAssociationsOnceResult, AWSError>;
/**
* Initiates execution of an Automation document.
*/
startAutomationExecution(params: SSM.Types.StartAutomationExecutionRequest, callback?: (err: AWSError, data: SSM.Types.StartAutomationExecutionResult) => void): Request<SSM.Types.StartAutomationExecutionResult, AWSError>;
/**
* Initiates execution of an Automation document.
*/
startAutomationExecution(callback?: (err: AWSError, data: SSM.Types.StartAutomationExecutionResult) => void): Request<SSM.Types.StartAutomationExecutionResult, AWSError>;
/**
* Initiates a connection to a target (for example, an instance) for a Session Manager session. Returns a URL and token that can be used to open a WebSocket connection for sending input and receiving outputs. AWS CLI usage: start-session is an interactive command that requires the Session Manager plugin to be installed on the client machine making the call. For information, see Install the Session Manager Plugin for the AWS CLI in the AWS Systems Manager User Guide. AWS Tools for PowerShell usage: Start-SSMSession is not currently supported by AWS Tools for PowerShell on Windows local machines.
*/
startSession(params: SSM.Types.StartSessionRequest, callback?: (err: AWSError, data: SSM.Types.StartSessionResponse) => void): Request<SSM.Types.StartSessionResponse, AWSError>;
/**
* Initiates a connection to a target (for example, an instance) for a Session Manager session. Returns a URL and token that can be used to open a WebSocket connection for sending input and receiving outputs. AWS CLI usage: start-session is an interactive command that requires the Session Manager plugin to be installed on the client machine making the call. For information, see Install the Session Manager Plugin for the AWS CLI in the AWS Systems Manager User Guide. AWS Tools for PowerShell usage: Start-SSMSession is not currently supported by AWS Tools for PowerShell on Windows local machines.
*/
startSession(callback?: (err: AWSError, data: SSM.Types.StartSessionResponse) => void): Request<SSM.Types.StartSessionResponse, AWSError>;
/**
* Stop an Automation that is currently running.
*/
stopAutomationExecution(params: SSM.Types.StopAutomationExecutionRequest, callback?: (err: AWSError, data: SSM.Types.StopAutomationExecutionResult) => void): Request<SSM.Types.StopAutomationExecutionResult, AWSError>;
/**
* Stop an Automation that is currently running.
*/
stopAutomationExecution(callback?: (err: AWSError, data: SSM.Types.StopAutomationExecutionResult) => void): Request<SSM.Types.StopAutomationExecutionResult, AWSError>;
/**
* Permanently ends a session and closes the data connection between the Session Manager client and SSM Agent on the instance. A terminated session cannot be resumed.
*/
terminateSession(params: SSM.Types.TerminateSessionRequest, callback?: (err: AWSError, data: SSM.Types.TerminateSessionResponse) => void): Request<SSM.Types.TerminateSessionResponse, AWSError>;
/**
* Permanently ends a session and closes the data connection between the Session Manager client and SSM Agent on the instance. A terminated session cannot be resumed.
*/
terminateSession(callback?: (err: AWSError, data: SSM.Types.TerminateSessionResponse) => void): Request<SSM.Types.TerminateSessionResponse, AWSError>;
/**
* Updates an association. You can update the association name and version, the document version, schedule, parameters, and Amazon S3 output. In order to call this API action, your IAM user account, group, or role must be configured with permission to call the DescribeAssociation API action. If you don't have permission to call DescribeAssociation, then you receive the following error: An error occurred (AccessDeniedException) when calling the UpdateAssociation operation: User: <user_arn> is not authorized to perform: ssm:DescribeAssociation on resource: <resource_arn> When you update an association, the association immediately runs against the specified targets.
*/
updateAssociation(params: SSM.Types.UpdateAssociationRequest, callback?: (err: AWSError, data: SSM.Types.UpdateAssociationResult) => void): Request<SSM.Types.UpdateAssociationResult, AWSError>;
/**
* Updates an association. You can update the association name and version, the document version, schedule, parameters, and Amazon S3 output. In order to call this API action, your IAM user account, group, or role must be configured with permission to call the DescribeAssociation API action. If you don't have permission to call DescribeAssociation, then you receive the following error: An error occurred (AccessDeniedException) when calling the UpdateAssociation operation: User: <user_arn> is not authorized to perform: ssm:DescribeAssociation on resource: <resource_arn> When you update an association, the association immediately runs against the specified targets.
*/
updateAssociation(callback?: (err: AWSError, data: SSM.Types.UpdateAssociationResult) => void): Request<SSM.Types.UpdateAssociationResult, AWSError>;
/**
* Updates the status of the Systems Manager document associated with the specified instance.
*/
updateAssociationStatus(params: SSM.Types.UpdateAssociationStatusRequest, callback?: (err: AWSError, data: SSM.Types.UpdateAssociationStatusResult) => void): Request<SSM.Types.UpdateAssociationStatusResult, AWSError>;
/**
* Updates the status of the Systems Manager document associated with the specified instance.
*/
updateAssociationStatus(callback?: (err: AWSError, data: SSM.Types.UpdateAssociationStatusResult) => void): Request<SSM.Types.UpdateAssociationStatusResult, AWSError>;
/**
* Updates one or more values for an SSM document.
*/
updateDocument(params: SSM.Types.UpdateDocumentRequest, callback?: (err: AWSError, data: SSM.Types.UpdateDocumentResult) => void): Request<SSM.Types.UpdateDocumentResult, AWSError>;
/**
* Updates one or more values for an SSM document.
*/
updateDocument(callback?: (err: AWSError, data: SSM.Types.UpdateDocumentResult) => void): Request<SSM.Types.UpdateDocumentResult, AWSError>;
/**
* Set the default version of a document.
*/
updateDocumentDefaultVersion(params: SSM.Types.UpdateDocumentDefaultVersionRequest, callback?: (err: AWSError, data: SSM.Types.UpdateDocumentDefaultVersionResult) => void): Request<SSM.Types.UpdateDocumentDefaultVersionResult, AWSError>;
/**
* Set the default version of a document.
*/
updateDocumentDefaultVersion(callback?: (err: AWSError, data: SSM.Types.UpdateDocumentDefaultVersionResult) => void): Request<SSM.Types.UpdateDocumentDefaultVersionResult, AWSError>;
/**
* Updates an existing maintenance window. Only specified parameters are modified. The value you specify for Duration determines the specific end time for the maintenance window based on the time it begins. No maintenance window tasks are permitted to start after the resulting endtime minus the number of hours you specify for Cutoff. For example, if the maintenance window starts at 3 PM, the duration is three hours, and the value you specify for Cutoff is one hour, no maintenance window tasks can start after 5 PM.
*/
updateMaintenanceWindow(params: SSM.Types.UpdateMaintenanceWindowRequest, callback?: (err: AWSError, data: SSM.Types.UpdateMaintenanceWindowResult) => void): Request<SSM.Types.UpdateMaintenanceWindowResult, AWSError>;
/**
* Updates an existing maintenance window. Only specified parameters are modified. The value you specify for Duration determines the specific end time for the maintenance window based on the time it begins. No maintenance window tasks are permitted to start after the resulting endtime minus the number of hours you specify for Cutoff. For example, if the maintenance window starts at 3 PM, the duration is three hours, and the value you specify for Cutoff is one hour, no maintenance window tasks can start after 5 PM.
*/
updateMaintenanceWindow(callback?: (err: AWSError, data: SSM.Types.UpdateMaintenanceWindowResult) => void): Request<SSM.Types.UpdateMaintenanceWindowResult, AWSError>;
/**
* Modifies the target of an existing maintenance window. You can change the following: Name Description Owner IDs for an ID target Tags for a Tag target From any supported tag type to another. The three supported tag types are ID target, Tag target, and resource group. For more information, see Target. If a parameter is null, then the corresponding field is not modified.
*/
updateMaintenanceWindowTarget(params: SSM.Types.UpdateMaintenanceWindowTargetRequest, callback?: (err: AWSError, data: SSM.Types.UpdateMaintenanceWindowTargetResult) => void): Request<SSM.Types.UpdateMaintenanceWindowTargetResult, AWSError>;
/**
* Modifies the target of an existing maintenance window. You can change the following: Name Description Owner IDs for an ID target Tags for a Tag target From any supported tag type to another. The three supported tag types are ID target, Tag target, and resource group. For more information, see Target. If a parameter is null, then the corresponding field is not modified.
*/
updateMaintenanceWindowTarget(callback?: (err: AWSError, data: SSM.Types.UpdateMaintenanceWindowTargetResult) => void): Request<SSM.Types.UpdateMaintenanceWindowTargetResult, AWSError>;
/**
* Modifies a task assigned to a maintenance window. You can't change the task type, but you can change the following values: TaskARN. For example, you can change a RUN_COMMAND task from AWS-RunPowerShellScript to AWS-RunShellScript. ServiceRoleArn TaskInvocationParameters Priority MaxConcurrency MaxErrors If a parameter is null, then the corresponding field is not modified. Also, if you set Replace to true, then all fields required by the RegisterTaskWithMaintenanceWindow action are required for this request. Optional fields that aren't specified are set to null.
*/
updateMaintenanceWindowTask(params: SSM.Types.UpdateMaintenanceWindowTaskRequest, callback?: (err: AWSError, data: SSM.Types.UpdateMaintenanceWindowTaskResult) => void): Request<SSM.Types.UpdateMaintenanceWindowTaskResult, AWSError>;
/**
* Modifies a task assigned to a maintenance window. You can't change the task type, but you can change the following values: TaskARN. For example, you can change a RUN_COMMAND task from AWS-RunPowerShellScript to AWS-RunShellScript. ServiceRoleArn TaskInvocationParameters Priority MaxConcurrency MaxErrors If a parameter is null, then the corresponding field is not modified. Also, if you set Replace to true, then all fields required by the RegisterTaskWithMaintenanceWindow action are required for this request. Optional fields that aren't specified are set to null.
*/
updateMaintenanceWindowTask(callback?: (err: AWSError, data: SSM.Types.UpdateMaintenanceWindowTaskResult) => void): Request<SSM.Types.UpdateMaintenanceWindowTaskResult, AWSError>;
/**
* Assigns or changes an Amazon Identity and Access Management (IAM) role for the managed instance.
*/
updateManagedInstanceRole(params: SSM.Types.UpdateManagedInstanceRoleRequest, callback?: (err: AWSError, data: SSM.Types.UpdateManagedInstanceRoleResult) => void): Request<SSM.Types.UpdateManagedInstanceRoleResult, AWSError>;
/**
* Assigns or changes an Amazon Identity and Access Management (IAM) role for the managed instance.
*/
updateManagedInstanceRole(callback?: (err: AWSError, data: SSM.Types.UpdateManagedInstanceRoleResult) => void): Request<SSM.Types.UpdateManagedInstanceRoleResult, AWSError>;
/**
* Edit or change an OpsItem. You must have permission in AWS Identity and Access Management (IAM) to update an OpsItem. For more information, see Getting Started with OpsCenter in the AWS Systems Manager User Guide. Operations engineers and IT professionals use OpsCenter to view, investigate, and remediate operational issues impacting the performance and health of their AWS resources. For more information, see AWS Systems Manager OpsCenter in the AWS Systems Manager User Guide.
*/
updateOpsItem(params: SSM.Types.UpdateOpsItemRequest, callback?: (err: AWSError, data: SSM.Types.UpdateOpsItemResponse) => void): Request<SSM.Types.UpdateOpsItemResponse, AWSError>;
/**
* Edit or change an OpsItem. You must have permission in AWS Identity and Access Management (IAM) to update an OpsItem. For more information, see Getting Started with OpsCenter in the AWS Systems Manager User Guide. Operations engineers and IT professionals use OpsCenter to view, investigate, and remediate operational issues impacting the performance and health of their AWS resources. For more information, see AWS Systems Manager OpsCenter in the AWS Systems Manager User Guide.
*/
updateOpsItem(callback?: (err: AWSError, data: SSM.Types.UpdateOpsItemResponse) => void): Request<SSM.Types.UpdateOpsItemResponse, AWSError>;
/**
* Modifies an existing patch baseline. Fields not specified in the request are left unchanged. For information about valid key and value pairs in PatchFilters for each supported operating system type, see PatchFilter.
*/
updatePatchBaseline(params: SSM.Types.UpdatePatchBaselineRequest, callback?: (err: AWSError, data: SSM.Types.UpdatePatchBaselineResult) => void): Request<SSM.Types.UpdatePatchBaselineResult, AWSError>;
/**
* Modifies an existing patch baseline. Fields not specified in the request are left unchanged. For information about valid key and value pairs in PatchFilters for each supported operating system type, see PatchFilter.
*/
updatePatchBaseline(callback?: (err: AWSError, data: SSM.Types.UpdatePatchBaselineResult) => void): Request<SSM.Types.UpdatePatchBaselineResult, AWSError>;
/**
* Update a resource data sync. After you create a resource data sync for a Region, you can't change the account options for that sync. For example, if you create a sync in the us-east-2 (Ohio) Region and you choose the Include only the current account option, you can't edit that sync later and choose the Include all accounts from my AWS Organizations configuration option. Instead, you must delete the first resource data sync, and create a new one.
*/
updateResourceDataSync(params: SSM.Types.UpdateResourceDataSyncRequest, callback?: (err: AWSError, data: SSM.Types.UpdateResourceDataSyncResult) => void): Request<SSM.Types.UpdateResourceDataSyncResult, AWSError>;
/**
* Update a resource data sync. After you create a resource data sync for a Region, you can't change the account options for that sync. For example, if you create a sync in the us-east-2 (Ohio) Region and you choose the Include only the current account option, you can't edit that sync later and choose the Include all accounts from my AWS Organizations configuration option. Instead, you must delete the first resource data sync, and create a new one.
*/
updateResourceDataSync(callback?: (err: AWSError, data: SSM.Types.UpdateResourceDataSyncResult) => void): Request<SSM.Types.UpdateResourceDataSyncResult, AWSError>;
/**
* ServiceSetting is an account-level setting for an AWS service. This setting defines how a user interacts with or uses a service or a feature of a service. For example, if an AWS service charges money to the account based on feature or service usage, then the AWS service team might create a default setting of "false". This means the user can't use this feature unless they change the setting to "true" and intentionally opt in for a paid feature. Services map a SettingId object to a setting value. AWS services teams define the default value for a SettingId. You can't create a new SettingId, but you can overwrite the default value if you have the ssm:UpdateServiceSetting permission for the setting. Use the GetServiceSetting API action to view the current value. Or, use the ResetServiceSetting to change the value back to the original value defined by the AWS service team. Update the service setting for the account.
*/
updateServiceSetting(params: SSM.Types.UpdateServiceSettingRequest, callback?: (err: AWSError, data: SSM.Types.UpdateServiceSettingResult) => void): Request<SSM.Types.UpdateServiceSettingResult, AWSError>;
/**
* ServiceSetting is an account-level setting for an AWS service. This setting defines how a user interacts with or uses a service or a feature of a service. For example, if an AWS service charges money to the account based on feature or service usage, then the AWS service team might create a default setting of "false". This means the user can't use this feature unless they change the setting to "true" and intentionally opt in for a paid feature. Services map a SettingId object to a setting value. AWS services teams define the default value for a SettingId. You can't create a new SettingId, but you can overwrite the default value if you have the ssm:UpdateServiceSetting permission for the setting. Use the GetServiceSetting API action to view the current value. Or, use the ResetServiceSetting to change the value back to the original value defined by the AWS service team. Update the service setting for the account.
*/
updateServiceSetting(callback?: (err: AWSError, data: SSM.Types.UpdateServiceSettingResult) => void): Request<SSM.Types.UpdateServiceSettingResult, AWSError>;
}
declare namespace SSM {
export type Account = string;
export type AccountId = string;
export type AccountIdList = AccountId[];
export interface AccountSharingInfo {
/**
* The AWS account ID where the current document is shared.
*/
AccountId?: AccountId;
/**
* The version of the current document shared with the account.
*/
SharedDocumentVersion?: SharedDocumentVersion;
}
export type AccountSharingInfoList = AccountSharingInfo[];
export type Accounts = Account[];
export interface Activation {
/**
* The ID created by Systems Manager when you submitted the activation.
*/
ActivationId?: ActivationId;
/**
* A user defined description of the activation.
*/
Description?: ActivationDescription;
/**
* A name for the managed instance when it is created.
*/
DefaultInstanceName?: DefaultInstanceName;
/**
* The Amazon Identity and Access Management (IAM) role to assign to the managed instance.
*/
IamRole?: IamRole;
/**
* The maximum number of managed instances that can be registered using this activation.
*/
RegistrationLimit?: RegistrationLimit;
/**
* The number of managed instances already registered with this activation.
*/
RegistrationsCount?: RegistrationsCount;
/**
* The date when this activation can no longer be used to register managed instances.
*/
ExpirationDate?: ExpirationDate;
/**
* Whether or not the activation is expired.
*/
Expired?: Boolean;
/**
* The date the activation was created.
*/
CreatedDate?: CreatedDate;
/**
* Tags assigned to the activation.
*/
Tags?: TagList;
}
export type ActivationCode = string;
export type ActivationDescription = string;
export type ActivationId = string;
export type ActivationList = Activation[];
export interface AddTagsToResourceRequest {
/**
* Specifies the type of resource you are tagging. The ManagedInstance type for this API action is for on-premises managed instances. You must specify the name of the managed instance in the following format: mi-ID_number. For example, mi-1a2b3c4d5e6f.
*/
ResourceType: ResourceTypeForTagging;
/**
* The resource ID you want to tag. Use the ID of the resource. Here are some examples: ManagedInstance: mi-012345abcde MaintenanceWindow: mw-012345abcde PatchBaseline: pb-012345abcde For the Document and Parameter values, use the name of the resource. The ManagedInstance type for this API action is only for on-premises managed instances. You must specify the name of the managed instance in the following format: mi-ID_number. For example, mi-1a2b3c4d5e6f.
*/
ResourceId: ResourceId;
/**
* One or more tags. The value parameter is required, but if you don't want the tag to have a value, specify the parameter with no value, and we set the value to an empty string. Do not enter personally identifiable information in this field.
*/
Tags: TagList;
}
export interface AddTagsToResourceResult {
}
export type AgentErrorCode = string;
export type AggregatorSchemaOnly = boolean;
export type AllowedPattern = string;
export type ApproveAfterDays = number;
export interface Association {
/**
* The name of the Systems Manager document.
*/
Name?: DocumentARN;
/**
* The ID of the instance.
*/
InstanceId?: InstanceId;
/**
* The ID created by the system when you create an association. An association is a binding between a document and a set of targets with a schedule.
*/
AssociationId?: AssociationId;
/**
* The association version.
*/
AssociationVersion?: AssociationVersion;
/**
* The version of the document used in the association.
*/
DocumentVersion?: DocumentVersion;
/**
* The instances targeted by the request to create an association.
*/
Targets?: Targets;
/**
* The date on which the association was last run.
*/
LastExecutionDate?: DateTime;
/**
* Information about the association.
*/
Overview?: AssociationOverview;
/**
* A cron expression that specifies a schedule when the association runs.
*/
ScheduleExpression?: ScheduleExpression;
/**
* The association name.
*/
AssociationName?: AssociationName;
}
export type AssociationComplianceSeverity = "CRITICAL"|"HIGH"|"MEDIUM"|"LOW"|"UNSPECIFIED"|string;
export interface AssociationDescription {
/**
* The name of the Systems Manager document.
*/
Name?: DocumentARN;
/**
* The ID of the instance.
*/
InstanceId?: InstanceId;
/**
* The association version.
*/
AssociationVersion?: AssociationVersion;
/**
* The date when the association was made.
*/
Date?: DateTime;
/**
* The date when the association was last updated.
*/
LastUpdateAssociationDate?: DateTime;
/**
* The association status.
*/
Status?: AssociationStatus;
/**
* Information about the association.
*/
Overview?: AssociationOverview;
/**
* The document version.
*/
DocumentVersion?: DocumentVersion;
/**
* Specify the target for the association. This target is required for associations that use an Automation document and target resources by using rate controls.
*/
AutomationTargetParameterName?: AutomationTargetParameterName;
/**
* A description of the parameters for a document.
*/
Parameters?: Parameters;
/**
* The association ID.
*/
AssociationId?: AssociationId;
/**
* The instances targeted by the request.
*/
Targets?: Targets;
/**
* A cron expression that specifies a schedule when the association runs.
*/
ScheduleExpression?: ScheduleExpression;
/**
* An Amazon S3 bucket where you want to store the output details of the request.
*/
OutputLocation?: InstanceAssociationOutputLocation;
/**
* The date on which the association was last run.
*/
LastExecutionDate?: DateTime;
/**
* The last date on which the association was successfully run.
*/
LastSuccessfulExecutionDate?: DateTime;
/**
* The association name.
*/
AssociationName?: AssociationName;
/**
* The number of errors that are allowed before the system stops sending requests to run the association on additional targets. You can specify either an absolute number of errors, for example 10, or a percentage of the target set, for example 10%. If you specify 3, for example, the system stops sending requests when the fourth error is received. If you specify 0, then the system stops sending requests after the first error is returned. If you run an association on 50 instances and set MaxError to 10%, then the system stops sending the request when the sixth error is received. Executions that are already running an association when MaxErrors is reached are allowed to complete, but some of these executions may fail as well. If you need to ensure that there won't be more than max-errors failed executions, set MaxConcurrency to 1 so that executions proceed one at a time.
*/
MaxErrors?: MaxErrors;
/**
* The maximum number of targets allowed to run the association at the same time. You can specify a number, for example 10, or a percentage of the target set, for example 10%. The default value is 100%, which means all targets run the association at the same time. If a new instance starts and attempts to run an association while Systems Manager is running MaxConcurrency associations, the association is allowed to run. During the next association interval, the new instance will process its association within the limit specified for MaxConcurrency.
*/
MaxConcurrency?: MaxConcurrency;
/**
* The severity level that is assigned to the association.
*/
ComplianceSeverity?: AssociationComplianceSeverity;
}
export type AssociationDescriptionList = AssociationDescription[];
export interface AssociationExecution {
/**
* The association ID.
*/
AssociationId?: AssociationId;
/**
* The association version.
*/
AssociationVersion?: AssociationVersion;
/**
* The execution ID for the association.
*/
ExecutionId?: AssociationExecutionId;
/**
* The status of the association execution.
*/
Status?: StatusName;
/**
* Detailed status information about the execution.
*/
DetailedStatus?: StatusName;
/**
* The time the execution started.
*/
CreatedTime?: DateTime;
/**
* The date of the last execution.
*/
LastExecutionDate?: DateTime;
/**
* An aggregate status of the resources in the execution based on the status type.
*/
ResourceCountByStatus?: ResourceCountByStatus;
}
export interface AssociationExecutionFilter {
/**
* The key value used in the request.
*/
Key: AssociationExecutionFilterKey;
/**
* The value specified for the key.
*/
Value: AssociationExecutionFilterValue;
/**
* The filter type specified in the request.
*/
Type: AssociationFilterOperatorType;
}
export type AssociationExecutionFilterKey = "ExecutionId"|"Status"|"CreatedTime"|string;
export type AssociationExecutionFilterList = AssociationExecutionFilter[];
export type AssociationExecutionFilterValue = string;
export type AssociationExecutionId = string;
export interface AssociationExecutionTarget {
/**
* The association ID.
*/
AssociationId?: AssociationId;
/**
* The association version.
*/
AssociationVersion?: AssociationVersion;
/**
* The execution ID.
*/
ExecutionId?: AssociationExecutionId;
/**
* The resource ID, for example, the instance ID where the association ran.
*/
ResourceId?: AssociationResourceId;
/**
* The resource type, for example, instance.
*/
ResourceType?: AssociationResourceType;
/**
* The association execution status.
*/
Status?: StatusName;
/**
* Detailed information about the execution status.
*/
DetailedStatus?: StatusName;
/**
* The date of the last execution.
*/
LastExecutionDate?: DateTime;
/**
* The location where the association details are saved.
*/
OutputSource?: OutputSource;
}
export interface AssociationExecutionTargetsFilter {
/**
* The key value used in the request.
*/
Key: AssociationExecutionTargetsFilterKey;
/**
* The value specified for the key.
*/
Value: AssociationExecutionTargetsFilterValue;
}
export type AssociationExecutionTargetsFilterKey = "Status"|"ResourceId"|"ResourceType"|string;
export type AssociationExecutionTargetsFilterList = AssociationExecutionTargetsFilter[];
export type AssociationExecutionTargetsFilterValue = string;
export type AssociationExecutionTargetsList = AssociationExecutionTarget[];
export type AssociationExecutionsList = AssociationExecution[];
export interface AssociationFilter {
/**
* The name of the filter.
*/
key: AssociationFilterKey;
/**
* The filter value.
*/
value: AssociationFilterValue;
}
export type AssociationFilterKey = "InstanceId"|"Name"|"AssociationId"|"AssociationStatusName"|"LastExecutedBefore"|"LastExecutedAfter"|"AssociationName"|string;
export type AssociationFilterList = AssociationFilter[];
export type AssociationFilterOperatorType = "EQUAL"|"LESS_THAN"|"GREATER_THAN"|string;
export type AssociationFilterValue = string;
export type AssociationId = string;
export type AssociationIdList = AssociationId[];
export type AssociationList = Association[];
export type AssociationName = string;
export interface AssociationOverview {
/**
* The status of the association. Status can be: Pending, Success, or Failed.
*/
Status?: StatusName;
/**
* A detailed status of the association.
*/
DetailedStatus?: StatusName;
/**
* Returns the number of targets for the association status. For example, if you created an association with two instances, and one of them was successful, this would return the count of instances by status.
*/
AssociationStatusAggregatedCount?: AssociationStatusAggregatedCount;
}
export type AssociationResourceId = string;
export type AssociationResourceType = string;
export interface AssociationStatus {
/**
* The date when the status changed.
*/
Date: DateTime;
/**
* The status.
*/
Name: AssociationStatusName;
/**
* The reason for the status.
*/
Message: StatusMessage;
/**
* A user-defined string.
*/
AdditionalInfo?: StatusAdditionalInfo;
}
export type AssociationStatusAggregatedCount = {[key: string]: InstanceCount};
export type AssociationStatusName = "Pending"|"Success"|"Failed"|string;
export type AssociationVersion = string;
export interface AssociationVersionInfo {
/**
* The ID created by the system when the association was created.
*/
AssociationId?: AssociationId;
/**
* The association version.
*/
AssociationVersion?: AssociationVersion;
/**
* The date the association version was created.
*/
CreatedDate?: DateTime;
/**
* The name specified when the association was created.
*/
Name?: DocumentARN;
/**
* The version of a Systems Manager document used when the association version was created.
*/
DocumentVersion?: DocumentVersion;
/**
* Parameters specified when the association version was created.
*/
Parameters?: Parameters;
/**
* The targets specified for the association when the association version was created.
*/
Targets?: Targets;
/**
* The cron or rate schedule specified for the association when the association version was created.
*/
ScheduleExpression?: ScheduleExpression;
/**
* The location in Amazon S3 specified for the association when the association version was created.
*/
OutputLocation?: InstanceAssociationOutputLocation;
/**
* The name specified for the association version when the association version was created.
*/
AssociationName?: AssociationName;
/**
* The number of errors that are allowed before the system stops sending requests to run the association on additional targets. You can specify either an absolute number of errors, for example 10, or a percentage of the target set, for example 10%. If you specify 3, for example, the system stops sending requests when the fourth error is received. If you specify 0, then the system stops sending requests after the first error is returned. If you run an association on 50 instances and set MaxError to 10%, then the system stops sending the request when the sixth error is received. Executions that are already running an association when MaxErrors is reached are allowed to complete, but some of these executions may fail as well. If you need to ensure that there won't be more than max-errors failed executions, set MaxConcurrency to 1 so that executions proceed one at a time.
*/
MaxErrors?: MaxErrors;
/**
* The maximum number of targets allowed to run the association at the same time. You can specify a number, for example 10, or a percentage of the target set, for example 10%. The default value is 100%, which means all targets run the association at the same time. If a new instance starts and attempts to run an association while Systems Manager is running MaxConcurrency associations, the association is allowed to run. During the next association interval, the new instance will process its association within the limit specified for MaxConcurrency.
*/
MaxConcurrency?: MaxConcurrency;
/**
* The severity level that is assigned to the association.
*/
ComplianceSeverity?: AssociationComplianceSeverity;
}
export type AssociationVersionList = AssociationVersionInfo[];
export interface AttachmentContent {
/**
* The name of an attachment.
*/
Name?: AttachmentName;
/**
* The size of an attachment in bytes.
*/
Size?: ContentLength;
/**
* The cryptographic hash value of the document content.
*/
Hash?: AttachmentHash;
/**
* The hash algorithm used to calculate the hash value.
*/
HashType?: AttachmentHashType;
/**
* The URL location of the attachment content.
*/
Url?: AttachmentUrl;
}
export type AttachmentContentList = AttachmentContent[];
export type AttachmentHash = string;
export type AttachmentHashType = "Sha256"|string;
export type AttachmentIdentifier = string;
export interface AttachmentInformation {
/**
* The name of the attachment.
*/
Name?: AttachmentName;
}
export type AttachmentInformationList = AttachmentInformation[];
export type AttachmentName = string;
export type AttachmentUrl = string;
export interface AttachmentsSource {
/**
* The key of a key-value pair that identifies the location of an attachment to a document.
*/
Key?: AttachmentsSourceKey;
/**
* The value of a key-value pair that identifies the location of an attachment to a document. The format is the URL of the location of a document attachment, such as the URL of an Amazon S3 bucket.
*/
Values?: AttachmentsSourceValues;
/**
* The name of the document attachment file.
*/
Name?: AttachmentIdentifier;
}
export type AttachmentsSourceKey = "SourceUrl"|"S3FileUrl"|string;
export type AttachmentsSourceList = AttachmentsSource[];
export type AttachmentsSourceValue = string;
export type AttachmentsSourceValues = AttachmentsSourceValue[];
export type AttributeName = string;
export type AttributeValue = string;
export type AutomationActionName = string;
export interface AutomationExecution {
/**
* The execution ID.
*/
AutomationExecutionId?: AutomationExecutionId;
/**
* The name of the Automation document used during the execution.
*/
DocumentName?: DocumentName;
/**
* The version of the document to use during execution.
*/
DocumentVersion?: DocumentVersion;
/**
* The time the execution started.
*/
ExecutionStartTime?: DateTime;
/**
* The time the execution finished.
*/
ExecutionEndTime?: DateTime;
/**
* The execution status of the Automation.
*/
AutomationExecutionStatus?: AutomationExecutionStatus;
/**
* A list of details about the current state of all steps that comprise an execution. An Automation document contains a list of steps that are run in order.
*/
StepExecutions?: StepExecutionList;
/**
* A boolean value that indicates if the response contains the full list of the Automation step executions. If true, use the DescribeAutomationStepExecutions API action to get the full list of step executions.
*/
StepExecutionsTruncated?: Boolean;
/**
* The key-value map of execution parameters, which were supplied when calling StartAutomationExecution.
*/
Parameters?: AutomationParameterMap;
/**
* The list of execution outputs as defined in the automation document.
*/
Outputs?: AutomationParameterMap;
/**
* A message describing why an execution has failed, if the status is set to Failed.
*/
FailureMessage?: String;
/**
* The automation execution mode.
*/
Mode?: ExecutionMode;
/**
* The AutomationExecutionId of the parent automation.
*/
ParentAutomationExecutionId?: AutomationExecutionId;
/**
* The Amazon Resource Name (ARN) of the user who ran the automation.
*/
ExecutedBy?: String;
/**
* The name of the step that is currently running.
*/
CurrentStepName?: String;
/**
* The action of the step that is currently running.
*/
CurrentAction?: String;
/**
* The parameter name.
*/
TargetParameterName?: AutomationParameterKey;
/**
* The specified targets.
*/
Targets?: Targets;
/**
* The specified key-value mapping of document parameters to target resources.
*/
TargetMaps?: TargetMaps;
/**
* A list of resolved targets in the rate control execution.
*/
ResolvedTargets?: ResolvedTargets;
/**
* The MaxConcurrency value specified by the user when the execution started.
*/
MaxConcurrency?: MaxConcurrency;
/**
* The MaxErrors value specified by the user when the execution started.
*/
MaxErrors?: MaxErrors;
/**
* The target of the execution.
*/
Target?: String;
/**
* The combination of AWS Regions and/or AWS accounts where you want to run the Automation.
*/
TargetLocations?: TargetLocations;
/**
* An aggregate of step execution statuses displayed in the AWS Console for a multi-Region and multi-account Automation execution.
*/
ProgressCounters?: ProgressCounters;
}
export interface AutomationExecutionFilter {
/**
* One or more keys to limit the results. Valid filter keys include the following: DocumentNamePrefix, ExecutionStatus, ExecutionId, ParentExecutionId, CurrentAction, StartTimeBefore, StartTimeAfter.
*/
Key: AutomationExecutionFilterKey;
/**
* The values used to limit the execution information associated with the filter's key.
*/
Values: AutomationExecutionFilterValueList;
}
export type AutomationExecutionFilterKey = "DocumentNamePrefix"|"ExecutionStatus"|"ExecutionId"|"ParentExecutionId"|"CurrentAction"|"StartTimeBefore"|"StartTimeAfter"|"AutomationType"|string;
export type AutomationExecutionFilterList = AutomationExecutionFilter[];
export type AutomationExecutionFilterValue = string;
export type AutomationExecutionFilterValueList = AutomationExecutionFilterValue[];
export type AutomationExecutionId = string;
export interface AutomationExecutionMetadata {
/**
* The execution ID.
*/
AutomationExecutionId?: AutomationExecutionId;
/**
* The name of the Automation document used during execution.
*/
DocumentName?: DocumentName;
/**
* The document version used during the execution.
*/
DocumentVersion?: DocumentVersion;
/**
* The status of the execution. Valid values include: Running, Succeeded, Failed, Timed out, or Cancelled.
*/
AutomationExecutionStatus?: AutomationExecutionStatus;
/**
* The time the execution started.>
*/
ExecutionStartTime?: DateTime;
/**
* The time the execution finished. This is not populated if the execution is still in progress.
*/
ExecutionEndTime?: DateTime;
/**
* The IAM role ARN of the user who ran the Automation.
*/
ExecutedBy?: String;
/**
* An Amazon S3 bucket where execution information is stored.
*/
LogFile?: String;
/**
* The list of execution outputs as defined in the Automation document.
*/
Outputs?: AutomationParameterMap;
/**
* The Automation execution mode.
*/
Mode?: ExecutionMode;
/**
* The ExecutionId of the parent Automation.
*/
ParentAutomationExecutionId?: AutomationExecutionId;
/**
* The name of the step that is currently running.
*/
CurrentStepName?: String;
/**
* The action of the step that is currently running.
*/
CurrentAction?: String;
/**
* The list of execution outputs as defined in the Automation document.
*/
FailureMessage?: String;
/**
* The list of execution outputs as defined in the Automation document.
*/
TargetParameterName?: AutomationParameterKey;
/**
* The targets defined by the user when starting the Automation.
*/
Targets?: Targets;
/**
* The specified key-value mapping of document parameters to target resources.
*/
TargetMaps?: TargetMaps;
/**
* A list of targets that resolved during the execution.
*/
ResolvedTargets?: ResolvedTargets;
/**
* The MaxConcurrency value specified by the user when starting the Automation.
*/
MaxConcurrency?: MaxConcurrency;
/**
* The MaxErrors value specified by the user when starting the Automation.
*/
MaxErrors?: MaxErrors;
/**
* The list of execution outputs as defined in the Automation document.
*/
Target?: String;
/**
* Use this filter with DescribeAutomationExecutions. Specify either Local or CrossAccount. CrossAccount is an Automation that runs in multiple AWS Regions and accounts. For more information, see Executing Automations in Multiple AWS Regions and Accounts in the AWS Systems Manager User Guide.
*/
AutomationType?: AutomationType;
}
export type AutomationExecutionMetadataList = AutomationExecutionMetadata[];
export type AutomationExecutionStatus = "Pending"|"InProgress"|"Waiting"|"Success"|"TimedOut"|"Cancelling"|"Cancelled"|"Failed"|string;
export type AutomationParameterKey = string;
export type AutomationParameterMap = {[key: string]: AutomationParameterValueList};
export type AutomationParameterValue = string;
export type AutomationParameterValueList = AutomationParameterValue[];
export type AutomationTargetParameterName = string;
export type AutomationType = "CrossAccount"|"Local"|string;
export type BaselineDescription = string;
export type BaselineId = string;
export type BaselineName = string;
export type BatchErrorMessage = string;
export type Boolean = boolean;
export type CalendarNameOrARN = string;
export type CalendarNameOrARNList = CalendarNameOrARN[];
export type CalendarState = "OPEN"|"CLOSED"|string;
export interface CancelCommandRequest {
/**
* The ID of the command you want to cancel.
*/
CommandId: CommandId;
/**
* (Optional) A list of instance IDs on which you want to cancel the command. If not provided, the command is canceled on every instance on which it was requested.
*/
InstanceIds?: InstanceIdList;
}
export interface CancelCommandResult {
}
export interface CancelMaintenanceWindowExecutionRequest {
/**
* The ID of the maintenance window execution to stop.
*/
WindowExecutionId: MaintenanceWindowExecutionId;
}
export interface CancelMaintenanceWindowExecutionResult {
/**
* The ID of the maintenance window execution that has been stopped.
*/
WindowExecutionId?: MaintenanceWindowExecutionId;
}
export type ClientToken = string;
export type CloudWatchLogGroupName = string;
export interface CloudWatchOutputConfig {
/**
* The name of the CloudWatch log group where you want to send command output. If you don't specify a group name, Systems Manager automatically creates a log group for you. The log group uses the following naming format: aws/ssm/SystemsManagerDocumentName.
*/
CloudWatchLogGroupName?: CloudWatchLogGroupName;
/**
* Enables Systems Manager to send command output to CloudWatch Logs.
*/
CloudWatchOutputEnabled?: CloudWatchOutputEnabled;
}
export type CloudWatchOutputEnabled = boolean;
export interface Command {
/**
* A unique identifier for this command.
*/
CommandId?: CommandId;
/**
* The name of the document requested for execution.
*/
DocumentName?: DocumentName;
/**
* The SSM document version.
*/
DocumentVersion?: DocumentVersion;
/**
* User-specified information about the command, such as a brief description of what the command should do.
*/
Comment?: Comment;
/**
* If this time is reached and the command has not already started running, it will not run. Calculated based on the ExpiresAfter user input provided as part of the SendCommand API.
*/
ExpiresAfter?: DateTime;
/**
* The parameter values to be inserted in the document when running the command.
*/
Parameters?: Parameters;
/**
* The instance IDs against which this command was requested.
*/
InstanceIds?: InstanceIdList;
/**
* An array of search criteria that targets instances using a Key,Value combination that you specify. Targets is required if you don't provide one or more instance IDs in the call.
*/
Targets?: Targets;
/**
* The date and time the command was requested.
*/
RequestedDateTime?: DateTime;
/**
* The status of the command.
*/
Status?: CommandStatus;
/**
* A detailed status of the command execution. StatusDetails includes more information than Status because it includes states resulting from error and concurrency control parameters. StatusDetails can show different results than Status. For more information about these statuses, see Understanding Command Statuses in the AWS Systems Manager User Guide. StatusDetails can be one of the following values: Pending: The command has not been sent to any instances. In Progress: The command has been sent to at least one instance but has not reached a final state on all instances. Success: The command successfully ran on all invocations. This is a terminal state. Delivery Timed Out: The value of MaxErrors or more command invocations shows a status of Delivery Timed Out. This is a terminal state. Execution Timed Out: The value of MaxErrors or more command invocations shows a status of Execution Timed Out. This is a terminal state. Failed: The value of MaxErrors or more command invocations shows a status of Failed. This is a terminal state. Incomplete: The command was attempted on all instances and one or more invocations does not have a value of Success but not enough invocations failed for the status to be Failed. This is a terminal state. Canceled: The command was terminated before it was completed. This is a terminal state. Rate Exceeded: The number of instances targeted by the command exceeded the account limit for pending invocations. The system has canceled the command before running it on any instance. This is a terminal state.
*/
StatusDetails?: StatusDetails;
/**
* (Deprecated) You can no longer specify this parameter. The system ignores it. Instead, Systems Manager automatically determines the Amazon S3 bucket region.
*/
OutputS3Region?: S3Region;
/**
* The S3 bucket where the responses to the command executions should be stored. This was requested when issuing the command.
*/
OutputS3BucketName?: S3BucketName;
/**
* The S3 directory path inside the bucket where the responses to the command executions should be stored. This was requested when issuing the command.
*/
OutputS3KeyPrefix?: S3KeyPrefix;
/**
* The maximum number of instances that are allowed to run the command at the same time. You can specify a number of instances, such as 10, or a percentage of instances, such as 10%. The default value is 50. For more information about how to use MaxConcurrency, see Running Commands Using Systems Manager Run Command in the AWS Systems Manager User Guide.
*/
MaxConcurrency?: MaxConcurrency;
/**
* The maximum number of errors allowed before the system stops sending the command to additional targets. You can specify a number of errors, such as 10, or a percentage or errors, such as 10%. The default value is 0. For more information about how to use MaxErrors, see Running Commands Using Systems Manager Run Command in the AWS Systems Manager User Guide.
*/
MaxErrors?: MaxErrors;
/**
* The number of targets for the command.
*/
TargetCount?: TargetCount;
/**
* The number of targets for which the command invocation reached a terminal state. Terminal states include the following: Success, Failed, Execution Timed Out, Delivery Timed Out, Canceled, Terminated, or Undeliverable.
*/
CompletedCount?: CompletedCount;
/**
* The number of targets for which the status is Failed or Execution Timed Out.
*/
ErrorCount?: ErrorCount;
/**
* The number of targets for which the status is Delivery Timed Out.
*/
DeliveryTimedOutCount?: DeliveryTimedOutCount;
/**
* The IAM service role that Run Command uses to act on your behalf when sending notifications about command status changes.
*/
ServiceRole?: ServiceRole;
/**
* Configurations for sending notifications about command status changes.
*/
NotificationConfig?: NotificationConfig;
/**
* CloudWatch Logs information where you want Systems Manager to send the command output.
*/
CloudWatchOutputConfig?: CloudWatchOutputConfig;
}
export interface CommandFilter {
/**
* The name of the filter.
*/
key: CommandFilterKey;
/**
* The filter value. Valid values for each filter key are as follows: InvokedAfter: Specify a timestamp to limit your results. For example, specify 2018-07-07T00:00:00Z to see a list of command executions occurring July 7, 2018, and later. InvokedBefore: Specify a timestamp to limit your results. For example, specify 2018-07-07T00:00:00Z to see a list of command executions from before July 7, 2018. Status: Specify a valid command status to see a list of all command executions with that status. Status values you can specify include: Pending InProgress Success Cancelled Failed TimedOut Cancelling DocumentName: Specify name of the SSM document for which you want to see command execution results. For example, specify AWS-RunPatchBaseline to see command executions that used this SSM document to perform security patching operations on instances. ExecutionStage: Specify one of the following values: Executing: Returns a list of command executions that are currently still running. Complete: Returns a list of command executions that have already completed.
*/
value: CommandFilterValue;
}
export type CommandFilterKey = "InvokedAfter"|"InvokedBefore"|"Status"|"ExecutionStage"|"DocumentName"|string;
export type CommandFilterList = CommandFilter[];
export type CommandFilterValue = string;
export type CommandId = string;
export interface CommandInvocation {
/**
* The command against which this invocation was requested.
*/
CommandId?: CommandId;
/**
* The instance ID in which this invocation was requested.
*/
InstanceId?: InstanceId;
/**
* The name of the invocation target. For Amazon EC2 instances this is the value for the aws:Name tag. For on-premises instances, this is the name of the instance.
*/
InstanceName?: InstanceTagName;
/**
* User-specified information about the command, such as a brief description of what the command should do.
*/
Comment?: Comment;
/**
* The document name that was requested for execution.
*/
DocumentName?: DocumentName;
/**
* The SSM document version.
*/
DocumentVersion?: DocumentVersion;
/**
* The time and date the request was sent to this instance.
*/
RequestedDateTime?: DateTime;
/**
* Whether or not the invocation succeeded, failed, or is pending.
*/
Status?: CommandInvocationStatus;
/**
* A detailed status of the command execution for each invocation (each instance targeted by the command). StatusDetails includes more information than Status because it includes states resulting from error and concurrency control parameters. StatusDetails can show different results than Status. For more information about these statuses, see Understanding Command Statuses in the AWS Systems Manager User Guide. StatusDetails can be one of the following values: Pending: The command has not been sent to the instance. In Progress: The command has been sent to the instance but has not reached a terminal state. Success: The execution of the command or plugin was successfully completed. This is a terminal state. Delivery Timed Out: The command was not delivered to the instance before the delivery timeout expired. Delivery timeouts do not count against the parent command's MaxErrors limit, but they do contribute to whether the parent command status is Success or Incomplete. This is a terminal state. Execution Timed Out: Command execution started on the instance, but the execution was not complete before the execution timeout expired. Execution timeouts count against the MaxErrors limit of the parent command. This is a terminal state. Failed: The command was not successful on the instance. For a plugin, this indicates that the result code was not zero. For a command invocation, this indicates that the result code for one or more plugins was not zero. Invocation failures count against the MaxErrors limit of the parent command. This is a terminal state. Canceled: The command was terminated before it was completed. This is a terminal state. Undeliverable: The command can't be delivered to the instance. The instance might not exist or might not be responding. Undeliverable invocations don't count against the parent command's MaxErrors limit and don't contribute to whether the parent command status is Success or Incomplete. This is a terminal state. Terminated: The parent command exceeded its MaxErrors limit and subsequent command invocations were canceled by the system. This is a terminal state.
*/
StatusDetails?: StatusDetails;
/**
* Gets the trace output sent by the agent.
*/
TraceOutput?: InvocationTraceOutput;
/**
* The URL to the plugin's StdOut file in Amazon S3, if the Amazon S3 bucket was defined for the parent command. For an invocation, StandardOutputUrl is populated if there is just one plugin defined for the command, and the Amazon S3 bucket was defined for the command.
*/
StandardOutputUrl?: Url;
/**
* The URL to the plugin's StdErr file in Amazon S3, if the Amazon S3 bucket was defined for the parent command. For an invocation, StandardErrorUrl is populated if there is just one plugin defined for the command, and the Amazon S3 bucket was defined for the command.
*/
StandardErrorUrl?: Url;
CommandPlugins?: CommandPluginList;
/**
* The IAM service role that Run Command uses to act on your behalf when sending notifications about command status changes on a per instance basis.
*/
ServiceRole?: ServiceRole;
/**
* Configurations for sending notifications about command status changes on a per instance basis.
*/
NotificationConfig?: NotificationConfig;
/**
* CloudWatch Logs information where you want Systems Manager to send the command output.
*/
CloudWatchOutputConfig?: CloudWatchOutputConfig;
}
export type CommandInvocationList = CommandInvocation[];
export type CommandInvocationStatus = "Pending"|"InProgress"|"Delayed"|"Success"|"Cancelled"|"TimedOut"|"Failed"|"Cancelling"|string;
export type CommandList = Command[];
export type CommandMaxResults = number;
export interface CommandPlugin {
/**
* The name of the plugin. Must be one of the following: aws:updateAgent, aws:domainjoin, aws:applications, aws:runPowerShellScript, aws:psmodule, aws:cloudWatch, aws:runShellScript, or aws:updateSSMAgent.
*/
Name?: CommandPluginName;
/**
* The status of this plugin. You can run a document with multiple plugins.
*/
Status?: CommandPluginStatus;
/**
* A detailed status of the plugin execution. StatusDetails includes more information than Status because it includes states resulting from error and concurrency control parameters. StatusDetails can show different results than Status. For more information about these statuses, see Understanding Command Statuses in the AWS Systems Manager User Guide. StatusDetails can be one of the following values: Pending: The command has not been sent to the instance. In Progress: The command has been sent to the instance but has not reached a terminal state. Success: The execution of the command or plugin was successfully completed. This is a terminal state. Delivery Timed Out: The command was not delivered to the instance before the delivery timeout expired. Delivery timeouts do not count against the parent command's MaxErrors limit, but they do contribute to whether the parent command status is Success or Incomplete. This is a terminal state. Execution Timed Out: Command execution started on the instance, but the execution was not complete before the execution timeout expired. Execution timeouts count against the MaxErrors limit of the parent command. This is a terminal state. Failed: The command was not successful on the instance. For a plugin, this indicates that the result code was not zero. For a command invocation, this indicates that the result code for one or more plugins was not zero. Invocation failures count against the MaxErrors limit of the parent command. This is a terminal state. Canceled: The command was terminated before it was completed. This is a terminal state. Undeliverable: The command can't be delivered to the instance. The instance might not exist, or it might not be responding. Undeliverable invocations don't count against the parent command's MaxErrors limit, and they don't contribute to whether the parent command status is Success or Incomplete. This is a terminal state. Terminated: The parent command exceeded its MaxErrors limit and subsequent command invocations were canceled by the system. This is a terminal state.
*/
StatusDetails?: StatusDetails;
/**
* A numeric response code generated after running the plugin.
*/
ResponseCode?: ResponseCode;
/**
* The time the plugin started running.
*/
ResponseStartDateTime?: DateTime;
/**
* The time the plugin stopped running. Could stop prematurely if, for example, a cancel command was sent.
*/
ResponseFinishDateTime?: DateTime;
/**
* Output of the plugin execution.
*/
Output?: CommandPluginOutput;
/**
* The URL for the complete text written by the plugin to stdout in Amazon S3. If the Amazon S3 bucket for the command was not specified, then this string is empty.
*/
StandardOutputUrl?: Url;
/**
* The URL for the complete text written by the plugin to stderr. If execution is not yet complete, then this string is empty.
*/
StandardErrorUrl?: Url;
/**
* (Deprecated) You can no longer specify this parameter. The system ignores it. Instead, Systems Manager automatically determines the Amazon S3 bucket region.
*/
OutputS3Region?: S3Region;
/**
* The S3 bucket where the responses to the command executions should be stored. This was requested when issuing the command. For example, in the following response: test_folder/ab19cb99-a030-46dd-9dfc-8eSAMPLEPre-Fix/i-1234567876543/awsrunShellScript test_folder is the name of the Amazon S3 bucket; ab19cb99-a030-46dd-9dfc-8eSAMPLEPre-Fix is the name of the S3 prefix; i-1234567876543 is the instance ID; awsrunShellScript is the name of the plugin.
*/
OutputS3BucketName?: S3BucketName;
/**
* The S3 directory path inside the bucket where the responses to the command executions should be stored. This was requested when issuing the command. For example, in the following response: test_folder/ab19cb99-a030-46dd-9dfc-8eSAMPLEPre-Fix/i-1234567876543/awsrunShellScript test_folder is the name of the Amazon S3 bucket; ab19cb99-a030-46dd-9dfc-8eSAMPLEPre-Fix is the name of the S3 prefix; i-1234567876543 is the instance ID; awsrunShellScript is the name of the plugin.
*/
OutputS3KeyPrefix?: S3KeyPrefix;
}
export type CommandPluginList = CommandPlugin[];
export type CommandPluginName = string;
export type CommandPluginOutput = string;
export type CommandPluginStatus = "Pending"|"InProgress"|"Success"|"TimedOut"|"Cancelled"|"Failed"|string;
export type CommandStatus = "Pending"|"InProgress"|"Success"|"Cancelled"|"Failed"|"TimedOut"|"Cancelling"|string;
export type Comment = string;
export type CompletedCount = number;
export type ComplianceExecutionId = string;
export interface ComplianceExecutionSummary {
/**
* The time the execution ran as a datetime object that is saved in the following format: yyyy-MM-dd'T'HH:mm:ss'Z'.
*/
ExecutionTime: DateTime;
/**
* An ID created by the system when PutComplianceItems was called. For example, CommandID is a valid execution ID. You can use this ID in subsequent calls.
*/
ExecutionId?: ComplianceExecutionId;
/**
* The type of execution. For example, Command is a valid execution type.
*/
ExecutionType?: ComplianceExecutionType;
}
export type ComplianceExecutionType = string;
export type ComplianceFilterValue = string;
export interface ComplianceItem {
/**
* The compliance type. For example, Association (for a State Manager association), Patch, or Custom:string are all valid compliance types.
*/
ComplianceType?: ComplianceTypeName;
/**
* The type of resource. ManagedInstance is currently the only supported resource type.
*/
ResourceType?: ComplianceResourceType;
/**
* An ID for the resource. For a managed instance, this is the instance ID.
*/
ResourceId?: ComplianceResourceId;
/**
* An ID for the compliance item. For example, if the compliance item is a Windows patch, the ID could be the number of the KB article; for example: KB4010320.
*/
Id?: ComplianceItemId;
/**
* A title for the compliance item. For example, if the compliance item is a Windows patch, the title could be the title of the KB article for the patch; for example: Security Update for Active Directory Federation Services.
*/
Title?: ComplianceItemTitle;
/**
* The status of the compliance item. An item is either COMPLIANT or NON_COMPLIANT.
*/
Status?: ComplianceStatus;
/**
* The severity of the compliance status. Severity can be one of the following: Critical, High, Medium, Low, Informational, Unspecified.
*/
Severity?: ComplianceSeverity;
/**
* A summary for the compliance item. The summary includes an execution ID, the execution type (for example, command), and the execution time.
*/
ExecutionSummary?: ComplianceExecutionSummary;
/**
* A "Key": "Value" tag combination for the compliance item.
*/
Details?: ComplianceItemDetails;
}
export type ComplianceItemContentHash = string;
export type ComplianceItemDetails = {[key: string]: AttributeValue};
export interface ComplianceItemEntry {
/**
* The compliance item ID. For example, if the compliance item is a Windows patch, the ID could be the number of the KB article.
*/
Id?: ComplianceItemId;
/**
* The title of the compliance item. For example, if the compliance item is a Windows patch, the title could be the title of the KB article for the patch; for example: Security Update for Active Directory Federation Services.
*/
Title?: ComplianceItemTitle;
/**
* The severity of the compliance status. Severity can be one of the following: Critical, High, Medium, Low, Informational, Unspecified.
*/
Severity: ComplianceSeverity;
/**
* The status of the compliance item. An item is either COMPLIANT or NON_COMPLIANT.
*/
Status: ComplianceStatus;
/**
* A "Key": "Value" tag combination for the compliance item.
*/
Details?: ComplianceItemDetails;
}
export type ComplianceItemEntryList = ComplianceItemEntry[];
export type ComplianceItemId = string;
export type ComplianceItemList = ComplianceItem[];
export type ComplianceItemTitle = string;
export type ComplianceQueryOperatorType = "EQUAL"|"NOT_EQUAL"|"BEGIN_WITH"|"LESS_THAN"|"GREATER_THAN"|string;
export type ComplianceResourceId = string;
export type ComplianceResourceIdList = ComplianceResourceId[];
export type ComplianceResourceType = string;
export type ComplianceResourceTypeList = ComplianceResourceType[];
export type ComplianceSeverity = "CRITICAL"|"HIGH"|"MEDIUM"|"LOW"|"INFORMATIONAL"|"UNSPECIFIED"|string;
export type ComplianceStatus = "COMPLIANT"|"NON_COMPLIANT"|string;
export interface ComplianceStringFilter {
/**
* The name of the filter.
*/
Key?: ComplianceStringFilterKey;
/**
* The value for which to search.
*/
Values?: ComplianceStringFilterValueList;
/**
* The type of comparison that should be performed for the value: Equal, NotEqual, BeginWith, LessThan, or GreaterThan.
*/
Type?: ComplianceQueryOperatorType;
}
export type ComplianceStringFilterKey = string;
export type ComplianceStringFilterList = ComplianceStringFilter[];
export type ComplianceStringFilterValueList = ComplianceFilterValue[];
export type ComplianceSummaryCount = number;
export interface ComplianceSummaryItem {
/**
* The type of compliance item. For example, the compliance type can be Association, Patch, or Custom:string.
*/
ComplianceType?: ComplianceTypeName;
/**
* A list of COMPLIANT items for the specified compliance type.
*/
CompliantSummary?: CompliantSummary;
/**
* A list of NON_COMPLIANT items for the specified compliance type.
*/
NonCompliantSummary?: NonCompliantSummary;
}
export type ComplianceSummaryItemList = ComplianceSummaryItem[];
export type ComplianceTypeName = string;
export interface CompliantSummary {
/**
* The total number of resources that are compliant.
*/
CompliantCount?: ComplianceSummaryCount;
/**
* A summary of the compliance severity by compliance type.
*/
SeveritySummary?: SeveritySummary;
}
export type ComputerName = string;
export type ConnectionStatus = "Connected"|"NotConnected"|string;
export type ContentLength = number;
export interface CreateActivationRequest {
/**
* A user-defined description of the resource that you want to register with Amazon EC2. Do not enter personally identifiable information in this field.
*/
Description?: ActivationDescription;
/**
* The name of the registered, managed instance as it will appear in the Amazon EC2 console or when you use the AWS command line tools to list EC2 resources. Do not enter personally identifiable information in this field.
*/
DefaultInstanceName?: DefaultInstanceName;
/**
* The Amazon Identity and Access Management (IAM) role that you want to assign to the managed instance.
*/
IamRole: IamRole;
/**
* Specify the maximum number of managed instances you want to register. The default value is 1 instance.
*/
RegistrationLimit?: RegistrationLimit;
/**
* The date by which this activation request should expire. The default value is 24 hours.
*/
ExpirationDate?: ExpirationDate;
/**
* Optional metadata that you assign to a resource. Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For example, you might want to tag an activation to identify which servers or virtual machines (VMs) in your on-premises environment you intend to activate. In this case, you could specify the following key name/value pairs: Key=OS,Value=Windows Key=Environment,Value=Production When you install SSM Agent on your on-premises servers and VMs, you specify an activation ID and code. When you specify the activation ID and code, tags assigned to the activation are automatically applied to the on-premises servers or VMs. You can't add tags to or delete tags from an existing activation. You can tag your on-premises servers and VMs after they connect to Systems Manager for the first time and are assigned a managed instance ID. This means they are listed in the AWS Systems Manager console with an ID that is prefixed with "mi-". For information about how to add tags to your managed instances, see AddTagsToResource. For information about how to remove tags from your managed instances, see RemoveTagsFromResource.
*/
Tags?: TagList;
}
export interface CreateActivationResult {
/**
* The ID number generated by the system when it processed the activation. The activation ID functions like a user name.
*/
ActivationId?: ActivationId;
/**
* The code the system generates when it processes the activation. The activation code functions like a password to validate the activation ID.
*/
ActivationCode?: ActivationCode;
}
export interface CreateAssociationBatchRequest {
/**
* One or more associations.
*/
Entries: CreateAssociationBatchRequestEntries;
}
export type CreateAssociationBatchRequestEntries = CreateAssociationBatchRequestEntry[];
export interface CreateAssociationBatchRequestEntry {
/**
* The name of the SSM document that contains the configuration information for the instance. You can specify Command or Automation documents. You can specify AWS-predefined documents, documents you created, or a document that is shared with you from another account. For SSM documents that are shared with you from other AWS accounts, you must specify the complete SSM document ARN, in the following format: arn:aws:ssm:region:account-id:document/document-name For example: arn:aws:ssm:us-east-2:12345678912:document/My-Shared-Document For AWS-predefined documents and SSM documents you created in your account, you only need to specify the document name. For example, AWS-ApplyPatchBaseline or My-Document.
*/
Name: DocumentARN;
/**
* The ID of the instance.
*/
InstanceId?: InstanceId;
/**
* A description of the parameters for a document.
*/
Parameters?: Parameters;
/**
* Specify the target for the association. This target is required for associations that use an Automation document and target resources by using rate controls.
*/
AutomationTargetParameterName?: AutomationTargetParameterName;
/**
* The document version.
*/
DocumentVersion?: DocumentVersion;
/**
* The instances targeted by the request.
*/
Targets?: Targets;
/**
* A cron expression that specifies a schedule when the association runs.
*/
ScheduleExpression?: ScheduleExpression;
/**
* An Amazon S3 bucket where you want to store the results of this request.
*/
OutputLocation?: InstanceAssociationOutputLocation;
/**
* Specify a descriptive name for the association.
*/
AssociationName?: AssociationName;
/**
* The number of errors that are allowed before the system stops sending requests to run the association on additional targets. You can specify either an absolute number of errors, for example 10, or a percentage of the target set, for example 10%. If you specify 3, for example, the system stops sending requests when the fourth error is received. If you specify 0, then the system stops sending requests after the first error is returned. If you run an association on 50 instances and set MaxError to 10%, then the system stops sending the request when the sixth error is received. Executions that are already running an association when MaxErrors is reached are allowed to complete, but some of these executions may fail as well. If you need to ensure that there won't be more than max-errors failed executions, set MaxConcurrency to 1 so that executions proceed one at a time.
*/
MaxErrors?: MaxErrors;
/**
* The maximum number of targets allowed to run the association at the same time. You can specify a number, for example 10, or a percentage of the target set, for example 10%. The default value is 100%, which means all targets run the association at the same time. If a new instance starts and attempts to run an association while Systems Manager is running MaxConcurrency associations, the association is allowed to run. During the next association interval, the new instance will process its association within the limit specified for MaxConcurrency.
*/
MaxConcurrency?: MaxConcurrency;
/**
* The severity level to assign to the association.
*/
ComplianceSeverity?: AssociationComplianceSeverity;
}
export interface CreateAssociationBatchResult {
/**
* Information about the associations that succeeded.
*/
Successful?: AssociationDescriptionList;
/**
* Information about the associations that failed.
*/
Failed?: FailedCreateAssociationList;
}
export interface CreateAssociationRequest {
/**
* The name of the SSM document that contains the configuration information for the instance. You can specify Command or Automation documents. You can specify AWS-predefined documents, documents you created, or a document that is shared with you from another account. For SSM documents that are shared with you from other AWS accounts, you must specify the complete SSM document ARN, in the following format: arn:partition:ssm:region:account-id:document/document-name For example: arn:aws:ssm:us-east-2:12345678912:document/My-Shared-Document For AWS-predefined documents and SSM documents you created in your account, you only need to specify the document name. For example, AWS-ApplyPatchBaseline or My-Document.
*/
Name: DocumentARN;
/**
* The document version you want to associate with the target(s). Can be a specific version or the default version.
*/
DocumentVersion?: DocumentVersion;
/**
* The instance ID. InstanceId has been deprecated. To specify an instance ID for an association, use the Targets parameter. If you use the parameter InstanceId, you cannot use the parameters AssociationName, DocumentVersion, MaxErrors, MaxConcurrency, OutputLocation, or ScheduleExpression. To use these parameters, you must use the Targets parameter.
*/
InstanceId?: InstanceId;
/**
* The parameters for the runtime configuration of the document.
*/
Parameters?: Parameters;
/**
* The targets (either instances or tags) for the association. You must specify a value for Targets if you don't specify a value for InstanceId.
*/
Targets?: Targets;
/**
* A cron expression when the association will be applied to the target(s).
*/
ScheduleExpression?: ScheduleExpression;
/**
* An Amazon S3 bucket where you want to store the output details of the request.
*/
OutputLocation?: InstanceAssociationOutputLocation;
/**
* Specify a descriptive name for the association.
*/
AssociationName?: AssociationName;
/**
* Specify the target for the association. This target is required for associations that use an Automation document and target resources by using rate controls.
*/
AutomationTargetParameterName?: AutomationTargetParameterName;
/**
* The number of errors that are allowed before the system stops sending requests to run the association on additional targets. You can specify either an absolute number of errors, for example 10, or a percentage of the target set, for example 10%. If you specify 3, for example, the system stops sending requests when the fourth error is received. If you specify 0, then the system stops sending requests after the first error is returned. If you run an association on 50 instances and set MaxError to 10%, then the system stops sending the request when the sixth error is received. Executions that are already running an association when MaxErrors is reached are allowed to complete, but some of these executions may fail as well. If you need to ensure that there won't be more than max-errors failed executions, set MaxConcurrency to 1 so that executions proceed one at a time.
*/
MaxErrors?: MaxErrors;
/**
* The maximum number of targets allowed to run the association at the same time. You can specify a number, for example 10, or a percentage of the target set, for example 10%. The default value is 100%, which means all targets run the association at the same time. If a new instance starts and attempts to run an association while Systems Manager is running MaxConcurrency associations, the association is allowed to run. During the next association interval, the new instance will process its association within the limit specified for MaxConcurrency.
*/
MaxConcurrency?: MaxConcurrency;
/**
* The severity level to assign to the association.
*/
ComplianceSeverity?: AssociationComplianceSeverity;
}
export interface CreateAssociationResult {
/**
* Information about the association.
*/
AssociationDescription?: AssociationDescription;
}
export interface CreateDocumentRequest {
/**
* A valid JSON or YAML string.
*/
Content: DocumentContent;
/**
* A list of SSM documents required by a document. For example, an ApplicationConfiguration document requires an ApplicationConfigurationSchema document.
*/
Requires?: DocumentRequiresList;
/**
* A list of key and value pairs that describe attachments to a version of a document.
*/
Attachments?: AttachmentsSourceList;
/**
* A name for the Systems Manager document. Do not use the following to begin the names of documents you create. They are reserved by AWS for use as document prefixes: aws amazon amzn
*/
Name: DocumentName;
/**
* An optional field specifying the version of the artifact you are creating with the document. For example, "Release 12, Update 6". This value is unique across all versions of a document, and cannot be changed.
*/
VersionName?: DocumentVersionName;
/**
* The type of document to create. Valid document types include: Command, Policy, Automation, Session, and Package.
*/
DocumentType?: DocumentType;
/**
* Specify the document format for the request. The document format can be either JSON or YAML. JSON is the default format.
*/
DocumentFormat?: DocumentFormat;
/**
* Specify a target type to define the kinds of resources the document can run on. For example, to run a document on EC2 instances, specify the following value: /AWS::EC2::Instance. If you specify a value of '/' the document can run on all types of resources. If you don't specify a value, the document can't run on any resources. For a list of valid resource types, see AWS Resource Types Reference in the AWS CloudFormation User Guide.
*/
TargetType?: TargetType;
/**
* Optional metadata that you assign to a resource. Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For example, you might want to tag an SSM document to identify the types of targets or the environment where it will run. In this case, you could specify the following key name/value pairs: Key=OS,Value=Windows Key=Environment,Value=Production To add tags to an existing SSM document, use the AddTagsToResource action.
*/
Tags?: TagList;
}
export interface CreateDocumentResult {
/**
* Information about the Systems Manager document.
*/
DocumentDescription?: DocumentDescription;
}
export interface CreateMaintenanceWindowRequest {
/**
* The name of the maintenance window.
*/
Name: MaintenanceWindowName;
/**
* An optional description for the maintenance window. We recommend specifying a description to help you organize your maintenance windows.
*/
Description?: MaintenanceWindowDescription;
/**
* The date and time, in ISO-8601 Extended format, for when you want the maintenance window to become active. StartDate allows you to delay activation of the maintenance window until the specified future date.
*/
StartDate?: MaintenanceWindowStringDateTime;
/**
* The date and time, in ISO-8601 Extended format, for when you want the maintenance window to become inactive. EndDate allows you to set a date and time in the future when the maintenance window will no longer run.
*/
EndDate?: MaintenanceWindowStringDateTime;
/**
* The schedule of the maintenance window in the form of a cron or rate expression.
*/
Schedule: MaintenanceWindowSchedule;
/**
* The time zone that the scheduled maintenance window executions are based on, in Internet Assigned Numbers Authority (IANA) format. For example: "America/Los_Angeles", "etc/UTC", or "Asia/Seoul". For more information, see the Time Zone Database on the IANA website.
*/
ScheduleTimezone?: MaintenanceWindowTimezone;
/**
* The duration of the maintenance window in hours.
*/
Duration: MaintenanceWindowDurationHours;
/**
* The number of hours before the end of the maintenance window that Systems Manager stops scheduling new tasks for execution.
*/
Cutoff: MaintenanceWindowCutoff;
/**
* Enables a maintenance window task to run on managed instances, even if you have not registered those instances as targets. If enabled, then you must specify the unregistered instances (by instance ID) when you register a task with the maintenance window. If you don't enable this option, then you must specify previously-registered targets when you register a task with the maintenance window.
*/
AllowUnassociatedTargets: MaintenanceWindowAllowUnassociatedTargets;
/**
* User-provided idempotency token.
*/
ClientToken?: ClientToken;
/**
* Optional metadata that you assign to a resource. Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For example, you might want to tag a maintenance window to identify the type of tasks it will run, the types of targets, and the environment it will run in. In this case, you could specify the following key name/value pairs: Key=TaskType,Value=AgentUpdate Key=OS,Value=Windows Key=Environment,Value=Production To add tags to an existing maintenance window, use the AddTagsToResource action.
*/
Tags?: TagList;
}
export interface CreateMaintenanceWindowResult {
/**
* The ID of the created maintenance window.
*/
WindowId?: MaintenanceWindowId;
}
export interface CreateOpsItemRequest {
/**
* Information about the OpsItem.
*/
Description: OpsItemDescription;
/**
* Operational data is custom data that provides useful reference details about the OpsItem. For example, you can specify log files, error strings, license keys, troubleshooting tips, or other relevant data. You enter operational data as key-value pairs. The key has a maximum length of 128 characters. The value has a maximum size of 20 KB. Operational data keys can't begin with the following: amazon, aws, amzn, ssm, /amazon, /aws, /amzn, /ssm. You can choose to make the data searchable by other users in the account or you can restrict search access. Searchable data means that all users with access to the OpsItem Overview page (as provided by the DescribeOpsItems API action) can view and search on the specified data. Operational data that is not searchable is only viewable by users who have access to the OpsItem (as provided by the GetOpsItem API action). Use the /aws/resources key in OperationalData to specify a related resource in the request. Use the /aws/automations key in OperationalData to associate an Automation runbook with the OpsItem. To view AWS CLI example commands that use these keys, see Creating OpsItems Manually in the AWS Systems Manager User Guide.
*/
OperationalData?: OpsItemOperationalData;
/**
* The Amazon Resource Name (ARN) of an SNS topic where notifications are sent when this OpsItem is edited or changed.
*/
Notifications?: OpsItemNotifications;
/**
* The importance of this OpsItem in relation to other OpsItems in the system.
*/
Priority?: OpsItemPriority;
/**
* One or more OpsItems that share something in common with the current OpsItems. For example, related OpsItems can include OpsItems with similar error messages, impacted resources, or statuses for the impacted resource.
*/
RelatedOpsItems?: RelatedOpsItems;
/**
* The origin of the OpsItem, such as Amazon EC2 or AWS Systems Manager.
*/
Source: OpsItemSource;
/**
* A short heading that describes the nature of the OpsItem and the impacted resource.
*/
Title: OpsItemTitle;
/**
* Optional metadata that you assign to a resource. You can restrict access to OpsItems by using an inline IAM policy that specifies tags. For more information, see Getting Started with OpsCenter in the AWS Systems Manager User Guide. Tags use a key-value pair. For example: Key=Department,Value=Finance To add tags to an existing OpsItem, use the AddTagsToResource action.
*/
Tags?: TagList;
/**
* Specify a category to assign to an OpsItem.
*/
Category?: OpsItemCategory;
/**
* Specify a severity to assign to an OpsItem.
*/
Severity?: OpsItemSeverity;
}
export interface CreateOpsItemResponse {
/**
* The ID of the OpsItem.
*/
OpsItemId?: String;
}
export interface CreatePatchBaselineRequest {
/**
* Defines the operating system the patch baseline applies to. The Default value is WINDOWS.
*/
OperatingSystem?: OperatingSystem;
/**
* The name of the patch baseline.
*/
Name: BaselineName;
/**
* A set of global filters used to include patches in the baseline.
*/
GlobalFilters?: PatchFilterGroup;
/**
* A set of rules used to include patches in the baseline.
*/
ApprovalRules?: PatchRuleGroup;
/**
* A list of explicitly approved patches for the baseline. For information about accepted formats for lists of approved patches and rejected patches, see Package Name Formats for Approved and Rejected Patch Lists in the AWS Systems Manager User Guide.
*/
ApprovedPatches?: PatchIdList;
/**
* Defines the compliance level for approved patches. This means that if an approved patch is reported as missing, this is the severity of the compliance violation. The default value is UNSPECIFIED.
*/
ApprovedPatchesComplianceLevel?: PatchComplianceLevel;
/**
* Indicates whether the list of approved patches includes non-security updates that should be applied to the instances. The default value is 'false'. Applies to Linux instances only.
*/
ApprovedPatchesEnableNonSecurity?: Boolean;
/**
* A list of explicitly rejected patches for the baseline. For information about accepted formats for lists of approved patches and rejected patches, see Package Name Formats for Approved and Rejected Patch Lists in the AWS Systems Manager User Guide.
*/
RejectedPatches?: PatchIdList;
/**
* The action for Patch Manager to take on patches included in the RejectedPackages list. ALLOW_AS_DEPENDENCY: A package in the Rejected patches list is installed only if it is a dependency of another package. It is considered compliant with the patch baseline, and its status is reported as InstalledOther. This is the default action if no option is specified. BLOCK: Packages in the RejectedPatches list, and packages that include them as dependencies, are not installed under any circumstances. If a package was installed before it was added to the Rejected patches list, it is considered non-compliant with the patch baseline, and its status is reported as InstalledRejected.
*/
RejectedPatchesAction?: PatchAction;
/**
* A description of the patch baseline.
*/
Description?: BaselineDescription;
/**
* Information about the patches to use to update the instances, including target operating systems and source repositories. Applies to Linux instances only.
*/
Sources?: PatchSourceList;
/**
* User-provided idempotency token.
*/
ClientToken?: ClientToken;
/**
* Optional metadata that you assign to a resource. Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For example, you might want to tag a patch baseline to identify the severity level of patches it specifies and the operating system family it applies to. In this case, you could specify the following key name/value pairs: Key=PatchSeverity,Value=Critical Key=OS,Value=Windows To add tags to an existing patch baseline, use the AddTagsToResource action.
*/
Tags?: TagList;
}
export interface CreatePatchBaselineResult {
/**
* The ID of the created patch baseline.
*/
BaselineId?: BaselineId;
}
export interface CreateResourceDataSyncRequest {
/**
* A name for the configuration.
*/
SyncName: ResourceDataSyncName;
/**
* Amazon S3 configuration details for the sync.
*/
S3Destination?: ResourceDataSyncS3Destination;
/**
* Specify SyncToDestination to create a resource data sync that synchronizes data from multiple AWS Regions to an Amazon S3 bucket. Specify SyncFromSource to synchronize data from multiple AWS accounts and Regions, as listed in AWS Organizations.
*/
SyncType?: ResourceDataSyncType;
/**
* Specify information about the data sources to synchronize.
*/
SyncSource?: ResourceDataSyncSource;
}
export interface CreateResourceDataSyncResult {
}
export type CreatedDate = Date;
export type DateTime = Date;
export type DefaultBaseline = boolean;
export type DefaultInstanceName = string;
export interface DeleteActivationRequest {
/**
* The ID of the activation that you want to delete.
*/
ActivationId: ActivationId;
}
export interface DeleteActivationResult {
}
export interface DeleteAssociationRequest {
/**
* The name of the Systems Manager document.
*/
Name?: DocumentARN;
/**
* The ID of the instance.
*/
InstanceId?: InstanceId;
/**
* The association ID that you want to delete.
*/
AssociationId?: AssociationId;
}
export interface DeleteAssociationResult {
}
export interface DeleteDocumentRequest {
/**
* The name of the document.
*/
Name: DocumentName;
/**
* The version of the document that you want to delete. If not provided, all versions of the document are deleted.
*/
DocumentVersion?: DocumentVersion;
/**
* The version name of the document that you want to delete. If not provided, all versions of the document are deleted.
*/
VersionName?: DocumentVersionName;
/**
* Some SSM document types require that you specify a Force flag before you can delete the document. For example, you must specify a Force flag to delete a document of type ApplicationConfigurationSchema. You can restrict access to the Force flag in an AWS Identity and Access Management (IAM) policy.
*/
Force?: Boolean;
}
export interface DeleteDocumentResult {
}
export interface DeleteInventoryRequest {
/**
* The name of the custom inventory type for which you want to delete either all previously collected data, or the inventory type itself.
*/
TypeName: InventoryItemTypeName;
/**
* Use the SchemaDeleteOption to delete a custom inventory type (schema). If you don't choose this option, the system only deletes existing inventory data associated with the custom inventory type. Choose one of the following options: DisableSchema: If you choose this option, the system ignores all inventory data for the specified version, and any earlier versions. To enable this schema again, you must call the PutInventory action for a version greater than the disabled version. DeleteSchema: This option deletes the specified custom type from the Inventory service. You can recreate the schema later, if you want.
*/
SchemaDeleteOption?: InventorySchemaDeleteOption;
/**
* Use this option to view a summary of the deletion request without deleting any data or the data type. This option is useful when you only want to understand what will be deleted. Once you validate that the data to be deleted is what you intend to delete, you can run the same command without specifying the DryRun option.
*/
DryRun?: DryRun;
/**
* User-provided idempotency token.
*/
ClientToken?: ClientToken;
}
export interface DeleteInventoryResult {
/**
* Every DeleteInventory action is assigned a unique ID. This option returns a unique ID. You can use this ID to query the status of a delete operation. This option is useful for ensuring that a delete operation has completed before you begin other actions.
*/
DeletionId?: InventoryDeletionId;
/**
* The name of the inventory data type specified in the request.
*/
TypeName?: InventoryItemTypeName;
/**
* A summary of the delete operation. For more information about this summary, see Understanding the Delete Inventory Summary in the AWS Systems Manager User Guide.
*/
DeletionSummary?: InventoryDeletionSummary;
}
export interface DeleteMaintenanceWindowRequest {
/**
* The ID of the maintenance window to delete.
*/
WindowId: MaintenanceWindowId;
}
export interface DeleteMaintenanceWindowResult {
/**
* The ID of the deleted maintenance window.
*/
WindowId?: MaintenanceWindowId;
}
export interface DeleteParameterRequest {
/**
* The name of the parameter to delete.
*/
Name: PSParameterName;
}
export interface DeleteParameterResult {
}
export interface DeleteParametersRequest {
/**
* The names of the parameters to delete.
*/
Names: ParameterNameList;
}
export interface DeleteParametersResult {
/**
* The names of the deleted parameters.
*/
DeletedParameters?: ParameterNameList;
/**
* The names of parameters that weren't deleted because the parameters are not valid.
*/
InvalidParameters?: ParameterNameList;
}
export interface DeletePatchBaselineRequest {
/**
* The ID of the patch baseline to delete.
*/
BaselineId: BaselineId;
}
export interface DeletePatchBaselineResult {
/**
* The ID of the deleted patch baseline.
*/
BaselineId?: BaselineId;
}
export interface DeleteResourceDataSyncRequest {
/**
* The name of the configuration to delete.
*/
SyncName: ResourceDataSyncName;
/**
* Specify the type of resource data sync to delete.
*/
SyncType?: ResourceDataSyncType;
}
export interface DeleteResourceDataSyncResult {
}
export type DeliveryTimedOutCount = number;
export interface DeregisterManagedInstanceRequest {
/**
* The ID assigned to the managed instance when you registered it using the activation process.
*/
InstanceId: ManagedInstanceId;
}
export interface DeregisterManagedInstanceResult {
}
export interface DeregisterPatchBaselineForPatchGroupRequest {
/**
* The ID of the patch baseline to deregister the patch group from.
*/
BaselineId: BaselineId;
/**
* The name of the patch group that should be deregistered from the patch baseline.
*/
PatchGroup: PatchGroup;
}
export interface DeregisterPatchBaselineForPatchGroupResult {
/**
* The ID of the patch baseline the patch group was deregistered from.
*/
BaselineId?: BaselineId;
/**
* The name of the patch group deregistered from the patch baseline.
*/
PatchGroup?: PatchGroup;
}
export interface DeregisterTargetFromMaintenanceWindowRequest {
/**
* The ID of the maintenance window the target should be removed from.
*/
WindowId: MaintenanceWindowId;
/**
* The ID of the target definition to remove.
*/
WindowTargetId: MaintenanceWindowTargetId;
/**
* The system checks if the target is being referenced by a task. If the target is being referenced, the system returns an error and does not deregister the target from the maintenance window.
*/
Safe?: Boolean;
}
export interface DeregisterTargetFromMaintenanceWindowResult {
/**
* The ID of the maintenance window the target was removed from.
*/
WindowId?: MaintenanceWindowId;
/**
* The ID of the removed target definition.
*/
WindowTargetId?: MaintenanceWindowTargetId;
}
export interface DeregisterTaskFromMaintenanceWindowRequest {
/**
* The ID of the maintenance window the task should be removed from.
*/
WindowId: MaintenanceWindowId;
/**
* The ID of the task to remove from the maintenance window.
*/
WindowTaskId: MaintenanceWindowTaskId;
}
export interface DeregisterTaskFromMaintenanceWindowResult {
/**
* The ID of the maintenance window the task was removed from.
*/
WindowId?: MaintenanceWindowId;
/**
* The ID of the task removed from the maintenance window.
*/
WindowTaskId?: MaintenanceWindowTaskId;
}
export interface DescribeActivationsFilter {
/**
* The name of the filter.
*/
FilterKey?: DescribeActivationsFilterKeys;
/**
* The filter values.
*/
FilterValues?: StringList;
}
export type DescribeActivationsFilterKeys = "ActivationIds"|"DefaultInstanceName"|"IamRole"|string;
export type DescribeActivationsFilterList = DescribeActivationsFilter[];
export interface DescribeActivationsRequest {
/**
* A filter to view information about your activations.
*/
Filters?: DescribeActivationsFilterList;
/**
* The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.
*/
MaxResults?: MaxResults;
/**
* A token to start the list. Use this token to get the next set of results.
*/
NextToken?: NextToken;
}
export interface DescribeActivationsResult {
/**
* A list of activations for your AWS account.
*/
ActivationList?: ActivationList;
/**
* The token for the next set of items to return. Use this token to get the next set of results.
*/
NextToken?: NextToken;
}
export interface DescribeAssociationExecutionTargetsRequest {
/**
* The association ID that includes the execution for which you want to view details.
*/
AssociationId: AssociationId;
/**
* The execution ID for which you want to view details.
*/
ExecutionId: AssociationExecutionId;
/**
* Filters for the request. You can specify the following filters and values. Status (EQUAL) ResourceId (EQUAL) ResourceType (EQUAL)
*/
Filters?: AssociationExecutionTargetsFilterList;
/**
* The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.
*/
MaxResults?: MaxResults;
/**
* A token to start the list. Use this token to get the next set of results.
*/
NextToken?: NextToken;
}
export interface DescribeAssociationExecutionTargetsResult {
/**
* Information about the execution.
*/
AssociationExecutionTargets?: AssociationExecutionTargetsList;
/**
* The token for the next set of items to return. Use this token to get the next set of results.
*/
NextToken?: NextToken;
}
export interface DescribeAssociationExecutionsRequest {
/**
* The association ID for which you want to view execution history details.
*/
AssociationId: AssociationId;
/**
* Filters for the request. You can specify the following filters and values. ExecutionId (EQUAL) Status (EQUAL) CreatedTime (EQUAL, GREATER_THAN, LESS_THAN)
*/
Filters?: AssociationExecutionFilterList;
/**
* The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.
*/
MaxResults?: MaxResults;
/**
* A token to start the list. Use this token to get the next set of results.
*/
NextToken?: NextToken;
}
export interface DescribeAssociationExecutionsResult {
/**
* A list of the executions for the specified association ID.
*/
AssociationExecutions?: AssociationExecutionsList;
/**
* The token for the next set of items to return. Use this token to get the next set of results.
*/
NextToken?: NextToken;
}
export interface DescribeAssociationRequest {
/**
* The name of the Systems Manager document.
*/
Name?: DocumentARN;
/**
* The instance ID.
*/
InstanceId?: InstanceId;
/**
* The association ID for which you want information.
*/
AssociationId?: AssociationId;
/**
* Specify the association version to retrieve. To view the latest version, either specify $LATEST for this parameter, or omit this parameter. To view a list of all associations for an instance, use ListAssociations. To get a list of versions for a specific association, use ListAssociationVersions.
*/
AssociationVersion?: AssociationVersion;
}
export interface DescribeAssociationResult {
/**
* Information about the association.
*/
AssociationDescription?: AssociationDescription;
}
export interface DescribeAutomationExecutionsRequest {
/**
* Filters used to limit the scope of executions that are requested.
*/
Filters?: AutomationExecutionFilterList;
/**
* The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.
*/
MaxResults?: MaxResults;
/**
* The token for the next set of items to return. (You received this token from a previous call.)
*/
NextToken?: NextToken;
}
export interface DescribeAutomationExecutionsResult {
/**
* The list of details about each automation execution which has occurred which matches the filter specification, if any.
*/
AutomationExecutionMetadataList?: AutomationExecutionMetadataList;
/**
* The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.
*/
NextToken?: NextToken;
}
export interface DescribeAutomationStepExecutionsRequest {
/**
* The Automation execution ID for which you want step execution descriptions.
*/
AutomationExecutionId: AutomationExecutionId;
/**
* One or more filters to limit the number of step executions returned by the request.
*/
Filters?: StepExecutionFilterList;
/**
* The token for the next set of items to return. (You received this token from a previous call.)
*/
NextToken?: NextToken;
/**
* The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.
*/
MaxResults?: MaxResults;
/**
* A boolean that indicates whether to list step executions in reverse order by start time. The default value is false.
*/
ReverseOrder?: Boolean;
}
export interface DescribeAutomationStepExecutionsResult {
/**
* A list of details about the current state of all steps that make up an execution.
*/
StepExecutions?: StepExecutionList;
/**
* The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.
*/
NextToken?: NextToken;
}
export interface DescribeAvailablePatchesRequest {
/**
* Filters used to scope down the returned patches.
*/
Filters?: PatchOrchestratorFilterList;
/**
* The maximum number of patches to return (per page).
*/
MaxResults?: PatchBaselineMaxResults;
/**
* The token for the next set of items to return. (You received this token from a previous call.)
*/
NextToken?: NextToken;
}
export interface DescribeAvailablePatchesResult {
/**
* An array of patches. Each entry in the array is a patch structure.
*/
Patches?: PatchList;
/**
* The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.
*/
NextToken?: NextToken;
}
export interface DescribeDocumentPermissionRequest {
/**
* The name of the document for which you are the owner.
*/
Name: DocumentName;
/**
* The permission type for the document. The permission type can be Share.
*/
PermissionType: DocumentPermissionType;
}
export interface DescribeDocumentPermissionResponse {
/**
* The account IDs that have permission to use this document. The ID can be either an AWS account or All.
*/
AccountIds?: AccountIdList;
/**
* A list of of AWS accounts where the current document is shared and the version shared with each account.
*/
AccountSharingInfoList?: AccountSharingInfoList;
}
export interface DescribeDocumentRequest {
/**
* The name of the Systems Manager document.
*/
Name: DocumentARN;
/**
* The document version for which you want information. Can be a specific version or the default version.
*/
DocumentVersion?: DocumentVersion;
/**
* An optional field specifying the version of the artifact associated with the document. For example, "Release 12, Update 6". This value is unique across all versions of a document, and cannot be changed.
*/
VersionName?: DocumentVersionName;
}
export interface DescribeDocumentResult {
/**
* Information about the Systems Manager document.
*/
Document?: DocumentDescription;
}
export interface DescribeEffectiveInstanceAssociationsRequest {
/**
* The instance ID for which you want to view all associations.
*/
InstanceId: InstanceId;
/**
* The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.
*/
MaxResults?: EffectiveInstanceAssociationMaxResults;
/**
* The token for the next set of items to return. (You received this token from a previous call.)
*/
NextToken?: NextToken;
}
export interface DescribeEffectiveInstanceAssociationsResult {
/**
* The associations for the requested instance.
*/
Associations?: InstanceAssociationList;
/**
* The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.
*/
NextToken?: NextToken;
}
export interface DescribeEffectivePatchesForPatchBaselineRequest {
/**
* The ID of the patch baseline to retrieve the effective patches for.
*/
BaselineId: BaselineId;
/**
* The maximum number of patches to return (per page).
*/
MaxResults?: PatchBaselineMaxResults;
/**
* The token for the next set of items to return. (You received this token from a previous call.)
*/
NextToken?: NextToken;
}
export interface DescribeEffectivePatchesForPatchBaselineResult {
/**
* An array of patches and patch status.
*/
EffectivePatches?: EffectivePatchList;
/**
* The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.
*/
NextToken?: NextToken;
}
export interface DescribeInstanceAssociationsStatusRequest {
/**
* The instance IDs for which you want association status information.
*/
InstanceId: InstanceId;
/**
* The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.
*/
MaxResults?: MaxResults;
/**
* The token for the next set of items to return. (You received this token from a previous call.)
*/
NextToken?: NextToken;
}
export interface DescribeInstanceAssociationsStatusResult {
/**
* Status information about the association.
*/
InstanceAssociationStatusInfos?: InstanceAssociationStatusInfos;
/**
* The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.
*/
NextToken?: NextToken;
}
export interface DescribeInstanceInformationRequest {
/**
* This is a legacy method. We recommend that you don't use this method. Instead, use the InstanceInformationFilter action. The InstanceInformationFilter action enables you to return instance information by using tags that are specified as a key-value mapping. If you do use this method, then you can't use the InstanceInformationFilter action. Using this method and the InstanceInformationFilter action causes an exception error.
*/
InstanceInformationFilterList?: InstanceInformationFilterList;
/**
* One or more filters. Use a filter to return a more specific list of instances. You can filter on Amazon EC2 tag. Specify tags by using a key-value mapping.
*/
Filters?: InstanceInformationStringFilterList;
/**
* The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.
*/
MaxResults?: MaxResultsEC2Compatible;
/**
* The token for the next set of items to return. (You received this token from a previous call.)
*/
NextToken?: NextToken;
}
export interface DescribeInstanceInformationResult {
/**
* The instance information list.
*/
InstanceInformationList?: InstanceInformationList;
/**
* The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.
*/
NextToken?: NextToken;
}
export interface DescribeInstancePatchStatesForPatchGroupRequest {
/**
* The name of the patch group for which the patch state information should be retrieved.
*/
PatchGroup: PatchGroup;
/**
* Each entry in the array is a structure containing: Key (string between 1 and 200 characters) Values (array containing a single string) Type (string "Equal", "NotEqual", "LessThan", "GreaterThan")
*/
Filters?: InstancePatchStateFilterList;
/**
* The token for the next set of items to return. (You received this token from a previous call.)
*/
NextToken?: NextToken;
/**
* The maximum number of patches to return (per page).
*/
MaxResults?: PatchComplianceMaxResults;
}
export interface DescribeInstancePatchStatesForPatchGroupResult {
/**
* The high-level patch state for the requested instances.
*/
InstancePatchStates?: InstancePatchStatesList;
/**
* The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.
*/
NextToken?: NextToken;
}
export interface DescribeInstancePatchStatesRequest {
/**
* The ID of the instance whose patch state information should be retrieved.
*/
InstanceIds: InstanceIdList;
/**
* The token for the next set of items to return. (You received this token from a previous call.)
*/
NextToken?: NextToken;
/**
* The maximum number of instances to return (per page).
*/
MaxResults?: PatchComplianceMaxResults;
}
export interface DescribeInstancePatchStatesResult {
/**
* The high-level patch state for the requested instances.
*/
InstancePatchStates?: InstancePatchStateList;
/**
* The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.
*/
NextToken?: NextToken;
}
export interface DescribeInstancePatchesRequest {
/**
* The ID of the instance whose patch state information should be retrieved.
*/
InstanceId: InstanceId;
/**
* An array of structures. Each entry in the array is a structure containing a Key, Value combination. Valid values for Key are Classification | KBId | Severity | State.
*/
Filters?: PatchOrchestratorFilterList;
/**
* The token for the next set of items to return. (You received this token from a previous call.)
*/
NextToken?: NextToken;
/**
* The maximum number of patches to return (per page).
*/
MaxResults?: PatchComplianceMaxResults;
}
export interface DescribeInstancePatchesResult {
/**
* Each entry in the array is a structure containing: Title (string) KBId (string) Classification (string) Severity (string) State (string, such as "INSTALLED" or "FAILED") InstalledTime (DateTime) InstalledBy (string)
*/
Patches?: PatchComplianceDataList;
/**
* The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.
*/
NextToken?: NextToken;
}
export interface DescribeInventoryDeletionsRequest {
/**
* Specify the delete inventory ID for which you want information. This ID was returned by the DeleteInventory action.
*/
DeletionId?: InventoryDeletionId;
/**
* A token to start the list. Use this token to get the next set of results.
*/
NextToken?: NextToken;
/**
* The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.
*/
MaxResults?: MaxResults;
}
export interface DescribeInventoryDeletionsResult {
/**
* A list of status items for deleted inventory.
*/
InventoryDeletions?: InventoryDeletionsList;
/**
* The token for the next set of items to return. Use this token to get the next set of results.
*/
NextToken?: NextToken;
}
export interface DescribeMaintenanceWindowExecutionTaskInvocationsRequest {
/**
* The ID of the maintenance window execution the task is part of.
*/
WindowExecutionId: MaintenanceWindowExecutionId;
/**
* The ID of the specific task in the maintenance window task that should be retrieved.
*/
TaskId: MaintenanceWindowExecutionTaskId;
/**
* Optional filters used to scope down the returned task invocations. The supported filter key is STATUS with the corresponding values PENDING, IN_PROGRESS, SUCCESS, FAILED, TIMED_OUT, CANCELLING, and CANCELLED.
*/
Filters?: MaintenanceWindowFilterList;
/**
* The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.
*/
MaxResults?: MaintenanceWindowMaxResults;
/**
* The token for the next set of items to return. (You received this token from a previous call.)
*/
NextToken?: NextToken;
}
export interface DescribeMaintenanceWindowExecutionTaskInvocationsResult {
/**
* Information about the task invocation results per invocation.
*/
WindowExecutionTaskInvocationIdentities?: MaintenanceWindowExecutionTaskInvocationIdentityList;
/**
* The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.
*/
NextToken?: NextToken;
}
export interface DescribeMaintenanceWindowExecutionTasksRequest {
/**
* The ID of the maintenance window execution whose task executions should be retrieved.
*/
WindowExecutionId: MaintenanceWindowExecutionId;
/**
* Optional filters used to scope down the returned tasks. The supported filter key is STATUS with the corresponding values PENDING, IN_PROGRESS, SUCCESS, FAILED, TIMED_OUT, CANCELLING, and CANCELLED.
*/
Filters?: MaintenanceWindowFilterList;
/**
* The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.
*/
MaxResults?: MaintenanceWindowMaxResults;
/**
* The token for the next set of items to return. (You received this token from a previous call.)
*/
NextToken?: NextToken;
}
export interface DescribeMaintenanceWindowExecutionTasksResult {
/**
* Information about the task executions.
*/
WindowExecutionTaskIdentities?: MaintenanceWindowExecutionTaskIdentityList;
/**
* The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.
*/
NextToken?: NextToken;
}
export interface DescribeMaintenanceWindowExecutionsRequest {
/**
* The ID of the maintenance window whose executions should be retrieved.
*/
WindowId: MaintenanceWindowId;
/**
* Each entry in the array is a structure containing: Key (string, between 1 and 128 characters) Values (array of strings, each string is between 1 and 256 characters) The supported Keys are ExecutedBefore and ExecutedAfter with the value being a date/time string such as 2016-11-04T05:00:00Z.
*/
Filters?: MaintenanceWindowFilterList;
/**
* The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.
*/
MaxResults?: MaintenanceWindowMaxResults;
/**
* The token for the next set of items to return. (You received this token from a previous call.)
*/
NextToken?: NextToken;
}
export interface DescribeMaintenanceWindowExecutionsResult {
/**
* Information about the maintenance window executions.
*/
WindowExecutions?: MaintenanceWindowExecutionList;
/**
* The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.
*/
NextToken?: NextToken;
}
export interface DescribeMaintenanceWindowScheduleRequest {
/**
* The ID of the maintenance window to retrieve information about.
*/
WindowId?: MaintenanceWindowId;
/**
* The instance ID or key/value pair to retrieve information about.
*/
Targets?: Targets;
/**
* The type of resource you want to retrieve information about. For example, "INSTANCE".
*/
ResourceType?: MaintenanceWindowResourceType;
/**
* Filters used to limit the range of results. For example, you can limit maintenance window executions to only those scheduled before or after a certain date and time.
*/
Filters?: PatchOrchestratorFilterList;
/**
* The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.
*/
MaxResults?: MaintenanceWindowSearchMaxResults;
/**
* The token for the next set of items to return. (You received this token from a previous call.)
*/
NextToken?: NextToken;
}
export interface DescribeMaintenanceWindowScheduleResult {
/**
* Information about maintenance window executions scheduled for the specified time range.
*/
ScheduledWindowExecutions?: ScheduledWindowExecutionList;
/**
* The token for the next set of items to return. (You use this token in the next call.)
*/
NextToken?: NextToken;
}
export interface DescribeMaintenanceWindowTargetsRequest {
/**
* The ID of the maintenance window whose targets should be retrieved.
*/
WindowId: MaintenanceWindowId;
/**
* Optional filters that can be used to narrow down the scope of the returned window targets. The supported filter keys are Type, WindowTargetId and OwnerInformation.
*/
Filters?: MaintenanceWindowFilterList;
/**
* The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.
*/
MaxResults?: MaintenanceWindowMaxResults;
/**
* The token for the next set of items to return. (You received this token from a previous call.)
*/
NextToken?: NextToken;
}
export interface DescribeMaintenanceWindowTargetsResult {
/**
* Information about the targets in the maintenance window.
*/
Targets?: MaintenanceWindowTargetList;
/**
* The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.
*/
NextToken?: NextToken;
}
export interface DescribeMaintenanceWindowTasksRequest {
/**
* The ID of the maintenance window whose tasks should be retrieved.
*/
WindowId: MaintenanceWindowId;
/**
* Optional filters used to narrow down the scope of the returned tasks. The supported filter keys are WindowTaskId, TaskArn, Priority, and TaskType.
*/
Filters?: MaintenanceWindowFilterList;
/**
* The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.
*/
MaxResults?: MaintenanceWindowMaxResults;
/**
* The token for the next set of items to return. (You received this token from a previous call.)
*/
NextToken?: NextToken;
}
export interface DescribeMaintenanceWindowTasksResult {
/**
* Information about the tasks in the maintenance window.
*/
Tasks?: MaintenanceWindowTaskList;
/**
* The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.
*/
NextToken?: NextToken;
}
export interface DescribeMaintenanceWindowsForTargetRequest {
/**
* The instance ID or key/value pair to retrieve information about.
*/
Targets: Targets;
/**
* The type of resource you want to retrieve information about. For example, "INSTANCE".
*/
ResourceType: MaintenanceWindowResourceType;
/**
* The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.
*/
MaxResults?: MaintenanceWindowSearchMaxResults;
/**
* The token for the next set of items to return. (You received this token from a previous call.)
*/
NextToken?: NextToken;
}
export interface DescribeMaintenanceWindowsForTargetResult {
/**
* Information about the maintenance window targets and tasks an instance is associated with.
*/
WindowIdentities?: MaintenanceWindowsForTargetList;
/**
* The token for the next set of items to return. (You use this token in the next call.)
*/
NextToken?: NextToken;
}
export interface DescribeMaintenanceWindowsRequest {
/**
* Optional filters used to narrow down the scope of the returned maintenance windows. Supported filter keys are Name and Enabled.
*/
Filters?: MaintenanceWindowFilterList;
/**
* The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.
*/
MaxResults?: MaintenanceWindowMaxResults;
/**
* The token for the next set of items to return. (You received this token from a previous call.)
*/
NextToken?: NextToken;
}
export interface DescribeMaintenanceWindowsResult {
/**
* Information about the maintenance windows.
*/
WindowIdentities?: MaintenanceWindowIdentityList;
/**
* The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.
*/
NextToken?: NextToken;
}
export interface DescribeOpsItemsRequest {
/**
* One or more filters to limit the reponse. Key: CreatedTime Operations: GreaterThan, LessThan Key: LastModifiedBy Operations: Contains, Equals Key: LastModifiedTime Operations: GreaterThan, LessThan Key: Priority Operations: Equals Key: Source Operations: Contains, Equals Key: Status Operations: Equals Key: Title Operations: Contains Key: OperationalData* Operations: Equals Key: OperationalDataKey Operations: Equals Key: OperationalDataValue Operations: Equals, Contains Key: OpsItemId Operations: Equals Key: ResourceId Operations: Contains Key: AutomationId Operations: Equals *If you filter the response by using the OperationalData operator, specify a key-value pair by using the following JSON format: {"key":"key_name","value":"a_value"}
*/
OpsItemFilters?: OpsItemFilters;
/**
* The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.
*/
MaxResults?: OpsItemMaxResults;
/**
* A token to start the list. Use this token to get the next set of results.
*/
NextToken?: String;
}
export interface DescribeOpsItemsResponse {
/**
* The token for the next set of items to return. Use this token to get the next set of results.
*/
NextToken?: String;
/**
* A list of OpsItems.
*/
OpsItemSummaries?: OpsItemSummaries;
}
export interface DescribeParametersRequest {
/**
* This data type is deprecated. Instead, use ParameterFilters.
*/
Filters?: ParametersFilterList;
/**
* Filters to limit the request results.
*/
ParameterFilters?: ParameterStringFilterList;
/**
* The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.
*/
MaxResults?: MaxResults;
/**
* The token for the next set of items to return. (You received this token from a previous call.)
*/
NextToken?: NextToken;
}
export interface DescribeParametersResult {
/**
* Parameters returned by the request.
*/
Parameters?: ParameterMetadataList;
/**
* The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.
*/
NextToken?: NextToken;
}
export interface DescribePatchBaselinesRequest {
/**
* Each element in the array is a structure containing: Key: (string, "NAME_PREFIX" or "OWNER") Value: (array of strings, exactly 1 entry, between 1 and 255 characters)
*/
Filters?: PatchOrchestratorFilterList;
/**
* The maximum number of patch baselines to return (per page).
*/
MaxResults?: PatchBaselineMaxResults;
/**
* The token for the next set of items to return. (You received this token from a previous call.)
*/
NextToken?: NextToken;
}
export interface DescribePatchBaselinesResult {
/**
* An array of PatchBaselineIdentity elements.
*/
BaselineIdentities?: PatchBaselineIdentityList;
/**
* The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.
*/
NextToken?: NextToken;
}
export interface DescribePatchGroupStateRequest {
/**
* The name of the patch group whose patch snapshot should be retrieved.
*/
PatchGroup: PatchGroup;
}
export interface DescribePatchGroupStateResult {
/**
* The number of instances in the patch group.
*/
Instances?: Integer;
/**
* The number of instances with installed patches.
*/
InstancesWithInstalledPatches?: Integer;
/**
* The number of instances with patches installed that aren't defined in the patch baseline.
*/
InstancesWithInstalledOtherPatches?: Integer;
/**
* Reserved for future use.
*/
InstancesWithInstalledPendingRebootPatches?: InstancesCount;
/**
* The number of instances with patches installed that are specified in a RejectedPatches list. Patches with a status of INSTALLED_REJECTED were typically installed before they were added to a RejectedPatches list. If ALLOW_AS_DEPENDENCY is the specified option for RejectedPatchesAction, the value of InstancesWithInstalledRejectedPatches will always be 0 (zero).
*/
InstancesWithInstalledRejectedPatches?: InstancesCount;
/**
* The number of instances with missing patches from the patch baseline.
*/
InstancesWithMissingPatches?: Integer;
/**
* The number of instances with patches from the patch baseline that failed to install.
*/
InstancesWithFailedPatches?: Integer;
/**
* The number of instances with patches that aren't applicable.
*/
InstancesWithNotApplicablePatches?: Integer;
/**
* The number of instances with NotApplicable patches beyond the supported limit, which are not reported by name to Systems Manager Inventory.
*/
InstancesWithUnreportedNotApplicablePatches?: Integer;
}
export interface DescribePatchGroupsRequest {
/**
* The maximum number of patch groups to return (per page).
*/
MaxResults?: PatchBaselineMaxResults;
/**
* One or more filters. Use a filter to return a more specific list of results.
*/
Filters?: PatchOrchestratorFilterList;
/**
* The token for the next set of items to return. (You received this token from a previous call.)
*/
NextToken?: NextToken;
}
export interface DescribePatchGroupsResult {
/**
* Each entry in the array contains: PatchGroup: string (between 1 and 256 characters, Regex: ^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$) PatchBaselineIdentity: A PatchBaselineIdentity element.
*/
Mappings?: PatchGroupPatchBaselineMappingList;
/**
* The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.
*/
NextToken?: NextToken;
}
export interface DescribePatchPropertiesRequest {
/**
* The operating system type for which to list patches.
*/
OperatingSystem: OperatingSystem;
/**
* The patch property for which you want to view patch details.
*/
Property: PatchProperty;
/**
* Indicates whether to list patches for the Windows operating system or for Microsoft applications. Not applicable for Linux operating systems.
*/
PatchSet?: PatchSet;
/**
* The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.
*/
MaxResults?: MaxResults;
/**
* The token for the next set of items to return. (You received this token from a previous call.)
*/
NextToken?: NextToken;
}
export interface DescribePatchPropertiesResult {
/**
* A list of the properties for patches matching the filter request parameters.
*/
Properties?: PatchPropertiesList;
/**
* The token for the next set of items to return. (You use this token in the next call.)
*/
NextToken?: NextToken;
}
export interface DescribeSessionsRequest {
/**
* The session status to retrieve a list of sessions for. For example, "Active".
*/
State: SessionState;
/**
* The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.
*/
MaxResults?: SessionMaxResults;
/**
* The token for the next set of items to return. (You received this token from a previous call.)
*/
NextToken?: NextToken;
/**
* One or more filters to limit the type of sessions returned by the request.
*/
Filters?: SessionFilterList;
}
export interface DescribeSessionsResponse {
/**
* A list of sessions meeting the request parameters.
*/
Sessions?: SessionList;
/**
* The token for the next set of items to return. (You received this token from a previous call.)
*/
NextToken?: NextToken;
}
export type DescriptionInDocument = string;
export type DocumentARN = string;
export type DocumentContent = string;
export interface DocumentDefaultVersionDescription {
/**
* The name of the document.
*/
Name?: DocumentName;
/**
* The default version of the document.
*/
DefaultVersion?: DocumentVersion;
/**
* The default version of the artifact associated with the document.
*/
DefaultVersionName?: DocumentVersionName;
}
export interface DocumentDescription {
/**
* The SHA1 hash of the document, which you can use for verification.
*/
Sha1?: DocumentSha1;
/**
* The Sha256 or Sha1 hash created by the system when the document was created. Sha1 hashes have been deprecated.
*/
Hash?: DocumentHash;
/**
* The hash type of the document. Valid values include Sha256 or Sha1. Sha1 hashes have been deprecated.
*/
HashType?: DocumentHashType;
/**
* The name of the Systems Manager document.
*/
Name?: DocumentARN;
/**
* The version of the artifact associated with the document.
*/
VersionName?: DocumentVersionName;
/**
* The AWS user account that created the document.
*/
Owner?: DocumentOwner;
/**
* The date when the document was created.
*/
CreatedDate?: DateTime;
/**
* The status of the Systems Manager document.
*/
Status?: DocumentStatus;
/**
* A message returned by AWS Systems Manager that explains the Status value. For example, a Failed status might be explained by the StatusInformation message, "The specified S3 bucket does not exist. Verify that the URL of the S3 bucket is correct."
*/
StatusInformation?: DocumentStatusInformation;
/**
* The document version.
*/
DocumentVersion?: DocumentVersion;
/**
* A description of the document.
*/
Description?: DescriptionInDocument;
/**
* A description of the parameters for a document.
*/
Parameters?: DocumentParameterList;
/**
* The list of OS platforms compatible with this Systems Manager document.
*/
PlatformTypes?: PlatformTypeList;
/**
* The type of document.
*/
DocumentType?: DocumentType;
/**
* The schema version.
*/
SchemaVersion?: DocumentSchemaVersion;
/**
* The latest version of the document.
*/
LatestVersion?: DocumentVersion;
/**
* The default version.
*/
DefaultVersion?: DocumentVersion;
/**
* The document format, either JSON or YAML.
*/
DocumentFormat?: DocumentFormat;
/**
* The target type which defines the kinds of resources the document can run on. For example, /AWS::EC2::Instance. For a list of valid resource types, see AWS Resource Types Reference in the AWS CloudFormation User Guide.
*/
TargetType?: TargetType;
/**
* The tags, or metadata, that have been applied to the document.
*/
Tags?: TagList;
/**
* Details about the document attachments, including names, locations, sizes, etc.
*/
AttachmentsInformation?: AttachmentInformationList;
/**
* A list of SSM documents required by a document. For example, an ApplicationConfiguration document requires an ApplicationConfigurationSchema document.
*/
Requires?: DocumentRequiresList;
}
export interface DocumentFilter {
/**
* The name of the filter.
*/
key: DocumentFilterKey;
/**
* The value of the filter.
*/
value: DocumentFilterValue;
}
export type DocumentFilterKey = "Name"|"Owner"|"PlatformTypes"|"DocumentType"|string;
export type DocumentFilterList = DocumentFilter[];
export type DocumentFilterValue = string;
export type DocumentFormat = "YAML"|"JSON"|"TEXT"|string;
export type DocumentHash = string;
export type DocumentHashType = "Sha256"|"Sha1"|string;
export interface DocumentIdentifier {
/**
* The name of the Systems Manager document.
*/
Name?: DocumentARN;
/**
* The AWS user account that created the document.
*/
Owner?: DocumentOwner;
/**
* An optional field specifying the version of the artifact associated with the document. For example, "Release 12, Update 6". This value is unique across all versions of a document, and cannot be changed.
*/
VersionName?: DocumentVersionName;
/**
* The operating system platform.
*/
PlatformTypes?: PlatformTypeList;
/**
* The document version.
*/
DocumentVersion?: DocumentVersion;
/**
* The document type.
*/
DocumentType?: DocumentType;
/**
* The schema version.
*/
SchemaVersion?: DocumentSchemaVersion;
/**
* The document format, either JSON or YAML.
*/
DocumentFormat?: DocumentFormat;
/**
* The target type which defines the kinds of resources the document can run on. For example, /AWS::EC2::Instance. For a list of valid resource types, see AWS Resource Types Reference in the AWS CloudFormation User Guide.
*/
TargetType?: TargetType;
/**
* The tags, or metadata, that have been applied to the document.
*/
Tags?: TagList;
/**
* A list of SSM documents required by a document. For example, an ApplicationConfiguration document requires an ApplicationConfigurationSchema document.
*/
Requires?: DocumentRequiresList;
}
export type DocumentIdentifierList = DocumentIdentifier[];
export interface DocumentKeyValuesFilter {
/**
* The name of the filter key.
*/
Key?: DocumentKeyValuesFilterKey;
/**
* The value for the filter key.
*/
Values?: DocumentKeyValuesFilterValues;
}
export type DocumentKeyValuesFilterKey = string;
export type DocumentKeyValuesFilterList = DocumentKeyValuesFilter[];
export type DocumentKeyValuesFilterValue = string;
export type DocumentKeyValuesFilterValues = DocumentKeyValuesFilterValue[];
export type DocumentName = string;
export type DocumentOwner = string;
export interface DocumentParameter {
/**
* The name of the parameter.
*/
Name?: DocumentParameterName;
/**
* The type of parameter. The type can be either String or StringList.
*/
Type?: DocumentParameterType;
/**
* A description of what the parameter does, how to use it, the default value, and whether or not the parameter is optional.
*/
Description?: DocumentParameterDescrption;
/**
* If specified, the default values for the parameters. Parameters without a default value are required. Parameters with a default value are optional.
*/
DefaultValue?: DocumentParameterDefaultValue;
}
export type DocumentParameterDefaultValue = string;
export type DocumentParameterDescrption = string;
export type DocumentParameterList = DocumentParameter[];
export type DocumentParameterName = string;
export type DocumentParameterType = "String"|"StringList"|string;
export type DocumentPermissionType = "Share"|string;
export interface DocumentRequires {
/**
* The name of the required SSM document. The name can be an Amazon Resource Name (ARN).
*/
Name: DocumentARN;
/**
* The document version required by the current document.
*/
Version?: DocumentVersion;
}
export type DocumentRequiresList = DocumentRequires[];
export type DocumentSchemaVersion = string;
export type DocumentSha1 = string;
export type DocumentStatus = "Creating"|"Active"|"Updating"|"Deleting"|"Failed"|string;
export type DocumentStatusInformation = string;
export type DocumentType = "Command"|"Policy"|"Automation"|"Session"|"Package"|"ApplicationConfiguration"|"ApplicationConfigurationSchema"|"DeploymentStrategy"|"ChangeCalendar"|string;
export type DocumentVersion = string;
export interface DocumentVersionInfo {
/**
* The document name.
*/
Name?: DocumentName;
/**
* The document version.
*/
DocumentVersion?: DocumentVersion;
/**
* The version of the artifact associated with the document. For example, "Release 12, Update 6". This value is unique across all versions of a document, and cannot be changed.
*/
VersionName?: DocumentVersionName;
/**
* The date the document was created.
*/
CreatedDate?: DateTime;
/**
* An identifier for the default version of the document.
*/
IsDefaultVersion?: Boolean;
/**
* The document format, either JSON or YAML.
*/
DocumentFormat?: DocumentFormat;
/**
* The status of the Systems Manager document, such as Creating, Active, Failed, and Deleting.
*/
Status?: DocumentStatus;
/**
* A message returned by AWS Systems Manager that explains the Status value. For example, a Failed status might be explained by the StatusInformation message, "The specified S3 bucket does not exist. Verify that the URL of the S3 bucket is correct."
*/
StatusInformation?: DocumentStatusInformation;
}
export type DocumentVersionList = DocumentVersionInfo[];
export type DocumentVersionName = string;
export type DocumentVersionNumber = string;
export type DryRun = boolean;
export type EffectiveInstanceAssociationMaxResults = number;
export interface EffectivePatch {
/**
* Provides metadata for a patch, including information such as the KB ID, severity, classification and a URL for where more information can be obtained about the patch.
*/
Patch?: Patch;
/**
* The status of the patch in a patch baseline. This includes information about whether the patch is currently approved, due to be approved by a rule, explicitly approved, or explicitly rejected and the date the patch was or will be approved.
*/
PatchStatus?: PatchStatus;
}
export type EffectivePatchList = EffectivePatch[];
export type ErrorCount = number;
export type ExecutionMode = "Auto"|"Interactive"|string;
export type ExecutionRoleName = string;
export type ExpirationDate = Date;
export interface FailedCreateAssociation {
/**
* The association.
*/
Entry?: CreateAssociationBatchRequestEntry;
/**
* A description of the failure.
*/
Message?: BatchErrorMessage;
/**
* The source of the failure.
*/
Fault?: Fault;
}
export type FailedCreateAssociationList = FailedCreateAssociation[];
export interface FailureDetails {
/**
* The stage of the Automation execution when the failure occurred. The stages include the following: InputValidation, PreVerification, Invocation, PostVerification.
*/
FailureStage?: String;
/**
* The type of Automation failure. Failure types include the following: Action, Permission, Throttling, Verification, Internal.
*/
FailureType?: String;
/**
* Detailed information about the Automation step failure.
*/
Details?: AutomationParameterMap;
}
export type Fault = "Client"|"Server"|"Unknown"|string;
export interface GetAutomationExecutionRequest {
/**
* The unique identifier for an existing automation execution to examine. The execution ID is returned by StartAutomationExecution when the execution of an Automation document is initiated.
*/
AutomationExecutionId: AutomationExecutionId;
}
export interface GetAutomationExecutionResult {
/**
* Detailed information about the current state of an automation execution.
*/
AutomationExecution?: AutomationExecution;
}
export interface GetCalendarStateRequest {
/**
* The names or Amazon Resource Names (ARNs) of the Systems Manager documents that represent the calendar entries for which you want to get the state.
*/
CalendarNames: CalendarNameOrARNList;
/**
* (Optional) The specific time for which you want to get calendar state information, in ISO 8601 format. If you do not add AtTime, the current time is assumed.
*/
AtTime?: ISO8601String;
}
export interface GetCalendarStateResponse {
/**
* The state of the calendar. An OPEN calendar indicates that actions are allowed to proceed, and a CLOSED calendar indicates that actions are not allowed to proceed.
*/
State?: CalendarState;
/**
* The time, as an ISO 8601 string, that you specified in your command. If you did not specify a time, GetCalendarState uses the current time.
*/
AtTime?: ISO8601String;
/**
* The time, as an ISO 8601 string, that the calendar state will change. If the current calendar state is OPEN, NextTransitionTime indicates when the calendar state changes to CLOSED, and vice-versa.
*/
NextTransitionTime?: ISO8601String;
}
export interface GetCommandInvocationRequest {
/**
* (Required) The parent command ID of the invocation plugin.
*/
CommandId: CommandId;
/**
* (Required) The ID of the managed instance targeted by the command. A managed instance can be an Amazon EC2 instance or an instance in your hybrid environment that is configured for Systems Manager.
*/
InstanceId: InstanceId;
/**
* (Optional) The name of the plugin for which you want detailed results. If the document contains only one plugin, the name can be omitted and the details will be returned.
*/
PluginName?: CommandPluginName;
}
export interface GetCommandInvocationResult {
/**
* The parent command ID of the invocation plugin.
*/
CommandId?: CommandId;
/**
* The ID of the managed instance targeted by the command. A managed instance can be an Amazon EC2 instance or an instance in your hybrid environment that is configured for Systems Manager.
*/
InstanceId?: InstanceId;
/**
* The comment text for the command.
*/
Comment?: Comment;
/**
* The name of the document that was run. For example, AWS-RunShellScript.
*/
DocumentName?: DocumentName;
/**
* The SSM document version used in the request.
*/
DocumentVersion?: DocumentVersion;
/**
* The name of the plugin for which you want detailed results. For example, aws:RunShellScript is a plugin.
*/
PluginName?: CommandPluginName;
/**
* The error level response code for the plugin script. If the response code is -1, then the command has not started running on the instance, or it was not received by the instance.
*/
ResponseCode?: ResponseCode;
/**
* The date and time the plugin started running. Date and time are written in ISO 8601 format. For example, June 7, 2017 is represented as 2017-06-7. The following sample AWS CLI command uses the InvokedBefore filter. aws ssm list-commands --filters key=InvokedBefore,value=2017-06-07T00:00:00Z If the plugin has not started to run, the string is empty.
*/
ExecutionStartDateTime?: StringDateTime;
/**
* Duration since ExecutionStartDateTime.
*/
ExecutionElapsedTime?: StringDateTime;
/**
* The date and time the plugin was finished running. Date and time are written in ISO 8601 format. For example, June 7, 2017 is represented as 2017-06-7. The following sample AWS CLI command uses the InvokedAfter filter. aws ssm list-commands --filters key=InvokedAfter,value=2017-06-07T00:00:00Z If the plugin has not started to run, the string is empty.
*/
ExecutionEndDateTime?: StringDateTime;
/**
* The status of this invocation plugin. This status can be different than StatusDetails.
*/
Status?: CommandInvocationStatus;
/**
* A detailed status of the command execution for an invocation. StatusDetails includes more information than Status because it includes states resulting from error and concurrency control parameters. StatusDetails can show different results than Status. For more information about these statuses, see Understanding Command Statuses in the AWS Systems Manager User Guide. StatusDetails can be one of the following values: Pending: The command has not been sent to the instance. In Progress: The command has been sent to the instance but has not reached a terminal state. Delayed: The system attempted to send the command to the target, but the target was not available. The instance might not be available because of network issues, the instance was stopped, etc. The system will try to deliver the command again. Success: The command or plugin was run successfully. This is a terminal state. Delivery Timed Out: The command was not delivered to the instance before the delivery timeout expired. Delivery timeouts do not count against the parent command's MaxErrors limit, but they do contribute to whether the parent command status is Success or Incomplete. This is a terminal state. Execution Timed Out: The command started to run on the instance, but the execution was not complete before the timeout expired. Execution timeouts count against the MaxErrors limit of the parent command. This is a terminal state. Failed: The command wasn't run successfully on the instance. For a plugin, this indicates that the result code was not zero. For a command invocation, this indicates that the result code for one or more plugins was not zero. Invocation failures count against the MaxErrors limit of the parent command. This is a terminal state. Canceled: The command was terminated before it was completed. This is a terminal state. Undeliverable: The command can't be delivered to the instance. The instance might not exist or might not be responding. Undeliverable invocations don't count against the parent command's MaxErrors limit and don't contribute to whether the parent command status is Success or Incomplete. This is a terminal state. Terminated: The parent command exceeded its MaxErrors limit and subsequent command invocations were canceled by the system. This is a terminal state.
*/
StatusDetails?: StatusDetails;
/**
* The first 24,000 characters written by the plugin to stdout. If the command has not finished running, if ExecutionStatus is neither Succeeded nor Failed, then this string is empty.
*/
StandardOutputContent?: StandardOutputContent;
/**
* The URL for the complete text written by the plugin to stdout in Amazon S3. If an Amazon S3 bucket was not specified, then this string is empty.
*/
StandardOutputUrl?: Url;
/**
* The first 8,000 characters written by the plugin to stderr. If the command has not finished running, then this string is empty.
*/
StandardErrorContent?: StandardErrorContent;
/**
* The URL for the complete text written by the plugin to stderr. If the command has not finished running, then this string is empty.
*/
StandardErrorUrl?: Url;
/**
* CloudWatch Logs information where Systems Manager sent the command output.
*/
CloudWatchOutputConfig?: CloudWatchOutputConfig;
}
export interface GetConnectionStatusRequest {
/**
* The ID of the instance.
*/
Target: SessionTarget;
}
export interface GetConnectionStatusResponse {
/**
* The ID of the instance to check connection status.
*/
Target?: SessionTarget;
/**
* The status of the connection to the instance. For example, 'Connected' or 'Not Connected'.
*/
Status?: ConnectionStatus;
}
export interface GetDefaultPatchBaselineRequest {
/**
* Returns the default patch baseline for the specified operating system.
*/
OperatingSystem?: OperatingSystem;
}
export interface GetDefaultPatchBaselineResult {
/**
* The ID of the default patch baseline.
*/
BaselineId?: BaselineId;
/**
* The operating system for the returned patch baseline.
*/
OperatingSystem?: OperatingSystem;
}
export interface GetDeployablePatchSnapshotForInstanceRequest {
/**
* The ID of the instance for which the appropriate patch snapshot should be retrieved.
*/
InstanceId: InstanceId;
/**
* The user-defined snapshot ID.
*/
SnapshotId: SnapshotId;
}
export interface GetDeployablePatchSnapshotForInstanceResult {
/**
* The ID of the instance.
*/
InstanceId?: InstanceId;
/**
* The user-defined snapshot ID.
*/
SnapshotId?: SnapshotId;
/**
* A pre-signed Amazon S3 URL that can be used to download the patch snapshot.
*/
SnapshotDownloadUrl?: SnapshotDownloadUrl;
/**
* Returns the specific operating system (for example Windows Server 2012 or Amazon Linux 2015.09) on the instance for the specified patch snapshot.
*/
Product?: Product;
}
export interface GetDocumentRequest {
/**
* The name of the Systems Manager document.
*/
Name: DocumentARN;
/**
* An optional field specifying the version of the artifact associated with the document. For example, "Release 12, Update 6". This value is unique across all versions of a document, and cannot be changed.
*/
VersionName?: DocumentVersionName;
/**
* The document version for which you want information.
*/
DocumentVersion?: DocumentVersion;
/**
* Returns the document in the specified format. The document format can be either JSON or YAML. JSON is the default format.
*/
DocumentFormat?: DocumentFormat;
}
export interface GetDocumentResult {
/**
* The name of the Systems Manager document.
*/
Name?: DocumentARN;
/**
* The version of the artifact associated with the document. For example, "Release 12, Update 6". This value is unique across all versions of a document, and cannot be changed.
*/
VersionName?: DocumentVersionName;
/**
* The document version.
*/
DocumentVersion?: DocumentVersion;
/**
* The status of the Systems Manager document, such as Creating, Active, Updating, Failed, and Deleting.
*/
Status?: DocumentStatus;
/**
* A message returned by AWS Systems Manager that explains the Status value. For example, a Failed status might be explained by the StatusInformation message, "The specified S3 bucket does not exist. Verify that the URL of the S3 bucket is correct."
*/
StatusInformation?: DocumentStatusInformation;
/**
* The contents of the Systems Manager document.
*/
Content?: DocumentContent;
/**
* The document type.
*/
DocumentType?: DocumentType;
/**
* The document format, either JSON or YAML.
*/
DocumentFormat?: DocumentFormat;
/**
* A list of SSM documents required by a document. For example, an ApplicationConfiguration document requires an ApplicationConfigurationSchema document.
*/
Requires?: DocumentRequiresList;
/**
* A description of the document attachments, including names, locations, sizes, etc.
*/
AttachmentsContent?: AttachmentContentList;
}
export interface GetInventoryRequest {
/**
* One or more filters. Use a filter to return a more specific list of results.
*/
Filters?: InventoryFilterList;
/**
* Returns counts of inventory types based on one or more expressions. For example, if you aggregate by using an expression that uses the AWS:InstanceInformation.PlatformType type, you can see a count of how many Windows and Linux instances exist in your inventoried fleet.
*/
Aggregators?: InventoryAggregatorList;
/**
* The list of inventory item types to return.
*/
ResultAttributes?: ResultAttributeList;
/**
* The token for the next set of items to return. (You received this token from a previous call.)
*/
NextToken?: NextToken;
/**
* The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.
*/
MaxResults?: MaxResults;
}
export interface GetInventoryResult {
/**
* Collection of inventory entities such as a collection of instance inventory.
*/
Entities?: InventoryResultEntityList;
/**
* The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.
*/
NextToken?: NextToken;
}
export type GetInventorySchemaMaxResults = number;
export interface GetInventorySchemaRequest {
/**
* The type of inventory item to return.
*/
TypeName?: InventoryItemTypeNameFilter;
/**
* The token for the next set of items to return. (You received this token from a previous call.)
*/
NextToken?: NextToken;
/**
* The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.
*/
MaxResults?: GetInventorySchemaMaxResults;
/**
* Returns inventory schemas that support aggregation. For example, this call returns the AWS:InstanceInformation type, because it supports aggregation based on the PlatformName, PlatformType, and PlatformVersion attributes.
*/
Aggregator?: AggregatorSchemaOnly;
/**
* Returns the sub-type schema for a specified inventory type.
*/
SubType?: IsSubTypeSchema;
}
export interface GetInventorySchemaResult {
/**
* Inventory schemas returned by the request.
*/
Schemas?: InventoryItemSchemaResultList;
/**
* The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.
*/
NextToken?: NextToken;
}
export interface GetMaintenanceWindowExecutionRequest {
/**
* The ID of the maintenance window execution that includes the task.
*/
WindowExecutionId: MaintenanceWindowExecutionId;
}
export interface GetMaintenanceWindowExecutionResult {
/**
* The ID of the maintenance window execution.
*/
WindowExecutionId?: MaintenanceWindowExecutionId;
/**
* The ID of the task executions from the maintenance window execution.
*/
TaskIds?: MaintenanceWindowExecutionTaskIdList;
/**
* The status of the maintenance window execution.
*/
Status?: MaintenanceWindowExecutionStatus;
/**
* The details explaining the Status. Only available for certain status values.
*/
StatusDetails?: MaintenanceWindowExecutionStatusDetails;
/**
* The time the maintenance window started running.
*/
StartTime?: DateTime;
/**
* The time the maintenance window finished running.
*/
EndTime?: DateTime;
}
export interface GetMaintenanceWindowExecutionTaskInvocationRequest {
/**
* The ID of the maintenance window execution for which the task is a part.
*/
WindowExecutionId: MaintenanceWindowExecutionId;
/**
* The ID of the specific task in the maintenance window task that should be retrieved.
*/
TaskId: MaintenanceWindowExecutionTaskId;
/**
* The invocation ID to retrieve.
*/
InvocationId: MaintenanceWindowExecutionTaskInvocationId;
}
export interface GetMaintenanceWindowExecutionTaskInvocationResult {
/**
* The maintenance window execution ID.
*/
WindowExecutionId?: MaintenanceWindowExecutionId;
/**
* The task execution ID.
*/
TaskExecutionId?: MaintenanceWindowExecutionTaskId;
/**
* The invocation ID.
*/
InvocationId?: MaintenanceWindowExecutionTaskInvocationId;
/**
* The execution ID.
*/
ExecutionId?: MaintenanceWindowExecutionTaskExecutionId;
/**
* Retrieves the task type for a maintenance window. Task types include the following: LAMBDA, STEP_FUNCTIONS, AUTOMATION, RUN_COMMAND.
*/
TaskType?: MaintenanceWindowTaskType;
/**
* The parameters used at the time that the task ran.
*/
Parameters?: MaintenanceWindowExecutionTaskInvocationParameters;
/**
* The task status for an invocation.
*/
Status?: MaintenanceWindowExecutionStatus;
/**
* The details explaining the status. Details are only available for certain status values.
*/
StatusDetails?: MaintenanceWindowExecutionStatusDetails;
/**
* The time that the task started running on the target.
*/
StartTime?: DateTime;
/**
* The time that the task finished running on the target.
*/
EndTime?: DateTime;
/**
* User-provided value to be included in any CloudWatch events raised while running tasks for these targets in this maintenance window.
*/
OwnerInformation?: OwnerInformation;
/**
* The maintenance window target ID.
*/
WindowTargetId?: MaintenanceWindowTaskTargetId;
}
export interface GetMaintenanceWindowExecutionTaskRequest {
/**
* The ID of the maintenance window execution that includes the task.
*/
WindowExecutionId: MaintenanceWindowExecutionId;
/**
* The ID of the specific task execution in the maintenance window task that should be retrieved.
*/
TaskId: MaintenanceWindowExecutionTaskId;
}
export interface GetMaintenanceWindowExecutionTaskResult {
/**
* The ID of the maintenance window execution that includes the task.
*/
WindowExecutionId?: MaintenanceWindowExecutionId;
/**
* The ID of the specific task execution in the maintenance window task that was retrieved.
*/
TaskExecutionId?: MaintenanceWindowExecutionTaskId;
/**
* The ARN of the task that ran.
*/
TaskArn?: MaintenanceWindowTaskArn;
/**
* The role that was assumed when running the task.
*/
ServiceRole?: ServiceRole;
/**
* The type of task that was run.
*/
Type?: MaintenanceWindowTaskType;
/**
* The parameters passed to the task when it was run. TaskParameters has been deprecated. To specify parameters to pass to a task when it runs, instead use the Parameters option in the TaskInvocationParameters structure. For information about how Systems Manager handles these options for the supported maintenance window task types, see MaintenanceWindowTaskInvocationParameters. The map has the following format: Key: string, between 1 and 255 characters Value: an array of strings, each string is between 1 and 255 characters
*/
TaskParameters?: MaintenanceWindowTaskParametersList;
/**
* The priority of the task.
*/
Priority?: MaintenanceWindowTaskPriority;
/**
* The defined maximum number of task executions that could be run in parallel.
*/
MaxConcurrency?: MaxConcurrency;
/**
* The defined maximum number of task execution errors allowed before scheduling of the task execution would have been stopped.
*/
MaxErrors?: MaxErrors;
/**
* The status of the task.
*/
Status?: MaintenanceWindowExecutionStatus;
/**
* The details explaining the Status. Only available for certain status values.
*/
StatusDetails?: MaintenanceWindowExecutionStatusDetails;
/**
* The time the task execution started.
*/
StartTime?: DateTime;
/**
* The time the task execution completed.
*/
EndTime?: DateTime;
}
export interface GetMaintenanceWindowRequest {
/**
* The ID of the maintenance window for which you want to retrieve information.
*/
WindowId: MaintenanceWindowId;
}
export interface GetMaintenanceWindowResult {
/**
* The ID of the created maintenance window.
*/
WindowId?: MaintenanceWindowId;
/**
* The name of the maintenance window.
*/
Name?: MaintenanceWindowName;
/**
* The description of the maintenance window.
*/
Description?: MaintenanceWindowDescription;
/**
* The date and time, in ISO-8601 Extended format, for when the maintenance window is scheduled to become active. The maintenance window will not run before this specified time.
*/
StartDate?: MaintenanceWindowStringDateTime;
/**
* The date and time, in ISO-8601 Extended format, for when the maintenance window is scheduled to become inactive. The maintenance window will not run after this specified time.
*/
EndDate?: MaintenanceWindowStringDateTime;
/**
* The schedule of the maintenance window in the form of a cron or rate expression.
*/
Schedule?: MaintenanceWindowSchedule;
/**
* The time zone that the scheduled maintenance window executions are based on, in Internet Assigned Numbers Authority (IANA) format. For example: "America/Los_Angeles", "etc/UTC", or "Asia/Seoul". For more information, see the Time Zone Database on the IANA website.
*/
ScheduleTimezone?: MaintenanceWindowTimezone;
/**
* The next time the maintenance window will actually run, taking into account any specified times for the maintenance window to become active or inactive.
*/
NextExecutionTime?: MaintenanceWindowStringDateTime;
/**
* The duration of the maintenance window in hours.
*/
Duration?: MaintenanceWindowDurationHours;
/**
* The number of hours before the end of the maintenance window that Systems Manager stops scheduling new tasks for execution.
*/
Cutoff?: MaintenanceWindowCutoff;
/**
* Whether targets must be registered with the maintenance window before tasks can be defined for those targets.
*/
AllowUnassociatedTargets?: MaintenanceWindowAllowUnassociatedTargets;
/**
* Indicates whether the maintenance window is enabled.
*/
Enabled?: MaintenanceWindowEnabled;
/**
* The date the maintenance window was created.
*/
CreatedDate?: DateTime;
/**
* The date the maintenance window was last modified.
*/
ModifiedDate?: DateTime;
}
export interface GetMaintenanceWindowTaskRequest {
/**
* The maintenance window ID that includes the task to retrieve.
*/
WindowId: MaintenanceWindowId;
/**
* The maintenance window task ID to retrieve.
*/
WindowTaskId: MaintenanceWindowTaskId;
}
export interface GetMaintenanceWindowTaskResult {
/**
* The retrieved maintenance window ID.
*/
WindowId?: MaintenanceWindowId;
/**
* The retrieved maintenance window task ID.
*/
WindowTaskId?: MaintenanceWindowTaskId;
/**
* The targets where the task should run.
*/
Targets?: Targets;
/**
* The resource that the task used during execution. For RUN_COMMAND and AUTOMATION task types, the TaskArn is the Systems Manager Document name/ARN. For LAMBDA tasks, the value is the function name/ARN. For STEP_FUNCTIONS tasks, the value is the state machine ARN.
*/
TaskArn?: MaintenanceWindowTaskArn;
/**
* The ARN of the IAM service role to use to publish Amazon Simple Notification Service (Amazon SNS) notifications for maintenance window Run Command tasks.
*/
ServiceRoleArn?: ServiceRole;
/**
* The type of task to run.
*/
TaskType?: MaintenanceWindowTaskType;
/**
* The parameters to pass to the task when it runs. TaskParameters has been deprecated. To specify parameters to pass to a task when it runs, instead use the Parameters option in the TaskInvocationParameters structure. For information about how Systems Manager handles these options for the supported maintenance window task types, see MaintenanceWindowTaskInvocationParameters.
*/
TaskParameters?: MaintenanceWindowTaskParameters;
/**
* The parameters to pass to the task when it runs.
*/
TaskInvocationParameters?: MaintenanceWindowTaskInvocationParameters;
/**
* The priority of the task when it runs. The lower the number, the higher the priority. Tasks that have the same priority are scheduled in parallel.
*/
Priority?: MaintenanceWindowTaskPriority;
/**
* The maximum number of targets allowed to run this task in parallel.
*/
MaxConcurrency?: MaxConcurrency;
/**
* The maximum number of errors allowed before the task stops being scheduled.
*/
MaxErrors?: MaxErrors;
/**
* The location in Amazon S3 where the task results are logged. LoggingInfo has been deprecated. To specify an S3 bucket to contain logs, instead use the OutputS3BucketName and OutputS3KeyPrefix options in the TaskInvocationParameters structure. For information about how Systems Manager handles these options for the supported maintenance window task types, see MaintenanceWindowTaskInvocationParameters.
*/
LoggingInfo?: LoggingInfo;
/**
* The retrieved task name.
*/
Name?: MaintenanceWindowName;
/**
* The retrieved task description.
*/
Description?: MaintenanceWindowDescription;
}
export interface GetOpsItemRequest {
/**
* The ID of the OpsItem that you want to get.
*/
OpsItemId: OpsItemId;
}
export interface GetOpsItemResponse {
/**
* The OpsItem.
*/
OpsItem?: OpsItem;
}
export interface GetOpsSummaryRequest {
/**
* Specify the name of a resource data sync to get.
*/
SyncName?: ResourceDataSyncName;
/**
* Optional filters used to scope down the returned OpsItems.
*/
Filters?: OpsFilterList;
/**
* Optional aggregators that return counts of OpsItems based on one or more expressions.
*/
Aggregators?: OpsAggregatorList;
/**
* The OpsItem data type to return.
*/
ResultAttributes?: OpsResultAttributeList;
/**
* A token to start the list. Use this token to get the next set of results.
*/
NextToken?: NextToken;
/**
* The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.
*/
MaxResults?: MaxResults;
}
export interface GetOpsSummaryResult {
/**
* The list of aggregated and filtered OpsItems.
*/
Entities?: OpsEntityList;
/**
* The token for the next set of items to return. Use this token to get the next set of results.
*/
NextToken?: NextToken;
}
export interface GetParameterHistoryRequest {
/**
* The name of a parameter you want to query.
*/
Name: PSParameterName;
/**
* Return decrypted values for secure string parameters. This flag is ignored for String and StringList parameter types.
*/
WithDecryption?: Boolean;
/**
* The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.
*/
MaxResults?: MaxResults;
/**
* The token for the next set of items to return. (You received this token from a previous call.)
*/
NextToken?: NextToken;
}
export interface GetParameterHistoryResult {
/**
* A list of parameters returned by the request.
*/
Parameters?: ParameterHistoryList;
/**
* The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.
*/
NextToken?: NextToken;
}
export interface GetParameterRequest {
/**
* The name of the parameter you want to query.
*/
Name: PSParameterName;
/**
* Return decrypted values for secure string parameters. This flag is ignored for String and StringList parameter types.
*/
WithDecryption?: Boolean;
}
export interface GetParameterResult {
/**
* Information about a parameter.
*/
Parameter?: Parameter;
}
export type GetParametersByPathMaxResults = number;
export interface GetParametersByPathRequest {
/**
* The hierarchy for the parameter. Hierarchies start with a forward slash (/) and end with the parameter name. A parameter name hierarchy can have a maximum of 15 levels. Here is an example of a hierarchy: /Finance/Prod/IAD/WinServ2016/license33
*/
Path: PSParameterName;
/**
* Retrieve all parameters within a hierarchy. If a user has access to a path, then the user can access all levels of that path. For example, if a user has permission to access path /a, then the user can also access /a/b. Even if a user has explicitly been denied access in IAM for parameter /a/b, they can still call the GetParametersByPath API action recursively for /a and view /a/b.
*/
Recursive?: Boolean;
/**
* Filters to limit the request results.
*/
ParameterFilters?: ParameterStringFilterList;
/**
* Retrieve all parameters in a hierarchy with their value decrypted.
*/
WithDecryption?: Boolean;
/**
* The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.
*/
MaxResults?: GetParametersByPathMaxResults;
/**
* A token to start the list. Use this token to get the next set of results.
*/
NextToken?: NextToken;
}
export interface GetParametersByPathResult {
/**
* A list of parameters found in the specified hierarchy.
*/
Parameters?: ParameterList;
/**
* The token for the next set of items to return. Use this token to get the next set of results.
*/
NextToken?: NextToken;
}
export interface GetParametersRequest {
/**
* Names of the parameters for which you want to query information.
*/
Names: ParameterNameList;
/**
* Return decrypted secure string value. Return decrypted values for secure string parameters. This flag is ignored for String and StringList parameter types.
*/
WithDecryption?: Boolean;
}
export interface GetParametersResult {
/**
* A list of details for a parameter.
*/
Parameters?: ParameterList;
/**
* A list of parameters that are not formatted correctly or do not run during an execution.
*/
InvalidParameters?: ParameterNameList;
}
export interface GetPatchBaselineForPatchGroupRequest {
/**
* The name of the patch group whose patch baseline should be retrieved.
*/
PatchGroup: PatchGroup;
/**
* Returns he operating system rule specified for patch groups using the patch baseline.
*/
OperatingSystem?: OperatingSystem;
}
export interface GetPatchBaselineForPatchGroupResult {
/**
* The ID of the patch baseline that should be used for the patch group.
*/
BaselineId?: BaselineId;
/**
* The name of the patch group.
*/
PatchGroup?: PatchGroup;
/**
* The operating system rule specified for patch groups using the patch baseline.
*/
OperatingSystem?: OperatingSystem;
}
export interface GetPatchBaselineRequest {
/**
* The ID of the patch baseline to retrieve.
*/
BaselineId: BaselineId;
}
export interface GetPatchBaselineResult {
/**
* The ID of the retrieved patch baseline.
*/
BaselineId?: BaselineId;
/**
* The name of the patch baseline.
*/
Name?: BaselineName;
/**
* Returns the operating system specified for the patch baseline.
*/
OperatingSystem?: OperatingSystem;
/**
* A set of global filters used to exclude patches from the baseline.
*/
GlobalFilters?: PatchFilterGroup;
/**
* A set of rules used to include patches in the baseline.
*/
ApprovalRules?: PatchRuleGroup;
/**
* A list of explicitly approved patches for the baseline.
*/
ApprovedPatches?: PatchIdList;
/**
* Returns the specified compliance severity level for approved patches in the patch baseline.
*/
ApprovedPatchesComplianceLevel?: PatchComplianceLevel;
/**
* Indicates whether the list of approved patches includes non-security updates that should be applied to the instances. The default value is 'false'. Applies to Linux instances only.
*/
ApprovedPatchesEnableNonSecurity?: Boolean;
/**
* A list of explicitly rejected patches for the baseline.
*/
RejectedPatches?: PatchIdList;
/**
* The action specified to take on patches included in the RejectedPatches list. A patch can be allowed only if it is a dependency of another package, or blocked entirely along with packages that include it as a dependency.
*/
RejectedPatchesAction?: PatchAction;
/**
* Patch groups included in the patch baseline.
*/
PatchGroups?: PatchGroupList;
/**
* The date the patch baseline was created.
*/
CreatedDate?: DateTime;
/**
* The date the patch baseline was last modified.
*/
ModifiedDate?: DateTime;
/**
* A description of the patch baseline.
*/
Description?: BaselineDescription;
/**
* Information about the patches to use to update the instances, including target operating systems and source repositories. Applies to Linux instances only.
*/
Sources?: PatchSourceList;
}
export interface GetServiceSettingRequest {
/**
* The ID of the service setting to get.
*/
SettingId: ServiceSettingId;
}
export interface GetServiceSettingResult {
/**
* The query result of the current service setting.
*/
ServiceSetting?: ServiceSetting;
}
export type IPAddress = string;
export type ISO8601String = string;
export type IamRole = string;
export type IdempotencyToken = string;
export type InstallOverrideList = string;
export interface InstanceAggregatedAssociationOverview {
/**
* Detailed status information about the aggregated associations.
*/
DetailedStatus?: StatusName;
/**
* The number of associations for the instance(s).
*/
InstanceAssociationStatusAggregatedCount?: InstanceAssociationStatusAggregatedCount;
}
export interface InstanceAssociation {
/**
* The association ID.
*/
AssociationId?: AssociationId;
/**
* The instance ID.
*/
InstanceId?: InstanceId;
/**
* The content of the association document for the instance(s).
*/
Content?: DocumentContent;
/**
* Version information for the association on the instance.
*/
AssociationVersion?: AssociationVersion;
}
export type InstanceAssociationExecutionSummary = string;
export type InstanceAssociationList = InstanceAssociation[];
export interface InstanceAssociationOutputLocation {
/**
* An Amazon S3 bucket where you want to store the results of this request.
*/
S3Location?: S3OutputLocation;
}
export interface InstanceAssociationOutputUrl {
/**
* The URL of Amazon S3 bucket where you want to store the results of this request.
*/
S3OutputUrl?: S3OutputUrl;
}
export type InstanceAssociationStatusAggregatedCount = {[key: string]: InstanceCount};
export interface InstanceAssociationStatusInfo {
/**
* The association ID.
*/
AssociationId?: AssociationId;
/**
* The name of the association.
*/
Name?: DocumentARN;
/**
* The association document versions.
*/
DocumentVersion?: DocumentVersion;
/**
* The version of the association applied to the instance.
*/
AssociationVersion?: AssociationVersion;
/**
* The instance ID where the association was created.
*/
InstanceId?: InstanceId;
/**
* The date the instance association ran.
*/
ExecutionDate?: DateTime;
/**
* Status information about the instance association.
*/
Status?: StatusName;
/**
* Detailed status information about the instance association.
*/
DetailedStatus?: StatusName;
/**
* Summary information about association execution.
*/
ExecutionSummary?: InstanceAssociationExecutionSummary;
/**
* An error code returned by the request to create the association.
*/
ErrorCode?: AgentErrorCode;
/**
* A URL for an Amazon S3 bucket where you want to store the results of this request.
*/
OutputUrl?: InstanceAssociationOutputUrl;
/**
* The name of the association applied to the instance.
*/
AssociationName?: AssociationName;
}
export type InstanceAssociationStatusInfos = InstanceAssociationStatusInfo[];
export type InstanceCount = number;
export type InstanceId = string;
export type InstanceIdList = InstanceId[];
export interface InstanceInformation {
/**
* The instance ID.
*/
InstanceId?: InstanceId;
/**
* Connection status of SSM Agent.
*/
PingStatus?: PingStatus;
/**
* The date and time when agent last pinged Systems Manager service.
*/
LastPingDateTime?: DateTime;
/**
* The version of SSM Agent running on your Linux instance.
*/
AgentVersion?: Version;
/**
* Indicates whether the latest version of SSM Agent is running on your Linux Managed Instance. This field does not indicate whether or not the latest version is installed on Windows managed instances, because some older versions of Windows Server use the EC2Config service to process SSM requests.
*/
IsLatestVersion?: Boolean;
/**
* The operating system platform type.
*/
PlatformType?: PlatformType;
/**
* The name of the operating system platform running on your instance.
*/
PlatformName?: String;
/**
* The version of the OS platform running on your instance.
*/
PlatformVersion?: String;
/**
* The activation ID created by Systems Manager when the server or VM was registered.
*/
ActivationId?: ActivationId;
/**
* The Amazon Identity and Access Management (IAM) role assigned to the on-premises Systems Manager managed instances. This call does not return the IAM role for Amazon EC2 instances.
*/
IamRole?: IamRole;
/**
* The date the server or VM was registered with AWS as a managed instance.
*/
RegistrationDate?: DateTime;
/**
* The type of instance. Instances are either EC2 instances or managed instances.
*/
ResourceType?: ResourceType;
/**
* The name of the managed instance.
*/
Name?: String;
/**
* The IP address of the managed instance.
*/
IPAddress?: IPAddress;
/**
* The fully qualified host name of the managed instance.
*/
ComputerName?: ComputerName;
/**
* The status of the association.
*/
AssociationStatus?: StatusName;
/**
* The date the association was last run.
*/
LastAssociationExecutionDate?: DateTime;
/**
* The last date the association was successfully run.
*/
LastSuccessfulAssociationExecutionDate?: DateTime;
/**
* Information about the association.
*/
AssociationOverview?: InstanceAggregatedAssociationOverview;
}
export interface InstanceInformationFilter {
/**
* The name of the filter.
*/
key: InstanceInformationFilterKey;
/**
* The filter values.
*/
valueSet: InstanceInformationFilterValueSet;
}
export type InstanceInformationFilterKey = "InstanceIds"|"AgentVersion"|"PingStatus"|"PlatformTypes"|"ActivationIds"|"IamRole"|"ResourceType"|"AssociationStatus"|string;
export type InstanceInformationFilterList = InstanceInformationFilter[];
export type InstanceInformationFilterValue = string;
export type InstanceInformationFilterValueSet = InstanceInformationFilterValue[];
export type InstanceInformationList = InstanceInformation[];
export interface InstanceInformationStringFilter {
/**
* The filter key name to describe your instances. For example: "InstanceIds"|"AgentVersion"|"PingStatus"|"PlatformTypes"|"ActivationIds"|"IamRole"|"ResourceType"|"AssociationStatus"|"Tag Key"
*/
Key: InstanceInformationStringFilterKey;
/**
* The filter values.
*/
Values: InstanceInformationFilterValueSet;
}
export type InstanceInformationStringFilterKey = string;
export type InstanceInformationStringFilterList = InstanceInformationStringFilter[];
export interface InstancePatchState {
/**
* The ID of the managed instance the high-level patch compliance information was collected for.
*/
InstanceId: InstanceId;
/**
* The name of the patch group the managed instance belongs to.
*/
PatchGroup: PatchGroup;
/**
* The ID of the patch baseline used to patch the instance.
*/
BaselineId: BaselineId;
/**
* The ID of the patch baseline snapshot used during the patching operation when this compliance data was collected.
*/
SnapshotId?: SnapshotId;
/**
* An https URL or an Amazon S3 path-style URL to a list of patches to be installed. This patch installation list, which you maintain in an Amazon S3 bucket in YAML format and specify in the SSM document AWS-RunPatchBaseline, overrides the patches specified by the default patch baseline. For more information about the InstallOverrideList parameter, see About the SSM Document AWS-RunPatchBaseline in the AWS Systems Manager User Guide.
*/
InstallOverrideList?: InstallOverrideList;
/**
* Placeholder information. This field will always be empty in the current release of the service.
*/
OwnerInformation?: OwnerInformation;
/**
* The number of patches from the patch baseline that are installed on the instance.
*/
InstalledCount?: PatchInstalledCount;
/**
* The number of patches not specified in the patch baseline that are installed on the instance.
*/
InstalledOtherCount?: PatchInstalledOtherCount;
/**
* Reserved for future use.
*/
InstalledPendingRebootCount?: PatchInstalledPendingRebootCount;
/**
* The number of instances with patches installed that are specified in a RejectedPatches list. Patches with a status of InstalledRejected were typically installed before they were added to a RejectedPatches list. If ALLOW_AS_DEPENDENCY is the specified option for RejectedPatchesAction, the value of InstalledRejectedCount will always be 0 (zero).
*/
InstalledRejectedCount?: PatchInstalledRejectedCount;
/**
* The number of patches from the patch baseline that are applicable for the instance but aren't currently installed.
*/
MissingCount?: PatchMissingCount;
/**
* The number of patches from the patch baseline that were attempted to be installed during the last patching operation, but failed to install.
*/
FailedCount?: PatchFailedCount;
/**
* The number of patches beyond the supported limit of NotApplicableCount that are not reported by name to Systems Manager Inventory.
*/
UnreportedNotApplicableCount?: PatchUnreportedNotApplicableCount;
/**
* The number of patches from the patch baseline that aren't applicable for the instance and therefore aren't installed on the instance. This number may be truncated if the list of patch names is very large. The number of patches beyond this limit are reported in UnreportedNotApplicableCount.
*/
NotApplicableCount?: PatchNotApplicableCount;
/**
* The time the most recent patching operation was started on the instance.
*/
OperationStartTime: DateTime;
/**
* The time the most recent patching operation completed on the instance.
*/
OperationEndTime: DateTime;
/**
* The type of patching operation that was performed: SCAN (assess patch compliance state) or INSTALL (install missing patches).
*/
Operation: PatchOperationType;
/**
* Reserved for future use.
*/
LastNoRebootInstallOperationTime?: DateTime;
/**
* Reserved for future use.
*/
RebootOption?: RebootOption;
}
export interface InstancePatchStateFilter {
/**
* The key for the filter. Supported values are FailedCount, InstalledCount, InstalledOtherCount, MissingCount and NotApplicableCount.
*/
Key: InstancePatchStateFilterKey;
/**
* The value for the filter, must be an integer greater than or equal to 0.
*/
Values: InstancePatchStateFilterValues;
/**
* The type of comparison that should be performed for the value: Equal, NotEqual, LessThan or GreaterThan.
*/
Type: InstancePatchStateOperatorType;
}
export type InstancePatchStateFilterKey = string;
export type InstancePatchStateFilterList = InstancePatchStateFilter[];
export type InstancePatchStateFilterValue = string;
export type InstancePatchStateFilterValues = InstancePatchStateFilterValue[];
export type InstancePatchStateList = InstancePatchState[];
export type InstancePatchStateOperatorType = "Equal"|"NotEqual"|"LessThan"|"GreaterThan"|string;
export type InstancePatchStatesList = InstancePatchState[];
export type InstanceTagName = string;
export type InstancesCount = number;
export type Integer = number;
export interface InventoryAggregator {
/**
* The inventory type and attribute name for aggregation.
*/
Expression?: InventoryAggregatorExpression;
/**
* Nested aggregators to further refine aggregation for an inventory type.
*/
Aggregators?: InventoryAggregatorList;
/**
* A user-defined set of one or more filters on which to aggregate inventory data. Groups return a count of resources that match and don't match the specified criteria.
*/
Groups?: InventoryGroupList;
}
export type InventoryAggregatorExpression = string;
export type InventoryAggregatorList = InventoryAggregator[];
export type InventoryAttributeDataType = "string"|"number"|string;
export type InventoryDeletionId = string;
export type InventoryDeletionLastStatusMessage = string;
export type InventoryDeletionLastStatusUpdateTime = Date;
export type InventoryDeletionStartTime = Date;
export type InventoryDeletionStatus = "InProgress"|"Complete"|string;
export interface InventoryDeletionStatusItem {
/**
* The deletion ID returned by the DeleteInventory action.
*/
DeletionId?: InventoryDeletionId;
/**
* The name of the inventory data type.
*/
TypeName?: InventoryItemTypeName;
/**
* The UTC timestamp when the delete operation started.
*/
DeletionStartTime?: InventoryDeletionStartTime;
/**
* The status of the operation. Possible values are InProgress and Complete.
*/
LastStatus?: InventoryDeletionStatus;
/**
* Information about the status.
*/
LastStatusMessage?: InventoryDeletionLastStatusMessage;
/**
* Information about the delete operation. For more information about this summary, see Understanding the Delete Inventory Summary in the AWS Systems Manager User Guide.
*/
DeletionSummary?: InventoryDeletionSummary;
/**
* The UTC timestamp of when the last status report.
*/
LastStatusUpdateTime?: InventoryDeletionLastStatusUpdateTime;
}
export interface InventoryDeletionSummary {
/**
* The total number of items to delete. This count does not change during the delete operation.
*/
TotalCount?: TotalCount;
/**
* Remaining number of items to delete.
*/
RemainingCount?: RemainingCount;
/**
* A list of counts and versions for deleted items.
*/
SummaryItems?: InventoryDeletionSummaryItems;
}
export interface InventoryDeletionSummaryItem {
/**
* The inventory type version.
*/
Version?: InventoryItemSchemaVersion;
/**
* A count of the number of deleted items.
*/
Count?: ResourceCount;
/**
* The remaining number of items to delete.
*/
RemainingCount?: RemainingCount;
}
export type InventoryDeletionSummaryItems = InventoryDeletionSummaryItem[];
export type InventoryDeletionsList = InventoryDeletionStatusItem[];
export interface InventoryFilter {
/**
* The name of the filter key.
*/
Key: InventoryFilterKey;
/**
* Inventory filter values. Example: inventory filter where instance IDs are specified as values Key=AWS:InstanceInformation.InstanceId,Values= i-a12b3c4d5e6g, i-1a2b3c4d5e6,Type=Equal
*/
Values: InventoryFilterValueList;
/**
* The type of filter. Valid values include the following: "Equal"|"NotEqual"|"BeginWith"|"LessThan"|"GreaterThan"
*/
Type?: InventoryQueryOperatorType;
}
export type InventoryFilterKey = string;
export type InventoryFilterList = InventoryFilter[];
export type InventoryFilterValue = string;
export type InventoryFilterValueList = InventoryFilterValue[];
export interface InventoryGroup {
/**
* The name of the group.
*/
Name: InventoryGroupName;
/**
* Filters define the criteria for the group. The matchingCount field displays the number of resources that match the criteria. The notMatchingCount field displays the number of resources that don't match the criteria.
*/
Filters: InventoryFilterList;
}
export type InventoryGroupList = InventoryGroup[];
export type InventoryGroupName = string;
export interface InventoryItem {
/**
* The name of the inventory type. Default inventory item type names start with AWS. Custom inventory type names will start with Custom. Default inventory item types include the following: AWS:AWSComponent, AWS:Application, AWS:InstanceInformation, AWS:Network, and AWS:WindowsUpdate.
*/
TypeName: InventoryItemTypeName;
/**
* The schema version for the inventory item.
*/
SchemaVersion: InventoryItemSchemaVersion;
/**
* The time the inventory information was collected.
*/
CaptureTime: InventoryItemCaptureTime;
/**
* MD5 hash of the inventory item type contents. The content hash is used to determine whether to update inventory information. The PutInventory API does not update the inventory item type contents if the MD5 hash has not changed since last update.
*/
ContentHash?: InventoryItemContentHash;
/**
* The inventory data of the inventory type.
*/
Content?: InventoryItemEntryList;
/**
* A map of associated properties for a specified inventory type. For example, with this attribute, you can specify the ExecutionId, ExecutionType, ComplianceType properties of the AWS:ComplianceItem type.
*/
Context?: InventoryItemContentContext;
}
export interface InventoryItemAttribute {
/**
* Name of the inventory item attribute.
*/
Name: InventoryItemAttributeName;
/**
* The data type of the inventory item attribute.
*/
DataType: InventoryAttributeDataType;
}
export type InventoryItemAttributeList = InventoryItemAttribute[];
export type InventoryItemAttributeName = string;
export type InventoryItemCaptureTime = string;
export type InventoryItemContentContext = {[key: string]: AttributeValue};
export type InventoryItemContentHash = string;
export type InventoryItemEntry = {[key: string]: AttributeValue};
export type InventoryItemEntryList = InventoryItemEntry[];
export type InventoryItemList = InventoryItem[];
export interface InventoryItemSchema {
/**
* The name of the inventory type. Default inventory item type names start with AWS. Custom inventory type names will start with Custom. Default inventory item types include the following: AWS:AWSComponent, AWS:Application, AWS:InstanceInformation, AWS:Network, and AWS:WindowsUpdate.
*/
TypeName: InventoryItemTypeName;
/**
* The schema version for the inventory item.
*/
Version?: InventoryItemSchemaVersion;
/**
* The schema attributes for inventory. This contains data type and attribute name.
*/
Attributes: InventoryItemAttributeList;
/**
* The alias name of the inventory type. The alias name is used for display purposes.
*/
DisplayName?: InventoryTypeDisplayName;
}
export type InventoryItemSchemaResultList = InventoryItemSchema[];
export type InventoryItemSchemaVersion = string;
export type InventoryItemTypeName = string;
export type InventoryItemTypeNameFilter = string;
export type InventoryQueryOperatorType = "Equal"|"NotEqual"|"BeginWith"|"LessThan"|"GreaterThan"|"Exists"|string;
export interface InventoryResultEntity {
/**
* ID of the inventory result entity. For example, for managed instance inventory the result will be the managed instance ID. For EC2 instance inventory, the result will be the instance ID.
*/
Id?: InventoryResultEntityId;
/**
* The data section in the inventory result entity JSON.
*/
Data?: InventoryResultItemMap;
}
export type InventoryResultEntityId = string;
export type InventoryResultEntityList = InventoryResultEntity[];
export interface InventoryResultItem {
/**
* The name of the inventory result item type.
*/
TypeName: InventoryItemTypeName;
/**
* The schema version for the inventory result item/
*/
SchemaVersion: InventoryItemSchemaVersion;
/**
* The time inventory item data was captured.
*/
CaptureTime?: InventoryItemCaptureTime;
/**
* MD5 hash of the inventory item type contents. The content hash is used to determine whether to update inventory information. The PutInventory API does not update the inventory item type contents if the MD5 hash has not changed since last update.
*/
ContentHash?: InventoryItemContentHash;
/**
* Contains all the inventory data of the item type. Results include attribute names and values.
*/
Content: InventoryItemEntryList;
}
export type InventoryResultItemKey = string;
export type InventoryResultItemMap = {[key: string]: InventoryResultItem};
export type InventorySchemaDeleteOption = "DisableSchema"|"DeleteSchema"|string;
export type InventoryTypeDisplayName = string;
export type InvocationTraceOutput = string;
export type IsSubTypeSchema = boolean;
export type KeyList = TagKey[];
export interface LabelParameterVersionRequest {
/**
* The parameter name on which you want to attach one or more labels.
*/
Name: PSParameterName;
/**
* The specific version of the parameter on which you want to attach one or more labels. If no version is specified, the system attaches the label to the latest version.
*/
ParameterVersion?: PSParameterVersion;
/**
* One or more labels to attach to the specified parameter version.
*/
Labels: ParameterLabelList;
}
export interface LabelParameterVersionResult {
/**
* The label does not meet the requirements. For information about parameter label requirements, see Labeling Parameters in the AWS Systems Manager User Guide.
*/
InvalidLabels?: ParameterLabelList;
/**
* The version of the parameter that has been labeled.
*/
ParameterVersion?: PSParameterVersion;
}
export type LastResourceDataSyncMessage = string;
export type LastResourceDataSyncStatus = "Successful"|"Failed"|"InProgress"|string;
export type LastResourceDataSyncTime = Date;
export type LastSuccessfulResourceDataSyncTime = Date;
export interface ListAssociationVersionsRequest {
/**
* The association ID for which you want to view all versions.
*/
AssociationId: AssociationId;
/**
* The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.
*/
MaxResults?: MaxResults;
/**
* A token to start the list. Use this token to get the next set of results.
*/
NextToken?: NextToken;
}
export interface ListAssociationVersionsResult {
/**
* Information about all versions of the association for the specified association ID.
*/
AssociationVersions?: AssociationVersionList;
/**
* The token for the next set of items to return. Use this token to get the next set of results.
*/
NextToken?: NextToken;
}
export interface ListAssociationsRequest {
/**
* One or more filters. Use a filter to return a more specific list of results.
*/
AssociationFilterList?: AssociationFilterList;
/**
* The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.
*/
MaxResults?: MaxResults;
/**
* The token for the next set of items to return. (You received this token from a previous call.)
*/
NextToken?: NextToken;
}
export interface ListAssociationsResult {
/**
* The associations.
*/
Associations?: AssociationList;
/**
* The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.
*/
NextToken?: NextToken;
}
export interface ListCommandInvocationsRequest {
/**
* (Optional) The invocations for a specific command ID.
*/
CommandId?: CommandId;
/**
* (Optional) The command execution details for a specific instance ID.
*/
InstanceId?: InstanceId;
/**
* (Optional) The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.
*/
MaxResults?: CommandMaxResults;
/**
* (Optional) The token for the next set of items to return. (You received this token from a previous call.)
*/
NextToken?: NextToken;
/**
* (Optional) One or more filters. Use a filter to return a more specific list of results. Note that the DocumentName filter is not supported for ListCommandInvocations.
*/
Filters?: CommandFilterList;
/**
* (Optional) If set this returns the response of the command executions and any command output. By default this is set to False.
*/
Details?: Boolean;
}
export interface ListCommandInvocationsResult {
/**
* (Optional) A list of all invocations.
*/
CommandInvocations?: CommandInvocationList;
/**
* (Optional) The token for the next set of items to return. (You received this token from a previous call.)
*/
NextToken?: NextToken;
}
export interface ListCommandsRequest {
/**
* (Optional) If provided, lists only the specified command.
*/
CommandId?: CommandId;
/**
* (Optional) Lists commands issued against this instance ID.
*/
InstanceId?: InstanceId;
/**
* (Optional) The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.
*/
MaxResults?: CommandMaxResults;
/**
* (Optional) The token for the next set of items to return. (You received this token from a previous call.)
*/
NextToken?: NextToken;
/**
* (Optional) One or more filters. Use a filter to return a more specific list of results.
*/
Filters?: CommandFilterList;
}
export interface ListCommandsResult {
/**
* (Optional) The list of commands requested by the user.
*/
Commands?: CommandList;
/**
* (Optional) The token for the next set of items to return. (You received this token from a previous call.)
*/
NextToken?: NextToken;
}
export interface ListComplianceItemsRequest {
/**
* One or more compliance filters. Use a filter to return a more specific list of results.
*/
Filters?: ComplianceStringFilterList;
/**
* The ID for the resources from which to get compliance information. Currently, you can only specify one resource ID.
*/
ResourceIds?: ComplianceResourceIdList;
/**
* The type of resource from which to get compliance information. Currently, the only supported resource type is ManagedInstance.
*/
ResourceTypes?: ComplianceResourceTypeList;
/**
* A token to start the list. Use this token to get the next set of results.
*/
NextToken?: NextToken;
/**
* The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.
*/
MaxResults?: MaxResults;
}
export interface ListComplianceItemsResult {
/**
* A list of compliance information for the specified resource ID.
*/
ComplianceItems?: ComplianceItemList;
/**
* The token for the next set of items to return. Use this token to get the next set of results.
*/
NextToken?: NextToken;
}
export interface ListComplianceSummariesRequest {
/**
* One or more compliance or inventory filters. Use a filter to return a more specific list of results.
*/
Filters?: ComplianceStringFilterList;
/**
* A token to start the list. Use this token to get the next set of results.
*/
NextToken?: NextToken;
/**
* The maximum number of items to return for this call. Currently, you can specify null or 50. The call also returns a token that you can specify in a subsequent call to get the next set of results.
*/
MaxResults?: MaxResults;
}
export interface ListComplianceSummariesResult {
/**
* A list of compliant and non-compliant summary counts based on compliance types. For example, this call returns State Manager associations, patches, or custom compliance types according to the filter criteria that you specified.
*/
ComplianceSummaryItems?: ComplianceSummaryItemList;
/**
* The token for the next set of items to return. Use this token to get the next set of results.
*/
NextToken?: NextToken;
}
export interface ListDocumentVersionsRequest {
/**
* The name of the document. You can specify an Amazon Resource Name (ARN).
*/
Name: DocumentARN;
/**
* The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.
*/
MaxResults?: MaxResults;
/**
* The token for the next set of items to return. (You received this token from a previous call.)
*/
NextToken?: NextToken;
}
export interface ListDocumentVersionsResult {
/**
* The document versions.
*/
DocumentVersions?: DocumentVersionList;
/**
* The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.
*/
NextToken?: NextToken;
}
export interface ListDocumentsRequest {
/**
* One or more filters. Use a filter to return a more specific list of results.
*/
DocumentFilterList?: DocumentFilterList;
/**
* One or more filters. Use a filter to return a more specific list of results.
*/
Filters?: DocumentKeyValuesFilterList;
/**
* The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.
*/
MaxResults?: MaxResults;
/**
* The token for the next set of items to return. (You received this token from a previous call.)
*/
NextToken?: NextToken;
}
export interface ListDocumentsResult {
/**
* The names of the Systems Manager documents.
*/
DocumentIdentifiers?: DocumentIdentifierList;
/**
* The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.
*/
NextToken?: NextToken;
}
export interface ListInventoryEntriesRequest {
/**
* The instance ID for which you want inventory information.
*/
InstanceId: InstanceId;
/**
* The type of inventory item for which you want information.
*/
TypeName: InventoryItemTypeName;
/**
* One or more filters. Use a filter to return a more specific list of results.
*/
Filters?: InventoryFilterList;
/**
* The token for the next set of items to return. (You received this token from a previous call.)
*/
NextToken?: NextToken;
/**
* The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.
*/
MaxResults?: MaxResults;
}
export interface ListInventoryEntriesResult {
/**
* The type of inventory item returned by the request.
*/
TypeName?: InventoryItemTypeName;
/**
* The instance ID targeted by the request to query inventory information.
*/
InstanceId?: InstanceId;
/**
* The inventory schema version used by the instance(s).
*/
SchemaVersion?: InventoryItemSchemaVersion;
/**
* The time that inventory information was collected for the instance(s).
*/
CaptureTime?: InventoryItemCaptureTime;
/**
* A list of inventory items on the instance(s).
*/
Entries?: InventoryItemEntryList;
/**
* The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.
*/
NextToken?: NextToken;
}
export interface ListResourceComplianceSummariesRequest {
/**
* One or more filters. Use a filter to return a more specific list of results.
*/
Filters?: ComplianceStringFilterList;
/**
* A token to start the list. Use this token to get the next set of results.
*/
NextToken?: NextToken;
/**
* The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.
*/
MaxResults?: MaxResults;
}
export interface ListResourceComplianceSummariesResult {
/**
* A summary count for specified or targeted managed instances. Summary count includes information about compliant and non-compliant State Manager associations, patch status, or custom items according to the filter criteria that you specify.
*/
ResourceComplianceSummaryItems?: ResourceComplianceSummaryItemList;
/**
* The token for the next set of items to return. Use this token to get the next set of results.
*/
NextToken?: NextToken;
}
export interface ListResourceDataSyncRequest {
/**
* View a list of resource data syncs according to the sync type. Specify SyncToDestination to view resource data syncs that synchronize data to an Amazon S3 buckets. Specify SyncFromSource to view resource data syncs from AWS Organizations or from multiple AWS Regions.
*/
SyncType?: ResourceDataSyncType;
/**
* A token to start the list. Use this token to get the next set of results.
*/
NextToken?: NextToken;
/**
* The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.
*/
MaxResults?: MaxResults;
}
export interface ListResourceDataSyncResult {
/**
* A list of your current Resource Data Sync configurations and their statuses.
*/
ResourceDataSyncItems?: ResourceDataSyncItemList;
/**
* The token for the next set of items to return. Use this token to get the next set of results.
*/
NextToken?: NextToken;
}
export interface ListTagsForResourceRequest {
/**
* Returns a list of tags for a specific resource type.
*/
ResourceType: ResourceTypeForTagging;
/**
* The resource ID for which you want to see a list of tags.
*/
ResourceId: ResourceId;
}
export interface ListTagsForResourceResult {
/**
* A list of tags.
*/
TagList?: TagList;
}
export interface LoggingInfo {
/**
* The name of an Amazon S3 bucket where execution logs are stored .
*/
S3BucketName: S3BucketName;
/**
* (Optional) The Amazon S3 bucket subfolder.
*/
S3KeyPrefix?: S3KeyPrefix;
/**
* The region where the Amazon S3 bucket is located.
*/
S3Region: S3Region;
}
export type Long = number;
export type MaintenanceWindowAllowUnassociatedTargets = boolean;
export interface MaintenanceWindowAutomationParameters {
/**
* The version of an Automation document to use during task execution.
*/
DocumentVersion?: DocumentVersion;
/**
* The parameters for the AUTOMATION task. For information about specifying and updating task parameters, see RegisterTaskWithMaintenanceWindow and UpdateMaintenanceWindowTask. LoggingInfo has been deprecated. To specify an S3 bucket to contain logs, instead use the OutputS3BucketName and OutputS3KeyPrefix options in the TaskInvocationParameters structure. For information about how Systems Manager handles these options for the supported maintenance window task types, see MaintenanceWindowTaskInvocationParameters. TaskParameters has been deprecated. To specify parameters to pass to a task when it runs, instead use the Parameters option in the TaskInvocationParameters structure. For information about how Systems Manager handles these options for the supported maintenance window task types, see MaintenanceWindowTaskInvocationParameters. For AUTOMATION task types, Systems Manager ignores any values specified for these parameters.
*/
Parameters?: AutomationParameterMap;
}
export type MaintenanceWindowCutoff = number;
export type MaintenanceWindowDescription = string;
export type MaintenanceWindowDurationHours = number;
export type MaintenanceWindowEnabled = boolean;
export interface MaintenanceWindowExecution {
/**
* The ID of the maintenance window.
*/
WindowId?: MaintenanceWindowId;
/**
* The ID of the maintenance window execution.
*/
WindowExecutionId?: MaintenanceWindowExecutionId;
/**
* The status of the execution.
*/
Status?: MaintenanceWindowExecutionStatus;
/**
* The details explaining the Status. Only available for certain status values.
*/
StatusDetails?: MaintenanceWindowExecutionStatusDetails;
/**
* The time the execution started.
*/
StartTime?: DateTime;
/**
* The time the execution finished.
*/
EndTime?: DateTime;
}
export type MaintenanceWindowExecutionId = string;
export type MaintenanceWindowExecutionList = MaintenanceWindowExecution[];
export type MaintenanceWindowExecutionStatus = "PENDING"|"IN_PROGRESS"|"SUCCESS"|"FAILED"|"TIMED_OUT"|"CANCELLING"|"CANCELLED"|"SKIPPED_OVERLAPPING"|string;
export type MaintenanceWindowExecutionStatusDetails = string;
export type MaintenanceWindowExecutionTaskExecutionId = string;
export type MaintenanceWindowExecutionTaskId = string;
export type MaintenanceWindowExecutionTaskIdList = MaintenanceWindowExecutionTaskId[];
export interface MaintenanceWindowExecutionTaskIdentity {
/**
* The ID of the maintenance window execution that ran the task.
*/
WindowExecutionId?: MaintenanceWindowExecutionId;
/**
* The ID of the specific task execution in the maintenance window execution.
*/
TaskExecutionId?: MaintenanceWindowExecutionTaskId;
/**
* The status of the task execution.
*/
Status?: MaintenanceWindowExecutionStatus;
/**
* The details explaining the status of the task execution. Only available for certain status values.
*/
StatusDetails?: MaintenanceWindowExecutionStatusDetails;
/**
* The time the task execution started.
*/
StartTime?: DateTime;
/**
* The time the task execution finished.
*/
EndTime?: DateTime;
/**
* The ARN of the task that ran.
*/
TaskArn?: MaintenanceWindowTaskArn;
/**
* The type of task that ran.
*/
TaskType?: MaintenanceWindowTaskType;
}
export type MaintenanceWindowExecutionTaskIdentityList = MaintenanceWindowExecutionTaskIdentity[];
export type MaintenanceWindowExecutionTaskInvocationId = string;
export interface MaintenanceWindowExecutionTaskInvocationIdentity {
/**
* The ID of the maintenance window execution that ran the task.
*/
WindowExecutionId?: MaintenanceWindowExecutionId;
/**
* The ID of the specific task execution in the maintenance window execution.
*/
TaskExecutionId?: MaintenanceWindowExecutionTaskId;
/**
* The ID of the task invocation.
*/
InvocationId?: MaintenanceWindowExecutionTaskInvocationId;
/**
* The ID of the action performed in the service that actually handled the task invocation. If the task type is RUN_COMMAND, this value is the command ID.
*/
ExecutionId?: MaintenanceWindowExecutionTaskExecutionId;
/**
* The task type.
*/
TaskType?: MaintenanceWindowTaskType;
/**
* The parameters that were provided for the invocation when it was run.
*/
Parameters?: MaintenanceWindowExecutionTaskInvocationParameters;
/**
* The status of the task invocation.
*/
Status?: MaintenanceWindowExecutionStatus;
/**
* The details explaining the status of the task invocation. Only available for certain Status values.
*/
StatusDetails?: MaintenanceWindowExecutionStatusDetails;
/**
* The time the invocation started.
*/
StartTime?: DateTime;
/**
* The time the invocation finished.
*/
EndTime?: DateTime;
/**
* User-provided value that was specified when the target was registered with the maintenance window. This was also included in any CloudWatch events raised during the task invocation.
*/
OwnerInformation?: OwnerInformation;
/**
* The ID of the target definition in this maintenance window the invocation was performed for.
*/
WindowTargetId?: MaintenanceWindowTaskTargetId;
}
export type MaintenanceWindowExecutionTaskInvocationIdentityList = MaintenanceWindowExecutionTaskInvocationIdentity[];
export type MaintenanceWindowExecutionTaskInvocationParameters = string;
export interface MaintenanceWindowFilter {
/**
* The name of the filter.
*/
Key?: MaintenanceWindowFilterKey;
/**
* The filter values.
*/
Values?: MaintenanceWindowFilterValues;
}
export type MaintenanceWindowFilterKey = string;
export type MaintenanceWindowFilterList = MaintenanceWindowFilter[];
export type MaintenanceWindowFilterValue = string;
export type MaintenanceWindowFilterValues = MaintenanceWindowFilterValue[];
export type MaintenanceWindowId = string;
export interface MaintenanceWindowIdentity {
/**
* The ID of the maintenance window.
*/
WindowId?: MaintenanceWindowId;
/**
* The name of the maintenance window.
*/
Name?: MaintenanceWindowName;
/**
* A description of the maintenance window.
*/
Description?: MaintenanceWindowDescription;
/**
* Indicates whether the maintenance window is enabled.
*/
Enabled?: MaintenanceWindowEnabled;
/**
* The duration of the maintenance window in hours.
*/
Duration?: MaintenanceWindowDurationHours;
/**
* The number of hours before the end of the maintenance window that Systems Manager stops scheduling new tasks for execution.
*/
Cutoff?: MaintenanceWindowCutoff;
/**
* The schedule of the maintenance window in the form of a cron or rate expression.
*/
Schedule?: MaintenanceWindowSchedule;
/**
* The time zone that the scheduled maintenance window executions are based on, in Internet Assigned Numbers Authority (IANA) format.
*/
ScheduleTimezone?: MaintenanceWindowTimezone;
/**
* The date and time, in ISO-8601 Extended format, for when the maintenance window is scheduled to become inactive.
*/
EndDate?: MaintenanceWindowStringDateTime;
/**
* The date and time, in ISO-8601 Extended format, for when the maintenance window is scheduled to become active.
*/
StartDate?: MaintenanceWindowStringDateTime;
/**
* The next time the maintenance window will actually run, taking into account any specified times for the maintenance window to become active or inactive.
*/
NextExecutionTime?: MaintenanceWindowStringDateTime;
}
export interface MaintenanceWindowIdentityForTarget {
/**
* The ID of the maintenance window.
*/
WindowId?: MaintenanceWindowId;
/**
* The name of the maintenance window.
*/
Name?: MaintenanceWindowName;
}
export type MaintenanceWindowIdentityList = MaintenanceWindowIdentity[];
export type MaintenanceWindowLambdaClientContext = string;
export interface MaintenanceWindowLambdaParameters {
/**
* Pass client-specific information to the Lambda function that you are invoking. You can then process the client information in your Lambda function as you choose through the context variable.
*/
ClientContext?: MaintenanceWindowLambdaClientContext;
/**
* (Optional) Specify a Lambda function version or alias name. If you specify a function version, the action uses the qualified function ARN to invoke a specific Lambda function. If you specify an alias name, the action uses the alias ARN to invoke the Lambda function version to which the alias points.
*/
Qualifier?: MaintenanceWindowLambdaQualifier;
/**
* JSON to provide to your Lambda function as input.
*/
Payload?: MaintenanceWindowLambdaPayload;
}
export type MaintenanceWindowLambdaPayload = Buffer|Uint8Array|Blob|string;
export type MaintenanceWindowLambdaQualifier = string;
export type MaintenanceWindowMaxResults = number;
export type MaintenanceWindowName = string;
export type MaintenanceWindowResourceType = "INSTANCE"|"RESOURCE_GROUP"|string;
export interface MaintenanceWindowRunCommandParameters {
/**
* Information about the commands to run.
*/
Comment?: Comment;
/**
* The SHA-256 or SHA-1 hash created by the system when the document was created. SHA-1 hashes have been deprecated.
*/
DocumentHash?: DocumentHash;
/**
* SHA-256 or SHA-1. SHA-1 hashes have been deprecated.
*/
DocumentHashType?: DocumentHashType;
/**
* Configurations for sending notifications about command status changes on a per-instance basis.
*/
NotificationConfig?: NotificationConfig;
/**
* The name of the Amazon S3 bucket.
*/
OutputS3BucketName?: S3BucketName;
/**
* The Amazon S3 bucket subfolder.
*/
OutputS3KeyPrefix?: S3KeyPrefix;
/**
* The parameters for the RUN_COMMAND task execution.
*/
Parameters?: Parameters;
/**
* The ARN of the IAM service role to use to publish Amazon Simple Notification Service (Amazon SNS) notifications for maintenance window Run Command tasks.
*/
ServiceRoleArn?: ServiceRole;
/**
* If this time is reached and the command has not already started running, it doesn't run.
*/
TimeoutSeconds?: TimeoutSeconds;
}
export type MaintenanceWindowSchedule = string;
export type MaintenanceWindowSearchMaxResults = number;
export type MaintenanceWindowStepFunctionsInput = string;
export type MaintenanceWindowStepFunctionsName = string;
export interface MaintenanceWindowStepFunctionsParameters {
/**
* The inputs for the STEP_FUNCTIONS task.
*/
Input?: MaintenanceWindowStepFunctionsInput;
/**
* The name of the STEP_FUNCTIONS task.
*/
Name?: MaintenanceWindowStepFunctionsName;
}
export type MaintenanceWindowStringDateTime = string;
export interface MaintenanceWindowTarget {
/**
* The ID of the maintenance window to register the target with.
*/
WindowId?: MaintenanceWindowId;
/**
* The ID of the target.
*/
WindowTargetId?: MaintenanceWindowTargetId;
/**
* The type of target that is being registered with the maintenance window.
*/
ResourceType?: MaintenanceWindowResourceType;
/**
* The targets, either instances or tags. Specify instances using the following format: Key=instanceids,Values=<instanceid1>,<instanceid2> Tags are specified using the following format: Key=<tag name>,Values=<tag value>.
*/
Targets?: Targets;
/**
* A user-provided value that will be included in any CloudWatch events that are raised while running tasks for these targets in this maintenance window.
*/
OwnerInformation?: OwnerInformation;
/**
* The name for the maintenance window target.
*/
Name?: MaintenanceWindowName;
/**
* A description for the target.
*/
Description?: MaintenanceWindowDescription;
}
export type MaintenanceWindowTargetId = string;
export type MaintenanceWindowTargetList = MaintenanceWindowTarget[];
export interface MaintenanceWindowTask {
/**
* The ID of the maintenance window where the task is registered.
*/
WindowId?: MaintenanceWindowId;
/**
* The task ID.
*/
WindowTaskId?: MaintenanceWindowTaskId;
/**
* The resource that the task uses during execution. For RUN_COMMAND and AUTOMATION task types, TaskArn is the Systems Manager document name or ARN. For LAMBDA tasks, it's the function name or ARN. For STEP_FUNCTIONS tasks, it's the state machine ARN.
*/
TaskArn?: MaintenanceWindowTaskArn;
/**
* The type of task. The type can be one of the following: RUN_COMMAND, AUTOMATION, LAMBDA, or STEP_FUNCTIONS.
*/
Type?: MaintenanceWindowTaskType;
/**
* The targets (either instances or tags). Instances are specified using Key=instanceids,Values=<instanceid1>,<instanceid2>. Tags are specified using Key=<tag name>,Values=<tag value>.
*/
Targets?: Targets;
/**
* The parameters that should be passed to the task when it is run. TaskParameters has been deprecated. To specify parameters to pass to a task when it runs, instead use the Parameters option in the TaskInvocationParameters structure. For information about how Systems Manager handles these options for the supported maintenance window task types, see MaintenanceWindowTaskInvocationParameters.
*/
TaskParameters?: MaintenanceWindowTaskParameters;
/**
* The priority of the task in the maintenance window. The lower the number, the higher the priority. Tasks that have the same priority are scheduled in parallel.
*/
Priority?: MaintenanceWindowTaskPriority;
/**
* Information about an Amazon S3 bucket to write task-level logs to. LoggingInfo has been deprecated. To specify an S3 bucket to contain logs, instead use the OutputS3BucketName and OutputS3KeyPrefix options in the TaskInvocationParameters structure. For information about how Systems Manager handles these options for the supported maintenance window task types, see MaintenanceWindowTaskInvocationParameters.
*/
LoggingInfo?: LoggingInfo;
/**
* The ARN of the IAM service role to use to publish Amazon Simple Notification Service (Amazon SNS) notifications for maintenance window Run Command tasks.
*/
ServiceRoleArn?: ServiceRole;
/**
* The maximum number of targets this task can be run for, in parallel.
*/
MaxConcurrency?: MaxConcurrency;
/**
* The maximum number of errors allowed before this task stops being scheduled.
*/
MaxErrors?: MaxErrors;
/**
* The task name.
*/
Name?: MaintenanceWindowName;
/**
* A description of the task.
*/
Description?: MaintenanceWindowDescription;
}
export type MaintenanceWindowTaskArn = string;
export type MaintenanceWindowTaskId = string;
export interface MaintenanceWindowTaskInvocationParameters {
/**
* The parameters for a RUN_COMMAND task type.
*/
RunCommand?: MaintenanceWindowRunCommandParameters;
/**
* The parameters for an AUTOMATION task type.
*/
Automation?: MaintenanceWindowAutomationParameters;
/**
* The parameters for a STEP_FUNCTIONS task type.
*/
StepFunctions?: MaintenanceWindowStepFunctionsParameters;
/**
* The parameters for a LAMBDA task type.
*/
Lambda?: MaintenanceWindowLambdaParameters;
}
export type MaintenanceWindowTaskList = MaintenanceWindowTask[];
export type MaintenanceWindowTaskParameterName = string;
export type MaintenanceWindowTaskParameterValue = string;
export interface MaintenanceWindowTaskParameterValueExpression {
/**
* This field contains an array of 0 or more strings, each 1 to 255 characters in length.
*/
Values?: MaintenanceWindowTaskParameterValueList;
}
export type MaintenanceWindowTaskParameterValueList = MaintenanceWindowTaskParameterValue[];
export type MaintenanceWindowTaskParameters = {[key: string]: MaintenanceWindowTaskParameterValueExpression};
export type MaintenanceWindowTaskParametersList = MaintenanceWindowTaskParameters[];
export type MaintenanceWindowTaskPriority = number;
export type MaintenanceWindowTaskTargetId = string;
export type MaintenanceWindowTaskType = "RUN_COMMAND"|"AUTOMATION"|"STEP_FUNCTIONS"|"LAMBDA"|string;
export type MaintenanceWindowTimezone = string;
export type MaintenanceWindowsForTargetList = MaintenanceWindowIdentityForTarget[];
export type ManagedInstanceId = string;
export type MaxConcurrency = string;
export type MaxErrors = string;
export type MaxResults = number;
export type MaxResultsEC2Compatible = number;
export interface ModifyDocumentPermissionRequest {
/**
* The name of the document that you want to share.
*/
Name: DocumentName;
/**
* The permission type for the document. The permission type can be Share.
*/
PermissionType: DocumentPermissionType;
/**
* The AWS user accounts that should have access to the document. The account IDs can either be a group of account IDs or All.
*/
AccountIdsToAdd?: AccountIdList;
/**
* The AWS user accounts that should no longer have access to the document. The AWS user account can either be a group of account IDs or All. This action has a higher priority than AccountIdsToAdd. If you specify an account ID to add and the same ID to remove, the system removes access to the document.
*/
AccountIdsToRemove?: AccountIdList;
/**
* (Optional) The version of the document to share. If it's not specified, the system choose the Default version to share.
*/
SharedDocumentVersion?: SharedDocumentVersion;
}
export interface ModifyDocumentPermissionResponse {
}
export type NextToken = string;
export interface NonCompliantSummary {
/**
* The total number of compliance items that are not compliant.
*/
NonCompliantCount?: ComplianceSummaryCount;
/**
* A summary of the non-compliance severity by compliance type
*/
SeveritySummary?: SeveritySummary;
}
export type NormalStringMap = {[key: string]: String};
export type NotificationArn = string;
export interface NotificationConfig {
/**
* An Amazon Resource Name (ARN) for an Amazon Simple Notification Service (Amazon SNS) topic. Run Command pushes notifications about command status changes to this topic.
*/
NotificationArn?: NotificationArn;
/**
* The different events for which you can receive notifications. These events include the following: All (events), InProgress, Success, TimedOut, Cancelled, Failed. To learn more about these events, see Configuring Amazon SNS Notifications for AWS Systems Manager in the AWS Systems Manager User Guide.
*/
NotificationEvents?: NotificationEventList;
/**
* Command: Receive notification when the status of a command changes. Invocation: For commands sent to multiple instances, receive notification on a per-instance basis when the status of a command changes.
*/
NotificationType?: NotificationType;
}
export type NotificationEvent = "All"|"InProgress"|"Success"|"TimedOut"|"Cancelled"|"Failed"|string;
export type NotificationEventList = NotificationEvent[];
export type NotificationType = "Command"|"Invocation"|string;
export type OperatingSystem = "WINDOWS"|"AMAZON_LINUX"|"AMAZON_LINUX_2"|"UBUNTU"|"REDHAT_ENTERPRISE_LINUX"|"SUSE"|"CENTOS"|string;
export interface OpsAggregator {
/**
* Either a Range or Count aggregator for limiting an OpsItem summary.
*/
AggregatorType?: OpsAggregatorType;
/**
* The data type name to use for viewing counts of OpsItems.
*/
TypeName?: OpsDataTypeName;
/**
* The name of an OpsItem attribute on which to limit the count of OpsItems.
*/
AttributeName?: OpsDataAttributeName;
/**
* The aggregator value.
*/
Values?: OpsAggregatorValueMap;
/**
* The aggregator filters.
*/
Filters?: OpsFilterList;
/**
* A nested aggregator for viewing counts of OpsItems.
*/
Aggregators?: OpsAggregatorList;
}
export type OpsAggregatorList = OpsAggregator[];
export type OpsAggregatorType = string;
export type OpsAggregatorValue = string;
export type OpsAggregatorValueKey = string;
export type OpsAggregatorValueMap = {[key: string]: OpsAggregatorValue};
export type OpsDataAttributeName = string;
export type OpsDataTypeName = string;
export interface OpsEntity {
/**
* The query ID.
*/
Id?: OpsEntityId;
/**
* The data returned by the query.
*/
Data?: OpsEntityItemMap;
}
export type OpsEntityId = string;
export interface OpsEntityItem {
/**
* The time OpsItem data was captured.
*/
CaptureTime?: OpsEntityItemCaptureTime;
/**
* The detailed data content for an OpsItem summaries result item.
*/
Content?: OpsEntityItemEntryList;
}
export type OpsEntityItemCaptureTime = string;
export type OpsEntityItemEntry = {[key: string]: AttributeValue};
export type OpsEntityItemEntryList = OpsEntityItemEntry[];
export type OpsEntityItemKey = string;
export type OpsEntityItemMap = {[key: string]: OpsEntityItem};
export type OpsEntityList = OpsEntity[];
export interface OpsFilter {
/**
* The name of the filter.
*/
Key: OpsFilterKey;
/**
* The filter value.
*/
Values: OpsFilterValueList;
/**
* The type of filter.
*/
Type?: OpsFilterOperatorType;
}
export type OpsFilterKey = string;
export type OpsFilterList = OpsFilter[];
export type OpsFilterOperatorType = "Equal"|"NotEqual"|"BeginWith"|"LessThan"|"GreaterThan"|"Exists"|string;
export type OpsFilterValue = string;
export type OpsFilterValueList = OpsFilterValue[];
export interface OpsItem {
/**
* The ARN of the AWS account that created the OpsItem.
*/
CreatedBy?: String;
/**
* The date and time the OpsItem was created.
*/
CreatedTime?: DateTime;
/**
* The OpsItem description.
*/
Description?: OpsItemDescription;
/**
* The ARN of the AWS account that last updated the OpsItem.
*/
LastModifiedBy?: String;
/**
* The date and time the OpsItem was last updated.
*/
LastModifiedTime?: DateTime;
/**
* The Amazon Resource Name (ARN) of an SNS topic where notifications are sent when this OpsItem is edited or changed.
*/
Notifications?: OpsItemNotifications;
/**
* The importance of this OpsItem in relation to other OpsItems in the system.
*/
Priority?: OpsItemPriority;
/**
* One or more OpsItems that share something in common with the current OpsItem. For example, related OpsItems can include OpsItems with similar error messages, impacted resources, or statuses for the impacted resource.
*/
RelatedOpsItems?: RelatedOpsItems;
/**
* The OpsItem status. Status can be Open, In Progress, or Resolved. For more information, see Editing OpsItem Details in the AWS Systems Manager User Guide.
*/
Status?: OpsItemStatus;
/**
* The ID of the OpsItem.
*/
OpsItemId?: OpsItemId;
/**
* The version of this OpsItem. Each time the OpsItem is edited the version number increments by one.
*/
Version?: String;
/**
* A short heading that describes the nature of the OpsItem and the impacted resource.
*/
Title?: OpsItemTitle;
/**
* The origin of the OpsItem, such as Amazon EC2 or AWS Systems Manager. The impacted resource is a subset of source.
*/
Source?: OpsItemSource;
/**
* Operational data is custom data that provides useful reference details about the OpsItem. For example, you can specify log files, error strings, license keys, troubleshooting tips, or other relevant data. You enter operational data as key-value pairs. The key has a maximum length of 128 characters. The value has a maximum size of 20 KB. Operational data keys can't begin with the following: amazon, aws, amzn, ssm, /amazon, /aws, /amzn, /ssm. You can choose to make the data searchable by other users in the account or you can restrict search access. Searchable data means that all users with access to the OpsItem Overview page (as provided by the DescribeOpsItems API action) can view and search on the specified data. Operational data that is not searchable is only viewable by users who have access to the OpsItem (as provided by the GetOpsItem API action). Use the /aws/resources key in OperationalData to specify a related resource in the request. Use the /aws/automations key in OperationalData to associate an Automation runbook with the OpsItem. To view AWS CLI example commands that use these keys, see Creating OpsItems Manually in the AWS Systems Manager User Guide.
*/
OperationalData?: OpsItemOperationalData;
/**
* An OpsItem category. Category options include: Availability, Cost, Performance, Recovery, Security.
*/
Category?: OpsItemCategory;
/**
* The severity of the OpsItem. Severity options range from 1 to 4.
*/
Severity?: OpsItemSeverity;
}
export type OpsItemCategory = string;
export type OpsItemDataKey = string;
export type OpsItemDataType = "SearchableString"|"String"|string;
export interface OpsItemDataValue {
/**
* The value of the OperationalData key.
*/
Value?: OpsItemDataValueString;
/**
* The type of key-value pair. Valid types include SearchableString and String.
*/
Type?: OpsItemDataType;
}
export type OpsItemDataValueString = string;
export type OpsItemDescription = string;
export interface OpsItemFilter {
/**
* The name of the filter.
*/
Key: OpsItemFilterKey;
/**
* The filter value.
*/
Values: OpsItemFilterValues;
/**
* The operator used by the filter call.
*/
Operator: OpsItemFilterOperator;
}
export type OpsItemFilterKey = "Status"|"CreatedBy"|"Source"|"Priority"|"Title"|"OpsItemId"|"CreatedTime"|"LastModifiedTime"|"OperationalData"|"OperationalDataKey"|"OperationalDataValue"|"ResourceId"|"AutomationId"|"Category"|"Severity"|string;
export type OpsItemFilterOperator = "Equal"|"Contains"|"GreaterThan"|"LessThan"|string;
export type OpsItemFilterValue = string;
export type OpsItemFilterValues = OpsItemFilterValue[];
export type OpsItemFilters = OpsItemFilter[];
export type OpsItemId = string;
export type OpsItemMaxResults = number;
export interface OpsItemNotification {
/**
* The Amazon Resource Name (ARN) of an SNS topic where notifications are sent when this OpsItem is edited or changed.
*/
Arn?: String;
}
export type OpsItemNotifications = OpsItemNotification[];
export type OpsItemOperationalData = {[key: string]: OpsItemDataValue};
export type OpsItemOpsDataKeysList = String[];
export type OpsItemPriority = number;
export type OpsItemSeverity = string;
export type OpsItemSource = string;
export type OpsItemStatus = "Open"|"InProgress"|"Resolved"|string;
export type OpsItemSummaries = OpsItemSummary[];
export interface OpsItemSummary {
/**
* The Amazon Resource Name (ARN) of the IAM entity that created the OpsItem.
*/
CreatedBy?: String;
/**
* The date and time the OpsItem was created.
*/
CreatedTime?: DateTime;
/**
* The Amazon Resource Name (ARN) of the IAM entity that created the OpsItem.
*/
LastModifiedBy?: String;
/**
* The date and time the OpsItem was last updated.
*/
LastModifiedTime?: DateTime;
/**
* The importance of this OpsItem in relation to other OpsItems in the system.
*/
Priority?: OpsItemPriority;
/**
* The impacted AWS resource.
*/
Source?: OpsItemSource;
/**
* The OpsItem status. Status can be Open, In Progress, or Resolved.
*/
Status?: OpsItemStatus;
/**
* The ID of the OpsItem.
*/
OpsItemId?: OpsItemId;
/**
* A short heading that describes the nature of the OpsItem and the impacted resource.
*/
Title?: OpsItemTitle;
/**
* Operational data is custom data that provides useful reference details about the OpsItem.
*/
OperationalData?: OpsItemOperationalData;
/**
* A list of OpsItems by category.
*/
Category?: OpsItemCategory;
/**
* A list of OpsItems by severity.
*/
Severity?: OpsItemSeverity;
}
export type OpsItemTitle = string;
export interface OpsResultAttribute {
/**
* Name of the data type. Valid value: AWS:OpsItem, AWS:EC2InstanceInformation, AWS:OpsItemTrendline, or AWS:ComplianceSummary.
*/
TypeName: OpsDataTypeName;
}
export type OpsResultAttributeList = OpsResultAttribute[];
export interface OutputSource {
/**
* The ID of the output source, for example the URL of an Amazon S3 bucket.
*/
OutputSourceId?: OutputSourceId;
/**
* The type of source where the association execution details are stored, for example, Amazon S3.
*/
OutputSourceType?: OutputSourceType;
}
export type OutputSourceId = string;
export type OutputSourceType = string;
export type OwnerInformation = string;
export type PSParameterName = string;
export type PSParameterSelector = string;
export type PSParameterValue = string;
export type PSParameterVersion = number;
export interface Parameter {
/**
* The name of the parameter.
*/
Name?: PSParameterName;
/**
* The type of parameter. Valid values include the following: String, String list, Secure string.
*/
Type?: ParameterType;
/**
* The parameter value.
*/
Value?: PSParameterValue;
/**
* The parameter version.
*/
Version?: PSParameterVersion;
/**
* Either the version number or the label used to retrieve the parameter value. Specify selectors by using one of the following formats: parameter_name:version parameter_name:label
*/
Selector?: PSParameterSelector;
/**
* Applies to parameters that reference information in other AWS services. SourceResult is the raw result or response from the source.
*/
SourceResult?: String;
/**
* Date the parameter was last changed or updated and the parameter version was created.
*/
LastModifiedDate?: DateTime;
/**
* The Amazon Resource Name (ARN) of the parameter.
*/
ARN?: String;
}
export type ParameterDescription = string;
export interface ParameterHistory {
/**
* The name of the parameter.
*/
Name?: PSParameterName;
/**
* The type of parameter used.
*/
Type?: ParameterType;
/**
* The ID of the query key used for this parameter.
*/
KeyId?: ParameterKeyId;
/**
* Date the parameter was last changed or updated.
*/
LastModifiedDate?: DateTime;
/**
* Amazon Resource Name (ARN) of the AWS user who last changed the parameter.
*/
LastModifiedUser?: String;
/**
* Information about the parameter.
*/
Description?: ParameterDescription;
/**
* The parameter value.
*/
Value?: PSParameterValue;
/**
* Parameter names can include the following letters and symbols. a-zA-Z0-9_.-
*/
AllowedPattern?: AllowedPattern;
/**
* The parameter version.
*/
Version?: PSParameterVersion;
/**
* Labels assigned to the parameter version.
*/
Labels?: ParameterLabelList;
/**
* The parameter tier.
*/
Tier?: ParameterTier;
/**
* Information about the policies assigned to a parameter. Working with Parameter Policies in the AWS Systems Manager User Guide.
*/
Policies?: ParameterPolicyList;
}
export type ParameterHistoryList = ParameterHistory[];
export interface ParameterInlinePolicy {
/**
* The JSON text of the policy.
*/
PolicyText?: String;
/**
* The type of policy. Parameter Store supports the following policy types: Expiration, ExpirationNotification, and NoChangeNotification.
*/
PolicyType?: String;
/**
* The status of the policy. Policies report the following statuses: Pending (the policy has not been enforced or applied yet), Finished (the policy was applied), Failed (the policy was not applied), or InProgress (the policy is being applied now).
*/
PolicyStatus?: String;
}
export type ParameterKeyId = string;
export type ParameterLabel = string;
export type ParameterLabelList = ParameterLabel[];
export type ParameterList = Parameter[];
export interface ParameterMetadata {
/**
* The parameter name.
*/
Name?: PSParameterName;
/**
* The type of parameter. Valid parameter types include the following: String, String list, Secure string.
*/
Type?: ParameterType;
/**
* The ID of the query key used for this parameter.
*/
KeyId?: ParameterKeyId;
/**
* Date the parameter was last changed or updated.
*/
LastModifiedDate?: DateTime;
/**
* Amazon Resource Name (ARN) of the AWS user who last changed the parameter.
*/
LastModifiedUser?: String;
/**
* Description of the parameter actions.
*/
Description?: ParameterDescription;
/**
* A parameter name can include only the following letters and symbols. a-zA-Z0-9_.-
*/
AllowedPattern?: AllowedPattern;
/**
* The parameter version.
*/
Version?: PSParameterVersion;
/**
* The parameter tier.
*/
Tier?: ParameterTier;
/**
* A list of policies associated with a parameter.
*/
Policies?: ParameterPolicyList;
}
export type ParameterMetadataList = ParameterMetadata[];
export type ParameterName = string;
export type ParameterNameList = PSParameterName[];
export type ParameterPolicies = string;
export type ParameterPolicyList = ParameterInlinePolicy[];
export interface ParameterStringFilter {
/**
* The name of the filter.
*/
Key: ParameterStringFilterKey;
/**
* For all filters used with DescribeParameters, valid options include Equals and BeginsWith. The Name filter additionally supports the Contains option. (Exception: For filters using the key Path, valid options include Recursive and OneLevel.) For filters used with GetParametersByPath, valid options include Equals and BeginsWith. (Exception: For filters using the key Label, the only valid option is Equals.)
*/
Option?: ParameterStringQueryOption;
/**
* The value you want to search for.
*/
Values?: ParameterStringFilterValueList;
}
export type ParameterStringFilterKey = string;
export type ParameterStringFilterList = ParameterStringFilter[];
export type ParameterStringFilterValue = string;
export type ParameterStringFilterValueList = ParameterStringFilterValue[];
export type ParameterStringQueryOption = string;
export type ParameterTier = "Standard"|"Advanced"|"Intelligent-Tiering"|string;
export type ParameterType = "String"|"StringList"|"SecureString"|string;
export type ParameterValue = string;
export type ParameterValueList = ParameterValue[];
export type Parameters = {[key: string]: ParameterValueList};
export interface ParametersFilter {
/**
* The name of the filter.
*/
Key: ParametersFilterKey;
/**
* The filter values.
*/
Values: ParametersFilterValueList;
}
export type ParametersFilterKey = "Name"|"Type"|"KeyId"|string;
export type ParametersFilterList = ParametersFilter[];
export type ParametersFilterValue = string;
export type ParametersFilterValueList = ParametersFilterValue[];
export interface Patch {
/**
* The ID of the patch (this is different than the Microsoft Knowledge Base ID).
*/
Id?: PatchId;
/**
* The date the patch was released.
*/
ReleaseDate?: DateTime;
/**
* The title of the patch.
*/
Title?: PatchTitle;
/**
* The description of the patch.
*/
Description?: PatchDescription;
/**
* The URL where more information can be obtained about the patch.
*/
ContentUrl?: PatchContentUrl;
/**
* The name of the vendor providing the patch.
*/
Vendor?: PatchVendor;
/**
* The product family the patch is applicable for (for example, Windows).
*/
ProductFamily?: PatchProductFamily;
/**
* The specific product the patch is applicable for (for example, WindowsServer2016).
*/
Product?: PatchProduct;
/**
* The classification of the patch (for example, SecurityUpdates, Updates, CriticalUpdates).
*/
Classification?: PatchClassification;
/**
* The severity of the patch (for example Critical, Important, Moderate).
*/
MsrcSeverity?: PatchMsrcSeverity;
/**
* The Microsoft Knowledge Base ID of the patch.
*/
KbNumber?: PatchKbNumber;
/**
* The ID of the MSRC bulletin the patch is related to.
*/
MsrcNumber?: PatchMsrcNumber;
/**
* The language of the patch if it's language-specific.
*/
Language?: PatchLanguage;
}
export type PatchAction = "ALLOW_AS_DEPENDENCY"|"BLOCK"|string;
export interface PatchBaselineIdentity {
/**
* The ID of the patch baseline.
*/
BaselineId?: BaselineId;
/**
* The name of the patch baseline.
*/
BaselineName?: BaselineName;
/**
* Defines the operating system the patch baseline applies to. The Default value is WINDOWS.
*/
OperatingSystem?: OperatingSystem;
/**
* The description of the patch baseline.
*/
BaselineDescription?: BaselineDescription;
/**
* Whether this is the default baseline. Note that Systems Manager supports creating multiple default patch baselines. For example, you can create a default patch baseline for each operating system.
*/
DefaultBaseline?: DefaultBaseline;
}
export type PatchBaselineIdentityList = PatchBaselineIdentity[];
export type PatchBaselineMaxResults = number;
export type PatchClassification = string;
export interface PatchComplianceData {
/**
* The title of the patch.
*/
Title: PatchTitle;
/**
* The operating system-specific ID of the patch.
*/
KBId: PatchKbNumber;
/**
* The classification of the patch (for example, SecurityUpdates, Updates, CriticalUpdates).
*/
Classification: PatchClassification;
/**
* The severity of the patch (for example, Critical, Important, Moderate).
*/
Severity: PatchSeverity;
/**
* The state of the patch on the instance, such as INSTALLED or FAILED. For descriptions of each patch state, see About Patch Compliance in the AWS Systems Manager User Guide.
*/
State: PatchComplianceDataState;
/**
* The date/time the patch was installed on the instance. Note that not all operating systems provide this level of information.
*/
InstalledTime: DateTime;
}
export type PatchComplianceDataList = PatchComplianceData[];
export type PatchComplianceDataState = "INSTALLED"|"INSTALLED_OTHER"|"INSTALLED_PENDING_REBOOT"|"INSTALLED_REJECTED"|"MISSING"|"NOT_APPLICABLE"|"FAILED"|string;
export type PatchComplianceLevel = "CRITICAL"|"HIGH"|"MEDIUM"|"LOW"|"INFORMATIONAL"|"UNSPECIFIED"|string;
export type PatchComplianceMaxResults = number;
export type PatchContentUrl = string;
export type PatchDeploymentStatus = "APPROVED"|"PENDING_APPROVAL"|"EXPLICIT_APPROVED"|"EXPLICIT_REJECTED"|string;
export type PatchDescription = string;
export type PatchFailedCount = number;
export interface PatchFilter {
/**
* The key for the filter. Run the DescribePatchProperties command to view lists of valid keys for each operating system type.
*/
Key: PatchFilterKey;
/**
* The value for the filter key. Run the DescribePatchProperties command to view lists of valid values for each key based on operating system type.
*/
Values: PatchFilterValueList;
}
export interface PatchFilterGroup {
/**
* The set of patch filters that make up the group.
*/
PatchFilters: PatchFilterList;
}
export type PatchFilterKey = "PATCH_SET"|"PRODUCT"|"PRODUCT_FAMILY"|"CLASSIFICATION"|"MSRC_SEVERITY"|"PATCH_ID"|"SECTION"|"PRIORITY"|"SEVERITY"|string;
export type PatchFilterList = PatchFilter[];
export type PatchFilterValue = string;
export type PatchFilterValueList = PatchFilterValue[];
export type PatchGroup = string;
export type PatchGroupList = PatchGroup[];
export interface PatchGroupPatchBaselineMapping {
/**
* The name of the patch group registered with the patch baseline.
*/
PatchGroup?: PatchGroup;
/**
* The patch baseline the patch group is registered with.
*/
BaselineIdentity?: PatchBaselineIdentity;
}
export type PatchGroupPatchBaselineMappingList = PatchGroupPatchBaselineMapping[];
export type PatchId = string;
export type PatchIdList = PatchId[];
export type PatchInstalledCount = number;
export type PatchInstalledOtherCount = number;
export type PatchInstalledPendingRebootCount = number;
export type PatchInstalledRejectedCount = number;
export type PatchKbNumber = string;
export type PatchLanguage = string;
export type PatchList = Patch[];
export type PatchMissingCount = number;
export type PatchMsrcNumber = string;
export type PatchMsrcSeverity = string;
export type PatchNotApplicableCount = number;
export type PatchOperationType = "Scan"|"Install"|string;
export interface PatchOrchestratorFilter {
/**
* The key for the filter.
*/
Key?: PatchOrchestratorFilterKey;
/**
* The value for the filter.
*/
Values?: PatchOrchestratorFilterValues;
}
export type PatchOrchestratorFilterKey = string;
export type PatchOrchestratorFilterList = PatchOrchestratorFilter[];
export type PatchOrchestratorFilterValue = string;
export type PatchOrchestratorFilterValues = PatchOrchestratorFilterValue[];
export type PatchProduct = string;
export type PatchProductFamily = string;
export type PatchPropertiesList = PatchPropertyEntry[];
export type PatchProperty = "PRODUCT"|"PRODUCT_FAMILY"|"CLASSIFICATION"|"MSRC_SEVERITY"|"PRIORITY"|"SEVERITY"|string;
export type PatchPropertyEntry = {[key: string]: AttributeValue};
export interface PatchRule {
/**
* The patch filter group that defines the criteria for the rule.
*/
PatchFilterGroup: PatchFilterGroup;
/**
* A compliance severity level for all approved patches in a patch baseline. Valid compliance severity levels include the following: Unspecified, Critical, High, Medium, Low, and Informational.
*/
ComplianceLevel?: PatchComplianceLevel;
/**
* The number of days after the release date of each patch matched by the rule that the patch is marked as approved in the patch baseline. For example, a value of 7 means that patches are approved seven days after they are released.
*/
ApproveAfterDays: ApproveAfterDays;
/**
* For instances identified by the approval rule filters, enables a patch baseline to apply non-security updates available in the specified repository. The default value is 'false'. Applies to Linux instances only.
*/
EnableNonSecurity?: Boolean;
}
export interface PatchRuleGroup {
/**
* The rules that make up the rule group.
*/
PatchRules: PatchRuleList;
}
export type PatchRuleList = PatchRule[];
export type PatchSet = "OS"|"APPLICATION"|string;
export type PatchSeverity = string;
export interface PatchSource {
/**
* The name specified to identify the patch source.
*/
Name: PatchSourceName;
/**
* The specific operating system versions a patch repository applies to, such as "Ubuntu16.04", "AmazonLinux2016.09", "RedhatEnterpriseLinux7.2" or "Suse12.7". For lists of supported product values, see PatchFilter.
*/
Products: PatchSourceProductList;
/**
* The value of the yum repo configuration. For example: [main] cachedir=/var/cache/yum/$basesearch$releasever keepcache=0 debuglevel=2
*/
Configuration: PatchSourceConfiguration;
}
export type PatchSourceConfiguration = string;
export type PatchSourceList = PatchSource[];
export type PatchSourceName = string;
export type PatchSourceProduct = string;
export type PatchSourceProductList = PatchSourceProduct[];
export interface PatchStatus {
/**
* The approval status of a patch (APPROVED, PENDING_APPROVAL, EXPLICIT_APPROVED, EXPLICIT_REJECTED).
*/
DeploymentStatus?: PatchDeploymentStatus;
/**
* The compliance severity level for a patch.
*/
ComplianceLevel?: PatchComplianceLevel;
/**
* The date the patch was approved (or will be approved if the status is PENDING_APPROVAL).
*/
ApprovalDate?: DateTime;
}
export type PatchTitle = string;
export type PatchUnreportedNotApplicableCount = number;
export type PatchVendor = string;
export type PingStatus = "Online"|"ConnectionLost"|"Inactive"|string;
export type PlatformType = "Windows"|"Linux"|string;
export type PlatformTypeList = PlatformType[];
export type Product = string;
export interface ProgressCounters {
/**
* The total number of steps run in all specified AWS Regions and accounts for the current Automation execution.
*/
TotalSteps?: Integer;
/**
* The total number of steps that successfully completed in all specified AWS Regions and accounts for the current Automation execution.
*/
SuccessSteps?: Integer;
/**
* The total number of steps that failed to run in all specified AWS Regions and accounts for the current Automation execution.
*/
FailedSteps?: Integer;
/**
* The total number of steps that the system cancelled in all specified AWS Regions and accounts for the current Automation execution.
*/
CancelledSteps?: Integer;
/**
* The total number of steps that timed out in all specified AWS Regions and accounts for the current Automation execution.
*/
TimedOutSteps?: Integer;
}
export interface PutComplianceItemsRequest {
/**
* Specify an ID for this resource. For a managed instance, this is the instance ID.
*/
ResourceId: ComplianceResourceId;
/**
* Specify the type of resource. ManagedInstance is currently the only supported resource type.
*/
ResourceType: ComplianceResourceType;
/**
* Specify the compliance type. For example, specify Association (for a State Manager association), Patch, or Custom:string.
*/
ComplianceType: ComplianceTypeName;
/**
* A summary of the call execution that includes an execution ID, the type of execution (for example, Command), and the date/time of the execution using a datetime object that is saved in the following format: yyyy-MM-dd'T'HH:mm:ss'Z'.
*/
ExecutionSummary: ComplianceExecutionSummary;
/**
* Information about the compliance as defined by the resource type. For example, for a patch compliance type, Items includes information about the PatchSeverity, Classification, etc.
*/
Items: ComplianceItemEntryList;
/**
* MD5 or SHA-256 content hash. The content hash is used to determine if existing information should be overwritten or ignored. If the content hashes match, the request to put compliance information is ignored.
*/
ItemContentHash?: ComplianceItemContentHash;
}
export interface PutComplianceItemsResult {
}
export type PutInventoryMessage = string;
export interface PutInventoryRequest {
/**
* An instance ID where you want to add or update inventory items.
*/
InstanceId: InstanceId;
/**
* The inventory items that you want to add or update on instances.
*/
Items: InventoryItemList;
}
export interface PutInventoryResult {
/**
* Information about the request.
*/
Message?: PutInventoryMessage;
}
export interface PutParameterRequest {
/**
* The fully qualified name of the parameter that you want to add to the system. The fully qualified name includes the complete hierarchy of the parameter path and name. For example: /Dev/DBServer/MySQL/db-string13 Naming Constraints: Parameter names are case sensitive. A parameter name must be unique within an AWS Region A parameter name can't be prefixed with "aws" or "ssm" (case-insensitive). Parameter names can include only the following symbols and letters: a-zA-Z0-9_.-/ A parameter name can't include spaces. Parameter hierarchies are limited to a maximum depth of fifteen levels. For additional information about valid values for parameter names, see Requirements and Constraints for Parameter Names in the AWS Systems Manager User Guide. The maximum length constraint listed below includes capacity for additional system attributes that are not part of the name. The maximum length for the fully qualified parameter name is 1011 characters, including the full length of the parameter ARN. For example, the following fully qualified parameter name is 65 characters, not 20 characters: arn:aws:ssm:us-east-2:111122223333:parameter/ExampleParameterName
*/
Name: PSParameterName;
/**
* Information about the parameter that you want to add to the system. Optional but recommended. Do not enter personally identifiable information in this field.
*/
Description?: ParameterDescription;
/**
* The parameter value that you want to add to the system. Standard parameters have a value limit of 4 KB. Advanced parameters have a value limit of 8 KB.
*/
Value: PSParameterValue;
/**
* The type of parameter that you want to add to the system. Items in a StringList must be separated by a comma (,). You can't use other punctuation or special character to escape items in the list. If you have a parameter value that requires a comma, then use the String data type. SecureString is not currently supported for AWS CloudFormation templates or in the China Regions.
*/
Type: ParameterType;
/**
* The KMS Key ID that you want to use to encrypt a parameter. Either the default AWS Key Management Service (AWS KMS) key automatically assigned to your AWS account or a custom key. Required for parameters that use the SecureString data type. If you don't specify a key ID, the system uses the default key associated with your AWS account. To use your default AWS KMS key, choose the SecureString data type, and do not specify the Key ID when you create the parameter. The system automatically populates Key ID with your default KMS key. To use a custom KMS key, choose the SecureString data type with the Key ID parameter.
*/
KeyId?: ParameterKeyId;
/**
* Overwrite an existing parameter. If not specified, will default to "false".
*/
Overwrite?: Boolean;
/**
* A regular expression used to validate the parameter value. For example, for String types with values restricted to numbers, you can specify the following: AllowedPattern=^\d+$
*/
AllowedPattern?: AllowedPattern;
/**
* Optional metadata that you assign to a resource. Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For example, you might want to tag a Systems Manager parameter to identify the type of resource to which it applies, the environment, or the type of configuration data referenced by the parameter. In this case, you could specify the following key name/value pairs: Key=Resource,Value=S3bucket Key=OS,Value=Windows Key=ParameterType,Value=LicenseKey To add tags to an existing Systems Manager parameter, use the AddTagsToResource action.
*/
Tags?: TagList;
/**
* The parameter tier to assign to a parameter. Parameter Store offers a standard tier and an advanced tier for parameters. Standard parameters have a content size limit of 4 KB and can't be configured to use parameter policies. You can create a maximum of 10,000 standard parameters for each Region in an AWS account. Standard parameters are offered at no additional cost. Advanced parameters have a content size limit of 8 KB and can be configured to use parameter policies. You can create a maximum of 100,000 advanced parameters for each Region in an AWS account. Advanced parameters incur a charge. For more information, see About Advanced Parameters in the AWS Systems Manager User Guide. You can change a standard parameter to an advanced parameter any time. But you can't revert an advanced parameter to a standard parameter. Reverting an advanced parameter to a standard parameter would result in data loss because the system would truncate the size of the parameter from 8 KB to 4 KB. Reverting would also remove any policies attached to the parameter. Lastly, advanced parameters use a different form of encryption than standard parameters. If you no longer need an advanced parameter, or if you no longer want to incur charges for an advanced parameter, you must delete it and recreate it as a new standard parameter. Using the Default Tier Configuration In PutParameter requests, you can specify the tier to create the parameter in. Whenever you specify a tier in the request, Parameter Store creates or updates the parameter according to that request. However, if you do not specify a tier in a request, Parameter Store assigns the tier based on the current Parameter Store default tier configuration. The default tier when you begin using Parameter Store is the standard-parameter tier. If you use the advanced-parameter tier, you can specify one of the following as the default: Advanced: With this option, Parameter Store evaluates all requests as advanced parameters. Intelligent-Tiering: With this option, Parameter Store evaluates each request to determine if the parameter is standard or advanced. If the request doesn't include any options that require an advanced parameter, the parameter is created in the standard-parameter tier. If one or more options requiring an advanced parameter are included in the request, Parameter Store create a parameter in the advanced-parameter tier. This approach helps control your parameter-related costs by always creating standard parameters unless an advanced parameter is necessary. Options that require an advanced parameter include the following: The content size of the parameter is more than 4 KB. The parameter uses a parameter policy. More than 10,000 parameters already exist in your AWS account in the current Region. For more information about configuring the default tier option, see Specifying a Default Parameter Tier in the AWS Systems Manager User Guide.
*/
Tier?: ParameterTier;
/**
* One or more policies to apply to a parameter. This action takes a JSON array. Parameter Store supports the following policy types: Expiration: This policy deletes the parameter after it expires. When you create the policy, you specify the expiration date. You can update the expiration date and time by updating the policy. Updating the parameter does not affect the expiration date and time. When the expiration time is reached, Parameter Store deletes the parameter. ExpirationNotification: This policy triggers an event in Amazon CloudWatch Events that notifies you about the expiration. By using this policy, you can receive notification before or after the expiration time is reached, in units of days or hours. NoChangeNotification: This policy triggers a CloudWatch event if a parameter has not been modified for a specified period of time. This policy type is useful when, for example, a secret needs to be changed within a period of time, but it has not been changed. All existing policies are preserved until you send new policies or an empty policy. For more information about parameter policies, see Working with Parameter Policies.
*/
Policies?: ParameterPolicies;
}
export interface PutParameterResult {
/**
* The new version number of a parameter. If you edit a parameter value, Parameter Store automatically creates a new version and assigns this new version a unique ID. You can reference a parameter version ID in API actions or in Systems Manager documents (SSM documents). By default, if you don't specify a specific version, the system returns the latest parameter value when a parameter is called.
*/
Version?: PSParameterVersion;
/**
* The tier assigned to the parameter.
*/
Tier?: ParameterTier;
}
export type RebootOption = "RebootIfNeeded"|"NoReboot"|string;
export type Region = string;
export type Regions = Region[];
export interface RegisterDefaultPatchBaselineRequest {
/**
* The ID of the patch baseline that should be the default patch baseline.
*/
BaselineId: BaselineId;
}
export interface RegisterDefaultPatchBaselineResult {
/**
* The ID of the default patch baseline.
*/
BaselineId?: BaselineId;
}
export interface RegisterPatchBaselineForPatchGroupRequest {
/**
* The ID of the patch baseline to register the patch group with.
*/
BaselineId: BaselineId;
/**
* The name of the patch group that should be registered with the patch baseline.
*/
PatchGroup: PatchGroup;
}
export interface RegisterPatchBaselineForPatchGroupResult {
/**
* The ID of the patch baseline the patch group was registered with.
*/
BaselineId?: BaselineId;
/**
* The name of the patch group registered with the patch baseline.
*/
PatchGroup?: PatchGroup;
}
export interface RegisterTargetWithMaintenanceWindowRequest {
/**
* The ID of the maintenance window the target should be registered with.
*/
WindowId: MaintenanceWindowId;
/**
* The type of target being registered with the maintenance window.
*/
ResourceType: MaintenanceWindowResourceType;
/**
* The targets to register with the maintenance window. In other words, the instances to run commands on when the maintenance window runs. You can specify targets using instance IDs, resource group names, or tags that have been applied to instances. Example 1: Specify instance IDs Key=InstanceIds,Values=instance-id-1,instance-id-2,instance-id-3 Example 2: Use tag key-pairs applied to instances Key=tag:my-tag-key,Values=my-tag-value-1,my-tag-value-2 Example 3: Use tag-keys applied to instances Key=tag-key,Values=my-tag-key-1,my-tag-key-2 Example 4: Use resource group names Key=resource-groups:Name,Values=resource-group-name Example 5: Use filters for resource group types Key=resource-groups:ResourceTypeFilters,Values=resource-type-1,resource-type-2 For Key=resource-groups:ResourceTypeFilters, specify resource types in the following format Key=resource-groups:ResourceTypeFilters,Values=AWS::EC2::INSTANCE,AWS::EC2::VPC For more information about these examples formats, including the best use case for each one, see Examples: Register Targets with a Maintenance Window in the AWS Systems Manager User Guide.
*/
Targets: Targets;
/**
* User-provided value that will be included in any CloudWatch events raised while running tasks for these targets in this maintenance window.
*/
OwnerInformation?: OwnerInformation;
/**
* An optional name for the target.
*/
Name?: MaintenanceWindowName;
/**
* An optional description for the target.
*/
Description?: MaintenanceWindowDescription;
/**
* User-provided idempotency token.
*/
ClientToken?: ClientToken;
}
export interface RegisterTargetWithMaintenanceWindowResult {
/**
* The ID of the target definition in this maintenance window.
*/
WindowTargetId?: MaintenanceWindowTargetId;
}
export interface RegisterTaskWithMaintenanceWindowRequest {
/**
* The ID of the maintenance window the task should be added to.
*/
WindowId: MaintenanceWindowId;
/**
* The targets (either instances or maintenance window targets). Specify instances using the following format: Key=InstanceIds,Values=<instance-id-1>,<instance-id-2> Specify maintenance window targets using the following format: Key=WindowTargetIds;,Values=<window-target-id-1>,<window-target-id-2>
*/
Targets: Targets;
/**
* The ARN of the task to run.
*/
TaskArn: MaintenanceWindowTaskArn;
/**
* The ARN of the IAM service role for Systems Manager to assume when running a maintenance window task. If you do not specify a service role ARN, Systems Manager uses your account's service-linked role. If no service-linked role for Systems Manager exists in your account, it is created when you run RegisterTaskWithMaintenanceWindow. For more information, see the following topics in the in the AWS Systems Manager User Guide: Service-Linked Role Permissions for Systems Manager Should I Use a Service-Linked Role or a Custom Service Role to Run Maintenance Window Tasks?
*/
ServiceRoleArn?: ServiceRole;
/**
* The type of task being registered.
*/
TaskType: MaintenanceWindowTaskType;
/**
* The parameters that should be passed to the task when it is run. TaskParameters has been deprecated. To specify parameters to pass to a task when it runs, instead use the Parameters option in the TaskInvocationParameters structure. For information about how Systems Manager handles these options for the supported maintenance window task types, see MaintenanceWindowTaskInvocationParameters.
*/
TaskParameters?: MaintenanceWindowTaskParameters;
/**
* The parameters that the task should use during execution. Populate only the fields that match the task type. All other fields should be empty.
*/
TaskInvocationParameters?: MaintenanceWindowTaskInvocationParameters;
/**
* The priority of the task in the maintenance window, the lower the number the higher the priority. Tasks in a maintenance window are scheduled in priority order with tasks that have the same priority scheduled in parallel.
*/
Priority?: MaintenanceWindowTaskPriority;
/**
* The maximum number of targets this task can be run for in parallel.
*/
MaxConcurrency: MaxConcurrency;
/**
* The maximum number of errors allowed before this task stops being scheduled.
*/
MaxErrors: MaxErrors;
/**
* A structure containing information about an Amazon S3 bucket to write instance-level logs to. LoggingInfo has been deprecated. To specify an S3 bucket to contain logs, instead use the OutputS3BucketName and OutputS3KeyPrefix options in the TaskInvocationParameters structure. For information about how Systems Manager handles these options for the supported maintenance window task types, see MaintenanceWindowTaskInvocationParameters.
*/
LoggingInfo?: LoggingInfo;
/**
* An optional name for the task.
*/
Name?: MaintenanceWindowName;
/**
* An optional description for the task.
*/
Description?: MaintenanceWindowDescription;
/**
* User-provided idempotency token.
*/
ClientToken?: ClientToken;
}
export interface RegisterTaskWithMaintenanceWindowResult {
/**
* The ID of the task in the maintenance window.
*/
WindowTaskId?: MaintenanceWindowTaskId;
}
export type RegistrationLimit = number;
export type RegistrationsCount = number;
export interface RelatedOpsItem {
/**
* The ID of an OpsItem related to the current OpsItem.
*/
OpsItemId: String;
}
export type RelatedOpsItems = RelatedOpsItem[];
export type RemainingCount = number;
export interface RemoveTagsFromResourceRequest {
/**
* The type of resource from which you want to remove a tag. The ManagedInstance type for this API action is only for on-premises managed instances. Specify the name of the managed instance in the following format: mi-ID_number. For example, mi-1a2b3c4d5e6f.
*/
ResourceType: ResourceTypeForTagging;
/**
* The ID of the resource from which you want to remove tags. For example: ManagedInstance: mi-012345abcde MaintenanceWindow: mw-012345abcde PatchBaseline: pb-012345abcde For the Document and Parameter values, use the name of the resource. The ManagedInstance type for this API action is only for on-premises managed instances. Specify the name of the managed instance in the following format: mi-ID_number. For example, mi-1a2b3c4d5e6f.
*/
ResourceId: ResourceId;
/**
* Tag keys that you want to remove from the specified resource.
*/
TagKeys: KeyList;
}
export interface RemoveTagsFromResourceResult {
}
export interface ResetServiceSettingRequest {
/**
* The ID of the service setting to reset.
*/
SettingId: ServiceSettingId;
}
export interface ResetServiceSettingResult {
/**
* The current, effective service setting after calling the ResetServiceSetting API action.
*/
ServiceSetting?: ServiceSetting;
}
export interface ResolvedTargets {
/**
* A list of parameter values sent to targets that resolved during the Automation execution.
*/
ParameterValues?: TargetParameterList;
/**
* A boolean value indicating whether the resolved target list is truncated.
*/
Truncated?: Boolean;
}
export interface ResourceComplianceSummaryItem {
/**
* The compliance type.
*/
ComplianceType?: ComplianceTypeName;
/**
* The resource type.
*/
ResourceType?: ComplianceResourceType;
/**
* The resource ID.
*/
ResourceId?: ComplianceResourceId;
/**
* The compliance status for the resource.
*/
Status?: ComplianceStatus;
/**
* The highest severity item found for the resource. The resource is compliant for this item.
*/
OverallSeverity?: ComplianceSeverity;
/**
* Information about the execution.
*/
ExecutionSummary?: ComplianceExecutionSummary;
/**
* A list of items that are compliant for the resource.
*/
CompliantSummary?: CompliantSummary;
/**
* A list of items that aren't compliant for the resource.
*/
NonCompliantSummary?: NonCompliantSummary;
}
export type ResourceComplianceSummaryItemList = ResourceComplianceSummaryItem[];
export type ResourceCount = number;
export type ResourceCountByStatus = string;
export type ResourceDataSyncAWSKMSKeyARN = string;
export interface ResourceDataSyncAwsOrganizationsSource {
/**
* If an AWS Organization is present, this is either OrganizationalUnits or EntireOrganization. For OrganizationalUnits, the data is aggregated from a set of organization units. For EntireOrganization, the data is aggregated from the entire AWS Organization.
*/
OrganizationSourceType: ResourceDataSyncOrganizationSourceType;
/**
* The AWS Organizations organization units included in the sync.
*/
OrganizationalUnits?: ResourceDataSyncOrganizationalUnitList;
}
export type ResourceDataSyncCreatedTime = Date;
export type ResourceDataSyncIncludeFutureRegions = boolean;
export interface ResourceDataSyncItem {
/**
* The name of the Resource Data Sync.
*/
SyncName?: ResourceDataSyncName;
/**
* The type of resource data sync. If SyncType is SyncToDestination, then the resource data sync synchronizes data to an Amazon S3 bucket. If the SyncType is SyncFromSource then the resource data sync synchronizes data from AWS Organizations or from multiple AWS Regions.
*/
SyncType?: ResourceDataSyncType;
/**
* Information about the source where the data was synchronized.
*/
SyncSource?: ResourceDataSyncSourceWithState;
/**
* Configuration information for the target Amazon S3 bucket.
*/
S3Destination?: ResourceDataSyncS3Destination;
/**
* The last time the configuration attempted to sync (UTC).
*/
LastSyncTime?: LastResourceDataSyncTime;
/**
* The last time the sync operations returned a status of SUCCESSFUL (UTC).
*/
LastSuccessfulSyncTime?: LastSuccessfulResourceDataSyncTime;
/**
* The date and time the resource data sync was changed.
*/
SyncLastModifiedTime?: ResourceDataSyncLastModifiedTime;
/**
* The status reported by the last sync.
*/
LastStatus?: LastResourceDataSyncStatus;
/**
* The date and time the configuration was created (UTC).
*/
SyncCreatedTime?: ResourceDataSyncCreatedTime;
/**
* The status message details reported by the last sync.
*/
LastSyncStatusMessage?: LastResourceDataSyncMessage;
}
export type ResourceDataSyncItemList = ResourceDataSyncItem[];
export type ResourceDataSyncLastModifiedTime = Date;
export type ResourceDataSyncName = string;
export type ResourceDataSyncOrganizationSourceType = string;
export interface ResourceDataSyncOrganizationalUnit {
/**
* The AWS Organization unit ID data source for the sync.
*/
OrganizationalUnitId?: ResourceDataSyncOrganizationalUnitId;
}
export type ResourceDataSyncOrganizationalUnitId = string;
export type ResourceDataSyncOrganizationalUnitList = ResourceDataSyncOrganizationalUnit[];
export type ResourceDataSyncS3BucketName = string;
export interface ResourceDataSyncS3Destination {
/**
* The name of the Amazon S3 bucket where the aggregated data is stored.
*/
BucketName: ResourceDataSyncS3BucketName;
/**
* An Amazon S3 prefix for the bucket.
*/
Prefix?: ResourceDataSyncS3Prefix;
/**
* A supported sync format. The following format is currently supported: JsonSerDe
*/
SyncFormat: ResourceDataSyncS3Format;
/**
* The AWS Region with the Amazon S3 bucket targeted by the Resource Data Sync.
*/
Region: ResourceDataSyncS3Region;
/**
* The ARN of an encryption key for a destination in Amazon S3. Must belong to the same Region as the destination Amazon S3 bucket.
*/
AWSKMSKeyARN?: ResourceDataSyncAWSKMSKeyARN;
}
export type ResourceDataSyncS3Format = "JsonSerDe"|string;
export type ResourceDataSyncS3Prefix = string;
export type ResourceDataSyncS3Region = string;
export interface ResourceDataSyncSource {
/**
* The type of data source for the resource data sync. SourceType is either AwsOrganizations (if an organization is present in AWS Organizations) or singleAccountMultiRegions.
*/
SourceType: ResourceDataSyncSourceType;
/**
* The field name in SyncSource for the ResourceDataSyncAwsOrganizationsSource type.
*/
AwsOrganizationsSource?: ResourceDataSyncAwsOrganizationsSource;
/**
* The SyncSource AWS Regions included in the resource data sync.
*/
SourceRegions: ResourceDataSyncSourceRegionList;
/**
* Whether to automatically synchronize and aggregate data from new AWS Regions when those Regions come online.
*/
IncludeFutureRegions?: ResourceDataSyncIncludeFutureRegions;
}
export type ResourceDataSyncSourceRegion = string;
export type ResourceDataSyncSourceRegionList = ResourceDataSyncSourceRegion[];
export type ResourceDataSyncSourceType = string;
export interface ResourceDataSyncSourceWithState {
/**
* The type of data source for the resource data sync. SourceType is either AwsOrganizations (if an organization is present in AWS Organizations) or singleAccountMultiRegions.
*/
SourceType?: ResourceDataSyncSourceType;
/**
* The field name in SyncSource for the ResourceDataSyncAwsOrganizationsSource type.
*/
AwsOrganizationsSource?: ResourceDataSyncAwsOrganizationsSource;
/**
* The SyncSource AWS Regions included in the resource data sync.
*/
SourceRegions?: ResourceDataSyncSourceRegionList;
/**
* Whether to automatically synchronize and aggregate data from new AWS Regions when those Regions come online.
*/
IncludeFutureRegions?: ResourceDataSyncIncludeFutureRegions;
/**
* The data type name for including resource data sync state. There are four sync states: OrganizationNotExists: Your organization doesn't exist. NoPermissions: The system can't locate the service-linked role. This role is automatically created when a user creates a resource data sync in Explorer. InvalidOrganizationalUnit: You specified or selected an invalid unit in the resource data sync configuration. TrustedAccessDisabled: You disabled Systems Manager access in the organization in AWS Organizations.
*/
State?: ResourceDataSyncState;
}
export type ResourceDataSyncState = string;
export type ResourceDataSyncType = string;
export type ResourceId = string;
export type ResourceType = "ManagedInstance"|"Document"|"EC2Instance"|string;
export type ResourceTypeForTagging = "Document"|"ManagedInstance"|"MaintenanceWindow"|"Parameter"|"PatchBaseline"|"OpsItem"|string;
export type ResponseCode = number;
export interface ResultAttribute {
/**
* Name of the inventory item type. Valid value: AWS:InstanceInformation. Default Value: AWS:InstanceInformation.
*/
TypeName: InventoryItemTypeName;
}
export type ResultAttributeList = ResultAttribute[];
export interface ResumeSessionRequest {
/**
* The ID of the disconnected session to resume.
*/
SessionId: SessionId;
}
export interface ResumeSessionResponse {
/**
* The ID of the session.
*/
SessionId?: SessionId;
/**
* An encrypted token value containing session and caller information. Used to authenticate the connection to the instance.
*/
TokenValue?: TokenValue;
/**
* A URL back to SSM Agent on the instance that the Session Manager client uses to send commands and receive output from the instance. Format: wss://ssmmessages.region.amazonaws.com/v1/data-channel/session-id?stream=(input|output). region represents the Region identifier for an AWS Region supported by AWS Systems Manager, such as us-east-2 for the US East (Ohio) Region. For a list of supported region values, see the Region column in the AWS Systems Manager table of regions and endpoints in the AWS General Reference. session-id represents the ID of a Session Manager session, such as 1a2b3c4dEXAMPLE.
*/
StreamUrl?: StreamUrl;
}
export type S3BucketName = string;
export type S3KeyPrefix = string;
export interface S3OutputLocation {
/**
* (Deprecated) You can no longer specify this parameter. The system ignores it. Instead, Systems Manager automatically determines the Amazon S3 bucket region.
*/
OutputS3Region?: S3Region;
/**
* The name of the Amazon S3 bucket.
*/
OutputS3BucketName?: S3BucketName;
/**
* The Amazon S3 bucket subfolder.
*/
OutputS3KeyPrefix?: S3KeyPrefix;
}
export interface S3OutputUrl {
/**
* A URL for an Amazon S3 bucket where you want to store the results of this request.
*/
OutputUrl?: Url;
}
export type S3Region = string;
export type ScheduleExpression = string;
export interface ScheduledWindowExecution {
/**
* The ID of the maintenance window to be run.
*/
WindowId?: MaintenanceWindowId;
/**
* The name of the maintenance window to be run.
*/
Name?: MaintenanceWindowName;
/**
* The time, in ISO-8601 Extended format, that the maintenance window is scheduled to be run.
*/
ExecutionTime?: MaintenanceWindowStringDateTime;
}
export type ScheduledWindowExecutionList = ScheduledWindowExecution[];
export interface SendAutomationSignalRequest {
/**
* The unique identifier for an existing Automation execution that you want to send the signal to.
*/
AutomationExecutionId: AutomationExecutionId;
/**
* The type of signal to send to an Automation execution.
*/
SignalType: SignalType;
/**
* The data sent with the signal. The data schema depends on the type of signal used in the request. For Approve and Reject signal types, the payload is an optional comment that you can send with the signal type. For example: Comment="Looks good" For StartStep and Resume signal types, you must send the name of the Automation step to start or resume as the payload. For example: StepName="step1" For the StopStep signal type, you must send the step execution ID as the payload. For example: StepExecutionId="97fff367-fc5a-4299-aed8-0123456789ab"
*/
Payload?: AutomationParameterMap;
}
export interface SendAutomationSignalResult {
}
export interface SendCommandRequest {
/**
* The instance IDs where the command should run. You can specify a maximum of 50 IDs. If you prefer not to list individual instance IDs, you can instead send commands to a fleet of instances using the Targets parameter, which accepts EC2 tags. For more information about how to use targets, see Sending Commands to a Fleet in the AWS Systems Manager User Guide.
*/
InstanceIds?: InstanceIdList;
/**
* (Optional) An array of search criteria that targets instances using a Key,Value combination that you specify. Targets is required if you don't provide one or more instance IDs in the call. For more information about how to use targets, see Sending Commands to a Fleet in the AWS Systems Manager User Guide.
*/
Targets?: Targets;
/**
* Required. The name of the Systems Manager document to run. This can be a public document or a custom document.
*/
DocumentName: DocumentARN;
/**
* The SSM document version to use in the request. You can specify $DEFAULT, $LATEST, or a specific version number. If you run commands by using the AWS CLI, then you must escape the first two options by using a backslash. If you specify a version number, then you don't need to use the backslash. For example: --document-version "\$DEFAULT" --document-version "\$LATEST" --document-version "3"
*/
DocumentVersion?: DocumentVersion;
/**
* The Sha256 or Sha1 hash created by the system when the document was created. Sha1 hashes have been deprecated.
*/
DocumentHash?: DocumentHash;
/**
* Sha256 or Sha1. Sha1 hashes have been deprecated.
*/
DocumentHashType?: DocumentHashType;
/**
* If this time is reached and the command has not already started running, it will not run.
*/
TimeoutSeconds?: TimeoutSeconds;
/**
* User-specified information about the command, such as a brief description of what the command should do.
*/
Comment?: Comment;
/**
* The required and optional parameters specified in the document being run.
*/
Parameters?: Parameters;
/**
* (Deprecated) You can no longer specify this parameter. The system ignores it. Instead, Systems Manager automatically determines the Amazon S3 bucket region.
*/
OutputS3Region?: S3Region;
/**
* The name of the S3 bucket where command execution responses should be stored.
*/
OutputS3BucketName?: S3BucketName;
/**
* The directory structure within the S3 bucket where the responses should be stored.
*/
OutputS3KeyPrefix?: S3KeyPrefix;
/**
* (Optional) The maximum number of instances that are allowed to run the command at the same time. You can specify a number such as 10 or a percentage such as 10%. The default value is 50. For more information about how to use MaxConcurrency, see Using Concurrency Controls in the AWS Systems Manager User Guide.
*/
MaxConcurrency?: MaxConcurrency;
/**
* The maximum number of errors allowed without the command failing. When the command fails one more time beyond the value of MaxErrors, the systems stops sending the command to additional targets. You can specify a number like 10 or a percentage like 10%. The default value is 0. For more information about how to use MaxErrors, see Using Error Controls in the AWS Systems Manager User Guide.
*/
MaxErrors?: MaxErrors;
/**
* The ARN of the IAM service role to use to publish Amazon Simple Notification Service (Amazon SNS) notifications for Run Command commands.
*/
ServiceRoleArn?: ServiceRole;
/**
* Configurations for sending notifications.
*/
NotificationConfig?: NotificationConfig;
/**
* Enables Systems Manager to send Run Command output to Amazon CloudWatch Logs.
*/
CloudWatchOutputConfig?: CloudWatchOutputConfig;
}
export interface SendCommandResult {
/**
* The request as it was received by Systems Manager. Also provides the command ID which can be used future references to this request.
*/
Command?: Command;
}
export type ServiceRole = string;
export interface ServiceSetting {
/**
* The ID of the service setting.
*/
SettingId?: ServiceSettingId;
/**
* The value of the service setting.
*/
SettingValue?: ServiceSettingValue;
/**
* The last time the service setting was modified.
*/
LastModifiedDate?: DateTime;
/**
* The ARN of the last modified user. This field is populated only if the setting value was overwritten.
*/
LastModifiedUser?: String;
/**
* The ARN of the service setting.
*/
ARN?: String;
/**
* The status of the service setting. The value can be Default, Customized or PendingUpdate. Default: The current setting uses a default value provisioned by the AWS service team. Customized: The current setting use a custom value specified by the customer. PendingUpdate: The current setting uses a default or custom value, but a setting change request is pending approval.
*/
Status?: String;
}
export type ServiceSettingId = string;
export type ServiceSettingValue = string;
export interface Session {
/**
* The ID of the session.
*/
SessionId?: SessionId;
/**
* The instance that the Session Manager session connected to.
*/
Target?: SessionTarget;
/**
* The status of the session. For example, "Connected" or "Terminated".
*/
Status?: SessionStatus;
/**
* The date and time, in ISO-8601 Extended format, when the session began.
*/
StartDate?: DateTime;
/**
* The date and time, in ISO-8601 Extended format, when the session was terminated.
*/
EndDate?: DateTime;
/**
* The name of the Session Manager SSM document used to define the parameters and plugin settings for the session. For example, SSM-SessionManagerRunShell.
*/
DocumentName?: DocumentName;
/**
* The ID of the AWS user account that started the session.
*/
Owner?: SessionOwner;
/**
* Reserved for future use.
*/
Details?: SessionDetails;
/**
* Reserved for future use.
*/
OutputUrl?: SessionManagerOutputUrl;
}
export type SessionDetails = string;
export interface SessionFilter {
/**
* The name of the filter.
*/
key: SessionFilterKey;
/**
* The filter value. Valid values for each filter key are as follows: InvokedAfter: Specify a timestamp to limit your results. For example, specify 2018-08-29T00:00:00Z to see sessions that started August 29, 2018, and later. InvokedBefore: Specify a timestamp to limit your results. For example, specify 2018-08-29T00:00:00Z to see sessions that started before August 29, 2018. Target: Specify an instance to which session connections have been made. Owner: Specify an AWS user account to see a list of sessions started by that user. Status: Specify a valid session status to see a list of all sessions with that status. Status values you can specify include: Connected Connecting Disconnected Terminated Terminating Failed
*/
value: SessionFilterValue;
}
export type SessionFilterKey = "InvokedAfter"|"InvokedBefore"|"Target"|"Owner"|"Status"|string;
export type SessionFilterList = SessionFilter[];
export type SessionFilterValue = string;
export type SessionId = string;
export type SessionList = Session[];
export type SessionManagerCloudWatchOutputUrl = string;
export interface SessionManagerOutputUrl {
/**
* Reserved for future use.
*/
S3OutputUrl?: SessionManagerS3OutputUrl;
/**
* Reserved for future use.
*/
CloudWatchOutputUrl?: SessionManagerCloudWatchOutputUrl;
}
export type SessionManagerParameterName = string;
export type SessionManagerParameterValue = string;
export type SessionManagerParameterValueList = SessionManagerParameterValue[];
export type SessionManagerParameters = {[key: string]: SessionManagerParameterValueList};
export type SessionManagerS3OutputUrl = string;
export type SessionMaxResults = number;
export type SessionOwner = string;
export type SessionState = "Active"|"History"|string;
export type SessionStatus = "Connected"|"Connecting"|"Disconnected"|"Terminated"|"Terminating"|"Failed"|string;
export type SessionTarget = string;
export interface SeveritySummary {
/**
* The total number of resources or compliance items that have a severity level of critical. Critical severity is determined by the organization that published the compliance items.
*/
CriticalCount?: ComplianceSummaryCount;
/**
* The total number of resources or compliance items that have a severity level of high. High severity is determined by the organization that published the compliance items.
*/
HighCount?: ComplianceSummaryCount;
/**
* The total number of resources or compliance items that have a severity level of medium. Medium severity is determined by the organization that published the compliance items.
*/
MediumCount?: ComplianceSummaryCount;
/**
* The total number of resources or compliance items that have a severity level of low. Low severity is determined by the organization that published the compliance items.
*/
LowCount?: ComplianceSummaryCount;
/**
* The total number of resources or compliance items that have a severity level of informational. Informational severity is determined by the organization that published the compliance items.
*/
InformationalCount?: ComplianceSummaryCount;
/**
* The total number of resources or compliance items that have a severity level of unspecified. Unspecified severity is determined by the organization that published the compliance items.
*/
UnspecifiedCount?: ComplianceSummaryCount;
}
export type SharedDocumentVersion = string;
export type SignalType = "Approve"|"Reject"|"StartStep"|"StopStep"|"Resume"|string;
export type SnapshotDownloadUrl = string;
export type SnapshotId = string;
export type StandardErrorContent = string;
export type StandardOutputContent = string;
export interface StartAssociationsOnceRequest {
/**
* The association IDs that you want to run immediately and only one time.
*/
AssociationIds: AssociationIdList;
}
export interface StartAssociationsOnceResult {
}
export interface StartAutomationExecutionRequest {
/**
* The name of the Automation document to use for this execution.
*/
DocumentName: DocumentARN;
/**
* The version of the Automation document to use for this execution.
*/
DocumentVersion?: DocumentVersion;
/**
* A key-value map of execution parameters, which match the declared parameters in the Automation document.
*/
Parameters?: AutomationParameterMap;
/**
* User-provided idempotency token. The token must be unique, is case insensitive, enforces the UUID format, and can't be reused.
*/
ClientToken?: IdempotencyToken;
/**
* The execution mode of the automation. Valid modes include the following: Auto and Interactive. The default mode is Auto.
*/
Mode?: ExecutionMode;
/**
* The name of the parameter used as the target resource for the rate-controlled execution. Required if you specify targets.
*/
TargetParameterName?: AutomationParameterKey;
/**
* A key-value mapping to target resources. Required if you specify TargetParameterName.
*/
Targets?: Targets;
/**
* A key-value mapping of document parameters to target resources. Both Targets and TargetMaps cannot be specified together.
*/
TargetMaps?: TargetMaps;
/**
* The maximum number of targets allowed to run this task in parallel. You can specify a number, such as 10, or a percentage, such as 10%. The default value is 10.
*/
MaxConcurrency?: MaxConcurrency;
/**
* The number of errors that are allowed before the system stops running the automation on additional targets. You can specify either an absolute number of errors, for example 10, or a percentage of the target set, for example 10%. If you specify 3, for example, the system stops running the automation when the fourth error is received. If you specify 0, then the system stops running the automation on additional targets after the first error result is returned. If you run an automation on 50 resources and set max-errors to 10%, then the system stops running the automation on additional targets when the sixth error is received. Executions that are already running an automation when max-errors is reached are allowed to complete, but some of these executions may fail as well. If you need to ensure that there won't be more than max-errors failed executions, set max-concurrency to 1 so the executions proceed one at a time.
*/
MaxErrors?: MaxErrors;
/**
* A location is a combination of AWS Regions and/or AWS accounts where you want to run the Automation. Use this action to start an Automation in multiple Regions and multiple accounts. For more information, see Executing Automations in Multiple AWS Regions and Accounts in the AWS Systems Manager User Guide.
*/
TargetLocations?: TargetLocations;
}
export interface StartAutomationExecutionResult {
/**
* The unique ID of a newly scheduled automation execution.
*/
AutomationExecutionId?: AutomationExecutionId;
}
export interface StartSessionRequest {
/**
* The instance to connect to for the session.
*/
Target: SessionTarget;
/**
* The name of the SSM document to define the parameters and plugin settings for the session. For example, SSM-SessionManagerRunShell. If no document name is provided, a shell to the instance is launched by default.
*/
DocumentName?: DocumentARN;
/**
* Reserved for future use.
*/
Parameters?: SessionManagerParameters;
}
export interface StartSessionResponse {
/**
* The ID of the session.
*/
SessionId?: SessionId;
/**
* An encrypted token value containing session and caller information. Used to authenticate the connection to the instance.
*/
TokenValue?: TokenValue;
/**
* A URL back to SSM Agent on the instance that the Session Manager client uses to send commands and receive output from the instance. Format: wss://ssmmessages.region.amazonaws.com/v1/data-channel/session-id?stream=(input|output) region represents the Region identifier for an AWS Region supported by AWS Systems Manager, such as us-east-2 for the US East (Ohio) Region. For a list of supported region values, see the Region column in the AWS Systems Manager table of regions and endpoints in the AWS General Reference. session-id represents the ID of a Session Manager session, such as 1a2b3c4dEXAMPLE.
*/
StreamUrl?: StreamUrl;
}
export type StatusAdditionalInfo = string;
export type StatusDetails = string;
export type StatusMessage = string;
export type StatusName = string;
export interface StepExecution {
/**
* The name of this execution step.
*/
StepName?: String;
/**
* The action this step performs. The action determines the behavior of the step.
*/
Action?: AutomationActionName;
/**
* The timeout seconds of the step.
*/
TimeoutSeconds?: Long;
/**
* The action to take if the step fails. The default value is Abort.
*/
OnFailure?: String;
/**
* The maximum number of tries to run the action of the step. The default value is 1.
*/
MaxAttempts?: Integer;
/**
* If a step has begun execution, this contains the time the step started. If the step is in Pending status, this field is not populated.
*/
ExecutionStartTime?: DateTime;
/**
* If a step has finished execution, this contains the time the execution ended. If the step has not yet concluded, this field is not populated.
*/
ExecutionEndTime?: DateTime;
/**
* The execution status for this step. Valid values include: Pending, InProgress, Success, Cancelled, Failed, and TimedOut.
*/
StepStatus?: AutomationExecutionStatus;
/**
* The response code returned by the execution of the step.
*/
ResponseCode?: String;
/**
* Fully-resolved values passed into the step before execution.
*/
Inputs?: NormalStringMap;
/**
* Returned values from the execution of the step.
*/
Outputs?: AutomationParameterMap;
/**
* A message associated with the response code for an execution.
*/
Response?: String;
/**
* If a step failed, this message explains why the execution failed.
*/
FailureMessage?: String;
/**
* Information about the Automation failure.
*/
FailureDetails?: FailureDetails;
/**
* The unique ID of a step execution.
*/
StepExecutionId?: String;
/**
* A user-specified list of parameters to override when running a step.
*/
OverriddenParameters?: AutomationParameterMap;
/**
* The flag which can be used to end automation no matter whether the step succeeds or fails.
*/
IsEnd?: Boolean;
/**
* The next step after the step succeeds.
*/
NextStep?: String;
/**
* The flag which can be used to help decide whether the failure of current step leads to the Automation failure.
*/
IsCritical?: Boolean;
/**
* Strategies used when step fails, we support Continue and Abort. Abort will fail the automation when the step fails. Continue will ignore the failure of current step and allow automation to run the next step. With conditional branching, we add step:stepName to support the automation to go to another specific step.
*/
ValidNextSteps?: ValidNextStepList;
/**
* The targets for the step execution.
*/
Targets?: Targets;
/**
* The combination of AWS Regions and accounts targeted by the current Automation execution.
*/
TargetLocation?: TargetLocation;
}
export interface StepExecutionFilter {
/**
* One or more keys to limit the results. Valid filter keys include the following: StepName, Action, StepExecutionId, StepExecutionStatus, StartTimeBefore, StartTimeAfter.
*/
Key: StepExecutionFilterKey;
/**
* The values of the filter key.
*/
Values: StepExecutionFilterValueList;
}
export type StepExecutionFilterKey = "StartTimeBefore"|"StartTimeAfter"|"StepExecutionStatus"|"StepExecutionId"|"StepName"|"Action"|string;
export type StepExecutionFilterList = StepExecutionFilter[];
export type StepExecutionFilterValue = string;
export type StepExecutionFilterValueList = StepExecutionFilterValue[];
export type StepExecutionList = StepExecution[];
export interface StopAutomationExecutionRequest {
/**
* The execution ID of the Automation to stop.
*/
AutomationExecutionId: AutomationExecutionId;
/**
* The stop request type. Valid types include the following: Cancel and Complete. The default type is Cancel.
*/
Type?: StopType;
}
export interface StopAutomationExecutionResult {
}
export type StopType = "Complete"|"Cancel"|string;
export type StreamUrl = string;
export type String = string;
export type StringDateTime = string;
export type StringList = String[];
export interface Tag {
/**
* The name of the tag.
*/
Key: TagKey;
/**
* The value of the tag.
*/
Value: TagValue;
}
export type TagKey = string;
export type TagList = Tag[];
export type TagValue = string;
export interface Target {
/**
* User-defined criteria for sending commands that target instances that meet the criteria.
*/
Key?: TargetKey;
/**
* User-defined criteria that maps to Key. For example, if you specified tag:ServerRole, you could specify value:WebServer to run a command on instances that include Amazon EC2 tags of ServerRole,WebServer.
*/
Values?: TargetValues;
}
export type TargetCount = number;
export type TargetKey = string;
export interface TargetLocation {
/**
* The AWS accounts targeted by the current Automation execution.
*/
Accounts?: Accounts;
/**
* The AWS Regions targeted by the current Automation execution.
*/
Regions?: Regions;
/**
* The maximum number of AWS accounts and AWS regions allowed to run the Automation concurrently
*/
TargetLocationMaxConcurrency?: MaxConcurrency;
/**
* The maximum number of errors allowed before the system stops queueing additional Automation executions for the currently running Automation.
*/
TargetLocationMaxErrors?: MaxErrors;
/**
* The Automation execution role used by the currently running Automation.
*/
ExecutionRoleName?: ExecutionRoleName;
}
export type TargetLocations = TargetLocation[];
export type TargetMap = {[key: string]: TargetMapValueList};
export type TargetMapKey = string;
export type TargetMapValue = string;
export type TargetMapValueList = TargetMapValue[];
export type TargetMaps = TargetMap[];
export type TargetParameterList = ParameterValue[];
export type TargetType = string;
export type TargetValue = string;
export type TargetValues = TargetValue[];
export type Targets = Target[];
export interface TerminateSessionRequest {
/**
* The ID of the session to terminate.
*/
SessionId: SessionId;
}
export interface TerminateSessionResponse {
/**
* The ID of the session that has been terminated.
*/
SessionId?: SessionId;
}
export type TimeoutSeconds = number;
export type TokenValue = string;
export type TotalCount = number;
export interface UpdateAssociationRequest {
/**
* The ID of the association you want to update.
*/
AssociationId: AssociationId;
/**
* The parameters you want to update for the association. If you create a parameter using Parameter Store, you can reference the parameter using {{ssm:parameter-name}}
*/
Parameters?: Parameters;
/**
* The document version you want update for the association.
*/
DocumentVersion?: DocumentVersion;
/**
* The cron expression used to schedule the association that you want to update.
*/
ScheduleExpression?: ScheduleExpression;
/**
* An Amazon S3 bucket where you want to store the results of this request.
*/
OutputLocation?: InstanceAssociationOutputLocation;
/**
* The name of the SSM document that contains the configuration information for the instance. You can specify Command or Automation documents. You can specify AWS-predefined documents, documents you created, or a document that is shared with you from another account. For SSM documents that are shared with you from other AWS accounts, you must specify the complete SSM document ARN, in the following format: arn:aws:ssm:region:account-id:document/document-name For example: arn:aws:ssm:us-east-2:12345678912:document/My-Shared-Document For AWS-predefined documents and SSM documents you created in your account, you only need to specify the document name. For example, AWS-ApplyPatchBaseline or My-Document.
*/
Name?: DocumentARN;
/**
* The targets of the association.
*/
Targets?: Targets;
/**
* The name of the association that you want to update.
*/
AssociationName?: AssociationName;
/**
* This parameter is provided for concurrency control purposes. You must specify the latest association version in the service. If you want to ensure that this request succeeds, either specify $LATEST, or omit this parameter.
*/
AssociationVersion?: AssociationVersion;
/**
* Specify the target for the association. This target is required for associations that use an Automation document and target resources by using rate controls.
*/
AutomationTargetParameterName?: AutomationTargetParameterName;
/**
* The number of errors that are allowed before the system stops sending requests to run the association on additional targets. You can specify either an absolute number of errors, for example 10, or a percentage of the target set, for example 10%. If you specify 3, for example, the system stops sending requests when the fourth error is received. If you specify 0, then the system stops sending requests after the first error is returned. If you run an association on 50 instances and set MaxError to 10%, then the system stops sending the request when the sixth error is received. Executions that are already running an association when MaxErrors is reached are allowed to complete, but some of these executions may fail as well. If you need to ensure that there won't be more than max-errors failed executions, set MaxConcurrency to 1 so that executions proceed one at a time.
*/
MaxErrors?: MaxErrors;
/**
* The maximum number of targets allowed to run the association at the same time. You can specify a number, for example 10, or a percentage of the target set, for example 10%. The default value is 100%, which means all targets run the association at the same time. If a new instance starts and attempts to run an association while Systems Manager is running MaxConcurrency associations, the association is allowed to run. During the next association interval, the new instance will process its association within the limit specified for MaxConcurrency.
*/
MaxConcurrency?: MaxConcurrency;
/**
* The severity level to assign to the association.
*/
ComplianceSeverity?: AssociationComplianceSeverity;
}
export interface UpdateAssociationResult {
/**
* The description of the association that was updated.
*/
AssociationDescription?: AssociationDescription;
}
export interface UpdateAssociationStatusRequest {
/**
* The name of the Systems Manager document.
*/
Name: DocumentARN;
/**
* The ID of the instance.
*/
InstanceId: InstanceId;
/**
* The association status.
*/
AssociationStatus: AssociationStatus;
}
export interface UpdateAssociationStatusResult {
/**
* Information about the association.
*/
AssociationDescription?: AssociationDescription;
}
export interface UpdateDocumentDefaultVersionRequest {
/**
* The name of a custom document that you want to set as the default version.
*/
Name: DocumentName;
/**
* The version of a custom document that you want to set as the default version.
*/
DocumentVersion: DocumentVersionNumber;
}
export interface UpdateDocumentDefaultVersionResult {
/**
* The description of a custom document that you want to set as the default version.
*/
Description?: DocumentDefaultVersionDescription;
}
export interface UpdateDocumentRequest {
/**
* A valid JSON or YAML string.
*/
Content: DocumentContent;
/**
* A list of key and value pairs that describe attachments to a version of a document.
*/
Attachments?: AttachmentsSourceList;
/**
* The name of the document that you want to update.
*/
Name: DocumentName;
/**
* An optional field specifying the version of the artifact you are updating with the document. For example, "Release 12, Update 6". This value is unique across all versions of a document, and cannot be changed.
*/
VersionName?: DocumentVersionName;
/**
* (Required) The version of the document that you want to update.
*/
DocumentVersion?: DocumentVersion;
/**
* Specify the document format for the new document version. Systems Manager supports JSON and YAML documents. JSON is the default format.
*/
DocumentFormat?: DocumentFormat;
/**
* Specify a new target type for the document.
*/
TargetType?: TargetType;
}
export interface UpdateDocumentResult {
/**
* A description of the document that was updated.
*/
DocumentDescription?: DocumentDescription;
}
export interface UpdateMaintenanceWindowRequest {
/**
* The ID of the maintenance window to update.
*/
WindowId: MaintenanceWindowId;
/**
* The name of the maintenance window.
*/
Name?: MaintenanceWindowName;
/**
* An optional description for the update request.
*/
Description?: MaintenanceWindowDescription;
/**
* The time zone that the scheduled maintenance window executions are based on, in Internet Assigned Numbers Authority (IANA) format. For example: "America/Los_Angeles", "etc/UTC", or "Asia/Seoul". For more information, see the Time Zone Database on the IANA website.
*/
StartDate?: MaintenanceWindowStringDateTime;
/**
* The date and time, in ISO-8601 Extended format, for when you want the maintenance window to become inactive. EndDate allows you to set a date and time in the future when the maintenance window will no longer run.
*/
EndDate?: MaintenanceWindowStringDateTime;
/**
* The schedule of the maintenance window in the form of a cron or rate expression.
*/
Schedule?: MaintenanceWindowSchedule;
/**
* The time zone that the scheduled maintenance window executions are based on, in Internet Assigned Numbers Authority (IANA) format. For example: "America/Los_Angeles", "etc/UTC", or "Asia/Seoul". For more information, see the Time Zone Database on the IANA website.
*/
ScheduleTimezone?: MaintenanceWindowTimezone;
/**
* The duration of the maintenance window in hours.
*/
Duration?: MaintenanceWindowDurationHours;
/**
* The number of hours before the end of the maintenance window that Systems Manager stops scheduling new tasks for execution.
*/
Cutoff?: MaintenanceWindowCutoff;
/**
* Whether targets must be registered with the maintenance window before tasks can be defined for those targets.
*/
AllowUnassociatedTargets?: MaintenanceWindowAllowUnassociatedTargets;
/**
* Whether the maintenance window is enabled.
*/
Enabled?: MaintenanceWindowEnabled;
/**
* If True, then all fields that are required by the CreateMaintenanceWindow action are also required for this API request. Optional fields that are not specified are set to null.
*/
Replace?: Boolean;
}
export interface UpdateMaintenanceWindowResult {
/**
* The ID of the created maintenance window.
*/
WindowId?: MaintenanceWindowId;
/**
* The name of the maintenance window.
*/
Name?: MaintenanceWindowName;
/**
* An optional description of the update.
*/
Description?: MaintenanceWindowDescription;
/**
* The date and time, in ISO-8601 Extended format, for when the maintenance window is scheduled to become active. The maintenance window will not run before this specified time.
*/
StartDate?: MaintenanceWindowStringDateTime;
/**
* The date and time, in ISO-8601 Extended format, for when the maintenance window is scheduled to become inactive. The maintenance window will not run after this specified time.
*/
EndDate?: MaintenanceWindowStringDateTime;
/**
* The schedule of the maintenance window in the form of a cron or rate expression.
*/
Schedule?: MaintenanceWindowSchedule;
/**
* The time zone that the scheduled maintenance window executions are based on, in Internet Assigned Numbers Authority (IANA) format. For example: "America/Los_Angeles", "etc/UTC", or "Asia/Seoul". For more information, see the Time Zone Database on the IANA website.
*/
ScheduleTimezone?: MaintenanceWindowTimezone;
/**
* The duration of the maintenance window in hours.
*/
Duration?: MaintenanceWindowDurationHours;
/**
* The number of hours before the end of the maintenance window that Systems Manager stops scheduling new tasks for execution.
*/
Cutoff?: MaintenanceWindowCutoff;
/**
* Whether targets must be registered with the maintenance window before tasks can be defined for those targets.
*/
AllowUnassociatedTargets?: MaintenanceWindowAllowUnassociatedTargets;
/**
* Whether the maintenance window is enabled.
*/
Enabled?: MaintenanceWindowEnabled;
}
export interface UpdateMaintenanceWindowTargetRequest {
/**
* The maintenance window ID with which to modify the target.
*/
WindowId: MaintenanceWindowId;
/**
* The target ID to modify.
*/
WindowTargetId: MaintenanceWindowTargetId;
/**
* The targets to add or replace.
*/
Targets?: Targets;
/**
* User-provided value that will be included in any CloudWatch events raised while running tasks for these targets in this maintenance window.
*/
OwnerInformation?: OwnerInformation;
/**
* A name for the update.
*/
Name?: MaintenanceWindowName;
/**
* An optional description for the update.
*/
Description?: MaintenanceWindowDescription;
/**
* If True, then all fields that are required by the RegisterTargetWithMaintenanceWindow action are also required for this API request. Optional fields that are not specified are set to null.
*/
Replace?: Boolean;
}
export interface UpdateMaintenanceWindowTargetResult {
/**
* The maintenance window ID specified in the update request.
*/
WindowId?: MaintenanceWindowId;
/**
* The target ID specified in the update request.
*/
WindowTargetId?: MaintenanceWindowTargetId;
/**
* The updated targets.
*/
Targets?: Targets;
/**
* The updated owner.
*/
OwnerInformation?: OwnerInformation;
/**
* The updated name.
*/
Name?: MaintenanceWindowName;
/**
* The updated description.
*/
Description?: MaintenanceWindowDescription;
}
export interface UpdateMaintenanceWindowTaskRequest {
/**
* The maintenance window ID that contains the task to modify.
*/
WindowId: MaintenanceWindowId;
/**
* The task ID to modify.
*/
WindowTaskId: MaintenanceWindowTaskId;
/**
* The targets (either instances or tags) to modify. Instances are specified using Key=instanceids,Values=instanceID_1,instanceID_2. Tags are specified using Key=tag_name,Values=tag_value.
*/
Targets?: Targets;
/**
* The task ARN to modify.
*/
TaskArn?: MaintenanceWindowTaskArn;
/**
* The ARN of the IAM service role for Systems Manager to assume when running a maintenance window task. If you do not specify a service role ARN, Systems Manager uses your account's service-linked role. If no service-linked role for Systems Manager exists in your account, it is created when you run RegisterTaskWithMaintenanceWindow. For more information, see the following topics in the in the AWS Systems Manager User Guide: Service-Linked Role Permissions for Systems Manager Should I Use a Service-Linked Role or a Custom Service Role to Run Maintenance Window Tasks?
*/
ServiceRoleArn?: ServiceRole;
/**
* The parameters to modify. TaskParameters has been deprecated. To specify parameters to pass to a task when it runs, instead use the Parameters option in the TaskInvocationParameters structure. For information about how Systems Manager handles these options for the supported maintenance window task types, see MaintenanceWindowTaskInvocationParameters. The map has the following format: Key: string, between 1 and 255 characters Value: an array of strings, each string is between 1 and 255 characters
*/
TaskParameters?: MaintenanceWindowTaskParameters;
/**
* The parameters that the task should use during execution. Populate only the fields that match the task type. All other fields should be empty.
*/
TaskInvocationParameters?: MaintenanceWindowTaskInvocationParameters;
/**
* The new task priority to specify. The lower the number, the higher the priority. Tasks that have the same priority are scheduled in parallel.
*/
Priority?: MaintenanceWindowTaskPriority;
/**
* The new MaxConcurrency value you want to specify. MaxConcurrency is the number of targets that are allowed to run this task in parallel.
*/
MaxConcurrency?: MaxConcurrency;
/**
* The new MaxErrors value to specify. MaxErrors is the maximum number of errors that are allowed before the task stops being scheduled.
*/
MaxErrors?: MaxErrors;
/**
* The new logging location in Amazon S3 to specify. LoggingInfo has been deprecated. To specify an S3 bucket to contain logs, instead use the OutputS3BucketName and OutputS3KeyPrefix options in the TaskInvocationParameters structure. For information about how Systems Manager handles these options for the supported maintenance window task types, see MaintenanceWindowTaskInvocationParameters.
*/
LoggingInfo?: LoggingInfo;
/**
* The new task name to specify.
*/
Name?: MaintenanceWindowName;
/**
* The new task description to specify.
*/
Description?: MaintenanceWindowDescription;
/**
* If True, then all fields that are required by the RegisterTaskWithMaintenanceWndow action are also required for this API request. Optional fields that are not specified are set to null.
*/
Replace?: Boolean;
}
export interface UpdateMaintenanceWindowTaskResult {
/**
* The ID of the maintenance window that was updated.
*/
WindowId?: MaintenanceWindowId;
/**
* The task ID of the maintenance window that was updated.
*/
WindowTaskId?: MaintenanceWindowTaskId;
/**
* The updated target values.
*/
Targets?: Targets;
/**
* The updated task ARN value.
*/
TaskArn?: MaintenanceWindowTaskArn;
/**
* The ARN of the IAM service role to use to publish Amazon Simple Notification Service (Amazon SNS) notifications for maintenance window Run Command tasks.
*/
ServiceRoleArn?: ServiceRole;
/**
* The updated parameter values. TaskParameters has been deprecated. To specify parameters to pass to a task when it runs, instead use the Parameters option in the TaskInvocationParameters structure. For information about how Systems Manager handles these options for the supported maintenance window task types, see MaintenanceWindowTaskInvocationParameters.
*/
TaskParameters?: MaintenanceWindowTaskParameters;
/**
* The updated parameter values.
*/
TaskInvocationParameters?: MaintenanceWindowTaskInvocationParameters;
/**
* The updated priority value.
*/
Priority?: MaintenanceWindowTaskPriority;
/**
* The updated MaxConcurrency value.
*/
MaxConcurrency?: MaxConcurrency;
/**
* The updated MaxErrors value.
*/
MaxErrors?: MaxErrors;
/**
* The updated logging information in Amazon S3. LoggingInfo has been deprecated. To specify an S3 bucket to contain logs, instead use the OutputS3BucketName and OutputS3KeyPrefix options in the TaskInvocationParameters structure. For information about how Systems Manager handles these options for the supported maintenance window task types, see MaintenanceWindowTaskInvocationParameters.
*/
LoggingInfo?: LoggingInfo;
/**
* The updated task name.
*/
Name?: MaintenanceWindowName;
/**
* The updated task description.
*/
Description?: MaintenanceWindowDescription;
}
export interface UpdateManagedInstanceRoleRequest {
/**
* The ID of the managed instance where you want to update the role.
*/
InstanceId: ManagedInstanceId;
/**
* The IAM role you want to assign or change.
*/
IamRole: IamRole;
}
export interface UpdateManagedInstanceRoleResult {
}
export interface UpdateOpsItemRequest {
/**
* Update the information about the OpsItem. Provide enough information so that users reading this OpsItem for the first time understand the issue.
*/
Description?: OpsItemDescription;
/**
* Add new keys or edit existing key-value pairs of the OperationalData map in the OpsItem object. Operational data is custom data that provides useful reference details about the OpsItem. For example, you can specify log files, error strings, license keys, troubleshooting tips, or other relevant data. You enter operational data as key-value pairs. The key has a maximum length of 128 characters. The value has a maximum size of 20 KB. Operational data keys can't begin with the following: amazon, aws, amzn, ssm, /amazon, /aws, /amzn, /ssm. You can choose to make the data searchable by other users in the account or you can restrict search access. Searchable data means that all users with access to the OpsItem Overview page (as provided by the DescribeOpsItems API action) can view and search on the specified data. Operational data that is not searchable is only viewable by users who have access to the OpsItem (as provided by the GetOpsItem API action). Use the /aws/resources key in OperationalData to specify a related resource in the request. Use the /aws/automations key in OperationalData to associate an Automation runbook with the OpsItem. To view AWS CLI example commands that use these keys, see Creating OpsItems Manually in the AWS Systems Manager User Guide.
*/
OperationalData?: OpsItemOperationalData;
/**
* Keys that you want to remove from the OperationalData map.
*/
OperationalDataToDelete?: OpsItemOpsDataKeysList;
/**
* The Amazon Resource Name (ARN) of an SNS topic where notifications are sent when this OpsItem is edited or changed.
*/
Notifications?: OpsItemNotifications;
/**
* The importance of this OpsItem in relation to other OpsItems in the system.
*/
Priority?: OpsItemPriority;
/**
* One or more OpsItems that share something in common with the current OpsItems. For example, related OpsItems can include OpsItems with similar error messages, impacted resources, or statuses for the impacted resource.
*/
RelatedOpsItems?: RelatedOpsItems;
/**
* The OpsItem status. Status can be Open, In Progress, or Resolved. For more information, see Editing OpsItem Details in the AWS Systems Manager User Guide.
*/
Status?: OpsItemStatus;
/**
* The ID of the OpsItem.
*/
OpsItemId: OpsItemId;
/**
* A short heading that describes the nature of the OpsItem and the impacted resource.
*/
Title?: OpsItemTitle;
/**
* Specify a new category for an OpsItem.
*/
Category?: OpsItemCategory;
/**
* Specify a new severity for an OpsItem.
*/
Severity?: OpsItemSeverity;
}
export interface UpdateOpsItemResponse {
}
export interface UpdatePatchBaselineRequest {
/**
* The ID of the patch baseline to update.
*/
BaselineId: BaselineId;
/**
* The name of the patch baseline.
*/
Name?: BaselineName;
/**
* A set of global filters used to include patches in the baseline.
*/
GlobalFilters?: PatchFilterGroup;
/**
* A set of rules used to include patches in the baseline.
*/
ApprovalRules?: PatchRuleGroup;
/**
* A list of explicitly approved patches for the baseline. For information about accepted formats for lists of approved patches and rejected patches, see Package Name Formats for Approved and Rejected Patch Lists in the AWS Systems Manager User Guide.
*/
ApprovedPatches?: PatchIdList;
/**
* Assigns a new compliance severity level to an existing patch baseline.
*/
ApprovedPatchesComplianceLevel?: PatchComplianceLevel;
/**
* Indicates whether the list of approved patches includes non-security updates that should be applied to the instances. The default value is 'false'. Applies to Linux instances only.
*/
ApprovedPatchesEnableNonSecurity?: Boolean;
/**
* A list of explicitly rejected patches for the baseline. For information about accepted formats for lists of approved patches and rejected patches, see Package Name Formats for Approved and Rejected Patch Lists in the AWS Systems Manager User Guide.
*/
RejectedPatches?: PatchIdList;
/**
* The action for Patch Manager to take on patches included in the RejectedPackages list. ALLOW_AS_DEPENDENCY: A package in the Rejected patches list is installed only if it is a dependency of another package. It is considered compliant with the patch baseline, and its status is reported as InstalledOther. This is the default action if no option is specified. BLOCK: Packages in the RejectedPatches list, and packages that include them as dependencies, are not installed under any circumstances. If a package was installed before it was added to the Rejected patches list, it is considered non-compliant with the patch baseline, and its status is reported as InstalledRejected.
*/
RejectedPatchesAction?: PatchAction;
/**
* A description of the patch baseline.
*/
Description?: BaselineDescription;
/**
* Information about the patches to use to update the instances, including target operating systems and source repositories. Applies to Linux instances only.
*/
Sources?: PatchSourceList;
/**
* If True, then all fields that are required by the CreatePatchBaseline action are also required for this API request. Optional fields that are not specified are set to null.
*/
Replace?: Boolean;
}
export interface UpdatePatchBaselineResult {
/**
* The ID of the deleted patch baseline.
*/
BaselineId?: BaselineId;
/**
* The name of the patch baseline.
*/
Name?: BaselineName;
/**
* The operating system rule used by the updated patch baseline.
*/
OperatingSystem?: OperatingSystem;
/**
* A set of global filters used to exclude patches from the baseline.
*/
GlobalFilters?: PatchFilterGroup;
/**
* A set of rules used to include patches in the baseline.
*/
ApprovalRules?: PatchRuleGroup;
/**
* A list of explicitly approved patches for the baseline.
*/
ApprovedPatches?: PatchIdList;
/**
* The compliance severity level assigned to the patch baseline after the update completed.
*/
ApprovedPatchesComplianceLevel?: PatchComplianceLevel;
/**
* Indicates whether the list of approved patches includes non-security updates that should be applied to the instances. The default value is 'false'. Applies to Linux instances only.
*/
ApprovedPatchesEnableNonSecurity?: Boolean;
/**
* A list of explicitly rejected patches for the baseline.
*/
RejectedPatches?: PatchIdList;
/**
* The action specified to take on patches included in the RejectedPatches list. A patch can be allowed only if it is a dependency of another package, or blocked entirely along with packages that include it as a dependency.
*/
RejectedPatchesAction?: PatchAction;
/**
* The date when the patch baseline was created.
*/
CreatedDate?: DateTime;
/**
* The date when the patch baseline was last modified.
*/
ModifiedDate?: DateTime;
/**
* A description of the Patch Baseline.
*/
Description?: BaselineDescription;
/**
* Information about the patches to use to update the instances, including target operating systems and source repositories. Applies to Linux instances only.
*/
Sources?: PatchSourceList;
}
export interface UpdateResourceDataSyncRequest {
/**
* The name of the resource data sync you want to update.
*/
SyncName: ResourceDataSyncName;
/**
* The type of resource data sync. If SyncType is SyncToDestination, then the resource data sync synchronizes data to an Amazon S3 bucket. If the SyncType is SyncFromSource then the resource data sync synchronizes data from AWS Organizations or from multiple AWS Regions.
*/
SyncType: ResourceDataSyncType;
/**
* Specify information about the data sources to synchronize.
*/
SyncSource: ResourceDataSyncSource;
}
export interface UpdateResourceDataSyncResult {
}
export interface UpdateServiceSettingRequest {
/**
* The ID of the service setting to update.
*/
SettingId: ServiceSettingId;
/**
* The new value to specify for the service setting.
*/
SettingValue: ServiceSettingValue;
}
export interface UpdateServiceSettingResult {
}
export type Url = string;
export type ValidNextStep = string;
export type ValidNextStepList = ValidNextStep[];
export type Version = string;
/**
* A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
*/
export type apiVersion = "2014-11-06"|"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 SSM client.
*/
export import Types = SSM;
}
export = SSM;