1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325 2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 2338 2339 2340 2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 2372 2373 2374 2375 2376 2377 2378 2379 2380 2381 2382 2383 2384 2385 2386 2387 2388 2389 2390 2391 2392 2393 2394 2395 2396 2397 2398 2399 2400 2401 2402 2403 2404 2405 2406 2407 2408 2409 2410 2411 2412 2413 2414 2415 2416 2417 2418 2419 2420 2421 2422 2423 2424 2425 2426 2427 2428 2429 2430 2431 2432 2433 2434 2435 2436 2437 2438 2439 2440 2441 2442 2443 2444 2445 2446 2447 2448 2449 2450 2451 2452 2453 2454 2455 2456 2457 2458 2459 2460 2461 2462 2463 2464 2465 2466 2467 2468 2469 2470 2471 2472 2473 2474 2475 2476 2477 2478 2479 2480 2481 2482 2483 2484 2485 2486 2487 2488 2489 2490 2491 2492 2493 2494 2495 2496 2497 2498 2499 2500 2501 2502 2503 2504 2505 2506 2507 2508 2509 2510 2511 2512 2513 2514 2515 2516 2517 2518 2519 2520 2521 2522 2523 2524 2525 2526 2527 2528 2529 2530 2531 2532 2533 2534 2535 2536 2537 2538 2539 2540 2541 2542 2543 2544 2545 2546 2547 2548 2549 2550 2551 2552 2553 2554 2555 2556 2557 2558 2559 2560 2561 2562 2563 2564 2565 2566 2567 2568 2569 2570 2571 2572 2573 2574 2575 2576 2577 2578 2579 2580 2581 2582 2583 2584 2585 2586 2587 2588 2589 2590 2591 2592 2593 2594 2595 2596 2597 2598 2599 2600 2601 2602 2603 2604 2605 2606 2607 2608 2609 2610 2611 2612 2613 2614 2615 2616 2617 2618 2619 2620 2621 2622 2623 2624 2625 2626 2627 2628 2629 2630 2631 2632 2633 2634 2635 2636 2637 2638 2639 2640 2641 2642 2643 2644 2645 2646 2647 2648 2649 2650 2651 2652 2653 2654 2655 2656 2657 2658 2659 2660 2661 2662 2663 2664 2665 2666 2667 2668 2669 2670 2671 2672 2673 2674 2675 2676 2677 2678 2679 2680 2681 2682 2683 2684 2685 2686 2687 2688 2689 2690 2691 2692 2693 2694 2695 2696 2697 2698 2699 2700 2701 2702 2703 2704 2705 2706 2707 2708 2709 2710 2711 2712 2713 2714 2715 2716 2717 2718 2719 2720 2721 2722 2723 2724 2725 2726 2727 2728 2729 2730 2731 2732 2733 2734 2735 2736 2737 2738 2739 2740 2741 2742 2743 2744 2745 2746 2747 2748 2749 2750 2751 2752 2753 2754 2755 2756 2757 2758 2759 2760 2761 2762 2763 2764 2765 2766 2767 2768 2769 2770 2771 2772 2773 2774 2775 2776 2777 2778 2779 2780 2781 2782 2783 2784 2785 2786 2787 2788 2789 2790 2791 2792 2793 2794 2795 2796 2797 2798 2799 2800 2801 2802 2803 2804 2805 2806 2807 2808 2809 2810 2811 2812 2813 2814 2815 2816 2817 2818 2819 2820 2821 2822 2823 2824 2825 2826 2827 2828 2829 2830 2831 2832 2833 2834 2835 2836 2837 2838 2839 2840 2841 2842 2843 2844 2845 2846 2847 2848 2849 2850 2851 2852 2853 2854 2855 2856 2857 2858 2859 2860 2861 2862 2863 2864 2865 2866 2867 2868 2869 2870 2871 2872 2873 2874 2875 2876 2877 2878 2879 2880 2881 2882 2883 2884 2885 2886 2887 2888 2889 2890 2891 2892 2893 2894 2895 2896 2897 2898 2899 2900 2901 2902 2903 2904 2905 2906 2907 2908 2909 2910 2911 2912 2913 2914 2915 2916 2917 2918 2919 2920 2921 2922 2923 2924 2925 2926 2927 2928 2929 2930 2931 2932 2933 2934 2935 2936 2937 2938 2939 2940 2941 2942 2943 2944 2945 2946 2947 2948 2949 2950 2951 2952 2953 2954 2955 2956 2957 2958 2959 2960 2961 2962 2963 2964 2965 2966 2967 2968 2969 2970 2971 2972 2973 2974 2975 2976 2977 2978 2979 2980 2981 2982 2983 2984 2985 2986 2987 2988 2989 2990 2991 2992 2993 2994 2995 2996 2997 2998 2999 3000 3001 3002 3003 3004 3005 3006 3007 3008 3009 3010 3011 3012 3013 3014 3015 3016 3017 3018 3019 3020 3021 3022 3023 3024 3025 3026 3027 3028 3029 3030 3031 3032 3033 3034 3035 3036 3037 3038 3039 3040 3041 3042 3043 3044 3045 3046 3047 3048 3049 3050 3051 3052 3053 3054 3055 3056 3057 3058 3059 3060 3061 3062 3063 3064 3065 3066 3067 3068 3069 3070 3071 3072 3073 3074 3075 3076 3077 3078 3079 3080 3081 3082 3083 3084 3085 3086 3087 3088 3089 3090 3091 3092 3093 3094 3095 3096 3097 3098 3099 3100 3101 3102 3103 3104 3105 3106 3107 3108 3109 3110 3111 3112 3113 3114 3115 3116 3117 3118 3119 3120 3121 3122 3123 3124 3125 3126 3127 3128 3129 3130 3131 3132 3133 3134 3135 3136 3137 3138 3139 3140 3141 3142 3143 3144 3145 3146 3147 3148 3149 3150 3151 3152 3153 3154 3155 3156 3157 3158 3159 3160 3161 3162 3163 3164 3165 3166 3167 3168 3169 3170 3171 3172 3173 3174 3175 3176 3177 3178 3179 3180 3181 3182 3183 3184 3185 3186 3187 3188 3189 3190 3191 3192 3193 3194 3195 3196 3197 3198 3199 3200 3201 3202 3203 3204 3205 3206 3207 3208 3209 3210 3211 3212 3213 3214 3215 3216 3217 3218 3219 3220 3221 3222 3223 3224 3225 3226 3227 3228 3229 3230 3231 3232 3233 3234 3235 3236 3237 3238 3239 3240 3241 3242 3243 3244 3245 3246 3247 3248 3249 3250 3251 3252 3253 3254 3255 3256 3257 3258 3259 3260 3261 3262 3263 3264 3265 3266 3267 3268 3269 3270 3271 3272 3273 3274 3275 3276 3277 3278 3279 3280 3281 3282 3283 3284 3285 3286 3287 3288 3289 3290 3291 3292 3293 3294 3295 3296 3297 3298 3299 3300 3301 3302 3303 3304 3305 3306 3307 3308 3309 3310 3311 3312 3313 3314 3315 3316 3317 3318 3319 3320 3321 3322 3323 3324 3325 3326 3327 3328 3329 3330 3331 3332 3333 3334 3335 3336 3337 3338 3339 3340 3341 3342 3343 3344 3345 3346 3347 3348 3349 3350 3351 3352 3353 3354 3355 3356 3357 3358 3359 3360 3361 3362 3363 3364 3365 3366 3367 3368 3369 3370 3371 3372 3373 3374 3375 3376 3377 3378 3379 3380 3381 3382 3383 3384 3385 3386 3387 3388 3389 3390 3391 3392 3393 3394 3395 3396 3397 3398 3399 3400 3401 3402 3403 3404 3405 3406 3407 3408 3409 3410 3411 3412 3413 3414 3415 3416 3417 3418 3419 3420 3421 3422 3423 3424 3425 3426 3427 3428 3429 3430 3431 3432 3433 3434 3435 3436 3437 3438 3439 3440 3441 3442 3443 3444 3445 3446 3447 3448 3449 3450 3451 3452 3453 3454 3455 3456 3457 3458 3459 3460 3461 3462 3463 3464 3465 3466 3467 3468 3469 3470 3471 3472 3473 3474 3475 3476 3477 3478 3479 3480 3481 3482 3483 3484 3485 3486 3487 3488 3489 3490 3491 3492 3493 3494 3495 3496 3497 3498 3499 3500 3501 3502 3503 3504 3505 3506 3507 3508 3509 3510 3511 3512 3513 3514 3515 3516 3517 3518 3519 3520 3521 3522 3523 3524 3525 3526 3527 3528 3529 3530 3531 3532 3533 3534 3535 3536 3537 3538 3539 3540 3541 3542 3543 3544 3545 3546 3547 3548 3549 3550 3551 3552 3553 3554 3555 3556 3557 3558 3559 3560 3561 3562 3563 3564 3565 3566 3567 3568 3569 3570 3571 3572 3573 3574 3575 3576 3577 3578 3579 3580 3581 3582 3583 3584 3585 3586 3587 3588 3589 3590 3591 3592 3593 3594 3595 3596 3597 3598 3599 3600 3601 3602 3603 3604 3605 3606 3607 3608 3609 3610 3611 3612 3613 3614 3615 3616 3617 3618 3619 3620 3621 3622 3623 3624 3625 3626 3627 3628 3629 3630 3631 3632 3633 3634 3635 3636 3637 3638 3639 3640 3641 3642 3643 3644 3645 3646 3647 3648 3649 3650 3651 3652 3653 3654 3655 3656 3657 3658 3659 3660 3661 3662 3663 3664 3665 3666 3667 3668 3669 3670 3671 3672 3673 3674 3675 3676 3677 3678 3679 3680 3681 3682 3683 3684 3685 3686 3687 3688 3689 3690 3691 3692 3693 3694 3695 3696 3697 3698 3699 3700 3701 3702 3703 3704 3705 3706 3707 3708 3709 3710 3711 3712 3713 3714 3715 3716 3717 3718 3719 3720 3721 3722 3723 3724 3725 3726 3727 3728 3729 3730 3731 3732 3733 3734 3735 3736 3737 3738 3739 3740 3741 3742 3743 3744 3745 3746 3747 3748 3749 3750 3751 3752 3753 3754 3755 3756 3757 3758 3759 3760 3761 3762 3763 3764 3765 3766 3767 3768 3769 3770 3771 3772 3773 3774 3775 3776 3777 3778 3779 3780 3781 3782 3783 3784 3785 3786 3787 3788 3789 3790 3791 3792 3793 3794 3795 3796 3797 3798 3799 3800 3801 3802 3803 3804 3805 3806 3807 3808 3809 3810 3811 3812 3813 3814 3815 3816 3817 3818 3819 3820 3821 3822 3823 3824 3825 3826 3827 3828 3829 3830 3831 3832 3833 3834 3835 3836 3837 3838 3839 3840 3841 3842 3843 3844 3845 3846 3847 3848 3849 3850 3851 3852 3853 3854 3855 3856 3857 3858 3859 3860 3861 3862 3863 3864 3865 3866 3867 3868 3869 3870 3871 3872 3873 3874 3875 3876 3877 3878 3879 3880 3881 3882 3883 3884 3885 3886 3887 3888 3889 3890 3891 3892 3893 3894 3895 3896 3897 3898 3899 3900 3901 3902 3903 3904 3905 3906 3907 3908 3909 3910 3911 3912 3913 3914 3915 3916 3917 3918 3919 3920 3921 3922 3923 3924 3925 3926 3927 3928 3929 3930 3931 3932 3933 3934 3935 3936 3937 3938 3939 3940 3941 3942 3943 3944 3945 3946 3947 3948 3949 3950 3951 3952 3953 3954 3955 3956 3957 3958 3959 3960 3961 3962 3963 3964 3965 3966 3967 3968 3969 3970 3971 3972 3973 3974 3975 3976 3977 3978 3979 3980 3981 3982 3983 3984 3985 3986 3987 3988 3989 3990 3991 3992 3993 3994 3995 3996 3997 3998 3999 4000 4001 4002 4003 4004 4005 4006 4007 4008 4009 4010 4011 4012 4013 4014 4015 4016 4017 4018 4019 4020 4021 4022 4023 4024 4025 4026 4027 4028 4029 4030 4031 4032 4033 4034 4035 4036 4037 4038 4039 4040 4041 4042 4043 4044 4045 4046 4047 4048 4049 4050 4051 4052 4053 4054 4055 4056 4057 4058 4059 4060 4061 4062 4063 4064 4065 4066 4067 4068 4069 4070 4071 4072 4073 4074 4075 4076 4077 4078 4079 4080 4081 4082 4083 4084 4085 4086 4087 4088 4089 4090 4091 4092 4093 4094 4095 4096 4097 4098 4099 4100 4101 4102 4103 4104 4105 4106 4107 4108 4109 4110 4111 4112 4113 4114 4115 4116 4117 4118 4119 4120 4121 4122 4123 4124 4125 4126 4127 4128 4129 4130 4131 4132 4133 4134 4135 4136 4137 4138 4139 4140 4141 4142 4143 4144 4145 4146 4147 4148 4149 4150 4151 4152 4153 4154 4155 4156 4157 4158 4159 4160 4161 4162 4163 4164 4165 4166 4167 4168 4169 4170 4171 4172 4173 4174 4175 4176 4177 4178 4179 4180 4181 4182 4183 4184 4185 4186 4187 4188 4189 4190 4191 4192 4193 4194 4195 4196 4197 4198 4199 4200 4201 4202 4203 4204 4205 4206 4207 4208 4209 4210 4211 4212 4213 4214 4215 4216 4217 4218 4219 4220 4221 4222 4223 4224 4225 4226 4227 4228 4229 4230 4231 4232 4233 4234 4235 4236 4237 4238 4239 4240 4241 4242 4243 4244 4245 4246 4247 4248 4249 4250 4251 4252 4253 4254 4255 4256 4257 4258 4259 4260 4261 4262 4263 4264 4265 4266 4267 4268 4269 4270 4271 4272 4273 4274 4275 4276 4277 4278 4279 4280 4281 4282 4283 4284 4285 4286 4287 4288 4289 4290 4291 4292 4293 4294 4295 4296 4297 4298 4299 4300 4301 4302 4303 4304 4305 4306 4307 4308 4309 4310 4311 4312 4313 4314 4315 4316 4317 4318 4319 4320 4321 4322 4323 4324 4325 4326 4327 4328 4329 4330 4331 4332 4333 4334 4335 4336 4337 4338 4339 4340 4341 4342 4343 4344 4345 4346 4347 4348 4349 4350 4351 4352 4353 4354 4355 4356 4357 4358 4359 4360 4361 4362 4363 4364 4365 4366 4367 4368 4369 4370 4371 4372 4373 4374 4375 4376 4377 4378 4379 4380 4381 4382 4383 4384 4385 4386 4387 4388 4389 4390 4391 4392 4393 4394 4395 4396 4397 4398 4399 4400 4401 4402 4403 4404 4405 4406 4407 4408 4409 4410 4411 4412 4413 4414 4415 4416 4417 4418 4419 4420 4421 4422 4423 4424 4425 4426 4427 4428 4429 4430 4431 4432 4433 4434 4435 4436 4437 4438 4439 4440 4441 4442 4443 4444 4445 4446 4447 4448 4449 4450 4451 4452 4453 4454 4455 4456 4457 4458 4459 4460 4461 4462 4463 4464 4465 4466 4467 4468 4469 4470 4471 4472 4473 4474 4475 4476 4477 4478 4479 4480 4481 4482 4483 4484 4485 4486 4487 4488 4489 4490 4491 4492 4493 4494 4495 4496 4497 4498 4499 4500 4501 4502 4503 4504 4505 4506 4507 4508 4509 4510 4511 4512 4513 4514 4515 4516 4517 4518 4519 4520 4521 4522 4523 4524 4525 4526 4527 4528 4529 4530 4531 4532 4533 4534 4535 4536 4537 4538 4539 4540 4541 4542 4543 4544 4545 4546 4547 4548 4549 4550 4551 4552 4553 4554 4555 4556 4557 4558 4559 4560 4561 4562 4563 4564 4565 4566 4567 4568 4569 4570 4571 4572 4573 4574 4575 4576 4577 4578 4579 4580 4581 4582 4583 4584 4585 4586 4587 4588 4589 4590 4591 4592 4593 4594 4595 4596 4597 4598 4599 4600 4601 4602 4603 4604 4605 4606 4607 4608 4609 4610 4611 4612 4613 4614 4615 4616 4617 4618 4619 4620 4621 4622 4623 4624 4625 4626 4627 4628 4629 4630 4631 4632 4633 4634 4635 4636 4637 4638 4639 4640 4641 4642 4643 4644 4645 4646 4647 4648 4649 4650 4651 4652 4653 4654 4655 4656 4657 4658 4659 4660 4661 4662 4663 4664 4665 4666 4667 4668 4669 4670 4671 4672 4673 4674 4675 4676 4677 4678 4679 4680 4681 4682 4683 4684 4685 4686 4687 4688 4689 4690 4691 4692 4693 4694 4695 4696 4697 4698 4699 4700 4701 4702 4703 4704 4705 4706 4707 4708 4709 4710 4711 4712 4713 4714 4715 4716 4717 4718 4719 4720 4721 4722 4723 4724 4725 4726 4727 4728 4729 4730 4731 4732 4733 4734 4735 4736 4737 4738 4739 4740 4741 4742 4743 4744 4745 4746 4747 4748 4749 4750 4751 4752 4753 4754 4755 4756 4757 4758 4759 4760 4761 4762 4763 4764 4765 4766 4767 4768 4769 4770 4771 4772 4773 4774 4775 4776 4777 4778 4779 4780 4781 4782 4783 4784 4785 4786 4787 4788 4789 4790 4791 4792 4793 4794 4795 4796 4797 4798 4799 4800 4801 4802 4803 4804 4805 4806 4807 4808 4809 4810 4811 4812 4813 4814 4815 4816 4817 4818 4819 4820 4821 4822 4823 4824 4825 4826 4827 4828 4829 4830 4831 4832 4833 4834 4835 4836 4837 4838 4839 4840 4841 4842 4843 4844 4845 4846 4847 4848 4849 4850 4851 4852 4853 4854 4855 4856 4857 4858 4859 4860 4861 4862 4863 4864 4865 4866 4867 4868 4869 4870 4871 4872 4873 4874 4875 4876 4877 4878 4879 4880 4881 4882 4883 4884 4885 4886 4887 4888 4889 4890 4891 4892 4893 4894 4895 4896 4897 4898 4899 4900 4901 4902 4903 4904 4905 4906 4907 4908 4909 4910 4911 4912 4913 4914 4915 4916 4917 4918 4919 4920 4921 4922 4923 4924 4925 4926 4927 4928 4929 4930 4931 4932 4933 4934 4935 4936 4937 4938 4939 4940 4941 4942 4943 4944 4945 4946 4947 4948 4949 4950 4951 4952 4953 4954 4955 4956 4957 4958 4959 4960 4961 4962 4963 4964 4965 4966 4967 4968 4969 4970 4971 4972 4973 4974 4975 4976 4977 4978 4979 4980 4981 4982 4983 4984 4985 4986 4987 4988 4989 4990 4991 4992 4993 4994 4995 4996 4997 4998 4999 5000 5001 5002 5003 5004 5005 5006 5007 5008 5009 5010 5011 5012 5013 5014 5015 5016 5017 5018 5019 5020 5021 5022 5023 5024 5025 5026 5027 5028 5029 5030 5031 5032 5033 5034 5035 5036 5037 5038 5039 5040 5041 5042 5043 5044 5045 5046 5047 5048 5049 5050 5051 5052 5053 5054 5055 5056 5057 5058 5059 5060 5061 5062 5063 5064 5065 5066 5067 5068 5069 5070 5071 5072 5073 5074 5075 5076 5077 5078 5079 5080 5081 5082 5083 5084 5085 5086 5087 5088 5089 5090 5091 5092 5093 5094 5095 5096 5097 5098 5099 5100 5101 5102 5103 5104 5105 5106 5107 5108 5109 5110 5111 5112 5113 5114 5115 5116 5117 5118 5119 5120 5121 5122 5123 5124 5125 5126 5127 5128 5129 5130 5131 5132 5133 5134 5135 5136 5137 5138 5139 5140 5141 5142 5143 5144 5145 5146 5147 5148 5149 5150 5151 5152 5153 5154 5155 5156 5157 5158 5159 5160 5161 5162 5163 5164 5165 5166 5167 5168 5169 5170 5171 5172 5173 5174 5175 5176 5177 5178 5179 5180 5181 5182 5183 5184 5185 5186 5187 5188 5189 5190 5191 5192 5193 5194 5195 5196 5197 5198 5199 5200 5201 5202 5203 5204 5205 5206 5207 5208 5209 5210 5211 5212 5213 5214 5215 5216 5217 5218 5219 5220 5221 5222 5223 5224 5225 5226 5227 5228 5229 5230 5231 5232 5233 5234 5235 5236 5237 5238 5239 5240 5241 5242 5243 5244 5245 5246 5247 5248 5249 5250 5251 5252 5253 5254 5255 5256 5257 5258 5259 5260 5261 5262 5263 5264 5265 5266 5267 5268 5269 5270 5271 5272 5273 5274 5275 5276 5277 5278 5279 5280 5281 5282 5283 5284 5285 5286 5287 5288 5289 5290 5291 5292 5293 5294 5295 5296 5297 5298 5299 5300 5301 5302 5303 5304 5305 5306 5307 5308 5309 5310 5311 5312 5313 5314 5315 5316 5317 5318 5319 5320 5321 5322 5323 5324 5325 5326 5327 5328 5329 5330 5331 5332 5333 5334 5335 5336 5337 5338 5339 5340 5341 5342 5343 5344 5345 5346 5347 5348 5349 5350 5351 5352 5353 5354 5355 5356 5357 5358 5359 5360 5361 5362 5363 5364 5365 5366 5367 5368 5369 5370 5371 5372 5373 5374 5375 5376 5377 5378 5379 5380 5381 5382 5383 5384 5385 5386 5387 5388 5389 5390 5391 5392 5393 5394 5395 5396 5397 5398 5399 5400 5401 5402 5403 5404 5405 5406 5407 5408 5409 5410 5411 5412 5413 5414 5415 5416 5417 5418 5419 5420 5421 5422 5423 5424 5425 5426 5427 5428 5429 5430 5431 5432 5433 5434 5435 5436 5437 5438 5439 5440 5441 5442 5443 5444 5445 5446 5447 5448 5449 5450 5451 5452 5453 5454 5455 5456 5457 5458 5459 5460 5461 5462 5463 5464 5465 5466 5467 5468 5469 5470 5471 5472 5473 5474 5475 5476 5477 5478 5479 5480 5481 5482 5483 5484 5485 5486 5487 5488 5489 5490 5491 5492 5493 5494 5495 5496 5497 5498 5499 5500 5501 5502 5503 5504 5505 5506 5507 5508 5509 5510 5511 5512 5513 5514 5515 5516 5517 5518 5519 5520 5521 5522 5523 5524 5525 5526 5527 5528 5529 5530 5531 5532 5533 5534 5535 5536 5537 5538 5539 5540 5541 5542 5543 5544 5545 5546 5547 5548 5549 5550 5551 5552 5553 5554 5555 5556 5557 5558 5559 5560 5561 5562 5563 5564 5565 5566 5567 5568 5569 5570 5571 5572 5573 5574 5575 5576 5577 5578 5579 5580 5581 5582 5583 5584 5585 5586 5587 5588 5589 5590 5591 5592 5593 5594 5595 5596 5597 5598 5599 5600 5601 5602 5603 5604 5605 5606 5607 5608 5609 5610 5611 5612 5613 5614 5615 5616 5617 5618 5619 5620 5621 5622 5623 5624 5625 5626 5627 5628 5629 5630 5631 5632 5633 5634 5635 5636 5637 5638 5639 5640 5641 5642 5643 5644 5645 5646 5647 5648 5649 5650 5651 5652 5653 5654 5655 5656 5657 5658 5659 5660 5661 5662 5663 5664 5665 5666 5667 5668 5669 5670 5671 5672 5673 5674 5675 5676 5677 5678 5679 5680 5681 5682 5683 5684 5685 5686 5687 5688 5689 5690 5691 5692 5693 5694 5695 5696 5697 5698 5699 5700 5701 5702 5703 5704 5705 5706 5707 5708 5709 5710 5711 5712 5713 5714 5715 5716 5717 5718 5719 5720 5721 5722 5723 5724 5725 5726 5727 5728 5729 5730
// ================================================================= // // * WARNING * // // This file is generated! // // Changes made to this file will be overwritten. If changes are // required to the generated code, the service_crategen project // must be updated to generate the changes. // // ================================================================= use std::error::Error; use std::fmt; use async_trait::async_trait; use rusoto_core::credential::ProvideAwsCredentials; use rusoto_core::region; use rusoto_core::request::{BufferedHttpResponse, DispatchSignedRequest}; use rusoto_core::{Client, RusotoError}; use rusoto_core::proto; use rusoto_core::request::HttpResponse; use rusoto_core::signature::SignedRequest; #[allow(unused_imports)] use serde::{Deserialize, Serialize}; impl KmsClient { fn new_signed_request(&self, http_method: &str, request_uri: &str) -> SignedRequest { let mut request = SignedRequest::new(http_method, "kms", &self.region, request_uri); request.set_content_type("application/x-amz-json-1.1".to_owned()); request } async fn sign_and_dispatch<E>( &self, request: SignedRequest, from_response: fn(BufferedHttpResponse) -> RusotoError<E>, ) -> Result<HttpResponse, RusotoError<E>> { let mut response = self.client.sign_and_dispatch(request).await?; if !response.status.is_success() { let response = response.buffer().await.map_err(RusotoError::HttpDispatch)?; return Err(from_response(response)); } Ok(response) } } use serde_json; /// <p>Contains information about an alias.</p> #[derive(Clone, Debug, Default, Deserialize, PartialEq)] #[cfg_attr(any(test, feature = "serialize_structs"), derive(Serialize))] pub struct AliasListEntry { /// <p>String that contains the key ARN.</p> #[serde(rename = "AliasArn")] #[serde(skip_serializing_if = "Option::is_none")] pub alias_arn: Option<String>, /// <p>String that contains the alias. This value begins with <code>alias/</code>.</p> #[serde(rename = "AliasName")] #[serde(skip_serializing_if = "Option::is_none")] pub alias_name: Option<String>, /// <p>String that contains the key identifier referred to by the alias.</p> #[serde(rename = "TargetKeyId")] #[serde(skip_serializing_if = "Option::is_none")] pub target_key_id: Option<String>, } #[derive(Clone, Debug, Default, PartialEq, Serialize)] #[cfg_attr(feature = "deserialize_structs", derive(Deserialize))] pub struct CancelKeyDeletionRequest { /// <p>The unique identifier for the customer master key (CMK) for which to cancel deletion.</p> <p>Specify the key ID or the Amazon Resource Name (ARN) of the CMK.</p> <p>For example:</p> <ul> <li> <p>Key ID: <code>1234abcd-12ab-34cd-56ef-1234567890ab</code> </p> </li> <li> <p>Key ARN: <code>arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab</code> </p> </li> </ul> <p>To get the key ID and key ARN for a CMK, use <a>ListKeys</a> or <a>DescribeKey</a>.</p> #[serde(rename = "KeyId")] pub key_id: String, } #[derive(Clone, Debug, Default, Deserialize, PartialEq)] #[cfg_attr(any(test, feature = "serialize_structs"), derive(Serialize))] pub struct CancelKeyDeletionResponse { /// <p>The Amazon Resource Name (<a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id-key-ARN">key ARN</a>) of the CMK whose deletion is canceled.</p> #[serde(rename = "KeyId")] #[serde(skip_serializing_if = "Option::is_none")] pub key_id: Option<String>, } #[derive(Clone, Debug, Default, PartialEq, Serialize)] #[cfg_attr(feature = "deserialize_structs", derive(Deserialize))] pub struct ConnectCustomKeyStoreRequest { /// <p>Enter the key store ID of the custom key store that you want to connect. To find the ID of a custom key store, use the <a>DescribeCustomKeyStores</a> operation.</p> #[serde(rename = "CustomKeyStoreId")] pub custom_key_store_id: String, } #[derive(Clone, Debug, Default, Deserialize, PartialEq)] #[cfg_attr(any(test, feature = "serialize_structs"), derive(Serialize))] pub struct ConnectCustomKeyStoreResponse {} #[derive(Clone, Debug, Default, PartialEq, Serialize)] #[cfg_attr(feature = "deserialize_structs", derive(Deserialize))] pub struct CreateAliasRequest { /// <p>Specifies the alias name. This value must begin with <code>alias/</code> followed by a name, such as <code>alias/ExampleAlias</code>. The alias name cannot begin with <code>alias/aws/</code>. The <code>alias/aws/</code> prefix is reserved for AWS managed CMKs.</p> #[serde(rename = "AliasName")] pub alias_name: String, /// <p>Identifies the CMK to which the alias refers. Specify the key ID or the Amazon Resource Name (ARN) of the CMK. You cannot specify another alias. For help finding the key ID and ARN, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/viewing-keys.html#find-cmk-id-arn">Finding the Key ID and ARN</a> in the <i>AWS Key Management Service Developer Guide</i>.</p> #[serde(rename = "TargetKeyId")] pub target_key_id: String, } #[derive(Clone, Debug, Default, PartialEq, Serialize)] #[cfg_attr(feature = "deserialize_structs", derive(Deserialize))] pub struct CreateCustomKeyStoreRequest { /// <p>Identifies the AWS CloudHSM cluster for the custom key store. Enter the cluster ID of any active AWS CloudHSM cluster that is not already associated with a custom key store. To find the cluster ID, use the <a href="https://docs.aws.amazon.com/cloudhsm/latest/APIReference/API_DescribeClusters.html">DescribeClusters</a> operation.</p> #[serde(rename = "CloudHsmClusterId")] pub cloud_hsm_cluster_id: String, /// <p>Specifies a friendly name for the custom key store. The name must be unique in your AWS account.</p> #[serde(rename = "CustomKeyStoreName")] pub custom_key_store_name: String, /// <p>Enter the password of the <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-store-concepts.html#concept-kmsuser"> <code>kmsuser</code> crypto user (CU) account</a> in the specified AWS CloudHSM cluster. AWS KMS logs into the cluster as this user to manage key material on your behalf.</p> <p>The password must be a string of 7 to 32 characters. Its value is case sensitive.</p> <p>This parameter tells AWS KMS the <code>kmsuser</code> account password; it does not change the password in the AWS CloudHSM cluster.</p> #[serde(rename = "KeyStorePassword")] pub key_store_password: String, /// <p>Enter the content of the trust anchor certificate for the cluster. This is the content of the <code>customerCA.crt</code> file that you created when you <a href="https://docs.aws.amazon.com/cloudhsm/latest/userguide/initialize-cluster.html">initialized the cluster</a>.</p> #[serde(rename = "TrustAnchorCertificate")] pub trust_anchor_certificate: String, } #[derive(Clone, Debug, Default, Deserialize, PartialEq)] #[cfg_attr(any(test, feature = "serialize_structs"), derive(Serialize))] pub struct CreateCustomKeyStoreResponse { /// <p>A unique identifier for the new custom key store.</p> #[serde(rename = "CustomKeyStoreId")] #[serde(skip_serializing_if = "Option::is_none")] pub custom_key_store_id: Option<String>, } #[derive(Clone, Debug, Default, PartialEq, Serialize)] #[cfg_attr(feature = "deserialize_structs", derive(Deserialize))] pub struct CreateGrantRequest { /// <p>Allows a <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#cryptographic-operations">cryptographic operation</a> only when the encryption context matches or includes the encryption context specified in this structure. For more information about encryption context, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context">Encryption Context</a> in the <i> <i>AWS Key Management Service Developer Guide</i> </i>.</p> #[serde(rename = "Constraints")] #[serde(skip_serializing_if = "Option::is_none")] pub constraints: Option<GrantConstraints>, /// <p>A list of grant tokens.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#grant_token">Grant Tokens</a> in the <i>AWS Key Management Service Developer Guide</i>.</p> #[serde(rename = "GrantTokens")] #[serde(skip_serializing_if = "Option::is_none")] pub grant_tokens: Option<Vec<String>>, /// <p>The principal that is given permission to perform the operations that the grant permits.</p> <p>To specify the principal, use the <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Name (ARN)</a> of an AWS principal. Valid AWS principals include AWS accounts (root), IAM users, IAM roles, federated users, and assumed role users. For examples of the ARN syntax to use for specifying a principal, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#arn-syntax-iam">AWS Identity and Access Management (IAM)</a> in the Example ARNs section of the <i>AWS General Reference</i>.</p> #[serde(rename = "GranteePrincipal")] pub grantee_principal: String, /// <p>The unique identifier for the customer master key (CMK) that the grant applies to.</p> <p>Specify the key ID or the Amazon Resource Name (ARN) of the CMK. To specify a CMK in a different AWS account, you must use the key ARN.</p> <p>For example:</p> <ul> <li> <p>Key ID: <code>1234abcd-12ab-34cd-56ef-1234567890ab</code> </p> </li> <li> <p>Key ARN: <code>arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab</code> </p> </li> </ul> <p>To get the key ID and key ARN for a CMK, use <a>ListKeys</a> or <a>DescribeKey</a>.</p> #[serde(rename = "KeyId")] pub key_id: String, /// <p>A friendly name for identifying the grant. Use this value to prevent the unintended creation of duplicate grants when retrying this request.</p> <p>When this value is absent, all <code>CreateGrant</code> requests result in a new grant with a unique <code>GrantId</code> even if all the supplied parameters are identical. This can result in unintended duplicates when you retry the <code>CreateGrant</code> request.</p> <p>When this value is present, you can retry a <code>CreateGrant</code> request with identical parameters; if the grant already exists, the original <code>GrantId</code> is returned without creating a new grant. Note that the returned grant token is unique with every <code>CreateGrant</code> request, even when a duplicate <code>GrantId</code> is returned. All grant tokens obtained in this way can be used interchangeably.</p> #[serde(rename = "Name")] #[serde(skip_serializing_if = "Option::is_none")] pub name: Option<String>, /// <p>A list of operations that the grant permits.</p> #[serde(rename = "Operations")] pub operations: Vec<String>, /// <p>The principal that is given permission to retire the grant by using <a>RetireGrant</a> operation.</p> <p>To specify the principal, use the <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Name (ARN)</a> of an AWS principal. Valid AWS principals include AWS accounts (root), IAM users, federated users, and assumed role users. For examples of the ARN syntax to use for specifying a principal, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#arn-syntax-iam">AWS Identity and Access Management (IAM)</a> in the Example ARNs section of the <i>AWS General Reference</i>.</p> #[serde(rename = "RetiringPrincipal")] #[serde(skip_serializing_if = "Option::is_none")] pub retiring_principal: Option<String>, } #[derive(Clone, Debug, Default, Deserialize, PartialEq)] #[cfg_attr(any(test, feature = "serialize_structs"), derive(Serialize))] pub struct CreateGrantResponse { /// <p>The unique identifier for the grant.</p> <p>You can use the <code>GrantId</code> in a subsequent <a>RetireGrant</a> or <a>RevokeGrant</a> operation.</p> #[serde(rename = "GrantId")] #[serde(skip_serializing_if = "Option::is_none")] pub grant_id: Option<String>, /// <p>The grant token.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#grant_token">Grant Tokens</a> in the <i>AWS Key Management Service Developer Guide</i>.</p> #[serde(rename = "GrantToken")] #[serde(skip_serializing_if = "Option::is_none")] pub grant_token: Option<String>, } #[derive(Clone, Debug, Default, PartialEq, Serialize)] #[cfg_attr(feature = "deserialize_structs", derive(Deserialize))] pub struct CreateKeyRequest { /// <p>A flag to indicate whether to bypass the key policy lockout safety check.</p> <important> <p>Setting this value to true increases the risk that the CMK becomes unmanageable. Do not set this value to true indiscriminately.</p> <p>For more information, refer to the scenario in the <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html#key-policy-default-allow-root-enable-iam">Default Key Policy</a> section in the <i> <i>AWS Key Management Service Developer Guide</i> </i>.</p> </important> <p>Use this parameter only when you include a policy in the request and you intend to prevent the principal that is making the request from making a subsequent <a>PutKeyPolicy</a> request on the CMK.</p> <p>The default value is false.</p> #[serde(rename = "BypassPolicyLockoutSafetyCheck")] #[serde(skip_serializing_if = "Option::is_none")] pub bypass_policy_lockout_safety_check: Option<bool>, /// <p>Creates the CMK in the specified <a href="https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html">custom key store</a> and the key material in its associated AWS CloudHSM cluster. To create a CMK in a custom key store, you must also specify the <code>Origin</code> parameter with a value of <code>AWS_CLOUDHSM</code>. The AWS CloudHSM cluster that is associated with the custom key store must have at least two active HSMs, each in a different Availability Zone in the Region.</p> <p>This parameter is valid only for symmetric CMKs. You cannot create an asymmetric CMK in a custom key store.</p> <p>To find the ID of a custom key store, use the <a>DescribeCustomKeyStores</a> operation.</p> <p>The response includes the custom key store ID and the ID of the AWS CloudHSM cluster.</p> <p>This operation is part of the <a href="https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html">Custom Key Store feature</a> feature in AWS KMS, which combines the convenience and extensive integration of AWS KMS with the isolation and control of a single-tenant key store.</p> #[serde(rename = "CustomKeyStoreId")] #[serde(skip_serializing_if = "Option::is_none")] pub custom_key_store_id: Option<String>, /// <p><p>Specifies the type of CMK to create. The default value, <code>SYMMETRIC<em>DEFAULT</code>, creates a CMK with a 256-bit symmetric key for encryption and decryption. For help choosing a key spec for your CMK, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/symm-asymm-choose.html">How to Choose Your CMK Configuration</a> in the <i>AWS Key Management Service Developer Guide</i>.</p> <p>The <code>CustomerMasterKeySpec</code> determines whether the CMK contains a symmetric key or an asymmetric key pair. It also determines the encryption algorithms or signing algorithms that the CMK supports. You can't change the <code>CustomerMasterKeySpec</code> after the CMK is created. To further restrict the algorithms that can be used with the CMK, use a condition key in its key policy or IAM policy. For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/policy-conditions.html#conditions-kms-encryption-algorithm">kms:EncryptionAlgorithm</a> or <a href="https://docs.aws.amazon.com/kms/latest/developerguide/policy-conditions.html#conditions-kms-signing-algorithm">kms:Signing Algorithm</a> in the <i>AWS Key Management Service Developer Guide</i>.</p> <important> <p> <a href="http://aws.amazon.com/kms/features/#AWS</em>Service<em>Integration">AWS services that are integrated with AWS KMS</a> use symmetric CMKs to protect your data. These services do not support asymmetric CMKs. For help determining whether a CMK is symmetric or asymmetric, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/find-symm-asymm.html">Identifying Symmetric and Asymmetric CMKs</a> in the <i>AWS Key Management Service Developer Guide</i>.</p> </important> <p>AWS KMS supports the following key specs for CMKs:</p> <ul> <li> <p>Symmetric key (default)</p> <ul> <li> <p> <code>SYMMETRIC</em>DEFAULT</code> (AES-256-GCM)</p> </li> </ul> </li> <li> <p>Asymmetric RSA key pairs</p> <ul> <li> <p> <code>RSA<em>2048</code> </p> </li> <li> <p> <code>RSA</em>3072</code> </p> </li> <li> <p> <code>RSA<em>4096</code> </p> </li> </ul> </li> <li> <p>Asymmetric NIST-recommended elliptic curve key pairs</p> <ul> <li> <p> <code>ECC</em>NIST<em>P256</code> (secp256r1)</p> </li> <li> <p> <code>ECC</em>NIST<em>P384</code> (secp384r1)</p> </li> <li> <p> <code>ECC</em>NIST<em>P521</code> (secp521r1)</p> </li> </ul> </li> <li> <p>Other asymmetric elliptic curve key pairs</p> <ul> <li> <p> <code>ECC</em>SECG_P256K1</code> (secp256k1), commonly used for cryptocurrencies.</p> </li> </ul> </li> </ul></p> #[serde(rename = "CustomerMasterKeySpec")] #[serde(skip_serializing_if = "Option::is_none")] pub customer_master_key_spec: Option<String>, /// <p>A description of the CMK.</p> <p>Use a description that helps you decide whether the CMK is appropriate for a task.</p> #[serde(rename = "Description")] #[serde(skip_serializing_if = "Option::is_none")] pub description: Option<String>, /// <p><p>Determines the <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#cryptographic-operations">cryptographic operations</a> for which you can use the CMK. The default value is <code>ENCRYPT<em>DECRYPT</code>. This parameter is required only for asymmetric CMKs. You can't change the <code>KeyUsage</code> value after the CMK is created.</p> <p>Select only one valid value.</p> <ul> <li> <p>For symmetric CMKs, omit the parameter or specify <code>ENCRYPT</em>DECRYPT</code>.</p> </li> <li> <p>For asymmetric CMKs with RSA key material, specify <code>ENCRYPT<em>DECRYPT</code> or <code>SIGN</em>VERIFY</code>.</p> </li> <li> <p>For asymmetric CMKs with ECC key material, specify <code>SIGN_VERIFY</code>.</p> </li> </ul></p> #[serde(rename = "KeyUsage")] #[serde(skip_serializing_if = "Option::is_none")] pub key_usage: Option<String>, /// <p>The source of the key material for the CMK. You cannot change the origin after you create the CMK. The default is <code>AWS_KMS</code>, which means AWS KMS creates the key material.</p> <p>When the parameter value is <code>EXTERNAL</code>, AWS KMS creates a CMK without key material so that you can import key material from your existing key management infrastructure. For more information about importing key material into AWS KMS, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys.html">Importing Key Material</a> in the <i>AWS Key Management Service Developer Guide</i>. This value is valid only for symmetric CMKs.</p> <p>When the parameter value is <code>AWS_CLOUDHSM</code>, AWS KMS creates the CMK in an AWS KMS <a href="https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html">custom key store</a> and creates its key material in the associated AWS CloudHSM cluster. You must also use the <code>CustomKeyStoreId</code> parameter to identify the custom key store. This value is valid only for symmetric CMKs.</p> #[serde(rename = "Origin")] #[serde(skip_serializing_if = "Option::is_none")] pub origin: Option<String>, /// <p>The key policy to attach to the CMK.</p> <p>If you provide a key policy, it must meet the following criteria:</p> <ul> <li> <p>If you don't set <code>BypassPolicyLockoutSafetyCheck</code> to true, the key policy must allow the principal that is making the <code>CreateKey</code> request to make a subsequent <a>PutKeyPolicy</a> request on the CMK. This reduces the risk that the CMK becomes unmanageable. For more information, refer to the scenario in the <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html#key-policy-default-allow-root-enable-iam">Default Key Policy</a> section of the <i> <i>AWS Key Management Service Developer Guide</i> </i>.</p> </li> <li> <p>Each statement in the key policy must contain one or more principals. The principals in the key policy must exist and be visible to AWS KMS. When you create a new AWS principal (for example, an IAM user or role), you might need to enforce a delay before including the new principal in a key policy because the new principal might not be immediately visible to AWS KMS. For more information, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/troubleshoot_general.html#troubleshoot_general_eventual-consistency">Changes that I make are not always immediately visible</a> in the <i>AWS Identity and Access Management User Guide</i>.</p> </li> </ul> <p>If you do not provide a key policy, AWS KMS attaches a default key policy to the CMK. For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html#key-policy-default">Default Key Policy</a> in the <i>AWS Key Management Service Developer Guide</i>.</p> <p>The key policy size quota is 32 kilobytes (32768 bytes).</p> #[serde(rename = "Policy")] #[serde(skip_serializing_if = "Option::is_none")] pub policy: Option<String>, /// <p>One or more tags. Each tag consists of a tag key and a tag value. Both the tag key and the tag value are required, but the tag value can be an empty (null) string.</p> <p>When you add tags to an AWS resource, AWS generates a cost allocation report with usage and costs aggregated by tags. For information about adding, changing, deleting and listing tags for CMKs, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/tagging-keys.html">Tagging Keys</a>.</p> <p>Use this parameter to tag the CMK when it is created. To add tags to an existing CMK, use the <a>TagResource</a> operation.</p> #[serde(rename = "Tags")] #[serde(skip_serializing_if = "Option::is_none")] pub tags: Option<Vec<Tag>>, } #[derive(Clone, Debug, Default, Deserialize, PartialEq)] #[cfg_attr(any(test, feature = "serialize_structs"), derive(Serialize))] pub struct CreateKeyResponse { /// <p>Metadata associated with the CMK.</p> #[serde(rename = "KeyMetadata")] #[serde(skip_serializing_if = "Option::is_none")] pub key_metadata: Option<KeyMetadata>, } /// <p>Contains information about each custom key store in the custom key store list.</p> #[derive(Clone, Debug, Default, Deserialize, PartialEq)] #[cfg_attr(any(test, feature = "serialize_structs"), derive(Serialize))] pub struct CustomKeyStoresListEntry { /// <p>A unique identifier for the AWS CloudHSM cluster that is associated with the custom key store.</p> #[serde(rename = "CloudHsmClusterId")] #[serde(skip_serializing_if = "Option::is_none")] pub cloud_hsm_cluster_id: Option<String>, /// <p><p>Describes the connection error. This field appears in the response only when the <code>ConnectionState</code> is <code>FAILED</code>. For help resolving these errors, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/fix-keystore.html#fix-keystore-failed">How to Fix a Connection Failure</a> in <i>AWS Key Management Service Developer Guide</i>.</p> <p>Valid values are:</p> <ul> <li> <p> <code>CLUSTER<em>NOT</em>FOUND</code> - AWS KMS cannot find the AWS CloudHSM cluster with the specified cluster ID.</p> </li> <li> <p> <code>INSUFFICIENT<em>CLOUDHSM</em>HSMS</code> - The associated AWS CloudHSM cluster does not contain any active HSMs. To connect a custom key store to its AWS CloudHSM cluster, the cluster must contain at least one active HSM.</p> </li> <li> <p> <code>INTERNAL<em>ERROR</code> - AWS KMS could not complete the request due to an internal error. Retry the request. For <code>ConnectCustomKeyStore</code> requests, disconnect the custom key store before trying to connect again.</p> </li> <li> <p> <code>INVALID</em>CREDENTIALS</code> - AWS KMS does not have the correct password for the <code>kmsuser</code> crypto user in the AWS CloudHSM cluster. Before you can connect your custom key store to its AWS CloudHSM cluster, you must change the <code>kmsuser</code> account password and update the key store password value for the custom key store.</p> </li> <li> <p> <code>NETWORK<em>ERRORS</code> - Network errors are preventing AWS KMS from connecting to the custom key store.</p> </li> <li> <p> <code>SUBNET</em>NOT<em>FOUND</code> - A subnet in the AWS CloudHSM cluster configuration was deleted. If AWS KMS cannot find all of the subnets in the cluster configuration, attempts to connect the custom key store to the AWS CloudHSM cluster fail. To fix this error, create a cluster from a recent backup and associate it with your custom key store. (This process creates a new cluster configuration with a VPC and private subnets.) For details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/fix-keystore.html#fix-keystore-failed">How to Fix a Connection Failure</a> in the <i>AWS Key Management Service Developer Guide</i>.</p> </li> <li> <p> <code>USER</em>LOCKED<em>OUT</code> - The <code>kmsuser</code> CU account is locked out of the associated AWS CloudHSM cluster due to too many failed password attempts. Before you can connect your custom key store to its AWS CloudHSM cluster, you must change the <code>kmsuser</code> account password and update the key store password value for the custom key store.</p> </li> <li> <p> <code>USER</em>LOGGED<em>IN</code> - The <code>kmsuser</code> CU account is logged into the the associated AWS CloudHSM cluster. This prevents AWS KMS from rotating the <code>kmsuser</code> account password and logging into the cluster. Before you can connect your custom key store to its AWS CloudHSM cluster, you must log the <code>kmsuser</code> CU out of the cluster. If you changed the <code>kmsuser</code> password to log into the cluster, you must also and update the key store password value for the custom key store. For help, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/fix-keystore.html#login-kmsuser-2">How to Log Out and Reconnect</a> in the <i>AWS Key Management Service Developer Guide</i>.</p> </li> <li> <p> <code>USER</em>NOT_FOUND</code> - AWS KMS cannot find a <code>kmsuser</code> CU account in the associated AWS CloudHSM cluster. Before you can connect your custom key store to its AWS CloudHSM cluster, you must create a <code>kmsuser</code> CU account in the cluster, and then update the key store password value for the custom key store.</p> </li> </ul></p> #[serde(rename = "ConnectionErrorCode")] #[serde(skip_serializing_if = "Option::is_none")] pub connection_error_code: Option<String>, /// <p>Indicates whether the custom key store is connected to its AWS CloudHSM cluster.</p> <p>You can create and use CMKs in your custom key stores only when its connection state is <code>CONNECTED</code>.</p> <p>The value is <code>DISCONNECTED</code> if the key store has never been connected or you use the <a>DisconnectCustomKeyStore</a> operation to disconnect it. If the value is <code>CONNECTED</code> but you are having trouble using the custom key store, make sure that its associated AWS CloudHSM cluster is active and contains at least one active HSM.</p> <p>A value of <code>FAILED</code> indicates that an attempt to connect was unsuccessful. The <code>ConnectionErrorCode</code> field in the response indicates the cause of the failure. For help resolving a connection failure, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/fix-keystore.html">Troubleshooting a Custom Key Store</a> in the <i>AWS Key Management Service Developer Guide</i>.</p> #[serde(rename = "ConnectionState")] #[serde(skip_serializing_if = "Option::is_none")] pub connection_state: Option<String>, /// <p>The date and time when the custom key store was created.</p> #[serde(rename = "CreationDate")] #[serde(skip_serializing_if = "Option::is_none")] pub creation_date: Option<f64>, /// <p>A unique identifier for the custom key store.</p> #[serde(rename = "CustomKeyStoreId")] #[serde(skip_serializing_if = "Option::is_none")] pub custom_key_store_id: Option<String>, /// <p>The user-specified friendly name for the custom key store.</p> #[serde(rename = "CustomKeyStoreName")] #[serde(skip_serializing_if = "Option::is_none")] pub custom_key_store_name: Option<String>, /// <p>The trust anchor certificate of the associated AWS CloudHSM cluster. When you <a href="https://docs.aws.amazon.com/cloudhsm/latest/userguide/initialize-cluster.html#sign-csr">initialize the cluster</a>, you create this certificate and save it in the <code>customerCA.crt</code> file.</p> #[serde(rename = "TrustAnchorCertificate")] #[serde(skip_serializing_if = "Option::is_none")] pub trust_anchor_certificate: Option<String>, } #[derive(Clone, Debug, Default, PartialEq, Serialize)] #[cfg_attr(feature = "deserialize_structs", derive(Deserialize))] pub struct DecryptRequest { /// <p>Ciphertext to be decrypted. The blob includes metadata.</p> #[serde(rename = "CiphertextBlob")] #[serde( deserialize_with = "::rusoto_core::serialization::SerdeBlob::deserialize_blob", serialize_with = "::rusoto_core::serialization::SerdeBlob::serialize_blob", default )] pub ciphertext_blob: bytes::Bytes, /// <p>Specifies the encryption algorithm that will be used to decrypt the ciphertext. Specify the same algorithm that was used to encrypt the data. If you specify a different algorithm, the <code>Decrypt</code> operation fails.</p> <p>This parameter is required only when the ciphertext was encrypted under an asymmetric CMK. The default value, <code>SYMMETRIC_DEFAULT</code>, represents the only supported algorithm that is valid for symmetric CMKs.</p> #[serde(rename = "EncryptionAlgorithm")] #[serde(skip_serializing_if = "Option::is_none")] pub encryption_algorithm: Option<String>, /// <p>Specifies the encryption context to use when decrypting the data. An encryption context is valid only for <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#cryptographic-operations">cryptographic operations</a> with a symmetric CMK. The standard asymmetric encryption algorithms that AWS KMS uses do not support an encryption context.</p> <p>An <i>encryption context</i> is a collection of non-secret key-value pairs that represents additional authenticated data. When you use an encryption context to encrypt data, you must specify the same (an exact case-sensitive match) encryption context to decrypt the data. An encryption context is optional when encrypting with a symmetric CMK, but it is highly recommended.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context">Encryption Context</a> in the <i>AWS Key Management Service Developer Guide</i>.</p> #[serde(rename = "EncryptionContext")] #[serde(skip_serializing_if = "Option::is_none")] pub encryption_context: Option<::std::collections::HashMap<String, String>>, /// <p>A list of grant tokens.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#grant_token">Grant Tokens</a> in the <i>AWS Key Management Service Developer Guide</i>.</p> #[serde(rename = "GrantTokens")] #[serde(skip_serializing_if = "Option::is_none")] pub grant_tokens: Option<Vec<String>>, /// <p>Specifies the customer master key (CMK) that AWS KMS will use to decrypt the ciphertext. Enter a key ID of the CMK that was used to encrypt the ciphertext.</p> <p>If you specify a <code>KeyId</code> value, the <code>Decrypt</code> operation succeeds only if the specified CMK was used to encrypt the ciphertext.</p> <p>This parameter is required only when the ciphertext was encrypted under an asymmetric CMK. Otherwise, AWS KMS uses the metadata that it adds to the ciphertext blob to determine which CMK was used to encrypt the ciphertext. However, you can use this parameter to ensure that a particular CMK (of any kind) is used to decrypt the ciphertext.</p> <p>To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name, prefix it with <code>"alias/"</code>.</p> <p>For example:</p> <ul> <li> <p>Key ID: <code>1234abcd-12ab-34cd-56ef-1234567890ab</code> </p> </li> <li> <p>Key ARN: <code>arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab</code> </p> </li> <li> <p>Alias name: <code>alias/ExampleAlias</code> </p> </li> <li> <p>Alias ARN: <code>arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias</code> </p> </li> </ul> <p>To get the key ID and key ARN for a CMK, use <a>ListKeys</a> or <a>DescribeKey</a>. To get the alias name and alias ARN, use <a>ListAliases</a>.</p> #[serde(rename = "KeyId")] #[serde(skip_serializing_if = "Option::is_none")] pub key_id: Option<String>, } #[derive(Clone, Debug, Default, Deserialize, PartialEq)] #[cfg_attr(any(test, feature = "serialize_structs"), derive(Serialize))] pub struct DecryptResponse { /// <p>The encryption algorithm that was used to decrypt the ciphertext.</p> #[serde(rename = "EncryptionAlgorithm")] #[serde(skip_serializing_if = "Option::is_none")] pub encryption_algorithm: Option<String>, /// <p>The Amazon Resource Name (<a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id-key-ARN">key ARN</a>) of the CMK that was used to decrypt the ciphertext.</p> #[serde(rename = "KeyId")] #[serde(skip_serializing_if = "Option::is_none")] pub key_id: Option<String>, /// <p>Decrypted plaintext data. When you use the HTTP API or the AWS CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.</p> #[serde(rename = "Plaintext")] #[serde( deserialize_with = "::rusoto_core::serialization::SerdeBlob::deserialize_blob", serialize_with = "::rusoto_core::serialization::SerdeBlob::serialize_blob", default )] #[serde(skip_serializing_if = "Option::is_none")] pub plaintext: Option<bytes::Bytes>, } #[derive(Clone, Debug, Default, PartialEq, Serialize)] #[cfg_attr(feature = "deserialize_structs", derive(Deserialize))] pub struct DeleteAliasRequest { /// <p>The alias to be deleted. The alias name must begin with <code>alias/</code> followed by the alias name, such as <code>alias/ExampleAlias</code>.</p> #[serde(rename = "AliasName")] pub alias_name: String, } #[derive(Clone, Debug, Default, PartialEq, Serialize)] #[cfg_attr(feature = "deserialize_structs", derive(Deserialize))] pub struct DeleteCustomKeyStoreRequest { /// <p>Enter the ID of the custom key store you want to delete. To find the ID of a custom key store, use the <a>DescribeCustomKeyStores</a> operation.</p> #[serde(rename = "CustomKeyStoreId")] pub custom_key_store_id: String, } #[derive(Clone, Debug, Default, Deserialize, PartialEq)] #[cfg_attr(any(test, feature = "serialize_structs"), derive(Serialize))] pub struct DeleteCustomKeyStoreResponse {} #[derive(Clone, Debug, Default, PartialEq, Serialize)] #[cfg_attr(feature = "deserialize_structs", derive(Deserialize))] pub struct DeleteImportedKeyMaterialRequest { /// <p>Identifies the CMK from which you are deleting imported key material. The <code>Origin</code> of the CMK must be <code>EXTERNAL</code>.</p> <p>Specify the key ID or the Amazon Resource Name (ARN) of the CMK.</p> <p>For example:</p> <ul> <li> <p>Key ID: <code>1234abcd-12ab-34cd-56ef-1234567890ab</code> </p> </li> <li> <p>Key ARN: <code>arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab</code> </p> </li> </ul> <p>To get the key ID and key ARN for a CMK, use <a>ListKeys</a> or <a>DescribeKey</a>.</p> #[serde(rename = "KeyId")] pub key_id: String, } #[derive(Clone, Debug, Default, PartialEq, Serialize)] #[cfg_attr(feature = "deserialize_structs", derive(Deserialize))] pub struct DescribeCustomKeyStoresRequest { /// <p>Gets only information about the specified custom key store. Enter the key store ID.</p> <p>By default, this operation gets information about all custom key stores in the account and region. To limit the output to a particular custom key store, you can use either the <code>CustomKeyStoreId</code> or <code>CustomKeyStoreName</code> parameter, but not both.</p> #[serde(rename = "CustomKeyStoreId")] #[serde(skip_serializing_if = "Option::is_none")] pub custom_key_store_id: Option<String>, /// <p>Gets only information about the specified custom key store. Enter the friendly name of the custom key store.</p> <p>By default, this operation gets information about all custom key stores in the account and region. To limit the output to a particular custom key store, you can use either the <code>CustomKeyStoreId</code> or <code>CustomKeyStoreName</code> parameter, but not both.</p> #[serde(rename = "CustomKeyStoreName")] #[serde(skip_serializing_if = "Option::is_none")] pub custom_key_store_name: Option<String>, /// <p>Use this parameter to specify the maximum number of items to return. When this value is present, AWS KMS does not return more than the specified number of items, but it might return fewer.</p> #[serde(rename = "Limit")] #[serde(skip_serializing_if = "Option::is_none")] pub limit: Option<i64>, /// <p>Use this parameter in a subsequent request after you receive a response with truncated results. Set it to the value of <code>NextMarker</code> from the truncated response you just received.</p> #[serde(rename = "Marker")] #[serde(skip_serializing_if = "Option::is_none")] pub marker: Option<String>, } #[derive(Clone, Debug, Default, Deserialize, PartialEq)] #[cfg_attr(any(test, feature = "serialize_structs"), derive(Serialize))] pub struct DescribeCustomKeyStoresResponse { /// <p>Contains metadata about each custom key store.</p> #[serde(rename = "CustomKeyStores")] #[serde(skip_serializing_if = "Option::is_none")] pub custom_key_stores: Option<Vec<CustomKeyStoresListEntry>>, /// <p>When <code>Truncated</code> is true, this element is present and contains the value to use for the <code>Marker</code> parameter in a subsequent request.</p> #[serde(rename = "NextMarker")] #[serde(skip_serializing_if = "Option::is_none")] pub next_marker: Option<String>, /// <p>A flag that indicates whether there are more items in the list. When this value is true, the list in this response is truncated. To get more items, pass the value of the <code>NextMarker</code> element in thisresponse to the <code>Marker</code> parameter in a subsequent request.</p> #[serde(rename = "Truncated")] #[serde(skip_serializing_if = "Option::is_none")] pub truncated: Option<bool>, } #[derive(Clone, Debug, Default, PartialEq, Serialize)] #[cfg_attr(feature = "deserialize_structs", derive(Deserialize))] pub struct DescribeKeyRequest { /// <p>A list of grant tokens.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#grant_token">Grant Tokens</a> in the <i>AWS Key Management Service Developer Guide</i>.</p> #[serde(rename = "GrantTokens")] #[serde(skip_serializing_if = "Option::is_none")] pub grant_tokens: Option<Vec<String>>, /// <p>Describes the specified customer master key (CMK). </p> <p>If you specify a predefined AWS alias (an AWS alias with no key ID), KMS associates the alias with an <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#master_keys">AWS managed CMK</a> and returns its <code>KeyId</code> and <code>Arn</code> in the response.</p> <p>To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name, prefix it with <code>"alias/"</code>. To specify a CMK in a different AWS account, you must use the key ARN or alias ARN.</p> <p>For example:</p> <ul> <li> <p>Key ID: <code>1234abcd-12ab-34cd-56ef-1234567890ab</code> </p> </li> <li> <p>Key ARN: <code>arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab</code> </p> </li> <li> <p>Alias name: <code>alias/ExampleAlias</code> </p> </li> <li> <p>Alias ARN: <code>arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias</code> </p> </li> </ul> <p>To get the key ID and key ARN for a CMK, use <a>ListKeys</a> or <a>DescribeKey</a>. To get the alias name and alias ARN, use <a>ListAliases</a>.</p> #[serde(rename = "KeyId")] pub key_id: String, } #[derive(Clone, Debug, Default, Deserialize, PartialEq)] #[cfg_attr(any(test, feature = "serialize_structs"), derive(Serialize))] pub struct DescribeKeyResponse { /// <p>Metadata associated with the key.</p> #[serde(rename = "KeyMetadata")] #[serde(skip_serializing_if = "Option::is_none")] pub key_metadata: Option<KeyMetadata>, } #[derive(Clone, Debug, Default, PartialEq, Serialize)] #[cfg_attr(feature = "deserialize_structs", derive(Deserialize))] pub struct DisableKeyRequest { /// <p>A unique identifier for the customer master key (CMK).</p> <p>Specify the key ID or the Amazon Resource Name (ARN) of the CMK.</p> <p>For example:</p> <ul> <li> <p>Key ID: <code>1234abcd-12ab-34cd-56ef-1234567890ab</code> </p> </li> <li> <p>Key ARN: <code>arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab</code> </p> </li> </ul> <p>To get the key ID and key ARN for a CMK, use <a>ListKeys</a> or <a>DescribeKey</a>.</p> #[serde(rename = "KeyId")] pub key_id: String, } #[derive(Clone, Debug, Default, PartialEq, Serialize)] #[cfg_attr(feature = "deserialize_structs", derive(Deserialize))] pub struct DisableKeyRotationRequest { /// <p>Identifies a symmetric customer master key (CMK). You cannot enable automatic rotation of <a href="https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html#asymmetric-cmks">asymmetric CMKs</a>, CMKs with <a href="https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys.html">imported key material</a>, or CMKs in a <a href="https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html">custom key store</a>.</p> <p>Specify the key ID or the Amazon Resource Name (ARN) of the CMK.</p> <p>For example:</p> <ul> <li> <p>Key ID: <code>1234abcd-12ab-34cd-56ef-1234567890ab</code> </p> </li> <li> <p>Key ARN: <code>arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab</code> </p> </li> </ul> <p>To get the key ID and key ARN for a CMK, use <a>ListKeys</a> or <a>DescribeKey</a>.</p> #[serde(rename = "KeyId")] pub key_id: String, } #[derive(Clone, Debug, Default, PartialEq, Serialize)] #[cfg_attr(feature = "deserialize_structs", derive(Deserialize))] pub struct DisconnectCustomKeyStoreRequest { /// <p>Enter the ID of the custom key store you want to disconnect. To find the ID of a custom key store, use the <a>DescribeCustomKeyStores</a> operation.</p> #[serde(rename = "CustomKeyStoreId")] pub custom_key_store_id: String, } #[derive(Clone, Debug, Default, Deserialize, PartialEq)] #[cfg_attr(any(test, feature = "serialize_structs"), derive(Serialize))] pub struct DisconnectCustomKeyStoreResponse {} #[derive(Clone, Debug, Default, PartialEq, Serialize)] #[cfg_attr(feature = "deserialize_structs", derive(Deserialize))] pub struct EnableKeyRequest { /// <p>A unique identifier for the customer master key (CMK).</p> <p>Specify the key ID or the Amazon Resource Name (ARN) of the CMK.</p> <p>For example:</p> <ul> <li> <p>Key ID: <code>1234abcd-12ab-34cd-56ef-1234567890ab</code> </p> </li> <li> <p>Key ARN: <code>arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab</code> </p> </li> </ul> <p>To get the key ID and key ARN for a CMK, use <a>ListKeys</a> or <a>DescribeKey</a>.</p> #[serde(rename = "KeyId")] pub key_id: String, } #[derive(Clone, Debug, Default, PartialEq, Serialize)] #[cfg_attr(feature = "deserialize_structs", derive(Deserialize))] pub struct EnableKeyRotationRequest { /// <p>Identifies a symmetric customer master key (CMK). You cannot enable automatic rotation of asymmetric CMKs, CMKs with imported key material, or CMKs in a <a href="https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html">custom key store</a>.</p> <p>Specify the key ID or the Amazon Resource Name (ARN) of the CMK.</p> <p>For example:</p> <ul> <li> <p>Key ID: <code>1234abcd-12ab-34cd-56ef-1234567890ab</code> </p> </li> <li> <p>Key ARN: <code>arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab</code> </p> </li> </ul> <p>To get the key ID and key ARN for a CMK, use <a>ListKeys</a> or <a>DescribeKey</a>.</p> #[serde(rename = "KeyId")] pub key_id: String, } #[derive(Clone, Debug, Default, PartialEq, Serialize)] #[cfg_attr(feature = "deserialize_structs", derive(Deserialize))] pub struct EncryptRequest { /// <p>Specifies the encryption algorithm that AWS KMS will use to encrypt the plaintext message. The algorithm must be compatible with the CMK that you specify.</p> <p>This parameter is required only for asymmetric CMKs. The default value, <code>SYMMETRIC_DEFAULT</code>, is the algorithm used for symmetric CMKs. If you are using an asymmetric CMK, we recommend RSAES_OAEP_SHA_256.</p> #[serde(rename = "EncryptionAlgorithm")] #[serde(skip_serializing_if = "Option::is_none")] pub encryption_algorithm: Option<String>, /// <p>Specifies the encryption context that will be used to encrypt the data. An encryption context is valid only for <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#cryptographic-operations">cryptographic operations</a> with a symmetric CMK. The standard asymmetric encryption algorithms that AWS KMS uses do not support an encryption context. </p> <p>An <i>encryption context</i> is a collection of non-secret key-value pairs that represents additional authenticated data. When you use an encryption context to encrypt data, you must specify the same (an exact case-sensitive match) encryption context to decrypt the data. An encryption context is optional when encrypting with a symmetric CMK, but it is highly recommended.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context">Encryption Context</a> in the <i>AWS Key Management Service Developer Guide</i>.</p> #[serde(rename = "EncryptionContext")] #[serde(skip_serializing_if = "Option::is_none")] pub encryption_context: Option<::std::collections::HashMap<String, String>>, /// <p>A list of grant tokens.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#grant_token">Grant Tokens</a> in the <i>AWS Key Management Service Developer Guide</i>.</p> #[serde(rename = "GrantTokens")] #[serde(skip_serializing_if = "Option::is_none")] pub grant_tokens: Option<Vec<String>>, /// <p>A unique identifier for the customer master key (CMK).</p> <p>To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name, prefix it with <code>"alias/"</code>. To specify a CMK in a different AWS account, you must use the key ARN or alias ARN.</p> <p>For example:</p> <ul> <li> <p>Key ID: <code>1234abcd-12ab-34cd-56ef-1234567890ab</code> </p> </li> <li> <p>Key ARN: <code>arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab</code> </p> </li> <li> <p>Alias name: <code>alias/ExampleAlias</code> </p> </li> <li> <p>Alias ARN: <code>arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias</code> </p> </li> </ul> <p>To get the key ID and key ARN for a CMK, use <a>ListKeys</a> or <a>DescribeKey</a>. To get the alias name and alias ARN, use <a>ListAliases</a>.</p> #[serde(rename = "KeyId")] pub key_id: String, /// <p>Data to be encrypted.</p> #[serde(rename = "Plaintext")] #[serde( deserialize_with = "::rusoto_core::serialization::SerdeBlob::deserialize_blob", serialize_with = "::rusoto_core::serialization::SerdeBlob::serialize_blob", default )] pub plaintext: bytes::Bytes, } #[derive(Clone, Debug, Default, Deserialize, PartialEq)] #[cfg_attr(any(test, feature = "serialize_structs"), derive(Serialize))] pub struct EncryptResponse { /// <p>The encrypted plaintext. When you use the HTTP API or the AWS CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.</p> #[serde(rename = "CiphertextBlob")] #[serde( deserialize_with = "::rusoto_core::serialization::SerdeBlob::deserialize_blob", serialize_with = "::rusoto_core::serialization::SerdeBlob::serialize_blob", default )] #[serde(skip_serializing_if = "Option::is_none")] pub ciphertext_blob: Option<bytes::Bytes>, /// <p>The encryption algorithm that was used to encrypt the plaintext.</p> #[serde(rename = "EncryptionAlgorithm")] #[serde(skip_serializing_if = "Option::is_none")] pub encryption_algorithm: Option<String>, /// <p>The Amazon Resource Name (<a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id-key-ARN">key ARN</a>) of the CMK that was used to encrypt the plaintext.</p> #[serde(rename = "KeyId")] #[serde(skip_serializing_if = "Option::is_none")] pub key_id: Option<String>, } #[derive(Clone, Debug, Default, PartialEq, Serialize)] #[cfg_attr(feature = "deserialize_structs", derive(Deserialize))] pub struct GenerateDataKeyPairRequest { /// <p>Specifies the encryption context that will be used when encrypting the private key in the data key pair.</p> <p>An <i>encryption context</i> is a collection of non-secret key-value pairs that represents additional authenticated data. When you use an encryption context to encrypt data, you must specify the same (an exact case-sensitive match) encryption context to decrypt the data. An encryption context is optional when encrypting with a symmetric CMK, but it is highly recommended.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context">Encryption Context</a> in the <i>AWS Key Management Service Developer Guide</i>.</p> #[serde(rename = "EncryptionContext")] #[serde(skip_serializing_if = "Option::is_none")] pub encryption_context: Option<::std::collections::HashMap<String, String>>, /// <p>A list of grant tokens.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#grant_token">Grant Tokens</a> in the <i>AWS Key Management Service Developer Guide</i>.</p> #[serde(rename = "GrantTokens")] #[serde(skip_serializing_if = "Option::is_none")] pub grant_tokens: Option<Vec<String>>, /// <p>Specifies the symmetric CMK that encrypts the private key in the data key pair. You cannot specify an asymmetric CMK or a CMK in a custom key store. To get the type and origin of your CMK, use the <a>DescribeKey</a> operation.</p> <p>To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name, prefix it with <code>"alias/"</code>. To specify a CMK in a different AWS account, you must use the key ARN or alias ARN.</p> <p>For example:</p> <ul> <li> <p>Key ID: <code>1234abcd-12ab-34cd-56ef-1234567890ab</code> </p> </li> <li> <p>Key ARN: <code>arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab</code> </p> </li> <li> <p>Alias name: <code>alias/ExampleAlias</code> </p> </li> <li> <p>Alias ARN: <code>arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias</code> </p> </li> </ul> <p>To get the key ID and key ARN for a CMK, use <a>ListKeys</a> or <a>DescribeKey</a>. To get the alias name and alias ARN, use <a>ListAliases</a>.</p> #[serde(rename = "KeyId")] pub key_id: String, /// <p>Determines the type of data key pair that is generated. </p> <p>The AWS KMS rule that restricts the use of asymmetric RSA CMKs to encrypt and decrypt or to sign and verify (but not both), and the rule that permits you to use ECC CMKs only to sign and verify, are not effective outside of AWS KMS.</p> #[serde(rename = "KeyPairSpec")] pub key_pair_spec: String, } #[derive(Clone, Debug, Default, Deserialize, PartialEq)] #[cfg_attr(any(test, feature = "serialize_structs"), derive(Serialize))] pub struct GenerateDataKeyPairResponse { /// <p>The Amazon Resource Name (<a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id-key-ARN">key ARN</a>) of the CMK that encrypted the private key.</p> #[serde(rename = "KeyId")] #[serde(skip_serializing_if = "Option::is_none")] pub key_id: Option<String>, /// <p>The type of data key pair that was generated.</p> #[serde(rename = "KeyPairSpec")] #[serde(skip_serializing_if = "Option::is_none")] pub key_pair_spec: Option<String>, /// <p>The encrypted copy of the private key. When you use the HTTP API or the AWS CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.</p> #[serde(rename = "PrivateKeyCiphertextBlob")] #[serde( deserialize_with = "::rusoto_core::serialization::SerdeBlob::deserialize_blob", serialize_with = "::rusoto_core::serialization::SerdeBlob::serialize_blob", default )] #[serde(skip_serializing_if = "Option::is_none")] pub private_key_ciphertext_blob: Option<bytes::Bytes>, /// <p>The plaintext copy of the private key. When you use the HTTP API or the AWS CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.</p> #[serde(rename = "PrivateKeyPlaintext")] #[serde( deserialize_with = "::rusoto_core::serialization::SerdeBlob::deserialize_blob", serialize_with = "::rusoto_core::serialization::SerdeBlob::serialize_blob", default )] #[serde(skip_serializing_if = "Option::is_none")] pub private_key_plaintext: Option<bytes::Bytes>, /// <p>The public key (in plaintext).</p> #[serde(rename = "PublicKey")] #[serde( deserialize_with = "::rusoto_core::serialization::SerdeBlob::deserialize_blob", serialize_with = "::rusoto_core::serialization::SerdeBlob::serialize_blob", default )] #[serde(skip_serializing_if = "Option::is_none")] pub public_key: Option<bytes::Bytes>, } #[derive(Clone, Debug, Default, PartialEq, Serialize)] #[cfg_attr(feature = "deserialize_structs", derive(Deserialize))] pub struct GenerateDataKeyPairWithoutPlaintextRequest { /// <p>Specifies the encryption context that will be used when encrypting the private key in the data key pair.</p> <p>An <i>encryption context</i> is a collection of non-secret key-value pairs that represents additional authenticated data. When you use an encryption context to encrypt data, you must specify the same (an exact case-sensitive match) encryption context to decrypt the data. An encryption context is optional when encrypting with a symmetric CMK, but it is highly recommended.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context">Encryption Context</a> in the <i>AWS Key Management Service Developer Guide</i>.</p> #[serde(rename = "EncryptionContext")] #[serde(skip_serializing_if = "Option::is_none")] pub encryption_context: Option<::std::collections::HashMap<String, String>>, /// <p>A list of grant tokens.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#grant_token">Grant Tokens</a> in the <i>AWS Key Management Service Developer Guide</i>.</p> #[serde(rename = "GrantTokens")] #[serde(skip_serializing_if = "Option::is_none")] pub grant_tokens: Option<Vec<String>>, /// <p>Specifies the CMK that encrypts the private key in the data key pair. You must specify a symmetric CMK. You cannot use an asymmetric CMK or a CMK in a custom key store. To get the type and origin of your CMK, use the <a>DescribeKey</a> operation. </p> <p>To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name, prefix it with <code>"alias/"</code>.</p> <p>For example:</p> <ul> <li> <p>Key ID: <code>1234abcd-12ab-34cd-56ef-1234567890ab</code> </p> </li> <li> <p>Key ARN: <code>arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab</code> </p> </li> <li> <p>Alias name: <code>alias/ExampleAlias</code> </p> </li> <li> <p>Alias ARN: <code>arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias</code> </p> </li> </ul> <p>To get the key ID and key ARN for a CMK, use <a>ListKeys</a> or <a>DescribeKey</a>. To get the alias name and alias ARN, use <a>ListAliases</a>.</p> #[serde(rename = "KeyId")] pub key_id: String, /// <p>Determines the type of data key pair that is generated.</p> <p>The AWS KMS rule that restricts the use of asymmetric RSA CMKs to encrypt and decrypt or to sign and verify (but not both), and the rule that permits you to use ECC CMKs only to sign and verify, are not effective outside of AWS KMS.</p> #[serde(rename = "KeyPairSpec")] pub key_pair_spec: String, } #[derive(Clone, Debug, Default, Deserialize, PartialEq)] #[cfg_attr(any(test, feature = "serialize_structs"), derive(Serialize))] pub struct GenerateDataKeyPairWithoutPlaintextResponse { /// <p>The Amazon Resource Name (<a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id-key-ARN">key ARN</a>) of the CMK that encrypted the private key.</p> #[serde(rename = "KeyId")] #[serde(skip_serializing_if = "Option::is_none")] pub key_id: Option<String>, /// <p>The type of data key pair that was generated.</p> #[serde(rename = "KeyPairSpec")] #[serde(skip_serializing_if = "Option::is_none")] pub key_pair_spec: Option<String>, /// <p>The encrypted copy of the private key. When you use the HTTP API or the AWS CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.</p> #[serde(rename = "PrivateKeyCiphertextBlob")] #[serde( deserialize_with = "::rusoto_core::serialization::SerdeBlob::deserialize_blob", serialize_with = "::rusoto_core::serialization::SerdeBlob::serialize_blob", default )] #[serde(skip_serializing_if = "Option::is_none")] pub private_key_ciphertext_blob: Option<bytes::Bytes>, /// <p>The public key (in plaintext).</p> #[serde(rename = "PublicKey")] #[serde( deserialize_with = "::rusoto_core::serialization::SerdeBlob::deserialize_blob", serialize_with = "::rusoto_core::serialization::SerdeBlob::serialize_blob", default )] #[serde(skip_serializing_if = "Option::is_none")] pub public_key: Option<bytes::Bytes>, } #[derive(Clone, Debug, Default, PartialEq, Serialize)] #[cfg_attr(feature = "deserialize_structs", derive(Deserialize))] pub struct GenerateDataKeyRequest { /// <p>Specifies the encryption context that will be used when encrypting the data key.</p> <p>An <i>encryption context</i> is a collection of non-secret key-value pairs that represents additional authenticated data. When you use an encryption context to encrypt data, you must specify the same (an exact case-sensitive match) encryption context to decrypt the data. An encryption context is optional when encrypting with a symmetric CMK, but it is highly recommended.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context">Encryption Context</a> in the <i>AWS Key Management Service Developer Guide</i>.</p> #[serde(rename = "EncryptionContext")] #[serde(skip_serializing_if = "Option::is_none")] pub encryption_context: Option<::std::collections::HashMap<String, String>>, /// <p>A list of grant tokens.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#grant_token">Grant Tokens</a> in the <i>AWS Key Management Service Developer Guide</i>.</p> #[serde(rename = "GrantTokens")] #[serde(skip_serializing_if = "Option::is_none")] pub grant_tokens: Option<Vec<String>>, /// <p>Identifies the symmetric CMK that encrypts the data key.</p> <p>To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name, prefix it with <code>"alias/"</code>. To specify a CMK in a different AWS account, you must use the key ARN or alias ARN.</p> <p>For example:</p> <ul> <li> <p>Key ID: <code>1234abcd-12ab-34cd-56ef-1234567890ab</code> </p> </li> <li> <p>Key ARN: <code>arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab</code> </p> </li> <li> <p>Alias name: <code>alias/ExampleAlias</code> </p> </li> <li> <p>Alias ARN: <code>arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias</code> </p> </li> </ul> <p>To get the key ID and key ARN for a CMK, use <a>ListKeys</a> or <a>DescribeKey</a>. To get the alias name and alias ARN, use <a>ListAliases</a>.</p> #[serde(rename = "KeyId")] pub key_id: String, /// <p>Specifies the length of the data key. Use <code>AES_128</code> to generate a 128-bit symmetric key, or <code>AES_256</code> to generate a 256-bit symmetric key.</p> <p>You must specify either the <code>KeySpec</code> or the <code>NumberOfBytes</code> parameter (but not both) in every <code>GenerateDataKey</code> request.</p> #[serde(rename = "KeySpec")] #[serde(skip_serializing_if = "Option::is_none")] pub key_spec: Option<String>, /// <p>Specifies the length of the data key in bytes. For example, use the value 64 to generate a 512-bit data key (64 bytes is 512 bits). For 128-bit (16-byte) and 256-bit (32-byte) data keys, use the <code>KeySpec</code> parameter.</p> <p>You must specify either the <code>KeySpec</code> or the <code>NumberOfBytes</code> parameter (but not both) in every <code>GenerateDataKey</code> request.</p> #[serde(rename = "NumberOfBytes")] #[serde(skip_serializing_if = "Option::is_none")] pub number_of_bytes: Option<i64>, } #[derive(Clone, Debug, Default, Deserialize, PartialEq)] #[cfg_attr(any(test, feature = "serialize_structs"), derive(Serialize))] pub struct GenerateDataKeyResponse { /// <p>The encrypted copy of the data key. When you use the HTTP API or the AWS CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.</p> #[serde(rename = "CiphertextBlob")] #[serde( deserialize_with = "::rusoto_core::serialization::SerdeBlob::deserialize_blob", serialize_with = "::rusoto_core::serialization::SerdeBlob::serialize_blob", default )] #[serde(skip_serializing_if = "Option::is_none")] pub ciphertext_blob: Option<bytes::Bytes>, /// <p>The Amazon Resource Name (<a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id-key-ARN">key ARN</a>) of the CMK that encrypted the data key.</p> #[serde(rename = "KeyId")] #[serde(skip_serializing_if = "Option::is_none")] pub key_id: Option<String>, /// <p>The plaintext data key. When you use the HTTP API or the AWS CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded. Use this data key to encrypt your data outside of KMS. Then, remove it from memory as soon as possible.</p> #[serde(rename = "Plaintext")] #[serde( deserialize_with = "::rusoto_core::serialization::SerdeBlob::deserialize_blob", serialize_with = "::rusoto_core::serialization::SerdeBlob::serialize_blob", default )] #[serde(skip_serializing_if = "Option::is_none")] pub plaintext: Option<bytes::Bytes>, } #[derive(Clone, Debug, Default, PartialEq, Serialize)] #[cfg_attr(feature = "deserialize_structs", derive(Deserialize))] pub struct GenerateDataKeyWithoutPlaintextRequest { /// <p>Specifies the encryption context that will be used when encrypting the data key.</p> <p>An <i>encryption context</i> is a collection of non-secret key-value pairs that represents additional authenticated data. When you use an encryption context to encrypt data, you must specify the same (an exact case-sensitive match) encryption context to decrypt the data. An encryption context is optional when encrypting with a symmetric CMK, but it is highly recommended.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context">Encryption Context</a> in the <i>AWS Key Management Service Developer Guide</i>.</p> #[serde(rename = "EncryptionContext")] #[serde(skip_serializing_if = "Option::is_none")] pub encryption_context: Option<::std::collections::HashMap<String, String>>, /// <p>A list of grant tokens.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#grant_token">Grant Tokens</a> in the <i>AWS Key Management Service Developer Guide</i>.</p> #[serde(rename = "GrantTokens")] #[serde(skip_serializing_if = "Option::is_none")] pub grant_tokens: Option<Vec<String>>, /// <p>The identifier of the symmetric customer master key (CMK) that encrypts the data key.</p> <p>To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name, prefix it with <code>"alias/"</code>. To specify a CMK in a different AWS account, you must use the key ARN or alias ARN.</p> <p>For example:</p> <ul> <li> <p>Key ID: <code>1234abcd-12ab-34cd-56ef-1234567890ab</code> </p> </li> <li> <p>Key ARN: <code>arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab</code> </p> </li> <li> <p>Alias name: <code>alias/ExampleAlias</code> </p> </li> <li> <p>Alias ARN: <code>arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias</code> </p> </li> </ul> <p>To get the key ID and key ARN for a CMK, use <a>ListKeys</a> or <a>DescribeKey</a>. To get the alias name and alias ARN, use <a>ListAliases</a>.</p> #[serde(rename = "KeyId")] pub key_id: String, /// <p>The length of the data key. Use <code>AES_128</code> to generate a 128-bit symmetric key, or <code>AES_256</code> to generate a 256-bit symmetric key.</p> #[serde(rename = "KeySpec")] #[serde(skip_serializing_if = "Option::is_none")] pub key_spec: Option<String>, /// <p>The length of the data key in bytes. For example, use the value 64 to generate a 512-bit data key (64 bytes is 512 bits). For common key lengths (128-bit and 256-bit symmetric keys), we recommend that you use the <code>KeySpec</code> field instead of this one.</p> #[serde(rename = "NumberOfBytes")] #[serde(skip_serializing_if = "Option::is_none")] pub number_of_bytes: Option<i64>, } #[derive(Clone, Debug, Default, Deserialize, PartialEq)] #[cfg_attr(any(test, feature = "serialize_structs"), derive(Serialize))] pub struct GenerateDataKeyWithoutPlaintextResponse { /// <p>The encrypted data key. When you use the HTTP API or the AWS CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.</p> #[serde(rename = "CiphertextBlob")] #[serde( deserialize_with = "::rusoto_core::serialization::SerdeBlob::deserialize_blob", serialize_with = "::rusoto_core::serialization::SerdeBlob::serialize_blob", default )] #[serde(skip_serializing_if = "Option::is_none")] pub ciphertext_blob: Option<bytes::Bytes>, /// <p>The Amazon Resource Name (<a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id-key-ARN">key ARN</a>) of the CMK that encrypted the data key.</p> #[serde(rename = "KeyId")] #[serde(skip_serializing_if = "Option::is_none")] pub key_id: Option<String>, } #[derive(Clone, Debug, Default, PartialEq, Serialize)] #[cfg_attr(feature = "deserialize_structs", derive(Deserialize))] pub struct GenerateRandomRequest { /// <p>Generates the random byte string in the AWS CloudHSM cluster that is associated with the specified <a href="https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html">custom key store</a>. To find the ID of a custom key store, use the <a>DescribeCustomKeyStores</a> operation.</p> #[serde(rename = "CustomKeyStoreId")] #[serde(skip_serializing_if = "Option::is_none")] pub custom_key_store_id: Option<String>, /// <p>The length of the byte string.</p> #[serde(rename = "NumberOfBytes")] #[serde(skip_serializing_if = "Option::is_none")] pub number_of_bytes: Option<i64>, } #[derive(Clone, Debug, Default, Deserialize, PartialEq)] #[cfg_attr(any(test, feature = "serialize_structs"), derive(Serialize))] pub struct GenerateRandomResponse { /// <p>The random byte string. When you use the HTTP API or the AWS CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.</p> #[serde(rename = "Plaintext")] #[serde( deserialize_with = "::rusoto_core::serialization::SerdeBlob::deserialize_blob", serialize_with = "::rusoto_core::serialization::SerdeBlob::serialize_blob", default )] #[serde(skip_serializing_if = "Option::is_none")] pub plaintext: Option<bytes::Bytes>, } #[derive(Clone, Debug, Default, PartialEq, Serialize)] #[cfg_attr(feature = "deserialize_structs", derive(Deserialize))] pub struct GetKeyPolicyRequest { /// <p>A unique identifier for the customer master key (CMK).</p> <p>Specify the key ID or the Amazon Resource Name (ARN) of the CMK.</p> <p>For example:</p> <ul> <li> <p>Key ID: <code>1234abcd-12ab-34cd-56ef-1234567890ab</code> </p> </li> <li> <p>Key ARN: <code>arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab</code> </p> </li> </ul> <p>To get the key ID and key ARN for a CMK, use <a>ListKeys</a> or <a>DescribeKey</a>.</p> #[serde(rename = "KeyId")] pub key_id: String, /// <p>Specifies the name of the key policy. The only valid name is <code>default</code>. To get the names of key policies, use <a>ListKeyPolicies</a>.</p> #[serde(rename = "PolicyName")] pub policy_name: String, } #[derive(Clone, Debug, Default, Deserialize, PartialEq)] #[cfg_attr(any(test, feature = "serialize_structs"), derive(Serialize))] pub struct GetKeyPolicyResponse { /// <p>A key policy document in JSON format.</p> #[serde(rename = "Policy")] #[serde(skip_serializing_if = "Option::is_none")] pub policy: Option<String>, } #[derive(Clone, Debug, Default, PartialEq, Serialize)] #[cfg_attr(feature = "deserialize_structs", derive(Deserialize))] pub struct GetKeyRotationStatusRequest { /// <p>A unique identifier for the customer master key (CMK).</p> <p>Specify the key ID or the Amazon Resource Name (ARN) of the CMK. To specify a CMK in a different AWS account, you must use the key ARN.</p> <p>For example:</p> <ul> <li> <p>Key ID: <code>1234abcd-12ab-34cd-56ef-1234567890ab</code> </p> </li> <li> <p>Key ARN: <code>arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab</code> </p> </li> </ul> <p>To get the key ID and key ARN for a CMK, use <a>ListKeys</a> or <a>DescribeKey</a>.</p> #[serde(rename = "KeyId")] pub key_id: String, } #[derive(Clone, Debug, Default, Deserialize, PartialEq)] #[cfg_attr(any(test, feature = "serialize_structs"), derive(Serialize))] pub struct GetKeyRotationStatusResponse { /// <p>A Boolean value that specifies whether key rotation is enabled.</p> #[serde(rename = "KeyRotationEnabled")] #[serde(skip_serializing_if = "Option::is_none")] pub key_rotation_enabled: Option<bool>, } #[derive(Clone, Debug, Default, PartialEq, Serialize)] #[cfg_attr(feature = "deserialize_structs", derive(Deserialize))] pub struct GetParametersForImportRequest { /// <p>The identifier of the symmetric CMK into which you will import key material. The <code>Origin</code> of the CMK must be <code>EXTERNAL</code>.</p> <p>Specify the key ID or the Amazon Resource Name (ARN) of the CMK.</p> <p>For example:</p> <ul> <li> <p>Key ID: <code>1234abcd-12ab-34cd-56ef-1234567890ab</code> </p> </li> <li> <p>Key ARN: <code>arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab</code> </p> </li> </ul> <p>To get the key ID and key ARN for a CMK, use <a>ListKeys</a> or <a>DescribeKey</a>.</p> #[serde(rename = "KeyId")] pub key_id: String, /// <p>The algorithm you will use to encrypt the key material before importing it with <a>ImportKeyMaterial</a>. For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys-encrypt-key-material.html">Encrypt the Key Material</a> in the <i>AWS Key Management Service Developer Guide</i>.</p> #[serde(rename = "WrappingAlgorithm")] pub wrapping_algorithm: String, /// <p>The type of wrapping key (public key) to return in the response. Only 2048-bit RSA public keys are supported.</p> #[serde(rename = "WrappingKeySpec")] pub wrapping_key_spec: String, } #[derive(Clone, Debug, Default, Deserialize, PartialEq)] #[cfg_attr(any(test, feature = "serialize_structs"), derive(Serialize))] pub struct GetParametersForImportResponse { /// <p>The import token to send in a subsequent <a>ImportKeyMaterial</a> request.</p> #[serde(rename = "ImportToken")] #[serde( deserialize_with = "::rusoto_core::serialization::SerdeBlob::deserialize_blob", serialize_with = "::rusoto_core::serialization::SerdeBlob::serialize_blob", default )] #[serde(skip_serializing_if = "Option::is_none")] pub import_token: Option<bytes::Bytes>, /// <p>The Amazon Resource Name (<a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id-key-ARN">key ARN</a>) of the CMK to use in a subsequent <a>ImportKeyMaterial</a> request. This is the same CMK specified in the <code>GetParametersForImport</code> request.</p> #[serde(rename = "KeyId")] #[serde(skip_serializing_if = "Option::is_none")] pub key_id: Option<String>, /// <p>The time at which the import token and public key are no longer valid. After this time, you cannot use them to make an <a>ImportKeyMaterial</a> request and you must send another <code>GetParametersForImport</code> request to get new ones.</p> #[serde(rename = "ParametersValidTo")] #[serde(skip_serializing_if = "Option::is_none")] pub parameters_valid_to: Option<f64>, /// <p>The public key to use to encrypt the key material before importing it with <a>ImportKeyMaterial</a>.</p> #[serde(rename = "PublicKey")] #[serde( deserialize_with = "::rusoto_core::serialization::SerdeBlob::deserialize_blob", serialize_with = "::rusoto_core::serialization::SerdeBlob::serialize_blob", default )] #[serde(skip_serializing_if = "Option::is_none")] pub public_key: Option<bytes::Bytes>, } #[derive(Clone, Debug, Default, PartialEq, Serialize)] #[cfg_attr(feature = "deserialize_structs", derive(Deserialize))] pub struct GetPublicKeyRequest { /// <p>A list of grant tokens.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#grant_token">Grant Tokens</a> in the <i>AWS Key Management Service Developer Guide</i>.</p> #[serde(rename = "GrantTokens")] #[serde(skip_serializing_if = "Option::is_none")] pub grant_tokens: Option<Vec<String>>, /// <p>Identifies the asymmetric CMK that includes the public key.</p> <p>To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name, prefix it with <code>"alias/"</code>. To specify a CMK in a different AWS account, you must use the key ARN or alias ARN.</p> <p>For example:</p> <ul> <li> <p>Key ID: <code>1234abcd-12ab-34cd-56ef-1234567890ab</code> </p> </li> <li> <p>Key ARN: <code>arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab</code> </p> </li> <li> <p>Alias name: <code>alias/ExampleAlias</code> </p> </li> <li> <p>Alias ARN: <code>arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias</code> </p> </li> </ul> <p>To get the key ID and key ARN for a CMK, use <a>ListKeys</a> or <a>DescribeKey</a>. To get the alias name and alias ARN, use <a>ListAliases</a>.</p> #[serde(rename = "KeyId")] pub key_id: String, } #[derive(Clone, Debug, Default, Deserialize, PartialEq)] #[cfg_attr(any(test, feature = "serialize_structs"), derive(Serialize))] pub struct GetPublicKeyResponse { /// <p>The type of the of the public key that was downloaded.</p> #[serde(rename = "CustomerMasterKeySpec")] #[serde(skip_serializing_if = "Option::is_none")] pub customer_master_key_spec: Option<String>, /// <p>The encryption algorithms that AWS KMS supports for this key. </p> <p>This information is critical. If a public key encrypts data outside of AWS KMS by using an unsupported encryption algorithm, the ciphertext cannot be decrypted. </p> <p>This field appears in the response only when the <code>KeyUsage</code> of the public key is <code>ENCRYPT_DECRYPT</code>.</p> #[serde(rename = "EncryptionAlgorithms")] #[serde(skip_serializing_if = "Option::is_none")] pub encryption_algorithms: Option<Vec<String>>, /// <p>The Amazon Resource Name (<a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id-key-ARN">key ARN</a>) of the asymmetric CMK from which the public key was downloaded.</p> #[serde(rename = "KeyId")] #[serde(skip_serializing_if = "Option::is_none")] pub key_id: Option<String>, /// <p>The permitted use of the public key. Valid values are <code>ENCRYPT_DECRYPT</code> or <code>SIGN_VERIFY</code>. </p> <p>This information is critical. If a public key with <code>SIGN_VERIFY</code> key usage encrypts data outside of AWS KMS, the ciphertext cannot be decrypted. </p> #[serde(rename = "KeyUsage")] #[serde(skip_serializing_if = "Option::is_none")] pub key_usage: Option<String>, /// <p><p>The exported public key. </p> <p>The value is a DER-encoded X.509 public key, also known as <code>SubjectPublicKeyInfo</code> (SPKI), as defined in <a href="https://tools.ietf.org/html/rfc5280">RFC 5280</a>. When you use the HTTP API or the AWS CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.</p> <p/></p> #[serde(rename = "PublicKey")] #[serde( deserialize_with = "::rusoto_core::serialization::SerdeBlob::deserialize_blob", serialize_with = "::rusoto_core::serialization::SerdeBlob::serialize_blob", default )] #[serde(skip_serializing_if = "Option::is_none")] pub public_key: Option<bytes::Bytes>, /// <p>The signing algorithms that AWS KMS supports for this key.</p> <p>This field appears in the response only when the <code>KeyUsage</code> of the public key is <code>SIGN_VERIFY</code>.</p> #[serde(rename = "SigningAlgorithms")] #[serde(skip_serializing_if = "Option::is_none")] pub signing_algorithms: Option<Vec<String>>, } /// <p><p>Use this structure to allow <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#cryptographic-operations">cryptographic operations</a> in the grant only when the operation request includes the specified <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context">encryption context</a>. </p> <p>AWS KMS applies the grant constraints only to cryptographic operations that support an encryption context, that is, all cryptographic operations with a <a href="https://docs.aws.amazon.com/kms/latest/developerguide/symm-asymm-concepts.html#symmetric-cmks">symmetric CMK</a>. Grant constraints are not applied to operations that do not support an encryption context, such as cryptographic operations with asymmetric CMKs and management operations, such as <a>DescribeKey</a> or <a>ScheduleKeyDeletion</a>.</p> <important> <p>In a cryptographic operation, the encryption context in the decryption operation must be an exact, case-sensitive match for the keys and values in the encryption context of the encryption operation. Only the order of the pairs can vary.</p> <p>However, in a grant constraint, the key in each key-value pair is not case sensitive, but the value is case sensitive.</p> <p>To avoid confusion, do not use multiple encryption context pairs that differ only by case. To require a fully case-sensitive encryption context, use the <code>kms:EncryptionContext:</code> and <code>kms:EncryptionContextKeys</code> conditions in an IAM or key policy. For details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/policy-conditions.html#conditions-kms-encryption-context">kms:EncryptionContext:</a> in the <i> <i>AWS Key Management Service Developer Guide</i> </i>.</p> </important></p> #[derive(Clone, Debug, Default, Deserialize, PartialEq, Serialize)] pub struct GrantConstraints { /// <p>A list of key-value pairs that must match the encryption context in the <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#cryptographic-operations">cryptographic operation</a> request. The grant allows the operation only when the encryption context in the request is the same as the encryption context specified in this constraint.</p> #[serde(rename = "EncryptionContextEquals")] #[serde(skip_serializing_if = "Option::is_none")] pub encryption_context_equals: Option<::std::collections::HashMap<String, String>>, /// <p>A list of key-value pairs that must be included in the encryption context of the <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#cryptographic-operations">cryptographic operation</a> request. The grant allows the cryptographic operation only when the encryption context in the request includes the key-value pairs specified in this constraint, although it can include additional key-value pairs.</p> #[serde(rename = "EncryptionContextSubset")] #[serde(skip_serializing_if = "Option::is_none")] pub encryption_context_subset: Option<::std::collections::HashMap<String, String>>, } /// <p>Contains information about a grant.</p> #[derive(Clone, Debug, Default, Deserialize, PartialEq)] #[cfg_attr(any(test, feature = "serialize_structs"), derive(Serialize))] pub struct GrantListEntry { /// <p>A list of key-value pairs that must be present in the encryption context of certain subsequent operations that the grant allows.</p> #[serde(rename = "Constraints")] #[serde(skip_serializing_if = "Option::is_none")] pub constraints: Option<GrantConstraints>, /// <p>The date and time when the grant was created.</p> #[serde(rename = "CreationDate")] #[serde(skip_serializing_if = "Option::is_none")] pub creation_date: Option<f64>, /// <p>The unique identifier for the grant.</p> #[serde(rename = "GrantId")] #[serde(skip_serializing_if = "Option::is_none")] pub grant_id: Option<String>, /// <p>The identity that gets the permissions in the grant.</p> <p>The <code>GranteePrincipal</code> field in the <code>ListGrants</code> response usually contains the user or role designated as the grantee principal in the grant. However, when the grantee principal in the grant is an AWS service, the <code>GranteePrincipal</code> field contains the <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements_principal.html#principal-services">service principal</a>, which might represent several different grantee principals.</p> #[serde(rename = "GranteePrincipal")] #[serde(skip_serializing_if = "Option::is_none")] pub grantee_principal: Option<String>, /// <p>The AWS account under which the grant was issued.</p> #[serde(rename = "IssuingAccount")] #[serde(skip_serializing_if = "Option::is_none")] pub issuing_account: Option<String>, /// <p>The unique identifier for the customer master key (CMK) to which the grant applies.</p> #[serde(rename = "KeyId")] #[serde(skip_serializing_if = "Option::is_none")] pub key_id: Option<String>, /// <p>The friendly name that identifies the grant. If a name was provided in the <a>CreateGrant</a> request, that name is returned. Otherwise this value is null.</p> #[serde(rename = "Name")] #[serde(skip_serializing_if = "Option::is_none")] pub name: Option<String>, /// <p>The list of operations permitted by the grant.</p> #[serde(rename = "Operations")] #[serde(skip_serializing_if = "Option::is_none")] pub operations: Option<Vec<String>>, /// <p>The principal that can retire the grant.</p> #[serde(rename = "RetiringPrincipal")] #[serde(skip_serializing_if = "Option::is_none")] pub retiring_principal: Option<String>, } #[derive(Clone, Debug, Default, PartialEq, Serialize)] #[cfg_attr(feature = "deserialize_structs", derive(Deserialize))] pub struct ImportKeyMaterialRequest { /// <p>The encrypted key material to import. The key material must be encrypted with the public wrapping key that <a>GetParametersForImport</a> returned, using the wrapping algorithm that you specified in the same <code>GetParametersForImport</code> request.</p> #[serde(rename = "EncryptedKeyMaterial")] #[serde( deserialize_with = "::rusoto_core::serialization::SerdeBlob::deserialize_blob", serialize_with = "::rusoto_core::serialization::SerdeBlob::serialize_blob", default )] pub encrypted_key_material: bytes::Bytes, /// <p>Specifies whether the key material expires. The default is <code>KEY_MATERIAL_EXPIRES</code>, in which case you must include the <code>ValidTo</code> parameter. When this parameter is set to <code>KEY_MATERIAL_DOES_NOT_EXPIRE</code>, you must omit the <code>ValidTo</code> parameter.</p> #[serde(rename = "ExpirationModel")] #[serde(skip_serializing_if = "Option::is_none")] pub expiration_model: Option<String>, /// <p>The import token that you received in the response to a previous <a>GetParametersForImport</a> request. It must be from the same response that contained the public key that you used to encrypt the key material.</p> #[serde(rename = "ImportToken")] #[serde( deserialize_with = "::rusoto_core::serialization::SerdeBlob::deserialize_blob", serialize_with = "::rusoto_core::serialization::SerdeBlob::serialize_blob", default )] pub import_token: bytes::Bytes, /// <p>The identifier of the symmetric CMK that receives the imported key material. The CMK's <code>Origin</code> must be <code>EXTERNAL</code>. This must be the same CMK specified in the <code>KeyID</code> parameter of the corresponding <a>GetParametersForImport</a> request.</p> <p>Specify the key ID or the Amazon Resource Name (ARN) of the CMK.</p> <p>For example:</p> <ul> <li> <p>Key ID: <code>1234abcd-12ab-34cd-56ef-1234567890ab</code> </p> </li> <li> <p>Key ARN: <code>arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab</code> </p> </li> </ul> <p>To get the key ID and key ARN for a CMK, use <a>ListKeys</a> or <a>DescribeKey</a>.</p> #[serde(rename = "KeyId")] pub key_id: String, /// <p>The time at which the imported key material expires. When the key material expires, AWS KMS deletes the key material and the CMK becomes unusable. You must omit this parameter when the <code>ExpirationModel</code> parameter is set to <code>KEY_MATERIAL_DOES_NOT_EXPIRE</code>. Otherwise it is required.</p> #[serde(rename = "ValidTo")] #[serde(skip_serializing_if = "Option::is_none")] pub valid_to: Option<f64>, } #[derive(Clone, Debug, Default, Deserialize, PartialEq)] #[cfg_attr(any(test, feature = "serialize_structs"), derive(Serialize))] pub struct ImportKeyMaterialResponse {} /// <p>Contains information about each entry in the key list.</p> #[derive(Clone, Debug, Default, Deserialize, PartialEq)] #[cfg_attr(any(test, feature = "serialize_structs"), derive(Serialize))] pub struct KeyListEntry { /// <p>ARN of the key.</p> #[serde(rename = "KeyArn")] #[serde(skip_serializing_if = "Option::is_none")] pub key_arn: Option<String>, /// <p>Unique identifier of the key.</p> #[serde(rename = "KeyId")] #[serde(skip_serializing_if = "Option::is_none")] pub key_id: Option<String>, } /// <p>Contains metadata about a customer master key (CMK).</p> <p>This data type is used as a response element for the <a>CreateKey</a> and <a>DescribeKey</a> operations.</p> #[derive(Clone, Debug, Default, Deserialize, PartialEq)] #[cfg_attr(any(test, feature = "serialize_structs"), derive(Serialize))] pub struct KeyMetadata { /// <p>The twelve-digit account ID of the AWS account that owns the CMK.</p> #[serde(rename = "AWSAccountId")] #[serde(skip_serializing_if = "Option::is_none")] pub aws_account_id: Option<String>, /// <p>The Amazon Resource Name (ARN) of the CMK. For examples, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#arn-syntax-kms">AWS Key Management Service (AWS KMS)</a> in the Example ARNs section of the <i>AWS General Reference</i>.</p> #[serde(rename = "Arn")] #[serde(skip_serializing_if = "Option::is_none")] pub arn: Option<String>, /// <p>The cluster ID of the AWS CloudHSM cluster that contains the key material for the CMK. When you create a CMK in a <a href="https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html">custom key store</a>, AWS KMS creates the key material for the CMK in the associated AWS CloudHSM cluster. This value is present only when the CMK is created in a custom key store.</p> #[serde(rename = "CloudHsmClusterId")] #[serde(skip_serializing_if = "Option::is_none")] pub cloud_hsm_cluster_id: Option<String>, /// <p>The date and time when the CMK was created.</p> #[serde(rename = "CreationDate")] #[serde(skip_serializing_if = "Option::is_none")] pub creation_date: Option<f64>, /// <p>A unique identifier for the <a href="https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html">custom key store</a> that contains the CMK. This value is present only when the CMK is created in a custom key store.</p> #[serde(rename = "CustomKeyStoreId")] #[serde(skip_serializing_if = "Option::is_none")] pub custom_key_store_id: Option<String>, /// <p>Describes the type of key material in the CMK.</p> #[serde(rename = "CustomerMasterKeySpec")] #[serde(skip_serializing_if = "Option::is_none")] pub customer_master_key_spec: Option<String>, /// <p>The date and time after which AWS KMS deletes the CMK. This value is present only when <code>KeyState</code> is <code>PendingDeletion</code>.</p> #[serde(rename = "DeletionDate")] #[serde(skip_serializing_if = "Option::is_none")] pub deletion_date: Option<f64>, /// <p>The description of the CMK.</p> #[serde(rename = "Description")] #[serde(skip_serializing_if = "Option::is_none")] pub description: Option<String>, /// <p>Specifies whether the CMK is enabled. When <code>KeyState</code> is <code>Enabled</code> this value is true, otherwise it is false.</p> #[serde(rename = "Enabled")] #[serde(skip_serializing_if = "Option::is_none")] pub enabled: Option<bool>, /// <p>The encryption algorithms that the CMK supports. You cannot use the CMK with other encryption algorithms within AWS KMS.</p> <p>This field appears only when the <code>KeyUsage</code> of the CMK is <code>ENCRYPT_DECRYPT</code>.</p> #[serde(rename = "EncryptionAlgorithms")] #[serde(skip_serializing_if = "Option::is_none")] pub encryption_algorithms: Option<Vec<String>>, /// <p>Specifies whether the CMK's key material expires. This value is present only when <code>Origin</code> is <code>EXTERNAL</code>, otherwise this value is omitted.</p> #[serde(rename = "ExpirationModel")] #[serde(skip_serializing_if = "Option::is_none")] pub expiration_model: Option<String>, /// <p>The globally unique identifier for the CMK.</p> #[serde(rename = "KeyId")] pub key_id: String, /// <p>The manager of the CMK. CMKs in your AWS account are either customer managed or AWS managed. For more information about the difference, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#master_keys">Customer Master Keys</a> in the <i>AWS Key Management Service Developer Guide</i>.</p> #[serde(rename = "KeyManager")] #[serde(skip_serializing_if = "Option::is_none")] pub key_manager: Option<String>, /// <p>The current status of the CMK.</p> <p>For more information about how key state affects the use of a CMK, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">Key state: Effect on your CMK</a> in the <i>AWS Key Management Service Developer Guide</i>.</p> #[serde(rename = "KeyState")] #[serde(skip_serializing_if = "Option::is_none")] pub key_state: Option<String>, /// <p>The <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#cryptographic-operations">cryptographic operations</a> for which you can use the CMK.</p> #[serde(rename = "KeyUsage")] #[serde(skip_serializing_if = "Option::is_none")] pub key_usage: Option<String>, /// <p>The source of the CMK's key material. When this value is <code>AWS_KMS</code>, AWS KMS created the key material. When this value is <code>EXTERNAL</code>, the key material was imported from your existing key management infrastructure or the CMK lacks key material. When this value is <code>AWS_CLOUDHSM</code>, the key material was created in the AWS CloudHSM cluster associated with a custom key store.</p> #[serde(rename = "Origin")] #[serde(skip_serializing_if = "Option::is_none")] pub origin: Option<String>, /// <p>The signing algorithms that the CMK supports. You cannot use the CMK with other signing algorithms within AWS KMS.</p> <p>This field appears only when the <code>KeyUsage</code> of the CMK is <code>SIGN_VERIFY</code>.</p> #[serde(rename = "SigningAlgorithms")] #[serde(skip_serializing_if = "Option::is_none")] pub signing_algorithms: Option<Vec<String>>, /// <p>The time at which the imported key material expires. When the key material expires, AWS KMS deletes the key material and the CMK becomes unusable. This value is present only for CMKs whose <code>Origin</code> is <code>EXTERNAL</code> and whose <code>ExpirationModel</code> is <code>KEY_MATERIAL_EXPIRES</code>, otherwise this value is omitted.</p> #[serde(rename = "ValidTo")] #[serde(skip_serializing_if = "Option::is_none")] pub valid_to: Option<f64>, } #[derive(Clone, Debug, Default, PartialEq, Serialize)] #[cfg_attr(feature = "deserialize_structs", derive(Deserialize))] pub struct ListAliasesRequest { /// <p>Lists only aliases that refer to the specified CMK. The value of this parameter can be the ID or Amazon Resource Name (ARN) of a CMK in the caller's account and region. You cannot use an alias name or alias ARN in this value.</p> <p>This parameter is optional. If you omit it, <code>ListAliases</code> returns all aliases in the account and region.</p> #[serde(rename = "KeyId")] #[serde(skip_serializing_if = "Option::is_none")] pub key_id: Option<String>, /// <p>Use this parameter to specify the maximum number of items to return. When this value is present, AWS KMS does not return more than the specified number of items, but it might return fewer.</p> <p>This value is optional. If you include a value, it must be between 1 and 100, inclusive. If you do not include a value, it defaults to 50.</p> #[serde(rename = "Limit")] #[serde(skip_serializing_if = "Option::is_none")] pub limit: Option<i64>, /// <p>Use this parameter in a subsequent request after you receive a response with truncated results. Set it to the value of <code>NextMarker</code> from the truncated response you just received.</p> #[serde(rename = "Marker")] #[serde(skip_serializing_if = "Option::is_none")] pub marker: Option<String>, } #[derive(Clone, Debug, Default, Deserialize, PartialEq)] #[cfg_attr(any(test, feature = "serialize_structs"), derive(Serialize))] pub struct ListAliasesResponse { /// <p>A list of aliases.</p> #[serde(rename = "Aliases")] #[serde(skip_serializing_if = "Option::is_none")] pub aliases: Option<Vec<AliasListEntry>>, /// <p>When <code>Truncated</code> is true, this element is present and contains the value to use for the <code>Marker</code> parameter in a subsequent request.</p> #[serde(rename = "NextMarker")] #[serde(skip_serializing_if = "Option::is_none")] pub next_marker: Option<String>, /// <p>A flag that indicates whether there are more items in the list. When this value is true, the list in this response is truncated. To get more items, pass the value of the <code>NextMarker</code> element in thisresponse to the <code>Marker</code> parameter in a subsequent request.</p> #[serde(rename = "Truncated")] #[serde(skip_serializing_if = "Option::is_none")] pub truncated: Option<bool>, } #[derive(Clone, Debug, Default, PartialEq, Serialize)] #[cfg_attr(feature = "deserialize_structs", derive(Deserialize))] pub struct ListGrantsRequest { /// <p>A unique identifier for the customer master key (CMK).</p> <p>Specify the key ID or the Amazon Resource Name (ARN) of the CMK. To specify a CMK in a different AWS account, you must use the key ARN.</p> <p>For example:</p> <ul> <li> <p>Key ID: <code>1234abcd-12ab-34cd-56ef-1234567890ab</code> </p> </li> <li> <p>Key ARN: <code>arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab</code> </p> </li> </ul> <p>To get the key ID and key ARN for a CMK, use <a>ListKeys</a> or <a>DescribeKey</a>.</p> #[serde(rename = "KeyId")] pub key_id: String, /// <p>Use this parameter to specify the maximum number of items to return. When this value is present, AWS KMS does not return more than the specified number of items, but it might return fewer.</p> <p>This value is optional. If you include a value, it must be between 1 and 100, inclusive. If you do not include a value, it defaults to 50.</p> #[serde(rename = "Limit")] #[serde(skip_serializing_if = "Option::is_none")] pub limit: Option<i64>, /// <p>Use this parameter in a subsequent request after you receive a response with truncated results. Set it to the value of <code>NextMarker</code> from the truncated response you just received.</p> #[serde(rename = "Marker")] #[serde(skip_serializing_if = "Option::is_none")] pub marker: Option<String>, } #[derive(Clone, Debug, Default, Deserialize, PartialEq)] #[cfg_attr(any(test, feature = "serialize_structs"), derive(Serialize))] pub struct ListGrantsResponse { /// <p>A list of grants.</p> #[serde(rename = "Grants")] #[serde(skip_serializing_if = "Option::is_none")] pub grants: Option<Vec<GrantListEntry>>, /// <p>When <code>Truncated</code> is true, this element is present and contains the value to use for the <code>Marker</code> parameter in a subsequent request.</p> #[serde(rename = "NextMarker")] #[serde(skip_serializing_if = "Option::is_none")] pub next_marker: Option<String>, /// <p>A flag that indicates whether there are more items in the list. When this value is true, the list in this response is truncated. To get more items, pass the value of the <code>NextMarker</code> element in thisresponse to the <code>Marker</code> parameter in a subsequent request.</p> #[serde(rename = "Truncated")] #[serde(skip_serializing_if = "Option::is_none")] pub truncated: Option<bool>, } #[derive(Clone, Debug, Default, PartialEq, Serialize)] #[cfg_attr(feature = "deserialize_structs", derive(Deserialize))] pub struct ListKeyPoliciesRequest { /// <p>A unique identifier for the customer master key (CMK).</p> <p>Specify the key ID or the Amazon Resource Name (ARN) of the CMK.</p> <p>For example:</p> <ul> <li> <p>Key ID: <code>1234abcd-12ab-34cd-56ef-1234567890ab</code> </p> </li> <li> <p>Key ARN: <code>arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab</code> </p> </li> </ul> <p>To get the key ID and key ARN for a CMK, use <a>ListKeys</a> or <a>DescribeKey</a>.</p> #[serde(rename = "KeyId")] pub key_id: String, /// <p>Use this parameter to specify the maximum number of items to return. When this value is present, AWS KMS does not return more than the specified number of items, but it might return fewer.</p> <p>This value is optional. If you include a value, it must be between 1 and 1000, inclusive. If you do not include a value, it defaults to 100.</p> <p>Only one policy can be attached to a key.</p> #[serde(rename = "Limit")] #[serde(skip_serializing_if = "Option::is_none")] pub limit: Option<i64>, /// <p>Use this parameter in a subsequent request after you receive a response with truncated results. Set it to the value of <code>NextMarker</code> from the truncated response you just received.</p> #[serde(rename = "Marker")] #[serde(skip_serializing_if = "Option::is_none")] pub marker: Option<String>, } #[derive(Clone, Debug, Default, Deserialize, PartialEq)] #[cfg_attr(any(test, feature = "serialize_structs"), derive(Serialize))] pub struct ListKeyPoliciesResponse { /// <p>When <code>Truncated</code> is true, this element is present and contains the value to use for the <code>Marker</code> parameter in a subsequent request.</p> #[serde(rename = "NextMarker")] #[serde(skip_serializing_if = "Option::is_none")] pub next_marker: Option<String>, /// <p>A list of key policy names. The only valid value is <code>default</code>.</p> #[serde(rename = "PolicyNames")] #[serde(skip_serializing_if = "Option::is_none")] pub policy_names: Option<Vec<String>>, /// <p>A flag that indicates whether there are more items in the list. When this value is true, the list in this response is truncated. To get more items, pass the value of the <code>NextMarker</code> element in thisresponse to the <code>Marker</code> parameter in a subsequent request.</p> #[serde(rename = "Truncated")] #[serde(skip_serializing_if = "Option::is_none")] pub truncated: Option<bool>, } #[derive(Clone, Debug, Default, PartialEq, Serialize)] #[cfg_attr(feature = "deserialize_structs", derive(Deserialize))] pub struct ListKeysRequest { /// <p>Use this parameter to specify the maximum number of items to return. When this value is present, AWS KMS does not return more than the specified number of items, but it might return fewer.</p> <p>This value is optional. If you include a value, it must be between 1 and 1000, inclusive. If you do not include a value, it defaults to 100.</p> #[serde(rename = "Limit")] #[serde(skip_serializing_if = "Option::is_none")] pub limit: Option<i64>, /// <p>Use this parameter in a subsequent request after you receive a response with truncated results. Set it to the value of <code>NextMarker</code> from the truncated response you just received.</p> #[serde(rename = "Marker")] #[serde(skip_serializing_if = "Option::is_none")] pub marker: Option<String>, } #[derive(Clone, Debug, Default, Deserialize, PartialEq)] #[cfg_attr(any(test, feature = "serialize_structs"), derive(Serialize))] pub struct ListKeysResponse { /// <p>A list of customer master keys (CMKs).</p> #[serde(rename = "Keys")] #[serde(skip_serializing_if = "Option::is_none")] pub keys: Option<Vec<KeyListEntry>>, /// <p>When <code>Truncated</code> is true, this element is present and contains the value to use for the <code>Marker</code> parameter in a subsequent request.</p> #[serde(rename = "NextMarker")] #[serde(skip_serializing_if = "Option::is_none")] pub next_marker: Option<String>, /// <p>A flag that indicates whether there are more items in the list. When this value is true, the list in this response is truncated. To get more items, pass the value of the <code>NextMarker</code> element in thisresponse to the <code>Marker</code> parameter in a subsequent request.</p> #[serde(rename = "Truncated")] #[serde(skip_serializing_if = "Option::is_none")] pub truncated: Option<bool>, } #[derive(Clone, Debug, Default, PartialEq, Serialize)] #[cfg_attr(feature = "deserialize_structs", derive(Deserialize))] pub struct ListResourceTagsRequest { /// <p>A unique identifier for the customer master key (CMK).</p> <p>Specify the key ID or the Amazon Resource Name (ARN) of the CMK.</p> <p>For example:</p> <ul> <li> <p>Key ID: <code>1234abcd-12ab-34cd-56ef-1234567890ab</code> </p> </li> <li> <p>Key ARN: <code>arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab</code> </p> </li> </ul> <p>To get the key ID and key ARN for a CMK, use <a>ListKeys</a> or <a>DescribeKey</a>.</p> #[serde(rename = "KeyId")] pub key_id: String, /// <p>Use this parameter to specify the maximum number of items to return. When this value is present, AWS KMS does not return more than the specified number of items, but it might return fewer.</p> <p>This value is optional. If you include a value, it must be between 1 and 50, inclusive. If you do not include a value, it defaults to 50.</p> #[serde(rename = "Limit")] #[serde(skip_serializing_if = "Option::is_none")] pub limit: Option<i64>, /// <p>Use this parameter in a subsequent request after you receive a response with truncated results. Set it to the value of <code>NextMarker</code> from the truncated response you just received.</p> <p>Do not attempt to construct this value. Use only the value of <code>NextMarker</code> from the truncated response you just received.</p> #[serde(rename = "Marker")] #[serde(skip_serializing_if = "Option::is_none")] pub marker: Option<String>, } #[derive(Clone, Debug, Default, Deserialize, PartialEq)] #[cfg_attr(any(test, feature = "serialize_structs"), derive(Serialize))] pub struct ListResourceTagsResponse { /// <p>When <code>Truncated</code> is true, this element is present and contains the value to use for the <code>Marker</code> parameter in a subsequent request.</p> <p>Do not assume or infer any information from this value.</p> #[serde(rename = "NextMarker")] #[serde(skip_serializing_if = "Option::is_none")] pub next_marker: Option<String>, /// <p>A list of tags. Each tag consists of a tag key and a tag value.</p> #[serde(rename = "Tags")] #[serde(skip_serializing_if = "Option::is_none")] pub tags: Option<Vec<Tag>>, /// <p>A flag that indicates whether there are more items in the list. When this value is true, the list in this response is truncated. To get more items, pass the value of the <code>NextMarker</code> element in thisresponse to the <code>Marker</code> parameter in a subsequent request.</p> #[serde(rename = "Truncated")] #[serde(skip_serializing_if = "Option::is_none")] pub truncated: Option<bool>, } #[derive(Clone, Debug, Default, PartialEq, Serialize)] #[cfg_attr(feature = "deserialize_structs", derive(Deserialize))] pub struct ListRetirableGrantsRequest { /// <p>Use this parameter to specify the maximum number of items to return. When this value is present, AWS KMS does not return more than the specified number of items, but it might return fewer.</p> <p>This value is optional. If you include a value, it must be between 1 and 100, inclusive. If you do not include a value, it defaults to 50.</p> #[serde(rename = "Limit")] #[serde(skip_serializing_if = "Option::is_none")] pub limit: Option<i64>, /// <p>Use this parameter in a subsequent request after you receive a response with truncated results. Set it to the value of <code>NextMarker</code> from the truncated response you just received.</p> #[serde(rename = "Marker")] #[serde(skip_serializing_if = "Option::is_none")] pub marker: Option<String>, /// <p>The retiring principal for which to list grants.</p> <p>To specify the retiring principal, use the <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Name (ARN)</a> of an AWS principal. Valid AWS principals include AWS accounts (root), IAM users, federated users, and assumed role users. For examples of the ARN syntax for specifying a principal, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#arn-syntax-iam">AWS Identity and Access Management (IAM)</a> in the Example ARNs section of the <i>Amazon Web Services General Reference</i>.</p> #[serde(rename = "RetiringPrincipal")] pub retiring_principal: String, } #[derive(Clone, Debug, Default, PartialEq, Serialize)] #[cfg_attr(feature = "deserialize_structs", derive(Deserialize))] pub struct PutKeyPolicyRequest { /// <p>A flag to indicate whether to bypass the key policy lockout safety check.</p> <important> <p>Setting this value to true increases the risk that the CMK becomes unmanageable. Do not set this value to true indiscriminately.</p> <p>For more information, refer to the scenario in the <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html#key-policy-default-allow-root-enable-iam">Default Key Policy</a> section in the <i>AWS Key Management Service Developer Guide</i>.</p> </important> <p>Use this parameter only when you intend to prevent the principal that is making the request from making a subsequent <code>PutKeyPolicy</code> request on the CMK.</p> <p>The default value is false.</p> #[serde(rename = "BypassPolicyLockoutSafetyCheck")] #[serde(skip_serializing_if = "Option::is_none")] pub bypass_policy_lockout_safety_check: Option<bool>, /// <p>A unique identifier for the customer master key (CMK).</p> <p>Specify the key ID or the Amazon Resource Name (ARN) of the CMK.</p> <p>For example:</p> <ul> <li> <p>Key ID: <code>1234abcd-12ab-34cd-56ef-1234567890ab</code> </p> </li> <li> <p>Key ARN: <code>arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab</code> </p> </li> </ul> <p>To get the key ID and key ARN for a CMK, use <a>ListKeys</a> or <a>DescribeKey</a>.</p> #[serde(rename = "KeyId")] pub key_id: String, /// <p>The key policy to attach to the CMK.</p> <p>The key policy must meet the following criteria:</p> <ul> <li> <p>If you don't set <code>BypassPolicyLockoutSafetyCheck</code> to true, the key policy must allow the principal that is making the <code>PutKeyPolicy</code> request to make a subsequent <code>PutKeyPolicy</code> request on the CMK. This reduces the risk that the CMK becomes unmanageable. For more information, refer to the scenario in the <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html#key-policy-default-allow-root-enable-iam">Default Key Policy</a> section of the <i>AWS Key Management Service Developer Guide</i>.</p> </li> <li> <p>Each statement in the key policy must contain one or more principals. The principals in the key policy must exist and be visible to AWS KMS. When you create a new AWS principal (for example, an IAM user or role), you might need to enforce a delay before including the new principal in a key policy because the new principal might not be immediately visible to AWS KMS. For more information, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/troubleshoot_general.html#troubleshoot_general_eventual-consistency">Changes that I make are not always immediately visible</a> in the <i>AWS Identity and Access Management User Guide</i>.</p> </li> </ul> <p>The key policy cannot exceed 32 kilobytes (32768 bytes). For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/resource-limits.html">Resource Quotas</a> in the <i>AWS Key Management Service Developer Guide</i>.</p> #[serde(rename = "Policy")] pub policy: String, /// <p>The name of the key policy. The only valid value is <code>default</code>.</p> #[serde(rename = "PolicyName")] pub policy_name: String, } #[derive(Clone, Debug, Default, PartialEq, Serialize)] #[cfg_attr(feature = "deserialize_structs", derive(Deserialize))] pub struct ReEncryptRequest { /// <p>Ciphertext of the data to reencrypt.</p> #[serde(rename = "CiphertextBlob")] #[serde( deserialize_with = "::rusoto_core::serialization::SerdeBlob::deserialize_blob", serialize_with = "::rusoto_core::serialization::SerdeBlob::serialize_blob", default )] pub ciphertext_blob: bytes::Bytes, /// <p>Specifies the encryption algorithm that AWS KMS will use to reecrypt the data after it has decrypted it. The default value, <code>SYMMETRIC_DEFAULT</code>, represents the encryption algorithm used for symmetric CMKs.</p> <p>This parameter is required only when the destination CMK is an asymmetric CMK.</p> #[serde(rename = "DestinationEncryptionAlgorithm")] #[serde(skip_serializing_if = "Option::is_none")] pub destination_encryption_algorithm: Option<String>, /// <p>Specifies that encryption context to use when the reencrypting the data.</p> <p>A destination encryption context is valid only when the destination CMK is a symmetric CMK. The standard ciphertext format for asymmetric CMKs does not include fields for metadata.</p> <p>An <i>encryption context</i> is a collection of non-secret key-value pairs that represents additional authenticated data. When you use an encryption context to encrypt data, you must specify the same (an exact case-sensitive match) encryption context to decrypt the data. An encryption context is optional when encrypting with a symmetric CMK, but it is highly recommended.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context">Encryption Context</a> in the <i>AWS Key Management Service Developer Guide</i>.</p> #[serde(rename = "DestinationEncryptionContext")] #[serde(skip_serializing_if = "Option::is_none")] pub destination_encryption_context: Option<::std::collections::HashMap<String, String>>, /// <p>A unique identifier for the CMK that is used to reencrypt the data. Specify a symmetric or asymmetric CMK with a <code>KeyUsage</code> value of <code>ENCRYPT_DECRYPT</code>. To find the <code>KeyUsage</code> value of a CMK, use the <a>DescribeKey</a> operation.</p> <p>To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name, prefix it with <code>"alias/"</code>. To specify a CMK in a different AWS account, you must use the key ARN or alias ARN.</p> <p>For example:</p> <ul> <li> <p>Key ID: <code>1234abcd-12ab-34cd-56ef-1234567890ab</code> </p> </li> <li> <p>Key ARN: <code>arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab</code> </p> </li> <li> <p>Alias name: <code>alias/ExampleAlias</code> </p> </li> <li> <p>Alias ARN: <code>arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias</code> </p> </li> </ul> <p>To get the key ID and key ARN for a CMK, use <a>ListKeys</a> or <a>DescribeKey</a>. To get the alias name and alias ARN, use <a>ListAliases</a>.</p> #[serde(rename = "DestinationKeyId")] pub destination_key_id: String, /// <p>A list of grant tokens.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#grant_token">Grant Tokens</a> in the <i>AWS Key Management Service Developer Guide</i>.</p> #[serde(rename = "GrantTokens")] #[serde(skip_serializing_if = "Option::is_none")] pub grant_tokens: Option<Vec<String>>, /// <p>Specifies the encryption algorithm that AWS KMS will use to decrypt the ciphertext before it is reencrypted. The default value, <code>SYMMETRIC_DEFAULT</code>, represents the algorithm used for symmetric CMKs.</p> <p>Specify the same algorithm that was used to encrypt the ciphertext. If you specify a different algorithm, the decrypt attempt fails.</p> <p>This parameter is required only when the ciphertext was encrypted under an asymmetric CMK.</p> #[serde(rename = "SourceEncryptionAlgorithm")] #[serde(skip_serializing_if = "Option::is_none")] pub source_encryption_algorithm: Option<String>, /// <p>Specifies the encryption context to use to decrypt the ciphertext. Enter the same encryption context that was used to encrypt the ciphertext.</p> <p>An <i>encryption context</i> is a collection of non-secret key-value pairs that represents additional authenticated data. When you use an encryption context to encrypt data, you must specify the same (an exact case-sensitive match) encryption context to decrypt the data. An encryption context is optional when encrypting with a symmetric CMK, but it is highly recommended.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context">Encryption Context</a> in the <i>AWS Key Management Service Developer Guide</i>.</p> #[serde(rename = "SourceEncryptionContext")] #[serde(skip_serializing_if = "Option::is_none")] pub source_encryption_context: Option<::std::collections::HashMap<String, String>>, /// <p>A unique identifier for the CMK that is used to decrypt the ciphertext before it reencrypts it using the destination CMK.</p> <p>This parameter is required only when the ciphertext was encrypted under an asymmetric CMK. Otherwise, AWS KMS uses the metadata that it adds to the ciphertext blob to determine which CMK was used to encrypt the ciphertext. However, you can use this parameter to ensure that a particular CMK (of any kind) is used to decrypt the ciphertext before it is reencrypted.</p> <p>If you specify a <code>KeyId</code> value, the decrypt part of the <code>ReEncrypt</code> operation succeeds only if the specified CMK was used to encrypt the ciphertext.</p> <p>To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name, prefix it with <code>"alias/"</code>.</p> <p>For example:</p> <ul> <li> <p>Key ID: <code>1234abcd-12ab-34cd-56ef-1234567890ab</code> </p> </li> <li> <p>Key ARN: <code>arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab</code> </p> </li> <li> <p>Alias name: <code>alias/ExampleAlias</code> </p> </li> <li> <p>Alias ARN: <code>arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias</code> </p> </li> </ul> <p>To get the key ID and key ARN for a CMK, use <a>ListKeys</a> or <a>DescribeKey</a>. To get the alias name and alias ARN, use <a>ListAliases</a>.</p> #[serde(rename = "SourceKeyId")] #[serde(skip_serializing_if = "Option::is_none")] pub source_key_id: Option<String>, } #[derive(Clone, Debug, Default, Deserialize, PartialEq)] #[cfg_attr(any(test, feature = "serialize_structs"), derive(Serialize))] pub struct ReEncryptResponse { /// <p>The reencrypted data. When you use the HTTP API or the AWS CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.</p> #[serde(rename = "CiphertextBlob")] #[serde( deserialize_with = "::rusoto_core::serialization::SerdeBlob::deserialize_blob", serialize_with = "::rusoto_core::serialization::SerdeBlob::serialize_blob", default )] #[serde(skip_serializing_if = "Option::is_none")] pub ciphertext_blob: Option<bytes::Bytes>, /// <p>The encryption algorithm that was used to reencrypt the data.</p> #[serde(rename = "DestinationEncryptionAlgorithm")] #[serde(skip_serializing_if = "Option::is_none")] pub destination_encryption_algorithm: Option<String>, /// <p>The Amazon Resource Name (<a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id-key-ARN">key ARN</a>) of the CMK that was used to reencrypt the data.</p> #[serde(rename = "KeyId")] #[serde(skip_serializing_if = "Option::is_none")] pub key_id: Option<String>, /// <p>The encryption algorithm that was used to decrypt the ciphertext before it was reencrypted.</p> #[serde(rename = "SourceEncryptionAlgorithm")] #[serde(skip_serializing_if = "Option::is_none")] pub source_encryption_algorithm: Option<String>, /// <p>Unique identifier of the CMK used to originally encrypt the data.</p> #[serde(rename = "SourceKeyId")] #[serde(skip_serializing_if = "Option::is_none")] pub source_key_id: Option<String>, } #[derive(Clone, Debug, Default, PartialEq, Serialize)] #[cfg_attr(feature = "deserialize_structs", derive(Deserialize))] pub struct RetireGrantRequest { /// <p><p>Unique identifier of the grant to retire. The grant ID is returned in the response to a <code>CreateGrant</code> operation.</p> <ul> <li> <p>Grant ID Example - 0123456789012345678901234567890123456789012345678901234567890123</p> </li> </ul></p> #[serde(rename = "GrantId")] #[serde(skip_serializing_if = "Option::is_none")] pub grant_id: Option<String>, /// <p>Token that identifies the grant to be retired.</p> #[serde(rename = "GrantToken")] #[serde(skip_serializing_if = "Option::is_none")] pub grant_token: Option<String>, /// <p>The Amazon Resource Name (ARN) of the CMK associated with the grant. </p> <p>For example: <code>arn:aws:kms:us-east-2:444455556666:key/1234abcd-12ab-34cd-56ef-1234567890ab</code> </p> #[serde(rename = "KeyId")] #[serde(skip_serializing_if = "Option::is_none")] pub key_id: Option<String>, } #[derive(Clone, Debug, Default, PartialEq, Serialize)] #[cfg_attr(feature = "deserialize_structs", derive(Deserialize))] pub struct RevokeGrantRequest { /// <p>Identifier of the grant to be revoked.</p> #[serde(rename = "GrantId")] pub grant_id: String, /// <p>A unique identifier for the customer master key associated with the grant.</p> <p>Specify the key ID or the Amazon Resource Name (ARN) of the CMK. To specify a CMK in a different AWS account, you must use the key ARN.</p> <p>For example:</p> <ul> <li> <p>Key ID: <code>1234abcd-12ab-34cd-56ef-1234567890ab</code> </p> </li> <li> <p>Key ARN: <code>arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab</code> </p> </li> </ul> <p>To get the key ID and key ARN for a CMK, use <a>ListKeys</a> or <a>DescribeKey</a>.</p> #[serde(rename = "KeyId")] pub key_id: String, } #[derive(Clone, Debug, Default, PartialEq, Serialize)] #[cfg_attr(feature = "deserialize_structs", derive(Deserialize))] pub struct ScheduleKeyDeletionRequest { /// <p>The unique identifier of the customer master key (CMK) to delete.</p> <p>Specify the key ID or the Amazon Resource Name (ARN) of the CMK.</p> <p>For example:</p> <ul> <li> <p>Key ID: <code>1234abcd-12ab-34cd-56ef-1234567890ab</code> </p> </li> <li> <p>Key ARN: <code>arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab</code> </p> </li> </ul> <p>To get the key ID and key ARN for a CMK, use <a>ListKeys</a> or <a>DescribeKey</a>.</p> #[serde(rename = "KeyId")] pub key_id: String, /// <p>The waiting period, specified in number of days. After the waiting period ends, AWS KMS deletes the customer master key (CMK).</p> <p>This value is optional. If you include a value, it must be between 7 and 30, inclusive. If you do not include a value, it defaults to 30.</p> #[serde(rename = "PendingWindowInDays")] #[serde(skip_serializing_if = "Option::is_none")] pub pending_window_in_days: Option<i64>, } #[derive(Clone, Debug, Default, Deserialize, PartialEq)] #[cfg_attr(any(test, feature = "serialize_structs"), derive(Serialize))] pub struct ScheduleKeyDeletionResponse { /// <p>The date and time after which AWS KMS deletes the customer master key (CMK).</p> #[serde(rename = "DeletionDate")] #[serde(skip_serializing_if = "Option::is_none")] pub deletion_date: Option<f64>, /// <p>The Amazon Resource Name (<a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id-key-ARN">key ARN</a>) of the CMK whose deletion is scheduled.</p> #[serde(rename = "KeyId")] #[serde(skip_serializing_if = "Option::is_none")] pub key_id: Option<String>, } #[derive(Clone, Debug, Default, PartialEq, Serialize)] #[cfg_attr(feature = "deserialize_structs", derive(Deserialize))] pub struct SignRequest { /// <p>A list of grant tokens.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#grant_token">Grant Tokens</a> in the <i>AWS Key Management Service Developer Guide</i>.</p> #[serde(rename = "GrantTokens")] #[serde(skip_serializing_if = "Option::is_none")] pub grant_tokens: Option<Vec<String>>, /// <p>Identifies an asymmetric CMK. AWS KMS uses the private key in the asymmetric CMK to sign the message. The <code>KeyUsage</code> type of the CMK must be <code>SIGN_VERIFY</code>. To find the <code>KeyUsage</code> of a CMK, use the <a>DescribeKey</a> operation.</p> <p>To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name, prefix it with <code>"alias/"</code>. To specify a CMK in a different AWS account, you must use the key ARN or alias ARN.</p> <p>For example:</p> <ul> <li> <p>Key ID: <code>1234abcd-12ab-34cd-56ef-1234567890ab</code> </p> </li> <li> <p>Key ARN: <code>arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab</code> </p> </li> <li> <p>Alias name: <code>alias/ExampleAlias</code> </p> </li> <li> <p>Alias ARN: <code>arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias</code> </p> </li> </ul> <p>To get the key ID and key ARN for a CMK, use <a>ListKeys</a> or <a>DescribeKey</a>. To get the alias name and alias ARN, use <a>ListAliases</a>.</p> #[serde(rename = "KeyId")] pub key_id: String, /// <p>Specifies the message or message digest to sign. Messages can be 0-4096 bytes. To sign a larger message, provide the message digest.</p> <p>If you provide a message, AWS KMS generates a hash digest of the message and then signs it.</p> #[serde(rename = "Message")] #[serde( deserialize_with = "::rusoto_core::serialization::SerdeBlob::deserialize_blob", serialize_with = "::rusoto_core::serialization::SerdeBlob::serialize_blob", default )] pub message: bytes::Bytes, /// <p>Tells AWS KMS whether the value of the <code>Message</code> parameter is a message or message digest. The default value, RAW, indicates a message. To indicate a message digest, enter <code>DIGEST</code>.</p> #[serde(rename = "MessageType")] #[serde(skip_serializing_if = "Option::is_none")] pub message_type: Option<String>, /// <p>Specifies the signing algorithm to use when signing the message. </p> <p>Choose an algorithm that is compatible with the type and size of the specified asymmetric CMK.</p> #[serde(rename = "SigningAlgorithm")] pub signing_algorithm: String, } #[derive(Clone, Debug, Default, Deserialize, PartialEq)] #[cfg_attr(any(test, feature = "serialize_structs"), derive(Serialize))] pub struct SignResponse { /// <p>The Amazon Resource Name (<a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id-key-ARN">key ARN</a>) of the asymmetric CMK that was used to sign the message.</p> #[serde(rename = "KeyId")] #[serde(skip_serializing_if = "Option::is_none")] pub key_id: Option<String>, /// <p>The cryptographic signature that was generated for the message. </p> <ul> <li> <p>When used with the supported RSA signing algorithms, the encoding of this value is defined by <a href="https://tools.ietf.org/html/rfc8017">PKCS #1 in RFC 8017</a>.</p> </li> <li> <p>When used with the <code>ECDSA_SHA_256</code>, <code>ECDSA_SHA_384</code>, or <code>ECDSA_SHA_512</code> signing algorithms, this value is a DER-encoded object as defined by ANS X9.62–2005 and <a href="https://tools.ietf.org/html/rfc3279#section-2.2.3">RFC 3279 Section 2.2.3</a>. This is the most commonly used signature format and is appropriate for most uses. </p> </li> </ul> <p>When you use the HTTP API or the AWS CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.</p> #[serde(rename = "Signature")] #[serde( deserialize_with = "::rusoto_core::serialization::SerdeBlob::deserialize_blob", serialize_with = "::rusoto_core::serialization::SerdeBlob::serialize_blob", default )] #[serde(skip_serializing_if = "Option::is_none")] pub signature: Option<bytes::Bytes>, /// <p>The signing algorithm that was used to sign the message.</p> #[serde(rename = "SigningAlgorithm")] #[serde(skip_serializing_if = "Option::is_none")] pub signing_algorithm: Option<String>, } /// <p>A key-value pair. A tag consists of a tag key and a tag value. Tag keys and tag values are both required, but tag values can be empty (null) strings.</p> <p>For information about the rules that apply to tag keys and tag values, see <a href="https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/allocation-tag-restrictions.html">User-Defined Tag Restrictions</a> in the <i>AWS Billing and Cost Management User Guide</i>.</p> #[derive(Clone, Debug, Default, Deserialize, PartialEq, Serialize)] pub struct Tag { /// <p>The key of the tag.</p> #[serde(rename = "TagKey")] pub tag_key: String, /// <p>The value of the tag.</p> #[serde(rename = "TagValue")] pub tag_value: String, } #[derive(Clone, Debug, Default, PartialEq, Serialize)] #[cfg_attr(feature = "deserialize_structs", derive(Deserialize))] pub struct TagResourceRequest { /// <p>A unique identifier for the CMK you are tagging.</p> <p>Specify the key ID or the Amazon Resource Name (ARN) of the CMK.</p> <p>For example:</p> <ul> <li> <p>Key ID: <code>1234abcd-12ab-34cd-56ef-1234567890ab</code> </p> </li> <li> <p>Key ARN: <code>arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab</code> </p> </li> </ul> <p>To get the key ID and key ARN for a CMK, use <a>ListKeys</a> or <a>DescribeKey</a>.</p> #[serde(rename = "KeyId")] pub key_id: String, /// <p>One or more tags. Each tag consists of a tag key and a tag value.</p> #[serde(rename = "Tags")] pub tags: Vec<Tag>, } #[derive(Clone, Debug, Default, PartialEq, Serialize)] #[cfg_attr(feature = "deserialize_structs", derive(Deserialize))] pub struct UntagResourceRequest { /// <p>A unique identifier for the CMK from which you are removing tags.</p> <p>Specify the key ID or the Amazon Resource Name (ARN) of the CMK.</p> <p>For example:</p> <ul> <li> <p>Key ID: <code>1234abcd-12ab-34cd-56ef-1234567890ab</code> </p> </li> <li> <p>Key ARN: <code>arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab</code> </p> </li> </ul> <p>To get the key ID and key ARN for a CMK, use <a>ListKeys</a> or <a>DescribeKey</a>.</p> #[serde(rename = "KeyId")] pub key_id: String, /// <p>One or more tag keys. Specify only the tag keys, not the tag values.</p> #[serde(rename = "TagKeys")] pub tag_keys: Vec<String>, } #[derive(Clone, Debug, Default, PartialEq, Serialize)] #[cfg_attr(feature = "deserialize_structs", derive(Deserialize))] pub struct UpdateAliasRequest { /// <p>Identifies the alias that is changing its CMK. This value must begin with <code>alias/</code> followed by the alias name, such as <code>alias/ExampleAlias</code>. You cannot use UpdateAlias to change the alias name.</p> #[serde(rename = "AliasName")] pub alias_name: String, /// <p>Identifies the CMK to associate with the alias. When the update operation completes, the alias will point to this CMK. </p> <p>The CMK must be in the same AWS account and Region as the alias. Also, the new target CMK must be the same type as the current target CMK (both symmetric or both asymmetric) and they must have the same key usage. </p> <p>Specify the key ID or the Amazon Resource Name (ARN) of the CMK.</p> <p>For example:</p> <ul> <li> <p>Key ID: <code>1234abcd-12ab-34cd-56ef-1234567890ab</code> </p> </li> <li> <p>Key ARN: <code>arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab</code> </p> </li> </ul> <p>To get the key ID and key ARN for a CMK, use <a>ListKeys</a> or <a>DescribeKey</a>.</p> <p>To verify that the alias is mapped to the correct CMK, use <a>ListAliases</a>.</p> #[serde(rename = "TargetKeyId")] pub target_key_id: String, } #[derive(Clone, Debug, Default, PartialEq, Serialize)] #[cfg_attr(feature = "deserialize_structs", derive(Deserialize))] pub struct UpdateCustomKeyStoreRequest { /// <p>Associates the custom key store with a related AWS CloudHSM cluster. </p> <p>Enter the cluster ID of the cluster that you used to create the custom key store or a cluster that shares a backup history and has the same cluster certificate as the original cluster. You cannot use this parameter to associate a custom key store with an unrelated cluster. In addition, the replacement cluster must <a href="https://docs.aws.amazon.com/kms/latest/developerguide/create-keystore.html#before-keystore">fulfill the requirements</a> for a cluster associated with a custom key store. To view the cluster certificate of a cluster, use the <a href="https://docs.aws.amazon.com/cloudhsm/latest/APIReference/API_DescribeClusters.html">DescribeClusters</a> operation.</p> #[serde(rename = "CloudHsmClusterId")] #[serde(skip_serializing_if = "Option::is_none")] pub cloud_hsm_cluster_id: Option<String>, /// <p>Identifies the custom key store that you want to update. Enter the ID of the custom key store. To find the ID of a custom key store, use the <a>DescribeCustomKeyStores</a> operation.</p> #[serde(rename = "CustomKeyStoreId")] pub custom_key_store_id: String, /// <p>Enter the current password of the <code>kmsuser</code> crypto user (CU) in the AWS CloudHSM cluster that is associated with the custom key store.</p> <p>This parameter tells AWS KMS the current password of the <code>kmsuser</code> crypto user (CU). It does not set or change the password of any users in the AWS CloudHSM cluster.</p> #[serde(rename = "KeyStorePassword")] #[serde(skip_serializing_if = "Option::is_none")] pub key_store_password: Option<String>, /// <p>Changes the friendly name of the custom key store to the value that you specify. The custom key store name must be unique in the AWS account.</p> #[serde(rename = "NewCustomKeyStoreName")] #[serde(skip_serializing_if = "Option::is_none")] pub new_custom_key_store_name: Option<String>, } #[derive(Clone, Debug, Default, Deserialize, PartialEq)] #[cfg_attr(any(test, feature = "serialize_structs"), derive(Serialize))] pub struct UpdateCustomKeyStoreResponse {} #[derive(Clone, Debug, Default, PartialEq, Serialize)] #[cfg_attr(feature = "deserialize_structs", derive(Deserialize))] pub struct UpdateKeyDescriptionRequest { /// <p>New description for the CMK.</p> #[serde(rename = "Description")] pub description: String, /// <p>A unique identifier for the customer master key (CMK).</p> <p>Specify the key ID or the Amazon Resource Name (ARN) of the CMK.</p> <p>For example:</p> <ul> <li> <p>Key ID: <code>1234abcd-12ab-34cd-56ef-1234567890ab</code> </p> </li> <li> <p>Key ARN: <code>arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab</code> </p> </li> </ul> <p>To get the key ID and key ARN for a CMK, use <a>ListKeys</a> or <a>DescribeKey</a>.</p> #[serde(rename = "KeyId")] pub key_id: String, } #[derive(Clone, Debug, Default, PartialEq, Serialize)] #[cfg_attr(feature = "deserialize_structs", derive(Deserialize))] pub struct VerifyRequest { /// <p>A list of grant tokens.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#grant_token">Grant Tokens</a> in the <i>AWS Key Management Service Developer Guide</i>.</p> #[serde(rename = "GrantTokens")] #[serde(skip_serializing_if = "Option::is_none")] pub grant_tokens: Option<Vec<String>>, /// <p>Identifies the asymmetric CMK that will be used to verify the signature. This must be the same CMK that was used to generate the signature. If you specify a different CMK, the signature verification fails.</p> <p>To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name, prefix it with <code>"alias/"</code>. To specify a CMK in a different AWS account, you must use the key ARN or alias ARN.</p> <p>For example:</p> <ul> <li> <p>Key ID: <code>1234abcd-12ab-34cd-56ef-1234567890ab</code> </p> </li> <li> <p>Key ARN: <code>arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab</code> </p> </li> <li> <p>Alias name: <code>alias/ExampleAlias</code> </p> </li> <li> <p>Alias ARN: <code>arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias</code> </p> </li> </ul> <p>To get the key ID and key ARN for a CMK, use <a>ListKeys</a> or <a>DescribeKey</a>. To get the alias name and alias ARN, use <a>ListAliases</a>.</p> #[serde(rename = "KeyId")] pub key_id: String, /// <p>Specifies the message that was signed. You can submit a raw message of up to 4096 bytes, or a hash digest of the message. If you submit a digest, use the <code>MessageType</code> parameter with a value of <code>DIGEST</code>.</p> <p>If the message specified here is different from the message that was signed, the signature verification fails. A message and its hash digest are considered to be the same message.</p> #[serde(rename = "Message")] #[serde( deserialize_with = "::rusoto_core::serialization::SerdeBlob::deserialize_blob", serialize_with = "::rusoto_core::serialization::SerdeBlob::serialize_blob", default )] pub message: bytes::Bytes, /// <p><p>Tells AWS KMS whether the value of the <code>Message</code> parameter is a message or message digest. The default value, RAW, indicates a message. To indicate a message digest, enter <code>DIGEST</code>.</p> <important> <p>Use the <code>DIGEST</code> value only when the value of the <code>Message</code> parameter is a message digest. If you use the <code>DIGEST</code> value with a raw message, the security of the verification operation can be compromised.</p> </important></p> #[serde(rename = "MessageType")] #[serde(skip_serializing_if = "Option::is_none")] pub message_type: Option<String>, /// <p>The signature that the <code>Sign</code> operation generated.</p> #[serde(rename = "Signature")] #[serde( deserialize_with = "::rusoto_core::serialization::SerdeBlob::deserialize_blob", serialize_with = "::rusoto_core::serialization::SerdeBlob::serialize_blob", default )] pub signature: bytes::Bytes, /// <p>The signing algorithm that was used to sign the message. If you submit a different algorithm, the signature verification fails.</p> #[serde(rename = "SigningAlgorithm")] pub signing_algorithm: String, } #[derive(Clone, Debug, Default, Deserialize, PartialEq)] #[cfg_attr(any(test, feature = "serialize_structs"), derive(Serialize))] pub struct VerifyResponse { /// <p>The Amazon Resource Name (<a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id-key-ARN">key ARN</a>) of the asymmetric CMK that was used to verify the signature.</p> #[serde(rename = "KeyId")] #[serde(skip_serializing_if = "Option::is_none")] pub key_id: Option<String>, /// <p>A Boolean value that indicates whether the signature was verified. A value of <code>True</code> indicates that the <code>Signature</code> was produced by signing the <code>Message</code> with the specified <code>KeyID</code> and <code>SigningAlgorithm.</code> If the signature is not verified, the <code>Verify</code> operation fails with a <code>KMSInvalidSignatureException</code> exception. </p> #[serde(rename = "SignatureValid")] #[serde(skip_serializing_if = "Option::is_none")] pub signature_valid: Option<bool>, /// <p>The signing algorithm that was used to verify the signature.</p> #[serde(rename = "SigningAlgorithm")] #[serde(skip_serializing_if = "Option::is_none")] pub signing_algorithm: Option<String>, } /// Errors returned by CancelKeyDeletion #[derive(Debug, PartialEq)] pub enum CancelKeyDeletionError { /// <p>The system timed out while trying to fulfill the request. The request can be retried.</p> DependencyTimeout(String), /// <p>The request was rejected because a specified ARN, or an ARN in a key policy, is not valid.</p> InvalidArn(String), /// <p>The request was rejected because an internal exception occurred. The request can be retried.</p> KMSInternal(String), /// <p>The request was rejected because the state of the specified resource is not valid for this request.</p> <p>For more information about how key state affects the use of a CMK, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">How Key State Affects Use of a Customer Master Key</a> in the <i> <i>AWS Key Management Service Developer Guide</i> </i>.</p> KMSInvalidState(String), /// <p>The request was rejected because the specified entity or resource could not be found.</p> NotFound(String), } impl CancelKeyDeletionError { pub fn from_response(res: BufferedHttpResponse) -> RusotoError<CancelKeyDeletionError> { if let Some(err) = proto::json::Error::parse(&res) { match err.typ.as_str() { "DependencyTimeoutException" => { return RusotoError::Service(CancelKeyDeletionError::DependencyTimeout(err.msg)) } "InvalidArnException" => { return RusotoError::Service(CancelKeyDeletionError::InvalidArn(err.msg)) } "KMSInternalException" => { return RusotoError::Service(CancelKeyDeletionError::KMSInternal(err.msg)) } "KMSInvalidStateException" => { return RusotoError::Service(CancelKeyDeletionError::KMSInvalidState(err.msg)) } "NotFoundException" => { return RusotoError::Service(CancelKeyDeletionError::NotFound(err.msg)) } "ValidationException" => return RusotoError::Validation(err.msg), _ => {} } } RusotoError::Unknown(res) } } impl fmt::Display for CancelKeyDeletionError { #[allow(unused_variables)] fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result { match *self { CancelKeyDeletionError::DependencyTimeout(ref cause) => write!(f, "{}", cause), CancelKeyDeletionError::InvalidArn(ref cause) => write!(f, "{}", cause), CancelKeyDeletionError::KMSInternal(ref cause) => write!(f, "{}", cause), CancelKeyDeletionError::KMSInvalidState(ref cause) => write!(f, "{}", cause), CancelKeyDeletionError::NotFound(ref cause) => write!(f, "{}", cause), } } } impl Error for CancelKeyDeletionError {} /// Errors returned by ConnectCustomKeyStore #[derive(Debug, PartialEq)] pub enum ConnectCustomKeyStoreError { /// <p>The request was rejected because the associated AWS CloudHSM cluster did not meet the configuration requirements for a custom key store.</p> <ul> <li> <p>The cluster must be configured with private subnets in at least two different Availability Zones in the Region.</p> </li> <li> <p>The <a href="https://docs.aws.amazon.com/cloudhsm/latest/userguide/configure-sg.html">security group for the cluster</a> (cloudhsm-cluster-<i><cluster-id></i>-sg) must include inbound rules and outbound rules that allow TCP traffic on ports 2223-2225. The <b>Source</b> in the inbound rules and the <b>Destination</b> in the outbound rules must match the security group ID. These rules are set by default when you create the cluster. Do not delete or change them. To get information about a particular security group, use the <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeSecurityGroups.html">DescribeSecurityGroups</a> operation.</p> </li> <li> <p>The cluster must contain at least as many HSMs as the operation requires. To add HSMs, use the AWS CloudHSM <a href="https://docs.aws.amazon.com/cloudhsm/latest/APIReference/API_CreateHsm.html">CreateHsm</a> operation.</p> <p>For the <a>CreateCustomKeyStore</a>, <a>UpdateCustomKeyStore</a>, and <a>CreateKey</a> operations, the AWS CloudHSM cluster must have at least two active HSMs, each in a different Availability Zone. For the <a>ConnectCustomKeyStore</a> operation, the AWS CloudHSM must contain at least one active HSM.</p> </li> </ul> <p>For information about the requirements for an AWS CloudHSM cluster that is associated with a custom key store, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/create-keystore.html#before-keystore">Assemble the Prerequisites</a> in the <i>AWS Key Management Service Developer Guide</i>. For information about creating a private subnet for an AWS CloudHSM cluster, see <a href="https://docs.aws.amazon.com/cloudhsm/latest/userguide/create-subnets.html">Create a Private Subnet</a> in the <i>AWS CloudHSM User Guide</i>. For information about cluster security groups, see <a href="https://docs.aws.amazon.com/cloudhsm/latest/userguide/configure-sg.html">Configure a Default Security Group</a> in the <i> <i>AWS CloudHSM User Guide</i> </i>. </p> CloudHsmClusterInvalidConfiguration(String), /// <p>The request was rejected because the AWS CloudHSM cluster that is associated with the custom key store is not active. Initialize and activate the cluster and try the command again. For detailed instructions, see <a href="https://docs.aws.amazon.com/cloudhsm/latest/userguide/getting-started.html">Getting Started</a> in the <i>AWS CloudHSM User Guide</i>.</p> CloudHsmClusterNotActive(String), /// <p><p>The request was rejected because of the <code>ConnectionState</code> of the custom key store. To get the <code>ConnectionState</code> of a custom key store, use the <a>DescribeCustomKeyStores</a> operation.</p> <p>This exception is thrown under the following conditions:</p> <ul> <li> <p>You requested the <a>CreateKey</a> or <a>GenerateRandom</a> operation in a custom key store that is not connected. These operations are valid only when the custom key store <code>ConnectionState</code> is <code>CONNECTED</code>.</p> </li> <li> <p>You requested the <a>UpdateCustomKeyStore</a> or <a>DeleteCustomKeyStore</a> operation on a custom key store that is not disconnected. This operation is valid only when the custom key store <code>ConnectionState</code> is <code>DISCONNECTED</code>.</p> </li> <li> <p>You requested the <a>ConnectCustomKeyStore</a> operation on a custom key store with a <code>ConnectionState</code> of <code>DISCONNECTING</code> or <code>FAILED</code>. This operation is valid for all other <code>ConnectionState</code> values.</p> </li> </ul></p> CustomKeyStoreInvalidState(String), /// <p>The request was rejected because AWS KMS cannot find a custom key store with the specified key store name or ID.</p> CustomKeyStoreNotFound(String), /// <p>The request was rejected because an internal exception occurred. The request can be retried.</p> KMSInternal(String), } impl ConnectCustomKeyStoreError { pub fn from_response(res: BufferedHttpResponse) -> RusotoError<ConnectCustomKeyStoreError> { if let Some(err) = proto::json::Error::parse(&res) { match err.typ.as_str() { "CloudHsmClusterInvalidConfigurationException" => { return RusotoError::Service( ConnectCustomKeyStoreError::CloudHsmClusterInvalidConfiguration(err.msg), ) } "CloudHsmClusterNotActiveException" => { return RusotoError::Service( ConnectCustomKeyStoreError::CloudHsmClusterNotActive(err.msg), ) } "CustomKeyStoreInvalidStateException" => { return RusotoError::Service( ConnectCustomKeyStoreError::CustomKeyStoreInvalidState(err.msg), ) } "CustomKeyStoreNotFoundException" => { return RusotoError::Service( ConnectCustomKeyStoreError::CustomKeyStoreNotFound(err.msg), ) } "KMSInternalException" => { return RusotoError::Service(ConnectCustomKeyStoreError::KMSInternal(err.msg)) } "ValidationException" => return RusotoError::Validation(err.msg), _ => {} } } RusotoError::Unknown(res) } } impl fmt::Display for ConnectCustomKeyStoreError { #[allow(unused_variables)] fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result { match *self { ConnectCustomKeyStoreError::CloudHsmClusterInvalidConfiguration(ref cause) => { write!(f, "{}", cause) } ConnectCustomKeyStoreError::CloudHsmClusterNotActive(ref cause) => { write!(f, "{}", cause) } ConnectCustomKeyStoreError::CustomKeyStoreInvalidState(ref cause) => { write!(f, "{}", cause) } ConnectCustomKeyStoreError::CustomKeyStoreNotFound(ref cause) => write!(f, "{}", cause), ConnectCustomKeyStoreError::KMSInternal(ref cause) => write!(f, "{}", cause), } } } impl Error for ConnectCustomKeyStoreError {} /// Errors returned by CreateAlias #[derive(Debug, PartialEq)] pub enum CreateAliasError { /// <p>The request was rejected because it attempted to create a resource that already exists.</p> AlreadyExists(String), /// <p>The system timed out while trying to fulfill the request. The request can be retried.</p> DependencyTimeout(String), /// <p>The request was rejected because the specified alias name is not valid.</p> InvalidAliasName(String), /// <p>The request was rejected because an internal exception occurred. The request can be retried.</p> KMSInternal(String), /// <p>The request was rejected because the state of the specified resource is not valid for this request.</p> <p>For more information about how key state affects the use of a CMK, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">How Key State Affects Use of a Customer Master Key</a> in the <i> <i>AWS Key Management Service Developer Guide</i> </i>.</p> KMSInvalidState(String), /// <p>The request was rejected because a quota was exceeded. For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/limits.html">Quotas</a> in the <i>AWS Key Management Service Developer Guide</i>.</p> LimitExceeded(String), /// <p>The request was rejected because the specified entity or resource could not be found.</p> NotFound(String), } impl CreateAliasError { pub fn from_response(res: BufferedHttpResponse) -> RusotoError<CreateAliasError> { if let Some(err) = proto::json::Error::parse(&res) { match err.typ.as_str() { "AlreadyExistsException" => { return RusotoError::Service(CreateAliasError::AlreadyExists(err.msg)) } "DependencyTimeoutException" => { return RusotoError::Service(CreateAliasError::DependencyTimeout(err.msg)) } "InvalidAliasNameException" => { return RusotoError::Service(CreateAliasError::InvalidAliasName(err.msg)) } "KMSInternalException" => { return RusotoError::Service(CreateAliasError::KMSInternal(err.msg)) } "KMSInvalidStateException" => { return RusotoError::Service(CreateAliasError::KMSInvalidState(err.msg)) } "LimitExceededException" => { return RusotoError::Service(CreateAliasError::LimitExceeded(err.msg)) } "NotFoundException" => { return RusotoError::Service(CreateAliasError::NotFound(err.msg)) } "ValidationException" => return RusotoError::Validation(err.msg), _ => {} } } RusotoError::Unknown(res) } } impl fmt::Display for CreateAliasError { #[allow(unused_variables)] fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result { match *self { CreateAliasError::AlreadyExists(ref cause) => write!(f, "{}", cause), CreateAliasError::DependencyTimeout(ref cause) => write!(f, "{}", cause), CreateAliasError::InvalidAliasName(ref cause) => write!(f, "{}", cause), CreateAliasError::KMSInternal(ref cause) => write!(f, "{}", cause), CreateAliasError::KMSInvalidState(ref cause) => write!(f, "{}", cause), CreateAliasError::LimitExceeded(ref cause) => write!(f, "{}", cause), CreateAliasError::NotFound(ref cause) => write!(f, "{}", cause), } } } impl Error for CreateAliasError {} /// Errors returned by CreateCustomKeyStore #[derive(Debug, PartialEq)] pub enum CreateCustomKeyStoreError { /// <p>The request was rejected because the specified AWS CloudHSM cluster is already associated with a custom key store or it shares a backup history with a cluster that is associated with a custom key store. Each custom key store must be associated with a different AWS CloudHSM cluster.</p> <p>Clusters that share a backup history have the same cluster certificate. To view the cluster certificate of a cluster, use the <a href="https://docs.aws.amazon.com/cloudhsm/latest/APIReference/API_DescribeClusters.html">DescribeClusters</a> operation.</p> CloudHsmClusterInUse(String), /// <p>The request was rejected because the associated AWS CloudHSM cluster did not meet the configuration requirements for a custom key store.</p> <ul> <li> <p>The cluster must be configured with private subnets in at least two different Availability Zones in the Region.</p> </li> <li> <p>The <a href="https://docs.aws.amazon.com/cloudhsm/latest/userguide/configure-sg.html">security group for the cluster</a> (cloudhsm-cluster-<i><cluster-id></i>-sg) must include inbound rules and outbound rules that allow TCP traffic on ports 2223-2225. The <b>Source</b> in the inbound rules and the <b>Destination</b> in the outbound rules must match the security group ID. These rules are set by default when you create the cluster. Do not delete or change them. To get information about a particular security group, use the <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeSecurityGroups.html">DescribeSecurityGroups</a> operation.</p> </li> <li> <p>The cluster must contain at least as many HSMs as the operation requires. To add HSMs, use the AWS CloudHSM <a href="https://docs.aws.amazon.com/cloudhsm/latest/APIReference/API_CreateHsm.html">CreateHsm</a> operation.</p> <p>For the <a>CreateCustomKeyStore</a>, <a>UpdateCustomKeyStore</a>, and <a>CreateKey</a> operations, the AWS CloudHSM cluster must have at least two active HSMs, each in a different Availability Zone. For the <a>ConnectCustomKeyStore</a> operation, the AWS CloudHSM must contain at least one active HSM.</p> </li> </ul> <p>For information about the requirements for an AWS CloudHSM cluster that is associated with a custom key store, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/create-keystore.html#before-keystore">Assemble the Prerequisites</a> in the <i>AWS Key Management Service Developer Guide</i>. For information about creating a private subnet for an AWS CloudHSM cluster, see <a href="https://docs.aws.amazon.com/cloudhsm/latest/userguide/create-subnets.html">Create a Private Subnet</a> in the <i>AWS CloudHSM User Guide</i>. For information about cluster security groups, see <a href="https://docs.aws.amazon.com/cloudhsm/latest/userguide/configure-sg.html">Configure a Default Security Group</a> in the <i> <i>AWS CloudHSM User Guide</i> </i>. </p> CloudHsmClusterInvalidConfiguration(String), /// <p>The request was rejected because the AWS CloudHSM cluster that is associated with the custom key store is not active. Initialize and activate the cluster and try the command again. For detailed instructions, see <a href="https://docs.aws.amazon.com/cloudhsm/latest/userguide/getting-started.html">Getting Started</a> in the <i>AWS CloudHSM User Guide</i>.</p> CloudHsmClusterNotActive(String), /// <p>The request was rejected because AWS KMS cannot find the AWS CloudHSM cluster with the specified cluster ID. Retry the request with a different cluster ID.</p> CloudHsmClusterNotFound(String), /// <p>The request was rejected because the specified custom key store name is already assigned to another custom key store in the account. Try again with a custom key store name that is unique in the account.</p> CustomKeyStoreNameInUse(String), /// <p>The request was rejected because the trust anchor certificate in the request is not the trust anchor certificate for the specified AWS CloudHSM cluster.</p> <p>When you <a href="https://docs.aws.amazon.com/cloudhsm/latest/userguide/initialize-cluster.html#sign-csr">initialize the cluster</a>, you create the trust anchor certificate and save it in the <code>customerCA.crt</code> file.</p> IncorrectTrustAnchor(String), /// <p>The request was rejected because an internal exception occurred. The request can be retried.</p> KMSInternal(String), } impl CreateCustomKeyStoreError { pub fn from_response(res: BufferedHttpResponse) -> RusotoError<CreateCustomKeyStoreError> { if let Some(err) = proto::json::Error::parse(&res) { match err.typ.as_str() { "CloudHsmClusterInUseException" => { return RusotoError::Service(CreateCustomKeyStoreError::CloudHsmClusterInUse( err.msg, )) } "CloudHsmClusterInvalidConfigurationException" => { return RusotoError::Service( CreateCustomKeyStoreError::CloudHsmClusterInvalidConfiguration(err.msg), ) } "CloudHsmClusterNotActiveException" => { return RusotoError::Service( CreateCustomKeyStoreError::CloudHsmClusterNotActive(err.msg), ) } "CloudHsmClusterNotFoundException" => { return RusotoError::Service( CreateCustomKeyStoreError::CloudHsmClusterNotFound(err.msg), ) } "CustomKeyStoreNameInUseException" => { return RusotoError::Service( CreateCustomKeyStoreError::CustomKeyStoreNameInUse(err.msg), ) } "IncorrectTrustAnchorException" => { return RusotoError::Service(CreateCustomKeyStoreError::IncorrectTrustAnchor( err.msg, )) } "KMSInternalException" => { return RusotoError::Service(CreateCustomKeyStoreError::KMSInternal(err.msg)) } "ValidationException" => return RusotoError::Validation(err.msg), _ => {} } } RusotoError::Unknown(res) } } impl fmt::Display for CreateCustomKeyStoreError { #[allow(unused_variables)] fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result { match *self { CreateCustomKeyStoreError::CloudHsmClusterInUse(ref cause) => write!(f, "{}", cause), CreateCustomKeyStoreError::CloudHsmClusterInvalidConfiguration(ref cause) => { write!(f, "{}", cause) } CreateCustomKeyStoreError::CloudHsmClusterNotActive(ref cause) => { write!(f, "{}", cause) } CreateCustomKeyStoreError::CloudHsmClusterNotFound(ref cause) => write!(f, "{}", cause), CreateCustomKeyStoreError::CustomKeyStoreNameInUse(ref cause) => write!(f, "{}", cause), CreateCustomKeyStoreError::IncorrectTrustAnchor(ref cause) => write!(f, "{}", cause), CreateCustomKeyStoreError::KMSInternal(ref cause) => write!(f, "{}", cause), } } } impl Error for CreateCustomKeyStoreError {} /// Errors returned by CreateGrant #[derive(Debug, PartialEq)] pub enum CreateGrantError { /// <p>The system timed out while trying to fulfill the request. The request can be retried.</p> DependencyTimeout(String), /// <p>The request was rejected because the specified CMK is not enabled.</p> Disabled(String), /// <p>The request was rejected because a specified ARN, or an ARN in a key policy, is not valid.</p> InvalidArn(String), /// <p>The request was rejected because the specified grant token is not valid.</p> InvalidGrantToken(String), /// <p>The request was rejected because an internal exception occurred. The request can be retried.</p> KMSInternal(String), /// <p>The request was rejected because the state of the specified resource is not valid for this request.</p> <p>For more information about how key state affects the use of a CMK, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">How Key State Affects Use of a Customer Master Key</a> in the <i> <i>AWS Key Management Service Developer Guide</i> </i>.</p> KMSInvalidState(String), /// <p>The request was rejected because a quota was exceeded. For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/limits.html">Quotas</a> in the <i>AWS Key Management Service Developer Guide</i>.</p> LimitExceeded(String), /// <p>The request was rejected because the specified entity or resource could not be found.</p> NotFound(String), } impl CreateGrantError { pub fn from_response(res: BufferedHttpResponse) -> RusotoError<CreateGrantError> { if let Some(err) = proto::json::Error::parse(&res) { match err.typ.as_str() { "DependencyTimeoutException" => { return RusotoError::Service(CreateGrantError::DependencyTimeout(err.msg)) } "DisabledException" => { return RusotoError::Service(CreateGrantError::Disabled(err.msg)) } "InvalidArnException" => { return RusotoError::Service(CreateGrantError::InvalidArn(err.msg)) } "InvalidGrantTokenException" => { return RusotoError::Service(CreateGrantError::InvalidGrantToken(err.msg)) } "KMSInternalException" => { return RusotoError::Service(CreateGrantError::KMSInternal(err.msg)) } "KMSInvalidStateException" => { return RusotoError::Service(CreateGrantError::KMSInvalidState(err.msg)) } "LimitExceededException" => { return RusotoError::Service(CreateGrantError::LimitExceeded(err.msg)) } "NotFoundException" => { return RusotoError::Service(CreateGrantError::NotFound(err.msg)) } "ValidationException" => return RusotoError::Validation(err.msg), _ => {} } } RusotoError::Unknown(res) } } impl fmt::Display for CreateGrantError { #[allow(unused_variables)] fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result { match *self { CreateGrantError::DependencyTimeout(ref cause) => write!(f, "{}", cause), CreateGrantError::Disabled(ref cause) => write!(f, "{}", cause), CreateGrantError::InvalidArn(ref cause) => write!(f, "{}", cause), CreateGrantError::InvalidGrantToken(ref cause) => write!(f, "{}", cause), CreateGrantError::KMSInternal(ref cause) => write!(f, "{}", cause), CreateGrantError::KMSInvalidState(ref cause) => write!(f, "{}", cause), CreateGrantError::LimitExceeded(ref cause) => write!(f, "{}", cause), CreateGrantError::NotFound(ref cause) => write!(f, "{}", cause), } } } impl Error for CreateGrantError {} /// Errors returned by CreateKey #[derive(Debug, PartialEq)] pub enum CreateKeyError { /// <p>The request was rejected because the associated AWS CloudHSM cluster did not meet the configuration requirements for a custom key store.</p> <ul> <li> <p>The cluster must be configured with private subnets in at least two different Availability Zones in the Region.</p> </li> <li> <p>The <a href="https://docs.aws.amazon.com/cloudhsm/latest/userguide/configure-sg.html">security group for the cluster</a> (cloudhsm-cluster-<i><cluster-id></i>-sg) must include inbound rules and outbound rules that allow TCP traffic on ports 2223-2225. The <b>Source</b> in the inbound rules and the <b>Destination</b> in the outbound rules must match the security group ID. These rules are set by default when you create the cluster. Do not delete or change them. To get information about a particular security group, use the <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeSecurityGroups.html">DescribeSecurityGroups</a> operation.</p> </li> <li> <p>The cluster must contain at least as many HSMs as the operation requires. To add HSMs, use the AWS CloudHSM <a href="https://docs.aws.amazon.com/cloudhsm/latest/APIReference/API_CreateHsm.html">CreateHsm</a> operation.</p> <p>For the <a>CreateCustomKeyStore</a>, <a>UpdateCustomKeyStore</a>, and <a>CreateKey</a> operations, the AWS CloudHSM cluster must have at least two active HSMs, each in a different Availability Zone. For the <a>ConnectCustomKeyStore</a> operation, the AWS CloudHSM must contain at least one active HSM.</p> </li> </ul> <p>For information about the requirements for an AWS CloudHSM cluster that is associated with a custom key store, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/create-keystore.html#before-keystore">Assemble the Prerequisites</a> in the <i>AWS Key Management Service Developer Guide</i>. For information about creating a private subnet for an AWS CloudHSM cluster, see <a href="https://docs.aws.amazon.com/cloudhsm/latest/userguide/create-subnets.html">Create a Private Subnet</a> in the <i>AWS CloudHSM User Guide</i>. For information about cluster security groups, see <a href="https://docs.aws.amazon.com/cloudhsm/latest/userguide/configure-sg.html">Configure a Default Security Group</a> in the <i> <i>AWS CloudHSM User Guide</i> </i>. </p> CloudHsmClusterInvalidConfiguration(String), /// <p><p>The request was rejected because of the <code>ConnectionState</code> of the custom key store. To get the <code>ConnectionState</code> of a custom key store, use the <a>DescribeCustomKeyStores</a> operation.</p> <p>This exception is thrown under the following conditions:</p> <ul> <li> <p>You requested the <a>CreateKey</a> or <a>GenerateRandom</a> operation in a custom key store that is not connected. These operations are valid only when the custom key store <code>ConnectionState</code> is <code>CONNECTED</code>.</p> </li> <li> <p>You requested the <a>UpdateCustomKeyStore</a> or <a>DeleteCustomKeyStore</a> operation on a custom key store that is not disconnected. This operation is valid only when the custom key store <code>ConnectionState</code> is <code>DISCONNECTED</code>.</p> </li> <li> <p>You requested the <a>ConnectCustomKeyStore</a> operation on a custom key store with a <code>ConnectionState</code> of <code>DISCONNECTING</code> or <code>FAILED</code>. This operation is valid for all other <code>ConnectionState</code> values.</p> </li> </ul></p> CustomKeyStoreInvalidState(String), /// <p>The request was rejected because AWS KMS cannot find a custom key store with the specified key store name or ID.</p> CustomKeyStoreNotFound(String), /// <p>The system timed out while trying to fulfill the request. The request can be retried.</p> DependencyTimeout(String), /// <p>The request was rejected because a specified ARN, or an ARN in a key policy, is not valid.</p> InvalidArn(String), /// <p>The request was rejected because an internal exception occurred. The request can be retried.</p> KMSInternal(String), /// <p>The request was rejected because a quota was exceeded. For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/limits.html">Quotas</a> in the <i>AWS Key Management Service Developer Guide</i>.</p> LimitExceeded(String), /// <p>The request was rejected because the specified policy is not syntactically or semantically correct.</p> MalformedPolicyDocument(String), /// <p>The request was rejected because one or more tags are not valid.</p> Tag(String), /// <p>The request was rejected because a specified parameter is not supported or a specified resource is not valid for this operation.</p> UnsupportedOperation(String), } impl CreateKeyError { pub fn from_response(res: BufferedHttpResponse) -> RusotoError<CreateKeyError> { if let Some(err) = proto::json::Error::parse(&res) { match err.typ.as_str() { "CloudHsmClusterInvalidConfigurationException" => { return RusotoError::Service( CreateKeyError::CloudHsmClusterInvalidConfiguration(err.msg), ) } "CustomKeyStoreInvalidStateException" => { return RusotoError::Service(CreateKeyError::CustomKeyStoreInvalidState( err.msg, )) } "CustomKeyStoreNotFoundException" => { return RusotoError::Service(CreateKeyError::CustomKeyStoreNotFound(err.msg)) } "DependencyTimeoutException" => { return RusotoError::Service(CreateKeyError::DependencyTimeout(err.msg)) } "InvalidArnException" => { return RusotoError::Service(CreateKeyError::InvalidArn(err.msg)) } "KMSInternalException" => { return RusotoError::Service(CreateKeyError::KMSInternal(err.msg)) } "LimitExceededException" => { return RusotoError::Service(CreateKeyError::LimitExceeded(err.msg)) } "MalformedPolicyDocumentException" => { return RusotoError::Service(CreateKeyError::MalformedPolicyDocument(err.msg)) } "TagException" => return RusotoError::Service(CreateKeyError::Tag(err.msg)), "UnsupportedOperationException" => { return RusotoError::Service(CreateKeyError::UnsupportedOperation(err.msg)) } "ValidationException" => return RusotoError::Validation(err.msg), _ => {} } } RusotoError::Unknown(res) } } impl fmt::Display for CreateKeyError { #[allow(unused_variables)] fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result { match *self { CreateKeyError::CloudHsmClusterInvalidConfiguration(ref cause) => { write!(f, "{}", cause) } CreateKeyError::CustomKeyStoreInvalidState(ref cause) => write!(f, "{}", cause), CreateKeyError::CustomKeyStoreNotFound(ref cause) => write!(f, "{}", cause), CreateKeyError::DependencyTimeout(ref cause) => write!(f, "{}", cause), CreateKeyError::InvalidArn(ref cause) => write!(f, "{}", cause), CreateKeyError::KMSInternal(ref cause) => write!(f, "{}", cause), CreateKeyError::LimitExceeded(ref cause) => write!(f, "{}", cause), CreateKeyError::MalformedPolicyDocument(ref cause) => write!(f, "{}", cause), CreateKeyError::Tag(ref cause) => write!(f, "{}", cause), CreateKeyError::UnsupportedOperation(ref cause) => write!(f, "{}", cause), } } } impl Error for CreateKeyError {} /// Errors returned by Decrypt #[derive(Debug, PartialEq)] pub enum DecryptError { /// <p>The system timed out while trying to fulfill the request. The request can be retried.</p> DependencyTimeout(String), /// <p>The request was rejected because the specified CMK is not enabled.</p> Disabled(String), /// <p>The request was rejected because the specified CMK cannot decrypt the data. The <code>KeyId</code> in a <a>Decrypt</a> request and the <code>SourceKeyId</code> in a <a>ReEncrypt</a> request must identify the same CMK that was used to encrypt the ciphertext.</p> IncorrectKey(String), /// <p>From the <a>Decrypt</a> or <a>ReEncrypt</a> operation, the request was rejected because the specified ciphertext, or additional authenticated data incorporated into the ciphertext, such as the encryption context, is corrupted, missing, or otherwise invalid.</p> <p>From the <a>ImportKeyMaterial</a> operation, the request was rejected because AWS KMS could not decrypt the encrypted (wrapped) key material. </p> InvalidCiphertext(String), /// <p>The request was rejected because the specified grant token is not valid.</p> InvalidGrantToken(String), /// <p>The request was rejected for one of the following reasons: </p> <ul> <li> <p>The <code>KeyUsage</code> value of the CMK is incompatible with the API operation.</p> </li> <li> <p>The encryption algorithm or signing algorithm specified for the operation is incompatible with the type of key material in the CMK <code>(CustomerMasterKeySpec</code>).</p> </li> </ul> <p>For encrypting, decrypting, re-encrypting, and generating data keys, the <code>KeyUsage</code> must be <code>ENCRYPT_DECRYPT</code>. For signing and verifying, the <code>KeyUsage</code> must be <code>SIGN_VERIFY</code>. To find the <code>KeyUsage</code> of a CMK, use the <a>DescribeKey</a> operation.</p> <p>To find the encryption or signing algorithms supported for a particular CMK, use the <a>DescribeKey</a> operation.</p> InvalidKeyUsage(String), /// <p>The request was rejected because an internal exception occurred. The request can be retried.</p> KMSInternal(String), /// <p>The request was rejected because the state of the specified resource is not valid for this request.</p> <p>For more information about how key state affects the use of a CMK, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">How Key State Affects Use of a Customer Master Key</a> in the <i> <i>AWS Key Management Service Developer Guide</i> </i>.</p> KMSInvalidState(String), /// <p>The request was rejected because the specified CMK was not available. You can retry the request.</p> KeyUnavailable(String), /// <p>The request was rejected because the specified entity or resource could not be found.</p> NotFound(String), } impl DecryptError { pub fn from_response(res: BufferedHttpResponse) -> RusotoError<DecryptError> { if let Some(err) = proto::json::Error::parse(&res) { match err.typ.as_str() { "DependencyTimeoutException" => { return RusotoError::Service(DecryptError::DependencyTimeout(err.msg)) } "DisabledException" => { return RusotoError::Service(DecryptError::Disabled(err.msg)) } "IncorrectKeyException" => { return RusotoError::Service(DecryptError::IncorrectKey(err.msg)) } "InvalidCiphertextException" => { return RusotoError::Service(DecryptError::InvalidCiphertext(err.msg)) } "InvalidGrantTokenException" => { return RusotoError::Service(DecryptError::InvalidGrantToken(err.msg)) } "InvalidKeyUsageException" => { return RusotoError::Service(DecryptError::InvalidKeyUsage(err.msg)) } "KMSInternalException" => { return RusotoError::Service(DecryptError::KMSInternal(err.msg)) } "KMSInvalidStateException" => { return RusotoError::Service(DecryptError::KMSInvalidState(err.msg)) } "KeyUnavailableException" => { return RusotoError::Service(DecryptError::KeyUnavailable(err.msg)) } "NotFoundException" => { return RusotoError::Service(DecryptError::NotFound(err.msg)) } "ValidationException" => return RusotoError::Validation(err.msg), _ => {} } } RusotoError::Unknown(res) } } impl fmt::Display for DecryptError { #[allow(unused_variables)] fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result { match *self { DecryptError::DependencyTimeout(ref cause) => write!(f, "{}", cause), DecryptError::Disabled(ref cause) => write!(f, "{}", cause), DecryptError::IncorrectKey(ref cause) => write!(f, "{}", cause), DecryptError::InvalidCiphertext(ref cause) => write!(f, "{}", cause), DecryptError::InvalidGrantToken(ref cause) => write!(f, "{}", cause), DecryptError::InvalidKeyUsage(ref cause) => write!(f, "{}", cause), DecryptError::KMSInternal(ref cause) => write!(f, "{}", cause), DecryptError::KMSInvalidState(ref cause) => write!(f, "{}", cause), DecryptError::KeyUnavailable(ref cause) => write!(f, "{}", cause), DecryptError::NotFound(ref cause) => write!(f, "{}", cause), } } } impl Error for DecryptError {} /// Errors returned by DeleteAlias #[derive(Debug, PartialEq)] pub enum DeleteAliasError { /// <p>The system timed out while trying to fulfill the request. The request can be retried.</p> DependencyTimeout(String), /// <p>The request was rejected because an internal exception occurred. The request can be retried.</p> KMSInternal(String), /// <p>The request was rejected because the state of the specified resource is not valid for this request.</p> <p>For more information about how key state affects the use of a CMK, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">How Key State Affects Use of a Customer Master Key</a> in the <i> <i>AWS Key Management Service Developer Guide</i> </i>.</p> KMSInvalidState(String), /// <p>The request was rejected because the specified entity or resource could not be found.</p> NotFound(String), } impl DeleteAliasError { pub fn from_response(res: BufferedHttpResponse) -> RusotoError<DeleteAliasError> { if let Some(err) = proto::json::Error::parse(&res) { match err.typ.as_str() { "DependencyTimeoutException" => { return RusotoError::Service(DeleteAliasError::DependencyTimeout(err.msg)) } "KMSInternalException" => { return RusotoError::Service(DeleteAliasError::KMSInternal(err.msg)) } "KMSInvalidStateException" => { return RusotoError::Service(DeleteAliasError::KMSInvalidState(err.msg)) } "NotFoundException" => { return RusotoError::Service(DeleteAliasError::NotFound(err.msg)) } "ValidationException" => return RusotoError::Validation(err.msg), _ => {} } } RusotoError::Unknown(res) } } impl fmt::Display for DeleteAliasError { #[allow(unused_variables)] fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result { match *self { DeleteAliasError::DependencyTimeout(ref cause) => write!(f, "{}", cause), DeleteAliasError::KMSInternal(ref cause) => write!(f, "{}", cause), DeleteAliasError::KMSInvalidState(ref cause) => write!(f, "{}", cause), DeleteAliasError::NotFound(ref cause) => write!(f, "{}", cause), } } } impl Error for DeleteAliasError {} /// Errors returned by DeleteCustomKeyStore #[derive(Debug, PartialEq)] pub enum DeleteCustomKeyStoreError { /// <p>The request was rejected because the custom key store contains AWS KMS customer master keys (CMKs). After verifying that you do not need to use the CMKs, use the <a>ScheduleKeyDeletion</a> operation to delete the CMKs. After they are deleted, you can delete the custom key store.</p> CustomKeyStoreHasCMKs(String), /// <p><p>The request was rejected because of the <code>ConnectionState</code> of the custom key store. To get the <code>ConnectionState</code> of a custom key store, use the <a>DescribeCustomKeyStores</a> operation.</p> <p>This exception is thrown under the following conditions:</p> <ul> <li> <p>You requested the <a>CreateKey</a> or <a>GenerateRandom</a> operation in a custom key store that is not connected. These operations are valid only when the custom key store <code>ConnectionState</code> is <code>CONNECTED</code>.</p> </li> <li> <p>You requested the <a>UpdateCustomKeyStore</a> or <a>DeleteCustomKeyStore</a> operation on a custom key store that is not disconnected. This operation is valid only when the custom key store <code>ConnectionState</code> is <code>DISCONNECTED</code>.</p> </li> <li> <p>You requested the <a>ConnectCustomKeyStore</a> operation on a custom key store with a <code>ConnectionState</code> of <code>DISCONNECTING</code> or <code>FAILED</code>. This operation is valid for all other <code>ConnectionState</code> values.</p> </li> </ul></p> CustomKeyStoreInvalidState(String), /// <p>The request was rejected because AWS KMS cannot find a custom key store with the specified key store name or ID.</p> CustomKeyStoreNotFound(String), /// <p>The request was rejected because an internal exception occurred. The request can be retried.</p> KMSInternal(String), } impl DeleteCustomKeyStoreError { pub fn from_response(res: BufferedHttpResponse) -> RusotoError<DeleteCustomKeyStoreError> { if let Some(err) = proto::json::Error::parse(&res) { match err.typ.as_str() { "CustomKeyStoreHasCMKsException" => { return RusotoError::Service(DeleteCustomKeyStoreError::CustomKeyStoreHasCMKs( err.msg, )) } "CustomKeyStoreInvalidStateException" => { return RusotoError::Service( DeleteCustomKeyStoreError::CustomKeyStoreInvalidState(err.msg), ) } "CustomKeyStoreNotFoundException" => { return RusotoError::Service(DeleteCustomKeyStoreError::CustomKeyStoreNotFound( err.msg, )) } "KMSInternalException" => { return RusotoError::Service(DeleteCustomKeyStoreError::KMSInternal(err.msg)) } "ValidationException" => return RusotoError::Validation(err.msg), _ => {} } } RusotoError::Unknown(res) } } impl fmt::Display for DeleteCustomKeyStoreError { #[allow(unused_variables)] fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result { match *self { DeleteCustomKeyStoreError::CustomKeyStoreHasCMKs(ref cause) => write!(f, "{}", cause), DeleteCustomKeyStoreError::CustomKeyStoreInvalidState(ref cause) => { write!(f, "{}", cause) } DeleteCustomKeyStoreError::CustomKeyStoreNotFound(ref cause) => write!(f, "{}", cause), DeleteCustomKeyStoreError::KMSInternal(ref cause) => write!(f, "{}", cause), } } } impl Error for DeleteCustomKeyStoreError {} /// Errors returned by DeleteImportedKeyMaterial #[derive(Debug, PartialEq)] pub enum DeleteImportedKeyMaterialError { /// <p>The system timed out while trying to fulfill the request. The request can be retried.</p> DependencyTimeout(String), /// <p>The request was rejected because a specified ARN, or an ARN in a key policy, is not valid.</p> InvalidArn(String), /// <p>The request was rejected because an internal exception occurred. The request can be retried.</p> KMSInternal(String), /// <p>The request was rejected because the state of the specified resource is not valid for this request.</p> <p>For more information about how key state affects the use of a CMK, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">How Key State Affects Use of a Customer Master Key</a> in the <i> <i>AWS Key Management Service Developer Guide</i> </i>.</p> KMSInvalidState(String), /// <p>The request was rejected because the specified entity or resource could not be found.</p> NotFound(String), /// <p>The request was rejected because a specified parameter is not supported or a specified resource is not valid for this operation.</p> UnsupportedOperation(String), } impl DeleteImportedKeyMaterialError { pub fn from_response(res: BufferedHttpResponse) -> RusotoError<DeleteImportedKeyMaterialError> { if let Some(err) = proto::json::Error::parse(&res) { match err.typ.as_str() { "DependencyTimeoutException" => { return RusotoError::Service(DeleteImportedKeyMaterialError::DependencyTimeout( err.msg, )) } "InvalidArnException" => { return RusotoError::Service(DeleteImportedKeyMaterialError::InvalidArn( err.msg, )) } "KMSInternalException" => { return RusotoError::Service(DeleteImportedKeyMaterialError::KMSInternal( err.msg, )) } "KMSInvalidStateException" => { return RusotoError::Service(DeleteImportedKeyMaterialError::KMSInvalidState( err.msg, )) } "NotFoundException" => { return RusotoError::Service(DeleteImportedKeyMaterialError::NotFound(err.msg)) } "UnsupportedOperationException" => { return RusotoError::Service( DeleteImportedKeyMaterialError::UnsupportedOperation(err.msg), ) } "ValidationException" => return RusotoError::Validation(err.msg), _ => {} } } RusotoError::Unknown(res) } } impl fmt::Display for DeleteImportedKeyMaterialError { #[allow(unused_variables)] fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result { match *self { DeleteImportedKeyMaterialError::DependencyTimeout(ref cause) => write!(f, "{}", cause), DeleteImportedKeyMaterialError::InvalidArn(ref cause) => write!(f, "{}", cause), DeleteImportedKeyMaterialError::KMSInternal(ref cause) => write!(f, "{}", cause), DeleteImportedKeyMaterialError::KMSInvalidState(ref cause) => write!(f, "{}", cause), DeleteImportedKeyMaterialError::NotFound(ref cause) => write!(f, "{}", cause), DeleteImportedKeyMaterialError::UnsupportedOperation(ref cause) => { write!(f, "{}", cause) } } } } impl Error for DeleteImportedKeyMaterialError {} /// Errors returned by DescribeCustomKeyStores #[derive(Debug, PartialEq)] pub enum DescribeCustomKeyStoresError { /// <p>The request was rejected because AWS KMS cannot find a custom key store with the specified key store name or ID.</p> CustomKeyStoreNotFound(String), /// <p>The request was rejected because an internal exception occurred. The request can be retried.</p> KMSInternal(String), } impl DescribeCustomKeyStoresError { pub fn from_response(res: BufferedHttpResponse) -> RusotoError<DescribeCustomKeyStoresError> { if let Some(err) = proto::json::Error::parse(&res) { match err.typ.as_str() { "CustomKeyStoreNotFoundException" => { return RusotoError::Service( DescribeCustomKeyStoresError::CustomKeyStoreNotFound(err.msg), ) } "KMSInternalException" => { return RusotoError::Service(DescribeCustomKeyStoresError::KMSInternal(err.msg)) } "ValidationException" => return RusotoError::Validation(err.msg), _ => {} } } RusotoError::Unknown(res) } } impl fmt::Display for DescribeCustomKeyStoresError { #[allow(unused_variables)] fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result { match *self { DescribeCustomKeyStoresError::CustomKeyStoreNotFound(ref cause) => { write!(f, "{}", cause) } DescribeCustomKeyStoresError::KMSInternal(ref cause) => write!(f, "{}", cause), } } } impl Error for DescribeCustomKeyStoresError {} /// Errors returned by DescribeKey #[derive(Debug, PartialEq)] pub enum DescribeKeyError { /// <p>The system timed out while trying to fulfill the request. The request can be retried.</p> DependencyTimeout(String), /// <p>The request was rejected because a specified ARN, or an ARN in a key policy, is not valid.</p> InvalidArn(String), /// <p>The request was rejected because an internal exception occurred. The request can be retried.</p> KMSInternal(String), /// <p>The request was rejected because the specified entity or resource could not be found.</p> NotFound(String), } impl DescribeKeyError { pub fn from_response(res: BufferedHttpResponse) -> RusotoError<DescribeKeyError> { if let Some(err) = proto::json::Error::parse(&res) { match err.typ.as_str() { "DependencyTimeoutException" => { return RusotoError::Service(DescribeKeyError::DependencyTimeout(err.msg)) } "InvalidArnException" => { return RusotoError::Service(DescribeKeyError::InvalidArn(err.msg)) } "KMSInternalException" => { return RusotoError::Service(DescribeKeyError::KMSInternal(err.msg)) } "NotFoundException" => { return RusotoError::Service(DescribeKeyError::NotFound(err.msg)) } "ValidationException" => return RusotoError::Validation(err.msg), _ => {} } } RusotoError::Unknown(res) } } impl fmt::Display for DescribeKeyError { #[allow(unused_variables)] fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result { match *self { DescribeKeyError::DependencyTimeout(ref cause) => write!(f, "{}", cause), DescribeKeyError::InvalidArn(ref cause) => write!(f, "{}", cause), DescribeKeyError::KMSInternal(ref cause) => write!(f, "{}", cause), DescribeKeyError::NotFound(ref cause) => write!(f, "{}", cause), } } } impl Error for DescribeKeyError {} /// Errors returned by DisableKey #[derive(Debug, PartialEq)] pub enum DisableKeyError { /// <p>The system timed out while trying to fulfill the request. The request can be retried.</p> DependencyTimeout(String), /// <p>The request was rejected because a specified ARN, or an ARN in a key policy, is not valid.</p> InvalidArn(String), /// <p>The request was rejected because an internal exception occurred. The request can be retried.</p> KMSInternal(String), /// <p>The request was rejected because the state of the specified resource is not valid for this request.</p> <p>For more information about how key state affects the use of a CMK, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">How Key State Affects Use of a Customer Master Key</a> in the <i> <i>AWS Key Management Service Developer Guide</i> </i>.</p> KMSInvalidState(String), /// <p>The request was rejected because the specified entity or resource could not be found.</p> NotFound(String), } impl DisableKeyError { pub fn from_response(res: BufferedHttpResponse) -> RusotoError<DisableKeyError> { if let Some(err) = proto::json::Error::parse(&res) { match err.typ.as_str() { "DependencyTimeoutException" => { return RusotoError::Service(DisableKeyError::DependencyTimeout(err.msg)) } "InvalidArnException" => { return RusotoError::Service(DisableKeyError::InvalidArn(err.msg)) } "KMSInternalException" => { return RusotoError::Service(DisableKeyError::KMSInternal(err.msg)) } "KMSInvalidStateException" => { return RusotoError::Service(DisableKeyError::KMSInvalidState(err.msg)) } "NotFoundException" => { return RusotoError::Service(DisableKeyError::NotFound(err.msg)) } "ValidationException" => return RusotoError::Validation(err.msg), _ => {} } } RusotoError::Unknown(res) } } impl fmt::Display for DisableKeyError { #[allow(unused_variables)] fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result { match *self { DisableKeyError::DependencyTimeout(ref cause) => write!(f, "{}", cause), DisableKeyError::InvalidArn(ref cause) => write!(f, "{}", cause), DisableKeyError::KMSInternal(ref cause) => write!(f, "{}", cause), DisableKeyError::KMSInvalidState(ref cause) => write!(f, "{}", cause), DisableKeyError::NotFound(ref cause) => write!(f, "{}", cause), } } } impl Error for DisableKeyError {} /// Errors returned by DisableKeyRotation #[derive(Debug, PartialEq)] pub enum DisableKeyRotationError { /// <p>The system timed out while trying to fulfill the request. The request can be retried.</p> DependencyTimeout(String), /// <p>The request was rejected because the specified CMK is not enabled.</p> Disabled(String), /// <p>The request was rejected because a specified ARN, or an ARN in a key policy, is not valid.</p> InvalidArn(String), /// <p>The request was rejected because an internal exception occurred. The request can be retried.</p> KMSInternal(String), /// <p>The request was rejected because the state of the specified resource is not valid for this request.</p> <p>For more information about how key state affects the use of a CMK, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">How Key State Affects Use of a Customer Master Key</a> in the <i> <i>AWS Key Management Service Developer Guide</i> </i>.</p> KMSInvalidState(String), /// <p>The request was rejected because the specified entity or resource could not be found.</p> NotFound(String), /// <p>The request was rejected because a specified parameter is not supported or a specified resource is not valid for this operation.</p> UnsupportedOperation(String), } impl DisableKeyRotationError { pub fn from_response(res: BufferedHttpResponse) -> RusotoError<DisableKeyRotationError> { if let Some(err) = proto::json::Error::parse(&res) { match err.typ.as_str() { "DependencyTimeoutException" => { return RusotoError::Service(DisableKeyRotationError::DependencyTimeout( err.msg, )) } "DisabledException" => { return RusotoError::Service(DisableKeyRotationError::Disabled(err.msg)) } "InvalidArnException" => { return RusotoError::Service(DisableKeyRotationError::InvalidArn(err.msg)) } "KMSInternalException" => { return RusotoError::Service(DisableKeyRotationError::KMSInternal(err.msg)) } "KMSInvalidStateException" => { return RusotoError::Service(DisableKeyRotationError::KMSInvalidState(err.msg)) } "NotFoundException" => { return RusotoError::Service(DisableKeyRotationError::NotFound(err.msg)) } "UnsupportedOperationException" => { return RusotoError::Service(DisableKeyRotationError::UnsupportedOperation( err.msg, )) } "ValidationException" => return RusotoError::Validation(err.msg), _ => {} } } RusotoError::Unknown(res) } } impl fmt::Display for DisableKeyRotationError { #[allow(unused_variables)] fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result { match *self { DisableKeyRotationError::DependencyTimeout(ref cause) => write!(f, "{}", cause), DisableKeyRotationError::Disabled(ref cause) => write!(f, "{}", cause), DisableKeyRotationError::InvalidArn(ref cause) => write!(f, "{}", cause), DisableKeyRotationError::KMSInternal(ref cause) => write!(f, "{}", cause), DisableKeyRotationError::KMSInvalidState(ref cause) => write!(f, "{}", cause), DisableKeyRotationError::NotFound(ref cause) => write!(f, "{}", cause), DisableKeyRotationError::UnsupportedOperation(ref cause) => write!(f, "{}", cause), } } } impl Error for DisableKeyRotationError {} /// Errors returned by DisconnectCustomKeyStore #[derive(Debug, PartialEq)] pub enum DisconnectCustomKeyStoreError { /// <p><p>The request was rejected because of the <code>ConnectionState</code> of the custom key store. To get the <code>ConnectionState</code> of a custom key store, use the <a>DescribeCustomKeyStores</a> operation.</p> <p>This exception is thrown under the following conditions:</p> <ul> <li> <p>You requested the <a>CreateKey</a> or <a>GenerateRandom</a> operation in a custom key store that is not connected. These operations are valid only when the custom key store <code>ConnectionState</code> is <code>CONNECTED</code>.</p> </li> <li> <p>You requested the <a>UpdateCustomKeyStore</a> or <a>DeleteCustomKeyStore</a> operation on a custom key store that is not disconnected. This operation is valid only when the custom key store <code>ConnectionState</code> is <code>DISCONNECTED</code>.</p> </li> <li> <p>You requested the <a>ConnectCustomKeyStore</a> operation on a custom key store with a <code>ConnectionState</code> of <code>DISCONNECTING</code> or <code>FAILED</code>. This operation is valid for all other <code>ConnectionState</code> values.</p> </li> </ul></p> CustomKeyStoreInvalidState(String), /// <p>The request was rejected because AWS KMS cannot find a custom key store with the specified key store name or ID.</p> CustomKeyStoreNotFound(String), /// <p>The request was rejected because an internal exception occurred. The request can be retried.</p> KMSInternal(String), } impl DisconnectCustomKeyStoreError { pub fn from_response(res: BufferedHttpResponse) -> RusotoError<DisconnectCustomKeyStoreError> { if let Some(err) = proto::json::Error::parse(&res) { match err.typ.as_str() { "CustomKeyStoreInvalidStateException" => { return RusotoError::Service( DisconnectCustomKeyStoreError::CustomKeyStoreInvalidState(err.msg), ) } "CustomKeyStoreNotFoundException" => { return RusotoError::Service( DisconnectCustomKeyStoreError::CustomKeyStoreNotFound(err.msg), ) } "KMSInternalException" => { return RusotoError::Service(DisconnectCustomKeyStoreError::KMSInternal( err.msg, )) } "ValidationException" => return RusotoError::Validation(err.msg), _ => {} } } RusotoError::Unknown(res) } } impl fmt::Display for DisconnectCustomKeyStoreError { #[allow(unused_variables)] fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result { match *self { DisconnectCustomKeyStoreError::CustomKeyStoreInvalidState(ref cause) => { write!(f, "{}", cause) } DisconnectCustomKeyStoreError::CustomKeyStoreNotFound(ref cause) => { write!(f, "{}", cause) } DisconnectCustomKeyStoreError::KMSInternal(ref cause) => write!(f, "{}", cause), } } } impl Error for DisconnectCustomKeyStoreError {} /// Errors returned by EnableKey #[derive(Debug, PartialEq)] pub enum EnableKeyError { /// <p>The system timed out while trying to fulfill the request. The request can be retried.</p> DependencyTimeout(String), /// <p>The request was rejected because a specified ARN, or an ARN in a key policy, is not valid.</p> InvalidArn(String), /// <p>The request was rejected because an internal exception occurred. The request can be retried.</p> KMSInternal(String), /// <p>The request was rejected because the state of the specified resource is not valid for this request.</p> <p>For more information about how key state affects the use of a CMK, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">How Key State Affects Use of a Customer Master Key</a> in the <i> <i>AWS Key Management Service Developer Guide</i> </i>.</p> KMSInvalidState(String), /// <p>The request was rejected because a quota was exceeded. For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/limits.html">Quotas</a> in the <i>AWS Key Management Service Developer Guide</i>.</p> LimitExceeded(String), /// <p>The request was rejected because the specified entity or resource could not be found.</p> NotFound(String), } impl EnableKeyError { pub fn from_response(res: BufferedHttpResponse) -> RusotoError<EnableKeyError> { if let Some(err) = proto::json::Error::parse(&res) { match err.typ.as_str() { "DependencyTimeoutException" => { return RusotoError::Service(EnableKeyError::DependencyTimeout(err.msg)) } "InvalidArnException" => { return RusotoError::Service(EnableKeyError::InvalidArn(err.msg)) } "KMSInternalException" => { return RusotoError::Service(EnableKeyError::KMSInternal(err.msg)) } "KMSInvalidStateException" => { return RusotoError::Service(EnableKeyError::KMSInvalidState(err.msg)) } "LimitExceededException" => { return RusotoError::Service(EnableKeyError::LimitExceeded(err.msg)) } "NotFoundException" => { return RusotoError::Service(EnableKeyError::NotFound(err.msg)) } "ValidationException" => return RusotoError::Validation(err.msg), _ => {} } } RusotoError::Unknown(res) } } impl fmt::Display for EnableKeyError { #[allow(unused_variables)] fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result { match *self { EnableKeyError::DependencyTimeout(ref cause) => write!(f, "{}", cause), EnableKeyError::InvalidArn(ref cause) => write!(f, "{}", cause), EnableKeyError::KMSInternal(ref cause) => write!(f, "{}", cause), EnableKeyError::KMSInvalidState(ref cause) => write!(f, "{}", cause), EnableKeyError::LimitExceeded(ref cause) => write!(f, "{}", cause), EnableKeyError::NotFound(ref cause) => write!(f, "{}", cause), } } } impl Error for EnableKeyError {} /// Errors returned by EnableKeyRotation #[derive(Debug, PartialEq)] pub enum EnableKeyRotationError { /// <p>The system timed out while trying to fulfill the request. The request can be retried.</p> DependencyTimeout(String), /// <p>The request was rejected because the specified CMK is not enabled.</p> Disabled(String), /// <p>The request was rejected because a specified ARN, or an ARN in a key policy, is not valid.</p> InvalidArn(String), /// <p>The request was rejected because an internal exception occurred. The request can be retried.</p> KMSInternal(String), /// <p>The request was rejected because the state of the specified resource is not valid for this request.</p> <p>For more information about how key state affects the use of a CMK, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">How Key State Affects Use of a Customer Master Key</a> in the <i> <i>AWS Key Management Service Developer Guide</i> </i>.</p> KMSInvalidState(String), /// <p>The request was rejected because the specified entity or resource could not be found.</p> NotFound(String), /// <p>The request was rejected because a specified parameter is not supported or a specified resource is not valid for this operation.</p> UnsupportedOperation(String), } impl EnableKeyRotationError { pub fn from_response(res: BufferedHttpResponse) -> RusotoError<EnableKeyRotationError> { if let Some(err) = proto::json::Error::parse(&res) { match err.typ.as_str() { "DependencyTimeoutException" => { return RusotoError::Service(EnableKeyRotationError::DependencyTimeout(err.msg)) } "DisabledException" => { return RusotoError::Service(EnableKeyRotationError::Disabled(err.msg)) } "InvalidArnException" => { return RusotoError::Service(EnableKeyRotationError::InvalidArn(err.msg)) } "KMSInternalException" => { return RusotoError::Service(EnableKeyRotationError::KMSInternal(err.msg)) } "KMSInvalidStateException" => { return RusotoError::Service(EnableKeyRotationError::KMSInvalidState(err.msg)) } "NotFoundException" => { return RusotoError::Service(EnableKeyRotationError::NotFound(err.msg)) } "UnsupportedOperationException" => { return RusotoError::Service(EnableKeyRotationError::UnsupportedOperation( err.msg, )) } "ValidationException" => return RusotoError::Validation(err.msg), _ => {} } } RusotoError::Unknown(res) } } impl fmt::Display for EnableKeyRotationError { #[allow(unused_variables)] fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result { match *self { EnableKeyRotationError::DependencyTimeout(ref cause) => write!(f, "{}", cause), EnableKeyRotationError::Disabled(ref cause) => write!(f, "{}", cause), EnableKeyRotationError::InvalidArn(ref cause) => write!(f, "{}", cause), EnableKeyRotationError::KMSInternal(ref cause) => write!(f, "{}", cause), EnableKeyRotationError::KMSInvalidState(ref cause) => write!(f, "{}", cause), EnableKeyRotationError::NotFound(ref cause) => write!(f, "{}", cause), EnableKeyRotationError::UnsupportedOperation(ref cause) => write!(f, "{}", cause), } } } impl Error for EnableKeyRotationError {} /// Errors returned by Encrypt #[derive(Debug, PartialEq)] pub enum EncryptError { /// <p>The system timed out while trying to fulfill the request. The request can be retried.</p> DependencyTimeout(String), /// <p>The request was rejected because the specified CMK is not enabled.</p> Disabled(String), /// <p>The request was rejected because the specified grant token is not valid.</p> InvalidGrantToken(String), /// <p>The request was rejected for one of the following reasons: </p> <ul> <li> <p>The <code>KeyUsage</code> value of the CMK is incompatible with the API operation.</p> </li> <li> <p>The encryption algorithm or signing algorithm specified for the operation is incompatible with the type of key material in the CMK <code>(CustomerMasterKeySpec</code>).</p> </li> </ul> <p>For encrypting, decrypting, re-encrypting, and generating data keys, the <code>KeyUsage</code> must be <code>ENCRYPT_DECRYPT</code>. For signing and verifying, the <code>KeyUsage</code> must be <code>SIGN_VERIFY</code>. To find the <code>KeyUsage</code> of a CMK, use the <a>DescribeKey</a> operation.</p> <p>To find the encryption or signing algorithms supported for a particular CMK, use the <a>DescribeKey</a> operation.</p> InvalidKeyUsage(String), /// <p>The request was rejected because an internal exception occurred. The request can be retried.</p> KMSInternal(String), /// <p>The request was rejected because the state of the specified resource is not valid for this request.</p> <p>For more information about how key state affects the use of a CMK, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">How Key State Affects Use of a Customer Master Key</a> in the <i> <i>AWS Key Management Service Developer Guide</i> </i>.</p> KMSInvalidState(String), /// <p>The request was rejected because the specified CMK was not available. You can retry the request.</p> KeyUnavailable(String), /// <p>The request was rejected because the specified entity or resource could not be found.</p> NotFound(String), } impl EncryptError { pub fn from_response(res: BufferedHttpResponse) -> RusotoError<EncryptError> { if let Some(err) = proto::json::Error::parse(&res) { match err.typ.as_str() { "DependencyTimeoutException" => { return RusotoError::Service(EncryptError::DependencyTimeout(err.msg)) } "DisabledException" => { return RusotoError::Service(EncryptError::Disabled(err.msg)) } "InvalidGrantTokenException" => { return RusotoError::Service(EncryptError::InvalidGrantToken(err.msg)) } "InvalidKeyUsageException" => { return RusotoError::Service(EncryptError::InvalidKeyUsage(err.msg)) } "KMSInternalException" => { return RusotoError::Service(EncryptError::KMSInternal(err.msg)) } "KMSInvalidStateException" => { return RusotoError::Service(EncryptError::KMSInvalidState(err.msg)) } "KeyUnavailableException" => { return RusotoError::Service(EncryptError::KeyUnavailable(err.msg)) } "NotFoundException" => { return RusotoError::Service(EncryptError::NotFound(err.msg)) } "ValidationException" => return RusotoError::Validation(err.msg), _ => {} } } RusotoError::Unknown(res) } } impl fmt::Display for EncryptError { #[allow(unused_variables)] fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result { match *self { EncryptError::DependencyTimeout(ref cause) => write!(f, "{}", cause), EncryptError::Disabled(ref cause) => write!(f, "{}", cause), EncryptError::InvalidGrantToken(ref cause) => write!(f, "{}", cause), EncryptError::InvalidKeyUsage(ref cause) => write!(f, "{}", cause), EncryptError::KMSInternal(ref cause) => write!(f, "{}", cause), EncryptError::KMSInvalidState(ref cause) => write!(f, "{}", cause), EncryptError::KeyUnavailable(ref cause) => write!(f, "{}", cause), EncryptError::NotFound(ref cause) => write!(f, "{}", cause), } } } impl Error for EncryptError {} /// Errors returned by GenerateDataKey #[derive(Debug, PartialEq)] pub enum GenerateDataKeyError { /// <p>The system timed out while trying to fulfill the request. The request can be retried.</p> DependencyTimeout(String), /// <p>The request was rejected because the specified CMK is not enabled.</p> Disabled(String), /// <p>The request was rejected because the specified grant token is not valid.</p> InvalidGrantToken(String), /// <p>The request was rejected for one of the following reasons: </p> <ul> <li> <p>The <code>KeyUsage</code> value of the CMK is incompatible with the API operation.</p> </li> <li> <p>The encryption algorithm or signing algorithm specified for the operation is incompatible with the type of key material in the CMK <code>(CustomerMasterKeySpec</code>).</p> </li> </ul> <p>For encrypting, decrypting, re-encrypting, and generating data keys, the <code>KeyUsage</code> must be <code>ENCRYPT_DECRYPT</code>. For signing and verifying, the <code>KeyUsage</code> must be <code>SIGN_VERIFY</code>. To find the <code>KeyUsage</code> of a CMK, use the <a>DescribeKey</a> operation.</p> <p>To find the encryption or signing algorithms supported for a particular CMK, use the <a>DescribeKey</a> operation.</p> InvalidKeyUsage(String), /// <p>The request was rejected because an internal exception occurred. The request can be retried.</p> KMSInternal(String), /// <p>The request was rejected because the state of the specified resource is not valid for this request.</p> <p>For more information about how key state affects the use of a CMK, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">How Key State Affects Use of a Customer Master Key</a> in the <i> <i>AWS Key Management Service Developer Guide</i> </i>.</p> KMSInvalidState(String), /// <p>The request was rejected because the specified CMK was not available. You can retry the request.</p> KeyUnavailable(String), /// <p>The request was rejected because the specified entity or resource could not be found.</p> NotFound(String), } impl GenerateDataKeyError { pub fn from_response(res: BufferedHttpResponse) -> RusotoError<GenerateDataKeyError> { if let Some(err) = proto::json::Error::parse(&res) { match err.typ.as_str() { "DependencyTimeoutException" => { return RusotoError::Service(GenerateDataKeyError::DependencyTimeout(err.msg)) } "DisabledException" => { return RusotoError::Service(GenerateDataKeyError::Disabled(err.msg)) } "InvalidGrantTokenException" => { return RusotoError::Service(GenerateDataKeyError::InvalidGrantToken(err.msg)) } "InvalidKeyUsageException" => { return RusotoError::Service(GenerateDataKeyError::InvalidKeyUsage(err.msg)) } "KMSInternalException" => { return RusotoError::Service(GenerateDataKeyError::KMSInternal(err.msg)) } "KMSInvalidStateException" => { return RusotoError::Service(GenerateDataKeyError::KMSInvalidState(err.msg)) } "KeyUnavailableException" => { return RusotoError::Service(GenerateDataKeyError::KeyUnavailable(err.msg)) } "NotFoundException" => { return RusotoError::Service(GenerateDataKeyError::NotFound(err.msg)) } "ValidationException" => return RusotoError::Validation(err.msg), _ => {} } } RusotoError::Unknown(res) } } impl fmt::Display for GenerateDataKeyError { #[allow(unused_variables)] fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result { match *self { GenerateDataKeyError::DependencyTimeout(ref cause) => write!(f, "{}", cause), GenerateDataKeyError::Disabled(ref cause) => write!(f, "{}", cause), GenerateDataKeyError::InvalidGrantToken(ref cause) => write!(f, "{}", cause), GenerateDataKeyError::InvalidKeyUsage(ref cause) => write!(f, "{}", cause), GenerateDataKeyError::KMSInternal(ref cause) => write!(f, "{}", cause), GenerateDataKeyError::KMSInvalidState(ref cause) => write!(f, "{}", cause), GenerateDataKeyError::KeyUnavailable(ref cause) => write!(f, "{}", cause), GenerateDataKeyError::NotFound(ref cause) => write!(f, "{}", cause), } } } impl Error for GenerateDataKeyError {} /// Errors returned by GenerateDataKeyPair #[derive(Debug, PartialEq)] pub enum GenerateDataKeyPairError { /// <p>The system timed out while trying to fulfill the request. The request can be retried.</p> DependencyTimeout(String), /// <p>The request was rejected because the specified CMK is not enabled.</p> Disabled(String), /// <p>The request was rejected because the specified grant token is not valid.</p> InvalidGrantToken(String), /// <p>The request was rejected for one of the following reasons: </p> <ul> <li> <p>The <code>KeyUsage</code> value of the CMK is incompatible with the API operation.</p> </li> <li> <p>The encryption algorithm or signing algorithm specified for the operation is incompatible with the type of key material in the CMK <code>(CustomerMasterKeySpec</code>).</p> </li> </ul> <p>For encrypting, decrypting, re-encrypting, and generating data keys, the <code>KeyUsage</code> must be <code>ENCRYPT_DECRYPT</code>. For signing and verifying, the <code>KeyUsage</code> must be <code>SIGN_VERIFY</code>. To find the <code>KeyUsage</code> of a CMK, use the <a>DescribeKey</a> operation.</p> <p>To find the encryption or signing algorithms supported for a particular CMK, use the <a>DescribeKey</a> operation.</p> InvalidKeyUsage(String), /// <p>The request was rejected because an internal exception occurred. The request can be retried.</p> KMSInternal(String), /// <p>The request was rejected because the state of the specified resource is not valid for this request.</p> <p>For more information about how key state affects the use of a CMK, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">How Key State Affects Use of a Customer Master Key</a> in the <i> <i>AWS Key Management Service Developer Guide</i> </i>.</p> KMSInvalidState(String), /// <p>The request was rejected because the specified CMK was not available. You can retry the request.</p> KeyUnavailable(String), /// <p>The request was rejected because the specified entity or resource could not be found.</p> NotFound(String), /// <p>The request was rejected because a specified parameter is not supported or a specified resource is not valid for this operation.</p> UnsupportedOperation(String), } impl GenerateDataKeyPairError { pub fn from_response(res: BufferedHttpResponse) -> RusotoError<GenerateDataKeyPairError> { if let Some(err) = proto::json::Error::parse(&res) { match err.typ.as_str() { "DependencyTimeoutException" => { return RusotoError::Service(GenerateDataKeyPairError::DependencyTimeout( err.msg, )) } "DisabledException" => { return RusotoError::Service(GenerateDataKeyPairError::Disabled(err.msg)) } "InvalidGrantTokenException" => { return RusotoError::Service(GenerateDataKeyPairError::InvalidGrantToken( err.msg, )) } "InvalidKeyUsageException" => { return RusotoError::Service(GenerateDataKeyPairError::InvalidKeyUsage(err.msg)) } "KMSInternalException" => { return RusotoError::Service(GenerateDataKeyPairError::KMSInternal(err.msg)) } "KMSInvalidStateException" => { return RusotoError::Service(GenerateDataKeyPairError::KMSInvalidState(err.msg)) } "KeyUnavailableException" => { return RusotoError::Service(GenerateDataKeyPairError::KeyUnavailable(err.msg)) } "NotFoundException" => { return RusotoError::Service(GenerateDataKeyPairError::NotFound(err.msg)) } "UnsupportedOperationException" => { return RusotoError::Service(GenerateDataKeyPairError::UnsupportedOperation( err.msg, )) } "ValidationException" => return RusotoError::Validation(err.msg), _ => {} } } RusotoError::Unknown(res) } } impl fmt::Display for GenerateDataKeyPairError { #[allow(unused_variables)] fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result { match *self { GenerateDataKeyPairError::DependencyTimeout(ref cause) => write!(f, "{}", cause), GenerateDataKeyPairError::Disabled(ref cause) => write!(f, "{}", cause), GenerateDataKeyPairError::InvalidGrantToken(ref cause) => write!(f, "{}", cause), GenerateDataKeyPairError::InvalidKeyUsage(ref cause) => write!(f, "{}", cause), GenerateDataKeyPairError::KMSInternal(ref cause) => write!(f, "{}", cause), GenerateDataKeyPairError::KMSInvalidState(ref cause) => write!(f, "{}", cause), GenerateDataKeyPairError::KeyUnavailable(ref cause) => write!(f, "{}", cause), GenerateDataKeyPairError::NotFound(ref cause) => write!(f, "{}", cause), GenerateDataKeyPairError::UnsupportedOperation(ref cause) => write!(f, "{}", cause), } } } impl Error for GenerateDataKeyPairError {} /// Errors returned by GenerateDataKeyPairWithoutPlaintext #[derive(Debug, PartialEq)] pub enum GenerateDataKeyPairWithoutPlaintextError { /// <p>The system timed out while trying to fulfill the request. The request can be retried.</p> DependencyTimeout(String), /// <p>The request was rejected because the specified CMK is not enabled.</p> Disabled(String), /// <p>The request was rejected because the specified grant token is not valid.</p> InvalidGrantToken(String), /// <p>The request was rejected for one of the following reasons: </p> <ul> <li> <p>The <code>KeyUsage</code> value of the CMK is incompatible with the API operation.</p> </li> <li> <p>The encryption algorithm or signing algorithm specified for the operation is incompatible with the type of key material in the CMK <code>(CustomerMasterKeySpec</code>).</p> </li> </ul> <p>For encrypting, decrypting, re-encrypting, and generating data keys, the <code>KeyUsage</code> must be <code>ENCRYPT_DECRYPT</code>. For signing and verifying, the <code>KeyUsage</code> must be <code>SIGN_VERIFY</code>. To find the <code>KeyUsage</code> of a CMK, use the <a>DescribeKey</a> operation.</p> <p>To find the encryption or signing algorithms supported for a particular CMK, use the <a>DescribeKey</a> operation.</p> InvalidKeyUsage(String), /// <p>The request was rejected because an internal exception occurred. The request can be retried.</p> KMSInternal(String), /// <p>The request was rejected because the state of the specified resource is not valid for this request.</p> <p>For more information about how key state affects the use of a CMK, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">How Key State Affects Use of a Customer Master Key</a> in the <i> <i>AWS Key Management Service Developer Guide</i> </i>.</p> KMSInvalidState(String), /// <p>The request was rejected because the specified CMK was not available. You can retry the request.</p> KeyUnavailable(String), /// <p>The request was rejected because the specified entity or resource could not be found.</p> NotFound(String), /// <p>The request was rejected because a specified parameter is not supported or a specified resource is not valid for this operation.</p> UnsupportedOperation(String), } impl GenerateDataKeyPairWithoutPlaintextError { pub fn from_response( res: BufferedHttpResponse, ) -> RusotoError<GenerateDataKeyPairWithoutPlaintextError> { if let Some(err) = proto::json::Error::parse(&res) { match err.typ.as_str() { "DependencyTimeoutException" => { return RusotoError::Service( GenerateDataKeyPairWithoutPlaintextError::DependencyTimeout(err.msg), ) } "DisabledException" => { return RusotoError::Service( GenerateDataKeyPairWithoutPlaintextError::Disabled(err.msg), ) } "InvalidGrantTokenException" => { return RusotoError::Service( GenerateDataKeyPairWithoutPlaintextError::InvalidGrantToken(err.msg), ) } "InvalidKeyUsageException" => { return RusotoError::Service( GenerateDataKeyPairWithoutPlaintextError::InvalidKeyUsage(err.msg), ) } "KMSInternalException" => { return RusotoError::Service( GenerateDataKeyPairWithoutPlaintextError::KMSInternal(err.msg), ) } "KMSInvalidStateException" => { return RusotoError::Service( GenerateDataKeyPairWithoutPlaintextError::KMSInvalidState(err.msg), ) } "KeyUnavailableException" => { return RusotoError::Service( GenerateDataKeyPairWithoutPlaintextError::KeyUnavailable(err.msg), ) } "NotFoundException" => { return RusotoError::Service( GenerateDataKeyPairWithoutPlaintextError::NotFound(err.msg), ) } "UnsupportedOperationException" => { return RusotoError::Service( GenerateDataKeyPairWithoutPlaintextError::UnsupportedOperation(err.msg), ) } "ValidationException" => return RusotoError::Validation(err.msg), _ => {} } } RusotoError::Unknown(res) } } impl fmt::Display for GenerateDataKeyPairWithoutPlaintextError { #[allow(unused_variables)] fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result { match *self { GenerateDataKeyPairWithoutPlaintextError::DependencyTimeout(ref cause) => { write!(f, "{}", cause) } GenerateDataKeyPairWithoutPlaintextError::Disabled(ref cause) => write!(f, "{}", cause), GenerateDataKeyPairWithoutPlaintextError::InvalidGrantToken(ref cause) => { write!(f, "{}", cause) } GenerateDataKeyPairWithoutPlaintextError::InvalidKeyUsage(ref cause) => { write!(f, "{}", cause) } GenerateDataKeyPairWithoutPlaintextError::KMSInternal(ref cause) => { write!(f, "{}", cause) } GenerateDataKeyPairWithoutPlaintextError::KMSInvalidState(ref cause) => { write!(f, "{}", cause) } GenerateDataKeyPairWithoutPlaintextError::KeyUnavailable(ref cause) => { write!(f, "{}", cause) } GenerateDataKeyPairWithoutPlaintextError::NotFound(ref cause) => write!(f, "{}", cause), GenerateDataKeyPairWithoutPlaintextError::UnsupportedOperation(ref cause) => { write!(f, "{}", cause) } } } } impl Error for GenerateDataKeyPairWithoutPlaintextError {} /// Errors returned by GenerateDataKeyWithoutPlaintext #[derive(Debug, PartialEq)] pub enum GenerateDataKeyWithoutPlaintextError { /// <p>The system timed out while trying to fulfill the request. The request can be retried.</p> DependencyTimeout(String), /// <p>The request was rejected because the specified CMK is not enabled.</p> Disabled(String), /// <p>The request was rejected because the specified grant token is not valid.</p> InvalidGrantToken(String), /// <p>The request was rejected for one of the following reasons: </p> <ul> <li> <p>The <code>KeyUsage</code> value of the CMK is incompatible with the API operation.</p> </li> <li> <p>The encryption algorithm or signing algorithm specified for the operation is incompatible with the type of key material in the CMK <code>(CustomerMasterKeySpec</code>).</p> </li> </ul> <p>For encrypting, decrypting, re-encrypting, and generating data keys, the <code>KeyUsage</code> must be <code>ENCRYPT_DECRYPT</code>. For signing and verifying, the <code>KeyUsage</code> must be <code>SIGN_VERIFY</code>. To find the <code>KeyUsage</code> of a CMK, use the <a>DescribeKey</a> operation.</p> <p>To find the encryption or signing algorithms supported for a particular CMK, use the <a>DescribeKey</a> operation.</p> InvalidKeyUsage(String), /// <p>The request was rejected because an internal exception occurred. The request can be retried.</p> KMSInternal(String), /// <p>The request was rejected because the state of the specified resource is not valid for this request.</p> <p>For more information about how key state affects the use of a CMK, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">How Key State Affects Use of a Customer Master Key</a> in the <i> <i>AWS Key Management Service Developer Guide</i> </i>.</p> KMSInvalidState(String), /// <p>The request was rejected because the specified CMK was not available. You can retry the request.</p> KeyUnavailable(String), /// <p>The request was rejected because the specified entity or resource could not be found.</p> NotFound(String), } impl GenerateDataKeyWithoutPlaintextError { pub fn from_response( res: BufferedHttpResponse, ) -> RusotoError<GenerateDataKeyWithoutPlaintextError> { if let Some(err) = proto::json::Error::parse(&res) { match err.typ.as_str() { "DependencyTimeoutException" => { return RusotoError::Service( GenerateDataKeyWithoutPlaintextError::DependencyTimeout(err.msg), ) } "DisabledException" => { return RusotoError::Service(GenerateDataKeyWithoutPlaintextError::Disabled( err.msg, )) } "InvalidGrantTokenException" => { return RusotoError::Service( GenerateDataKeyWithoutPlaintextError::InvalidGrantToken(err.msg), ) } "InvalidKeyUsageException" => { return RusotoError::Service( GenerateDataKeyWithoutPlaintextError::InvalidKeyUsage(err.msg), ) } "KMSInternalException" => { return RusotoError::Service(GenerateDataKeyWithoutPlaintextError::KMSInternal( err.msg, )) } "KMSInvalidStateException" => { return RusotoError::Service( GenerateDataKeyWithoutPlaintextError::KMSInvalidState(err.msg), ) } "KeyUnavailableException" => { return RusotoError::Service( GenerateDataKeyWithoutPlaintextError::KeyUnavailable(err.msg), ) } "NotFoundException" => { return RusotoError::Service(GenerateDataKeyWithoutPlaintextError::NotFound( err.msg, )) } "ValidationException" => return RusotoError::Validation(err.msg), _ => {} } } RusotoError::Unknown(res) } } impl fmt::Display for GenerateDataKeyWithoutPlaintextError { #[allow(unused_variables)] fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result { match *self { GenerateDataKeyWithoutPlaintextError::DependencyTimeout(ref cause) => { write!(f, "{}", cause) } GenerateDataKeyWithoutPlaintextError::Disabled(ref cause) => write!(f, "{}", cause), GenerateDataKeyWithoutPlaintextError::InvalidGrantToken(ref cause) => { write!(f, "{}", cause) } GenerateDataKeyWithoutPlaintextError::InvalidKeyUsage(ref cause) => { write!(f, "{}", cause) } GenerateDataKeyWithoutPlaintextError::KMSInternal(ref cause) => write!(f, "{}", cause), GenerateDataKeyWithoutPlaintextError::KMSInvalidState(ref cause) => { write!(f, "{}", cause) } GenerateDataKeyWithoutPlaintextError::KeyUnavailable(ref cause) => { write!(f, "{}", cause) } GenerateDataKeyWithoutPlaintextError::NotFound(ref cause) => write!(f, "{}", cause), } } } impl Error for GenerateDataKeyWithoutPlaintextError {} /// Errors returned by GenerateRandom #[derive(Debug, PartialEq)] pub enum GenerateRandomError { /// <p><p>The request was rejected because of the <code>ConnectionState</code> of the custom key store. To get the <code>ConnectionState</code> of a custom key store, use the <a>DescribeCustomKeyStores</a> operation.</p> <p>This exception is thrown under the following conditions:</p> <ul> <li> <p>You requested the <a>CreateKey</a> or <a>GenerateRandom</a> operation in a custom key store that is not connected. These operations are valid only when the custom key store <code>ConnectionState</code> is <code>CONNECTED</code>.</p> </li> <li> <p>You requested the <a>UpdateCustomKeyStore</a> or <a>DeleteCustomKeyStore</a> operation on a custom key store that is not disconnected. This operation is valid only when the custom key store <code>ConnectionState</code> is <code>DISCONNECTED</code>.</p> </li> <li> <p>You requested the <a>ConnectCustomKeyStore</a> operation on a custom key store with a <code>ConnectionState</code> of <code>DISCONNECTING</code> or <code>FAILED</code>. This operation is valid for all other <code>ConnectionState</code> values.</p> </li> </ul></p> CustomKeyStoreInvalidState(String), /// <p>The request was rejected because AWS KMS cannot find a custom key store with the specified key store name or ID.</p> CustomKeyStoreNotFound(String), /// <p>The system timed out while trying to fulfill the request. The request can be retried.</p> DependencyTimeout(String), /// <p>The request was rejected because an internal exception occurred. The request can be retried.</p> KMSInternal(String), } impl GenerateRandomError { pub fn from_response(res: BufferedHttpResponse) -> RusotoError<GenerateRandomError> { if let Some(err) = proto::json::Error::parse(&res) { match err.typ.as_str() { "CustomKeyStoreInvalidStateException" => { return RusotoError::Service(GenerateRandomError::CustomKeyStoreInvalidState( err.msg, )) } "CustomKeyStoreNotFoundException" => { return RusotoError::Service(GenerateRandomError::CustomKeyStoreNotFound( err.msg, )) } "DependencyTimeoutException" => { return RusotoError::Service(GenerateRandomError::DependencyTimeout(err.msg)) } "KMSInternalException" => { return RusotoError::Service(GenerateRandomError::KMSInternal(err.msg)) } "ValidationException" => return RusotoError::Validation(err.msg), _ => {} } } RusotoError::Unknown(res) } } impl fmt::Display for GenerateRandomError { #[allow(unused_variables)] fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result { match *self { GenerateRandomError::CustomKeyStoreInvalidState(ref cause) => write!(f, "{}", cause), GenerateRandomError::CustomKeyStoreNotFound(ref cause) => write!(f, "{}", cause), GenerateRandomError::DependencyTimeout(ref cause) => write!(f, "{}", cause), GenerateRandomError::KMSInternal(ref cause) => write!(f, "{}", cause), } } } impl Error for GenerateRandomError {} /// Errors returned by GetKeyPolicy #[derive(Debug, PartialEq)] pub enum GetKeyPolicyError { /// <p>The system timed out while trying to fulfill the request. The request can be retried.</p> DependencyTimeout(String), /// <p>The request was rejected because a specified ARN, or an ARN in a key policy, is not valid.</p> InvalidArn(String), /// <p>The request was rejected because an internal exception occurred. The request can be retried.</p> KMSInternal(String), /// <p>The request was rejected because the state of the specified resource is not valid for this request.</p> <p>For more information about how key state affects the use of a CMK, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">How Key State Affects Use of a Customer Master Key</a> in the <i> <i>AWS Key Management Service Developer Guide</i> </i>.</p> KMSInvalidState(String), /// <p>The request was rejected because the specified entity or resource could not be found.</p> NotFound(String), } impl GetKeyPolicyError { pub fn from_response(res: BufferedHttpResponse) -> RusotoError<GetKeyPolicyError> { if let Some(err) = proto::json::Error::parse(&res) { match err.typ.as_str() { "DependencyTimeoutException" => { return RusotoError::Service(GetKeyPolicyError::DependencyTimeout(err.msg)) } "InvalidArnException" => { return RusotoError::Service(GetKeyPolicyError::InvalidArn(err.msg)) } "KMSInternalException" => { return RusotoError::Service(GetKeyPolicyError::KMSInternal(err.msg)) } "KMSInvalidStateException" => { return RusotoError::Service(GetKeyPolicyError::KMSInvalidState(err.msg)) } "NotFoundException" => { return RusotoError::Service(GetKeyPolicyError::NotFound(err.msg)) } "ValidationException" => return RusotoError::Validation(err.msg), _ => {} } } RusotoError::Unknown(res) } } impl fmt::Display for GetKeyPolicyError { #[allow(unused_variables)] fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result { match *self { GetKeyPolicyError::DependencyTimeout(ref cause) => write!(f, "{}", cause), GetKeyPolicyError::InvalidArn(ref cause) => write!(f, "{}", cause), GetKeyPolicyError::KMSInternal(ref cause) => write!(f, "{}", cause), GetKeyPolicyError::KMSInvalidState(ref cause) => write!(f, "{}", cause), GetKeyPolicyError::NotFound(ref cause) => write!(f, "{}", cause), } } } impl Error for GetKeyPolicyError {} /// Errors returned by GetKeyRotationStatus #[derive(Debug, PartialEq)] pub enum GetKeyRotationStatusError { /// <p>The system timed out while trying to fulfill the request. The request can be retried.</p> DependencyTimeout(String), /// <p>The request was rejected because a specified ARN, or an ARN in a key policy, is not valid.</p> InvalidArn(String), /// <p>The request was rejected because an internal exception occurred. The request can be retried.</p> KMSInternal(String), /// <p>The request was rejected because the state of the specified resource is not valid for this request.</p> <p>For more information about how key state affects the use of a CMK, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">How Key State Affects Use of a Customer Master Key</a> in the <i> <i>AWS Key Management Service Developer Guide</i> </i>.</p> KMSInvalidState(String), /// <p>The request was rejected because the specified entity or resource could not be found.</p> NotFound(String), /// <p>The request was rejected because a specified parameter is not supported or a specified resource is not valid for this operation.</p> UnsupportedOperation(String), } impl GetKeyRotationStatusError { pub fn from_response(res: BufferedHttpResponse) -> RusotoError<GetKeyRotationStatusError> { if let Some(err) = proto::json::Error::parse(&res) { match err.typ.as_str() { "DependencyTimeoutException" => { return RusotoError::Service(GetKeyRotationStatusError::DependencyTimeout( err.msg, )) } "InvalidArnException" => { return RusotoError::Service(GetKeyRotationStatusError::InvalidArn(err.msg)) } "KMSInternalException" => { return RusotoError::Service(GetKeyRotationStatusError::KMSInternal(err.msg)) } "KMSInvalidStateException" => { return RusotoError::Service(GetKeyRotationStatusError::KMSInvalidState( err.msg, )) } "NotFoundException" => { return RusotoError::Service(GetKeyRotationStatusError::NotFound(err.msg)) } "UnsupportedOperationException" => { return RusotoError::Service(GetKeyRotationStatusError::UnsupportedOperation( err.msg, )) } "ValidationException" => return RusotoError::Validation(err.msg), _ => {} } } RusotoError::Unknown(res) } } impl fmt::Display for GetKeyRotationStatusError { #[allow(unused_variables)] fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result { match *self { GetKeyRotationStatusError::DependencyTimeout(ref cause) => write!(f, "{}", cause), GetKeyRotationStatusError::InvalidArn(ref cause) => write!(f, "{}", cause), GetKeyRotationStatusError::KMSInternal(ref cause) => write!(f, "{}", cause), GetKeyRotationStatusError::KMSInvalidState(ref cause) => write!(f, "{}", cause), GetKeyRotationStatusError::NotFound(ref cause) => write!(f, "{}", cause), GetKeyRotationStatusError::UnsupportedOperation(ref cause) => write!(f, "{}", cause), } } } impl Error for GetKeyRotationStatusError {} /// Errors returned by GetParametersForImport #[derive(Debug, PartialEq)] pub enum GetParametersForImportError { /// <p>The system timed out while trying to fulfill the request. The request can be retried.</p> DependencyTimeout(String), /// <p>The request was rejected because a specified ARN, or an ARN in a key policy, is not valid.</p> InvalidArn(String), /// <p>The request was rejected because an internal exception occurred. The request can be retried.</p> KMSInternal(String), /// <p>The request was rejected because the state of the specified resource is not valid for this request.</p> <p>For more information about how key state affects the use of a CMK, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">How Key State Affects Use of a Customer Master Key</a> in the <i> <i>AWS Key Management Service Developer Guide</i> </i>.</p> KMSInvalidState(String), /// <p>The request was rejected because the specified entity or resource could not be found.</p> NotFound(String), /// <p>The request was rejected because a specified parameter is not supported or a specified resource is not valid for this operation.</p> UnsupportedOperation(String), } impl GetParametersForImportError { pub fn from_response(res: BufferedHttpResponse) -> RusotoError<GetParametersForImportError> { if let Some(err) = proto::json::Error::parse(&res) { match err.typ.as_str() { "DependencyTimeoutException" => { return RusotoError::Service(GetParametersForImportError::DependencyTimeout( err.msg, )) } "InvalidArnException" => { return RusotoError::Service(GetParametersForImportError::InvalidArn(err.msg)) } "KMSInternalException" => { return RusotoError::Service(GetParametersForImportError::KMSInternal(err.msg)) } "KMSInvalidStateException" => { return RusotoError::Service(GetParametersForImportError::KMSInvalidState( err.msg, )) } "NotFoundException" => { return RusotoError::Service(GetParametersForImportError::NotFound(err.msg)) } "UnsupportedOperationException" => { return RusotoError::Service(GetParametersForImportError::UnsupportedOperation( err.msg, )) } "ValidationException" => return RusotoError::Validation(err.msg), _ => {} } } RusotoError::Unknown(res) } } impl fmt::Display for GetParametersForImportError { #[allow(unused_variables)] fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result { match *self { GetParametersForImportError::DependencyTimeout(ref cause) => write!(f, "{}", cause), GetParametersForImportError::InvalidArn(ref cause) => write!(f, "{}", cause), GetParametersForImportError::KMSInternal(ref cause) => write!(f, "{}", cause), GetParametersForImportError::KMSInvalidState(ref cause) => write!(f, "{}", cause), GetParametersForImportError::NotFound(ref cause) => write!(f, "{}", cause), GetParametersForImportError::UnsupportedOperation(ref cause) => write!(f, "{}", cause), } } } impl Error for GetParametersForImportError {} /// Errors returned by GetPublicKey #[derive(Debug, PartialEq)] pub enum GetPublicKeyError { /// <p>The system timed out while trying to fulfill the request. The request can be retried.</p> DependencyTimeout(String), /// <p>The request was rejected because the specified CMK is not enabled.</p> Disabled(String), /// <p>The request was rejected because a specified ARN, or an ARN in a key policy, is not valid.</p> InvalidArn(String), /// <p>The request was rejected because the specified grant token is not valid.</p> InvalidGrantToken(String), /// <p>The request was rejected for one of the following reasons: </p> <ul> <li> <p>The <code>KeyUsage</code> value of the CMK is incompatible with the API operation.</p> </li> <li> <p>The encryption algorithm or signing algorithm specified for the operation is incompatible with the type of key material in the CMK <code>(CustomerMasterKeySpec</code>).</p> </li> </ul> <p>For encrypting, decrypting, re-encrypting, and generating data keys, the <code>KeyUsage</code> must be <code>ENCRYPT_DECRYPT</code>. For signing and verifying, the <code>KeyUsage</code> must be <code>SIGN_VERIFY</code>. To find the <code>KeyUsage</code> of a CMK, use the <a>DescribeKey</a> operation.</p> <p>To find the encryption or signing algorithms supported for a particular CMK, use the <a>DescribeKey</a> operation.</p> InvalidKeyUsage(String), /// <p>The request was rejected because an internal exception occurred. The request can be retried.</p> KMSInternal(String), /// <p>The request was rejected because the state of the specified resource is not valid for this request.</p> <p>For more information about how key state affects the use of a CMK, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">How Key State Affects Use of a Customer Master Key</a> in the <i> <i>AWS Key Management Service Developer Guide</i> </i>.</p> KMSInvalidState(String), /// <p>The request was rejected because the specified CMK was not available. You can retry the request.</p> KeyUnavailable(String), /// <p>The request was rejected because the specified entity or resource could not be found.</p> NotFound(String), /// <p>The request was rejected because a specified parameter is not supported or a specified resource is not valid for this operation.</p> UnsupportedOperation(String), } impl GetPublicKeyError { pub fn from_response(res: BufferedHttpResponse) -> RusotoError<GetPublicKeyError> { if let Some(err) = proto::json::Error::parse(&res) { match err.typ.as_str() { "DependencyTimeoutException" => { return RusotoError::Service(GetPublicKeyError::DependencyTimeout(err.msg)) } "DisabledException" => { return RusotoError::Service(GetPublicKeyError::Disabled(err.msg)) } "InvalidArnException" => { return RusotoError::Service(GetPublicKeyError::InvalidArn(err.msg)) } "InvalidGrantTokenException" => { return RusotoError::Service(GetPublicKeyError::InvalidGrantToken(err.msg)) } "InvalidKeyUsageException" => { return RusotoError::Service(GetPublicKeyError::InvalidKeyUsage(err.msg)) } "KMSInternalException" => { return RusotoError::Service(GetPublicKeyError::KMSInternal(err.msg)) } "KMSInvalidStateException" => { return RusotoError::Service(GetPublicKeyError::KMSInvalidState(err.msg)) } "KeyUnavailableException" => { return RusotoError::Service(GetPublicKeyError::KeyUnavailable(err.msg)) } "NotFoundException" => { return RusotoError::Service(GetPublicKeyError::NotFound(err.msg)) } "UnsupportedOperationException" => { return RusotoError::Service(GetPublicKeyError::UnsupportedOperation(err.msg)) } "ValidationException" => return RusotoError::Validation(err.msg), _ => {} } } RusotoError::Unknown(res) } } impl fmt::Display for GetPublicKeyError { #[allow(unused_variables)] fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result { match *self { GetPublicKeyError::DependencyTimeout(ref cause) => write!(f, "{}", cause), GetPublicKeyError::Disabled(ref cause) => write!(f, "{}", cause), GetPublicKeyError::InvalidArn(ref cause) => write!(f, "{}", cause), GetPublicKeyError::InvalidGrantToken(ref cause) => write!(f, "{}", cause), GetPublicKeyError::InvalidKeyUsage(ref cause) => write!(f, "{}", cause), GetPublicKeyError::KMSInternal(ref cause) => write!(f, "{}", cause), GetPublicKeyError::KMSInvalidState(ref cause) => write!(f, "{}", cause), GetPublicKeyError::KeyUnavailable(ref cause) => write!(f, "{}", cause), GetPublicKeyError::NotFound(ref cause) => write!(f, "{}", cause), GetPublicKeyError::UnsupportedOperation(ref cause) => write!(f, "{}", cause), } } } impl Error for GetPublicKeyError {} /// Errors returned by ImportKeyMaterial #[derive(Debug, PartialEq)] pub enum ImportKeyMaterialError { /// <p>The system timed out while trying to fulfill the request. The request can be retried.</p> DependencyTimeout(String), /// <p>The request was rejected because the specified import token is expired. Use <a>GetParametersForImport</a> to get a new import token and public key, use the new public key to encrypt the key material, and then try the request again.</p> ExpiredImportToken(String), /// <p>The request was rejected because the key material in the request is, expired, invalid, or is not the same key material that was previously imported into this customer master key (CMK).</p> IncorrectKeyMaterial(String), /// <p>The request was rejected because a specified ARN, or an ARN in a key policy, is not valid.</p> InvalidArn(String), /// <p>From the <a>Decrypt</a> or <a>ReEncrypt</a> operation, the request was rejected because the specified ciphertext, or additional authenticated data incorporated into the ciphertext, such as the encryption context, is corrupted, missing, or otherwise invalid.</p> <p>From the <a>ImportKeyMaterial</a> operation, the request was rejected because AWS KMS could not decrypt the encrypted (wrapped) key material. </p> InvalidCiphertext(String), /// <p>The request was rejected because the provided import token is invalid or is associated with a different customer master key (CMK).</p> InvalidImportToken(String), /// <p>The request was rejected because an internal exception occurred. The request can be retried.</p> KMSInternal(String), /// <p>The request was rejected because the state of the specified resource is not valid for this request.</p> <p>For more information about how key state affects the use of a CMK, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">How Key State Affects Use of a Customer Master Key</a> in the <i> <i>AWS Key Management Service Developer Guide</i> </i>.</p> KMSInvalidState(String), /// <p>The request was rejected because the specified entity or resource could not be found.</p> NotFound(String), /// <p>The request was rejected because a specified parameter is not supported or a specified resource is not valid for this operation.</p> UnsupportedOperation(String), } impl ImportKeyMaterialError { pub fn from_response(res: BufferedHttpResponse) -> RusotoError<ImportKeyMaterialError> { if let Some(err) = proto::json::Error::parse(&res) { match err.typ.as_str() { "DependencyTimeoutException" => { return RusotoError::Service(ImportKeyMaterialError::DependencyTimeout(err.msg)) } "ExpiredImportTokenException" => { return RusotoError::Service(ImportKeyMaterialError::ExpiredImportToken( err.msg, )) } "IncorrectKeyMaterialException" => { return RusotoError::Service(ImportKeyMaterialError::IncorrectKeyMaterial( err.msg, )) } "InvalidArnException" => { return RusotoError::Service(ImportKeyMaterialError::InvalidArn(err.msg)) } "InvalidCiphertextException" => { return RusotoError::Service(ImportKeyMaterialError::InvalidCiphertext(err.msg)) } "InvalidImportTokenException" => { return RusotoError::Service(ImportKeyMaterialError::InvalidImportToken( err.msg, )) } "KMSInternalException" => { return RusotoError::Service(ImportKeyMaterialError::KMSInternal(err.msg)) } "KMSInvalidStateException" => { return RusotoError::Service(ImportKeyMaterialError::KMSInvalidState(err.msg)) } "NotFoundException" => { return RusotoError::Service(ImportKeyMaterialError::NotFound(err.msg)) } "UnsupportedOperationException" => { return RusotoError::Service(ImportKeyMaterialError::UnsupportedOperation( err.msg, )) } "ValidationException" => return RusotoError::Validation(err.msg), _ => {} } } RusotoError::Unknown(res) } } impl fmt::Display for ImportKeyMaterialError { #[allow(unused_variables)] fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result { match *self { ImportKeyMaterialError::DependencyTimeout(ref cause) => write!(f, "{}", cause), ImportKeyMaterialError::ExpiredImportToken(ref cause) => write!(f, "{}", cause), ImportKeyMaterialError::IncorrectKeyMaterial(ref cause) => write!(f, "{}", cause), ImportKeyMaterialError::InvalidArn(ref cause) => write!(f, "{}", cause), ImportKeyMaterialError::InvalidCiphertext(ref cause) => write!(f, "{}", cause), ImportKeyMaterialError::InvalidImportToken(ref cause) => write!(f, "{}", cause), ImportKeyMaterialError::KMSInternal(ref cause) => write!(f, "{}", cause), ImportKeyMaterialError::KMSInvalidState(ref cause) => write!(f, "{}", cause), ImportKeyMaterialError::NotFound(ref cause) => write!(f, "{}", cause), ImportKeyMaterialError::UnsupportedOperation(ref cause) => write!(f, "{}", cause), } } } impl Error for ImportKeyMaterialError {} /// Errors returned by ListAliases #[derive(Debug, PartialEq)] pub enum ListAliasesError { /// <p>The system timed out while trying to fulfill the request. The request can be retried.</p> DependencyTimeout(String), /// <p>The request was rejected because a specified ARN, or an ARN in a key policy, is not valid.</p> InvalidArn(String), /// <p>The request was rejected because the marker that specifies where pagination should next begin is not valid.</p> InvalidMarker(String), /// <p>The request was rejected because an internal exception occurred. The request can be retried.</p> KMSInternal(String), /// <p>The request was rejected because the specified entity or resource could not be found.</p> NotFound(String), } impl ListAliasesError { pub fn from_response(res: BufferedHttpResponse) -> RusotoError<ListAliasesError> { if let Some(err) = proto::json::Error::parse(&res) { match err.typ.as_str() { "DependencyTimeoutException" => { return RusotoError::Service(ListAliasesError::DependencyTimeout(err.msg)) } "InvalidArnException" => { return RusotoError::Service(ListAliasesError::InvalidArn(err.msg)) } "InvalidMarkerException" => { return RusotoError::Service(ListAliasesError::InvalidMarker(err.msg)) } "KMSInternalException" => { return RusotoError::Service(ListAliasesError::KMSInternal(err.msg)) } "NotFoundException" => { return RusotoError::Service(ListAliasesError::NotFound(err.msg)) } "ValidationException" => return RusotoError::Validation(err.msg), _ => {} } } RusotoError::Unknown(res) } } impl fmt::Display for ListAliasesError { #[allow(unused_variables)] fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result { match *self { ListAliasesError::DependencyTimeout(ref cause) => write!(f, "{}", cause), ListAliasesError::InvalidArn(ref cause) => write!(f, "{}", cause), ListAliasesError::InvalidMarker(ref cause) => write!(f, "{}", cause), ListAliasesError::KMSInternal(ref cause) => write!(f, "{}", cause), ListAliasesError::NotFound(ref cause) => write!(f, "{}", cause), } } } impl Error for ListAliasesError {} /// Errors returned by ListGrants #[derive(Debug, PartialEq)] pub enum ListGrantsError { /// <p>The system timed out while trying to fulfill the request. The request can be retried.</p> DependencyTimeout(String), /// <p>The request was rejected because a specified ARN, or an ARN in a key policy, is not valid.</p> InvalidArn(String), /// <p>The request was rejected because the marker that specifies where pagination should next begin is not valid.</p> InvalidMarker(String), /// <p>The request was rejected because an internal exception occurred. The request can be retried.</p> KMSInternal(String), /// <p>The request was rejected because the state of the specified resource is not valid for this request.</p> <p>For more information about how key state affects the use of a CMK, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">How Key State Affects Use of a Customer Master Key</a> in the <i> <i>AWS Key Management Service Developer Guide</i> </i>.</p> KMSInvalidState(String), /// <p>The request was rejected because the specified entity or resource could not be found.</p> NotFound(String), } impl ListGrantsError { pub fn from_response(res: BufferedHttpResponse) -> RusotoError<ListGrantsError> { if let Some(err) = proto::json::Error::parse(&res) { match err.typ.as_str() { "DependencyTimeoutException" => { return RusotoError::Service(ListGrantsError::DependencyTimeout(err.msg)) } "InvalidArnException" => { return RusotoError::Service(ListGrantsError::InvalidArn(err.msg)) } "InvalidMarkerException" => { return RusotoError::Service(ListGrantsError::InvalidMarker(err.msg)) } "KMSInternalException" => { return RusotoError::Service(ListGrantsError::KMSInternal(err.msg)) } "KMSInvalidStateException" => { return RusotoError::Service(ListGrantsError::KMSInvalidState(err.msg)) } "NotFoundException" => { return RusotoError::Service(ListGrantsError::NotFound(err.msg)) } "ValidationException" => return RusotoError::Validation(err.msg), _ => {} } } RusotoError::Unknown(res) } } impl fmt::Display for ListGrantsError { #[allow(unused_variables)] fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result { match *self { ListGrantsError::DependencyTimeout(ref cause) => write!(f, "{}", cause), ListGrantsError::InvalidArn(ref cause) => write!(f, "{}", cause), ListGrantsError::InvalidMarker(ref cause) => write!(f, "{}", cause), ListGrantsError::KMSInternal(ref cause) => write!(f, "{}", cause), ListGrantsError::KMSInvalidState(ref cause) => write!(f, "{}", cause), ListGrantsError::NotFound(ref cause) => write!(f, "{}", cause), } } } impl Error for ListGrantsError {} /// Errors returned by ListKeyPolicies #[derive(Debug, PartialEq)] pub enum ListKeyPoliciesError { /// <p>The system timed out while trying to fulfill the request. The request can be retried.</p> DependencyTimeout(String), /// <p>The request was rejected because a specified ARN, or an ARN in a key policy, is not valid.</p> InvalidArn(String), /// <p>The request was rejected because an internal exception occurred. The request can be retried.</p> KMSInternal(String), /// <p>The request was rejected because the state of the specified resource is not valid for this request.</p> <p>For more information about how key state affects the use of a CMK, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">How Key State Affects Use of a Customer Master Key</a> in the <i> <i>AWS Key Management Service Developer Guide</i> </i>.</p> KMSInvalidState(String), /// <p>The request was rejected because the specified entity or resource could not be found.</p> NotFound(String), } impl ListKeyPoliciesError { pub fn from_response(res: BufferedHttpResponse) -> RusotoError<ListKeyPoliciesError> { if let Some(err) = proto::json::Error::parse(&res) { match err.typ.as_str() { "DependencyTimeoutException" => { return RusotoError::Service(ListKeyPoliciesError::DependencyTimeout(err.msg)) } "InvalidArnException" => { return RusotoError::Service(ListKeyPoliciesError::InvalidArn(err.msg)) } "KMSInternalException" => { return RusotoError::Service(ListKeyPoliciesError::KMSInternal(err.msg)) } "KMSInvalidStateException" => { return RusotoError::Service(ListKeyPoliciesError::KMSInvalidState(err.msg)) } "NotFoundException" => { return RusotoError::Service(ListKeyPoliciesError::NotFound(err.msg)) } "ValidationException" => return RusotoError::Validation(err.msg), _ => {} } } RusotoError::Unknown(res) } } impl fmt::Display for ListKeyPoliciesError { #[allow(unused_variables)] fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result { match *self { ListKeyPoliciesError::DependencyTimeout(ref cause) => write!(f, "{}", cause), ListKeyPoliciesError::InvalidArn(ref cause) => write!(f, "{}", cause), ListKeyPoliciesError::KMSInternal(ref cause) => write!(f, "{}", cause), ListKeyPoliciesError::KMSInvalidState(ref cause) => write!(f, "{}", cause), ListKeyPoliciesError::NotFound(ref cause) => write!(f, "{}", cause), } } } impl Error for ListKeyPoliciesError {} /// Errors returned by ListKeys #[derive(Debug, PartialEq)] pub enum ListKeysError { /// <p>The system timed out while trying to fulfill the request. The request can be retried.</p> DependencyTimeout(String), /// <p>The request was rejected because the marker that specifies where pagination should next begin is not valid.</p> InvalidMarker(String), /// <p>The request was rejected because an internal exception occurred. The request can be retried.</p> KMSInternal(String), } impl ListKeysError { pub fn from_response(res: BufferedHttpResponse) -> RusotoError<ListKeysError> { if let Some(err) = proto::json::Error::parse(&res) { match err.typ.as_str() { "DependencyTimeoutException" => { return RusotoError::Service(ListKeysError::DependencyTimeout(err.msg)) } "InvalidMarkerException" => { return RusotoError::Service(ListKeysError::InvalidMarker(err.msg)) } "KMSInternalException" => { return RusotoError::Service(ListKeysError::KMSInternal(err.msg)) } "ValidationException" => return RusotoError::Validation(err.msg), _ => {} } } RusotoError::Unknown(res) } } impl fmt::Display for ListKeysError { #[allow(unused_variables)] fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result { match *self { ListKeysError::DependencyTimeout(ref cause) => write!(f, "{}", cause), ListKeysError::InvalidMarker(ref cause) => write!(f, "{}", cause), ListKeysError::KMSInternal(ref cause) => write!(f, "{}", cause), } } } impl Error for ListKeysError {} /// Errors returned by ListResourceTags #[derive(Debug, PartialEq)] pub enum ListResourceTagsError { /// <p>The request was rejected because a specified ARN, or an ARN in a key policy, is not valid.</p> InvalidArn(String), /// <p>The request was rejected because the marker that specifies where pagination should next begin is not valid.</p> InvalidMarker(String), /// <p>The request was rejected because an internal exception occurred. The request can be retried.</p> KMSInternal(String), /// <p>The request was rejected because the specified entity or resource could not be found.</p> NotFound(String), } impl ListResourceTagsError { pub fn from_response(res: BufferedHttpResponse) -> RusotoError<ListResourceTagsError> { if let Some(err) = proto::json::Error::parse(&res) { match err.typ.as_str() { "InvalidArnException" => { return RusotoError::Service(ListResourceTagsError::InvalidArn(err.msg)) } "InvalidMarkerException" => { return RusotoError::Service(ListResourceTagsError::InvalidMarker(err.msg)) } "KMSInternalException" => { return RusotoError::Service(ListResourceTagsError::KMSInternal(err.msg)) } "NotFoundException" => { return RusotoError::Service(ListResourceTagsError::NotFound(err.msg)) } "ValidationException" => return RusotoError::Validation(err.msg), _ => {} } } RusotoError::Unknown(res) } } impl fmt::Display for ListResourceTagsError { #[allow(unused_variables)] fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result { match *self { ListResourceTagsError::InvalidArn(ref cause) => write!(f, "{}", cause), ListResourceTagsError::InvalidMarker(ref cause) => write!(f, "{}", cause), ListResourceTagsError::KMSInternal(ref cause) => write!(f, "{}", cause), ListResourceTagsError::NotFound(ref cause) => write!(f, "{}", cause), } } } impl Error for ListResourceTagsError {} /// Errors returned by ListRetirableGrants #[derive(Debug, PartialEq)] pub enum ListRetirableGrantsError { /// <p>The system timed out while trying to fulfill the request. The request can be retried.</p> DependencyTimeout(String), /// <p>The request was rejected because a specified ARN, or an ARN in a key policy, is not valid.</p> InvalidArn(String), /// <p>The request was rejected because the marker that specifies where pagination should next begin is not valid.</p> InvalidMarker(String), /// <p>The request was rejected because an internal exception occurred. The request can be retried.</p> KMSInternal(String), /// <p>The request was rejected because the specified entity or resource could not be found.</p> NotFound(String), } impl ListRetirableGrantsError { pub fn from_response(res: BufferedHttpResponse) -> RusotoError<ListRetirableGrantsError> { if let Some(err) = proto::json::Error::parse(&res) { match err.typ.as_str() { "DependencyTimeoutException" => { return RusotoError::Service(ListRetirableGrantsError::DependencyTimeout( err.msg, )) } "InvalidArnException" => { return RusotoError::Service(ListRetirableGrantsError::InvalidArn(err.msg)) } "InvalidMarkerException" => { return RusotoError::Service(ListRetirableGrantsError::InvalidMarker(err.msg)) } "KMSInternalException" => { return RusotoError::Service(ListRetirableGrantsError::KMSInternal(err.msg)) } "NotFoundException" => { return RusotoError::Service(ListRetirableGrantsError::NotFound(err.msg)) } "ValidationException" => return RusotoError::Validation(err.msg), _ => {} } } RusotoError::Unknown(res) } } impl fmt::Display for ListRetirableGrantsError { #[allow(unused_variables)] fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result { match *self { ListRetirableGrantsError::DependencyTimeout(ref cause) => write!(f, "{}", cause), ListRetirableGrantsError::InvalidArn(ref cause) => write!(f, "{}", cause), ListRetirableGrantsError::InvalidMarker(ref cause) => write!(f, "{}", cause), ListRetirableGrantsError::KMSInternal(ref cause) => write!(f, "{}", cause), ListRetirableGrantsError::NotFound(ref cause) => write!(f, "{}", cause), } } } impl Error for ListRetirableGrantsError {} /// Errors returned by PutKeyPolicy #[derive(Debug, PartialEq)] pub enum PutKeyPolicyError { /// <p>The system timed out while trying to fulfill the request. The request can be retried.</p> DependencyTimeout(String), /// <p>The request was rejected because a specified ARN, or an ARN in a key policy, is not valid.</p> InvalidArn(String), /// <p>The request was rejected because an internal exception occurred. The request can be retried.</p> KMSInternal(String), /// <p>The request was rejected because the state of the specified resource is not valid for this request.</p> <p>For more information about how key state affects the use of a CMK, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">How Key State Affects Use of a Customer Master Key</a> in the <i> <i>AWS Key Management Service Developer Guide</i> </i>.</p> KMSInvalidState(String), /// <p>The request was rejected because a quota was exceeded. For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/limits.html">Quotas</a> in the <i>AWS Key Management Service Developer Guide</i>.</p> LimitExceeded(String), /// <p>The request was rejected because the specified policy is not syntactically or semantically correct.</p> MalformedPolicyDocument(String), /// <p>The request was rejected because the specified entity or resource could not be found.</p> NotFound(String), /// <p>The request was rejected because a specified parameter is not supported or a specified resource is not valid for this operation.</p> UnsupportedOperation(String), } impl PutKeyPolicyError { pub fn from_response(res: BufferedHttpResponse) -> RusotoError<PutKeyPolicyError> { if let Some(err) = proto::json::Error::parse(&res) { match err.typ.as_str() { "DependencyTimeoutException" => { return RusotoError::Service(PutKeyPolicyError::DependencyTimeout(err.msg)) } "InvalidArnException" => { return RusotoError::Service(PutKeyPolicyError::InvalidArn(err.msg)) } "KMSInternalException" => { return RusotoError::Service(PutKeyPolicyError::KMSInternal(err.msg)) } "KMSInvalidStateException" => { return RusotoError::Service(PutKeyPolicyError::KMSInvalidState(err.msg)) } "LimitExceededException" => { return RusotoError::Service(PutKeyPolicyError::LimitExceeded(err.msg)) } "MalformedPolicyDocumentException" => { return RusotoError::Service(PutKeyPolicyError::MalformedPolicyDocument( err.msg, )) } "NotFoundException" => { return RusotoError::Service(PutKeyPolicyError::NotFound(err.msg)) } "UnsupportedOperationException" => { return RusotoError::Service(PutKeyPolicyError::UnsupportedOperation(err.msg)) } "ValidationException" => return RusotoError::Validation(err.msg), _ => {} } } RusotoError::Unknown(res) } } impl fmt::Display for PutKeyPolicyError { #[allow(unused_variables)] fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result { match *self { PutKeyPolicyError::DependencyTimeout(ref cause) => write!(f, "{}", cause), PutKeyPolicyError::InvalidArn(ref cause) => write!(f, "{}", cause), PutKeyPolicyError::KMSInternal(ref cause) => write!(f, "{}", cause), PutKeyPolicyError::KMSInvalidState(ref cause) => write!(f, "{}", cause), PutKeyPolicyError::LimitExceeded(ref cause) => write!(f, "{}", cause), PutKeyPolicyError::MalformedPolicyDocument(ref cause) => write!(f, "{}", cause), PutKeyPolicyError::NotFound(ref cause) => write!(f, "{}", cause), PutKeyPolicyError::UnsupportedOperation(ref cause) => write!(f, "{}", cause), } } } impl Error for PutKeyPolicyError {} /// Errors returned by ReEncrypt #[derive(Debug, PartialEq)] pub enum ReEncryptError { /// <p>The system timed out while trying to fulfill the request. The request can be retried.</p> DependencyTimeout(String), /// <p>The request was rejected because the specified CMK is not enabled.</p> Disabled(String), /// <p>The request was rejected because the specified CMK cannot decrypt the data. The <code>KeyId</code> in a <a>Decrypt</a> request and the <code>SourceKeyId</code> in a <a>ReEncrypt</a> request must identify the same CMK that was used to encrypt the ciphertext.</p> IncorrectKey(String), /// <p>From the <a>Decrypt</a> or <a>ReEncrypt</a> operation, the request was rejected because the specified ciphertext, or additional authenticated data incorporated into the ciphertext, such as the encryption context, is corrupted, missing, or otherwise invalid.</p> <p>From the <a>ImportKeyMaterial</a> operation, the request was rejected because AWS KMS could not decrypt the encrypted (wrapped) key material. </p> InvalidCiphertext(String), /// <p>The request was rejected because the specified grant token is not valid.</p> InvalidGrantToken(String), /// <p>The request was rejected for one of the following reasons: </p> <ul> <li> <p>The <code>KeyUsage</code> value of the CMK is incompatible with the API operation.</p> </li> <li> <p>The encryption algorithm or signing algorithm specified for the operation is incompatible with the type of key material in the CMK <code>(CustomerMasterKeySpec</code>).</p> </li> </ul> <p>For encrypting, decrypting, re-encrypting, and generating data keys, the <code>KeyUsage</code> must be <code>ENCRYPT_DECRYPT</code>. For signing and verifying, the <code>KeyUsage</code> must be <code>SIGN_VERIFY</code>. To find the <code>KeyUsage</code> of a CMK, use the <a>DescribeKey</a> operation.</p> <p>To find the encryption or signing algorithms supported for a particular CMK, use the <a>DescribeKey</a> operation.</p> InvalidKeyUsage(String), /// <p>The request was rejected because an internal exception occurred. The request can be retried.</p> KMSInternal(String), /// <p>The request was rejected because the state of the specified resource is not valid for this request.</p> <p>For more information about how key state affects the use of a CMK, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">How Key State Affects Use of a Customer Master Key</a> in the <i> <i>AWS Key Management Service Developer Guide</i> </i>.</p> KMSInvalidState(String), /// <p>The request was rejected because the specified CMK was not available. You can retry the request.</p> KeyUnavailable(String), /// <p>The request was rejected because the specified entity or resource could not be found.</p> NotFound(String), } impl ReEncryptError { pub fn from_response(res: BufferedHttpResponse) -> RusotoError<ReEncryptError> { if let Some(err) = proto::json::Error::parse(&res) { match err.typ.as_str() { "DependencyTimeoutException" => { return RusotoError::Service(ReEncryptError::DependencyTimeout(err.msg)) } "DisabledException" => { return RusotoError::Service(ReEncryptError::Disabled(err.msg)) } "IncorrectKeyException" => { return RusotoError::Service(ReEncryptError::IncorrectKey(err.msg)) } "InvalidCiphertextException" => { return RusotoError::Service(ReEncryptError::InvalidCiphertext(err.msg)) } "InvalidGrantTokenException" => { return RusotoError::Service(ReEncryptError::InvalidGrantToken(err.msg)) } "InvalidKeyUsageException" => { return RusotoError::Service(ReEncryptError::InvalidKeyUsage(err.msg)) } "KMSInternalException" => { return RusotoError::Service(ReEncryptError::KMSInternal(err.msg)) } "KMSInvalidStateException" => { return RusotoError::Service(ReEncryptError::KMSInvalidState(err.msg)) } "KeyUnavailableException" => { return RusotoError::Service(ReEncryptError::KeyUnavailable(err.msg)) } "NotFoundException" => { return RusotoError::Service(ReEncryptError::NotFound(err.msg)) } "ValidationException" => return RusotoError::Validation(err.msg), _ => {} } } RusotoError::Unknown(res) } } impl fmt::Display for ReEncryptError { #[allow(unused_variables)] fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result { match *self { ReEncryptError::DependencyTimeout(ref cause) => write!(f, "{}", cause), ReEncryptError::Disabled(ref cause) => write!(f, "{}", cause), ReEncryptError::IncorrectKey(ref cause) => write!(f, "{}", cause), ReEncryptError::InvalidCiphertext(ref cause) => write!(f, "{}", cause), ReEncryptError::InvalidGrantToken(ref cause) => write!(f, "{}", cause), ReEncryptError::InvalidKeyUsage(ref cause) => write!(f, "{}", cause), ReEncryptError::KMSInternal(ref cause) => write!(f, "{}", cause), ReEncryptError::KMSInvalidState(ref cause) => write!(f, "{}", cause), ReEncryptError::KeyUnavailable(ref cause) => write!(f, "{}", cause), ReEncryptError::NotFound(ref cause) => write!(f, "{}", cause), } } } impl Error for ReEncryptError {} /// Errors returned by RetireGrant #[derive(Debug, PartialEq)] pub enum RetireGrantError { /// <p>The system timed out while trying to fulfill the request. The request can be retried.</p> DependencyTimeout(String), /// <p>The request was rejected because a specified ARN, or an ARN in a key policy, is not valid.</p> InvalidArn(String), /// <p>The request was rejected because the specified <code>GrantId</code> is not valid.</p> InvalidGrantId(String), /// <p>The request was rejected because the specified grant token is not valid.</p> InvalidGrantToken(String), /// <p>The request was rejected because an internal exception occurred. The request can be retried.</p> KMSInternal(String), /// <p>The request was rejected because the state of the specified resource is not valid for this request.</p> <p>For more information about how key state affects the use of a CMK, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">How Key State Affects Use of a Customer Master Key</a> in the <i> <i>AWS Key Management Service Developer Guide</i> </i>.</p> KMSInvalidState(String), /// <p>The request was rejected because the specified entity or resource could not be found.</p> NotFound(String), } impl RetireGrantError { pub fn from_response(res: BufferedHttpResponse) -> RusotoError<RetireGrantError> { if let Some(err) = proto::json::Error::parse(&res) { match err.typ.as_str() { "DependencyTimeoutException" => { return RusotoError::Service(RetireGrantError::DependencyTimeout(err.msg)) } "InvalidArnException" => { return RusotoError::Service(RetireGrantError::InvalidArn(err.msg)) } "InvalidGrantIdException" => { return RusotoError::Service(RetireGrantError::InvalidGrantId(err.msg)) } "InvalidGrantTokenException" => { return RusotoError::Service(RetireGrantError::InvalidGrantToken(err.msg)) } "KMSInternalException" => { return RusotoError::Service(RetireGrantError::KMSInternal(err.msg)) } "KMSInvalidStateException" => { return RusotoError::Service(RetireGrantError::KMSInvalidState(err.msg)) } "NotFoundException" => { return RusotoError::Service(RetireGrantError::NotFound(err.msg)) } "ValidationException" => return RusotoError::Validation(err.msg), _ => {} } } RusotoError::Unknown(res) } } impl fmt::Display for RetireGrantError { #[allow(unused_variables)] fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result { match *self { RetireGrantError::DependencyTimeout(ref cause) => write!(f, "{}", cause), RetireGrantError::InvalidArn(ref cause) => write!(f, "{}", cause), RetireGrantError::InvalidGrantId(ref cause) => write!(f, "{}", cause), RetireGrantError::InvalidGrantToken(ref cause) => write!(f, "{}", cause), RetireGrantError::KMSInternal(ref cause) => write!(f, "{}", cause), RetireGrantError::KMSInvalidState(ref cause) => write!(f, "{}", cause), RetireGrantError::NotFound(ref cause) => write!(f, "{}", cause), } } } impl Error for RetireGrantError {} /// Errors returned by RevokeGrant #[derive(Debug, PartialEq)] pub enum RevokeGrantError { /// <p>The system timed out while trying to fulfill the request. The request can be retried.</p> DependencyTimeout(String), /// <p>The request was rejected because a specified ARN, or an ARN in a key policy, is not valid.</p> InvalidArn(String), /// <p>The request was rejected because the specified <code>GrantId</code> is not valid.</p> InvalidGrantId(String), /// <p>The request was rejected because an internal exception occurred. The request can be retried.</p> KMSInternal(String), /// <p>The request was rejected because the state of the specified resource is not valid for this request.</p> <p>For more information about how key state affects the use of a CMK, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">How Key State Affects Use of a Customer Master Key</a> in the <i> <i>AWS Key Management Service Developer Guide</i> </i>.</p> KMSInvalidState(String), /// <p>The request was rejected because the specified entity or resource could not be found.</p> NotFound(String), } impl RevokeGrantError { pub fn from_response(res: BufferedHttpResponse) -> RusotoError<RevokeGrantError> { if let Some(err) = proto::json::Error::parse(&res) { match err.typ.as_str() { "DependencyTimeoutException" => { return RusotoError::Service(RevokeGrantError::DependencyTimeout(err.msg)) } "InvalidArnException" => { return RusotoError::Service(RevokeGrantError::InvalidArn(err.msg)) } "InvalidGrantIdException" => { return RusotoError::Service(RevokeGrantError::InvalidGrantId(err.msg)) } "KMSInternalException" => { return RusotoError::Service(RevokeGrantError::KMSInternal(err.msg)) } "KMSInvalidStateException" => { return RusotoError::Service(RevokeGrantError::KMSInvalidState(err.msg)) } "NotFoundException" => { return RusotoError::Service(RevokeGrantError::NotFound(err.msg)) } "ValidationException" => return RusotoError::Validation(err.msg), _ => {} } } RusotoError::Unknown(res) } } impl fmt::Display for RevokeGrantError { #[allow(unused_variables)] fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result { match *self { RevokeGrantError::DependencyTimeout(ref cause) => write!(f, "{}", cause), RevokeGrantError::InvalidArn(ref cause) => write!(f, "{}", cause), RevokeGrantError::InvalidGrantId(ref cause) => write!(f, "{}", cause), RevokeGrantError::KMSInternal(ref cause) => write!(f, "{}", cause), RevokeGrantError::KMSInvalidState(ref cause) => write!(f, "{}", cause), RevokeGrantError::NotFound(ref cause) => write!(f, "{}", cause), } } } impl Error for RevokeGrantError {} /// Errors returned by ScheduleKeyDeletion #[derive(Debug, PartialEq)] pub enum ScheduleKeyDeletionError { /// <p>The system timed out while trying to fulfill the request. The request can be retried.</p> DependencyTimeout(String), /// <p>The request was rejected because a specified ARN, or an ARN in a key policy, is not valid.</p> InvalidArn(String), /// <p>The request was rejected because an internal exception occurred. The request can be retried.</p> KMSInternal(String), /// <p>The request was rejected because the state of the specified resource is not valid for this request.</p> <p>For more information about how key state affects the use of a CMK, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">How Key State Affects Use of a Customer Master Key</a> in the <i> <i>AWS Key Management Service Developer Guide</i> </i>.</p> KMSInvalidState(String), /// <p>The request was rejected because the specified entity or resource could not be found.</p> NotFound(String), } impl ScheduleKeyDeletionError { pub fn from_response(res: BufferedHttpResponse) -> RusotoError<ScheduleKeyDeletionError> { if let Some(err) = proto::json::Error::parse(&res) { match err.typ.as_str() { "DependencyTimeoutException" => { return RusotoError::Service(ScheduleKeyDeletionError::DependencyTimeout( err.msg, )) } "InvalidArnException" => { return RusotoError::Service(ScheduleKeyDeletionError::InvalidArn(err.msg)) } "KMSInternalException" => { return RusotoError::Service(ScheduleKeyDeletionError::KMSInternal(err.msg)) } "KMSInvalidStateException" => { return RusotoError::Service(ScheduleKeyDeletionError::KMSInvalidState(err.msg)) } "NotFoundException" => { return RusotoError::Service(ScheduleKeyDeletionError::NotFound(err.msg)) } "ValidationException" => return RusotoError::Validation(err.msg), _ => {} } } RusotoError::Unknown(res) } } impl fmt::Display for ScheduleKeyDeletionError { #[allow(unused_variables)] fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result { match *self { ScheduleKeyDeletionError::DependencyTimeout(ref cause) => write!(f, "{}", cause), ScheduleKeyDeletionError::InvalidArn(ref cause) => write!(f, "{}", cause), ScheduleKeyDeletionError::KMSInternal(ref cause) => write!(f, "{}", cause), ScheduleKeyDeletionError::KMSInvalidState(ref cause) => write!(f, "{}", cause), ScheduleKeyDeletionError::NotFound(ref cause) => write!(f, "{}", cause), } } } impl Error for ScheduleKeyDeletionError {} /// Errors returned by Sign #[derive(Debug, PartialEq)] pub enum SignError { /// <p>The system timed out while trying to fulfill the request. The request can be retried.</p> DependencyTimeout(String), /// <p>The request was rejected because the specified CMK is not enabled.</p> Disabled(String), /// <p>The request was rejected because the specified grant token is not valid.</p> InvalidGrantToken(String), /// <p>The request was rejected for one of the following reasons: </p> <ul> <li> <p>The <code>KeyUsage</code> value of the CMK is incompatible with the API operation.</p> </li> <li> <p>The encryption algorithm or signing algorithm specified for the operation is incompatible with the type of key material in the CMK <code>(CustomerMasterKeySpec</code>).</p> </li> </ul> <p>For encrypting, decrypting, re-encrypting, and generating data keys, the <code>KeyUsage</code> must be <code>ENCRYPT_DECRYPT</code>. For signing and verifying, the <code>KeyUsage</code> must be <code>SIGN_VERIFY</code>. To find the <code>KeyUsage</code> of a CMK, use the <a>DescribeKey</a> operation.</p> <p>To find the encryption or signing algorithms supported for a particular CMK, use the <a>DescribeKey</a> operation.</p> InvalidKeyUsage(String), /// <p>The request was rejected because an internal exception occurred. The request can be retried.</p> KMSInternal(String), /// <p>The request was rejected because the state of the specified resource is not valid for this request.</p> <p>For more information about how key state affects the use of a CMK, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">How Key State Affects Use of a Customer Master Key</a> in the <i> <i>AWS Key Management Service Developer Guide</i> </i>.</p> KMSInvalidState(String), /// <p>The request was rejected because the specified CMK was not available. You can retry the request.</p> KeyUnavailable(String), /// <p>The request was rejected because the specified entity or resource could not be found.</p> NotFound(String), } impl SignError { pub fn from_response(res: BufferedHttpResponse) -> RusotoError<SignError> { if let Some(err) = proto::json::Error::parse(&res) { match err.typ.as_str() { "DependencyTimeoutException" => { return RusotoError::Service(SignError::DependencyTimeout(err.msg)) } "DisabledException" => return RusotoError::Service(SignError::Disabled(err.msg)), "InvalidGrantTokenException" => { return RusotoError::Service(SignError::InvalidGrantToken(err.msg)) } "InvalidKeyUsageException" => { return RusotoError::Service(SignError::InvalidKeyUsage(err.msg)) } "KMSInternalException" => { return RusotoError::Service(SignError::KMSInternal(err.msg)) } "KMSInvalidStateException" => { return RusotoError::Service(SignError::KMSInvalidState(err.msg)) } "KeyUnavailableException" => { return RusotoError::Service(SignError::KeyUnavailable(err.msg)) } "NotFoundException" => return RusotoError::Service(SignError::NotFound(err.msg)), "ValidationException" => return RusotoError::Validation(err.msg), _ => {} } } RusotoError::Unknown(res) } } impl fmt::Display for SignError { #[allow(unused_variables)] fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result { match *self { SignError::DependencyTimeout(ref cause) => write!(f, "{}", cause), SignError::Disabled(ref cause) => write!(f, "{}", cause), SignError::InvalidGrantToken(ref cause) => write!(f, "{}", cause), SignError::InvalidKeyUsage(ref cause) => write!(f, "{}", cause), SignError::KMSInternal(ref cause) => write!(f, "{}", cause), SignError::KMSInvalidState(ref cause) => write!(f, "{}", cause), SignError::KeyUnavailable(ref cause) => write!(f, "{}", cause), SignError::NotFound(ref cause) => write!(f, "{}", cause), } } } impl Error for SignError {} /// Errors returned by TagResource #[derive(Debug, PartialEq)] pub enum TagResourceError { /// <p>The request was rejected because a specified ARN, or an ARN in a key policy, is not valid.</p> InvalidArn(String), /// <p>The request was rejected because an internal exception occurred. The request can be retried.</p> KMSInternal(String), /// <p>The request was rejected because the state of the specified resource is not valid for this request.</p> <p>For more information about how key state affects the use of a CMK, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">How Key State Affects Use of a Customer Master Key</a> in the <i> <i>AWS Key Management Service Developer Guide</i> </i>.</p> KMSInvalidState(String), /// <p>The request was rejected because a quota was exceeded. For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/limits.html">Quotas</a> in the <i>AWS Key Management Service Developer Guide</i>.</p> LimitExceeded(String), /// <p>The request was rejected because the specified entity or resource could not be found.</p> NotFound(String), /// <p>The request was rejected because one or more tags are not valid.</p> Tag(String), } impl TagResourceError { pub fn from_response(res: BufferedHttpResponse) -> RusotoError<TagResourceError> { if let Some(err) = proto::json::Error::parse(&res) { match err.typ.as_str() { "InvalidArnException" => { return RusotoError::Service(TagResourceError::InvalidArn(err.msg)) } "KMSInternalException" => { return RusotoError::Service(TagResourceError::KMSInternal(err.msg)) } "KMSInvalidStateException" => { return RusotoError::Service(TagResourceError::KMSInvalidState(err.msg)) } "LimitExceededException" => { return RusotoError::Service(TagResourceError::LimitExceeded(err.msg)) } "NotFoundException" => { return RusotoError::Service(TagResourceError::NotFound(err.msg)) } "TagException" => return RusotoError::Service(TagResourceError::Tag(err.msg)), "ValidationException" => return RusotoError::Validation(err.msg), _ => {} } } RusotoError::Unknown(res) } } impl fmt::Display for TagResourceError { #[allow(unused_variables)] fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result { match *self { TagResourceError::InvalidArn(ref cause) => write!(f, "{}", cause), TagResourceError::KMSInternal(ref cause) => write!(f, "{}", cause), TagResourceError::KMSInvalidState(ref cause) => write!(f, "{}", cause), TagResourceError::LimitExceeded(ref cause) => write!(f, "{}", cause), TagResourceError::NotFound(ref cause) => write!(f, "{}", cause), TagResourceError::Tag(ref cause) => write!(f, "{}", cause), } } } impl Error for TagResourceError {} /// Errors returned by UntagResource #[derive(Debug, PartialEq)] pub enum UntagResourceError { /// <p>The request was rejected because a specified ARN, or an ARN in a key policy, is not valid.</p> InvalidArn(String), /// <p>The request was rejected because an internal exception occurred. The request can be retried.</p> KMSInternal(String), /// <p>The request was rejected because the state of the specified resource is not valid for this request.</p> <p>For more information about how key state affects the use of a CMK, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">How Key State Affects Use of a Customer Master Key</a> in the <i> <i>AWS Key Management Service Developer Guide</i> </i>.</p> KMSInvalidState(String), /// <p>The request was rejected because the specified entity or resource could not be found.</p> NotFound(String), /// <p>The request was rejected because one or more tags are not valid.</p> Tag(String), } impl UntagResourceError { pub fn from_response(res: BufferedHttpResponse) -> RusotoError<UntagResourceError> { if let Some(err) = proto::json::Error::parse(&res) { match err.typ.as_str() { "InvalidArnException" => { return RusotoError::Service(UntagResourceError::InvalidArn(err.msg)) } "KMSInternalException" => { return RusotoError::Service(UntagResourceError::KMSInternal(err.msg)) } "KMSInvalidStateException" => { return RusotoError::Service(UntagResourceError::KMSInvalidState(err.msg)) } "NotFoundException" => { return RusotoError::Service(UntagResourceError::NotFound(err.msg)) } "TagException" => return RusotoError::Service(UntagResourceError::Tag(err.msg)), "ValidationException" => return RusotoError::Validation(err.msg), _ => {} } } RusotoError::Unknown(res) } } impl fmt::Display for UntagResourceError { #[allow(unused_variables)] fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result { match *self { UntagResourceError::InvalidArn(ref cause) => write!(f, "{}", cause), UntagResourceError::KMSInternal(ref cause) => write!(f, "{}", cause), UntagResourceError::KMSInvalidState(ref cause) => write!(f, "{}", cause), UntagResourceError::NotFound(ref cause) => write!(f, "{}", cause), UntagResourceError::Tag(ref cause) => write!(f, "{}", cause), } } } impl Error for UntagResourceError {} /// Errors returned by UpdateAlias #[derive(Debug, PartialEq)] pub enum UpdateAliasError { /// <p>The system timed out while trying to fulfill the request. The request can be retried.</p> DependencyTimeout(String), /// <p>The request was rejected because an internal exception occurred. The request can be retried.</p> KMSInternal(String), /// <p>The request was rejected because the state of the specified resource is not valid for this request.</p> <p>For more information about how key state affects the use of a CMK, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">How Key State Affects Use of a Customer Master Key</a> in the <i> <i>AWS Key Management Service Developer Guide</i> </i>.</p> KMSInvalidState(String), /// <p>The request was rejected because a quota was exceeded. For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/limits.html">Quotas</a> in the <i>AWS Key Management Service Developer Guide</i>.</p> LimitExceeded(String), /// <p>The request was rejected because the specified entity or resource could not be found.</p> NotFound(String), } impl UpdateAliasError { pub fn from_response(res: BufferedHttpResponse) -> RusotoError<UpdateAliasError> { if let Some(err) = proto::json::Error::parse(&res) { match err.typ.as_str() { "DependencyTimeoutException" => { return RusotoError::Service(UpdateAliasError::DependencyTimeout(err.msg)) } "KMSInternalException" => { return RusotoError::Service(UpdateAliasError::KMSInternal(err.msg)) } "KMSInvalidStateException" => { return RusotoError::Service(UpdateAliasError::KMSInvalidState(err.msg)) } "LimitExceededException" => { return RusotoError::Service(UpdateAliasError::LimitExceeded(err.msg)) } "NotFoundException" => { return RusotoError::Service(UpdateAliasError::NotFound(err.msg)) } "ValidationException" => return RusotoError::Validation(err.msg), _ => {} } } RusotoError::Unknown(res) } } impl fmt::Display for UpdateAliasError { #[allow(unused_variables)] fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result { match *self { UpdateAliasError::DependencyTimeout(ref cause) => write!(f, "{}", cause), UpdateAliasError::KMSInternal(ref cause) => write!(f, "{}", cause), UpdateAliasError::KMSInvalidState(ref cause) => write!(f, "{}", cause), UpdateAliasError::LimitExceeded(ref cause) => write!(f, "{}", cause), UpdateAliasError::NotFound(ref cause) => write!(f, "{}", cause), } } } impl Error for UpdateAliasError {} /// Errors returned by UpdateCustomKeyStore #[derive(Debug, PartialEq)] pub enum UpdateCustomKeyStoreError { /// <p>The request was rejected because the associated AWS CloudHSM cluster did not meet the configuration requirements for a custom key store.</p> <ul> <li> <p>The cluster must be configured with private subnets in at least two different Availability Zones in the Region.</p> </li> <li> <p>The <a href="https://docs.aws.amazon.com/cloudhsm/latest/userguide/configure-sg.html">security group for the cluster</a> (cloudhsm-cluster-<i><cluster-id></i>-sg) must include inbound rules and outbound rules that allow TCP traffic on ports 2223-2225. The <b>Source</b> in the inbound rules and the <b>Destination</b> in the outbound rules must match the security group ID. These rules are set by default when you create the cluster. Do not delete or change them. To get information about a particular security group, use the <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeSecurityGroups.html">DescribeSecurityGroups</a> operation.</p> </li> <li> <p>The cluster must contain at least as many HSMs as the operation requires. To add HSMs, use the AWS CloudHSM <a href="https://docs.aws.amazon.com/cloudhsm/latest/APIReference/API_CreateHsm.html">CreateHsm</a> operation.</p> <p>For the <a>CreateCustomKeyStore</a>, <a>UpdateCustomKeyStore</a>, and <a>CreateKey</a> operations, the AWS CloudHSM cluster must have at least two active HSMs, each in a different Availability Zone. For the <a>ConnectCustomKeyStore</a> operation, the AWS CloudHSM must contain at least one active HSM.</p> </li> </ul> <p>For information about the requirements for an AWS CloudHSM cluster that is associated with a custom key store, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/create-keystore.html#before-keystore">Assemble the Prerequisites</a> in the <i>AWS Key Management Service Developer Guide</i>. For information about creating a private subnet for an AWS CloudHSM cluster, see <a href="https://docs.aws.amazon.com/cloudhsm/latest/userguide/create-subnets.html">Create a Private Subnet</a> in the <i>AWS CloudHSM User Guide</i>. For information about cluster security groups, see <a href="https://docs.aws.amazon.com/cloudhsm/latest/userguide/configure-sg.html">Configure a Default Security Group</a> in the <i> <i>AWS CloudHSM User Guide</i> </i>. </p> CloudHsmClusterInvalidConfiguration(String), /// <p>The request was rejected because the AWS CloudHSM cluster that is associated with the custom key store is not active. Initialize and activate the cluster and try the command again. For detailed instructions, see <a href="https://docs.aws.amazon.com/cloudhsm/latest/userguide/getting-started.html">Getting Started</a> in the <i>AWS CloudHSM User Guide</i>.</p> CloudHsmClusterNotActive(String), /// <p>The request was rejected because AWS KMS cannot find the AWS CloudHSM cluster with the specified cluster ID. Retry the request with a different cluster ID.</p> CloudHsmClusterNotFound(String), /// <p>The request was rejected because the specified AWS CloudHSM cluster has a different cluster certificate than the original cluster. You cannot use the operation to specify an unrelated cluster.</p> <p>Specify a cluster that shares a backup history with the original cluster. This includes clusters that were created from a backup of the current cluster, and clusters that were created from the same backup that produced the current cluster.</p> <p>Clusters that share a backup history have the same cluster certificate. To view the cluster certificate of a cluster, use the <a href="https://docs.aws.amazon.com/cloudhsm/latest/APIReference/API_DescribeClusters.html">DescribeClusters</a> operation.</p> CloudHsmClusterNotRelated(String), /// <p><p>The request was rejected because of the <code>ConnectionState</code> of the custom key store. To get the <code>ConnectionState</code> of a custom key store, use the <a>DescribeCustomKeyStores</a> operation.</p> <p>This exception is thrown under the following conditions:</p> <ul> <li> <p>You requested the <a>CreateKey</a> or <a>GenerateRandom</a> operation in a custom key store that is not connected. These operations are valid only when the custom key store <code>ConnectionState</code> is <code>CONNECTED</code>.</p> </li> <li> <p>You requested the <a>UpdateCustomKeyStore</a> or <a>DeleteCustomKeyStore</a> operation on a custom key store that is not disconnected. This operation is valid only when the custom key store <code>ConnectionState</code> is <code>DISCONNECTED</code>.</p> </li> <li> <p>You requested the <a>ConnectCustomKeyStore</a> operation on a custom key store with a <code>ConnectionState</code> of <code>DISCONNECTING</code> or <code>FAILED</code>. This operation is valid for all other <code>ConnectionState</code> values.</p> </li> </ul></p> CustomKeyStoreInvalidState(String), /// <p>The request was rejected because the specified custom key store name is already assigned to another custom key store in the account. Try again with a custom key store name that is unique in the account.</p> CustomKeyStoreNameInUse(String), /// <p>The request was rejected because AWS KMS cannot find a custom key store with the specified key store name or ID.</p> CustomKeyStoreNotFound(String), /// <p>The request was rejected because an internal exception occurred. The request can be retried.</p> KMSInternal(String), } impl UpdateCustomKeyStoreError { pub fn from_response(res: BufferedHttpResponse) -> RusotoError<UpdateCustomKeyStoreError> { if let Some(err) = proto::json::Error::parse(&res) { match err.typ.as_str() { "CloudHsmClusterInvalidConfigurationException" => { return RusotoError::Service( UpdateCustomKeyStoreError::CloudHsmClusterInvalidConfiguration(err.msg), ) } "CloudHsmClusterNotActiveException" => { return RusotoError::Service( UpdateCustomKeyStoreError::CloudHsmClusterNotActive(err.msg), ) } "CloudHsmClusterNotFoundException" => { return RusotoError::Service( UpdateCustomKeyStoreError::CloudHsmClusterNotFound(err.msg), ) } "CloudHsmClusterNotRelatedException" => { return RusotoError::Service( UpdateCustomKeyStoreError::CloudHsmClusterNotRelated(err.msg), ) } "CustomKeyStoreInvalidStateException" => { return RusotoError::Service( UpdateCustomKeyStoreError::CustomKeyStoreInvalidState(err.msg), ) } "CustomKeyStoreNameInUseException" => { return RusotoError::Service( UpdateCustomKeyStoreError::CustomKeyStoreNameInUse(err.msg), ) } "CustomKeyStoreNotFoundException" => { return RusotoError::Service(UpdateCustomKeyStoreError::CustomKeyStoreNotFound( err.msg, )) } "KMSInternalException" => { return RusotoError::Service(UpdateCustomKeyStoreError::KMSInternal(err.msg)) } "ValidationException" => return RusotoError::Validation(err.msg), _ => {} } } RusotoError::Unknown(res) } } impl fmt::Display for UpdateCustomKeyStoreError { #[allow(unused_variables)] fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result { match *self { UpdateCustomKeyStoreError::CloudHsmClusterInvalidConfiguration(ref cause) => { write!(f, "{}", cause) } UpdateCustomKeyStoreError::CloudHsmClusterNotActive(ref cause) => { write!(f, "{}", cause) } UpdateCustomKeyStoreError::CloudHsmClusterNotFound(ref cause) => write!(f, "{}", cause), UpdateCustomKeyStoreError::CloudHsmClusterNotRelated(ref cause) => { write!(f, "{}", cause) } UpdateCustomKeyStoreError::CustomKeyStoreInvalidState(ref cause) => { write!(f, "{}", cause) } UpdateCustomKeyStoreError::CustomKeyStoreNameInUse(ref cause) => write!(f, "{}", cause), UpdateCustomKeyStoreError::CustomKeyStoreNotFound(ref cause) => write!(f, "{}", cause), UpdateCustomKeyStoreError::KMSInternal(ref cause) => write!(f, "{}", cause), } } } impl Error for UpdateCustomKeyStoreError {} /// Errors returned by UpdateKeyDescription #[derive(Debug, PartialEq)] pub enum UpdateKeyDescriptionError { /// <p>The system timed out while trying to fulfill the request. The request can be retried.</p> DependencyTimeout(String), /// <p>The request was rejected because a specified ARN, or an ARN in a key policy, is not valid.</p> InvalidArn(String), /// <p>The request was rejected because an internal exception occurred. The request can be retried.</p> KMSInternal(String), /// <p>The request was rejected because the state of the specified resource is not valid for this request.</p> <p>For more information about how key state affects the use of a CMK, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">How Key State Affects Use of a Customer Master Key</a> in the <i> <i>AWS Key Management Service Developer Guide</i> </i>.</p> KMSInvalidState(String), /// <p>The request was rejected because the specified entity or resource could not be found.</p> NotFound(String), } impl UpdateKeyDescriptionError { pub fn from_response(res: BufferedHttpResponse) -> RusotoError<UpdateKeyDescriptionError> { if let Some(err) = proto::json::Error::parse(&res) { match err.typ.as_str() { "DependencyTimeoutException" => { return RusotoError::Service(UpdateKeyDescriptionError::DependencyTimeout( err.msg, )) } "InvalidArnException" => { return RusotoError::Service(UpdateKeyDescriptionError::InvalidArn(err.msg)) } "KMSInternalException" => { return RusotoError::Service(UpdateKeyDescriptionError::KMSInternal(err.msg)) } "KMSInvalidStateException" => { return RusotoError::Service(UpdateKeyDescriptionError::KMSInvalidState( err.msg, )) } "NotFoundException" => { return RusotoError::Service(UpdateKeyDescriptionError::NotFound(err.msg)) } "ValidationException" => return RusotoError::Validation(err.msg), _ => {} } } RusotoError::Unknown(res) } } impl fmt::Display for UpdateKeyDescriptionError { #[allow(unused_variables)] fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result { match *self { UpdateKeyDescriptionError::DependencyTimeout(ref cause) => write!(f, "{}", cause), UpdateKeyDescriptionError::InvalidArn(ref cause) => write!(f, "{}", cause), UpdateKeyDescriptionError::KMSInternal(ref cause) => write!(f, "{}", cause), UpdateKeyDescriptionError::KMSInvalidState(ref cause) => write!(f, "{}", cause), UpdateKeyDescriptionError::NotFound(ref cause) => write!(f, "{}", cause), } } } impl Error for UpdateKeyDescriptionError {} /// Errors returned by Verify #[derive(Debug, PartialEq)] pub enum VerifyError { /// <p>The system timed out while trying to fulfill the request. The request can be retried.</p> DependencyTimeout(String), /// <p>The request was rejected because the specified CMK is not enabled.</p> Disabled(String), /// <p>The request was rejected because the specified grant token is not valid.</p> InvalidGrantToken(String), /// <p>The request was rejected for one of the following reasons: </p> <ul> <li> <p>The <code>KeyUsage</code> value of the CMK is incompatible with the API operation.</p> </li> <li> <p>The encryption algorithm or signing algorithm specified for the operation is incompatible with the type of key material in the CMK <code>(CustomerMasterKeySpec</code>).</p> </li> </ul> <p>For encrypting, decrypting, re-encrypting, and generating data keys, the <code>KeyUsage</code> must be <code>ENCRYPT_DECRYPT</code>. For signing and verifying, the <code>KeyUsage</code> must be <code>SIGN_VERIFY</code>. To find the <code>KeyUsage</code> of a CMK, use the <a>DescribeKey</a> operation.</p> <p>To find the encryption or signing algorithms supported for a particular CMK, use the <a>DescribeKey</a> operation.</p> InvalidKeyUsage(String), /// <p>The request was rejected because an internal exception occurred. The request can be retried.</p> KMSInternal(String), /// <p>The request was rejected because the signature verification failed. Signature verification fails when it cannot confirm that signature was produced by signing the specified message with the specified CMK and signing algorithm.</p> KMSInvalidSignature(String), /// <p>The request was rejected because the state of the specified resource is not valid for this request.</p> <p>For more information about how key state affects the use of a CMK, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">How Key State Affects Use of a Customer Master Key</a> in the <i> <i>AWS Key Management Service Developer Guide</i> </i>.</p> KMSInvalidState(String), /// <p>The request was rejected because the specified CMK was not available. You can retry the request.</p> KeyUnavailable(String), /// <p>The request was rejected because the specified entity or resource could not be found.</p> NotFound(String), } impl VerifyError { pub fn from_response(res: BufferedHttpResponse) -> RusotoError<VerifyError> { if let Some(err) = proto::json::Error::parse(&res) { match err.typ.as_str() { "DependencyTimeoutException" => { return RusotoError::Service(VerifyError::DependencyTimeout(err.msg)) } "DisabledException" => return RusotoError::Service(VerifyError::Disabled(err.msg)), "InvalidGrantTokenException" => { return RusotoError::Service(VerifyError::InvalidGrantToken(err.msg)) } "InvalidKeyUsageException" => { return RusotoError::Service(VerifyError::InvalidKeyUsage(err.msg)) } "KMSInternalException" => { return RusotoError::Service(VerifyError::KMSInternal(err.msg)) } "KMSInvalidSignatureException" => { return RusotoError::Service(VerifyError::KMSInvalidSignature(err.msg)) } "KMSInvalidStateException" => { return RusotoError::Service(VerifyError::KMSInvalidState(err.msg)) } "KeyUnavailableException" => { return RusotoError::Service(VerifyError::KeyUnavailable(err.msg)) } "NotFoundException" => return RusotoError::Service(VerifyError::NotFound(err.msg)), "ValidationException" => return RusotoError::Validation(err.msg), _ => {} } } RusotoError::Unknown(res) } } impl fmt::Display for VerifyError { #[allow(unused_variables)] fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result { match *self { VerifyError::DependencyTimeout(ref cause) => write!(f, "{}", cause), VerifyError::Disabled(ref cause) => write!(f, "{}", cause), VerifyError::InvalidGrantToken(ref cause) => write!(f, "{}", cause), VerifyError::InvalidKeyUsage(ref cause) => write!(f, "{}", cause), VerifyError::KMSInternal(ref cause) => write!(f, "{}", cause), VerifyError::KMSInvalidSignature(ref cause) => write!(f, "{}", cause), VerifyError::KMSInvalidState(ref cause) => write!(f, "{}", cause), VerifyError::KeyUnavailable(ref cause) => write!(f, "{}", cause), VerifyError::NotFound(ref cause) => write!(f, "{}", cause), } } } impl Error for VerifyError {} /// Trait representing the capabilities of the KMS API. KMS clients implement this trait. #[async_trait] pub trait Kms { /// <p>Cancels the deletion of a customer master key (CMK). When this operation succeeds, the key state of the CMK is <code>Disabled</code>. To enable the CMK, use <a>EnableKey</a>. You cannot perform this operation on a CMK in a different AWS account.</p> <p>For more information about scheduling and canceling deletion of a CMK, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/deleting-keys.html">Deleting Customer Master Keys</a> in the <i>AWS Key Management Service Developer Guide</i>.</p> <p>The CMK that you use for this operation must be in a compatible key state. For details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">How Key State Affects Use of a Customer Master Key</a> in the <i>AWS Key Management Service Developer Guide</i>.</p> async fn cancel_key_deletion( &self, input: CancelKeyDeletionRequest, ) -> Result<CancelKeyDeletionResponse, RusotoError<CancelKeyDeletionError>>; /// <p>Connects or reconnects a <a href="https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html">custom key store</a> to its associated AWS CloudHSM cluster.</p> <p>The custom key store must be connected before you can create customer master keys (CMKs) in the key store or use the CMKs it contains. You can disconnect and reconnect a custom key store at any time.</p> <p>To connect a custom key store, its associated AWS CloudHSM cluster must have at least one active HSM. To get the number of active HSMs in a cluster, use the <a href="https://docs.aws.amazon.com/cloudhsm/latest/APIReference/API_DescribeClusters.html">DescribeClusters</a> operation. To add HSMs to the cluster, use the <a href="https://docs.aws.amazon.com/cloudhsm/latest/APIReference/API_CreateHsm.html">CreateHsm</a> operation. Also, the <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-store-concepts.html#concept-kmsuser"> <code>kmsuser</code> crypto user</a> (CU) must not be logged into the cluster. This prevents AWS KMS from using this account to log in.</p> <p>The connection process can take an extended amount of time to complete; up to 20 minutes. This operation starts the connection process, but it does not wait for it to complete. When it succeeds, this operation quickly returns an HTTP 200 response and a JSON object with no properties. However, this response does not indicate that the custom key store is connected. To get the connection state of the custom key store, use the <a>DescribeCustomKeyStores</a> operation.</p> <p>During the connection process, AWS KMS finds the AWS CloudHSM cluster that is associated with the custom key store, creates the connection infrastructure, connects to the cluster, logs into the AWS CloudHSM client as the <code>kmsuser</code> CU, and rotates its password.</p> <p>The <code>ConnectCustomKeyStore</code> operation might fail for various reasons. To find the reason, use the <a>DescribeCustomKeyStores</a> operation and see the <code>ConnectionErrorCode</code> in the response. For help interpreting the <code>ConnectionErrorCode</code>, see <a>CustomKeyStoresListEntry</a>.</p> <p>To fix the failure, use the <a>DisconnectCustomKeyStore</a> operation to disconnect the custom key store, correct the error, use the <a>UpdateCustomKeyStore</a> operation if necessary, and then use <code>ConnectCustomKeyStore</code> again.</p> <p>If you are having trouble connecting or disconnecting a custom key store, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/fix-keystore.html">Troubleshooting a Custom Key Store</a> in the <i>AWS Key Management Service Developer Guide</i>.</p> async fn connect_custom_key_store( &self, input: ConnectCustomKeyStoreRequest, ) -> Result<ConnectCustomKeyStoreResponse, RusotoError<ConnectCustomKeyStoreError>>; /// <p>Creates a display name for a customer managed customer master key (CMK). You can use an alias to identify a CMK in <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#cryptographic-operations">cryptographic operations</a>, such as <a>Encrypt</a> and <a>GenerateDataKey</a>. You can change the CMK associated with the alias at any time.</p> <p>Aliases are easier to remember than key IDs. They can also help to simplify your applications. For example, if you use an alias in your code, you can change the CMK your code uses by associating a given alias with a different CMK. </p> <p>To run the same code in multiple AWS regions, use an alias in your code, such as <code>alias/ApplicationKey</code>. Then, in each AWS Region, create an <code>alias/ApplicationKey</code> alias that is associated with a CMK in that Region. When you run your code, it uses the <code>alias/ApplicationKey</code> CMK for that AWS Region without any Region-specific code.</p> <p>This operation does not return a response. To get the alias that you created, use the <a>ListAliases</a> operation.</p> <p>To use aliases successfully, be aware of the following information.</p> <ul> <li> <p>Each alias points to only one CMK at a time, although a single CMK can have multiple aliases. The alias and its associated CMK must be in the same AWS account and Region. </p> </li> <li> <p>You can associate an alias with any customer managed CMK in the same AWS account and Region. However, you do not have permission to associate an alias with an <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-cmk">AWS managed CMK</a> or an <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-owned-cmk">AWS owned CMK</a>. </p> </li> <li> <p>To change the CMK associated with an alias, use the <a>UpdateAlias</a> operation. The current CMK and the new CMK must be the same type (both symmetric or both asymmetric) and they must have the same key usage (<code>ENCRYPT_DECRYPT</code> or <code>SIGN_VERIFY</code>). This restriction prevents cryptographic errors in code that uses aliases.</p> </li> <li> <p>The alias name must begin with <code>alias/</code> followed by a name, such as <code>alias/ExampleAlias</code>. It can contain only alphanumeric characters, forward slashes (/), underscores (_), and dashes (-). The alias name cannot begin with <code>alias/aws/</code>. The <code>alias/aws/</code> prefix is reserved for <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-cmk">AWS managed CMKs</a>. </p> </li> <li> <p>The alias name must be unique within an AWS Region. However, you can use the same alias name in multiple Regions of the same AWS account. Each instance of the alias is associated with a CMK in its Region.</p> </li> <li> <p>After you create an alias, you cannot change its alias name. However, you can use the <a>DeleteAlias</a> operation to delete the alias and then create a new alias with the desired name.</p> </li> <li> <p>You can use an alias name or alias ARN to identify a CMK in AWS KMS <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#cryptographic-operations">cryptographic operations</a> and in the <a>DescribeKey</a> operation. However, you cannot use alias names or alias ARNs in API operations that manage CMKs, such as <a>DisableKey</a> or <a>GetKeyPolicy</a>. For information about the valid CMK identifiers for each AWS KMS API operation, see the descriptions of the <code>KeyId</code> parameter in the API operation documentation.</p> </li> </ul> <p>Because an alias is not a property of a CMK, you can delete and change the aliases of a CMK without affecting the CMK. Also, aliases do not appear in the response from the <a>DescribeKey</a> operation. To get the aliases and alias ARNs of CMKs in each AWS account and Region, use the <a>ListAliases</a> operation.</p> <p>The CMK that you use for this operation must be in a compatible key state. For details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">How Key State Affects Use of a Customer Master Key</a> in the <i>AWS Key Management Service Developer Guide</i>.</p> async fn create_alias( &self, input: CreateAliasRequest, ) -> Result<(), RusotoError<CreateAliasError>>; /// <p>Creates a <a href="https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html">custom key store</a> that is associated with an <a href="https://docs.aws.amazon.com/cloudhsm/latest/userguide/clusters.html">AWS CloudHSM cluster</a> that you own and manage.</p> <p>This operation is part of the <a href="https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html">Custom Key Store feature</a> feature in AWS KMS, which combines the convenience and extensive integration of AWS KMS with the isolation and control of a single-tenant key store.</p> <p>Before you create the custom key store, you must assemble the required elements, including an AWS CloudHSM cluster that fulfills the requirements for a custom key store. For details about the required elements, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/create-keystore.html#before-keystore">Assemble the Prerequisites</a> in the <i>AWS Key Management Service Developer Guide</i>.</p> <p>When the operation completes successfully, it returns the ID of the new custom key store. Before you can use your new custom key store, you need to use the <a>ConnectCustomKeyStore</a> operation to connect the new key store to its AWS CloudHSM cluster. Even if you are not going to use your custom key store immediately, you might want to connect it to verify that all settings are correct and then disconnect it until you are ready to use it.</p> <p>For help with failures, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/fix-keystore.html">Troubleshooting a Custom Key Store</a> in the <i>AWS Key Management Service Developer Guide</i>.</p> async fn create_custom_key_store( &self, input: CreateCustomKeyStoreRequest, ) -> Result<CreateCustomKeyStoreResponse, RusotoError<CreateCustomKeyStoreError>>; /// <p>Adds a grant to a customer master key (CMK). The grant allows the grantee principal to use the CMK when the conditions specified in the grant are met. When setting permissions, grants are an alternative to key policies. </p> <p>To create a grant that allows a <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#cryptographic-operations">cryptographic operation</a> only when the request includes a particular <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context">encryption context</a>, use the <code>Constraints</code> parameter. For details, see <a>GrantConstraints</a>.</p> <p>You can create grants on symmetric and asymmetric CMKs. However, if the grant allows an operation that the CMK does not support, <code>CreateGrant</code> fails with a <code>ValidationException</code>. </p> <ul> <li> <p>Grants for symmetric CMKs cannot allow operations that are not supported for symmetric CMKs, including <a>Sign</a>, <a>Verify</a>, and <a>GetPublicKey</a>. (There are limited exceptions to this rule for legacy operations, but you should not create a grant for an operation that AWS KMS does not support.)</p> </li> <li> <p>Grants for asymmetric CMKs cannot allow operations that are not supported for asymmetric CMKs, including operations that <a href="https://docs.aws.amazon.com/kms/latest/APIReference/API_GenerateDataKey">generate data keys</a> or <a href="https://docs.aws.amazon.com/kms/latest/APIReference/API_GenerateDataKeyPair">data key pairs</a>, or operations related to <a href="https://docs.aws.amazon.com/kms/latest/developerguide/rotate-keys.html">automatic key rotation</a>, <a href="https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys.html">imported key material</a>, or CMKs in <a href="https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html">custom key stores</a>.</p> </li> <li> <p>Grants for asymmetric CMKs with a <code>KeyUsage</code> of <code>ENCRYPT_DECRYPT</code> cannot allow the <a>Sign</a> or <a>Verify</a> operations. Grants for asymmetric CMKs with a <code>KeyUsage</code> of <code>SIGN_VERIFY</code> cannot allow the <a>Encrypt</a> or <a>Decrypt</a> operations.</p> </li> <li> <p>Grants for asymmetric CMKs cannot include an encryption context grant constraint. An encryption context is not supported on asymmetric CMKs.</p> </li> </ul> <p>For information about symmetric and asymmetric CMKs, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html">Using Symmetric and Asymmetric CMKs</a> in the <i>AWS Key Management Service Developer Guide</i>.</p> <p>To perform this operation on a CMK in a different AWS account, specify the key ARN in the value of the <code>KeyId</code> parameter. For more information about grants, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/grants.html">Grants</a> in the <i> <i>AWS Key Management Service Developer Guide</i> </i>.</p> <p>The CMK that you use for this operation must be in a compatible key state. For details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">How Key State Affects Use of a Customer Master Key</a> in the <i>AWS Key Management Service Developer Guide</i>.</p> async fn create_grant( &self, input: CreateGrantRequest, ) -> Result<CreateGrantResponse, RusotoError<CreateGrantError>>; /// <p><p>Creates a unique customer managed <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#master-keys">customer master key</a> (CMK) in your AWS account and Region. You cannot use this operation to create a CMK in a different AWS account.</p> <p>You can use the <code>CreateKey</code> operation to create symmetric or asymmetric CMKs.</p> <ul> <li> <p> <b>Symmetric CMKs</b> contain a 256-bit symmetric key that never leaves AWS KMS unencrypted. To use the CMK, you must call AWS KMS. You can use a symmetric CMK to encrypt and decrypt small amounts of data, but they are typically used to generate <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#data-keys">data keys</a> and <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#data-key-pairs">data keys pairs</a>. For details, see <a>GenerateDataKey</a> and <a>GenerateDataKeyPair</a>.</p> </li> <li> <p> <b>Asymmetric CMKs</b> can contain an RSA key pair or an Elliptic Curve (ECC) key pair. The private key in an asymmetric CMK never leaves AWS KMS unencrypted. However, you can use the <a>GetPublicKey</a> operation to download the public key so it can be used outside of AWS KMS. CMKs with RSA key pairs can be used to encrypt or decrypt data or sign and verify messages (but not both). CMKs with ECC key pairs can be used only to sign and verify messages.</p> </li> </ul> <p>For information about symmetric and asymmetric CMKs, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html">Using Symmetric and Asymmetric CMKs</a> in the <i>AWS Key Management Service Developer Guide</i>.</p> <p>To create different types of CMKs, use the following guidance:</p> <dl> <dt>Asymmetric CMKs</dt> <dd> <p>To create an asymmetric CMK, use the <code>CustomerMasterKeySpec</code> parameter to specify the type of key material in the CMK. Then, use the <code>KeyUsage</code> parameter to determine whether the CMK will be used to encrypt and decrypt or sign and verify. You can't change these properties after the CMK is created.</p> <p> </p> </dd> <dt>Symmetric CMKs</dt> <dd> <p>When creating a symmetric CMK, you don't need to specify the <code>CustomerMasterKeySpec</code> or <code>KeyUsage</code> parameters. The default value for <code>CustomerMasterKeySpec</code>, <code>SYMMETRIC<em>DEFAULT</code>, and the default value for <code>KeyUsage</code>, <code>ENCRYPT</em>DECRYPT</code>, are the only valid values for symmetric CMKs. </p> <p> </p> </dd> <dt>Imported Key Material</dt> <dd> <p>To import your own key material, begin by creating a symmetric CMK with no key material. To do this, use the <code>Origin</code> parameter of <code>CreateKey</code> with a value of <code>EXTERNAL</code>. Next, use <a>GetParametersForImport</a> operation to get a public key and import token, and use the public key to encrypt your key material. Then, use <a>ImportKeyMaterial</a> with your import token to import the key material. For step-by-step instructions, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys.html">Importing Key Material</a> in the <i> <i>AWS Key Management Service Developer Guide</i> </i>. You cannot import the key material into an asymmetric CMK.</p> <p> </p> </dd> <dt>Custom Key Stores</dt> <dd> <p>To create a symmetric CMK in a <a href="https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html">custom key store</a>, use the <code>CustomKeyStoreId</code> parameter to specify the custom key store. You must also use the <code>Origin</code> parameter with a value of <code>AWS_CLOUDHSM</code>. The AWS CloudHSM cluster that is associated with the custom key store must have at least two active HSMs in different Availability Zones in the AWS Region. </p> <p>You cannot create an asymmetric CMK in a custom key store. For information about custom key stores in AWS KMS see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html">Using Custom Key Stores</a> in the <i> <i>AWS Key Management Service Developer Guide</i> </i>.</p> </dd> </dl></p> async fn create_key( &self, input: CreateKeyRequest, ) -> Result<CreateKeyResponse, RusotoError<CreateKeyError>>; /// <p>Decrypts ciphertext that was encrypted by a AWS KMS customer master key (CMK) using any of the following operations:</p> <ul> <li> <p> <a>Encrypt</a> </p> </li> <li> <p> <a>GenerateDataKey</a> </p> </li> <li> <p> <a>GenerateDataKeyPair</a> </p> </li> <li> <p> <a>GenerateDataKeyWithoutPlaintext</a> </p> </li> <li> <p> <a>GenerateDataKeyPairWithoutPlaintext</a> </p> </li> </ul> <p>You can use this operation to decrypt ciphertext that was encrypted under a symmetric or asymmetric CMK. When the CMK is asymmetric, you must specify the CMK and the encryption algorithm that was used to encrypt the ciphertext. For information about symmetric and asymmetric CMKs, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html">Using Symmetric and Asymmetric CMKs</a> in the <i>AWS Key Management Service Developer Guide</i>.</p> <p>The Decrypt operation also decrypts ciphertext that was encrypted outside of AWS KMS by the public key in an AWS KMS asymmetric CMK. However, it cannot decrypt ciphertext produced by other libraries, such as the <a href="https://docs.aws.amazon.com/encryption-sdk/latest/developer-guide/">AWS Encryption SDK</a> or <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingClientSideEncryption.html">Amazon S3 client-side encryption</a>. These libraries return a ciphertext format that is incompatible with AWS KMS.</p> <p>If the ciphertext was encrypted under a symmetric CMK, you do not need to specify the CMK or the encryption algorithm. AWS KMS can get this information from metadata that it adds to the symmetric ciphertext blob. However, if you prefer, you can specify the <code>KeyId</code> to ensure that a particular CMK is used to decrypt the ciphertext. If you specify a different CMK than the one used to encrypt the ciphertext, the <code>Decrypt</code> operation fails.</p> <p>Whenever possible, use key policies to give users permission to call the Decrypt operation on a particular CMK, instead of using IAM policies. Otherwise, you might create an IAM user policy that gives the user Decrypt permission on all CMKs. This user could decrypt ciphertext that was encrypted by CMKs in other accounts if the key policy for the cross-account CMK permits it. If you must use an IAM policy for <code>Decrypt</code> permissions, limit the user to particular CMKs or particular trusted accounts.</p> <p>The CMK that you use for this operation must be in a compatible key state. For details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">How Key State Affects Use of a Customer Master Key</a> in the <i>AWS Key Management Service Developer Guide</i>.</p> async fn decrypt( &self, input: DecryptRequest, ) -> Result<DecryptResponse, RusotoError<DecryptError>>; /// <p>Deletes the specified alias. You cannot perform this operation on an alias in a different AWS account. </p> <p>Because an alias is not a property of a CMK, you can delete and change the aliases of a CMK without affecting the CMK. Also, aliases do not appear in the response from the <a>DescribeKey</a> operation. To get the aliases of all CMKs, use the <a>ListAliases</a> operation. </p> <p>Each CMK can have multiple aliases. To change the alias of a CMK, use <a>DeleteAlias</a> to delete the current alias and <a>CreateAlias</a> to create a new alias. To associate an existing alias with a different customer master key (CMK), call <a>UpdateAlias</a>.</p> async fn delete_alias( &self, input: DeleteAliasRequest, ) -> Result<(), RusotoError<DeleteAliasError>>; /// <p>Deletes a <a href="https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html">custom key store</a>. This operation does not delete the AWS CloudHSM cluster that is associated with the custom key store, or affect any users or keys in the cluster.</p> <p>The custom key store that you delete cannot contain any AWS KMS <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#master_keys">customer master keys (CMKs)</a>. Before deleting the key store, verify that you will never need to use any of the CMKs in the key store for any <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#cryptographic-operations">cryptographic operations</a>. Then, use <a>ScheduleKeyDeletion</a> to delete the AWS KMS customer master keys (CMKs) from the key store. When the scheduled waiting period expires, the <code>ScheduleKeyDeletion</code> operation deletes the CMKs. Then it makes a best effort to delete the key material from the associated cluster. However, you might need to manually <a href="https://docs.aws.amazon.com/kms/latest/developerguide/fix-keystore.html#fix-keystore-orphaned-key">delete the orphaned key material</a> from the cluster and its backups.</p> <p>After all CMKs are deleted from AWS KMS, use <a>DisconnectCustomKeyStore</a> to disconnect the key store from AWS KMS. Then, you can delete the custom key store.</p> <p>Instead of deleting the custom key store, consider using <a>DisconnectCustomKeyStore</a> to disconnect it from AWS KMS. While the key store is disconnected, you cannot create or use the CMKs in the key store. But, you do not need to delete CMKs and you can reconnect a disconnected custom key store at any time.</p> <p>If the operation succeeds, it returns a JSON object with no properties.</p> <p>This operation is part of the <a href="https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html">Custom Key Store feature</a> feature in AWS KMS, which combines the convenience and extensive integration of AWS KMS with the isolation and control of a single-tenant key store.</p> async fn delete_custom_key_store( &self, input: DeleteCustomKeyStoreRequest, ) -> Result<DeleteCustomKeyStoreResponse, RusotoError<DeleteCustomKeyStoreError>>; /// <p>Deletes key material that you previously imported. This operation makes the specified customer master key (CMK) unusable. For more information about importing key material into AWS KMS, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys.html">Importing Key Material</a> in the <i>AWS Key Management Service Developer Guide</i>. You cannot perform this operation on a CMK in a different AWS account.</p> <p>When the specified CMK is in the <code>PendingDeletion</code> state, this operation does not change the CMK's state. Otherwise, it changes the CMK's state to <code>PendingImport</code>.</p> <p>After you delete key material, you can use <a>ImportKeyMaterial</a> to reimport the same key material into the CMK.</p> <p>The CMK that you use for this operation must be in a compatible key state. For details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">How Key State Affects Use of a Customer Master Key</a> in the <i>AWS Key Management Service Developer Guide</i>.</p> async fn delete_imported_key_material( &self, input: DeleteImportedKeyMaterialRequest, ) -> Result<(), RusotoError<DeleteImportedKeyMaterialError>>; /// <p>Gets information about <a href="https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html">custom key stores</a> in the account and region.</p> <p>This operation is part of the <a href="https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html">Custom Key Store feature</a> feature in AWS KMS, which combines the convenience and extensive integration of AWS KMS with the isolation and control of a single-tenant key store.</p> <p>By default, this operation returns information about all custom key stores in the account and region. To get only information about a particular custom key store, use either the <code>CustomKeyStoreName</code> or <code>CustomKeyStoreId</code> parameter (but not both).</p> <p>To determine whether the custom key store is connected to its AWS CloudHSM cluster, use the <code>ConnectionState</code> element in the response. If an attempt to connect the custom key store failed, the <code>ConnectionState</code> value is <code>FAILED</code> and the <code>ConnectionErrorCode</code> element in the response indicates the cause of the failure. For help interpreting the <code>ConnectionErrorCode</code>, see <a>CustomKeyStoresListEntry</a>.</p> <p>Custom key stores have a <code>DISCONNECTED</code> connection state if the key store has never been connected or you use the <a>DisconnectCustomKeyStore</a> operation to disconnect it. If your custom key store state is <code>CONNECTED</code> but you are having trouble using it, make sure that its associated AWS CloudHSM cluster is active and contains the minimum number of HSMs required for the operation, if any.</p> <p> For help repairing your custom key store, see the <a href="https://docs.aws.amazon.com/kms/latest/developerguide/fix-keystore.html">Troubleshooting Custom Key Stores</a> topic in the <i>AWS Key Management Service Developer Guide</i>.</p> async fn describe_custom_key_stores( &self, input: DescribeCustomKeyStoresRequest, ) -> Result<DescribeCustomKeyStoresResponse, RusotoError<DescribeCustomKeyStoresError>>; /// <p>Provides detailed information about a customer master key (CMK). You can run <code>DescribeKey</code> on a <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#customer-cmk">customer managed CMK</a> or an <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-cmk">AWS managed CMK</a>.</p> <p>This detailed information includes the key ARN, creation date (and deletion date, if applicable), the key state, and the origin and expiration date (if any) of the key material. For CMKs in custom key stores, it includes information about the custom key store, such as the key store ID and the AWS CloudHSM cluster ID. It includes fields, like <code>KeySpec</code>, that help you distinguish symmetric from asymmetric CMKs. It also provides information that is particularly important to asymmetric CMKs, such as the key usage (encryption or signing) and the encryption algorithms or signing algorithms that the CMK supports.</p> <p> <code>DescribeKey</code> does not return the following information:</p> <ul> <li> <p>Aliases associated with the CMK. To get this information, use <a>ListAliases</a>.</p> </li> <li> <p>Whether automatic key rotation is enabled on the CMK. To get this information, use <a>GetKeyRotationStatus</a>. Also, some key states prevent a CMK from being automatically rotated. For details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/rotate-keys.html#rotate-keys-how-it-works">How Automatic Key Rotation Works</a> in <i>AWS Key Management Service Developer Guide</i>.</p> </li> <li> <p>Tags on the CMK. To get this information, use <a>ListResourceTags</a>.</p> </li> <li> <p>Key policies and grants on the CMK. To get this information, use <a>GetKeyPolicy</a> and <a>ListGrants</a>.</p> </li> </ul> <p>If you call the <code>DescribeKey</code> operation on a <i>predefined AWS alias</i>, that is, an AWS alias with no key ID, AWS KMS creates an <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#master_keys">AWS managed CMK</a>. Then, it associates the alias with the new CMK, and returns the <code>KeyId</code> and <code>Arn</code> of the new CMK in the response.</p> <p>To perform this operation on a CMK in a different AWS account, specify the key ARN or alias ARN in the value of the KeyId parameter.</p> async fn describe_key( &self, input: DescribeKeyRequest, ) -> Result<DescribeKeyResponse, RusotoError<DescribeKeyError>>; /// <p>Sets the state of a customer master key (CMK) to disabled, thereby preventing its use for <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#cryptographic-operations">cryptographic operations</a>. You cannot perform this operation on a CMK in a different AWS account.</p> <p>For more information about how key state affects the use of a CMK, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">How Key State Affects the Use of a Customer Master Key</a> in the <i> <i>AWS Key Management Service Developer Guide</i> </i>.</p> <p>The CMK that you use for this operation must be in a compatible key state. For details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">How Key State Affects Use of a Customer Master Key</a> in the <i>AWS Key Management Service Developer Guide</i>.</p> async fn disable_key( &self, input: DisableKeyRequest, ) -> Result<(), RusotoError<DisableKeyError>>; /// <p>Disables <a href="https://docs.aws.amazon.com/kms/latest/developerguide/rotate-keys.html">automatic rotation of the key material</a> for the specified symmetric customer master key (CMK).</p> <p> You cannot enable automatic rotation of asymmetric CMKs, CMKs with imported key material, or CMKs in a <a href="https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html">custom key store</a>. You cannot perform this operation on a CMK in a different AWS account.</p> <p>The CMK that you use for this operation must be in a compatible key state. For details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">How Key State Affects Use of a Customer Master Key</a> in the <i>AWS Key Management Service Developer Guide</i>.</p> async fn disable_key_rotation( &self, input: DisableKeyRotationRequest, ) -> Result<(), RusotoError<DisableKeyRotationError>>; /// <p>Disconnects the <a href="https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html">custom key store</a> from its associated AWS CloudHSM cluster. While a custom key store is disconnected, you can manage the custom key store and its customer master keys (CMKs), but you cannot create or use CMKs in the custom key store. You can reconnect the custom key store at any time.</p> <note> <p>While a custom key store is disconnected, all attempts to create customer master keys (CMKs) in the custom key store or to use existing CMKs in <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#cryptographic-operations">cryptographic operations</a> will fail. This action can prevent users from storing and accessing sensitive data.</p> </note> <p/> <p>To find the connection state of a custom key store, use the <a>DescribeCustomKeyStores</a> operation. To reconnect a custom key store, use the <a>ConnectCustomKeyStore</a> operation.</p> <p>If the operation succeeds, it returns a JSON object with no properties.</p> <p>This operation is part of the <a href="https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html">Custom Key Store feature</a> feature in AWS KMS, which combines the convenience and extensive integration of AWS KMS with the isolation and control of a single-tenant key store.</p> async fn disconnect_custom_key_store( &self, input: DisconnectCustomKeyStoreRequest, ) -> Result<DisconnectCustomKeyStoreResponse, RusotoError<DisconnectCustomKeyStoreError>>; /// <p>Sets the key state of a customer master key (CMK) to enabled. This allows you to use the CMK for <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#cryptographic-operations">cryptographic operations</a>. You cannot perform this operation on a CMK in a different AWS account.</p> <p>The CMK that you use for this operation must be in a compatible key state. For details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">How Key State Affects Use of a Customer Master Key</a> in the <i>AWS Key Management Service Developer Guide</i>.</p> async fn enable_key(&self, input: EnableKeyRequest) -> Result<(), RusotoError<EnableKeyError>>; /// <p>Enables <a href="https://docs.aws.amazon.com/kms/latest/developerguide/rotate-keys.html">automatic rotation of the key material</a> for the specified symmetric customer master key (CMK). You cannot perform this operation on a CMK in a different AWS account.</p> <p>You cannot enable automatic rotation of asymmetric CMKs, CMKs with imported key material, or CMKs in a <a href="https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html">custom key store</a>.</p> <p>The CMK that you use for this operation must be in a compatible key state. For details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">How Key State Affects Use of a Customer Master Key</a> in the <i>AWS Key Management Service Developer Guide</i>.</p> async fn enable_key_rotation( &self, input: EnableKeyRotationRequest, ) -> Result<(), RusotoError<EnableKeyRotationError>>; /// <p>Encrypts plaintext into ciphertext by using a customer master key (CMK). The <code>Encrypt</code> operation has two primary use cases:</p> <ul> <li> <p>You can encrypt small amounts of arbitrary data, such as a personal identifier or database password, or other sensitive information. </p> </li> <li> <p>You can use the <code>Encrypt</code> operation to move encrypted data from one AWS Region to another. For example, in Region A, generate a data key and use the plaintext key to encrypt your data. Then, in Region A, use the <code>Encrypt</code> operation to encrypt the plaintext data key under a CMK in Region B. Now, you can move the encrypted data and the encrypted data key to Region B. When necessary, you can decrypt the encrypted data key and the encrypted data entirely within in Region B.</p> </li> </ul> <p>You don't need to use the <code>Encrypt</code> operation to encrypt a data key. The <a>GenerateDataKey</a> and <a>GenerateDataKeyPair</a> operations return a plaintext data key and an encrypted copy of that data key.</p> <p>When you encrypt data, you must specify a symmetric or asymmetric CMK to use in the encryption operation. The CMK must have a <code>KeyUsage</code> value of <code>ENCRYPT_DECRYPT.</code> To find the <code>KeyUsage</code> of a CMK, use the <a>DescribeKey</a> operation. </p> <p>If you use a symmetric CMK, you can use an encryption context to add additional security to your encryption operation. If you specify an <code>EncryptionContext</code> when encrypting data, you must specify the same encryption context (a case-sensitive exact match) when decrypting the data. Otherwise, the request to decrypt fails with an <code>InvalidCiphertextException</code>. For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context">Encryption Context</a> in the <i>AWS Key Management Service Developer Guide</i>.</p> <p>If you specify an asymmetric CMK, you must also specify the encryption algorithm. The algorithm must be compatible with the CMK type.</p> <important> <p>When you use an asymmetric CMK to encrypt or reencrypt data, be sure to record the CMK and encryption algorithm that you choose. You will be required to provide the same CMK and encryption algorithm when you decrypt the data. If the CMK and algorithm do not match the values used to encrypt the data, the decrypt operation fails.</p> <p>You are not required to supply the CMK ID and encryption algorithm when you decrypt with symmetric CMKs because AWS KMS stores this information in the ciphertext blob. AWS KMS cannot store metadata in ciphertext generated with asymmetric keys. The standard format for asymmetric key ciphertext does not include configurable fields.</p> </important> <p>The maximum size of the data that you can encrypt varies with the type of CMK and the encryption algorithm that you choose.</p> <ul> <li> <p>Symmetric CMKs</p> <ul> <li> <p> <code>SYMMETRIC_DEFAULT</code>: 4096 bytes</p> </li> </ul> </li> <li> <p> <code>RSA_2048</code> </p> <ul> <li> <p> <code>RSAES_OAEP_SHA_1</code>: 214 bytes</p> </li> <li> <p> <code>RSAES_OAEP_SHA_256</code>: 190 bytes</p> </li> </ul> </li> <li> <p> <code>RSA_3072</code> </p> <ul> <li> <p> <code>RSAES_OAEP_SHA_1</code>: 342 bytes</p> </li> <li> <p> <code>RSAES_OAEP_SHA_256</code>: 318 bytes</p> </li> </ul> </li> <li> <p> <code>RSA_4096</code> </p> <ul> <li> <p> <code>RSAES_OAEP_SHA_1</code>: 470 bytes</p> </li> <li> <p> <code>RSAES_OAEP_SHA_256</code>: 446 bytes</p> </li> </ul> </li> </ul> <p>The CMK that you use for this operation must be in a compatible key state. For details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">How Key State Affects Use of a Customer Master Key</a> in the <i>AWS Key Management Service Developer Guide</i>.</p> <p>To perform this operation on a CMK in a different AWS account, specify the key ARN or alias ARN in the value of the KeyId parameter.</p> async fn encrypt( &self, input: EncryptRequest, ) -> Result<EncryptResponse, RusotoError<EncryptError>>; /// <p><p>Generates a unique symmetric data key for client-side encryption. This operation returns a plaintext copy of the data key and a copy that is encrypted under a customer master key (CMK) that you specify. You can use the plaintext key to encrypt your data outside of AWS KMS and store the encrypted data key with the encrypted data.</p> <p> <code>GenerateDataKey</code> returns a unique data key for each request. The bytes in the plaintext key are not related to the caller or the CMK.</p> <p>To generate a data key, specify the symmetric CMK that will be used to encrypt the data key. You cannot use an asymmetric CMK to generate data keys. To get the type of your CMK, use the <a>DescribeKey</a> operation. You must also specify the length of the data key. Use either the <code>KeySpec</code> or <code>NumberOfBytes</code> parameters (but not both). For 128-bit and 256-bit data keys, use the <code>KeySpec</code> parameter. </p> <p>To get only an encrypted copy of the data key, use <a>GenerateDataKeyWithoutPlaintext</a>. To generate an asymmetric data key pair, use the <a>GenerateDataKeyPair</a> or <a>GenerateDataKeyPairWithoutPlaintext</a> operation. To get a cryptographically secure random byte string, use <a>GenerateRandom</a>.</p> <p>You can use the optional encryption context to add additional security to the encryption operation. If you specify an <code>EncryptionContext</code>, you must specify the same encryption context (a case-sensitive exact match) when decrypting the encrypted data key. Otherwise, the request to decrypt fails with an <code>InvalidCiphertextException</code>. For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context">Encryption Context</a> in the <i>AWS Key Management Service Developer Guide</i>.</p> <p>The CMK that you use for this operation must be in a compatible key state. For details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">How Key State Affects Use of a Customer Master Key</a> in the <i>AWS Key Management Service Developer Guide</i>.</p> <p> <b>How to use your data key</b> </p> <p>We recommend that you use the following pattern to encrypt data locally in your application. You can write your own code or use a client-side encryption library, such as the <a href="https://docs.aws.amazon.com/encryption-sdk/latest/developer-guide/">AWS Encryption SDK</a>, the <a href="https://docs.aws.amazon.com/dynamodb-encryption-client/latest/devguide/">Amazon DynamoDB Encryption Client</a>, or <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingClientSideEncryption.html">Amazon S3 client-side encryption</a> to do these tasks for you.</p> <p>To encrypt data outside of AWS KMS:</p> <ol> <li> <p>Use the <code>GenerateDataKey</code> operation to get a data key.</p> </li> <li> <p>Use the plaintext data key (in the <code>Plaintext</code> field of the response) to encrypt your data outside of AWS KMS. Then erase the plaintext data key from memory.</p> </li> <li> <p>Store the encrypted data key (in the <code>CiphertextBlob</code> field of the response) with the encrypted data.</p> </li> </ol> <p>To decrypt data outside of AWS KMS:</p> <ol> <li> <p>Use the <a>Decrypt</a> operation to decrypt the encrypted data key. The operation returns a plaintext copy of the data key.</p> </li> <li> <p>Use the plaintext data key to decrypt data outside of AWS KMS, then erase the plaintext data key from memory.</p> </li> </ol></p> async fn generate_data_key( &self, input: GenerateDataKeyRequest, ) -> Result<GenerateDataKeyResponse, RusotoError<GenerateDataKeyError>>; /// <p>Generates a unique asymmetric data key pair. The <code>GenerateDataKeyPair</code> operation returns a plaintext public key, a plaintext private key, and a copy of the private key that is encrypted under the symmetric CMK you specify. You can use the data key pair to perform asymmetric cryptography outside of AWS KMS.</p> <p> <code>GenerateDataKeyPair</code> returns a unique data key pair for each request. The bytes in the keys are not related to the caller or the CMK that is used to encrypt the private key.</p> <p>You can use the public key that <code>GenerateDataKeyPair</code> returns to encrypt data or verify a signature outside of AWS KMS. Then, store the encrypted private key with the data. When you are ready to decrypt data or sign a message, you can use the <a>Decrypt</a> operation to decrypt the encrypted private key.</p> <p>To generate a data key pair, you must specify a symmetric customer master key (CMK) to encrypt the private key in a data key pair. You cannot use an asymmetric CMK or a CMK in a custom key store. To get the type and origin of your CMK, use the <a>DescribeKey</a> operation. </p> <p>If you are using the data key pair to encrypt data, or for any operation where you don't immediately need a private key, consider using the <a>GenerateDataKeyPairWithoutPlaintext</a> operation. <code>GenerateDataKeyPairWithoutPlaintext</code> returns a plaintext public key and an encrypted private key, but omits the plaintext private key that you need only to decrypt ciphertext or sign a message. Later, when you need to decrypt the data or sign a message, use the <a>Decrypt</a> operation to decrypt the encrypted private key in the data key pair.</p> <p>You can use the optional encryption context to add additional security to the encryption operation. If you specify an <code>EncryptionContext</code>, you must specify the same encryption context (a case-sensitive exact match) when decrypting the encrypted data key. Otherwise, the request to decrypt fails with an <code>InvalidCiphertextException</code>. For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context">Encryption Context</a> in the <i>AWS Key Management Service Developer Guide</i>.</p> <p>The CMK that you use for this operation must be in a compatible key state. For details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">How Key State Affects Use of a Customer Master Key</a> in the <i>AWS Key Management Service Developer Guide</i>.</p> async fn generate_data_key_pair( &self, input: GenerateDataKeyPairRequest, ) -> Result<GenerateDataKeyPairResponse, RusotoError<GenerateDataKeyPairError>>; /// <p>Generates a unique asymmetric data key pair. The <code>GenerateDataKeyPairWithoutPlaintext</code> operation returns a plaintext public key and a copy of the private key that is encrypted under the symmetric CMK you specify. Unlike <a>GenerateDataKeyPair</a>, this operation does not return a plaintext private key. </p> <p>To generate a data key pair, you must specify a symmetric customer master key (CMK) to encrypt the private key in the data key pair. You cannot use an asymmetric CMK or a CMK in a custom key store. To get the type and origin of your CMK, use the <code>KeySpec</code> field in the <a>DescribeKey</a> response.</p> <p>You can use the public key that <code>GenerateDataKeyPairWithoutPlaintext</code> returns to encrypt data or verify a signature outside of AWS KMS. Then, store the encrypted private key with the data. When you are ready to decrypt data or sign a message, you can use the <a>Decrypt</a> operation to decrypt the encrypted private key.</p> <p> <code>GenerateDataKeyPairWithoutPlaintext</code> returns a unique data key pair for each request. The bytes in the key are not related to the caller or CMK that is used to encrypt the private key.</p> <p>You can use the optional encryption context to add additional security to the encryption operation. If you specify an <code>EncryptionContext</code>, you must specify the same encryption context (a case-sensitive exact match) when decrypting the encrypted data key. Otherwise, the request to decrypt fails with an <code>InvalidCiphertextException</code>. For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context">Encryption Context</a> in the <i>AWS Key Management Service Developer Guide</i>.</p> <p>The CMK that you use for this operation must be in a compatible key state. For details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">How Key State Affects Use of a Customer Master Key</a> in the <i>AWS Key Management Service Developer Guide</i>.</p> async fn generate_data_key_pair_without_plaintext( &self, input: GenerateDataKeyPairWithoutPlaintextRequest, ) -> Result< GenerateDataKeyPairWithoutPlaintextResponse, RusotoError<GenerateDataKeyPairWithoutPlaintextError>, >; /// <p>Generates a unique symmetric data key. This operation returns a data key that is encrypted under a customer master key (CMK) that you specify. To request an asymmetric data key pair, use the <a>GenerateDataKeyPair</a> or <a>GenerateDataKeyPairWithoutPlaintext</a> operations.</p> <p> <code>GenerateDataKeyWithoutPlaintext</code> is identical to the <a>GenerateDataKey</a> operation except that returns only the encrypted copy of the data key. This operation is useful for systems that need to encrypt data at some point, but not immediately. When you need to encrypt the data, you call the <a>Decrypt</a> operation on the encrypted copy of the key. </p> <p>It's also useful in distributed systems with different levels of trust. For example, you might store encrypted data in containers. One component of your system creates new containers and stores an encrypted data key with each container. Then, a different component puts the data into the containers. That component first decrypts the data key, uses the plaintext data key to encrypt data, puts the encrypted data into the container, and then destroys the plaintext data key. In this system, the component that creates the containers never sees the plaintext data key.</p> <p> <code>GenerateDataKeyWithoutPlaintext</code> returns a unique data key for each request. The bytes in the keys are not related to the caller or CMK that is used to encrypt the private key.</p> <p>To generate a data key, you must specify the symmetric customer master key (CMK) that is used to encrypt the data key. You cannot use an asymmetric CMK to generate a data key. To get the type of your CMK, use the <a>DescribeKey</a> operation.</p> <p>If the operation succeeds, you will find the encrypted copy of the data key in the <code>CiphertextBlob</code> field.</p> <p>You can use the optional encryption context to add additional security to the encryption operation. If you specify an <code>EncryptionContext</code>, you must specify the same encryption context (a case-sensitive exact match) when decrypting the encrypted data key. Otherwise, the request to decrypt fails with an <code>InvalidCiphertextException</code>. For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context">Encryption Context</a> in the <i>AWS Key Management Service Developer Guide</i>.</p> <p>The CMK that you use for this operation must be in a compatible key state. For details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">How Key State Affects Use of a Customer Master Key</a> in the <i>AWS Key Management Service Developer Guide</i>.</p> async fn generate_data_key_without_plaintext( &self, input: GenerateDataKeyWithoutPlaintextRequest, ) -> Result< GenerateDataKeyWithoutPlaintextResponse, RusotoError<GenerateDataKeyWithoutPlaintextError>, >; /// <p>Returns a random byte string that is cryptographically secure.</p> <p>By default, the random byte string is generated in AWS KMS. To generate the byte string in the AWS CloudHSM cluster that is associated with a <a href="https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html">custom key store</a>, specify the custom key store ID.</p> <p>For more information about entropy and random number generation, see the <a href="https://d0.awsstatic.com/whitepapers/KMS-Cryptographic-Details.pdf">AWS Key Management Service Cryptographic Details</a> whitepaper.</p> async fn generate_random( &self, input: GenerateRandomRequest, ) -> Result<GenerateRandomResponse, RusotoError<GenerateRandomError>>; /// <p>Gets a key policy attached to the specified customer master key (CMK). You cannot perform this operation on a CMK in a different AWS account.</p> async fn get_key_policy( &self, input: GetKeyPolicyRequest, ) -> Result<GetKeyPolicyResponse, RusotoError<GetKeyPolicyError>>; /// <p>Gets a Boolean value that indicates whether <a href="https://docs.aws.amazon.com/kms/latest/developerguide/rotate-keys.html">automatic rotation of the key material</a> is enabled for the specified customer master key (CMK).</p> <p>You cannot enable automatic rotation of asymmetric CMKs, CMKs with imported key material, or CMKs in a <a href="https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html">custom key store</a>. The key rotation status for these CMKs is always <code>false</code>.</p> <p>The CMK that you use for this operation must be in a compatible key state. For details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">How Key State Affects Use of a Customer Master Key</a> in the <i>AWS Key Management Service Developer Guide</i>.</p> <ul> <li> <p>Disabled: The key rotation status does not change when you disable a CMK. However, while the CMK is disabled, AWS KMS does not rotate the backing key.</p> </li> <li> <p>Pending deletion: While a CMK is pending deletion, its key rotation status is <code>false</code> and AWS KMS does not rotate the backing key. If you cancel the deletion, the original key rotation status is restored.</p> </li> </ul> <p>To perform this operation on a CMK in a different AWS account, specify the key ARN in the value of the <code>KeyId</code> parameter.</p> async fn get_key_rotation_status( &self, input: GetKeyRotationStatusRequest, ) -> Result<GetKeyRotationStatusResponse, RusotoError<GetKeyRotationStatusError>>; /// <p>Returns the items you need to import key material into a symmetric, customer managed customer master key (CMK). For more information about importing key material into AWS KMS, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys.html">Importing Key Material</a> in the <i>AWS Key Management Service Developer Guide</i>.</p> <p>This operation returns a public key and an import token. Use the public key to encrypt the symmetric key material. Store the import token to send with a subsequent <a>ImportKeyMaterial</a> request.</p> <p>You must specify the key ID of the symmetric CMK into which you will import key material. This CMK's <code>Origin</code> must be <code>EXTERNAL</code>. You must also specify the wrapping algorithm and type of wrapping key (public key) that you will use to encrypt the key material. You cannot perform this operation on an asymmetric CMK or on any CMK in a different AWS account.</p> <p>To import key material, you must use the public key and import token from the same response. These items are valid for 24 hours. The expiration date and time appear in the <code>GetParametersForImport</code> response. You cannot use an expired token in an <a>ImportKeyMaterial</a> request. If your key and token expire, send another <code>GetParametersForImport</code> request.</p> <p>The CMK that you use for this operation must be in a compatible key state. For details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">How Key State Affects Use of a Customer Master Key</a> in the <i>AWS Key Management Service Developer Guide</i>.</p> async fn get_parameters_for_import( &self, input: GetParametersForImportRequest, ) -> Result<GetParametersForImportResponse, RusotoError<GetParametersForImportError>>; /// <p>Returns the public key of an asymmetric CMK. Unlike the private key of a asymmetric CMK, which never leaves AWS KMS unencrypted, callers with <code>kms:GetPublicKey</code> permission can download the public key of an asymmetric CMK. You can share the public key to allow others to encrypt messages and verify signatures outside of AWS KMS. For information about symmetric and asymmetric CMKs, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html">Using Symmetric and Asymmetric CMKs</a> in the <i>AWS Key Management Service Developer Guide</i>.</p> <p>You do not need to download the public key. Instead, you can use the public key within AWS KMS by calling the <a>Encrypt</a>, <a>ReEncrypt</a>, or <a>Verify</a> operations with the identifier of an asymmetric CMK. When you use the public key within AWS KMS, you benefit from the authentication, authorization, and logging that are part of every AWS KMS operation. You also reduce of risk of encrypting data that cannot be decrypted. These features are not effective outside of AWS KMS. For details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/download-public-key.html#download-public-key-considerations">Special Considerations for Downloading Public Keys</a>.</p> <p>To help you use the public key safely outside of AWS KMS, <code>GetPublicKey</code> returns important information about the public key in the response, including:</p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/kms/latest/APIReference/API_GetPublicKey.html#KMS-GetPublicKey-response-CustomerMasterKeySpec">CustomerMasterKeySpec</a>: The type of key material in the public key, such as <code>RSA_4096</code> or <code>ECC_NIST_P521</code>.</p> </li> <li> <p> <a href="https://docs.aws.amazon.com/kms/latest/APIReference/API_GetPublicKey.html#KMS-GetPublicKey-response-KeyUsage">KeyUsage</a>: Whether the key is used for encryption or signing.</p> </li> <li> <p> <a href="https://docs.aws.amazon.com/kms/latest/APIReference/API_GetPublicKey.html#KMS-GetPublicKey-response-EncryptionAlgorithms">EncryptionAlgorithms</a> or <a href="https://docs.aws.amazon.com/kms/latest/APIReference/API_GetPublicKey.html#KMS-GetPublicKey-response-SigningAlgorithms">SigningAlgorithms</a>: A list of the encryption algorithms or the signing algorithms for the key.</p> </li> </ul> <p>Although AWS KMS cannot enforce these restrictions on external operations, it is crucial that you use this information to prevent the public key from being used improperly. For example, you can prevent a public signing key from being used encrypt data, or prevent a public key from being used with an encryption algorithm that is not supported by AWS KMS. You can also avoid errors, such as using the wrong signing algorithm in a verification operation.</p> <p>The CMK that you use for this operation must be in a compatible key state. For details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">How Key State Affects Use of a Customer Master Key</a> in the <i>AWS Key Management Service Developer Guide</i>.</p> async fn get_public_key( &self, input: GetPublicKeyRequest, ) -> Result<GetPublicKeyResponse, RusotoError<GetPublicKeyError>>; /// <p>Imports key material into an existing symmetric AWS KMS customer master key (CMK) that was created without key material. After you successfully import key material into a CMK, you can <a href="https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys.html#reimport-key-material">reimport the same key material</a> into that CMK, but you cannot import different key material.</p> <p>You cannot perform this operation on an asymmetric CMK or on any CMK in a different AWS account. For more information about creating CMKs with no key material and then importing key material, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys.html">Importing Key Material</a> in the <i>AWS Key Management Service Developer Guide</i>.</p> <p>Before using this operation, call <a>GetParametersForImport</a>. Its response includes a public key and an import token. Use the public key to encrypt the key material. Then, submit the import token from the same <code>GetParametersForImport</code> response.</p> <p>When calling this operation, you must specify the following values:</p> <ul> <li> <p>The key ID or key ARN of a CMK with no key material. Its <code>Origin</code> must be <code>EXTERNAL</code>.</p> <p>To create a CMK with no key material, call <a>CreateKey</a> and set the value of its <code>Origin</code> parameter to <code>EXTERNAL</code>. To get the <code>Origin</code> of a CMK, call <a>DescribeKey</a>.)</p> </li> <li> <p>The encrypted key material. To get the public key to encrypt the key material, call <a>GetParametersForImport</a>.</p> </li> <li> <p>The import token that <a>GetParametersForImport</a> returned. You must use a public key and token from the same <code>GetParametersForImport</code> response.</p> </li> <li> <p>Whether the key material expires and if so, when. If you set an expiration date, AWS KMS deletes the key material from the CMK on the specified date, and the CMK becomes unusable. To use the CMK again, you must reimport the same key material. The only way to change an expiration date is by reimporting the same key material and specifying a new expiration date. </p> </li> </ul> <p>When this operation is successful, the key state of the CMK changes from <code>PendingImport</code> to <code>Enabled</code>, and you can use the CMK.</p> <p>If this operation fails, use the exception to help determine the problem. If the error is related to the key material, the import token, or wrapping key, use <a>GetParametersForImport</a> to get a new public key and import token for the CMK and repeat the import procedure. For help, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys.html#importing-keys-overview">How To Import Key Material</a> in the <i>AWS Key Management Service Developer Guide</i>.</p> <p>The CMK that you use for this operation must be in a compatible key state. For details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">How Key State Affects Use of a Customer Master Key</a> in the <i>AWS Key Management Service Developer Guide</i>.</p> async fn import_key_material( &self, input: ImportKeyMaterialRequest, ) -> Result<ImportKeyMaterialResponse, RusotoError<ImportKeyMaterialError>>; /// <p>Gets a list of aliases in the caller's AWS account and region. You cannot list aliases in other accounts. For more information about aliases, see <a>CreateAlias</a>.</p> <p>By default, the ListAliases command returns all aliases in the account and region. To get only the aliases that point to a particular customer master key (CMK), use the <code>KeyId</code> parameter.</p> <p>The <code>ListAliases</code> response can include aliases that you created and associated with your customer managed CMKs, and aliases that AWS created and associated with AWS managed CMKs in your account. You can recognize AWS aliases because their names have the format <code>aws/<service-name></code>, such as <code>aws/dynamodb</code>.</p> <p>The response might also include aliases that have no <code>TargetKeyId</code> field. These are predefined aliases that AWS has created but has not yet associated with a CMK. Aliases that AWS creates in your account, including predefined aliases, do not count against your <a href="https://docs.aws.amazon.com/kms/latest/developerguide/limits.html#aliases-limit">AWS KMS aliases quota</a>.</p> async fn list_aliases( &self, input: ListAliasesRequest, ) -> Result<ListAliasesResponse, RusotoError<ListAliasesError>>; /// <p><p>Gets a list of all grants for the specified customer master key (CMK).</p> <p>To perform this operation on a CMK in a different AWS account, specify the key ARN in the value of the <code>KeyId</code> parameter.</p> <note> <p>The <code>GranteePrincipal</code> field in the <code>ListGrants</code> response usually contains the user or role designated as the grantee principal in the grant. However, when the grantee principal in the grant is an AWS service, the <code>GranteePrincipal</code> field contains the <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements_principal.html#principal-services">service principal</a>, which might represent several different grantee principals.</p> </note></p> async fn list_grants( &self, input: ListGrantsRequest, ) -> Result<ListGrantsResponse, RusotoError<ListGrantsError>>; /// <p>Gets the names of the key policies that are attached to a customer master key (CMK). This operation is designed to get policy names that you can use in a <a>GetKeyPolicy</a> operation. However, the only valid policy name is <code>default</code>. You cannot perform this operation on a CMK in a different AWS account.</p> async fn list_key_policies( &self, input: ListKeyPoliciesRequest, ) -> Result<ListKeyPoliciesResponse, RusotoError<ListKeyPoliciesError>>; /// <p>Gets a list of all customer master keys (CMKs) in the caller's AWS account and Region.</p> async fn list_keys( &self, input: ListKeysRequest, ) -> Result<ListKeysResponse, RusotoError<ListKeysError>>; /// <p>Returns a list of all tags for the specified customer master key (CMK).</p> <p>You cannot perform this operation on a CMK in a different AWS account.</p> async fn list_resource_tags( &self, input: ListResourceTagsRequest, ) -> Result<ListResourceTagsResponse, RusotoError<ListResourceTagsError>>; /// <p>Returns a list of all grants for which the grant's <code>RetiringPrincipal</code> matches the one specified.</p> <p>A typical use is to list all grants that you are able to retire. To retire a grant, use <a>RetireGrant</a>.</p> async fn list_retirable_grants( &self, input: ListRetirableGrantsRequest, ) -> Result<ListGrantsResponse, RusotoError<ListRetirableGrantsError>>; /// <p>Attaches a key policy to the specified customer master key (CMK). You cannot perform this operation on a CMK in a different AWS account.</p> <p>For more information about key policies, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html">Key Policies</a> in the <i>AWS Key Management Service Developer Guide</i>.</p> async fn put_key_policy( &self, input: PutKeyPolicyRequest, ) -> Result<(), RusotoError<PutKeyPolicyError>>; /// <p>Decrypts ciphertext and then reencrypts it entirely within AWS KMS. You can use this operation to change the customer master key (CMK) under which data is encrypted, such as when you <a href="https://docs.aws.amazon.com/kms/latest/developerguide/rotate-keys.html#rotate-keys-manually">manually rotate</a> a CMK or change the CMK that protects a ciphertext. You can also use it to reencrypt ciphertext under the same CMK, such as to change the <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context">encryption context</a> of a ciphertext.</p> <p>The <code>ReEncrypt</code> operation can decrypt ciphertext that was encrypted by using an AWS KMS CMK in an AWS KMS operation, such as <a>Encrypt</a> or <a>GenerateDataKey</a>. It can also decrypt ciphertext that was encrypted by using the public key of an <a href="https://docs.aws.amazon.com/kms/latest/developerguide/symm-asymm-concepts.html#asymmetric-cmks">asymmetric CMK</a> outside of AWS KMS. However, it cannot decrypt ciphertext produced by other libraries, such as the <a href="https://docs.aws.amazon.com/encryption-sdk/latest/developer-guide/">AWS Encryption SDK</a> or <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingClientSideEncryption.html">Amazon S3 client-side encryption</a>. These libraries return a ciphertext format that is incompatible with AWS KMS.</p> <p>When you use the <code>ReEncrypt</code> operation, you need to provide information for the decrypt operation and the subsequent encrypt operation.</p> <ul> <li> <p>If your ciphertext was encrypted under an asymmetric CMK, you must identify the <i>source CMK</i>, that is, the CMK that encrypted the ciphertext. You must also supply the encryption algorithm that was used. This information is required to decrypt the data.</p> </li> <li> <p>It is optional, but you can specify a source CMK even when the ciphertext was encrypted under a symmetric CMK. This ensures that the ciphertext is decrypted only by using a particular CMK. If the CMK that you specify cannot decrypt the ciphertext, the <code>ReEncrypt</code> operation fails.</p> </li> <li> <p>To reencrypt the data, you must specify the <i>destination CMK</i>, that is, the CMK that re-encrypts the data after it is decrypted. You can select a symmetric or asymmetric CMK. If the destination CMK is an asymmetric CMK, you must also provide the encryption algorithm. The algorithm that you choose must be compatible with the CMK.</p> <important> <p>When you use an asymmetric CMK to encrypt or reencrypt data, be sure to record the CMK and encryption algorithm that you choose. You will be required to provide the same CMK and encryption algorithm when you decrypt the data. If the CMK and algorithm do not match the values used to encrypt the data, the decrypt operation fails.</p> <p>You are not required to supply the CMK ID and encryption algorithm when you decrypt with symmetric CMKs because AWS KMS stores this information in the ciphertext blob. AWS KMS cannot store metadata in ciphertext generated with asymmetric keys. The standard format for asymmetric key ciphertext does not include configurable fields.</p> </important> </li> </ul> <p>Unlike other AWS KMS API operations, <code>ReEncrypt</code> callers must have two permissions:</p> <ul> <li> <p> <code>kms:ReEncryptFrom</code> permission on the source CMK</p> </li> <li> <p> <code>kms:ReEncryptTo</code> permission on the destination CMK</p> </li> </ul> <p>To permit reencryption from or to a CMK, include the <code>"kms:ReEncrypt*"</code> permission in your <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html">key policy</a>. This permission is automatically included in the key policy when you use the console to create a CMK. But you must include it manually when you create a CMK programmatically or when you use the <a>PutKeyPolicy</a> operation to set a key policy.</p> <p>The CMK that you use for this operation must be in a compatible key state. For details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">How Key State Affects Use of a Customer Master Key</a> in the <i>AWS Key Management Service Developer Guide</i>.</p> async fn re_encrypt( &self, input: ReEncryptRequest, ) -> Result<ReEncryptResponse, RusotoError<ReEncryptError>>; /// <p>Retires a grant. To clean up, you can retire a grant when you're done using it. You should revoke a grant when you intend to actively deny operations that depend on it. The following are permitted to call this API:</p> <ul> <li> <p>The AWS account (root user) under which the grant was created</p> </li> <li> <p>The <code>RetiringPrincipal</code>, if present in the grant</p> </li> <li> <p>The <code>GranteePrincipal</code>, if <code>RetireGrant</code> is an operation specified in the grant</p> </li> </ul> <p>You must identify the grant to retire by its grant token or by a combination of the grant ID and the Amazon Resource Name (ARN) of the customer master key (CMK). A grant token is a unique variable-length base64-encoded string. A grant ID is a 64 character unique identifier of a grant. The <a>CreateGrant</a> operation returns both.</p> async fn retire_grant( &self, input: RetireGrantRequest, ) -> Result<(), RusotoError<RetireGrantError>>; /// <p>Revokes the specified grant for the specified customer master key (CMK). You can revoke a grant to actively deny operations that depend on it.</p> <p>To perform this operation on a CMK in a different AWS account, specify the key ARN in the value of the <code>KeyId</code> parameter.</p> async fn revoke_grant( &self, input: RevokeGrantRequest, ) -> Result<(), RusotoError<RevokeGrantError>>; /// <p>Schedules the deletion of a customer master key (CMK). You may provide a waiting period, specified in days, before deletion occurs. If you do not provide a waiting period, the default period of 30 days is used. When this operation is successful, the key state of the CMK changes to <code>PendingDeletion</code>. Before the waiting period ends, you can use <a>CancelKeyDeletion</a> to cancel the deletion of the CMK. After the waiting period ends, AWS KMS deletes the CMK and all AWS KMS data associated with it, including all aliases that refer to it.</p> <important> <p>Deleting a CMK is a destructive and potentially dangerous operation. When a CMK is deleted, all data that was encrypted under the CMK is unrecoverable. To prevent the use of a CMK without deleting it, use <a>DisableKey</a>.</p> </important> <p>If you schedule deletion of a CMK from a <a href="https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html">custom key store</a>, when the waiting period expires, <code>ScheduleKeyDeletion</code> deletes the CMK from AWS KMS. Then AWS KMS makes a best effort to delete the key material from the associated AWS CloudHSM cluster. However, you might need to manually <a href="https://docs.aws.amazon.com/kms/latest/developerguide/fix-keystore.html#fix-keystore-orphaned-key">delete the orphaned key material</a> from the cluster and its backups.</p> <p>You cannot perform this operation on a CMK in a different AWS account.</p> <p>For more information about scheduling a CMK for deletion, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/deleting-keys.html">Deleting Customer Master Keys</a> in the <i>AWS Key Management Service Developer Guide</i>.</p> <p>The CMK that you use for this operation must be in a compatible key state. For details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">How Key State Affects Use of a Customer Master Key</a> in the <i>AWS Key Management Service Developer Guide</i>.</p> async fn schedule_key_deletion( &self, input: ScheduleKeyDeletionRequest, ) -> Result<ScheduleKeyDeletionResponse, RusotoError<ScheduleKeyDeletionError>>; /// <p>Creates a <a href="https://en.wikipedia.org/wiki/Digital_signature">digital signature</a> for a message or message digest by using the private key in an asymmetric CMK. To verify the signature, use the <a>Verify</a> operation, or use the public key in the same asymmetric CMK outside of AWS KMS. For information about symmetric and asymmetric CMKs, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html">Using Symmetric and Asymmetric CMKs</a> in the <i>AWS Key Management Service Developer Guide</i>.</p> <p>Digital signatures are generated and verified by using asymmetric key pair, such as an RSA or ECC pair that is represented by an asymmetric customer master key (CMK). The key owner (or an authorized user) uses their private key to sign a message. Anyone with the public key can verify that the message was signed with that particular private key and that the message hasn't changed since it was signed. </p> <p>To use the <code>Sign</code> operation, provide the following information:</p> <ul> <li> <p>Use the <code>KeyId</code> parameter to identify an asymmetric CMK with a <code>KeyUsage</code> value of <code>SIGN_VERIFY</code>. To get the <code>KeyUsage</code> value of a CMK, use the <a>DescribeKey</a> operation. The caller must have <code>kms:Sign</code> permission on the CMK.</p> </li> <li> <p>Use the <code>Message</code> parameter to specify the message or message digest to sign. You can submit messages of up to 4096 bytes. To sign a larger message, generate a hash digest of the message, and then provide the hash digest in the <code>Message</code> parameter. To indicate whether the message is a full message or a digest, use the <code>MessageType</code> parameter.</p> </li> <li> <p>Choose a signing algorithm that is compatible with the CMK. </p> </li> </ul> <important> <p>When signing a message, be sure to record the CMK and the signing algorithm. This information is required to verify the signature.</p> </important> <p>To verify the signature that this operation generates, use the <a>Verify</a> operation. Or use the <a>GetPublicKey</a> operation to download the public key and then use the public key to verify the signature outside of AWS KMS. </p> <p>The CMK that you use for this operation must be in a compatible key state. For details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">How Key State Affects Use of a Customer Master Key</a> in the <i>AWS Key Management Service Developer Guide</i>.</p> async fn sign(&self, input: SignRequest) -> Result<SignResponse, RusotoError<SignError>>; /// <p>Adds or edits tags for a customer master key (CMK). You cannot perform this operation on a CMK in a different AWS account.</p> <p>Each tag consists of a tag key and a tag value. Tag keys and tag values are both required, but tag values can be empty (null) strings.</p> <p>You can only use a tag key once for each CMK. If you use the tag key again, AWS KMS replaces the current tag value with the specified value.</p> <p>For information about the rules that apply to tag keys and tag values, see <a href="https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/allocation-tag-restrictions.html">User-Defined Tag Restrictions</a> in the <i>AWS Billing and Cost Management User Guide</i>.</p> <p>The CMK that you use for this operation must be in a compatible key state. For details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">How Key State Affects Use of a Customer Master Key</a> in the <i>AWS Key Management Service Developer Guide</i>.</p> async fn tag_resource( &self, input: TagResourceRequest, ) -> Result<(), RusotoError<TagResourceError>>; /// <p>Removes the specified tags from the specified customer master key (CMK). You cannot perform this operation on a CMK in a different AWS account.</p> <p>To remove a tag, specify the tag key. To change the tag value of an existing tag key, use <a>TagResource</a>.</p> <p>The CMK that you use for this operation must be in a compatible key state. For details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">How Key State Affects Use of a Customer Master Key</a> in the <i>AWS Key Management Service Developer Guide</i>.</p> async fn untag_resource( &self, input: UntagResourceRequest, ) -> Result<(), RusotoError<UntagResourceError>>; /// <p>Associates an existing AWS KMS alias with a different customer master key (CMK). Each alias is associated with only one CMK at a time, although a CMK can have multiple aliases. The alias and the CMK must be in the same AWS account and region. You cannot perform this operation on an alias in a different AWS account. </p> <p>The current and new CMK must be the same type (both symmetric or both asymmetric), and they must have the same key usage (<code>ENCRYPT_DECRYPT</code> or <code>SIGN_VERIFY</code>). This restriction prevents errors in code that uses aliases. If you must assign an alias to a different type of CMK, use <a>DeleteAlias</a> to delete the old alias and <a>CreateAlias</a> to create a new alias.</p> <p>You cannot use <code>UpdateAlias</code> to change an alias name. To change an alias name, use <a>DeleteAlias</a> to delete the old alias and <a>CreateAlias</a> to create a new alias.</p> <p>Because an alias is not a property of a CMK, you can create, update, and delete the aliases of a CMK without affecting the CMK. Also, aliases do not appear in the response from the <a>DescribeKey</a> operation. To get the aliases of all CMKs in the account, use the <a>ListAliases</a> operation. </p> <p>The CMK that you use for this operation must be in a compatible key state. For details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">How Key State Affects Use of a Customer Master Key</a> in the <i>AWS Key Management Service Developer Guide</i>.</p> async fn update_alias( &self, input: UpdateAliasRequest, ) -> Result<(), RusotoError<UpdateAliasError>>; /// <p>Changes the properties of a custom key store. Use the <code>CustomKeyStoreId</code> parameter to identify the custom key store you want to edit. Use the remaining parameters to change the properties of the custom key store.</p> <p>You can only update a custom key store that is disconnected. To disconnect the custom key store, use <a>DisconnectCustomKeyStore</a>. To reconnect the custom key store after the update completes, use <a>ConnectCustomKeyStore</a>. To find the connection state of a custom key store, use the <a>DescribeCustomKeyStores</a> operation.</p> <p>Use the parameters of <code>UpdateCustomKeyStore</code> to edit your keystore settings.</p> <ul> <li> <p>Use the <b>NewCustomKeyStoreName</b> parameter to change the friendly name of the custom key store to the value that you specify.</p> <p> </p> </li> <li> <p>Use the <b>KeyStorePassword</b> parameter tell AWS KMS the current password of the <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-store-concepts.html#concept-kmsuser"> <code>kmsuser</code> crypto user (CU)</a> in the associated AWS CloudHSM cluster. You can use this parameter to <a href="https://docs.aws.amazon.com/kms/latest/developerguide/fix-keystore.html#fix-keystore-password">fix connection failures</a> that occur when AWS KMS cannot log into the associated cluster because the <code>kmsuser</code> password has changed. This value does not change the password in the AWS CloudHSM cluster.</p> <p> </p> </li> <li> <p>Use the <b>CloudHsmClusterId</b> parameter to associate the custom key store with a different, but related, AWS CloudHSM cluster. You can use this parameter to repair a custom key store if its AWS CloudHSM cluster becomes corrupted or is deleted, or when you need to create or restore a cluster from a backup. </p> </li> </ul> <p>If the operation succeeds, it returns a JSON object with no properties.</p> <p>This operation is part of the <a href="https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html">Custom Key Store feature</a> feature in AWS KMS, which combines the convenience and extensive integration of AWS KMS with the isolation and control of a single-tenant key store.</p> async fn update_custom_key_store( &self, input: UpdateCustomKeyStoreRequest, ) -> Result<UpdateCustomKeyStoreResponse, RusotoError<UpdateCustomKeyStoreError>>; /// <p>Updates the description of a customer master key (CMK). To see the description of a CMK, use <a>DescribeKey</a>. </p> <p>You cannot perform this operation on a CMK in a different AWS account.</p> <p>The CMK that you use for this operation must be in a compatible key state. For details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">How Key State Affects Use of a Customer Master Key</a> in the <i>AWS Key Management Service Developer Guide</i>.</p> async fn update_key_description( &self, input: UpdateKeyDescriptionRequest, ) -> Result<(), RusotoError<UpdateKeyDescriptionError>>; /// <p>Verifies a digital signature that was generated by the <a>Sign</a> operation. </p> <p/> <p>Verification confirms that an authorized user signed the message with the specified CMK and signing algorithm, and the message hasn't changed since it was signed. If the signature is verified, the value of the <code>SignatureValid</code> field in the response is <code>True</code>. If the signature verification fails, the <code>Verify</code> operation fails with an <code>KMSInvalidSignatureException</code> exception.</p> <p>A digital signature is generated by using the private key in an asymmetric CMK. The signature is verified by using the public key in the same asymmetric CMK. For information about symmetric and asymmetric CMKs, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html">Using Symmetric and Asymmetric CMKs</a> in the <i>AWS Key Management Service Developer Guide</i>.</p> <p>To verify a digital signature, you can use the <code>Verify</code> operation. Specify the same asymmetric CMK, message, and signing algorithm that were used to produce the signature.</p> <p>You can also verify the digital signature by using the public key of the CMK outside of AWS KMS. Use the <a>GetPublicKey</a> operation to download the public key in the asymmetric CMK and then use the public key to verify the signature outside of AWS KMS. The advantage of using the <code>Verify</code> operation is that it is performed within AWS KMS. As a result, it's easy to call, the operation is performed within the FIPS boundary, it is logged in AWS CloudTrail, and you can use key policy and IAM policy to determine who is authorized to use the CMK to verify signatures.</p> <p>The CMK that you use for this operation must be in a compatible key state. For details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">How Key State Affects Use of a Customer Master Key</a> in the <i>AWS Key Management Service Developer Guide</i>.</p> async fn verify( &self, input: VerifyRequest, ) -> Result<VerifyResponse, RusotoError<VerifyError>>; } /// A client for the KMS API. #[derive(Clone)] pub struct KmsClient { client: Client, region: region::Region, } impl KmsClient { /// Creates a client backed by the default tokio event loop. /// /// The client will use the default credentials provider and tls client. pub fn new(region: region::Region) -> KmsClient { KmsClient { client: Client::shared(), region, } } pub fn new_with<P, D>( request_dispatcher: D, credentials_provider: P, region: region::Region, ) -> KmsClient where P: ProvideAwsCredentials + Send + Sync + 'static, D: DispatchSignedRequest + Send + Sync + 'static, { KmsClient { client: Client::new_with(credentials_provider, request_dispatcher), region, } } pub fn new_with_client(client: Client, region: region::Region) -> KmsClient { KmsClient { client, region } } } #[async_trait] impl Kms for KmsClient { /// <p>Cancels the deletion of a customer master key (CMK). When this operation succeeds, the key state of the CMK is <code>Disabled</code>. To enable the CMK, use <a>EnableKey</a>. You cannot perform this operation on a CMK in a different AWS account.</p> <p>For more information about scheduling and canceling deletion of a CMK, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/deleting-keys.html">Deleting Customer Master Keys</a> in the <i>AWS Key Management Service Developer Guide</i>.</p> <p>The CMK that you use for this operation must be in a compatible key state. For details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">How Key State Affects Use of a Customer Master Key</a> in the <i>AWS Key Management Service Developer Guide</i>.</p> async fn cancel_key_deletion( &self, input: CancelKeyDeletionRequest, ) -> Result<CancelKeyDeletionResponse, RusotoError<CancelKeyDeletionError>> { let mut request = self.new_signed_request("POST", "/"); request.add_header("x-amz-target", "TrentService.CancelKeyDeletion"); let encoded = serde_json::to_string(&input).unwrap(); request.set_payload(Some(encoded)); let response = self .sign_and_dispatch(request, CancelKeyDeletionError::from_response) .await?; let mut response = response; let response = response.buffer().await.map_err(RusotoError::HttpDispatch)?; proto::json::ResponsePayload::new(&response).deserialize::<CancelKeyDeletionResponse, _>() } /// <p>Connects or reconnects a <a href="https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html">custom key store</a> to its associated AWS CloudHSM cluster.</p> <p>The custom key store must be connected before you can create customer master keys (CMKs) in the key store or use the CMKs it contains. You can disconnect and reconnect a custom key store at any time.</p> <p>To connect a custom key store, its associated AWS CloudHSM cluster must have at least one active HSM. To get the number of active HSMs in a cluster, use the <a href="https://docs.aws.amazon.com/cloudhsm/latest/APIReference/API_DescribeClusters.html">DescribeClusters</a> operation. To add HSMs to the cluster, use the <a href="https://docs.aws.amazon.com/cloudhsm/latest/APIReference/API_CreateHsm.html">CreateHsm</a> operation. Also, the <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-store-concepts.html#concept-kmsuser"> <code>kmsuser</code> crypto user</a> (CU) must not be logged into the cluster. This prevents AWS KMS from using this account to log in.</p> <p>The connection process can take an extended amount of time to complete; up to 20 minutes. This operation starts the connection process, but it does not wait for it to complete. When it succeeds, this operation quickly returns an HTTP 200 response and a JSON object with no properties. However, this response does not indicate that the custom key store is connected. To get the connection state of the custom key store, use the <a>DescribeCustomKeyStores</a> operation.</p> <p>During the connection process, AWS KMS finds the AWS CloudHSM cluster that is associated with the custom key store, creates the connection infrastructure, connects to the cluster, logs into the AWS CloudHSM client as the <code>kmsuser</code> CU, and rotates its password.</p> <p>The <code>ConnectCustomKeyStore</code> operation might fail for various reasons. To find the reason, use the <a>DescribeCustomKeyStores</a> operation and see the <code>ConnectionErrorCode</code> in the response. For help interpreting the <code>ConnectionErrorCode</code>, see <a>CustomKeyStoresListEntry</a>.</p> <p>To fix the failure, use the <a>DisconnectCustomKeyStore</a> operation to disconnect the custom key store, correct the error, use the <a>UpdateCustomKeyStore</a> operation if necessary, and then use <code>ConnectCustomKeyStore</code> again.</p> <p>If you are having trouble connecting or disconnecting a custom key store, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/fix-keystore.html">Troubleshooting a Custom Key Store</a> in the <i>AWS Key Management Service Developer Guide</i>.</p> async fn connect_custom_key_store( &self, input: ConnectCustomKeyStoreRequest, ) -> Result<ConnectCustomKeyStoreResponse, RusotoError<ConnectCustomKeyStoreError>> { let mut request = self.new_signed_request("POST", "/"); request.add_header("x-amz-target", "TrentService.ConnectCustomKeyStore"); let encoded = serde_json::to_string(&input).unwrap(); request.set_payload(Some(encoded)); let response = self .sign_and_dispatch(request, ConnectCustomKeyStoreError::from_response) .await?; let mut response = response; let response = response.buffer().await.map_err(RusotoError::HttpDispatch)?; proto::json::ResponsePayload::new(&response) .deserialize::<ConnectCustomKeyStoreResponse, _>() } /// <p>Creates a display name for a customer managed customer master key (CMK). You can use an alias to identify a CMK in <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#cryptographic-operations">cryptographic operations</a>, such as <a>Encrypt</a> and <a>GenerateDataKey</a>. You can change the CMK associated with the alias at any time.</p> <p>Aliases are easier to remember than key IDs. They can also help to simplify your applications. For example, if you use an alias in your code, you can change the CMK your code uses by associating a given alias with a different CMK. </p> <p>To run the same code in multiple AWS regions, use an alias in your code, such as <code>alias/ApplicationKey</code>. Then, in each AWS Region, create an <code>alias/ApplicationKey</code> alias that is associated with a CMK in that Region. When you run your code, it uses the <code>alias/ApplicationKey</code> CMK for that AWS Region without any Region-specific code.</p> <p>This operation does not return a response. To get the alias that you created, use the <a>ListAliases</a> operation.</p> <p>To use aliases successfully, be aware of the following information.</p> <ul> <li> <p>Each alias points to only one CMK at a time, although a single CMK can have multiple aliases. The alias and its associated CMK must be in the same AWS account and Region. </p> </li> <li> <p>You can associate an alias with any customer managed CMK in the same AWS account and Region. However, you do not have permission to associate an alias with an <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-cmk">AWS managed CMK</a> or an <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-owned-cmk">AWS owned CMK</a>. </p> </li> <li> <p>To change the CMK associated with an alias, use the <a>UpdateAlias</a> operation. The current CMK and the new CMK must be the same type (both symmetric or both asymmetric) and they must have the same key usage (<code>ENCRYPT_DECRYPT</code> or <code>SIGN_VERIFY</code>). This restriction prevents cryptographic errors in code that uses aliases.</p> </li> <li> <p>The alias name must begin with <code>alias/</code> followed by a name, such as <code>alias/ExampleAlias</code>. It can contain only alphanumeric characters, forward slashes (/), underscores (_), and dashes (-). The alias name cannot begin with <code>alias/aws/</code>. The <code>alias/aws/</code> prefix is reserved for <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-cmk">AWS managed CMKs</a>. </p> </li> <li> <p>The alias name must be unique within an AWS Region. However, you can use the same alias name in multiple Regions of the same AWS account. Each instance of the alias is associated with a CMK in its Region.</p> </li> <li> <p>After you create an alias, you cannot change its alias name. However, you can use the <a>DeleteAlias</a> operation to delete the alias and then create a new alias with the desired name.</p> </li> <li> <p>You can use an alias name or alias ARN to identify a CMK in AWS KMS <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#cryptographic-operations">cryptographic operations</a> and in the <a>DescribeKey</a> operation. However, you cannot use alias names or alias ARNs in API operations that manage CMKs, such as <a>DisableKey</a> or <a>GetKeyPolicy</a>. For information about the valid CMK identifiers for each AWS KMS API operation, see the descriptions of the <code>KeyId</code> parameter in the API operation documentation.</p> </li> </ul> <p>Because an alias is not a property of a CMK, you can delete and change the aliases of a CMK without affecting the CMK. Also, aliases do not appear in the response from the <a>DescribeKey</a> operation. To get the aliases and alias ARNs of CMKs in each AWS account and Region, use the <a>ListAliases</a> operation.</p> <p>The CMK that you use for this operation must be in a compatible key state. For details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">How Key State Affects Use of a Customer Master Key</a> in the <i>AWS Key Management Service Developer Guide</i>.</p> async fn create_alias( &self, input: CreateAliasRequest, ) -> Result<(), RusotoError<CreateAliasError>> { let mut request = self.new_signed_request("POST", "/"); request.add_header("x-amz-target", "TrentService.CreateAlias"); let encoded = serde_json::to_string(&input).unwrap(); request.set_payload(Some(encoded)); let response = self .sign_and_dispatch(request, CreateAliasError::from_response) .await?; std::mem::drop(response); Ok(()) } /// <p>Creates a <a href="https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html">custom key store</a> that is associated with an <a href="https://docs.aws.amazon.com/cloudhsm/latest/userguide/clusters.html">AWS CloudHSM cluster</a> that you own and manage.</p> <p>This operation is part of the <a href="https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html">Custom Key Store feature</a> feature in AWS KMS, which combines the convenience and extensive integration of AWS KMS with the isolation and control of a single-tenant key store.</p> <p>Before you create the custom key store, you must assemble the required elements, including an AWS CloudHSM cluster that fulfills the requirements for a custom key store. For details about the required elements, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/create-keystore.html#before-keystore">Assemble the Prerequisites</a> in the <i>AWS Key Management Service Developer Guide</i>.</p> <p>When the operation completes successfully, it returns the ID of the new custom key store. Before you can use your new custom key store, you need to use the <a>ConnectCustomKeyStore</a> operation to connect the new key store to its AWS CloudHSM cluster. Even if you are not going to use your custom key store immediately, you might want to connect it to verify that all settings are correct and then disconnect it until you are ready to use it.</p> <p>For help with failures, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/fix-keystore.html">Troubleshooting a Custom Key Store</a> in the <i>AWS Key Management Service Developer Guide</i>.</p> async fn create_custom_key_store( &self, input: CreateCustomKeyStoreRequest, ) -> Result<CreateCustomKeyStoreResponse, RusotoError<CreateCustomKeyStoreError>> { let mut request = self.new_signed_request("POST", "/"); request.add_header("x-amz-target", "TrentService.CreateCustomKeyStore"); let encoded = serde_json::to_string(&input).unwrap(); request.set_payload(Some(encoded)); let response = self .sign_and_dispatch(request, CreateCustomKeyStoreError::from_response) .await?; let mut response = response; let response = response.buffer().await.map_err(RusotoError::HttpDispatch)?; proto::json::ResponsePayload::new(&response) .deserialize::<CreateCustomKeyStoreResponse, _>() } /// <p>Adds a grant to a customer master key (CMK). The grant allows the grantee principal to use the CMK when the conditions specified in the grant are met. When setting permissions, grants are an alternative to key policies. </p> <p>To create a grant that allows a <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#cryptographic-operations">cryptographic operation</a> only when the request includes a particular <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context">encryption context</a>, use the <code>Constraints</code> parameter. For details, see <a>GrantConstraints</a>.</p> <p>You can create grants on symmetric and asymmetric CMKs. However, if the grant allows an operation that the CMK does not support, <code>CreateGrant</code> fails with a <code>ValidationException</code>. </p> <ul> <li> <p>Grants for symmetric CMKs cannot allow operations that are not supported for symmetric CMKs, including <a>Sign</a>, <a>Verify</a>, and <a>GetPublicKey</a>. (There are limited exceptions to this rule for legacy operations, but you should not create a grant for an operation that AWS KMS does not support.)</p> </li> <li> <p>Grants for asymmetric CMKs cannot allow operations that are not supported for asymmetric CMKs, including operations that <a href="https://docs.aws.amazon.com/kms/latest/APIReference/API_GenerateDataKey">generate data keys</a> or <a href="https://docs.aws.amazon.com/kms/latest/APIReference/API_GenerateDataKeyPair">data key pairs</a>, or operations related to <a href="https://docs.aws.amazon.com/kms/latest/developerguide/rotate-keys.html">automatic key rotation</a>, <a href="https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys.html">imported key material</a>, or CMKs in <a href="https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html">custom key stores</a>.</p> </li> <li> <p>Grants for asymmetric CMKs with a <code>KeyUsage</code> of <code>ENCRYPT_DECRYPT</code> cannot allow the <a>Sign</a> or <a>Verify</a> operations. Grants for asymmetric CMKs with a <code>KeyUsage</code> of <code>SIGN_VERIFY</code> cannot allow the <a>Encrypt</a> or <a>Decrypt</a> operations.</p> </li> <li> <p>Grants for asymmetric CMKs cannot include an encryption context grant constraint. An encryption context is not supported on asymmetric CMKs.</p> </li> </ul> <p>For information about symmetric and asymmetric CMKs, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html">Using Symmetric and Asymmetric CMKs</a> in the <i>AWS Key Management Service Developer Guide</i>.</p> <p>To perform this operation on a CMK in a different AWS account, specify the key ARN in the value of the <code>KeyId</code> parameter. For more information about grants, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/grants.html">Grants</a> in the <i> <i>AWS Key Management Service Developer Guide</i> </i>.</p> <p>The CMK that you use for this operation must be in a compatible key state. For details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">How Key State Affects Use of a Customer Master Key</a> in the <i>AWS Key Management Service Developer Guide</i>.</p> async fn create_grant( &self, input: CreateGrantRequest, ) -> Result<CreateGrantResponse, RusotoError<CreateGrantError>> { let mut request = self.new_signed_request("POST", "/"); request.add_header("x-amz-target", "TrentService.CreateGrant"); let encoded = serde_json::to_string(&input).unwrap(); request.set_payload(Some(encoded)); let response = self .sign_and_dispatch(request, CreateGrantError::from_response) .await?; let mut response = response; let response = response.buffer().await.map_err(RusotoError::HttpDispatch)?; proto::json::ResponsePayload::new(&response).deserialize::<CreateGrantResponse, _>() } /// <p><p>Creates a unique customer managed <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#master-keys">customer master key</a> (CMK) in your AWS account and Region. You cannot use this operation to create a CMK in a different AWS account.</p> <p>You can use the <code>CreateKey</code> operation to create symmetric or asymmetric CMKs.</p> <ul> <li> <p> <b>Symmetric CMKs</b> contain a 256-bit symmetric key that never leaves AWS KMS unencrypted. To use the CMK, you must call AWS KMS. You can use a symmetric CMK to encrypt and decrypt small amounts of data, but they are typically used to generate <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#data-keys">data keys</a> and <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#data-key-pairs">data keys pairs</a>. For details, see <a>GenerateDataKey</a> and <a>GenerateDataKeyPair</a>.</p> </li> <li> <p> <b>Asymmetric CMKs</b> can contain an RSA key pair or an Elliptic Curve (ECC) key pair. The private key in an asymmetric CMK never leaves AWS KMS unencrypted. However, you can use the <a>GetPublicKey</a> operation to download the public key so it can be used outside of AWS KMS. CMKs with RSA key pairs can be used to encrypt or decrypt data or sign and verify messages (but not both). CMKs with ECC key pairs can be used only to sign and verify messages.</p> </li> </ul> <p>For information about symmetric and asymmetric CMKs, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html">Using Symmetric and Asymmetric CMKs</a> in the <i>AWS Key Management Service Developer Guide</i>.</p> <p>To create different types of CMKs, use the following guidance:</p> <dl> <dt>Asymmetric CMKs</dt> <dd> <p>To create an asymmetric CMK, use the <code>CustomerMasterKeySpec</code> parameter to specify the type of key material in the CMK. Then, use the <code>KeyUsage</code> parameter to determine whether the CMK will be used to encrypt and decrypt or sign and verify. You can't change these properties after the CMK is created.</p> <p> </p> </dd> <dt>Symmetric CMKs</dt> <dd> <p>When creating a symmetric CMK, you don't need to specify the <code>CustomerMasterKeySpec</code> or <code>KeyUsage</code> parameters. The default value for <code>CustomerMasterKeySpec</code>, <code>SYMMETRIC<em>DEFAULT</code>, and the default value for <code>KeyUsage</code>, <code>ENCRYPT</em>DECRYPT</code>, are the only valid values for symmetric CMKs. </p> <p> </p> </dd> <dt>Imported Key Material</dt> <dd> <p>To import your own key material, begin by creating a symmetric CMK with no key material. To do this, use the <code>Origin</code> parameter of <code>CreateKey</code> with a value of <code>EXTERNAL</code>. Next, use <a>GetParametersForImport</a> operation to get a public key and import token, and use the public key to encrypt your key material. Then, use <a>ImportKeyMaterial</a> with your import token to import the key material. For step-by-step instructions, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys.html">Importing Key Material</a> in the <i> <i>AWS Key Management Service Developer Guide</i> </i>. You cannot import the key material into an asymmetric CMK.</p> <p> </p> </dd> <dt>Custom Key Stores</dt> <dd> <p>To create a symmetric CMK in a <a href="https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html">custom key store</a>, use the <code>CustomKeyStoreId</code> parameter to specify the custom key store. You must also use the <code>Origin</code> parameter with a value of <code>AWS_CLOUDHSM</code>. The AWS CloudHSM cluster that is associated with the custom key store must have at least two active HSMs in different Availability Zones in the AWS Region. </p> <p>You cannot create an asymmetric CMK in a custom key store. For information about custom key stores in AWS KMS see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html">Using Custom Key Stores</a> in the <i> <i>AWS Key Management Service Developer Guide</i> </i>.</p> </dd> </dl></p> async fn create_key( &self, input: CreateKeyRequest, ) -> Result<CreateKeyResponse, RusotoError<CreateKeyError>> { let mut request = self.new_signed_request("POST", "/"); request.add_header("x-amz-target", "TrentService.CreateKey"); let encoded = serde_json::to_string(&input).unwrap(); request.set_payload(Some(encoded)); let response = self .sign_and_dispatch(request, CreateKeyError::from_response) .await?; let mut response = response; let response = response.buffer().await.map_err(RusotoError::HttpDispatch)?; proto::json::ResponsePayload::new(&response).deserialize::<CreateKeyResponse, _>() } /// <p>Decrypts ciphertext that was encrypted by a AWS KMS customer master key (CMK) using any of the following operations:</p> <ul> <li> <p> <a>Encrypt</a> </p> </li> <li> <p> <a>GenerateDataKey</a> </p> </li> <li> <p> <a>GenerateDataKeyPair</a> </p> </li> <li> <p> <a>GenerateDataKeyWithoutPlaintext</a> </p> </li> <li> <p> <a>GenerateDataKeyPairWithoutPlaintext</a> </p> </li> </ul> <p>You can use this operation to decrypt ciphertext that was encrypted under a symmetric or asymmetric CMK. When the CMK is asymmetric, you must specify the CMK and the encryption algorithm that was used to encrypt the ciphertext. For information about symmetric and asymmetric CMKs, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html">Using Symmetric and Asymmetric CMKs</a> in the <i>AWS Key Management Service Developer Guide</i>.</p> <p>The Decrypt operation also decrypts ciphertext that was encrypted outside of AWS KMS by the public key in an AWS KMS asymmetric CMK. However, it cannot decrypt ciphertext produced by other libraries, such as the <a href="https://docs.aws.amazon.com/encryption-sdk/latest/developer-guide/">AWS Encryption SDK</a> or <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingClientSideEncryption.html">Amazon S3 client-side encryption</a>. These libraries return a ciphertext format that is incompatible with AWS KMS.</p> <p>If the ciphertext was encrypted under a symmetric CMK, you do not need to specify the CMK or the encryption algorithm. AWS KMS can get this information from metadata that it adds to the symmetric ciphertext blob. However, if you prefer, you can specify the <code>KeyId</code> to ensure that a particular CMK is used to decrypt the ciphertext. If you specify a different CMK than the one used to encrypt the ciphertext, the <code>Decrypt</code> operation fails.</p> <p>Whenever possible, use key policies to give users permission to call the Decrypt operation on a particular CMK, instead of using IAM policies. Otherwise, you might create an IAM user policy that gives the user Decrypt permission on all CMKs. This user could decrypt ciphertext that was encrypted by CMKs in other accounts if the key policy for the cross-account CMK permits it. If you must use an IAM policy for <code>Decrypt</code> permissions, limit the user to particular CMKs or particular trusted accounts.</p> <p>The CMK that you use for this operation must be in a compatible key state. For details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">How Key State Affects Use of a Customer Master Key</a> in the <i>AWS Key Management Service Developer Guide</i>.</p> async fn decrypt( &self, input: DecryptRequest, ) -> Result<DecryptResponse, RusotoError<DecryptError>> { let mut request = self.new_signed_request("POST", "/"); request.add_header("x-amz-target", "TrentService.Decrypt"); let encoded = serde_json::to_string(&input).unwrap(); request.set_payload(Some(encoded)); let response = self .sign_and_dispatch(request, DecryptError::from_response) .await?; let mut response = response; let response = response.buffer().await.map_err(RusotoError::HttpDispatch)?; proto::json::ResponsePayload::new(&response).deserialize::<DecryptResponse, _>() } /// <p>Deletes the specified alias. You cannot perform this operation on an alias in a different AWS account. </p> <p>Because an alias is not a property of a CMK, you can delete and change the aliases of a CMK without affecting the CMK. Also, aliases do not appear in the response from the <a>DescribeKey</a> operation. To get the aliases of all CMKs, use the <a>ListAliases</a> operation. </p> <p>Each CMK can have multiple aliases. To change the alias of a CMK, use <a>DeleteAlias</a> to delete the current alias and <a>CreateAlias</a> to create a new alias. To associate an existing alias with a different customer master key (CMK), call <a>UpdateAlias</a>.</p> async fn delete_alias( &self, input: DeleteAliasRequest, ) -> Result<(), RusotoError<DeleteAliasError>> { let mut request = self.new_signed_request("POST", "/"); request.add_header("x-amz-target", "TrentService.DeleteAlias"); let encoded = serde_json::to_string(&input).unwrap(); request.set_payload(Some(encoded)); let response = self .sign_and_dispatch(request, DeleteAliasError::from_response) .await?; std::mem::drop(response); Ok(()) } /// <p>Deletes a <a href="https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html">custom key store</a>. This operation does not delete the AWS CloudHSM cluster that is associated with the custom key store, or affect any users or keys in the cluster.</p> <p>The custom key store that you delete cannot contain any AWS KMS <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#master_keys">customer master keys (CMKs)</a>. Before deleting the key store, verify that you will never need to use any of the CMKs in the key store for any <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#cryptographic-operations">cryptographic operations</a>. Then, use <a>ScheduleKeyDeletion</a> to delete the AWS KMS customer master keys (CMKs) from the key store. When the scheduled waiting period expires, the <code>ScheduleKeyDeletion</code> operation deletes the CMKs. Then it makes a best effort to delete the key material from the associated cluster. However, you might need to manually <a href="https://docs.aws.amazon.com/kms/latest/developerguide/fix-keystore.html#fix-keystore-orphaned-key">delete the orphaned key material</a> from the cluster and its backups.</p> <p>After all CMKs are deleted from AWS KMS, use <a>DisconnectCustomKeyStore</a> to disconnect the key store from AWS KMS. Then, you can delete the custom key store.</p> <p>Instead of deleting the custom key store, consider using <a>DisconnectCustomKeyStore</a> to disconnect it from AWS KMS. While the key store is disconnected, you cannot create or use the CMKs in the key store. But, you do not need to delete CMKs and you can reconnect a disconnected custom key store at any time.</p> <p>If the operation succeeds, it returns a JSON object with no properties.</p> <p>This operation is part of the <a href="https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html">Custom Key Store feature</a> feature in AWS KMS, which combines the convenience and extensive integration of AWS KMS with the isolation and control of a single-tenant key store.</p> async fn delete_custom_key_store( &self, input: DeleteCustomKeyStoreRequest, ) -> Result<DeleteCustomKeyStoreResponse, RusotoError<DeleteCustomKeyStoreError>> { let mut request = self.new_signed_request("POST", "/"); request.add_header("x-amz-target", "TrentService.DeleteCustomKeyStore"); let encoded = serde_json::to_string(&input).unwrap(); request.set_payload(Some(encoded)); let response = self .sign_and_dispatch(request, DeleteCustomKeyStoreError::from_response) .await?; let mut response = response; let response = response.buffer().await.map_err(RusotoError::HttpDispatch)?; proto::json::ResponsePayload::new(&response) .deserialize::<DeleteCustomKeyStoreResponse, _>() } /// <p>Deletes key material that you previously imported. This operation makes the specified customer master key (CMK) unusable. For more information about importing key material into AWS KMS, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys.html">Importing Key Material</a> in the <i>AWS Key Management Service Developer Guide</i>. You cannot perform this operation on a CMK in a different AWS account.</p> <p>When the specified CMK is in the <code>PendingDeletion</code> state, this operation does not change the CMK's state. Otherwise, it changes the CMK's state to <code>PendingImport</code>.</p> <p>After you delete key material, you can use <a>ImportKeyMaterial</a> to reimport the same key material into the CMK.</p> <p>The CMK that you use for this operation must be in a compatible key state. For details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">How Key State Affects Use of a Customer Master Key</a> in the <i>AWS Key Management Service Developer Guide</i>.</p> async fn delete_imported_key_material( &self, input: DeleteImportedKeyMaterialRequest, ) -> Result<(), RusotoError<DeleteImportedKeyMaterialError>> { let mut request = self.new_signed_request("POST", "/"); request.add_header("x-amz-target", "TrentService.DeleteImportedKeyMaterial"); let encoded = serde_json::to_string(&input).unwrap(); request.set_payload(Some(encoded)); let response = self .sign_and_dispatch(request, DeleteImportedKeyMaterialError::from_response) .await?; std::mem::drop(response); Ok(()) } /// <p>Gets information about <a href="https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html">custom key stores</a> in the account and region.</p> <p>This operation is part of the <a href="https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html">Custom Key Store feature</a> feature in AWS KMS, which combines the convenience and extensive integration of AWS KMS with the isolation and control of a single-tenant key store.</p> <p>By default, this operation returns information about all custom key stores in the account and region. To get only information about a particular custom key store, use either the <code>CustomKeyStoreName</code> or <code>CustomKeyStoreId</code> parameter (but not both).</p> <p>To determine whether the custom key store is connected to its AWS CloudHSM cluster, use the <code>ConnectionState</code> element in the response. If an attempt to connect the custom key store failed, the <code>ConnectionState</code> value is <code>FAILED</code> and the <code>ConnectionErrorCode</code> element in the response indicates the cause of the failure. For help interpreting the <code>ConnectionErrorCode</code>, see <a>CustomKeyStoresListEntry</a>.</p> <p>Custom key stores have a <code>DISCONNECTED</code> connection state if the key store has never been connected or you use the <a>DisconnectCustomKeyStore</a> operation to disconnect it. If your custom key store state is <code>CONNECTED</code> but you are having trouble using it, make sure that its associated AWS CloudHSM cluster is active and contains the minimum number of HSMs required for the operation, if any.</p> <p> For help repairing your custom key store, see the <a href="https://docs.aws.amazon.com/kms/latest/developerguide/fix-keystore.html">Troubleshooting Custom Key Stores</a> topic in the <i>AWS Key Management Service Developer Guide</i>.</p> async fn describe_custom_key_stores( &self, input: DescribeCustomKeyStoresRequest, ) -> Result<DescribeCustomKeyStoresResponse, RusotoError<DescribeCustomKeyStoresError>> { let mut request = self.new_signed_request("POST", "/"); request.add_header("x-amz-target", "TrentService.DescribeCustomKeyStores"); let encoded = serde_json::to_string(&input).unwrap(); request.set_payload(Some(encoded)); let response = self .sign_and_dispatch(request, DescribeCustomKeyStoresError::from_response) .await?; let mut response = response; let response = response.buffer().await.map_err(RusotoError::HttpDispatch)?; proto::json::ResponsePayload::new(&response) .deserialize::<DescribeCustomKeyStoresResponse, _>() } /// <p>Provides detailed information about a customer master key (CMK). You can run <code>DescribeKey</code> on a <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#customer-cmk">customer managed CMK</a> or an <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-cmk">AWS managed CMK</a>.</p> <p>This detailed information includes the key ARN, creation date (and deletion date, if applicable), the key state, and the origin and expiration date (if any) of the key material. For CMKs in custom key stores, it includes information about the custom key store, such as the key store ID and the AWS CloudHSM cluster ID. It includes fields, like <code>KeySpec</code>, that help you distinguish symmetric from asymmetric CMKs. It also provides information that is particularly important to asymmetric CMKs, such as the key usage (encryption or signing) and the encryption algorithms or signing algorithms that the CMK supports.</p> <p> <code>DescribeKey</code> does not return the following information:</p> <ul> <li> <p>Aliases associated with the CMK. To get this information, use <a>ListAliases</a>.</p> </li> <li> <p>Whether automatic key rotation is enabled on the CMK. To get this information, use <a>GetKeyRotationStatus</a>. Also, some key states prevent a CMK from being automatically rotated. For details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/rotate-keys.html#rotate-keys-how-it-works">How Automatic Key Rotation Works</a> in <i>AWS Key Management Service Developer Guide</i>.</p> </li> <li> <p>Tags on the CMK. To get this information, use <a>ListResourceTags</a>.</p> </li> <li> <p>Key policies and grants on the CMK. To get this information, use <a>GetKeyPolicy</a> and <a>ListGrants</a>.</p> </li> </ul> <p>If you call the <code>DescribeKey</code> operation on a <i>predefined AWS alias</i>, that is, an AWS alias with no key ID, AWS KMS creates an <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#master_keys">AWS managed CMK</a>. Then, it associates the alias with the new CMK, and returns the <code>KeyId</code> and <code>Arn</code> of the new CMK in the response.</p> <p>To perform this operation on a CMK in a different AWS account, specify the key ARN or alias ARN in the value of the KeyId parameter.</p> async fn describe_key( &self, input: DescribeKeyRequest, ) -> Result<DescribeKeyResponse, RusotoError<DescribeKeyError>> { let mut request = self.new_signed_request("POST", "/"); request.add_header("x-amz-target", "TrentService.DescribeKey"); let encoded = serde_json::to_string(&input).unwrap(); request.set_payload(Some(encoded)); let response = self .sign_and_dispatch(request, DescribeKeyError::from_response) .await?; let mut response = response; let response = response.buffer().await.map_err(RusotoError::HttpDispatch)?; proto::json::ResponsePayload::new(&response).deserialize::<DescribeKeyResponse, _>() } /// <p>Sets the state of a customer master key (CMK) to disabled, thereby preventing its use for <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#cryptographic-operations">cryptographic operations</a>. You cannot perform this operation on a CMK in a different AWS account.</p> <p>For more information about how key state affects the use of a CMK, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">How Key State Affects the Use of a Customer Master Key</a> in the <i> <i>AWS Key Management Service Developer Guide</i> </i>.</p> <p>The CMK that you use for this operation must be in a compatible key state. For details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">How Key State Affects Use of a Customer Master Key</a> in the <i>AWS Key Management Service Developer Guide</i>.</p> async fn disable_key( &self, input: DisableKeyRequest, ) -> Result<(), RusotoError<DisableKeyError>> { let mut request = self.new_signed_request("POST", "/"); request.add_header("x-amz-target", "TrentService.DisableKey"); let encoded = serde_json::to_string(&input).unwrap(); request.set_payload(Some(encoded)); let response = self .sign_and_dispatch(request, DisableKeyError::from_response) .await?; std::mem::drop(response); Ok(()) } /// <p>Disables <a href="https://docs.aws.amazon.com/kms/latest/developerguide/rotate-keys.html">automatic rotation of the key material</a> for the specified symmetric customer master key (CMK).</p> <p> You cannot enable automatic rotation of asymmetric CMKs, CMKs with imported key material, or CMKs in a <a href="https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html">custom key store</a>. You cannot perform this operation on a CMK in a different AWS account.</p> <p>The CMK that you use for this operation must be in a compatible key state. For details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">How Key State Affects Use of a Customer Master Key</a> in the <i>AWS Key Management Service Developer Guide</i>.</p> async fn disable_key_rotation( &self, input: DisableKeyRotationRequest, ) -> Result<(), RusotoError<DisableKeyRotationError>> { let mut request = self.new_signed_request("POST", "/"); request.add_header("x-amz-target", "TrentService.DisableKeyRotation"); let encoded = serde_json::to_string(&input).unwrap(); request.set_payload(Some(encoded)); let response = self .sign_and_dispatch(request, DisableKeyRotationError::from_response) .await?; std::mem::drop(response); Ok(()) } /// <p>Disconnects the <a href="https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html">custom key store</a> from its associated AWS CloudHSM cluster. While a custom key store is disconnected, you can manage the custom key store and its customer master keys (CMKs), but you cannot create or use CMKs in the custom key store. You can reconnect the custom key store at any time.</p> <note> <p>While a custom key store is disconnected, all attempts to create customer master keys (CMKs) in the custom key store or to use existing CMKs in <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#cryptographic-operations">cryptographic operations</a> will fail. This action can prevent users from storing and accessing sensitive data.</p> </note> <p/> <p>To find the connection state of a custom key store, use the <a>DescribeCustomKeyStores</a> operation. To reconnect a custom key store, use the <a>ConnectCustomKeyStore</a> operation.</p> <p>If the operation succeeds, it returns a JSON object with no properties.</p> <p>This operation is part of the <a href="https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html">Custom Key Store feature</a> feature in AWS KMS, which combines the convenience and extensive integration of AWS KMS with the isolation and control of a single-tenant key store.</p> async fn disconnect_custom_key_store( &self, input: DisconnectCustomKeyStoreRequest, ) -> Result<DisconnectCustomKeyStoreResponse, RusotoError<DisconnectCustomKeyStoreError>> { let mut request = self.new_signed_request("POST", "/"); request.add_header("x-amz-target", "TrentService.DisconnectCustomKeyStore"); let encoded = serde_json::to_string(&input).unwrap(); request.set_payload(Some(encoded)); let response = self .sign_and_dispatch(request, DisconnectCustomKeyStoreError::from_response) .await?; let mut response = response; let response = response.buffer().await.map_err(RusotoError::HttpDispatch)?; proto::json::ResponsePayload::new(&response) .deserialize::<DisconnectCustomKeyStoreResponse, _>() } /// <p>Sets the key state of a customer master key (CMK) to enabled. This allows you to use the CMK for <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#cryptographic-operations">cryptographic operations</a>. You cannot perform this operation on a CMK in a different AWS account.</p> <p>The CMK that you use for this operation must be in a compatible key state. For details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">How Key State Affects Use of a Customer Master Key</a> in the <i>AWS Key Management Service Developer Guide</i>.</p> async fn enable_key(&self, input: EnableKeyRequest) -> Result<(), RusotoError<EnableKeyError>> { let mut request = self.new_signed_request("POST", "/"); request.add_header("x-amz-target", "TrentService.EnableKey"); let encoded = serde_json::to_string(&input).unwrap(); request.set_payload(Some(encoded)); let response = self .sign_and_dispatch(request, EnableKeyError::from_response) .await?; std::mem::drop(response); Ok(()) } /// <p>Enables <a href="https://docs.aws.amazon.com/kms/latest/developerguide/rotate-keys.html">automatic rotation of the key material</a> for the specified symmetric customer master key (CMK). You cannot perform this operation on a CMK in a different AWS account.</p> <p>You cannot enable automatic rotation of asymmetric CMKs, CMKs with imported key material, or CMKs in a <a href="https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html">custom key store</a>.</p> <p>The CMK that you use for this operation must be in a compatible key state. For details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">How Key State Affects Use of a Customer Master Key</a> in the <i>AWS Key Management Service Developer Guide</i>.</p> async fn enable_key_rotation( &self, input: EnableKeyRotationRequest, ) -> Result<(), RusotoError<EnableKeyRotationError>> { let mut request = self.new_signed_request("POST", "/"); request.add_header("x-amz-target", "TrentService.EnableKeyRotation"); let encoded = serde_json::to_string(&input).unwrap(); request.set_payload(Some(encoded)); let response = self .sign_and_dispatch(request, EnableKeyRotationError::from_response) .await?; std::mem::drop(response); Ok(()) } /// <p>Encrypts plaintext into ciphertext by using a customer master key (CMK). The <code>Encrypt</code> operation has two primary use cases:</p> <ul> <li> <p>You can encrypt small amounts of arbitrary data, such as a personal identifier or database password, or other sensitive information. </p> </li> <li> <p>You can use the <code>Encrypt</code> operation to move encrypted data from one AWS Region to another. For example, in Region A, generate a data key and use the plaintext key to encrypt your data. Then, in Region A, use the <code>Encrypt</code> operation to encrypt the plaintext data key under a CMK in Region B. Now, you can move the encrypted data and the encrypted data key to Region B. When necessary, you can decrypt the encrypted data key and the encrypted data entirely within in Region B.</p> </li> </ul> <p>You don't need to use the <code>Encrypt</code> operation to encrypt a data key. The <a>GenerateDataKey</a> and <a>GenerateDataKeyPair</a> operations return a plaintext data key and an encrypted copy of that data key.</p> <p>When you encrypt data, you must specify a symmetric or asymmetric CMK to use in the encryption operation. The CMK must have a <code>KeyUsage</code> value of <code>ENCRYPT_DECRYPT.</code> To find the <code>KeyUsage</code> of a CMK, use the <a>DescribeKey</a> operation. </p> <p>If you use a symmetric CMK, you can use an encryption context to add additional security to your encryption operation. If you specify an <code>EncryptionContext</code> when encrypting data, you must specify the same encryption context (a case-sensitive exact match) when decrypting the data. Otherwise, the request to decrypt fails with an <code>InvalidCiphertextException</code>. For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context">Encryption Context</a> in the <i>AWS Key Management Service Developer Guide</i>.</p> <p>If you specify an asymmetric CMK, you must also specify the encryption algorithm. The algorithm must be compatible with the CMK type.</p> <important> <p>When you use an asymmetric CMK to encrypt or reencrypt data, be sure to record the CMK and encryption algorithm that you choose. You will be required to provide the same CMK and encryption algorithm when you decrypt the data. If the CMK and algorithm do not match the values used to encrypt the data, the decrypt operation fails.</p> <p>You are not required to supply the CMK ID and encryption algorithm when you decrypt with symmetric CMKs because AWS KMS stores this information in the ciphertext blob. AWS KMS cannot store metadata in ciphertext generated with asymmetric keys. The standard format for asymmetric key ciphertext does not include configurable fields.</p> </important> <p>The maximum size of the data that you can encrypt varies with the type of CMK and the encryption algorithm that you choose.</p> <ul> <li> <p>Symmetric CMKs</p> <ul> <li> <p> <code>SYMMETRIC_DEFAULT</code>: 4096 bytes</p> </li> </ul> </li> <li> <p> <code>RSA_2048</code> </p> <ul> <li> <p> <code>RSAES_OAEP_SHA_1</code>: 214 bytes</p> </li> <li> <p> <code>RSAES_OAEP_SHA_256</code>: 190 bytes</p> </li> </ul> </li> <li> <p> <code>RSA_3072</code> </p> <ul> <li> <p> <code>RSAES_OAEP_SHA_1</code>: 342 bytes</p> </li> <li> <p> <code>RSAES_OAEP_SHA_256</code>: 318 bytes</p> </li> </ul> </li> <li> <p> <code>RSA_4096</code> </p> <ul> <li> <p> <code>RSAES_OAEP_SHA_1</code>: 470 bytes</p> </li> <li> <p> <code>RSAES_OAEP_SHA_256</code>: 446 bytes</p> </li> </ul> </li> </ul> <p>The CMK that you use for this operation must be in a compatible key state. For details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">How Key State Affects Use of a Customer Master Key</a> in the <i>AWS Key Management Service Developer Guide</i>.</p> <p>To perform this operation on a CMK in a different AWS account, specify the key ARN or alias ARN in the value of the KeyId parameter.</p> async fn encrypt( &self, input: EncryptRequest, ) -> Result<EncryptResponse, RusotoError<EncryptError>> { let mut request = self.new_signed_request("POST", "/"); request.add_header("x-amz-target", "TrentService.Encrypt"); let encoded = serde_json::to_string(&input).unwrap(); request.set_payload(Some(encoded)); let response = self .sign_and_dispatch(request, EncryptError::from_response) .await?; let mut response = response; let response = response.buffer().await.map_err(RusotoError::HttpDispatch)?; proto::json::ResponsePayload::new(&response).deserialize::<EncryptResponse, _>() } /// <p><p>Generates a unique symmetric data key for client-side encryption. This operation returns a plaintext copy of the data key and a copy that is encrypted under a customer master key (CMK) that you specify. You can use the plaintext key to encrypt your data outside of AWS KMS and store the encrypted data key with the encrypted data.</p> <p> <code>GenerateDataKey</code> returns a unique data key for each request. The bytes in the plaintext key are not related to the caller or the CMK.</p> <p>To generate a data key, specify the symmetric CMK that will be used to encrypt the data key. You cannot use an asymmetric CMK to generate data keys. To get the type of your CMK, use the <a>DescribeKey</a> operation. You must also specify the length of the data key. Use either the <code>KeySpec</code> or <code>NumberOfBytes</code> parameters (but not both). For 128-bit and 256-bit data keys, use the <code>KeySpec</code> parameter. </p> <p>To get only an encrypted copy of the data key, use <a>GenerateDataKeyWithoutPlaintext</a>. To generate an asymmetric data key pair, use the <a>GenerateDataKeyPair</a> or <a>GenerateDataKeyPairWithoutPlaintext</a> operation. To get a cryptographically secure random byte string, use <a>GenerateRandom</a>.</p> <p>You can use the optional encryption context to add additional security to the encryption operation. If you specify an <code>EncryptionContext</code>, you must specify the same encryption context (a case-sensitive exact match) when decrypting the encrypted data key. Otherwise, the request to decrypt fails with an <code>InvalidCiphertextException</code>. For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context">Encryption Context</a> in the <i>AWS Key Management Service Developer Guide</i>.</p> <p>The CMK that you use for this operation must be in a compatible key state. For details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">How Key State Affects Use of a Customer Master Key</a> in the <i>AWS Key Management Service Developer Guide</i>.</p> <p> <b>How to use your data key</b> </p> <p>We recommend that you use the following pattern to encrypt data locally in your application. You can write your own code or use a client-side encryption library, such as the <a href="https://docs.aws.amazon.com/encryption-sdk/latest/developer-guide/">AWS Encryption SDK</a>, the <a href="https://docs.aws.amazon.com/dynamodb-encryption-client/latest/devguide/">Amazon DynamoDB Encryption Client</a>, or <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingClientSideEncryption.html">Amazon S3 client-side encryption</a> to do these tasks for you.</p> <p>To encrypt data outside of AWS KMS:</p> <ol> <li> <p>Use the <code>GenerateDataKey</code> operation to get a data key.</p> </li> <li> <p>Use the plaintext data key (in the <code>Plaintext</code> field of the response) to encrypt your data outside of AWS KMS. Then erase the plaintext data key from memory.</p> </li> <li> <p>Store the encrypted data key (in the <code>CiphertextBlob</code> field of the response) with the encrypted data.</p> </li> </ol> <p>To decrypt data outside of AWS KMS:</p> <ol> <li> <p>Use the <a>Decrypt</a> operation to decrypt the encrypted data key. The operation returns a plaintext copy of the data key.</p> </li> <li> <p>Use the plaintext data key to decrypt data outside of AWS KMS, then erase the plaintext data key from memory.</p> </li> </ol></p> async fn generate_data_key( &self, input: GenerateDataKeyRequest, ) -> Result<GenerateDataKeyResponse, RusotoError<GenerateDataKeyError>> { let mut request = self.new_signed_request("POST", "/"); request.add_header("x-amz-target", "TrentService.GenerateDataKey"); let encoded = serde_json::to_string(&input).unwrap(); request.set_payload(Some(encoded)); let response = self .sign_and_dispatch(request, GenerateDataKeyError::from_response) .await?; let mut response = response; let response = response.buffer().await.map_err(RusotoError::HttpDispatch)?; proto::json::ResponsePayload::new(&response).deserialize::<GenerateDataKeyResponse, _>() } /// <p>Generates a unique asymmetric data key pair. The <code>GenerateDataKeyPair</code> operation returns a plaintext public key, a plaintext private key, and a copy of the private key that is encrypted under the symmetric CMK you specify. You can use the data key pair to perform asymmetric cryptography outside of AWS KMS.</p> <p> <code>GenerateDataKeyPair</code> returns a unique data key pair for each request. The bytes in the keys are not related to the caller or the CMK that is used to encrypt the private key.</p> <p>You can use the public key that <code>GenerateDataKeyPair</code> returns to encrypt data or verify a signature outside of AWS KMS. Then, store the encrypted private key with the data. When you are ready to decrypt data or sign a message, you can use the <a>Decrypt</a> operation to decrypt the encrypted private key.</p> <p>To generate a data key pair, you must specify a symmetric customer master key (CMK) to encrypt the private key in a data key pair. You cannot use an asymmetric CMK or a CMK in a custom key store. To get the type and origin of your CMK, use the <a>DescribeKey</a> operation. </p> <p>If you are using the data key pair to encrypt data, or for any operation where you don't immediately need a private key, consider using the <a>GenerateDataKeyPairWithoutPlaintext</a> operation. <code>GenerateDataKeyPairWithoutPlaintext</code> returns a plaintext public key and an encrypted private key, but omits the plaintext private key that you need only to decrypt ciphertext or sign a message. Later, when you need to decrypt the data or sign a message, use the <a>Decrypt</a> operation to decrypt the encrypted private key in the data key pair.</p> <p>You can use the optional encryption context to add additional security to the encryption operation. If you specify an <code>EncryptionContext</code>, you must specify the same encryption context (a case-sensitive exact match) when decrypting the encrypted data key. Otherwise, the request to decrypt fails with an <code>InvalidCiphertextException</code>. For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context">Encryption Context</a> in the <i>AWS Key Management Service Developer Guide</i>.</p> <p>The CMK that you use for this operation must be in a compatible key state. For details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">How Key State Affects Use of a Customer Master Key</a> in the <i>AWS Key Management Service Developer Guide</i>.</p> async fn generate_data_key_pair( &self, input: GenerateDataKeyPairRequest, ) -> Result<GenerateDataKeyPairResponse, RusotoError<GenerateDataKeyPairError>> { let mut request = self.new_signed_request("POST", "/"); request.add_header("x-amz-target", "TrentService.GenerateDataKeyPair"); let encoded = serde_json::to_string(&input).unwrap(); request.set_payload(Some(encoded)); let response = self .sign_and_dispatch(request, GenerateDataKeyPairError::from_response) .await?; let mut response = response; let response = response.buffer().await.map_err(RusotoError::HttpDispatch)?; proto::json::ResponsePayload::new(&response).deserialize::<GenerateDataKeyPairResponse, _>() } /// <p>Generates a unique asymmetric data key pair. The <code>GenerateDataKeyPairWithoutPlaintext</code> operation returns a plaintext public key and a copy of the private key that is encrypted under the symmetric CMK you specify. Unlike <a>GenerateDataKeyPair</a>, this operation does not return a plaintext private key. </p> <p>To generate a data key pair, you must specify a symmetric customer master key (CMK) to encrypt the private key in the data key pair. You cannot use an asymmetric CMK or a CMK in a custom key store. To get the type and origin of your CMK, use the <code>KeySpec</code> field in the <a>DescribeKey</a> response.</p> <p>You can use the public key that <code>GenerateDataKeyPairWithoutPlaintext</code> returns to encrypt data or verify a signature outside of AWS KMS. Then, store the encrypted private key with the data. When you are ready to decrypt data or sign a message, you can use the <a>Decrypt</a> operation to decrypt the encrypted private key.</p> <p> <code>GenerateDataKeyPairWithoutPlaintext</code> returns a unique data key pair for each request. The bytes in the key are not related to the caller or CMK that is used to encrypt the private key.</p> <p>You can use the optional encryption context to add additional security to the encryption operation. If you specify an <code>EncryptionContext</code>, you must specify the same encryption context (a case-sensitive exact match) when decrypting the encrypted data key. Otherwise, the request to decrypt fails with an <code>InvalidCiphertextException</code>. For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context">Encryption Context</a> in the <i>AWS Key Management Service Developer Guide</i>.</p> <p>The CMK that you use for this operation must be in a compatible key state. For details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">How Key State Affects Use of a Customer Master Key</a> in the <i>AWS Key Management Service Developer Guide</i>.</p> async fn generate_data_key_pair_without_plaintext( &self, input: GenerateDataKeyPairWithoutPlaintextRequest, ) -> Result< GenerateDataKeyPairWithoutPlaintextResponse, RusotoError<GenerateDataKeyPairWithoutPlaintextError>, > { let mut request = self.new_signed_request("POST", "/"); request.add_header( "x-amz-target", "TrentService.GenerateDataKeyPairWithoutPlaintext", ); let encoded = serde_json::to_string(&input).unwrap(); request.set_payload(Some(encoded)); let response = self .sign_and_dispatch( request, GenerateDataKeyPairWithoutPlaintextError::from_response, ) .await?; let mut response = response; let response = response.buffer().await.map_err(RusotoError::HttpDispatch)?; proto::json::ResponsePayload::new(&response) .deserialize::<GenerateDataKeyPairWithoutPlaintextResponse, _>() } /// <p>Generates a unique symmetric data key. This operation returns a data key that is encrypted under a customer master key (CMK) that you specify. To request an asymmetric data key pair, use the <a>GenerateDataKeyPair</a> or <a>GenerateDataKeyPairWithoutPlaintext</a> operations.</p> <p> <code>GenerateDataKeyWithoutPlaintext</code> is identical to the <a>GenerateDataKey</a> operation except that returns only the encrypted copy of the data key. This operation is useful for systems that need to encrypt data at some point, but not immediately. When you need to encrypt the data, you call the <a>Decrypt</a> operation on the encrypted copy of the key. </p> <p>It's also useful in distributed systems with different levels of trust. For example, you might store encrypted data in containers. One component of your system creates new containers and stores an encrypted data key with each container. Then, a different component puts the data into the containers. That component first decrypts the data key, uses the plaintext data key to encrypt data, puts the encrypted data into the container, and then destroys the plaintext data key. In this system, the component that creates the containers never sees the plaintext data key.</p> <p> <code>GenerateDataKeyWithoutPlaintext</code> returns a unique data key for each request. The bytes in the keys are not related to the caller or CMK that is used to encrypt the private key.</p> <p>To generate a data key, you must specify the symmetric customer master key (CMK) that is used to encrypt the data key. You cannot use an asymmetric CMK to generate a data key. To get the type of your CMK, use the <a>DescribeKey</a> operation.</p> <p>If the operation succeeds, you will find the encrypted copy of the data key in the <code>CiphertextBlob</code> field.</p> <p>You can use the optional encryption context to add additional security to the encryption operation. If you specify an <code>EncryptionContext</code>, you must specify the same encryption context (a case-sensitive exact match) when decrypting the encrypted data key. Otherwise, the request to decrypt fails with an <code>InvalidCiphertextException</code>. For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context">Encryption Context</a> in the <i>AWS Key Management Service Developer Guide</i>.</p> <p>The CMK that you use for this operation must be in a compatible key state. For details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">How Key State Affects Use of a Customer Master Key</a> in the <i>AWS Key Management Service Developer Guide</i>.</p> async fn generate_data_key_without_plaintext( &self, input: GenerateDataKeyWithoutPlaintextRequest, ) -> Result< GenerateDataKeyWithoutPlaintextResponse, RusotoError<GenerateDataKeyWithoutPlaintextError>, > { let mut request = self.new_signed_request("POST", "/"); request.add_header( "x-amz-target", "TrentService.GenerateDataKeyWithoutPlaintext", ); let encoded = serde_json::to_string(&input).unwrap(); request.set_payload(Some(encoded)); let response = self .sign_and_dispatch(request, GenerateDataKeyWithoutPlaintextError::from_response) .await?; let mut response = response; let response = response.buffer().await.map_err(RusotoError::HttpDispatch)?; proto::json::ResponsePayload::new(&response) .deserialize::<GenerateDataKeyWithoutPlaintextResponse, _>() } /// <p>Returns a random byte string that is cryptographically secure.</p> <p>By default, the random byte string is generated in AWS KMS. To generate the byte string in the AWS CloudHSM cluster that is associated with a <a href="https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html">custom key store</a>, specify the custom key store ID.</p> <p>For more information about entropy and random number generation, see the <a href="https://d0.awsstatic.com/whitepapers/KMS-Cryptographic-Details.pdf">AWS Key Management Service Cryptographic Details</a> whitepaper.</p> async fn generate_random( &self, input: GenerateRandomRequest, ) -> Result<GenerateRandomResponse, RusotoError<GenerateRandomError>> { let mut request = self.new_signed_request("POST", "/"); request.add_header("x-amz-target", "TrentService.GenerateRandom"); let encoded = serde_json::to_string(&input).unwrap(); request.set_payload(Some(encoded)); let response = self .sign_and_dispatch(request, GenerateRandomError::from_response) .await?; let mut response = response; let response = response.buffer().await.map_err(RusotoError::HttpDispatch)?; proto::json::ResponsePayload::new(&response).deserialize::<GenerateRandomResponse, _>() } /// <p>Gets a key policy attached to the specified customer master key (CMK). You cannot perform this operation on a CMK in a different AWS account.</p> async fn get_key_policy( &self, input: GetKeyPolicyRequest, ) -> Result<GetKeyPolicyResponse, RusotoError<GetKeyPolicyError>> { let mut request = self.new_signed_request("POST", "/"); request.add_header("x-amz-target", "TrentService.GetKeyPolicy"); let encoded = serde_json::to_string(&input).unwrap(); request.set_payload(Some(encoded)); let response = self .sign_and_dispatch(request, GetKeyPolicyError::from_response) .await?; let mut response = response; let response = response.buffer().await.map_err(RusotoError::HttpDispatch)?; proto::json::ResponsePayload::new(&response).deserialize::<GetKeyPolicyResponse, _>() } /// <p>Gets a Boolean value that indicates whether <a href="https://docs.aws.amazon.com/kms/latest/developerguide/rotate-keys.html">automatic rotation of the key material</a> is enabled for the specified customer master key (CMK).</p> <p>You cannot enable automatic rotation of asymmetric CMKs, CMKs with imported key material, or CMKs in a <a href="https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html">custom key store</a>. The key rotation status for these CMKs is always <code>false</code>.</p> <p>The CMK that you use for this operation must be in a compatible key state. For details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">How Key State Affects Use of a Customer Master Key</a> in the <i>AWS Key Management Service Developer Guide</i>.</p> <ul> <li> <p>Disabled: The key rotation status does not change when you disable a CMK. However, while the CMK is disabled, AWS KMS does not rotate the backing key.</p> </li> <li> <p>Pending deletion: While a CMK is pending deletion, its key rotation status is <code>false</code> and AWS KMS does not rotate the backing key. If you cancel the deletion, the original key rotation status is restored.</p> </li> </ul> <p>To perform this operation on a CMK in a different AWS account, specify the key ARN in the value of the <code>KeyId</code> parameter.</p> async fn get_key_rotation_status( &self, input: GetKeyRotationStatusRequest, ) -> Result<GetKeyRotationStatusResponse, RusotoError<GetKeyRotationStatusError>> { let mut request = self.new_signed_request("POST", "/"); request.add_header("x-amz-target", "TrentService.GetKeyRotationStatus"); let encoded = serde_json::to_string(&input).unwrap(); request.set_payload(Some(encoded)); let response = self .sign_and_dispatch(request, GetKeyRotationStatusError::from_response) .await?; let mut response = response; let response = response.buffer().await.map_err(RusotoError::HttpDispatch)?; proto::json::ResponsePayload::new(&response) .deserialize::<GetKeyRotationStatusResponse, _>() } /// <p>Returns the items you need to import key material into a symmetric, customer managed customer master key (CMK). For more information about importing key material into AWS KMS, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys.html">Importing Key Material</a> in the <i>AWS Key Management Service Developer Guide</i>.</p> <p>This operation returns a public key and an import token. Use the public key to encrypt the symmetric key material. Store the import token to send with a subsequent <a>ImportKeyMaterial</a> request.</p> <p>You must specify the key ID of the symmetric CMK into which you will import key material. This CMK's <code>Origin</code> must be <code>EXTERNAL</code>. You must also specify the wrapping algorithm and type of wrapping key (public key) that you will use to encrypt the key material. You cannot perform this operation on an asymmetric CMK or on any CMK in a different AWS account.</p> <p>To import key material, you must use the public key and import token from the same response. These items are valid for 24 hours. The expiration date and time appear in the <code>GetParametersForImport</code> response. You cannot use an expired token in an <a>ImportKeyMaterial</a> request. If your key and token expire, send another <code>GetParametersForImport</code> request.</p> <p>The CMK that you use for this operation must be in a compatible key state. For details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">How Key State Affects Use of a Customer Master Key</a> in the <i>AWS Key Management Service Developer Guide</i>.</p> async fn get_parameters_for_import( &self, input: GetParametersForImportRequest, ) -> Result<GetParametersForImportResponse, RusotoError<GetParametersForImportError>> { let mut request = self.new_signed_request("POST", "/"); request.add_header("x-amz-target", "TrentService.GetParametersForImport"); let encoded = serde_json::to_string(&input).unwrap(); request.set_payload(Some(encoded)); let response = self .sign_and_dispatch(request, GetParametersForImportError::from_response) .await?; let mut response = response; let response = response.buffer().await.map_err(RusotoError::HttpDispatch)?; proto::json::ResponsePayload::new(&response) .deserialize::<GetParametersForImportResponse, _>() } /// <p>Returns the public key of an asymmetric CMK. Unlike the private key of a asymmetric CMK, which never leaves AWS KMS unencrypted, callers with <code>kms:GetPublicKey</code> permission can download the public key of an asymmetric CMK. You can share the public key to allow others to encrypt messages and verify signatures outside of AWS KMS. For information about symmetric and asymmetric CMKs, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html">Using Symmetric and Asymmetric CMKs</a> in the <i>AWS Key Management Service Developer Guide</i>.</p> <p>You do not need to download the public key. Instead, you can use the public key within AWS KMS by calling the <a>Encrypt</a>, <a>ReEncrypt</a>, or <a>Verify</a> operations with the identifier of an asymmetric CMK. When you use the public key within AWS KMS, you benefit from the authentication, authorization, and logging that are part of every AWS KMS operation. You also reduce of risk of encrypting data that cannot be decrypted. These features are not effective outside of AWS KMS. For details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/download-public-key.html#download-public-key-considerations">Special Considerations for Downloading Public Keys</a>.</p> <p>To help you use the public key safely outside of AWS KMS, <code>GetPublicKey</code> returns important information about the public key in the response, including:</p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/kms/latest/APIReference/API_GetPublicKey.html#KMS-GetPublicKey-response-CustomerMasterKeySpec">CustomerMasterKeySpec</a>: The type of key material in the public key, such as <code>RSA_4096</code> or <code>ECC_NIST_P521</code>.</p> </li> <li> <p> <a href="https://docs.aws.amazon.com/kms/latest/APIReference/API_GetPublicKey.html#KMS-GetPublicKey-response-KeyUsage">KeyUsage</a>: Whether the key is used for encryption or signing.</p> </li> <li> <p> <a href="https://docs.aws.amazon.com/kms/latest/APIReference/API_GetPublicKey.html#KMS-GetPublicKey-response-EncryptionAlgorithms">EncryptionAlgorithms</a> or <a href="https://docs.aws.amazon.com/kms/latest/APIReference/API_GetPublicKey.html#KMS-GetPublicKey-response-SigningAlgorithms">SigningAlgorithms</a>: A list of the encryption algorithms or the signing algorithms for the key.</p> </li> </ul> <p>Although AWS KMS cannot enforce these restrictions on external operations, it is crucial that you use this information to prevent the public key from being used improperly. For example, you can prevent a public signing key from being used encrypt data, or prevent a public key from being used with an encryption algorithm that is not supported by AWS KMS. You can also avoid errors, such as using the wrong signing algorithm in a verification operation.</p> <p>The CMK that you use for this operation must be in a compatible key state. For details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">How Key State Affects Use of a Customer Master Key</a> in the <i>AWS Key Management Service Developer Guide</i>.</p> async fn get_public_key( &self, input: GetPublicKeyRequest, ) -> Result<GetPublicKeyResponse, RusotoError<GetPublicKeyError>> { let mut request = self.new_signed_request("POST", "/"); request.add_header("x-amz-target", "TrentService.GetPublicKey"); let encoded = serde_json::to_string(&input).unwrap(); request.set_payload(Some(encoded)); let response = self .sign_and_dispatch(request, GetPublicKeyError::from_response) .await?; let mut response = response; let response = response.buffer().await.map_err(RusotoError::HttpDispatch)?; proto::json::ResponsePayload::new(&response).deserialize::<GetPublicKeyResponse, _>() } /// <p>Imports key material into an existing symmetric AWS KMS customer master key (CMK) that was created without key material. After you successfully import key material into a CMK, you can <a href="https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys.html#reimport-key-material">reimport the same key material</a> into that CMK, but you cannot import different key material.</p> <p>You cannot perform this operation on an asymmetric CMK or on any CMK in a different AWS account. For more information about creating CMKs with no key material and then importing key material, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys.html">Importing Key Material</a> in the <i>AWS Key Management Service Developer Guide</i>.</p> <p>Before using this operation, call <a>GetParametersForImport</a>. Its response includes a public key and an import token. Use the public key to encrypt the key material. Then, submit the import token from the same <code>GetParametersForImport</code> response.</p> <p>When calling this operation, you must specify the following values:</p> <ul> <li> <p>The key ID or key ARN of a CMK with no key material. Its <code>Origin</code> must be <code>EXTERNAL</code>.</p> <p>To create a CMK with no key material, call <a>CreateKey</a> and set the value of its <code>Origin</code> parameter to <code>EXTERNAL</code>. To get the <code>Origin</code> of a CMK, call <a>DescribeKey</a>.)</p> </li> <li> <p>The encrypted key material. To get the public key to encrypt the key material, call <a>GetParametersForImport</a>.</p> </li> <li> <p>The import token that <a>GetParametersForImport</a> returned. You must use a public key and token from the same <code>GetParametersForImport</code> response.</p> </li> <li> <p>Whether the key material expires and if so, when. If you set an expiration date, AWS KMS deletes the key material from the CMK on the specified date, and the CMK becomes unusable. To use the CMK again, you must reimport the same key material. The only way to change an expiration date is by reimporting the same key material and specifying a new expiration date. </p> </li> </ul> <p>When this operation is successful, the key state of the CMK changes from <code>PendingImport</code> to <code>Enabled</code>, and you can use the CMK.</p> <p>If this operation fails, use the exception to help determine the problem. If the error is related to the key material, the import token, or wrapping key, use <a>GetParametersForImport</a> to get a new public key and import token for the CMK and repeat the import procedure. For help, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys.html#importing-keys-overview">How To Import Key Material</a> in the <i>AWS Key Management Service Developer Guide</i>.</p> <p>The CMK that you use for this operation must be in a compatible key state. For details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">How Key State Affects Use of a Customer Master Key</a> in the <i>AWS Key Management Service Developer Guide</i>.</p> async fn import_key_material( &self, input: ImportKeyMaterialRequest, ) -> Result<ImportKeyMaterialResponse, RusotoError<ImportKeyMaterialError>> { let mut request = self.new_signed_request("POST", "/"); request.add_header("x-amz-target", "TrentService.ImportKeyMaterial"); let encoded = serde_json::to_string(&input).unwrap(); request.set_payload(Some(encoded)); let response = self .sign_and_dispatch(request, ImportKeyMaterialError::from_response) .await?; let mut response = response; let response = response.buffer().await.map_err(RusotoError::HttpDispatch)?; proto::json::ResponsePayload::new(&response).deserialize::<ImportKeyMaterialResponse, _>() } /// <p>Gets a list of aliases in the caller's AWS account and region. You cannot list aliases in other accounts. For more information about aliases, see <a>CreateAlias</a>.</p> <p>By default, the ListAliases command returns all aliases in the account and region. To get only the aliases that point to a particular customer master key (CMK), use the <code>KeyId</code> parameter.</p> <p>The <code>ListAliases</code> response can include aliases that you created and associated with your customer managed CMKs, and aliases that AWS created and associated with AWS managed CMKs in your account. You can recognize AWS aliases because their names have the format <code>aws/<service-name></code>, such as <code>aws/dynamodb</code>.</p> <p>The response might also include aliases that have no <code>TargetKeyId</code> field. These are predefined aliases that AWS has created but has not yet associated with a CMK. Aliases that AWS creates in your account, including predefined aliases, do not count against your <a href="https://docs.aws.amazon.com/kms/latest/developerguide/limits.html#aliases-limit">AWS KMS aliases quota</a>.</p> async fn list_aliases( &self, input: ListAliasesRequest, ) -> Result<ListAliasesResponse, RusotoError<ListAliasesError>> { let mut request = self.new_signed_request("POST", "/"); request.add_header("x-amz-target", "TrentService.ListAliases"); let encoded = serde_json::to_string(&input).unwrap(); request.set_payload(Some(encoded)); let response = self .sign_and_dispatch(request, ListAliasesError::from_response) .await?; let mut response = response; let response = response.buffer().await.map_err(RusotoError::HttpDispatch)?; proto::json::ResponsePayload::new(&response).deserialize::<ListAliasesResponse, _>() } /// <p><p>Gets a list of all grants for the specified customer master key (CMK).</p> <p>To perform this operation on a CMK in a different AWS account, specify the key ARN in the value of the <code>KeyId</code> parameter.</p> <note> <p>The <code>GranteePrincipal</code> field in the <code>ListGrants</code> response usually contains the user or role designated as the grantee principal in the grant. However, when the grantee principal in the grant is an AWS service, the <code>GranteePrincipal</code> field contains the <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements_principal.html#principal-services">service principal</a>, which might represent several different grantee principals.</p> </note></p> async fn list_grants( &self, input: ListGrantsRequest, ) -> Result<ListGrantsResponse, RusotoError<ListGrantsError>> { let mut request = self.new_signed_request("POST", "/"); request.add_header("x-amz-target", "TrentService.ListGrants"); let encoded = serde_json::to_string(&input).unwrap(); request.set_payload(Some(encoded)); let response = self .sign_and_dispatch(request, ListGrantsError::from_response) .await?; let mut response = response; let response = response.buffer().await.map_err(RusotoError::HttpDispatch)?; proto::json::ResponsePayload::new(&response).deserialize::<ListGrantsResponse, _>() } /// <p>Gets the names of the key policies that are attached to a customer master key (CMK). This operation is designed to get policy names that you can use in a <a>GetKeyPolicy</a> operation. However, the only valid policy name is <code>default</code>. You cannot perform this operation on a CMK in a different AWS account.</p> async fn list_key_policies( &self, input: ListKeyPoliciesRequest, ) -> Result<ListKeyPoliciesResponse, RusotoError<ListKeyPoliciesError>> { let mut request = self.new_signed_request("POST", "/"); request.add_header("x-amz-target", "TrentService.ListKeyPolicies"); let encoded = serde_json::to_string(&input).unwrap(); request.set_payload(Some(encoded)); let response = self .sign_and_dispatch(request, ListKeyPoliciesError::from_response) .await?; let mut response = response; let response = response.buffer().await.map_err(RusotoError::HttpDispatch)?; proto::json::ResponsePayload::new(&response).deserialize::<ListKeyPoliciesResponse, _>() } /// <p>Gets a list of all customer master keys (CMKs) in the caller's AWS account and Region.</p> async fn list_keys( &self, input: ListKeysRequest, ) -> Result<ListKeysResponse, RusotoError<ListKeysError>> { let mut request = self.new_signed_request("POST", "/"); request.add_header("x-amz-target", "TrentService.ListKeys"); let encoded = serde_json::to_string(&input).unwrap(); request.set_payload(Some(encoded)); let response = self .sign_and_dispatch(request, ListKeysError::from_response) .await?; let mut response = response; let response = response.buffer().await.map_err(RusotoError::HttpDispatch)?; proto::json::ResponsePayload::new(&response).deserialize::<ListKeysResponse, _>() } /// <p>Returns a list of all tags for the specified customer master key (CMK).</p> <p>You cannot perform this operation on a CMK in a different AWS account.</p> async fn list_resource_tags( &self, input: ListResourceTagsRequest, ) -> Result<ListResourceTagsResponse, RusotoError<ListResourceTagsError>> { let mut request = self.new_signed_request("POST", "/"); request.add_header("x-amz-target", "TrentService.ListResourceTags"); let encoded = serde_json::to_string(&input).unwrap(); request.set_payload(Some(encoded)); let response = self .sign_and_dispatch(request, ListResourceTagsError::from_response) .await?; let mut response = response; let response = response.buffer().await.map_err(RusotoError::HttpDispatch)?; proto::json::ResponsePayload::new(&response).deserialize::<ListResourceTagsResponse, _>() } /// <p>Returns a list of all grants for which the grant's <code>RetiringPrincipal</code> matches the one specified.</p> <p>A typical use is to list all grants that you are able to retire. To retire a grant, use <a>RetireGrant</a>.</p> async fn list_retirable_grants( &self, input: ListRetirableGrantsRequest, ) -> Result<ListGrantsResponse, RusotoError<ListRetirableGrantsError>> { let mut request = self.new_signed_request("POST", "/"); request.add_header("x-amz-target", "TrentService.ListRetirableGrants"); let encoded = serde_json::to_string(&input).unwrap(); request.set_payload(Some(encoded)); let response = self .sign_and_dispatch(request, ListRetirableGrantsError::from_response) .await?; let mut response = response; let response = response.buffer().await.map_err(RusotoError::HttpDispatch)?; proto::json::ResponsePayload::new(&response).deserialize::<ListGrantsResponse, _>() } /// <p>Attaches a key policy to the specified customer master key (CMK). You cannot perform this operation on a CMK in a different AWS account.</p> <p>For more information about key policies, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html">Key Policies</a> in the <i>AWS Key Management Service Developer Guide</i>.</p> async fn put_key_policy( &self, input: PutKeyPolicyRequest, ) -> Result<(), RusotoError<PutKeyPolicyError>> { let mut request = self.new_signed_request("POST", "/"); request.add_header("x-amz-target", "TrentService.PutKeyPolicy"); let encoded = serde_json::to_string(&input).unwrap(); request.set_payload(Some(encoded)); let response = self .sign_and_dispatch(request, PutKeyPolicyError::from_response) .await?; std::mem::drop(response); Ok(()) } /// <p>Decrypts ciphertext and then reencrypts it entirely within AWS KMS. You can use this operation to change the customer master key (CMK) under which data is encrypted, such as when you <a href="https://docs.aws.amazon.com/kms/latest/developerguide/rotate-keys.html#rotate-keys-manually">manually rotate</a> a CMK or change the CMK that protects a ciphertext. You can also use it to reencrypt ciphertext under the same CMK, such as to change the <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context">encryption context</a> of a ciphertext.</p> <p>The <code>ReEncrypt</code> operation can decrypt ciphertext that was encrypted by using an AWS KMS CMK in an AWS KMS operation, such as <a>Encrypt</a> or <a>GenerateDataKey</a>. It can also decrypt ciphertext that was encrypted by using the public key of an <a href="https://docs.aws.amazon.com/kms/latest/developerguide/symm-asymm-concepts.html#asymmetric-cmks">asymmetric CMK</a> outside of AWS KMS. However, it cannot decrypt ciphertext produced by other libraries, such as the <a href="https://docs.aws.amazon.com/encryption-sdk/latest/developer-guide/">AWS Encryption SDK</a> or <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingClientSideEncryption.html">Amazon S3 client-side encryption</a>. These libraries return a ciphertext format that is incompatible with AWS KMS.</p> <p>When you use the <code>ReEncrypt</code> operation, you need to provide information for the decrypt operation and the subsequent encrypt operation.</p> <ul> <li> <p>If your ciphertext was encrypted under an asymmetric CMK, you must identify the <i>source CMK</i>, that is, the CMK that encrypted the ciphertext. You must also supply the encryption algorithm that was used. This information is required to decrypt the data.</p> </li> <li> <p>It is optional, but you can specify a source CMK even when the ciphertext was encrypted under a symmetric CMK. This ensures that the ciphertext is decrypted only by using a particular CMK. If the CMK that you specify cannot decrypt the ciphertext, the <code>ReEncrypt</code> operation fails.</p> </li> <li> <p>To reencrypt the data, you must specify the <i>destination CMK</i>, that is, the CMK that re-encrypts the data after it is decrypted. You can select a symmetric or asymmetric CMK. If the destination CMK is an asymmetric CMK, you must also provide the encryption algorithm. The algorithm that you choose must be compatible with the CMK.</p> <important> <p>When you use an asymmetric CMK to encrypt or reencrypt data, be sure to record the CMK and encryption algorithm that you choose. You will be required to provide the same CMK and encryption algorithm when you decrypt the data. If the CMK and algorithm do not match the values used to encrypt the data, the decrypt operation fails.</p> <p>You are not required to supply the CMK ID and encryption algorithm when you decrypt with symmetric CMKs because AWS KMS stores this information in the ciphertext blob. AWS KMS cannot store metadata in ciphertext generated with asymmetric keys. The standard format for asymmetric key ciphertext does not include configurable fields.</p> </important> </li> </ul> <p>Unlike other AWS KMS API operations, <code>ReEncrypt</code> callers must have two permissions:</p> <ul> <li> <p> <code>kms:ReEncryptFrom</code> permission on the source CMK</p> </li> <li> <p> <code>kms:ReEncryptTo</code> permission on the destination CMK</p> </li> </ul> <p>To permit reencryption from or to a CMK, include the <code>"kms:ReEncrypt*"</code> permission in your <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html">key policy</a>. This permission is automatically included in the key policy when you use the console to create a CMK. But you must include it manually when you create a CMK programmatically or when you use the <a>PutKeyPolicy</a> operation to set a key policy.</p> <p>The CMK that you use for this operation must be in a compatible key state. For details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">How Key State Affects Use of a Customer Master Key</a> in the <i>AWS Key Management Service Developer Guide</i>.</p> async fn re_encrypt( &self, input: ReEncryptRequest, ) -> Result<ReEncryptResponse, RusotoError<ReEncryptError>> { let mut request = self.new_signed_request("POST", "/"); request.add_header("x-amz-target", "TrentService.ReEncrypt"); let encoded = serde_json::to_string(&input).unwrap(); request.set_payload(Some(encoded)); let response = self .sign_and_dispatch(request, ReEncryptError::from_response) .await?; let mut response = response; let response = response.buffer().await.map_err(RusotoError::HttpDispatch)?; proto::json::ResponsePayload::new(&response).deserialize::<ReEncryptResponse, _>() } /// <p>Retires a grant. To clean up, you can retire a grant when you're done using it. You should revoke a grant when you intend to actively deny operations that depend on it. The following are permitted to call this API:</p> <ul> <li> <p>The AWS account (root user) under which the grant was created</p> </li> <li> <p>The <code>RetiringPrincipal</code>, if present in the grant</p> </li> <li> <p>The <code>GranteePrincipal</code>, if <code>RetireGrant</code> is an operation specified in the grant</p> </li> </ul> <p>You must identify the grant to retire by its grant token or by a combination of the grant ID and the Amazon Resource Name (ARN) of the customer master key (CMK). A grant token is a unique variable-length base64-encoded string. A grant ID is a 64 character unique identifier of a grant. The <a>CreateGrant</a> operation returns both.</p> async fn retire_grant( &self, input: RetireGrantRequest, ) -> Result<(), RusotoError<RetireGrantError>> { let mut request = self.new_signed_request("POST", "/"); request.add_header("x-amz-target", "TrentService.RetireGrant"); let encoded = serde_json::to_string(&input).unwrap(); request.set_payload(Some(encoded)); let response = self .sign_and_dispatch(request, RetireGrantError::from_response) .await?; std::mem::drop(response); Ok(()) } /// <p>Revokes the specified grant for the specified customer master key (CMK). You can revoke a grant to actively deny operations that depend on it.</p> <p>To perform this operation on a CMK in a different AWS account, specify the key ARN in the value of the <code>KeyId</code> parameter.</p> async fn revoke_grant( &self, input: RevokeGrantRequest, ) -> Result<(), RusotoError<RevokeGrantError>> { let mut request = self.new_signed_request("POST", "/"); request.add_header("x-amz-target", "TrentService.RevokeGrant"); let encoded = serde_json::to_string(&input).unwrap(); request.set_payload(Some(encoded)); let response = self .sign_and_dispatch(request, RevokeGrantError::from_response) .await?; std::mem::drop(response); Ok(()) } /// <p>Schedules the deletion of a customer master key (CMK). You may provide a waiting period, specified in days, before deletion occurs. If you do not provide a waiting period, the default period of 30 days is used. When this operation is successful, the key state of the CMK changes to <code>PendingDeletion</code>. Before the waiting period ends, you can use <a>CancelKeyDeletion</a> to cancel the deletion of the CMK. After the waiting period ends, AWS KMS deletes the CMK and all AWS KMS data associated with it, including all aliases that refer to it.</p> <important> <p>Deleting a CMK is a destructive and potentially dangerous operation. When a CMK is deleted, all data that was encrypted under the CMK is unrecoverable. To prevent the use of a CMK without deleting it, use <a>DisableKey</a>.</p> </important> <p>If you schedule deletion of a CMK from a <a href="https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html">custom key store</a>, when the waiting period expires, <code>ScheduleKeyDeletion</code> deletes the CMK from AWS KMS. Then AWS KMS makes a best effort to delete the key material from the associated AWS CloudHSM cluster. However, you might need to manually <a href="https://docs.aws.amazon.com/kms/latest/developerguide/fix-keystore.html#fix-keystore-orphaned-key">delete the orphaned key material</a> from the cluster and its backups.</p> <p>You cannot perform this operation on a CMK in a different AWS account.</p> <p>For more information about scheduling a CMK for deletion, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/deleting-keys.html">Deleting Customer Master Keys</a> in the <i>AWS Key Management Service Developer Guide</i>.</p> <p>The CMK that you use for this operation must be in a compatible key state. For details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">How Key State Affects Use of a Customer Master Key</a> in the <i>AWS Key Management Service Developer Guide</i>.</p> async fn schedule_key_deletion( &self, input: ScheduleKeyDeletionRequest, ) -> Result<ScheduleKeyDeletionResponse, RusotoError<ScheduleKeyDeletionError>> { let mut request = self.new_signed_request("POST", "/"); request.add_header("x-amz-target", "TrentService.ScheduleKeyDeletion"); let encoded = serde_json::to_string(&input).unwrap(); request.set_payload(Some(encoded)); let response = self .sign_and_dispatch(request, ScheduleKeyDeletionError::from_response) .await?; let mut response = response; let response = response.buffer().await.map_err(RusotoError::HttpDispatch)?; proto::json::ResponsePayload::new(&response).deserialize::<ScheduleKeyDeletionResponse, _>() } /// <p>Creates a <a href="https://en.wikipedia.org/wiki/Digital_signature">digital signature</a> for a message or message digest by using the private key in an asymmetric CMK. To verify the signature, use the <a>Verify</a> operation, or use the public key in the same asymmetric CMK outside of AWS KMS. For information about symmetric and asymmetric CMKs, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html">Using Symmetric and Asymmetric CMKs</a> in the <i>AWS Key Management Service Developer Guide</i>.</p> <p>Digital signatures are generated and verified by using asymmetric key pair, such as an RSA or ECC pair that is represented by an asymmetric customer master key (CMK). The key owner (or an authorized user) uses their private key to sign a message. Anyone with the public key can verify that the message was signed with that particular private key and that the message hasn't changed since it was signed. </p> <p>To use the <code>Sign</code> operation, provide the following information:</p> <ul> <li> <p>Use the <code>KeyId</code> parameter to identify an asymmetric CMK with a <code>KeyUsage</code> value of <code>SIGN_VERIFY</code>. To get the <code>KeyUsage</code> value of a CMK, use the <a>DescribeKey</a> operation. The caller must have <code>kms:Sign</code> permission on the CMK.</p> </li> <li> <p>Use the <code>Message</code> parameter to specify the message or message digest to sign. You can submit messages of up to 4096 bytes. To sign a larger message, generate a hash digest of the message, and then provide the hash digest in the <code>Message</code> parameter. To indicate whether the message is a full message or a digest, use the <code>MessageType</code> parameter.</p> </li> <li> <p>Choose a signing algorithm that is compatible with the CMK. </p> </li> </ul> <important> <p>When signing a message, be sure to record the CMK and the signing algorithm. This information is required to verify the signature.</p> </important> <p>To verify the signature that this operation generates, use the <a>Verify</a> operation. Or use the <a>GetPublicKey</a> operation to download the public key and then use the public key to verify the signature outside of AWS KMS. </p> <p>The CMK that you use for this operation must be in a compatible key state. For details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">How Key State Affects Use of a Customer Master Key</a> in the <i>AWS Key Management Service Developer Guide</i>.</p> async fn sign(&self, input: SignRequest) -> Result<SignResponse, RusotoError<SignError>> { let mut request = self.new_signed_request("POST", "/"); request.add_header("x-amz-target", "TrentService.Sign"); let encoded = serde_json::to_string(&input).unwrap(); request.set_payload(Some(encoded)); let response = self .sign_and_dispatch(request, SignError::from_response) .await?; let mut response = response; let response = response.buffer().await.map_err(RusotoError::HttpDispatch)?; proto::json::ResponsePayload::new(&response).deserialize::<SignResponse, _>() } /// <p>Adds or edits tags for a customer master key (CMK). You cannot perform this operation on a CMK in a different AWS account.</p> <p>Each tag consists of a tag key and a tag value. Tag keys and tag values are both required, but tag values can be empty (null) strings.</p> <p>You can only use a tag key once for each CMK. If you use the tag key again, AWS KMS replaces the current tag value with the specified value.</p> <p>For information about the rules that apply to tag keys and tag values, see <a href="https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/allocation-tag-restrictions.html">User-Defined Tag Restrictions</a> in the <i>AWS Billing and Cost Management User Guide</i>.</p> <p>The CMK that you use for this operation must be in a compatible key state. For details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">How Key State Affects Use of a Customer Master Key</a> in the <i>AWS Key Management Service Developer Guide</i>.</p> async fn tag_resource( &self, input: TagResourceRequest, ) -> Result<(), RusotoError<TagResourceError>> { let mut request = self.new_signed_request("POST", "/"); request.add_header("x-amz-target", "TrentService.TagResource"); let encoded = serde_json::to_string(&input).unwrap(); request.set_payload(Some(encoded)); let response = self .sign_and_dispatch(request, TagResourceError::from_response) .await?; std::mem::drop(response); Ok(()) } /// <p>Removes the specified tags from the specified customer master key (CMK). You cannot perform this operation on a CMK in a different AWS account.</p> <p>To remove a tag, specify the tag key. To change the tag value of an existing tag key, use <a>TagResource</a>.</p> <p>The CMK that you use for this operation must be in a compatible key state. For details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">How Key State Affects Use of a Customer Master Key</a> in the <i>AWS Key Management Service Developer Guide</i>.</p> async fn untag_resource( &self, input: UntagResourceRequest, ) -> Result<(), RusotoError<UntagResourceError>> { let mut request = self.new_signed_request("POST", "/"); request.add_header("x-amz-target", "TrentService.UntagResource"); let encoded = serde_json::to_string(&input).unwrap(); request.set_payload(Some(encoded)); let response = self .sign_and_dispatch(request, UntagResourceError::from_response) .await?; std::mem::drop(response); Ok(()) } /// <p>Associates an existing AWS KMS alias with a different customer master key (CMK). Each alias is associated with only one CMK at a time, although a CMK can have multiple aliases. The alias and the CMK must be in the same AWS account and region. You cannot perform this operation on an alias in a different AWS account. </p> <p>The current and new CMK must be the same type (both symmetric or both asymmetric), and they must have the same key usage (<code>ENCRYPT_DECRYPT</code> or <code>SIGN_VERIFY</code>). This restriction prevents errors in code that uses aliases. If you must assign an alias to a different type of CMK, use <a>DeleteAlias</a> to delete the old alias and <a>CreateAlias</a> to create a new alias.</p> <p>You cannot use <code>UpdateAlias</code> to change an alias name. To change an alias name, use <a>DeleteAlias</a> to delete the old alias and <a>CreateAlias</a> to create a new alias.</p> <p>Because an alias is not a property of a CMK, you can create, update, and delete the aliases of a CMK without affecting the CMK. Also, aliases do not appear in the response from the <a>DescribeKey</a> operation. To get the aliases of all CMKs in the account, use the <a>ListAliases</a> operation. </p> <p>The CMK that you use for this operation must be in a compatible key state. For details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">How Key State Affects Use of a Customer Master Key</a> in the <i>AWS Key Management Service Developer Guide</i>.</p> async fn update_alias( &self, input: UpdateAliasRequest, ) -> Result<(), RusotoError<UpdateAliasError>> { let mut request = self.new_signed_request("POST", "/"); request.add_header("x-amz-target", "TrentService.UpdateAlias"); let encoded = serde_json::to_string(&input).unwrap(); request.set_payload(Some(encoded)); let response = self .sign_and_dispatch(request, UpdateAliasError::from_response) .await?; std::mem::drop(response); Ok(()) } /// <p>Changes the properties of a custom key store. Use the <code>CustomKeyStoreId</code> parameter to identify the custom key store you want to edit. Use the remaining parameters to change the properties of the custom key store.</p> <p>You can only update a custom key store that is disconnected. To disconnect the custom key store, use <a>DisconnectCustomKeyStore</a>. To reconnect the custom key store after the update completes, use <a>ConnectCustomKeyStore</a>. To find the connection state of a custom key store, use the <a>DescribeCustomKeyStores</a> operation.</p> <p>Use the parameters of <code>UpdateCustomKeyStore</code> to edit your keystore settings.</p> <ul> <li> <p>Use the <b>NewCustomKeyStoreName</b> parameter to change the friendly name of the custom key store to the value that you specify.</p> <p> </p> </li> <li> <p>Use the <b>KeyStorePassword</b> parameter tell AWS KMS the current password of the <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-store-concepts.html#concept-kmsuser"> <code>kmsuser</code> crypto user (CU)</a> in the associated AWS CloudHSM cluster. You can use this parameter to <a href="https://docs.aws.amazon.com/kms/latest/developerguide/fix-keystore.html#fix-keystore-password">fix connection failures</a> that occur when AWS KMS cannot log into the associated cluster because the <code>kmsuser</code> password has changed. This value does not change the password in the AWS CloudHSM cluster.</p> <p> </p> </li> <li> <p>Use the <b>CloudHsmClusterId</b> parameter to associate the custom key store with a different, but related, AWS CloudHSM cluster. You can use this parameter to repair a custom key store if its AWS CloudHSM cluster becomes corrupted or is deleted, or when you need to create or restore a cluster from a backup. </p> </li> </ul> <p>If the operation succeeds, it returns a JSON object with no properties.</p> <p>This operation is part of the <a href="https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html">Custom Key Store feature</a> feature in AWS KMS, which combines the convenience and extensive integration of AWS KMS with the isolation and control of a single-tenant key store.</p> async fn update_custom_key_store( &self, input: UpdateCustomKeyStoreRequest, ) -> Result<UpdateCustomKeyStoreResponse, RusotoError<UpdateCustomKeyStoreError>> { let mut request = self.new_signed_request("POST", "/"); request.add_header("x-amz-target", "TrentService.UpdateCustomKeyStore"); let encoded = serde_json::to_string(&input).unwrap(); request.set_payload(Some(encoded)); let response = self .sign_and_dispatch(request, UpdateCustomKeyStoreError::from_response) .await?; let mut response = response; let response = response.buffer().await.map_err(RusotoError::HttpDispatch)?; proto::json::ResponsePayload::new(&response) .deserialize::<UpdateCustomKeyStoreResponse, _>() } /// <p>Updates the description of a customer master key (CMK). To see the description of a CMK, use <a>DescribeKey</a>. </p> <p>You cannot perform this operation on a CMK in a different AWS account.</p> <p>The CMK that you use for this operation must be in a compatible key state. For details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">How Key State Affects Use of a Customer Master Key</a> in the <i>AWS Key Management Service Developer Guide</i>.</p> async fn update_key_description( &self, input: UpdateKeyDescriptionRequest, ) -> Result<(), RusotoError<UpdateKeyDescriptionError>> { let mut request = self.new_signed_request("POST", "/"); request.add_header("x-amz-target", "TrentService.UpdateKeyDescription"); let encoded = serde_json::to_string(&input).unwrap(); request.set_payload(Some(encoded)); let response = self .sign_and_dispatch(request, UpdateKeyDescriptionError::from_response) .await?; std::mem::drop(response); Ok(()) } /// <p>Verifies a digital signature that was generated by the <a>Sign</a> operation. </p> <p/> <p>Verification confirms that an authorized user signed the message with the specified CMK and signing algorithm, and the message hasn't changed since it was signed. If the signature is verified, the value of the <code>SignatureValid</code> field in the response is <code>True</code>. If the signature verification fails, the <code>Verify</code> operation fails with an <code>KMSInvalidSignatureException</code> exception.</p> <p>A digital signature is generated by using the private key in an asymmetric CMK. The signature is verified by using the public key in the same asymmetric CMK. For information about symmetric and asymmetric CMKs, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html">Using Symmetric and Asymmetric CMKs</a> in the <i>AWS Key Management Service Developer Guide</i>.</p> <p>To verify a digital signature, you can use the <code>Verify</code> operation. Specify the same asymmetric CMK, message, and signing algorithm that were used to produce the signature.</p> <p>You can also verify the digital signature by using the public key of the CMK outside of AWS KMS. Use the <a>GetPublicKey</a> operation to download the public key in the asymmetric CMK and then use the public key to verify the signature outside of AWS KMS. The advantage of using the <code>Verify</code> operation is that it is performed within AWS KMS. As a result, it's easy to call, the operation is performed within the FIPS boundary, it is logged in AWS CloudTrail, and you can use key policy and IAM policy to determine who is authorized to use the CMK to verify signatures.</p> <p>The CMK that you use for this operation must be in a compatible key state. For details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">How Key State Affects Use of a Customer Master Key</a> in the <i>AWS Key Management Service Developer Guide</i>.</p> async fn verify( &self, input: VerifyRequest, ) -> Result<VerifyResponse, RusotoError<VerifyError>> { let mut request = self.new_signed_request("POST", "/"); request.add_header("x-amz-target", "TrentService.Verify"); let encoded = serde_json::to_string(&input).unwrap(); request.set_payload(Some(encoded)); let response = self .sign_and_dispatch(request, VerifyError::from_response) .await?; let mut response = response; let response = response.buffer().await.map_err(RusotoError::HttpDispatch)?; proto::json::ResponsePayload::new(&response).deserialize::<VerifyResponse, _>() } }