1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325 2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 2338 2339 2340 2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 2372 2373 2374 2375 2376 2377 2378 2379 2380 2381 2382 2383 2384 2385 2386 2387 2388 2389 2390 2391 2392 2393 2394 2395 2396 2397 2398 2399 2400 2401 2402 2403 2404 2405 2406 2407 2408 2409 2410 2411 2412 2413 2414 2415 2416 2417 2418 2419 2420 2421 2422 2423 2424 2425 2426 2427 2428 2429 2430 2431 2432 2433 2434 2435 2436 2437 2438 2439 2440 2441 2442 2443 2444 2445 2446 2447 2448 2449 2450 2451 2452 2453 2454 2455 2456 2457 2458 2459 2460 2461 2462 2463 2464 2465 2466 2467 2468 2469 2470 2471 2472 2473 2474 2475 2476 2477 2478 2479 2480 2481 2482 2483 2484 2485 2486 2487 2488 2489 2490 2491 2492 2493 2494 2495 2496 2497 2498 2499 2500 2501 2502 2503 2504 2505 2506 2507 2508 2509 2510 2511 2512 2513 2514 2515 2516 2517 2518 2519 2520 2521 2522 2523 2524 2525 2526 2527 2528 2529 2530 2531 2532 2533 2534 2535 2536 2537 2538 2539 2540 2541 2542 2543 2544 2545 2546 2547 2548 2549 2550 2551 2552 2553 2554 2555 2556 2557 2558 2559 2560 2561 2562 2563 2564 2565 2566 2567 2568 2569 2570 2571 2572 2573 2574 2575 2576 2577 2578 2579 2580 2581 2582 2583 2584 2585 2586 2587 2588 2589 2590 2591 2592 2593 2594 2595 2596 2597 2598 2599 2600 2601 2602 2603 2604 2605 2606 2607 2608 2609 2610 2611 2612 2613 2614 2615 2616 2617 2618 2619 2620 2621 2622 2623 2624 2625 2626 2627 2628 2629 2630 2631 2632 2633 2634 2635 2636 2637 2638 2639 2640 2641 2642 2643 2644 2645 2646 2647 2648 2649 2650 2651 2652 2653 2654 2655 2656 2657 2658 2659 2660 2661 2662 2663 2664 2665 2666 2667 2668 2669 2670 2671 2672 2673 2674 2675 2676 2677 2678 2679 2680 2681 2682 2683 2684 2685 2686 2687 2688 2689 2690 2691 2692 2693 2694 2695 2696 2697 2698 2699 2700 2701 2702 2703 2704 2705 2706 2707 2708 2709 2710 2711 2712 2713 2714 2715 2716 2717 2718 2719 2720 2721 2722 2723 2724 2725 2726 2727 2728 2729 2730 2731 2732 2733 2734 2735 2736 2737 2738 2739 2740 2741 2742 2743 2744 2745 2746 2747 2748 2749 2750 2751 2752 2753 2754 2755 2756 2757 2758 2759 2760 2761 2762 2763 2764 2765 2766 2767 2768 2769 2770 2771 2772 2773 2774 2775 2776 2777 2778 2779 2780 2781 2782 2783 2784 2785 2786 2787 2788 2789 2790 2791 2792 2793 2794 2795 2796 2797 2798 2799 2800 2801 2802 2803 2804 2805 2806 2807 2808 2809 2810 2811 2812 2813 2814 2815 2816 2817 2818 2819 2820 2821 2822 2823 2824 2825 2826 2827 2828 2829 2830 2831 2832 2833 2834 2835 2836 2837 2838 2839 2840 2841 2842 2843 2844 2845 2846 2847 2848 2849 2850 2851 2852 2853 2854 2855 2856 2857 2858 2859 2860 2861 2862 2863 2864 2865 2866 2867 2868 2869 2870 2871 2872 2873 2874 2875 2876 2877 2878 2879 2880 2881 2882 2883 2884 2885 2886 2887 2888 2889 2890 2891 2892 2893 2894 2895 2896 2897 2898 2899 2900 2901 2902 2903 2904 2905 2906 2907 2908 2909 2910 2911 2912 2913 2914 2915 2916 2917 2918 2919 2920 2921 2922 2923 2924 2925 2926 2927 2928 2929 2930 2931 2932 2933 2934 2935 2936 2937 2938 2939 2940 2941 2942 2943 2944 2945 2946 2947 2948 2949 2950 2951 2952 2953 2954 2955 2956 2957 2958 2959 2960 2961 2962 2963 2964 2965 2966 2967 2968 2969 2970 2971 2972 2973 2974 2975 2976 2977 2978 2979 2980 2981 2982 2983 2984 2985 2986 2987 2988 2989 2990 2991 2992 2993 2994 2995 2996 2997 2998 2999 3000 3001 3002 3003 3004 3005 3006 3007 3008 3009 3010 3011 3012 3013 3014 3015 3016 3017 3018 3019 3020 3021 3022 3023 3024 3025 3026 3027 3028 3029 3030 3031 3032 3033 3034 3035 3036 3037 3038 3039 3040 3041 3042 3043 3044 3045 3046 3047 3048 3049 3050 3051 3052 3053 3054 3055 3056 3057 3058 3059 3060 3061 3062 3063 3064 3065 3066 3067 3068 3069 3070 3071 3072 3073 3074 3075 3076 3077 3078 3079 3080 3081 3082 3083 3084 3085 3086 3087 3088 3089 3090 3091 3092 3093 3094 3095 3096 3097 3098 3099 3100 3101 3102 3103 3104 3105 3106 3107 3108 3109 3110 3111 3112 3113 3114 3115 3116 3117 3118 3119 3120 3121 3122 3123 3124 3125 3126 3127 3128 3129 3130 3131 3132 3133 3134 3135 3136 3137 3138 3139 3140 3141 3142 3143 3144 3145 3146 3147 3148 3149 3150 3151 3152 3153 3154 3155 3156 3157 3158 3159 3160 3161 3162 3163 3164 3165 3166 3167 3168 3169 3170 3171 3172 3173 3174 3175 3176 3177 3178 3179 3180 3181 3182 3183 3184 3185 3186 3187 3188 3189 3190 3191 3192 3193 3194 3195 3196 3197 3198 3199 3200 3201 3202 3203 3204 3205 3206 3207 3208 3209 3210 3211 3212 3213 3214 3215 3216 3217 3218 3219 3220 3221 3222 3223 3224 3225 3226 3227 3228 3229 3230 3231 3232 3233 3234 3235 3236 3237 3238 3239 3240 3241 3242 3243 3244 3245 3246 3247 3248 3249 3250 3251 3252 3253 3254 3255 3256 3257 3258 3259 3260 3261 3262 3263 3264 3265 3266 3267 3268
|
// Code generated by smithy-go-codegen DO NOT EDIT.
package types
import (
smithydocument "github.com/aws/smithy-go/document"
"time"
)
// The Amazon QuickSight customizations associated with your Amazon Web Services
// account or a QuickSight namespace in a specific Amazon Web Services Region.
type AccountCustomization struct {
// The default email customization template.
DefaultEmailCustomizationTemplate *string
// The default theme for this Amazon QuickSight subscription.
DefaultTheme *string
noSmithyDocumentSerde
}
// A structure that contains the following account information elements:
//
// * Your
// Amazon QuickSight account name.
//
// * The edition of Amazon QuickSight that your
// account is using.
//
// * The notification email address that is associated with the
// Amazon QuickSight account.
//
// * The authentication type of the Amazon QuickSight
// account.
//
// * The status of the Amazon QuickSight account's subscription.
type AccountInfo struct {
// The account name that you provided for the Amazon QuickSight subscription in
// your Amazon Web Services account. You create this name when you sign up for
// Amazon QuickSight. It's unique over all of Amazon Web Services, and it appears
// only when users sign in.
AccountName *string
// The status of your account subscription.
AccountSubscriptionStatus *string
// The way that your Amazon QuickSight account is authenticated.
AuthenticationType *string
// The edition of your Amazon QuickSight account.
Edition Edition
// The email address that will be used for Amazon QuickSight to send notifications
// regarding your Amazon Web Services account or Amazon QuickSight subscription.
NotificationEmail *string
noSmithyDocumentSerde
}
// The Amazon QuickSight settings associated with your Amazon Web Services account.
type AccountSettings struct {
// The "account name" you provided for the Amazon QuickSight subscription in your
// Amazon Web Services account. You create this name when you sign up for Amazon
// QuickSight. It is unique in all of Amazon Web Services and it appears only when
// users sign in.
AccountName *string
// The default Amazon QuickSight namespace for your Amazon Web Services account.
DefaultNamespace *string
// The edition of Amazon QuickSight that you're currently subscribed to: Enterprise
// edition or Standard edition.
Edition Edition
// The main notification email for your Amazon QuickSight subscription.
NotificationEmail *string
// A Boolean value that indicates whether public sharing is turned on for an Amazon
// QuickSight account. For more information about turning on public sharing, see
// UpdatePublicSharingSettings
// (https://docs.aws.amazon.com/quicksight/latest/APIReference/API_UpdatePublicSharingSettings.html).
PublicSharingEnabled bool
noSmithyDocumentSerde
}
// The active Identity and Access Management (IAM) policy assignment.
type ActiveIAMPolicyAssignment struct {
// A name for the IAM policy assignment.
AssignmentName *string
// The Amazon Resource Name (ARN) of the resource.
PolicyArn *string
noSmithyDocumentSerde
}
// An ad hoc (one-time) filtering option.
type AdHocFilteringOption struct {
// Availability status.
AvailabilityStatus DashboardBehavior
noSmithyDocumentSerde
}
// The parameters for OpenSearch.
type AmazonElasticsearchParameters struct {
// The OpenSearch domain.
//
// This member is required.
Domain *string
noSmithyDocumentSerde
}
// The parameters for OpenSearch.
type AmazonOpenSearchParameters struct {
// The OpenSearch domain.
//
// This member is required.
Domain *string
noSmithyDocumentSerde
}
// Metadata structure for an analysis in Amazon QuickSight
type Analysis struct {
// The ID of the analysis.
AnalysisId *string
// The Amazon Resource Name (ARN) of the analysis.
Arn *string
// The time that the analysis was created.
CreatedTime *time.Time
// The ARNs of the datasets of the analysis.
DataSetArns []string
// Errors associated with the analysis.
Errors []AnalysisError
// The time that the analysis was last updated.
LastUpdatedTime *time.Time
// The descriptive name of the analysis.
Name *string
// A list of the associated sheets with the unique identifier and name of each
// sheet.
Sheets []Sheet
// Status associated with the analysis.
Status ResourceStatus
// The ARN of the theme of the analysis.
ThemeArn *string
noSmithyDocumentSerde
}
// Analysis error.
type AnalysisError struct {
// The message associated with the analysis error.
Message *string
// The type of the analysis error.
Type AnalysisErrorType
noSmithyDocumentSerde
}
// A filter that you apply when searching for one or more analyses.
type AnalysisSearchFilter struct {
// The name of the value that you want to use as a filter, for example "Name":
// "QUICKSIGHT_USER".
Name AnalysisFilterAttribute
// The comparison operator that you want to use as a filter, for example
// "Operator": "StringEquals".
Operator FilterOperator
// The value of the named item, in this case QUICKSIGHT_USER, that you want to use
// as a filter, for example "Value". An example is
// "arn:aws:quicksight:us-east-1:1:user/default/UserName1".
Value *string
noSmithyDocumentSerde
}
// The source entity of an analysis.
type AnalysisSourceEntity struct {
// The source template for the source entity of the analysis.
SourceTemplate *AnalysisSourceTemplate
noSmithyDocumentSerde
}
// The source template of an analysis.
type AnalysisSourceTemplate struct {
// The Amazon Resource Name (ARN) of the source template of an analysis.
//
// This member is required.
Arn *string
// The dataset references of the source template of an analysis.
//
// This member is required.
DataSetReferences []DataSetReference
noSmithyDocumentSerde
}
// The summary metadata that describes an analysis.
type AnalysisSummary struct {
// The ID of the analysis. This ID displays in the URL.
AnalysisId *string
// The Amazon Resource Name (ARN) for the analysis.
Arn *string
// The time that the analysis was created.
CreatedTime *time.Time
// The time that the analysis was last updated.
LastUpdatedTime *time.Time
// The name of the analysis. This name is displayed in the Amazon QuickSight
// console.
Name *string
// The last known status for the analysis.
Status ResourceStatus
noSmithyDocumentSerde
}
// Information about the dashboard that you want to embed.
type AnonymousUserDashboardEmbeddingConfiguration struct {
// The dashboard ID for the dashboard that you want the user to see first. This ID
// is included in the output URL. When the URL in response is accessed, Amazon
// QuickSight renders this dashboard. The Amazon Resource Name (ARN) of this
// dashboard must be included in the AuthorizedResourceArns parameter. Otherwise,
// the request will fail with InvalidParameterValueException.
//
// This member is required.
InitialDashboardId *string
noSmithyDocumentSerde
}
// The experience that you are embedding. You can use this object to generate a url
// that embeds a visual into your application.
type AnonymousUserDashboardVisualEmbeddingConfiguration struct {
// The visual ID for the visual that you want the user to see. This ID is included
// in the output URL. When the URL in response is accessed, Amazon QuickSight
// renders this visual. The Amazon Resource Name (ARN) of the dashboard that the
// visual belongs to must be included in the AuthorizedResourceArns parameter.
// Otherwise, the request will fail with InvalidParameterValueException.
//
// This member is required.
InitialDashboardVisualId *DashboardVisualId
noSmithyDocumentSerde
}
// The type of experience you want to embed. For anonymous users, you can embed
// Amazon QuickSight dashboards.
type AnonymousUserEmbeddingExperienceConfiguration struct {
// The type of embedding experience. In this case, Amazon QuickSight dashboards.
Dashboard *AnonymousUserDashboardEmbeddingConfiguration
// The type of embedding experience. In this case, Amazon QuickSight visuals.
DashboardVisual *AnonymousUserDashboardVisualEmbeddingConfiguration
noSmithyDocumentSerde
}
// Parameters for Amazon Athena.
type AthenaParameters struct {
// The workgroup that Amazon Athena uses.
WorkGroup *string
noSmithyDocumentSerde
}
// Parameters for Amazon Aurora.
type AuroraParameters struct {
// Database.
//
// This member is required.
Database *string
// Host.
//
// This member is required.
Host *string
// Port.
//
// This member is required.
Port int32
noSmithyDocumentSerde
}
// Parameters for Amazon Aurora PostgreSQL-Compatible Edition.
type AuroraPostgreSqlParameters struct {
// The Amazon Aurora PostgreSQL database to connect to.
//
// This member is required.
Database *string
// The Amazon Aurora PostgreSQL-Compatible host to connect to.
//
// This member is required.
Host *string
// The port that Amazon Aurora PostgreSQL is listening on.
//
// This member is required.
Port int32
noSmithyDocumentSerde
}
// The parameters for IoT Analytics.
type AwsIotAnalyticsParameters struct {
// Dataset name.
//
// This member is required.
DataSetName *string
noSmithyDocumentSerde
}
// The display options for tile borders for visuals.
type BorderStyle struct {
// The option to enable display of borders for visuals.
Show *bool
noSmithyDocumentSerde
}
// A calculated column for a dataset.
type CalculatedColumn struct {
// A unique ID to identify a calculated column. During a dataset update, if the
// column ID of a calculated column matches that of an existing calculated column,
// Amazon QuickSight preserves the existing calculated column.
//
// This member is required.
ColumnId *string
// Column name.
//
// This member is required.
ColumnName *string
// An expression that defines the calculated column.
//
// This member is required.
Expression *string
noSmithyDocumentSerde
}
// A transform operation that casts a column to a different type.
type CastColumnTypeOperation struct {
// Column name.
//
// This member is required.
ColumnName *string
// New column data type.
//
// This member is required.
NewColumnType ColumnDataType
// When casting a column from string to datetime type, you can supply a string in a
// format supported by Amazon QuickSight to denote the source data format.
Format *string
noSmithyDocumentSerde
}
// Metadata that contains a description for a column.
type ColumnDescription struct {
// The text of a description for a column.
Text *string
noSmithyDocumentSerde
}
// Groupings of columns that work together in certain Amazon QuickSight features.
// This is a variant type structure. For this structure to be valid, only one of
// the attributes can be non-null.
type ColumnGroup struct {
// Geospatial column group that denotes a hierarchy.
GeoSpatialColumnGroup *GeoSpatialColumnGroup
noSmithyDocumentSerde
}
// A structure describing the name, data type, and geographic role of the columns.
type ColumnGroupColumnSchema struct {
// The name of the column group's column schema.
Name *string
noSmithyDocumentSerde
}
// The column group schema.
type ColumnGroupSchema struct {
// A structure containing the list of schemas for column group columns.
ColumnGroupColumnSchemaList []ColumnGroupColumnSchema
// The name of the column group schema.
Name *string
noSmithyDocumentSerde
}
// A rule defined to grant access on one or more restricted columns. Each dataset
// can have multiple rules. To create a restricted column, you add it to one or
// more rules. Each rule must contain at least one column and at least one user or
// group. To be able to see a restricted column, a user or group needs to be added
// to a rule for that column.
type ColumnLevelPermissionRule struct {
// An array of column names.
ColumnNames []string
// An array of Amazon Resource Names (ARNs) for Amazon QuickSight users or groups.
Principals []string
noSmithyDocumentSerde
}
// The column schema.
type ColumnSchema struct {
// The data type of the column schema.
DataType *string
// The geographic role of the column schema.
GeographicRole *string
// The name of the column schema.
Name *string
noSmithyDocumentSerde
}
// A tag for a column in a TagColumnOperation
// (https://docs.aws.amazon.com/quicksight/latest/APIReference/API_TagColumnOperation.html)
// structure. This is a variant type structure. For this structure to be valid,
// only one of the attributes can be non-null.
type ColumnTag struct {
// A description for a column.
ColumnDescription *ColumnDescription
// A geospatial role for a column.
ColumnGeographicRole GeoSpatialDataRole
noSmithyDocumentSerde
}
// A transform operation that creates calculated columns. Columns created in one
// such operation form a lexical closure.
type CreateColumnsOperation struct {
// Calculated columns to create.
//
// This member is required.
Columns []CalculatedColumn
noSmithyDocumentSerde
}
// The combination of user name and password that are used as credentials.
type CredentialPair struct {
// Password.
//
// This member is required.
Password *string
// User name.
//
// This member is required.
Username *string
// A set of alternate data source parameters that you want to share for these
// credentials. The credentials are applied in tandem with the data source
// parameters when you copy a data source by using a create or update request. The
// API operation compares the DataSourceParameters structure that's in the request
// with the structures in the AlternateDataSourceParameters allow list. If the
// structures are an exact match, the request is allowed to use the new data source
// with the existing credentials. If the AlternateDataSourceParameters list is
// null, the DataSourceParameters originally used with these Credentials is
// automatically allowed.
AlternateDataSourceParameters []DataSourceParameters
noSmithyDocumentSerde
}
// A physical table type built from the results of the custom SQL query.
type CustomSql struct {
// The Amazon Resource Name (ARN) of the data source.
//
// This member is required.
DataSourceArn *string
// A display name for the SQL query result.
//
// This member is required.
Name *string
// The SQL query.
//
// This member is required.
SqlQuery *string
// The column schema from the SQL query result set.
Columns []InputColumn
noSmithyDocumentSerde
}
// Dashboard.
type Dashboard struct {
// The Amazon Resource Name (ARN) of the resource.
Arn *string
// The time that this dataset was created.
CreatedTime *time.Time
// Dashboard ID.
DashboardId *string
// The last time that this dataset was published.
LastPublishedTime *time.Time
// The last time that this dataset was updated.
LastUpdatedTime *time.Time
// A display name for the dashboard.
Name *string
// Version.
Version *DashboardVersion
noSmithyDocumentSerde
}
// Dashboard error.
type DashboardError struct {
// Message.
Message *string
// Type.
Type DashboardErrorType
noSmithyDocumentSerde
}
// Dashboard publish options.
type DashboardPublishOptions struct {
// Ad hoc (one-time) filtering option.
AdHocFilteringOption *AdHocFilteringOption
// Export to .csv option.
ExportToCSVOption *ExportToCSVOption
// Sheet controls option.
SheetControlsOption *SheetControlsOption
noSmithyDocumentSerde
}
// A filter that you apply when searching for dashboards.
type DashboardSearchFilter struct {
// The comparison operator that you want to use as a filter, for example,
// "Operator": "StringEquals".
//
// This member is required.
Operator FilterOperator
// The name of the value that you want to use as a filter, for example, "Name":
// "QUICKSIGHT_USER".
Name DashboardFilterAttribute
// The value of the named item, in this case QUICKSIGHT_USER, that you want to use
// as a filter, for example, "Value":
// "arn:aws:quicksight:us-east-1:1:user/default/UserName1".
Value *string
noSmithyDocumentSerde
}
// Dashboard source entity.
type DashboardSourceEntity struct {
// Source template.
SourceTemplate *DashboardSourceTemplate
noSmithyDocumentSerde
}
// Dashboard source template.
type DashboardSourceTemplate struct {
// The Amazon Resource Name (ARN) of the resource.
//
// This member is required.
Arn *string
// Dataset references.
//
// This member is required.
DataSetReferences []DataSetReference
noSmithyDocumentSerde
}
// Dashboard summary.
type DashboardSummary struct {
// The Amazon Resource Name (ARN) of the resource.
Arn *string
// The time that this dashboard was created.
CreatedTime *time.Time
// Dashboard ID.
DashboardId *string
// The last time that this dashboard was published.
LastPublishedTime *time.Time
// The last time that this dashboard was updated.
LastUpdatedTime *time.Time
// A display name for the dashboard.
Name *string
// Published version number.
PublishedVersionNumber *int64
noSmithyDocumentSerde
}
// Dashboard version.
type DashboardVersion struct {
// The Amazon Resource Name (ARN) of the resource.
Arn *string
// The time that this dashboard version was created.
CreatedTime *time.Time
// The Amazon Resource Numbers (ARNs) for the datasets that are associated with
// this version of the dashboard.
DataSetArns []string
// Description.
Description *string
// Errors associated with this dashboard version.
Errors []DashboardError
// A list of the associated sheets with the unique identifier and name of each
// sheet.
Sheets []Sheet
// Source entity ARN.
SourceEntityArn *string
// The HTTP status of the request.
Status ResourceStatus
// The ARN of the theme associated with a version of the dashboard.
ThemeArn *string
// Version number for this version of the dashboard.
VersionNumber *int64
noSmithyDocumentSerde
}
// Dashboard version summary.
type DashboardVersionSummary struct {
// The Amazon Resource Name (ARN) of the resource.
Arn *string
// The time that this dashboard version was created.
CreatedTime *time.Time
// Description.
Description *string
// Source entity ARN.
SourceEntityArn *string
// The HTTP status of the request.
Status ResourceStatus
// Version number.
VersionNumber *int64
noSmithyDocumentSerde
}
// A structure that contains the following elements:
//
// * The DashboardId of the
// dashboard that has the visual that you want to embed.
//
// * The SheetId of the
// sheet that has the visual that you want to embed.
//
// * The VisualId of the visual
// that you want to embed.
//
// The DashboardId, SheetId, and VisualId can be found in
// the IDs for developers section of the Embed visual pane of the visual's
// on-visual menu of the Amazon QuickSight console. You can also get the
// DashboardId with a ListDashboards API operation.
type DashboardVisualId struct {
// The ID of the dashboard that has the visual that you want to embed. The
// DashboardId can be found in the IDs for developers section of the Embed visual
// pane of the visual's on-visual menu of the Amazon QuickSight console. You can
// also get the DashboardId with a ListDashboards API operation.
//
// This member is required.
DashboardId *string
// The ID of the sheet that the has visual that you want to embed. The SheetId can
// be found in the IDs for developers section of the Embed visual pane of the
// visual's on-visual menu of the Amazon QuickSight console.
//
// This member is required.
SheetId *string
// The ID of the visual that you want to embed. The VisualID can be found in the
// IDs for developers section of the Embed visual pane of the visual's on-visual
// menu of the Amazon QuickSight console.
//
// This member is required.
VisualId *string
noSmithyDocumentSerde
}
// The theme colors that are used for data colors in charts. The colors description
// is a hexadecimal color code that consists of six alphanumerical characters,
// prefixed with #, for example #37BFF5.
type DataColorPalette struct {
// The hexadecimal codes for the colors.
Colors []string
// The hexadecimal code of a color that applies to charts where a lack of data is
// highlighted.
EmptyFillColor *string
// The minimum and maximum hexadecimal codes that describe a color gradient.
MinMaxGradient []string
noSmithyDocumentSerde
}
// Dataset.
type DataSet struct {
// The Amazon Resource Name (ARN) of the resource.
Arn *string
// Groupings of columns that work together in certain Amazon QuickSight features.
// Currently, only geospatial hierarchy is supported.
ColumnGroups []ColumnGroup
// A set of one or more definitions of a ColumnLevelPermissionRule
// (https://docs.aws.amazon.com/quicksight/latest/APIReference/API_ColumnLevelPermissionRule.html).
ColumnLevelPermissionRules []ColumnLevelPermissionRule
// The amount of SPICE capacity used by this dataset. This is 0 if the dataset
// isn't imported into SPICE.
ConsumedSpiceCapacityInBytes int64
// The time that this dataset was created.
CreatedTime *time.Time
// The ID of the dataset.
DataSetId *string
// The usage configuration to apply to child datasets that reference this dataset
// as a source.
DataSetUsageConfiguration *DataSetUsageConfiguration
// The folder that contains fields and nested subfolders for your dataset.
FieldFolders map[string]FieldFolder
// A value that indicates whether you want to import the data into SPICE.
ImportMode DataSetImportMode
// The last time that this dataset was updated.
LastUpdatedTime *time.Time
// Configures the combination and transformation of the data from the physical
// tables.
LogicalTableMap map[string]LogicalTable
// A display name for the dataset.
Name *string
// The list of columns after all transforms. These columns are available in
// templates, analyses, and dashboards.
OutputColumns []OutputColumn
// Declares the physical tables that are available in the underlying data sources.
PhysicalTableMap map[string]PhysicalTable
// The row-level security configuration for the dataset.
RowLevelPermissionDataSet *RowLevelPermissionDataSet
// The element you can use to define tags for row-level security.
RowLevelPermissionTagConfiguration *RowLevelPermissionTagConfiguration
noSmithyDocumentSerde
}
// Dataset configuration.
type DataSetConfiguration struct {
// A structure containing the list of column group schemas.
ColumnGroupSchemaList []ColumnGroupSchema
// Dataset schema.
DataSetSchema *DataSetSchema
// Placeholder.
Placeholder *string
noSmithyDocumentSerde
}
// Dataset reference.
type DataSetReference struct {
// Dataset Amazon Resource Name (ARN).
//
// This member is required.
DataSetArn *string
// Dataset placeholder.
//
// This member is required.
DataSetPlaceholder *string
noSmithyDocumentSerde
}
// Dataset schema.
type DataSetSchema struct {
// A structure containing the list of column schemas.
ColumnSchemaList []ColumnSchema
noSmithyDocumentSerde
}
// Dataset summary.
type DataSetSummary struct {
// The Amazon Resource Name (ARN) of the dataset.
Arn *string
// A value that indicates if the dataset has column level permission configured.
ColumnLevelPermissionRulesApplied bool
// The time that this dataset was created.
CreatedTime *time.Time
// The ID of the dataset.
DataSetId *string
// A value that indicates whether you want to import the data into SPICE.
ImportMode DataSetImportMode
// The last time that this dataset was updated.
LastUpdatedTime *time.Time
// A display name for the dataset.
Name *string
// The row-level security configuration for the dataset.
RowLevelPermissionDataSet *RowLevelPermissionDataSet
// Whether or not the row level permission tags are applied.
RowLevelPermissionTagConfigurationApplied bool
noSmithyDocumentSerde
}
// The usage configuration to apply to child datasets that reference this dataset
// as a source.
type DataSetUsageConfiguration struct {
// An option that controls whether a child dataset of a direct query can use this
// dataset as a source.
DisableUseAsDirectQuerySource bool
// An option that controls whether a child dataset that's stored in QuickSight can
// use this dataset as a source.
DisableUseAsImportedSource bool
noSmithyDocumentSerde
}
// The structure of a data source.
type DataSource struct {
// A set of alternate data source parameters that you want to share for the
// credentials stored with this data source. The credentials are applied in tandem
// with the data source parameters when you copy a data source by using a create or
// update request. The API operation compares the DataSourceParameters structure
// that's in the request with the structures in the AlternateDataSourceParameters
// allow list. If the structures are an exact match, the request is allowed to use
// the credentials from this existing data source. If the
// AlternateDataSourceParameters list is null, the Credentials originally used with
// this DataSourceParameters are automatically allowed.
AlternateDataSourceParameters []DataSourceParameters
// The Amazon Resource Name (ARN) of the data source.
Arn *string
// The time that this data source was created.
CreatedTime *time.Time
// The ID of the data source. This ID is unique per Amazon Web Services Region for
// each Amazon Web Services account.
DataSourceId *string
// The parameters that Amazon QuickSight uses to connect to your underlying source.
// This is a variant type structure. For this structure to be valid, only one of
// the attributes can be non-null.
DataSourceParameters DataSourceParameters
// Error information from the last update or the creation of the data source.
ErrorInfo *DataSourceErrorInfo
// The last time that this data source was updated.
LastUpdatedTime *time.Time
// A display name for the data source.
Name *string
// The Amazon Resource Name (ARN) of the secret associated with the data source in
// Amazon Secrets Manager.
SecretArn *string
// Secure Socket Layer (SSL) properties that apply when Amazon QuickSight connects
// to your underlying source.
SslProperties *SslProperties
// The HTTP status of the request.
Status ResourceStatus
// The type of the data source. This type indicates which database engine the data
// source connects to.
Type DataSourceType
// The VPC connection information. You need to use this parameter only when you
// want Amazon QuickSight to use a VPC connection when connecting to your
// underlying source.
VpcConnectionProperties *VpcConnectionProperties
noSmithyDocumentSerde
}
// Data source credentials. This is a variant type structure. For this structure to
// be valid, only one of the attributes can be non-null.
type DataSourceCredentials struct {
// The Amazon Resource Name (ARN) of a data source that has the credential pair
// that you want to use. When CopySourceArn is not null, the credential pair from
// the data source in the ARN is used as the credentials for the
// DataSourceCredentials structure.
CopySourceArn *string
// Credential pair. For more information, see CredentialPair
// (https://docs.aws.amazon.com/quicksight/latest/APIReference/API_CredentialPair.html).
CredentialPair *CredentialPair
// The Amazon Resource Name (ARN) of the secret associated with the data source in
// Amazon Secrets Manager.
SecretArn *string
noSmithyDocumentSerde
}
// Error information for the data source creation or update.
type DataSourceErrorInfo struct {
// Error message.
Message *string
// Error type.
Type DataSourceErrorInfoType
noSmithyDocumentSerde
}
// The parameters that Amazon QuickSight uses to connect to your underlying data
// source. This is a variant type structure. For this structure to be valid, only
// one of the attributes can be non-null.
//
// The following types satisfy this interface:
//
// DataSourceParametersMemberAmazonElasticsearchParameters
// DataSourceParametersMemberAmazonOpenSearchParameters
// DataSourceParametersMemberAthenaParameters
// DataSourceParametersMemberAuroraParameters
// DataSourceParametersMemberAuroraPostgreSqlParameters
// DataSourceParametersMemberAwsIotAnalyticsParameters
// DataSourceParametersMemberExasolParameters
// DataSourceParametersMemberJiraParameters
// DataSourceParametersMemberMariaDbParameters
// DataSourceParametersMemberMySqlParameters
// DataSourceParametersMemberOracleParameters
// DataSourceParametersMemberPostgreSqlParameters
// DataSourceParametersMemberPrestoParameters
// DataSourceParametersMemberRdsParameters
// DataSourceParametersMemberRedshiftParameters
// DataSourceParametersMemberS3Parameters
// DataSourceParametersMemberServiceNowParameters
// DataSourceParametersMemberSnowflakeParameters
// DataSourceParametersMemberSparkParameters
// DataSourceParametersMemberSqlServerParameters
// DataSourceParametersMemberTeradataParameters
// DataSourceParametersMemberTwitterParameters
type DataSourceParameters interface {
isDataSourceParameters()
}
// The parameters for OpenSearch.
type DataSourceParametersMemberAmazonElasticsearchParameters struct {
Value AmazonElasticsearchParameters
noSmithyDocumentSerde
}
func (*DataSourceParametersMemberAmazonElasticsearchParameters) isDataSourceParameters() {}
// The parameters for OpenSearch.
type DataSourceParametersMemberAmazonOpenSearchParameters struct {
Value AmazonOpenSearchParameters
noSmithyDocumentSerde
}
func (*DataSourceParametersMemberAmazonOpenSearchParameters) isDataSourceParameters() {}
// The parameters for Amazon Athena.
type DataSourceParametersMemberAthenaParameters struct {
Value AthenaParameters
noSmithyDocumentSerde
}
func (*DataSourceParametersMemberAthenaParameters) isDataSourceParameters() {}
// The parameters for Amazon Aurora MySQL.
type DataSourceParametersMemberAuroraParameters struct {
Value AuroraParameters
noSmithyDocumentSerde
}
func (*DataSourceParametersMemberAuroraParameters) isDataSourceParameters() {}
// The parameters for Amazon Aurora.
type DataSourceParametersMemberAuroraPostgreSqlParameters struct {
Value AuroraPostgreSqlParameters
noSmithyDocumentSerde
}
func (*DataSourceParametersMemberAuroraPostgreSqlParameters) isDataSourceParameters() {}
// The parameters for IoT Analytics.
type DataSourceParametersMemberAwsIotAnalyticsParameters struct {
Value AwsIotAnalyticsParameters
noSmithyDocumentSerde
}
func (*DataSourceParametersMemberAwsIotAnalyticsParameters) isDataSourceParameters() {}
// The parameters for Exasol.
type DataSourceParametersMemberExasolParameters struct {
Value ExasolParameters
noSmithyDocumentSerde
}
func (*DataSourceParametersMemberExasolParameters) isDataSourceParameters() {}
// The parameters for Jira.
type DataSourceParametersMemberJiraParameters struct {
Value JiraParameters
noSmithyDocumentSerde
}
func (*DataSourceParametersMemberJiraParameters) isDataSourceParameters() {}
// The parameters for MariaDB.
type DataSourceParametersMemberMariaDbParameters struct {
Value MariaDbParameters
noSmithyDocumentSerde
}
func (*DataSourceParametersMemberMariaDbParameters) isDataSourceParameters() {}
// The parameters for MySQL.
type DataSourceParametersMemberMySqlParameters struct {
Value MySqlParameters
noSmithyDocumentSerde
}
func (*DataSourceParametersMemberMySqlParameters) isDataSourceParameters() {}
// The parameters for Oracle.
type DataSourceParametersMemberOracleParameters struct {
Value OracleParameters
noSmithyDocumentSerde
}
func (*DataSourceParametersMemberOracleParameters) isDataSourceParameters() {}
// The parameters for PostgreSQL.
type DataSourceParametersMemberPostgreSqlParameters struct {
Value PostgreSqlParameters
noSmithyDocumentSerde
}
func (*DataSourceParametersMemberPostgreSqlParameters) isDataSourceParameters() {}
// The parameters for Presto.
type DataSourceParametersMemberPrestoParameters struct {
Value PrestoParameters
noSmithyDocumentSerde
}
func (*DataSourceParametersMemberPrestoParameters) isDataSourceParameters() {}
// The parameters for Amazon RDS.
type DataSourceParametersMemberRdsParameters struct {
Value RdsParameters
noSmithyDocumentSerde
}
func (*DataSourceParametersMemberRdsParameters) isDataSourceParameters() {}
// The parameters for Amazon Redshift.
type DataSourceParametersMemberRedshiftParameters struct {
Value RedshiftParameters
noSmithyDocumentSerde
}
func (*DataSourceParametersMemberRedshiftParameters) isDataSourceParameters() {}
// The parameters for S3.
type DataSourceParametersMemberS3Parameters struct {
Value S3Parameters
noSmithyDocumentSerde
}
func (*DataSourceParametersMemberS3Parameters) isDataSourceParameters() {}
// The parameters for ServiceNow.
type DataSourceParametersMemberServiceNowParameters struct {
Value ServiceNowParameters
noSmithyDocumentSerde
}
func (*DataSourceParametersMemberServiceNowParameters) isDataSourceParameters() {}
// The parameters for Snowflake.
type DataSourceParametersMemberSnowflakeParameters struct {
Value SnowflakeParameters
noSmithyDocumentSerde
}
func (*DataSourceParametersMemberSnowflakeParameters) isDataSourceParameters() {}
// The parameters for Spark.
type DataSourceParametersMemberSparkParameters struct {
Value SparkParameters
noSmithyDocumentSerde
}
func (*DataSourceParametersMemberSparkParameters) isDataSourceParameters() {}
// The parameters for SQL Server.
type DataSourceParametersMemberSqlServerParameters struct {
Value SqlServerParameters
noSmithyDocumentSerde
}
func (*DataSourceParametersMemberSqlServerParameters) isDataSourceParameters() {}
// The parameters for Teradata.
type DataSourceParametersMemberTeradataParameters struct {
Value TeradataParameters
noSmithyDocumentSerde
}
func (*DataSourceParametersMemberTeradataParameters) isDataSourceParameters() {}
// The parameters for Twitter.
type DataSourceParametersMemberTwitterParameters struct {
Value TwitterParameters
noSmithyDocumentSerde
}
func (*DataSourceParametersMemberTwitterParameters) isDataSourceParameters() {}
// A date-time parameter.
type DateTimeParameter struct {
// A display name for the date-time parameter.
//
// This member is required.
Name *string
// The values for the date-time parameter.
//
// This member is required.
Values []time.Time
noSmithyDocumentSerde
}
// A decimal parameter.
type DecimalParameter struct {
// A display name for the decimal parameter.
//
// This member is required.
Name *string
// The values for the decimal parameter.
//
// This member is required.
Values []float64
noSmithyDocumentSerde
}
// Error information for the SPICE ingestion of a dataset.
type ErrorInfo struct {
// Error message.
Message *string
// Error type.
Type IngestionErrorType
noSmithyDocumentSerde
}
// The required parameters for connecting to an Exasol data source.
type ExasolParameters struct {
// The hostname or IP address of the Exasol data source.
//
// This member is required.
Host *string
// The port for the Exasol data source.
//
// This member is required.
Port int32
noSmithyDocumentSerde
}
// Export to .csv option.
type ExportToCSVOption struct {
// Availability status.
AvailabilityStatus DashboardBehavior
noSmithyDocumentSerde
}
// A FieldFolder element is a folder that contains fields and nested subfolders.
type FieldFolder struct {
// A folder has a list of columns. A column can only be in one folder.
Columns []string
// The description for a field folder.
Description *string
noSmithyDocumentSerde
}
// A transform operation that filters rows based on a condition.
type FilterOperation struct {
// An expression that must evaluate to a Boolean value. Rows for which the
// expression evaluates to true are kept in the dataset.
//
// This member is required.
ConditionExpression *string
noSmithyDocumentSerde
}
// A folder in Amazon QuickSight.
type Folder struct {
// The Amazon Resource Name (ARN) for the folder.
Arn *string
// The time that the folder was created.
CreatedTime *time.Time
// The ID of the folder.
FolderId *string
// An array of ancestor ARN strings for the folder.
FolderPath []string
// The type of folder it is.
FolderType FolderType
// The time that the folder was last updated.
LastUpdatedTime *time.Time
// A display name for the folder.
Name *string
noSmithyDocumentSerde
}
// An asset in a Amazon QuickSight folder, such as a dashboard, analysis, or
// dataset.
type FolderMember struct {
// The ID of an asset in the folder.
MemberId *string
// The type of asset that it is.
MemberType MemberType
noSmithyDocumentSerde
}
// A filter to use to search a Amazon QuickSight folder.
type FolderSearchFilter struct {
// The name of a value that you want to use in the filter. For example, "Name":
// "PARENT_FOLDER_ARN".
Name FolderFilterAttribute
// The comparison operator that you want to use in the filter. For example,
// "Operator": "StringEquals".
Operator FilterOperator
// The value of the named item (in this example, PARENT_FOLDER_ARN), that you want
// to use as a filter. For example, "Value":
// "arn:aws:quicksight:us-east-1:1:folder/folderId".
Value *string
noSmithyDocumentSerde
}
// A summary of information about an existing Amazon QuickSight folder.
type FolderSummary struct {
// The Amazon Resource Name (ARN) of the folder.
Arn *string
// The time that the folder was created.
CreatedTime *time.Time
// The ID of the folder.
FolderId *string
// The type of folder.
FolderType FolderType
// The time that the folder was last updated.
LastUpdatedTime *time.Time
// The display name of the folder.
Name *string
noSmithyDocumentSerde
}
// Geospatial column group that denotes a hierarchy.
type GeoSpatialColumnGroup struct {
// Columns in this hierarchy.
//
// This member is required.
Columns []string
// A display name for the hierarchy.
//
// This member is required.
Name *string
// Country code.
CountryCode GeoSpatialCountryCode
noSmithyDocumentSerde
}
// A group in Amazon QuickSight consists of a set of users. You can use groups to
// make it easier to manage access and security.
type Group struct {
// The Amazon Resource Name (ARN) for the group.
Arn *string
// The group description.
Description *string
// The name of the group.
GroupName *string
// The principal ID of the group.
PrincipalId *string
noSmithyDocumentSerde
}
// A member of an Amazon QuickSight group. Currently, group members must be users.
// Groups can't be members of another group. .
type GroupMember struct {
// The Amazon Resource Name (ARN) for the group member (user).
Arn *string
// The name of the group member (user).
MemberName *string
noSmithyDocumentSerde
}
// A GroupSearchFilter object that you want to apply to your search.
type GroupSearchFilter struct {
// The name of the value that you want to use as a filter, for example "Name":
// "GROUP_NAME". Currently, the only supported name is GROUP_NAME.
//
// This member is required.
Name GroupFilterAttribute
// The comparison operator that you want to use as a filter, for example
// "Operator": "StartsWith". Currently, the only supported operator is StartsWith.
//
// This member is required.
Operator GroupFilterOperator
// The value of the named item, in this case GROUP_NAME, that you want to use as a
// filter.
//
// This member is required.
Value *string
noSmithyDocumentSerde
}
// The display options for gutter spacing between tiles on a sheet.
type GutterStyle struct {
// This Boolean value controls whether to display a gutter space between sheet
// tiles.
Show *bool
noSmithyDocumentSerde
}
// An Identity and Access Management (IAM) policy assignment.
type IAMPolicyAssignment struct {
// Assignment ID.
AssignmentId *string
// Assignment name.
AssignmentName *string
// Assignment status.
AssignmentStatus AssignmentStatus
// The Amazon Web Services account ID.
AwsAccountId *string
// Identities.
Identities map[string][]string
// The Amazon Resource Name (ARN) for the IAM policy.
PolicyArn *string
noSmithyDocumentSerde
}
// IAM policy assignment summary.
type IAMPolicyAssignmentSummary struct {
// Assignment name.
AssignmentName *string
// Assignment status.
AssignmentStatus AssignmentStatus
noSmithyDocumentSerde
}
// Information about the SPICE ingestion for a dataset.
type Ingestion struct {
// The Amazon Resource Name (ARN) of the resource.
//
// This member is required.
Arn *string
// The time that this ingestion started.
//
// This member is required.
CreatedTime *time.Time
// Ingestion status.
//
// This member is required.
IngestionStatus IngestionStatus
// Error information for this ingestion.
ErrorInfo *ErrorInfo
// Ingestion ID.
IngestionId *string
// The size of the data ingested, in bytes.
IngestionSizeInBytes *int64
// The time that this ingestion took, measured in seconds.
IngestionTimeInSeconds *int64
// Information about a queued dataset SPICE ingestion.
QueueInfo *QueueInfo
// Event source for this ingestion.
RequestSource IngestionRequestSource
// Type of this ingestion.
RequestType IngestionRequestType
// Information about rows for a data set SPICE ingestion.
RowInfo *RowInfo
noSmithyDocumentSerde
}
// Metadata for a column that is used as the input of a transform operation.
type InputColumn struct {
// The name of this column in the underlying data source.
//
// This member is required.
Name *string
// The data type of the column.
//
// This member is required.
Type InputColumnDataType
noSmithyDocumentSerde
}
// An integer parameter.
type IntegerParameter struct {
// The name of the integer parameter.
//
// This member is required.
Name *string
// The values for the integer parameter.
//
// This member is required.
Values []int64
noSmithyDocumentSerde
}
// The parameters for Jira.
type JiraParameters struct {
// The base URL of the Jira site.
//
// This member is required.
SiteBaseUrl *string
noSmithyDocumentSerde
}
// The instructions associated with a join.
type JoinInstruction struct {
// The operand on the left side of a join.
//
// This member is required.
LeftOperand *string
// The join instructions provided in the ON clause of a join.
//
// This member is required.
OnClause *string
// The operand on the right side of a join.
//
// This member is required.
RightOperand *string
// The type of join that it is.
//
// This member is required.
Type JoinType
// Join key properties of the left operand.
LeftJoinKeyProperties *JoinKeyProperties
// Join key properties of the right operand.
RightJoinKeyProperties *JoinKeyProperties
noSmithyDocumentSerde
}
// Properties associated with the columns participating in a join.
type JoinKeyProperties struct {
// A value that indicates that a row in a table is uniquely identified by the
// columns in a join key. This is used by Amazon QuickSight to optimize query
// performance.
UniqueKey *bool
noSmithyDocumentSerde
}
// A structure that contains the configuration of a shareable link to the
// dashboard.
type LinkSharingConfiguration struct {
// A structure that contains the permissions of a shareable link.
Permissions []ResourcePermission
noSmithyDocumentSerde
}
// A logical table is a unit that joins and that data transformations operate on. A
// logical table has a source, which can be either a physical table or result of a
// join. When a logical table points to a physical table, the logical table acts as
// a mutable copy of that physical table through transform operations.
type LogicalTable struct {
// A display name for the logical table.
//
// This member is required.
Alias *string
// Source of this logical table.
//
// This member is required.
Source *LogicalTableSource
// Transform operations that act on this logical table.
DataTransforms []TransformOperation
noSmithyDocumentSerde
}
// Information about the source of a logical table. This is a variant type
// structure. For this structure to be valid, only one of the attributes can be
// non-null.
type LogicalTableSource struct {
// The Amazon Resource Number (ARN) of the parent dataset.
DataSetArn *string
// Specifies the result of a join of two logical tables.
JoinInstruction *JoinInstruction
// Physical table ID.
PhysicalTableId *string
noSmithyDocumentSerde
}
// Amazon S3 manifest file location.
type ManifestFileLocation struct {
// Amazon S3 bucket.
//
// This member is required.
Bucket *string
// Amazon S3 key that identifies an object.
//
// This member is required.
Key *string
noSmithyDocumentSerde
}
// The display options for margins around the outside edge of sheets.
type MarginStyle struct {
// This Boolean value controls whether to display sheet margins.
Show *bool
noSmithyDocumentSerde
}
// The parameters for MariaDB.
type MariaDbParameters struct {
// Database.
//
// This member is required.
Database *string
// Host.
//
// This member is required.
Host *string
// Port.
//
// This member is required.
Port int32
noSmithyDocumentSerde
}
// An object that consists of a member Amazon Resource Name (ARN) and a member ID.
type MemberIdArnPair struct {
// The Amazon Resource Name (ARN) of the member.
MemberArn *string
// The ID of the member.
MemberId *string
noSmithyDocumentSerde
}
// The parameters for MySQL.
type MySqlParameters struct {
// Database.
//
// This member is required.
Database *string
// Host.
//
// This member is required.
Host *string
// Port.
//
// This member is required.
Port int32
noSmithyDocumentSerde
}
// Errors that occur during namespace creation.
type NamespaceError struct {
// The message for the error.
Message *string
// The error type.
Type NamespaceErrorType
noSmithyDocumentSerde
}
// The error type.
type NamespaceInfoV2 struct {
// The namespace ARN.
Arn *string
// The namespace Amazon Web Services Region.
CapacityRegion *string
// The creation status of a namespace that is not yet completely created.
CreationStatus NamespaceStatus
// The identity store used for the namespace.
IdentityStore IdentityStore
// The name of the error.
Name *string
// An error that occurred when the namespace was created.
NamespaceError *NamespaceError
noSmithyDocumentSerde
}
// The parameters for Oracle.
type OracleParameters struct {
// Database.
//
// This member is required.
Database *string
// An Oracle host.
//
// This member is required.
Host *string
// Port.
//
// This member is required.
Port int32
noSmithyDocumentSerde
}
// Output column.
type OutputColumn struct {
// A description for a column.
Description *string
// A display name for the dataset.
Name *string
// Type.
Type ColumnDataType
noSmithyDocumentSerde
}
// A list of Amazon QuickSight parameters and the list's override values.
type Parameters struct {
// The parameters that have a data type of date-time.
DateTimeParameters []DateTimeParameter
// The parameters that have a data type of decimal.
DecimalParameters []DecimalParameter
// The parameters that have a data type of integer.
IntegerParameters []IntegerParameter
// The parameters that have a data type of string.
StringParameters []StringParameter
noSmithyDocumentSerde
}
// A view of a data source that contains information about the shape of the data in
// the underlying source. This is a variant type structure. For this structure to
// be valid, only one of the attributes can be non-null.
//
// The following types satisfy this interface:
//
// PhysicalTableMemberCustomSql
// PhysicalTableMemberRelationalTable
// PhysicalTableMemberS3Source
type PhysicalTable interface {
isPhysicalTable()
}
// A physical table type built from the results of the custom SQL query.
type PhysicalTableMemberCustomSql struct {
Value CustomSql
noSmithyDocumentSerde
}
func (*PhysicalTableMemberCustomSql) isPhysicalTable() {}
// A physical table type for relational data sources.
type PhysicalTableMemberRelationalTable struct {
Value RelationalTable
noSmithyDocumentSerde
}
func (*PhysicalTableMemberRelationalTable) isPhysicalTable() {}
// A physical table type for as S3 data source.
type PhysicalTableMemberS3Source struct {
Value S3Source
noSmithyDocumentSerde
}
func (*PhysicalTableMemberS3Source) isPhysicalTable() {}
// The parameters for PostgreSQL.
type PostgreSqlParameters struct {
// Database.
//
// This member is required.
Database *string
// Host.
//
// This member is required.
Host *string
// Port.
//
// This member is required.
Port int32
noSmithyDocumentSerde
}
// The parameters for Presto.
type PrestoParameters struct {
// Catalog.
//
// This member is required.
Catalog *string
// Host.
//
// This member is required.
Host *string
// Port.
//
// This member is required.
Port int32
noSmithyDocumentSerde
}
// A transform operation that projects columns. Operations that come after a
// projection can only refer to projected columns.
type ProjectOperation struct {
// Projected columns.
//
// This member is required.
ProjectedColumns []string
noSmithyDocumentSerde
}
// Information about a queued dataset SPICE ingestion.
type QueueInfo struct {
// The ID of the ongoing ingestion. The queued ingestion is waiting for the ongoing
// ingestion to complete.
//
// This member is required.
QueuedIngestion *string
// The ID of the queued ingestion.
//
// This member is required.
WaitingOnIngestion *string
noSmithyDocumentSerde
}
// The parameters for Amazon RDS.
type RdsParameters struct {
// Database.
//
// This member is required.
Database *string
// Instance ID.
//
// This member is required.
InstanceId *string
noSmithyDocumentSerde
}
// The parameters for Amazon Redshift. The ClusterId field can be blank if Host and
// Port are both set. The Host and Port fields can be blank if the ClusterId field
// is set.
type RedshiftParameters struct {
// Database.
//
// This member is required.
Database *string
// Cluster ID. This field can be blank if the Host and Port are provided.
ClusterId *string
// Host. This field can be blank if ClusterId is provided.
Host *string
// Port. This field can be blank if the ClusterId is provided.
Port int32
noSmithyDocumentSerde
}
// Information about the dashboard you want to embed.
type RegisteredUserDashboardEmbeddingConfiguration struct {
// The dashboard ID for the dashboard that you want the user to see first. This ID
// is included in the output URL. When the URL in response is accessed, Amazon
// QuickSight renders this dashboard if the user has permissions to view it. If the
// user does not have permission to view this dashboard, they see a permissions
// error message.
//
// This member is required.
InitialDashboardId *string
noSmithyDocumentSerde
}
// The experience that you are embedding. You can use this object to generate a url
// that embeds a visual into your application.
type RegisteredUserDashboardVisualEmbeddingConfiguration struct {
// The visual ID for the visual that you want the user to embed. This ID is
// included in the output URL. When the URL in response is accessed, Amazon
// QuickSight renders this visual. The Amazon Resource Name (ARN) of the dashboard
// that the visual belongs to must be included in the AuthorizedResourceArns
// parameter. Otherwise, the request will fail with InvalidParameterValueException.
//
// This member is required.
InitialDashboardVisualId *DashboardVisualId
noSmithyDocumentSerde
}
// The type of experience you want to embed. For registered users, you can embed
// Amazon QuickSight dashboards or the Amazon QuickSight console. Exactly one of
// the experience configurations is required. You can choose Dashboard or
// QuickSightConsole. You cannot choose more than one experience configuration.
type RegisteredUserEmbeddingExperienceConfiguration struct {
// The configuration details for providing a dashboard embedding experience.
Dashboard *RegisteredUserDashboardEmbeddingConfiguration
// The type of embedding experience. In this case, Amazon QuickSight visuals.
DashboardVisual *RegisteredUserDashboardVisualEmbeddingConfiguration
// The configuration details for embedding the Q search bar. For more information
// about embedding the Q search bar, see Embedding Overview
// (https://docs.aws.amazon.com/quicksight/latest/user/embedding-overview.html) in
// the Amazon QuickSight User Guide.
QSearchBar *RegisteredUserQSearchBarEmbeddingConfiguration
// The configuration details for providing each Amazon QuickSight console embedding
// experience. This can be used along with custom permissions to restrict access to
// certain features. For more information, see Customizing Access to the Amazon
// QuickSight Console
// (https://docs.aws.amazon.com/quicksight/latest/user/customizing-permissions-to-the-quicksight-console.html)
// in the Amazon QuickSight User Guide. Use GenerateEmbedUrlForRegisteredUser
// (https://docs.aws.amazon.com/quicksight/latest/APIReference/API_GenerateEmbedUrlForRegisteredUser.html)
// where you want to provide an authoring portal that allows users to create data
// sources, datasets, analyses, and dashboards. The users who accesses an embedded
// Amazon QuickSight console needs to belong to the author or admin security
// cohort. If you want to restrict permissions to some of these features, add a
// custom permissions profile to the user with the UpdateUser
// (https://docs.aws.amazon.com/quicksight/latest/APIReference/API_UpdateUser.html)
// API operation. Use the RegisterUser
// (https://docs.aws.amazon.com/quicksight/latest/APIReference/API_RegisterUser.html)
// API operation to add a new user with a custom permission profile attached. For
// more information, see the following sections in the Amazon QuickSight User
// Guide:
//
// * Embedding the Full Functionality of the Amazon QuickSight Console for
// Authenticated Users
// (https://docs.aws.amazon.com/quicksight/latest/user/embedded-analytics-full-console-for-authenticated-users.html)
//
// *
// Customizing Access to the Amazon QuickSight Console
// (https://docs.aws.amazon.com/quicksight/latest/user/customizing-permissions-to-the-quicksight-console.html)
//
// For
// more information about the high-level steps for embedding and for an interactive
// demo of the ways you can customize embedding, visit the Amazon QuickSight
// Developer Portal
// (https://docs.aws.amazon.com/quicksight/latest/user/quicksight-dev-portal.html).
QuickSightConsole *RegisteredUserQuickSightConsoleEmbeddingConfiguration
noSmithyDocumentSerde
}
// Information about the Q search bar embedding experience.
type RegisteredUserQSearchBarEmbeddingConfiguration struct {
// The ID of the Q topic that you want to make the starting topic in the Q search
// bar. You can find a topic ID by navigating to the Topics pane in the Amazon
// QuickSight application and opening a topic. The ID is in the URL for the topic
// that you open. If you don't specify an initial topic, a list of all shared
// topics is shown in the Q bar for your readers. When you select an initial topic,
// you can specify whether or not readers are allowed to select other topics from
// the available ones in the list.
InitialTopicId *string
noSmithyDocumentSerde
}
// Information about the Amazon QuickSight console that you want to embed.
type RegisteredUserQuickSightConsoleEmbeddingConfiguration struct {
// The initial URL path for the Amazon QuickSight console. InitialPath is required.
// The entry point URL is constrained to the following paths:
//
// * /start
//
// *
// /start/analyses
//
// * /start/dashboards
//
// * /start/favorites
//
// *
// /dashboards/DashboardId. DashboardId is the actual ID key from the Amazon
// QuickSight console URL of the dashboard.
//
// * /analyses/AnalysisId. AnalysisId is
// the actual ID key from the Amazon QuickSight console URL of the analysis.
InitialPath *string
noSmithyDocumentSerde
}
// A physical table type for relational data sources.
type RelationalTable struct {
// The Amazon Resource Name (ARN) for the data source.
//
// This member is required.
DataSourceArn *string
// The column schema of the table.
//
// This member is required.
InputColumns []InputColumn
// The name of the relational table.
//
// This member is required.
Name *string
// The catalog associated with a table.
Catalog *string
// The schema name. This name applies to certain relational database engines.
Schema *string
noSmithyDocumentSerde
}
// A transform operation that renames a column.
type RenameColumnOperation struct {
// The name of the column to be renamed.
//
// This member is required.
ColumnName *string
// The new name for the column.
//
// This member is required.
NewColumnName *string
noSmithyDocumentSerde
}
// Permission for the resource.
type ResourcePermission struct {
// The IAM action to grant or revoke permissions on.
//
// This member is required.
Actions []string
// The Amazon Resource Name (ARN) of the principal. This can be one of the
// following:
//
// * The ARN of an Amazon QuickSight user or group associated with a
// data source or dataset. (This is common.)
//
// * The ARN of an Amazon QuickSight
// user, group, or namespace associated with an analysis, dashboard, template, or
// theme. (This is common.)
//
// * The ARN of an Amazon Web Services account root: This
// is an IAM ARN rather than a QuickSight ARN. Use this option only to share
// resources (templates) across Amazon Web Services accounts. (This is less
// common.)
//
// This member is required.
Principal *string
noSmithyDocumentSerde
}
// Information about rows for a data set SPICE ingestion.
type RowInfo struct {
// The number of rows that were not ingested.
RowsDropped *int64
// The number of rows that were ingested.
RowsIngested *int64
// The total number of rows in the dataset.
TotalRowsInDataset *int64
noSmithyDocumentSerde
}
// Information about a dataset that contains permissions for row-level security
// (RLS). The permissions dataset maps fields to users or groups. For more
// information, see Using Row-Level Security (RLS) to Restrict Access to a Dataset
// (https://docs.aws.amazon.com/quicksight/latest/user/restrict-access-to-a-data-set-using-row-level-security.html)
// in the Amazon QuickSight User Guide. The option to deny permissions by setting
// PermissionPolicy to DENY_ACCESS is not supported for new RLS datasets.
type RowLevelPermissionDataSet struct {
// The Amazon Resource Name (ARN) of the dataset that contains permissions for RLS.
//
// This member is required.
Arn *string
// The type of permissions to use when interpreting the permissions for RLS.
// DENY_ACCESS is included for backward compatibility only.
//
// This member is required.
PermissionPolicy RowLevelPermissionPolicy
// The user or group rules associated with the dataset that contains permissions
// for RLS. By default, FormatVersion is VERSION_1. When FormatVersion is
// VERSION_1, UserName and GroupName are required. When FormatVersion is VERSION_2,
// UserARN and GroupARN are required, and Namespace must not exist.
FormatVersion RowLevelPermissionFormatVersion
// The namespace associated with the dataset that contains permissions for RLS.
Namespace *string
// The status of the row-level security permission dataset. If enabled, the status
// is ENABLED. If disabled, the status is DISABLED.
Status Status
noSmithyDocumentSerde
}
// The configuration of tags on a dataset to set row-level security.
type RowLevelPermissionTagConfiguration struct {
// A set of rules associated with row-level security, such as the tag names and
// columns that they are assigned to.
//
// This member is required.
TagRules []RowLevelPermissionTagRule
// The status of row-level security tags. If enabled, the status is ENABLED. If
// disabled, the status is DISABLED.
Status Status
noSmithyDocumentSerde
}
// A set of rules associated with a tag.
type RowLevelPermissionTagRule struct {
// The column name that a tag key is assigned to.
//
// This member is required.
ColumnName *string
// The unique key for a tag.
//
// This member is required.
TagKey *string
// A string that you want to use to filter by all the values in a column in the
// dataset and don’t want to list the values one by one. For example, you can use
// an asterisk as your match all value.
MatchAllValue *string
// A string that you want to use to delimit the values when you pass the values at
// run time. For example, you can delimit the values with a comma.
TagMultiValueDelimiter *string
noSmithyDocumentSerde
}
// The parameters for S3.
type S3Parameters struct {
// Location of the Amazon S3 manifest file. This is NULL if the manifest file was
// uploaded into Amazon QuickSight.
//
// This member is required.
ManifestFileLocation *ManifestFileLocation
noSmithyDocumentSerde
}
// A physical table type for an S3 data source.
type S3Source struct {
// The Amazon Resource Name (ARN) for the data source.
//
// This member is required.
DataSourceArn *string
// A physical table type for an S3 data source. For files that aren't JSON, only
// STRING data types are supported in input columns.
//
// This member is required.
InputColumns []InputColumn
// Information about the format for the S3 source file or files.
UploadSettings *UploadSettings
noSmithyDocumentSerde
}
// The parameters for ServiceNow.
type ServiceNowParameters struct {
// URL of the base site.
//
// This member is required.
SiteBaseUrl *string
noSmithyDocumentSerde
}
// The key-value pair used for the row-level security tags feature.
type SessionTag struct {
// The key for the tag.
//
// This member is required.
Key *string
// The value that you want to assign the tag.
//
// This member is required.
Value *string
noSmithyDocumentSerde
}
// A sheet, which is an object that contains a set of visuals that are viewed
// together on one page in Amazon QuickSight. Every analysis and dashboard contains
// at least one sheet. Each sheet contains at least one visualization widget, for
// example a chart, pivot table, or narrative insight. Sheets can be associated
// with other components, such as controls, filters, and so on.
type Sheet struct {
// The name of a sheet. This name is displayed on the sheet's tab in the Amazon
// QuickSight console.
Name *string
// The unique identifier associated with a sheet.
SheetId *string
noSmithyDocumentSerde
}
// Sheet controls option.
type SheetControlsOption struct {
// Visibility state.
VisibilityState DashboardUIState
noSmithyDocumentSerde
}
// The theme display options for sheets.
type SheetStyle struct {
// The display options for tiles.
Tile *TileStyle
// The layout options for tiles.
TileLayout *TileLayoutStyle
noSmithyDocumentSerde
}
// A SignupResponse object that contains a summary of a newly created account.
type SignupResponse struct {
// The name of your Amazon QuickSight account.
AccountName *string
// The type of Active Directory that is being used to authenticate the Amazon
// QuickSight account. Valid values are SIMPLE_AD, AD_CONNECTOR, and MICROSOFT_AD.
DirectoryType *string
// A Boolean that is TRUE if the Amazon QuickSight uses IAM as an authentication
// method.
IAMUser bool
// The user login name for your Amazon QuickSight account.
UserLoginName *string
noSmithyDocumentSerde
}
// The parameters for Snowflake.
type SnowflakeParameters struct {
// Database.
//
// This member is required.
Database *string
// Host.
//
// This member is required.
Host *string
// Warehouse.
//
// This member is required.
Warehouse *string
noSmithyDocumentSerde
}
// The parameters for Spark.
type SparkParameters struct {
// Host.
//
// This member is required.
Host *string
// Port.
//
// This member is required.
Port int32
noSmithyDocumentSerde
}
// The parameters for SQL Server.
type SqlServerParameters struct {
// Database.
//
// This member is required.
Database *string
// Host.
//
// This member is required.
Host *string
// Port.
//
// This member is required.
Port int32
noSmithyDocumentSerde
}
// Secure Socket Layer (SSL) properties that apply when Amazon QuickSight connects
// to your underlying data source.
type SslProperties struct {
// A Boolean option to control whether SSL should be disabled.
DisableSsl bool
noSmithyDocumentSerde
}
// A string parameter.
type StringParameter struct {
// A display name for a string parameter.
//
// This member is required.
Name *string
// The values of a string parameter.
//
// This member is required.
Values []string
noSmithyDocumentSerde
}
// The key or keys of the key-value pairs for the resource tag or tags assigned to
// the resource.
type Tag struct {
// Tag key.
//
// This member is required.
Key *string
// Tag value.
//
// This member is required.
Value *string
noSmithyDocumentSerde
}
// A transform operation that tags a column with additional information.
type TagColumnOperation struct {
// The column that this operation acts on.
//
// This member is required.
ColumnName *string
// The dataset column tag, currently only used for geospatial type tagging. This is
// not tags for the Amazon Web Services tagging feature.
//
// This member is required.
Tags []ColumnTag
noSmithyDocumentSerde
}
// A template object. A template is an entity in Amazon QuickSight that
// encapsulates the metadata required to create an analysis and that you can use to
// create a dashboard. A template adds a layer of abstraction by using placeholders
// to replace the dataset associated with an analysis. You can use templates to
// create dashboards by replacing dataset placeholders with datasets that follow
// the same schema that was used to create the source analysis and template. You
// can share templates across Amazon Web Services accounts by allowing users in
// other Amazon Web Services accounts to create a template or a dashboard from an
// existing template.
type Template struct {
// The Amazon Resource Name (ARN) of the template.
Arn *string
// Time when this was created.
CreatedTime *time.Time
// Time when this was last updated.
LastUpdatedTime *time.Time
// The display name of the template.
Name *string
// The ID for the template. This is unique per Amazon Web Services Region for each
// Amazon Web Services account.
TemplateId *string
// A structure describing the versions of the template.
Version *TemplateVersion
noSmithyDocumentSerde
}
// The template alias.
type TemplateAlias struct {
// The display name of the template alias.
AliasName *string
// The Amazon Resource Name (ARN) of the template alias.
Arn *string
// The version number of the template alias.
TemplateVersionNumber *int64
noSmithyDocumentSerde
}
// List of errors that occurred when the template version creation failed.
type TemplateError struct {
// Description of the error type.
Message *string
// Type of error.
Type TemplateErrorType
noSmithyDocumentSerde
}
// The source analysis of the template.
type TemplateSourceAnalysis struct {
// The Amazon Resource Name (ARN) of the resource.
//
// This member is required.
Arn *string
// A structure containing information about the dataset references used as
// placeholders in the template.
//
// This member is required.
DataSetReferences []DataSetReference
noSmithyDocumentSerde
}
// The source entity of the template.
type TemplateSourceEntity struct {
// The source analysis, if it is based on an analysis.
SourceAnalysis *TemplateSourceAnalysis
// The source template, if it is based on an template.
SourceTemplate *TemplateSourceTemplate
noSmithyDocumentSerde
}
// The source template of the template.
type TemplateSourceTemplate struct {
// The Amazon Resource Name (ARN) of the resource.
//
// This member is required.
Arn *string
noSmithyDocumentSerde
}
// The template summary.
type TemplateSummary struct {
// A summary of a template.
Arn *string
// The last time that this template was created.
CreatedTime *time.Time
// The last time that this template was updated.
LastUpdatedTime *time.Time
// A structure containing a list of version numbers for the template summary.
LatestVersionNumber *int64
// A display name for the template.
Name *string
// The ID of the template. This ID is unique per Amazon Web Services Region for
// each Amazon Web Services account.
TemplateId *string
noSmithyDocumentSerde
}
// A version of a template.
type TemplateVersion struct {
// The time that this template version was created.
CreatedTime *time.Time
// Schema of the dataset identified by the placeholder. Any dashboard created from
// this template should be bound to new datasets matching the same schema described
// through this API operation.
DataSetConfigurations []DataSetConfiguration
// The description of the template.
Description *string
// Errors associated with this template version.
Errors []TemplateError
// A list of the associated sheets with the unique identifier and name of each
// sheet.
Sheets []Sheet
// The Amazon Resource Name (ARN) of an analysis or template that was used to
// create this template.
SourceEntityArn *string
// The HTTP status of the request.
Status ResourceStatus
// The ARN of the theme associated with this version of the template.
ThemeArn *string
// The version number of the template version.
VersionNumber *int64
noSmithyDocumentSerde
}
// The template version.
type TemplateVersionSummary struct {
// The Amazon Resource Name (ARN) of the template version.
Arn *string
// The time that this template version was created.
CreatedTime *time.Time
// The description of the template version.
Description *string
// The status of the template version.
Status ResourceStatus
// The version number of the template version.
VersionNumber *int64
noSmithyDocumentSerde
}
// The parameters for Teradata.
type TeradataParameters struct {
// Database.
//
// This member is required.
Database *string
// Host.
//
// This member is required.
Host *string
// Port.
//
// This member is required.
Port int32
noSmithyDocumentSerde
}
// Summary information about a theme.
type Theme struct {
// The Amazon Resource Name (ARN) of the theme.
Arn *string
// The date and time that the theme was created.
CreatedTime *time.Time
// The date and time that the theme was last updated.
LastUpdatedTime *time.Time
// The name that the user gives to the theme.
Name *string
// The identifier that the user gives to the theme.
ThemeId *string
// The type of theme, based on how it was created. Valid values include: QUICKSIGHT
// and CUSTOM.
Type ThemeType
// A version of a theme.
Version *ThemeVersion
noSmithyDocumentSerde
}
// An alias for a theme.
type ThemeAlias struct {
// The display name of the theme alias.
AliasName *string
// The Amazon Resource Name (ARN) of the theme alias.
Arn *string
// The version number of the theme alias.
ThemeVersionNumber *int64
noSmithyDocumentSerde
}
// The theme configuration. This configuration contains all of the display
// properties for a theme.
type ThemeConfiguration struct {
// Color properties that apply to chart data colors.
DataColorPalette *DataColorPalette
// Display options related to sheets.
Sheet *SheetStyle
// Color properties that apply to the UI and to charts, excluding the colors that
// apply to data.
UIColorPalette *UIColorPalette
noSmithyDocumentSerde
}
// Theme error.
type ThemeError struct {
// The error message.
Message *string
// The type of error.
Type ThemeErrorType
noSmithyDocumentSerde
}
// The theme summary.
type ThemeSummary struct {
// The Amazon Resource Name (ARN) of the resource.
Arn *string
// The date and time that this theme was created.
CreatedTime *time.Time
// The last date and time that this theme was updated.
LastUpdatedTime *time.Time
// The latest version number for the theme.
LatestVersionNumber *int64
// the display name for the theme.
Name *string
// The ID of the theme. This ID is unique per Amazon Web Services Region for each
// Amazon Web Services account.
ThemeId *string
noSmithyDocumentSerde
}
// A version of a theme.
type ThemeVersion struct {
// The Amazon Resource Name (ARN) of the resource.
Arn *string
// The Amazon QuickSight-defined ID of the theme that a custom theme inherits from.
// All themes initially inherit from a default Amazon QuickSight theme.
BaseThemeId *string
// The theme configuration, which contains all the theme display properties.
Configuration *ThemeConfiguration
// The date and time that this theme version was created.
CreatedTime *time.Time
// The description of the theme.
Description *string
// Errors associated with the theme.
Errors []ThemeError
// The status of the theme version.
Status ResourceStatus
// The version number of the theme.
VersionNumber *int64
noSmithyDocumentSerde
}
// The theme version.
type ThemeVersionSummary struct {
// The Amazon Resource Name (ARN) of the theme version.
Arn *string
// The date and time that this theme version was created.
CreatedTime *time.Time
// The description of the theme version.
Description *string
// The status of the theme version.
Status ResourceStatus
// The version number of the theme version.
VersionNumber *int64
noSmithyDocumentSerde
}
// The display options for the layout of tiles on a sheet.
type TileLayoutStyle struct {
// The gutter settings that apply between tiles.
Gutter *GutterStyle
// The margin settings that apply around the outside edge of sheets.
Margin *MarginStyle
noSmithyDocumentSerde
}
// Display options related to tiles on a sheet.
type TileStyle struct {
// The border around a tile.
Border *BorderStyle
noSmithyDocumentSerde
}
// A data transformation on a logical table. This is a variant type structure. For
// this structure to be valid, only one of the attributes can be non-null.
//
// The following types satisfy this interface:
//
// TransformOperationMemberCastColumnTypeOperation
// TransformOperationMemberCreateColumnsOperation
// TransformOperationMemberFilterOperation
// TransformOperationMemberProjectOperation
// TransformOperationMemberRenameColumnOperation
// TransformOperationMemberTagColumnOperation
// TransformOperationMemberUntagColumnOperation
type TransformOperation interface {
isTransformOperation()
}
// A transform operation that casts a column to a different type.
type TransformOperationMemberCastColumnTypeOperation struct {
Value CastColumnTypeOperation
noSmithyDocumentSerde
}
func (*TransformOperationMemberCastColumnTypeOperation) isTransformOperation() {}
// An operation that creates calculated columns. Columns created in one such
// operation form a lexical closure.
type TransformOperationMemberCreateColumnsOperation struct {
Value CreateColumnsOperation
noSmithyDocumentSerde
}
func (*TransformOperationMemberCreateColumnsOperation) isTransformOperation() {}
// An operation that filters rows based on some condition.
type TransformOperationMemberFilterOperation struct {
Value FilterOperation
noSmithyDocumentSerde
}
func (*TransformOperationMemberFilterOperation) isTransformOperation() {}
// An operation that projects columns. Operations that come after a projection can
// only refer to projected columns.
type TransformOperationMemberProjectOperation struct {
Value ProjectOperation
noSmithyDocumentSerde
}
func (*TransformOperationMemberProjectOperation) isTransformOperation() {}
// An operation that renames a column.
type TransformOperationMemberRenameColumnOperation struct {
Value RenameColumnOperation
noSmithyDocumentSerde
}
func (*TransformOperationMemberRenameColumnOperation) isTransformOperation() {}
// An operation that tags a column with additional information.
type TransformOperationMemberTagColumnOperation struct {
Value TagColumnOperation
noSmithyDocumentSerde
}
func (*TransformOperationMemberTagColumnOperation) isTransformOperation() {}
// A transform operation that removes tags associated with a column.
type TransformOperationMemberUntagColumnOperation struct {
Value UntagColumnOperation
noSmithyDocumentSerde
}
func (*TransformOperationMemberUntagColumnOperation) isTransformOperation() {}
// The parameters for Twitter.
type TwitterParameters struct {
// Maximum number of rows to query Twitter.
//
// This member is required.
MaxRows int32
// Twitter query string.
//
// This member is required.
Query *string
noSmithyDocumentSerde
}
// The theme colors that apply to UI and to charts, excluding data colors. The
// colors description is a hexadecimal color code that consists of six
// alphanumerical characters, prefixed with #, for example #37BFF5. For more
// information, see Using Themes in Amazon QuickSight
// (https://docs.aws.amazon.com/quicksight/latest/user/themes-in-quicksight.html)
// in the Amazon QuickSight User Guide.
type UIColorPalette struct {
// This color is that applies to selected states and buttons.
Accent *string
// The foreground color that applies to any text or other elements that appear over
// the accent color.
AccentForeground *string
// The color that applies to error messages.
Danger *string
// The foreground color that applies to any text or other elements that appear over
// the error color.
DangerForeground *string
// The color that applies to the names of fields that are identified as dimensions.
Dimension *string
// The foreground color that applies to any text or other elements that appear over
// the dimension color.
DimensionForeground *string
// The color that applies to the names of fields that are identified as measures.
Measure *string
// The foreground color that applies to any text or other elements that appear over
// the measure color.
MeasureForeground *string
// The background color that applies to visuals and other high emphasis UI.
PrimaryBackground *string
// The color of text and other foreground elements that appear over the primary
// background regions, such as grid lines, borders, table banding, icons, and so
// on.
PrimaryForeground *string
// The background color that applies to the sheet background and sheet controls.
SecondaryBackground *string
// The foreground color that applies to any sheet title, sheet control text, or UI
// that appears over the secondary background.
SecondaryForeground *string
// The color that applies to success messages, for example the check mark for a
// successful download.
Success *string
// The foreground color that applies to any text or other elements that appear over
// the success color.
SuccessForeground *string
// This color that applies to warning and informational messages.
Warning *string
// The foreground color that applies to any text or other elements that appear over
// the warning color.
WarningForeground *string
noSmithyDocumentSerde
}
// A transform operation that removes tags associated with a column.
type UntagColumnOperation struct {
// The column that this operation acts on.
//
// This member is required.
ColumnName *string
// The column tags to remove from this column.
//
// This member is required.
TagNames []ColumnTagName
noSmithyDocumentSerde
}
// Information about the format for a source file or files.
type UploadSettings struct {
// Whether the file has a header row, or the files each have a header row.
ContainsHeader *bool
// The delimiter between values in the file.
Delimiter *string
// File format.
Format FileFormat
// A row number to start reading data from.
StartFromRow *int32
// Text qualifier.
TextQualifier TextQualifier
noSmithyDocumentSerde
}
// A registered user of Amazon QuickSight.
type User struct {
// The active status of user. When you create an Amazon QuickSight user that’s not
// an IAM user or an Active Directory user, that user is inactive until they sign
// in and provide a password.
Active bool
// The Amazon Resource Name (ARN) for the user.
Arn *string
// The custom permissions profile associated with this user.
CustomPermissionsName *string
// The user's email address.
Email *string
// The type of supported external login provider that provides identity to let the
// user federate into Amazon QuickSight with an associated IAM role. The type can
// be one of the following.
//
// * COGNITO: Amazon Cognito. The provider URL is
// cognito-identity.amazonaws.com.
//
// * CUSTOM_OIDC: Custom OpenID Connect (OIDC)
// provider.
ExternalLoginFederationProviderType *string
// The URL of the external login provider.
ExternalLoginFederationProviderUrl *string
// The identity ID for the user in the external login provider.
ExternalLoginId *string
// The type of identity authentication used by the user.
IdentityType IdentityType
// The principal ID of the user.
PrincipalId *string
// The Amazon QuickSight role for the user. The user role can be one of the
// following:.
//
// * READER: A user who has read-only access to dashboards.
//
// * AUTHOR:
// A user who can create data sources, datasets, analyses, and dashboards.
//
// *
// ADMIN: A user who is an author, who can also manage Amazon Amazon QuickSight
// settings.
//
// * RESTRICTED_READER: This role isn't currently available for use.
//
// *
// RESTRICTED_AUTHOR: This role isn't currently available for use.
Role UserRole
// The user's user name. This value is required if you are registering a user that
// will be managed in Amazon QuickSight. In the output, the value for UserName is
// N/A when the value for IdentityType is IAM and the corresponding IAM user is
// deleted.
UserName *string
noSmithyDocumentSerde
}
// VPC connection properties.
type VpcConnectionProperties struct {
// The Amazon Resource Name (ARN) for the VPC connection.
//
// This member is required.
VpcConnectionArn *string
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) isDataSourceParameters() {}
func (*UnknownUnionMember) isPhysicalTable() {}
func (*UnknownUnionMember) isTransformOperation() {}
|