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
|
// Code generated by smithy-go-codegen DO NOT EDIT.
package types
import (
smithydocument "github.com/aws/smithy-go/document"
"time"
)
// Information includes the Amazon Web Services account ID where the current
// document is shared and the version shared with that account.
type AccountSharingInfo struct {
// The Amazon Web Services account ID where the current document is shared.
AccountId *string
// The version of the current document shared with the account.
SharedDocumentVersion *string
noSmithyDocumentSerde
}
// An activation registers one or more on-premises servers or virtual machines
// (VMs) with Amazon Web Services so that you can configure those servers or VMs
// using Run Command. A server or VM that has been registered with Amazon Web
// Services Systems Manager is called a managed node.
type Activation struct {
// The ID created by Systems Manager when you submitted the activation.
ActivationId *string
// The date the activation was created.
CreatedDate *time.Time
// A name for the managed node when it is created.
DefaultInstanceName *string
// A user defined description of the activation.
Description *string
// The date when this activation can no longer be used to register managed nodes.
ExpirationDate *time.Time
// Whether or not the activation is expired.
Expired bool
// The Identity and Access Management (IAM) role to assign to the managed node.
IamRole *string
// The maximum number of managed nodes that can be registered using this
// activation.
RegistrationLimit *int32
// The number of managed nodes already registered with this activation.
RegistrationsCount *int32
// Tags assigned to the activation.
Tags []Tag
noSmithyDocumentSerde
}
// A CloudWatch alarm you apply to an automation or command.
type Alarm struct {
// The name of your CloudWatch alarm.
//
// This member is required.
Name *string
noSmithyDocumentSerde
}
// The details for the CloudWatch alarm you want to apply to an automation or
// command.
type AlarmConfiguration struct {
// The name of the CloudWatch alarm specified in the configuration.
//
// This member is required.
Alarms []Alarm
// When this value is true, your automation or command continues to run in cases
// where we can’t retrieve alarm status information from CloudWatch. In cases where
// we successfully retrieve an alarm status of OK or INSUFFICIENT_DATA, the
// automation or command continues to run, regardless of this value. Default is
// false.
IgnorePollAlarmFailure bool
noSmithyDocumentSerde
}
// The details about the state of your CloudWatch alarm.
type AlarmStateInformation struct {
// The name of your CloudWatch alarm.
//
// This member is required.
Name *string
// The state of your CloudWatch alarm.
//
// This member is required.
State ExternalAlarmState
noSmithyDocumentSerde
}
// Describes an association of a Amazon Web Services Systems Manager document (SSM
// document) and a managed node.
type Association struct {
// 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 *string
// The association name.
AssociationName *string
// The association version.
AssociationVersion *string
// The version of the document used in the association. If you change a document
// version for a State Manager association, Systems Manager immediately runs the
// association unless you previously specifed the apply-only-at-cron-interval
// parameter. State Manager doesn't support running associations that use a new
// version of a document if that document is shared from another account. State
// Manager always runs the default version of a document if shared from another
// account, even though the Systems Manager console shows that a new version was
// processed. If you want to run an association using a new version of a document
// shared form another account, you must set the document version to default .
DocumentVersion *string
// The managed node ID.
InstanceId *string
// The date on which the association was last run.
LastExecutionDate *time.Time
// The name of the SSM document.
Name *string
// Information about the association.
Overview *AssociationOverview
// A cron expression that specifies a schedule when the association runs. The
// schedule runs in Coordinated Universal Time (UTC).
ScheduleExpression *string
// Number of days to wait after the scheduled day to run an association.
ScheduleOffset *int32
// A key-value mapping of document parameters to target resources. Both Targets
// and TargetMaps can't be specified together.
TargetMaps []map[string][]string
// The managed nodes targeted by the request to create an association. You can
// target all managed nodes in an Amazon Web Services account by specifying the
// InstanceIds key with a value of * .
Targets []Target
noSmithyDocumentSerde
}
// Describes the parameters for a document.
type AssociationDescription struct {
// The details for the CloudWatch alarm you want to apply to an automation or
// command.
AlarmConfiguration *AlarmConfiguration
// By default, when you create a new associations, the system runs it immediately
// after it is created and then according to the schedule you specified. Specify
// this option if you don't want an association to run immediately after you create
// it. This parameter isn't supported for rate expressions.
ApplyOnlyAtCronInterval bool
// The association ID.
AssociationId *string
// The association name.
AssociationName *string
// The association version.
AssociationVersion *string
// Choose the parameter that will define how your automation will branch out. This
// target is required for associations that use an Automation runbook and target
// resources by using rate controls. Automation is a capability of Amazon Web
// Services Systems Manager.
AutomationTargetParameterName *string
// The names or Amazon Resource Names (ARNs) of the Change Calendar type documents
// your associations are gated under. The associations only run when that change
// calendar is open. For more information, see Amazon Web Services Systems Manager
// Change Calendar (https://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-change-calendar)
// .
CalendarNames []string
// The severity level that is assigned to the association.
ComplianceSeverity AssociationComplianceSeverity
// The date when the association was made.
Date *time.Time
// The document version.
DocumentVersion *string
// The managed node ID.
InstanceId *string
// The date on which the association was last run.
LastExecutionDate *time.Time
// The last date on which the association was successfully run.
LastSuccessfulExecutionDate *time.Time
// The date when the association was last updated.
LastUpdateAssociationDate *time.Time
// 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 managed node 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
// managed node will process its association within the limit specified for
// MaxConcurrency .
MaxConcurrency *string
// 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
// managed nodes 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 *string
// The name of the SSM document.
Name *string
// An S3 bucket where you want to store the output details of the request.
OutputLocation *InstanceAssociationOutputLocation
// Information about the association.
Overview *AssociationOverview
// A description of the parameters for a document.
Parameters map[string][]string
// A cron expression that specifies a schedule when the association runs.
ScheduleExpression *string
// Number of days to wait after the scheduled day to run an association.
ScheduleOffset *int32
// The association status.
Status *AssociationStatus
// The mode for generating association compliance. You can specify AUTO or MANUAL .
// In AUTO mode, the system uses the status of the association execution to
// determine the compliance status. If the association execution runs successfully,
// then the association is COMPLIANT . If the association execution doesn't run
// successfully, the association is NON-COMPLIANT . In MANUAL mode, you must
// specify the AssociationId as a parameter for the PutComplianceItems API
// operation. In this case, compliance data isn't managed by State Manager, a
// capability of Amazon Web Services Systems Manager. It is managed by your direct
// call to the PutComplianceItems API operation. By default, all associations use
// AUTO mode.
SyncCompliance AssociationSyncCompliance
// The combination of Amazon Web Services Regions and Amazon Web Services accounts
// where you want to run the association.
TargetLocations []TargetLocation
// A key-value mapping of document parameters to target resources. Both Targets
// and TargetMaps can't be specified together.
TargetMaps []map[string][]string
// The managed nodes targeted by the request.
Targets []Target
// The CloudWatch alarm that was invoked during the association.
TriggeredAlarms []AlarmStateInformation
noSmithyDocumentSerde
}
// Includes information about the specified association.
type AssociationExecution struct {
// The details for the CloudWatch alarm you want to apply to an automation or
// command.
AlarmConfiguration *AlarmConfiguration
// The association ID.
AssociationId *string
// The association version.
AssociationVersion *string
// The time the execution started.
CreatedTime *time.Time
// Detailed status information about the execution.
DetailedStatus *string
// The execution ID for the association.
ExecutionId *string
// The date of the last execution.
LastExecutionDate *time.Time
// An aggregate status of the resources in the execution based on the status type.
ResourceCountByStatus *string
// The status of the association execution.
Status *string
// The CloudWatch alarms that were invoked by the association.
TriggeredAlarms []AlarmStateInformation
noSmithyDocumentSerde
}
// Filters used in the request.
type AssociationExecutionFilter struct {
// The key value used in the request.
//
// This member is required.
Key AssociationExecutionFilterKey
// The filter type specified in the request.
//
// This member is required.
Type AssociationFilterOperatorType
// The value specified for the key.
//
// This member is required.
Value *string
noSmithyDocumentSerde
}
// Includes information about the specified association execution.
type AssociationExecutionTarget struct {
// The association ID.
AssociationId *string
// The association version.
AssociationVersion *string
// Detailed information about the execution status.
DetailedStatus *string
// The execution ID.
ExecutionId *string
// The date of the last execution.
LastExecutionDate *time.Time
// The location where the association details are saved.
OutputSource *OutputSource
// The resource ID, for example, the managed node ID where the association ran.
ResourceId *string
// The resource type, for example, EC2.
ResourceType *string
// The association execution status.
Status *string
noSmithyDocumentSerde
}
// Filters for the association execution.
type AssociationExecutionTargetsFilter struct {
// The key value used in the request.
//
// This member is required.
Key AssociationExecutionTargetsFilterKey
// The value specified for the key.
//
// This member is required.
Value *string
noSmithyDocumentSerde
}
// Describes a filter.
type AssociationFilter struct {
// The name of the filter. InstanceId has been deprecated.
//
// This member is required.
Key AssociationFilterKey
// The filter value.
//
// This member is required.
Value *string
noSmithyDocumentSerde
}
// Information about the association.
type AssociationOverview struct {
// Returns the number of targets for the association status. For example, if you
// created an association with two managed nodes, and one of them was successful,
// this would return the count of managed nodes by status.
AssociationStatusAggregatedCount map[string]int32
// A detailed status of the association.
DetailedStatus *string
// The status of the association. Status can be: Pending, Success, or Failed.
Status *string
noSmithyDocumentSerde
}
// Describes an association status.
type AssociationStatus struct {
// The date when the status changed.
//
// This member is required.
Date *time.Time
// The reason for the status.
//
// This member is required.
Message *string
// The status.
//
// This member is required.
Name AssociationStatusName
// A user-defined string.
AdditionalInfo *string
noSmithyDocumentSerde
}
// Information about the association version.
type AssociationVersionInfo struct {
// By default, when you create a new associations, the system runs it immediately
// after it is created and then according to the schedule you specified. Specify
// this option if you don't want an association to run immediately after you create
// it. This parameter isn't supported for rate expressions.
ApplyOnlyAtCronInterval bool
// The ID created by the system when the association was created.
AssociationId *string
// The name specified for the association version when the association version was
// created.
AssociationName *string
// The association version.
AssociationVersion *string
// The names or Amazon Resource Names (ARNs) of the Change Calendar type documents
// your associations are gated under. The associations for this version only run
// when that Change Calendar is open. For more information, see Amazon Web
// Services Systems Manager Change Calendar (https://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-change-calendar)
// .
CalendarNames []string
// The severity level that is assigned to the association.
ComplianceSeverity AssociationComplianceSeverity
// The date the association version was created.
CreatedDate *time.Time
// The version of an Amazon Web Services Systems Manager document (SSM document)
// used when the association version was created.
DocumentVersion *string
// 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 managed node 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
// managed node will process its association within the limit specified for
// MaxConcurrency .
MaxConcurrency *string
// 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
// managed nodes 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 *string
// The name specified when the association was created.
Name *string
// The location in Amazon S3 specified for the association when the association
// version was created.
OutputLocation *InstanceAssociationOutputLocation
// Parameters specified when the association version was created.
Parameters map[string][]string
// The cron or rate schedule specified for the association when the association
// version was created.
ScheduleExpression *string
// Number of days to wait after the scheduled day to run an association.
ScheduleOffset *int32
// The mode for generating association compliance. You can specify AUTO or MANUAL .
// In AUTO mode, the system uses the status of the association execution to
// determine the compliance status. If the association execution runs successfully,
// then the association is COMPLIANT . If the association execution doesn't run
// successfully, the association is NON-COMPLIANT . In MANUAL mode, you must
// specify the AssociationId as a parameter for the PutComplianceItems API
// operation. In this case, compliance data isn't managed by State Manager, a
// capability of Amazon Web Services Systems Manager. It is managed by your direct
// call to the PutComplianceItems API operation. By default, all associations use
// AUTO mode.
SyncCompliance AssociationSyncCompliance
// The combination of Amazon Web Services Regions and Amazon Web Services accounts
// where you wanted to run the association when this association version was
// created.
TargetLocations []TargetLocation
// A key-value mapping of document parameters to target resources. Both Targets
// and TargetMaps can't be specified together.
TargetMaps []map[string][]string
// The targets specified for the association when the association version was
// created.
Targets []Target
noSmithyDocumentSerde
}
// A structure that includes attributes that describe a document attachment.
type AttachmentContent struct {
// The cryptographic hash value of the document content.
Hash *string
// The hash algorithm used to calculate the hash value.
HashType AttachmentHashType
// The name of an attachment.
Name *string
// The size of an attachment in bytes.
Size int64
// The URL location of the attachment content.
Url *string
noSmithyDocumentSerde
}
// An attribute of an attachment, such as the attachment name.
type AttachmentInformation struct {
// The name of the attachment.
Name *string
noSmithyDocumentSerde
}
// Identifying information about a document attachment, including the file name
// and a key-value pair that identifies the location of an attachment to a
// document.
type AttachmentsSource struct {
// The key of a key-value pair that identifies the location of an attachment to a
// document.
Key AttachmentsSourceKey
// The name of the document attachment file.
Name *string
// The value of a key-value pair that identifies the location of an attachment to
// a document. The format for Value depends on the type of key you specify.
// - For the key SourceUrl, the value is an S3 bucket location. For example:
// "Values": [ "s3://doc-example-bucket/my-folder" ]
// - For the key S3FileUrl, the value is a file in an S3 bucket. For example:
// "Values": [ "s3://doc-example-bucket/my-folder/my-file.py" ]
// - For the key AttachmentReference, the value is constructed from the name of
// another SSM document in your account, a version number of that document, and a
// file attached to that document version that you want to reuse. For example:
// "Values": [ "MyOtherDocument/3/my-other-file.py" ] However, if the SSM
// document is shared with you from another account, the full SSM document ARN must
// be specified instead of the document name only. For example: "Values": [
// "arn:aws:ssm:us-east-2:111122223333:document/OtherAccountDocument/3/their-file.py"
// ]
Values []string
noSmithyDocumentSerde
}
// Detailed information about the current state of an individual Automation
// execution.
type AutomationExecution struct {
// The details for the CloudWatch alarm applied to your automation.
AlarmConfiguration *AlarmConfiguration
// The ID of a State Manager association used in the Automation operation.
AssociationId *string
// The execution ID.
AutomationExecutionId *string
// The execution status of the Automation.
AutomationExecutionStatus AutomationExecutionStatus
// The subtype of the Automation operation. Currently, the only supported value is
// ChangeRequest .
AutomationSubtype AutomationSubtype
// The name of the Change Manager change request.
ChangeRequestName *string
// The action of the step that is currently running.
CurrentAction *string
// The name of the step that is currently running.
CurrentStepName *string
// The name of the Automation runbook used during the execution.
DocumentName *string
// The version of the document to use during execution.
DocumentVersion *string
// The Amazon Resource Name (ARN) of the user who ran the automation.
ExecutedBy *string
// The time the execution finished.
ExecutionEndTime *time.Time
// The time the execution started.
ExecutionStartTime *time.Time
// A message describing why an execution has failed, if the status is set to
// Failed.
FailureMessage *string
// The MaxConcurrency value specified by the user when the execution started.
MaxConcurrency *string
// The MaxErrors value specified by the user when the execution started.
MaxErrors *string
// The automation execution mode.
Mode ExecutionMode
// The ID of an OpsItem that is created to represent a Change Manager change
// request.
OpsItemId *string
// The list of execution outputs as defined in the Automation runbook.
Outputs map[string][]string
// The key-value map of execution parameters, which were supplied when calling
// StartAutomationExecution .
Parameters map[string][]string
// The AutomationExecutionId of the parent automation.
ParentAutomationExecutionId *string
// An aggregate of step execution statuses displayed in the Amazon Web Services
// Systems Manager console for a multi-Region and multi-account Automation
// execution.
ProgressCounters *ProgressCounters
// A list of resolved targets in the rate control execution.
ResolvedTargets *ResolvedTargets
// Information about the Automation runbooks that are run as part of a runbook
// workflow. The Automation runbooks specified for the runbook workflow can't run
// until all required approvals for the change request have been received.
Runbooks []Runbook
// The date and time the Automation operation is scheduled to start.
ScheduledTime *time.Time
// A list of details about the current state of all steps that comprise an
// execution. An Automation runbook contains a list of steps that are run in order.
StepExecutions []StepExecution
// A boolean value that indicates if the response contains the full list of the
// Automation step executions. If true, use the DescribeAutomationStepExecutions
// API operation to get the full list of step executions.
StepExecutionsTruncated bool
// The target of the execution.
Target *string
// The combination of Amazon Web Services Regions and/or Amazon Web Services
// accounts where you want to run the Automation.
TargetLocations []TargetLocation
// The specified key-value mapping of document parameters to target resources.
TargetMaps []map[string][]string
// The parameter name.
TargetParameterName *string
// The specified targets.
Targets []Target
// The CloudWatch alarm that was invoked by the automation.
TriggeredAlarms []AlarmStateInformation
// Variables defined for the automation.
Variables map[string][]string
noSmithyDocumentSerde
}
// A filter used to match specific automation executions. This is used to limit
// the scope of Automation execution information returned.
type AutomationExecutionFilter struct {
// One or more keys to limit the results.
//
// This member is required.
Key AutomationExecutionFilterKey
// The values used to limit the execution information associated with the filter's
// key.
//
// This member is required.
Values []string
noSmithyDocumentSerde
}
// Details about a specific Automation execution.
type AutomationExecutionMetadata struct {
// The details for the CloudWatch alarm applied to your automation.
AlarmConfiguration *AlarmConfiguration
// The ID of a State Manager association used in the Automation operation.
AssociationId *string
// The execution ID.
AutomationExecutionId *string
// The status of the execution.
AutomationExecutionStatus AutomationExecutionStatus
// The subtype of the Automation operation. Currently, the only supported value is
// ChangeRequest .
AutomationSubtype AutomationSubtype
// Use this filter with DescribeAutomationExecutions . Specify either Local or
// CrossAccount. CrossAccount is an Automation that runs in multiple Amazon Web
// Services Regions and Amazon Web Services accounts. For more information, see
// Running Automation workflows in multiple Amazon Web Services Regions and
// accounts (https://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-automation-multiple-accounts-and-regions.html)
// in the Amazon Web Services Systems Manager User Guide.
AutomationType AutomationType
// The name of the Change Manager change request.
ChangeRequestName *string
// The action of the step that is currently running.
CurrentAction *string
// The name of the step that is currently running.
CurrentStepName *string
// The name of the Automation runbook used during execution.
DocumentName *string
// The document version used during the execution.
DocumentVersion *string
// The IAM role ARN of the user who ran the automation.
ExecutedBy *string
// The time the execution finished. This isn't populated if the execution is still
// in progress.
ExecutionEndTime *time.Time
// The time the execution started.
ExecutionStartTime *time.Time
// The list of execution outputs as defined in the Automation runbook.
FailureMessage *string
// An S3 bucket where execution information is stored.
LogFile *string
// The MaxConcurrency value specified by the user when starting the automation.
MaxConcurrency *string
// The MaxErrors value specified by the user when starting the automation.
MaxErrors *string
// The Automation execution mode.
Mode ExecutionMode
// The ID of an OpsItem that is created to represent a Change Manager change
// request.
OpsItemId *string
// The list of execution outputs as defined in the Automation runbook.
Outputs map[string][]string
// The execution ID of the parent automation.
ParentAutomationExecutionId *string
// A list of targets that resolved during the execution.
ResolvedTargets *ResolvedTargets
// Information about the Automation runbooks that are run during a runbook
// workflow in Change Manager. The Automation runbooks specified for the runbook
// workflow can't run until all required approvals for the change request have been
// received.
Runbooks []Runbook
// The date and time the Automation operation is scheduled to start.
ScheduledTime *time.Time
// The list of execution outputs as defined in the Automation runbook.
Target *string
// The specified key-value mapping of document parameters to target resources.
TargetMaps []map[string][]string
// The list of execution outputs as defined in the Automation runbook.
TargetParameterName *string
// The targets defined by the user when starting the automation.
Targets []Target
// The CloudWatch alarm that was invoked by the automation.
TriggeredAlarms []AlarmStateInformation
noSmithyDocumentSerde
}
// Defines the basic information about a patch baseline override.
type BaselineOverride struct {
// A set of rules defining the approval rules for a patch 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 About
// package name formats for approved and rejected patch lists (https://docs.aws.amazon.com/systems-manager/latest/userguide/patch-manager-approved-rejected-package-name-formats.html)
// in the Amazon Web Services Systems Manager User Guide.
ApprovedPatches []string
// Defines the compliance level for approved patches. When an approved patch is
// reported as missing, this value describes the severity of the compliance
// violation.
ApprovedPatchesComplianceLevel PatchComplianceLevel
// Indicates whether the list of approved patches includes non-security updates
// that should be applied to the managed nodes. The default value is false .
// Applies to Linux managed nodes only.
ApprovedPatchesEnableNonSecurity bool
// A set of patch filters, typically used for approval rules.
GlobalFilters *PatchFilterGroup
// The operating system rule used by the patch baseline override.
OperatingSystem OperatingSystem
// A list of explicitly rejected patches for the baseline. For information about
// accepted formats for lists of approved patches and rejected patches, see About
// package name formats for approved and rejected patch lists (https://docs.aws.amazon.com/systems-manager/latest/userguide/patch-manager-approved-rejected-package-name-formats.html)
// in the Amazon Web Services Systems Manager User Guide.
RejectedPatches []string
// The action for Patch Manager to take on patches included in the RejectedPackages
// 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
// Information about the patches to use to update the managed nodes, including
// target operating systems and source repositories. Applies to Linux managed nodes
// only.
Sources []PatchSource
noSmithyDocumentSerde
}
// Configuration options for sending command output to Amazon CloudWatch Logs.
type CloudWatchOutputConfig struct {
// The name of the CloudWatch Logs log group where you want to send command
// output. If you don't specify a group name, Amazon Web Services Systems Manager
// automatically creates a log group for you. The log group uses the following
// naming format: aws/ssm/SystemsManagerDocumentName
CloudWatchLogGroupName *string
// Enables Systems Manager to send command output to CloudWatch Logs.
CloudWatchOutputEnabled bool
noSmithyDocumentSerde
}
// Describes a command request.
type Command struct {
// The details for the CloudWatch alarm applied to your command.
AlarmConfiguration *AlarmConfiguration
// Amazon CloudWatch Logs information where you want Amazon Web Services Systems
// Manager to send the command output.
CloudWatchOutputConfig *CloudWatchOutputConfig
// A unique identifier for this command.
CommandId *string
// User-specified information about the command, such as a brief description of
// what the command should do.
Comment *string
// 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, Cancelled, Terminated, or Undeliverable.
CompletedCount int32
// The number of targets for which the status is Delivery Timed Out.
DeliveryTimedOutCount int32
// The name of the document requested for execution.
DocumentName *string
// The Systems Manager document (SSM document) version.
DocumentVersion *string
// The number of targets for which the status is Failed or Execution Timed Out.
ErrorCount int32
// If a command expires, it changes status to DeliveryTimedOut for all invocations
// that have the status InProgress , Pending , or Delayed . ExpiresAfter is
// calculated based on the total timeout for the overall command. For more
// information, see Understanding command timeout values (https://docs.aws.amazon.com/systems-manager/latest/userguide/monitor-commands.html?icmpid=docs_ec2_console#monitor-about-status-timeouts)
// in the Amazon Web Services Systems Manager User Guide.
ExpiresAfter *time.Time
// The managed node IDs against which this command was requested.
InstanceIds []string
// The maximum number of managed nodes that are allowed to run the command at the
// same time. You can specify a number of managed nodes, such as 10, or a
// percentage of nodes, such as 10%. The default value is 50. For more information
// about how to use MaxConcurrency , see Running commands using Systems Manager
// Run Command (https://docs.aws.amazon.com/systems-manager/latest/userguide/run-command.html)
// in the Amazon Web Services Systems Manager User Guide.
MaxConcurrency *string
// 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 (https://docs.aws.amazon.com/systems-manager/latest/userguide/run-command.html)
// in the Amazon Web Services Systems Manager User Guide.
MaxErrors *string
// Configurations for sending notifications about command status changes.
NotificationConfig *NotificationConfig
// The S3 bucket where the responses to the command executions should be stored.
// This was requested when issuing the command.
OutputS3BucketName *string
// 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 *string
// (Deprecated) You can no longer specify this parameter. The system ignores it.
// Instead, Systems Manager automatically determines the Amazon Web Services Region
// of the S3 bucket.
OutputS3Region *string
// The parameter values to be inserted in the document when running the command.
Parameters map[string][]string
// The date and time the command was requested.
RequestedDateTime *time.Time
// The Identity and Access Management (IAM) service role that Run Command, a
// capability of Amazon Web Services Systems Manager, uses to act on your behalf
// when sending notifications about command status changes.
ServiceRole *string
// 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 (https://docs.aws.amazon.com/systems-manager/latest/userguide/monitor-commands.html)
// in the Amazon Web Services Systems Manager User Guide. StatusDetails can be one
// of the following values:
// - Pending: The command hasn't been sent to any managed nodes.
// - In Progress: The command has been sent to at least one managed node but
// hasn't reached a final state on all managed nodes.
// - 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 managed nodes and one or more
// invocations doesn't have a value of Success but not enough invocations failed
// for the status to be Failed. This is a terminal state.
// - Cancelled: The command was terminated before it was completed. This is a
// terminal state.
// - Rate Exceeded: The number of managed nodes targeted by the command exceeded
// the account limit for pending invocations. The system has canceled the command
// before running it on any managed node. This is a terminal state.
// - Delayed: The system attempted to send the command to the managed node but
// wasn't successful. The system retries again.
StatusDetails *string
// The number of targets for the command.
TargetCount int32
// An array of search criteria that targets managed nodes using a Key,Value
// combination that you specify. Targets is required if you don't provide one or
// more managed node IDs in the call.
Targets []Target
// The TimeoutSeconds value specified for a command.
TimeoutSeconds *int32
// The CloudWatch alarm that was invoked by the command.
TriggeredAlarms []AlarmStateInformation
noSmithyDocumentSerde
}
// Describes a command filter. A managed node ID can't be specified when a command
// status is Pending because the command hasn't run on the node yet.
type CommandFilter struct {
// The name of the filter. The ExecutionStage filter can't be used with the
// ListCommandInvocations operation, only with ListCommands .
//
// This member is required.
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 2021-07-07T00:00:00Z to see a list of command executions occurring
// July 7, 2021, and later.
// - InvokedBefore: Specify a timestamp to limit your results. For example,
// specify 2021-07-07T00:00:00Z to see a list of command executions from before
// July 7, 2021.
// - Status: Specify a valid command status to see a list of all command
// executions with that status. The status choices depend on the API you call. The
// status values you can specify for ListCommands are:
// - Pending
// - InProgress
// - Success
// - Cancelled
// - Failed
// - TimedOut (this includes both Delivery and Execution time outs)
// - AccessDenied
// - DeliveryTimedOut
// - ExecutionTimedOut
// - Incomplete
// - NoInstancesInTag
// - LimitExceeded The status values you can specify for ListCommandInvocations
// are:
// - Pending
// - InProgress
// - Delayed
// - Success
// - Cancelled
// - Failed
// - TimedOut (this includes both Delivery and Execution time outs)
// - AccessDenied
// - DeliveryTimedOut
// - ExecutionTimedOut
// - Undeliverable
// - InvalidPlatform
// - Terminated
// - DocumentName: Specify name of the Amazon Web Services Systems Manager
// document (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 managed nodes.
// - ExecutionStage: Specify one of the following values ( ListCommands
// operations only):
// - Executing : Returns a list of command executions that are currently still
// running.
// - Complete : Returns a list of command executions that have already completed.
//
// This member is required.
Value *string
noSmithyDocumentSerde
}
// An invocation is a copy of a command sent to a specific managed node. A command
// can apply to one or more managed nodes. A command invocation applies to one
// managed node. For example, if a user runs SendCommand against three managed
// nodes, then a command invocation is created for each requested managed node ID.
// A command invocation returns status and detail information about a command you
// ran.
type CommandInvocation struct {
// Amazon CloudWatch Logs information where you want Amazon Web Services Systems
// Manager to send the command output.
CloudWatchOutputConfig *CloudWatchOutputConfig
// The command against which this invocation was requested.
CommandId *string
// Plugins processed by the command.
CommandPlugins []CommandPlugin
// User-specified information about the command, such as a brief description of
// what the command should do.
Comment *string
// The document name that was requested for execution.
DocumentName *string
// The Systems Manager document (SSM document) version.
DocumentVersion *string
// The managed node ID in which this invocation was requested.
InstanceId *string
// The fully qualified host name of the managed node.
InstanceName *string
// Configurations for sending notifications about command status changes on a per
// managed node basis.
NotificationConfig *NotificationConfig
// The time and date the request was sent to this managed node.
RequestedDateTime *time.Time
// The Identity and Access Management (IAM) service role that Run Command, a
// capability of Amazon Web Services Systems Manager, uses to act on your behalf
// when sending notifications about command status changes on a per managed node
// basis.
ServiceRole *string
// The URL to the plugin's StdErr file in Amazon Simple Storage Service (Amazon
// S3), if the 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 S3 bucket was defined for the command.
StandardErrorUrl *string
// The URL to the plugin's StdOut file in Amazon Simple Storage Service (Amazon
// S3), if the 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 S3 bucket was defined for the command.
StandardOutputUrl *string
// Whether or not the invocation succeeded, failed, or is pending.
Status CommandInvocationStatus
// A detailed status of the command execution for each invocation (each managed
// node 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 (https://docs.aws.amazon.com/systems-manager/latest/userguide/monitor-commands.html)
// in the Amazon Web Services Systems Manager User Guide. StatusDetails can be one
// of the following values:
// - Pending: The command hasn't been sent to the managed node.
// - In Progress: The command has been sent to the managed node but hasn't
// 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 wasn't delivered to the managed node before
// the delivery timeout expired. Delivery timeouts don't 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 managed node, but the
// execution wasn't 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 wasn't successful on the managed node. For a plugin,
// this indicates that the result code wasn't zero. For a command invocation, this
// indicates that the result code for one or more plugins wasn't zero. Invocation
// failures count against the MaxErrors limit of the parent command. This is a
// terminal state.
// - Cancelled: The command was terminated before it was completed. This is a
// terminal state.
// - Undeliverable: The command can't be delivered to the managed node. The
// managed node 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.
// - Delayed: The system attempted to send the command to the managed node but
// wasn't successful. The system retries again.
StatusDetails *string
// Gets the trace output sent by the agent.
TraceOutput *string
noSmithyDocumentSerde
}
// Describes plugin details.
type CommandPlugin struct {
// 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 *string
// Output of the plugin execution.
Output *string
// 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:
// doc-example-bucket/ab19cb99-a030-46dd-9dfc-8eSAMPLEPre-Fix/i-02573cafcfEXAMPLE/awsrunShellScript
// doc-example-bucket is the name of the S3 bucket;
// ab19cb99-a030-46dd-9dfc-8eSAMPLEPre-Fix is the name of the S3 prefix;
// i-02573cafcfEXAMPLE is the managed node ID; awsrunShellScript is the name of
// the plugin.
OutputS3BucketName *string
// 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:
// doc-example-bucket/ab19cb99-a030-46dd-9dfc-8eSAMPLEPre-Fix/i-02573cafcfEXAMPLE/awsrunShellScript
// doc-example-bucket is the name of the S3 bucket;
// ab19cb99-a030-46dd-9dfc-8eSAMPLEPre-Fix is the name of the S3 prefix;
// i-02573cafcfEXAMPLE is the managed node ID; awsrunShellScript is the name of
// the plugin.
OutputS3KeyPrefix *string
// (Deprecated) You can no longer specify this parameter. The system ignores it.
// Instead, Amazon Web Services Systems Manager automatically determines the S3
// bucket region.
OutputS3Region *string
// A numeric response code generated after running the plugin.
ResponseCode int32
// The time the plugin stopped running. Could stop prematurely if, for example, a
// cancel command was sent.
ResponseFinishDateTime *time.Time
// The time the plugin started running.
ResponseStartDateTime *time.Time
// The URL for the complete text written by the plugin to stderr. If execution
// isn't yet complete, then this string is empty.
StandardErrorUrl *string
// The URL for the complete text written by the plugin to stdout in Amazon S3. If
// the S3 bucket for the command wasn't specified, then this string is empty.
StandardOutputUrl *string
// 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 (https://docs.aws.amazon.com/systems-manager/latest/userguide/monitor-commands.html)
// in the Amazon Web Services Systems Manager User Guide. StatusDetails can be one
// of the following values:
// - Pending: The command hasn't been sent to the managed node.
// - In Progress: The command has been sent to the managed node but hasn't
// 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 wasn't delivered to the managed node before
// the delivery timeout expired. Delivery timeouts don't 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 managed node, but the
// execution wasn't 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 wasn't successful on the managed node. For a plugin,
// this indicates that the result code wasn't zero. For a command invocation, this
// indicates that the result code for one or more plugins wasn't zero. Invocation
// failures count against the MaxErrors limit of the parent command. This is a
// terminal state.
// - Cancelled: The command was terminated before it was completed. This is a
// terminal state.
// - Undeliverable: The command can't be delivered to the managed node. The
// managed node 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 *string
noSmithyDocumentSerde
}
// 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'.
type ComplianceExecutionSummary struct {
// The time the execution ran as a datetime object that is saved in the following
// format: yyyy-MM-dd'T'HH:mm:ss'Z'.
//
// This member is required.
ExecutionTime *time.Time
// 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 *string
// The type of execution. For example, Command is a valid execution type.
ExecutionType *string
noSmithyDocumentSerde
}
// Information about the compliance as defined by the resource type. For example,
// for a patch resource type, Items includes information about the PatchSeverity,
// Classification, and so on.
type ComplianceItem struct {
// The compliance type. For example, Association (for a State Manager
// association), Patch, or Custom: string are all valid compliance types.
ComplianceType *string
// A "Key": "Value" tag combination for the compliance item.
Details map[string]string
// A summary for the compliance item. The summary includes an execution ID, the
// execution type (for example, command), and the execution time.
ExecutionSummary *ComplianceExecutionSummary
// 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 *string
// An ID for the resource. For a managed node, this is the node ID.
ResourceId *string
// The type of resource. ManagedInstance is currently the only supported resource
// type.
ResourceType *string
// 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, NON_COMPLIANT,
// or an empty string (for Windows patches that aren't applicable).
Status ComplianceStatus
// 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 *string
noSmithyDocumentSerde
}
// Information about a compliance item.
type ComplianceItemEntry struct {
// The severity of the compliance status. Severity can be one of the following:
// Critical, High, Medium, Low, Informational, Unspecified.
//
// This member is required.
Severity ComplianceSeverity
// The status of the compliance item. An item is either COMPLIANT or NON_COMPLIANT.
//
// This member is required.
Status ComplianceStatus
// A "Key": "Value" tag combination for the compliance item.
Details map[string]string
// 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 *string
// 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 *string
noSmithyDocumentSerde
}
// One or more filters. Use a filter to return a more specific list of results.
type ComplianceStringFilter struct {
// The name of the filter.
Key *string
// The type of comparison that should be performed for the value: Equal, NotEqual,
// BeginWith, LessThan, or GreaterThan.
Type ComplianceQueryOperatorType
// The value for which to search.
Values []string
noSmithyDocumentSerde
}
// A summary of compliance information by compliance type.
type ComplianceSummaryItem struct {
// The type of compliance item. For example, the compliance type can be
// Association, Patch, or Custom:string.
ComplianceType *string
// 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
noSmithyDocumentSerde
}
// A summary of resources that are compliant. The summary is organized according
// to the resource count for each compliance type.
type CompliantSummary struct {
// The total number of resources that are compliant.
CompliantCount int32
// A summary of the compliance severity by compliance type.
SeveritySummary *SeveritySummary
noSmithyDocumentSerde
}
// Describes the association of a Amazon Web Services Systems Manager document
// (SSM document) and a managed node.
type CreateAssociationBatchRequestEntry struct {
// The name of the SSM document that contains the configuration information for
// the managed node. You can specify Command or Automation runbooks. You can
// specify Amazon Web Services-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 Amazon Web Services 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 Amazon Web
// Services-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 .
//
// This member is required.
Name *string
// The details for the CloudWatch alarm you want to apply to an automation or
// command.
AlarmConfiguration *AlarmConfiguration
// By default, when you create a new associations, the system runs it immediately
// after it is created and then according to the schedule you specified. Specify
// this option if you don't want an association to run immediately after you create
// it. This parameter isn't supported for rate expressions.
ApplyOnlyAtCronInterval bool
// Specify a descriptive name for the association.
AssociationName *string
// Specify the target for the association. This target is required for
// associations that use an Automation runbook and target resources by using rate
// controls. Automation is a capability of Amazon Web Services Systems Manager.
AutomationTargetParameterName *string
// The names or Amazon Resource Names (ARNs) of the Change Calendar type documents
// your associations are gated under. The associations only run when that Change
// Calendar is open. For more information, see Amazon Web Services Systems Manager
// Change Calendar (https://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-change-calendar)
// .
CalendarNames []string
// The severity level to assign to the association.
ComplianceSeverity AssociationComplianceSeverity
// The document version.
DocumentVersion *string
// The managed node ID. InstanceId has been deprecated. To specify a managed node
// ID for an association, use the Targets parameter. Requests that include the
// parameter InstanceID with Systems Manager documents (SSM documents) that use
// schema version 2.0 or later will fail. In addition, if you use the parameter
// InstanceId , you can't use the parameters AssociationName , DocumentVersion ,
// MaxErrors , MaxConcurrency , OutputLocation , or ScheduleExpression . To use
// these parameters, you must use the Targets parameter.
InstanceId *string
// 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 managed node 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
// managed node will process its association within the limit specified for
// MaxConcurrency .
MaxConcurrency *string
// 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
// managed nodes 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 *string
// An S3 bucket where you want to store the results of this request.
OutputLocation *InstanceAssociationOutputLocation
// A description of the parameters for a document.
Parameters map[string][]string
// A cron expression that specifies a schedule when the association runs.
ScheduleExpression *string
// Number of days to wait after the scheduled day to run an association.
ScheduleOffset *int32
// The mode for generating association compliance. You can specify AUTO or MANUAL .
// In AUTO mode, the system uses the status of the association execution to
// determine the compliance status. If the association execution runs successfully,
// then the association is COMPLIANT . If the association execution doesn't run
// successfully, the association is NON-COMPLIANT . In MANUAL mode, you must
// specify the AssociationId as a parameter for the PutComplianceItems API
// operation. In this case, compliance data isn't managed by State Manager, a
// capability of Amazon Web Services Systems Manager. It is managed by your direct
// call to the PutComplianceItems API operation. By default, all associations use
// AUTO mode.
SyncCompliance AssociationSyncCompliance
// Use this action to create an association in multiple Regions and multiple
// accounts.
TargetLocations []TargetLocation
// A key-value mapping of document parameters to target resources. Both Targets
// and TargetMaps can't be specified together.
TargetMaps []map[string][]string
// The managed nodes targeted by the request.
Targets []Target
noSmithyDocumentSerde
}
// Filter for the DescribeActivation API.
type DescribeActivationsFilter struct {
// The name of the filter.
FilterKey DescribeActivationsFilterKeys
// The filter values.
FilterValues []string
noSmithyDocumentSerde
}
// A default version of a document.
type DocumentDefaultVersionDescription struct {
// The default version of the document.
DefaultVersion *string
// The default version of the artifact associated with the document.
DefaultVersionName *string
// The name of the document.
Name *string
noSmithyDocumentSerde
}
// Describes an Amazon Web Services Systems Manager document (SSM document).
type DocumentDescription struct {
// The version of the document currently approved for use in the organization.
ApprovedVersion *string
// Details about the document attachments, including names, locations, sizes, and
// so on.
AttachmentsInformation []AttachmentInformation
// The user in your organization who created the document.
Author *string
// The classification of a document to help you identify and categorize its use.
Category []string
// The value that identifies a document's category.
CategoryEnum []string
// The date when the document was created.
CreatedDate *time.Time
// The default version.
DefaultVersion *string
// A description of the document.
Description *string
// The friendly name of the SSM document. This value can differ for each version
// of the document. If you want to update this value, see UpdateDocument .
DisplayName *string
// The document format, either JSON or YAML.
DocumentFormat DocumentFormat
// The type of document.
DocumentType DocumentType
// The document version.
DocumentVersion *string
// The Sha256 or Sha1 hash created by the system when the document was created.
// Sha1 hashes have been deprecated.
Hash *string
// The hash type of the document. Valid values include Sha256 or Sha1 . Sha1 hashes
// have been deprecated.
HashType DocumentHashType
// The latest version of the document.
LatestVersion *string
// The name of the SSM document.
Name *string
// The Amazon Web Services user that created the document.
Owner *string
// A description of the parameters for a document.
Parameters []DocumentParameter
// The version of the document that is currently under review.
PendingReviewVersion *string
// The list of operating system (OS) platforms compatible with this SSM document.
PlatformTypes []PlatformType
// A list of SSM documents required by a document. For example, an
// ApplicationConfiguration document requires an ApplicationConfigurationSchema
// document.
Requires []DocumentRequires
// Details about the review of a document.
ReviewInformation []ReviewInformation
// The current status of the review.
ReviewStatus ReviewStatus
// The schema version.
SchemaVersion *string
// The SHA1 hash of the document, which you can use for verification.
Sha1 *string
// The status of the SSM document.
Status DocumentStatus
// A message returned by Amazon Web Services Systems Manager that explains the
// Status value. For example, a Failed status might be explained by the
// StatusInformation message, "The specified S3 bucket doesn't exist. Verify that
// the URL of the S3 bucket is correct."
StatusInformation *string
// The tags, or metadata, that have been applied to the document.
Tags []Tag
// 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
// Amazon Web Services resource and property types reference (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html)
// in the CloudFormation User Guide.
TargetType *string
// The version of the artifact associated with the document.
VersionName *string
noSmithyDocumentSerde
}
// This data type is deprecated. Instead, use DocumentKeyValuesFilter .
type DocumentFilter struct {
// The name of the filter.
//
// This member is required.
Key DocumentFilterKey
// The value of the filter.
//
// This member is required.
Value *string
noSmithyDocumentSerde
}
// Describes the name of a SSM document.
type DocumentIdentifier struct {
// The user in your organization who created the document.
Author *string
// The date the SSM document was created.
CreatedDate *time.Time
// An optional field where you can specify a friendly name for the SSM document.
// This value can differ for each version of the document. If you want to update
// this value, see UpdateDocument .
DisplayName *string
// The document format, either JSON or YAML.
DocumentFormat DocumentFormat
// The document type.
DocumentType DocumentType
// The document version.
DocumentVersion *string
// The name of the SSM document.
Name *string
// The Amazon Web Services user that created the document.
Owner *string
// The operating system platform.
PlatformTypes []PlatformType
// A list of SSM documents required by a document. For example, an
// ApplicationConfiguration document requires an ApplicationConfigurationSchema
// document.
Requires []DocumentRequires
// The current status of a document review.
ReviewStatus ReviewStatus
// The schema version.
SchemaVersion *string
// The tags, or metadata, that have been applied to the document.
Tags []Tag
// 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
// Amazon Web Services resource and property types reference (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html)
// in the CloudFormation User Guide.
TargetType *string
// 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 can't be changed.
VersionName *string
noSmithyDocumentSerde
}
// One or more filters. Use a filter to return a more specific list of documents.
// For keys, you can specify one or more tags that have been applied to a document.
// You can also use Amazon Web Services-provided keys, some of which have specific
// allowed values. These keys and their associated values are as follows:
// DocumentType
// - ApplicationConfiguration
// - ApplicationConfigurationSchema
// - Automation
// - ChangeCalendar
// - Command
// - Package
// - Policy
// - Session
//
// Owner Note that only one Owner can be specified in a request. For example:
// Key=Owner,Values=Self .
// - Amazon
// - Private
// - Public
// - Self
// - ThirdParty
//
// PlatformTypes
// - Linux
// - Windows
//
// Name is another Amazon Web Services-provided key. If you use Name as a key, you
// can use a name prefix to return a list of documents. For example, in the Amazon
// Web Services CLI, to return a list of all documents that begin with Te , run the
// following command: aws ssm list-documents --filters Key=Name,Values=Te You can
// also use the TargetType Amazon Web Services-provided key. For a list of valid
// resource type values that can be used with this key, see Amazon Web Services
// resource and property types reference (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html)
// in the CloudFormation User Guide. If you specify more than two keys, only
// documents that are identified by all the tags are returned in the results. If
// you specify more than two values for a key, documents that are identified by any
// of the values are returned in the results. To specify a custom key-value pair,
// use the format Key=tag:tagName,Values=valueName . For example, if you created a
// key called region and are using the Amazon Web Services CLI to call the
// list-documents command: aws ssm list-documents --filters
// Key=tag:region,Values=east,west Key=Owner,Values=Self
type DocumentKeyValuesFilter struct {
// The name of the filter key.
Key *string
// The value for the filter key.
Values []string
noSmithyDocumentSerde
}
// Details about the response to a document review request.
type DocumentMetadataResponseInfo struct {
// Details about a reviewer's response to a document review request.
ReviewerResponse []DocumentReviewerResponseSource
noSmithyDocumentSerde
}
// Parameters specified in a Systems Manager document that run on the server when
// the command is run.
type DocumentParameter struct {
// If specified, the default values for the parameters. Parameters without a
// default value are required. Parameters with a default value are optional.
DefaultValue *string
// A description of what the parameter does, how to use it, the default value, and
// whether or not the parameter is optional.
Description *string
// The name of the parameter.
Name *string
// The type of parameter. The type can be either String or StringList.
Type DocumentParameterType
noSmithyDocumentSerde
}
// An SSM document required by the current document.
type DocumentRequires struct {
// The name of the required SSM document. The name can be an Amazon Resource Name
// (ARN).
//
// This member is required.
Name *string
// The document type of the required SSM document.
RequireType *string
// The document version required by the current document.
Version *string
// 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 can't be changed.
VersionName *string
noSmithyDocumentSerde
}
// Information about comments added to a document review request.
type DocumentReviewCommentSource struct {
// The content of a comment entered by a user who requests a review of a new
// document version, or who reviews the new version.
Content *string
// The type of information added to a review request. Currently, only the value
// Comment is supported.
Type DocumentReviewCommentType
noSmithyDocumentSerde
}
// Information about a reviewer's response to a document review request.
type DocumentReviewerResponseSource struct {
// The comment entered by a reviewer as part of their document review response.
Comment []DocumentReviewCommentSource
// The date and time that a reviewer entered a response to a document review
// request.
CreateTime *time.Time
// The current review status of a new custom SSM document created by a member of
// your organization, or of the latest version of an existing SSM document. Only
// one version of a document can be in the APPROVED state at a time. When a new
// version is approved, the status of the previous version changes to REJECTED.
// Only one version of a document can be in review, or PENDING, at a time.
ReviewStatus ReviewStatus
// The user in your organization assigned to review a document request.
Reviewer *string
// The date and time that a reviewer last updated a response to a document review
// request.
UpdatedTime *time.Time
noSmithyDocumentSerde
}
// Information about a document approval review.
type DocumentReviews struct {
// The action to take on a document approval review request.
//
// This member is required.
Action DocumentReviewAction
// A comment entered by a user in your organization about the document review
// request.
Comment []DocumentReviewCommentSource
noSmithyDocumentSerde
}
// Version information about the document.
type DocumentVersionInfo struct {
// The date the document was created.
CreatedDate *time.Time
// The friendly name of the SSM document. This value can differ for each version
// of the document. If you want to update this value, see UpdateDocument .
DisplayName *string
// The document format, either JSON or YAML.
DocumentFormat DocumentFormat
// The document version.
DocumentVersion *string
// An identifier for the default version of the document.
IsDefaultVersion bool
// The document name.
Name *string
// The current status of the approval review for the latest version of the
// document.
ReviewStatus ReviewStatus
// The status of the SSM document, such as Creating , Active , Failed , and
// Deleting .
Status DocumentStatus
// A message returned by Amazon Web Services Systems Manager that explains the
// Status value. For example, a Failed status might be explained by the
// StatusInformation message, "The specified S3 bucket doesn't exist. Verify that
// the URL of the S3 bucket is correct."
StatusInformation *string
// 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 can't
// be changed.
VersionName *string
noSmithyDocumentSerde
}
// The EffectivePatch structure defines metadata about a patch along with the
// approval state of the patch in a particular patch baseline. The approval state
// 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.
type EffectivePatch struct {
// 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
noSmithyDocumentSerde
}
// Describes a failed association.
type FailedCreateAssociation struct {
// The association.
Entry *CreateAssociationBatchRequestEntry
// The source of the failure.
Fault Fault
// A description of the failure.
Message *string
noSmithyDocumentSerde
}
// Information about an Automation failure.
type FailureDetails struct {
// Detailed information about the Automation step failure.
Details map[string][]string
// 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
noSmithyDocumentSerde
}
// A resource policy helps you to define the IAM entity (for example, an Amazon
// Web Services account) that can manage your Systems Manager resources. Currently,
// OpsItemGroup is the only resource that supports Systems Manager resource
// policies. The resource policy for OpsItemGroup enables Amazon Web Services
// accounts to view and interact with OpsCenter operational work items (OpsItems).
type GetResourcePoliciesResponseEntry struct {
// A resource policy helps you to define the IAM entity (for example, an Amazon
// Web Services account) that can manage your Systems Manager resources. Currently,
// OpsItemGroup is the only resource that supports Systems Manager resource
// policies. The resource policy for OpsItemGroup enables Amazon Web Services
// accounts to view and interact with OpsCenter operational work items (OpsItems).
Policy *string
// ID of the current policy version. The hash helps to prevent a situation where
// multiple users attempt to overwrite a policy. You must provide this hash when
// updating or deleting a policy.
PolicyHash *string
// A policy ID.
PolicyId *string
noSmithyDocumentSerde
}
// Status information about the aggregated associations.
type InstanceAggregatedAssociationOverview struct {
// Detailed status information about the aggregated associations.
DetailedStatus *string
// The number of associations for the managed node(s).
InstanceAssociationStatusAggregatedCount map[string]int32
noSmithyDocumentSerde
}
// One or more association documents on the managed node.
type InstanceAssociation struct {
// The association ID.
AssociationId *string
// Version information for the association on the managed node.
AssociationVersion *string
// The content of the association document for the managed node(s).
Content *string
// The managed node ID.
InstanceId *string
noSmithyDocumentSerde
}
// An S3 bucket where you want to store the results of this request. For the
// minimal permissions required to enable Amazon S3 output for an association, see
// Creating associations (https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-state-assoc.html)
// in the Systems Manager User Guide.
type InstanceAssociationOutputLocation struct {
// An S3 bucket where you want to store the results of this request.
S3Location *S3OutputLocation
noSmithyDocumentSerde
}
// The URL of S3 bucket where you want to store the results of this request.
type InstanceAssociationOutputUrl struct {
// The URL of S3 bucket where you want to store the results of this request.
S3OutputUrl *S3OutputUrl
noSmithyDocumentSerde
}
// Status information about the association.
type InstanceAssociationStatusInfo struct {
// The association ID.
AssociationId *string
// The name of the association applied to the managed node.
AssociationName *string
// The version of the association applied to the managed node.
AssociationVersion *string
// Detailed status information about the association.
DetailedStatus *string
// The association document versions.
DocumentVersion *string
// An error code returned by the request to create the association.
ErrorCode *string
// The date the association ran.
ExecutionDate *time.Time
// Summary information about association execution.
ExecutionSummary *string
// The managed node ID where the association was created.
InstanceId *string
// The name of the association.
Name *string
// A URL for an S3 bucket where you want to store the results of this request.
OutputUrl *InstanceAssociationOutputUrl
// Status information about the association.
Status *string
noSmithyDocumentSerde
}
// Describes a filter for a specific list of managed nodes.
type InstanceInformation struct {
// The activation ID created by Amazon Web Services Systems Manager when the
// server or virtual machine (VM) was registered.
ActivationId *string
// The version of SSM Agent running on your Linux managed node.
AgentVersion *string
// Information about the association.
AssociationOverview *InstanceAggregatedAssociationOverview
// The status of the association.
AssociationStatus *string
// The fully qualified host name of the managed node.
ComputerName *string
// The IP address of the managed node.
IPAddress *string
// The Identity and Access Management (IAM) role assigned to the on-premises
// Systems Manager managed node. This call doesn't return the IAM role for Amazon
// Elastic Compute Cloud (Amazon EC2) instances. To retrieve the IAM role for an
// EC2 instance, use the Amazon EC2 DescribeInstances operation. For information,
// see DescribeInstances (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeInstances.html)
// in the Amazon EC2 API Reference or describe-instances (https://docs.aws.amazon.com/cli/latest/reference/ec2/describe-instances.html)
// in the Amazon Web Services CLI Command Reference.
IamRole *string
// The managed node ID.
InstanceId *string
// Indicates whether the latest version of SSM Agent is running on your Linux
// managed node. This field doesn't indicate whether or not the latest version is
// installed on Windows managed nodes, because some older versions of Windows
// Server use the EC2Config service to process Systems Manager requests.
IsLatestVersion *bool
// The date the association was last run.
LastAssociationExecutionDate *time.Time
// The date and time when the agent last pinged the Systems Manager service.
LastPingDateTime *time.Time
// The last date the association was successfully run.
LastSuccessfulAssociationExecutionDate *time.Time
// The name assigned to an on-premises server, edge device, or virtual machine
// (VM) when it is activated as a Systems Manager managed node. The name is
// specified as the DefaultInstanceName property using the CreateActivation
// command. It is applied to the managed node by specifying the Activation Code and
// Activation ID when you install SSM Agent on the node, as explained in Install
// SSM Agent for a hybrid environment (Linux) (https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-install-managed-linux.html)
// and Install SSM Agent for a hybrid environment (Windows) (https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-install-managed-win.html)
// . To retrieve the Name tag of an EC2 instance, use the Amazon EC2
// DescribeInstances operation. For information, see DescribeInstances (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeInstances.html)
// in the Amazon EC2 API Reference or describe-instances (https://docs.aws.amazon.com/cli/latest/reference/ec2/describe-instances.html)
// in the Amazon Web Services CLI Command Reference.
Name *string
// Connection status of SSM Agent. The status Inactive has been deprecated and is
// no longer in use.
PingStatus PingStatus
// The name of the operating system platform running on your managed node.
PlatformName *string
// The operating system platform type.
PlatformType PlatformType
// The version of the OS platform running on your managed node.
PlatformVersion *string
// The date the server or VM was registered with Amazon Web Services as a managed
// node.
RegistrationDate *time.Time
// The type of instance. Instances are either EC2 instances or managed instances.
ResourceType ResourceType
// The ID of the source resource. For IoT Greengrass devices, SourceId is the
// Thing name.
SourceId *string
// The type of the source resource. For IoT Greengrass devices, SourceType is
// AWS::IoT::Thing .
SourceType SourceType
noSmithyDocumentSerde
}
// Describes a filter for a specific list of managed nodes. You can filter node
// information by using tags. You specify tags by using a key-value mapping. Use
// this operation instead of the
// DescribeInstanceInformationRequest$InstanceInformationFilterList method. The
// InstanceInformationFilterList method is a legacy method and doesn't support tags.
type InstanceInformationFilter struct {
// The name of the filter.
//
// This member is required.
Key InstanceInformationFilterKey
// The filter values.
//
// This member is required.
ValueSet []string
noSmithyDocumentSerde
}
// The filters to describe or get information about your managed nodes.
type InstanceInformationStringFilter struct {
// The filter key name to describe your managed nodes. Valid filter key values:
// ActivationIds | AgentVersion | AssociationStatus | IamRole | InstanceIds |
// PingStatus | PlatformTypes | ResourceType | SourceIds | SourceTypes | "tag-key"
// | "tag: {keyname}
// - Valid values for the AssociationStatus filter key: Success | Pending |
// Failed
// - Valid values for the PingStatus filter key: Online | ConnectionLost |
// Inactive (deprecated)
// - Valid values for the PlatformType filter key: Windows | Linux | MacOS
// - Valid values for the ResourceType filter key: EC2Instance | ManagedInstance
// - Valid values for the SourceType filter key: AWS::EC2::Instance |
// AWS::SSM::ManagedInstance | AWS::IoT::Thing
// - Valid tag examples: Key=tag-key,Values=Purpose | Key=tag:Purpose,Values=Test
// .
//
// This member is required.
Key *string
// The filter values.
//
// This member is required.
Values []string
noSmithyDocumentSerde
}
// Defines the high-level patch compliance state for a managed node, providing
// information about the number of installed, missing, not applicable, and failed
// patches along with metadata about the operation when this information was
// gathered for the managed node.
type InstancePatchState struct {
// The ID of the patch baseline used to patch the managed node.
//
// This member is required.
BaselineId *string
// The ID of the managed node the high-level patch compliance information was
// collected for.
//
// This member is required.
InstanceId *string
// The type of patching operation that was performed: or
// - SCAN assesses the patch compliance state.
// - INSTALL installs missing patches.
//
// This member is required.
Operation PatchOperationType
// The time the most recent patching operation completed on the managed node.
//
// This member is required.
OperationEndTime *time.Time
// The time the most recent patching operation was started on the managed node.
//
// This member is required.
OperationStartTime *time.Time
// The name of the patch group the managed node belongs to.
//
// This member is required.
PatchGroup *string
// The number of patches per node that are specified as Critical for compliance
// reporting in the patch baseline aren't installed. These patches might be
// missing, have failed installation, were rejected, or were installed but awaiting
// a required managed node reboot. The status of these managed nodes is
// NON_COMPLIANT .
CriticalNonCompliantCount *int32
// The number of patches from the patch baseline that were attempted to be
// installed during the last patching operation, but failed to install.
FailedCount int32
// An https URL or an Amazon Simple Storage Service (Amazon S3) path-style URL to
// a list of patches to be installed. This patch installation list, which you
// maintain in an 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 AWS-RunPatchBaseline (https://docs.aws.amazon.com/systems-manager/latest/userguide/patch-manager-about-aws-runpatchbaseline.html)
// SSM document in the Amazon Web Services Systems Manager User Guide.
InstallOverrideList *string
// The number of patches from the patch baseline that are installed on the managed
// node.
InstalledCount int32
// The number of patches not specified in the patch baseline that are installed on
// the managed node.
InstalledOtherCount int32
// The number of patches installed by Patch Manager since the last time the
// managed node was rebooted.
InstalledPendingRebootCount *int32
// The number of patches installed on a managed node 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 *int32
// The time of the last attempt to patch the managed node with NoReboot specified
// as the reboot option.
LastNoRebootInstallOperationTime *time.Time
// The number of patches from the patch baseline that are applicable for the
// managed node but aren't currently installed.
MissingCount int32
// The number of patches from the patch baseline that aren't applicable for the
// managed node and therefore aren't installed on the node. 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 int32
// The number of patches per node that are specified as other than Critical or
// Security but aren't compliant with the patch baseline. The status of these
// managed nodes is NON_COMPLIANT .
OtherNonCompliantCount *int32
// Placeholder information. This field will always be empty in the current release
// of the service.
OwnerInformation *string
// Indicates the reboot option specified in the patch baseline. Reboot options
// apply to Install operations only. Reboots aren't attempted for Patch Manager
// Scan operations.
// - RebootIfNeeded : Patch Manager tries to reboot the managed node if it
// installed any patches, or if any patches are detected with a status of
// InstalledPendingReboot .
// - NoReboot : Patch Manager attempts to install missing packages without trying
// to reboot the system. Patches installed with this option are assigned a status
// of InstalledPendingReboot . These patches might not be in effect until a
// reboot is performed.
RebootOption RebootOption
// The number of patches per node that are specified as Security in a patch
// advisory aren't installed. These patches might be missing, have failed
// installation, were rejected, or were installed but awaiting a required managed
// node reboot. The status of these managed nodes is NON_COMPLIANT .
SecurityNonCompliantCount *int32
// The ID of the patch baseline snapshot used during the patching operation when
// this compliance data was collected.
SnapshotId *string
// The number of patches beyond the supported limit of NotApplicableCount that
// aren't reported by name to Inventory. Inventory is a capability of Amazon Web
// Services Systems Manager.
UnreportedNotApplicableCount *int32
noSmithyDocumentSerde
}
// Defines a filter used in DescribeInstancePatchStatesForPatchGroup to scope down
// the information returned by the API. Example: To filter for all managed nodes in
// a patch group having more than three patches with a FailedCount status, use the
// following for the filter:
// - Value for Key : FailedCount
// - Value for Type : GreaterThan
// - Value for Values : 3
type InstancePatchStateFilter struct {
// The key for the filter. Supported values include the following:
// - InstalledCount
// - InstalledOtherCount
// - InstalledPendingRebootCount
// - InstalledRejectedCount
// - MissingCount
// - FailedCount
// - UnreportedNotApplicableCount
// - NotApplicableCount
//
// This member is required.
Key *string
// The type of comparison that should be performed for the value.
//
// This member is required.
Type InstancePatchStateOperatorType
// The value for the filter. Must be an integer greater than or equal to 0.
//
// This member is required.
Values []string
noSmithyDocumentSerde
}
// Specifies the inventory type and attribute for the aggregation execution.
type InventoryAggregator struct {
// Nested aggregators to further refine aggregation for an inventory type.
Aggregators []InventoryAggregator
// The inventory type and attribute name for aggregation.
Expression *string
// 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 []InventoryGroup
noSmithyDocumentSerde
}
// Status information returned by the DeleteInventory operation.
type InventoryDeletionStatusItem struct {
// The deletion ID returned by the DeleteInventory operation.
DeletionId *string
// The UTC timestamp when the delete operation started.
DeletionStartTime *time.Time
// Information about the delete operation. For more information about this
// summary, see Understanding the delete inventory summary (https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-inventory-custom.html#sysman-inventory-delete)
// in the Amazon Web Services Systems Manager User Guide.
DeletionSummary *InventoryDeletionSummary
// The status of the operation. Possible values are InProgress and Complete.
LastStatus InventoryDeletionStatus
// Information about the status.
LastStatusMessage *string
// The UTC timestamp of when the last status report.
LastStatusUpdateTime *time.Time
// The name of the inventory data type.
TypeName *string
noSmithyDocumentSerde
}
// Information about the delete operation.
type InventoryDeletionSummary struct {
// Remaining number of items to delete.
RemainingCount int32
// A list of counts and versions for deleted items.
SummaryItems []InventoryDeletionSummaryItem
// The total number of items to delete. This count doesn't change during the
// delete operation.
TotalCount int32
noSmithyDocumentSerde
}
// Either a count, remaining count, or a version number in a delete inventory
// summary.
type InventoryDeletionSummaryItem struct {
// A count of the number of deleted items.
Count int32
// The remaining number of items to delete.
RemainingCount int32
// The inventory type version.
Version *string
noSmithyDocumentSerde
}
// One or more filters. Use a filter to return a more specific list of results.
type InventoryFilter struct {
// The name of the filter key.
//
// This member is required.
Key *string
// Inventory filter values. Example: inventory filter where managed node IDs are
// specified as values Key=AWS:InstanceInformation.InstanceId,Values=
// i-a12b3c4d5e6g, i-1a2b3c4d5e6,Type=Equal .
//
// This member is required.
Values []string
// The type of filter. The Exists filter must be used with aggregators. For more
// information, see Aggregating inventory data (https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-inventory-aggregate.html)
// in the Amazon Web Services Systems Manager User Guide.
Type InventoryQueryOperatorType
noSmithyDocumentSerde
}
// 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.
type InventoryGroup struct {
// 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.
//
// This member is required.
Filters []InventoryFilter
// The name of the group.
//
// This member is required.
Name *string
noSmithyDocumentSerde
}
// Information collected from managed nodes based on your inventory policy document
type InventoryItem struct {
// The time the inventory information was collected.
//
// This member is required.
CaptureTime *string
// The schema version for the inventory item.
//
// This member is required.
SchemaVersion *string
// 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 .
//
// This member is required.
TypeName *string
// The inventory data of the inventory type.
Content []map[string]string
// MD5 hash of the inventory item type contents. The content hash is used to
// determine whether to update inventory information. The PutInventory API doesn't
// update the inventory item type contents if the MD5 hash hasn't changed since
// last update.
ContentHash *string
// 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 map[string]string
noSmithyDocumentSerde
}
// Attributes are the entries within the inventory item content. It contains name
// and value.
type InventoryItemAttribute struct {
// The data type of the inventory item attribute.
//
// This member is required.
DataType InventoryAttributeDataType
// Name of the inventory item attribute.
//
// This member is required.
Name *string
noSmithyDocumentSerde
}
// The inventory item schema definition. Users can use this to compose inventory
// query filters.
type InventoryItemSchema struct {
// The schema attributes for inventory. This contains data type and attribute name.
//
// This member is required.
Attributes []InventoryItemAttribute
// The name of the inventory type. Default inventory item type names start with
// Amazon Web Services. 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 .
//
// This member is required.
TypeName *string
// The alias name of the inventory type. The alias name is used for display
// purposes.
DisplayName *string
// The schema version for the inventory item.
Version *string
noSmithyDocumentSerde
}
// Inventory query results.
type InventoryResultEntity struct {
// The data section in the inventory result entity JSON.
Data map[string]InventoryResultItem
// ID of the inventory result entity. For example, for managed node inventory the
// result will be the managed node ID. For EC2 instance inventory, the result will
// be the instance ID.
Id *string
noSmithyDocumentSerde
}
// The inventory result item.
type InventoryResultItem struct {
// Contains all the inventory data of the item type. Results include attribute
// names and values.
//
// This member is required.
Content []map[string]string
// The schema version for the inventory result item/
//
// This member is required.
SchemaVersion *string
// The name of the inventory result item type.
//
// This member is required.
TypeName *string
// The time inventory item data was captured.
CaptureTime *string
// MD5 hash of the inventory item type contents. The content hash is used to
// determine whether to update inventory information. The PutInventory API doesn't
// update the inventory item type contents if the MD5 hash hasn't changed since
// last update.
ContentHash *string
noSmithyDocumentSerde
}
// Information about an Amazon Simple Storage Service (Amazon S3) bucket to write
// managed node-level logs to. LoggingInfo has been deprecated. To specify an
// Amazon Simple Storage Service (Amazon S3) bucket to contain logs, instead use
// the OutputS3BucketName and OutputS3KeyPrefix options in the
// TaskInvocationParameters structure. For information about how Amazon Web
// Services Systems Manager handles these options for the supported maintenance
// window task types, see MaintenanceWindowTaskInvocationParameters .
type LoggingInfo struct {
// The name of an S3 bucket where execution logs are stored.
//
// This member is required.
S3BucketName *string
// The Amazon Web Services Region where the S3 bucket is located.
//
// This member is required.
S3Region *string
// (Optional) The S3 bucket subfolder.
S3KeyPrefix *string
noSmithyDocumentSerde
}
// The parameters for an AUTOMATION task type.
type MaintenanceWindowAutomationParameters struct {
// The version of an Automation runbook to use during task execution.
DocumentVersion *string
// 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
// Amazon Simple Storage Service (Amazon S3) bucket to contain logs, instead use
// the OutputS3BucketName and OutputS3KeyPrefix options in the
// TaskInvocationParameters structure. For information about how Amazon Web
// Services 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, Amazon
// Web Services Systems Manager ignores any values specified for these parameters.
Parameters map[string][]string
noSmithyDocumentSerde
}
// Describes the information about an execution of a maintenance window.
type MaintenanceWindowExecution struct {
// The time the execution finished.
EndTime *time.Time
// The time the execution started.
StartTime *time.Time
// The status of the execution.
Status MaintenanceWindowExecutionStatus
// The details explaining the status. Not available for all status values.
StatusDetails *string
// The ID of the maintenance window execution.
WindowExecutionId *string
// The ID of the maintenance window.
WindowId *string
noSmithyDocumentSerde
}
// Information about a task execution performed as part of a maintenance window
// execution.
type MaintenanceWindowExecutionTaskIdentity struct {
// The details for the CloudWatch alarm applied to your maintenance window task.
AlarmConfiguration *AlarmConfiguration
// The time the task execution finished.
EndTime *time.Time
// The time the task execution started.
StartTime *time.Time
// The status of the task execution.
Status MaintenanceWindowExecutionStatus
// The details explaining the status of the task execution. Not available for all
// status values.
StatusDetails *string
// The Amazon Resource Name (ARN) of the task that ran.
TaskArn *string
// The ID of the specific task execution in the maintenance window execution.
TaskExecutionId *string
// The type of task that ran.
TaskType MaintenanceWindowTaskType
// The CloudWatch alarm that was invoked by the maintenance window task.
TriggeredAlarms []AlarmStateInformation
// The ID of the maintenance window execution that ran the task.
WindowExecutionId *string
noSmithyDocumentSerde
}
// Describes the information about a task invocation for a particular target as
// part of a task execution performed as part of a maintenance window execution.
type MaintenanceWindowExecutionTaskInvocationIdentity struct {
// The time the invocation finished.
EndTime *time.Time
// 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 *string
// The ID of the task invocation.
InvocationId *string
// User-provided value that was specified when the target was registered with the
// maintenance window. This was also included in any Amazon CloudWatch Events
// events raised during the task invocation.
OwnerInformation *string
// The parameters that were provided for the invocation when it was run.
Parameters *string
// The time the invocation started.
StartTime *time.Time
// The status of the task invocation.
Status MaintenanceWindowExecutionStatus
// The details explaining the status of the task invocation. Not available for all
// status values.
StatusDetails *string
// The ID of the specific task execution in the maintenance window execution.
TaskExecutionId *string
// The task type.
TaskType MaintenanceWindowTaskType
// The ID of the maintenance window execution that ran the task.
WindowExecutionId *string
// The ID of the target definition in this maintenance window the invocation was
// performed for.
WindowTargetId *string
noSmithyDocumentSerde
}
// Filter used in the request. Supported filter keys depend on the API operation
// that includes the filter. API operations that use MaintenanceWindowFilter>
// include the following:
// - DescribeMaintenanceWindowExecutions
// - DescribeMaintenanceWindowExecutionTaskInvocations
// - DescribeMaintenanceWindowExecutionTasks
// - DescribeMaintenanceWindows
// - DescribeMaintenanceWindowTargets
// - DescribeMaintenanceWindowTasks
type MaintenanceWindowFilter struct {
// The name of the filter.
Key *string
// The filter values.
Values []string
noSmithyDocumentSerde
}
// Information about the maintenance window.
type MaintenanceWindowIdentity struct {
// The number of hours before the end of the maintenance window that Amazon Web
// Services Systems Manager stops scheduling new tasks for execution.
Cutoff int32
// A description of the maintenance window.
Description *string
// The duration of the maintenance window in hours.
Duration *int32
// Indicates whether the maintenance window is enabled.
Enabled bool
// The date and time, in ISO-8601 Extended format, for when the maintenance window
// is scheduled to become inactive.
EndDate *string
// The name of the maintenance window.
Name *string
// 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 *string
// The schedule of the maintenance window in the form of a cron or rate expression.
Schedule *string
// The number of days to wait to run a maintenance window after the scheduled cron
// expression date and time.
ScheduleOffset *int32
// The time zone that the scheduled maintenance window executions are based on, in
// Internet Assigned Numbers Authority (IANA) format.
ScheduleTimezone *string
// The date and time, in ISO-8601 Extended format, for when the maintenance window
// is scheduled to become active.
StartDate *string
// The ID of the maintenance window.
WindowId *string
noSmithyDocumentSerde
}
// The maintenance window to which the specified target belongs.
type MaintenanceWindowIdentityForTarget struct {
// The name of the maintenance window.
Name *string
// The ID of the maintenance window.
WindowId *string
noSmithyDocumentSerde
}
// The parameters for a LAMBDA task type. For information about specifying and
// updating task parameters, see RegisterTaskWithMaintenanceWindow and
// UpdateMaintenanceWindowTask . LoggingInfo has been deprecated. To specify an
// Amazon Simple Storage Service (Amazon S3) bucket to contain logs, instead use
// the OutputS3BucketName and OutputS3KeyPrefix options in the
// TaskInvocationParameters structure. For information about how Amazon Web
// Services 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 Lambda tasks, Systems Manager
// ignores any values specified for TaskParameters and LoggingInfo.
type MaintenanceWindowLambdaParameters struct {
// 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 *string
// JSON to provide to your Lambda function as input.
Payload []byte
// (Optional) Specify an Lambda function version or alias name. If you specify a
// function version, the operation uses the qualified function Amazon Resource Name
// (ARN) to invoke a specific Lambda function. If you specify an alias name, the
// operation uses the alias ARN to invoke the Lambda function version to which the
// alias points.
Qualifier *string
noSmithyDocumentSerde
}
// The parameters for a RUN_COMMAND task type. For information about specifying
// and updating task parameters, see RegisterTaskWithMaintenanceWindow and
// UpdateMaintenanceWindowTask . LoggingInfo has been deprecated. To specify an
// Amazon Simple Storage Service (Amazon S3) bucket to contain logs, instead use
// the OutputS3BucketName and OutputS3KeyPrefix options in the
// TaskInvocationParameters structure. For information about how Amazon Web
// Services 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 RUN_COMMAND tasks, Systems
// Manager uses specified values for TaskParameters and LoggingInfo only if no
// values are specified for TaskInvocationParameters .
type MaintenanceWindowRunCommandParameters struct {
// Configuration options for sending command output to Amazon CloudWatch Logs.
CloudWatchOutputConfig *CloudWatchOutputConfig
// Information about the commands to run.
Comment *string
// The SHA-256 or SHA-1 hash created by the system when the document was created.
// SHA-1 hashes have been deprecated.
DocumentHash *string
// SHA-256 or SHA-1. SHA-1 hashes have been deprecated.
DocumentHashType DocumentHashType
// The Amazon Web Services Systems Manager document (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 Amazon Web Services 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 *string
// Configurations for sending notifications about command status changes on a
// per-managed node basis.
NotificationConfig *NotificationConfig
// The name of the Amazon Simple Storage Service (Amazon S3) bucket.
OutputS3BucketName *string
// The S3 bucket subfolder.
OutputS3KeyPrefix *string
// The parameters for the RUN_COMMAND task execution.
Parameters map[string][]string
// The Amazon Resource Name (ARN) of the Identity and Access Management (IAM)
// service role to use to publish Amazon Simple Notification Service (Amazon SNS)
// notifications for maintenance window Run Command tasks.
ServiceRoleArn *string
// If this time is reached and the command hasn't already started running, it
// doesn't run.
TimeoutSeconds *int32
noSmithyDocumentSerde
}
// The parameters for a STEP_FUNCTIONS task. For information about specifying and
// updating task parameters, see RegisterTaskWithMaintenanceWindow and
// UpdateMaintenanceWindowTask . LoggingInfo has been deprecated. To specify an
// Amazon Simple Storage Service (Amazon S3) bucket to contain logs, instead use
// the OutputS3BucketName and OutputS3KeyPrefix options in the
// TaskInvocationParameters structure. For information about how Amazon Web
// Services 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 Step Functions tasks, Systems
// Manager ignores any values specified for TaskParameters and LoggingInfo .
type MaintenanceWindowStepFunctionsParameters struct {
// The inputs for the STEP_FUNCTIONS task.
Input *string
// The name of the STEP_FUNCTIONS task.
Name *string
noSmithyDocumentSerde
}
// The target registered with the maintenance window.
type MaintenanceWindowTarget struct {
// A description for the target.
Description *string
// The name for the maintenance window target.
Name *string
// A user-provided value that will be included in any Amazon CloudWatch Events
// events that are raised while running tasks for these targets in this maintenance
// window.
OwnerInformation *string
// The type of target that is being registered with the maintenance window.
ResourceType MaintenanceWindowResourceType
// The targets, either managed nodes or tags. Specify managed nodes using the
// following format: Key=instanceids,Values=, Tags are specified using the
// following format: Key=,Values= .
Targets []Target
// The ID of the maintenance window to register the target with.
WindowId *string
// The ID of the target.
WindowTargetId *string
noSmithyDocumentSerde
}
// Information about a task defined for a maintenance window.
type MaintenanceWindowTask struct {
// The details for the CloudWatch alarm applied to your maintenance window task.
AlarmConfiguration *AlarmConfiguration
// The specification for whether tasks should continue to run after the cutoff
// time specified in the maintenance windows is reached.
CutoffBehavior MaintenanceWindowTaskCutoffBehavior
// A description of the task.
Description *string
// Information about an S3 bucket to write task-level logs to. LoggingInfo has
// been deprecated. To specify an Amazon Simple Storage Service (Amazon S3) bucket
// to contain logs, instead use the OutputS3BucketName and OutputS3KeyPrefix
// options in the TaskInvocationParameters structure. For information about how
// Amazon Web Services Systems Manager handles these options for the supported
// maintenance window task types, see MaintenanceWindowTaskInvocationParameters .
LoggingInfo *LoggingInfo
// The maximum number of targets this task can be run for, in parallel. Although
// this element is listed as "Required: No", a value can be omitted only when you
// are registering or updating a targetless task (https://docs.aws.amazon.com/systems-manager/latest/userguide/maintenance-windows-targetless-tasks.html)
// You must provide a value in all other cases. For maintenance window tasks
// without a target specified, you can't supply a value for this option. Instead,
// the system inserts a placeholder value of 1 . This value doesn't affect the
// running of your task.
MaxConcurrency *string
// The maximum number of errors allowed before this task stops being scheduled.
// Although this element is listed as "Required: No", a value can be omitted only
// when you are registering or updating a targetless task (https://docs.aws.amazon.com/systems-manager/latest/userguide/maintenance-windows-targetless-tasks.html)
// You must provide a value in all other cases. For maintenance window tasks
// without a target specified, you can't supply a value for this option. Instead,
// the system inserts a placeholder value of 1 . This value doesn't affect the
// running of your task.
MaxErrors *string
// The task name.
Name *string
// 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 int32
// The Amazon Resource Name (ARN) of the Identity and Access Management (IAM)
// service role to use to publish Amazon Simple Notification Service (Amazon SNS)
// notifications for maintenance window Run Command tasks.
ServiceRoleArn *string
// The targets (either managed nodes or tags). Managed nodes are specified using
// Key=instanceids,Values=, . Tags are specified using Key=,Values= .
Targets []Target
// The resource that the task uses during execution. For RUN_COMMAND and AUTOMATION
// task types, TaskArn is the Amazon Web Services Systems Manager (SSM 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 *string
// 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 map[string]MaintenanceWindowTaskParameterValueExpression
// The type of task.
Type MaintenanceWindowTaskType
// The ID of the maintenance window where the task is registered.
WindowId *string
// The task ID.
WindowTaskId *string
noSmithyDocumentSerde
}
// The parameters for task execution.
type MaintenanceWindowTaskInvocationParameters struct {
// The parameters for an AUTOMATION task type.
Automation *MaintenanceWindowAutomationParameters
// The parameters for a LAMBDA task type.
Lambda *MaintenanceWindowLambdaParameters
// The parameters for a RUN_COMMAND task type.
RunCommand *MaintenanceWindowRunCommandParameters
// The parameters for a STEP_FUNCTIONS task type.
StepFunctions *MaintenanceWindowStepFunctionsParameters
noSmithyDocumentSerde
}
// Defines the values for a task parameter.
type MaintenanceWindowTaskParameterValueExpression struct {
// This field contains an array of 0 or more strings, each 1 to 255 characters in
// length.
Values []string
noSmithyDocumentSerde
}
// Metadata to assign to an Application Manager application.
type MetadataValue struct {
// Metadata value to assign to an Application Manager application.
Value *string
noSmithyDocumentSerde
}
// A summary of resources that aren't compliant. The summary is organized
// according to resource type.
type NonCompliantSummary struct {
// The total number of compliance items that aren't compliant.
NonCompliantCount int32
// A summary of the non-compliance severity by compliance type
SeveritySummary *SeveritySummary
noSmithyDocumentSerde
}
// Configurations for sending notifications.
type NotificationConfig struct {
// 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 *string
// The different events for which you can receive notifications. To learn more
// about these events, see Monitoring Systems Manager status changes using Amazon
// SNS notifications (https://docs.aws.amazon.com/systems-manager/latest/userguide/monitoring-sns-notifications.html)
// in the Amazon Web Services Systems Manager User Guide.
NotificationEvents []NotificationEvent
// The type of notification.
// - Command : Receive notification when the status of a command changes.
// - Invocation : For commands sent to multiple managed nodes, receive
// notification on a per-node basis when the status of a command changes.
NotificationType NotificationType
noSmithyDocumentSerde
}
// One or more aggregators for viewing counts of OpsData using different
// dimensions such as Source , CreatedTime , or Source and CreatedTime , to name a
// few.
type OpsAggregator struct {
// Either a Range or Count aggregator for limiting an OpsData summary.
AggregatorType *string
// A nested aggregator for viewing counts of OpsData.
Aggregators []OpsAggregator
// The name of an OpsData attribute on which to limit the count of OpsData.
AttributeName *string
// The aggregator filters.
Filters []OpsFilter
// The data type name to use for viewing counts of OpsData.
TypeName *string
// The aggregator value.
Values map[string]string
noSmithyDocumentSerde
}
// The result of the query.
type OpsEntity struct {
// The data returned by the query.
Data map[string]OpsEntityItem
// The query ID.
Id *string
noSmithyDocumentSerde
}
// The OpsData summary.
type OpsEntityItem struct {
// The time the OpsData was captured.
CaptureTime *string
// The details of an OpsData summary.
Content []map[string]string
noSmithyDocumentSerde
}
// A filter for viewing OpsData summaries.
type OpsFilter struct {
// The name of the filter.
//
// This member is required.
Key *string
// The filter value.
//
// This member is required.
Values []string
// The type of filter.
Type OpsFilterOperatorType
noSmithyDocumentSerde
}
// Operations engineers and IT professionals use Amazon Web Services Systems
// Manager OpsCenter to view, investigate, and remediate operational work items
// (OpsItems) impacting the performance and health of their Amazon Web Services
// resources. OpsCenter is integrated with Amazon EventBridge and Amazon
// CloudWatch. This means you can configure these services to automatically create
// an OpsItem in OpsCenter when a CloudWatch alarm enters the ALARM state or when
// EventBridge processes an event from any Amazon Web Services service that
// publishes events. Configuring Amazon CloudWatch alarms and EventBridge events to
// automatically create OpsItems allows you to quickly diagnose and remediate
// issues with Amazon Web Services resources from a single console. To help you
// diagnose issues, each OpsItem includes contextually relevant information such as
// the name and ID of the Amazon Web Services resource that generated the OpsItem,
// alarm or event details, alarm history, and an alarm timeline graph. For the
// Amazon Web Services resource, OpsCenter aggregates information from Config,
// CloudTrail logs, and EventBridge, so you don't have to navigate across multiple
// console pages during your investigation. For more information, see OpsCenter (https://docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter.html)
// in the Amazon Web Services Systems Manager User Guide.
type OpsItem struct {
// The time a runbook workflow ended. Currently reported only for the OpsItem type
// /aws/changerequest .
ActualEndTime *time.Time
// The time a runbook workflow started. Currently reported only for the OpsItem
// type /aws/changerequest .
ActualStartTime *time.Time
// An OpsItem category. Category options include: Availability, Cost, Performance,
// Recovery, Security.
Category *string
// The ARN of the Amazon Web Services account that created the OpsItem.
CreatedBy *string
// The date and time the OpsItem was created.
CreatedTime *time.Time
// The OpsItem description.
Description *string
// The ARN of the Amazon Web Services account that last updated the OpsItem.
LastModifiedBy *string
// The date and time the OpsItem was last updated.
LastModifiedTime *time.Time
// The Amazon Resource Name (ARN) of an Amazon Simple Notification Service (Amazon
// SNS) topic where notifications are sent when this OpsItem is edited or changed.
Notifications []OpsItemNotification
// 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 operation) can
// view and search on the specified data. Operational data that isn't searchable is
// only viewable by users who have access to the OpsItem (as provided by the
// GetOpsItem API operation). 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
// Amazon Web Services CLI example commands that use these keys, see Creating
// OpsItems manually (https://docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter-manually-create-OpsItems.html)
// in the Amazon Web Services Systems Manager User Guide.
OperationalData map[string]OpsItemDataValue
// The OpsItem Amazon Resource Name (ARN).
OpsItemArn *string
// The ID of the OpsItem.
OpsItemId *string
// The type of OpsItem. Systems Manager supports the following types of OpsItems:
// - /aws/issue This type of OpsItem is used for default OpsItems created by
// OpsCenter.
// - /aws/changerequest This type of OpsItem is used by Change Manager for
// reviewing and approving or rejecting change requests.
// - /aws/insight This type of OpsItem is used by OpsCenter for aggregating and
// reporting on duplicate OpsItems.
OpsItemType *string
// The time specified in a change request for a runbook workflow to end. Currently
// supported only for the OpsItem type /aws/changerequest .
PlannedEndTime *time.Time
// The time specified in a change request for a runbook workflow to start.
// Currently supported only for the OpsItem type /aws/changerequest .
PlannedStartTime *time.Time
// The importance of this OpsItem in relation to other OpsItems in the system.
Priority *int32
// 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 []RelatedOpsItem
// The severity of the OpsItem. Severity options range from 1 to 4.
Severity *string
// The origin of the OpsItem, such as Amazon EC2 or Systems Manager. The impacted
// resource is a subset of source.
Source *string
// The OpsItem status. Status can be Open , In Progress , or Resolved . For more
// information, see Editing OpsItem details (https://docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter-working-with-OpsItems-editing-details.html)
// in the Amazon Web Services Systems Manager User Guide.
Status OpsItemStatus
// A short heading that describes the nature of the OpsItem and the impacted
// resource.
Title *string
// The version of this OpsItem. Each time the OpsItem is edited the version number
// increments by one.
Version *string
noSmithyDocumentSerde
}
// An object that defines the value of the key and its type in the OperationalData
// map.
type OpsItemDataValue struct {
// The type of key-value pair. Valid types include SearchableString and String .
Type OpsItemDataType
// The value of the OperationalData key.
Value *string
noSmithyDocumentSerde
}
// Describes a filter for a specific list of OpsItem events. You can filter event
// information by using tags. You specify tags by using a key-value pair mapping.
type OpsItemEventFilter struct {
// The name of the filter key. Currently, the only supported value is OpsItemId .
//
// This member is required.
Key OpsItemEventFilterKey
// The operator used by the filter call. Currently, the only supported value is
// Equal .
//
// This member is required.
Operator OpsItemEventFilterOperator
// The values for the filter, consisting of one or more OpsItem IDs.
//
// This member is required.
Values []string
noSmithyDocumentSerde
}
// Summary information about an OpsItem event or that associated an OpsItem with a
// related item.
type OpsItemEventSummary struct {
// Information about the user or resource that created the OpsItem event.
CreatedBy *OpsItemIdentity
// The date and time the OpsItem event was created.
CreatedTime *time.Time
// Specific information about the OpsItem event.
Detail *string
// The type of information provided as a detail.
DetailType *string
// The ID of the OpsItem event.
EventId *string
// The ID of the OpsItem.
OpsItemId *string
// The source of the OpsItem event.
Source *string
noSmithyDocumentSerde
}
// Describes an OpsItem filter.
type OpsItemFilter struct {
// The name of the filter.
//
// This member is required.
Key OpsItemFilterKey
// The operator used by the filter call.
//
// This member is required.
Operator OpsItemFilterOperator
// The filter value.
//
// This member is required.
Values []string
noSmithyDocumentSerde
}
// Information about the user or resource that created an OpsItem event.
type OpsItemIdentity struct {
// The Amazon Resource Name (ARN) of the IAM entity that created the OpsItem event.
Arn *string
noSmithyDocumentSerde
}
// A notification about the OpsItem.
type OpsItemNotification struct {
// The Amazon Resource Name (ARN) of an Amazon Simple Notification Service (Amazon
// SNS) topic where notifications are sent when this OpsItem is edited or changed.
Arn *string
noSmithyDocumentSerde
}
// Describes a filter for a specific list of related-item resources.
type OpsItemRelatedItemsFilter struct {
// The name of the filter key. Supported values include ResourceUri , ResourceType
// , or AssociationId .
//
// This member is required.
Key OpsItemRelatedItemsFilterKey
// The operator used by the filter call. The only supported operator is EQUAL .
//
// This member is required.
Operator OpsItemRelatedItemsFilterOperator
// The values for the filter.
//
// This member is required.
Values []string
noSmithyDocumentSerde
}
// Summary information about related-item resources for an OpsItem.
type OpsItemRelatedItemSummary struct {
// The association ID.
AssociationId *string
// The association type.
AssociationType *string
// Information about the user or resource that created an OpsItem event.
CreatedBy *OpsItemIdentity
// The time the related-item association was created.
CreatedTime *time.Time
// Information about the user or resource that created an OpsItem event.
LastModifiedBy *OpsItemIdentity
// The time the related-item association was last updated.
LastModifiedTime *time.Time
// The OpsItem ID.
OpsItemId *string
// The resource type.
ResourceType *string
// The Amazon Resource Name (ARN) of the related-item resource.
ResourceUri *string
noSmithyDocumentSerde
}
// A count of OpsItems.
type OpsItemSummary struct {
// The time a runbook workflow ended. Currently reported only for the OpsItem type
// /aws/changerequest .
ActualEndTime *time.Time
// The time a runbook workflow started. Currently reported only for the OpsItem
// type /aws/changerequest .
ActualStartTime *time.Time
// A list of OpsItems by category.
Category *string
// The Amazon Resource Name (ARN) of the IAM entity that created the OpsItem.
CreatedBy *string
// The date and time the OpsItem was created.
CreatedTime *time.Time
// 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 *time.Time
// Operational data is custom data that provides useful reference details about
// the OpsItem.
OperationalData map[string]OpsItemDataValue
// The ID of the OpsItem.
OpsItemId *string
// The type of OpsItem. Systems Manager supports the following types of OpsItems:
// - /aws/issue This type of OpsItem is used for default OpsItems created by
// OpsCenter.
// - /aws/changerequest This type of OpsItem is used by Change Manager for
// reviewing and approving or rejecting change requests.
// - /aws/insight This type of OpsItem is used by OpsCenter for aggregating and
// reporting on duplicate OpsItems.
OpsItemType *string
// The time specified in a change request for a runbook workflow to end. Currently
// supported only for the OpsItem type /aws/changerequest .
PlannedEndTime *time.Time
// The time specified in a change request for a runbook workflow to start.
// Currently supported only for the OpsItem type /aws/changerequest .
PlannedStartTime *time.Time
// The importance of this OpsItem in relation to other OpsItems in the system.
Priority *int32
// A list of OpsItems by severity.
Severity *string
// The impacted Amazon Web Services resource.
Source *string
// The OpsItem status. Status can be Open , In Progress , or Resolved .
Status OpsItemStatus
// A short heading that describes the nature of the OpsItem and the impacted
// resource.
Title *string
noSmithyDocumentSerde
}
// Operational metadata for an application in Application Manager.
type OpsMetadata struct {
// The date the OpsMetadata objects was created.
CreationDate *time.Time
// The date the OpsMetadata object was last updated.
LastModifiedDate *time.Time
// The user name who last updated the OpsMetadata object.
LastModifiedUser *string
// The Amazon Resource Name (ARN) of the OpsMetadata Object or blob.
OpsMetadataArn *string
// The ID of the Application Manager application.
ResourceId *string
noSmithyDocumentSerde
}
// A filter to limit the number of OpsMetadata objects displayed.
type OpsMetadataFilter struct {
// A filter key.
//
// This member is required.
Key *string
// A filter value.
//
// This member is required.
Values []string
noSmithyDocumentSerde
}
// The OpsItem data type to return.
type OpsResultAttribute struct {
// Name of the data type. Valid value: AWS:OpsItem , AWS:EC2InstanceInformation ,
// AWS:OpsItemTrendline , or AWS:ComplianceSummary .
//
// This member is required.
TypeName *string
noSmithyDocumentSerde
}
// Information about the source where the association execution details are stored.
type OutputSource struct {
// The ID of the output source, for example the URL of an S3 bucket.
OutputSourceId *string
// The type of source where the association execution details are stored, for
// example, Amazon S3.
OutputSourceType *string
noSmithyDocumentSerde
}
// An Amazon Web Services Systems Manager parameter in Parameter Store.
type Parameter struct {
// The Amazon Resource Name (ARN) of the parameter.
ARN *string
// The data type of the parameter, such as text or aws:ec2:image . The default is
// text .
DataType *string
// Date the parameter was last changed or updated and the parameter version was
// created.
LastModifiedDate *time.Time
// The name of the parameter.
Name *string
// 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 *string
// Applies to parameters that reference information in other Amazon Web Services
// services. SourceResult is the raw result or response from the source.
SourceResult *string
// The type of parameter. Valid values include the following: String , StringList ,
// and SecureString . If type is StringList , the system returns a comma-separated
// string with no spaces between commas in the Value field.
Type ParameterType
// The parameter value. If type is StringList , the system returns a
// comma-separated string with no spaces between commas in the Value field.
Value *string
// The parameter version.
Version int64
noSmithyDocumentSerde
}
// Information about parameter usage.
type ParameterHistory struct {
// Parameter names can include the following letters and symbols. a-zA-Z0-9_.-
AllowedPattern *string
// The data type of the parameter, such as text or aws:ec2:image . The default is
// text .
DataType *string
// Information about the parameter.
Description *string
// The ID of the query key used for this parameter.
KeyId *string
// Labels assigned to the parameter version.
Labels []string
// Date the parameter was last changed or updated.
LastModifiedDate *time.Time
// Amazon Resource Name (ARN) of the Amazon Web Services user who last changed the
// parameter.
LastModifiedUser *string
// The name of the parameter.
Name *string
// Information about the policies assigned to a parameter. Assigning parameter
// policies (https://docs.aws.amazon.com/systems-manager/latest/userguide/parameter-store-policies.html)
// in the Amazon Web Services Systems Manager User Guide.
Policies []ParameterInlinePolicy
// The parameter tier.
Tier ParameterTier
// The type of parameter used.
Type ParameterType
// The parameter value.
Value *string
// The parameter version.
Version int64
noSmithyDocumentSerde
}
// One or more policies assigned to a parameter.
type ParameterInlinePolicy struct {
// The status of the policy. Policies report the following statuses: Pending (the
// policy hasn't been enforced or applied yet), Finished (the policy was applied),
// Failed (the policy wasn't applied), or InProgress (the policy is being applied
// now).
PolicyStatus *string
// The JSON text of the policy.
PolicyText *string
// The type of policy. Parameter Store, a capability of Amazon Web Services
// Systems Manager, supports the following policy types: Expiration,
// ExpirationNotification, and NoChangeNotification.
PolicyType *string
noSmithyDocumentSerde
}
// Metadata includes information like the ARN of the last user and the date/time
// the parameter was last used.
type ParameterMetadata struct {
// A parameter name can include only the following letters and symbols.
// a-zA-Z0-9_.-
AllowedPattern *string
// The data type of the parameter, such as text or aws:ec2:image . The default is
// text .
DataType *string
// Description of the parameter actions.
Description *string
// The ID of the query key used for this parameter.
KeyId *string
// Date the parameter was last changed or updated.
LastModifiedDate *time.Time
// Amazon Resource Name (ARN) of the Amazon Web Services user who last changed the
// parameter.
LastModifiedUser *string
// The parameter name.
Name *string
// A list of policies associated with a parameter.
Policies []ParameterInlinePolicy
// The parameter tier.
Tier ParameterTier
// The type of parameter. Valid parameter types include the following: String ,
// StringList , and SecureString .
Type ParameterType
// The parameter version.
Version int64
noSmithyDocumentSerde
}
// This data type is deprecated. Instead, use ParameterStringFilter .
type ParametersFilter struct {
// The name of the filter.
//
// This member is required.
Key ParametersFilterKey
// The filter values.
//
// This member is required.
Values []string
noSmithyDocumentSerde
}
// One or more filters. Use a filter to return a more specific list of results.
type ParameterStringFilter struct {
// The name of the filter. The ParameterStringFilter object is used by the
// DescribeParameters and GetParametersByPath API operations. However, not all of
// the pattern values listed for Key can be used with both operations. For
// DescribeParameters , all of the listed patterns are valid except Label . For
// GetParametersByPath , the following patterns listed for Key aren't valid: tag ,
// DataType , Name , Path , and Tier . For examples of Amazon Web Services CLI
// commands demonstrating valid parameter filter constructions, see Searching for
// Systems Manager parameters (https://docs.aws.amazon.com/systems-manager/latest/userguide/parameter-search.html)
// in the Amazon Web Services Systems Manager User Guide.
//
// This member is required.
Key *string
// 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 Label as the Key
// name, the only valid option is Equals .)
Option *string
// The value you want to search for.
Values []string
noSmithyDocumentSerde
}
// A detailed status of the parent step.
type ParentStepDetails struct {
// The name of the automation action.
Action *string
// The current repetition of the loop represented by an integer.
Iteration *int32
// The current value of the specified iterator in the loop.
IteratorValue *string
// The unique ID of a step execution.
StepExecutionId *string
// The name of the step.
StepName *string
noSmithyDocumentSerde
}
// Represents metadata about a patch.
type Patch struct {
// The Advisory ID of the patch. For example, RHSA-2020:3779 . Applies to
// Linux-based managed nodes only.
AdvisoryIds []string
// The architecture of the patch. For example, in
// example-pkg-0.710.10-2.7.abcd.x86_64 , the architecture is indicated by x86_64 .
// Applies to Linux-based managed nodes only.
Arch *string
// The Bugzilla ID of the patch. For example, 1600646 . Applies to Linux-based
// managed nodes only.
BugzillaIds []string
// The Common Vulnerabilities and Exposures (CVE) ID of the patch. For example,
// CVE-2011-3192 . Applies to Linux-based managed nodes only.
CVEIds []string
// The classification of the patch. For example, SecurityUpdates , Updates , or
// CriticalUpdates .
Classification *string
// The URL where more information can be obtained about the patch.
ContentUrl *string
// The description of the patch.
Description *string
// The epoch of the patch. For example in pkg-example-EE-20180914-2.2.amzn1.noarch
// , the epoch value is 20180914-2 . Applies to Linux-based managed nodes only.
Epoch int32
// The ID of the patch. Applies to Windows patches only. This ID isn't the same as
// the Microsoft Knowledge Base ID.
Id *string
// The Microsoft Knowledge Base ID of the patch. Applies to Windows patches only.
KbNumber *string
// The language of the patch if it's language-specific.
Language *string
// The ID of the Microsoft Security Response Center (MSRC) bulletin the patch is
// related to. For example, MS14-045 . Applies to Windows patches only.
MsrcNumber *string
// The severity of the patch, such as Critical , Important , or Moderate . Applies
// to Windows patches only.
MsrcSeverity *string
// The name of the patch. Applies to Linux-based managed nodes only.
Name *string
// The specific product the patch is applicable for. For example, WindowsServer2016
// or AmazonLinux2018.03 .
Product *string
// The product family the patch is applicable for. For example, Windows or Amazon
// Linux 2 .
ProductFamily *string
// The particular release of a patch. For example, in
// pkg-example-EE-20180914-2.2.amzn1.noarch , the release is 2.amaz1 . Applies to
// Linux-based managed nodes only.
Release *string
// The date the patch was released.
ReleaseDate *time.Time
// The source patch repository for the operating system and version, such as
// trusty-security for Ubuntu Server 14.04 LTE and focal-security for Ubuntu
// Server 20.04 LTE. Applies to Linux-based managed nodes only.
Repository *string
// The severity level of the patch. For example, CRITICAL or MODERATE .
Severity *string
// The title of the patch.
Title *string
// The name of the vendor providing the patch.
Vendor *string
// The version number of the patch. For example, in
// example-pkg-1.710.10-2.7.abcd.x86_64 , the version number is indicated by -1 .
// Applies to Linux-based managed nodes only.
Version *string
noSmithyDocumentSerde
}
// Defines the basic information about a patch baseline.
type PatchBaselineIdentity struct {
// The description of the patch baseline.
BaselineDescription *string
// The ID of the patch baseline.
BaselineId *string
// The name of the patch baseline.
BaselineName *string
// Whether this is the default baseline. Amazon Web Services Systems Manager
// supports creating multiple default patch baselines. For example, you can create
// a default patch baseline for each operating system.
DefaultBaseline bool
// Defines the operating system the patch baseline applies to. The default value
// is WINDOWS .
OperatingSystem OperatingSystem
noSmithyDocumentSerde
}
// Information about the state of a patch on a particular managed node as it
// relates to the patch baseline used to patch the node.
type PatchComplianceData struct {
// The classification of the patch, such as SecurityUpdates , Updates , and
// CriticalUpdates .
//
// This member is required.
Classification *string
// The date/time the patch was installed on the managed node. Not all operating
// systems provide this level of information.
//
// This member is required.
InstalledTime *time.Time
// The operating system-specific ID of the patch.
//
// This member is required.
KBId *string
// The severity of the patch such as Critical , Important , and Moderate .
//
// This member is required.
Severity *string
// The state of the patch on the managed node, such as INSTALLED or FAILED. For
// descriptions of each patch state, see About patch compliance (https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-compliance-about.html#sysman-compliance-monitor-patch)
// in the Amazon Web Services Systems Manager User Guide.
//
// This member is required.
State PatchComplianceDataState
// The title of the patch.
//
// This member is required.
Title *string
// The IDs of one or more Common Vulnerabilities and Exposure (CVE) issues that
// are resolved by the patch.
CVEIds *string
noSmithyDocumentSerde
}
// Defines which patches should be included in a patch baseline. A patch filter
// consists of a key and a set of values. The filter key is a patch property. For
// example, the available filter keys for WINDOWS are PATCH_SET , PRODUCT ,
// PRODUCT_FAMILY , CLASSIFICATION , and MSRC_SEVERITY . The filter values define a
// matching criterion for the patch property indicated by the key. For example, if
// the filter key is PRODUCT and the filter values are ["Office 2013", "Office
// 2016"] , then the filter accepts all patches where product name is either
// "Office 2013" or "Office 2016". The filter values can be exact values for the
// patch property given as a key, or a wildcard (*), which matches all values. You
// can view lists of valid values for the patch properties by running the
// DescribePatchProperties command. For information about which patch properties
// can be used with each major operating system, see DescribePatchProperties .
type PatchFilter struct {
// The key for the filter. Run the DescribePatchProperties command to view lists
// of valid keys for each operating system type.
//
// This member is required.
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.
//
// This member is required.
Values []string
noSmithyDocumentSerde
}
// A set of patch filters, typically used for approval rules.
type PatchFilterGroup struct {
// The set of patch filters that make up the group.
//
// This member is required.
PatchFilters []PatchFilter
noSmithyDocumentSerde
}
// The mapping between a patch group and the patch baseline the patch group is
// registered with.
type PatchGroupPatchBaselineMapping struct {
// The patch baseline the patch group is registered with.
BaselineIdentity *PatchBaselineIdentity
// The name of the patch group registered with the patch baseline.
PatchGroup *string
noSmithyDocumentSerde
}
// Defines a filter used in Patch Manager APIs. Supported filter keys depend on
// the API operation that includes the filter. Patch Manager API operations that
// use PatchOrchestratorFilter include the following:
// - DescribeAvailablePatches
// - DescribeInstancePatches
// - DescribePatchBaselines
// - DescribePatchGroups
type PatchOrchestratorFilter struct {
// The key for the filter.
Key *string
// The value for the filter.
Values []string
noSmithyDocumentSerde
}
// Defines an approval rule for a patch baseline.
type PatchRule struct {
// The patch filter group that defines the criteria for the rule.
//
// This member is required.
PatchFilterGroup *PatchFilterGroup
// 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. Not
// supported on Debian Server or Ubuntu Server.
ApproveAfterDays *int32
// The cutoff date for auto approval of released patches. Any patches released on
// or before this date are installed automatically. Not supported on Debian Server
// or Ubuntu Server. Enter dates in the format YYYY-MM-DD . For example, 2021-12-31
// .
ApproveUntilDate *string
// A compliance severity level for all approved patches in a patch baseline.
ComplianceLevel PatchComplianceLevel
// For managed nodes 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 managed nodes only.
EnableNonSecurity *bool
noSmithyDocumentSerde
}
// A set of rules defining the approval rules for a patch baseline.
type PatchRuleGroup struct {
// The rules that make up the rule group.
//
// This member is required.
PatchRules []PatchRule
noSmithyDocumentSerde
}
// Information about the patches to use to update the managed nodes, including
// target operating systems and source repository. Applies to Linux managed nodes
// only.
type PatchSource struct {
// The value of the yum repo configuration. For example: [main]
// name=MyCustomRepository
//
// baseurl=https://my-custom-repository
// enabled=1 For information about other options available for your yum repository
// configuration, see dnf.conf(5) (https://man7.org/linux/man-pages/man5/dnf.conf.5.html)
// .
//
// This member is required.
Configuration *string
// The name specified to identify the patch source.
//
// This member is required.
Name *string
// 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 .
//
// This member is required.
Products []string
noSmithyDocumentSerde
}
// Information about the approval status of a patch.
type PatchStatus struct {
// The date the patch was approved (or will be approved if the status is
// PENDING_APPROVAL ).
ApprovalDate *time.Time
// The compliance severity level for a patch.
ComplianceLevel PatchComplianceLevel
// The approval status of a patch.
DeploymentStatus PatchDeploymentStatus
noSmithyDocumentSerde
}
// An aggregate of step execution statuses displayed in the Amazon Web Services
// Systems Manager console for a multi-Region and multi-account Automation
// execution.
type ProgressCounters struct {
// The total number of steps that the system cancelled in all specified Amazon Web
// Services Regions and Amazon Web Services accounts for the current Automation
// execution.
CancelledSteps int32
// The total number of steps that failed to run in all specified Amazon Web
// Services Regions and Amazon Web Services accounts for the current Automation
// execution.
FailedSteps int32
// The total number of steps that successfully completed in all specified Amazon
// Web Services Regions and Amazon Web Services accounts for the current Automation
// execution.
SuccessSteps int32
// The total number of steps that timed out in all specified Amazon Web Services
// Regions and Amazon Web Services accounts for the current Automation execution.
TimedOutSteps int32
// The total number of steps run in all specified Amazon Web Services Regions and
// Amazon Web Services accounts for the current Automation execution.
TotalSteps int32
noSmithyDocumentSerde
}
// Reserved for internal use.
type RegistrationMetadataItem struct {
// Reserved for internal use.
//
// This member is required.
Key *string
// Reserved for internal use.
//
// This member is required.
Value *string
noSmithyDocumentSerde
}
// An OpsItems that shares 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.
type RelatedOpsItem struct {
// The ID of an OpsItem related to the current OpsItem.
//
// This member is required.
OpsItemId *string
noSmithyDocumentSerde
}
// Information about targets that resolved during the Automation execution.
type ResolvedTargets struct {
// A list of parameter values sent to targets that resolved during the Automation
// execution.
ParameterValues []string
// A boolean value indicating whether the resolved target list is truncated.
Truncated bool
noSmithyDocumentSerde
}
// Compliance summary information for a specific resource.
type ResourceComplianceSummaryItem struct {
// The compliance type.
ComplianceType *string
// A list of items that are compliant for the resource.
CompliantSummary *CompliantSummary
// Information about the execution.
ExecutionSummary *ComplianceExecutionSummary
// A list of items that aren't compliant for the resource.
NonCompliantSummary *NonCompliantSummary
// The highest severity item found for the resource. The resource is compliant for
// this item.
OverallSeverity ComplianceSeverity
// The resource ID.
ResourceId *string
// The resource type.
ResourceType *string
// The compliance status for the resource.
Status ComplianceStatus
noSmithyDocumentSerde
}
// Information about the AwsOrganizationsSource resource data sync source. A sync
// source of this type can synchronize data from Organizations or, if an Amazon Web
// Services organization isn't present, from multiple Amazon Web Services Regions.
type ResourceDataSyncAwsOrganizationsSource struct {
// If an Amazon Web Services 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 Amazon Web Services organization.
//
// This member is required.
OrganizationSourceType *string
// The Organizations organization units included in the sync.
OrganizationalUnits []ResourceDataSyncOrganizationalUnit
noSmithyDocumentSerde
}
// Synchronize Amazon Web Services Systems Manager Inventory data from multiple
// Amazon Web Services accounts defined in Organizations to a centralized Amazon S3
// bucket. Data is synchronized to individual key prefixes in the central bucket.
// Each key prefix represents a different Amazon Web Services account ID.
type ResourceDataSyncDestinationDataSharing struct {
// The sharing data type. Only Organization is supported.
DestinationDataSharingType *string
noSmithyDocumentSerde
}
// Information about a resource data sync configuration, including its current
// status and last successful sync.
type ResourceDataSyncItem struct {
// The status reported by the last sync.
LastStatus LastResourceDataSyncStatus
// The last time the sync operations returned a status of SUCCESSFUL (UTC).
LastSuccessfulSyncTime *time.Time
// The status message details reported by the last sync.
LastSyncStatusMessage *string
// The last time the configuration attempted to sync (UTC).
LastSyncTime *time.Time
// Configuration information for the target S3 bucket.
S3Destination *ResourceDataSyncS3Destination
// The date and time the configuration was created (UTC).
SyncCreatedTime *time.Time
// The date and time the resource data sync was changed.
SyncLastModifiedTime *time.Time
// The name of the resource data sync.
SyncName *string
// Information about the source where the data was synchronized.
SyncSource *ResourceDataSyncSourceWithState
// The type of resource data sync. If SyncType is SyncToDestination , then the
// resource data sync synchronizes data to an S3 bucket. If the SyncType is
// SyncFromSource then the resource data sync synchronizes data from Organizations
// or from multiple Amazon Web Services Regions.
SyncType *string
noSmithyDocumentSerde
}
// The Organizations organizational unit data source for the sync.
type ResourceDataSyncOrganizationalUnit struct {
// The Organizations unit ID data source for the sync.
OrganizationalUnitId *string
noSmithyDocumentSerde
}
// Information about the target S3 bucket for the resource data sync.
type ResourceDataSyncS3Destination struct {
// The name of the S3 bucket where the aggregated data is stored.
//
// This member is required.
BucketName *string
// The Amazon Web Services Region with the S3 bucket targeted by the resource data
// sync.
//
// This member is required.
Region *string
// A supported sync format. The following format is currently supported: JsonSerDe
//
// This member is required.
SyncFormat ResourceDataSyncS3Format
// The ARN of an encryption key for a destination in Amazon S3. Must belong to the
// same Region as the destination S3 bucket.
AWSKMSKeyARN *string
// Enables destination data sharing. By default, this field is null .
DestinationDataSharing *ResourceDataSyncDestinationDataSharing
// An Amazon S3 prefix for the bucket.
Prefix *string
noSmithyDocumentSerde
}
// Information about the source of the data included in the resource data sync.
type ResourceDataSyncSource struct {
// The SyncSource Amazon Web Services Regions included in the resource data sync.
//
// This member is required.
SourceRegions []string
// The type of data source for the resource data sync. SourceType is either
// AwsOrganizations (if an organization is present in Organizations) or
// SingleAccountMultiRegions .
//
// This member is required.
SourceType *string
// Information about the AwsOrganizationsSource resource data sync source. A sync
// source of this type can synchronize data from Organizations.
AwsOrganizationsSource *ResourceDataSyncAwsOrganizationsSource
// When you create a resource data sync, if you choose one of the Organizations
// options, then Systems Manager automatically enables all OpsData sources in the
// selected Amazon Web Services Regions for all Amazon Web Services accounts in
// your organization (or in the selected organization units). For more information,
// see About multiple account and Region resource data syncs (https://docs.aws.amazon.com/systems-manager/latest/userguide/Explorer-resouce-data-sync-multiple-accounts-and-regions.html)
// in the Amazon Web Services Systems Manager User Guide.
EnableAllOpsDataSources bool
// Whether to automatically synchronize and aggregate data from new Amazon Web
// Services Regions when those Regions come online.
IncludeFutureRegions bool
noSmithyDocumentSerde
}
// 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 Amazon Web Services Systems
// Manager 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 Organizations.)
type ResourceDataSyncSourceWithState struct {
// The field name in SyncSource for the ResourceDataSyncAwsOrganizationsSource
// type.
AwsOrganizationsSource *ResourceDataSyncAwsOrganizationsSource
// When you create a resource data sync, if you choose one of the Organizations
// options, then Systems Manager automatically enables all OpsData sources in the
// selected Amazon Web Services Regions for all Amazon Web Services accounts in
// your organization (or in the selected organization units). For more information,
// see About multiple account and Region resource data syncs (https://docs.aws.amazon.com/systems-manager/latest/userguide/Explorer-resouce-data-sync-multiple-accounts-and-regions.html)
// in the Amazon Web Services Systems Manager User Guide.
EnableAllOpsDataSources bool
// Whether to automatically synchronize and aggregate data from new Amazon Web
// Services Regions when those Regions come online.
IncludeFutureRegions bool
// The SyncSource Amazon Web Services Regions included in the resource data sync.
SourceRegions []string
// The type of data source for the resource data sync. SourceType is either
// AwsOrganizations (if an organization is present in Organizations) or
// singleAccountMultiRegions .
SourceType *string
// 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 Organizations.
State *string
noSmithyDocumentSerde
}
// The inventory item result attribute.
type ResultAttribute struct {
// Name of the inventory item type. Valid value: AWS:InstanceInformation . Default
// Value: AWS:InstanceInformation .
//
// This member is required.
TypeName *string
noSmithyDocumentSerde
}
// Information about the result of a document review request.
type ReviewInformation struct {
// The time that the reviewer took action on the document review request.
ReviewedTime *time.Time
// The reviewer assigned to take action on the document review request.
Reviewer *string
// The current status of the document review request.
Status ReviewStatus
noSmithyDocumentSerde
}
// Information about an Automation runbook used in a runbook workflow in Change
// Manager. The Automation runbooks specified for the runbook workflow can't run
// until all required approvals for the change request have been received.
type Runbook struct {
// The name of the Automation runbook used in a runbook workflow.
//
// This member is required.
DocumentName *string
// The version of the Automation runbook used in a runbook workflow.
DocumentVersion *string
// The MaxConcurrency value specified by the user when the operation started,
// indicating the maximum number of resources that the runbook operation can run on
// at the same time.
MaxConcurrency *string
// The MaxErrors value specified by the user when the execution started,
// indicating the maximum number of errors that can occur during the operation
// before the updates are stopped or rolled back.
MaxErrors *string
// The key-value map of execution parameters, which were supplied when calling
// StartChangeRequestExecution .
Parameters map[string][]string
// Information about the Amazon Web Services Regions and Amazon Web Services
// accounts targeted by the current Runbook operation.
TargetLocations []TargetLocation
// A key-value mapping of runbook parameters to target resources. Both Targets and
// TargetMaps can't be specified together.
TargetMaps []map[string][]string
// The name of the parameter used as the target resource for the rate-controlled
// runbook workflow. Required if you specify Targets .
TargetParameterName *string
// A key-value mapping to target resources that the runbook operation performs
// tasks on. Required if you specify TargetParameterName .
Targets []Target
noSmithyDocumentSerde
}
// An S3 bucket where you want to store the results of this request.
type S3OutputLocation struct {
// The name of the S3 bucket.
OutputS3BucketName *string
// The S3 bucket subfolder.
OutputS3KeyPrefix *string
// The Amazon Web Services Region of the S3 bucket.
OutputS3Region *string
noSmithyDocumentSerde
}
// A URL for the Amazon Web Services Systems Manager (Systems Manager) bucket
// where you want to store the results of this request.
type S3OutputUrl struct {
// A URL for an S3 bucket where you want to store the results of this request.
OutputUrl *string
noSmithyDocumentSerde
}
// Information about a scheduled execution for a maintenance window.
type ScheduledWindowExecution struct {
// The time, in ISO-8601 Extended format, that the maintenance window is scheduled
// to be run.
ExecutionTime *string
// The name of the maintenance window to be run.
Name *string
// The ID of the maintenance window to be run.
WindowId *string
noSmithyDocumentSerde
}
// The service setting data structure. ServiceSetting is an account-level setting
// for an Amazon Web Services service. This setting defines how a user interacts
// with or uses a service or a feature of a service. For example, if an Amazon Web
// Services service charges money to the account based on feature or service usage,
// then the Amazon Web Services 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. Amazon Web Services 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 operation to
// change the default setting. Or, use the ResetServiceSetting to change the value
// back to the original value defined by the Amazon Web Services service team.
type ServiceSetting struct {
// The ARN of the service setting.
ARN *string
// The last time the service setting was modified.
LastModifiedDate *time.Time
// The ARN of the last modified user. This field is populated only if the setting
// value was overwritten.
LastModifiedUser *string
// The ID of the service setting.
SettingId *string
// The value of the service setting.
SettingValue *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 Amazon
// Web Services 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
noSmithyDocumentSerde
}
// Information about a Session Manager connection to a managed node.
type Session struct {
// Reserved for future use.
Details *string
// The name of the Session Manager SSM document used to define the parameters and
// plugin settings for the session. For example, SSM-SessionManagerRunShell .
DocumentName *string
// The date and time, in ISO-8601 Extended format, when the session was terminated.
EndDate *time.Time
// The maximum duration of a session before it terminates.
MaxSessionDuration *string
// Reserved for future use.
OutputUrl *SessionManagerOutputUrl
// The ID of the Amazon Web Services user that started the session.
Owner *string
// The reason for connecting to the instance.
Reason *string
// The ID of the session.
SessionId *string
// The date and time, in ISO-8601 Extended format, when the session began.
StartDate *time.Time
// The status of the session. For example, "Connected" or "Terminated".
Status SessionStatus
// The managed node that the Session Manager session connected to.
Target *string
noSmithyDocumentSerde
}
// Describes a filter for Session Manager information.
type SessionFilter struct {
// The name of the filter.
//
// This member is required.
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 a managed node to which session connections have been made.
// - Owner: Specify an Amazon Web Services user 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
// - SessionId: Specify a session ID to return details about the session.
//
// This member is required.
Value *string
noSmithyDocumentSerde
}
// Reserved for future use.
type SessionManagerOutputUrl struct {
// Reserved for future use.
CloudWatchOutputUrl *string
// Reserved for future use.
S3OutputUrl *string
noSmithyDocumentSerde
}
// The number of managed nodes found for each patch severity level defined in the
// request filter.
type SeveritySummary struct {
// 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 int32
// 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 int32
// 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 int32
// 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 int32
// 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 int32
// 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 int32
noSmithyDocumentSerde
}
// Detailed information about an the execution state of an Automation step.
type StepExecution struct {
// The action this step performs. The action determines the behavior of the step.
Action *string
// If a step has finished execution, this contains the time the execution ended.
// If the step hasn't yet concluded, this field isn't populated.
ExecutionEndTime *time.Time
// If a step has begun execution, this contains the time the step started. If the
// step is in Pending status, this field isn't populated.
ExecutionStartTime *time.Time
// Information about the Automation failure.
FailureDetails *FailureDetails
// If a step failed, this message explains why the execution failed.
FailureMessage *string
// Fully-resolved values passed into the step before execution.
Inputs map[string]string
// The flag which can be used to help decide whether the failure of current step
// leads to the Automation failure.
IsCritical *bool
// The flag which can be used to end automation no matter whether the step
// succeeds or fails.
IsEnd *bool
// The maximum number of tries to run the action of the step. The default value is
// 1 .
MaxAttempts *int32
// The next step after the step succeeds.
NextStep *string
// The action to take if the step fails. The default value is Abort .
OnFailure *string
// Returned values from the execution of the step.
Outputs map[string][]string
// A user-specified list of parameters to override when running a step.
OverriddenParameters map[string][]string
// Information about the parent step.
ParentStepDetails *ParentStepDetails
// A message associated with the response code for an execution.
Response *string
// The response code returned by the execution of the step.
ResponseCode *string
// The unique ID of a step execution.
StepExecutionId *string
// The name of this execution step.
StepName *string
// The execution status for this step.
StepStatus AutomationExecutionStatus
// The combination of Amazon Web Services Regions and Amazon Web Services accounts
// targeted by the current Automation execution.
TargetLocation *TargetLocation
// The targets for the step execution.
Targets []Target
// The timeout seconds of the step.
TimeoutSeconds *int64
// The CloudWatch alarms that were invoked by the automation.
TriggeredAlarms []AlarmStateInformation
// 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 []string
noSmithyDocumentSerde
}
// A filter to limit the amount of step execution information returned by the call.
type StepExecutionFilter struct {
// One or more keys to limit the results.
//
// This member is required.
Key StepExecutionFilterKey
// The values of the filter key.
//
// This member is required.
Values []string
noSmithyDocumentSerde
}
// Metadata that you assign to your Amazon Web Services resources. Tags enable you
// to categorize your resources in different ways, for example, by purpose, owner,
// or environment. In Amazon Web Services Systems Manager, you can apply tags to
// Systems Manager documents (SSM documents), managed nodes, maintenance windows,
// parameters, patch baselines, OpsItems, and OpsMetadata.
type Tag struct {
// The name of the tag.
//
// This member is required.
Key *string
// The value of the tag.
//
// This member is required.
Value *string
noSmithyDocumentSerde
}
// An array of search criteria that targets managed nodes using a key-value pair
// that you specify. One or more targets must be specified for maintenance window
// Run Command-type tasks. Depending on the task, targets are optional for other
// maintenance window task types (Automation, Lambda, and Step Functions). For more
// information about running tasks that don't specify targets, see Registering
// maintenance window tasks without targets (https://docs.aws.amazon.com/systems-manager/latest/userguide/maintenance-windows-targetless-tasks.html)
// in the Amazon Web Services Systems Manager User Guide. Supported formats include
// the following.
// - Key=InstanceIds,Values=,,
// - Key=tag:,Values=,
// - Key=tag-key,Values=,
// - Run Command and Maintenance window targets only:
// Key=resource-groups:Name,Values=
// - Maintenance window targets only:
// Key=resource-groups:ResourceTypeFilters,Values=,
// - Automation targets only: Key=ResourceGroup;Values=
//
// For example:
//
// -
// Key=InstanceIds,Values=i-02573cafcfEXAMPLE,i-0471e04240EXAMPLE,i-07782c72faEXAMPLE
// - Key=tag:CostCenter,Values=CostCenter1,CostCenter2,CostCenter3
// - Key=tag-key,Values=Name,Instance-Type,CostCenter
// - Run Command and Maintenance window targets only:
// Key=resource-groups:Name,Values=ProductionResourceGroup This example
// demonstrates how to target all resources in the resource group
// ProductionResourceGroup in your maintenance window.
// - Maintenance window targets only:
// Key=resource-groups:ResourceTypeFilters,Values=AWS::EC2::INSTANCE,AWS::EC2::VPC
// This example demonstrates how to target only Amazon Elastic Compute Cloud
// (Amazon EC2) instances and VPCs in your maintenance window.
// - Automation targets only: Key=ResourceGroup,Values=MyResourceGroup
// - State Manager association targets only: Key=InstanceIds,Values=* This
// example demonstrates how to target all managed instances in the Amazon Web
// Services Region where the association was created.
//
// For more information about how to send commands that target managed nodes using
// Key,Value parameters, see Targeting multiple instances (https://docs.aws.amazon.com/systems-manager/latest/userguide/send-commands-multiple.html#send-commands-targeting)
// in the Amazon Web Services Systems Manager User Guide.
type Target struct {
// User-defined criteria for sending commands that target managed nodes that meet
// the criteria.
Key *string
// 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 EC2 tags of ServerRole,WebServer . Depending on the type
// of target, the maximum number of values for a key might be lower than the global
// maximum of 50.
Values []string
noSmithyDocumentSerde
}
// The combination of Amazon Web Services Regions and Amazon Web Services accounts
// targeted by the current Automation execution.
type TargetLocation struct {
// The Amazon Web Services accounts targeted by the current Automation execution.
Accounts []string
// The Automation execution role used by the currently running Automation. If not
// specified, the default value is AWS-SystemsManager-AutomationExecutionRole .
ExecutionRoleName *string
// The Amazon Web Services Regions targeted by the current Automation execution.
Regions []string
// The details for the CloudWatch alarm you want to apply to an automation or
// command.
TargetLocationAlarmConfiguration *AlarmConfiguration
// The maximum number of Amazon Web Services Regions and Amazon Web Services
// accounts allowed to run the Automation concurrently.
TargetLocationMaxConcurrency *string
// The maximum number of errors allowed before the system stops queueing
// additional Automation executions for the currently running Automation.
TargetLocationMaxErrors *string
noSmithyDocumentSerde
}
type noSmithyDocumentSerde = smithydocument.NoSerde
|