quicksight.d.ts
243 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
2883
2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
2930
2931
2932
2933
2934
2935
2936
2937
2938
2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
2951
2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
3035
3036
3037
3038
3039
3040
3041
3042
3043
3044
3045
3046
3047
3048
3049
3050
3051
3052
3053
3054
3055
3056
3057
3058
3059
3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
3076
3077
3078
3079
3080
3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
3097
3098
3099
3100
3101
3102
3103
3104
3105
3106
3107
3108
3109
3110
3111
3112
3113
3114
3115
3116
3117
3118
3119
3120
3121
3122
3123
3124
3125
3126
3127
3128
3129
3130
3131
3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
3149
3150
3151
3152
3153
3154
3155
3156
3157
3158
3159
3160
3161
3162
3163
3164
3165
3166
3167
3168
3169
3170
3171
3172
3173
3174
3175
3176
3177
3178
3179
3180
3181
3182
3183
3184
3185
3186
3187
3188
3189
3190
3191
3192
3193
3194
3195
3196
3197
3198
3199
3200
3201
3202
3203
3204
3205
3206
3207
3208
3209
3210
3211
3212
3213
3214
3215
3216
3217
3218
3219
3220
3221
3222
3223
3224
3225
3226
3227
3228
3229
3230
3231
3232
3233
3234
3235
3236
3237
3238
3239
3240
3241
3242
3243
3244
3245
3246
3247
3248
3249
3250
3251
3252
3253
3254
3255
3256
3257
3258
3259
3260
3261
3262
3263
3264
3265
3266
3267
3268
3269
3270
3271
3272
3273
3274
3275
3276
3277
3278
3279
3280
3281
3282
3283
3284
3285
3286
3287
3288
3289
3290
3291
3292
3293
3294
3295
3296
3297
3298
3299
3300
3301
3302
3303
3304
3305
3306
3307
3308
3309
3310
3311
3312
3313
3314
3315
3316
3317
3318
3319
3320
3321
3322
3323
3324
3325
3326
3327
3328
3329
3330
3331
3332
3333
3334
3335
3336
3337
3338
3339
3340
3341
3342
3343
3344
3345
3346
3347
3348
3349
3350
3351
3352
3353
3354
3355
3356
3357
3358
3359
3360
3361
3362
3363
3364
3365
3366
3367
3368
3369
3370
3371
3372
3373
3374
3375
3376
3377
3378
3379
3380
3381
3382
3383
3384
3385
3386
3387
3388
3389
3390
3391
3392
3393
3394
3395
3396
3397
3398
3399
3400
3401
3402
3403
3404
3405
3406
3407
3408
3409
3410
3411
3412
3413
3414
3415
3416
3417
3418
3419
3420
3421
3422
3423
3424
3425
3426
3427
3428
3429
3430
3431
3432
3433
3434
3435
3436
3437
3438
3439
3440
3441
3442
3443
3444
3445
3446
3447
3448
3449
3450
3451
3452
3453
3454
3455
3456
3457
3458
3459
3460
3461
3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
3492
3493
3494
3495
3496
3497
3498
3499
3500
3501
3502
3503
3504
3505
3506
3507
3508
3509
3510
3511
3512
3513
3514
3515
3516
3517
3518
3519
3520
3521
3522
3523
3524
3525
3526
3527
3528
3529
3530
3531
3532
3533
3534
3535
3536
3537
3538
3539
3540
3541
3542
3543
3544
3545
3546
3547
3548
3549
3550
3551
3552
3553
3554
3555
3556
3557
3558
3559
3560
3561
3562
3563
3564
3565
3566
3567
3568
3569
3570
3571
3572
3573
3574
3575
3576
3577
3578
3579
3580
3581
3582
3583
3584
3585
3586
3587
3588
3589
3590
3591
3592
3593
3594
3595
3596
3597
3598
3599
3600
3601
3602
3603
3604
3605
3606
3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
3634
3635
3636
3637
3638
3639
3640
3641
3642
3643
3644
3645
3646
3647
3648
3649
3650
3651
3652
3653
3654
3655
3656
3657
3658
3659
3660
3661
3662
3663
3664
3665
3666
3667
3668
3669
3670
3671
3672
3673
3674
3675
3676
3677
3678
3679
3680
3681
3682
3683
3684
3685
3686
3687
3688
3689
3690
3691
3692
3693
3694
3695
3696
3697
3698
3699
3700
3701
3702
3703
3704
3705
3706
3707
3708
3709
3710
3711
3712
3713
3714
3715
3716
3717
3718
3719
3720
3721
3722
3723
3724
3725
3726
3727
3728
3729
3730
3731
3732
3733
3734
3735
3736
3737
3738
3739
3740
3741
3742
3743
3744
3745
3746
3747
3748
3749
3750
3751
3752
3753
3754
3755
3756
3757
3758
3759
3760
3761
3762
3763
3764
3765
3766
3767
3768
3769
3770
3771
3772
3773
3774
3775
3776
3777
3778
3779
3780
3781
3782
3783
3784
3785
3786
3787
3788
3789
3790
3791
3792
3793
3794
3795
3796
3797
3798
3799
3800
3801
3802
3803
3804
3805
3806
3807
3808
3809
3810
3811
3812
3813
3814
3815
3816
3817
3818
3819
3820
3821
3822
3823
3824
3825
3826
3827
3828
3829
3830
3831
3832
3833
3834
3835
3836
3837
3838
3839
3840
3841
3842
3843
3844
3845
3846
3847
3848
3849
3850
3851
3852
3853
3854
3855
3856
3857
3858
3859
3860
3861
3862
3863
3864
3865
3866
3867
3868
3869
3870
3871
3872
3873
3874
3875
3876
3877
3878
3879
3880
3881
3882
3883
3884
3885
3886
3887
3888
3889
3890
3891
3892
3893
3894
3895
3896
3897
3898
3899
3900
3901
3902
3903
3904
3905
3906
3907
3908
3909
3910
3911
3912
3913
3914
3915
3916
3917
3918
3919
3920
3921
3922
3923
3924
3925
3926
3927
3928
3929
3930
3931
3932
3933
3934
3935
3936
3937
3938
3939
3940
3941
3942
3943
3944
3945
3946
3947
3948
3949
3950
3951
3952
3953
3954
3955
3956
3957
3958
3959
3960
3961
3962
3963
3964
3965
3966
3967
3968
3969
3970
3971
3972
3973
3974
3975
3976
3977
3978
3979
3980
3981
3982
3983
3984
3985
3986
3987
3988
3989
3990
3991
3992
3993
3994
3995
3996
3997
3998
3999
4000
4001
4002
4003
4004
4005
4006
4007
4008
4009
4010
4011
4012
4013
4014
4015
4016
4017
4018
4019
4020
4021
4022
4023
4024
4025
4026
4027
4028
4029
4030
4031
4032
4033
4034
4035
4036
4037
4038
4039
4040
4041
4042
4043
4044
4045
4046
4047
4048
4049
4050
4051
4052
4053
4054
4055
4056
4057
4058
4059
4060
4061
4062
4063
4064
4065
4066
4067
4068
4069
4070
4071
4072
4073
4074
4075
4076
4077
4078
4079
4080
4081
4082
4083
4084
4085
4086
4087
4088
4089
4090
4091
4092
4093
4094
4095
4096
4097
4098
4099
4100
4101
4102
4103
4104
4105
4106
4107
4108
4109
4110
4111
4112
4113
4114
4115
4116
4117
4118
4119
4120
4121
4122
4123
4124
4125
4126
4127
4128
4129
4130
4131
4132
4133
4134
4135
4136
4137
4138
4139
4140
4141
4142
4143
4144
4145
4146
4147
4148
4149
4150
4151
4152
4153
4154
4155
4156
4157
4158
4159
4160
4161
4162
4163
4164
4165
4166
4167
4168
4169
4170
4171
4172
4173
4174
4175
4176
4177
4178
4179
4180
4181
4182
4183
4184
4185
4186
4187
4188
4189
4190
4191
4192
4193
4194
4195
4196
4197
4198
4199
4200
4201
4202
4203
4204
4205
4206
4207
4208
4209
4210
4211
4212
4213
4214
4215
4216
4217
4218
4219
4220
4221
4222
4223
4224
4225
4226
4227
4228
4229
4230
4231
4232
4233
4234
4235
4236
4237
4238
4239
4240
4241
4242
4243
4244
4245
4246
4247
4248
4249
4250
4251
4252
4253
4254
4255
4256
4257
4258
4259
4260
4261
4262
4263
4264
4265
4266
4267
4268
4269
4270
4271
4272
4273
4274
4275
4276
4277
4278
4279
4280
4281
4282
4283
4284
4285
4286
4287
4288
4289
4290
4291
4292
4293
4294
4295
4296
4297
4298
4299
4300
4301
4302
4303
4304
4305
4306
4307
4308
4309
4310
4311
4312
4313
4314
4315
4316
4317
4318
4319
4320
4321
4322
4323
4324
4325
4326
4327
4328
4329
4330
4331
4332
4333
4334
4335
4336
4337
4338
4339
4340
4341
4342
4343
4344
4345
4346
4347
4348
4349
4350
4351
4352
4353
4354
4355
4356
4357
4358
4359
4360
4361
4362
4363
4364
4365
4366
4367
4368
4369
4370
4371
4372
4373
4374
4375
4376
4377
4378
4379
4380
4381
4382
4383
4384
4385
4386
4387
4388
4389
4390
4391
4392
4393
4394
4395
4396
4397
4398
4399
4400
4401
4402
4403
4404
4405
4406
4407
4408
4409
4410
4411
4412
4413
4414
4415
4416
4417
4418
4419
4420
4421
4422
4423
4424
4425
4426
4427
4428
4429
4430
4431
4432
4433
4434
4435
4436
4437
4438
4439
4440
4441
4442
4443
4444
4445
4446
4447
4448
4449
4450
4451
4452
4453
4454
4455
4456
4457
4458
4459
4460
4461
4462
4463
4464
4465
4466
4467
4468
4469
4470
4471
4472
4473
4474
4475
4476
4477
4478
4479
4480
4481
4482
4483
4484
4485
4486
4487
4488
4489
4490
4491
4492
4493
4494
4495
4496
4497
4498
4499
4500
4501
4502
4503
4504
4505
4506
4507
4508
4509
4510
4511
4512
4513
4514
4515
4516
4517
4518
4519
4520
4521
4522
4523
4524
4525
4526
4527
4528
4529
4530
4531
4532
4533
4534
4535
4536
4537
4538
4539
4540
4541
4542
4543
4544
4545
4546
4547
4548
4549
4550
4551
4552
4553
4554
4555
4556
4557
4558
4559
4560
4561
4562
4563
4564
4565
4566
4567
4568
4569
4570
4571
4572
4573
4574
4575
4576
4577
4578
4579
4580
4581
4582
4583
4584
4585
4586
4587
4588
4589
4590
4591
4592
4593
4594
4595
4596
4597
4598
4599
4600
4601
4602
4603
4604
4605
4606
4607
4608
4609
4610
4611
4612
4613
4614
4615
4616
4617
4618
4619
4620
4621
4622
4623
4624
4625
4626
4627
4628
4629
4630
4631
4632
4633
4634
4635
4636
4637
4638
4639
4640
4641
4642
4643
4644
4645
4646
4647
4648
4649
4650
4651
4652
4653
4654
4655
4656
4657
4658
4659
4660
4661
4662
4663
4664
4665
4666
4667
4668
4669
4670
4671
4672
4673
4674
4675
4676
4677
4678
4679
4680
4681
4682
4683
4684
4685
4686
4687
4688
4689
4690
4691
4692
4693
4694
4695
4696
4697
4698
4699
4700
4701
4702
4703
4704
4705
4706
4707
4708
4709
4710
4711
4712
4713
4714
4715
4716
4717
4718
4719
4720
4721
4722
4723
4724
4725
4726
4727
4728
4729
4730
4731
4732
4733
4734
4735
4736
4737
4738
4739
4740
4741
4742
4743
4744
4745
4746
4747
4748
4749
4750
4751
4752
4753
4754
4755
4756
4757
4758
4759
4760
4761
4762
4763
4764
4765
4766
4767
4768
4769
4770
4771
4772
4773
4774
4775
4776
4777
4778
4779
4780
4781
4782
4783
4784
4785
4786
4787
4788
4789
4790
4791
4792
4793
4794
4795
4796
4797
4798
4799
4800
4801
4802
4803
4804
4805
4806
4807
4808
4809
4810
4811
4812
4813
4814
4815
4816
4817
4818
4819
4820
4821
4822
4823
4824
4825
4826
4827
4828
4829
4830
4831
4832
4833
4834
4835
4836
4837
4838
4839
4840
4841
4842
4843
4844
4845
4846
4847
4848
4849
4850
4851
4852
4853
4854
4855
4856
4857
4858
4859
4860
4861
4862
4863
4864
4865
4866
4867
4868
4869
4870
4871
4872
4873
4874
4875
4876
4877
4878
4879
4880
4881
4882
4883
4884
4885
4886
4887
4888
4889
4890
4891
4892
4893
4894
4895
4896
4897
4898
4899
4900
4901
4902
4903
4904
4905
4906
4907
4908
4909
4910
4911
4912
4913
4914
4915
4916
4917
4918
4919
4920
4921
4922
4923
4924
4925
4926
4927
4928
4929
4930
4931
4932
4933
4934
4935
4936
4937
4938
4939
4940
4941
4942
4943
4944
4945
4946
4947
4948
4949
4950
4951
4952
4953
4954
4955
4956
4957
4958
4959
4960
4961
4962
4963
4964
4965
4966
4967
4968
4969
4970
4971
4972
4973
4974
4975
4976
4977
4978
4979
4980
4981
4982
4983
4984
4985
4986
4987
4988
4989
4990
4991
4992
4993
4994
4995
4996
4997
4998
4999
5000
5001
5002
5003
5004
5005
5006
5007
5008
5009
5010
5011
5012
5013
5014
5015
5016
5017
5018
5019
5020
5021
5022
5023
5024
5025
5026
5027
5028
5029
5030
5031
5032
5033
5034
5035
5036
5037
5038
5039
5040
5041
5042
5043
5044
5045
5046
5047
5048
5049
5050
5051
5052
5053
5054
5055
5056
5057
5058
5059
5060
5061
5062
5063
5064
5065
5066
5067
5068
5069
5070
5071
5072
5073
5074
5075
5076
5077
5078
5079
5080
5081
5082
5083
5084
5085
5086
5087
5088
5089
5090
5091
5092
5093
5094
5095
5096
5097
5098
5099
5100
5101
5102
5103
5104
5105
5106
5107
5108
5109
5110
5111
5112
5113
5114
5115
5116
5117
5118
5119
5120
5121
5122
5123
5124
5125
5126
5127
5128
5129
5130
5131
5132
5133
5134
5135
5136
5137
5138
5139
5140
5141
5142
5143
5144
5145
5146
5147
5148
5149
5150
5151
5152
5153
5154
5155
5156
5157
5158
5159
5160
5161
5162
5163
5164
5165
5166
5167
5168
5169
5170
5171
5172
5173
5174
5175
5176
5177
5178
5179
5180
5181
5182
5183
5184
5185
5186
5187
5188
5189
5190
5191
5192
5193
5194
5195
5196
5197
5198
5199
5200
5201
5202
5203
5204
5205
5206
5207
5208
5209
5210
5211
5212
5213
5214
5215
5216
5217
5218
5219
5220
5221
5222
5223
5224
5225
5226
5227
5228
5229
5230
5231
5232
5233
5234
5235
5236
5237
5238
5239
5240
5241
5242
5243
5244
5245
5246
5247
5248
5249
5250
5251
5252
5253
5254
5255
5256
5257
5258
5259
5260
5261
5262
5263
5264
5265
5266
5267
5268
5269
5270
5271
5272
5273
5274
5275
5276
5277
5278
5279
5280
5281
5282
5283
5284
5285
5286
5287
5288
5289
5290
5291
5292
5293
5294
5295
5296
5297
5298
5299
5300
5301
5302
5303
5304
5305
5306
5307
5308
5309
5310
5311
5312
5313
5314
5315
5316
5317
5318
5319
5320
5321
5322
5323
5324
5325
5326
5327
5328
5329
5330
5331
5332
5333
5334
5335
5336
5337
5338
5339
5340
5341
5342
5343
5344
5345
5346
5347
5348
5349
5350
5351
5352
5353
5354
5355
5356
5357
5358
5359
5360
5361
5362
5363
5364
5365
5366
5367
5368
5369
5370
5371
5372
5373
5374
5375
5376
5377
5378
5379
5380
5381
5382
5383
5384
5385
5386
5387
5388
5389
5390
5391
5392
5393
5394
5395
5396
5397
5398
5399
5400
5401
5402
5403
5404
5405
5406
5407
5408
5409
5410
5411
5412
5413
5414
5415
5416
5417
5418
5419
5420
5421
5422
5423
5424
5425
5426
5427
5428
5429
5430
5431
5432
5433
5434
5435
5436
5437
5438
5439
5440
5441
5442
5443
5444
5445
5446
5447
5448
5449
5450
5451
5452
5453
5454
5455
5456
5457
5458
5459
5460
5461
5462
5463
5464
5465
5466
5467
5468
5469
5470
5471
5472
5473
5474
5475
5476
5477
5478
5479
5480
5481
5482
5483
5484
5485
5486
5487
5488
5489
5490
5491
5492
5493
5494
5495
5496
5497
5498
5499
5500
5501
5502
5503
5504
5505
5506
5507
5508
5509
5510
5511
5512
5513
5514
5515
5516
5517
5518
5519
5520
5521
5522
5523
5524
5525
5526
5527
5528
5529
5530
5531
5532
5533
5534
5535
5536
5537
5538
5539
5540
5541
5542
5543
5544
5545
5546
5547
5548
5549
5550
5551
5552
5553
5554
5555
5556
5557
5558
5559
5560
5561
5562
5563
5564
5565
5566
5567
5568
5569
5570
5571
5572
5573
5574
5575
5576
5577
5578
5579
5580
5581
5582
5583
5584
5585
5586
5587
5588
5589
5590
5591
5592
5593
5594
5595
5596
5597
5598
5599
5600
5601
5602
5603
5604
5605
5606
5607
5608
5609
5610
5611
5612
5613
5614
5615
5616
5617
5618
5619
5620
5621
5622
5623
5624
5625
5626
5627
5628
5629
5630
5631
5632
5633
5634
5635
5636
5637
5638
5639
5640
5641
5642
5643
5644
5645
5646
5647
5648
5649
5650
5651
5652
5653
5654
5655
5656
5657
5658
5659
5660
5661
5662
5663
5664
5665
5666
5667
5668
5669
5670
5671
5672
5673
5674
5675
5676
5677
5678
5679
5680
5681
5682
5683
5684
5685
5686
5687
5688
5689
5690
5691
5692
5693
5694
5695
5696
5697
5698
5699
5700
5701
5702
5703
5704
5705
5706
5707
5708
5709
5710
5711
5712
5713
5714
5715
5716
5717
5718
5719
5720
5721
5722
5723
5724
5725
5726
5727
5728
5729
5730
5731
5732
5733
5734
5735
5736
5737
5738
5739
5740
5741
5742
5743
5744
5745
5746
5747
5748
5749
5750
5751
5752
5753
5754
5755
5756
5757
5758
5759
5760
5761
5762
5763
5764
5765
5766
5767
5768
5769
5770
5771
5772
5773
5774
5775
5776
5777
5778
5779
5780
5781
5782
5783
5784
5785
5786
5787
5788
5789
5790
5791
5792
5793
5794
5795
5796
5797
5798
5799
5800
5801
5802
5803
5804
5805
5806
5807
5808
5809
5810
5811
5812
5813
5814
5815
5816
5817
5818
5819
5820
5821
5822
5823
5824
5825
5826
5827
5828
5829
5830
5831
5832
5833
5834
5835
5836
5837
5838
5839
5840
5841
5842
5843
5844
5845
5846
5847
5848
5849
5850
5851
5852
5853
5854
5855
5856
5857
5858
5859
5860
5861
5862
5863
5864
5865
5866
5867
5868
5869
5870
5871
5872
5873
5874
5875
5876
5877
5878
5879
5880
5881
5882
5883
5884
5885
5886
5887
5888
5889
5890
5891
5892
5893
5894
5895
5896
5897
5898
5899
5900
5901
5902
5903
5904
5905
5906
5907
5908
5909
5910
5911
5912
5913
5914
5915
5916
5917
5918
5919
5920
5921
5922
5923
5924
5925
5926
5927
5928
5929
5930
5931
5932
5933
5934
5935
5936
5937
5938
5939
5940
5941
5942
5943
5944
5945
5946
5947
5948
5949
5950
5951
5952
5953
5954
5955
5956
5957
5958
5959
5960
5961
5962
5963
5964
5965
5966
5967
5968
5969
5970
5971
5972
5973
5974
5975
5976
5977
5978
5979
5980
5981
5982
5983
5984
5985
5986
5987
5988
5989
5990
5991
5992
5993
5994
5995
5996
5997
5998
5999
6000
6001
6002
6003
6004
6005
6006
6007
6008
6009
6010
6011
6012
6013
6014
6015
6016
6017
6018
6019
6020
6021
6022
6023
6024
6025
6026
6027
6028
6029
6030
6031
6032
6033
6034
6035
6036
6037
6038
6039
6040
6041
6042
6043
6044
6045
6046
6047
6048
6049
6050
6051
6052
6053
6054
6055
6056
6057
6058
6059
6060
6061
6062
6063
6064
6065
6066
6067
6068
6069
6070
6071
6072
6073
6074
6075
6076
6077
6078
6079
6080
6081
6082
6083
6084
6085
6086
6087
6088
6089
6090
6091
6092
6093
6094
6095
6096
6097
6098
6099
6100
6101
6102
6103
6104
6105
6106
6107
6108
6109
6110
6111
6112
6113
6114
6115
6116
6117
6118
6119
6120
6121
6122
6123
6124
6125
6126
6127
6128
6129
6130
6131
6132
6133
6134
6135
6136
6137
6138
6139
6140
6141
6142
6143
6144
6145
6146
6147
6148
6149
6150
6151
6152
6153
6154
6155
6156
6157
6158
6159
6160
6161
6162
6163
6164
6165
6166
6167
6168
6169
6170
6171
6172
6173
6174
6175
6176
6177
6178
6179
6180
6181
6182
6183
6184
6185
6186
6187
6188
6189
6190
6191
6192
6193
6194
6195
6196
6197
6198
6199
6200
6201
6202
6203
6204
6205
6206
6207
6208
6209
6210
6211
6212
6213
6214
6215
6216
6217
6218
6219
6220
6221
6222
6223
6224
6225
6226
6227
6228
6229
6230
6231
6232
6233
6234
6235
6236
6237
6238
6239
6240
6241
6242
6243
6244
6245
6246
6247
6248
6249
6250
6251
6252
6253
6254
6255
6256
6257
6258
6259
6260
6261
6262
6263
6264
6265
6266
6267
6268
6269
6270
6271
6272
6273
6274
6275
6276
6277
6278
6279
6280
6281
6282
6283
6284
6285
6286
6287
6288
6289
6290
6291
6292
6293
6294
6295
6296
6297
6298
6299
6300
6301
6302
6303
6304
6305
6306
6307
6308
6309
6310
6311
6312
6313
6314
6315
6316
6317
6318
6319
6320
6321
6322
6323
6324
6325
6326
6327
6328
6329
6330
6331
6332
6333
6334
6335
6336
6337
6338
6339
6340
6341
6342
6343
6344
6345
6346
6347
6348
6349
6350
6351
6352
6353
6354
6355
6356
6357
6358
6359
6360
6361
6362
6363
6364
6365
6366
6367
6368
6369
6370
6371
6372
6373
6374
6375
6376
6377
6378
6379
6380
6381
6382
6383
6384
6385
6386
6387
6388
6389
6390
6391
6392
6393
6394
6395
6396
6397
6398
6399
6400
6401
6402
6403
6404
6405
6406
6407
6408
6409
6410
6411
6412
6413
6414
6415
6416
6417
6418
6419
6420
6421
6422
6423
6424
6425
6426
6427
6428
6429
6430
6431
6432
6433
6434
6435
6436
6437
6438
6439
6440
6441
6442
6443
import {Request} from '../lib/request';
import {Response} from '../lib/response';
import {AWSError} from '../lib/error';
import {Service} from '../lib/service';
import {ServiceConfigurationOptions} from '../lib/service';
import {ConfigBase as Config} from '../lib/config-base';
interface Blob {}
declare class QuickSight extends Service {
/**
* Constructs a service object. This object has one method for each API operation.
*/
constructor(options?: QuickSight.Types.ClientConfiguration)
config: Config & QuickSight.Types.ClientConfiguration;
/**
* Cancels an ongoing ingestion of data into SPICE.
*/
cancelIngestion(params: QuickSight.Types.CancelIngestionRequest, callback?: (err: AWSError, data: QuickSight.Types.CancelIngestionResponse) => void): Request<QuickSight.Types.CancelIngestionResponse, AWSError>;
/**
* Cancels an ongoing ingestion of data into SPICE.
*/
cancelIngestion(callback?: (err: AWSError, data: QuickSight.Types.CancelIngestionResponse) => void): Request<QuickSight.Types.CancelIngestionResponse, AWSError>;
/**
* Creates Amazon QuickSight customizations the current AWS Region. Currently, you can add a custom default theme by using the CreateAccountCustomization or UpdateAccountCustomization API operation. To further customize QuickSight by removing QuickSight sample assets and videos for all new users, see Customizing QuickSight in the Amazon QuickSight User Guide. You can create customizations for your AWS account or, if you specify a namespace, for a QuickSight namespace instead. Customizations that apply to a namespace always override customizations that apply to an AWS account. To find out which customizations apply, use the DescribeAccountCustomization API operation. Before you use the CreateAccountCustomization API operation to add a theme as the namespace default, make sure that you first share the theme with the namespace. If you don't share it with the namespace, the theme isn't visible to your users even if you make it the default theme. To check if the theme is shared, view the current permissions by using the DescribeThemePermissions API operation. To share the theme, grant permissions by using the UpdateThemePermissions API operation.
*/
createAccountCustomization(params: QuickSight.Types.CreateAccountCustomizationRequest, callback?: (err: AWSError, data: QuickSight.Types.CreateAccountCustomizationResponse) => void): Request<QuickSight.Types.CreateAccountCustomizationResponse, AWSError>;
/**
* Creates Amazon QuickSight customizations the current AWS Region. Currently, you can add a custom default theme by using the CreateAccountCustomization or UpdateAccountCustomization API operation. To further customize QuickSight by removing QuickSight sample assets and videos for all new users, see Customizing QuickSight in the Amazon QuickSight User Guide. You can create customizations for your AWS account or, if you specify a namespace, for a QuickSight namespace instead. Customizations that apply to a namespace always override customizations that apply to an AWS account. To find out which customizations apply, use the DescribeAccountCustomization API operation. Before you use the CreateAccountCustomization API operation to add a theme as the namespace default, make sure that you first share the theme with the namespace. If you don't share it with the namespace, the theme isn't visible to your users even if you make it the default theme. To check if the theme is shared, view the current permissions by using the DescribeThemePermissions API operation. To share the theme, grant permissions by using the UpdateThemePermissions API operation.
*/
createAccountCustomization(callback?: (err: AWSError, data: QuickSight.Types.CreateAccountCustomizationResponse) => void): Request<QuickSight.Types.CreateAccountCustomizationResponse, AWSError>;
/**
* Creates an analysis in Amazon QuickSight.
*/
createAnalysis(params: QuickSight.Types.CreateAnalysisRequest, callback?: (err: AWSError, data: QuickSight.Types.CreateAnalysisResponse) => void): Request<QuickSight.Types.CreateAnalysisResponse, AWSError>;
/**
* Creates an analysis in Amazon QuickSight.
*/
createAnalysis(callback?: (err: AWSError, data: QuickSight.Types.CreateAnalysisResponse) => void): Request<QuickSight.Types.CreateAnalysisResponse, AWSError>;
/**
* Creates a dashboard from a template. To first create a template, see the CreateTemplate API operation. A dashboard is an entity in QuickSight that identifies QuickSight reports, created from analyses. You can share QuickSight dashboards. With the right permissions, you can create scheduled email reports from them. If you have the correct permissions, you can create a dashboard from a template that exists in a different AWS account.
*/
createDashboard(params: QuickSight.Types.CreateDashboardRequest, callback?: (err: AWSError, data: QuickSight.Types.CreateDashboardResponse) => void): Request<QuickSight.Types.CreateDashboardResponse, AWSError>;
/**
* Creates a dashboard from a template. To first create a template, see the CreateTemplate API operation. A dashboard is an entity in QuickSight that identifies QuickSight reports, created from analyses. You can share QuickSight dashboards. With the right permissions, you can create scheduled email reports from them. If you have the correct permissions, you can create a dashboard from a template that exists in a different AWS account.
*/
createDashboard(callback?: (err: AWSError, data: QuickSight.Types.CreateDashboardResponse) => void): Request<QuickSight.Types.CreateDashboardResponse, AWSError>;
/**
* Creates a dataset.
*/
createDataSet(params: QuickSight.Types.CreateDataSetRequest, callback?: (err: AWSError, data: QuickSight.Types.CreateDataSetResponse) => void): Request<QuickSight.Types.CreateDataSetResponse, AWSError>;
/**
* Creates a dataset.
*/
createDataSet(callback?: (err: AWSError, data: QuickSight.Types.CreateDataSetResponse) => void): Request<QuickSight.Types.CreateDataSetResponse, AWSError>;
/**
* Creates a data source.
*/
createDataSource(params: QuickSight.Types.CreateDataSourceRequest, callback?: (err: AWSError, data: QuickSight.Types.CreateDataSourceResponse) => void): Request<QuickSight.Types.CreateDataSourceResponse, AWSError>;
/**
* Creates a data source.
*/
createDataSource(callback?: (err: AWSError, data: QuickSight.Types.CreateDataSourceResponse) => void): Request<QuickSight.Types.CreateDataSourceResponse, AWSError>;
/**
* Creates an Amazon QuickSight group. The permissions resource is arn:aws:quicksight:us-east-1:<relevant-aws-account-id>:group/default/<group-name> . The response is a group object.
*/
createGroup(params: QuickSight.Types.CreateGroupRequest, callback?: (err: AWSError, data: QuickSight.Types.CreateGroupResponse) => void): Request<QuickSight.Types.CreateGroupResponse, AWSError>;
/**
* Creates an Amazon QuickSight group. The permissions resource is arn:aws:quicksight:us-east-1:<relevant-aws-account-id>:group/default/<group-name> . The response is a group object.
*/
createGroup(callback?: (err: AWSError, data: QuickSight.Types.CreateGroupResponse) => void): Request<QuickSight.Types.CreateGroupResponse, AWSError>;
/**
* Adds an Amazon QuickSight user to an Amazon QuickSight group.
*/
createGroupMembership(params: QuickSight.Types.CreateGroupMembershipRequest, callback?: (err: AWSError, data: QuickSight.Types.CreateGroupMembershipResponse) => void): Request<QuickSight.Types.CreateGroupMembershipResponse, AWSError>;
/**
* Adds an Amazon QuickSight user to an Amazon QuickSight group.
*/
createGroupMembership(callback?: (err: AWSError, data: QuickSight.Types.CreateGroupMembershipResponse) => void): Request<QuickSight.Types.CreateGroupMembershipResponse, AWSError>;
/**
* Creates an assignment with one specified IAM policy, identified by its Amazon Resource Name (ARN). This policy will be assigned to specified groups or users of Amazon QuickSight. The users and groups need to be in the same namespace.
*/
createIAMPolicyAssignment(params: QuickSight.Types.CreateIAMPolicyAssignmentRequest, callback?: (err: AWSError, data: QuickSight.Types.CreateIAMPolicyAssignmentResponse) => void): Request<QuickSight.Types.CreateIAMPolicyAssignmentResponse, AWSError>;
/**
* Creates an assignment with one specified IAM policy, identified by its Amazon Resource Name (ARN). This policy will be assigned to specified groups or users of Amazon QuickSight. The users and groups need to be in the same namespace.
*/
createIAMPolicyAssignment(callback?: (err: AWSError, data: QuickSight.Types.CreateIAMPolicyAssignmentResponse) => void): Request<QuickSight.Types.CreateIAMPolicyAssignmentResponse, AWSError>;
/**
* Creates and starts a new SPICE ingestion on a dataset Any ingestions operating on tagged datasets inherit the same tags automatically for use in access control. For an example, see How do I create an IAM policy to control access to Amazon EC2 resources using tags? in the AWS Knowledge Center. Tags are visible on the tagged dataset, but not on the ingestion resource.
*/
createIngestion(params: QuickSight.Types.CreateIngestionRequest, callback?: (err: AWSError, data: QuickSight.Types.CreateIngestionResponse) => void): Request<QuickSight.Types.CreateIngestionResponse, AWSError>;
/**
* Creates and starts a new SPICE ingestion on a dataset Any ingestions operating on tagged datasets inherit the same tags automatically for use in access control. For an example, see How do I create an IAM policy to control access to Amazon EC2 resources using tags? in the AWS Knowledge Center. Tags are visible on the tagged dataset, but not on the ingestion resource.
*/
createIngestion(callback?: (err: AWSError, data: QuickSight.Types.CreateIngestionResponse) => void): Request<QuickSight.Types.CreateIngestionResponse, AWSError>;
/**
* (Enterprise edition only) Creates a new namespace for you to use with Amazon QuickSight. A namespace allows you to isolate the QuickSight users and groups that are registered for that namespace. Users that access the namespace can share assets only with other users or groups in the same namespace. They can't see users and groups in other namespaces. You can create a namespace after your AWS account is subscribed to QuickSight. The namespace must be unique within the AWS account. By default, there is a limit of 100 namespaces per AWS account. To increase your limit, create a ticket with AWS Support.
*/
createNamespace(params: QuickSight.Types.CreateNamespaceRequest, callback?: (err: AWSError, data: QuickSight.Types.CreateNamespaceResponse) => void): Request<QuickSight.Types.CreateNamespaceResponse, AWSError>;
/**
* (Enterprise edition only) Creates a new namespace for you to use with Amazon QuickSight. A namespace allows you to isolate the QuickSight users and groups that are registered for that namespace. Users that access the namespace can share assets only with other users or groups in the same namespace. They can't see users and groups in other namespaces. You can create a namespace after your AWS account is subscribed to QuickSight. The namespace must be unique within the AWS account. By default, there is a limit of 100 namespaces per AWS account. To increase your limit, create a ticket with AWS Support.
*/
createNamespace(callback?: (err: AWSError, data: QuickSight.Types.CreateNamespaceResponse) => void): Request<QuickSight.Types.CreateNamespaceResponse, AWSError>;
/**
* Creates a template from an existing QuickSight analysis or template. You can use the resulting template to create a dashboard. A template is an entity in QuickSight that encapsulates the metadata required to create an analysis and that you can use to create s dashboard. A template adds a layer of abstraction by using placeholders to replace the dataset associated with the 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.
*/
createTemplate(params: QuickSight.Types.CreateTemplateRequest, callback?: (err: AWSError, data: QuickSight.Types.CreateTemplateResponse) => void): Request<QuickSight.Types.CreateTemplateResponse, AWSError>;
/**
* Creates a template from an existing QuickSight analysis or template. You can use the resulting template to create a dashboard. A template is an entity in QuickSight that encapsulates the metadata required to create an analysis and that you can use to create s dashboard. A template adds a layer of abstraction by using placeholders to replace the dataset associated with the 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.
*/
createTemplate(callback?: (err: AWSError, data: QuickSight.Types.CreateTemplateResponse) => void): Request<QuickSight.Types.CreateTemplateResponse, AWSError>;
/**
* Creates a template alias for a template.
*/
createTemplateAlias(params: QuickSight.Types.CreateTemplateAliasRequest, callback?: (err: AWSError, data: QuickSight.Types.CreateTemplateAliasResponse) => void): Request<QuickSight.Types.CreateTemplateAliasResponse, AWSError>;
/**
* Creates a template alias for a template.
*/
createTemplateAlias(callback?: (err: AWSError, data: QuickSight.Types.CreateTemplateAliasResponse) => void): Request<QuickSight.Types.CreateTemplateAliasResponse, AWSError>;
/**
* Creates a theme. A theme is set of configuration options for color and layout. Themes apply to analyses and dashboards. For more information, see Using Themes in Amazon QuickSight in the Amazon QuickSight User Guide.
*/
createTheme(params: QuickSight.Types.CreateThemeRequest, callback?: (err: AWSError, data: QuickSight.Types.CreateThemeResponse) => void): Request<QuickSight.Types.CreateThemeResponse, AWSError>;
/**
* Creates a theme. A theme is set of configuration options for color and layout. Themes apply to analyses and dashboards. For more information, see Using Themes in Amazon QuickSight in the Amazon QuickSight User Guide.
*/
createTheme(callback?: (err: AWSError, data: QuickSight.Types.CreateThemeResponse) => void): Request<QuickSight.Types.CreateThemeResponse, AWSError>;
/**
* Creates a theme alias for a theme.
*/
createThemeAlias(params: QuickSight.Types.CreateThemeAliasRequest, callback?: (err: AWSError, data: QuickSight.Types.CreateThemeAliasResponse) => void): Request<QuickSight.Types.CreateThemeAliasResponse, AWSError>;
/**
* Creates a theme alias for a theme.
*/
createThemeAlias(callback?: (err: AWSError, data: QuickSight.Types.CreateThemeAliasResponse) => void): Request<QuickSight.Types.CreateThemeAliasResponse, AWSError>;
/**
* Deletes all Amazon QuickSight customizations in this AWS Region for the specified AWS account and QuickSight namespace.
*/
deleteAccountCustomization(params: QuickSight.Types.DeleteAccountCustomizationRequest, callback?: (err: AWSError, data: QuickSight.Types.DeleteAccountCustomizationResponse) => void): Request<QuickSight.Types.DeleteAccountCustomizationResponse, AWSError>;
/**
* Deletes all Amazon QuickSight customizations in this AWS Region for the specified AWS account and QuickSight namespace.
*/
deleteAccountCustomization(callback?: (err: AWSError, data: QuickSight.Types.DeleteAccountCustomizationResponse) => void): Request<QuickSight.Types.DeleteAccountCustomizationResponse, AWSError>;
/**
* Deletes an analysis from Amazon QuickSight. You can optionally include a recovery window during which you can restore the analysis. If you don't specify a recovery window value, the operation defaults to 30 days. QuickSight attaches a DeletionTime stamp to the response that specifies the end of the recovery window. At the end of the recovery window, QuickSight deletes the analysis permanently. At any time before recovery window ends, you can use the RestoreAnalysis API operation to remove the DeletionTime stamp and cancel the deletion of the analysis. The analysis remains visible in the API until it's deleted, so you can describe it but you can't make a template from it. An analysis that's scheduled for deletion isn't accessible in the QuickSight console. To access it in the console, restore it. Deleting an analysis doesn't delete the dashboards that you publish from it.
*/
deleteAnalysis(params: QuickSight.Types.DeleteAnalysisRequest, callback?: (err: AWSError, data: QuickSight.Types.DeleteAnalysisResponse) => void): Request<QuickSight.Types.DeleteAnalysisResponse, AWSError>;
/**
* Deletes an analysis from Amazon QuickSight. You can optionally include a recovery window during which you can restore the analysis. If you don't specify a recovery window value, the operation defaults to 30 days. QuickSight attaches a DeletionTime stamp to the response that specifies the end of the recovery window. At the end of the recovery window, QuickSight deletes the analysis permanently. At any time before recovery window ends, you can use the RestoreAnalysis API operation to remove the DeletionTime stamp and cancel the deletion of the analysis. The analysis remains visible in the API until it's deleted, so you can describe it but you can't make a template from it. An analysis that's scheduled for deletion isn't accessible in the QuickSight console. To access it in the console, restore it. Deleting an analysis doesn't delete the dashboards that you publish from it.
*/
deleteAnalysis(callback?: (err: AWSError, data: QuickSight.Types.DeleteAnalysisResponse) => void): Request<QuickSight.Types.DeleteAnalysisResponse, AWSError>;
/**
* Deletes a dashboard.
*/
deleteDashboard(params: QuickSight.Types.DeleteDashboardRequest, callback?: (err: AWSError, data: QuickSight.Types.DeleteDashboardResponse) => void): Request<QuickSight.Types.DeleteDashboardResponse, AWSError>;
/**
* Deletes a dashboard.
*/
deleteDashboard(callback?: (err: AWSError, data: QuickSight.Types.DeleteDashboardResponse) => void): Request<QuickSight.Types.DeleteDashboardResponse, AWSError>;
/**
* Deletes a dataset.
*/
deleteDataSet(params: QuickSight.Types.DeleteDataSetRequest, callback?: (err: AWSError, data: QuickSight.Types.DeleteDataSetResponse) => void): Request<QuickSight.Types.DeleteDataSetResponse, AWSError>;
/**
* Deletes a dataset.
*/
deleteDataSet(callback?: (err: AWSError, data: QuickSight.Types.DeleteDataSetResponse) => void): Request<QuickSight.Types.DeleteDataSetResponse, AWSError>;
/**
* Deletes the data source permanently. This operation breaks all the datasets that reference the deleted data source.
*/
deleteDataSource(params: QuickSight.Types.DeleteDataSourceRequest, callback?: (err: AWSError, data: QuickSight.Types.DeleteDataSourceResponse) => void): Request<QuickSight.Types.DeleteDataSourceResponse, AWSError>;
/**
* Deletes the data source permanently. This operation breaks all the datasets that reference the deleted data source.
*/
deleteDataSource(callback?: (err: AWSError, data: QuickSight.Types.DeleteDataSourceResponse) => void): Request<QuickSight.Types.DeleteDataSourceResponse, AWSError>;
/**
* Removes a user group from Amazon QuickSight.
*/
deleteGroup(params: QuickSight.Types.DeleteGroupRequest, callback?: (err: AWSError, data: QuickSight.Types.DeleteGroupResponse) => void): Request<QuickSight.Types.DeleteGroupResponse, AWSError>;
/**
* Removes a user group from Amazon QuickSight.
*/
deleteGroup(callback?: (err: AWSError, data: QuickSight.Types.DeleteGroupResponse) => void): Request<QuickSight.Types.DeleteGroupResponse, AWSError>;
/**
* Removes a user from a group so that the user is no longer a member of the group.
*/
deleteGroupMembership(params: QuickSight.Types.DeleteGroupMembershipRequest, callback?: (err: AWSError, data: QuickSight.Types.DeleteGroupMembershipResponse) => void): Request<QuickSight.Types.DeleteGroupMembershipResponse, AWSError>;
/**
* Removes a user from a group so that the user is no longer a member of the group.
*/
deleteGroupMembership(callback?: (err: AWSError, data: QuickSight.Types.DeleteGroupMembershipResponse) => void): Request<QuickSight.Types.DeleteGroupMembershipResponse, AWSError>;
/**
* Deletes an existing IAM policy assignment.
*/
deleteIAMPolicyAssignment(params: QuickSight.Types.DeleteIAMPolicyAssignmentRequest, callback?: (err: AWSError, data: QuickSight.Types.DeleteIAMPolicyAssignmentResponse) => void): Request<QuickSight.Types.DeleteIAMPolicyAssignmentResponse, AWSError>;
/**
* Deletes an existing IAM policy assignment.
*/
deleteIAMPolicyAssignment(callback?: (err: AWSError, data: QuickSight.Types.DeleteIAMPolicyAssignmentResponse) => void): Request<QuickSight.Types.DeleteIAMPolicyAssignmentResponse, AWSError>;
/**
* Deletes a namespace and the users and groups that are associated with the namespace. This is an asynchronous process. Assets including dashboards, analyses, datasets and data sources are not deleted. To delete these assets, you use the API operations for the relevant asset.
*/
deleteNamespace(params: QuickSight.Types.DeleteNamespaceRequest, callback?: (err: AWSError, data: QuickSight.Types.DeleteNamespaceResponse) => void): Request<QuickSight.Types.DeleteNamespaceResponse, AWSError>;
/**
* Deletes a namespace and the users and groups that are associated with the namespace. This is an asynchronous process. Assets including dashboards, analyses, datasets and data sources are not deleted. To delete these assets, you use the API operations for the relevant asset.
*/
deleteNamespace(callback?: (err: AWSError, data: QuickSight.Types.DeleteNamespaceResponse) => void): Request<QuickSight.Types.DeleteNamespaceResponse, AWSError>;
/**
* Deletes a template.
*/
deleteTemplate(params: QuickSight.Types.DeleteTemplateRequest, callback?: (err: AWSError, data: QuickSight.Types.DeleteTemplateResponse) => void): Request<QuickSight.Types.DeleteTemplateResponse, AWSError>;
/**
* Deletes a template.
*/
deleteTemplate(callback?: (err: AWSError, data: QuickSight.Types.DeleteTemplateResponse) => void): Request<QuickSight.Types.DeleteTemplateResponse, AWSError>;
/**
* Deletes the item that the specified template alias points to. If you provide a specific alias, you delete the version of the template that the alias points to.
*/
deleteTemplateAlias(params: QuickSight.Types.DeleteTemplateAliasRequest, callback?: (err: AWSError, data: QuickSight.Types.DeleteTemplateAliasResponse) => void): Request<QuickSight.Types.DeleteTemplateAliasResponse, AWSError>;
/**
* Deletes the item that the specified template alias points to. If you provide a specific alias, you delete the version of the template that the alias points to.
*/
deleteTemplateAlias(callback?: (err: AWSError, data: QuickSight.Types.DeleteTemplateAliasResponse) => void): Request<QuickSight.Types.DeleteTemplateAliasResponse, AWSError>;
/**
* Deletes a theme.
*/
deleteTheme(params: QuickSight.Types.DeleteThemeRequest, callback?: (err: AWSError, data: QuickSight.Types.DeleteThemeResponse) => void): Request<QuickSight.Types.DeleteThemeResponse, AWSError>;
/**
* Deletes a theme.
*/
deleteTheme(callback?: (err: AWSError, data: QuickSight.Types.DeleteThemeResponse) => void): Request<QuickSight.Types.DeleteThemeResponse, AWSError>;
/**
* Deletes the version of the theme that the specified theme alias points to. If you provide a specific alias, you delete the version of the theme that the alias points to.
*/
deleteThemeAlias(params: QuickSight.Types.DeleteThemeAliasRequest, callback?: (err: AWSError, data: QuickSight.Types.DeleteThemeAliasResponse) => void): Request<QuickSight.Types.DeleteThemeAliasResponse, AWSError>;
/**
* Deletes the version of the theme that the specified theme alias points to. If you provide a specific alias, you delete the version of the theme that the alias points to.
*/
deleteThemeAlias(callback?: (err: AWSError, data: QuickSight.Types.DeleteThemeAliasResponse) => void): Request<QuickSight.Types.DeleteThemeAliasResponse, AWSError>;
/**
* Deletes the Amazon QuickSight user that is associated with the identity of the AWS Identity and Access Management (IAM) user or role that's making the call. The IAM user isn't deleted as a result of this call.
*/
deleteUser(params: QuickSight.Types.DeleteUserRequest, callback?: (err: AWSError, data: QuickSight.Types.DeleteUserResponse) => void): Request<QuickSight.Types.DeleteUserResponse, AWSError>;
/**
* Deletes the Amazon QuickSight user that is associated with the identity of the AWS Identity and Access Management (IAM) user or role that's making the call. The IAM user isn't deleted as a result of this call.
*/
deleteUser(callback?: (err: AWSError, data: QuickSight.Types.DeleteUserResponse) => void): Request<QuickSight.Types.DeleteUserResponse, AWSError>;
/**
* Deletes a user identified by its principal ID.
*/
deleteUserByPrincipalId(params: QuickSight.Types.DeleteUserByPrincipalIdRequest, callback?: (err: AWSError, data: QuickSight.Types.DeleteUserByPrincipalIdResponse) => void): Request<QuickSight.Types.DeleteUserByPrincipalIdResponse, AWSError>;
/**
* Deletes a user identified by its principal ID.
*/
deleteUserByPrincipalId(callback?: (err: AWSError, data: QuickSight.Types.DeleteUserByPrincipalIdResponse) => void): Request<QuickSight.Types.DeleteUserByPrincipalIdResponse, AWSError>;
/**
* Describes the customizations associated with the provided AWS account and Amazon QuickSight namespace in an AWS Region. The QuickSight console evaluates which customizations to apply by running this API operation with the Resolved flag included. To determine what customizations display when you run this command, it can help to visualize the relationship of the entities involved. AWS Account - The AWS account exists at the top of the hierarchy. It has the potential to use all of the AWS Regions and AWS Services. When you subscribe to QuickSight, you choose one AWS Region to use as your home Region. That's where your free SPICE capacity is located. You can use QuickSight in any supported AWS Region. AWS Region - In each AWS Region where you sign in to QuickSight at least once, QuickSight acts as a separate instance of the same service. If you have a user directory, it resides in us-east-1, which is the US East (N. Virginia). Generally speaking, these users have access to QuickSight in any AWS Region, unless they are constrained to a namespace. To run the command in a different AWS Region, you change your Region settings. If you're using the AWS CLI, you can use one of the following options: Use command line options. Use named profiles. Run aws configure to change your default AWS Region. Use Enter to key the same settings for your keys. For more information, see Configuring the AWS CLI. Namespace - A QuickSight namespace is a partition that contains users and assets (data sources, datasets, dashboards, and so on). To access assets that are in a specific namespace, users and groups must also be part of the same namespace. People who share a namespace are completely isolated from users and assets in other namespaces, even if they are in the same AWS account and AWS Region. Applied customizations - Within an AWS Region, a set of QuickSight customizations can apply to an AWS account or to a namespace. Settings that you apply to a namespace override settings that you apply to an AWS account. All settings are isolated to a single AWS Region. To apply them in other AWS Regions, run the CreateAccountCustomization command in each AWS Region where you want to apply the same customizations.
*/
describeAccountCustomization(params: QuickSight.Types.DescribeAccountCustomizationRequest, callback?: (err: AWSError, data: QuickSight.Types.DescribeAccountCustomizationResponse) => void): Request<QuickSight.Types.DescribeAccountCustomizationResponse, AWSError>;
/**
* Describes the customizations associated with the provided AWS account and Amazon QuickSight namespace in an AWS Region. The QuickSight console evaluates which customizations to apply by running this API operation with the Resolved flag included. To determine what customizations display when you run this command, it can help to visualize the relationship of the entities involved. AWS Account - The AWS account exists at the top of the hierarchy. It has the potential to use all of the AWS Regions and AWS Services. When you subscribe to QuickSight, you choose one AWS Region to use as your home Region. That's where your free SPICE capacity is located. You can use QuickSight in any supported AWS Region. AWS Region - In each AWS Region where you sign in to QuickSight at least once, QuickSight acts as a separate instance of the same service. If you have a user directory, it resides in us-east-1, which is the US East (N. Virginia). Generally speaking, these users have access to QuickSight in any AWS Region, unless they are constrained to a namespace. To run the command in a different AWS Region, you change your Region settings. If you're using the AWS CLI, you can use one of the following options: Use command line options. Use named profiles. Run aws configure to change your default AWS Region. Use Enter to key the same settings for your keys. For more information, see Configuring the AWS CLI. Namespace - A QuickSight namespace is a partition that contains users and assets (data sources, datasets, dashboards, and so on). To access assets that are in a specific namespace, users and groups must also be part of the same namespace. People who share a namespace are completely isolated from users and assets in other namespaces, even if they are in the same AWS account and AWS Region. Applied customizations - Within an AWS Region, a set of QuickSight customizations can apply to an AWS account or to a namespace. Settings that you apply to a namespace override settings that you apply to an AWS account. All settings are isolated to a single AWS Region. To apply them in other AWS Regions, run the CreateAccountCustomization command in each AWS Region where you want to apply the same customizations.
*/
describeAccountCustomization(callback?: (err: AWSError, data: QuickSight.Types.DescribeAccountCustomizationResponse) => void): Request<QuickSight.Types.DescribeAccountCustomizationResponse, AWSError>;
/**
* Describes the settings that were used when your QuickSight subscription was first created in this AWS account.
*/
describeAccountSettings(params: QuickSight.Types.DescribeAccountSettingsRequest, callback?: (err: AWSError, data: QuickSight.Types.DescribeAccountSettingsResponse) => void): Request<QuickSight.Types.DescribeAccountSettingsResponse, AWSError>;
/**
* Describes the settings that were used when your QuickSight subscription was first created in this AWS account.
*/
describeAccountSettings(callback?: (err: AWSError, data: QuickSight.Types.DescribeAccountSettingsResponse) => void): Request<QuickSight.Types.DescribeAccountSettingsResponse, AWSError>;
/**
* Provides a summary of the metadata for an analysis.
*/
describeAnalysis(params: QuickSight.Types.DescribeAnalysisRequest, callback?: (err: AWSError, data: QuickSight.Types.DescribeAnalysisResponse) => void): Request<QuickSight.Types.DescribeAnalysisResponse, AWSError>;
/**
* Provides a summary of the metadata for an analysis.
*/
describeAnalysis(callback?: (err: AWSError, data: QuickSight.Types.DescribeAnalysisResponse) => void): Request<QuickSight.Types.DescribeAnalysisResponse, AWSError>;
/**
* Provides the read and write permissions for an analysis.
*/
describeAnalysisPermissions(params: QuickSight.Types.DescribeAnalysisPermissionsRequest, callback?: (err: AWSError, data: QuickSight.Types.DescribeAnalysisPermissionsResponse) => void): Request<QuickSight.Types.DescribeAnalysisPermissionsResponse, AWSError>;
/**
* Provides the read and write permissions for an analysis.
*/
describeAnalysisPermissions(callback?: (err: AWSError, data: QuickSight.Types.DescribeAnalysisPermissionsResponse) => void): Request<QuickSight.Types.DescribeAnalysisPermissionsResponse, AWSError>;
/**
* Provides a summary for a dashboard.
*/
describeDashboard(params: QuickSight.Types.DescribeDashboardRequest, callback?: (err: AWSError, data: QuickSight.Types.DescribeDashboardResponse) => void): Request<QuickSight.Types.DescribeDashboardResponse, AWSError>;
/**
* Provides a summary for a dashboard.
*/
describeDashboard(callback?: (err: AWSError, data: QuickSight.Types.DescribeDashboardResponse) => void): Request<QuickSight.Types.DescribeDashboardResponse, AWSError>;
/**
* Describes read and write permissions for a dashboard.
*/
describeDashboardPermissions(params: QuickSight.Types.DescribeDashboardPermissionsRequest, callback?: (err: AWSError, data: QuickSight.Types.DescribeDashboardPermissionsResponse) => void): Request<QuickSight.Types.DescribeDashboardPermissionsResponse, AWSError>;
/**
* Describes read and write permissions for a dashboard.
*/
describeDashboardPermissions(callback?: (err: AWSError, data: QuickSight.Types.DescribeDashboardPermissionsResponse) => void): Request<QuickSight.Types.DescribeDashboardPermissionsResponse, AWSError>;
/**
* Describes a dataset.
*/
describeDataSet(params: QuickSight.Types.DescribeDataSetRequest, callback?: (err: AWSError, data: QuickSight.Types.DescribeDataSetResponse) => void): Request<QuickSight.Types.DescribeDataSetResponse, AWSError>;
/**
* Describes a dataset.
*/
describeDataSet(callback?: (err: AWSError, data: QuickSight.Types.DescribeDataSetResponse) => void): Request<QuickSight.Types.DescribeDataSetResponse, AWSError>;
/**
* Describes the permissions on a dataset. The permissions resource is arn:aws:quicksight:region:aws-account-id:dataset/data-set-id.
*/
describeDataSetPermissions(params: QuickSight.Types.DescribeDataSetPermissionsRequest, callback?: (err: AWSError, data: QuickSight.Types.DescribeDataSetPermissionsResponse) => void): Request<QuickSight.Types.DescribeDataSetPermissionsResponse, AWSError>;
/**
* Describes the permissions on a dataset. The permissions resource is arn:aws:quicksight:region:aws-account-id:dataset/data-set-id.
*/
describeDataSetPermissions(callback?: (err: AWSError, data: QuickSight.Types.DescribeDataSetPermissionsResponse) => void): Request<QuickSight.Types.DescribeDataSetPermissionsResponse, AWSError>;
/**
* Describes a data source.
*/
describeDataSource(params: QuickSight.Types.DescribeDataSourceRequest, callback?: (err: AWSError, data: QuickSight.Types.DescribeDataSourceResponse) => void): Request<QuickSight.Types.DescribeDataSourceResponse, AWSError>;
/**
* Describes a data source.
*/
describeDataSource(callback?: (err: AWSError, data: QuickSight.Types.DescribeDataSourceResponse) => void): Request<QuickSight.Types.DescribeDataSourceResponse, AWSError>;
/**
* Describes the resource permissions for a data source.
*/
describeDataSourcePermissions(params: QuickSight.Types.DescribeDataSourcePermissionsRequest, callback?: (err: AWSError, data: QuickSight.Types.DescribeDataSourcePermissionsResponse) => void): Request<QuickSight.Types.DescribeDataSourcePermissionsResponse, AWSError>;
/**
* Describes the resource permissions for a data source.
*/
describeDataSourcePermissions(callback?: (err: AWSError, data: QuickSight.Types.DescribeDataSourcePermissionsResponse) => void): Request<QuickSight.Types.DescribeDataSourcePermissionsResponse, AWSError>;
/**
* Returns an Amazon QuickSight group's description and Amazon Resource Name (ARN).
*/
describeGroup(params: QuickSight.Types.DescribeGroupRequest, callback?: (err: AWSError, data: QuickSight.Types.DescribeGroupResponse) => void): Request<QuickSight.Types.DescribeGroupResponse, AWSError>;
/**
* Returns an Amazon QuickSight group's description and Amazon Resource Name (ARN).
*/
describeGroup(callback?: (err: AWSError, data: QuickSight.Types.DescribeGroupResponse) => void): Request<QuickSight.Types.DescribeGroupResponse, AWSError>;
/**
* Describes an existing IAM policy assignment, as specified by the assignment name.
*/
describeIAMPolicyAssignment(params: QuickSight.Types.DescribeIAMPolicyAssignmentRequest, callback?: (err: AWSError, data: QuickSight.Types.DescribeIAMPolicyAssignmentResponse) => void): Request<QuickSight.Types.DescribeIAMPolicyAssignmentResponse, AWSError>;
/**
* Describes an existing IAM policy assignment, as specified by the assignment name.
*/
describeIAMPolicyAssignment(callback?: (err: AWSError, data: QuickSight.Types.DescribeIAMPolicyAssignmentResponse) => void): Request<QuickSight.Types.DescribeIAMPolicyAssignmentResponse, AWSError>;
/**
* Describes a SPICE ingestion.
*/
describeIngestion(params: QuickSight.Types.DescribeIngestionRequest, callback?: (err: AWSError, data: QuickSight.Types.DescribeIngestionResponse) => void): Request<QuickSight.Types.DescribeIngestionResponse, AWSError>;
/**
* Describes a SPICE ingestion.
*/
describeIngestion(callback?: (err: AWSError, data: QuickSight.Types.DescribeIngestionResponse) => void): Request<QuickSight.Types.DescribeIngestionResponse, AWSError>;
/**
* Describes the current namespace.
*/
describeNamespace(params: QuickSight.Types.DescribeNamespaceRequest, callback?: (err: AWSError, data: QuickSight.Types.DescribeNamespaceResponse) => void): Request<QuickSight.Types.DescribeNamespaceResponse, AWSError>;
/**
* Describes the current namespace.
*/
describeNamespace(callback?: (err: AWSError, data: QuickSight.Types.DescribeNamespaceResponse) => void): Request<QuickSight.Types.DescribeNamespaceResponse, AWSError>;
/**
* Describes a template's metadata.
*/
describeTemplate(params: QuickSight.Types.DescribeTemplateRequest, callback?: (err: AWSError, data: QuickSight.Types.DescribeTemplateResponse) => void): Request<QuickSight.Types.DescribeTemplateResponse, AWSError>;
/**
* Describes a template's metadata.
*/
describeTemplate(callback?: (err: AWSError, data: QuickSight.Types.DescribeTemplateResponse) => void): Request<QuickSight.Types.DescribeTemplateResponse, AWSError>;
/**
* Describes the template alias for a template.
*/
describeTemplateAlias(params: QuickSight.Types.DescribeTemplateAliasRequest, callback?: (err: AWSError, data: QuickSight.Types.DescribeTemplateAliasResponse) => void): Request<QuickSight.Types.DescribeTemplateAliasResponse, AWSError>;
/**
* Describes the template alias for a template.
*/
describeTemplateAlias(callback?: (err: AWSError, data: QuickSight.Types.DescribeTemplateAliasResponse) => void): Request<QuickSight.Types.DescribeTemplateAliasResponse, AWSError>;
/**
* Describes read and write permissions on a template.
*/
describeTemplatePermissions(params: QuickSight.Types.DescribeTemplatePermissionsRequest, callback?: (err: AWSError, data: QuickSight.Types.DescribeTemplatePermissionsResponse) => void): Request<QuickSight.Types.DescribeTemplatePermissionsResponse, AWSError>;
/**
* Describes read and write permissions on a template.
*/
describeTemplatePermissions(callback?: (err: AWSError, data: QuickSight.Types.DescribeTemplatePermissionsResponse) => void): Request<QuickSight.Types.DescribeTemplatePermissionsResponse, AWSError>;
/**
* Describes a theme.
*/
describeTheme(params: QuickSight.Types.DescribeThemeRequest, callback?: (err: AWSError, data: QuickSight.Types.DescribeThemeResponse) => void): Request<QuickSight.Types.DescribeThemeResponse, AWSError>;
/**
* Describes a theme.
*/
describeTheme(callback?: (err: AWSError, data: QuickSight.Types.DescribeThemeResponse) => void): Request<QuickSight.Types.DescribeThemeResponse, AWSError>;
/**
* Describes the alias for a theme.
*/
describeThemeAlias(params: QuickSight.Types.DescribeThemeAliasRequest, callback?: (err: AWSError, data: QuickSight.Types.DescribeThemeAliasResponse) => void): Request<QuickSight.Types.DescribeThemeAliasResponse, AWSError>;
/**
* Describes the alias for a theme.
*/
describeThemeAlias(callback?: (err: AWSError, data: QuickSight.Types.DescribeThemeAliasResponse) => void): Request<QuickSight.Types.DescribeThemeAliasResponse, AWSError>;
/**
* Describes the read and write permissions for a theme.
*/
describeThemePermissions(params: QuickSight.Types.DescribeThemePermissionsRequest, callback?: (err: AWSError, data: QuickSight.Types.DescribeThemePermissionsResponse) => void): Request<QuickSight.Types.DescribeThemePermissionsResponse, AWSError>;
/**
* Describes the read and write permissions for a theme.
*/
describeThemePermissions(callback?: (err: AWSError, data: QuickSight.Types.DescribeThemePermissionsResponse) => void): Request<QuickSight.Types.DescribeThemePermissionsResponse, AWSError>;
/**
* Returns information about a user, given the user name.
*/
describeUser(params: QuickSight.Types.DescribeUserRequest, callback?: (err: AWSError, data: QuickSight.Types.DescribeUserResponse) => void): Request<QuickSight.Types.DescribeUserResponse, AWSError>;
/**
* Returns information about a user, given the user name.
*/
describeUser(callback?: (err: AWSError, data: QuickSight.Types.DescribeUserResponse) => void): Request<QuickSight.Types.DescribeUserResponse, AWSError>;
/**
* Generates a session URL and authorization code that you can use to embed an Amazon QuickSight read-only dashboard in your web server code. Before you use this command, make sure that you have configured the dashboards and permissions. Currently, you can use GetDashboardEmbedURL only from the server, not from the user's browser. The following rules apply to the combination of URL and authorization code: They must be used together. They can be used one time only. They are valid for 5 minutes after you run this command. The resulting user session is valid for 10 hours. For more information, see Embedding Amazon QuickSight in the Amazon QuickSight User Guide .
*/
getDashboardEmbedUrl(params: QuickSight.Types.GetDashboardEmbedUrlRequest, callback?: (err: AWSError, data: QuickSight.Types.GetDashboardEmbedUrlResponse) => void): Request<QuickSight.Types.GetDashboardEmbedUrlResponse, AWSError>;
/**
* Generates a session URL and authorization code that you can use to embed an Amazon QuickSight read-only dashboard in your web server code. Before you use this command, make sure that you have configured the dashboards and permissions. Currently, you can use GetDashboardEmbedURL only from the server, not from the user's browser. The following rules apply to the combination of URL and authorization code: They must be used together. They can be used one time only. They are valid for 5 minutes after you run this command. The resulting user session is valid for 10 hours. For more information, see Embedding Amazon QuickSight in the Amazon QuickSight User Guide .
*/
getDashboardEmbedUrl(callback?: (err: AWSError, data: QuickSight.Types.GetDashboardEmbedUrlResponse) => void): Request<QuickSight.Types.GetDashboardEmbedUrlResponse, AWSError>;
/**
* Generates a session URL and authorization code that you can use to embed the Amazon QuickSight console in your web server code. Use GetSessionEmbedUrl where you want to provide an authoring portal that allows users to create data sources, datasets, analyses, and dashboards. The users who access an embedded QuickSight console need 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 API operation. Use RegisterUser 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 Amazon QuickSight Console Customizing Access to the Amazon QuickSight Console
*/
getSessionEmbedUrl(params: QuickSight.Types.GetSessionEmbedUrlRequest, callback?: (err: AWSError, data: QuickSight.Types.GetSessionEmbedUrlResponse) => void): Request<QuickSight.Types.GetSessionEmbedUrlResponse, AWSError>;
/**
* Generates a session URL and authorization code that you can use to embed the Amazon QuickSight console in your web server code. Use GetSessionEmbedUrl where you want to provide an authoring portal that allows users to create data sources, datasets, analyses, and dashboards. The users who access an embedded QuickSight console need 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 API operation. Use RegisterUser 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 Amazon QuickSight Console Customizing Access to the Amazon QuickSight Console
*/
getSessionEmbedUrl(callback?: (err: AWSError, data: QuickSight.Types.GetSessionEmbedUrlResponse) => void): Request<QuickSight.Types.GetSessionEmbedUrlResponse, AWSError>;
/**
* Lists Amazon QuickSight analyses that exist in the specified AWS account.
*/
listAnalyses(params: QuickSight.Types.ListAnalysesRequest, callback?: (err: AWSError, data: QuickSight.Types.ListAnalysesResponse) => void): Request<QuickSight.Types.ListAnalysesResponse, AWSError>;
/**
* Lists Amazon QuickSight analyses that exist in the specified AWS account.
*/
listAnalyses(callback?: (err: AWSError, data: QuickSight.Types.ListAnalysesResponse) => void): Request<QuickSight.Types.ListAnalysesResponse, AWSError>;
/**
* Lists all the versions of the dashboards in the QuickSight subscription.
*/
listDashboardVersions(params: QuickSight.Types.ListDashboardVersionsRequest, callback?: (err: AWSError, data: QuickSight.Types.ListDashboardVersionsResponse) => void): Request<QuickSight.Types.ListDashboardVersionsResponse, AWSError>;
/**
* Lists all the versions of the dashboards in the QuickSight subscription.
*/
listDashboardVersions(callback?: (err: AWSError, data: QuickSight.Types.ListDashboardVersionsResponse) => void): Request<QuickSight.Types.ListDashboardVersionsResponse, AWSError>;
/**
* Lists dashboards in an AWS account.
*/
listDashboards(params: QuickSight.Types.ListDashboardsRequest, callback?: (err: AWSError, data: QuickSight.Types.ListDashboardsResponse) => void): Request<QuickSight.Types.ListDashboardsResponse, AWSError>;
/**
* Lists dashboards in an AWS account.
*/
listDashboards(callback?: (err: AWSError, data: QuickSight.Types.ListDashboardsResponse) => void): Request<QuickSight.Types.ListDashboardsResponse, AWSError>;
/**
* Lists all of the datasets belonging to the current AWS account in an AWS Region. The permissions resource is arn:aws:quicksight:region:aws-account-id:dataset/*.
*/
listDataSets(params: QuickSight.Types.ListDataSetsRequest, callback?: (err: AWSError, data: QuickSight.Types.ListDataSetsResponse) => void): Request<QuickSight.Types.ListDataSetsResponse, AWSError>;
/**
* Lists all of the datasets belonging to the current AWS account in an AWS Region. The permissions resource is arn:aws:quicksight:region:aws-account-id:dataset/*.
*/
listDataSets(callback?: (err: AWSError, data: QuickSight.Types.ListDataSetsResponse) => void): Request<QuickSight.Types.ListDataSetsResponse, AWSError>;
/**
* Lists data sources in current AWS Region that belong to this AWS account.
*/
listDataSources(params: QuickSight.Types.ListDataSourcesRequest, callback?: (err: AWSError, data: QuickSight.Types.ListDataSourcesResponse) => void): Request<QuickSight.Types.ListDataSourcesResponse, AWSError>;
/**
* Lists data sources in current AWS Region that belong to this AWS account.
*/
listDataSources(callback?: (err: AWSError, data: QuickSight.Types.ListDataSourcesResponse) => void): Request<QuickSight.Types.ListDataSourcesResponse, AWSError>;
/**
* Lists member users in a group.
*/
listGroupMemberships(params: QuickSight.Types.ListGroupMembershipsRequest, callback?: (err: AWSError, data: QuickSight.Types.ListGroupMembershipsResponse) => void): Request<QuickSight.Types.ListGroupMembershipsResponse, AWSError>;
/**
* Lists member users in a group.
*/
listGroupMemberships(callback?: (err: AWSError, data: QuickSight.Types.ListGroupMembershipsResponse) => void): Request<QuickSight.Types.ListGroupMembershipsResponse, AWSError>;
/**
* Lists all user groups in Amazon QuickSight.
*/
listGroups(params: QuickSight.Types.ListGroupsRequest, callback?: (err: AWSError, data: QuickSight.Types.ListGroupsResponse) => void): Request<QuickSight.Types.ListGroupsResponse, AWSError>;
/**
* Lists all user groups in Amazon QuickSight.
*/
listGroups(callback?: (err: AWSError, data: QuickSight.Types.ListGroupsResponse) => void): Request<QuickSight.Types.ListGroupsResponse, AWSError>;
/**
* Lists IAM policy assignments in the current Amazon QuickSight account.
*/
listIAMPolicyAssignments(params: QuickSight.Types.ListIAMPolicyAssignmentsRequest, callback?: (err: AWSError, data: QuickSight.Types.ListIAMPolicyAssignmentsResponse) => void): Request<QuickSight.Types.ListIAMPolicyAssignmentsResponse, AWSError>;
/**
* Lists IAM policy assignments in the current Amazon QuickSight account.
*/
listIAMPolicyAssignments(callback?: (err: AWSError, data: QuickSight.Types.ListIAMPolicyAssignmentsResponse) => void): Request<QuickSight.Types.ListIAMPolicyAssignmentsResponse, AWSError>;
/**
* Lists all the IAM policy assignments, including the Amazon Resource Names (ARNs) for the IAM policies assigned to the specified user and group or groups that the user belongs to.
*/
listIAMPolicyAssignmentsForUser(params: QuickSight.Types.ListIAMPolicyAssignmentsForUserRequest, callback?: (err: AWSError, data: QuickSight.Types.ListIAMPolicyAssignmentsForUserResponse) => void): Request<QuickSight.Types.ListIAMPolicyAssignmentsForUserResponse, AWSError>;
/**
* Lists all the IAM policy assignments, including the Amazon Resource Names (ARNs) for the IAM policies assigned to the specified user and group or groups that the user belongs to.
*/
listIAMPolicyAssignmentsForUser(callback?: (err: AWSError, data: QuickSight.Types.ListIAMPolicyAssignmentsForUserResponse) => void): Request<QuickSight.Types.ListIAMPolicyAssignmentsForUserResponse, AWSError>;
/**
* Lists the history of SPICE ingestions for a dataset.
*/
listIngestions(params: QuickSight.Types.ListIngestionsRequest, callback?: (err: AWSError, data: QuickSight.Types.ListIngestionsResponse) => void): Request<QuickSight.Types.ListIngestionsResponse, AWSError>;
/**
* Lists the history of SPICE ingestions for a dataset.
*/
listIngestions(callback?: (err: AWSError, data: QuickSight.Types.ListIngestionsResponse) => void): Request<QuickSight.Types.ListIngestionsResponse, AWSError>;
/**
* Lists the namespaces for the specified AWS account.
*/
listNamespaces(params: QuickSight.Types.ListNamespacesRequest, callback?: (err: AWSError, data: QuickSight.Types.ListNamespacesResponse) => void): Request<QuickSight.Types.ListNamespacesResponse, AWSError>;
/**
* Lists the namespaces for the specified AWS account.
*/
listNamespaces(callback?: (err: AWSError, data: QuickSight.Types.ListNamespacesResponse) => void): Request<QuickSight.Types.ListNamespacesResponse, AWSError>;
/**
* Lists the tags assigned to a resource.
*/
listTagsForResource(params: QuickSight.Types.ListTagsForResourceRequest, callback?: (err: AWSError, data: QuickSight.Types.ListTagsForResourceResponse) => void): Request<QuickSight.Types.ListTagsForResourceResponse, AWSError>;
/**
* Lists the tags assigned to a resource.
*/
listTagsForResource(callback?: (err: AWSError, data: QuickSight.Types.ListTagsForResourceResponse) => void): Request<QuickSight.Types.ListTagsForResourceResponse, AWSError>;
/**
* Lists all the aliases of a template.
*/
listTemplateAliases(params: QuickSight.Types.ListTemplateAliasesRequest, callback?: (err: AWSError, data: QuickSight.Types.ListTemplateAliasesResponse) => void): Request<QuickSight.Types.ListTemplateAliasesResponse, AWSError>;
/**
* Lists all the aliases of a template.
*/
listTemplateAliases(callback?: (err: AWSError, data: QuickSight.Types.ListTemplateAliasesResponse) => void): Request<QuickSight.Types.ListTemplateAliasesResponse, AWSError>;
/**
* Lists all the versions of the templates in the current Amazon QuickSight account.
*/
listTemplateVersions(params: QuickSight.Types.ListTemplateVersionsRequest, callback?: (err: AWSError, data: QuickSight.Types.ListTemplateVersionsResponse) => void): Request<QuickSight.Types.ListTemplateVersionsResponse, AWSError>;
/**
* Lists all the versions of the templates in the current Amazon QuickSight account.
*/
listTemplateVersions(callback?: (err: AWSError, data: QuickSight.Types.ListTemplateVersionsResponse) => void): Request<QuickSight.Types.ListTemplateVersionsResponse, AWSError>;
/**
* Lists all the templates in the current Amazon QuickSight account.
*/
listTemplates(params: QuickSight.Types.ListTemplatesRequest, callback?: (err: AWSError, data: QuickSight.Types.ListTemplatesResponse) => void): Request<QuickSight.Types.ListTemplatesResponse, AWSError>;
/**
* Lists all the templates in the current Amazon QuickSight account.
*/
listTemplates(callback?: (err: AWSError, data: QuickSight.Types.ListTemplatesResponse) => void): Request<QuickSight.Types.ListTemplatesResponse, AWSError>;
/**
* Lists all the aliases of a theme.
*/
listThemeAliases(params: QuickSight.Types.ListThemeAliasesRequest, callback?: (err: AWSError, data: QuickSight.Types.ListThemeAliasesResponse) => void): Request<QuickSight.Types.ListThemeAliasesResponse, AWSError>;
/**
* Lists all the aliases of a theme.
*/
listThemeAliases(callback?: (err: AWSError, data: QuickSight.Types.ListThemeAliasesResponse) => void): Request<QuickSight.Types.ListThemeAliasesResponse, AWSError>;
/**
* Lists all the versions of the themes in the current AWS account.
*/
listThemeVersions(params: QuickSight.Types.ListThemeVersionsRequest, callback?: (err: AWSError, data: QuickSight.Types.ListThemeVersionsResponse) => void): Request<QuickSight.Types.ListThemeVersionsResponse, AWSError>;
/**
* Lists all the versions of the themes in the current AWS account.
*/
listThemeVersions(callback?: (err: AWSError, data: QuickSight.Types.ListThemeVersionsResponse) => void): Request<QuickSight.Types.ListThemeVersionsResponse, AWSError>;
/**
* Lists all the themes in the current AWS account.
*/
listThemes(params: QuickSight.Types.ListThemesRequest, callback?: (err: AWSError, data: QuickSight.Types.ListThemesResponse) => void): Request<QuickSight.Types.ListThemesResponse, AWSError>;
/**
* Lists all the themes in the current AWS account.
*/
listThemes(callback?: (err: AWSError, data: QuickSight.Types.ListThemesResponse) => void): Request<QuickSight.Types.ListThemesResponse, AWSError>;
/**
* Lists the Amazon QuickSight groups that an Amazon QuickSight user is a member of.
*/
listUserGroups(params: QuickSight.Types.ListUserGroupsRequest, callback?: (err: AWSError, data: QuickSight.Types.ListUserGroupsResponse) => void): Request<QuickSight.Types.ListUserGroupsResponse, AWSError>;
/**
* Lists the Amazon QuickSight groups that an Amazon QuickSight user is a member of.
*/
listUserGroups(callback?: (err: AWSError, data: QuickSight.Types.ListUserGroupsResponse) => void): Request<QuickSight.Types.ListUserGroupsResponse, AWSError>;
/**
* Returns a list of all of the Amazon QuickSight users belonging to this account.
*/
listUsers(params: QuickSight.Types.ListUsersRequest, callback?: (err: AWSError, data: QuickSight.Types.ListUsersResponse) => void): Request<QuickSight.Types.ListUsersResponse, AWSError>;
/**
* Returns a list of all of the Amazon QuickSight users belonging to this account.
*/
listUsers(callback?: (err: AWSError, data: QuickSight.Types.ListUsersResponse) => void): Request<QuickSight.Types.ListUsersResponse, AWSError>;
/**
* Creates an Amazon QuickSight user, whose identity is associated with the AWS Identity and Access Management (IAM) identity or role specified in the request.
*/
registerUser(params: QuickSight.Types.RegisterUserRequest, callback?: (err: AWSError, data: QuickSight.Types.RegisterUserResponse) => void): Request<QuickSight.Types.RegisterUserResponse, AWSError>;
/**
* Creates an Amazon QuickSight user, whose identity is associated with the AWS Identity and Access Management (IAM) identity or role specified in the request.
*/
registerUser(callback?: (err: AWSError, data: QuickSight.Types.RegisterUserResponse) => void): Request<QuickSight.Types.RegisterUserResponse, AWSError>;
/**
* Restores an analysis.
*/
restoreAnalysis(params: QuickSight.Types.RestoreAnalysisRequest, callback?: (err: AWSError, data: QuickSight.Types.RestoreAnalysisResponse) => void): Request<QuickSight.Types.RestoreAnalysisResponse, AWSError>;
/**
* Restores an analysis.
*/
restoreAnalysis(callback?: (err: AWSError, data: QuickSight.Types.RestoreAnalysisResponse) => void): Request<QuickSight.Types.RestoreAnalysisResponse, AWSError>;
/**
* Searches for analyses that belong to the user specified in the filter.
*/
searchAnalyses(params: QuickSight.Types.SearchAnalysesRequest, callback?: (err: AWSError, data: QuickSight.Types.SearchAnalysesResponse) => void): Request<QuickSight.Types.SearchAnalysesResponse, AWSError>;
/**
* Searches for analyses that belong to the user specified in the filter.
*/
searchAnalyses(callback?: (err: AWSError, data: QuickSight.Types.SearchAnalysesResponse) => void): Request<QuickSight.Types.SearchAnalysesResponse, AWSError>;
/**
* Searches for dashboards that belong to a user.
*/
searchDashboards(params: QuickSight.Types.SearchDashboardsRequest, callback?: (err: AWSError, data: QuickSight.Types.SearchDashboardsResponse) => void): Request<QuickSight.Types.SearchDashboardsResponse, AWSError>;
/**
* Searches for dashboards that belong to a user.
*/
searchDashboards(callback?: (err: AWSError, data: QuickSight.Types.SearchDashboardsResponse) => void): Request<QuickSight.Types.SearchDashboardsResponse, AWSError>;
/**
* Assigns one or more tags (key-value pairs) to the specified QuickSight resource. Tags can help you organize and categorize your resources. You can also use them to scope user permissions, by granting a user permission to access or change only resources with certain tag values. You can use the TagResource operation with a resource that already has tags. If you specify a new tag key for the resource, this tag is appended to the list of tags associated with the resource. If you specify a tag key that is already associated with the resource, the new tag value that you specify replaces the previous value for that tag. You can associate as many as 50 tags with a resource. QuickSight supports tagging on data set, data source, dashboard, and template. Tagging for QuickSight works in a similar way to tagging for other AWS services, except for the following: You can't use tags to track AWS costs for QuickSight. This restriction is because QuickSight costs are based on users and SPICE capacity, which aren't taggable resources. QuickSight doesn't currently support the Tag Editor for AWS Resource Groups.
*/
tagResource(params: QuickSight.Types.TagResourceRequest, callback?: (err: AWSError, data: QuickSight.Types.TagResourceResponse) => void): Request<QuickSight.Types.TagResourceResponse, AWSError>;
/**
* Assigns one or more tags (key-value pairs) to the specified QuickSight resource. Tags can help you organize and categorize your resources. You can also use them to scope user permissions, by granting a user permission to access or change only resources with certain tag values. You can use the TagResource operation with a resource that already has tags. If you specify a new tag key for the resource, this tag is appended to the list of tags associated with the resource. If you specify a tag key that is already associated with the resource, the new tag value that you specify replaces the previous value for that tag. You can associate as many as 50 tags with a resource. QuickSight supports tagging on data set, data source, dashboard, and template. Tagging for QuickSight works in a similar way to tagging for other AWS services, except for the following: You can't use tags to track AWS costs for QuickSight. This restriction is because QuickSight costs are based on users and SPICE capacity, which aren't taggable resources. QuickSight doesn't currently support the Tag Editor for AWS Resource Groups.
*/
tagResource(callback?: (err: AWSError, data: QuickSight.Types.TagResourceResponse) => void): Request<QuickSight.Types.TagResourceResponse, AWSError>;
/**
* Removes a tag or tags from a resource.
*/
untagResource(params: QuickSight.Types.UntagResourceRequest, callback?: (err: AWSError, data: QuickSight.Types.UntagResourceResponse) => void): Request<QuickSight.Types.UntagResourceResponse, AWSError>;
/**
* Removes a tag or tags from a resource.
*/
untagResource(callback?: (err: AWSError, data: QuickSight.Types.UntagResourceResponse) => void): Request<QuickSight.Types.UntagResourceResponse, AWSError>;
/**
* Updates Amazon QuickSight customizations the current AWS Region. Currently, the only customization you can use is a theme. You can use customizations for your AWS account or, if you specify a namespace, for a QuickSight namespace instead. Customizations that apply to a namespace override customizations that apply to an AWS account. To find out which customizations apply, use the DescribeAccountCustomization API operation.
*/
updateAccountCustomization(params: QuickSight.Types.UpdateAccountCustomizationRequest, callback?: (err: AWSError, data: QuickSight.Types.UpdateAccountCustomizationResponse) => void): Request<QuickSight.Types.UpdateAccountCustomizationResponse, AWSError>;
/**
* Updates Amazon QuickSight customizations the current AWS Region. Currently, the only customization you can use is a theme. You can use customizations for your AWS account or, if you specify a namespace, for a QuickSight namespace instead. Customizations that apply to a namespace override customizations that apply to an AWS account. To find out which customizations apply, use the DescribeAccountCustomization API operation.
*/
updateAccountCustomization(callback?: (err: AWSError, data: QuickSight.Types.UpdateAccountCustomizationResponse) => void): Request<QuickSight.Types.UpdateAccountCustomizationResponse, AWSError>;
/**
* Updates the Amazon QuickSight settings in your AWS account.
*/
updateAccountSettings(params: QuickSight.Types.UpdateAccountSettingsRequest, callback?: (err: AWSError, data: QuickSight.Types.UpdateAccountSettingsResponse) => void): Request<QuickSight.Types.UpdateAccountSettingsResponse, AWSError>;
/**
* Updates the Amazon QuickSight settings in your AWS account.
*/
updateAccountSettings(callback?: (err: AWSError, data: QuickSight.Types.UpdateAccountSettingsResponse) => void): Request<QuickSight.Types.UpdateAccountSettingsResponse, AWSError>;
/**
* Updates an analysis in Amazon QuickSight
*/
updateAnalysis(params: QuickSight.Types.UpdateAnalysisRequest, callback?: (err: AWSError, data: QuickSight.Types.UpdateAnalysisResponse) => void): Request<QuickSight.Types.UpdateAnalysisResponse, AWSError>;
/**
* Updates an analysis in Amazon QuickSight
*/
updateAnalysis(callback?: (err: AWSError, data: QuickSight.Types.UpdateAnalysisResponse) => void): Request<QuickSight.Types.UpdateAnalysisResponse, AWSError>;
/**
* Updates the read and write permissions for an analysis.
*/
updateAnalysisPermissions(params: QuickSight.Types.UpdateAnalysisPermissionsRequest, callback?: (err: AWSError, data: QuickSight.Types.UpdateAnalysisPermissionsResponse) => void): Request<QuickSight.Types.UpdateAnalysisPermissionsResponse, AWSError>;
/**
* Updates the read and write permissions for an analysis.
*/
updateAnalysisPermissions(callback?: (err: AWSError, data: QuickSight.Types.UpdateAnalysisPermissionsResponse) => void): Request<QuickSight.Types.UpdateAnalysisPermissionsResponse, AWSError>;
/**
* Updates a dashboard in an AWS account.
*/
updateDashboard(params: QuickSight.Types.UpdateDashboardRequest, callback?: (err: AWSError, data: QuickSight.Types.UpdateDashboardResponse) => void): Request<QuickSight.Types.UpdateDashboardResponse, AWSError>;
/**
* Updates a dashboard in an AWS account.
*/
updateDashboard(callback?: (err: AWSError, data: QuickSight.Types.UpdateDashboardResponse) => void): Request<QuickSight.Types.UpdateDashboardResponse, AWSError>;
/**
* Updates read and write permissions on a dashboard.
*/
updateDashboardPermissions(params: QuickSight.Types.UpdateDashboardPermissionsRequest, callback?: (err: AWSError, data: QuickSight.Types.UpdateDashboardPermissionsResponse) => void): Request<QuickSight.Types.UpdateDashboardPermissionsResponse, AWSError>;
/**
* Updates read and write permissions on a dashboard.
*/
updateDashboardPermissions(callback?: (err: AWSError, data: QuickSight.Types.UpdateDashboardPermissionsResponse) => void): Request<QuickSight.Types.UpdateDashboardPermissionsResponse, AWSError>;
/**
* Updates the published version of a dashboard.
*/
updateDashboardPublishedVersion(params: QuickSight.Types.UpdateDashboardPublishedVersionRequest, callback?: (err: AWSError, data: QuickSight.Types.UpdateDashboardPublishedVersionResponse) => void): Request<QuickSight.Types.UpdateDashboardPublishedVersionResponse, AWSError>;
/**
* Updates the published version of a dashboard.
*/
updateDashboardPublishedVersion(callback?: (err: AWSError, data: QuickSight.Types.UpdateDashboardPublishedVersionResponse) => void): Request<QuickSight.Types.UpdateDashboardPublishedVersionResponse, AWSError>;
/**
* Updates a dataset.
*/
updateDataSet(params: QuickSight.Types.UpdateDataSetRequest, callback?: (err: AWSError, data: QuickSight.Types.UpdateDataSetResponse) => void): Request<QuickSight.Types.UpdateDataSetResponse, AWSError>;
/**
* Updates a dataset.
*/
updateDataSet(callback?: (err: AWSError, data: QuickSight.Types.UpdateDataSetResponse) => void): Request<QuickSight.Types.UpdateDataSetResponse, AWSError>;
/**
* Updates the permissions on a dataset. The permissions resource is arn:aws:quicksight:region:aws-account-id:dataset/data-set-id.
*/
updateDataSetPermissions(params: QuickSight.Types.UpdateDataSetPermissionsRequest, callback?: (err: AWSError, data: QuickSight.Types.UpdateDataSetPermissionsResponse) => void): Request<QuickSight.Types.UpdateDataSetPermissionsResponse, AWSError>;
/**
* Updates the permissions on a dataset. The permissions resource is arn:aws:quicksight:region:aws-account-id:dataset/data-set-id.
*/
updateDataSetPermissions(callback?: (err: AWSError, data: QuickSight.Types.UpdateDataSetPermissionsResponse) => void): Request<QuickSight.Types.UpdateDataSetPermissionsResponse, AWSError>;
/**
* Updates a data source.
*/
updateDataSource(params: QuickSight.Types.UpdateDataSourceRequest, callback?: (err: AWSError, data: QuickSight.Types.UpdateDataSourceResponse) => void): Request<QuickSight.Types.UpdateDataSourceResponse, AWSError>;
/**
* Updates a data source.
*/
updateDataSource(callback?: (err: AWSError, data: QuickSight.Types.UpdateDataSourceResponse) => void): Request<QuickSight.Types.UpdateDataSourceResponse, AWSError>;
/**
* Updates the permissions to a data source.
*/
updateDataSourcePermissions(params: QuickSight.Types.UpdateDataSourcePermissionsRequest, callback?: (err: AWSError, data: QuickSight.Types.UpdateDataSourcePermissionsResponse) => void): Request<QuickSight.Types.UpdateDataSourcePermissionsResponse, AWSError>;
/**
* Updates the permissions to a data source.
*/
updateDataSourcePermissions(callback?: (err: AWSError, data: QuickSight.Types.UpdateDataSourcePermissionsResponse) => void): Request<QuickSight.Types.UpdateDataSourcePermissionsResponse, AWSError>;
/**
* Changes a group description.
*/
updateGroup(params: QuickSight.Types.UpdateGroupRequest, callback?: (err: AWSError, data: QuickSight.Types.UpdateGroupResponse) => void): Request<QuickSight.Types.UpdateGroupResponse, AWSError>;
/**
* Changes a group description.
*/
updateGroup(callback?: (err: AWSError, data: QuickSight.Types.UpdateGroupResponse) => void): Request<QuickSight.Types.UpdateGroupResponse, AWSError>;
/**
* Updates an existing IAM policy assignment. This operation updates only the optional parameter or parameters that are specified in the request.
*/
updateIAMPolicyAssignment(params: QuickSight.Types.UpdateIAMPolicyAssignmentRequest, callback?: (err: AWSError, data: QuickSight.Types.UpdateIAMPolicyAssignmentResponse) => void): Request<QuickSight.Types.UpdateIAMPolicyAssignmentResponse, AWSError>;
/**
* Updates an existing IAM policy assignment. This operation updates only the optional parameter or parameters that are specified in the request.
*/
updateIAMPolicyAssignment(callback?: (err: AWSError, data: QuickSight.Types.UpdateIAMPolicyAssignmentResponse) => void): Request<QuickSight.Types.UpdateIAMPolicyAssignmentResponse, AWSError>;
/**
* Updates a template from an existing Amazon QuickSight analysis or another template.
*/
updateTemplate(params: QuickSight.Types.UpdateTemplateRequest, callback?: (err: AWSError, data: QuickSight.Types.UpdateTemplateResponse) => void): Request<QuickSight.Types.UpdateTemplateResponse, AWSError>;
/**
* Updates a template from an existing Amazon QuickSight analysis or another template.
*/
updateTemplate(callback?: (err: AWSError, data: QuickSight.Types.UpdateTemplateResponse) => void): Request<QuickSight.Types.UpdateTemplateResponse, AWSError>;
/**
* Updates the template alias of a template.
*/
updateTemplateAlias(params: QuickSight.Types.UpdateTemplateAliasRequest, callback?: (err: AWSError, data: QuickSight.Types.UpdateTemplateAliasResponse) => void): Request<QuickSight.Types.UpdateTemplateAliasResponse, AWSError>;
/**
* Updates the template alias of a template.
*/
updateTemplateAlias(callback?: (err: AWSError, data: QuickSight.Types.UpdateTemplateAliasResponse) => void): Request<QuickSight.Types.UpdateTemplateAliasResponse, AWSError>;
/**
* Updates the resource permissions for a template.
*/
updateTemplatePermissions(params: QuickSight.Types.UpdateTemplatePermissionsRequest, callback?: (err: AWSError, data: QuickSight.Types.UpdateTemplatePermissionsResponse) => void): Request<QuickSight.Types.UpdateTemplatePermissionsResponse, AWSError>;
/**
* Updates the resource permissions for a template.
*/
updateTemplatePermissions(callback?: (err: AWSError, data: QuickSight.Types.UpdateTemplatePermissionsResponse) => void): Request<QuickSight.Types.UpdateTemplatePermissionsResponse, AWSError>;
/**
* Updates a theme.
*/
updateTheme(params: QuickSight.Types.UpdateThemeRequest, callback?: (err: AWSError, data: QuickSight.Types.UpdateThemeResponse) => void): Request<QuickSight.Types.UpdateThemeResponse, AWSError>;
/**
* Updates a theme.
*/
updateTheme(callback?: (err: AWSError, data: QuickSight.Types.UpdateThemeResponse) => void): Request<QuickSight.Types.UpdateThemeResponse, AWSError>;
/**
* Updates an alias of a theme.
*/
updateThemeAlias(params: QuickSight.Types.UpdateThemeAliasRequest, callback?: (err: AWSError, data: QuickSight.Types.UpdateThemeAliasResponse) => void): Request<QuickSight.Types.UpdateThemeAliasResponse, AWSError>;
/**
* Updates an alias of a theme.
*/
updateThemeAlias(callback?: (err: AWSError, data: QuickSight.Types.UpdateThemeAliasResponse) => void): Request<QuickSight.Types.UpdateThemeAliasResponse, AWSError>;
/**
* Updates the resource permissions for a theme. Permissions apply to the action to grant or revoke permissions on, for example "quicksight:DescribeTheme". Theme permissions apply in groupings. Valid groupings include the following for the three levels of permissions, which are user, owner, or no permissions: User "quicksight:DescribeTheme" "quicksight:DescribeThemeAlias" "quicksight:ListThemeAliases" "quicksight:ListThemeVersions" Owner "quicksight:DescribeTheme" "quicksight:DescribeThemeAlias" "quicksight:ListThemeAliases" "quicksight:ListThemeVersions" "quicksight:DeleteTheme" "quicksight:UpdateTheme" "quicksight:CreateThemeAlias" "quicksight:DeleteThemeAlias" "quicksight:UpdateThemeAlias" "quicksight:UpdateThemePermissions" "quicksight:DescribeThemePermissions" To specify no permissions, omit the permissions list.
*/
updateThemePermissions(params: QuickSight.Types.UpdateThemePermissionsRequest, callback?: (err: AWSError, data: QuickSight.Types.UpdateThemePermissionsResponse) => void): Request<QuickSight.Types.UpdateThemePermissionsResponse, AWSError>;
/**
* Updates the resource permissions for a theme. Permissions apply to the action to grant or revoke permissions on, for example "quicksight:DescribeTheme". Theme permissions apply in groupings. Valid groupings include the following for the three levels of permissions, which are user, owner, or no permissions: User "quicksight:DescribeTheme" "quicksight:DescribeThemeAlias" "quicksight:ListThemeAliases" "quicksight:ListThemeVersions" Owner "quicksight:DescribeTheme" "quicksight:DescribeThemeAlias" "quicksight:ListThemeAliases" "quicksight:ListThemeVersions" "quicksight:DeleteTheme" "quicksight:UpdateTheme" "quicksight:CreateThemeAlias" "quicksight:DeleteThemeAlias" "quicksight:UpdateThemeAlias" "quicksight:UpdateThemePermissions" "quicksight:DescribeThemePermissions" To specify no permissions, omit the permissions list.
*/
updateThemePermissions(callback?: (err: AWSError, data: QuickSight.Types.UpdateThemePermissionsResponse) => void): Request<QuickSight.Types.UpdateThemePermissionsResponse, AWSError>;
/**
* Updates an Amazon QuickSight user.
*/
updateUser(params: QuickSight.Types.UpdateUserRequest, callback?: (err: AWSError, data: QuickSight.Types.UpdateUserResponse) => void): Request<QuickSight.Types.UpdateUserResponse, AWSError>;
/**
* Updates an Amazon QuickSight user.
*/
updateUser(callback?: (err: AWSError, data: QuickSight.Types.UpdateUserResponse) => void): Request<QuickSight.Types.UpdateUserResponse, AWSError>;
}
declare namespace QuickSight {
export interface AccountCustomization {
/**
* The default theme for this QuickSight subscription.
*/
DefaultTheme?: Arn;
}
export interface AccountSettings {
/**
* The "account name" you provided for the QuickSight subscription in your AWS account. You create this name when you sign up for QuickSight. It is unique in all of AWS and it appears only in the console when users sign in.
*/
AccountName?: String;
/**
* The edition of QuickSight that you're currently subscribed to: Enterprise edition or Standard edition.
*/
Edition?: Edition;
/**
* The default QuickSight namespace for your AWS account.
*/
DefaultNamespace?: Namespace;
/**
* The main notification email for your QuickSight subscription.
*/
NotificationEmail?: String;
}
export type ActionList = String[];
export interface ActiveIAMPolicyAssignment {
/**
* A name for the IAM policy assignment.
*/
AssignmentName?: IAMPolicyAssignmentName;
/**
* The Amazon Resource Name (ARN) of the resource.
*/
PolicyArn?: Arn;
}
export type ActiveIAMPolicyAssignmentList = ActiveIAMPolicyAssignment[];
export interface AdHocFilteringOption {
/**
* Availability status.
*/
AvailabilityStatus?: DashboardBehavior;
}
export type AliasName = string;
export interface AmazonElasticsearchParameters {
/**
* The Amazon Elasticsearch Service domain.
*/
Domain: Domain;
}
export interface Analysis {
/**
* The ID of the analysis.
*/
AnalysisId?: RestrictiveResourceId;
/**
* The Amazon Resource Name (ARN) of the analysis.
*/
Arn?: Arn;
/**
* The descriptive name of the analysis.
*/
Name?: AnalysisName;
/**
* Status associated with the analysis.
*/
Status?: ResourceStatus;
/**
* Errors associated with the analysis.
*/
Errors?: AnalysisErrorList;
/**
* The ARNs of the datasets of the analysis.
*/
DataSetArns?: DataSetArnsList;
/**
* The ARN of the theme of the analysis.
*/
ThemeArn?: Arn;
/**
* The time that the analysis was created.
*/
CreatedTime?: Timestamp;
/**
* The time that the analysis was last updated.
*/
LastUpdatedTime?: Timestamp;
/**
* A list of the associated sheets with the unique identifier and name of each sheet.
*/
Sheets?: SheetList;
}
export interface AnalysisError {
/**
* The type of the analysis error.
*/
Type?: AnalysisErrorType;
/**
* The message associated with the analysis error.
*/
Message?: NonEmptyString;
}
export type AnalysisErrorList = AnalysisError[];
export type AnalysisErrorType = "ACCESS_DENIED"|"SOURCE_NOT_FOUND"|"DATA_SET_NOT_FOUND"|"INTERNAL_FAILURE"|"PARAMETER_VALUE_INCOMPATIBLE"|"PARAMETER_TYPE_INVALID"|"PARAMETER_NOT_FOUND"|"COLUMN_TYPE_MISMATCH"|"COLUMN_GEOGRAPHIC_ROLE_MISMATCH"|"COLUMN_REPLACEMENT_MISSING"|string;
export type AnalysisFilterAttribute = "QUICKSIGHT_USER"|string;
export type AnalysisName = string;
export interface AnalysisSearchFilter {
/**
* The comparison operator that you want to use as a filter, for example "Operator": "StringEquals".
*/
Operator?: FilterOperator;
/**
* The name of the value that you want to use as a filter, for example "Name": "QUICKSIGHT_USER".
*/
Name?: AnalysisFilterAttribute;
/**
* 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;
}
export type AnalysisSearchFilterList = AnalysisSearchFilter[];
export interface AnalysisSourceEntity {
/**
* The source template for the source entity of the analysis.
*/
SourceTemplate?: AnalysisSourceTemplate;
}
export interface AnalysisSourceTemplate {
/**
* The dataset references of the source template of an analysis.
*/
DataSetReferences: DataSetReferenceList;
/**
* The Amazon Resource Name (ARN) of the source template of an analysis.
*/
Arn: Arn;
}
export interface AnalysisSummary {
/**
* The Amazon Resource Name (ARN) for the analysis.
*/
Arn?: Arn;
/**
* The ID of the analysis. This ID displays in the URL.
*/
AnalysisId?: RestrictiveResourceId;
/**
* The name of the analysis. This name is displayed in the QuickSight console.
*/
Name?: AnalysisName;
/**
* The last known status for the analysis.
*/
Status?: ResourceStatus;
/**
* The time that the analysis was created.
*/
CreatedTime?: Timestamp;
/**
* The time that the analysis was last updated.
*/
LastUpdatedTime?: Timestamp;
}
export type AnalysisSummaryList = AnalysisSummary[];
export type Arn = string;
export type AssignmentStatus = "ENABLED"|"DRAFT"|"DISABLED"|string;
export interface AthenaParameters {
/**
* The workgroup that Amazon Athena uses.
*/
WorkGroup?: WorkGroup;
}
export interface AuroraParameters {
/**
* Host.
*/
Host: Host;
/**
* Port.
*/
Port: Port;
/**
* Database.
*/
Database: Database;
}
export interface AuroraPostgreSqlParameters {
/**
* Host.
*/
Host: Host;
/**
* Port.
*/
Port: Port;
/**
* Database.
*/
Database: Database;
}
export type AwsAccountId = string;
export type AwsAndAccountId = string;
export interface AwsIotAnalyticsParameters {
/**
* Dataset name.
*/
DataSetName: DataSetName;
}
export type Boolean = boolean;
export interface BorderStyle {
/**
* The option to enable display of borders for visuals.
*/
Show?: boolean;
}
export interface CalculatedColumn {
/**
* Column name.
*/
ColumnName: ColumnName;
/**
* 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.
*/
ColumnId: ColumnId;
/**
* An expression that defines the calculated column.
*/
Expression: Expression;
}
export type CalculatedColumnList = CalculatedColumn[];
export interface CancelIngestionRequest {
/**
* The AWS account ID.
*/
AwsAccountId: AwsAccountId;
/**
* The ID of the dataset used in the ingestion.
*/
DataSetId: string;
/**
* An ID for the ingestion.
*/
IngestionId: IngestionId;
}
export interface CancelIngestionResponse {
/**
* The Amazon Resource Name (ARN) for the data ingestion.
*/
Arn?: Arn;
/**
* An ID for the ingestion.
*/
IngestionId?: IngestionId;
/**
* The AWS request ID for this operation.
*/
RequestId?: string;
/**
* The HTTP status of the request.
*/
Status?: StatusCode;
}
export interface CastColumnTypeOperation {
/**
* Column name.
*/
ColumnName: ColumnName;
/**
* New column data type.
*/
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?: TypeCastFormat;
}
export type Catalog = string;
export type ClusterId = string;
export type ColorList = HexColor[];
export type ColumnDataType = "STRING"|"INTEGER"|"DECIMAL"|"DATETIME"|string;
export interface ColumnGroup {
/**
* Geospatial column group that denotes a hierarchy.
*/
GeoSpatialColumnGroup?: GeoSpatialColumnGroup;
}
export interface ColumnGroupColumnSchema {
/**
* The name of the column group's column schema.
*/
Name?: String;
}
export type ColumnGroupColumnSchemaList = ColumnGroupColumnSchema[];
export type ColumnGroupList = ColumnGroup[];
export type ColumnGroupName = string;
export interface ColumnGroupSchema {
/**
* The name of the column group schema.
*/
Name?: String;
/**
* A structure containing the list of schemas for column group columns.
*/
ColumnGroupColumnSchemaList?: ColumnGroupColumnSchemaList;
}
export type ColumnGroupSchemaList = ColumnGroupSchema[];
export type ColumnId = string;
export type ColumnList = ColumnName[];
export type ColumnName = string;
export interface ColumnSchema {
/**
* The name of the column schema.
*/
Name?: String;
/**
* The data type of the column schema.
*/
DataType?: String;
/**
* The geographic role of the column schema.
*/
GeographicRole?: String;
}
export type ColumnSchemaList = ColumnSchema[];
export interface ColumnTag {
/**
* A geospatial role for a column.
*/
ColumnGeographicRole?: GeoSpatialDataRole;
}
export type ColumnTagList = ColumnTag[];
export type CopySourceArn = string;
export interface CreateAccountCustomizationRequest {
/**
* The ID for the AWS account that you want to customize QuickSight for.
*/
AwsAccountId: AwsAccountId;
/**
* The QuickSight namespace that you want to add customizations to.
*/
Namespace?: Namespace;
/**
* The QuickSight customizations you're adding in the current AWS Region. You can add these to an AWS account and a QuickSight namespace. For example, you can add a default theme by setting AccountCustomization to the midnight theme: "AccountCustomization": { "DefaultTheme": "arn:aws:quicksight::aws:theme/MIDNIGHT" }. Or, you can add a custom theme by specifying "AccountCustomization": { "DefaultTheme": "arn:aws:quicksight:us-west-2:111122223333:theme/bdb844d0-0fe9-4d9d-b520-0fe602d93639" }.
*/
AccountCustomization: AccountCustomization;
/**
* A list of the tags that you want to attach to this resource.
*/
Tags?: TagList;
}
export interface CreateAccountCustomizationResponse {
/**
* The Amazon Resource Name (ARN) for the customization that you created for this AWS account.
*/
Arn?: Arn;
/**
* The ID for the AWS account that you want to customize QuickSight for.
*/
AwsAccountId?: AwsAccountId;
/**
* The namespace associated with the customization you're creating.
*/
Namespace?: Namespace;
/**
* The QuickSight customizations you're adding in the current AWS Region.
*/
AccountCustomization?: AccountCustomization;
/**
* The AWS request ID for this operation.
*/
RequestId?: String;
/**
* The HTTP status of the request.
*/
Status?: StatusCode;
}
export interface CreateAnalysisRequest {
/**
* The ID of the AWS account where you are creating an analysis.
*/
AwsAccountId: AwsAccountId;
/**
* The ID for the analysis that you're creating. This ID displays in the URL of the analysis.
*/
AnalysisId: RestrictiveResourceId;
/**
* A descriptive name for the analysis that you're creating. This name displays for the analysis in the QuickSight console.
*/
Name: AnalysisName;
/**
* The parameter names and override values that you want to use. An analysis can have any parameter type, and some parameters might accept multiple values.
*/
Parameters?: Parameters;
/**
* A structure that describes the principals and the resource-level permissions on an analysis. You can use the Permissions structure to grant permissions by providing a list of AWS Identity and Access Management (IAM) action information for each principal listed by Amazon Resource Name (ARN). To specify no permissions, omit Permissions.
*/
Permissions?: ResourcePermissionList;
/**
* A source entity to use for the analysis that you're creating. This metadata structure contains details that describe a source template and one or more datasets.
*/
SourceEntity: AnalysisSourceEntity;
/**
* The ARN for the theme to apply to the analysis that you're creating. To see the theme in the QuickSight console, make sure that you have access to it.
*/
ThemeArn?: Arn;
/**
* Contains a map of the key-value pairs for the resource tag or tags assigned to the analysis.
*/
Tags?: TagList;
}
export interface CreateAnalysisResponse {
/**
* The ARN for the analysis.
*/
Arn?: Arn;
/**
* The ID of the analysis.
*/
AnalysisId?: RestrictiveResourceId;
/**
* The status of the creation of the analysis.
*/
CreationStatus?: ResourceStatus;
/**
* The HTTP status of the request.
*/
Status?: StatusCode;
/**
* The AWS request ID for this operation.
*/
RequestId?: String;
}
export interface CreateColumnsOperation {
/**
* Calculated columns to create.
*/
Columns: CalculatedColumnList;
}
export interface CreateDashboardRequest {
/**
* The ID of the AWS account where you want to create the dashboard.
*/
AwsAccountId: AwsAccountId;
/**
* The ID for the dashboard, also added to the IAM policy.
*/
DashboardId: RestrictiveResourceId;
/**
* The display name of the dashboard.
*/
Name: DashboardName;
/**
* The parameters for the creation of the dashboard, which you want to use to override the default settings. A dashboard can have any type of parameters, and some parameters might accept multiple values.
*/
Parameters?: Parameters;
/**
* A structure that contains the permissions of the dashboard. You can use this structure for granting permissions by providing a list of IAM action information for each principal ARN. To specify no permissions, omit the permissions list.
*/
Permissions?: ResourcePermissionList;
/**
* The entity that you are using as a source when you create the dashboard. In SourceEntity, you specify the type of object you're using as source. You can only create a dashboard from a template, so you use a SourceTemplate entity. If you need to create a dashboard from an analysis, first convert the analysis to a template by using the CreateTemplate API operation. For SourceTemplate, specify the Amazon Resource Name (ARN) of the source template. The SourceTemplateARN can contain any AWS Account and any QuickSight-supported AWS Region. Use the DataSetReferences entity within SourceTemplate to list the replacement datasets for the placeholders listed in the original. The schema in each dataset must match its placeholder.
*/
SourceEntity: DashboardSourceEntity;
/**
* Contains a map of the key-value pairs for the resource tag or tags assigned to the dashboard.
*/
Tags?: TagList;
/**
* A description for the first version of the dashboard being created.
*/
VersionDescription?: VersionDescription;
/**
* Options for publishing the dashboard when you create it: AvailabilityStatus for AdHocFilteringOption - This status can be either ENABLED or DISABLED. When this is set to DISABLED, QuickSight disables the left filter pane on the published dashboard, which can be used for ad hoc (one-time) filtering. This option is ENABLED by default. AvailabilityStatus for ExportToCSVOption - This status can be either ENABLED or DISABLED. The visual option to export data to .CSV format isn't enabled when this is set to DISABLED. This option is ENABLED by default. VisibilityState for SheetControlsOption - This visibility state can be either COLLAPSED or EXPANDED. This option is COLLAPSED by default.
*/
DashboardPublishOptions?: DashboardPublishOptions;
/**
* The Amazon Resource Name (ARN) of the theme that is being used for this dashboard. If you add a value for this field, it overrides the value that is used in the source entity. The theme ARN must exist in the same AWS account where you create the dashboard.
*/
ThemeArn?: Arn;
}
export interface CreateDashboardResponse {
/**
* The ARN of the dashboard.
*/
Arn?: Arn;
/**
* The ARN of the dashboard, including the version number of the first version that is created.
*/
VersionArn?: Arn;
/**
* The ID for the dashboard.
*/
DashboardId?: RestrictiveResourceId;
/**
* The status of the dashboard creation request.
*/
CreationStatus?: ResourceStatus;
/**
* The HTTP status of the request.
*/
Status?: StatusCode;
/**
* The AWS request ID for this operation.
*/
RequestId?: String;
}
export interface CreateDataSetRequest {
/**
* The AWS account ID.
*/
AwsAccountId: AwsAccountId;
/**
* An ID for the dataset that you want to create. This ID is unique per AWS Region for each AWS account.
*/
DataSetId: ResourceId;
/**
* The display name for the dataset.
*/
Name: ResourceName;
/**
* Declares the physical tables that are available in the underlying data sources.
*/
PhysicalTableMap: PhysicalTableMap;
/**
* Configures the combination and transformation of the data from the physical tables.
*/
LogicalTableMap?: LogicalTableMap;
/**
* Indicates whether you want to import the data into SPICE.
*/
ImportMode: DataSetImportMode;
/**
* Groupings of columns that work together in certain QuickSight features. Currently, only geospatial hierarchy is supported.
*/
ColumnGroups?: ColumnGroupList;
/**
* A list of resource permissions on the dataset.
*/
Permissions?: ResourcePermissionList;
/**
* The row-level security configuration for the data that you want to create.
*/
RowLevelPermissionDataSet?: RowLevelPermissionDataSet;
/**
* Contains a map of the key-value pairs for the resource tag or tags assigned to the dataset.
*/
Tags?: TagList;
}
export interface CreateDataSetResponse {
/**
* The Amazon Resource Name (ARN) of the dataset.
*/
Arn?: Arn;
/**
* The ID for the dataset that you want to create. This ID is unique per AWS Region for each AWS account.
*/
DataSetId?: ResourceId;
/**
* The ARN for the ingestion, which is triggered as a result of dataset creation if the import mode is SPICE.
*/
IngestionArn?: Arn;
/**
* The ID of the ingestion, which is triggered as a result of dataset creation if the import mode is SPICE.
*/
IngestionId?: ResourceId;
/**
* The AWS request ID for this operation.
*/
RequestId?: String;
/**
* The HTTP status of the request.
*/
Status?: StatusCode;
}
export interface CreateDataSourceRequest {
/**
* The AWS account ID.
*/
AwsAccountId: AwsAccountId;
/**
* An ID for the data source. This ID is unique per AWS Region for each AWS account.
*/
DataSourceId: ResourceId;
/**
* A display name for the data source.
*/
Name: ResourceName;
/**
* The type of the data source. Currently, the supported types for this operation are: ATHENA, AURORA, AURORA_POSTGRESQL, MARIADB, MYSQL, POSTGRESQL, PRESTO, REDSHIFT, S3, SNOWFLAKE, SPARK, SQLSERVER, TERADATA. Use ListDataSources to return a list of all data sources.
*/
Type: DataSourceType;
/**
* The parameters that QuickSight uses to connect to your underlying source.
*/
DataSourceParameters?: DataSourceParameters;
/**
* The credentials QuickSight that uses to connect to your underlying source. Currently, only credentials based on user name and password are supported.
*/
Credentials?: DataSourceCredentials;
/**
* A list of resource permissions on the data source.
*/
Permissions?: ResourcePermissionList;
/**
* Use this parameter only when you want QuickSight to use a VPC connection when connecting to your underlying source.
*/
VpcConnectionProperties?: VpcConnectionProperties;
/**
* Secure Socket Layer (SSL) properties that apply when QuickSight connects to your underlying source.
*/
SslProperties?: SslProperties;
/**
* Contains a map of the key-value pairs for the resource tag or tags assigned to the data source.
*/
Tags?: TagList;
}
export interface CreateDataSourceResponse {
/**
* The Amazon Resource Name (ARN) of the data source.
*/
Arn?: Arn;
/**
* The ID of the data source. This ID is unique per AWS Region for each AWS account.
*/
DataSourceId?: ResourceId;
/**
* The status of creating the data source.
*/
CreationStatus?: ResourceStatus;
/**
* The AWS request ID for this operation.
*/
RequestId?: String;
/**
* The HTTP status of the request.
*/
Status?: StatusCode;
}
export interface CreateGroupMembershipRequest {
/**
* The name of the user that you want to add to the group membership.
*/
MemberName: GroupMemberName;
/**
* The name of the group that you want to add the user to.
*/
GroupName: GroupName;
/**
* The ID for the AWS account that the group is in. Currently, you use the ID for the AWS account that contains your Amazon QuickSight account.
*/
AwsAccountId: AwsAccountId;
/**
* The namespace. Currently, you should set this to default.
*/
Namespace: Namespace;
}
export interface CreateGroupMembershipResponse {
/**
* The group member.
*/
GroupMember?: GroupMember;
/**
* The AWS request ID for this operation.
*/
RequestId?: String;
/**
* The HTTP status of the request.
*/
Status?: StatusCode;
}
export interface CreateGroupRequest {
/**
* A name for the group that you want to create.
*/
GroupName: GroupName;
/**
* A description for the group that you want to create.
*/
Description?: GroupDescription;
/**
* The ID for the AWS account that the group is in. Currently, you use the ID for the AWS account that contains your Amazon QuickSight account.
*/
AwsAccountId: AwsAccountId;
/**
* The namespace. Currently, you should set this to default.
*/
Namespace: Namespace;
}
export interface CreateGroupResponse {
/**
* The name of the group.
*/
Group?: Group;
/**
* The AWS request ID for this operation.
*/
RequestId?: String;
/**
* The HTTP status of the request.
*/
Status?: StatusCode;
}
export interface CreateIAMPolicyAssignmentRequest {
/**
* The ID of the AWS account where you want to assign an IAM policy to QuickSight users or groups.
*/
AwsAccountId: AwsAccountId;
/**
* The name of the assignment. It must be unique within an AWS account.
*/
AssignmentName: IAMPolicyAssignmentName;
/**
* The status of the assignment. Possible values are as follows: ENABLED - Anything specified in this assignment is used when creating the data source. DISABLED - This assignment isn't used when creating the data source. DRAFT - This assignment is an unfinished draft and isn't used when creating the data source.
*/
AssignmentStatus: AssignmentStatus;
/**
* The ARN for the IAM policy to apply to the QuickSight users and groups specified in this assignment.
*/
PolicyArn?: Arn;
/**
* The QuickSight users, groups, or both that you want to assign the policy to.
*/
Identities?: IdentityMap;
/**
* The namespace that contains the assignment.
*/
Namespace: Namespace;
}
export interface CreateIAMPolicyAssignmentResponse {
/**
* The name of the assignment. This name must be unique within the AWS account.
*/
AssignmentName?: IAMPolicyAssignmentName;
/**
* The ID for the assignment.
*/
AssignmentId?: String;
/**
* The status of the assignment. Possible values are as follows: ENABLED - Anything specified in this assignment is used when creating the data source. DISABLED - This assignment isn't used when creating the data source. DRAFT - This assignment is an unfinished draft and isn't used when creating the data source.
*/
AssignmentStatus?: AssignmentStatus;
/**
* The ARN for the IAM policy that is applied to the QuickSight users and groups specified in this assignment.
*/
PolicyArn?: Arn;
/**
* The QuickSight users, groups, or both that the IAM policy is assigned to.
*/
Identities?: IdentityMap;
/**
* The AWS request ID for this operation.
*/
RequestId?: String;
/**
* The HTTP status of the request.
*/
Status?: StatusCode;
}
export interface CreateIngestionRequest {
/**
* The ID of the dataset used in the ingestion.
*/
DataSetId: string;
/**
* An ID for the ingestion.
*/
IngestionId: IngestionId;
/**
* The AWS account ID.
*/
AwsAccountId: AwsAccountId;
}
export interface CreateIngestionResponse {
/**
* The Amazon Resource Name (ARN) for the data ingestion.
*/
Arn?: Arn;
/**
* An ID for the ingestion.
*/
IngestionId?: IngestionId;
/**
* The ingestion status.
*/
IngestionStatus?: IngestionStatus;
/**
* The AWS request ID for this operation.
*/
RequestId?: string;
/**
* The HTTP status of the request.
*/
Status?: StatusCode;
}
export interface CreateNamespaceRequest {
/**
* The ID for the AWS account that you want to create the QuickSight namespace in.
*/
AwsAccountId: AwsAccountId;
/**
* The name that you want to use to describe the new namespace.
*/
Namespace: Namespace;
/**
* Specifies the type of your user identity directory. Currently, this supports users with an identity type of QUICKSIGHT.
*/
IdentityStore: IdentityStore;
/**
* The tags that you want to associate with the namespace that you're creating.
*/
Tags?: TagList;
}
export interface CreateNamespaceResponse {
/**
* The ARN of the QuickSight namespace you created.
*/
Arn?: Arn;
/**
* The name of the new namespace that you created.
*/
Name?: Namespace;
/**
* The AWS Region that you want to use for the free SPICE capacity for the new namespace. This is set to the region that you run CreateNamespace in.
*/
CapacityRegion?: String;
/**
* The status of the creation of the namespace. This is an asynchronous process. A status of CREATED means that your namespace is ready to use. If an error occurs, it indicates if the process is retryable or non-retryable. In the case of a non-retryable error, refer to the error message for follow-up tasks.
*/
CreationStatus?: NamespaceStatus;
/**
* Specifies the type of your user identity directory. Currently, this supports users with an identity type of QUICKSIGHT.
*/
IdentityStore?: IdentityStore;
/**
* The AWS request ID for this operation.
*/
RequestId?: String;
/**
* The HTTP status of the request.
*/
Status?: StatusCode;
}
export interface CreateTemplateAliasRequest {
/**
* The ID of the AWS account that contains the template that you creating an alias for.
*/
AwsAccountId: AwsAccountId;
/**
* An ID for the template.
*/
TemplateId: RestrictiveResourceId;
/**
* The name that you want to give to the template alias that you're creating. Don't start the alias name with the $ character. Alias names that start with $ are reserved by QuickSight.
*/
AliasName: AliasName;
/**
* The version number of the template.
*/
TemplateVersionNumber: VersionNumber;
}
export interface CreateTemplateAliasResponse {
/**
* Information about the template alias.
*/
TemplateAlias?: TemplateAlias;
/**
* The HTTP status of the request.
*/
Status?: StatusCode;
/**
* The AWS request ID for this operation.
*/
RequestId?: String;
}
export interface CreateTemplateRequest {
/**
* The ID for the AWS account that the group is in. Currently, you use the ID for the AWS account that contains your Amazon QuickSight account.
*/
AwsAccountId: AwsAccountId;
/**
* An ID for the template that you want to create. This template is unique per AWS Region in each AWS account.
*/
TemplateId: RestrictiveResourceId;
/**
* A display name for the template.
*/
Name?: TemplateName;
/**
* A list of resource permissions to be set on the template.
*/
Permissions?: ResourcePermissionList;
/**
* The entity that you are using as a source when you create the template. In SourceEntity, you specify the type of object you're using as source: SourceTemplate for a template or SourceAnalysis for an analysis. Both of these require an Amazon Resource Name (ARN). For SourceTemplate, specify the ARN of the source template. For SourceAnalysis, specify the ARN of the source analysis. The SourceTemplate ARN can contain any AWS Account and any QuickSight-supported AWS Region. Use the DataSetReferences entity within SourceTemplate or SourceAnalysis to list the replacement datasets for the placeholders listed in the original. The schema in each dataset must match its placeholder.
*/
SourceEntity: TemplateSourceEntity;
/**
* Contains a map of the key-value pairs for the resource tag or tags assigned to the resource.
*/
Tags?: TagList;
/**
* A description of the current template version being created. This API operation creates the first version of the template. Every time UpdateTemplate is called, a new version is created. Each version of the template maintains a description of the version in the VersionDescription field.
*/
VersionDescription?: VersionDescription;
}
export interface CreateTemplateResponse {
/**
* The ARN for the template.
*/
Arn?: Arn;
/**
* The ARN for the template, including the version information of the first version.
*/
VersionArn?: Arn;
/**
* The ID of the template.
*/
TemplateId?: RestrictiveResourceId;
/**
* The template creation status.
*/
CreationStatus?: ResourceStatus;
/**
* The HTTP status of the request.
*/
Status?: StatusCode;
/**
* The AWS request ID for this operation.
*/
RequestId?: String;
}
export interface CreateThemeAliasRequest {
/**
* The ID of the AWS account that contains the theme for the new theme alias.
*/
AwsAccountId: AwsAccountId;
/**
* An ID for the theme alias.
*/
ThemeId: RestrictiveResourceId;
/**
* The name that you want to give to the theme alias that you are creating. The alias name can't begin with a $. Alias names that start with $ are reserved by Amazon QuickSight.
*/
AliasName: AliasName;
/**
* The version number of the theme.
*/
ThemeVersionNumber: VersionNumber;
}
export interface CreateThemeAliasResponse {
/**
* Information about the theme alias.
*/
ThemeAlias?: ThemeAlias;
/**
* The HTTP status of the request.
*/
Status?: StatusCode;
/**
* The AWS request ID for this operation.
*/
RequestId?: String;
}
export interface CreateThemeRequest {
/**
* The ID of the AWS account where you want to store the new theme.
*/
AwsAccountId: AwsAccountId;
/**
* An ID for the theme that you want to create. The theme ID is unique per AWS Region in each AWS account.
*/
ThemeId: RestrictiveResourceId;
/**
* A display name for the theme.
*/
Name: ThemeName;
/**
* The ID of the theme that a custom theme will inherit from. All themes inherit from one of the starting themes defined by Amazon QuickSight. For a list of the starting themes, use ListThemes or choose Themes from within a QuickSight analysis.
*/
BaseThemeId: RestrictiveResourceId;
/**
* A description of the first version of the theme that you're creating. Every time UpdateTheme is called, a new version is created. Each version of the theme has a description of the version in the VersionDescription field.
*/
VersionDescription?: VersionDescription;
/**
* The theme configuration, which contains the theme display properties.
*/
Configuration: ThemeConfiguration;
/**
* A valid grouping of resource permissions to apply to the new theme.
*/
Permissions?: ResourcePermissionList;
/**
* A map of the key-value pairs for the resource tag or tags that you want to add to the resource.
*/
Tags?: TagList;
}
export interface CreateThemeResponse {
/**
* The Amazon Resource Name (ARN) for the theme.
*/
Arn?: Arn;
/**
* The Amazon Resource Name (ARN) for the new theme.
*/
VersionArn?: Arn;
/**
* The ID of the theme.
*/
ThemeId?: RestrictiveResourceId;
/**
* The theme creation status.
*/
CreationStatus?: ResourceStatus;
/**
* The HTTP status of the request.
*/
Status?: StatusCode;
/**
* The AWS request ID for this operation.
*/
RequestId?: String;
}
export interface CredentialPair {
/**
* User name.
*/
Username: Username;
/**
* Password.
*/
Password: Password;
/**
* 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 allowlist. 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?: DataSourceParametersList;
}
export interface CustomSql {
/**
* The Amazon Resource Name (ARN) of the data source.
*/
DataSourceArn: Arn;
/**
* A display name for the SQL query result.
*/
Name: CustomSqlName;
/**
* The SQL query.
*/
SqlQuery: SqlQuery;
/**
* The column schema from the SQL query result set.
*/
Columns?: InputColumnList;
}
export type CustomSqlName = string;
export interface Dashboard {
/**
* Dashboard ID.
*/
DashboardId?: RestrictiveResourceId;
/**
* The Amazon Resource Name (ARN) of the resource.
*/
Arn?: Arn;
/**
* A display name for the dashboard.
*/
Name?: DashboardName;
/**
* Version.
*/
Version?: DashboardVersion;
/**
* The time that this dataset was created.
*/
CreatedTime?: Timestamp;
/**
* The last time that this dataset was published.
*/
LastPublishedTime?: Timestamp;
/**
* The last time that this dataset was updated.
*/
LastUpdatedTime?: Timestamp;
}
export type DashboardBehavior = "ENABLED"|"DISABLED"|string;
export interface DashboardError {
/**
* Type.
*/
Type?: DashboardErrorType;
/**
* Message.
*/
Message?: NonEmptyString;
}
export type DashboardErrorList = DashboardError[];
export type DashboardErrorType = "ACCESS_DENIED"|"SOURCE_NOT_FOUND"|"DATA_SET_NOT_FOUND"|"INTERNAL_FAILURE"|"PARAMETER_VALUE_INCOMPATIBLE"|"PARAMETER_TYPE_INVALID"|"PARAMETER_NOT_FOUND"|"COLUMN_TYPE_MISMATCH"|"COLUMN_GEOGRAPHIC_ROLE_MISMATCH"|"COLUMN_REPLACEMENT_MISSING"|string;
export type DashboardFilterAttribute = "QUICKSIGHT_USER"|string;
export type DashboardName = string;
export interface DashboardPublishOptions {
/**
* Ad hoc (one-time) filtering option.
*/
AdHocFilteringOption?: AdHocFilteringOption;
/**
* Export to .csv option.
*/
ExportToCSVOption?: ExportToCSVOption;
/**
* Sheet controls option.
*/
SheetControlsOption?: SheetControlsOption;
}
export interface DashboardSearchFilter {
/**
* The comparison operator that you want to use as a filter, for example, "Operator": "StringEquals".
*/
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;
}
export type DashboardSearchFilterList = DashboardSearchFilter[];
export interface DashboardSourceEntity {
/**
* Source template.
*/
SourceTemplate?: DashboardSourceTemplate;
}
export interface DashboardSourceTemplate {
/**
* Dataset references.
*/
DataSetReferences: DataSetReferenceList;
/**
* The Amazon Resource Name (ARN) of the resource.
*/
Arn: Arn;
}
export interface DashboardSummary {
/**
* The Amazon Resource Name (ARN) of the resource.
*/
Arn?: Arn;
/**
* Dashboard ID.
*/
DashboardId?: RestrictiveResourceId;
/**
* A display name for the dashboard.
*/
Name?: DashboardName;
/**
* The time that this dashboard was created.
*/
CreatedTime?: Timestamp;
/**
* The last time that this dashboard was updated.
*/
LastUpdatedTime?: Timestamp;
/**
* Published version number.
*/
PublishedVersionNumber?: VersionNumber;
/**
* The last time that this dashboard was published.
*/
LastPublishedTime?: Timestamp;
}
export type DashboardSummaryList = DashboardSummary[];
export type DashboardUIState = "EXPANDED"|"COLLAPSED"|string;
export interface DashboardVersion {
/**
* The time that this dashboard version was created.
*/
CreatedTime?: Timestamp;
/**
* Errors associated with this dashboard version.
*/
Errors?: DashboardErrorList;
/**
* Version number for this version of the dashboard.
*/
VersionNumber?: VersionNumber;
/**
* The HTTP status of the request.
*/
Status?: ResourceStatus;
/**
* The Amazon Resource Name (ARN) of the resource.
*/
Arn?: Arn;
/**
* Source entity ARN.
*/
SourceEntityArn?: Arn;
/**
* The Amazon Resource Numbers (ARNs) for the datasets that are associated with this version of the dashboard.
*/
DataSetArns?: DataSetArnsList;
/**
* Description.
*/
Description?: VersionDescription;
/**
* The ARN of the theme associated with a version of the dashboard.
*/
ThemeArn?: Arn;
/**
* A list of the associated sheets with the unique identifier and name of each sheet.
*/
Sheets?: SheetList;
}
export interface DashboardVersionSummary {
/**
* The Amazon Resource Name (ARN) of the resource.
*/
Arn?: Arn;
/**
* The time that this dashboard version was created.
*/
CreatedTime?: Timestamp;
/**
* Version number.
*/
VersionNumber?: VersionNumber;
/**
* The HTTP status of the request.
*/
Status?: ResourceStatus;
/**
* Source entity ARN.
*/
SourceEntityArn?: Arn;
/**
* Description.
*/
Description?: VersionDescription;
}
export type DashboardVersionSummaryList = DashboardVersionSummary[];
export interface DataColorPalette {
/**
* The hexadecimal codes for the colors.
*/
Colors?: ColorList;
/**
* The minimum and maximum hexadecimal codes that describe a color gradient.
*/
MinMaxGradient?: ColorList;
/**
* The hexadecimal code of a color that applies to charts where a lack of data is highlighted.
*/
EmptyFillColor?: HexColor;
}
export interface DataSet {
/**
* The Amazon Resource Name (ARN) of the resource.
*/
Arn?: Arn;
/**
* The ID of the dataset.
*/
DataSetId?: ResourceId;
/**
* A display name for the dataset.
*/
Name?: ResourceName;
/**
* The time that this dataset was created.
*/
CreatedTime?: Timestamp;
/**
* The last time that this dataset was updated.
*/
LastUpdatedTime?: Timestamp;
/**
* Declares the physical tables that are available in the underlying data sources.
*/
PhysicalTableMap?: PhysicalTableMap;
/**
* Configures the combination and transformation of the data from the physical tables.
*/
LogicalTableMap?: LogicalTableMap;
/**
* The list of columns after all transforms. These columns are available in templates, analyses, and dashboards.
*/
OutputColumns?: OutputColumnList;
/**
* Indicates whether you want to import the data into SPICE.
*/
ImportMode?: DataSetImportMode;
/**
* The amount of SPICE capacity used by this dataset. This is 0 if the dataset isn't imported into SPICE.
*/
ConsumedSpiceCapacityInBytes?: Long;
/**
* Groupings of columns that work together in certain Amazon QuickSight features. Currently, only geospatial hierarchy is supported.
*/
ColumnGroups?: ColumnGroupList;
/**
* The row-level security configuration for the dataset.
*/
RowLevelPermissionDataSet?: RowLevelPermissionDataSet;
}
export type DataSetArnsList = Arn[];
export interface DataSetConfiguration {
/**
* Placeholder.
*/
Placeholder?: String;
/**
* Dataset schema.
*/
DataSetSchema?: DataSetSchema;
/**
* A structure containing the list of column group schemas.
*/
ColumnGroupSchemaList?: ColumnGroupSchemaList;
}
export type DataSetConfigurationList = DataSetConfiguration[];
export type DataSetImportMode = "SPICE"|"DIRECT_QUERY"|string;
export type DataSetName = string;
export interface DataSetReference {
/**
* Dataset placeholder.
*/
DataSetPlaceholder: NonEmptyString;
/**
* Dataset Amazon Resource Name (ARN).
*/
DataSetArn: Arn;
}
export type DataSetReferenceList = DataSetReference[];
export interface DataSetSchema {
/**
* A structure containing the list of column schemas.
*/
ColumnSchemaList?: ColumnSchemaList;
}
export interface DataSetSummary {
/**
* The Amazon Resource Name (ARN) of the dataset.
*/
Arn?: Arn;
/**
* The ID of the dataset.
*/
DataSetId?: ResourceId;
/**
* A display name for the dataset.
*/
Name?: ResourceName;
/**
* The time that this dataset was created.
*/
CreatedTime?: Timestamp;
/**
* The last time that this dataset was updated.
*/
LastUpdatedTime?: Timestamp;
/**
* Indicates whether you want to import the data into SPICE.
*/
ImportMode?: DataSetImportMode;
/**
* The row-level security configuration for the dataset.
*/
RowLevelPermissionDataSet?: RowLevelPermissionDataSet;
}
export type DataSetSummaryList = DataSetSummary[];
export interface DataSource {
/**
* The Amazon Resource Name (ARN) of the data source.
*/
Arn?: Arn;
/**
* The ID of the data source. This ID is unique per AWS Region for each AWS account.
*/
DataSourceId?: ResourceId;
/**
* A display name for the data source.
*/
Name?: ResourceName;
/**
* The type of the data source. This type indicates which database engine the data source connects to.
*/
Type?: DataSourceType;
/**
* The HTTP status of the request.
*/
Status?: ResourceStatus;
/**
* The time that this data source was created.
*/
CreatedTime?: Timestamp;
/**
* The last time that this data source was updated.
*/
LastUpdatedTime?: Timestamp;
/**
* 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;
/**
* 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 allowlist. 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?: DataSourceParametersList;
/**
* The VPC connection information. You need to use this parameter only when you want QuickSight to use a VPC connection when connecting to your underlying source.
*/
VpcConnectionProperties?: VpcConnectionProperties;
/**
* Secure Socket Layer (SSL) properties that apply when QuickSight connects to your underlying source.
*/
SslProperties?: SslProperties;
/**
* Error information from the last update or the creation of the data source.
*/
ErrorInfo?: DataSourceErrorInfo;
}
export interface DataSourceCredentials {
/**
* Credential pair. For more information, see CredentialPair.
*/
CredentialPair?: CredentialPair;
/**
* 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?: CopySourceArn;
}
export interface DataSourceErrorInfo {
/**
* Error type.
*/
Type?: DataSourceErrorInfoType;
/**
* Error message.
*/
Message?: String;
}
export type DataSourceErrorInfoType = "ACCESS_DENIED"|"COPY_SOURCE_NOT_FOUND"|"TIMEOUT"|"ENGINE_VERSION_NOT_SUPPORTED"|"UNKNOWN_HOST"|"GENERIC_SQL_FAILURE"|"CONFLICT"|"UNKNOWN"|string;
export type DataSourceList = DataSource[];
export interface DataSourceParameters {
/**
* Amazon Elasticsearch Service parameters.
*/
AmazonElasticsearchParameters?: AmazonElasticsearchParameters;
/**
* Amazon Athena parameters.
*/
AthenaParameters?: AthenaParameters;
/**
* Amazon Aurora MySQL parameters.
*/
AuroraParameters?: AuroraParameters;
/**
* Aurora PostgreSQL parameters.
*/
AuroraPostgreSqlParameters?: AuroraPostgreSqlParameters;
/**
* AWS IoT Analytics parameters.
*/
AwsIotAnalyticsParameters?: AwsIotAnalyticsParameters;
/**
* Jira parameters.
*/
JiraParameters?: JiraParameters;
/**
* MariaDB parameters.
*/
MariaDbParameters?: MariaDbParameters;
/**
* MySQL parameters.
*/
MySqlParameters?: MySqlParameters;
/**
* PostgreSQL parameters.
*/
PostgreSqlParameters?: PostgreSqlParameters;
/**
* Presto parameters.
*/
PrestoParameters?: PrestoParameters;
/**
* Amazon RDS parameters.
*/
RdsParameters?: RdsParameters;
/**
* Amazon Redshift parameters.
*/
RedshiftParameters?: RedshiftParameters;
/**
* S3 parameters.
*/
S3Parameters?: S3Parameters;
/**
* ServiceNow parameters.
*/
ServiceNowParameters?: ServiceNowParameters;
/**
* Snowflake parameters.
*/
SnowflakeParameters?: SnowflakeParameters;
/**
* Spark parameters.
*/
SparkParameters?: SparkParameters;
/**
* SQL Server parameters.
*/
SqlServerParameters?: SqlServerParameters;
/**
* Teradata parameters.
*/
TeradataParameters?: TeradataParameters;
/**
* Twitter parameters.
*/
TwitterParameters?: TwitterParameters;
}
export type DataSourceParametersList = DataSourceParameters[];
export type DataSourceType = "ADOBE_ANALYTICS"|"AMAZON_ELASTICSEARCH"|"ATHENA"|"AURORA"|"AURORA_POSTGRESQL"|"AWS_IOT_ANALYTICS"|"GITHUB"|"JIRA"|"MARIADB"|"MYSQL"|"POSTGRESQL"|"PRESTO"|"REDSHIFT"|"S3"|"SALESFORCE"|"SERVICENOW"|"SNOWFLAKE"|"SPARK"|"SQLSERVER"|"TERADATA"|"TWITTER"|"TIMESTREAM"|string;
export type Database = string;
export interface DateTimeParameter {
/**
* A display name for the date-time parameter.
*/
Name: NonEmptyString;
/**
* The values for the date-time parameter.
*/
Values: TimestampList;
}
export type DateTimeParameterList = DateTimeParameter[];
export interface DecimalParameter {
/**
* A display name for the decimal parameter.
*/
Name: NonEmptyString;
/**
* The values for the decimal parameter.
*/
Values: DoubleList;
}
export type DecimalParameterList = DecimalParameter[];
export interface DeleteAccountCustomizationRequest {
/**
* The ID for the AWS account that you want to delete QuickSight customizations from in this AWS Region.
*/
AwsAccountId: AwsAccountId;
/**
* The QuickSight namespace that you're deleting the customizations from.
*/
Namespace?: Namespace;
}
export interface DeleteAccountCustomizationResponse {
/**
* The AWS request ID for this operation.
*/
RequestId?: String;
/**
* The HTTP status of the request.
*/
Status?: StatusCode;
}
export interface DeleteAnalysisRequest {
/**
* The ID of the AWS account where you want to delete an analysis.
*/
AwsAccountId: AwsAccountId;
/**
* The ID of the analysis that you're deleting.
*/
AnalysisId: RestrictiveResourceId;
/**
* A value that specifies the number of days that QuickSight waits before it deletes the analysis. You can't use this parameter with the ForceDeleteWithoutRecovery option in the same API call. The default value is 30.
*/
RecoveryWindowInDays?: RecoveryWindowInDays;
/**
* This option defaults to the value NoForceDeleteWithoutRecovery. To immediately delete the analysis, add the ForceDeleteWithoutRecovery option. You can't restore an analysis after it's deleted.
*/
ForceDeleteWithoutRecovery?: boolean;
}
export interface DeleteAnalysisResponse {
/**
* The HTTP status of the request.
*/
Status?: StatusCode;
/**
* The Amazon Resource Name (ARN) of the deleted analysis.
*/
Arn?: Arn;
/**
* The ID of the deleted analysis.
*/
AnalysisId?: RestrictiveResourceId;
/**
* The date and time that the analysis is scheduled to be deleted.
*/
DeletionTime?: Timestamp;
/**
* The AWS request ID for this operation.
*/
RequestId?: String;
}
export interface DeleteDashboardRequest {
/**
* The ID of the AWS account that contains the dashboard that you're deleting.
*/
AwsAccountId: AwsAccountId;
/**
* The ID for the dashboard.
*/
DashboardId: RestrictiveResourceId;
/**
* The version number of the dashboard. If the version number property is provided, only the specified version of the dashboard is deleted.
*/
VersionNumber?: VersionNumber;
}
export interface DeleteDashboardResponse {
/**
* The HTTP status of the request.
*/
Status?: StatusCode;
/**
* The Secure Socket Layer (SSL) properties that apply for the resource.
*/
Arn?: Arn;
/**
* The ID of the dashboard.
*/
DashboardId?: RestrictiveResourceId;
/**
* The AWS request ID for this operation.
*/
RequestId?: String;
}
export interface DeleteDataSetRequest {
/**
* The AWS account ID.
*/
AwsAccountId: AwsAccountId;
/**
* The ID for the dataset that you want to create. This ID is unique per AWS Region for each AWS account.
*/
DataSetId: ResourceId;
}
export interface DeleteDataSetResponse {
/**
* The Amazon Resource Name (ARN) of the dataset.
*/
Arn?: Arn;
/**
* The ID for the dataset that you want to create. This ID is unique per AWS Region for each AWS account.
*/
DataSetId?: ResourceId;
/**
* The AWS request ID for this operation.
*/
RequestId?: String;
/**
* The HTTP status of the request.
*/
Status?: StatusCode;
}
export interface DeleteDataSourceRequest {
/**
* The AWS account ID.
*/
AwsAccountId: AwsAccountId;
/**
* The ID of the data source. This ID is unique per AWS Region for each AWS account.
*/
DataSourceId: ResourceId;
}
export interface DeleteDataSourceResponse {
/**
* The Amazon Resource Name (ARN) of the data source that you deleted.
*/
Arn?: Arn;
/**
* The ID of the data source. This ID is unique per AWS Region for each AWS account.
*/
DataSourceId?: ResourceId;
/**
* The AWS request ID for this operation.
*/
RequestId?: String;
/**
* The HTTP status of the request.
*/
Status?: StatusCode;
}
export interface DeleteGroupMembershipRequest {
/**
* The name of the user that you want to delete from the group membership.
*/
MemberName: GroupMemberName;
/**
* The name of the group that you want to delete the user from.
*/
GroupName: GroupName;
/**
* The ID for the AWS account that the group is in. Currently, you use the ID for the AWS account that contains your Amazon QuickSight account.
*/
AwsAccountId: AwsAccountId;
/**
* The namespace. Currently, you should set this to default.
*/
Namespace: Namespace;
}
export interface DeleteGroupMembershipResponse {
/**
* The AWS request ID for this operation.
*/
RequestId?: String;
/**
* The HTTP status of the request.
*/
Status?: StatusCode;
}
export interface DeleteGroupRequest {
/**
* The name of the group that you want to delete.
*/
GroupName: GroupName;
/**
* The ID for the AWS account that the group is in. Currently, you use the ID for the AWS account that contains your Amazon QuickSight account.
*/
AwsAccountId: AwsAccountId;
/**
* The namespace. Currently, you should set this to default.
*/
Namespace: Namespace;
}
export interface DeleteGroupResponse {
/**
* The AWS request ID for this operation.
*/
RequestId?: String;
/**
* The HTTP status of the request.
*/
Status?: StatusCode;
}
export interface DeleteIAMPolicyAssignmentRequest {
/**
* The AWS account ID where you want to delete the IAM policy assignment.
*/
AwsAccountId: AwsAccountId;
/**
* The name of the assignment.
*/
AssignmentName: IAMPolicyAssignmentName;
/**
* The namespace that contains the assignment.
*/
Namespace: Namespace;
}
export interface DeleteIAMPolicyAssignmentResponse {
/**
* The name of the assignment.
*/
AssignmentName?: IAMPolicyAssignmentName;
/**
* The AWS request ID for this operation.
*/
RequestId?: String;
/**
* The HTTP status of the request.
*/
Status?: StatusCode;
}
export interface DeleteNamespaceRequest {
/**
* The ID for the AWS account that you want to delete the QuickSight namespace from.
*/
AwsAccountId: AwsAccountId;
/**
* The namespace that you want to delete.
*/
Namespace: Namespace;
}
export interface DeleteNamespaceResponse {
/**
* The AWS request ID for this operation.
*/
RequestId?: String;
/**
* The HTTP status of the request.
*/
Status?: StatusCode;
}
export interface DeleteTemplateAliasRequest {
/**
* The ID of the AWS account that contains the item to delete.
*/
AwsAccountId: AwsAccountId;
/**
* The ID for the template that the specified alias is for.
*/
TemplateId: RestrictiveResourceId;
/**
* The name for the template alias. To delete a specific alias, you delete the version that the alias points to. You can specify the alias name, or specify the latest version of the template by providing the keyword $LATEST in the AliasName parameter.
*/
AliasName: AliasName;
}
export interface DeleteTemplateAliasResponse {
/**
* The HTTP status of the request.
*/
Status?: StatusCode;
/**
* An ID for the template associated with the deletion.
*/
TemplateId?: RestrictiveResourceId;
/**
* The name for the template alias.
*/
AliasName?: AliasName;
/**
* The Amazon Resource Name (ARN) of the template you want to delete.
*/
Arn?: Arn;
/**
* The AWS request ID for this operation.
*/
RequestId?: String;
}
export interface DeleteTemplateRequest {
/**
* The ID of the AWS account that contains the template that you're deleting.
*/
AwsAccountId: AwsAccountId;
/**
* An ID for the template you want to delete.
*/
TemplateId: RestrictiveResourceId;
/**
* Specifies the version of the template that you want to delete. If you don't provide a version number, DeleteTemplate deletes all versions of the template.
*/
VersionNumber?: VersionNumber;
}
export interface DeleteTemplateResponse {
/**
* The AWS request ID for this operation.
*/
RequestId?: String;
/**
* The Amazon Resource Name (ARN) of the resource.
*/
Arn?: Arn;
/**
* An ID for the template.
*/
TemplateId?: RestrictiveResourceId;
/**
* The HTTP status of the request.
*/
Status?: StatusCode;
}
export interface DeleteThemeAliasRequest {
/**
* The ID of the AWS account that contains the theme alias to delete.
*/
AwsAccountId: AwsAccountId;
/**
* The ID for the theme that the specified alias is for.
*/
ThemeId: RestrictiveResourceId;
/**
* The unique name for the theme alias to delete.
*/
AliasName: AliasName;
}
export interface DeleteThemeAliasResponse {
/**
* The name for the theme alias.
*/
AliasName?: AliasName;
/**
* The Amazon Resource Name (ARN) of the theme resource using the deleted alias.
*/
Arn?: Arn;
/**
* The AWS request ID for this operation.
*/
RequestId?: String;
/**
* The HTTP status of the request.
*/
Status?: StatusCode;
/**
* An ID for the theme associated with the deletion.
*/
ThemeId?: RestrictiveResourceId;
}
export interface DeleteThemeRequest {
/**
* The ID of the AWS account that contains the theme that you're deleting.
*/
AwsAccountId: AwsAccountId;
/**
* An ID for the theme that you want to delete.
*/
ThemeId: RestrictiveResourceId;
/**
* The version of the theme that you want to delete. Note: If you don't provide a version number, you're using this call to DeleteTheme to delete all versions of the theme.
*/
VersionNumber?: VersionNumber;
}
export interface DeleteThemeResponse {
/**
* The Amazon Resource Name (ARN) of the resource.
*/
Arn?: Arn;
/**
* The AWS request ID for this operation.
*/
RequestId?: String;
/**
* The HTTP status of the request.
*/
Status?: StatusCode;
/**
* An ID for the theme.
*/
ThemeId?: RestrictiveResourceId;
}
export interface DeleteUserByPrincipalIdRequest {
/**
* The principal ID of the user.
*/
PrincipalId: String;
/**
* The ID for the AWS account that the user is in. Currently, you use the ID for the AWS account that contains your Amazon QuickSight account.
*/
AwsAccountId: AwsAccountId;
/**
* The namespace. Currently, you should set this to default.
*/
Namespace: Namespace;
}
export interface DeleteUserByPrincipalIdResponse {
/**
* The AWS request ID for this operation.
*/
RequestId?: String;
/**
* The HTTP status of the request.
*/
Status?: StatusCode;
}
export interface DeleteUserRequest {
/**
* The name of the user that you want to delete.
*/
UserName: UserName;
/**
* The ID for the AWS account that the user is in. Currently, you use the ID for the AWS account that contains your Amazon QuickSight account.
*/
AwsAccountId: AwsAccountId;
/**
* The namespace. Currently, you should set this to default.
*/
Namespace: Namespace;
}
export interface DeleteUserResponse {
/**
* The AWS request ID for this operation.
*/
RequestId?: String;
/**
* The HTTP status of the request.
*/
Status?: StatusCode;
}
export type Delimiter = string;
export interface DescribeAccountCustomizationRequest {
/**
* The ID for the AWS account that you want to describe QuickSight customizations for.
*/
AwsAccountId: AwsAccountId;
/**
* The QuickSight namespace that you want to describe QuickSight customizations for.
*/
Namespace?: Namespace;
/**
* The Resolved flag works with the other parameters to determine which view of QuickSight customizations is returned. You can add this flag to your command to use the same view that QuickSight uses to identify which customizations to apply to the console. Omit this flag, or set it to no-resolved, to reveal customizations that are configured at different levels.
*/
Resolved?: boolean;
}
export interface DescribeAccountCustomizationResponse {
/**
* The Amazon Resource Name (ARN) of the customization that's associated with this AWS account.
*/
Arn?: Arn;
/**
* The ID for the AWS account that you're describing.
*/
AwsAccountId?: AwsAccountId;
/**
* The QuickSight namespace that you're describing.
*/
Namespace?: Namespace;
/**
* The QuickSight customizations that exist in the current AWS Region.
*/
AccountCustomization?: AccountCustomization;
/**
* The AWS request ID for this operation.
*/
RequestId?: String;
/**
* The HTTP status of the request.
*/
Status?: StatusCode;
}
export interface DescribeAccountSettingsRequest {
/**
* The ID for the AWS account that contains the settings that you want to list.
*/
AwsAccountId: AwsAccountId;
}
export interface DescribeAccountSettingsResponse {
/**
* The QuickSight settings for this AWS account. This information includes the edition of Amazon QuickSight that you subscribed to (Standard or Enterprise) and the notification email for the QuickSight subscription. In the QuickSight console, the QuickSight subscription is sometimes referred to as a QuickSight "account" even though it's technically not an account by itself. Instead, it's a subscription to the QuickSight service for your AWS account. The edition that you subscribe to applies to QuickSight in every AWS Region where you use it.
*/
AccountSettings?: AccountSettings;
/**
* The AWS request ID for this operation.
*/
RequestId?: String;
/**
* The HTTP status of the request.
*/
Status?: StatusCode;
}
export interface DescribeAnalysisPermissionsRequest {
/**
* The ID of the AWS account that contains the analysis whose permissions you're describing. You must be using the AWS account that the analysis is in.
*/
AwsAccountId: AwsAccountId;
/**
* The ID of the analysis whose permissions you're describing. The ID is part of the analysis URL.
*/
AnalysisId: RestrictiveResourceId;
}
export interface DescribeAnalysisPermissionsResponse {
/**
* The ID of the analysis whose permissions you're describing.
*/
AnalysisId?: RestrictiveResourceId;
/**
* The Amazon Resource Name (ARN) of the analysis whose permissions you're describing.
*/
AnalysisArn?: Arn;
/**
* A structure that describes the principals and the resource-level permissions on an analysis.
*/
Permissions?: ResourcePermissionList;
/**
* The HTTP status of the request.
*/
Status?: StatusCode;
/**
* The AWS request ID for this operation.
*/
RequestId?: String;
}
export interface DescribeAnalysisRequest {
/**
* The ID of the AWS account that contains the analysis. You must be using the AWS account that the analysis is in.
*/
AwsAccountId: AwsAccountId;
/**
* The ID of the analysis that you're describing. The ID is part of the URL of the analysis.
*/
AnalysisId: RestrictiveResourceId;
}
export interface DescribeAnalysisResponse {
/**
* A metadata structure that contains summary information for the analysis that you're describing.
*/
Analysis?: Analysis;
/**
* The HTTP status of the request.
*/
Status?: StatusCode;
/**
* The AWS request ID for this operation.
*/
RequestId?: String;
}
export interface DescribeDashboardPermissionsRequest {
/**
* The ID of the AWS account that contains the dashboard that you're describing permissions for.
*/
AwsAccountId: AwsAccountId;
/**
* The ID for the dashboard, also added to the IAM policy.
*/
DashboardId: RestrictiveResourceId;
}
export interface DescribeDashboardPermissionsResponse {
/**
* The ID for the dashboard.
*/
DashboardId?: RestrictiveResourceId;
/**
* The Amazon Resource Name (ARN) of the dashboard.
*/
DashboardArn?: Arn;
/**
* A structure that contains the permissions for the dashboard.
*/
Permissions?: ResourcePermissionList;
/**
* The HTTP status of the request.
*/
Status?: StatusCode;
/**
* The AWS request ID for this operation.
*/
RequestId?: String;
}
export interface DescribeDashboardRequest {
/**
* The ID of the AWS account that contains the dashboard that you're describing.
*/
AwsAccountId: AwsAccountId;
/**
* The ID for the dashboard.
*/
DashboardId: RestrictiveResourceId;
/**
* The version number for the dashboard. If a version number isn't passed, the latest published dashboard version is described.
*/
VersionNumber?: VersionNumber;
/**
* The alias name.
*/
AliasName?: AliasName;
}
export interface DescribeDashboardResponse {
/**
* Information about the dashboard.
*/
Dashboard?: Dashboard;
/**
* The HTTP status of this request.
*/
Status?: StatusCode;
/**
* The AWS request ID for this operation.
*/
RequestId?: String;
}
export interface DescribeDataSetPermissionsRequest {
/**
* The AWS account ID.
*/
AwsAccountId: AwsAccountId;
/**
* The ID for the dataset that you want to create. This ID is unique per AWS Region for each AWS account.
*/
DataSetId: ResourceId;
}
export interface DescribeDataSetPermissionsResponse {
/**
* The Amazon Resource Name (ARN) of the dataset.
*/
DataSetArn?: Arn;
/**
* The ID for the dataset that you want to create. This ID is unique per AWS Region for each AWS account.
*/
DataSetId?: ResourceId;
/**
* A list of resource permissions on the dataset.
*/
Permissions?: ResourcePermissionList;
/**
* The AWS request ID for this operation.
*/
RequestId?: String;
/**
* The HTTP status of the request.
*/
Status?: StatusCode;
}
export interface DescribeDataSetRequest {
/**
* The AWS account ID.
*/
AwsAccountId: AwsAccountId;
/**
* The ID for the dataset that you want to create. This ID is unique per AWS Region for each AWS account.
*/
DataSetId: ResourceId;
}
export interface DescribeDataSetResponse {
/**
* Information on the dataset.
*/
DataSet?: DataSet;
/**
* The AWS request ID for this operation.
*/
RequestId?: String;
/**
* The HTTP status of the request.
*/
Status?: StatusCode;
}
export interface DescribeDataSourcePermissionsRequest {
/**
* The AWS account ID.
*/
AwsAccountId: AwsAccountId;
/**
* The ID of the data source. This ID is unique per AWS Region for each AWS account.
*/
DataSourceId: ResourceId;
}
export interface DescribeDataSourcePermissionsResponse {
/**
* The Amazon Resource Name (ARN) of the data source.
*/
DataSourceArn?: Arn;
/**
* The ID of the data source. This ID is unique per AWS Region for each AWS account.
*/
DataSourceId?: ResourceId;
/**
* A list of resource permissions on the data source.
*/
Permissions?: ResourcePermissionList;
/**
* The AWS request ID for this operation.
*/
RequestId?: String;
/**
* The HTTP status of the request.
*/
Status?: StatusCode;
}
export interface DescribeDataSourceRequest {
/**
* The AWS account ID.
*/
AwsAccountId: AwsAccountId;
/**
* The ID of the data source. This ID is unique per AWS Region for each AWS account.
*/
DataSourceId: ResourceId;
}
export interface DescribeDataSourceResponse {
/**
* The information on the data source.
*/
DataSource?: DataSource;
/**
* The AWS request ID for this operation.
*/
RequestId?: String;
/**
* The HTTP status of the request.
*/
Status?: StatusCode;
}
export interface DescribeGroupRequest {
/**
* The name of the group that you want to describe.
*/
GroupName: GroupName;
/**
* The ID for the AWS account that the group is in. Currently, you use the ID for the AWS account that contains your Amazon QuickSight account.
*/
AwsAccountId: AwsAccountId;
/**
* The namespace. Currently, you should set this to default.
*/
Namespace: Namespace;
}
export interface DescribeGroupResponse {
/**
* The name of the group.
*/
Group?: Group;
/**
* The AWS request ID for this operation.
*/
RequestId?: String;
/**
* The HTTP status of the request.
*/
Status?: StatusCode;
}
export interface DescribeIAMPolicyAssignmentRequest {
/**
* The ID of the AWS account that contains the assignment that you want to describe.
*/
AwsAccountId: AwsAccountId;
/**
* The name of the assignment.
*/
AssignmentName: IAMPolicyAssignmentName;
/**
* The namespace that contains the assignment.
*/
Namespace: Namespace;
}
export interface DescribeIAMPolicyAssignmentResponse {
/**
* Information describing the IAM policy assignment.
*/
IAMPolicyAssignment?: IAMPolicyAssignment;
/**
* The AWS request ID for this operation.
*/
RequestId?: String;
/**
* The HTTP status of the request.
*/
Status?: StatusCode;
}
export interface DescribeIngestionRequest {
/**
* The AWS account ID.
*/
AwsAccountId: AwsAccountId;
/**
* The ID of the dataset used in the ingestion.
*/
DataSetId: string;
/**
* An ID for the ingestion.
*/
IngestionId: IngestionId;
}
export interface DescribeIngestionResponse {
/**
* Information about the ingestion.
*/
Ingestion?: Ingestion;
/**
* The AWS request ID for this operation.
*/
RequestId?: string;
/**
* The HTTP status of the request.
*/
Status?: StatusCode;
}
export interface DescribeNamespaceRequest {
/**
* The ID for the AWS account that contains the QuickSight namespace that you want to describe.
*/
AwsAccountId: AwsAccountId;
/**
* The namespace that you want to describe.
*/
Namespace: Namespace;
}
export interface DescribeNamespaceResponse {
/**
* The information about the namespace that you're describing. The response includes the namespace ARN, name, AWS Region, creation status, and identity store. DescribeNamespace also works for namespaces that are in the process of being created. For incomplete namespaces, this API operation lists the namespace error types and messages associated with the creation process.
*/
Namespace?: NamespaceInfoV2;
/**
* The AWS request ID for this operation.
*/
RequestId?: String;
/**
* The HTTP status of the request.
*/
Status?: StatusCode;
}
export interface DescribeTemplateAliasRequest {
/**
* The ID of the AWS account that contains the template alias that you're describing.
*/
AwsAccountId: AwsAccountId;
/**
* The ID for the template.
*/
TemplateId: RestrictiveResourceId;
/**
* The name of the template alias that you want to describe. If you name a specific alias, you describe the version that the alias points to. You can specify the latest version of the template by providing the keyword $LATEST in the AliasName parameter. The keyword $PUBLISHED doesn't apply to templates.
*/
AliasName: AliasName;
}
export interface DescribeTemplateAliasResponse {
/**
* Information about the template alias.
*/
TemplateAlias?: TemplateAlias;
/**
* The HTTP status of the request.
*/
Status?: StatusCode;
/**
* The AWS request ID for this operation.
*/
RequestId?: String;
}
export interface DescribeTemplatePermissionsRequest {
/**
* The ID of the AWS account that contains the template that you're describing.
*/
AwsAccountId: AwsAccountId;
/**
* The ID for the template.
*/
TemplateId: RestrictiveResourceId;
}
export interface DescribeTemplatePermissionsResponse {
/**
* The ID for the template.
*/
TemplateId?: RestrictiveResourceId;
/**
* The Amazon Resource Name (ARN) of the template.
*/
TemplateArn?: Arn;
/**
* A list of resource permissions to be set on the template.
*/
Permissions?: ResourcePermissionList;
/**
* The AWS request ID for this operation.
*/
RequestId?: String;
/**
* The HTTP status of the request.
*/
Status?: StatusCode;
}
export interface DescribeTemplateRequest {
/**
* The ID of the AWS account that contains the template that you're describing.
*/
AwsAccountId: AwsAccountId;
/**
* The ID for the template.
*/
TemplateId: RestrictiveResourceId;
/**
* (Optional) The number for the version to describe. If a VersionNumber parameter value isn't provided, the latest version of the template is described.
*/
VersionNumber?: VersionNumber;
/**
* The alias of the template that you want to describe. If you name a specific alias, you describe the version that the alias points to. You can specify the latest version of the template by providing the keyword $LATEST in the AliasName parameter. The keyword $PUBLISHED doesn't apply to templates.
*/
AliasName?: AliasName;
}
export interface DescribeTemplateResponse {
/**
* The template structure for the object you want to describe.
*/
Template?: Template;
/**
* The HTTP status of the request.
*/
Status?: StatusCode;
/**
* The AWS request ID for this operation.
*/
RequestId?: String;
}
export interface DescribeThemeAliasRequest {
/**
* The ID of the AWS account that contains the theme alias that you're describing.
*/
AwsAccountId: AwsAccountId;
/**
* The ID for the theme.
*/
ThemeId: RestrictiveResourceId;
/**
* The name of the theme alias that you want to describe.
*/
AliasName: AliasName;
}
export interface DescribeThemeAliasResponse {
/**
* Information about the theme alias.
*/
ThemeAlias?: ThemeAlias;
/**
* The HTTP status of the request.
*/
Status?: StatusCode;
/**
* The AWS request ID for this operation.
*/
RequestId?: String;
}
export interface DescribeThemePermissionsRequest {
/**
* The ID of the AWS account that contains the theme that you're describing.
*/
AwsAccountId: AwsAccountId;
/**
* The ID for the theme that you want to describe permissions for.
*/
ThemeId: RestrictiveResourceId;
}
export interface DescribeThemePermissionsResponse {
/**
* The ID for the theme.
*/
ThemeId?: RestrictiveResourceId;
/**
* The Amazon Resource Name (ARN) of the theme.
*/
ThemeArn?: Arn;
/**
* A list of resource permissions set on the theme.
*/
Permissions?: ResourcePermissionList;
/**
* The AWS request ID for this operation.
*/
RequestId?: String;
/**
* The HTTP status of the request.
*/
Status?: StatusCode;
}
export interface DescribeThemeRequest {
/**
* The ID of the AWS account that contains the theme that you're describing.
*/
AwsAccountId: AwsAndAccountId;
/**
* The ID for the theme.
*/
ThemeId: RestrictiveResourceId;
/**
* The version number for the version to describe. If a VersionNumber parameter value isn't provided, the latest version of the theme is described.
*/
VersionNumber?: VersionNumber;
/**
* The alias of the theme that you want to describe. If you name a specific alias, you describe the version that the alias points to. You can specify the latest version of the theme by providing the keyword $LATEST in the AliasName parameter. The keyword $PUBLISHED doesn't apply to themes.
*/
AliasName?: AliasName;
}
export interface DescribeThemeResponse {
/**
* The information about the theme that you are describing.
*/
Theme?: Theme;
/**
* The HTTP status of the request.
*/
Status?: StatusCode;
/**
* The AWS request ID for this operation.
*/
RequestId?: String;
}
export interface DescribeUserRequest {
/**
* The name of the user that you want to describe.
*/
UserName: UserName;
/**
* The ID for the AWS account that the user is in. Currently, you use the ID for the AWS account that contains your Amazon QuickSight account.
*/
AwsAccountId: AwsAccountId;
/**
* The namespace. Currently, you should set this to default.
*/
Namespace: Namespace;
}
export interface DescribeUserResponse {
/**
* The user name.
*/
User?: User;
/**
* The AWS request ID for this operation.
*/
RequestId?: String;
/**
* The HTTP status of the request.
*/
Status?: StatusCode;
}
export type Domain = string;
export type Double = number;
export type DoubleList = Double[];
export type Edition = "STANDARD"|"ENTERPRISE"|string;
export type EmbeddingUrl = string;
export type EntryPoint = string;
export interface ErrorInfo {
/**
* Error type.
*/
Type?: IngestionErrorType;
/**
* Error message.
*/
Message?: string;
}
export interface ExportToCSVOption {
/**
* Availability status.
*/
AvailabilityStatus?: DashboardBehavior;
}
export type Expression = string;
export type FileFormat = "CSV"|"TSV"|"CLF"|"ELF"|"XLSX"|"JSON"|string;
export interface FilterOperation {
/**
* An expression that must evaluate to a Boolean value. Rows for which the expression evaluates to true are kept in the dataset.
*/
ConditionExpression: Expression;
}
export type FilterOperator = "StringEquals"|string;
export interface GeoSpatialColumnGroup {
/**
* A display name for the hierarchy.
*/
Name: ColumnGroupName;
/**
* Country code.
*/
CountryCode: GeoSpatialCountryCode;
/**
* Columns in this hierarchy.
*/
Columns: ColumnList;
}
export type GeoSpatialCountryCode = "US"|string;
export type GeoSpatialDataRole = "COUNTRY"|"STATE"|"COUNTY"|"CITY"|"POSTCODE"|"LONGITUDE"|"LATITUDE"|string;
export interface GetDashboardEmbedUrlRequest {
/**
* The ID for the AWS account that contains the dashboard that you're embedding.
*/
AwsAccountId: AwsAccountId;
/**
* The ID for the dashboard, also added to the IAM policy.
*/
DashboardId: RestrictiveResourceId;
/**
* The authentication method that the user uses to sign in.
*/
IdentityType: IdentityType;
/**
* How many minutes the session is valid. The session lifetime must be 15-600 minutes.
*/
SessionLifetimeInMinutes?: SessionLifetimeInMinutes;
/**
* Remove the undo/redo button on the embedded dashboard. The default is FALSE, which enables the undo/redo button.
*/
UndoRedoDisabled?: boolean;
/**
* Remove the reset button on the embedded dashboard. The default is FALSE, which enables the reset button.
*/
ResetDisabled?: boolean;
/**
* The Amazon QuickSight user's Amazon Resource Name (ARN), for use with QUICKSIGHT identity type. You can use this for any Amazon QuickSight users in your account (readers, authors, or admins) authenticated as one of the following: Active Directory (AD) users or group members Invited nonfederated users IAM users and IAM role-based sessions authenticated through Federated Single Sign-On using SAML, OpenID Connect, or IAM federation. Omit this parameter for users in the third group – IAM users and IAM role-based sessions.
*/
UserArn?: Arn;
}
export interface GetDashboardEmbedUrlResponse {
/**
* A single-use URL that you can put into your server-side webpage to embed your dashboard. This URL is valid for 5 minutes. The API operation provides the URL with an auth_code value that enables one (and only one) sign-on to a user session that is valid for 10 hours.
*/
EmbedUrl?: EmbeddingUrl;
/**
* The HTTP status of the request.
*/
Status?: StatusCode;
/**
* The AWS request ID for this operation.
*/
RequestId?: String;
}
export interface GetSessionEmbedUrlRequest {
/**
* The ID for the AWS account associated with your QuickSight subscription.
*/
AwsAccountId: AwsAccountId;
/**
* The URL you use to access the embedded session. The entry point URL is constrained to the following paths: /start /start/analyses /start/dashboards /start/favorites /dashboards/DashboardId - where DashboardId is the actual ID key from the QuickSight console URL of the dashboard /analyses/AnalysisId - where AnalysisId is the actual ID key from the QuickSight console URL of the analysis
*/
EntryPoint?: EntryPoint;
/**
* How many minutes the session is valid. The session lifetime must be 15-600 minutes.
*/
SessionLifetimeInMinutes?: SessionLifetimeInMinutes;
/**
* The Amazon QuickSight user's Amazon Resource Name (ARN), for use with QUICKSIGHT identity type. You can use this for any type of Amazon QuickSight users in your account (readers, authors, or admins). They need to be authenticated as one of the following: Active Directory (AD) users or group members Invited nonfederated users IAM users and IAM role-based sessions authenticated through Federated Single Sign-On using SAML, OpenID Connect, or IAM federation Omit this parameter for users in the third group – IAM users and IAM role-based sessions.
*/
UserArn?: Arn;
}
export interface GetSessionEmbedUrlResponse {
/**
* A single-use URL that you can put into your server-side web page to embed your QuickSight session. This URL is valid for 5 minutes. The API operation provides the URL with an auth_code value that enables one (and only one) sign-on to a user session that is valid for 10 hours.
*/
EmbedUrl?: EmbeddingUrl;
/**
* The HTTP status of the request.
*/
Status?: StatusCode;
/**
* The AWS request ID for this operation.
*/
RequestId?: String;
}
export interface Group {
/**
* The Amazon Resource Name (ARN) for the group.
*/
Arn?: Arn;
/**
* The name of the group.
*/
GroupName?: GroupName;
/**
* The group description.
*/
Description?: GroupDescription;
/**
* The principal ID of the group.
*/
PrincipalId?: String;
}
export type GroupDescription = string;
export type GroupList = Group[];
export interface GroupMember {
/**
* The Amazon Resource Name (ARN) for the group member (user).
*/
Arn?: Arn;
/**
* The name of the group member (user).
*/
MemberName?: GroupMemberName;
}
export type GroupMemberList = GroupMember[];
export type GroupMemberName = string;
export type GroupName = string;
export interface GutterStyle {
/**
* This Boolean value controls whether to display a gutter space between sheet tiles.
*/
Show?: boolean;
}
export type HexColor = string;
export type Host = string;
export interface IAMPolicyAssignment {
/**
* The AWS account ID.
*/
AwsAccountId?: AwsAccountId;
/**
* Assignment ID.
*/
AssignmentId?: String;
/**
* Assignment name.
*/
AssignmentName?: IAMPolicyAssignmentName;
/**
* The Amazon Resource Name (ARN) for the IAM policy.
*/
PolicyArn?: Arn;
/**
* Identities.
*/
Identities?: IdentityMap;
/**
* Assignment status.
*/
AssignmentStatus?: AssignmentStatus;
}
export type IAMPolicyAssignmentName = string;
export interface IAMPolicyAssignmentSummary {
/**
* Assignment name.
*/
AssignmentName?: IAMPolicyAssignmentName;
/**
* Assignment status.
*/
AssignmentStatus?: AssignmentStatus;
}
export type IAMPolicyAssignmentSummaryList = IAMPolicyAssignmentSummary[];
export type IdentityMap = {[key: string]: IdentityNameList};
export type IdentityName = string;
export type IdentityNameList = IdentityName[];
export type IdentityStore = "QUICKSIGHT"|string;
export type IdentityType = "IAM"|"QUICKSIGHT"|string;
export interface Ingestion {
/**
* The Amazon Resource Name (ARN) of the resource.
*/
Arn: Arn;
/**
* Ingestion ID.
*/
IngestionId?: IngestionId;
/**
* Ingestion status.
*/
IngestionStatus: IngestionStatus;
/**
* Error information for this ingestion.
*/
ErrorInfo?: ErrorInfo;
RowInfo?: RowInfo;
QueueInfo?: QueueInfo;
/**
* The time that this ingestion started.
*/
CreatedTime: timestamp;
/**
* The time that this ingestion took, measured in seconds.
*/
IngestionTimeInSeconds?: long;
/**
* The size of the data ingested, in bytes.
*/
IngestionSizeInBytes?: long;
/**
* Event source for this ingestion.
*/
RequestSource?: IngestionRequestSource;
/**
* Type of this ingestion.
*/
RequestType?: IngestionRequestType;
}
export type IngestionErrorType = "FAILURE_TO_ASSUME_ROLE"|"INGESTION_SUPERSEDED"|"INGESTION_CANCELED"|"DATA_SET_DELETED"|"DATA_SET_NOT_SPICE"|"S3_UPLOADED_FILE_DELETED"|"S3_MANIFEST_ERROR"|"DATA_TOLERANCE_EXCEPTION"|"SPICE_TABLE_NOT_FOUND"|"DATA_SET_SIZE_LIMIT_EXCEEDED"|"ROW_SIZE_LIMIT_EXCEEDED"|"ACCOUNT_CAPACITY_LIMIT_EXCEEDED"|"CUSTOMER_ERROR"|"DATA_SOURCE_NOT_FOUND"|"IAM_ROLE_NOT_AVAILABLE"|"CONNECTION_FAILURE"|"SQL_TABLE_NOT_FOUND"|"PERMISSION_DENIED"|"SSL_CERTIFICATE_VALIDATION_FAILURE"|"OAUTH_TOKEN_FAILURE"|"SOURCE_API_LIMIT_EXCEEDED_FAILURE"|"PASSWORD_AUTHENTICATION_FAILURE"|"SQL_SCHEMA_MISMATCH_ERROR"|"INVALID_DATE_FORMAT"|"INVALID_DATAPREP_SYNTAX"|"SOURCE_RESOURCE_LIMIT_EXCEEDED"|"SQL_INVALID_PARAMETER_VALUE"|"QUERY_TIMEOUT"|"SQL_NUMERIC_OVERFLOW"|"UNRESOLVABLE_HOST"|"UNROUTABLE_HOST"|"SQL_EXCEPTION"|"S3_FILE_INACCESSIBLE"|"IOT_FILE_NOT_FOUND"|"IOT_DATA_SET_FILE_EMPTY"|"INVALID_DATA_SOURCE_CONFIG"|"DATA_SOURCE_AUTH_FAILED"|"DATA_SOURCE_CONNECTION_FAILED"|"FAILURE_TO_PROCESS_JSON_FILE"|"INTERNAL_SERVICE_ERROR"|string;
export type IngestionId = string;
export type IngestionMaxResults = number;
export type IngestionRequestSource = "MANUAL"|"SCHEDULED"|string;
export type IngestionRequestType = "INITIAL_INGESTION"|"EDIT"|"INCREMENTAL_REFRESH"|"FULL_REFRESH"|string;
export type IngestionStatus = "INITIALIZED"|"QUEUED"|"RUNNING"|"FAILED"|"COMPLETED"|"CANCELLED"|string;
export type Ingestions = Ingestion[];
export interface InputColumn {
/**
* The name of this column in the underlying data source.
*/
Name: ColumnName;
/**
* The data type of the column.
*/
Type: InputColumnDataType;
}
export type InputColumnDataType = "STRING"|"INTEGER"|"DECIMAL"|"DATETIME"|"BIT"|"BOOLEAN"|"JSON"|string;
export type InputColumnList = InputColumn[];
export type InstanceId = string;
export interface IntegerParameter {
/**
* The name of the integer parameter.
*/
Name: NonEmptyString;
/**
* The values for the integer parameter.
*/
Values: LongList;
}
export type IntegerParameterList = IntegerParameter[];
export interface JiraParameters {
/**
* The base URL of the Jira site.
*/
SiteBaseUrl: SiteBaseUrl;
}
export interface JoinInstruction {
/**
* Left operand.
*/
LeftOperand: LogicalTableId;
/**
* Right operand.
*/
RightOperand: LogicalTableId;
/**
* Type.
*/
Type: JoinType;
/**
* On Clause.
*/
OnClause: OnClause;
}
export type JoinType = "INNER"|"OUTER"|"LEFT"|"RIGHT"|string;
export interface ListAnalysesRequest {
/**
* The ID of the AWS account that contains the analyses.
*/
AwsAccountId: AwsAccountId;
/**
* A pagination token that can be used in a subsequent request.
*/
NextToken?: String;
/**
* The maximum number of results to return.
*/
MaxResults?: MaxResults;
}
export interface ListAnalysesResponse {
/**
* Metadata describing each of the analyses that are listed.
*/
AnalysisSummaryList?: AnalysisSummaryList;
/**
* A pagination token that can be used in a subsequent request.
*/
NextToken?: String;
/**
* The HTTP status of the request.
*/
Status?: StatusCode;
/**
* The AWS request ID for this operation.
*/
RequestId?: String;
}
export interface ListDashboardVersionsRequest {
/**
* The ID of the AWS account that contains the dashboard that you're listing versions for.
*/
AwsAccountId: AwsAccountId;
/**
* The ID for the dashboard.
*/
DashboardId: RestrictiveResourceId;
/**
* The token for the next set of results, or null if there are no more results.
*/
NextToken?: String;
/**
* The maximum number of results to be returned per request.
*/
MaxResults?: MaxResults;
}
export interface ListDashboardVersionsResponse {
/**
* A structure that contains information about each version of the dashboard.
*/
DashboardVersionSummaryList?: DashboardVersionSummaryList;
/**
* The token for the next set of results, or null if there are no more results.
*/
NextToken?: String;
/**
* The HTTP status of the request.
*/
Status?: StatusCode;
/**
* The AWS request ID for this operation.
*/
RequestId?: String;
}
export interface ListDashboardsRequest {
/**
* The ID of the AWS account that contains the dashboards that you're listing.
*/
AwsAccountId: AwsAccountId;
/**
* The token for the next set of results, or null if there are no more results.
*/
NextToken?: String;
/**
* The maximum number of results to be returned per request.
*/
MaxResults?: MaxResults;
}
export interface ListDashboardsResponse {
/**
* A structure that contains all of the dashboards in your AWS account. This structure provides basic information about the dashboards.
*/
DashboardSummaryList?: DashboardSummaryList;
/**
* The token for the next set of results, or null if there are no more results.
*/
NextToken?: String;
/**
* The HTTP status of the request.
*/
Status?: StatusCode;
/**
* The AWS request ID for this operation.
*/
RequestId?: String;
}
export interface ListDataSetsRequest {
/**
* The AWS account ID.
*/
AwsAccountId: AwsAccountId;
/**
* The token for the next set of results, or null if there are no more results.
*/
NextToken?: String;
/**
* The maximum number of results to be returned per request.
*/
MaxResults?: MaxResults;
}
export interface ListDataSetsResponse {
/**
* The list of dataset summaries.
*/
DataSetSummaries?: DataSetSummaryList;
/**
* The token for the next set of results, or null if there are no more results.
*/
NextToken?: String;
/**
* The AWS request ID for this operation.
*/
RequestId?: String;
/**
* The HTTP status of the request.
*/
Status?: StatusCode;
}
export interface ListDataSourcesRequest {
/**
* The AWS account ID.
*/
AwsAccountId: AwsAccountId;
/**
* The token for the next set of results, or null if there are no more results.
*/
NextToken?: String;
/**
* The maximum number of results to be returned per request.
*/
MaxResults?: MaxResults;
}
export interface ListDataSourcesResponse {
/**
* A list of data sources.
*/
DataSources?: DataSourceList;
/**
* The token for the next set of results, or null if there are no more results.
*/
NextToken?: String;
/**
* The AWS request ID for this operation.
*/
RequestId?: String;
/**
* The HTTP status of the request.
*/
Status?: StatusCode;
}
export interface ListGroupMembershipsRequest {
/**
* The name of the group that you want to see a membership list of.
*/
GroupName: GroupName;
/**
* A pagination token that can be used in a subsequent request.
*/
NextToken?: String;
/**
* The maximum number of results to return from this request.
*/
MaxResults?: MaxResults;
/**
* The ID for the AWS account that the group is in. Currently, you use the ID for the AWS account that contains your Amazon QuickSight account.
*/
AwsAccountId: AwsAccountId;
/**
* The namespace. Currently, you should set this to default.
*/
Namespace: Namespace;
}
export interface ListGroupMembershipsResponse {
/**
* The list of the members of the group.
*/
GroupMemberList?: GroupMemberList;
/**
* A pagination token that can be used in a subsequent request.
*/
NextToken?: String;
/**
* The AWS request ID for this operation.
*/
RequestId?: String;
/**
* The HTTP status of the request.
*/
Status?: StatusCode;
}
export interface ListGroupsRequest {
/**
* The ID for the AWS account that the group is in. Currently, you use the ID for the AWS account that contains your Amazon QuickSight account.
*/
AwsAccountId: AwsAccountId;
/**
* A pagination token that can be used in a subsequent request.
*/
NextToken?: String;
/**
* The maximum number of results to return.
*/
MaxResults?: MaxResults;
/**
* The namespace. Currently, you should set this to default.
*/
Namespace: Namespace;
}
export interface ListGroupsResponse {
/**
* The list of the groups.
*/
GroupList?: GroupList;
/**
* A pagination token that can be used in a subsequent request.
*/
NextToken?: String;
/**
* The AWS request ID for this operation.
*/
RequestId?: String;
/**
* The HTTP status of the request.
*/
Status?: StatusCode;
}
export interface ListIAMPolicyAssignmentsForUserRequest {
/**
* The ID of the AWS account that contains the assignments.
*/
AwsAccountId: AwsAccountId;
/**
* The name of the user.
*/
UserName: UserName;
/**
* The token for the next set of results, or null if there are no more results.
*/
NextToken?: String;
/**
* The maximum number of results to be returned per request.
*/
MaxResults?: MaxResults;
/**
* The namespace of the assignment.
*/
Namespace: Namespace;
}
export interface ListIAMPolicyAssignmentsForUserResponse {
/**
* The active assignments for this user.
*/
ActiveAssignments?: ActiveIAMPolicyAssignmentList;
/**
* The AWS request ID for this operation.
*/
RequestId?: String;
/**
* The token for the next set of results, or null if there are no more results.
*/
NextToken?: String;
/**
* The HTTP status of the request.
*/
Status?: StatusCode;
}
export interface ListIAMPolicyAssignmentsRequest {
/**
* The ID of the AWS account that contains these IAM policy assignments.
*/
AwsAccountId: AwsAccountId;
/**
* The status of the assignments.
*/
AssignmentStatus?: AssignmentStatus;
/**
* The namespace for the assignments.
*/
Namespace: Namespace;
/**
* The token for the next set of results, or null if there are no more results.
*/
NextToken?: String;
/**
* The maximum number of results to be returned per request.
*/
MaxResults?: MaxResults;
}
export interface ListIAMPolicyAssignmentsResponse {
/**
* Information describing the IAM policy assignments.
*/
IAMPolicyAssignments?: IAMPolicyAssignmentSummaryList;
/**
* The token for the next set of results, or null if there are no more results.
*/
NextToken?: String;
/**
* The AWS request ID for this operation.
*/
RequestId?: String;
/**
* The HTTP status of the request.
*/
Status?: StatusCode;
}
export interface ListIngestionsRequest {
/**
* The ID of the dataset used in the ingestion.
*/
DataSetId: string;
/**
* The token for the next set of results, or null if there are no more results.
*/
NextToken?: string;
/**
* The AWS account ID.
*/
AwsAccountId: AwsAccountId;
/**
* The maximum number of results to be returned per request.
*/
MaxResults?: IngestionMaxResults;
}
export interface ListIngestionsResponse {
/**
* A list of the ingestions.
*/
Ingestions?: Ingestions;
/**
* The token for the next set of results, or null if there are no more results.
*/
NextToken?: string;
/**
* The AWS request ID for this operation.
*/
RequestId?: string;
/**
* The HTTP status of the request.
*/
Status?: StatusCode;
}
export interface ListNamespacesRequest {
/**
* The ID for the AWS account that contains the QuickSight namespaces that you want to list.
*/
AwsAccountId: AwsAccountId;
/**
* A pagination token that can be used in a subsequent request.
*/
NextToken?: String;
/**
* The maximum number of results to return.
*/
MaxResults?: MaxResults;
}
export interface ListNamespacesResponse {
/**
* The information about the namespaces in this AWS account. The response includes the namespace ARN, name, AWS Region, notification email address, creation status, and identity store.
*/
Namespaces?: Namespaces;
/**
* A pagination token that can be used in a subsequent request.
*/
NextToken?: String;
/**
* The AWS request ID for this operation.
*/
RequestId?: String;
/**
* The HTTP status of the request.
*/
Status?: StatusCode;
}
export interface ListTagsForResourceRequest {
/**
* The Amazon Resource Name (ARN) of the resource that you want a list of tags for.
*/
ResourceArn: Arn;
}
export interface ListTagsForResourceResponse {
/**
* Contains a map of the key-value pairs for the resource tag or tags assigned to the resource.
*/
Tags?: TagList;
/**
* The AWS request ID for this operation.
*/
RequestId?: String;
/**
* The HTTP status of the request.
*/
Status?: StatusCode;
}
export interface ListTemplateAliasesRequest {
/**
* The ID of the AWS account that contains the template aliases that you're listing.
*/
AwsAccountId: AwsAccountId;
/**
* The ID for the template.
*/
TemplateId: RestrictiveResourceId;
/**
* The token for the next set of results, or null if there are no more results.
*/
NextToken?: String;
/**
* The maximum number of results to be returned per request.
*/
MaxResults?: MaxResults;
}
export interface ListTemplateAliasesResponse {
/**
* A structure containing the list of the template's aliases.
*/
TemplateAliasList?: TemplateAliasList;
/**
* The HTTP status of the request.
*/
Status?: StatusCode;
/**
* The AWS request ID for this operation.
*/
RequestId?: String;
/**
* The token for the next set of results, or null if there are no more results.
*/
NextToken?: String;
}
export interface ListTemplateVersionsRequest {
/**
* The ID of the AWS account that contains the templates that you're listing.
*/
AwsAccountId: AwsAccountId;
/**
* The ID for the template.
*/
TemplateId: RestrictiveResourceId;
/**
* The token for the next set of results, or null if there are no more results.
*/
NextToken?: String;
/**
* The maximum number of results to be returned per request.
*/
MaxResults?: MaxResults;
}
export interface ListTemplateVersionsResponse {
/**
* A structure containing a list of all the versions of the specified template.
*/
TemplateVersionSummaryList?: TemplateVersionSummaryList;
/**
* The token for the next set of results, or null if there are no more results.
*/
NextToken?: String;
/**
* The HTTP status of the request.
*/
Status?: StatusCode;
/**
* The AWS request ID for this operation.
*/
RequestId?: String;
}
export interface ListTemplatesRequest {
/**
* The ID of the AWS account that contains the templates that you're listing.
*/
AwsAccountId: AwsAccountId;
/**
* The token for the next set of results, or null if there are no more results.
*/
NextToken?: String;
/**
* The maximum number of results to be returned per request.
*/
MaxResults?: MaxResults;
}
export interface ListTemplatesResponse {
/**
* A structure containing information about the templates in the list.
*/
TemplateSummaryList?: TemplateSummaryList;
/**
* The token for the next set of results, or null if there are no more results.
*/
NextToken?: String;
/**
* The HTTP status of the request.
*/
Status?: StatusCode;
/**
* The AWS request ID for this operation.
*/
RequestId?: String;
}
export interface ListThemeAliasesRequest {
/**
* The ID of the AWS account that contains the theme aliases that you're listing.
*/
AwsAccountId: AwsAccountId;
/**
* The ID for the theme.
*/
ThemeId: RestrictiveResourceId;
/**
* The token for the next set of results, or null if there are no more results.
*/
NextToken?: String;
/**
* The maximum number of results to be returned per request.
*/
MaxResults?: MaxResults;
}
export interface ListThemeAliasesResponse {
/**
* A structure containing the list of the theme's aliases.
*/
ThemeAliasList?: ThemeAliasList;
/**
* The HTTP status of the request.
*/
Status?: StatusCode;
/**
* The AWS request ID for this operation.
*/
RequestId?: String;
/**
* The token for the next set of results, or null if there are no more results.
*/
NextToken?: String;
}
export interface ListThemeVersionsRequest {
/**
* The ID of the AWS account that contains the themes that you're listing.
*/
AwsAccountId: AwsAccountId;
/**
* The ID for the theme.
*/
ThemeId: RestrictiveResourceId;
/**
* The token for the next set of results, or null if there are no more results.
*/
NextToken?: String;
/**
* The maximum number of results to be returned per request.
*/
MaxResults?: MaxResults;
}
export interface ListThemeVersionsResponse {
/**
* A structure containing a list of all the versions of the specified theme.
*/
ThemeVersionSummaryList?: ThemeVersionSummaryList;
/**
* The token for the next set of results, or null if there are no more results.
*/
NextToken?: String;
/**
* The HTTP status of the request.
*/
Status?: StatusCode;
/**
* The AWS request ID for this operation.
*/
RequestId?: String;
}
export interface ListThemesRequest {
/**
* The ID of the AWS account that contains the themes that you're listing.
*/
AwsAccountId: AwsAccountId;
/**
* The token for the next set of results, or null if there are no more results.
*/
NextToken?: String;
/**
* The maximum number of results to be returned per request.
*/
MaxResults?: MaxResults;
/**
* The type of themes that you want to list. Valid options include the following: ALL (default)- Display all existing themes. CUSTOM - Display only the themes created by people using Amazon QuickSight. QUICKSIGHT - Display only the starting themes defined by QuickSight.
*/
Type?: ThemeType;
}
export interface ListThemesResponse {
/**
* Information about the themes in the list.
*/
ThemeSummaryList?: ThemeSummaryList;
/**
* The token for the next set of results, or null if there are no more results.
*/
NextToken?: String;
/**
* The HTTP status of the request.
*/
Status?: StatusCode;
/**
* The AWS request ID for this operation.
*/
RequestId?: String;
}
export interface ListUserGroupsRequest {
/**
* The Amazon QuickSight user name that you want to list group memberships for.
*/
UserName: UserName;
/**
* The AWS account ID that the user is in. Currently, you use the ID for the AWS account that contains your Amazon QuickSight account.
*/
AwsAccountId: AwsAccountId;
/**
* The namespace. Currently, you should set this to default.
*/
Namespace: Namespace;
/**
* A pagination token that can be used in a subsequent request.
*/
NextToken?: String;
/**
* The maximum number of results to return from this request.
*/
MaxResults?: MaxResults;
}
export interface ListUserGroupsResponse {
/**
* The list of groups the user is a member of.
*/
GroupList?: GroupList;
/**
* A pagination token that can be used in a subsequent request.
*/
NextToken?: String;
/**
* The AWS request ID for this operation.
*/
RequestId?: String;
/**
* The HTTP status of the request.
*/
Status?: StatusCode;
}
export interface ListUsersRequest {
/**
* The ID for the AWS account that the user is in. Currently, you use the ID for the AWS account that contains your Amazon QuickSight account.
*/
AwsAccountId: AwsAccountId;
/**
* A pagination token that can be used in a subsequent request.
*/
NextToken?: String;
/**
* The maximum number of results to return from this request.
*/
MaxResults?: MaxResults;
/**
* The namespace. Currently, you should set this to default.
*/
Namespace: Namespace;
}
export interface ListUsersResponse {
/**
* The list of users.
*/
UserList?: UserList;
/**
* A pagination token that can be used in a subsequent request.
*/
NextToken?: String;
/**
* The AWS request ID for this operation.
*/
RequestId?: String;
/**
* The HTTP status of the request.
*/
Status?: StatusCode;
}
export interface LogicalTable {
/**
* A display name for the logical table.
*/
Alias: LogicalTableAlias;
/**
* Transform operations that act on this logical table.
*/
DataTransforms?: TransformOperationList;
/**
* Source of this logical table.
*/
Source: LogicalTableSource;
}
export type LogicalTableAlias = string;
export type LogicalTableId = string;
export type LogicalTableMap = {[key: string]: LogicalTable};
export interface LogicalTableSource {
/**
* Specifies the result of a join of two logical tables.
*/
JoinInstruction?: JoinInstruction;
/**
* Physical table ID.
*/
PhysicalTableId?: PhysicalTableId;
}
export type Long = number;
export type LongList = Long[];
export interface ManifestFileLocation {
/**
* Amazon S3 bucket.
*/
Bucket: S3Bucket;
/**
* Amazon S3 key that identifies an object.
*/
Key: S3Key;
}
export interface MarginStyle {
/**
* This Boolean value controls whether to display sheet margins.
*/
Show?: boolean;
}
export interface MariaDbParameters {
/**
* Host.
*/
Host: Host;
/**
* Port.
*/
Port: Port;
/**
* Database.
*/
Database: Database;
}
export type MaxResults = number;
export interface MySqlParameters {
/**
* Host.
*/
Host: Host;
/**
* Port.
*/
Port: Port;
/**
* Database.
*/
Database: Database;
}
export type Namespace = string;
export interface NamespaceError {
/**
* The error type.
*/
Type?: NamespaceErrorType;
/**
* The message for the error.
*/
Message?: String;
}
export type NamespaceErrorType = "PERMISSION_DENIED"|"INTERNAL_SERVICE_ERROR"|string;
export interface NamespaceInfoV2 {
/**
* The name of the error.
*/
Name?: Namespace;
/**
* The namespace ARN.
*/
Arn?: Arn;
/**
* The namespace AWS 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;
/**
* An error that occurred when the namespace was created.
*/
NamespaceError?: NamespaceError;
}
export type NamespaceStatus = "CREATED"|"CREATING"|"DELETING"|"RETRYABLE_FAILURE"|"NON_RETRYABLE_FAILURE"|string;
export type Namespaces = NamespaceInfoV2[];
export type NonEmptyString = string;
export type OnClause = string;
export type OptionalPort = number;
export interface OutputColumn {
/**
* A display name for the dataset.
*/
Name?: ColumnName;
/**
* Type.
*/
Type?: ColumnDataType;
}
export type OutputColumnList = OutputColumn[];
export interface Parameters {
/**
* String parameters.
*/
StringParameters?: StringParameterList;
/**
* Integer parameters.
*/
IntegerParameters?: IntegerParameterList;
/**
* Decimal parameters.
*/
DecimalParameters?: DecimalParameterList;
/**
* Date-time parameters.
*/
DateTimeParameters?: DateTimeParameterList;
}
export type Password = string;
export interface PhysicalTable {
/**
* A physical table type for relational data sources.
*/
RelationalTable?: RelationalTable;
/**
* A physical table type built from the results of the custom SQL query.
*/
CustomSql?: CustomSql;
/**
* A physical table type for as S3 data source.
*/
S3Source?: S3Source;
}
export type PhysicalTableId = string;
export type PhysicalTableMap = {[key: string]: PhysicalTable};
export type Port = number;
export type PositiveInteger = number;
export interface PostgreSqlParameters {
/**
* Host.
*/
Host: Host;
/**
* Port.
*/
Port: Port;
/**
* Database.
*/
Database: Database;
}
export interface PrestoParameters {
/**
* Host.
*/
Host: Host;
/**
* Port.
*/
Port: Port;
/**
* Catalog.
*/
Catalog: Catalog;
}
export type Principal = string;
export interface ProjectOperation {
/**
* Projected columns.
*/
ProjectedColumns: ProjectedColumnList;
}
export type ProjectedColumnList = String[];
export type Query = string;
export interface QueueInfo {
/**
* The ID of the queued ingestion.
*/
WaitingOnIngestion: string;
/**
* The ID of the ongoing ingestion. The queued ingestion is waiting for the ongoing ingestion to complete.
*/
QueuedIngestion: string;
}
export interface RdsParameters {
/**
* Instance ID.
*/
InstanceId: InstanceId;
/**
* Database.
*/
Database: Database;
}
export type RecoveryWindowInDays = number;
export interface RedshiftParameters {
/**
* Host. This field can be blank if ClusterId is provided.
*/
Host?: Host;
/**
* Port. This field can be blank if the ClusterId is provided.
*/
Port?: OptionalPort;
/**
* Database.
*/
Database: Database;
/**
* Cluster ID. This field can be blank if the Host and Port are provided.
*/
ClusterId?: ClusterId;
}
export interface RegisterUserRequest {
/**
* Amazon QuickSight supports several ways of managing the identity of users. This parameter accepts two values: IAM: A user whose identity maps to an existing IAM user or role. QUICKSIGHT: A user whose identity is owned and managed internally by Amazon QuickSight.
*/
IdentityType: IdentityType;
/**
* The email address of the user that you want to register.
*/
Email: 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 QuickSight settings. RESTRICTED_READER: This role isn't currently available for use. RESTRICTED_AUTHOR: This role isn't currently available for use.
*/
UserRole: UserRole;
/**
* The ARN of the IAM user or role that you are registering with Amazon QuickSight.
*/
IamArn?: String;
/**
* You need to use this parameter only when you register one or more users using an assumed IAM role. You don't need to provide the session name for other scenarios, for example when you are registering an IAM user or an Amazon QuickSight user. You can register multiple users using the same IAM role if each user has a different session name. For more information on assuming IAM roles, see assume-role in the AWS CLI Reference.
*/
SessionName?: RoleSessionName;
/**
* The ID for the AWS account that the user is in. Currently, you use the ID for the AWS account that contains your Amazon QuickSight account.
*/
AwsAccountId: AwsAccountId;
/**
* The namespace. Currently, you should set this to default.
*/
Namespace: Namespace;
/**
* The Amazon QuickSight user name that you want to create for the user you are registering.
*/
UserName?: UserName;
/**
* (Enterprise edition only) The name of the custom permissions profile that you want to assign to this user. Customized permissions allows you to control a user's access by restricting access the following operations: Create and update data sources Create and update datasets Create and update email reports Subscribe to email reports To add custom permissions to an existing user, use UpdateUser instead. A set of custom permissions includes any combination of these restrictions. Currently, you need to create the profile names for custom permission sets by using the QuickSight console. Then, you use the RegisterUser API operation to assign the named set of permissions to a QuickSight user. QuickSight custom permissions are applied through IAM policies. Therefore, they override the permissions typically granted by assigning QuickSight users to one of the default security cohorts in QuickSight (admin, author, reader). This feature is available only to QuickSight Enterprise edition subscriptions that use SAML 2.0-Based Federation for Single Sign-On (SSO).
*/
CustomPermissionsName?: RoleName;
}
export interface RegisterUserResponse {
/**
* The user's user name.
*/
User?: User;
/**
* The URL the user visits to complete registration and provide a password. This is returned only for users with an identity type of QUICKSIGHT.
*/
UserInvitationUrl?: String;
/**
* The AWS request ID for this operation.
*/
RequestId?: String;
/**
* The HTTP status of the request.
*/
Status?: StatusCode;
}
export interface RelationalTable {
/**
* The Amazon Resource Name (ARN) for the data source.
*/
DataSourceArn: Arn;
/**
* The schema name. This name applies to certain relational database engines.
*/
Schema?: RelationalTableSchema;
/**
* The name of the relational table.
*/
Name: RelationalTableName;
/**
* The column schema of the table.
*/
InputColumns: InputColumnList;
}
export type RelationalTableName = string;
export type RelationalTableSchema = string;
export interface RenameColumnOperation {
/**
* The name of the column to be renamed.
*/
ColumnName: ColumnName;
/**
* The new name for the column.
*/
NewColumnName: ColumnName;
}
export type ResourceId = string;
export type ResourceName = string;
export interface ResourcePermission {
/**
* The Amazon Resource Name (ARN) of the principal. This can be one of the following: The ARN of an Amazon QuickSight user, group, or namespace. (This is most common.) The ARN of an AWS account root: This is an IAM ARN rather than a QuickSight ARN. Use this option only to share resources (templates) across AWS accounts. (This is less common.)
*/
Principal: Principal;
/**
* The IAM action to grant or revoke permissions on, for example "quicksight:DescribeDashboard".
*/
Actions: ActionList;
}
export type ResourcePermissionList = ResourcePermission[];
export type ResourceStatus = "CREATION_IN_PROGRESS"|"CREATION_SUCCESSFUL"|"CREATION_FAILED"|"UPDATE_IN_PROGRESS"|"UPDATE_SUCCESSFUL"|"UPDATE_FAILED"|"DELETED"|string;
export interface RestoreAnalysisRequest {
/**
* The ID of the AWS account that contains the analysis.
*/
AwsAccountId: AwsAccountId;
/**
* The ID of the analysis that you're restoring.
*/
AnalysisId: RestrictiveResourceId;
}
export interface RestoreAnalysisResponse {
/**
* The HTTP status of the request.
*/
Status?: StatusCode;
/**
* The Amazon Resource Name (ARN) of the analysis that you're restoring.
*/
Arn?: Arn;
/**
* The ID of the analysis that you're restoring.
*/
AnalysisId?: RestrictiveResourceId;
/**
* The AWS request ID for this operation.
*/
RequestId?: String;
}
export type RestrictiveResourceId = string;
export type RoleName = string;
export type RoleSessionName = string;
export interface RowInfo {
/**
* The number of rows that were ingested.
*/
RowsIngested?: long;
/**
* The number of rows that were not ingested.
*/
RowsDropped?: long;
}
export interface RowLevelPermissionDataSet {
/**
* The namespace associated with the row-level permissions dataset.
*/
Namespace?: Namespace;
/**
* The Amazon Resource Name (ARN) of the permission dataset.
*/
Arn: Arn;
/**
* Permission policy.
*/
PermissionPolicy: RowLevelPermissionPolicy;
}
export type RowLevelPermissionPolicy = "GRANT_ACCESS"|"DENY_ACCESS"|string;
export type S3Bucket = string;
export type S3Key = string;
export interface S3Parameters {
/**
* Location of the Amazon S3 manifest file. This is NULL if the manifest file was uploaded in the console.
*/
ManifestFileLocation: ManifestFileLocation;
}
export interface S3Source {
/**
* The amazon Resource Name (ARN) for the data source.
*/
DataSourceArn: Arn;
/**
* Information about the format for the S3 source file or files.
*/
UploadSettings?: UploadSettings;
/**
* A physical table type for as S3 data source.
*/
InputColumns: InputColumnList;
}
export interface SearchAnalysesRequest {
/**
* The ID of the AWS account that contains the analyses that you're searching for.
*/
AwsAccountId: AwsAccountId;
/**
* The structure for the search filters that you want to apply to your search.
*/
Filters: AnalysisSearchFilterList;
/**
* A pagination token that can be used in a subsequent request.
*/
NextToken?: String;
/**
* The maximum number of results to return.
*/
MaxResults?: MaxResults;
}
export interface SearchAnalysesResponse {
/**
* Metadata describing the analyses that you searched for.
*/
AnalysisSummaryList?: AnalysisSummaryList;
/**
* A pagination token that can be used in a subsequent request.
*/
NextToken?: String;
/**
* The HTTP status of the request.
*/
Status?: StatusCode;
/**
* The AWS request ID for this operation.
*/
RequestId?: String;
}
export interface SearchDashboardsRequest {
/**
* The ID of the AWS account that contains the user whose dashboards you're searching for.
*/
AwsAccountId: AwsAccountId;
/**
* The filters to apply to the search. Currently, you can search only by user name, for example, "Filters": [ { "Name": "QUICKSIGHT_USER", "Operator": "StringEquals", "Value": "arn:aws:quicksight:us-east-1:1:user/default/UserName1" } ]
*/
Filters: DashboardSearchFilterList;
/**
* The token for the next set of results, or null if there are no more results.
*/
NextToken?: String;
/**
* The maximum number of results to be returned per request.
*/
MaxResults?: MaxResults;
}
export interface SearchDashboardsResponse {
/**
* The list of dashboards owned by the user specified in Filters in your request.
*/
DashboardSummaryList?: DashboardSummaryList;
/**
* The token for the next set of results, or null if there are no more results.
*/
NextToken?: String;
/**
* The HTTP status of the request.
*/
Status?: StatusCode;
/**
* The AWS request ID for this operation.
*/
RequestId?: String;
}
export interface ServiceNowParameters {
/**
* URL of the base site.
*/
SiteBaseUrl: SiteBaseUrl;
}
export type SessionLifetimeInMinutes = number;
export interface Sheet {
/**
* The unique identifier associated with a sheet.
*/
SheetId?: RestrictiveResourceId;
/**
* The name of a sheet. This is displayed on the sheet's tab in the QuickSight console.
*/
Name?: NonEmptyString;
}
export interface SheetControlsOption {
/**
* Visibility state.
*/
VisibilityState?: DashboardUIState;
}
export type SheetList = Sheet[];
export interface SheetStyle {
/**
* The display options for tiles.
*/
Tile?: TileStyle;
/**
* The layout options for tiles.
*/
TileLayout?: TileLayoutStyle;
}
export type SiteBaseUrl = string;
export interface SnowflakeParameters {
/**
* Host.
*/
Host: Host;
/**
* Database.
*/
Database: Database;
/**
* Warehouse.
*/
Warehouse: Warehouse;
}
export interface SparkParameters {
/**
* Host.
*/
Host: Host;
/**
* Port.
*/
Port: Port;
}
export type SqlQuery = string;
export interface SqlServerParameters {
/**
* Host.
*/
Host: Host;
/**
* Port.
*/
Port: Port;
/**
* Database.
*/
Database: Database;
}
export interface SslProperties {
/**
* A Boolean option to control whether SSL should be disabled.
*/
DisableSsl?: Boolean;
}
export type StatusCode = number;
export type String = string;
export type StringList = String[];
export interface StringParameter {
/**
* A display name for a string parameter.
*/
Name: NonEmptyString;
/**
* The values of a string parameter.
*/
Values: StringList;
}
export type StringParameterList = StringParameter[];
export interface Tag {
/**
* Tag key.
*/
Key: TagKey;
/**
* Tag value.
*/
Value: TagValue;
}
export interface TagColumnOperation {
/**
* The column that this operation acts on.
*/
ColumnName: ColumnName;
/**
* The dataset column tag, currently only used for geospatial type tagging. . This is not tags for the AWS tagging feature. .
*/
Tags: ColumnTagList;
}
export type TagKey = string;
export type TagKeyList = TagKey[];
export type TagList = Tag[];
export interface TagResourceRequest {
/**
* The Amazon Resource Name (ARN) of the resource that you want to tag.
*/
ResourceArn: Arn;
/**
* Contains a map of the key-value pairs for the resource tag or tags assigned to the resource.
*/
Tags: TagList;
}
export interface TagResourceResponse {
/**
* The AWS request ID for this operation.
*/
RequestId?: String;
/**
* The HTTP status of the request.
*/
Status?: StatusCode;
}
export type TagValue = string;
export interface Template {
/**
* The Amazon Resource Name (ARN) of the template.
*/
Arn?: Arn;
/**
* The display name of the template.
*/
Name?: TemplateName;
/**
* A structure describing the versions of the template.
*/
Version?: TemplateVersion;
/**
* The ID for the template. This is unique per AWS Region for each AWS account.
*/
TemplateId?: RestrictiveResourceId;
/**
* Time when this was last updated.
*/
LastUpdatedTime?: Timestamp;
/**
* Time when this was created.
*/
CreatedTime?: Timestamp;
}
export interface TemplateAlias {
/**
* The display name of the template alias.
*/
AliasName?: AliasName;
/**
* The Amazon Resource Name (ARN) of the template alias.
*/
Arn?: Arn;
/**
* The version number of the template alias.
*/
TemplateVersionNumber?: VersionNumber;
}
export type TemplateAliasList = TemplateAlias[];
export interface TemplateError {
/**
* Type of error.
*/
Type?: TemplateErrorType;
/**
* Description of the error type.
*/
Message?: NonEmptyString;
}
export type TemplateErrorList = TemplateError[];
export type TemplateErrorType = "SOURCE_NOT_FOUND"|"DATA_SET_NOT_FOUND"|"INTERNAL_FAILURE"|"ACCESS_DENIED"|string;
export type TemplateName = string;
export interface TemplateSourceAnalysis {
/**
* The Amazon Resource Name (ARN) of the resource.
*/
Arn: Arn;
/**
* A structure containing information about the dataset references used as placeholders in the template.
*/
DataSetReferences: DataSetReferenceList;
}
export interface TemplateSourceEntity {
/**
* The source analysis, if it is based on an analysis.
*/
SourceAnalysis?: TemplateSourceAnalysis;
/**
* The source template, if it is based on an template.
*/
SourceTemplate?: TemplateSourceTemplate;
}
export interface TemplateSourceTemplate {
/**
* The Amazon Resource Name (ARN) of the resource.
*/
Arn: Arn;
}
export interface TemplateSummary {
/**
* A summary of a template.
*/
Arn?: Arn;
/**
* The ID of the template. This ID is unique per AWS Region for each AWS account.
*/
TemplateId?: RestrictiveResourceId;
/**
* A display name for the template.
*/
Name?: TemplateName;
/**
* A structure containing a list of version numbers for the template summary.
*/
LatestVersionNumber?: VersionNumber;
/**
* The last time that this template was created.
*/
CreatedTime?: Timestamp;
/**
* The last time that this template was updated.
*/
LastUpdatedTime?: Timestamp;
}
export type TemplateSummaryList = TemplateSummary[];
export interface TemplateVersion {
/**
* The time that this template version was created.
*/
CreatedTime?: Timestamp;
/**
* Errors associated with this template version.
*/
Errors?: TemplateErrorList;
/**
* The version number of the template version.
*/
VersionNumber?: VersionNumber;
/**
* The HTTP status of the request.
*/
Status?: ResourceStatus;
/**
* 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?: DataSetConfigurationList;
/**
* The description of the template.
*/
Description?: VersionDescription;
/**
* The Amazon Resource Name (ARN) of an analysis or template that was used to create this template.
*/
SourceEntityArn?: Arn;
/**
* The ARN of the theme associated with this version of the template.
*/
ThemeArn?: Arn;
/**
* A list of the associated sheets with the unique identifier and name of each sheet.
*/
Sheets?: SheetList;
}
export interface TemplateVersionSummary {
/**
* The Amazon Resource Name (ARN) of the template version.
*/
Arn?: Arn;
/**
* The version number of the template version.
*/
VersionNumber?: VersionNumber;
/**
* The time that this template version was created.
*/
CreatedTime?: Timestamp;
/**
* The status of the template version.
*/
Status?: ResourceStatus;
/**
* The description of the template version.
*/
Description?: VersionDescription;
}
export type TemplateVersionSummaryList = TemplateVersionSummary[];
export interface TeradataParameters {
/**
* Host.
*/
Host: Host;
/**
* Port.
*/
Port: Port;
/**
* Database.
*/
Database: Database;
}
export type TextQualifier = "DOUBLE_QUOTE"|"SINGLE_QUOTE"|string;
export interface Theme {
/**
* The Amazon Resource Name (ARN) of the theme.
*/
Arn?: Arn;
/**
* The name that the user gives to the theme.
*/
Name?: ThemeName;
/**
* The identifier that the user gives to the theme.
*/
ThemeId?: RestrictiveResourceId;
Version?: ThemeVersion;
/**
* The date and time that the theme was created.
*/
CreatedTime?: Timestamp;
/**
* The date and time that the theme was last updated.
*/
LastUpdatedTime?: Timestamp;
/**
* The type of theme, based on how it was created. Valid values include: QUICKSIGHT and CUSTOM.
*/
Type?: ThemeType;
}
export interface ThemeAlias {
/**
* The Amazon Resource Name (ARN) of the theme alias.
*/
Arn?: Arn;
/**
* The display name of the theme alias.
*/
AliasName?: AliasName;
/**
* The version number of the theme alias.
*/
ThemeVersionNumber?: VersionNumber;
}
export type ThemeAliasList = ThemeAlias[];
export interface ThemeConfiguration {
/**
* Color properties that apply to chart data colors.
*/
DataColorPalette?: DataColorPalette;
/**
* Color properties that apply to the UI and to charts, excluding the colors that apply to data.
*/
UIColorPalette?: UIColorPalette;
/**
* Display options related to sheets.
*/
Sheet?: SheetStyle;
}
export interface ThemeError {
/**
* The type of error.
*/
Type?: ThemeErrorType;
/**
* The error message.
*/
Message?: NonEmptyString;
}
export type ThemeErrorList = ThemeError[];
export type ThemeErrorType = "INTERNAL_FAILURE"|string;
export type ThemeName = string;
export interface ThemeSummary {
/**
* The Amazon Resource Name (ARN) of the resource.
*/
Arn?: Arn;
/**
* the display name for the theme.
*/
Name?: ThemeName;
/**
* The ID of the theme. This ID is unique per AWS Region for each AWS account.
*/
ThemeId?: RestrictiveResourceId;
/**
* The latest version number for the theme.
*/
LatestVersionNumber?: VersionNumber;
/**
* The date and time that this theme was created.
*/
CreatedTime?: Timestamp;
/**
* The last date and time that this theme was updated.
*/
LastUpdatedTime?: Timestamp;
}
export type ThemeSummaryList = ThemeSummary[];
export type ThemeType = "QUICKSIGHT"|"CUSTOM"|"ALL"|string;
export interface ThemeVersion {
/**
* The version number of the theme.
*/
VersionNumber?: VersionNumber;
/**
* The Amazon Resource Name (ARN) of the resource.
*/
Arn?: Arn;
/**
* The description of the theme.
*/
Description?: VersionDescription;
/**
* The Amazon QuickSight-defined ID of the theme that a custom theme inherits from. All themes initially inherit from a default QuickSight theme.
*/
BaseThemeId?: RestrictiveResourceId;
/**
* The date and time that this theme version was created.
*/
CreatedTime?: Timestamp;
/**
* The theme configuration, which contains all the theme display properties.
*/
Configuration?: ThemeConfiguration;
/**
* Errors associated with the theme.
*/
Errors?: ThemeErrorList;
/**
* The status of the theme version.
*/
Status?: ResourceStatus;
}
export interface ThemeVersionSummary {
/**
* The version number of the theme version.
*/
VersionNumber?: VersionNumber;
/**
* The Amazon Resource Name (ARN) of the theme version.
*/
Arn?: Arn;
/**
* The description of the theme version.
*/
Description?: VersionDescription;
/**
* The date and time that this theme version was created.
*/
CreatedTime?: Timestamp;
/**
* The status of the theme version.
*/
Status?: ResourceStatus;
}
export type ThemeVersionSummaryList = ThemeVersionSummary[];
export interface TileLayoutStyle {
/**
* The gutter settings that apply between tiles.
*/
Gutter?: GutterStyle;
/**
* The margin settings that apply around the outside edge of sheets.
*/
Margin?: MarginStyle;
}
export interface TileStyle {
/**
* The border around a tile.
*/
Border?: BorderStyle;
}
export type Timestamp = Date;
export type TimestampList = Timestamp[];
export interface TransformOperation {
/**
* An operation that projects columns. Operations that come after a projection can only refer to projected columns.
*/
ProjectOperation?: ProjectOperation;
/**
* An operation that filters rows based on some condition.
*/
FilterOperation?: FilterOperation;
/**
* An operation that creates calculated columns. Columns created in one such operation form a lexical closure.
*/
CreateColumnsOperation?: CreateColumnsOperation;
/**
* An operation that renames a column.
*/
RenameColumnOperation?: RenameColumnOperation;
/**
* A transform operation that casts a column to a different type.
*/
CastColumnTypeOperation?: CastColumnTypeOperation;
/**
* An operation that tags a column with additional information.
*/
TagColumnOperation?: TagColumnOperation;
}
export type TransformOperationList = TransformOperation[];
export interface TwitterParameters {
/**
* Twitter query string.
*/
Query: Query;
/**
* Maximum number of rows to query Twitter.
*/
MaxRows: PositiveInteger;
}
export type TypeCastFormat = string;
export interface UIColorPalette {
/**
* 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?: HexColor;
/**
* The background color that applies to visuals and other high emphasis UI.
*/
PrimaryBackground?: HexColor;
/**
* The foreground color that applies to any sheet title, sheet control text, or UI that appears over the secondary background.
*/
SecondaryForeground?: HexColor;
/**
* The background color that applies to the sheet background and sheet controls.
*/
SecondaryBackground?: HexColor;
/**
* This color is that applies to selected states and buttons.
*/
Accent?: HexColor;
/**
* The foreground color that applies to any text or other elements that appear over the accent color.
*/
AccentForeground?: HexColor;
/**
* The color that applies to error messages.
*/
Danger?: HexColor;
/**
* The foreground color that applies to any text or other elements that appear over the error color.
*/
DangerForeground?: HexColor;
/**
* This color that applies to warning and informational messages.
*/
Warning?: HexColor;
/**
* The foreground color that applies to any text or other elements that appear over the warning color.
*/
WarningForeground?: HexColor;
/**
* The color that applies to success messages, for example the check mark for a successful download.
*/
Success?: HexColor;
/**
* The foreground color that applies to any text or other elements that appear over the success color.
*/
SuccessForeground?: HexColor;
/**
* The color that applies to the names of fields that are identified as dimensions.
*/
Dimension?: HexColor;
/**
* The foreground color that applies to any text or other elements that appear over the dimension color.
*/
DimensionForeground?: HexColor;
/**
* The color that applies to the names of fields that are identified as measures.
*/
Measure?: HexColor;
/**
* The foreground color that applies to any text or other elements that appear over the measure color.
*/
MeasureForeground?: HexColor;
}
export interface UntagResourceRequest {
/**
* The Amazon Resource Name (ARN) of the resource that you want to untag.
*/
ResourceArn: Arn;
/**
* The keys of the key-value pairs for the resource tag or tags assigned to the resource.
*/
TagKeys: TagKeyList;
}
export interface UntagResourceResponse {
/**
* The AWS request ID for this operation.
*/
RequestId?: String;
/**
* The HTTP status of the request.
*/
Status?: StatusCode;
}
export interface UpdateAccountCustomizationRequest {
/**
* The ID for the AWS account that you want to update QuickSight customizations for.
*/
AwsAccountId: AwsAccountId;
/**
* The namespace that you want to update QuickSight customizations for.
*/
Namespace?: Namespace;
/**
* The QuickSight customizations you're updating in the current AWS Region.
*/
AccountCustomization: AccountCustomization;
}
export interface UpdateAccountCustomizationResponse {
/**
* The Amazon Resource Name (ARN) for the updated customization for this AWS account.
*/
Arn?: Arn;
/**
* The ID for the AWS account that you want to update QuickSight customizations for.
*/
AwsAccountId?: AwsAccountId;
/**
* The namespace associated with the customization that you're updating.
*/
Namespace?: Namespace;
/**
* The QuickSight customizations you're updating in the current AWS Region.
*/
AccountCustomization?: AccountCustomization;
/**
* The AWS request ID for this operation.
*/
RequestId?: String;
/**
* The HTTP status of the request.
*/
Status?: StatusCode;
}
export interface UpdateAccountSettingsRequest {
/**
* The ID for the AWS account that contains the QuickSight settings that you want to list.
*/
AwsAccountId: AwsAccountId;
/**
* The default namespace for this AWS account. Currently, the default is default. AWS Identity and Access Management (IAM) users that register for the first time with QuickSight provide an email that becomes associated with the default namespace.
*/
DefaultNamespace: Namespace;
/**
* The email address that you want QuickSight to send notifications to regarding your AWS account or QuickSight subscription.
*/
NotificationEmail?: String;
}
export interface UpdateAccountSettingsResponse {
/**
* The AWS request ID for this operation.
*/
RequestId?: String;
/**
* The HTTP status of the request.
*/
Status?: StatusCode;
}
export interface UpdateAnalysisPermissionsRequest {
/**
* The ID of the AWS account that contains the analysis whose permissions you're updating. You must be using the AWS account that the analysis is in.
*/
AwsAccountId: AwsAccountId;
/**
* The ID of the analysis whose permissions you're updating. The ID is part of the analysis URL.
*/
AnalysisId: RestrictiveResourceId;
/**
* A structure that describes the permissions to add and the principal to add them to.
*/
GrantPermissions?: UpdateResourcePermissionList;
/**
* A structure that describes the permissions to remove and the principal to remove them from.
*/
RevokePermissions?: UpdateResourcePermissionList;
}
export interface UpdateAnalysisPermissionsResponse {
/**
* The Amazon Resource Name (ARN) of the analysis that you updated.
*/
AnalysisArn?: Arn;
/**
* The ID of the analysis that you updated permissions for.
*/
AnalysisId?: RestrictiveResourceId;
/**
* A structure that describes the principals and the resource-level permissions on an analysis.
*/
Permissions?: ResourcePermissionList;
/**
* The AWS request ID for this operation.
*/
RequestId?: String;
/**
* The HTTP status of the request.
*/
Status?: StatusCode;
}
export interface UpdateAnalysisRequest {
/**
* The ID of the AWS account that contains the analysis that you're updating.
*/
AwsAccountId: AwsAccountId;
/**
* The ID for the analysis that you're updating. This ID displays in the URL of the analysis.
*/
AnalysisId: RestrictiveResourceId;
/**
* A descriptive name for the analysis that you're updating. This name displays for the analysis in the QuickSight console.
*/
Name: AnalysisName;
/**
* The parameter names and override values that you want to use. An analysis can have any parameter type, and some parameters might accept multiple values.
*/
Parameters?: Parameters;
/**
* A source entity to use for the analysis that you're updating. This metadata structure contains details that describe a source template and one or more datasets.
*/
SourceEntity: AnalysisSourceEntity;
/**
* The Amazon Resource Name (ARN) for the theme to apply to the analysis that you're creating. To see the theme in the QuickSight console, make sure that you have access to it.
*/
ThemeArn?: Arn;
}
export interface UpdateAnalysisResponse {
/**
* The ARN of the analysis that you're updating.
*/
Arn?: Arn;
/**
* The ID of the analysis.
*/
AnalysisId?: RestrictiveResourceId;
/**
* The update status of the last update that was made to the analysis.
*/
UpdateStatus?: ResourceStatus;
/**
* The HTTP status of the request.
*/
Status?: StatusCode;
/**
* The AWS request ID for this operation.
*/
RequestId?: String;
}
export interface UpdateDashboardPermissionsRequest {
/**
* The ID of the AWS account that contains the dashboard whose permissions you're updating.
*/
AwsAccountId: AwsAccountId;
/**
* The ID for the dashboard.
*/
DashboardId: RestrictiveResourceId;
/**
* The permissions that you want to grant on this resource.
*/
GrantPermissions?: UpdateResourcePermissionList;
/**
* The permissions that you want to revoke from this resource.
*/
RevokePermissions?: UpdateResourcePermissionList;
}
export interface UpdateDashboardPermissionsResponse {
/**
* The Amazon Resource Name (ARN) of the dashboard.
*/
DashboardArn?: Arn;
/**
* The ID for the dashboard.
*/
DashboardId?: RestrictiveResourceId;
/**
* Information about the permissions on the dashboard.
*/
Permissions?: ResourcePermissionList;
/**
* The AWS request ID for this operation.
*/
RequestId?: String;
/**
* The HTTP status of the request.
*/
Status?: StatusCode;
}
export interface UpdateDashboardPublishedVersionRequest {
/**
* The ID of the AWS account that contains the dashboard that you're updating.
*/
AwsAccountId: AwsAccountId;
/**
* The ID for the dashboard.
*/
DashboardId: RestrictiveResourceId;
/**
* The version number of the dashboard.
*/
VersionNumber: VersionNumber;
}
export interface UpdateDashboardPublishedVersionResponse {
/**
* The ID for the dashboard.
*/
DashboardId?: RestrictiveResourceId;
/**
* The Amazon Resource Name (ARN) of the dashboard.
*/
DashboardArn?: Arn;
/**
* The HTTP status of the request.
*/
Status?: StatusCode;
/**
* The AWS request ID for this operation.
*/
RequestId?: String;
}
export interface UpdateDashboardRequest {
/**
* The ID of the AWS account that contains the dashboard that you're updating.
*/
AwsAccountId: AwsAccountId;
/**
* The ID for the dashboard.
*/
DashboardId: RestrictiveResourceId;
/**
* The display name of the dashboard.
*/
Name: DashboardName;
/**
* The entity that you are using as a source when you update the dashboard. In SourceEntity, you specify the type of object you're using as source. You can only update a dashboard from a template, so you use a SourceTemplate entity. If you need to update a dashboard from an analysis, first convert the analysis to a template by using the CreateTemplate API operation. For SourceTemplate, specify the Amazon Resource Name (ARN) of the source template. The SourceTemplate ARN can contain any AWS Account and any QuickSight-supported AWS Region. Use the DataSetReferences entity within SourceTemplate to list the replacement datasets for the placeholders listed in the original. The schema in each dataset must match its placeholder.
*/
SourceEntity: DashboardSourceEntity;
/**
* A structure that contains the parameters of the dashboard. These are parameter overrides for a dashboard. A dashboard can have any type of parameters, and some parameters might accept multiple values.
*/
Parameters?: Parameters;
/**
* A description for the first version of the dashboard being created.
*/
VersionDescription?: VersionDescription;
/**
* Options for publishing the dashboard when you create it: AvailabilityStatus for AdHocFilteringOption - This status can be either ENABLED or DISABLED. When this is set to DISABLED, QuickSight disables the left filter pane on the published dashboard, which can be used for ad hoc (one-time) filtering. This option is ENABLED by default. AvailabilityStatus for ExportToCSVOption - This status can be either ENABLED or DISABLED. The visual option to export data to .CSV format isn't enabled when this is set to DISABLED. This option is ENABLED by default. VisibilityState for SheetControlsOption - This visibility state can be either COLLAPSED or EXPANDED. This option is COLLAPSED by default.
*/
DashboardPublishOptions?: DashboardPublishOptions;
/**
* The Amazon Resource Name (ARN) of the theme that is being used for this dashboard. If you add a value for this field, it overrides the value that was originally associated with the entity. The theme ARN must exist in the same AWS account where you create the dashboard.
*/
ThemeArn?: Arn;
}
export interface UpdateDashboardResponse {
/**
* The Amazon Resource Name (ARN) of the resource.
*/
Arn?: Arn;
/**
* The ARN of the dashboard, including the version number.
*/
VersionArn?: Arn;
/**
* The ID for the dashboard.
*/
DashboardId?: RestrictiveResourceId;
/**
* The creation status of the request.
*/
CreationStatus?: ResourceStatus;
/**
* The HTTP status of the request.
*/
Status?: StatusCode;
/**
* The AWS request ID for this operation.
*/
RequestId?: String;
}
export interface UpdateDataSetPermissionsRequest {
/**
* The AWS account ID.
*/
AwsAccountId: AwsAccountId;
/**
* The ID for the dataset whose permissions you want to update. This ID is unique per AWS Region for each AWS account.
*/
DataSetId: ResourceId;
/**
* The resource permissions that you want to grant to the dataset.
*/
GrantPermissions?: ResourcePermissionList;
/**
* The resource permissions that you want to revoke from the dataset.
*/
RevokePermissions?: ResourcePermissionList;
}
export interface UpdateDataSetPermissionsResponse {
/**
* The Amazon Resource Name (ARN) of the dataset.
*/
DataSetArn?: Arn;
/**
* The ID for the dataset whose permissions you want to update. This ID is unique per AWS Region for each AWS account.
*/
DataSetId?: ResourceId;
/**
* The AWS request ID for this operation.
*/
RequestId?: String;
/**
* The HTTP status of the request.
*/
Status?: StatusCode;
}
export interface UpdateDataSetRequest {
/**
* The AWS account ID.
*/
AwsAccountId: AwsAccountId;
/**
* The ID for the dataset that you want to update. This ID is unique per AWS Region for each AWS account.
*/
DataSetId: ResourceId;
/**
* The display name for the dataset.
*/
Name: ResourceName;
/**
* Declares the physical tables that are available in the underlying data sources.
*/
PhysicalTableMap: PhysicalTableMap;
/**
* Configures the combination and transformation of the data from the physical tables.
*/
LogicalTableMap?: LogicalTableMap;
/**
* Indicates whether you want to import the data into SPICE.
*/
ImportMode: DataSetImportMode;
/**
* Groupings of columns that work together in certain QuickSight features. Currently, only geospatial hierarchy is supported.
*/
ColumnGroups?: ColumnGroupList;
/**
* The row-level security configuration for the data you want to create.
*/
RowLevelPermissionDataSet?: RowLevelPermissionDataSet;
}
export interface UpdateDataSetResponse {
/**
* The Amazon Resource Name (ARN) of the dataset.
*/
Arn?: Arn;
/**
* The ID for the dataset that you want to create. This ID is unique per AWS Region for each AWS account.
*/
DataSetId?: ResourceId;
/**
* The ARN for the ingestion, which is triggered as a result of dataset creation if the import mode is SPICE.
*/
IngestionArn?: Arn;
/**
* The ID of the ingestion, which is triggered as a result of dataset creation if the import mode is SPICE.
*/
IngestionId?: ResourceId;
/**
* The AWS request ID for this operation.
*/
RequestId?: String;
/**
* The HTTP status of the request.
*/
Status?: StatusCode;
}
export interface UpdateDataSourcePermissionsRequest {
/**
* The AWS account ID.
*/
AwsAccountId: AwsAccountId;
/**
* The ID of the data source. This ID is unique per AWS Region for each AWS account.
*/
DataSourceId: ResourceId;
/**
* A list of resource permissions that you want to grant on the data source.
*/
GrantPermissions?: ResourcePermissionList;
/**
* A list of resource permissions that you want to revoke on the data source.
*/
RevokePermissions?: ResourcePermissionList;
}
export interface UpdateDataSourcePermissionsResponse {
/**
* The Amazon Resource Name (ARN) of the data source.
*/
DataSourceArn?: Arn;
/**
* The ID of the data source. This ID is unique per AWS Region for each AWS account.
*/
DataSourceId?: ResourceId;
/**
* The AWS request ID for this operation.
*/
RequestId?: String;
/**
* The HTTP status of the request.
*/
Status?: StatusCode;
}
export interface UpdateDataSourceRequest {
/**
* The AWS account ID.
*/
AwsAccountId: AwsAccountId;
/**
* The ID of the data source. This ID is unique per AWS Region for each AWS account.
*/
DataSourceId: ResourceId;
/**
* A display name for the data source.
*/
Name: ResourceName;
/**
* The parameters that QuickSight uses to connect to your underlying source.
*/
DataSourceParameters?: DataSourceParameters;
/**
* The credentials that QuickSight that uses to connect to your underlying source. Currently, only credentials based on user name and password are supported.
*/
Credentials?: DataSourceCredentials;
/**
* Use this parameter only when you want QuickSight to use a VPC connection when connecting to your underlying source.
*/
VpcConnectionProperties?: VpcConnectionProperties;
/**
* Secure Socket Layer (SSL) properties that apply when QuickSight connects to your underlying source.
*/
SslProperties?: SslProperties;
}
export interface UpdateDataSourceResponse {
/**
* The Amazon Resource Name (ARN) of the data source.
*/
Arn?: Arn;
/**
* The ID of the data source. This ID is unique per AWS Region for each AWS account.
*/
DataSourceId?: ResourceId;
/**
* The update status of the data source's last update.
*/
UpdateStatus?: ResourceStatus;
/**
* The AWS request ID for this operation.
*/
RequestId?: String;
/**
* The HTTP status of the request.
*/
Status?: StatusCode;
}
export interface UpdateGroupRequest {
/**
* The name of the group that you want to update.
*/
GroupName: GroupName;
/**
* The description for the group that you want to update.
*/
Description?: GroupDescription;
/**
* The ID for the AWS account that the group is in. Currently, you use the ID for the AWS account that contains your Amazon QuickSight account.
*/
AwsAccountId: AwsAccountId;
/**
* The namespace. Currently, you should set this to default.
*/
Namespace: Namespace;
}
export interface UpdateGroupResponse {
/**
* The name of the group.
*/
Group?: Group;
/**
* The AWS request ID for this operation.
*/
RequestId?: String;
/**
* The HTTP status of the request.
*/
Status?: StatusCode;
}
export interface UpdateIAMPolicyAssignmentRequest {
/**
* The ID of the AWS account that contains the IAM policy assignment.
*/
AwsAccountId: AwsAccountId;
/**
* The name of the assignment. This name must be unique within an AWS account.
*/
AssignmentName: IAMPolicyAssignmentName;
/**
* The namespace of the assignment.
*/
Namespace: Namespace;
/**
* The status of the assignment. Possible values are as follows: ENABLED - Anything specified in this assignment is used when creating the data source. DISABLED - This assignment isn't used when creating the data source. DRAFT - This assignment is an unfinished draft and isn't used when creating the data source.
*/
AssignmentStatus?: AssignmentStatus;
/**
* The ARN for the IAM policy to apply to the QuickSight users and groups specified in this assignment.
*/
PolicyArn?: Arn;
/**
* The QuickSight users, groups, or both that you want to assign the policy to.
*/
Identities?: IdentityMap;
}
export interface UpdateIAMPolicyAssignmentResponse {
/**
* The name of the assignment.
*/
AssignmentName?: IAMPolicyAssignmentName;
/**
* The ID of the assignment.
*/
AssignmentId?: String;
/**
* The ARN for the IAM policy applied to the QuickSight users and groups specified in this assignment.
*/
PolicyArn?: Arn;
/**
* The QuickSight users, groups, or both that the IAM policy is assigned to.
*/
Identities?: IdentityMap;
/**
* The status of the assignment. Possible values are as follows: ENABLED - Anything specified in this assignment is used when creating the data source. DISABLED - This assignment isn't used when creating the data source. DRAFT - This assignment is an unfinished draft and isn't used when creating the data source.
*/
AssignmentStatus?: AssignmentStatus;
/**
* The AWS request ID for this operation.
*/
RequestId?: String;
/**
* The HTTP status of the request.
*/
Status?: StatusCode;
}
export type UpdateResourcePermissionList = ResourcePermission[];
export interface UpdateTemplateAliasRequest {
/**
* The ID of the AWS account that contains the template alias that you're updating.
*/
AwsAccountId: AwsAccountId;
/**
* The ID for the template.
*/
TemplateId: RestrictiveResourceId;
/**
* The alias of the template that you want to update. If you name a specific alias, you update the version that the alias points to. You can specify the latest version of the template by providing the keyword $LATEST in the AliasName parameter. The keyword $PUBLISHED doesn't apply to templates.
*/
AliasName: AliasName;
/**
* The version number of the template.
*/
TemplateVersionNumber: VersionNumber;
}
export interface UpdateTemplateAliasResponse {
/**
* The template alias.
*/
TemplateAlias?: TemplateAlias;
/**
* The HTTP status of the request.
*/
Status?: StatusCode;
/**
* The AWS request ID for this operation.
*/
RequestId?: String;
}
export interface UpdateTemplatePermissionsRequest {
/**
* The ID of the AWS account that contains the template.
*/
AwsAccountId: AwsAccountId;
/**
* The ID for the template.
*/
TemplateId: RestrictiveResourceId;
/**
* A list of resource permissions to be granted on the template.
*/
GrantPermissions?: UpdateResourcePermissionList;
/**
* A list of resource permissions to be revoked from the template.
*/
RevokePermissions?: UpdateResourcePermissionList;
}
export interface UpdateTemplatePermissionsResponse {
/**
* The ID for the template.
*/
TemplateId?: RestrictiveResourceId;
/**
* The Amazon Resource Name (ARN) of the template.
*/
TemplateArn?: Arn;
/**
* A list of resource permissions to be set on the template.
*/
Permissions?: ResourcePermissionList;
/**
* The AWS request ID for this operation.
*/
RequestId?: String;
/**
* The HTTP status of the request.
*/
Status?: StatusCode;
}
export interface UpdateTemplateRequest {
/**
* The ID of the AWS account that contains the template that you're updating.
*/
AwsAccountId: AwsAccountId;
/**
* The ID for the template.
*/
TemplateId: RestrictiveResourceId;
/**
* The entity that you are using as a source when you update the template. In SourceEntity, you specify the type of object you're using as source: SourceTemplate for a template or SourceAnalysis for an analysis. Both of these require an Amazon Resource Name (ARN). For SourceTemplate, specify the ARN of the source template. For SourceAnalysis, specify the ARN of the source analysis. The SourceTemplate ARN can contain any AWS Account and any QuickSight-supported AWS Region. Use the DataSetReferences entity within SourceTemplate or SourceAnalysis to list the replacement datasets for the placeholders listed in the original. The schema in each dataset must match its placeholder.
*/
SourceEntity: TemplateSourceEntity;
/**
* A description of the current template version that is being updated. Every time you call UpdateTemplate, you create a new version of the template. Each version of the template maintains a description of the version in the VersionDescription field.
*/
VersionDescription?: VersionDescription;
/**
* The name for the template.
*/
Name?: TemplateName;
}
export interface UpdateTemplateResponse {
/**
* The ID for the template.
*/
TemplateId?: RestrictiveResourceId;
/**
* The Amazon Resource Name (ARN) for the template.
*/
Arn?: Arn;
/**
* The ARN for the template, including the version information of the first version.
*/
VersionArn?: Arn;
/**
* The creation status of the template.
*/
CreationStatus?: ResourceStatus;
/**
* The HTTP status of the request.
*/
Status?: StatusCode;
/**
* The AWS request ID for this operation.
*/
RequestId?: String;
}
export interface UpdateThemeAliasRequest {
/**
* The ID of the AWS account that contains the theme alias that you're updating.
*/
AwsAccountId: AwsAccountId;
/**
* The ID for the theme.
*/
ThemeId: RestrictiveResourceId;
/**
* The name of the theme alias that you want to update.
*/
AliasName: AliasName;
/**
* The version number of the theme that the alias should reference.
*/
ThemeVersionNumber: VersionNumber;
}
export interface UpdateThemeAliasResponse {
/**
* Information about the theme alias.
*/
ThemeAlias?: ThemeAlias;
/**
* The HTTP status of the request.
*/
Status?: StatusCode;
/**
* The AWS request ID for this operation.
*/
RequestId?: String;
}
export interface UpdateThemePermissionsRequest {
/**
* The ID of the AWS account that contains the theme.
*/
AwsAccountId: AwsAccountId;
/**
* The ID for the theme.
*/
ThemeId: RestrictiveResourceId;
/**
* A list of resource permissions to be granted for the theme.
*/
GrantPermissions?: UpdateResourcePermissionList;
/**
* A list of resource permissions to be revoked from the theme.
*/
RevokePermissions?: UpdateResourcePermissionList;
}
export interface UpdateThemePermissionsResponse {
/**
* The ID for the theme.
*/
ThemeId?: RestrictiveResourceId;
/**
* The Amazon Resource Name (ARN) of the theme.
*/
ThemeArn?: Arn;
/**
* The resulting list of resource permissions for the theme.
*/
Permissions?: ResourcePermissionList;
/**
* The AWS request ID for this operation.
*/
RequestId?: String;
/**
* The HTTP status of the request.
*/
Status?: StatusCode;
}
export interface UpdateThemeRequest {
/**
* The ID of the AWS account that contains the theme that you're updating.
*/
AwsAccountId: AwsAccountId;
/**
* The ID for the theme.
*/
ThemeId: RestrictiveResourceId;
/**
* The name for the theme.
*/
Name?: ThemeName;
/**
* The theme ID, defined by Amazon QuickSight, that a custom theme inherits from. All themes initially inherit from a default QuickSight theme.
*/
BaseThemeId: RestrictiveResourceId;
/**
* A description of the theme version that you're updating Every time that you call UpdateTheme, you create a new version of the theme. Each version of the theme maintains a description of the version in VersionDescription.
*/
VersionDescription?: VersionDescription;
/**
* The theme configuration, which contains the theme display properties.
*/
Configuration?: ThemeConfiguration;
}
export interface UpdateThemeResponse {
/**
* The ID for the theme.
*/
ThemeId?: RestrictiveResourceId;
/**
* The Amazon Resource Name (ARN) for the theme.
*/
Arn?: Arn;
/**
* The Amazon Resource Name (ARN) for the new version of the theme.
*/
VersionArn?: Arn;
/**
* The creation status of the theme.
*/
CreationStatus?: ResourceStatus;
/**
* The HTTP status of the request.
*/
Status?: StatusCode;
/**
* The AWS request ID for this operation.
*/
RequestId?: String;
}
export interface UpdateUserRequest {
/**
* The Amazon QuickSight user name that you want to update.
*/
UserName: UserName;
/**
* The ID for the AWS account that the user is in. Currently, you use the ID for the AWS account that contains your Amazon QuickSight account.
*/
AwsAccountId: AwsAccountId;
/**
* The namespace. Currently, you should set this to default.
*/
Namespace: Namespace;
/**
* The email address of the user that you want to update.
*/
Email: String;
/**
* The Amazon QuickSight role of the user. The role can be one of the following default security cohorts: 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 QuickSight settings. The name of the QuickSight role is invisible to the user except for the console screens dealing with permissions.
*/
Role: UserRole;
/**
* (Enterprise edition only) The name of the custom permissions profile that you want to assign to this user. Customized permissions allows you to control a user's access by restricting access the following operations: Create and update data sources Create and update datasets Create and update email reports Subscribe to email reports A set of custom permissions includes any combination of these restrictions. Currently, you need to create the profile names for custom permission sets by using the QuickSight console. Then, you use the RegisterUser API operation to assign the named set of permissions to a QuickSight user. QuickSight custom permissions are applied through IAM policies. Therefore, they override the permissions typically granted by assigning QuickSight users to one of the default security cohorts in QuickSight (admin, author, reader). This feature is available only to QuickSight Enterprise edition subscriptions that use SAML 2.0-Based Federation for Single Sign-On (SSO).
*/
CustomPermissionsName?: RoleName;
/**
* A flag that you use to indicate that you want to remove all custom permissions from this user. Using this parameter resets the user to the state it was in before a custom permissions profile was applied. This parameter defaults to NULL and it doesn't accept any other value.
*/
UnapplyCustomPermissions?: Boolean;
}
export interface UpdateUserResponse {
/**
* The Amazon QuickSight user.
*/
User?: User;
/**
* The AWS request ID for this operation.
*/
RequestId?: String;
/**
* The HTTP status of the request.
*/
Status?: StatusCode;
}
export interface UploadSettings {
/**
* File format.
*/
Format?: FileFormat;
/**
* A row number to start reading data from.
*/
StartFromRow?: PositiveInteger;
/**
* Whether the file has a header row, or the files each have a header row.
*/
ContainsHeader?: Boolean;
/**
* Text qualifier.
*/
TextQualifier?: TextQualifier;
/**
* The delimiter between values in the file.
*/
Delimiter?: Delimiter;
}
export interface User {
/**
* The Amazon Resource Name (ARN) for the user.
*/
Arn?: Arn;
/**
* The user's user name.
*/
UserName?: UserName;
/**
* The user's email address.
*/
Email?: 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 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 type of identity authentication used by the user.
*/
IdentityType?: IdentityType;
/**
* 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?: Boolean;
/**
* The principal ID of the user.
*/
PrincipalId?: String;
/**
* The custom permissions profile associated with this user.
*/
CustomPermissionsName?: RoleName;
}
export type UserList = User[];
export type UserName = string;
export type UserRole = "ADMIN"|"AUTHOR"|"READER"|"RESTRICTED_AUTHOR"|"RESTRICTED_READER"|string;
export type Username = string;
export type VersionDescription = string;
export type VersionNumber = number;
export interface VpcConnectionProperties {
/**
* The Amazon Resource Name (ARN) for the VPC connection.
*/
VpcConnectionArn: Arn;
}
export type Warehouse = string;
export type WorkGroup = string;
export type long = number;
export type timestamp = Date;
/**
* A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
*/
export type apiVersion = "2018-04-01"|"latest"|string;
export interface ClientApiVersions {
/**
* A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
*/
apiVersion?: apiVersion;
}
export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions;
/**
* Contains interfaces for use with the QuickSight client.
*/
export import Types = QuickSight;
}
export = QuickSight;