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
|
// Code generated by smithy-go-codegen DO NOT EDIT.
package types
import (
smithydocument "github.com/aws/smithy-go/document"
"time"
)
// Contains details of a table archival operation.
type ArchivalSummary struct {
// The Amazon Resource Name (ARN) of the backup the table was archived to, when
// applicable in the archival reason. If you wish to restore this backup to the
// same table name, you will need to delete the original table.
ArchivalBackupArn *string
// The date and time when table archival was initiated by DynamoDB, in UNIX epoch
// time format.
ArchivalDateTime *time.Time
// The reason DynamoDB archived the table. Currently, the only possible value is:
// - INACCESSIBLE_ENCRYPTION_CREDENTIALS - The table was archived due to the
// table's KMS key being inaccessible for more than seven days. An On-Demand backup
// was created at the archival time.
ArchivalReason *string
noSmithyDocumentSerde
}
// Represents an attribute for describing the key schema for the table and indexes.
type AttributeDefinition struct {
// A name for the attribute.
//
// This member is required.
AttributeName *string
// The data type for the attribute, where:
// - S - the attribute is of type String
// - N - the attribute is of type Number
// - B - the attribute is of type Binary
//
// This member is required.
AttributeType ScalarAttributeType
noSmithyDocumentSerde
}
// Represents the data for an attribute. Each attribute value is described as a
// name-value pair. The name is the data type, and the value is the data itself.
// For more information, see Data Types (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.NamingRulesDataTypes.html#HowItWorks.DataTypes)
// in the Amazon DynamoDB Developer Guide.
//
// The following types satisfy this interface:
//
// AttributeValueMemberB
// AttributeValueMemberBOOL
// AttributeValueMemberBS
// AttributeValueMemberL
// AttributeValueMemberM
// AttributeValueMemberN
// AttributeValueMemberNS
// AttributeValueMemberNULL
// AttributeValueMemberS
// AttributeValueMemberSS
type AttributeValue interface {
isAttributeValue()
}
// An attribute of type Binary. For example: "B":
// "dGhpcyB0ZXh0IGlzIGJhc2U2NC1lbmNvZGVk"
type AttributeValueMemberB struct {
Value []byte
noSmithyDocumentSerde
}
func (*AttributeValueMemberB) isAttributeValue() {}
// An attribute of type Boolean. For example: "BOOL": true
type AttributeValueMemberBOOL struct {
Value bool
noSmithyDocumentSerde
}
func (*AttributeValueMemberBOOL) isAttributeValue() {}
// An attribute of type Binary Set. For example: "BS": ["U3Vubnk=", "UmFpbnk=",
// "U25vd3k="]
type AttributeValueMemberBS struct {
Value [][]byte
noSmithyDocumentSerde
}
func (*AttributeValueMemberBS) isAttributeValue() {}
// An attribute of type List. For example: "L": [ {"S": "Cookies"} , {"S":
// "Coffee"}, {"N": "3.14159"}]
type AttributeValueMemberL struct {
Value []AttributeValue
noSmithyDocumentSerde
}
func (*AttributeValueMemberL) isAttributeValue() {}
// An attribute of type Map. For example: "M": {"Name": {"S": "Joe"}, "Age": {"N":
// "35"}}
type AttributeValueMemberM struct {
Value map[string]AttributeValue
noSmithyDocumentSerde
}
func (*AttributeValueMemberM) isAttributeValue() {}
// An attribute of type Number. For example: "N": "123.45" Numbers are sent across
// the network to DynamoDB as strings, to maximize compatibility across languages
// and libraries. However, DynamoDB treats them as number type attributes for
// mathematical operations.
type AttributeValueMemberN struct {
Value string
noSmithyDocumentSerde
}
func (*AttributeValueMemberN) isAttributeValue() {}
// An attribute of type Number Set. For example: "NS": ["42.2", "-19", "7.5",
// "3.14"] Numbers are sent across the network to DynamoDB as strings, to maximize
// compatibility across languages and libraries. However, DynamoDB treats them as
// number type attributes for mathematical operations.
type AttributeValueMemberNS struct {
Value []string
noSmithyDocumentSerde
}
func (*AttributeValueMemberNS) isAttributeValue() {}
// An attribute of type Null. For example: "NULL": true
type AttributeValueMemberNULL struct {
Value bool
noSmithyDocumentSerde
}
func (*AttributeValueMemberNULL) isAttributeValue() {}
// An attribute of type String. For example: "S": "Hello"
type AttributeValueMemberS struct {
Value string
noSmithyDocumentSerde
}
func (*AttributeValueMemberS) isAttributeValue() {}
// An attribute of type String Set. For example: "SS": ["Giraffe", "Hippo"
// ,"Zebra"]
type AttributeValueMemberSS struct {
Value []string
noSmithyDocumentSerde
}
func (*AttributeValueMemberSS) isAttributeValue() {}
// For the UpdateItem operation, represents the attributes to be modified, the
// action to perform on each, and the new value for each. You cannot use UpdateItem
// to update any primary key attributes. Instead, you will need to delete the item,
// and then use PutItem to create a new item with new attributes. Attribute values
// cannot be null; string and binary type attributes must have lengths greater than
// zero; and set type attributes must not be empty. Requests with empty values will
// be rejected with a ValidationException exception.
type AttributeValueUpdate struct {
// Specifies how to perform the update. Valid values are PUT (default), DELETE ,
// and ADD . The behavior depends on whether the specified primary key already
// exists in the table. If an item with the specified Key is found in the table:
// - PUT - Adds the specified attribute to the item. If the attribute already
// exists, it is replaced by the new value.
// - DELETE - If no value is specified, the attribute and its value are removed
// from the item. The data type of the specified value must match the existing
// value's data type. If a set of values is specified, then those values are
// subtracted from the old set. For example, if the attribute value was the set
// [a,b,c] and the DELETE action specified [a,c] , then the final attribute value
// would be [b] . Specifying an empty set is an error.
// - ADD - If the attribute does not already exist, then the attribute and its
// values are added to the item. If the attribute does exist, then the behavior of
// ADD depends on the data type of the attribute:
// - If the existing attribute is a number, and if Value is also a number, then
// the Value is mathematically added to the existing attribute. If Value is a
// negative number, then it is subtracted from the existing attribute. If you use
// ADD to increment or decrement a number value for an item that doesn't exist
// before the update, DynamoDB uses 0 as the initial value. In addition, if you use
// ADD to update an existing item, and intend to increment or decrement an
// attribute value which does not yet exist, DynamoDB uses 0 as the initial
// value. For example, suppose that the item you want to update does not yet have
// an attribute named itemcount, but you decide to ADD the number 3 to this
// attribute anyway, even though it currently does not exist. DynamoDB will create
// the itemcount attribute, set its initial value to 0 , and finally add 3 to it.
// The result will be a new itemcount attribute in the item, with a value of 3 .
// - If the existing data type is a set, and if the Value is also a set, then the
// Value is added to the existing set. (This is a set operation, not mathematical
// addition.) For example, if the attribute value was the set [1,2] , and the ADD
// action specified [3] , then the final attribute value would be [1,2,3] . An
// error occurs if an Add action is specified for a set attribute and the attribute
// type specified does not match the existing set type. Both sets must have the
// same primitive data type. For example, if the existing data type is a set of
// strings, the Value must also be a set of strings. The same holds true for
// number sets and binary sets. This action is only valid for an existing
// attribute whose data type is number or is a set. Do not use ADD for any other
// data types.
// If no item with the specified Key is found:
// - PUT - DynamoDB creates a new item with the specified primary key, and then
// adds the attribute.
// - DELETE - Nothing happens; there is no attribute to delete.
// - ADD - DynamoDB creates a new item with the supplied primary key and number
// (or set) for the attribute value. The only data types allowed are number, number
// set, string set or binary set.
Action AttributeAction
// Represents the data for an attribute. Each attribute value is described as a
// name-value pair. The name is the data type, and the value is the data itself.
// For more information, see Data Types (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.NamingRulesDataTypes.html#HowItWorks.DataTypes)
// in the Amazon DynamoDB Developer Guide.
Value AttributeValue
noSmithyDocumentSerde
}
// Represents the properties of the scaling policy.
type AutoScalingPolicyDescription struct {
// The name of the scaling policy.
PolicyName *string
// Represents a target tracking scaling policy configuration.
TargetTrackingScalingPolicyConfiguration *AutoScalingTargetTrackingScalingPolicyConfigurationDescription
noSmithyDocumentSerde
}
// Represents the auto scaling policy to be modified.
type AutoScalingPolicyUpdate struct {
// Represents a target tracking scaling policy configuration.
//
// This member is required.
TargetTrackingScalingPolicyConfiguration *AutoScalingTargetTrackingScalingPolicyConfigurationUpdate
// The name of the scaling policy.
PolicyName *string
noSmithyDocumentSerde
}
// Represents the auto scaling settings for a global table or global secondary
// index.
type AutoScalingSettingsDescription struct {
// Disabled auto scaling for this global table or global secondary index.
AutoScalingDisabled *bool
// Role ARN used for configuring the auto scaling policy.
AutoScalingRoleArn *string
// The maximum capacity units that a global table or global secondary index should
// be scaled up to.
MaximumUnits *int64
// The minimum capacity units that a global table or global secondary index should
// be scaled down to.
MinimumUnits *int64
// Information about the scaling policies.
ScalingPolicies []AutoScalingPolicyDescription
noSmithyDocumentSerde
}
// Represents the auto scaling settings to be modified for a global table or
// global secondary index.
type AutoScalingSettingsUpdate struct {
// Disabled auto scaling for this global table or global secondary index.
AutoScalingDisabled *bool
// Role ARN used for configuring auto scaling policy.
AutoScalingRoleArn *string
// The maximum capacity units that a global table or global secondary index should
// be scaled up to.
MaximumUnits *int64
// The minimum capacity units that a global table or global secondary index should
// be scaled down to.
MinimumUnits *int64
// The scaling policy to apply for scaling target global table or global secondary
// index capacity units.
ScalingPolicyUpdate *AutoScalingPolicyUpdate
noSmithyDocumentSerde
}
// Represents the properties of a target tracking scaling policy.
type AutoScalingTargetTrackingScalingPolicyConfigurationDescription struct {
// The target value for the metric. The range is 8.515920e-109 to 1.174271e+108
// (Base 10) or 2e-360 to 2e360 (Base 2).
//
// This member is required.
TargetValue *float64
// Indicates whether scale in by the target tracking policy is disabled. If the
// value is true, scale in is disabled and the target tracking policy won't remove
// capacity from the scalable resource. Otherwise, scale in is enabled and the
// target tracking policy can remove capacity from the scalable resource. The
// default value is false.
DisableScaleIn *bool
// The amount of time, in seconds, after a scale in activity completes before
// another scale in activity can start. The cooldown period is used to block
// subsequent scale in requests until it has expired. You should scale in
// conservatively to protect your application's availability. However, if another
// alarm triggers a scale out policy during the cooldown period after a scale-in,
// application auto scaling scales out your scalable target immediately.
ScaleInCooldown *int32
// The amount of time, in seconds, after a scale out activity completes before
// another scale out activity can start. While the cooldown period is in effect,
// the capacity that has been added by the previous scale out event that initiated
// the cooldown is calculated as part of the desired capacity for the next scale
// out. You should continuously (but not excessively) scale out.
ScaleOutCooldown *int32
noSmithyDocumentSerde
}
// Represents the settings of a target tracking scaling policy that will be
// modified.
type AutoScalingTargetTrackingScalingPolicyConfigurationUpdate struct {
// The target value for the metric. The range is 8.515920e-109 to 1.174271e+108
// (Base 10) or 2e-360 to 2e360 (Base 2).
//
// This member is required.
TargetValue *float64
// Indicates whether scale in by the target tracking policy is disabled. If the
// value is true, scale in is disabled and the target tracking policy won't remove
// capacity from the scalable resource. Otherwise, scale in is enabled and the
// target tracking policy can remove capacity from the scalable resource. The
// default value is false.
DisableScaleIn *bool
// The amount of time, in seconds, after a scale in activity completes before
// another scale in activity can start. The cooldown period is used to block
// subsequent scale in requests until it has expired. You should scale in
// conservatively to protect your application's availability. However, if another
// alarm triggers a scale out policy during the cooldown period after a scale-in,
// application auto scaling scales out your scalable target immediately.
ScaleInCooldown *int32
// The amount of time, in seconds, after a scale out activity completes before
// another scale out activity can start. While the cooldown period is in effect,
// the capacity that has been added by the previous scale out event that initiated
// the cooldown is calculated as part of the desired capacity for the next scale
// out. You should continuously (but not excessively) scale out.
ScaleOutCooldown *int32
noSmithyDocumentSerde
}
// Contains the description of the backup created for the table.
type BackupDescription struct {
// Contains the details of the backup created for the table.
BackupDetails *BackupDetails
// Contains the details of the table when the backup was created.
SourceTableDetails *SourceTableDetails
// Contains the details of the features enabled on the table when the backup was
// created. For example, LSIs, GSIs, streams, TTL.
SourceTableFeatureDetails *SourceTableFeatureDetails
noSmithyDocumentSerde
}
// Contains the details of the backup created for the table.
type BackupDetails struct {
// ARN associated with the backup.
//
// This member is required.
BackupArn *string
// Time at which the backup was created. This is the request time of the backup.
//
// This member is required.
BackupCreationDateTime *time.Time
// Name of the requested backup.
//
// This member is required.
BackupName *string
// Backup can be in one of the following states: CREATING, ACTIVE, DELETED.
//
// This member is required.
BackupStatus BackupStatus
// BackupType:
// - USER - You create and manage these using the on-demand backup feature.
// - SYSTEM - If you delete a table with point-in-time recovery enabled, a SYSTEM
// backup is automatically created and is retained for 35 days (at no additional
// cost). System backups allow you to restore the deleted table to the state it was
// in just before the point of deletion.
// - AWS_BACKUP - On-demand backup created by you from Backup service.
//
// This member is required.
BackupType BackupType
// Time at which the automatic on-demand backup created by DynamoDB will expire.
// This SYSTEM on-demand backup expires automatically 35 days after its creation.
BackupExpiryDateTime *time.Time
// Size of the backup in bytes. DynamoDB updates this value approximately every
// six hours. Recent changes might not be reflected in this value.
BackupSizeBytes *int64
noSmithyDocumentSerde
}
// Contains details for the backup.
type BackupSummary struct {
// ARN associated with the backup.
BackupArn *string
// Time at which the backup was created.
BackupCreationDateTime *time.Time
// Time at which the automatic on-demand backup created by DynamoDB will expire.
// This SYSTEM on-demand backup expires automatically 35 days after its creation.
BackupExpiryDateTime *time.Time
// Name of the specified backup.
BackupName *string
// Size of the backup in bytes.
BackupSizeBytes *int64
// Backup can be in one of the following states: CREATING, ACTIVE, DELETED.
BackupStatus BackupStatus
// BackupType:
// - USER - You create and manage these using the on-demand backup feature.
// - SYSTEM - If you delete a table with point-in-time recovery enabled, a SYSTEM
// backup is automatically created and is retained for 35 days (at no additional
// cost). System backups allow you to restore the deleted table to the state it was
// in just before the point of deletion.
// - AWS_BACKUP - On-demand backup created by you from Backup service.
BackupType BackupType
// ARN associated with the table.
TableArn *string
// Unique identifier for the table.
TableId *string
// Name of the table.
TableName *string
noSmithyDocumentSerde
}
// An error associated with a statement in a PartiQL batch that was run.
type BatchStatementError struct {
// The error code associated with the failed PartiQL batch statement.
Code BatchStatementErrorCodeEnum
// The item which caused the condition check to fail. This will be set if
// ReturnValuesOnConditionCheckFailure is specified as ALL_OLD .
Item map[string]AttributeValue
// The error message associated with the PartiQL batch response.
Message *string
noSmithyDocumentSerde
}
// A PartiQL batch statement request.
type BatchStatementRequest struct {
// A valid PartiQL statement.
//
// This member is required.
Statement *string
// The read consistency of the PartiQL batch request.
ConsistentRead *bool
// The parameters associated with a PartiQL statement in the batch request.
Parameters []AttributeValue
// An optional parameter that returns the item attributes for a PartiQL batch
// request operation that failed a condition check. There is no additional cost
// associated with requesting a return value aside from the small network and
// processing overhead of receiving a larger response. No read capacity units are
// consumed.
ReturnValuesOnConditionCheckFailure ReturnValuesOnConditionCheckFailure
noSmithyDocumentSerde
}
// A PartiQL batch statement response..
type BatchStatementResponse struct {
// The error associated with a failed PartiQL batch statement.
Error *BatchStatementError
// A DynamoDB item associated with a BatchStatementResponse
Item map[string]AttributeValue
// The table name associated with a failed PartiQL batch statement.
TableName *string
noSmithyDocumentSerde
}
// Contains the details for the read/write capacity mode. This page talks about
// PROVISIONED and PAY_PER_REQUEST billing modes. For more information about these
// modes, see Read/write capacity mode (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.ReadWriteCapacityMode.html)
// . You may need to switch to on-demand mode at least once in order to return a
// BillingModeSummary response.
type BillingModeSummary struct {
// Controls how you are charged for read and write throughput and how you manage
// capacity. This setting can be changed later.
// - PROVISIONED - Sets the read/write capacity mode to PROVISIONED . We
// recommend using PROVISIONED for predictable workloads.
// - PAY_PER_REQUEST - Sets the read/write capacity mode to PAY_PER_REQUEST . We
// recommend using PAY_PER_REQUEST for unpredictable workloads.
BillingMode BillingMode
// Represents the time when PAY_PER_REQUEST was last set as the read/write
// capacity mode.
LastUpdateToPayPerRequestDateTime *time.Time
noSmithyDocumentSerde
}
// An ordered list of errors for each item in the request which caused the
// transaction to get cancelled. The values of the list are ordered according to
// the ordering of the TransactWriteItems request parameter. If no error occurred
// for the associated item an error with a Null code and Null message will be
// present.
type CancellationReason struct {
// Status code for the result of the cancelled transaction.
Code *string
// Item in the request which caused the transaction to get cancelled.
Item map[string]AttributeValue
// Cancellation reason message description.
Message *string
noSmithyDocumentSerde
}
// Represents the amount of provisioned throughput capacity consumed on a table or
// an index.
type Capacity struct {
// The total number of capacity units consumed on a table or an index.
CapacityUnits *float64
// The total number of read capacity units consumed on a table or an index.
ReadCapacityUnits *float64
// The total number of write capacity units consumed on a table or an index.
WriteCapacityUnits *float64
noSmithyDocumentSerde
}
// Represents the selection criteria for a Query or Scan operation:
// - For a Query operation, Condition is used for specifying the KeyConditions to
// use when querying a table or an index. For KeyConditions , only the following
// comparison operators are supported: EQ | LE | LT | GE | GT | BEGINS_WITH |
// BETWEEN Condition is also used in a QueryFilter , which evaluates the query
// results and returns only the desired values.
// - For a Scan operation, Condition is used in a ScanFilter , which evaluates
// the scan results and returns only the desired values.
type Condition struct {
// A comparator for evaluating attributes. For example, equals, greater than, less
// than, etc. The following comparison operators are available: EQ | NE | LE | LT
// | GE | GT | NOT_NULL | NULL | CONTAINS | NOT_CONTAINS | BEGINS_WITH | IN |
// BETWEEN The following are descriptions of each comparison operator.
// - EQ : Equal. EQ is supported for all data types, including lists and maps.
// AttributeValueList can contain only one AttributeValue element of type String,
// Number, Binary, String Set, Number Set, or Binary Set. If an item contains an
// AttributeValue element of a different type than the one provided in the
// request, the value does not match. For example, {"S":"6"} does not equal
// {"N":"6"} . Also, {"N":"6"} does not equal {"NS":["6", "2", "1"]} .
// - NE : Not equal. NE is supported for all data types, including lists and
// maps. AttributeValueList can contain only one AttributeValue of type String,
// Number, Binary, String Set, Number Set, or Binary Set. If an item contains an
// AttributeValue of a different type than the one provided in the request, the
// value does not match. For example, {"S":"6"} does not equal {"N":"6"} . Also,
// {"N":"6"} does not equal {"NS":["6", "2", "1"]} .
// - LE : Less than or equal. AttributeValueList can contain only one
// AttributeValue element of type String, Number, or Binary (not a set type). If
// an item contains an AttributeValue element of a different type than the one
// provided in the request, the value does not match. For example, {"S":"6"} does
// not equal {"N":"6"} . Also, {"N":"6"} does not compare to {"NS":["6", "2",
// "1"]} .
// - LT : Less than. AttributeValueList can contain only one AttributeValue of
// type String, Number, or Binary (not a set type). If an item contains an
// AttributeValue element of a different type than the one provided in the
// request, the value does not match. For example, {"S":"6"} does not equal
// {"N":"6"} . Also, {"N":"6"} does not compare to {"NS":["6", "2", "1"]} .
// - GE : Greater than or equal. AttributeValueList can contain only one
// AttributeValue element of type String, Number, or Binary (not a set type). If
// an item contains an AttributeValue element of a different type than the one
// provided in the request, the value does not match. For example, {"S":"6"} does
// not equal {"N":"6"} . Also, {"N":"6"} does not compare to {"NS":["6", "2",
// "1"]} .
// - GT : Greater than. AttributeValueList can contain only one AttributeValue
// element of type String, Number, or Binary (not a set type). If an item contains
// an AttributeValue element of a different type than the one provided in the
// request, the value does not match. For example, {"S":"6"} does not equal
// {"N":"6"} . Also, {"N":"6"} does not compare to {"NS":["6", "2", "1"]} .
// - NOT_NULL : The attribute exists. NOT_NULL is supported for all data types,
// including lists and maps. This operator tests for the existence of an attribute,
// not its data type. If the data type of attribute " a " is null, and you
// evaluate it using NOT_NULL , the result is a Boolean true . This result is
// because the attribute " a " exists; its data type is not relevant to the
// NOT_NULL comparison operator.
// - NULL : The attribute does not exist. NULL is supported for all data types,
// including lists and maps. This operator tests for the nonexistence of an
// attribute, not its data type. If the data type of attribute " a " is null, and
// you evaluate it using NULL , the result is a Boolean false . This is because
// the attribute " a " exists; its data type is not relevant to the NULL
// comparison operator.
// - CONTAINS : Checks for a subsequence, or value in a set. AttributeValueList
// can contain only one AttributeValue element of type String, Number, or Binary
// (not a set type). If the target attribute of the comparison is of type String,
// then the operator checks for a substring match. If the target attribute of the
// comparison is of type Binary, then the operator looks for a subsequence of the
// target that matches the input. If the target attribute of the comparison is a
// set (" SS ", " NS ", or " BS "), then the operator evaluates to true if it
// finds an exact match with any member of the set. CONTAINS is supported for
// lists: When evaluating " a CONTAINS b ", " a " can be a list; however, " b "
// cannot be a set, a map, or a list.
// - NOT_CONTAINS : Checks for absence of a subsequence, or absence of a value in
// a set. AttributeValueList can contain only one AttributeValue element of type
// String, Number, or Binary (not a set type). If the target attribute of the
// comparison is a String, then the operator checks for the absence of a substring
// match. If the target attribute of the comparison is Binary, then the operator
// checks for the absence of a subsequence of the target that matches the input. If
// the target attribute of the comparison is a set (" SS ", " NS ", or " BS "),
// then the operator evaluates to true if it does not find an exact match with any
// member of the set. NOT_CONTAINS is supported for lists: When evaluating " a
// NOT CONTAINS b ", " a " can be a list; however, " b " cannot be a set, a map,
// or a list.
// - BEGINS_WITH : Checks for a prefix. AttributeValueList can contain only one
// AttributeValue of type String or Binary (not a Number or a set type). The
// target attribute of the comparison must be of type String or Binary (not a
// Number or a set type).
// - IN : Checks for matching elements in a list. AttributeValueList can contain
// one or more AttributeValue elements of type String, Number, or Binary. These
// attributes are compared against an existing attribute of an item. If any
// elements of the input are equal to the item attribute, the expression evaluates
// to true.
// - BETWEEN : Greater than or equal to the first value, and less than or equal
// to the second value. AttributeValueList must contain two AttributeValue
// elements of the same type, either String, Number, or Binary (not a set type). A
// target attribute matches if the target value is greater than, or equal to, the
// first element and less than, or equal to, the second element. If an item
// contains an AttributeValue element of a different type than the one provided
// in the request, the value does not match. For example, {"S":"6"} does not
// compare to {"N":"6"} . Also, {"N":"6"} does not compare to {"NS":["6", "2",
// "1"]}
// For usage examples of AttributeValueList and ComparisonOperator , see Legacy
// Conditional Parameters (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.html)
// in the Amazon DynamoDB Developer Guide.
//
// This member is required.
ComparisonOperator ComparisonOperator
// One or more values to evaluate against the supplied attribute. The number of
// values in the list depends on the ComparisonOperator being used. For type
// Number, value comparisons are numeric. String value comparisons for greater
// than, equals, or less than are based on ASCII character code values. For
// example, a is greater than A , and a is greater than B . For a list of code
// values, see http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters (http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters)
// . For Binary, DynamoDB treats each byte of the binary data as unsigned when it
// compares binary values.
AttributeValueList []AttributeValue
noSmithyDocumentSerde
}
// Represents a request to perform a check that an item exists or to check the
// condition of specific attributes of the item.
type ConditionCheck struct {
// A condition that must be satisfied in order for a conditional update to
// succeed. For more information, see Condition expressions (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.ConditionExpressions.html)
// in the Amazon DynamoDB Developer Guide.
//
// This member is required.
ConditionExpression *string
// The primary key of the item to be checked. Each element consists of an
// attribute name and a value for that attribute.
//
// This member is required.
Key map[string]AttributeValue
// Name of the table for the check item request.
//
// This member is required.
TableName *string
// One or more substitution tokens for attribute names in an expression. For more
// information, see Expression attribute names (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.ExpressionAttributeNames.html)
// in the Amazon DynamoDB Developer Guide.
ExpressionAttributeNames map[string]string
// One or more values that can be substituted in an expression. For more
// information, see Condition expressions (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.ConditionExpressions.html)
// in the Amazon DynamoDB Developer Guide.
ExpressionAttributeValues map[string]AttributeValue
// Use ReturnValuesOnConditionCheckFailure to get the item attributes if the
// ConditionCheck condition fails. For ReturnValuesOnConditionCheckFailure , the
// valid values are: NONE and ALL_OLD.
ReturnValuesOnConditionCheckFailure ReturnValuesOnConditionCheckFailure
noSmithyDocumentSerde
}
// The capacity units consumed by an operation. The data returned includes the
// total provisioned throughput consumed, along with statistics for the table and
// any indexes involved in the operation. ConsumedCapacity is only returned if the
// request asked for it. For more information, see Provisioned Throughput (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ProvisionedThroughputIntro.html)
// in the Amazon DynamoDB Developer Guide.
type ConsumedCapacity struct {
// The total number of capacity units consumed by the operation.
CapacityUnits *float64
// The amount of throughput consumed on each global index affected by the
// operation.
GlobalSecondaryIndexes map[string]Capacity
// The amount of throughput consumed on each local index affected by the operation.
LocalSecondaryIndexes map[string]Capacity
// The total number of read capacity units consumed by the operation.
ReadCapacityUnits *float64
// The amount of throughput consumed on the table affected by the operation.
Table *Capacity
// The name of the table that was affected by the operation.
TableName *string
// The total number of write capacity units consumed by the operation.
WriteCapacityUnits *float64
noSmithyDocumentSerde
}
// Represents the continuous backups and point in time recovery settings on the
// table.
type ContinuousBackupsDescription struct {
// ContinuousBackupsStatus can be one of the following states: ENABLED, DISABLED
//
// This member is required.
ContinuousBackupsStatus ContinuousBackupsStatus
// The description of the point in time recovery settings applied to the table.
PointInTimeRecoveryDescription *PointInTimeRecoveryDescription
noSmithyDocumentSerde
}
// Represents a Contributor Insights summary entry.
type ContributorInsightsSummary struct {
// Describes the current status for contributor insights for the given table and
// index, if applicable.
ContributorInsightsStatus ContributorInsightsStatus
// Name of the index associated with the summary, if any.
IndexName *string
// Name of the table associated with the summary.
TableName *string
noSmithyDocumentSerde
}
// Represents a new global secondary index to be added to an existing table.
type CreateGlobalSecondaryIndexAction struct {
// The name of the global secondary index to be created.
//
// This member is required.
IndexName *string
// The key schema for the global secondary index.
//
// This member is required.
KeySchema []KeySchemaElement
// Represents attributes that are copied (projected) from the table into an index.
// These are in addition to the primary key attributes and index key attributes,
// which are automatically projected.
//
// This member is required.
Projection *Projection
// Represents the provisioned throughput settings for the specified global
// secondary index. For current minimum and maximum provisioned throughput values,
// see Service, Account, and Table Quotas (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Limits.html)
// in the Amazon DynamoDB Developer Guide.
ProvisionedThroughput *ProvisionedThroughput
noSmithyDocumentSerde
}
// Represents a replica to be added.
type CreateReplicaAction struct {
// The Region of the replica to be added.
//
// This member is required.
RegionName *string
noSmithyDocumentSerde
}
// Represents a replica to be created.
type CreateReplicationGroupMemberAction struct {
// The Region where the new replica will be created.
//
// This member is required.
RegionName *string
// Replica-specific global secondary index settings.
GlobalSecondaryIndexes []ReplicaGlobalSecondaryIndex
// The KMS key that should be used for KMS encryption in the new replica. To
// specify a key, use its key ID, Amazon Resource Name (ARN), alias name, or alias
// ARN. Note that you should only provide this parameter if the key is different
// from the default DynamoDB KMS key alias/aws/dynamodb .
KMSMasterKeyId *string
// Replica-specific provisioned throughput. If not specified, uses the source
// table's provisioned throughput settings.
ProvisionedThroughputOverride *ProvisionedThroughputOverride
// Replica-specific table class. If not specified, uses the source table's table
// class.
TableClassOverride TableClass
noSmithyDocumentSerde
}
// Processing options for the CSV file being imported.
type CsvOptions struct {
// The delimiter used for separating items in the CSV file being imported.
Delimiter *string
// List of the headers used to specify a common header for all source CSV files
// being imported. If this field is specified then the first line of each CSV file
// is treated as data instead of the header. If this field is not specified the the
// first line of each CSV file is treated as the header.
HeaderList []string
noSmithyDocumentSerde
}
// Represents a request to perform a DeleteItem operation.
type Delete struct {
// The primary key of the item to be deleted. Each element consists of an
// attribute name and a value for that attribute.
//
// This member is required.
Key map[string]AttributeValue
// Name of the table in which the item to be deleted resides.
//
// This member is required.
TableName *string
// A condition that must be satisfied in order for a conditional delete to succeed.
ConditionExpression *string
// One or more substitution tokens for attribute names in an expression.
ExpressionAttributeNames map[string]string
// One or more values that can be substituted in an expression.
ExpressionAttributeValues map[string]AttributeValue
// Use ReturnValuesOnConditionCheckFailure to get the item attributes if the Delete
// condition fails. For ReturnValuesOnConditionCheckFailure , the valid values are:
// NONE and ALL_OLD.
ReturnValuesOnConditionCheckFailure ReturnValuesOnConditionCheckFailure
noSmithyDocumentSerde
}
// Represents a global secondary index to be deleted from an existing table.
type DeleteGlobalSecondaryIndexAction struct {
// The name of the global secondary index to be deleted.
//
// This member is required.
IndexName *string
noSmithyDocumentSerde
}
// Represents a replica to be removed.
type DeleteReplicaAction struct {
// The Region of the replica to be removed.
//
// This member is required.
RegionName *string
noSmithyDocumentSerde
}
// Represents a replica to be deleted.
type DeleteReplicationGroupMemberAction struct {
// The Region where the replica exists.
//
// This member is required.
RegionName *string
noSmithyDocumentSerde
}
// Represents a request to perform a DeleteItem operation on an item.
type DeleteRequest struct {
// A map of attribute name to attribute values, representing the primary key of
// the item to delete. All of the table's primary key attributes must be specified,
// and their data types must match those of the table's key schema.
//
// This member is required.
Key map[string]AttributeValue
noSmithyDocumentSerde
}
// An endpoint information details.
type Endpoint struct {
// IP address of the endpoint.
//
// This member is required.
Address *string
// Endpoint cache time to live (TTL) value.
//
// This member is required.
CachePeriodInMinutes int64
noSmithyDocumentSerde
}
// Represents a condition to be compared with an attribute value. This condition
// can be used with DeleteItem , PutItem , or UpdateItem operations; if the
// comparison evaluates to true, the operation succeeds; if not, the operation
// fails. You can use ExpectedAttributeValue in one of two different ways:
// - Use AttributeValueList to specify one or more values to compare against an
// attribute. Use ComparisonOperator to specify how you want to perform the
// comparison. If the comparison evaluates to true, then the conditional operation
// succeeds.
// - Use Value to specify a value that DynamoDB will compare against an
// attribute. If the values match, then ExpectedAttributeValue evaluates to true
// and the conditional operation succeeds. Optionally, you can also set Exists to
// false, indicating that you do not expect to find the attribute value in the
// table. In this case, the conditional operation succeeds only if the comparison
// evaluates to false.
//
// Value and Exists are incompatible with AttributeValueList and ComparisonOperator
// . Note that if you use both sets of parameters at once, DynamoDB will return a
// ValidationException exception.
type ExpectedAttributeValue struct {
// One or more values to evaluate against the supplied attribute. The number of
// values in the list depends on the ComparisonOperator being used. For type
// Number, value comparisons are numeric. String value comparisons for greater
// than, equals, or less than are based on ASCII character code values. For
// example, a is greater than A , and a is greater than B . For a list of code
// values, see http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters (http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters)
// . For Binary, DynamoDB treats each byte of the binary data as unsigned when it
// compares binary values. For information on specifying data types in JSON, see
// JSON Data Format (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/DataFormat.html)
// in the Amazon DynamoDB Developer Guide.
AttributeValueList []AttributeValue
// A comparator for evaluating attributes in the AttributeValueList . For example,
// equals, greater than, less than, etc. The following comparison operators are
// available: EQ | NE | LE | LT | GE | GT | NOT_NULL | NULL | CONTAINS |
// NOT_CONTAINS | BEGINS_WITH | IN | BETWEEN The following are descriptions of each
// comparison operator.
// - EQ : Equal. EQ is supported for all data types, including lists and maps.
// AttributeValueList can contain only one AttributeValue element of type String,
// Number, Binary, String Set, Number Set, or Binary Set. If an item contains an
// AttributeValue element of a different type than the one provided in the
// request, the value does not match. For example, {"S":"6"} does not equal
// {"N":"6"} . Also, {"N":"6"} does not equal {"NS":["6", "2", "1"]} .
// - NE : Not equal. NE is supported for all data types, including lists and
// maps. AttributeValueList can contain only one AttributeValue of type String,
// Number, Binary, String Set, Number Set, or Binary Set. If an item contains an
// AttributeValue of a different type than the one provided in the request, the
// value does not match. For example, {"S":"6"} does not equal {"N":"6"} . Also,
// {"N":"6"} does not equal {"NS":["6", "2", "1"]} .
// - LE : Less than or equal. AttributeValueList can contain only one
// AttributeValue element of type String, Number, or Binary (not a set type). If
// an item contains an AttributeValue element of a different type than the one
// provided in the request, the value does not match. For example, {"S":"6"} does
// not equal {"N":"6"} . Also, {"N":"6"} does not compare to {"NS":["6", "2",
// "1"]} .
// - LT : Less than. AttributeValueList can contain only one AttributeValue of
// type String, Number, or Binary (not a set type). If an item contains an
// AttributeValue element of a different type than the one provided in the
// request, the value does not match. For example, {"S":"6"} does not equal
// {"N":"6"} . Also, {"N":"6"} does not compare to {"NS":["6", "2", "1"]} .
// - GE : Greater than or equal. AttributeValueList can contain only one
// AttributeValue element of type String, Number, or Binary (not a set type). If
// an item contains an AttributeValue element of a different type than the one
// provided in the request, the value does not match. For example, {"S":"6"} does
// not equal {"N":"6"} . Also, {"N":"6"} does not compare to {"NS":["6", "2",
// "1"]} .
// - GT : Greater than. AttributeValueList can contain only one AttributeValue
// element of type String, Number, or Binary (not a set type). If an item contains
// an AttributeValue element of a different type than the one provided in the
// request, the value does not match. For example, {"S":"6"} does not equal
// {"N":"6"} . Also, {"N":"6"} does not compare to {"NS":["6", "2", "1"]} .
// - NOT_NULL : The attribute exists. NOT_NULL is supported for all data types,
// including lists and maps. This operator tests for the existence of an attribute,
// not its data type. If the data type of attribute " a " is null, and you
// evaluate it using NOT_NULL , the result is a Boolean true . This result is
// because the attribute " a " exists; its data type is not relevant to the
// NOT_NULL comparison operator.
// - NULL : The attribute does not exist. NULL is supported for all data types,
// including lists and maps. This operator tests for the nonexistence of an
// attribute, not its data type. If the data type of attribute " a " is null, and
// you evaluate it using NULL , the result is a Boolean false . This is because
// the attribute " a " exists; its data type is not relevant to the NULL
// comparison operator.
// - CONTAINS : Checks for a subsequence, or value in a set. AttributeValueList
// can contain only one AttributeValue element of type String, Number, or Binary
// (not a set type). If the target attribute of the comparison is of type String,
// then the operator checks for a substring match. If the target attribute of the
// comparison is of type Binary, then the operator looks for a subsequence of the
// target that matches the input. If the target attribute of the comparison is a
// set (" SS ", " NS ", or " BS "), then the operator evaluates to true if it
// finds an exact match with any member of the set. CONTAINS is supported for
// lists: When evaluating " a CONTAINS b ", " a " can be a list; however, " b "
// cannot be a set, a map, or a list.
// - NOT_CONTAINS : Checks for absence of a subsequence, or absence of a value in
// a set. AttributeValueList can contain only one AttributeValue element of type
// String, Number, or Binary (not a set type). If the target attribute of the
// comparison is a String, then the operator checks for the absence of a substring
// match. If the target attribute of the comparison is Binary, then the operator
// checks for the absence of a subsequence of the target that matches the input. If
// the target attribute of the comparison is a set (" SS ", " NS ", or " BS "),
// then the operator evaluates to true if it does not find an exact match with any
// member of the set. NOT_CONTAINS is supported for lists: When evaluating " a
// NOT CONTAINS b ", " a " can be a list; however, " b " cannot be a set, a map,
// or a list.
// - BEGINS_WITH : Checks for a prefix. AttributeValueList can contain only one
// AttributeValue of type String or Binary (not a Number or a set type). The
// target attribute of the comparison must be of type String or Binary (not a
// Number or a set type).
// - IN : Checks for matching elements in a list. AttributeValueList can contain
// one or more AttributeValue elements of type String, Number, or Binary. These
// attributes are compared against an existing attribute of an item. If any
// elements of the input are equal to the item attribute, the expression evaluates
// to true.
// - BETWEEN : Greater than or equal to the first value, and less than or equal
// to the second value. AttributeValueList must contain two AttributeValue
// elements of the same type, either String, Number, or Binary (not a set type). A
// target attribute matches if the target value is greater than, or equal to, the
// first element and less than, or equal to, the second element. If an item
// contains an AttributeValue element of a different type than the one provided
// in the request, the value does not match. For example, {"S":"6"} does not
// compare to {"N":"6"} . Also, {"N":"6"} does not compare to {"NS":["6", "2",
// "1"]}
ComparisonOperator ComparisonOperator
// Causes DynamoDB to evaluate the value before attempting a conditional
// operation:
// - If Exists is true , DynamoDB will check to see if that attribute value
// already exists in the table. If it is found, then the operation succeeds. If it
// is not found, the operation fails with a ConditionCheckFailedException .
// - If Exists is false , DynamoDB assumes that the attribute value does not
// exist in the table. If in fact the value does not exist, then the assumption is
// valid and the operation succeeds. If the value is found, despite the assumption
// that it does not exist, the operation fails with a
// ConditionCheckFailedException .
// The default setting for Exists is true . If you supply a Value all by itself,
// DynamoDB assumes the attribute exists: You don't have to set Exists to true ,
// because it is implied. DynamoDB returns a ValidationException if:
// - Exists is true but there is no Value to check. (You expect a value to exist,
// but don't specify what that value is.)
// - Exists is false but you also provide a Value . (You cannot expect an
// attribute to have a value, while also expecting it not to exist.)
Exists *bool
// Represents the data for the expected attribute. Each attribute value is
// described as a name-value pair. The name is the data type, and the value is the
// data itself. For more information, see Data Types (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.NamingRulesDataTypes.html#HowItWorks.DataTypes)
// in the Amazon DynamoDB Developer Guide.
Value AttributeValue
noSmithyDocumentSerde
}
// Represents the properties of the exported table.
type ExportDescription struct {
// The billable size of the table export.
BilledSizeBytes *int64
// The client token that was provided for the export task. A client token makes
// calls to ExportTableToPointInTimeInput idempotent, meaning that multiple
// identical calls have the same effect as one single call.
ClientToken *string
// The time at which the export task completed.
EndTime *time.Time
// The Amazon Resource Name (ARN) of the table export.
ExportArn *string
// The format of the exported data. Valid values for ExportFormat are DYNAMODB_JSON
// or ION .
ExportFormat ExportFormat
// The name of the manifest file for the export task.
ExportManifest *string
// Export can be in one of the following states: IN_PROGRESS, COMPLETED, or FAILED.
ExportStatus ExportStatus
// Point in time from which table data was exported.
ExportTime *time.Time
// The type of export that was performed. Valid values are FULL_EXPORT or
// INCREMENTAL_EXPORT .
ExportType ExportType
// Status code for the result of the failed export.
FailureCode *string
// Export failure reason description.
FailureMessage *string
// Optional object containing the parameters specific to an incremental export.
IncrementalExportSpecification *IncrementalExportSpecification
// The number of items exported.
ItemCount *int64
// The name of the Amazon S3 bucket containing the export.
S3Bucket *string
// The ID of the Amazon Web Services account that owns the bucket containing the
// export.
S3BucketOwner *string
// The Amazon S3 bucket prefix used as the file name and path of the exported
// snapshot.
S3Prefix *string
// Type of encryption used on the bucket where export data is stored. Valid values
// for S3SseAlgorithm are:
// - AES256 - server-side encryption with Amazon S3 managed keys
// - KMS - server-side encryption with KMS managed keys
S3SseAlgorithm S3SseAlgorithm
// The ID of the KMS managed key used to encrypt the S3 bucket where export data
// is stored (if applicable).
S3SseKmsKeyId *string
// The time at which the export task began.
StartTime *time.Time
// The Amazon Resource Name (ARN) of the table that was exported.
TableArn *string
// Unique ID of the table that was exported.
TableId *string
noSmithyDocumentSerde
}
// Summary information about an export task.
type ExportSummary struct {
// The Amazon Resource Name (ARN) of the export.
ExportArn *string
// Export can be in one of the following states: IN_PROGRESS, COMPLETED, or FAILED.
ExportStatus ExportStatus
// The type of export that was performed. Valid values are FULL_EXPORT or
// INCREMENTAL_EXPORT .
ExportType ExportType
noSmithyDocumentSerde
}
// Represents a failure a contributor insights operation.
type FailureException struct {
// Description of the failure.
ExceptionDescription *string
// Exception name.
ExceptionName *string
noSmithyDocumentSerde
}
// Specifies an item and related attribute values to retrieve in a TransactGetItem
// object.
type Get struct {
// A map of attribute names to AttributeValue objects that specifies the primary
// key of the item to retrieve.
//
// This member is required.
Key map[string]AttributeValue
// The name of the table from which to retrieve the specified item.
//
// This member is required.
TableName *string
// One or more substitution tokens for attribute names in the ProjectionExpression
// parameter.
ExpressionAttributeNames map[string]string
// A string that identifies one or more attributes of the specified item to
// retrieve from the table. The attributes in the expression must be separated by
// commas. If no attribute names are specified, then all attributes of the
// specified item are returned. If any of the requested attributes are not found,
// they do not appear in the result.
ProjectionExpression *string
noSmithyDocumentSerde
}
// Represents the properties of a global secondary index.
type GlobalSecondaryIndex struct {
// The name of the global secondary index. The name must be unique among all other
// indexes on this table.
//
// This member is required.
IndexName *string
// The complete key schema for a global secondary index, which consists of one or
// more pairs of attribute names and key types:
// - HASH - partition key
// - RANGE - sort key
// The partition key of an item is also known as its hash attribute. The term
// "hash attribute" derives from DynamoDB's usage of an internal hash function to
// evenly distribute data items across partitions, based on their partition key
// values. The sort key of an item is also known as its range attribute. The term
// "range attribute" derives from the way DynamoDB stores items with the same
// partition key physically close together, in sorted order by the sort key value.
//
// This member is required.
KeySchema []KeySchemaElement
// Represents attributes that are copied (projected) from the table into the
// global secondary index. These are in addition to the primary key attributes and
// index key attributes, which are automatically projected.
//
// This member is required.
Projection *Projection
// Represents the provisioned throughput settings for the specified global
// secondary index. For current minimum and maximum provisioned throughput values,
// see Service, Account, and Table Quotas (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Limits.html)
// in the Amazon DynamoDB Developer Guide.
ProvisionedThroughput *ProvisionedThroughput
noSmithyDocumentSerde
}
// Represents the auto scaling settings of a global secondary index for a global
// table that will be modified.
type GlobalSecondaryIndexAutoScalingUpdate struct {
// The name of the global secondary index.
IndexName *string
// Represents the auto scaling settings to be modified for a global table or
// global secondary index.
ProvisionedWriteCapacityAutoScalingUpdate *AutoScalingSettingsUpdate
noSmithyDocumentSerde
}
// Represents the properties of a global secondary index.
type GlobalSecondaryIndexDescription struct {
// Indicates whether the index is currently backfilling. Backfilling is the
// process of reading items from the table and determining whether they can be
// added to the index. (Not all items will qualify: For example, a partition key
// cannot have any duplicate values.) If an item can be added to the index,
// DynamoDB will do so. After all items have been processed, the backfilling
// operation is complete and Backfilling is false. You can delete an index that is
// being created during the Backfilling phase when IndexStatus is set to CREATING
// and Backfilling is true. You can't delete the index that is being created when
// IndexStatus is set to CREATING and Backfilling is false. For indexes that were
// created during a CreateTable operation, the Backfilling attribute does not
// appear in the DescribeTable output.
Backfilling *bool
// The Amazon Resource Name (ARN) that uniquely identifies the index.
IndexArn *string
// The name of the global secondary index.
IndexName *string
// The total size of the specified index, in bytes. DynamoDB updates this value
// approximately every six hours. Recent changes might not be reflected in this
// value.
IndexSizeBytes *int64
// The current state of the global secondary index:
// - CREATING - The index is being created.
// - UPDATING - The index is being updated.
// - DELETING - The index is being deleted.
// - ACTIVE - The index is ready for use.
IndexStatus IndexStatus
// The number of items in the specified index. DynamoDB updates this value
// approximately every six hours. Recent changes might not be reflected in this
// value.
ItemCount *int64
// The complete key schema for a global secondary index, which consists of one or
// more pairs of attribute names and key types:
// - HASH - partition key
// - RANGE - sort key
// The partition key of an item is also known as its hash attribute. The term
// "hash attribute" derives from DynamoDB's usage of an internal hash function to
// evenly distribute data items across partitions, based on their partition key
// values. The sort key of an item is also known as its range attribute. The term
// "range attribute" derives from the way DynamoDB stores items with the same
// partition key physically close together, in sorted order by the sort key value.
KeySchema []KeySchemaElement
// Represents attributes that are copied (projected) from the table into the
// global secondary index. These are in addition to the primary key attributes and
// index key attributes, which are automatically projected.
Projection *Projection
// Represents the provisioned throughput settings for the specified global
// secondary index. For current minimum and maximum provisioned throughput values,
// see Service, Account, and Table Quotas (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Limits.html)
// in the Amazon DynamoDB Developer Guide.
ProvisionedThroughput *ProvisionedThroughputDescription
noSmithyDocumentSerde
}
// Represents the properties of a global secondary index for the table when the
// backup was created.
type GlobalSecondaryIndexInfo struct {
// The name of the global secondary index.
IndexName *string
// The complete key schema for a global secondary index, which consists of one or
// more pairs of attribute names and key types:
// - HASH - partition key
// - RANGE - sort key
// The partition key of an item is also known as its hash attribute. The term
// "hash attribute" derives from DynamoDB's usage of an internal hash function to
// evenly distribute data items across partitions, based on their partition key
// values. The sort key of an item is also known as its range attribute. The term
// "range attribute" derives from the way DynamoDB stores items with the same
// partition key physically close together, in sorted order by the sort key value.
KeySchema []KeySchemaElement
// Represents attributes that are copied (projected) from the table into the
// global secondary index. These are in addition to the primary key attributes and
// index key attributes, which are automatically projected.
Projection *Projection
// Represents the provisioned throughput settings for the specified global
// secondary index.
ProvisionedThroughput *ProvisionedThroughput
noSmithyDocumentSerde
}
// Represents one of the following:
// - A new global secondary index to be added to an existing table.
// - New provisioned throughput parameters for an existing global secondary
// index.
// - An existing global secondary index to be removed from an existing table.
type GlobalSecondaryIndexUpdate struct {
// The parameters required for creating a global secondary index on an existing
// table:
// - IndexName
// - KeySchema
// - AttributeDefinitions
// - Projection
// - ProvisionedThroughput
Create *CreateGlobalSecondaryIndexAction
// The name of an existing global secondary index to be removed.
Delete *DeleteGlobalSecondaryIndexAction
// The name of an existing global secondary index, along with new provisioned
// throughput settings to be applied to that index.
Update *UpdateGlobalSecondaryIndexAction
noSmithyDocumentSerde
}
// Represents the properties of a global table.
type GlobalTable struct {
// The global table name.
GlobalTableName *string
// The Regions where the global table has replicas.
ReplicationGroup []Replica
noSmithyDocumentSerde
}
// Contains details about the global table.
type GlobalTableDescription struct {
// The creation time of the global table.
CreationDateTime *time.Time
// The unique identifier of the global table.
GlobalTableArn *string
// The global table name.
GlobalTableName *string
// The current state of the global table:
// - CREATING - The global table is being created.
// - UPDATING - The global table is being updated.
// - DELETING - The global table is being deleted.
// - ACTIVE - The global table is ready for use.
GlobalTableStatus GlobalTableStatus
// The Regions where the global table has replicas.
ReplicationGroup []ReplicaDescription
noSmithyDocumentSerde
}
// Represents the settings of a global secondary index for a global table that
// will be modified.
type GlobalTableGlobalSecondaryIndexSettingsUpdate struct {
// The name of the global secondary index. The name must be unique among all other
// indexes on this table.
//
// This member is required.
IndexName *string
// Auto scaling settings for managing a global secondary index's write capacity
// units.
ProvisionedWriteCapacityAutoScalingSettingsUpdate *AutoScalingSettingsUpdate
// The maximum number of writes consumed per second before DynamoDB returns a
// ThrottlingException.
ProvisionedWriteCapacityUnits *int64
noSmithyDocumentSerde
}
// Summary information about the source file for the import.
type ImportSummary struct {
// The Amazon Resource Number (ARN) of the Cloudwatch Log Group associated with
// this import task.
CloudWatchLogGroupArn *string
// The time at which this import task ended. (Does this include the successful
// complete creation of the table it was imported to?)
EndTime *time.Time
// The Amazon Resource Number (ARN) corresponding to the import request.
ImportArn *string
// The status of the import operation.
ImportStatus ImportStatus
// The format of the source data. Valid values are CSV , DYNAMODB_JSON or ION .
InputFormat InputFormat
// The path and S3 bucket of the source file that is being imported. This includes
// the S3Bucket (required), S3KeyPrefix (optional) and S3BucketOwner (optional if
// the bucket is owned by the requester).
S3BucketSource *S3BucketSource
// The time at which this import task began.
StartTime *time.Time
// The Amazon Resource Number (ARN) of the table being imported into.
TableArn *string
noSmithyDocumentSerde
}
// Represents the properties of the table being imported into.
type ImportTableDescription struct {
// The client token that was provided for the import task. Reusing the client
// token on retry makes a call to ImportTable idempotent.
ClientToken *string
// The Amazon Resource Number (ARN) of the Cloudwatch Log Group associated with
// the target table.
CloudWatchLogGroupArn *string
// The time at which the creation of the table associated with this import task
// completed.
EndTime *time.Time
// The number of errors occurred on importing the source file into the target
// table.
ErrorCount int64
// The error code corresponding to the failure that the import job ran into during
// execution.
FailureCode *string
// The error message corresponding to the failure that the import job ran into
// during execution.
FailureMessage *string
// The Amazon Resource Number (ARN) corresponding to the import request.
ImportArn *string
// The status of the import.
ImportStatus ImportStatus
// The number of items successfully imported into the new table.
ImportedItemCount int64
// The compression options for the data that has been imported into the target
// table. The values are NONE, GZIP, or ZSTD.
InputCompressionType InputCompressionType
// The format of the source data going into the target table.
InputFormat InputFormat
// The format options for the data that was imported into the target table. There
// is one value, CsvOption.
InputFormatOptions *InputFormatOptions
// The total number of items processed from the source file.
ProcessedItemCount int64
// The total size of data processed from the source file, in Bytes.
ProcessedSizeBytes *int64
// Values for the S3 bucket the source file is imported from. Includes bucket name
// (required), key prefix (optional) and bucket account owner ID (optional).
S3BucketSource *S3BucketSource
// The time when this import task started.
StartTime *time.Time
// The Amazon Resource Number (ARN) of the table being imported into.
TableArn *string
// The parameters for the new table that is being imported into.
TableCreationParameters *TableCreationParameters
// The table id corresponding to the table created by import table process.
TableId *string
noSmithyDocumentSerde
}
// Optional object containing the parameters specific to an incremental export.
type IncrementalExportSpecification struct {
// Time in the past which provides the inclusive start range for the export
// table's data, counted in seconds from the start of the Unix epoch. The
// incremental export will reflect the table's state including and after this point
// in time.
ExportFromTime *time.Time
// Time in the past which provides the exclusive end range for the export table's
// data, counted in seconds from the start of the Unix epoch. The incremental
// export will reflect the table's state just prior to this point in time. If this
// is not provided, the latest time with data available will be used.
ExportToTime *time.Time
// The view type that was chosen for the export. Valid values are
// NEW_AND_OLD_IMAGES and NEW_IMAGES . The default value is NEW_AND_OLD_IMAGES .
ExportViewType ExportViewType
noSmithyDocumentSerde
}
// The format options for the data that was imported into the target table. There
// is one value, CsvOption.
type InputFormatOptions struct {
// The options for imported source files in CSV format. The values are Delimiter
// and HeaderList.
Csv *CsvOptions
noSmithyDocumentSerde
}
// Information about item collections, if any, that were affected by the
// operation. ItemCollectionMetrics is only returned if the request asked for it.
// If the table does not have any local secondary indexes, this information is not
// returned in the response.
type ItemCollectionMetrics struct {
// The partition key value of the item collection. This value is the same as the
// partition key value of the item.
ItemCollectionKey map[string]AttributeValue
// An estimate of item collection size, in gigabytes. This value is a two-element
// array containing a lower bound and an upper bound for the estimate. The estimate
// includes the size of all the items in the table, plus the size of all attributes
// projected into all of the local secondary indexes on that table. Use this
// estimate to measure whether a local secondary index is approaching its size
// limit. The estimate is subject to change over time; therefore, do not rely on
// the precision or accuracy of the estimate.
SizeEstimateRangeGB []float64
noSmithyDocumentSerde
}
// Details for the requested item.
type ItemResponse struct {
// Map of attribute data consisting of the data type and attribute value.
Item map[string]AttributeValue
noSmithyDocumentSerde
}
// Represents a set of primary keys and, for each key, the attributes to retrieve
// from the table. For each primary key, you must provide all of the key
// attributes. For example, with a simple primary key, you only need to provide the
// partition key. For a composite primary key, you must provide both the partition
// key and the sort key.
type KeysAndAttributes struct {
// The primary key attribute values that define the items and the attributes
// associated with the items.
//
// This member is required.
Keys []map[string]AttributeValue
// This is a legacy parameter. Use ProjectionExpression instead. For more
// information, see Legacy Conditional Parameters (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.html)
// in the Amazon DynamoDB Developer Guide.
AttributesToGet []string
// The consistency of a read operation. If set to true , then a strongly consistent
// read is used; otherwise, an eventually consistent read is used.
ConsistentRead *bool
// One or more substitution tokens for attribute names in an expression. The
// following are some use cases for using ExpressionAttributeNames :
// - To access an attribute whose name conflicts with a DynamoDB reserved word.
// - To create a placeholder for repeating occurrences of an attribute name in
// an expression.
// - To prevent special characters in an attribute name from being
// misinterpreted in an expression.
// Use the # character in an expression to dereference an attribute name. For
// example, consider the following attribute name:
// - Percentile
// The name of this attribute conflicts with a reserved word, so it cannot be used
// directly in an expression. (For the complete list of reserved words, see
// Reserved Words (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ReservedWords.html)
// in the Amazon DynamoDB Developer Guide). To work around this, you could specify
// the following for ExpressionAttributeNames :
// - {"#P":"Percentile"}
// You could then use this substitution in an expression, as in this example:
// - #P = :val
// Tokens that begin with the : character are expression attribute values, which
// are placeholders for the actual value at runtime. For more information on
// expression attribute names, see Accessing Item Attributes (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.AccessingItemAttributes.html)
// in the Amazon DynamoDB Developer Guide.
ExpressionAttributeNames map[string]string
// A string that identifies one or more attributes to retrieve from the table.
// These attributes can include scalars, sets, or elements of a JSON document. The
// attributes in the ProjectionExpression must be separated by commas. If no
// attribute names are specified, then all attributes will be returned. If any of
// the requested attributes are not found, they will not appear in the result. For
// more information, see Accessing Item Attributes (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.AccessingItemAttributes.html)
// in the Amazon DynamoDB Developer Guide.
ProjectionExpression *string
noSmithyDocumentSerde
}
// Represents a single element of a key schema. A key schema specifies the
// attributes that make up the primary key of a table, or the key attributes of an
// index. A KeySchemaElement represents exactly one attribute of the primary key.
// For example, a simple primary key would be represented by one KeySchemaElement
// (for the partition key). A composite primary key would require one
// KeySchemaElement for the partition key, and another KeySchemaElement for the
// sort key. A KeySchemaElement must be a scalar, top-level attribute (not a
// nested attribute). The data type must be one of String, Number, or Binary. The
// attribute cannot be nested within a List or a Map.
type KeySchemaElement struct {
// The name of a key attribute.
//
// This member is required.
AttributeName *string
// The role that this key attribute will assume:
// - HASH - partition key
// - RANGE - sort key
// The partition key of an item is also known as its hash attribute. The term
// "hash attribute" derives from DynamoDB's usage of an internal hash function to
// evenly distribute data items across partitions, based on their partition key
// values. The sort key of an item is also known as its range attribute. The term
// "range attribute" derives from the way DynamoDB stores items with the same
// partition key physically close together, in sorted order by the sort key value.
//
// This member is required.
KeyType KeyType
noSmithyDocumentSerde
}
// Describes a Kinesis data stream destination.
type KinesisDataStreamDestination struct {
// The current status of replication.
DestinationStatus DestinationStatus
// The human-readable string that corresponds to the replica status.
DestinationStatusDescription *string
// The ARN for a specific Kinesis data stream.
StreamArn *string
noSmithyDocumentSerde
}
// Represents the properties of a local secondary index.
type LocalSecondaryIndex struct {
// The name of the local secondary index. The name must be unique among all other
// indexes on this table.
//
// This member is required.
IndexName *string
// The complete key schema for the local secondary index, consisting of one or
// more pairs of attribute names and key types:
// - HASH - partition key
// - RANGE - sort key
// The partition key of an item is also known as its hash attribute. The term
// "hash attribute" derives from DynamoDB's usage of an internal hash function to
// evenly distribute data items across partitions, based on their partition key
// values. The sort key of an item is also known as its range attribute. The term
// "range attribute" derives from the way DynamoDB stores items with the same
// partition key physically close together, in sorted order by the sort key value.
//
// This member is required.
KeySchema []KeySchemaElement
// Represents attributes that are copied (projected) from the table into the local
// secondary index. These are in addition to the primary key attributes and index
// key attributes, which are automatically projected.
//
// This member is required.
Projection *Projection
noSmithyDocumentSerde
}
// Represents the properties of a local secondary index.
type LocalSecondaryIndexDescription struct {
// The Amazon Resource Name (ARN) that uniquely identifies the index.
IndexArn *string
// Represents the name of the local secondary index.
IndexName *string
// The total size of the specified index, in bytes. DynamoDB updates this value
// approximately every six hours. Recent changes might not be reflected in this
// value.
IndexSizeBytes *int64
// The number of items in the specified index. DynamoDB updates this value
// approximately every six hours. Recent changes might not be reflected in this
// value.
ItemCount *int64
// The complete key schema for the local secondary index, consisting of one or
// more pairs of attribute names and key types:
// - HASH - partition key
// - RANGE - sort key
// The partition key of an item is also known as its hash attribute. The term
// "hash attribute" derives from DynamoDB's usage of an internal hash function to
// evenly distribute data items across partitions, based on their partition key
// values. The sort key of an item is also known as its range attribute. The term
// "range attribute" derives from the way DynamoDB stores items with the same
// partition key physically close together, in sorted order by the sort key value.
KeySchema []KeySchemaElement
// Represents attributes that are copied (projected) from the table into the
// global secondary index. These are in addition to the primary key attributes and
// index key attributes, which are automatically projected.
Projection *Projection
noSmithyDocumentSerde
}
// Represents the properties of a local secondary index for the table when the
// backup was created.
type LocalSecondaryIndexInfo struct {
// Represents the name of the local secondary index.
IndexName *string
// The complete key schema for a local secondary index, which consists of one or
// more pairs of attribute names and key types:
// - HASH - partition key
// - RANGE - sort key
// The partition key of an item is also known as its hash attribute. The term
// "hash attribute" derives from DynamoDB's usage of an internal hash function to
// evenly distribute data items across partitions, based on their partition key
// values. The sort key of an item is also known as its range attribute. The term
// "range attribute" derives from the way DynamoDB stores items with the same
// partition key physically close together, in sorted order by the sort key value.
KeySchema []KeySchemaElement
// Represents attributes that are copied (projected) from the table into the
// global secondary index. These are in addition to the primary key attributes and
// index key attributes, which are automatically projected.
Projection *Projection
noSmithyDocumentSerde
}
// Represents a PartiQL statment that uses parameters.
type ParameterizedStatement struct {
// A PartiQL statment that uses parameters.
//
// This member is required.
Statement *string
// The parameter values.
Parameters []AttributeValue
// An optional parameter that returns the item attributes for a PartiQL
// ParameterizedStatement operation that failed a condition check. There is no
// additional cost associated with requesting a return value aside from the small
// network and processing overhead of receiving a larger response. No read capacity
// units are consumed.
ReturnValuesOnConditionCheckFailure ReturnValuesOnConditionCheckFailure
noSmithyDocumentSerde
}
// The description of the point in time settings applied to the table.
type PointInTimeRecoveryDescription struct {
// Specifies the earliest point in time you can restore your table to. You can
// restore your table to any point in time during the last 35 days.
EarliestRestorableDateTime *time.Time
// LatestRestorableDateTime is typically 5 minutes before the current time.
LatestRestorableDateTime *time.Time
// The current state of point in time recovery:
// - ENABLED - Point in time recovery is enabled.
// - DISABLED - Point in time recovery is disabled.
PointInTimeRecoveryStatus PointInTimeRecoveryStatus
noSmithyDocumentSerde
}
// Represents the settings used to enable point in time recovery.
type PointInTimeRecoverySpecification struct {
// Indicates whether point in time recovery is enabled (true) or disabled (false)
// on the table.
//
// This member is required.
PointInTimeRecoveryEnabled *bool
noSmithyDocumentSerde
}
// Represents attributes that are copied (projected) from the table into an index.
// These are in addition to the primary key attributes and index key attributes,
// which are automatically projected.
type Projection struct {
// Represents the non-key attribute names which will be projected into the index.
// For local secondary indexes, the total count of NonKeyAttributes summed across
// all of the local secondary indexes, must not exceed 100. If you project the same
// attribute into two different indexes, this counts as two distinct attributes
// when determining the total.
NonKeyAttributes []string
// The set of attributes that are projected into the index:
// - KEYS_ONLY - Only the index and primary keys are projected into the index.
// - INCLUDE - In addition to the attributes described in KEYS_ONLY , the
// secondary index will include other non-key attributes that you specify.
// - ALL - All of the table attributes are projected into the index.
ProjectionType ProjectionType
noSmithyDocumentSerde
}
// Represents the provisioned throughput settings for a specified table or index.
// The settings can be modified using the UpdateTable operation. For current
// minimum and maximum provisioned throughput values, see Service, Account, and
// Table Quotas (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Limits.html)
// in the Amazon DynamoDB Developer Guide.
type ProvisionedThroughput struct {
// The maximum number of strongly consistent reads consumed per second before
// DynamoDB returns a ThrottlingException . For more information, see Specifying
// Read and Write Requirements (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ProvisionedThroughput.html)
// in the Amazon DynamoDB Developer Guide. If read/write capacity mode is
// PAY_PER_REQUEST the value is set to 0.
//
// This member is required.
ReadCapacityUnits *int64
// The maximum number of writes consumed per second before DynamoDB returns a
// ThrottlingException . For more information, see Specifying Read and Write
// Requirements (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ProvisionedThroughput.html)
// in the Amazon DynamoDB Developer Guide. If read/write capacity mode is
// PAY_PER_REQUEST the value is set to 0.
//
// This member is required.
WriteCapacityUnits *int64
noSmithyDocumentSerde
}
// Represents the provisioned throughput settings for the table, consisting of
// read and write capacity units, along with data about increases and decreases.
type ProvisionedThroughputDescription struct {
// The date and time of the last provisioned throughput decrease for this table.
LastDecreaseDateTime *time.Time
// The date and time of the last provisioned throughput increase for this table.
LastIncreaseDateTime *time.Time
// The number of provisioned throughput decreases for this table during this UTC
// calendar day. For current maximums on provisioned throughput decreases, see
// Service, Account, and Table Quotas (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Limits.html)
// in the Amazon DynamoDB Developer Guide.
NumberOfDecreasesToday *int64
// The maximum number of strongly consistent reads consumed per second before
// DynamoDB returns a ThrottlingException . Eventually consistent reads require
// less effort than strongly consistent reads, so a setting of 50 ReadCapacityUnits
// per second provides 100 eventually consistent ReadCapacityUnits per second.
ReadCapacityUnits *int64
// The maximum number of writes consumed per second before DynamoDB returns a
// ThrottlingException .
WriteCapacityUnits *int64
noSmithyDocumentSerde
}
// Replica-specific provisioned throughput settings. If not specified, uses the
// source table's provisioned throughput settings.
type ProvisionedThroughputOverride struct {
// Replica-specific read capacity units. If not specified, uses the source table's
// read capacity settings.
ReadCapacityUnits *int64
noSmithyDocumentSerde
}
// Represents a request to perform a PutItem operation.
type Put struct {
// A map of attribute name to attribute values, representing the primary key of
// the item to be written by PutItem . All of the table's primary key attributes
// must be specified, and their data types must match those of the table's key
// schema. If any attributes are present in the item that are part of an index key
// schema for the table, their types must match the index key schema.
//
// This member is required.
Item map[string]AttributeValue
// Name of the table in which to write the item.
//
// This member is required.
TableName *string
// A condition that must be satisfied in order for a conditional update to succeed.
ConditionExpression *string
// One or more substitution tokens for attribute names in an expression.
ExpressionAttributeNames map[string]string
// One or more values that can be substituted in an expression.
ExpressionAttributeValues map[string]AttributeValue
// Use ReturnValuesOnConditionCheckFailure to get the item attributes if the Put
// condition fails. For ReturnValuesOnConditionCheckFailure , the valid values are:
// NONE and ALL_OLD.
ReturnValuesOnConditionCheckFailure ReturnValuesOnConditionCheckFailure
noSmithyDocumentSerde
}
// Represents a request to perform a PutItem operation on an item.
type PutRequest struct {
// A map of attribute name to attribute values, representing the primary key of an
// item to be processed by PutItem . All of the table's primary key attributes must
// be specified, and their data types must match those of the table's key schema.
// If any attributes are present in the item that are part of an index key schema
// for the table, their types must match the index key schema.
//
// This member is required.
Item map[string]AttributeValue
noSmithyDocumentSerde
}
// Represents the properties of a replica.
type Replica struct {
// The Region where the replica needs to be created.
RegionName *string
noSmithyDocumentSerde
}
// Represents the auto scaling settings of the replica.
type ReplicaAutoScalingDescription struct {
// Replica-specific global secondary index auto scaling settings.
GlobalSecondaryIndexes []ReplicaGlobalSecondaryIndexAutoScalingDescription
// The Region where the replica exists.
RegionName *string
// Represents the auto scaling settings for a global table or global secondary
// index.
ReplicaProvisionedReadCapacityAutoScalingSettings *AutoScalingSettingsDescription
// Represents the auto scaling settings for a global table or global secondary
// index.
ReplicaProvisionedWriteCapacityAutoScalingSettings *AutoScalingSettingsDescription
// The current state of the replica:
// - CREATING - The replica is being created.
// - UPDATING - The replica is being updated.
// - DELETING - The replica is being deleted.
// - ACTIVE - The replica is ready for use.
ReplicaStatus ReplicaStatus
noSmithyDocumentSerde
}
// Represents the auto scaling settings of a replica that will be modified.
type ReplicaAutoScalingUpdate struct {
// The Region where the replica exists.
//
// This member is required.
RegionName *string
// Represents the auto scaling settings of global secondary indexes that will be
// modified.
ReplicaGlobalSecondaryIndexUpdates []ReplicaGlobalSecondaryIndexAutoScalingUpdate
// Represents the auto scaling settings to be modified for a global table or
// global secondary index.
ReplicaProvisionedReadCapacityAutoScalingUpdate *AutoScalingSettingsUpdate
noSmithyDocumentSerde
}
// Contains the details of the replica.
type ReplicaDescription struct {
// Replica-specific global secondary index settings.
GlobalSecondaryIndexes []ReplicaGlobalSecondaryIndexDescription
// The KMS key of the replica that will be used for KMS encryption.
KMSMasterKeyId *string
// Replica-specific provisioned throughput. If not described, uses the source
// table's provisioned throughput settings.
ProvisionedThroughputOverride *ProvisionedThroughputOverride
// The name of the Region.
RegionName *string
// The time at which the replica was first detected as inaccessible. To determine
// cause of inaccessibility check the ReplicaStatus property.
ReplicaInaccessibleDateTime *time.Time
// The current state of the replica:
// - CREATING - The replica is being created.
// - UPDATING - The replica is being updated.
// - DELETING - The replica is being deleted.
// - ACTIVE - The replica is ready for use.
// - REGION_DISABLED - The replica is inaccessible because the Amazon Web
// Services Region has been disabled. If the Amazon Web Services Region remains
// inaccessible for more than 20 hours, DynamoDB will remove this replica from the
// replication group. The replica will not be deleted and replication will stop
// from and to this region.
// - INACCESSIBLE_ENCRYPTION_CREDENTIALS - The KMS key used to encrypt the table
// is inaccessible. If the KMS key remains inaccessible for more than 20 hours,
// DynamoDB will remove this replica from the replication group. The replica will
// not be deleted and replication will stop from and to this region.
ReplicaStatus ReplicaStatus
// Detailed information about the replica status.
ReplicaStatusDescription *string
// Specifies the progress of a Create, Update, or Delete action on the replica as
// a percentage.
ReplicaStatusPercentProgress *string
// Contains details of the table class.
ReplicaTableClassSummary *TableClassSummary
noSmithyDocumentSerde
}
// Represents the properties of a replica global secondary index.
type ReplicaGlobalSecondaryIndex struct {
// The name of the global secondary index.
//
// This member is required.
IndexName *string
// Replica table GSI-specific provisioned throughput. If not specified, uses the
// source table GSI's read capacity settings.
ProvisionedThroughputOverride *ProvisionedThroughputOverride
noSmithyDocumentSerde
}
// Represents the auto scaling configuration for a replica global secondary index.
type ReplicaGlobalSecondaryIndexAutoScalingDescription struct {
// The name of the global secondary index.
IndexName *string
// The current state of the replica global secondary index:
// - CREATING - The index is being created.
// - UPDATING - The table/index configuration is being updated. The table/index
// remains available for data operations when UPDATING
// - DELETING - The index is being deleted.
// - ACTIVE - The index is ready for use.
IndexStatus IndexStatus
// Represents the auto scaling settings for a global table or global secondary
// index.
ProvisionedReadCapacityAutoScalingSettings *AutoScalingSettingsDescription
// Represents the auto scaling settings for a global table or global secondary
// index.
ProvisionedWriteCapacityAutoScalingSettings *AutoScalingSettingsDescription
noSmithyDocumentSerde
}
// Represents the auto scaling settings of a global secondary index for a replica
// that will be modified.
type ReplicaGlobalSecondaryIndexAutoScalingUpdate struct {
// The name of the global secondary index.
IndexName *string
// Represents the auto scaling settings to be modified for a global table or
// global secondary index.
ProvisionedReadCapacityAutoScalingUpdate *AutoScalingSettingsUpdate
noSmithyDocumentSerde
}
// Represents the properties of a replica global secondary index.
type ReplicaGlobalSecondaryIndexDescription struct {
// The name of the global secondary index.
IndexName *string
// If not described, uses the source table GSI's read capacity settings.
ProvisionedThroughputOverride *ProvisionedThroughputOverride
noSmithyDocumentSerde
}
// Represents the properties of a global secondary index.
type ReplicaGlobalSecondaryIndexSettingsDescription struct {
// The name of the global secondary index. The name must be unique among all other
// indexes on this table.
//
// This member is required.
IndexName *string
// The current status of the global secondary index:
// - CREATING - The global secondary index is being created.
// - UPDATING - The global secondary index is being updated.
// - DELETING - The global secondary index is being deleted.
// - ACTIVE - The global secondary index is ready for use.
IndexStatus IndexStatus
// Auto scaling settings for a global secondary index replica's read capacity
// units.
ProvisionedReadCapacityAutoScalingSettings *AutoScalingSettingsDescription
// The maximum number of strongly consistent reads consumed per second before
// DynamoDB returns a ThrottlingException .
ProvisionedReadCapacityUnits *int64
// Auto scaling settings for a global secondary index replica's write capacity
// units.
ProvisionedWriteCapacityAutoScalingSettings *AutoScalingSettingsDescription
// The maximum number of writes consumed per second before DynamoDB returns a
// ThrottlingException .
ProvisionedWriteCapacityUnits *int64
noSmithyDocumentSerde
}
// Represents the settings of a global secondary index for a global table that
// will be modified.
type ReplicaGlobalSecondaryIndexSettingsUpdate struct {
// The name of the global secondary index. The name must be unique among all other
// indexes on this table.
//
// This member is required.
IndexName *string
// Auto scaling settings for managing a global secondary index replica's read
// capacity units.
ProvisionedReadCapacityAutoScalingSettingsUpdate *AutoScalingSettingsUpdate
// The maximum number of strongly consistent reads consumed per second before
// DynamoDB returns a ThrottlingException .
ProvisionedReadCapacityUnits *int64
noSmithyDocumentSerde
}
// Represents the properties of a replica.
type ReplicaSettingsDescription struct {
// The Region name of the replica.
//
// This member is required.
RegionName *string
// The read/write capacity mode of the replica.
ReplicaBillingModeSummary *BillingModeSummary
// Replica global secondary index settings for the global table.
ReplicaGlobalSecondaryIndexSettings []ReplicaGlobalSecondaryIndexSettingsDescription
// Auto scaling settings for a global table replica's read capacity units.
ReplicaProvisionedReadCapacityAutoScalingSettings *AutoScalingSettingsDescription
// The maximum number of strongly consistent reads consumed per second before
// DynamoDB returns a ThrottlingException . For more information, see Specifying
// Read and Write Requirements (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithTables.html#ProvisionedThroughput)
// in the Amazon DynamoDB Developer Guide.
ReplicaProvisionedReadCapacityUnits *int64
// Auto scaling settings for a global table replica's write capacity units.
ReplicaProvisionedWriteCapacityAutoScalingSettings *AutoScalingSettingsDescription
// The maximum number of writes consumed per second before DynamoDB returns a
// ThrottlingException . For more information, see Specifying Read and Write
// Requirements (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithTables.html#ProvisionedThroughput)
// in the Amazon DynamoDB Developer Guide.
ReplicaProvisionedWriteCapacityUnits *int64
// The current state of the Region:
// - CREATING - The Region is being created.
// - UPDATING - The Region is being updated.
// - DELETING - The Region is being deleted.
// - ACTIVE - The Region is ready for use.
ReplicaStatus ReplicaStatus
// Contains details of the table class.
ReplicaTableClassSummary *TableClassSummary
noSmithyDocumentSerde
}
// Represents the settings for a global table in a Region that will be modified.
type ReplicaSettingsUpdate struct {
// The Region of the replica to be added.
//
// This member is required.
RegionName *string
// Represents the settings of a global secondary index for a global table that
// will be modified.
ReplicaGlobalSecondaryIndexSettingsUpdate []ReplicaGlobalSecondaryIndexSettingsUpdate
// Auto scaling settings for managing a global table replica's read capacity units.
ReplicaProvisionedReadCapacityAutoScalingSettingsUpdate *AutoScalingSettingsUpdate
// The maximum number of strongly consistent reads consumed per second before
// DynamoDB returns a ThrottlingException . For more information, see Specifying
// Read and Write Requirements (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithTables.html#ProvisionedThroughput)
// in the Amazon DynamoDB Developer Guide.
ReplicaProvisionedReadCapacityUnits *int64
// Replica-specific table class. If not specified, uses the source table's table
// class.
ReplicaTableClass TableClass
noSmithyDocumentSerde
}
// Represents one of the following:
// - A new replica to be added to an existing regional table or global table.
// This request invokes the CreateTableReplica action in the destination Region.
// - New parameters for an existing replica. This request invokes the UpdateTable
// action in the destination Region.
// - An existing replica to be deleted. The request invokes the
// DeleteTableReplica action in the destination Region, deleting the replica and
// all if its items in the destination Region.
//
// When you manually remove a table or global table replica, you do not
// automatically remove any associated scalable targets, scaling policies, or
// CloudWatch alarms.
type ReplicationGroupUpdate struct {
// The parameters required for creating a replica for the table.
Create *CreateReplicationGroupMemberAction
// The parameters required for deleting a replica for the table.
Delete *DeleteReplicationGroupMemberAction
// The parameters required for updating a replica for the table.
Update *UpdateReplicationGroupMemberAction
noSmithyDocumentSerde
}
// Represents one of the following:
// - A new replica to be added to an existing global table.
// - New parameters for an existing replica.
// - An existing replica to be removed from an existing global table.
type ReplicaUpdate struct {
// The parameters required for creating a replica on an existing global table.
Create *CreateReplicaAction
// The name of the existing replica to be removed.
Delete *DeleteReplicaAction
noSmithyDocumentSerde
}
// Contains details for the restore.
type RestoreSummary struct {
// Point in time or source backup time.
//
// This member is required.
RestoreDateTime *time.Time
// Indicates if a restore is in progress or not.
//
// This member is required.
RestoreInProgress *bool
// The Amazon Resource Name (ARN) of the backup from which the table was restored.
SourceBackupArn *string
// The ARN of the source table of the backup that is being restored.
SourceTableArn *string
noSmithyDocumentSerde
}
// The S3 bucket that is being imported from.
type S3BucketSource struct {
// The S3 bucket that is being imported from.
//
// This member is required.
S3Bucket *string
// The account number of the S3 bucket that is being imported from. If the bucket
// is owned by the requester this is optional.
S3BucketOwner *string
// The key prefix shared by all S3 Objects that are being imported.
S3KeyPrefix *string
noSmithyDocumentSerde
}
// Contains the details of the table when the backup was created.
type SourceTableDetails struct {
// Schema of the table.
//
// This member is required.
KeySchema []KeySchemaElement
// Read IOPs and Write IOPS on the table when the backup was created.
//
// This member is required.
ProvisionedThroughput *ProvisionedThroughput
// Time when the source table was created.
//
// This member is required.
TableCreationDateTime *time.Time
// Unique identifier for the table for which the backup was created.
//
// This member is required.
TableId *string
// The name of the table for which the backup was created.
//
// This member is required.
TableName *string
// Controls how you are charged for read and write throughput and how you manage
// capacity. This setting can be changed later.
// - PROVISIONED - Sets the read/write capacity mode to PROVISIONED . We
// recommend using PROVISIONED for predictable workloads.
// - PAY_PER_REQUEST - Sets the read/write capacity mode to PAY_PER_REQUEST . We
// recommend using PAY_PER_REQUEST for unpredictable workloads.
BillingMode BillingMode
// Number of items in the table. Note that this is an approximate value.
ItemCount *int64
// ARN of the table for which backup was created.
TableArn *string
// Size of the table in bytes. Note that this is an approximate value.
TableSizeBytes *int64
noSmithyDocumentSerde
}
// Contains the details of the features enabled on the table when the backup was
// created. For example, LSIs, GSIs, streams, TTL.
type SourceTableFeatureDetails struct {
// Represents the GSI properties for the table when the backup was created. It
// includes the IndexName, KeySchema, Projection, and ProvisionedThroughput for the
// GSIs on the table at the time of backup.
GlobalSecondaryIndexes []GlobalSecondaryIndexInfo
// Represents the LSI properties for the table when the backup was created. It
// includes the IndexName, KeySchema and Projection for the LSIs on the table at
// the time of backup.
LocalSecondaryIndexes []LocalSecondaryIndexInfo
// The description of the server-side encryption status on the table when the
// backup was created.
SSEDescription *SSEDescription
// Stream settings on the table when the backup was created.
StreamDescription *StreamSpecification
// Time to Live settings on the table when the backup was created.
TimeToLiveDescription *TimeToLiveDescription
noSmithyDocumentSerde
}
// The description of the server-side encryption status on the specified table.
type SSEDescription struct {
// Indicates the time, in UNIX epoch date format, when DynamoDB detected that the
// table's KMS key was inaccessible. This attribute will automatically be cleared
// when DynamoDB detects that the table's KMS key is accessible again. DynamoDB
// will initiate the table archival process when table's KMS key remains
// inaccessible for more than seven days from this date.
InaccessibleEncryptionDateTime *time.Time
// The KMS key ARN used for the KMS encryption.
KMSMasterKeyArn *string
// Server-side encryption type. The only supported value is:
// - KMS - Server-side encryption that uses Key Management Service. The key is
// stored in your account and is managed by KMS (KMS charges apply).
SSEType SSEType
// Represents the current state of server-side encryption. The only supported
// values are:
// - ENABLED - Server-side encryption is enabled.
// - UPDATING - Server-side encryption is being updated.
Status SSEStatus
noSmithyDocumentSerde
}
// Represents the settings used to enable server-side encryption.
type SSESpecification struct {
// Indicates whether server-side encryption is done using an Amazon Web Services
// managed key or an Amazon Web Services owned key. If enabled (true), server-side
// encryption type is set to KMS and an Amazon Web Services managed key is used
// (KMS charges apply). If disabled (false) or not specified, server-side
// encryption is set to Amazon Web Services owned key.
Enabled *bool
// The KMS key that should be used for the KMS encryption. To specify a key, use
// its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. Note that you
// should only provide this parameter if the key is different from the default
// DynamoDB key alias/aws/dynamodb .
KMSMasterKeyId *string
// Server-side encryption type. The only supported value is:
// - KMS - Server-side encryption that uses Key Management Service. The key is
// stored in your account and is managed by KMS (KMS charges apply).
SSEType SSEType
noSmithyDocumentSerde
}
// Represents the DynamoDB Streams configuration for a table in DynamoDB.
type StreamSpecification struct {
// Indicates whether DynamoDB Streams is enabled (true) or disabled (false) on the
// table.
//
// This member is required.
StreamEnabled *bool
// When an item in the table is modified, StreamViewType determines what
// information is written to the stream for this table. Valid values for
// StreamViewType are:
// - KEYS_ONLY - Only the key attributes of the modified item are written to the
// stream.
// - NEW_IMAGE - The entire item, as it appears after it was modified, is written
// to the stream.
// - OLD_IMAGE - The entire item, as it appeared before it was modified, is
// written to the stream.
// - NEW_AND_OLD_IMAGES - Both the new and the old item images of the item are
// written to the stream.
StreamViewType StreamViewType
noSmithyDocumentSerde
}
// Represents the auto scaling configuration for a global table.
type TableAutoScalingDescription struct {
// Represents replicas of the global table.
Replicas []ReplicaAutoScalingDescription
// The name of the table.
TableName *string
// The current state of the table:
// - CREATING - The table is being created.
// - UPDATING - The table is being updated.
// - DELETING - The table is being deleted.
// - ACTIVE - The table is ready for use.
TableStatus TableStatus
noSmithyDocumentSerde
}
// Contains details of the table class.
type TableClassSummary struct {
// The date and time at which the table class was last updated.
LastUpdateDateTime *time.Time
// The table class of the specified table. Valid values are STANDARD and
// STANDARD_INFREQUENT_ACCESS .
TableClass TableClass
noSmithyDocumentSerde
}
// The parameters for the table created as part of the import operation.
type TableCreationParameters struct {
// The attributes of the table created as part of the import operation.
//
// This member is required.
AttributeDefinitions []AttributeDefinition
// The primary key and option sort key of the table created as part of the import
// operation.
//
// This member is required.
KeySchema []KeySchemaElement
// The name of the table created as part of the import operation.
//
// This member is required.
TableName *string
// The billing mode for provisioning the table created as part of the import
// operation.
BillingMode BillingMode
// The Global Secondary Indexes (GSI) of the table to be created as part of the
// import operation.
GlobalSecondaryIndexes []GlobalSecondaryIndex
// Represents the provisioned throughput settings for a specified table or index.
// The settings can be modified using the UpdateTable operation. For current
// minimum and maximum provisioned throughput values, see Service, Account, and
// Table Quotas (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Limits.html)
// in the Amazon DynamoDB Developer Guide.
ProvisionedThroughput *ProvisionedThroughput
// Represents the settings used to enable server-side encryption.
SSESpecification *SSESpecification
noSmithyDocumentSerde
}
// Represents the properties of a table.
type TableDescription struct {
// Contains information about the table archive.
ArchivalSummary *ArchivalSummary
// An array of AttributeDefinition objects. Each of these objects describes one
// attribute in the table and index key schema. Each AttributeDefinition object in
// this array is composed of:
// - AttributeName - The name of the attribute.
// - AttributeType - The data type for the attribute.
AttributeDefinitions []AttributeDefinition
// Contains the details for the read/write capacity mode.
BillingModeSummary *BillingModeSummary
// The date and time when the table was created, in UNIX epoch time (http://www.epochconverter.com/)
// format.
CreationDateTime *time.Time
// Indicates whether deletion protection is enabled (true) or disabled (false) on
// the table.
DeletionProtectionEnabled *bool
// The global secondary indexes, if any, on the table. Each index is scoped to a
// given partition key value. Each element is composed of:
// - Backfilling - If true, then the index is currently in the backfilling phase.
// Backfilling occurs only when a new global secondary index is added to the table.
// It is the process by which DynamoDB populates the new index with data from the
// table. (This attribute does not appear for indexes that were created during a
// CreateTable operation.) You can delete an index that is being created during
// the Backfilling phase when IndexStatus is set to CREATING and Backfilling is
// true. You can't delete the index that is being created when IndexStatus is set
// to CREATING and Backfilling is false. (This attribute does not appear for
// indexes that were created during a CreateTable operation.)
// - IndexName - The name of the global secondary index.
// - IndexSizeBytes - The total size of the global secondary index, in bytes.
// DynamoDB updates this value approximately every six hours. Recent changes might
// not be reflected in this value.
// - IndexStatus - The current status of the global secondary index:
// - CREATING - The index is being created.
// - UPDATING - The index is being updated.
// - DELETING - The index is being deleted.
// - ACTIVE - The index is ready for use.
// - ItemCount - The number of items in the global secondary index. DynamoDB
// updates this value approximately every six hours. Recent changes might not be
// reflected in this value.
// - KeySchema - Specifies the complete index key schema. The attribute names in
// the key schema must be between 1 and 255 characters (inclusive). The key schema
// must begin with the same partition key as the table.
// - Projection - Specifies attributes that are copied (projected) from the table
// into the index. These are in addition to the primary key attributes and index
// key attributes, which are automatically projected. Each attribute specification
// is composed of:
// - ProjectionType - One of the following:
// - KEYS_ONLY - Only the index and primary keys are projected into the index.
// - INCLUDE - In addition to the attributes described in KEYS_ONLY , the
// secondary index will include other non-key attributes that you specify.
// - ALL - All of the table attributes are projected into the index.
// - NonKeyAttributes - A list of one or more non-key attribute names that are
// projected into the secondary index. The total count of attributes provided in
// NonKeyAttributes , summed across all of the secondary indexes, must not exceed
// 100. If you project the same attribute into two different indexes, this counts
// as two distinct attributes when determining the total.
// - ProvisionedThroughput - The provisioned throughput settings for the global
// secondary index, consisting of read and write capacity units, along with data
// about increases and decreases.
// If the table is in the DELETING state, no information about indexes will be
// returned.
GlobalSecondaryIndexes []GlobalSecondaryIndexDescription
// Represents the version of global tables (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/GlobalTables.html)
// in use, if the table is replicated across Amazon Web Services Regions.
GlobalTableVersion *string
// The number of items in the specified table. DynamoDB updates this value
// approximately every six hours. Recent changes might not be reflected in this
// value.
ItemCount *int64
// The primary key structure for the table. Each KeySchemaElement consists of:
// - AttributeName - The name of the attribute.
// - KeyType - The role of the attribute:
// - HASH - partition key
// - RANGE - sort key The partition key of an item is also known as its hash
// attribute. The term "hash attribute" derives from DynamoDB's usage of an
// internal hash function to evenly distribute data items across partitions, based
// on their partition key values. The sort key of an item is also known as its
// range attribute. The term "range attribute" derives from the way DynamoDB stores
// items with the same partition key physically close together, in sorted order by
// the sort key value.
// For more information about primary keys, see Primary Key (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/DataModel.html#DataModelPrimaryKey)
// in the Amazon DynamoDB Developer Guide.
KeySchema []KeySchemaElement
// The Amazon Resource Name (ARN) that uniquely identifies the latest stream for
// this table.
LatestStreamArn *string
// A timestamp, in ISO 8601 format, for this stream. Note that LatestStreamLabel
// is not a unique identifier for the stream, because it is possible that a stream
// from another table might have the same timestamp. However, the combination of
// the following three elements is guaranteed to be unique:
// - Amazon Web Services customer ID
// - Table name
// - StreamLabel
LatestStreamLabel *string
// Represents one or more local secondary indexes on the table. Each index is
// scoped to a given partition key value. Tables with one or more local secondary
// indexes are subject to an item collection size limit, where the amount of data
// within a given item collection cannot exceed 10 GB. Each element is composed of:
//
// - IndexName - The name of the local secondary index.
// - KeySchema - Specifies the complete index key schema. The attribute names in
// the key schema must be between 1 and 255 characters (inclusive). The key schema
// must begin with the same partition key as the table.
// - Projection - Specifies attributes that are copied (projected) from the table
// into the index. These are in addition to the primary key attributes and index
// key attributes, which are automatically projected. Each attribute specification
// is composed of:
// - ProjectionType - One of the following:
// - KEYS_ONLY - Only the index and primary keys are projected into the index.
// - INCLUDE - Only the specified table attributes are projected into the index.
// The list of projected attributes is in NonKeyAttributes .
// - ALL - All of the table attributes are projected into the index.
// - NonKeyAttributes - A list of one or more non-key attribute names that are
// projected into the secondary index. The total count of attributes provided in
// NonKeyAttributes , summed across all of the secondary indexes, must not exceed
// 100. If you project the same attribute into two different indexes, this counts
// as two distinct attributes when determining the total.
// - IndexSizeBytes - Represents the total size of the index, in bytes. DynamoDB
// updates this value approximately every six hours. Recent changes might not be
// reflected in this value.
// - ItemCount - Represents the number of items in the index. DynamoDB updates
// this value approximately every six hours. Recent changes might not be reflected
// in this value.
// If the table is in the DELETING state, no information about indexes will be
// returned.
LocalSecondaryIndexes []LocalSecondaryIndexDescription
// The provisioned throughput settings for the table, consisting of read and write
// capacity units, along with data about increases and decreases.
ProvisionedThroughput *ProvisionedThroughputDescription
// Represents replicas of the table.
Replicas []ReplicaDescription
// Contains details for the restore.
RestoreSummary *RestoreSummary
// The description of the server-side encryption status on the specified table.
SSEDescription *SSEDescription
// The current DynamoDB Streams configuration for the table.
StreamSpecification *StreamSpecification
// The Amazon Resource Name (ARN) that uniquely identifies the table.
TableArn *string
// Contains details of the table class.
TableClassSummary *TableClassSummary
// Unique identifier for the table for which the backup was created.
TableId *string
// The name of the table.
TableName *string
// The total size of the specified table, in bytes. DynamoDB updates this value
// approximately every six hours. Recent changes might not be reflected in this
// value.
TableSizeBytes *int64
// The current state of the table:
// - CREATING - The table is being created.
// - UPDATING - The table/index configuration is being updated. The table/index
// remains available for data operations when UPDATING .
// - DELETING - The table is being deleted.
// - ACTIVE - The table is ready for use.
// - INACCESSIBLE_ENCRYPTION_CREDENTIALS - The KMS key used to encrypt the table
// in inaccessible. Table operations may fail due to failure to use the KMS key.
// DynamoDB will initiate the table archival process when a table's KMS key remains
// inaccessible for more than seven days.
// - ARCHIVING - The table is being archived. Operations are not allowed until
// archival is complete.
// - ARCHIVED - The table has been archived. See the ArchivalReason for more
// information.
TableStatus TableStatus
noSmithyDocumentSerde
}
// Describes a tag. A tag is a key-value pair. You can add up to 50 tags to a
// single DynamoDB table. Amazon Web Services-assigned tag names and values are
// automatically assigned the aws: prefix, which the user cannot assign. Amazon
// Web Services-assigned tag names do not count towards the tag limit of 50.
// User-assigned tag names have the prefix user: in the Cost Allocation Report.
// You cannot backdate the application of a tag. For an overview on tagging
// DynamoDB resources, see Tagging for DynamoDB (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Tagging.html)
// in the Amazon DynamoDB Developer Guide.
type Tag struct {
// The key of the tag. Tag keys are case sensitive. Each DynamoDB table can only
// have up to one tag with the same key. If you try to add an existing tag (same
// key), the existing tag value will be updated to the new value.
//
// This member is required.
Key *string
// The value of the tag. Tag values are case-sensitive and can be null.
//
// This member is required.
Value *string
noSmithyDocumentSerde
}
// The description of the Time to Live (TTL) status on the specified table.
type TimeToLiveDescription struct {
// The name of the TTL attribute for items in the table.
AttributeName *string
// The TTL status for the table.
TimeToLiveStatus TimeToLiveStatus
noSmithyDocumentSerde
}
// Represents the settings used to enable or disable Time to Live (TTL) for the
// specified table.
type TimeToLiveSpecification struct {
// The name of the TTL attribute used to store the expiration time for items in
// the table.
//
// This member is required.
AttributeName *string
// Indicates whether TTL is to be enabled (true) or disabled (false) on the table.
//
// This member is required.
Enabled *bool
noSmithyDocumentSerde
}
// Specifies an item to be retrieved as part of the transaction.
type TransactGetItem struct {
// Contains the primary key that identifies the item to get, together with the
// name of the table that contains the item, and optionally the specific attributes
// of the item to retrieve.
//
// This member is required.
Get *Get
noSmithyDocumentSerde
}
// A list of requests that can perform update, put, delete, or check operations on
// multiple items in one or more tables atomically.
type TransactWriteItem struct {
// A request to perform a check item operation.
ConditionCheck *ConditionCheck
// A request to perform a DeleteItem operation.
Delete *Delete
// A request to perform a PutItem operation.
Put *Put
// A request to perform an UpdateItem operation.
Update *Update
noSmithyDocumentSerde
}
// Represents a request to perform an UpdateItem operation.
type Update struct {
// The primary key of the item to be updated. Each element consists of an
// attribute name and a value for that attribute.
//
// This member is required.
Key map[string]AttributeValue
// Name of the table for the UpdateItem request.
//
// This member is required.
TableName *string
// An expression that defines one or more attributes to be updated, the action to
// be performed on them, and new value(s) for them.
//
// This member is required.
UpdateExpression *string
// A condition that must be satisfied in order for a conditional update to succeed.
ConditionExpression *string
// One or more substitution tokens for attribute names in an expression.
ExpressionAttributeNames map[string]string
// One or more values that can be substituted in an expression.
ExpressionAttributeValues map[string]AttributeValue
// Use ReturnValuesOnConditionCheckFailure to get the item attributes if the Update
// condition fails. For ReturnValuesOnConditionCheckFailure , the valid values are:
// NONE and ALL_OLD.
ReturnValuesOnConditionCheckFailure ReturnValuesOnConditionCheckFailure
noSmithyDocumentSerde
}
// Represents the new provisioned throughput settings to be applied to a global
// secondary index.
type UpdateGlobalSecondaryIndexAction struct {
// The name of the global secondary index to be updated.
//
// This member is required.
IndexName *string
// Represents the provisioned throughput settings for the specified global
// secondary index. For current minimum and maximum provisioned throughput values,
// see Service, Account, and Table Quotas (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Limits.html)
// in the Amazon DynamoDB Developer Guide.
//
// This member is required.
ProvisionedThroughput *ProvisionedThroughput
noSmithyDocumentSerde
}
// Represents a replica to be modified.
type UpdateReplicationGroupMemberAction struct {
// The Region where the replica exists.
//
// This member is required.
RegionName *string
// Replica-specific global secondary index settings.
GlobalSecondaryIndexes []ReplicaGlobalSecondaryIndex
// The KMS key of the replica that should be used for KMS encryption. To specify a
// key, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. Note
// that you should only provide this parameter if the key is different from the
// default DynamoDB KMS key alias/aws/dynamodb .
KMSMasterKeyId *string
// Replica-specific provisioned throughput. If not specified, uses the source
// table's provisioned throughput settings.
ProvisionedThroughputOverride *ProvisionedThroughputOverride
// Replica-specific table class. If not specified, uses the source table's table
// class.
TableClassOverride TableClass
noSmithyDocumentSerde
}
// Represents an operation to perform - either DeleteItem or PutItem . You can only
// request one of these operations, not both, in a single WriteRequest . If you do
// need to perform both of these operations, you need to provide two separate
// WriteRequest objects.
type WriteRequest struct {
// A request to perform a DeleteItem operation.
DeleteRequest *DeleteRequest
// A request to perform a PutItem operation.
PutRequest *PutRequest
noSmithyDocumentSerde
}
type noSmithyDocumentSerde = smithydocument.NoSerde
// UnknownUnionMember is returned when a union member is returned over the wire,
// but has an unknown tag.
type UnknownUnionMember struct {
Tag string
Value []byte
noSmithyDocumentSerde
}
func (*UnknownUnionMember) isAttributeValue() {}
|