redshift.d.ts
288 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
import {Request} from '../lib/request';
import {Response} from '../lib/response';
import {AWSError} from '../lib/error';
import {Service} from '../lib/service';
import {WaiterConfiguration} from '../lib/service';
import {ServiceConfigurationOptions} from '../lib/service';
import {ConfigBase as Config} from '../lib/config';
interface Blob {}
declare class Redshift extends Service {
/**
* Constructs a service object. This object has one method for each API operation.
*/
constructor(options?: Redshift.Types.ClientConfiguration)
config: Config & Redshift.Types.ClientConfiguration;
/**
* Exchanges a DC1 Reserved Node for a DC2 Reserved Node with no changes to the configuration (term, payment type, or number of nodes) and no additional costs.
*/
acceptReservedNodeExchange(params: Redshift.Types.AcceptReservedNodeExchangeInputMessage, callback?: (err: AWSError, data: Redshift.Types.AcceptReservedNodeExchangeOutputMessage) => void): Request<Redshift.Types.AcceptReservedNodeExchangeOutputMessage, AWSError>;
/**
* Exchanges a DC1 Reserved Node for a DC2 Reserved Node with no changes to the configuration (term, payment type, or number of nodes) and no additional costs.
*/
acceptReservedNodeExchange(callback?: (err: AWSError, data: Redshift.Types.AcceptReservedNodeExchangeOutputMessage) => void): Request<Redshift.Types.AcceptReservedNodeExchangeOutputMessage, AWSError>;
/**
* Adds an inbound (ingress) rule to an Amazon Redshift security group. Depending on whether the application accessing your cluster is running on the Internet or an Amazon EC2 instance, you can authorize inbound access to either a Classless Interdomain Routing (CIDR)/Internet Protocol (IP) range or to an Amazon EC2 security group. You can add as many as 20 ingress rules to an Amazon Redshift security group. If you authorize access to an Amazon EC2 security group, specify EC2SecurityGroupName and EC2SecurityGroupOwnerId. The Amazon EC2 security group and Amazon Redshift cluster must be in the same AWS Region. If you authorize access to a CIDR/IP address range, specify CIDRIP. For an overview of CIDR blocks, see the Wikipedia article on Classless Inter-Domain Routing. You must also associate the security group with a cluster so that clients running on these IP addresses or the EC2 instance are authorized to connect to the cluster. For information about managing security groups, go to Working with Security Groups in the Amazon Redshift Cluster Management Guide.
*/
authorizeClusterSecurityGroupIngress(params: Redshift.Types.AuthorizeClusterSecurityGroupIngressMessage, callback?: (err: AWSError, data: Redshift.Types.AuthorizeClusterSecurityGroupIngressResult) => void): Request<Redshift.Types.AuthorizeClusterSecurityGroupIngressResult, AWSError>;
/**
* Adds an inbound (ingress) rule to an Amazon Redshift security group. Depending on whether the application accessing your cluster is running on the Internet or an Amazon EC2 instance, you can authorize inbound access to either a Classless Interdomain Routing (CIDR)/Internet Protocol (IP) range or to an Amazon EC2 security group. You can add as many as 20 ingress rules to an Amazon Redshift security group. If you authorize access to an Amazon EC2 security group, specify EC2SecurityGroupName and EC2SecurityGroupOwnerId. The Amazon EC2 security group and Amazon Redshift cluster must be in the same AWS Region. If you authorize access to a CIDR/IP address range, specify CIDRIP. For an overview of CIDR blocks, see the Wikipedia article on Classless Inter-Domain Routing. You must also associate the security group with a cluster so that clients running on these IP addresses or the EC2 instance are authorized to connect to the cluster. For information about managing security groups, go to Working with Security Groups in the Amazon Redshift Cluster Management Guide.
*/
authorizeClusterSecurityGroupIngress(callback?: (err: AWSError, data: Redshift.Types.AuthorizeClusterSecurityGroupIngressResult) => void): Request<Redshift.Types.AuthorizeClusterSecurityGroupIngressResult, AWSError>;
/**
* Authorizes the specified AWS customer account to restore the specified snapshot. For more information about working with snapshots, go to Amazon Redshift Snapshots in the Amazon Redshift Cluster Management Guide.
*/
authorizeSnapshotAccess(params: Redshift.Types.AuthorizeSnapshotAccessMessage, callback?: (err: AWSError, data: Redshift.Types.AuthorizeSnapshotAccessResult) => void): Request<Redshift.Types.AuthorizeSnapshotAccessResult, AWSError>;
/**
* Authorizes the specified AWS customer account to restore the specified snapshot. For more information about working with snapshots, go to Amazon Redshift Snapshots in the Amazon Redshift Cluster Management Guide.
*/
authorizeSnapshotAccess(callback?: (err: AWSError, data: Redshift.Types.AuthorizeSnapshotAccessResult) => void): Request<Redshift.Types.AuthorizeSnapshotAccessResult, AWSError>;
/**
* Deletes a set of cluster snapshots.
*/
batchDeleteClusterSnapshots(params: Redshift.Types.BatchDeleteClusterSnapshotsRequest, callback?: (err: AWSError, data: Redshift.Types.BatchDeleteClusterSnapshotsResult) => void): Request<Redshift.Types.BatchDeleteClusterSnapshotsResult, AWSError>;
/**
* Deletes a set of cluster snapshots.
*/
batchDeleteClusterSnapshots(callback?: (err: AWSError, data: Redshift.Types.BatchDeleteClusterSnapshotsResult) => void): Request<Redshift.Types.BatchDeleteClusterSnapshotsResult, AWSError>;
/**
* Modifies the settings for a set of cluster snapshots.
*/
batchModifyClusterSnapshots(params: Redshift.Types.BatchModifyClusterSnapshotsMessage, callback?: (err: AWSError, data: Redshift.Types.BatchModifyClusterSnapshotsOutputMessage) => void): Request<Redshift.Types.BatchModifyClusterSnapshotsOutputMessage, AWSError>;
/**
* Modifies the settings for a set of cluster snapshots.
*/
batchModifyClusterSnapshots(callback?: (err: AWSError, data: Redshift.Types.BatchModifyClusterSnapshotsOutputMessage) => void): Request<Redshift.Types.BatchModifyClusterSnapshotsOutputMessage, AWSError>;
/**
* Cancels a resize operation for a cluster.
*/
cancelResize(params: Redshift.Types.CancelResizeMessage, callback?: (err: AWSError, data: Redshift.Types.ResizeProgressMessage) => void): Request<Redshift.Types.ResizeProgressMessage, AWSError>;
/**
* Cancels a resize operation for a cluster.
*/
cancelResize(callback?: (err: AWSError, data: Redshift.Types.ResizeProgressMessage) => void): Request<Redshift.Types.ResizeProgressMessage, AWSError>;
/**
* Copies the specified automated cluster snapshot to a new manual cluster snapshot. The source must be an automated snapshot and it must be in the available state. When you delete a cluster, Amazon Redshift deletes any automated snapshots of the cluster. Also, when the retention period of the snapshot expires, Amazon Redshift automatically deletes it. If you want to keep an automated snapshot for a longer period, you can make a manual copy of the snapshot. Manual snapshots are retained until you delete them. For more information about working with snapshots, go to Amazon Redshift Snapshots in the Amazon Redshift Cluster Management Guide.
*/
copyClusterSnapshot(params: Redshift.Types.CopyClusterSnapshotMessage, callback?: (err: AWSError, data: Redshift.Types.CopyClusterSnapshotResult) => void): Request<Redshift.Types.CopyClusterSnapshotResult, AWSError>;
/**
* Copies the specified automated cluster snapshot to a new manual cluster snapshot. The source must be an automated snapshot and it must be in the available state. When you delete a cluster, Amazon Redshift deletes any automated snapshots of the cluster. Also, when the retention period of the snapshot expires, Amazon Redshift automatically deletes it. If you want to keep an automated snapshot for a longer period, you can make a manual copy of the snapshot. Manual snapshots are retained until you delete them. For more information about working with snapshots, go to Amazon Redshift Snapshots in the Amazon Redshift Cluster Management Guide.
*/
copyClusterSnapshot(callback?: (err: AWSError, data: Redshift.Types.CopyClusterSnapshotResult) => void): Request<Redshift.Types.CopyClusterSnapshotResult, AWSError>;
/**
* Creates a new cluster with the specified parameters. To create a cluster in Virtual Private Cloud (VPC), you must provide a cluster subnet group name. The cluster subnet group identifies the subnets of your VPC that Amazon Redshift uses when creating the cluster. For more information about managing clusters, go to Amazon Redshift Clusters in the Amazon Redshift Cluster Management Guide.
*/
createCluster(params: Redshift.Types.CreateClusterMessage, callback?: (err: AWSError, data: Redshift.Types.CreateClusterResult) => void): Request<Redshift.Types.CreateClusterResult, AWSError>;
/**
* Creates a new cluster with the specified parameters. To create a cluster in Virtual Private Cloud (VPC), you must provide a cluster subnet group name. The cluster subnet group identifies the subnets of your VPC that Amazon Redshift uses when creating the cluster. For more information about managing clusters, go to Amazon Redshift Clusters in the Amazon Redshift Cluster Management Guide.
*/
createCluster(callback?: (err: AWSError, data: Redshift.Types.CreateClusterResult) => void): Request<Redshift.Types.CreateClusterResult, AWSError>;
/**
* Creates an Amazon Redshift parameter group. Creating parameter groups is independent of creating clusters. You can associate a cluster with a parameter group when you create the cluster. You can also associate an existing cluster with a parameter group after the cluster is created by using ModifyCluster. Parameters in the parameter group define specific behavior that applies to the databases you create on the cluster. For more information about parameters and parameter groups, go to Amazon Redshift Parameter Groups in the Amazon Redshift Cluster Management Guide.
*/
createClusterParameterGroup(params: Redshift.Types.CreateClusterParameterGroupMessage, callback?: (err: AWSError, data: Redshift.Types.CreateClusterParameterGroupResult) => void): Request<Redshift.Types.CreateClusterParameterGroupResult, AWSError>;
/**
* Creates an Amazon Redshift parameter group. Creating parameter groups is independent of creating clusters. You can associate a cluster with a parameter group when you create the cluster. You can also associate an existing cluster with a parameter group after the cluster is created by using ModifyCluster. Parameters in the parameter group define specific behavior that applies to the databases you create on the cluster. For more information about parameters and parameter groups, go to Amazon Redshift Parameter Groups in the Amazon Redshift Cluster Management Guide.
*/
createClusterParameterGroup(callback?: (err: AWSError, data: Redshift.Types.CreateClusterParameterGroupResult) => void): Request<Redshift.Types.CreateClusterParameterGroupResult, AWSError>;
/**
* Creates a new Amazon Redshift security group. You use security groups to control access to non-VPC clusters. For information about managing security groups, go to Amazon Redshift Cluster Security Groups in the Amazon Redshift Cluster Management Guide.
*/
createClusterSecurityGroup(params: Redshift.Types.CreateClusterSecurityGroupMessage, callback?: (err: AWSError, data: Redshift.Types.CreateClusterSecurityGroupResult) => void): Request<Redshift.Types.CreateClusterSecurityGroupResult, AWSError>;
/**
* Creates a new Amazon Redshift security group. You use security groups to control access to non-VPC clusters. For information about managing security groups, go to Amazon Redshift Cluster Security Groups in the Amazon Redshift Cluster Management Guide.
*/
createClusterSecurityGroup(callback?: (err: AWSError, data: Redshift.Types.CreateClusterSecurityGroupResult) => void): Request<Redshift.Types.CreateClusterSecurityGroupResult, AWSError>;
/**
* Creates a manual snapshot of the specified cluster. The cluster must be in the available state. For more information about working with snapshots, go to Amazon Redshift Snapshots in the Amazon Redshift Cluster Management Guide.
*/
createClusterSnapshot(params: Redshift.Types.CreateClusterSnapshotMessage, callback?: (err: AWSError, data: Redshift.Types.CreateClusterSnapshotResult) => void): Request<Redshift.Types.CreateClusterSnapshotResult, AWSError>;
/**
* Creates a manual snapshot of the specified cluster. The cluster must be in the available state. For more information about working with snapshots, go to Amazon Redshift Snapshots in the Amazon Redshift Cluster Management Guide.
*/
createClusterSnapshot(callback?: (err: AWSError, data: Redshift.Types.CreateClusterSnapshotResult) => void): Request<Redshift.Types.CreateClusterSnapshotResult, AWSError>;
/**
* Creates a new Amazon Redshift subnet group. You must provide a list of one or more subnets in your existing Amazon Virtual Private Cloud (Amazon VPC) when creating Amazon Redshift subnet group. For information about subnet groups, go to Amazon Redshift Cluster Subnet Groups in the Amazon Redshift Cluster Management Guide.
*/
createClusterSubnetGroup(params: Redshift.Types.CreateClusterSubnetGroupMessage, callback?: (err: AWSError, data: Redshift.Types.CreateClusterSubnetGroupResult) => void): Request<Redshift.Types.CreateClusterSubnetGroupResult, AWSError>;
/**
* Creates a new Amazon Redshift subnet group. You must provide a list of one or more subnets in your existing Amazon Virtual Private Cloud (Amazon VPC) when creating Amazon Redshift subnet group. For information about subnet groups, go to Amazon Redshift Cluster Subnet Groups in the Amazon Redshift Cluster Management Guide.
*/
createClusterSubnetGroup(callback?: (err: AWSError, data: Redshift.Types.CreateClusterSubnetGroupResult) => void): Request<Redshift.Types.CreateClusterSubnetGroupResult, AWSError>;
/**
* Creates an Amazon Redshift event notification subscription. This action requires an ARN (Amazon Resource Name) of an Amazon SNS topic created by either the Amazon Redshift console, the Amazon SNS console, or the Amazon SNS API. To obtain an ARN with Amazon SNS, you must create a topic in Amazon SNS and subscribe to the topic. The ARN is displayed in the SNS console. You can specify the source type, and lists of Amazon Redshift source IDs, event categories, and event severities. Notifications will be sent for all events you want that match those criteria. For example, you can specify source type = cluster, source ID = my-cluster-1 and mycluster2, event categories = Availability, Backup, and severity = ERROR. The subscription will only send notifications for those ERROR events in the Availability and Backup categories for the specified clusters. If you specify both the source type and source IDs, such as source type = cluster and source identifier = my-cluster-1, notifications will be sent for all the cluster events for my-cluster-1. If you specify a source type but do not specify a source identifier, you will receive notice of the events for the objects of that type in your AWS account. If you do not specify either the SourceType nor the SourceIdentifier, you will be notified of events generated from all Amazon Redshift sources belonging to your AWS account. You must specify a source type if you specify a source ID.
*/
createEventSubscription(params: Redshift.Types.CreateEventSubscriptionMessage, callback?: (err: AWSError, data: Redshift.Types.CreateEventSubscriptionResult) => void): Request<Redshift.Types.CreateEventSubscriptionResult, AWSError>;
/**
* Creates an Amazon Redshift event notification subscription. This action requires an ARN (Amazon Resource Name) of an Amazon SNS topic created by either the Amazon Redshift console, the Amazon SNS console, or the Amazon SNS API. To obtain an ARN with Amazon SNS, you must create a topic in Amazon SNS and subscribe to the topic. The ARN is displayed in the SNS console. You can specify the source type, and lists of Amazon Redshift source IDs, event categories, and event severities. Notifications will be sent for all events you want that match those criteria. For example, you can specify source type = cluster, source ID = my-cluster-1 and mycluster2, event categories = Availability, Backup, and severity = ERROR. The subscription will only send notifications for those ERROR events in the Availability and Backup categories for the specified clusters. If you specify both the source type and source IDs, such as source type = cluster and source identifier = my-cluster-1, notifications will be sent for all the cluster events for my-cluster-1. If you specify a source type but do not specify a source identifier, you will receive notice of the events for the objects of that type in your AWS account. If you do not specify either the SourceType nor the SourceIdentifier, you will be notified of events generated from all Amazon Redshift sources belonging to your AWS account. You must specify a source type if you specify a source ID.
*/
createEventSubscription(callback?: (err: AWSError, data: Redshift.Types.CreateEventSubscriptionResult) => void): Request<Redshift.Types.CreateEventSubscriptionResult, AWSError>;
/**
* Creates an HSM client certificate that an Amazon Redshift cluster will use to connect to the client's HSM in order to store and retrieve the keys used to encrypt the cluster databases. The command returns a public key, which you must store in the HSM. In addition to creating the HSM certificate, you must create an Amazon Redshift HSM configuration that provides a cluster the information needed to store and use encryption keys in the HSM. For more information, go to Hardware Security Modules in the Amazon Redshift Cluster Management Guide.
*/
createHsmClientCertificate(params: Redshift.Types.CreateHsmClientCertificateMessage, callback?: (err: AWSError, data: Redshift.Types.CreateHsmClientCertificateResult) => void): Request<Redshift.Types.CreateHsmClientCertificateResult, AWSError>;
/**
* Creates an HSM client certificate that an Amazon Redshift cluster will use to connect to the client's HSM in order to store and retrieve the keys used to encrypt the cluster databases. The command returns a public key, which you must store in the HSM. In addition to creating the HSM certificate, you must create an Amazon Redshift HSM configuration that provides a cluster the information needed to store and use encryption keys in the HSM. For more information, go to Hardware Security Modules in the Amazon Redshift Cluster Management Guide.
*/
createHsmClientCertificate(callback?: (err: AWSError, data: Redshift.Types.CreateHsmClientCertificateResult) => void): Request<Redshift.Types.CreateHsmClientCertificateResult, AWSError>;
/**
* Creates an HSM configuration that contains the information required by an Amazon Redshift cluster to store and use database encryption keys in a Hardware Security Module (HSM). After creating the HSM configuration, you can specify it as a parameter when creating a cluster. The cluster will then store its encryption keys in the HSM. In addition to creating an HSM configuration, you must also create an HSM client certificate. For more information, go to Hardware Security Modules in the Amazon Redshift Cluster Management Guide.
*/
createHsmConfiguration(params: Redshift.Types.CreateHsmConfigurationMessage, callback?: (err: AWSError, data: Redshift.Types.CreateHsmConfigurationResult) => void): Request<Redshift.Types.CreateHsmConfigurationResult, AWSError>;
/**
* Creates an HSM configuration that contains the information required by an Amazon Redshift cluster to store and use database encryption keys in a Hardware Security Module (HSM). After creating the HSM configuration, you can specify it as a parameter when creating a cluster. The cluster will then store its encryption keys in the HSM. In addition to creating an HSM configuration, you must also create an HSM client certificate. For more information, go to Hardware Security Modules in the Amazon Redshift Cluster Management Guide.
*/
createHsmConfiguration(callback?: (err: AWSError, data: Redshift.Types.CreateHsmConfigurationResult) => void): Request<Redshift.Types.CreateHsmConfigurationResult, AWSError>;
/**
* Creates a scheduled action. A scheduled action contains a schedule and an Amazon Redshift API action. For example, you can create a schedule of when to run the ResizeCluster API operation.
*/
createScheduledAction(params: Redshift.Types.CreateScheduledActionMessage, callback?: (err: AWSError, data: Redshift.Types.ScheduledAction) => void): Request<Redshift.Types.ScheduledAction, AWSError>;
/**
* Creates a scheduled action. A scheduled action contains a schedule and an Amazon Redshift API action. For example, you can create a schedule of when to run the ResizeCluster API operation.
*/
createScheduledAction(callback?: (err: AWSError, data: Redshift.Types.ScheduledAction) => void): Request<Redshift.Types.ScheduledAction, AWSError>;
/**
* Creates a snapshot copy grant that permits Amazon Redshift to use a customer master key (CMK) from AWS Key Management Service (AWS KMS) to encrypt copied snapshots in a destination region. For more information about managing snapshot copy grants, go to Amazon Redshift Database Encryption in the Amazon Redshift Cluster Management Guide.
*/
createSnapshotCopyGrant(params: Redshift.Types.CreateSnapshotCopyGrantMessage, callback?: (err: AWSError, data: Redshift.Types.CreateSnapshotCopyGrantResult) => void): Request<Redshift.Types.CreateSnapshotCopyGrantResult, AWSError>;
/**
* Creates a snapshot copy grant that permits Amazon Redshift to use a customer master key (CMK) from AWS Key Management Service (AWS KMS) to encrypt copied snapshots in a destination region. For more information about managing snapshot copy grants, go to Amazon Redshift Database Encryption in the Amazon Redshift Cluster Management Guide.
*/
createSnapshotCopyGrant(callback?: (err: AWSError, data: Redshift.Types.CreateSnapshotCopyGrantResult) => void): Request<Redshift.Types.CreateSnapshotCopyGrantResult, AWSError>;
/**
* Create a snapshot schedule that can be associated to a cluster and which overrides the default system backup schedule.
*/
createSnapshotSchedule(params: Redshift.Types.CreateSnapshotScheduleMessage, callback?: (err: AWSError, data: Redshift.Types.SnapshotSchedule) => void): Request<Redshift.Types.SnapshotSchedule, AWSError>;
/**
* Create a snapshot schedule that can be associated to a cluster and which overrides the default system backup schedule.
*/
createSnapshotSchedule(callback?: (err: AWSError, data: Redshift.Types.SnapshotSchedule) => void): Request<Redshift.Types.SnapshotSchedule, AWSError>;
/**
* Adds tags to a cluster. A resource can have up to 50 tags. If you try to create more than 50 tags for a resource, you will receive an error and the attempt will fail. If you specify a key that already exists for the resource, the value for that key will be updated with the new value.
*/
createTags(params: Redshift.Types.CreateTagsMessage, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Adds tags to a cluster. A resource can have up to 50 tags. If you try to create more than 50 tags for a resource, you will receive an error and the attempt will fail. If you specify a key that already exists for the resource, the value for that key will be updated with the new value.
*/
createTags(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Creates a usage limit for a specified Amazon Redshift feature on a cluster. The usage limit is identified by the returned usage limit identifier.
*/
createUsageLimit(params: Redshift.Types.CreateUsageLimitMessage, callback?: (err: AWSError, data: Redshift.Types.UsageLimit) => void): Request<Redshift.Types.UsageLimit, AWSError>;
/**
* Creates a usage limit for a specified Amazon Redshift feature on a cluster. The usage limit is identified by the returned usage limit identifier.
*/
createUsageLimit(callback?: (err: AWSError, data: Redshift.Types.UsageLimit) => void): Request<Redshift.Types.UsageLimit, AWSError>;
/**
* Deletes a previously provisioned cluster without its final snapshot being created. A successful response from the web service indicates that the request was received correctly. Use DescribeClusters to monitor the status of the deletion. The delete operation cannot be canceled or reverted once submitted. For more information about managing clusters, go to Amazon Redshift Clusters in the Amazon Redshift Cluster Management Guide. If you want to shut down the cluster and retain it for future use, set SkipFinalClusterSnapshot to false and specify a name for FinalClusterSnapshotIdentifier. You can later restore this snapshot to resume using the cluster. If a final cluster snapshot is requested, the status of the cluster will be "final-snapshot" while the snapshot is being taken, then it's "deleting" once Amazon Redshift begins deleting the cluster. For more information about managing clusters, go to Amazon Redshift Clusters in the Amazon Redshift Cluster Management Guide.
*/
deleteCluster(params: Redshift.Types.DeleteClusterMessage, callback?: (err: AWSError, data: Redshift.Types.DeleteClusterResult) => void): Request<Redshift.Types.DeleteClusterResult, AWSError>;
/**
* Deletes a previously provisioned cluster without its final snapshot being created. A successful response from the web service indicates that the request was received correctly. Use DescribeClusters to monitor the status of the deletion. The delete operation cannot be canceled or reverted once submitted. For more information about managing clusters, go to Amazon Redshift Clusters in the Amazon Redshift Cluster Management Guide. If you want to shut down the cluster and retain it for future use, set SkipFinalClusterSnapshot to false and specify a name for FinalClusterSnapshotIdentifier. You can later restore this snapshot to resume using the cluster. If a final cluster snapshot is requested, the status of the cluster will be "final-snapshot" while the snapshot is being taken, then it's "deleting" once Amazon Redshift begins deleting the cluster. For more information about managing clusters, go to Amazon Redshift Clusters in the Amazon Redshift Cluster Management Guide.
*/
deleteCluster(callback?: (err: AWSError, data: Redshift.Types.DeleteClusterResult) => void): Request<Redshift.Types.DeleteClusterResult, AWSError>;
/**
* Deletes a specified Amazon Redshift parameter group. You cannot delete a parameter group if it is associated with a cluster.
*/
deleteClusterParameterGroup(params: Redshift.Types.DeleteClusterParameterGroupMessage, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Deletes a specified Amazon Redshift parameter group. You cannot delete a parameter group if it is associated with a cluster.
*/
deleteClusterParameterGroup(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Deletes an Amazon Redshift security group. You cannot delete a security group that is associated with any clusters. You cannot delete the default security group. For information about managing security groups, go to Amazon Redshift Cluster Security Groups in the Amazon Redshift Cluster Management Guide.
*/
deleteClusterSecurityGroup(params: Redshift.Types.DeleteClusterSecurityGroupMessage, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Deletes an Amazon Redshift security group. You cannot delete a security group that is associated with any clusters. You cannot delete the default security group. For information about managing security groups, go to Amazon Redshift Cluster Security Groups in the Amazon Redshift Cluster Management Guide.
*/
deleteClusterSecurityGroup(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Deletes the specified manual snapshot. The snapshot must be in the available state, with no other users authorized to access the snapshot. Unlike automated snapshots, manual snapshots are retained even after you delete your cluster. Amazon Redshift does not delete your manual snapshots. You must delete manual snapshot explicitly to avoid getting charged. If other accounts are authorized to access the snapshot, you must revoke all of the authorizations before you can delete the snapshot.
*/
deleteClusterSnapshot(params: Redshift.Types.DeleteClusterSnapshotMessage, callback?: (err: AWSError, data: Redshift.Types.DeleteClusterSnapshotResult) => void): Request<Redshift.Types.DeleteClusterSnapshotResult, AWSError>;
/**
* Deletes the specified manual snapshot. The snapshot must be in the available state, with no other users authorized to access the snapshot. Unlike automated snapshots, manual snapshots are retained even after you delete your cluster. Amazon Redshift does not delete your manual snapshots. You must delete manual snapshot explicitly to avoid getting charged. If other accounts are authorized to access the snapshot, you must revoke all of the authorizations before you can delete the snapshot.
*/
deleteClusterSnapshot(callback?: (err: AWSError, data: Redshift.Types.DeleteClusterSnapshotResult) => void): Request<Redshift.Types.DeleteClusterSnapshotResult, AWSError>;
/**
* Deletes the specified cluster subnet group.
*/
deleteClusterSubnetGroup(params: Redshift.Types.DeleteClusterSubnetGroupMessage, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Deletes the specified cluster subnet group.
*/
deleteClusterSubnetGroup(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Deletes an Amazon Redshift event notification subscription.
*/
deleteEventSubscription(params: Redshift.Types.DeleteEventSubscriptionMessage, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Deletes an Amazon Redshift event notification subscription.
*/
deleteEventSubscription(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Deletes the specified HSM client certificate.
*/
deleteHsmClientCertificate(params: Redshift.Types.DeleteHsmClientCertificateMessage, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Deletes the specified HSM client certificate.
*/
deleteHsmClientCertificate(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Deletes the specified Amazon Redshift HSM configuration.
*/
deleteHsmConfiguration(params: Redshift.Types.DeleteHsmConfigurationMessage, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Deletes the specified Amazon Redshift HSM configuration.
*/
deleteHsmConfiguration(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Deletes a scheduled action.
*/
deleteScheduledAction(params: Redshift.Types.DeleteScheduledActionMessage, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Deletes a scheduled action.
*/
deleteScheduledAction(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Deletes the specified snapshot copy grant.
*/
deleteSnapshotCopyGrant(params: Redshift.Types.DeleteSnapshotCopyGrantMessage, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Deletes the specified snapshot copy grant.
*/
deleteSnapshotCopyGrant(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Deletes a snapshot schedule.
*/
deleteSnapshotSchedule(params: Redshift.Types.DeleteSnapshotScheduleMessage, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Deletes a snapshot schedule.
*/
deleteSnapshotSchedule(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Deletes tags from a resource. You must provide the ARN of the resource from which you want to delete the tag or tags.
*/
deleteTags(params: Redshift.Types.DeleteTagsMessage, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Deletes tags from a resource. You must provide the ARN of the resource from which you want to delete the tag or tags.
*/
deleteTags(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Deletes a usage limit from a cluster.
*/
deleteUsageLimit(params: Redshift.Types.DeleteUsageLimitMessage, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Deletes a usage limit from a cluster.
*/
deleteUsageLimit(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Returns a list of attributes attached to an account
*/
describeAccountAttributes(params: Redshift.Types.DescribeAccountAttributesMessage, callback?: (err: AWSError, data: Redshift.Types.AccountAttributeList) => void): Request<Redshift.Types.AccountAttributeList, AWSError>;
/**
* Returns a list of attributes attached to an account
*/
describeAccountAttributes(callback?: (err: AWSError, data: Redshift.Types.AccountAttributeList) => void): Request<Redshift.Types.AccountAttributeList, AWSError>;
/**
* Returns an array of ClusterDbRevision objects.
*/
describeClusterDbRevisions(params: Redshift.Types.DescribeClusterDbRevisionsMessage, callback?: (err: AWSError, data: Redshift.Types.ClusterDbRevisionsMessage) => void): Request<Redshift.Types.ClusterDbRevisionsMessage, AWSError>;
/**
* Returns an array of ClusterDbRevision objects.
*/
describeClusterDbRevisions(callback?: (err: AWSError, data: Redshift.Types.ClusterDbRevisionsMessage) => void): Request<Redshift.Types.ClusterDbRevisionsMessage, AWSError>;
/**
* Returns a list of Amazon Redshift parameter groups, including parameter groups you created and the default parameter group. For each parameter group, the response includes the parameter group name, description, and parameter group family name. You can optionally specify a name to retrieve the description of a specific parameter group. For more information about parameters and parameter groups, go to Amazon Redshift Parameter Groups in the Amazon Redshift Cluster Management Guide. If you specify both tag keys and tag values in the same request, Amazon Redshift returns all parameter groups that match any combination of the specified keys and values. For example, if you have owner and environment for tag keys, and admin and test for tag values, all parameter groups that have any combination of those values are returned. If both tag keys and values are omitted from the request, parameter groups are returned regardless of whether they have tag keys or values associated with them.
*/
describeClusterParameterGroups(params: Redshift.Types.DescribeClusterParameterGroupsMessage, callback?: (err: AWSError, data: Redshift.Types.ClusterParameterGroupsMessage) => void): Request<Redshift.Types.ClusterParameterGroupsMessage, AWSError>;
/**
* Returns a list of Amazon Redshift parameter groups, including parameter groups you created and the default parameter group. For each parameter group, the response includes the parameter group name, description, and parameter group family name. You can optionally specify a name to retrieve the description of a specific parameter group. For more information about parameters and parameter groups, go to Amazon Redshift Parameter Groups in the Amazon Redshift Cluster Management Guide. If you specify both tag keys and tag values in the same request, Amazon Redshift returns all parameter groups that match any combination of the specified keys and values. For example, if you have owner and environment for tag keys, and admin and test for tag values, all parameter groups that have any combination of those values are returned. If both tag keys and values are omitted from the request, parameter groups are returned regardless of whether they have tag keys or values associated with them.
*/
describeClusterParameterGroups(callback?: (err: AWSError, data: Redshift.Types.ClusterParameterGroupsMessage) => void): Request<Redshift.Types.ClusterParameterGroupsMessage, AWSError>;
/**
* Returns a detailed list of parameters contained within the specified Amazon Redshift parameter group. For each parameter the response includes information such as parameter name, description, data type, value, whether the parameter value is modifiable, and so on. You can specify source filter to retrieve parameters of only specific type. For example, to retrieve parameters that were modified by a user action such as from ModifyClusterParameterGroup, you can specify source equal to user. For more information about parameters and parameter groups, go to Amazon Redshift Parameter Groups in the Amazon Redshift Cluster Management Guide.
*/
describeClusterParameters(params: Redshift.Types.DescribeClusterParametersMessage, callback?: (err: AWSError, data: Redshift.Types.ClusterParameterGroupDetails) => void): Request<Redshift.Types.ClusterParameterGroupDetails, AWSError>;
/**
* Returns a detailed list of parameters contained within the specified Amazon Redshift parameter group. For each parameter the response includes information such as parameter name, description, data type, value, whether the parameter value is modifiable, and so on. You can specify source filter to retrieve parameters of only specific type. For example, to retrieve parameters that were modified by a user action such as from ModifyClusterParameterGroup, you can specify source equal to user. For more information about parameters and parameter groups, go to Amazon Redshift Parameter Groups in the Amazon Redshift Cluster Management Guide.
*/
describeClusterParameters(callback?: (err: AWSError, data: Redshift.Types.ClusterParameterGroupDetails) => void): Request<Redshift.Types.ClusterParameterGroupDetails, AWSError>;
/**
* Returns information about Amazon Redshift security groups. If the name of a security group is specified, the response will contain only information about only that security group. For information about managing security groups, go to Amazon Redshift Cluster Security Groups in the Amazon Redshift Cluster Management Guide. If you specify both tag keys and tag values in the same request, Amazon Redshift returns all security groups that match any combination of the specified keys and values. For example, if you have owner and environment for tag keys, and admin and test for tag values, all security groups that have any combination of those values are returned. If both tag keys and values are omitted from the request, security groups are returned regardless of whether they have tag keys or values associated with them.
*/
describeClusterSecurityGroups(params: Redshift.Types.DescribeClusterSecurityGroupsMessage, callback?: (err: AWSError, data: Redshift.Types.ClusterSecurityGroupMessage) => void): Request<Redshift.Types.ClusterSecurityGroupMessage, AWSError>;
/**
* Returns information about Amazon Redshift security groups. If the name of a security group is specified, the response will contain only information about only that security group. For information about managing security groups, go to Amazon Redshift Cluster Security Groups in the Amazon Redshift Cluster Management Guide. If you specify both tag keys and tag values in the same request, Amazon Redshift returns all security groups that match any combination of the specified keys and values. For example, if you have owner and environment for tag keys, and admin and test for tag values, all security groups that have any combination of those values are returned. If both tag keys and values are omitted from the request, security groups are returned regardless of whether they have tag keys or values associated with them.
*/
describeClusterSecurityGroups(callback?: (err: AWSError, data: Redshift.Types.ClusterSecurityGroupMessage) => void): Request<Redshift.Types.ClusterSecurityGroupMessage, AWSError>;
/**
* Returns one or more snapshot objects, which contain metadata about your cluster snapshots. By default, this operation returns information about all snapshots of all clusters that are owned by you AWS customer account. No information is returned for snapshots owned by inactive AWS customer accounts. If you specify both tag keys and tag values in the same request, Amazon Redshift returns all snapshots that match any combination of the specified keys and values. For example, if you have owner and environment for tag keys, and admin and test for tag values, all snapshots that have any combination of those values are returned. Only snapshots that you own are returned in the response; shared snapshots are not returned with the tag key and tag value request parameters. If both tag keys and values are omitted from the request, snapshots are returned regardless of whether they have tag keys or values associated with them.
*/
describeClusterSnapshots(params: Redshift.Types.DescribeClusterSnapshotsMessage, callback?: (err: AWSError, data: Redshift.Types.SnapshotMessage) => void): Request<Redshift.Types.SnapshotMessage, AWSError>;
/**
* Returns one or more snapshot objects, which contain metadata about your cluster snapshots. By default, this operation returns information about all snapshots of all clusters that are owned by you AWS customer account. No information is returned for snapshots owned by inactive AWS customer accounts. If you specify both tag keys and tag values in the same request, Amazon Redshift returns all snapshots that match any combination of the specified keys and values. For example, if you have owner and environment for tag keys, and admin and test for tag values, all snapshots that have any combination of those values are returned. Only snapshots that you own are returned in the response; shared snapshots are not returned with the tag key and tag value request parameters. If both tag keys and values are omitted from the request, snapshots are returned regardless of whether they have tag keys or values associated with them.
*/
describeClusterSnapshots(callback?: (err: AWSError, data: Redshift.Types.SnapshotMessage) => void): Request<Redshift.Types.SnapshotMessage, AWSError>;
/**
* Returns one or more cluster subnet group objects, which contain metadata about your cluster subnet groups. By default, this operation returns information about all cluster subnet groups that are defined in you AWS account. If you specify both tag keys and tag values in the same request, Amazon Redshift returns all subnet groups that match any combination of the specified keys and values. For example, if you have owner and environment for tag keys, and admin and test for tag values, all subnet groups that have any combination of those values are returned. If both tag keys and values are omitted from the request, subnet groups are returned regardless of whether they have tag keys or values associated with them.
*/
describeClusterSubnetGroups(params: Redshift.Types.DescribeClusterSubnetGroupsMessage, callback?: (err: AWSError, data: Redshift.Types.ClusterSubnetGroupMessage) => void): Request<Redshift.Types.ClusterSubnetGroupMessage, AWSError>;
/**
* Returns one or more cluster subnet group objects, which contain metadata about your cluster subnet groups. By default, this operation returns information about all cluster subnet groups that are defined in you AWS account. If you specify both tag keys and tag values in the same request, Amazon Redshift returns all subnet groups that match any combination of the specified keys and values. For example, if you have owner and environment for tag keys, and admin and test for tag values, all subnet groups that have any combination of those values are returned. If both tag keys and values are omitted from the request, subnet groups are returned regardless of whether they have tag keys or values associated with them.
*/
describeClusterSubnetGroups(callback?: (err: AWSError, data: Redshift.Types.ClusterSubnetGroupMessage) => void): Request<Redshift.Types.ClusterSubnetGroupMessage, AWSError>;
/**
* Returns a list of all the available maintenance tracks.
*/
describeClusterTracks(params: Redshift.Types.DescribeClusterTracksMessage, callback?: (err: AWSError, data: Redshift.Types.TrackListMessage) => void): Request<Redshift.Types.TrackListMessage, AWSError>;
/**
* Returns a list of all the available maintenance tracks.
*/
describeClusterTracks(callback?: (err: AWSError, data: Redshift.Types.TrackListMessage) => void): Request<Redshift.Types.TrackListMessage, AWSError>;
/**
* Returns descriptions of the available Amazon Redshift cluster versions. You can call this operation even before creating any clusters to learn more about the Amazon Redshift versions. For more information about managing clusters, go to Amazon Redshift Clusters in the Amazon Redshift Cluster Management Guide.
*/
describeClusterVersions(params: Redshift.Types.DescribeClusterVersionsMessage, callback?: (err: AWSError, data: Redshift.Types.ClusterVersionsMessage) => void): Request<Redshift.Types.ClusterVersionsMessage, AWSError>;
/**
* Returns descriptions of the available Amazon Redshift cluster versions. You can call this operation even before creating any clusters to learn more about the Amazon Redshift versions. For more information about managing clusters, go to Amazon Redshift Clusters in the Amazon Redshift Cluster Management Guide.
*/
describeClusterVersions(callback?: (err: AWSError, data: Redshift.Types.ClusterVersionsMessage) => void): Request<Redshift.Types.ClusterVersionsMessage, AWSError>;
/**
* Returns properties of provisioned clusters including general cluster properties, cluster database properties, maintenance and backup properties, and security and access properties. This operation supports pagination. For more information about managing clusters, go to Amazon Redshift Clusters in the Amazon Redshift Cluster Management Guide. If you specify both tag keys and tag values in the same request, Amazon Redshift returns all clusters that match any combination of the specified keys and values. For example, if you have owner and environment for tag keys, and admin and test for tag values, all clusters that have any combination of those values are returned. If both tag keys and values are omitted from the request, clusters are returned regardless of whether they have tag keys or values associated with them.
*/
describeClusters(params: Redshift.Types.DescribeClustersMessage, callback?: (err: AWSError, data: Redshift.Types.ClustersMessage) => void): Request<Redshift.Types.ClustersMessage, AWSError>;
/**
* Returns properties of provisioned clusters including general cluster properties, cluster database properties, maintenance and backup properties, and security and access properties. This operation supports pagination. For more information about managing clusters, go to Amazon Redshift Clusters in the Amazon Redshift Cluster Management Guide. If you specify both tag keys and tag values in the same request, Amazon Redshift returns all clusters that match any combination of the specified keys and values. For example, if you have owner and environment for tag keys, and admin and test for tag values, all clusters that have any combination of those values are returned. If both tag keys and values are omitted from the request, clusters are returned regardless of whether they have tag keys or values associated with them.
*/
describeClusters(callback?: (err: AWSError, data: Redshift.Types.ClustersMessage) => void): Request<Redshift.Types.ClustersMessage, AWSError>;
/**
* Returns a list of parameter settings for the specified parameter group family. For more information about parameters and parameter groups, go to Amazon Redshift Parameter Groups in the Amazon Redshift Cluster Management Guide.
*/
describeDefaultClusterParameters(params: Redshift.Types.DescribeDefaultClusterParametersMessage, callback?: (err: AWSError, data: Redshift.Types.DescribeDefaultClusterParametersResult) => void): Request<Redshift.Types.DescribeDefaultClusterParametersResult, AWSError>;
/**
* Returns a list of parameter settings for the specified parameter group family. For more information about parameters and parameter groups, go to Amazon Redshift Parameter Groups in the Amazon Redshift Cluster Management Guide.
*/
describeDefaultClusterParameters(callback?: (err: AWSError, data: Redshift.Types.DescribeDefaultClusterParametersResult) => void): Request<Redshift.Types.DescribeDefaultClusterParametersResult, AWSError>;
/**
* Displays a list of event categories for all event source types, or for a specified source type. For a list of the event categories and source types, go to Amazon Redshift Event Notifications.
*/
describeEventCategories(params: Redshift.Types.DescribeEventCategoriesMessage, callback?: (err: AWSError, data: Redshift.Types.EventCategoriesMessage) => void): Request<Redshift.Types.EventCategoriesMessage, AWSError>;
/**
* Displays a list of event categories for all event source types, or for a specified source type. For a list of the event categories and source types, go to Amazon Redshift Event Notifications.
*/
describeEventCategories(callback?: (err: AWSError, data: Redshift.Types.EventCategoriesMessage) => void): Request<Redshift.Types.EventCategoriesMessage, AWSError>;
/**
* Lists descriptions of all the Amazon Redshift event notification subscriptions for a customer account. If you specify a subscription name, lists the description for that subscription. If you specify both tag keys and tag values in the same request, Amazon Redshift returns all event notification subscriptions that match any combination of the specified keys and values. For example, if you have owner and environment for tag keys, and admin and test for tag values, all subscriptions that have any combination of those values are returned. If both tag keys and values are omitted from the request, subscriptions are returned regardless of whether they have tag keys or values associated with them.
*/
describeEventSubscriptions(params: Redshift.Types.DescribeEventSubscriptionsMessage, callback?: (err: AWSError, data: Redshift.Types.EventSubscriptionsMessage) => void): Request<Redshift.Types.EventSubscriptionsMessage, AWSError>;
/**
* Lists descriptions of all the Amazon Redshift event notification subscriptions for a customer account. If you specify a subscription name, lists the description for that subscription. If you specify both tag keys and tag values in the same request, Amazon Redshift returns all event notification subscriptions that match any combination of the specified keys and values. For example, if you have owner and environment for tag keys, and admin and test for tag values, all subscriptions that have any combination of those values are returned. If both tag keys and values are omitted from the request, subscriptions are returned regardless of whether they have tag keys or values associated with them.
*/
describeEventSubscriptions(callback?: (err: AWSError, data: Redshift.Types.EventSubscriptionsMessage) => void): Request<Redshift.Types.EventSubscriptionsMessage, AWSError>;
/**
* Returns events related to clusters, security groups, snapshots, and parameter groups for the past 14 days. Events specific to a particular cluster, security group, snapshot or parameter group can be obtained by providing the name as a parameter. By default, the past hour of events are returned.
*/
describeEvents(params: Redshift.Types.DescribeEventsMessage, callback?: (err: AWSError, data: Redshift.Types.EventsMessage) => void): Request<Redshift.Types.EventsMessage, AWSError>;
/**
* Returns events related to clusters, security groups, snapshots, and parameter groups for the past 14 days. Events specific to a particular cluster, security group, snapshot or parameter group can be obtained by providing the name as a parameter. By default, the past hour of events are returned.
*/
describeEvents(callback?: (err: AWSError, data: Redshift.Types.EventsMessage) => void): Request<Redshift.Types.EventsMessage, AWSError>;
/**
* Returns information about the specified HSM client certificate. If no certificate ID is specified, returns information about all the HSM certificates owned by your AWS customer account. If you specify both tag keys and tag values in the same request, Amazon Redshift returns all HSM client certificates that match any combination of the specified keys and values. For example, if you have owner and environment for tag keys, and admin and test for tag values, all HSM client certificates that have any combination of those values are returned. If both tag keys and values are omitted from the request, HSM client certificates are returned regardless of whether they have tag keys or values associated with them.
*/
describeHsmClientCertificates(params: Redshift.Types.DescribeHsmClientCertificatesMessage, callback?: (err: AWSError, data: Redshift.Types.HsmClientCertificateMessage) => void): Request<Redshift.Types.HsmClientCertificateMessage, AWSError>;
/**
* Returns information about the specified HSM client certificate. If no certificate ID is specified, returns information about all the HSM certificates owned by your AWS customer account. If you specify both tag keys and tag values in the same request, Amazon Redshift returns all HSM client certificates that match any combination of the specified keys and values. For example, if you have owner and environment for tag keys, and admin and test for tag values, all HSM client certificates that have any combination of those values are returned. If both tag keys and values are omitted from the request, HSM client certificates are returned regardless of whether they have tag keys or values associated with them.
*/
describeHsmClientCertificates(callback?: (err: AWSError, data: Redshift.Types.HsmClientCertificateMessage) => void): Request<Redshift.Types.HsmClientCertificateMessage, AWSError>;
/**
* Returns information about the specified Amazon Redshift HSM configuration. If no configuration ID is specified, returns information about all the HSM configurations owned by your AWS customer account. If you specify both tag keys and tag values in the same request, Amazon Redshift returns all HSM connections that match any combination of the specified keys and values. For example, if you have owner and environment for tag keys, and admin and test for tag values, all HSM connections that have any combination of those values are returned. If both tag keys and values are omitted from the request, HSM connections are returned regardless of whether they have tag keys or values associated with them.
*/
describeHsmConfigurations(params: Redshift.Types.DescribeHsmConfigurationsMessage, callback?: (err: AWSError, data: Redshift.Types.HsmConfigurationMessage) => void): Request<Redshift.Types.HsmConfigurationMessage, AWSError>;
/**
* Returns information about the specified Amazon Redshift HSM configuration. If no configuration ID is specified, returns information about all the HSM configurations owned by your AWS customer account. If you specify both tag keys and tag values in the same request, Amazon Redshift returns all HSM connections that match any combination of the specified keys and values. For example, if you have owner and environment for tag keys, and admin and test for tag values, all HSM connections that have any combination of those values are returned. If both tag keys and values are omitted from the request, HSM connections are returned regardless of whether they have tag keys or values associated with them.
*/
describeHsmConfigurations(callback?: (err: AWSError, data: Redshift.Types.HsmConfigurationMessage) => void): Request<Redshift.Types.HsmConfigurationMessage, AWSError>;
/**
* Describes whether information, such as queries and connection attempts, is being logged for the specified Amazon Redshift cluster.
*/
describeLoggingStatus(params: Redshift.Types.DescribeLoggingStatusMessage, callback?: (err: AWSError, data: Redshift.Types.LoggingStatus) => void): Request<Redshift.Types.LoggingStatus, AWSError>;
/**
* Describes whether information, such as queries and connection attempts, is being logged for the specified Amazon Redshift cluster.
*/
describeLoggingStatus(callback?: (err: AWSError, data: Redshift.Types.LoggingStatus) => void): Request<Redshift.Types.LoggingStatus, AWSError>;
/**
* Returns properties of possible node configurations such as node type, number of nodes, and disk usage for the specified action type.
*/
describeNodeConfigurationOptions(params: Redshift.Types.DescribeNodeConfigurationOptionsMessage, callback?: (err: AWSError, data: Redshift.Types.NodeConfigurationOptionsMessage) => void): Request<Redshift.Types.NodeConfigurationOptionsMessage, AWSError>;
/**
* Returns properties of possible node configurations such as node type, number of nodes, and disk usage for the specified action type.
*/
describeNodeConfigurationOptions(callback?: (err: AWSError, data: Redshift.Types.NodeConfigurationOptionsMessage) => void): Request<Redshift.Types.NodeConfigurationOptionsMessage, AWSError>;
/**
* Returns a list of orderable cluster options. Before you create a new cluster you can use this operation to find what options are available, such as the EC2 Availability Zones (AZ) in the specific AWS Region that you can specify, and the node types you can request. The node types differ by available storage, memory, CPU and price. With the cost involved you might want to obtain a list of cluster options in the specific region and specify values when creating a cluster. For more information about managing clusters, go to Amazon Redshift Clusters in the Amazon Redshift Cluster Management Guide.
*/
describeOrderableClusterOptions(params: Redshift.Types.DescribeOrderableClusterOptionsMessage, callback?: (err: AWSError, data: Redshift.Types.OrderableClusterOptionsMessage) => void): Request<Redshift.Types.OrderableClusterOptionsMessage, AWSError>;
/**
* Returns a list of orderable cluster options. Before you create a new cluster you can use this operation to find what options are available, such as the EC2 Availability Zones (AZ) in the specific AWS Region that you can specify, and the node types you can request. The node types differ by available storage, memory, CPU and price. With the cost involved you might want to obtain a list of cluster options in the specific region and specify values when creating a cluster. For more information about managing clusters, go to Amazon Redshift Clusters in the Amazon Redshift Cluster Management Guide.
*/
describeOrderableClusterOptions(callback?: (err: AWSError, data: Redshift.Types.OrderableClusterOptionsMessage) => void): Request<Redshift.Types.OrderableClusterOptionsMessage, AWSError>;
/**
* Returns a list of the available reserved node offerings by Amazon Redshift with their descriptions including the node type, the fixed and recurring costs of reserving the node and duration the node will be reserved for you. These descriptions help you determine which reserve node offering you want to purchase. You then use the unique offering ID in you call to PurchaseReservedNodeOffering to reserve one or more nodes for your Amazon Redshift cluster. For more information about reserved node offerings, go to Purchasing Reserved Nodes in the Amazon Redshift Cluster Management Guide.
*/
describeReservedNodeOfferings(params: Redshift.Types.DescribeReservedNodeOfferingsMessage, callback?: (err: AWSError, data: Redshift.Types.ReservedNodeOfferingsMessage) => void): Request<Redshift.Types.ReservedNodeOfferingsMessage, AWSError>;
/**
* Returns a list of the available reserved node offerings by Amazon Redshift with their descriptions including the node type, the fixed and recurring costs of reserving the node and duration the node will be reserved for you. These descriptions help you determine which reserve node offering you want to purchase. You then use the unique offering ID in you call to PurchaseReservedNodeOffering to reserve one or more nodes for your Amazon Redshift cluster. For more information about reserved node offerings, go to Purchasing Reserved Nodes in the Amazon Redshift Cluster Management Guide.
*/
describeReservedNodeOfferings(callback?: (err: AWSError, data: Redshift.Types.ReservedNodeOfferingsMessage) => void): Request<Redshift.Types.ReservedNodeOfferingsMessage, AWSError>;
/**
* Returns the descriptions of the reserved nodes.
*/
describeReservedNodes(params: Redshift.Types.DescribeReservedNodesMessage, callback?: (err: AWSError, data: Redshift.Types.ReservedNodesMessage) => void): Request<Redshift.Types.ReservedNodesMessage, AWSError>;
/**
* Returns the descriptions of the reserved nodes.
*/
describeReservedNodes(callback?: (err: AWSError, data: Redshift.Types.ReservedNodesMessage) => void): Request<Redshift.Types.ReservedNodesMessage, AWSError>;
/**
* Returns information about the last resize operation for the specified cluster. If no resize operation has ever been initiated for the specified cluster, a HTTP 404 error is returned. If a resize operation was initiated and completed, the status of the resize remains as SUCCEEDED until the next resize. A resize operation can be requested using ModifyCluster and specifying a different number or type of nodes for the cluster.
*/
describeResize(params: Redshift.Types.DescribeResizeMessage, callback?: (err: AWSError, data: Redshift.Types.ResizeProgressMessage) => void): Request<Redshift.Types.ResizeProgressMessage, AWSError>;
/**
* Returns information about the last resize operation for the specified cluster. If no resize operation has ever been initiated for the specified cluster, a HTTP 404 error is returned. If a resize operation was initiated and completed, the status of the resize remains as SUCCEEDED until the next resize. A resize operation can be requested using ModifyCluster and specifying a different number or type of nodes for the cluster.
*/
describeResize(callback?: (err: AWSError, data: Redshift.Types.ResizeProgressMessage) => void): Request<Redshift.Types.ResizeProgressMessage, AWSError>;
/**
* Describes properties of scheduled actions.
*/
describeScheduledActions(params: Redshift.Types.DescribeScheduledActionsMessage, callback?: (err: AWSError, data: Redshift.Types.ScheduledActionsMessage) => void): Request<Redshift.Types.ScheduledActionsMessage, AWSError>;
/**
* Describes properties of scheduled actions.
*/
describeScheduledActions(callback?: (err: AWSError, data: Redshift.Types.ScheduledActionsMessage) => void): Request<Redshift.Types.ScheduledActionsMessage, AWSError>;
/**
* Returns a list of snapshot copy grants owned by the AWS account in the destination region. For more information about managing snapshot copy grants, go to Amazon Redshift Database Encryption in the Amazon Redshift Cluster Management Guide.
*/
describeSnapshotCopyGrants(params: Redshift.Types.DescribeSnapshotCopyGrantsMessage, callback?: (err: AWSError, data: Redshift.Types.SnapshotCopyGrantMessage) => void): Request<Redshift.Types.SnapshotCopyGrantMessage, AWSError>;
/**
* Returns a list of snapshot copy grants owned by the AWS account in the destination region. For more information about managing snapshot copy grants, go to Amazon Redshift Database Encryption in the Amazon Redshift Cluster Management Guide.
*/
describeSnapshotCopyGrants(callback?: (err: AWSError, data: Redshift.Types.SnapshotCopyGrantMessage) => void): Request<Redshift.Types.SnapshotCopyGrantMessage, AWSError>;
/**
* Returns a list of snapshot schedules.
*/
describeSnapshotSchedules(params: Redshift.Types.DescribeSnapshotSchedulesMessage, callback?: (err: AWSError, data: Redshift.Types.DescribeSnapshotSchedulesOutputMessage) => void): Request<Redshift.Types.DescribeSnapshotSchedulesOutputMessage, AWSError>;
/**
* Returns a list of snapshot schedules.
*/
describeSnapshotSchedules(callback?: (err: AWSError, data: Redshift.Types.DescribeSnapshotSchedulesOutputMessage) => void): Request<Redshift.Types.DescribeSnapshotSchedulesOutputMessage, AWSError>;
/**
* Returns account level backups storage size and provisional storage.
*/
describeStorage(callback?: (err: AWSError, data: Redshift.Types.CustomerStorageMessage) => void): Request<Redshift.Types.CustomerStorageMessage, AWSError>;
/**
* Lists the status of one or more table restore requests made using the RestoreTableFromClusterSnapshot API action. If you don't specify a value for the TableRestoreRequestId parameter, then DescribeTableRestoreStatus returns the status of all table restore requests ordered by the date and time of the request in ascending order. Otherwise DescribeTableRestoreStatus returns the status of the table specified by TableRestoreRequestId.
*/
describeTableRestoreStatus(params: Redshift.Types.DescribeTableRestoreStatusMessage, callback?: (err: AWSError, data: Redshift.Types.TableRestoreStatusMessage) => void): Request<Redshift.Types.TableRestoreStatusMessage, AWSError>;
/**
* Lists the status of one or more table restore requests made using the RestoreTableFromClusterSnapshot API action. If you don't specify a value for the TableRestoreRequestId parameter, then DescribeTableRestoreStatus returns the status of all table restore requests ordered by the date and time of the request in ascending order. Otherwise DescribeTableRestoreStatus returns the status of the table specified by TableRestoreRequestId.
*/
describeTableRestoreStatus(callback?: (err: AWSError, data: Redshift.Types.TableRestoreStatusMessage) => void): Request<Redshift.Types.TableRestoreStatusMessage, AWSError>;
/**
* Returns a list of tags. You can return tags from a specific resource by specifying an ARN, or you can return all tags for a given type of resource, such as clusters, snapshots, and so on. The following are limitations for DescribeTags: You cannot specify an ARN and a resource-type value together in the same request. You cannot use the MaxRecords and Marker parameters together with the ARN parameter. The MaxRecords parameter can be a range from 10 to 50 results to return in a request. If you specify both tag keys and tag values in the same request, Amazon Redshift returns all resources that match any combination of the specified keys and values. For example, if you have owner and environment for tag keys, and admin and test for tag values, all resources that have any combination of those values are returned. If both tag keys and values are omitted from the request, resources are returned regardless of whether they have tag keys or values associated with them.
*/
describeTags(params: Redshift.Types.DescribeTagsMessage, callback?: (err: AWSError, data: Redshift.Types.TaggedResourceListMessage) => void): Request<Redshift.Types.TaggedResourceListMessage, AWSError>;
/**
* Returns a list of tags. You can return tags from a specific resource by specifying an ARN, or you can return all tags for a given type of resource, such as clusters, snapshots, and so on. The following are limitations for DescribeTags: You cannot specify an ARN and a resource-type value together in the same request. You cannot use the MaxRecords and Marker parameters together with the ARN parameter. The MaxRecords parameter can be a range from 10 to 50 results to return in a request. If you specify both tag keys and tag values in the same request, Amazon Redshift returns all resources that match any combination of the specified keys and values. For example, if you have owner and environment for tag keys, and admin and test for tag values, all resources that have any combination of those values are returned. If both tag keys and values are omitted from the request, resources are returned regardless of whether they have tag keys or values associated with them.
*/
describeTags(callback?: (err: AWSError, data: Redshift.Types.TaggedResourceListMessage) => void): Request<Redshift.Types.TaggedResourceListMessage, AWSError>;
/**
* Shows usage limits on a cluster. Results are filtered based on the combination of input usage limit identifier, cluster identifier, and feature type parameters: If usage limit identifier, cluster identifier, and feature type are not provided, then all usage limit objects for the current account in the current region are returned. If usage limit identifier is provided, then the corresponding usage limit object is returned. If cluster identifier is provided, then all usage limit objects for the specified cluster are returned. If cluster identifier and feature type are provided, then all usage limit objects for the combination of cluster and feature are returned.
*/
describeUsageLimits(params: Redshift.Types.DescribeUsageLimitsMessage, callback?: (err: AWSError, data: Redshift.Types.UsageLimitList) => void): Request<Redshift.Types.UsageLimitList, AWSError>;
/**
* Shows usage limits on a cluster. Results are filtered based on the combination of input usage limit identifier, cluster identifier, and feature type parameters: If usage limit identifier, cluster identifier, and feature type are not provided, then all usage limit objects for the current account in the current region are returned. If usage limit identifier is provided, then the corresponding usage limit object is returned. If cluster identifier is provided, then all usage limit objects for the specified cluster are returned. If cluster identifier and feature type are provided, then all usage limit objects for the combination of cluster and feature are returned.
*/
describeUsageLimits(callback?: (err: AWSError, data: Redshift.Types.UsageLimitList) => void): Request<Redshift.Types.UsageLimitList, AWSError>;
/**
* Stops logging information, such as queries and connection attempts, for the specified Amazon Redshift cluster.
*/
disableLogging(params: Redshift.Types.DisableLoggingMessage, callback?: (err: AWSError, data: Redshift.Types.LoggingStatus) => void): Request<Redshift.Types.LoggingStatus, AWSError>;
/**
* Stops logging information, such as queries and connection attempts, for the specified Amazon Redshift cluster.
*/
disableLogging(callback?: (err: AWSError, data: Redshift.Types.LoggingStatus) => void): Request<Redshift.Types.LoggingStatus, AWSError>;
/**
* Disables the automatic copying of snapshots from one region to another region for a specified cluster. If your cluster and its snapshots are encrypted using a customer master key (CMK) from AWS KMS, use DeleteSnapshotCopyGrant to delete the grant that grants Amazon Redshift permission to the CMK in the destination region.
*/
disableSnapshotCopy(params: Redshift.Types.DisableSnapshotCopyMessage, callback?: (err: AWSError, data: Redshift.Types.DisableSnapshotCopyResult) => void): Request<Redshift.Types.DisableSnapshotCopyResult, AWSError>;
/**
* Disables the automatic copying of snapshots from one region to another region for a specified cluster. If your cluster and its snapshots are encrypted using a customer master key (CMK) from AWS KMS, use DeleteSnapshotCopyGrant to delete the grant that grants Amazon Redshift permission to the CMK in the destination region.
*/
disableSnapshotCopy(callback?: (err: AWSError, data: Redshift.Types.DisableSnapshotCopyResult) => void): Request<Redshift.Types.DisableSnapshotCopyResult, AWSError>;
/**
* Starts logging information, such as queries and connection attempts, for the specified Amazon Redshift cluster.
*/
enableLogging(params: Redshift.Types.EnableLoggingMessage, callback?: (err: AWSError, data: Redshift.Types.LoggingStatus) => void): Request<Redshift.Types.LoggingStatus, AWSError>;
/**
* Starts logging information, such as queries and connection attempts, for the specified Amazon Redshift cluster.
*/
enableLogging(callback?: (err: AWSError, data: Redshift.Types.LoggingStatus) => void): Request<Redshift.Types.LoggingStatus, AWSError>;
/**
* Enables the automatic copy of snapshots from one region to another region for a specified cluster.
*/
enableSnapshotCopy(params: Redshift.Types.EnableSnapshotCopyMessage, callback?: (err: AWSError, data: Redshift.Types.EnableSnapshotCopyResult) => void): Request<Redshift.Types.EnableSnapshotCopyResult, AWSError>;
/**
* Enables the automatic copy of snapshots from one region to another region for a specified cluster.
*/
enableSnapshotCopy(callback?: (err: AWSError, data: Redshift.Types.EnableSnapshotCopyResult) => void): Request<Redshift.Types.EnableSnapshotCopyResult, AWSError>;
/**
* Returns a database user name and temporary password with temporary authorization to log on to an Amazon Redshift database. The action returns the database user name prefixed with IAM: if AutoCreate is False or IAMA: if AutoCreate is True. You can optionally specify one or more database user groups that the user will join at log on. By default, the temporary credentials expire in 900 seconds. You can optionally specify a duration between 900 seconds (15 minutes) and 3600 seconds (60 minutes). For more information, see Using IAM Authentication to Generate Database User Credentials in the Amazon Redshift Cluster Management Guide. The AWS Identity and Access Management (IAM)user or role that executes GetClusterCredentials must have an IAM policy attached that allows access to all necessary actions and resources. For more information about permissions, see Resource Policies for GetClusterCredentials in the Amazon Redshift Cluster Management Guide. If the DbGroups parameter is specified, the IAM policy must allow the redshift:JoinGroup action with access to the listed dbgroups. In addition, if the AutoCreate parameter is set to True, then the policy must include the redshift:CreateClusterUser privilege. If the DbName parameter is specified, the IAM policy must allow access to the resource dbname for the specified database name.
*/
getClusterCredentials(params: Redshift.Types.GetClusterCredentialsMessage, callback?: (err: AWSError, data: Redshift.Types.ClusterCredentials) => void): Request<Redshift.Types.ClusterCredentials, AWSError>;
/**
* Returns a database user name and temporary password with temporary authorization to log on to an Amazon Redshift database. The action returns the database user name prefixed with IAM: if AutoCreate is False or IAMA: if AutoCreate is True. You can optionally specify one or more database user groups that the user will join at log on. By default, the temporary credentials expire in 900 seconds. You can optionally specify a duration between 900 seconds (15 minutes) and 3600 seconds (60 minutes). For more information, see Using IAM Authentication to Generate Database User Credentials in the Amazon Redshift Cluster Management Guide. The AWS Identity and Access Management (IAM)user or role that executes GetClusterCredentials must have an IAM policy attached that allows access to all necessary actions and resources. For more information about permissions, see Resource Policies for GetClusterCredentials in the Amazon Redshift Cluster Management Guide. If the DbGroups parameter is specified, the IAM policy must allow the redshift:JoinGroup action with access to the listed dbgroups. In addition, if the AutoCreate parameter is set to True, then the policy must include the redshift:CreateClusterUser privilege. If the DbName parameter is specified, the IAM policy must allow access to the resource dbname for the specified database name.
*/
getClusterCredentials(callback?: (err: AWSError, data: Redshift.Types.ClusterCredentials) => void): Request<Redshift.Types.ClusterCredentials, AWSError>;
/**
* Returns an array of DC2 ReservedNodeOfferings that matches the payment type, term, and usage price of the given DC1 reserved node.
*/
getReservedNodeExchangeOfferings(params: Redshift.Types.GetReservedNodeExchangeOfferingsInputMessage, callback?: (err: AWSError, data: Redshift.Types.GetReservedNodeExchangeOfferingsOutputMessage) => void): Request<Redshift.Types.GetReservedNodeExchangeOfferingsOutputMessage, AWSError>;
/**
* Returns an array of DC2 ReservedNodeOfferings that matches the payment type, term, and usage price of the given DC1 reserved node.
*/
getReservedNodeExchangeOfferings(callback?: (err: AWSError, data: Redshift.Types.GetReservedNodeExchangeOfferingsOutputMessage) => void): Request<Redshift.Types.GetReservedNodeExchangeOfferingsOutputMessage, AWSError>;
/**
* Modifies the settings for a cluster. You can also change node type and the number of nodes to scale up or down the cluster. When resizing a cluster, you must specify both the number of nodes and the node type even if one of the parameters does not change. You can add another security or parameter group, or change the master user password. Resetting a cluster password or modifying the security groups associated with a cluster do not need a reboot. However, modifying a parameter group requires a reboot for parameters to take effect. For more information about managing clusters, go to Amazon Redshift Clusters in the Amazon Redshift Cluster Management Guide.
*/
modifyCluster(params: Redshift.Types.ModifyClusterMessage, callback?: (err: AWSError, data: Redshift.Types.ModifyClusterResult) => void): Request<Redshift.Types.ModifyClusterResult, AWSError>;
/**
* Modifies the settings for a cluster. You can also change node type and the number of nodes to scale up or down the cluster. When resizing a cluster, you must specify both the number of nodes and the node type even if one of the parameters does not change. You can add another security or parameter group, or change the master user password. Resetting a cluster password or modifying the security groups associated with a cluster do not need a reboot. However, modifying a parameter group requires a reboot for parameters to take effect. For more information about managing clusters, go to Amazon Redshift Clusters in the Amazon Redshift Cluster Management Guide.
*/
modifyCluster(callback?: (err: AWSError, data: Redshift.Types.ModifyClusterResult) => void): Request<Redshift.Types.ModifyClusterResult, AWSError>;
/**
* Modifies the database revision of a cluster. The database revision is a unique revision of the database running in a cluster.
*/
modifyClusterDbRevision(params: Redshift.Types.ModifyClusterDbRevisionMessage, callback?: (err: AWSError, data: Redshift.Types.ModifyClusterDbRevisionResult) => void): Request<Redshift.Types.ModifyClusterDbRevisionResult, AWSError>;
/**
* Modifies the database revision of a cluster. The database revision is a unique revision of the database running in a cluster.
*/
modifyClusterDbRevision(callback?: (err: AWSError, data: Redshift.Types.ModifyClusterDbRevisionResult) => void): Request<Redshift.Types.ModifyClusterDbRevisionResult, AWSError>;
/**
* Modifies the list of AWS Identity and Access Management (IAM) roles that can be used by the cluster to access other AWS services. A cluster can have up to 10 IAM roles associated at any time.
*/
modifyClusterIamRoles(params: Redshift.Types.ModifyClusterIamRolesMessage, callback?: (err: AWSError, data: Redshift.Types.ModifyClusterIamRolesResult) => void): Request<Redshift.Types.ModifyClusterIamRolesResult, AWSError>;
/**
* Modifies the list of AWS Identity and Access Management (IAM) roles that can be used by the cluster to access other AWS services. A cluster can have up to 10 IAM roles associated at any time.
*/
modifyClusterIamRoles(callback?: (err: AWSError, data: Redshift.Types.ModifyClusterIamRolesResult) => void): Request<Redshift.Types.ModifyClusterIamRolesResult, AWSError>;
/**
* Modifies the maintenance settings of a cluster.
*/
modifyClusterMaintenance(params: Redshift.Types.ModifyClusterMaintenanceMessage, callback?: (err: AWSError, data: Redshift.Types.ModifyClusterMaintenanceResult) => void): Request<Redshift.Types.ModifyClusterMaintenanceResult, AWSError>;
/**
* Modifies the maintenance settings of a cluster.
*/
modifyClusterMaintenance(callback?: (err: AWSError, data: Redshift.Types.ModifyClusterMaintenanceResult) => void): Request<Redshift.Types.ModifyClusterMaintenanceResult, AWSError>;
/**
* Modifies the parameters of a parameter group. For more information about parameters and parameter groups, go to Amazon Redshift Parameter Groups in the Amazon Redshift Cluster Management Guide.
*/
modifyClusterParameterGroup(params: Redshift.Types.ModifyClusterParameterGroupMessage, callback?: (err: AWSError, data: Redshift.Types.ClusterParameterGroupNameMessage) => void): Request<Redshift.Types.ClusterParameterGroupNameMessage, AWSError>;
/**
* Modifies the parameters of a parameter group. For more information about parameters and parameter groups, go to Amazon Redshift Parameter Groups in the Amazon Redshift Cluster Management Guide.
*/
modifyClusterParameterGroup(callback?: (err: AWSError, data: Redshift.Types.ClusterParameterGroupNameMessage) => void): Request<Redshift.Types.ClusterParameterGroupNameMessage, AWSError>;
/**
* Modifies the settings for a snapshot. This exanmple modifies the manual retention period setting for a cluster snapshot.
*/
modifyClusterSnapshot(params: Redshift.Types.ModifyClusterSnapshotMessage, callback?: (err: AWSError, data: Redshift.Types.ModifyClusterSnapshotResult) => void): Request<Redshift.Types.ModifyClusterSnapshotResult, AWSError>;
/**
* Modifies the settings for a snapshot. This exanmple modifies the manual retention period setting for a cluster snapshot.
*/
modifyClusterSnapshot(callback?: (err: AWSError, data: Redshift.Types.ModifyClusterSnapshotResult) => void): Request<Redshift.Types.ModifyClusterSnapshotResult, AWSError>;
/**
* Modifies a snapshot schedule for a cluster.
*/
modifyClusterSnapshotSchedule(params: Redshift.Types.ModifyClusterSnapshotScheduleMessage, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Modifies a snapshot schedule for a cluster.
*/
modifyClusterSnapshotSchedule(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Modifies a cluster subnet group to include the specified list of VPC subnets. The operation replaces the existing list of subnets with the new list of subnets.
*/
modifyClusterSubnetGroup(params: Redshift.Types.ModifyClusterSubnetGroupMessage, callback?: (err: AWSError, data: Redshift.Types.ModifyClusterSubnetGroupResult) => void): Request<Redshift.Types.ModifyClusterSubnetGroupResult, AWSError>;
/**
* Modifies a cluster subnet group to include the specified list of VPC subnets. The operation replaces the existing list of subnets with the new list of subnets.
*/
modifyClusterSubnetGroup(callback?: (err: AWSError, data: Redshift.Types.ModifyClusterSubnetGroupResult) => void): Request<Redshift.Types.ModifyClusterSubnetGroupResult, AWSError>;
/**
* Modifies an existing Amazon Redshift event notification subscription.
*/
modifyEventSubscription(params: Redshift.Types.ModifyEventSubscriptionMessage, callback?: (err: AWSError, data: Redshift.Types.ModifyEventSubscriptionResult) => void): Request<Redshift.Types.ModifyEventSubscriptionResult, AWSError>;
/**
* Modifies an existing Amazon Redshift event notification subscription.
*/
modifyEventSubscription(callback?: (err: AWSError, data: Redshift.Types.ModifyEventSubscriptionResult) => void): Request<Redshift.Types.ModifyEventSubscriptionResult, AWSError>;
/**
* Modifies a scheduled action.
*/
modifyScheduledAction(params: Redshift.Types.ModifyScheduledActionMessage, callback?: (err: AWSError, data: Redshift.Types.ScheduledAction) => void): Request<Redshift.Types.ScheduledAction, AWSError>;
/**
* Modifies a scheduled action.
*/
modifyScheduledAction(callback?: (err: AWSError, data: Redshift.Types.ScheduledAction) => void): Request<Redshift.Types.ScheduledAction, AWSError>;
/**
* Modifies the number of days to retain snapshots in the destination AWS Region after they are copied from the source AWS Region. By default, this operation only changes the retention period of copied automated snapshots. The retention periods for both new and existing copied automated snapshots are updated with the new retention period. You can set the manual option to change only the retention periods of copied manual snapshots. If you set this option, only newly copied manual snapshots have the new retention period.
*/
modifySnapshotCopyRetentionPeriod(params: Redshift.Types.ModifySnapshotCopyRetentionPeriodMessage, callback?: (err: AWSError, data: Redshift.Types.ModifySnapshotCopyRetentionPeriodResult) => void): Request<Redshift.Types.ModifySnapshotCopyRetentionPeriodResult, AWSError>;
/**
* Modifies the number of days to retain snapshots in the destination AWS Region after they are copied from the source AWS Region. By default, this operation only changes the retention period of copied automated snapshots. The retention periods for both new and existing copied automated snapshots are updated with the new retention period. You can set the manual option to change only the retention periods of copied manual snapshots. If you set this option, only newly copied manual snapshots have the new retention period.
*/
modifySnapshotCopyRetentionPeriod(callback?: (err: AWSError, data: Redshift.Types.ModifySnapshotCopyRetentionPeriodResult) => void): Request<Redshift.Types.ModifySnapshotCopyRetentionPeriodResult, AWSError>;
/**
* Modifies a snapshot schedule. Any schedule associated with a cluster is modified asynchronously.
*/
modifySnapshotSchedule(params: Redshift.Types.ModifySnapshotScheduleMessage, callback?: (err: AWSError, data: Redshift.Types.SnapshotSchedule) => void): Request<Redshift.Types.SnapshotSchedule, AWSError>;
/**
* Modifies a snapshot schedule. Any schedule associated with a cluster is modified asynchronously.
*/
modifySnapshotSchedule(callback?: (err: AWSError, data: Redshift.Types.SnapshotSchedule) => void): Request<Redshift.Types.SnapshotSchedule, AWSError>;
/**
* Modifies a usage limit in a cluster. You can't modify the feature type or period of a usage limit.
*/
modifyUsageLimit(params: Redshift.Types.ModifyUsageLimitMessage, callback?: (err: AWSError, data: Redshift.Types.UsageLimit) => void): Request<Redshift.Types.UsageLimit, AWSError>;
/**
* Modifies a usage limit in a cluster. You can't modify the feature type or period of a usage limit.
*/
modifyUsageLimit(callback?: (err: AWSError, data: Redshift.Types.UsageLimit) => void): Request<Redshift.Types.UsageLimit, AWSError>;
/**
* Pauses a cluster.
*/
pauseCluster(params: Redshift.Types.PauseClusterMessage, callback?: (err: AWSError, data: Redshift.Types.PauseClusterResult) => void): Request<Redshift.Types.PauseClusterResult, AWSError>;
/**
* Pauses a cluster.
*/
pauseCluster(callback?: (err: AWSError, data: Redshift.Types.PauseClusterResult) => void): Request<Redshift.Types.PauseClusterResult, AWSError>;
/**
* Allows you to purchase reserved nodes. Amazon Redshift offers a predefined set of reserved node offerings. You can purchase one or more of the offerings. You can call the DescribeReservedNodeOfferings API to obtain the available reserved node offerings. You can call this API by providing a specific reserved node offering and the number of nodes you want to reserve. For more information about reserved node offerings, go to Purchasing Reserved Nodes in the Amazon Redshift Cluster Management Guide.
*/
purchaseReservedNodeOffering(params: Redshift.Types.PurchaseReservedNodeOfferingMessage, callback?: (err: AWSError, data: Redshift.Types.PurchaseReservedNodeOfferingResult) => void): Request<Redshift.Types.PurchaseReservedNodeOfferingResult, AWSError>;
/**
* Allows you to purchase reserved nodes. Amazon Redshift offers a predefined set of reserved node offerings. You can purchase one or more of the offerings. You can call the DescribeReservedNodeOfferings API to obtain the available reserved node offerings. You can call this API by providing a specific reserved node offering and the number of nodes you want to reserve. For more information about reserved node offerings, go to Purchasing Reserved Nodes in the Amazon Redshift Cluster Management Guide.
*/
purchaseReservedNodeOffering(callback?: (err: AWSError, data: Redshift.Types.PurchaseReservedNodeOfferingResult) => void): Request<Redshift.Types.PurchaseReservedNodeOfferingResult, AWSError>;
/**
* Reboots a cluster. This action is taken as soon as possible. It results in a momentary outage to the cluster, during which the cluster status is set to rebooting. A cluster event is created when the reboot is completed. Any pending cluster modifications (see ModifyCluster) are applied at this reboot. For more information about managing clusters, go to Amazon Redshift Clusters in the Amazon Redshift Cluster Management Guide.
*/
rebootCluster(params: Redshift.Types.RebootClusterMessage, callback?: (err: AWSError, data: Redshift.Types.RebootClusterResult) => void): Request<Redshift.Types.RebootClusterResult, AWSError>;
/**
* Reboots a cluster. This action is taken as soon as possible. It results in a momentary outage to the cluster, during which the cluster status is set to rebooting. A cluster event is created when the reboot is completed. Any pending cluster modifications (see ModifyCluster) are applied at this reboot. For more information about managing clusters, go to Amazon Redshift Clusters in the Amazon Redshift Cluster Management Guide.
*/
rebootCluster(callback?: (err: AWSError, data: Redshift.Types.RebootClusterResult) => void): Request<Redshift.Types.RebootClusterResult, AWSError>;
/**
* Sets one or more parameters of the specified parameter group to their default values and sets the source values of the parameters to "engine-default". To reset the entire parameter group specify the ResetAllParameters parameter. For parameter changes to take effect you must reboot any associated clusters.
*/
resetClusterParameterGroup(params: Redshift.Types.ResetClusterParameterGroupMessage, callback?: (err: AWSError, data: Redshift.Types.ClusterParameterGroupNameMessage) => void): Request<Redshift.Types.ClusterParameterGroupNameMessage, AWSError>;
/**
* Sets one or more parameters of the specified parameter group to their default values and sets the source values of the parameters to "engine-default". To reset the entire parameter group specify the ResetAllParameters parameter. For parameter changes to take effect you must reboot any associated clusters.
*/
resetClusterParameterGroup(callback?: (err: AWSError, data: Redshift.Types.ClusterParameterGroupNameMessage) => void): Request<Redshift.Types.ClusterParameterGroupNameMessage, AWSError>;
/**
* Changes the size of the cluster. You can change the cluster's type, or change the number or type of nodes. The default behavior is to use the elastic resize method. With an elastic resize, your cluster is available for read and write operations more quickly than with the classic resize method. Elastic resize operations have the following restrictions: You can only resize clusters of the following types: dc2.large dc2.8xlarge ds2.xlarge ds2.8xlarge ra3.4xlarge ra3.16xlarge The type of nodes that you add must match the node type for the cluster.
*/
resizeCluster(params: Redshift.Types.ResizeClusterMessage, callback?: (err: AWSError, data: Redshift.Types.ResizeClusterResult) => void): Request<Redshift.Types.ResizeClusterResult, AWSError>;
/**
* Changes the size of the cluster. You can change the cluster's type, or change the number or type of nodes. The default behavior is to use the elastic resize method. With an elastic resize, your cluster is available for read and write operations more quickly than with the classic resize method. Elastic resize operations have the following restrictions: You can only resize clusters of the following types: dc2.large dc2.8xlarge ds2.xlarge ds2.8xlarge ra3.4xlarge ra3.16xlarge The type of nodes that you add must match the node type for the cluster.
*/
resizeCluster(callback?: (err: AWSError, data: Redshift.Types.ResizeClusterResult) => void): Request<Redshift.Types.ResizeClusterResult, AWSError>;
/**
* Creates a new cluster from a snapshot. By default, Amazon Redshift creates the resulting cluster with the same configuration as the original cluster from which the snapshot was created, except that the new cluster is created with the default cluster security and parameter groups. After Amazon Redshift creates the cluster, you can use the ModifyCluster API to associate a different security group and different parameter group with the restored cluster. If you are using a DS node type, you can also choose to change to another DS node type of the same size during restore. If you restore a cluster into a VPC, you must provide a cluster subnet group where you want the cluster restored. For more information about working with snapshots, go to Amazon Redshift Snapshots in the Amazon Redshift Cluster Management Guide.
*/
restoreFromClusterSnapshot(params: Redshift.Types.RestoreFromClusterSnapshotMessage, callback?: (err: AWSError, data: Redshift.Types.RestoreFromClusterSnapshotResult) => void): Request<Redshift.Types.RestoreFromClusterSnapshotResult, AWSError>;
/**
* Creates a new cluster from a snapshot. By default, Amazon Redshift creates the resulting cluster with the same configuration as the original cluster from which the snapshot was created, except that the new cluster is created with the default cluster security and parameter groups. After Amazon Redshift creates the cluster, you can use the ModifyCluster API to associate a different security group and different parameter group with the restored cluster. If you are using a DS node type, you can also choose to change to another DS node type of the same size during restore. If you restore a cluster into a VPC, you must provide a cluster subnet group where you want the cluster restored. For more information about working with snapshots, go to Amazon Redshift Snapshots in the Amazon Redshift Cluster Management Guide.
*/
restoreFromClusterSnapshot(callback?: (err: AWSError, data: Redshift.Types.RestoreFromClusterSnapshotResult) => void): Request<Redshift.Types.RestoreFromClusterSnapshotResult, AWSError>;
/**
* Creates a new table from a table in an Amazon Redshift cluster snapshot. You must create the new table within the Amazon Redshift cluster that the snapshot was taken from. You cannot use RestoreTableFromClusterSnapshot to restore a table with the same name as an existing table in an Amazon Redshift cluster. That is, you cannot overwrite an existing table in a cluster with a restored table. If you want to replace your original table with a new, restored table, then rename or drop your original table before you call RestoreTableFromClusterSnapshot. When you have renamed your original table, then you can pass the original name of the table as the NewTableName parameter value in the call to RestoreTableFromClusterSnapshot. This way, you can replace the original table with the table created from the snapshot.
*/
restoreTableFromClusterSnapshot(params: Redshift.Types.RestoreTableFromClusterSnapshotMessage, callback?: (err: AWSError, data: Redshift.Types.RestoreTableFromClusterSnapshotResult) => void): Request<Redshift.Types.RestoreTableFromClusterSnapshotResult, AWSError>;
/**
* Creates a new table from a table in an Amazon Redshift cluster snapshot. You must create the new table within the Amazon Redshift cluster that the snapshot was taken from. You cannot use RestoreTableFromClusterSnapshot to restore a table with the same name as an existing table in an Amazon Redshift cluster. That is, you cannot overwrite an existing table in a cluster with a restored table. If you want to replace your original table with a new, restored table, then rename or drop your original table before you call RestoreTableFromClusterSnapshot. When you have renamed your original table, then you can pass the original name of the table as the NewTableName parameter value in the call to RestoreTableFromClusterSnapshot. This way, you can replace the original table with the table created from the snapshot.
*/
restoreTableFromClusterSnapshot(callback?: (err: AWSError, data: Redshift.Types.RestoreTableFromClusterSnapshotResult) => void): Request<Redshift.Types.RestoreTableFromClusterSnapshotResult, AWSError>;
/**
* Resumes a paused cluster.
*/
resumeCluster(params: Redshift.Types.ResumeClusterMessage, callback?: (err: AWSError, data: Redshift.Types.ResumeClusterResult) => void): Request<Redshift.Types.ResumeClusterResult, AWSError>;
/**
* Resumes a paused cluster.
*/
resumeCluster(callback?: (err: AWSError, data: Redshift.Types.ResumeClusterResult) => void): Request<Redshift.Types.ResumeClusterResult, AWSError>;
/**
* Revokes an ingress rule in an Amazon Redshift security group for a previously authorized IP range or Amazon EC2 security group. To add an ingress rule, see AuthorizeClusterSecurityGroupIngress. For information about managing security groups, go to Amazon Redshift Cluster Security Groups in the Amazon Redshift Cluster Management Guide.
*/
revokeClusterSecurityGroupIngress(params: Redshift.Types.RevokeClusterSecurityGroupIngressMessage, callback?: (err: AWSError, data: Redshift.Types.RevokeClusterSecurityGroupIngressResult) => void): Request<Redshift.Types.RevokeClusterSecurityGroupIngressResult, AWSError>;
/**
* Revokes an ingress rule in an Amazon Redshift security group for a previously authorized IP range or Amazon EC2 security group. To add an ingress rule, see AuthorizeClusterSecurityGroupIngress. For information about managing security groups, go to Amazon Redshift Cluster Security Groups in the Amazon Redshift Cluster Management Guide.
*/
revokeClusterSecurityGroupIngress(callback?: (err: AWSError, data: Redshift.Types.RevokeClusterSecurityGroupIngressResult) => void): Request<Redshift.Types.RevokeClusterSecurityGroupIngressResult, AWSError>;
/**
* Removes the ability of the specified AWS customer account to restore the specified snapshot. If the account is currently restoring the snapshot, the restore will run to completion. For more information about working with snapshots, go to Amazon Redshift Snapshots in the Amazon Redshift Cluster Management Guide.
*/
revokeSnapshotAccess(params: Redshift.Types.RevokeSnapshotAccessMessage, callback?: (err: AWSError, data: Redshift.Types.RevokeSnapshotAccessResult) => void): Request<Redshift.Types.RevokeSnapshotAccessResult, AWSError>;
/**
* Removes the ability of the specified AWS customer account to restore the specified snapshot. If the account is currently restoring the snapshot, the restore will run to completion. For more information about working with snapshots, go to Amazon Redshift Snapshots in the Amazon Redshift Cluster Management Guide.
*/
revokeSnapshotAccess(callback?: (err: AWSError, data: Redshift.Types.RevokeSnapshotAccessResult) => void): Request<Redshift.Types.RevokeSnapshotAccessResult, AWSError>;
/**
* Rotates the encryption keys for a cluster.
*/
rotateEncryptionKey(params: Redshift.Types.RotateEncryptionKeyMessage, callback?: (err: AWSError, data: Redshift.Types.RotateEncryptionKeyResult) => void): Request<Redshift.Types.RotateEncryptionKeyResult, AWSError>;
/**
* Rotates the encryption keys for a cluster.
*/
rotateEncryptionKey(callback?: (err: AWSError, data: Redshift.Types.RotateEncryptionKeyResult) => void): Request<Redshift.Types.RotateEncryptionKeyResult, AWSError>;
/**
* Waits for the clusterAvailable state by periodically calling the underlying Redshift.describeClustersoperation every 60 seconds (at most 30 times).
*/
waitFor(state: "clusterAvailable", params: Redshift.Types.DescribeClustersMessage & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: Redshift.Types.ClustersMessage) => void): Request<Redshift.Types.ClustersMessage, AWSError>;
/**
* Waits for the clusterAvailable state by periodically calling the underlying Redshift.describeClustersoperation every 60 seconds (at most 30 times).
*/
waitFor(state: "clusterAvailable", callback?: (err: AWSError, data: Redshift.Types.ClustersMessage) => void): Request<Redshift.Types.ClustersMessage, AWSError>;
/**
* Waits for the clusterDeleted state by periodically calling the underlying Redshift.describeClustersoperation every 60 seconds (at most 30 times).
*/
waitFor(state: "clusterDeleted", params: Redshift.Types.DescribeClustersMessage & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: Redshift.Types.ClustersMessage) => void): Request<Redshift.Types.ClustersMessage, AWSError>;
/**
* Waits for the clusterDeleted state by periodically calling the underlying Redshift.describeClustersoperation every 60 seconds (at most 30 times).
*/
waitFor(state: "clusterDeleted", callback?: (err: AWSError, data: Redshift.Types.ClustersMessage) => void): Request<Redshift.Types.ClustersMessage, AWSError>;
/**
* Waits for the clusterRestored state by periodically calling the underlying Redshift.describeClustersoperation every 60 seconds (at most 30 times).
*/
waitFor(state: "clusterRestored", params: Redshift.Types.DescribeClustersMessage & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: Redshift.Types.ClustersMessage) => void): Request<Redshift.Types.ClustersMessage, AWSError>;
/**
* Waits for the clusterRestored state by periodically calling the underlying Redshift.describeClustersoperation every 60 seconds (at most 30 times).
*/
waitFor(state: "clusterRestored", callback?: (err: AWSError, data: Redshift.Types.ClustersMessage) => void): Request<Redshift.Types.ClustersMessage, AWSError>;
/**
* Waits for the snapshotAvailable state by periodically calling the underlying Redshift.describeClusterSnapshotsoperation every 15 seconds (at most 20 times).
*/
waitFor(state: "snapshotAvailable", params: Redshift.Types.DescribeClusterSnapshotsMessage & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: Redshift.Types.SnapshotMessage) => void): Request<Redshift.Types.SnapshotMessage, AWSError>;
/**
* Waits for the snapshotAvailable state by periodically calling the underlying Redshift.describeClusterSnapshotsoperation every 15 seconds (at most 20 times).
*/
waitFor(state: "snapshotAvailable", callback?: (err: AWSError, data: Redshift.Types.SnapshotMessage) => void): Request<Redshift.Types.SnapshotMessage, AWSError>;
}
declare namespace Redshift {
export interface AcceptReservedNodeExchangeInputMessage {
/**
* A string representing the node identifier of the DC1 Reserved Node to be exchanged.
*/
ReservedNodeId: String;
/**
* The unique identifier of the DC2 Reserved Node offering to be used for the exchange. You can obtain the value for the parameter by calling GetReservedNodeExchangeOfferings
*/
TargetReservedNodeOfferingId: String;
}
export interface AcceptReservedNodeExchangeOutputMessage {
/**
*
*/
ExchangedReservedNode?: ReservedNode;
}
export interface AccountAttribute {
/**
* The name of the attribute.
*/
AttributeName?: String;
/**
* A list of attribute values.
*/
AttributeValues?: AttributeValueList;
}
export interface AccountAttributeList {
/**
* A list of attributes assigned to an account.
*/
AccountAttributes?: AttributeList;
}
export interface AccountWithRestoreAccess {
/**
* The identifier of an AWS customer account authorized to restore a snapshot.
*/
AccountId?: String;
/**
* The identifier of an AWS support account authorized to restore a snapshot. For AWS support, the identifier is amazon-redshift-support.
*/
AccountAlias?: String;
}
export type AccountsWithRestoreAccessList = AccountWithRestoreAccess[];
export type ActionType = "restore-cluster"|"recommend-node-config"|"resize-cluster"|string;
export type AssociatedClusterList = ClusterAssociatedToSchedule[];
export type AttributeList = AccountAttribute[];
export type AttributeNameList = String[];
export type AttributeValueList = AttributeValueTarget[];
export interface AttributeValueTarget {
/**
* The value of the attribute.
*/
AttributeValue?: String;
}
export interface AuthorizeClusterSecurityGroupIngressMessage {
/**
* The name of the security group to which the ingress rule is added.
*/
ClusterSecurityGroupName: String;
/**
* The IP range to be added the Amazon Redshift security group.
*/
CIDRIP?: String;
/**
* The EC2 security group to be added the Amazon Redshift security group.
*/
EC2SecurityGroupName?: String;
/**
* The AWS account number of the owner of the security group specified by the EC2SecurityGroupName parameter. The AWS Access Key ID is not an acceptable value. Example: 111122223333
*/
EC2SecurityGroupOwnerId?: String;
}
export interface AuthorizeClusterSecurityGroupIngressResult {
ClusterSecurityGroup?: ClusterSecurityGroup;
}
export interface AuthorizeSnapshotAccessMessage {
/**
* The identifier of the snapshot the account is authorized to restore.
*/
SnapshotIdentifier: String;
/**
* The identifier of the cluster the snapshot was created from. This parameter is required if your IAM user has a policy containing a snapshot resource element that specifies anything other than * for the cluster name.
*/
SnapshotClusterIdentifier?: String;
/**
* The identifier of the AWS customer account authorized to restore the specified snapshot. To share a snapshot with AWS support, specify amazon-redshift-support.
*/
AccountWithRestoreAccess: String;
}
export interface AuthorizeSnapshotAccessResult {
Snapshot?: Snapshot;
}
export interface AvailabilityZone {
/**
* The name of the availability zone.
*/
Name?: String;
/**
*
*/
SupportedPlatforms?: SupportedPlatformsList;
}
export type AvailabilityZoneList = AvailabilityZone[];
export interface BatchDeleteClusterSnapshotsRequest {
/**
* A list of identifiers for the snapshots that you want to delete.
*/
Identifiers: DeleteClusterSnapshotMessageList;
}
export interface BatchDeleteClusterSnapshotsResult {
/**
* A list of the snapshot identifiers that were deleted.
*/
Resources?: SnapshotIdentifierList;
/**
* A list of any errors returned.
*/
Errors?: BatchSnapshotOperationErrorList;
}
export interface BatchModifyClusterSnapshotsMessage {
/**
* A list of snapshot identifiers you want to modify.
*/
SnapshotIdentifierList: SnapshotIdentifierList;
/**
* The number of days that a manual snapshot is retained. If you specify the value -1, the manual snapshot is retained indefinitely. The number must be either -1 or an integer between 1 and 3,653. If you decrease the manual snapshot retention period from its current value, existing manual snapshots that fall outside of the new retention period will return an error. If you want to suppress the errors and delete the snapshots, use the force option.
*/
ManualSnapshotRetentionPeriod?: IntegerOptional;
/**
* A boolean value indicating whether to override an exception if the retention period has passed.
*/
Force?: Boolean;
}
export interface BatchModifyClusterSnapshotsOutputMessage {
/**
* A list of the snapshots that were modified.
*/
Resources?: SnapshotIdentifierList;
/**
* A list of any errors returned.
*/
Errors?: BatchSnapshotOperationErrors;
}
export type BatchSnapshotOperationErrorList = SnapshotErrorMessage[];
export type BatchSnapshotOperationErrors = SnapshotErrorMessage[];
export type Boolean = boolean;
export type BooleanOptional = boolean;
export interface CancelResizeMessage {
/**
* The unique identifier for the cluster that you want to cancel a resize operation for.
*/
ClusterIdentifier: String;
}
export interface Cluster {
/**
* The unique identifier of the cluster.
*/
ClusterIdentifier?: String;
/**
* The node type for the nodes in the cluster.
*/
NodeType?: String;
/**
* The current state of the cluster. Possible values are the following: available available, prep-for-resize available, resize-cleanup cancelling-resize creating deleting final-snapshot hardware-failure incompatible-hsm incompatible-network incompatible-parameters incompatible-restore modifying paused rebooting renaming resizing rotating-keys storage-full updating-hsm
*/
ClusterStatus?: String;
/**
* The availability status of the cluster for queries. Possible values are the following: Available - The cluster is available for queries. Unavailable - The cluster is not available for queries. Maintenance - The cluster is intermittently available for queries due to maintenance activities. Modifying - The cluster is intermittently available for queries due to changes that modify the cluster. Failed - The cluster failed and is not available for queries.
*/
ClusterAvailabilityStatus?: String;
/**
* The status of a modify operation, if any, initiated for the cluster.
*/
ModifyStatus?: String;
/**
* The master user name for the cluster. This name is used to connect to the database that is specified in the DBName parameter.
*/
MasterUsername?: String;
/**
* The name of the initial database that was created when the cluster was created. This same name is returned for the life of the cluster. If an initial database was not specified, a database named devdev was created by default.
*/
DBName?: String;
/**
* The connection endpoint.
*/
Endpoint?: Endpoint;
/**
* The date and time that the cluster was created.
*/
ClusterCreateTime?: TStamp;
/**
* The number of days that automatic cluster snapshots are retained.
*/
AutomatedSnapshotRetentionPeriod?: Integer;
/**
* The default number of days to retain a manual snapshot. If the value is -1, the snapshot is retained indefinitely. This setting doesn't change the retention period of existing snapshots. The value must be either -1 or an integer between 1 and 3,653.
*/
ManualSnapshotRetentionPeriod?: Integer;
/**
* A list of cluster security group that are associated with the cluster. Each security group is represented by an element that contains ClusterSecurityGroup.Name and ClusterSecurityGroup.Status subelements. Cluster security groups are used when the cluster is not created in an Amazon Virtual Private Cloud (VPC). Clusters that are created in a VPC use VPC security groups, which are listed by the VpcSecurityGroups parameter.
*/
ClusterSecurityGroups?: ClusterSecurityGroupMembershipList;
/**
* A list of Amazon Virtual Private Cloud (Amazon VPC) security groups that are associated with the cluster. This parameter is returned only if the cluster is in a VPC.
*/
VpcSecurityGroups?: VpcSecurityGroupMembershipList;
/**
* The list of cluster parameter groups that are associated with this cluster. Each parameter group in the list is returned with its status.
*/
ClusterParameterGroups?: ClusterParameterGroupStatusList;
/**
* The name of the subnet group that is associated with the cluster. This parameter is valid only when the cluster is in a VPC.
*/
ClusterSubnetGroupName?: String;
/**
* The identifier of the VPC the cluster is in, if the cluster is in a VPC.
*/
VpcId?: String;
/**
* The name of the Availability Zone in which the cluster is located.
*/
AvailabilityZone?: String;
/**
* The weekly time range, in Universal Coordinated Time (UTC), during which system maintenance can occur.
*/
PreferredMaintenanceWindow?: String;
/**
* A value that, if present, indicates that changes to the cluster are pending. Specific pending changes are identified by subelements.
*/
PendingModifiedValues?: PendingModifiedValues;
/**
* The version ID of the Amazon Redshift engine that is running on the cluster.
*/
ClusterVersion?: String;
/**
* A boolean value that, if true, indicates that major version upgrades will be applied automatically to the cluster during the maintenance window.
*/
AllowVersionUpgrade?: Boolean;
/**
* The number of compute nodes in the cluster.
*/
NumberOfNodes?: Integer;
/**
* A boolean value that, if true, indicates that the cluster can be accessed from a public network.
*/
PubliclyAccessible?: Boolean;
/**
* A boolean value that, if true, indicates that data in the cluster is encrypted at rest.
*/
Encrypted?: Boolean;
/**
* A value that describes the status of a cluster restore action. This parameter returns null if the cluster was not created by restoring a snapshot.
*/
RestoreStatus?: RestoreStatus;
/**
*
*/
DataTransferProgress?: DataTransferProgress;
/**
* A value that reports whether the Amazon Redshift cluster has finished applying any hardware security module (HSM) settings changes specified in a modify cluster command. Values: active, applying
*/
HsmStatus?: HsmStatus;
/**
* A value that returns the destination region and retention period that are configured for cross-region snapshot copy.
*/
ClusterSnapshotCopyStatus?: ClusterSnapshotCopyStatus;
/**
* The public key for the cluster.
*/
ClusterPublicKey?: String;
/**
* The nodes in the cluster.
*/
ClusterNodes?: ClusterNodesList;
/**
* The status of the elastic IP (EIP) address.
*/
ElasticIpStatus?: ElasticIpStatus;
/**
* The specific revision number of the database in the cluster.
*/
ClusterRevisionNumber?: String;
/**
* The list of tags for the cluster.
*/
Tags?: TagList;
/**
* The AWS Key Management Service (AWS KMS) key ID of the encryption key used to encrypt data in the cluster.
*/
KmsKeyId?: String;
/**
* An option that specifies whether to create the cluster with enhanced VPC routing enabled. To create a cluster that uses enhanced VPC routing, the cluster must be in a VPC. For more information, see Enhanced VPC Routing in the Amazon Redshift Cluster Management Guide. If this option is true, enhanced VPC routing is enabled. Default: false
*/
EnhancedVpcRouting?: Boolean;
/**
* A list of AWS Identity and Access Management (IAM) roles that can be used by the cluster to access other AWS services.
*/
IamRoles?: ClusterIamRoleList;
/**
* Cluster operations that are waiting to be started.
*/
PendingActions?: PendingActionsList;
/**
* The name of the maintenance track for the cluster.
*/
MaintenanceTrackName?: String;
/**
* The number of nodes that you can resize the cluster to with the elastic resize method.
*/
ElasticResizeNumberOfNodeOptions?: String;
/**
* Describes a group of DeferredMaintenanceWindow objects.
*/
DeferredMaintenanceWindows?: DeferredMaintenanceWindowsList;
/**
* A unique identifier for the cluster snapshot schedule.
*/
SnapshotScheduleIdentifier?: String;
/**
* The current state of the cluster snapshot schedule.
*/
SnapshotScheduleState?: ScheduleState;
/**
* The date and time when the next snapshot is expected to be taken for clusters with a valid snapshot schedule and backups enabled.
*/
ExpectedNextSnapshotScheduleTime?: TStamp;
/**
* The status of next expected snapshot for clusters having a valid snapshot schedule and backups enabled. Possible values are the following: OnTrack - The next snapshot is expected to be taken on time. Pending - The next snapshot is pending to be taken.
*/
ExpectedNextSnapshotScheduleTimeStatus?: String;
/**
* The date and time in UTC when system maintenance can begin.
*/
NextMaintenanceWindowStartTime?: TStamp;
/**
* Returns the following: AllowCancelResize: a boolean value indicating if the resize operation can be cancelled. ResizeType: Returns ClassicResize
*/
ResizeInfo?: ResizeInfo;
}
export interface ClusterAssociatedToSchedule {
/**
*
*/
ClusterIdentifier?: String;
/**
*
*/
ScheduleAssociationState?: ScheduleState;
}
export interface ClusterCredentials {
/**
* A database user name that is authorized to log on to the database DbName using the password DbPassword. If the specified DbUser exists in the database, the new user name has the same database privileges as the the user named in DbUser. By default, the user is added to PUBLIC. If the DbGroups parameter is specifed, DbUser is added to the listed groups for any sessions created using these credentials.
*/
DbUser?: String;
/**
* A temporary password that authorizes the user name returned by DbUser to log on to the database DbName.
*/
DbPassword?: SensitiveString;
/**
* The date and time the password in DbPassword expires.
*/
Expiration?: TStamp;
}
export interface ClusterDbRevision {
/**
* The unique identifier of the cluster.
*/
ClusterIdentifier?: String;
/**
* A string representing the current cluster version.
*/
CurrentDatabaseRevision?: String;
/**
* The date on which the database revision was released.
*/
DatabaseRevisionReleaseDate?: TStamp;
/**
* A list of RevisionTarget objects, where each object describes the database revision that a cluster can be updated to.
*/
RevisionTargets?: RevisionTargetsList;
}
export type ClusterDbRevisionsList = ClusterDbRevision[];
export interface ClusterDbRevisionsMessage {
/**
* A string representing the starting point for the next set of revisions. If a value is returned in a response, you can retrieve the next set of revisions by providing the value in the marker parameter and retrying the command. If the marker field is empty, all revisions have already been returned.
*/
Marker?: String;
/**
* A list of revisions.
*/
ClusterDbRevisions?: ClusterDbRevisionsList;
}
export interface ClusterIamRole {
/**
* The Amazon Resource Name (ARN) of the IAM role, for example, arn:aws:iam::123456789012:role/RedshiftCopyUnload.
*/
IamRoleArn?: String;
/**
* A value that describes the status of the IAM role's association with an Amazon Redshift cluster. The following are possible statuses and descriptions. in-sync: The role is available for use by the cluster. adding: The role is in the process of being associated with the cluster. removing: The role is in the process of being disassociated with the cluster.
*/
ApplyStatus?: String;
}
export type ClusterIamRoleList = ClusterIamRole[];
export type ClusterList = Cluster[];
export interface ClusterNode {
/**
* Whether the node is a leader node or a compute node.
*/
NodeRole?: String;
/**
* The private IP address of a node within a cluster.
*/
PrivateIPAddress?: String;
/**
* The public IP address of a node within a cluster.
*/
PublicIPAddress?: String;
}
export type ClusterNodesList = ClusterNode[];
export interface ClusterParameterGroup {
/**
* The name of the cluster parameter group.
*/
ParameterGroupName?: String;
/**
* The name of the cluster parameter group family that this cluster parameter group is compatible with.
*/
ParameterGroupFamily?: String;
/**
* The description of the parameter group.
*/
Description?: String;
/**
* The list of tags for the cluster parameter group.
*/
Tags?: TagList;
}
export interface ClusterParameterGroupDetails {
/**
* A list of Parameter instances. Each instance lists the parameters of one cluster parameter group.
*/
Parameters?: ParametersList;
/**
* A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the Marker parameter and retrying the command. If the Marker field is empty, all response records have been retrieved for the request.
*/
Marker?: String;
}
export interface ClusterParameterGroupNameMessage {
/**
* The name of the cluster parameter group.
*/
ParameterGroupName?: String;
/**
* The status of the parameter group. For example, if you made a change to a parameter group name-value pair, then the change could be pending a reboot of an associated cluster.
*/
ParameterGroupStatus?: String;
}
export interface ClusterParameterGroupStatus {
/**
* The name of the cluster parameter group.
*/
ParameterGroupName?: String;
/**
* The status of parameter updates.
*/
ParameterApplyStatus?: String;
/**
* The list of parameter statuses. For more information about parameters and parameter groups, go to Amazon Redshift Parameter Groups in the Amazon Redshift Cluster Management Guide.
*/
ClusterParameterStatusList?: ClusterParameterStatusList;
}
export type ClusterParameterGroupStatusList = ClusterParameterGroupStatus[];
export interface ClusterParameterGroupsMessage {
/**
* A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the Marker parameter and retrying the command. If the Marker field is empty, all response records have been retrieved for the request.
*/
Marker?: String;
/**
* A list of ClusterParameterGroup instances. Each instance describes one cluster parameter group.
*/
ParameterGroups?: ParameterGroupList;
}
export interface ClusterParameterStatus {
/**
* The name of the parameter.
*/
ParameterName?: String;
/**
* The status of the parameter that indicates whether the parameter is in sync with the database, waiting for a cluster reboot, or encountered an error when being applied. The following are possible statuses and descriptions. in-sync: The parameter value is in sync with the database. pending-reboot: The parameter value will be applied after the cluster reboots. applying: The parameter value is being applied to the database. invalid-parameter: Cannot apply the parameter value because it has an invalid value or syntax. apply-deferred: The parameter contains static property changes. The changes are deferred until the cluster reboots. apply-error: Cannot connect to the cluster. The parameter change will be applied after the cluster reboots. unknown-error: Cannot apply the parameter change right now. The change will be applied after the cluster reboots.
*/
ParameterApplyStatus?: String;
/**
* The error that prevented the parameter from being applied to the database.
*/
ParameterApplyErrorDescription?: String;
}
export type ClusterParameterStatusList = ClusterParameterStatus[];
export interface ClusterSecurityGroup {
/**
* The name of the cluster security group to which the operation was applied.
*/
ClusterSecurityGroupName?: String;
/**
* A description of the security group.
*/
Description?: String;
/**
* A list of EC2 security groups that are permitted to access clusters associated with this cluster security group.
*/
EC2SecurityGroups?: EC2SecurityGroupList;
/**
* A list of IP ranges (CIDR blocks) that are permitted to access clusters associated with this cluster security group.
*/
IPRanges?: IPRangeList;
/**
* The list of tags for the cluster security group.
*/
Tags?: TagList;
}
export interface ClusterSecurityGroupMembership {
/**
* The name of the cluster security group.
*/
ClusterSecurityGroupName?: String;
/**
* The status of the cluster security group.
*/
Status?: String;
}
export type ClusterSecurityGroupMembershipList = ClusterSecurityGroupMembership[];
export interface ClusterSecurityGroupMessage {
/**
* A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the Marker parameter and retrying the command. If the Marker field is empty, all response records have been retrieved for the request.
*/
Marker?: String;
/**
* A list of ClusterSecurityGroup instances.
*/
ClusterSecurityGroups?: ClusterSecurityGroups;
}
export type ClusterSecurityGroupNameList = String[];
export type ClusterSecurityGroups = ClusterSecurityGroup[];
export interface ClusterSnapshotCopyStatus {
/**
* The destination region that snapshots are automatically copied to when cross-region snapshot copy is enabled.
*/
DestinationRegion?: String;
/**
* The number of days that automated snapshots are retained in the destination region after they are copied from a source region.
*/
RetentionPeriod?: Long;
/**
* The number of days that automated snapshots are retained in the destination region after they are copied from a source region. If the value is -1, the manual snapshot is retained indefinitely. The value must be either -1 or an integer between 1 and 3,653.
*/
ManualSnapshotRetentionPeriod?: Integer;
/**
* The name of the snapshot copy grant.
*/
SnapshotCopyGrantName?: String;
}
export interface ClusterSubnetGroup {
/**
* The name of the cluster subnet group.
*/
ClusterSubnetGroupName?: String;
/**
* The description of the cluster subnet group.
*/
Description?: String;
/**
* The VPC ID of the cluster subnet group.
*/
VpcId?: String;
/**
* The status of the cluster subnet group. Possible values are Complete, Incomplete and Invalid.
*/
SubnetGroupStatus?: String;
/**
* A list of the VPC Subnet elements.
*/
Subnets?: SubnetList;
/**
* The list of tags for the cluster subnet group.
*/
Tags?: TagList;
}
export interface ClusterSubnetGroupMessage {
/**
* A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the Marker parameter and retrying the command. If the Marker field is empty, all response records have been retrieved for the request.
*/
Marker?: String;
/**
* A list of ClusterSubnetGroup instances.
*/
ClusterSubnetGroups?: ClusterSubnetGroups;
}
export type ClusterSubnetGroups = ClusterSubnetGroup[];
export interface ClusterVersion {
/**
* The version number used by the cluster.
*/
ClusterVersion?: String;
/**
* The name of the cluster parameter group family for the cluster.
*/
ClusterParameterGroupFamily?: String;
/**
* The description of the cluster version.
*/
Description?: String;
}
export type ClusterVersionList = ClusterVersion[];
export interface ClusterVersionsMessage {
/**
* A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the Marker parameter and retrying the command. If the Marker field is empty, all response records have been retrieved for the request.
*/
Marker?: String;
/**
* A list of Version elements.
*/
ClusterVersions?: ClusterVersionList;
}
export interface ClustersMessage {
/**
* A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the Marker parameter and retrying the command. If the Marker field is empty, all response records have been retrieved for the request.
*/
Marker?: String;
/**
* A list of Cluster objects, where each object describes one cluster.
*/
Clusters?: ClusterList;
}
export interface CopyClusterSnapshotMessage {
/**
* The identifier for the source snapshot. Constraints: Must be the identifier for a valid automated snapshot whose state is available.
*/
SourceSnapshotIdentifier: String;
/**
* The identifier of the cluster the source snapshot was created from. This parameter is required if your IAM user has a policy containing a snapshot resource element that specifies anything other than * for the cluster name. Constraints: Must be the identifier for a valid cluster.
*/
SourceSnapshotClusterIdentifier?: String;
/**
* The identifier given to the new manual snapshot. Constraints: Cannot be null, empty, or blank. Must contain from 1 to 255 alphanumeric characters or hyphens. First character must be a letter. Cannot end with a hyphen or contain two consecutive hyphens. Must be unique for the AWS account that is making the request.
*/
TargetSnapshotIdentifier: String;
/**
* The number of days that a manual snapshot is retained. If the value is -1, the manual snapshot is retained indefinitely. The value must be either -1 or an integer between 1 and 3,653. The default value is -1.
*/
ManualSnapshotRetentionPeriod?: IntegerOptional;
}
export interface CopyClusterSnapshotResult {
Snapshot?: Snapshot;
}
export interface CreateClusterMessage {
/**
* The name of the first database to be created when the cluster is created. To create additional databases after the cluster is created, connect to the cluster with a SQL client and use SQL commands to create a database. For more information, go to Create a Database in the Amazon Redshift Database Developer Guide. Default: dev Constraints: Must contain 1 to 64 alphanumeric characters. Must contain only lowercase letters. Cannot be a word that is reserved by the service. A list of reserved words can be found in Reserved Words in the Amazon Redshift Database Developer Guide.
*/
DBName?: String;
/**
* A unique identifier for the cluster. You use this identifier to refer to the cluster for any subsequent cluster operations such as deleting or modifying. The identifier also appears in the Amazon Redshift console. Constraints: Must contain from 1 to 63 alphanumeric characters or hyphens. Alphabetic characters must be lowercase. First character must be a letter. Cannot end with a hyphen or contain two consecutive hyphens. Must be unique for all clusters within an AWS account. Example: myexamplecluster
*/
ClusterIdentifier: String;
/**
* The type of the cluster. When cluster type is specified as single-node, the NumberOfNodes parameter is not required. multi-node, the NumberOfNodes parameter is required. Valid Values: multi-node | single-node Default: multi-node
*/
ClusterType?: String;
/**
* The node type to be provisioned for the cluster. For information about node types, go to Working with Clusters in the Amazon Redshift Cluster Management Guide. Valid Values: ds2.xlarge | ds2.8xlarge | dc1.large | dc1.8xlarge | dc2.large | dc2.8xlarge | ra3.4xlarge | ra3.16xlarge
*/
NodeType: String;
/**
* The user name associated with the master user account for the cluster that is being created. Constraints: Must be 1 - 128 alphanumeric characters. The user name can't be PUBLIC. First character must be a letter. Cannot be a reserved word. A list of reserved words can be found in Reserved Words in the Amazon Redshift Database Developer Guide.
*/
MasterUsername: String;
/**
* The password associated with the master user account for the cluster that is being created. Constraints: Must be between 8 and 64 characters in length. Must contain at least one uppercase letter. Must contain at least one lowercase letter. Must contain one number. Can be any printable ASCII character (ASCII code 33 to 126) except ' (single quote), " (double quote), \, /, @, or space.
*/
MasterUserPassword: String;
/**
* A list of security groups to be associated with this cluster. Default: The default cluster security group for Amazon Redshift.
*/
ClusterSecurityGroups?: ClusterSecurityGroupNameList;
/**
* A list of Virtual Private Cloud (VPC) security groups to be associated with the cluster. Default: The default VPC security group is associated with the cluster.
*/
VpcSecurityGroupIds?: VpcSecurityGroupIdList;
/**
* The name of a cluster subnet group to be associated with this cluster. If this parameter is not provided the resulting cluster will be deployed outside virtual private cloud (VPC).
*/
ClusterSubnetGroupName?: String;
/**
* The EC2 Availability Zone (AZ) in which you want Amazon Redshift to provision the cluster. For example, if you have several EC2 instances running in a specific Availability Zone, then you might want the cluster to be provisioned in the same zone in order to decrease network latency. Default: A random, system-chosen Availability Zone in the region that is specified by the endpoint. Example: us-east-2d Constraint: The specified Availability Zone must be in the same region as the current endpoint.
*/
AvailabilityZone?: String;
/**
* The weekly time range (in UTC) during which automated cluster maintenance can occur. Format: ddd:hh24:mi-ddd:hh24:mi Default: A 30-minute window selected at random from an 8-hour block of time per region, occurring on a random day of the week. For more information about the time blocks for each region, see Maintenance Windows in Amazon Redshift Cluster Management Guide. Valid Days: Mon | Tue | Wed | Thu | Fri | Sat | Sun Constraints: Minimum 30-minute window.
*/
PreferredMaintenanceWindow?: String;
/**
* The name of the parameter group to be associated with this cluster. Default: The default Amazon Redshift cluster parameter group. For information about the default parameter group, go to Working with Amazon Redshift Parameter Groups Constraints: Must be 1 to 255 alphanumeric characters or hyphens. First character must be a letter. Cannot end with a hyphen or contain two consecutive hyphens.
*/
ClusterParameterGroupName?: String;
/**
* The number of days that automated snapshots are retained. If the value is 0, automated snapshots are disabled. Even if automated snapshots are disabled, you can still create manual snapshots when you want with CreateClusterSnapshot. Default: 1 Constraints: Must be a value from 0 to 35.
*/
AutomatedSnapshotRetentionPeriod?: IntegerOptional;
/**
* The default number of days to retain a manual snapshot. If the value is -1, the snapshot is retained indefinitely. This setting doesn't change the retention period of existing snapshots. The value must be either -1 or an integer between 1 and 3,653.
*/
ManualSnapshotRetentionPeriod?: IntegerOptional;
/**
* The port number on which the cluster accepts incoming connections. The cluster is accessible only via the JDBC and ODBC connection strings. Part of the connection string requires the port on which the cluster will listen for incoming connections. Default: 5439 Valid Values: 1150-65535
*/
Port?: IntegerOptional;
/**
* The version of the Amazon Redshift engine software that you want to deploy on the cluster. The version selected runs on all the nodes in the cluster. Constraints: Only version 1.0 is currently available. Example: 1.0
*/
ClusterVersion?: String;
/**
* If true, major version upgrades can be applied during the maintenance window to the Amazon Redshift engine that is running on the cluster. When a new major version of the Amazon Redshift engine is released, you can request that the service automatically apply upgrades during the maintenance window to the Amazon Redshift engine that is running on your cluster. Default: true
*/
AllowVersionUpgrade?: BooleanOptional;
/**
* The number of compute nodes in the cluster. This parameter is required when the ClusterType parameter is specified as multi-node. For information about determining how many nodes you need, go to Working with Clusters in the Amazon Redshift Cluster Management Guide. If you don't specify this parameter, you get a single-node cluster. When requesting a multi-node cluster, you must specify the number of nodes that you want in the cluster. Default: 1 Constraints: Value must be at least 1 and no more than 100.
*/
NumberOfNodes?: IntegerOptional;
/**
* If true, the cluster can be accessed from a public network.
*/
PubliclyAccessible?: BooleanOptional;
/**
* If true, the data in the cluster is encrypted at rest. Default: false
*/
Encrypted?: BooleanOptional;
/**
* Specifies the name of the HSM client certificate the Amazon Redshift cluster uses to retrieve the data encryption keys stored in an HSM.
*/
HsmClientCertificateIdentifier?: String;
/**
* Specifies the name of the HSM configuration that contains the information the Amazon Redshift cluster can use to retrieve and store keys in an HSM.
*/
HsmConfigurationIdentifier?: String;
/**
* The Elastic IP (EIP) address for the cluster. Constraints: The cluster must be provisioned in EC2-VPC and publicly-accessible through an Internet gateway. For more information about provisioning clusters in EC2-VPC, go to Supported Platforms to Launch Your Cluster in the Amazon Redshift Cluster Management Guide.
*/
ElasticIp?: String;
/**
* A list of tag instances.
*/
Tags?: TagList;
/**
* The AWS Key Management Service (KMS) key ID of the encryption key that you want to use to encrypt data in the cluster.
*/
KmsKeyId?: String;
/**
* An option that specifies whether to create the cluster with enhanced VPC routing enabled. To create a cluster that uses enhanced VPC routing, the cluster must be in a VPC. For more information, see Enhanced VPC Routing in the Amazon Redshift Cluster Management Guide. If this option is true, enhanced VPC routing is enabled. Default: false
*/
EnhancedVpcRouting?: BooleanOptional;
/**
* Reserved.
*/
AdditionalInfo?: String;
/**
* A list of AWS Identity and Access Management (IAM) roles that can be used by the cluster to access other AWS services. You must supply the IAM roles in their Amazon Resource Name (ARN) format. You can supply up to 10 IAM roles in a single request. A cluster can have up to 10 IAM roles associated with it at any time.
*/
IamRoles?: IamRoleArnList;
/**
* An optional parameter for the name of the maintenance track for the cluster. If you don't provide a maintenance track name, the cluster is assigned to the current track.
*/
MaintenanceTrackName?: String;
/**
* A unique identifier for the snapshot schedule.
*/
SnapshotScheduleIdentifier?: String;
}
export interface CreateClusterParameterGroupMessage {
/**
* The name of the cluster parameter group. Constraints: Must be 1 to 255 alphanumeric characters or hyphens First character must be a letter. Cannot end with a hyphen or contain two consecutive hyphens. Must be unique withing your AWS account. This value is stored as a lower-case string.
*/
ParameterGroupName: String;
/**
* The Amazon Redshift engine version to which the cluster parameter group applies. The cluster engine version determines the set of parameters. To get a list of valid parameter group family names, you can call DescribeClusterParameterGroups. By default, Amazon Redshift returns a list of all the parameter groups that are owned by your AWS account, including the default parameter groups for each Amazon Redshift engine version. The parameter group family names associated with the default parameter groups provide you the valid values. For example, a valid family name is "redshift-1.0".
*/
ParameterGroupFamily: String;
/**
* A description of the parameter group.
*/
Description: String;
/**
* A list of tag instances.
*/
Tags?: TagList;
}
export interface CreateClusterParameterGroupResult {
ClusterParameterGroup?: ClusterParameterGroup;
}
export interface CreateClusterResult {
Cluster?: Cluster;
}
export interface CreateClusterSecurityGroupMessage {
/**
* The name for the security group. Amazon Redshift stores the value as a lowercase string. Constraints: Must contain no more than 255 alphanumeric characters or hyphens. Must not be "Default". Must be unique for all security groups that are created by your AWS account. Example: examplesecuritygroup
*/
ClusterSecurityGroupName: String;
/**
* A description for the security group.
*/
Description: String;
/**
* A list of tag instances.
*/
Tags?: TagList;
}
export interface CreateClusterSecurityGroupResult {
ClusterSecurityGroup?: ClusterSecurityGroup;
}
export interface CreateClusterSnapshotMessage {
/**
* A unique identifier for the snapshot that you are requesting. This identifier must be unique for all snapshots within the AWS account. Constraints: Cannot be null, empty, or blank Must contain from 1 to 255 alphanumeric characters or hyphens First character must be a letter Cannot end with a hyphen or contain two consecutive hyphens Example: my-snapshot-id
*/
SnapshotIdentifier: String;
/**
* The cluster identifier for which you want a snapshot.
*/
ClusterIdentifier: String;
/**
* The number of days that a manual snapshot is retained. If the value is -1, the manual snapshot is retained indefinitely. The value must be either -1 or an integer between 1 and 3,653. The default value is -1.
*/
ManualSnapshotRetentionPeriod?: IntegerOptional;
/**
* A list of tag instances.
*/
Tags?: TagList;
}
export interface CreateClusterSnapshotResult {
Snapshot?: Snapshot;
}
export interface CreateClusterSubnetGroupMessage {
/**
* The name for the subnet group. Amazon Redshift stores the value as a lowercase string. Constraints: Must contain no more than 255 alphanumeric characters or hyphens. Must not be "Default". Must be unique for all subnet groups that are created by your AWS account. Example: examplesubnetgroup
*/
ClusterSubnetGroupName: String;
/**
* A description for the subnet group.
*/
Description: String;
/**
* An array of VPC subnet IDs. A maximum of 20 subnets can be modified in a single request.
*/
SubnetIds: SubnetIdentifierList;
/**
* A list of tag instances.
*/
Tags?: TagList;
}
export interface CreateClusterSubnetGroupResult {
ClusterSubnetGroup?: ClusterSubnetGroup;
}
export interface CreateEventSubscriptionMessage {
/**
* The name of the event subscription to be created. Constraints: Cannot be null, empty, or blank. Must contain from 1 to 255 alphanumeric characters or hyphens. First character must be a letter. Cannot end with a hyphen or contain two consecutive hyphens.
*/
SubscriptionName: String;
/**
* The Amazon Resource Name (ARN) of the Amazon SNS topic used to transmit the event notifications. The ARN is created by Amazon SNS when you create a topic and subscribe to it.
*/
SnsTopicArn: String;
/**
* The type of source that will be generating the events. For example, if you want to be notified of events generated by a cluster, you would set this parameter to cluster. If this value is not specified, events are returned for all Amazon Redshift objects in your AWS account. You must specify a source type in order to specify source IDs. Valid values: cluster, cluster-parameter-group, cluster-security-group, cluster-snapshot, and scheduled-action.
*/
SourceType?: String;
/**
* A list of one or more identifiers of Amazon Redshift source objects. All of the objects must be of the same type as was specified in the source type parameter. The event subscription will return only events generated by the specified objects. If not specified, then events are returned for all objects within the source type specified. Example: my-cluster-1, my-cluster-2 Example: my-snapshot-20131010
*/
SourceIds?: SourceIdsList;
/**
* Specifies the Amazon Redshift event categories to be published by the event notification subscription. Values: configuration, management, monitoring, security
*/
EventCategories?: EventCategoriesList;
/**
* Specifies the Amazon Redshift event severity to be published by the event notification subscription. Values: ERROR, INFO
*/
Severity?: String;
/**
* A boolean value; set to true to activate the subscription, and set to false to create the subscription but not activate it.
*/
Enabled?: BooleanOptional;
/**
* A list of tag instances.
*/
Tags?: TagList;
}
export interface CreateEventSubscriptionResult {
EventSubscription?: EventSubscription;
}
export interface CreateHsmClientCertificateMessage {
/**
* The identifier to be assigned to the new HSM client certificate that the cluster will use to connect to the HSM to use the database encryption keys.
*/
HsmClientCertificateIdentifier: String;
/**
* A list of tag instances.
*/
Tags?: TagList;
}
export interface CreateHsmClientCertificateResult {
HsmClientCertificate?: HsmClientCertificate;
}
export interface CreateHsmConfigurationMessage {
/**
* The identifier to be assigned to the new Amazon Redshift HSM configuration.
*/
HsmConfigurationIdentifier: String;
/**
* A text description of the HSM configuration to be created.
*/
Description: String;
/**
* The IP address that the Amazon Redshift cluster must use to access the HSM.
*/
HsmIpAddress: String;
/**
* The name of the partition in the HSM where the Amazon Redshift clusters will store their database encryption keys.
*/
HsmPartitionName: String;
/**
* The password required to access the HSM partition.
*/
HsmPartitionPassword: String;
/**
* The HSMs public certificate file. When using Cloud HSM, the file name is server.pem.
*/
HsmServerPublicCertificate: String;
/**
* A list of tag instances.
*/
Tags?: TagList;
}
export interface CreateHsmConfigurationResult {
HsmConfiguration?: HsmConfiguration;
}
export interface CreateScheduledActionMessage {
/**
* The name of the scheduled action. The name must be unique within an account. For more information about this parameter, see ScheduledAction.
*/
ScheduledActionName: String;
/**
* A JSON format string of the Amazon Redshift API operation with input parameters. For more information about this parameter, see ScheduledAction.
*/
TargetAction: ScheduledActionType;
/**
* The schedule in at( ) or cron( ) format. For more information about this parameter, see ScheduledAction.
*/
Schedule: String;
/**
* The IAM role to assume to run the target action. For more information about this parameter, see ScheduledAction.
*/
IamRole: String;
/**
* The description of the scheduled action.
*/
ScheduledActionDescription?: String;
/**
* The start time in UTC of the scheduled action. Before this time, the scheduled action does not trigger. For more information about this parameter, see ScheduledAction.
*/
StartTime?: TStamp;
/**
* The end time in UTC of the scheduled action. After this time, the scheduled action does not trigger. For more information about this parameter, see ScheduledAction.
*/
EndTime?: TStamp;
/**
* If true, the schedule is enabled. If false, the scheduled action does not trigger. For more information about state of the scheduled action, see ScheduledAction.
*/
Enable?: BooleanOptional;
}
export interface CreateSnapshotCopyGrantMessage {
/**
* The name of the snapshot copy grant. This name must be unique in the region for the AWS account. Constraints: Must contain from 1 to 63 alphanumeric characters or hyphens. Alphabetic characters must be lowercase. First character must be a letter. Cannot end with a hyphen or contain two consecutive hyphens. Must be unique for all clusters within an AWS account.
*/
SnapshotCopyGrantName: String;
/**
* The unique identifier of the customer master key (CMK) to which to grant Amazon Redshift permission. If no key is specified, the default key is used.
*/
KmsKeyId?: String;
/**
* A list of tag instances.
*/
Tags?: TagList;
}
export interface CreateSnapshotCopyGrantResult {
SnapshotCopyGrant?: SnapshotCopyGrant;
}
export interface CreateSnapshotScheduleMessage {
/**
* The definition of the snapshot schedule. The definition is made up of schedule expressions, for example "cron(30 12 *)" or "rate(12 hours)".
*/
ScheduleDefinitions?: ScheduleDefinitionList;
/**
* A unique identifier for a snapshot schedule. Only alphanumeric characters are allowed for the identifier.
*/
ScheduleIdentifier?: String;
/**
* The description of the snapshot schedule.
*/
ScheduleDescription?: String;
/**
* An optional set of tags you can use to search for the schedule.
*/
Tags?: TagList;
/**
*
*/
DryRun?: BooleanOptional;
/**
*
*/
NextInvocations?: IntegerOptional;
}
export interface CreateTagsMessage {
/**
* The Amazon Resource Name (ARN) to which you want to add the tag or tags. For example, arn:aws:redshift:us-east-2:123456789:cluster:t1.
*/
ResourceName: String;
/**
* One or more name/value pairs to add as tags to the specified resource. Each tag name is passed in with the parameter Key and the corresponding value is passed in with the parameter Value. The Key and Value parameters are separated by a comma (,). Separate multiple tags with a space. For example, --tags "Key"="owner","Value"="admin" "Key"="environment","Value"="test" "Key"="version","Value"="1.0".
*/
Tags: TagList;
}
export interface CreateUsageLimitMessage {
/**
* The identifier of the cluster that you want to limit usage.
*/
ClusterIdentifier: String;
/**
* The Amazon Redshift feature that you want to limit.
*/
FeatureType: UsageLimitFeatureType;
/**
* The type of limit. Depending on the feature type, this can be based on a time duration or data size. If FeatureType is spectrum, then LimitType must be data-scanned. If FeatureType is concurrency-scaling, then LimitType must be time.
*/
LimitType: UsageLimitLimitType;
/**
* The limit amount. If time-based, this amount is in minutes. If data-based, this amount is in terabytes (TB). The value must be a positive number.
*/
Amount: Long;
/**
* The time period that the amount applies to. A weekly period begins on Sunday. The default is monthly.
*/
Period?: UsageLimitPeriod;
/**
* The action that Amazon Redshift takes when the limit is reached. The default is log. For more information about this parameter, see UsageLimit.
*/
BreachAction?: UsageLimitBreachAction;
/**
* A list of tag instances.
*/
Tags?: TagList;
}
export interface CustomerStorageMessage {
/**
* The total amount of storage currently used for snapshots.
*/
TotalBackupSizeInMegaBytes?: Double;
/**
* The total amount of storage currently provisioned.
*/
TotalProvisionedStorageInMegaBytes?: Double;
}
export interface DataTransferProgress {
/**
* Describes the status of the cluster. While the transfer is in progress the status is transferringdata.
*/
Status?: String;
/**
* Describes the data transfer rate in MB's per second.
*/
CurrentRateInMegaBytesPerSecond?: DoubleOptional;
/**
* Describes the total amount of data to be transfered in megabytes.
*/
TotalDataInMegaBytes?: Long;
/**
* Describes the total amount of data that has been transfered in MB's.
*/
DataTransferredInMegaBytes?: Long;
/**
* Describes the estimated number of seconds remaining to complete the transfer.
*/
EstimatedTimeToCompletionInSeconds?: LongOptional;
/**
* Describes the number of seconds that have elapsed during the data transfer.
*/
ElapsedTimeInSeconds?: LongOptional;
}
export type DbGroupList = String[];
export interface DefaultClusterParameters {
/**
* The name of the cluster parameter group family to which the engine default parameters apply.
*/
ParameterGroupFamily?: String;
/**
* A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the Marker parameter and retrying the command. If the Marker field is empty, all response records have been retrieved for the request.
*/
Marker?: String;
/**
* The list of cluster default parameters.
*/
Parameters?: ParametersList;
}
export interface DeferredMaintenanceWindow {
/**
* A unique identifier for the maintenance window.
*/
DeferMaintenanceIdentifier?: String;
/**
* A timestamp for the beginning of the time period when we defer maintenance.
*/
DeferMaintenanceStartTime?: TStamp;
/**
* A timestamp for the end of the time period when we defer maintenance.
*/
DeferMaintenanceEndTime?: TStamp;
}
export type DeferredMaintenanceWindowsList = DeferredMaintenanceWindow[];
export interface DeleteClusterMessage {
/**
* The identifier of the cluster to be deleted. Constraints: Must contain lowercase characters. Must contain from 1 to 63 alphanumeric characters or hyphens. First character must be a letter. Cannot end with a hyphen or contain two consecutive hyphens.
*/
ClusterIdentifier: String;
/**
* Determines whether a final snapshot of the cluster is created before Amazon Redshift deletes the cluster. If true, a final cluster snapshot is not created. If false, a final cluster snapshot is created before the cluster is deleted. The FinalClusterSnapshotIdentifier parameter must be specified if SkipFinalClusterSnapshot is false. Default: false
*/
SkipFinalClusterSnapshot?: Boolean;
/**
* The identifier of the final snapshot that is to be created immediately before deleting the cluster. If this parameter is provided, SkipFinalClusterSnapshot must be false. Constraints: Must be 1 to 255 alphanumeric characters. First character must be a letter. Cannot end with a hyphen or contain two consecutive hyphens.
*/
FinalClusterSnapshotIdentifier?: String;
/**
* The number of days that a manual snapshot is retained. If the value is -1, the manual snapshot is retained indefinitely. The value must be either -1 or an integer between 1 and 3,653. The default value is -1.
*/
FinalClusterSnapshotRetentionPeriod?: IntegerOptional;
}
export interface DeleteClusterParameterGroupMessage {
/**
* The name of the parameter group to be deleted. Constraints: Must be the name of an existing cluster parameter group. Cannot delete a default cluster parameter group.
*/
ParameterGroupName: String;
}
export interface DeleteClusterResult {
Cluster?: Cluster;
}
export interface DeleteClusterSecurityGroupMessage {
/**
* The name of the cluster security group to be deleted.
*/
ClusterSecurityGroupName: String;
}
export interface DeleteClusterSnapshotMessage {
/**
* The unique identifier of the manual snapshot to be deleted. Constraints: Must be the name of an existing snapshot that is in the available, failed, or cancelled state.
*/
SnapshotIdentifier: String;
/**
* The unique identifier of the cluster the snapshot was created from. This parameter is required if your IAM user has a policy containing a snapshot resource element that specifies anything other than * for the cluster name. Constraints: Must be the name of valid cluster.
*/
SnapshotClusterIdentifier?: String;
}
export type DeleteClusterSnapshotMessageList = DeleteClusterSnapshotMessage[];
export interface DeleteClusterSnapshotResult {
Snapshot?: Snapshot;
}
export interface DeleteClusterSubnetGroupMessage {
/**
* The name of the cluster subnet group name to be deleted.
*/
ClusterSubnetGroupName: String;
}
export interface DeleteEventSubscriptionMessage {
/**
* The name of the Amazon Redshift event notification subscription to be deleted.
*/
SubscriptionName: String;
}
export interface DeleteHsmClientCertificateMessage {
/**
* The identifier of the HSM client certificate to be deleted.
*/
HsmClientCertificateIdentifier: String;
}
export interface DeleteHsmConfigurationMessage {
/**
* The identifier of the Amazon Redshift HSM configuration to be deleted.
*/
HsmConfigurationIdentifier: String;
}
export interface DeleteScheduledActionMessage {
/**
* The name of the scheduled action to delete.
*/
ScheduledActionName: String;
}
export interface DeleteSnapshotCopyGrantMessage {
/**
* The name of the snapshot copy grant to delete.
*/
SnapshotCopyGrantName: String;
}
export interface DeleteSnapshotScheduleMessage {
/**
* A unique identifier of the snapshot schedule to delete.
*/
ScheduleIdentifier: String;
}
export interface DeleteTagsMessage {
/**
* The Amazon Resource Name (ARN) from which you want to remove the tag or tags. For example, arn:aws:redshift:us-east-2:123456789:cluster:t1.
*/
ResourceName: String;
/**
* The tag key that you want to delete.
*/
TagKeys: TagKeyList;
}
export interface DeleteUsageLimitMessage {
/**
* The identifier of the usage limit to delete.
*/
UsageLimitId: String;
}
export interface DescribeAccountAttributesMessage {
/**
* A list of attribute names.
*/
AttributeNames?: AttributeNameList;
}
export interface DescribeClusterDbRevisionsMessage {
/**
* A unique identifier for a cluster whose ClusterDbRevisions you are requesting. This parameter is case sensitive. All clusters defined for an account are returned by default.
*/
ClusterIdentifier?: String;
/**
* The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in the marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the marker parameter and retrying the request. Default: 100 Constraints: minimum 20, maximum 100.
*/
MaxRecords?: IntegerOptional;
/**
* An optional parameter that specifies the starting point for returning a set of response records. When the results of a DescribeClusterDbRevisions request exceed the value specified in MaxRecords, Amazon Redshift returns a value in the marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the marker parameter and retrying the request. Constraints: You can specify either the ClusterIdentifier parameter, or the marker parameter, but not both.
*/
Marker?: String;
}
export interface DescribeClusterParameterGroupsMessage {
/**
* The name of a specific parameter group for which to return details. By default, details about all parameter groups and the default parameter group are returned.
*/
ParameterGroupName?: String;
/**
* The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value. Default: 100 Constraints: minimum 20, maximum 100.
*/
MaxRecords?: IntegerOptional;
/**
* An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterParameterGroups request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
*/
Marker?: String;
/**
* A tag key or keys for which you want to return all matching cluster parameter groups that are associated with the specified key or keys. For example, suppose that you have parameter groups that are tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the parameter groups that have either or both of these tag keys associated with them.
*/
TagKeys?: TagKeyList;
/**
* A tag value or values for which you want to return all matching cluster parameter groups that are associated with the specified tag value or values. For example, suppose that you have parameter groups that are tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with the parameter groups that have either or both of these tag values associated with them.
*/
TagValues?: TagValueList;
}
export interface DescribeClusterParametersMessage {
/**
* The name of a cluster parameter group for which to return details.
*/
ParameterGroupName: String;
/**
* The parameter types to return. Specify user to show parameters that are different form the default. Similarly, specify engine-default to show parameters that are the same as the default parameter group. Default: All parameter types returned. Valid Values: user | engine-default
*/
Source?: String;
/**
* The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value. Default: 100 Constraints: minimum 20, maximum 100.
*/
MaxRecords?: IntegerOptional;
/**
* An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterParameters request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
*/
Marker?: String;
}
export interface DescribeClusterSecurityGroupsMessage {
/**
* The name of a cluster security group for which you are requesting details. You can specify either the Marker parameter or a ClusterSecurityGroupName parameter, but not both. Example: securitygroup1
*/
ClusterSecurityGroupName?: String;
/**
* The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value. Default: 100 Constraints: minimum 20, maximum 100.
*/
MaxRecords?: IntegerOptional;
/**
* An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterSecurityGroups request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request. Constraints: You can specify either the ClusterSecurityGroupName parameter or the Marker parameter, but not both.
*/
Marker?: String;
/**
* A tag key or keys for which you want to return all matching cluster security groups that are associated with the specified key or keys. For example, suppose that you have security groups that are tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the security groups that have either or both of these tag keys associated with them.
*/
TagKeys?: TagKeyList;
/**
* A tag value or values for which you want to return all matching cluster security groups that are associated with the specified tag value or values. For example, suppose that you have security groups that are tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with the security groups that have either or both of these tag values associated with them.
*/
TagValues?: TagValueList;
}
export interface DescribeClusterSnapshotsMessage {
/**
* The identifier of the cluster which generated the requested snapshots.
*/
ClusterIdentifier?: String;
/**
* The snapshot identifier of the snapshot about which to return information.
*/
SnapshotIdentifier?: String;
/**
* The type of snapshots for which you are requesting information. By default, snapshots of all types are returned. Valid Values: automated | manual
*/
SnapshotType?: String;
/**
* A value that requests only snapshots created at or after the specified time. The time value is specified in ISO 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page. Example: 2012-07-16T18:00:00Z
*/
StartTime?: TStamp;
/**
* A time value that requests only snapshots created at or before the specified time. The time value is specified in ISO 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page. Example: 2012-07-16T18:00:00Z
*/
EndTime?: TStamp;
/**
* The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value. Default: 100 Constraints: minimum 20, maximum 100.
*/
MaxRecords?: IntegerOptional;
/**
* An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterSnapshots request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
*/
Marker?: String;
/**
* The AWS customer account used to create or copy the snapshot. Use this field to filter the results to snapshots owned by a particular account. To describe snapshots you own, either specify your AWS customer account, or do not specify the parameter.
*/
OwnerAccount?: String;
/**
* A tag key or keys for which you want to return all matching cluster snapshots that are associated with the specified key or keys. For example, suppose that you have snapshots that are tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the snapshots that have either or both of these tag keys associated with them.
*/
TagKeys?: TagKeyList;
/**
* A tag value or values for which you want to return all matching cluster snapshots that are associated with the specified tag value or values. For example, suppose that you have snapshots that are tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with the snapshots that have either or both of these tag values associated with them.
*/
TagValues?: TagValueList;
/**
* A value that indicates whether to return snapshots only for an existing cluster. You can perform table-level restore only by using a snapshot of an existing cluster, that is, a cluster that has not been deleted. Values for this parameter work as follows: If ClusterExists is set to true, ClusterIdentifier is required. If ClusterExists is set to false and ClusterIdentifier isn't specified, all snapshots associated with deleted clusters (orphaned snapshots) are returned. If ClusterExists is set to false and ClusterIdentifier is specified for a deleted cluster, snapshots associated with that cluster are returned. If ClusterExists is set to false and ClusterIdentifier is specified for an existing cluster, no snapshots are returned.
*/
ClusterExists?: BooleanOptional;
/**
*
*/
SortingEntities?: SnapshotSortingEntityList;
}
export interface DescribeClusterSubnetGroupsMessage {
/**
* The name of the cluster subnet group for which information is requested.
*/
ClusterSubnetGroupName?: String;
/**
* The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value. Default: 100 Constraints: minimum 20, maximum 100.
*/
MaxRecords?: IntegerOptional;
/**
* An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterSubnetGroups request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
*/
Marker?: String;
/**
* A tag key or keys for which you want to return all matching cluster subnet groups that are associated with the specified key or keys. For example, suppose that you have subnet groups that are tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the subnet groups that have either or both of these tag keys associated with them.
*/
TagKeys?: TagKeyList;
/**
* A tag value or values for which you want to return all matching cluster subnet groups that are associated with the specified tag value or values. For example, suppose that you have subnet groups that are tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with the subnet groups that have either or both of these tag values associated with them.
*/
TagValues?: TagValueList;
}
export interface DescribeClusterTracksMessage {
/**
* The name of the maintenance track.
*/
MaintenanceTrackName?: String;
/**
* An integer value for the maximum number of maintenance tracks to return.
*/
MaxRecords?: IntegerOptional;
/**
* An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterTracks request exceed the value specified in MaxRecords, Amazon Redshift returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
*/
Marker?: String;
}
export interface DescribeClusterVersionsMessage {
/**
* The specific cluster version to return. Example: 1.0
*/
ClusterVersion?: String;
/**
* The name of a specific cluster parameter group family to return details for. Constraints: Must be 1 to 255 alphanumeric characters First character must be a letter Cannot end with a hyphen or contain two consecutive hyphens
*/
ClusterParameterGroupFamily?: String;
/**
* The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value. Default: 100 Constraints: minimum 20, maximum 100.
*/
MaxRecords?: IntegerOptional;
/**
* An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterVersions request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
*/
Marker?: String;
}
export interface DescribeClustersMessage {
/**
* The unique identifier of a cluster whose properties you are requesting. This parameter is case sensitive. The default is that all clusters defined for an account are returned.
*/
ClusterIdentifier?: String;
/**
* The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value. Default: 100 Constraints: minimum 20, maximum 100.
*/
MaxRecords?: IntegerOptional;
/**
* An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusters request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request. Constraints: You can specify either the ClusterIdentifier parameter or the Marker parameter, but not both.
*/
Marker?: String;
/**
* A tag key or keys for which you want to return all matching clusters that are associated with the specified key or keys. For example, suppose that you have clusters that are tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the clusters that have either or both of these tag keys associated with them.
*/
TagKeys?: TagKeyList;
/**
* A tag value or values for which you want to return all matching clusters that are associated with the specified tag value or values. For example, suppose that you have clusters that are tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with the clusters that have either or both of these tag values associated with them.
*/
TagValues?: TagValueList;
}
export interface DescribeDefaultClusterParametersMessage {
/**
* The name of the cluster parameter group family.
*/
ParameterGroupFamily: String;
/**
* The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value. Default: 100 Constraints: minimum 20, maximum 100.
*/
MaxRecords?: IntegerOptional;
/**
* An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeDefaultClusterParameters request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
*/
Marker?: String;
}
export interface DescribeDefaultClusterParametersResult {
DefaultClusterParameters?: DefaultClusterParameters;
}
export interface DescribeEventCategoriesMessage {
/**
* The source type, such as cluster or parameter group, to which the described event categories apply. Valid values: cluster, cluster-snapshot, cluster-parameter-group, cluster-security-group, and scheduled-action.
*/
SourceType?: String;
}
export interface DescribeEventSubscriptionsMessage {
/**
* The name of the Amazon Redshift event notification subscription to be described.
*/
SubscriptionName?: String;
/**
* The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value. Default: 100 Constraints: minimum 20, maximum 100.
*/
MaxRecords?: IntegerOptional;
/**
* An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeEventSubscriptions request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
*/
Marker?: String;
/**
* A tag key or keys for which you want to return all matching event notification subscriptions that are associated with the specified key or keys. For example, suppose that you have subscriptions that are tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the subscriptions that have either or both of these tag keys associated with them.
*/
TagKeys?: TagKeyList;
/**
* A tag value or values for which you want to return all matching event notification subscriptions that are associated with the specified tag value or values. For example, suppose that you have subscriptions that are tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with the subscriptions that have either or both of these tag values associated with them.
*/
TagValues?: TagValueList;
}
export interface DescribeEventsMessage {
/**
* The identifier of the event source for which events will be returned. If this parameter is not specified, then all sources are included in the response. Constraints: If SourceIdentifier is supplied, SourceType must also be provided. Specify a cluster identifier when SourceType is cluster. Specify a cluster security group name when SourceType is cluster-security-group. Specify a cluster parameter group name when SourceType is cluster-parameter-group. Specify a cluster snapshot identifier when SourceType is cluster-snapshot.
*/
SourceIdentifier?: String;
/**
* The event source to retrieve events for. If no value is specified, all events are returned. Constraints: If SourceType is supplied, SourceIdentifier must also be provided. Specify cluster when SourceIdentifier is a cluster identifier. Specify cluster-security-group when SourceIdentifier is a cluster security group name. Specify cluster-parameter-group when SourceIdentifier is a cluster parameter group name. Specify cluster-snapshot when SourceIdentifier is a cluster snapshot identifier.
*/
SourceType?: SourceType;
/**
* The beginning of the time interval to retrieve events for, specified in ISO 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page. Example: 2009-07-08T18:00Z
*/
StartTime?: TStamp;
/**
* The end of the time interval for which to retrieve events, specified in ISO 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page. Example: 2009-07-08T18:00Z
*/
EndTime?: TStamp;
/**
* The number of minutes prior to the time of the request for which to retrieve events. For example, if the request is sent at 18:00 and you specify a duration of 60, then only events which have occurred after 17:00 will be returned. Default: 60
*/
Duration?: IntegerOptional;
/**
* The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value. Default: 100 Constraints: minimum 20, maximum 100.
*/
MaxRecords?: IntegerOptional;
/**
* An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeEvents request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
*/
Marker?: String;
}
export interface DescribeHsmClientCertificatesMessage {
/**
* The identifier of a specific HSM client certificate for which you want information. If no identifier is specified, information is returned for all HSM client certificates owned by your AWS customer account.
*/
HsmClientCertificateIdentifier?: String;
/**
* The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value. Default: 100 Constraints: minimum 20, maximum 100.
*/
MaxRecords?: IntegerOptional;
/**
* An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeHsmClientCertificates request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
*/
Marker?: String;
/**
* A tag key or keys for which you want to return all matching HSM client certificates that are associated with the specified key or keys. For example, suppose that you have HSM client certificates that are tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the HSM client certificates that have either or both of these tag keys associated with them.
*/
TagKeys?: TagKeyList;
/**
* A tag value or values for which you want to return all matching HSM client certificates that are associated with the specified tag value or values. For example, suppose that you have HSM client certificates that are tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with the HSM client certificates that have either or both of these tag values associated with them.
*/
TagValues?: TagValueList;
}
export interface DescribeHsmConfigurationsMessage {
/**
* The identifier of a specific Amazon Redshift HSM configuration to be described. If no identifier is specified, information is returned for all HSM configurations owned by your AWS customer account.
*/
HsmConfigurationIdentifier?: String;
/**
* The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value. Default: 100 Constraints: minimum 20, maximum 100.
*/
MaxRecords?: IntegerOptional;
/**
* An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeHsmConfigurations request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
*/
Marker?: String;
/**
* A tag key or keys for which you want to return all matching HSM configurations that are associated with the specified key or keys. For example, suppose that you have HSM configurations that are tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the HSM configurations that have either or both of these tag keys associated with them.
*/
TagKeys?: TagKeyList;
/**
* A tag value or values for which you want to return all matching HSM configurations that are associated with the specified tag value or values. For example, suppose that you have HSM configurations that are tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with the HSM configurations that have either or both of these tag values associated with them.
*/
TagValues?: TagValueList;
}
export interface DescribeLoggingStatusMessage {
/**
* The identifier of the cluster from which to get the logging status. Example: examplecluster
*/
ClusterIdentifier: String;
}
export interface DescribeNodeConfigurationOptionsMessage {
/**
* The action type to evaluate for possible node configurations. Specify "restore-cluster" to get configuration combinations based on an existing snapshot. Specify "recommend-node-config" to get configuration recommendations based on an existing cluster or snapshot. Specify "resize-cluster" to get configuration combinations for elastic resize based on an existing cluster.
*/
ActionType: ActionType;
/**
* The identifier of the cluster to evaluate for possible node configurations.
*/
ClusterIdentifier?: String;
/**
* The identifier of the snapshot to evaluate for possible node configurations.
*/
SnapshotIdentifier?: String;
/**
* The AWS customer account used to create or copy the snapshot. Required if you are restoring a snapshot you do not own, optional if you own the snapshot.
*/
OwnerAccount?: String;
/**
* A set of name, operator, and value items to filter the results.
*/
Filters?: NodeConfigurationOptionsFilterList;
/**
* An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeNodeConfigurationOptions request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
*/
Marker?: String;
/**
* The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value. Default: 500 Constraints: minimum 100, maximum 500.
*/
MaxRecords?: IntegerOptional;
}
export interface DescribeOrderableClusterOptionsMessage {
/**
* The version filter value. Specify this parameter to show only the available offerings matching the specified version. Default: All versions. Constraints: Must be one of the version returned from DescribeClusterVersions.
*/
ClusterVersion?: String;
/**
* The node type filter value. Specify this parameter to show only the available offerings matching the specified node type.
*/
NodeType?: String;
/**
* The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value. Default: 100 Constraints: minimum 20, maximum 100.
*/
MaxRecords?: IntegerOptional;
/**
* An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeOrderableClusterOptions request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
*/
Marker?: String;
}
export interface DescribeReservedNodeOfferingsMessage {
/**
* The unique identifier for the offering.
*/
ReservedNodeOfferingId?: String;
/**
* The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value. Default: 100 Constraints: minimum 20, maximum 100.
*/
MaxRecords?: IntegerOptional;
/**
* An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeReservedNodeOfferings request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
*/
Marker?: String;
}
export interface DescribeReservedNodesMessage {
/**
* Identifier for the node reservation.
*/
ReservedNodeId?: String;
/**
* The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value. Default: 100 Constraints: minimum 20, maximum 100.
*/
MaxRecords?: IntegerOptional;
/**
* An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeReservedNodes request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
*/
Marker?: String;
}
export interface DescribeResizeMessage {
/**
* The unique identifier of a cluster whose resize progress you are requesting. This parameter is case-sensitive. By default, resize operations for all clusters defined for an AWS account are returned.
*/
ClusterIdentifier: String;
}
export interface DescribeScheduledActionsMessage {
/**
* The name of the scheduled action to retrieve.
*/
ScheduledActionName?: String;
/**
* The type of the scheduled actions to retrieve.
*/
TargetActionType?: ScheduledActionTypeValues;
/**
* The start time in UTC of the scheduled actions to retrieve. Only active scheduled actions that have invocations after this time are retrieved.
*/
StartTime?: TStamp;
/**
* The end time in UTC of the scheduled action to retrieve. Only active scheduled actions that have invocations before this time are retrieved.
*/
EndTime?: TStamp;
/**
* If true, retrieve only active scheduled actions. If false, retrieve only disabled scheduled actions.
*/
Active?: BooleanOptional;
/**
* List of scheduled action filters.
*/
Filters?: ScheduledActionFilterList;
/**
* An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeScheduledActions request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
*/
Marker?: String;
/**
* The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value. Default: 100 Constraints: minimum 20, maximum 100.
*/
MaxRecords?: IntegerOptional;
}
export interface DescribeSnapshotCopyGrantsMessage {
/**
* The name of the snapshot copy grant.
*/
SnapshotCopyGrantName?: String;
/**
* The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value. Default: 100 Constraints: minimum 20, maximum 100.
*/
MaxRecords?: IntegerOptional;
/**
* An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeSnapshotCopyGrant request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request. Constraints: You can specify either the SnapshotCopyGrantName parameter or the Marker parameter, but not both.
*/
Marker?: String;
/**
* A tag key or keys for which you want to return all matching resources that are associated with the specified key or keys. For example, suppose that you have resources tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with all resources that have either or both of these tag keys associated with them.
*/
TagKeys?: TagKeyList;
/**
* A tag value or values for which you want to return all matching resources that are associated with the specified value or values. For example, suppose that you have resources tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with all resources that have either or both of these tag values associated with them.
*/
TagValues?: TagValueList;
}
export interface DescribeSnapshotSchedulesMessage {
/**
* The unique identifier for the cluster whose snapshot schedules you want to view.
*/
ClusterIdentifier?: String;
/**
* A unique identifier for a snapshot schedule.
*/
ScheduleIdentifier?: String;
/**
* The key value for a snapshot schedule tag.
*/
TagKeys?: TagKeyList;
/**
* The value corresponding to the key of the snapshot schedule tag.
*/
TagValues?: TagValueList;
/**
* A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the marker parameter and retrying the command. If the marker field is empty, all response records have been retrieved for the request.
*/
Marker?: String;
/**
* The maximum number or response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.
*/
MaxRecords?: IntegerOptional;
}
export interface DescribeSnapshotSchedulesOutputMessage {
/**
* A list of SnapshotSchedules.
*/
SnapshotSchedules?: SnapshotScheduleList;
/**
* A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the marker parameter and retrying the command. If the marker field is empty, all response records have been retrieved for the request.
*/
Marker?: String;
}
export interface DescribeTableRestoreStatusMessage {
/**
* The Amazon Redshift cluster that the table is being restored to.
*/
ClusterIdentifier?: String;
/**
* The identifier of the table restore request to return status for. If you don't specify a TableRestoreRequestId value, then DescribeTableRestoreStatus returns the status of all in-progress table restore requests.
*/
TableRestoreRequestId?: String;
/**
* The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.
*/
MaxRecords?: IntegerOptional;
/**
* An optional pagination token provided by a previous DescribeTableRestoreStatus request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by the MaxRecords parameter.
*/
Marker?: String;
}
export interface DescribeTagsMessage {
/**
* The Amazon Resource Name (ARN) for which you want to describe the tag or tags. For example, arn:aws:redshift:us-east-2:123456789:cluster:t1.
*/
ResourceName?: String;
/**
* The type of resource with which you want to view tags. Valid resource types are: Cluster CIDR/IP EC2 security group Snapshot Cluster security group Subnet group HSM connection HSM certificate Parameter group Snapshot copy grant For more information about Amazon Redshift resource types and constructing ARNs, go to Specifying Policy Elements: Actions, Effects, Resources, and Principals in the Amazon Redshift Cluster Management Guide.
*/
ResourceType?: String;
/**
* The maximum number or response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.
*/
MaxRecords?: IntegerOptional;
/**
* A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the marker parameter and retrying the command. If the marker field is empty, all response records have been retrieved for the request.
*/
Marker?: String;
/**
* A tag key or keys for which you want to return all matching resources that are associated with the specified key or keys. For example, suppose that you have resources tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with all resources that have either or both of these tag keys associated with them.
*/
TagKeys?: TagKeyList;
/**
* A tag value or values for which you want to return all matching resources that are associated with the specified value or values. For example, suppose that you have resources tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with all resources that have either or both of these tag values associated with them.
*/
TagValues?: TagValueList;
}
export interface DescribeUsageLimitsMessage {
/**
* The identifier of the usage limit to describe.
*/
UsageLimitId?: String;
/**
* The identifier of the cluster for which you want to describe usage limits.
*/
ClusterIdentifier?: String;
/**
* The feature type for which you want to describe usage limits.
*/
FeatureType?: UsageLimitFeatureType;
/**
* The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value. Default: 100 Constraints: minimum 20, maximum 100.
*/
MaxRecords?: IntegerOptional;
/**
* An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeUsageLimits request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
*/
Marker?: String;
/**
* A tag key or keys for which you want to return all matching usage limit objects that are associated with the specified key or keys. For example, suppose that you have parameter groups that are tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the usage limit objects have either or both of these tag keys associated with them.
*/
TagKeys?: TagKeyList;
/**
* A tag value or values for which you want to return all matching usage limit objects that are associated with the specified tag value or values. For example, suppose that you have parameter groups that are tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with the usage limit objects that have either or both of these tag values associated with them.
*/
TagValues?: TagValueList;
}
export interface DisableLoggingMessage {
/**
* The identifier of the cluster on which logging is to be stopped. Example: examplecluster
*/
ClusterIdentifier: String;
}
export interface DisableSnapshotCopyMessage {
/**
* The unique identifier of the source cluster that you want to disable copying of snapshots to a destination region. Constraints: Must be the valid name of an existing cluster that has cross-region snapshot copy enabled.
*/
ClusterIdentifier: String;
}
export interface DisableSnapshotCopyResult {
Cluster?: Cluster;
}
export type Double = number;
export type DoubleOptional = number;
export interface EC2SecurityGroup {
/**
* The status of the EC2 security group.
*/
Status?: String;
/**
* The name of the EC2 Security Group.
*/
EC2SecurityGroupName?: String;
/**
* The AWS ID of the owner of the EC2 security group specified in the EC2SecurityGroupName field.
*/
EC2SecurityGroupOwnerId?: String;
/**
* The list of tags for the EC2 security group.
*/
Tags?: TagList;
}
export type EC2SecurityGroupList = EC2SecurityGroup[];
export interface ElasticIpStatus {
/**
* The elastic IP (EIP) address for the cluster.
*/
ElasticIp?: String;
/**
* The status of the elastic IP (EIP) address.
*/
Status?: String;
}
export type EligibleTracksToUpdateList = UpdateTarget[];
export interface EnableLoggingMessage {
/**
* The identifier of the cluster on which logging is to be started. Example: examplecluster
*/
ClusterIdentifier: String;
/**
* The name of an existing S3 bucket where the log files are to be stored. Constraints: Must be in the same region as the cluster The cluster must have read bucket and put object permissions
*/
BucketName: String;
/**
* The prefix applied to the log file names. Constraints: Cannot exceed 512 characters Cannot contain spaces( ), double quotes ("), single quotes ('), a backslash (\), or control characters. The hexadecimal codes for invalid characters are: x00 to x20 x22 x27 x5c x7f or larger
*/
S3KeyPrefix?: String;
}
export interface EnableSnapshotCopyMessage {
/**
* The unique identifier of the source cluster to copy snapshots from. Constraints: Must be the valid name of an existing cluster that does not already have cross-region snapshot copy enabled.
*/
ClusterIdentifier: String;
/**
* The destination AWS Region that you want to copy snapshots to. Constraints: Must be the name of a valid AWS Region. For more information, see Regions and Endpoints in the Amazon Web Services General Reference.
*/
DestinationRegion: String;
/**
* The number of days to retain automated snapshots in the destination region after they are copied from the source region. Default: 7. Constraints: Must be at least 1 and no more than 35.
*/
RetentionPeriod?: IntegerOptional;
/**
* The name of the snapshot copy grant to use when snapshots of an AWS KMS-encrypted cluster are copied to the destination region.
*/
SnapshotCopyGrantName?: String;
/**
* The number of days to retain newly copied snapshots in the destination AWS Region after they are copied from the source AWS Region. If the value is -1, the manual snapshot is retained indefinitely. The value must be either -1 or an integer between 1 and 3,653.
*/
ManualSnapshotRetentionPeriod?: IntegerOptional;
}
export interface EnableSnapshotCopyResult {
Cluster?: Cluster;
}
export interface Endpoint {
/**
* The DNS address of the Cluster.
*/
Address?: String;
/**
* The port that the database engine is listening on.
*/
Port?: Integer;
}
export interface Event {
/**
* The identifier for the source of the event.
*/
SourceIdentifier?: String;
/**
* The source type for this event.
*/
SourceType?: SourceType;
/**
* The text of this event.
*/
Message?: String;
/**
* A list of the event categories. Values: Configuration, Management, Monitoring, Security
*/
EventCategories?: EventCategoriesList;
/**
* The severity of the event. Values: ERROR, INFO
*/
Severity?: String;
/**
* The date and time of the event.
*/
Date?: TStamp;
/**
* The identifier of the event.
*/
EventId?: String;
}
export type EventCategoriesList = String[];
export interface EventCategoriesMap {
/**
* The source type, such as cluster or cluster-snapshot, that the returned categories belong to.
*/
SourceType?: String;
/**
* The events in the event category.
*/
Events?: EventInfoMapList;
}
export type EventCategoriesMapList = EventCategoriesMap[];
export interface EventCategoriesMessage {
/**
* A list of event categories descriptions.
*/
EventCategoriesMapList?: EventCategoriesMapList;
}
export interface EventInfoMap {
/**
* The identifier of an Amazon Redshift event.
*/
EventId?: String;
/**
* The category of an Amazon Redshift event.
*/
EventCategories?: EventCategoriesList;
/**
* The description of an Amazon Redshift event.
*/
EventDescription?: String;
/**
* The severity of the event. Values: ERROR, INFO
*/
Severity?: String;
}
export type EventInfoMapList = EventInfoMap[];
export type EventList = Event[];
export interface EventSubscription {
/**
* The AWS customer account associated with the Amazon Redshift event notification subscription.
*/
CustomerAwsId?: String;
/**
* The name of the Amazon Redshift event notification subscription.
*/
CustSubscriptionId?: String;
/**
* The Amazon Resource Name (ARN) of the Amazon SNS topic used by the event notification subscription.
*/
SnsTopicArn?: String;
/**
* The status of the Amazon Redshift event notification subscription. Constraints: Can be one of the following: active | no-permission | topic-not-exist The status "no-permission" indicates that Amazon Redshift no longer has permission to post to the Amazon SNS topic. The status "topic-not-exist" indicates that the topic was deleted after the subscription was created.
*/
Status?: String;
/**
* The date and time the Amazon Redshift event notification subscription was created.
*/
SubscriptionCreationTime?: TStamp;
/**
* The source type of the events returned by the Amazon Redshift event notification, such as cluster, cluster-snapshot, cluster-parameter-group, cluster-security-group, or scheduled-action.
*/
SourceType?: String;
/**
* A list of the sources that publish events to the Amazon Redshift event notification subscription.
*/
SourceIdsList?: SourceIdsList;
/**
* The list of Amazon Redshift event categories specified in the event notification subscription. Values: Configuration, Management, Monitoring, Security
*/
EventCategoriesList?: EventCategoriesList;
/**
* The event severity specified in the Amazon Redshift event notification subscription. Values: ERROR, INFO
*/
Severity?: String;
/**
* A boolean value indicating whether the subscription is enabled; true indicates that the subscription is enabled.
*/
Enabled?: Boolean;
/**
* The list of tags for the event subscription.
*/
Tags?: TagList;
}
export type EventSubscriptionsList = EventSubscription[];
export interface EventSubscriptionsMessage {
/**
* A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the Marker parameter and retrying the command. If the Marker field is empty, all response records have been retrieved for the request.
*/
Marker?: String;
/**
* A list of event subscriptions.
*/
EventSubscriptionsList?: EventSubscriptionsList;
}
export interface EventsMessage {
/**
* A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the Marker parameter and retrying the command. If the Marker field is empty, all response records have been retrieved for the request.
*/
Marker?: String;
/**
* A list of Event instances.
*/
Events?: EventList;
}
export interface GetClusterCredentialsMessage {
/**
* The name of a database user. If a user name matching DbUser exists in the database, the temporary user credentials have the same permissions as the existing user. If DbUser doesn't exist in the database and Autocreate is True, a new user is created using the value for DbUser with PUBLIC permissions. If a database user matching the value for DbUser doesn't exist and Autocreate is False, then the command succeeds but the connection attempt will fail because the user doesn't exist in the database. For more information, see CREATE USER in the Amazon Redshift Database Developer Guide. Constraints: Must be 1 to 64 alphanumeric characters or hyphens. The user name can't be PUBLIC. Must contain only lowercase letters, numbers, underscore, plus sign, period (dot), at symbol (@), or hyphen. First character must be a letter. Must not contain a colon ( : ) or slash ( / ). Cannot be a reserved word. A list of reserved words can be found in Reserved Words in the Amazon Redshift Database Developer Guide.
*/
DbUser: String;
/**
* The name of a database that DbUser is authorized to log on to. If DbName is not specified, DbUser can log on to any existing database. Constraints: Must be 1 to 64 alphanumeric characters or hyphens Must contain only lowercase letters, numbers, underscore, plus sign, period (dot), at symbol (@), or hyphen. First character must be a letter. Must not contain a colon ( : ) or slash ( / ). Cannot be a reserved word. A list of reserved words can be found in Reserved Words in the Amazon Redshift Database Developer Guide.
*/
DbName?: String;
/**
* The unique identifier of the cluster that contains the database for which your are requesting credentials. This parameter is case sensitive.
*/
ClusterIdentifier: String;
/**
* The number of seconds until the returned temporary password expires. Constraint: minimum 900, maximum 3600. Default: 900
*/
DurationSeconds?: IntegerOptional;
/**
* Create a database user with the name specified for the user named in DbUser if one does not exist.
*/
AutoCreate?: BooleanOptional;
/**
* A list of the names of existing database groups that the user named in DbUser will join for the current session, in addition to any group memberships for an existing user. If not specified, a new user is added only to PUBLIC. Database group name constraints Must be 1 to 64 alphanumeric characters or hyphens Must contain only lowercase letters, numbers, underscore, plus sign, period (dot), at symbol (@), or hyphen. First character must be a letter. Must not contain a colon ( : ) or slash ( / ). Cannot be a reserved word. A list of reserved words can be found in Reserved Words in the Amazon Redshift Database Developer Guide.
*/
DbGroups?: DbGroupList;
}
export interface GetReservedNodeExchangeOfferingsInputMessage {
/**
* A string representing the node identifier for the DC1 Reserved Node to be exchanged.
*/
ReservedNodeId: String;
/**
* An integer setting the maximum number of ReservedNodeOfferings to retrieve.
*/
MaxRecords?: IntegerOptional;
/**
* A value that indicates the starting point for the next set of ReservedNodeOfferings.
*/
Marker?: String;
}
export interface GetReservedNodeExchangeOfferingsOutputMessage {
/**
* An optional parameter that specifies the starting point for returning a set of response records. When the results of a GetReservedNodeExchangeOfferings request exceed the value specified in MaxRecords, Amazon Redshift returns a value in the marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the marker parameter and retrying the request.
*/
Marker?: String;
/**
* Returns an array of ReservedNodeOffering objects.
*/
ReservedNodeOfferings?: ReservedNodeOfferingList;
}
export interface HsmClientCertificate {
/**
* The identifier of the HSM client certificate.
*/
HsmClientCertificateIdentifier?: String;
/**
* The public key that the Amazon Redshift cluster will use to connect to the HSM. You must register the public key in the HSM.
*/
HsmClientCertificatePublicKey?: String;
/**
* The list of tags for the HSM client certificate.
*/
Tags?: TagList;
}
export type HsmClientCertificateList = HsmClientCertificate[];
export interface HsmClientCertificateMessage {
/**
* A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the Marker parameter and retrying the command. If the Marker field is empty, all response records have been retrieved for the request.
*/
Marker?: String;
/**
* A list of the identifiers for one or more HSM client certificates used by Amazon Redshift clusters to store and retrieve database encryption keys in an HSM.
*/
HsmClientCertificates?: HsmClientCertificateList;
}
export interface HsmConfiguration {
/**
* The name of the Amazon Redshift HSM configuration.
*/
HsmConfigurationIdentifier?: String;
/**
* A text description of the HSM configuration.
*/
Description?: String;
/**
* The IP address that the Amazon Redshift cluster must use to access the HSM.
*/
HsmIpAddress?: String;
/**
* The name of the partition in the HSM where the Amazon Redshift clusters will store their database encryption keys.
*/
HsmPartitionName?: String;
/**
* The list of tags for the HSM configuration.
*/
Tags?: TagList;
}
export type HsmConfigurationList = HsmConfiguration[];
export interface HsmConfigurationMessage {
/**
* A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the Marker parameter and retrying the command. If the Marker field is empty, all response records have been retrieved for the request.
*/
Marker?: String;
/**
* A list of HsmConfiguration objects.
*/
HsmConfigurations?: HsmConfigurationList;
}
export interface HsmStatus {
/**
* Specifies the name of the HSM client certificate the Amazon Redshift cluster uses to retrieve the data encryption keys stored in an HSM.
*/
HsmClientCertificateIdentifier?: String;
/**
* Specifies the name of the HSM configuration that contains the information the Amazon Redshift cluster can use to retrieve and store keys in an HSM.
*/
HsmConfigurationIdentifier?: String;
/**
* Reports whether the Amazon Redshift cluster has finished applying any HSM settings changes specified in a modify cluster command. Values: active, applying
*/
Status?: String;
}
export interface IPRange {
/**
* The status of the IP range, for example, "authorized".
*/
Status?: String;
/**
* The IP range in Classless Inter-Domain Routing (CIDR) notation.
*/
CIDRIP?: String;
/**
* The list of tags for the IP range.
*/
Tags?: TagList;
}
export type IPRangeList = IPRange[];
export type IamRoleArnList = String[];
export type ImportTablesCompleted = String[];
export type ImportTablesInProgress = String[];
export type ImportTablesNotStarted = String[];
export type Integer = number;
export type IntegerOptional = number;
export interface LoggingStatus {
/**
* true if logging is on, false if logging is off.
*/
LoggingEnabled?: Boolean;
/**
* The name of the S3 bucket where the log files are stored.
*/
BucketName?: String;
/**
* The prefix applied to the log file names.
*/
S3KeyPrefix?: String;
/**
* The last time that logs were delivered.
*/
LastSuccessfulDeliveryTime?: TStamp;
/**
* The last time when logs failed to be delivered.
*/
LastFailureTime?: TStamp;
/**
* The message indicating that logs failed to be delivered.
*/
LastFailureMessage?: String;
}
export type Long = number;
export type LongOptional = number;
export interface MaintenanceTrack {
/**
* The name of the maintenance track. Possible values are current and trailing.
*/
MaintenanceTrackName?: String;
/**
* The version number for the cluster release.
*/
DatabaseVersion?: String;
/**
* An array of UpdateTarget objects to update with the maintenance track.
*/
UpdateTargets?: EligibleTracksToUpdateList;
}
export type Mode = "standard"|"high-performance"|string;
export interface ModifyClusterDbRevisionMessage {
/**
* The unique identifier of a cluster whose database revision you want to modify. Example: examplecluster
*/
ClusterIdentifier: String;
/**
* The identifier of the database revision. You can retrieve this value from the response to the DescribeClusterDbRevisions request.
*/
RevisionTarget: String;
}
export interface ModifyClusterDbRevisionResult {
Cluster?: Cluster;
}
export interface ModifyClusterIamRolesMessage {
/**
* The unique identifier of the cluster for which you want to associate or disassociate IAM roles.
*/
ClusterIdentifier: String;
/**
* Zero or more IAM roles to associate with the cluster. The roles must be in their Amazon Resource Name (ARN) format. You can associate up to 10 IAM roles with a single cluster in a single request.
*/
AddIamRoles?: IamRoleArnList;
/**
* Zero or more IAM roles in ARN format to disassociate from the cluster. You can disassociate up to 10 IAM roles from a single cluster in a single request.
*/
RemoveIamRoles?: IamRoleArnList;
}
export interface ModifyClusterIamRolesResult {
Cluster?: Cluster;
}
export interface ModifyClusterMaintenanceMessage {
/**
* A unique identifier for the cluster.
*/
ClusterIdentifier: String;
/**
* A boolean indicating whether to enable the deferred maintenance window.
*/
DeferMaintenance?: BooleanOptional;
/**
* A unique identifier for the deferred maintenance window.
*/
DeferMaintenanceIdentifier?: String;
/**
* A timestamp indicating the start time for the deferred maintenance window.
*/
DeferMaintenanceStartTime?: TStamp;
/**
* A timestamp indicating end time for the deferred maintenance window. If you specify an end time, you can't specify a duration.
*/
DeferMaintenanceEndTime?: TStamp;
/**
* An integer indicating the duration of the maintenance window in days. If you specify a duration, you can't specify an end time. The duration must be 45 days or less.
*/
DeferMaintenanceDuration?: IntegerOptional;
}
export interface ModifyClusterMaintenanceResult {
Cluster?: Cluster;
}
export interface ModifyClusterMessage {
/**
* The unique identifier of the cluster to be modified. Example: examplecluster
*/
ClusterIdentifier: String;
/**
* The new cluster type. When you submit your cluster resize request, your existing cluster goes into a read-only mode. After Amazon Redshift provisions a new cluster based on your resize requirements, there will be outage for a period while the old cluster is deleted and your connection is switched to the new cluster. You can use DescribeResize to track the progress of the resize request. Valid Values: multi-node | single-node
*/
ClusterType?: String;
/**
* The new node type of the cluster. If you specify a new node type, you must also specify the number of nodes parameter. For more information about resizing clusters, go to Resizing Clusters in Amazon Redshift in the Amazon Redshift Cluster Management Guide. Valid Values: ds2.xlarge | ds2.8xlarge | dc1.large | dc1.8xlarge | dc2.large | dc2.8xlarge | ra3.4xlarge | ra3.16xlarge
*/
NodeType?: String;
/**
* The new number of nodes of the cluster. If you specify a new number of nodes, you must also specify the node type parameter. For more information about resizing clusters, go to Resizing Clusters in Amazon Redshift in the Amazon Redshift Cluster Management Guide. Valid Values: Integer greater than 0.
*/
NumberOfNodes?: IntegerOptional;
/**
* A list of cluster security groups to be authorized on this cluster. This change is asynchronously applied as soon as possible. Security groups currently associated with the cluster, and not in the list of groups to apply, will be revoked from the cluster. Constraints: Must be 1 to 255 alphanumeric characters or hyphens First character must be a letter Cannot end with a hyphen or contain two consecutive hyphens
*/
ClusterSecurityGroups?: ClusterSecurityGroupNameList;
/**
* A list of virtual private cloud (VPC) security groups to be associated with the cluster. This change is asynchronously applied as soon as possible.
*/
VpcSecurityGroupIds?: VpcSecurityGroupIdList;
/**
* The new password for the cluster master user. This change is asynchronously applied as soon as possible. Between the time of the request and the completion of the request, the MasterUserPassword element exists in the PendingModifiedValues element of the operation response. Operations never return the password, so this operation provides a way to regain access to the master user account for a cluster if the password is lost. Default: Uses existing setting. Constraints: Must be between 8 and 64 characters in length. Must contain at least one uppercase letter. Must contain at least one lowercase letter. Must contain one number. Can be any printable ASCII character (ASCII code 33 to 126) except ' (single quote), " (double quote), \, /, @, or space.
*/
MasterUserPassword?: String;
/**
* The name of the cluster parameter group to apply to this cluster. This change is applied only after the cluster is rebooted. To reboot a cluster use RebootCluster. Default: Uses existing setting. Constraints: The cluster parameter group must be in the same parameter group family that matches the cluster version.
*/
ClusterParameterGroupName?: String;
/**
* The number of days that automated snapshots are retained. If the value is 0, automated snapshots are disabled. Even if automated snapshots are disabled, you can still create manual snapshots when you want with CreateClusterSnapshot. If you decrease the automated snapshot retention period from its current value, existing automated snapshots that fall outside of the new retention period will be immediately deleted. Default: Uses existing setting. Constraints: Must be a value from 0 to 35.
*/
AutomatedSnapshotRetentionPeriod?: IntegerOptional;
/**
* The default for number of days that a newly created manual snapshot is retained. If the value is -1, the manual snapshot is retained indefinitely. This value doesn't retroactively change the retention periods of existing manual snapshots. The value must be either -1 or an integer between 1 and 3,653. The default value is -1.
*/
ManualSnapshotRetentionPeriod?: IntegerOptional;
/**
* The weekly time range (in UTC) during which system maintenance can occur, if necessary. If system maintenance is necessary during the window, it may result in an outage. This maintenance window change is made immediately. If the new maintenance window indicates the current time, there must be at least 120 minutes between the current time and end of the window in order to ensure that pending changes are applied. Default: Uses existing setting. Format: ddd:hh24:mi-ddd:hh24:mi, for example wed:07:30-wed:08:00. Valid Days: Mon | Tue | Wed | Thu | Fri | Sat | Sun Constraints: Must be at least 30 minutes.
*/
PreferredMaintenanceWindow?: String;
/**
* The new version number of the Amazon Redshift engine to upgrade to. For major version upgrades, if a non-default cluster parameter group is currently in use, a new cluster parameter group in the cluster parameter group family for the new version must be specified. The new cluster parameter group can be the default for that cluster parameter group family. For more information about parameters and parameter groups, go to Amazon Redshift Parameter Groups in the Amazon Redshift Cluster Management Guide. Example: 1.0
*/
ClusterVersion?: String;
/**
* If true, major version upgrades will be applied automatically to the cluster during the maintenance window. Default: false
*/
AllowVersionUpgrade?: BooleanOptional;
/**
* Specifies the name of the HSM client certificate the Amazon Redshift cluster uses to retrieve the data encryption keys stored in an HSM.
*/
HsmClientCertificateIdentifier?: String;
/**
* Specifies the name of the HSM configuration that contains the information the Amazon Redshift cluster can use to retrieve and store keys in an HSM.
*/
HsmConfigurationIdentifier?: String;
/**
* The new identifier for the cluster. Constraints: Must contain from 1 to 63 alphanumeric characters or hyphens. Alphabetic characters must be lowercase. First character must be a letter. Cannot end with a hyphen or contain two consecutive hyphens. Must be unique for all clusters within an AWS account. Example: examplecluster
*/
NewClusterIdentifier?: String;
/**
* If true, the cluster can be accessed from a public network. Only clusters in VPCs can be set to be publicly available.
*/
PubliclyAccessible?: BooleanOptional;
/**
* The Elastic IP (EIP) address for the cluster. Constraints: The cluster must be provisioned in EC2-VPC and publicly-accessible through an Internet gateway. For more information about provisioning clusters in EC2-VPC, go to Supported Platforms to Launch Your Cluster in the Amazon Redshift Cluster Management Guide.
*/
ElasticIp?: String;
/**
* An option that specifies whether to create the cluster with enhanced VPC routing enabled. To create a cluster that uses enhanced VPC routing, the cluster must be in a VPC. For more information, see Enhanced VPC Routing in the Amazon Redshift Cluster Management Guide. If this option is true, enhanced VPC routing is enabled. Default: false
*/
EnhancedVpcRouting?: BooleanOptional;
/**
* The name for the maintenance track that you want to assign for the cluster. This name change is asynchronous. The new track name stays in the PendingModifiedValues for the cluster until the next maintenance window. When the maintenance track changes, the cluster is switched to the latest cluster release available for the maintenance track. At this point, the maintenance track name is applied.
*/
MaintenanceTrackName?: String;
/**
* Indicates whether the cluster is encrypted. If the value is encrypted (true) and you provide a value for the KmsKeyId parameter, we encrypt the cluster with the provided KmsKeyId. If you don't provide a KmsKeyId, we encrypt with the default key. In the China region we use legacy encryption if you specify that the cluster is encrypted. If the value is not encrypted (false), then the cluster is decrypted.
*/
Encrypted?: BooleanOptional;
/**
* The AWS Key Management Service (KMS) key ID of the encryption key that you want to use to encrypt data in the cluster.
*/
KmsKeyId?: String;
}
export interface ModifyClusterParameterGroupMessage {
/**
* The name of the parameter group to be modified.
*/
ParameterGroupName: String;
/**
* An array of parameters to be modified. A maximum of 20 parameters can be modified in a single request. For each parameter to be modified, you must supply at least the parameter name and parameter value; other name-value pairs of the parameter are optional. For the workload management (WLM) configuration, you must supply all the name-value pairs in the wlm_json_configuration parameter.
*/
Parameters: ParametersList;
}
export interface ModifyClusterResult {
Cluster?: Cluster;
}
export interface ModifyClusterSnapshotMessage {
/**
* The identifier of the snapshot whose setting you want to modify.
*/
SnapshotIdentifier: String;
/**
* The number of days that a manual snapshot is retained. If the value is -1, the manual snapshot is retained indefinitely. If the manual snapshot falls outside of the new retention period, you can specify the force option to immediately delete the snapshot. The value must be either -1 or an integer between 1 and 3,653.
*/
ManualSnapshotRetentionPeriod?: IntegerOptional;
/**
* A Boolean option to override an exception if the retention period has already passed.
*/
Force?: Boolean;
}
export interface ModifyClusterSnapshotResult {
Snapshot?: Snapshot;
}
export interface ModifyClusterSnapshotScheduleMessage {
/**
* A unique identifier for the cluster whose snapshot schedule you want to modify.
*/
ClusterIdentifier: String;
/**
* A unique alphanumeric identifier for the schedule that you want to associate with the cluster.
*/
ScheduleIdentifier?: String;
/**
* A boolean to indicate whether to remove the assoiciation between the cluster and the schedule.
*/
DisassociateSchedule?: BooleanOptional;
}
export interface ModifyClusterSubnetGroupMessage {
/**
* The name of the subnet group to be modified.
*/
ClusterSubnetGroupName: String;
/**
* A text description of the subnet group to be modified.
*/
Description?: String;
/**
* An array of VPC subnet IDs. A maximum of 20 subnets can be modified in a single request.
*/
SubnetIds: SubnetIdentifierList;
}
export interface ModifyClusterSubnetGroupResult {
ClusterSubnetGroup?: ClusterSubnetGroup;
}
export interface ModifyEventSubscriptionMessage {
/**
* The name of the modified Amazon Redshift event notification subscription.
*/
SubscriptionName: String;
/**
* The Amazon Resource Name (ARN) of the SNS topic to be used by the event notification subscription.
*/
SnsTopicArn?: String;
/**
* The type of source that will be generating the events. For example, if you want to be notified of events generated by a cluster, you would set this parameter to cluster. If this value is not specified, events are returned for all Amazon Redshift objects in your AWS account. You must specify a source type in order to specify source IDs. Valid values: cluster, cluster-parameter-group, cluster-security-group, cluster-snapshot, and scheduled-action.
*/
SourceType?: String;
/**
* A list of one or more identifiers of Amazon Redshift source objects. All of the objects must be of the same type as was specified in the source type parameter. The event subscription will return only events generated by the specified objects. If not specified, then events are returned for all objects within the source type specified. Example: my-cluster-1, my-cluster-2 Example: my-snapshot-20131010
*/
SourceIds?: SourceIdsList;
/**
* Specifies the Amazon Redshift event categories to be published by the event notification subscription. Values: configuration, management, monitoring, security
*/
EventCategories?: EventCategoriesList;
/**
* Specifies the Amazon Redshift event severity to be published by the event notification subscription. Values: ERROR, INFO
*/
Severity?: String;
/**
* A Boolean value indicating if the subscription is enabled. true indicates the subscription is enabled
*/
Enabled?: BooleanOptional;
}
export interface ModifyEventSubscriptionResult {
EventSubscription?: EventSubscription;
}
export interface ModifyScheduledActionMessage {
/**
* The name of the scheduled action to modify.
*/
ScheduledActionName: String;
/**
* A modified JSON format of the scheduled action. For more information about this parameter, see ScheduledAction.
*/
TargetAction?: ScheduledActionType;
/**
* A modified schedule in either at( ) or cron( ) format. For more information about this parameter, see ScheduledAction.
*/
Schedule?: String;
/**
* A different IAM role to assume to run the target action. For more information about this parameter, see ScheduledAction.
*/
IamRole?: String;
/**
* A modified description of the scheduled action.
*/
ScheduledActionDescription?: String;
/**
* A modified start time of the scheduled action. For more information about this parameter, see ScheduledAction.
*/
StartTime?: TStamp;
/**
* A modified end time of the scheduled action. For more information about this parameter, see ScheduledAction.
*/
EndTime?: TStamp;
/**
* A modified enable flag of the scheduled action. If true, the scheduled action is active. If false, the scheduled action is disabled.
*/
Enable?: BooleanOptional;
}
export interface ModifySnapshotCopyRetentionPeriodMessage {
/**
* The unique identifier of the cluster for which you want to change the retention period for either automated or manual snapshots that are copied to a destination AWS Region. Constraints: Must be the valid name of an existing cluster that has cross-region snapshot copy enabled.
*/
ClusterIdentifier: String;
/**
* The number of days to retain automated snapshots in the destination AWS Region after they are copied from the source AWS Region. By default, this only changes the retention period of copied automated snapshots. If you decrease the retention period for automated snapshots that are copied to a destination AWS Region, Amazon Redshift deletes any existing automated snapshots that were copied to the destination AWS Region and that fall outside of the new retention period. Constraints: Must be at least 1 and no more than 35 for automated snapshots. If you specify the manual option, only newly copied manual snapshots will have the new retention period. If you specify the value of -1 newly copied manual snapshots are retained indefinitely. Constraints: The number of days must be either -1 or an integer between 1 and 3,653 for manual snapshots.
*/
RetentionPeriod: Integer;
/**
* Indicates whether to apply the snapshot retention period to newly copied manual snapshots instead of automated snapshots.
*/
Manual?: Boolean;
}
export interface ModifySnapshotCopyRetentionPeriodResult {
Cluster?: Cluster;
}
export interface ModifySnapshotScheduleMessage {
/**
* A unique alphanumeric identifier of the schedule to modify.
*/
ScheduleIdentifier: String;
/**
* An updated list of schedule definitions. A schedule definition is made up of schedule expressions, for example, "cron(30 12 *)" or "rate(12 hours)".
*/
ScheduleDefinitions: ScheduleDefinitionList;
}
export interface ModifyUsageLimitMessage {
/**
* The identifier of the usage limit to modify.
*/
UsageLimitId: String;
/**
* The new limit amount. For more information about this parameter, see UsageLimit.
*/
Amount?: LongOptional;
/**
* The new action that Amazon Redshift takes when the limit is reached. For more information about this parameter, see UsageLimit.
*/
BreachAction?: UsageLimitBreachAction;
}
export interface NodeConfigurationOption {
/**
* The node type, such as, "ds2.8xlarge".
*/
NodeType?: String;
/**
* The number of nodes.
*/
NumberOfNodes?: Integer;
/**
* The estimated disk utilizaton percentage.
*/
EstimatedDiskUtilizationPercent?: DoubleOptional;
/**
* The category of the node configuration recommendation.
*/
Mode?: Mode;
}
export type NodeConfigurationOptionList = NodeConfigurationOption[];
export interface NodeConfigurationOptionsFilter {
/**
* The name of the element to filter.
*/
Name?: NodeConfigurationOptionsFilterName;
/**
* The filter operator. If filter Name is NodeType only the 'in' operator is supported. Provide one value to evaluate for 'eq', 'lt', 'le', 'gt', and 'ge'. Provide two values to evaluate for 'between'. Provide a list of values for 'in'.
*/
Operator?: OperatorType;
/**
* List of values. Compare Name using Operator to Values. If filter Name is NumberOfNodes, then values can range from 0 to 200. If filter Name is EstimatedDiskUtilizationPercent, then values can range from 0 to 100. For example, filter NumberOfNodes (name) GT (operator) 3 (values).
*/
Values?: ValueStringList;
}
export type NodeConfigurationOptionsFilterList = NodeConfigurationOptionsFilter[];
export type NodeConfigurationOptionsFilterName = "NodeType"|"NumberOfNodes"|"EstimatedDiskUtilizationPercent"|"Mode"|string;
export interface NodeConfigurationOptionsMessage {
/**
* A list of valid node configurations.
*/
NodeConfigurationOptionList?: NodeConfigurationOptionList;
/**
* A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the Marker parameter and retrying the command. If the Marker field is empty, all response records have been retrieved for the request.
*/
Marker?: String;
}
export type OperatorType = "eq"|"lt"|"gt"|"le"|"ge"|"in"|"between"|string;
export interface OrderableClusterOption {
/**
* The version of the orderable cluster.
*/
ClusterVersion?: String;
/**
* The cluster type, for example multi-node.
*/
ClusterType?: String;
/**
* The node type for the orderable cluster.
*/
NodeType?: String;
/**
* A list of availability zones for the orderable cluster.
*/
AvailabilityZones?: AvailabilityZoneList;
}
export type OrderableClusterOptionsList = OrderableClusterOption[];
export interface OrderableClusterOptionsMessage {
/**
* An OrderableClusterOption structure containing information about orderable options for the cluster.
*/
OrderableClusterOptions?: OrderableClusterOptionsList;
/**
* A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the Marker parameter and retrying the command. If the Marker field is empty, all response records have been retrieved for the request.
*/
Marker?: String;
}
export interface Parameter {
/**
* The name of the parameter.
*/
ParameterName?: String;
/**
* The value of the parameter.
*/
ParameterValue?: String;
/**
* A description of the parameter.
*/
Description?: String;
/**
* The source of the parameter value, such as "engine-default" or "user".
*/
Source?: String;
/**
* The data type of the parameter.
*/
DataType?: String;
/**
* The valid range of values for the parameter.
*/
AllowedValues?: String;
/**
* Specifies how to apply the WLM configuration parameter. Some properties can be applied dynamically, while other properties require that any associated clusters be rebooted for the configuration changes to be applied. For more information about parameters and parameter groups, go to Amazon Redshift Parameter Groups in the Amazon Redshift Cluster Management Guide.
*/
ApplyType?: ParameterApplyType;
/**
* If true, the parameter can be modified. Some parameters have security or operational implications that prevent them from being changed.
*/
IsModifiable?: Boolean;
/**
* The earliest engine version to which the parameter can apply.
*/
MinimumEngineVersion?: String;
}
export type ParameterApplyType = "static"|"dynamic"|string;
export type ParameterGroupList = ClusterParameterGroup[];
export type ParametersList = Parameter[];
export interface PauseClusterMessage {
/**
* The identifier of the cluster to be paused.
*/
ClusterIdentifier: String;
}
export interface PauseClusterResult {
Cluster?: Cluster;
}
export type PendingActionsList = String[];
export interface PendingModifiedValues {
/**
* The pending or in-progress change of the master user password for the cluster.
*/
MasterUserPassword?: String;
/**
* The pending or in-progress change of the cluster's node type.
*/
NodeType?: String;
/**
* The pending or in-progress change of the number of nodes in the cluster.
*/
NumberOfNodes?: IntegerOptional;
/**
* The pending or in-progress change of the cluster type.
*/
ClusterType?: String;
/**
* The pending or in-progress change of the service version.
*/
ClusterVersion?: String;
/**
* The pending or in-progress change of the automated snapshot retention period.
*/
AutomatedSnapshotRetentionPeriod?: IntegerOptional;
/**
* The pending or in-progress change of the new identifier for the cluster.
*/
ClusterIdentifier?: String;
/**
* The pending or in-progress change of the ability to connect to the cluster from the public network.
*/
PubliclyAccessible?: BooleanOptional;
/**
* An option that specifies whether to create the cluster with enhanced VPC routing enabled. To create a cluster that uses enhanced VPC routing, the cluster must be in a VPC. For more information, see Enhanced VPC Routing in the Amazon Redshift Cluster Management Guide. If this option is true, enhanced VPC routing is enabled. Default: false
*/
EnhancedVpcRouting?: BooleanOptional;
/**
* The name of the maintenance track that the cluster will change to during the next maintenance window.
*/
MaintenanceTrackName?: String;
/**
* The encryption type for a cluster. Possible values are: KMS and None. For the China region the possible values are None, and Legacy.
*/
EncryptionType?: String;
}
export interface PurchaseReservedNodeOfferingMessage {
/**
* The unique identifier of the reserved node offering you want to purchase.
*/
ReservedNodeOfferingId: String;
/**
* The number of reserved nodes that you want to purchase. Default: 1
*/
NodeCount?: IntegerOptional;
}
export interface PurchaseReservedNodeOfferingResult {
ReservedNode?: ReservedNode;
}
export interface RebootClusterMessage {
/**
* The cluster identifier.
*/
ClusterIdentifier: String;
}
export interface RebootClusterResult {
Cluster?: Cluster;
}
export interface RecurringCharge {
/**
* The amount charged per the period of time specified by the recurring charge frequency.
*/
RecurringChargeAmount?: Double;
/**
* The frequency at which the recurring charge amount is applied.
*/
RecurringChargeFrequency?: String;
}
export type RecurringChargeList = RecurringCharge[];
export interface ReservedNode {
/**
* The unique identifier for the reservation.
*/
ReservedNodeId?: String;
/**
* The identifier for the reserved node offering.
*/
ReservedNodeOfferingId?: String;
/**
* The node type of the reserved node.
*/
NodeType?: String;
/**
* The time the reservation started. You purchase a reserved node offering for a duration. This is the start time of that duration.
*/
StartTime?: TStamp;
/**
* The duration of the node reservation in seconds.
*/
Duration?: Integer;
/**
* The fixed cost Amazon Redshift charges you for this reserved node.
*/
FixedPrice?: Double;
/**
* The hourly rate Amazon Redshift charges you for this reserved node.
*/
UsagePrice?: Double;
/**
* The currency code for the reserved cluster.
*/
CurrencyCode?: String;
/**
* The number of reserved compute nodes.
*/
NodeCount?: Integer;
/**
* The state of the reserved compute node. Possible Values: pending-payment-This reserved node has recently been purchased, and the sale has been approved, but payment has not yet been confirmed. active-This reserved node is owned by the caller and is available for use. payment-failed-Payment failed for the purchase attempt. retired-The reserved node is no longer available. exchanging-The owner is exchanging the reserved node for another reserved node.
*/
State?: String;
/**
* The anticipated utilization of the reserved node, as defined in the reserved node offering.
*/
OfferingType?: String;
/**
* The recurring charges for the reserved node.
*/
RecurringCharges?: RecurringChargeList;
/**
*
*/
ReservedNodeOfferingType?: ReservedNodeOfferingType;
}
export type ReservedNodeList = ReservedNode[];
export interface ReservedNodeOffering {
/**
* The offering identifier.
*/
ReservedNodeOfferingId?: String;
/**
* The node type offered by the reserved node offering.
*/
NodeType?: String;
/**
* The duration, in seconds, for which the offering will reserve the node.
*/
Duration?: Integer;
/**
* The upfront fixed charge you will pay to purchase the specific reserved node offering.
*/
FixedPrice?: Double;
/**
* The rate you are charged for each hour the cluster that is using the offering is running.
*/
UsagePrice?: Double;
/**
* The currency code for the compute nodes offering.
*/
CurrencyCode?: String;
/**
* The anticipated utilization of the reserved node, as defined in the reserved node offering.
*/
OfferingType?: String;
/**
* The charge to your account regardless of whether you are creating any clusters using the node offering. Recurring charges are only in effect for heavy-utilization reserved nodes.
*/
RecurringCharges?: RecurringChargeList;
/**
*
*/
ReservedNodeOfferingType?: ReservedNodeOfferingType;
}
export type ReservedNodeOfferingList = ReservedNodeOffering[];
export type ReservedNodeOfferingType = "Regular"|"Upgradable"|string;
export interface ReservedNodeOfferingsMessage {
/**
* A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the Marker parameter and retrying the command. If the Marker field is empty, all response records have been retrieved for the request.
*/
Marker?: String;
/**
* A list of ReservedNodeOffering objects.
*/
ReservedNodeOfferings?: ReservedNodeOfferingList;
}
export interface ReservedNodesMessage {
/**
* A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the Marker parameter and retrying the command. If the Marker field is empty, all response records have been retrieved for the request.
*/
Marker?: String;
/**
* The list of ReservedNode objects.
*/
ReservedNodes?: ReservedNodeList;
}
export interface ResetClusterParameterGroupMessage {
/**
* The name of the cluster parameter group to be reset.
*/
ParameterGroupName: String;
/**
* If true, all parameters in the specified parameter group will be reset to their default values. Default: true
*/
ResetAllParameters?: Boolean;
/**
* An array of names of parameters to be reset. If ResetAllParameters option is not used, then at least one parameter name must be supplied. Constraints: A maximum of 20 parameters can be reset in a single request.
*/
Parameters?: ParametersList;
}
export interface ResizeClusterMessage {
/**
* The unique identifier for the cluster to resize.
*/
ClusterIdentifier: String;
/**
* The new cluster type for the specified cluster.
*/
ClusterType?: String;
/**
* The new node type for the nodes you are adding. If not specified, the cluster's current node type is used.
*/
NodeType?: String;
/**
* The new number of nodes for the cluster.
*/
NumberOfNodes?: Integer;
/**
* A boolean value indicating whether the resize operation is using the classic resize process. If you don't provide this parameter or set the value to false, the resize type is elastic.
*/
Classic?: BooleanOptional;
}
export interface ResizeClusterResult {
Cluster?: Cluster;
}
export interface ResizeInfo {
/**
* Returns the value ClassicResize.
*/
ResizeType?: String;
/**
* A boolean value indicating if the resize operation can be cancelled.
*/
AllowCancelResize?: Boolean;
}
export interface ResizeProgressMessage {
/**
* The node type that the cluster will have after the resize operation is complete.
*/
TargetNodeType?: String;
/**
* The number of nodes that the cluster will have after the resize operation is complete.
*/
TargetNumberOfNodes?: IntegerOptional;
/**
* The cluster type after the resize operation is complete. Valid Values: multi-node | single-node
*/
TargetClusterType?: String;
/**
* The status of the resize operation. Valid Values: NONE | IN_PROGRESS | FAILED | SUCCEEDED | CANCELLING
*/
Status?: String;
/**
* The names of tables that have been completely imported . Valid Values: List of table names.
*/
ImportTablesCompleted?: ImportTablesCompleted;
/**
* The names of tables that are being currently imported. Valid Values: List of table names.
*/
ImportTablesInProgress?: ImportTablesInProgress;
/**
* The names of tables that have not been yet imported. Valid Values: List of table names
*/
ImportTablesNotStarted?: ImportTablesNotStarted;
/**
* The average rate of the resize operation over the last few minutes, measured in megabytes per second. After the resize operation completes, this value shows the average rate of the entire resize operation.
*/
AvgResizeRateInMegaBytesPerSecond?: DoubleOptional;
/**
* The estimated total amount of data, in megabytes, on the cluster before the resize operation began.
*/
TotalResizeDataInMegaBytes?: LongOptional;
/**
* While the resize operation is in progress, this value shows the current amount of data, in megabytes, that has been processed so far. When the resize operation is complete, this value shows the total amount of data, in megabytes, on the cluster, which may be more or less than TotalResizeDataInMegaBytes (the estimated total amount of data before resize).
*/
ProgressInMegaBytes?: LongOptional;
/**
* The amount of seconds that have elapsed since the resize operation began. After the resize operation completes, this value shows the total actual time, in seconds, for the resize operation.
*/
ElapsedTimeInSeconds?: LongOptional;
/**
* The estimated time remaining, in seconds, until the resize operation is complete. This value is calculated based on the average resize rate and the estimated amount of data remaining to be processed. Once the resize operation is complete, this value will be 0.
*/
EstimatedTimeToCompletionInSeconds?: LongOptional;
/**
* An enum with possible values of ClassicResize and ElasticResize. These values describe the type of resize operation being performed.
*/
ResizeType?: String;
/**
* An optional string to provide additional details about the resize action.
*/
Message?: String;
/**
* The type of encryption for the cluster after the resize is complete. Possible values are KMS and None. In the China region possible values are: Legacy and None.
*/
TargetEncryptionType?: String;
/**
* The percent of data transferred from source cluster to target cluster.
*/
DataTransferProgressPercent?: DoubleOptional;
}
export type RestorableNodeTypeList = String[];
export interface RestoreFromClusterSnapshotMessage {
/**
* The identifier of the cluster that will be created from restoring the snapshot. Constraints: Must contain from 1 to 63 alphanumeric characters or hyphens. Alphabetic characters must be lowercase. First character must be a letter. Cannot end with a hyphen or contain two consecutive hyphens. Must be unique for all clusters within an AWS account.
*/
ClusterIdentifier: String;
/**
* The name of the snapshot from which to create the new cluster. This parameter isn't case sensitive. Example: my-snapshot-id
*/
SnapshotIdentifier: String;
/**
* The name of the cluster the source snapshot was created from. This parameter is required if your IAM user has a policy containing a snapshot resource element that specifies anything other than * for the cluster name.
*/
SnapshotClusterIdentifier?: String;
/**
* The port number on which the cluster accepts connections. Default: The same port as the original cluster. Constraints: Must be between 1115 and 65535.
*/
Port?: IntegerOptional;
/**
* The Amazon EC2 Availability Zone in which to restore the cluster. Default: A random, system-chosen Availability Zone. Example: us-east-2a
*/
AvailabilityZone?: String;
/**
* If true, major version upgrades can be applied during the maintenance window to the Amazon Redshift engine that is running on the cluster. Default: true
*/
AllowVersionUpgrade?: BooleanOptional;
/**
* The name of the subnet group where you want to cluster restored. A snapshot of cluster in VPC can be restored only in VPC. Therefore, you must provide subnet group name where you want the cluster restored.
*/
ClusterSubnetGroupName?: String;
/**
* If true, the cluster can be accessed from a public network.
*/
PubliclyAccessible?: BooleanOptional;
/**
* The AWS customer account used to create or copy the snapshot. Required if you are restoring a snapshot you do not own, optional if you own the snapshot.
*/
OwnerAccount?: String;
/**
* Specifies the name of the HSM client certificate the Amazon Redshift cluster uses to retrieve the data encryption keys stored in an HSM.
*/
HsmClientCertificateIdentifier?: String;
/**
* Specifies the name of the HSM configuration that contains the information the Amazon Redshift cluster can use to retrieve and store keys in an HSM.
*/
HsmConfigurationIdentifier?: String;
/**
* The elastic IP (EIP) address for the cluster.
*/
ElasticIp?: String;
/**
* The name of the parameter group to be associated with this cluster. Default: The default Amazon Redshift cluster parameter group. For information about the default parameter group, go to Working with Amazon Redshift Parameter Groups. Constraints: Must be 1 to 255 alphanumeric characters or hyphens. First character must be a letter. Cannot end with a hyphen or contain two consecutive hyphens.
*/
ClusterParameterGroupName?: String;
/**
* A list of security groups to be associated with this cluster. Default: The default cluster security group for Amazon Redshift. Cluster security groups only apply to clusters outside of VPCs.
*/
ClusterSecurityGroups?: ClusterSecurityGroupNameList;
/**
* A list of Virtual Private Cloud (VPC) security groups to be associated with the cluster. Default: The default VPC security group is associated with the cluster. VPC security groups only apply to clusters in VPCs.
*/
VpcSecurityGroupIds?: VpcSecurityGroupIdList;
/**
* The weekly time range (in UTC) during which automated cluster maintenance can occur. Format: ddd:hh24:mi-ddd:hh24:mi Default: The value selected for the cluster from which the snapshot was taken. For more information about the time blocks for each region, see Maintenance Windows in Amazon Redshift Cluster Management Guide. Valid Days: Mon | Tue | Wed | Thu | Fri | Sat | Sun Constraints: Minimum 30-minute window.
*/
PreferredMaintenanceWindow?: String;
/**
* The number of days that automated snapshots are retained. If the value is 0, automated snapshots are disabled. Even if automated snapshots are disabled, you can still create manual snapshots when you want with CreateClusterSnapshot. Default: The value selected for the cluster from which the snapshot was taken. Constraints: Must be a value from 0 to 35.
*/
AutomatedSnapshotRetentionPeriod?: IntegerOptional;
/**
* The default number of days to retain a manual snapshot. If the value is -1, the snapshot is retained indefinitely. This setting doesn't change the retention period of existing snapshots. The value must be either -1 or an integer between 1 and 3,653.
*/
ManualSnapshotRetentionPeriod?: IntegerOptional;
/**
* The AWS Key Management Service (KMS) key ID of the encryption key that you want to use to encrypt data in the cluster that you restore from a shared snapshot.
*/
KmsKeyId?: String;
/**
* The node type that the restored cluster will be provisioned with. Default: The node type of the cluster from which the snapshot was taken. You can modify this if you are using any DS node type. In that case, you can choose to restore into another DS node type of the same size. For example, you can restore ds1.8xlarge into ds2.8xlarge, or ds1.xlarge into ds2.xlarge. If you have a DC instance type, you must restore into that same instance type and size. In other words, you can only restore a dc1.large instance type into another dc1.large instance type or dc2.large instance type. You can't restore dc1.8xlarge to dc2.8xlarge. First restore to a dc1.8xlarge cluster, then resize to a dc2.8large cluster. For more information about node types, see About Clusters and Nodes in the Amazon Redshift Cluster Management Guide.
*/
NodeType?: String;
/**
* An option that specifies whether to create the cluster with enhanced VPC routing enabled. To create a cluster that uses enhanced VPC routing, the cluster must be in a VPC. For more information, see Enhanced VPC Routing in the Amazon Redshift Cluster Management Guide. If this option is true, enhanced VPC routing is enabled. Default: false
*/
EnhancedVpcRouting?: BooleanOptional;
/**
* Reserved.
*/
AdditionalInfo?: String;
/**
* A list of AWS Identity and Access Management (IAM) roles that can be used by the cluster to access other AWS services. You must supply the IAM roles in their Amazon Resource Name (ARN) format. You can supply up to 10 IAM roles in a single request. A cluster can have up to 10 IAM roles associated at any time.
*/
IamRoles?: IamRoleArnList;
/**
* The name of the maintenance track for the restored cluster. When you take a snapshot, the snapshot inherits the MaintenanceTrack value from the cluster. The snapshot might be on a different track than the cluster that was the source for the snapshot. For example, suppose that you take a snapshot of a cluster that is on the current track and then change the cluster to be on the trailing track. In this case, the snapshot and the source cluster are on different tracks.
*/
MaintenanceTrackName?: String;
/**
* A unique identifier for the snapshot schedule.
*/
SnapshotScheduleIdentifier?: String;
/**
* The number of nodes specified when provisioning the restored cluster.
*/
NumberOfNodes?: IntegerOptional;
}
export interface RestoreFromClusterSnapshotResult {
Cluster?: Cluster;
}
export interface RestoreStatus {
/**
* The status of the restore action. Returns starting, restoring, completed, or failed.
*/
Status?: String;
/**
* The number of megabytes per second being transferred from the backup storage. Returns the average rate for a completed backup. This field is only updated when you restore to DC2 and DS2 node types.
*/
CurrentRestoreRateInMegaBytesPerSecond?: Double;
/**
* The size of the set of snapshot data used to restore the cluster. This field is only updated when you restore to DC2 and DS2 node types.
*/
SnapshotSizeInMegaBytes?: Long;
/**
* The number of megabytes that have been transferred from snapshot storage. This field is only updated when you restore to DC2 and DS2 node types.
*/
ProgressInMegaBytes?: Long;
/**
* The amount of time an in-progress restore has been running, or the amount of time it took a completed restore to finish. This field is only updated when you restore to DC2 and DS2 node types.
*/
ElapsedTimeInSeconds?: Long;
/**
* The estimate of the time remaining before the restore will complete. Returns 0 for a completed restore. This field is only updated when you restore to DC2 and DS2 node types.
*/
EstimatedTimeToCompletionInSeconds?: Long;
}
export interface RestoreTableFromClusterSnapshotMessage {
/**
* The identifier of the Amazon Redshift cluster to restore the table to.
*/
ClusterIdentifier: String;
/**
* The identifier of the snapshot to restore the table from. This snapshot must have been created from the Amazon Redshift cluster specified by the ClusterIdentifier parameter.
*/
SnapshotIdentifier: String;
/**
* The name of the source database that contains the table to restore from.
*/
SourceDatabaseName: String;
/**
* The name of the source schema that contains the table to restore from. If you do not specify a SourceSchemaName value, the default is public.
*/
SourceSchemaName?: String;
/**
* The name of the source table to restore from.
*/
SourceTableName: String;
/**
* The name of the database to restore the table to.
*/
TargetDatabaseName?: String;
/**
* The name of the schema to restore the table to.
*/
TargetSchemaName?: String;
/**
* The name of the table to create as a result of the current request.
*/
NewTableName: String;
}
export interface RestoreTableFromClusterSnapshotResult {
TableRestoreStatus?: TableRestoreStatus;
}
export interface ResumeClusterMessage {
/**
* The identifier of the cluster to be resumed.
*/
ClusterIdentifier: String;
}
export interface ResumeClusterResult {
Cluster?: Cluster;
}
export interface RevisionTarget {
/**
* A unique string that identifies the version to update the cluster to. You can use this value in ModifyClusterDbRevision.
*/
DatabaseRevision?: String;
/**
* A string that describes the changes and features that will be applied to the cluster when it is updated to the corresponding ClusterDbRevision.
*/
Description?: String;
/**
* The date on which the database revision was released.
*/
DatabaseRevisionReleaseDate?: TStamp;
}
export type RevisionTargetsList = RevisionTarget[];
export interface RevokeClusterSecurityGroupIngressMessage {
/**
* The name of the security Group from which to revoke the ingress rule.
*/
ClusterSecurityGroupName: String;
/**
* The IP range for which to revoke access. This range must be a valid Classless Inter-Domain Routing (CIDR) block of IP addresses. If CIDRIP is specified, EC2SecurityGroupName and EC2SecurityGroupOwnerId cannot be provided.
*/
CIDRIP?: String;
/**
* The name of the EC2 Security Group whose access is to be revoked. If EC2SecurityGroupName is specified, EC2SecurityGroupOwnerId must also be provided and CIDRIP cannot be provided.
*/
EC2SecurityGroupName?: String;
/**
* The AWS account number of the owner of the security group specified in the EC2SecurityGroupName parameter. The AWS access key ID is not an acceptable value. If EC2SecurityGroupOwnerId is specified, EC2SecurityGroupName must also be provided. and CIDRIP cannot be provided. Example: 111122223333
*/
EC2SecurityGroupOwnerId?: String;
}
export interface RevokeClusterSecurityGroupIngressResult {
ClusterSecurityGroup?: ClusterSecurityGroup;
}
export interface RevokeSnapshotAccessMessage {
/**
* The identifier of the snapshot that the account can no longer access.
*/
SnapshotIdentifier: String;
/**
* The identifier of the cluster the snapshot was created from. This parameter is required if your IAM user has a policy containing a snapshot resource element that specifies anything other than * for the cluster name.
*/
SnapshotClusterIdentifier?: String;
/**
* The identifier of the AWS customer account that can no longer restore the specified snapshot.
*/
AccountWithRestoreAccess: String;
}
export interface RevokeSnapshotAccessResult {
Snapshot?: Snapshot;
}
export interface RotateEncryptionKeyMessage {
/**
* The unique identifier of the cluster that you want to rotate the encryption keys for. Constraints: Must be the name of valid cluster that has encryption enabled.
*/
ClusterIdentifier: String;
}
export interface RotateEncryptionKeyResult {
Cluster?: Cluster;
}
export type ScheduleDefinitionList = String[];
export type ScheduleState = "MODIFYING"|"ACTIVE"|"FAILED"|string;
export interface ScheduledAction {
/**
* The name of the scheduled action.
*/
ScheduledActionName?: String;
/**
* A JSON format string of the Amazon Redshift API operation with input parameters. "{\"ResizeCluster\":{\"NodeType\":\"ds2.8xlarge\",\"ClusterIdentifier\":\"my-test-cluster\",\"NumberOfNodes\":3}}".
*/
TargetAction?: ScheduledActionType;
/**
* The schedule for a one-time (at format) or recurring (cron format) scheduled action. Schedule invocations must be separated by at least one hour. Format of at expressions is "at(yyyy-mm-ddThh:mm:ss)". For example, "at(2016-03-04T17:27:00)". Format of cron expressions is "cron(Minutes Hours Day-of-month Month Day-of-week Year)". For example, "cron(0 10 ? * MON *)". For more information, see Cron Expressions in the Amazon CloudWatch Events User Guide.
*/
Schedule?: String;
/**
* The IAM role to assume to run the scheduled action. This IAM role must have permission to run the Amazon Redshift API operation in the scheduled action. This IAM role must allow the Amazon Redshift scheduler (Principal scheduler.redshift.amazonaws.com) to assume permissions on your behalf. For more information about the IAM role to use with the Amazon Redshift scheduler, see Using Identity-Based Policies for Amazon Redshift in the Amazon Redshift Cluster Management Guide.
*/
IamRole?: String;
/**
* The description of the scheduled action.
*/
ScheduledActionDescription?: String;
/**
* The state of the scheduled action. For example, DISABLED.
*/
State?: ScheduledActionState;
/**
* List of times when the scheduled action will run.
*/
NextInvocations?: ScheduledActionTimeList;
/**
* The start time in UTC when the schedule is active. Before this time, the scheduled action does not trigger.
*/
StartTime?: TStamp;
/**
* The end time in UTC when the schedule is no longer active. After this time, the scheduled action does not trigger.
*/
EndTime?: TStamp;
}
export interface ScheduledActionFilter {
/**
* The type of element to filter.
*/
Name: ScheduledActionFilterName;
/**
* List of values. Compare if the value (of type defined by Name) equals an item in the list of scheduled actions.
*/
Values: ValueStringList;
}
export type ScheduledActionFilterList = ScheduledActionFilter[];
export type ScheduledActionFilterName = "cluster-identifier"|"iam-role"|string;
export type ScheduledActionList = ScheduledAction[];
export type ScheduledActionState = "ACTIVE"|"DISABLED"|string;
export type ScheduledActionTimeList = TStamp[];
export interface ScheduledActionType {
/**
* An action that runs a ResizeCluster API operation.
*/
ResizeCluster?: ResizeClusterMessage;
/**
* An action that runs a PauseCluster API operation.
*/
PauseCluster?: PauseClusterMessage;
/**
* An action that runs a ResumeCluster API operation.
*/
ResumeCluster?: ResumeClusterMessage;
}
export type ScheduledActionTypeValues = "ResizeCluster"|"PauseCluster"|"ResumeCluster"|string;
export interface ScheduledActionsMessage {
/**
* An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeScheduledActions request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
*/
Marker?: String;
/**
* List of retrieved scheduled actions.
*/
ScheduledActions?: ScheduledActionList;
}
export type ScheduledSnapshotTimeList = TStamp[];
export type SensitiveString = string;
export interface Snapshot {
/**
* The snapshot identifier that is provided in the request.
*/
SnapshotIdentifier?: String;
/**
* The identifier of the cluster for which the snapshot was taken.
*/
ClusterIdentifier?: String;
/**
* The time (in UTC format) when Amazon Redshift began the snapshot. A snapshot contains a copy of the cluster data as of this exact time.
*/
SnapshotCreateTime?: TStamp;
/**
* The snapshot status. The value of the status depends on the API operation used: CreateClusterSnapshot and CopyClusterSnapshot returns status as "creating". DescribeClusterSnapshots returns status as "creating", "available", "final snapshot", or "failed". DeleteClusterSnapshot returns status as "deleted".
*/
Status?: String;
/**
* The port that the cluster is listening on.
*/
Port?: Integer;
/**
* The Availability Zone in which the cluster was created.
*/
AvailabilityZone?: String;
/**
* The time (UTC) when the cluster was originally created.
*/
ClusterCreateTime?: TStamp;
/**
* The master user name for the cluster.
*/
MasterUsername?: String;
/**
* The version ID of the Amazon Redshift engine that is running on the cluster.
*/
ClusterVersion?: String;
/**
* The snapshot type. Snapshots created using CreateClusterSnapshot and CopyClusterSnapshot are of type "manual".
*/
SnapshotType?: String;
/**
* The node type of the nodes in the cluster.
*/
NodeType?: String;
/**
* The number of nodes in the cluster.
*/
NumberOfNodes?: Integer;
/**
* The name of the database that was created when the cluster was created.
*/
DBName?: String;
/**
* The VPC identifier of the cluster if the snapshot is from a cluster in a VPC. Otherwise, this field is not in the output.
*/
VpcId?: String;
/**
* If true, the data in the snapshot is encrypted at rest.
*/
Encrypted?: Boolean;
/**
* The AWS Key Management Service (KMS) key ID of the encryption key that was used to encrypt data in the cluster from which the snapshot was taken.
*/
KmsKeyId?: String;
/**
* A boolean that indicates whether the snapshot data is encrypted using the HSM keys of the source cluster. true indicates that the data is encrypted using HSM keys.
*/
EncryptedWithHSM?: Boolean;
/**
* A list of the AWS customer accounts authorized to restore the snapshot. Returns null if no accounts are authorized. Visible only to the snapshot owner.
*/
AccountsWithRestoreAccess?: AccountsWithRestoreAccessList;
/**
* For manual snapshots, the AWS customer account used to create or copy the snapshot. For automatic snapshots, the owner of the cluster. The owner can perform all snapshot actions, such as sharing a manual snapshot.
*/
OwnerAccount?: String;
/**
* The size of the complete set of backup data that would be used to restore the cluster.
*/
TotalBackupSizeInMegaBytes?: Double;
/**
* The size of the incremental backup.
*/
ActualIncrementalBackupSizeInMegaBytes?: Double;
/**
* The number of megabytes that have been transferred to the snapshot backup.
*/
BackupProgressInMegaBytes?: Double;
/**
* The number of megabytes per second being transferred to the snapshot backup. Returns 0 for a completed backup.
*/
CurrentBackupRateInMegaBytesPerSecond?: Double;
/**
* The estimate of the time remaining before the snapshot backup will complete. Returns 0 for a completed backup.
*/
EstimatedSecondsToCompletion?: Long;
/**
* The amount of time an in-progress snapshot backup has been running, or the amount of time it took a completed backup to finish.
*/
ElapsedTimeInSeconds?: Long;
/**
* The source region from which the snapshot was copied.
*/
SourceRegion?: String;
/**
* The list of tags for the cluster snapshot.
*/
Tags?: TagList;
/**
* The list of node types that this cluster snapshot is able to restore into.
*/
RestorableNodeTypes?: RestorableNodeTypeList;
/**
* An option that specifies whether to create the cluster with enhanced VPC routing enabled. To create a cluster that uses enhanced VPC routing, the cluster must be in a VPC. For more information, see Enhanced VPC Routing in the Amazon Redshift Cluster Management Guide. If this option is true, enhanced VPC routing is enabled. Default: false
*/
EnhancedVpcRouting?: Boolean;
/**
* The name of the maintenance track for the snapshot.
*/
MaintenanceTrackName?: String;
/**
* The number of days that a manual snapshot is retained. If the value is -1, the manual snapshot is retained indefinitely. The value must be either -1 or an integer between 1 and 3,653.
*/
ManualSnapshotRetentionPeriod?: IntegerOptional;
/**
* The number of days until a manual snapshot will pass its retention period.
*/
ManualSnapshotRemainingDays?: IntegerOptional;
/**
* A timestamp representing the start of the retention period for the snapshot.
*/
SnapshotRetentionStartTime?: TStamp;
}
export type SnapshotAttributeToSortBy = "SOURCE_TYPE"|"TOTAL_SIZE"|"CREATE_TIME"|string;
export interface SnapshotCopyGrant {
/**
* The name of the snapshot copy grant.
*/
SnapshotCopyGrantName?: String;
/**
* The unique identifier of the customer master key (CMK) in AWS KMS to which Amazon Redshift is granted permission.
*/
KmsKeyId?: String;
/**
* A list of tag instances.
*/
Tags?: TagList;
}
export type SnapshotCopyGrantList = SnapshotCopyGrant[];
export interface SnapshotCopyGrantMessage {
/**
* An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeSnapshotCopyGrant request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request. Constraints: You can specify either the SnapshotCopyGrantName parameter or the Marker parameter, but not both.
*/
Marker?: String;
/**
* The list of SnapshotCopyGrant objects.
*/
SnapshotCopyGrants?: SnapshotCopyGrantList;
}
export interface SnapshotErrorMessage {
/**
* A unique identifier for the snapshot returning the error.
*/
SnapshotIdentifier?: String;
/**
* A unique identifier for the cluster.
*/
SnapshotClusterIdentifier?: String;
/**
* The failure code for the error.
*/
FailureCode?: String;
/**
* The text message describing the error.
*/
FailureReason?: String;
}
export type SnapshotIdentifierList = String[];
export type SnapshotList = Snapshot[];
export interface SnapshotMessage {
/**
* A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the Marker parameter and retrying the command. If the Marker field is empty, all response records have been retrieved for the request.
*/
Marker?: String;
/**
* A list of Snapshot instances.
*/
Snapshots?: SnapshotList;
}
export interface SnapshotSchedule {
/**
* A list of ScheduleDefinitions.
*/
ScheduleDefinitions?: ScheduleDefinitionList;
/**
* A unique identifier for the schedule.
*/
ScheduleIdentifier?: String;
/**
* The description of the schedule.
*/
ScheduleDescription?: String;
/**
* An optional set of tags describing the schedule.
*/
Tags?: TagList;
/**
*
*/
NextInvocations?: ScheduledSnapshotTimeList;
/**
* The number of clusters associated with the schedule.
*/
AssociatedClusterCount?: IntegerOptional;
/**
* A list of clusters associated with the schedule. A maximum of 100 clusters is returned.
*/
AssociatedClusters?: AssociatedClusterList;
}
export type SnapshotScheduleList = SnapshotSchedule[];
export interface SnapshotSortingEntity {
/**
* The category for sorting the snapshots.
*/
Attribute: SnapshotAttributeToSortBy;
/**
* The order for listing the attributes.
*/
SortOrder?: SortByOrder;
}
export type SnapshotSortingEntityList = SnapshotSortingEntity[];
export type SortByOrder = "ASC"|"DESC"|string;
export type SourceIdsList = String[];
export type SourceType = "cluster"|"cluster-parameter-group"|"cluster-security-group"|"cluster-snapshot"|"scheduled-action"|string;
export type String = string;
export interface Subnet {
/**
* The identifier of the subnet.
*/
SubnetIdentifier?: String;
/**
*
*/
SubnetAvailabilityZone?: AvailabilityZone;
/**
* The status of the subnet.
*/
SubnetStatus?: String;
}
export type SubnetIdentifierList = String[];
export type SubnetList = Subnet[];
export interface SupportedOperation {
/**
* A list of the supported operations.
*/
OperationName?: String;
}
export type SupportedOperationList = SupportedOperation[];
export interface SupportedPlatform {
/**
*
*/
Name?: String;
}
export type SupportedPlatformsList = SupportedPlatform[];
export type TStamp = Date;
export interface TableRestoreStatus {
/**
* The unique identifier for the table restore request.
*/
TableRestoreRequestId?: String;
/**
* A value that describes the current state of the table restore request. Valid Values: SUCCEEDED, FAILED, CANCELED, PENDING, IN_PROGRESS
*/
Status?: TableRestoreStatusType;
/**
* A description of the status of the table restore request. Status values include SUCCEEDED, FAILED, CANCELED, PENDING, IN_PROGRESS.
*/
Message?: String;
/**
* The time that the table restore request was made, in Universal Coordinated Time (UTC).
*/
RequestTime?: TStamp;
/**
* The amount of data restored to the new table so far, in megabytes (MB).
*/
ProgressInMegaBytes?: LongOptional;
/**
* The total amount of data to restore to the new table, in megabytes (MB).
*/
TotalDataInMegaBytes?: LongOptional;
/**
* The identifier of the Amazon Redshift cluster that the table is being restored to.
*/
ClusterIdentifier?: String;
/**
* The identifier of the snapshot that the table is being restored from.
*/
SnapshotIdentifier?: String;
/**
* The name of the source database that contains the table being restored.
*/
SourceDatabaseName?: String;
/**
* The name of the source schema that contains the table being restored.
*/
SourceSchemaName?: String;
/**
* The name of the source table being restored.
*/
SourceTableName?: String;
/**
* The name of the database to restore the table to.
*/
TargetDatabaseName?: String;
/**
* The name of the schema to restore the table to.
*/
TargetSchemaName?: String;
/**
* The name of the table to create as a result of the table restore request.
*/
NewTableName?: String;
}
export type TableRestoreStatusList = TableRestoreStatus[];
export interface TableRestoreStatusMessage {
/**
* A list of status details for one or more table restore requests.
*/
TableRestoreStatusDetails?: TableRestoreStatusList;
/**
* A pagination token that can be used in a subsequent DescribeTableRestoreStatus request.
*/
Marker?: String;
}
export type TableRestoreStatusType = "PENDING"|"IN_PROGRESS"|"SUCCEEDED"|"FAILED"|"CANCELED"|string;
export interface Tag {
/**
* The key, or name, for the resource tag.
*/
Key?: String;
/**
* The value for the resource tag.
*/
Value?: String;
}
export type TagKeyList = String[];
export type TagList = Tag[];
export type TagValueList = String[];
export interface TaggedResource {
/**
* The tag for the resource.
*/
Tag?: Tag;
/**
* The Amazon Resource Name (ARN) with which the tag is associated, for example: arn:aws:redshift:us-east-2:123456789:cluster:t1.
*/
ResourceName?: String;
/**
* The type of resource with which the tag is associated. Valid resource types are: Cluster CIDR/IP EC2 security group Snapshot Cluster security group Subnet group HSM connection HSM certificate Parameter group For more information about Amazon Redshift resource types and constructing ARNs, go to Constructing an Amazon Redshift Amazon Resource Name (ARN) in the Amazon Redshift Cluster Management Guide.
*/
ResourceType?: String;
}
export type TaggedResourceList = TaggedResource[];
export interface TaggedResourceListMessage {
/**
* A list of tags with their associated resources.
*/
TaggedResources?: TaggedResourceList;
/**
* A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the Marker parameter and retrying the command. If the Marker field is empty, all response records have been retrieved for the request.
*/
Marker?: String;
}
export type TrackList = MaintenanceTrack[];
export interface TrackListMessage {
/**
* A list of maintenance tracks output by the DescribeClusterTracks operation.
*/
MaintenanceTracks?: TrackList;
/**
* The starting point to return a set of response tracklist records. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
*/
Marker?: String;
}
export interface UpdateTarget {
/**
* The name of the new maintenance track.
*/
MaintenanceTrackName?: String;
/**
* The cluster version for the new maintenance track.
*/
DatabaseVersion?: String;
/**
* A list of operations supported by the maintenance track.
*/
SupportedOperations?: SupportedOperationList;
}
export interface UsageLimit {
/**
* The identifier of the usage limit.
*/
UsageLimitId?: String;
/**
* The identifier of the cluster with a usage limit.
*/
ClusterIdentifier?: String;
/**
* The Amazon Redshift feature to which the limit applies.
*/
FeatureType?: UsageLimitFeatureType;
/**
* The type of limit. Depending on the feature type, this can be based on a time duration or data size.
*/
LimitType?: UsageLimitLimitType;
/**
* The limit amount. If time-based, this amount is in minutes. If data-based, this amount is in terabytes (TB).
*/
Amount?: Long;
/**
* The time period that the amount applies to. A weekly period begins on Sunday. The default is monthly.
*/
Period?: UsageLimitPeriod;
/**
* The action that Amazon Redshift takes when the limit is reached. Possible values are: log - To log an event in a system table. The default is log. emit-metric - To emit CloudWatch metrics. disable - To disable the feature until the next usage period begins.
*/
BreachAction?: UsageLimitBreachAction;
/**
* A list of tag instances.
*/
Tags?: TagList;
}
export type UsageLimitBreachAction = "log"|"emit-metric"|"disable"|string;
export type UsageLimitFeatureType = "spectrum"|"concurrency-scaling"|string;
export type UsageLimitLimitType = "time"|"data-scanned"|string;
export interface UsageLimitList {
/**
* Contains the output from the DescribeUsageLimits action.
*/
UsageLimits?: UsageLimits;
/**
* A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the Marker parameter and retrying the command. If the Marker field is empty, all response records have been retrieved for the request.
*/
Marker?: String;
}
export type UsageLimitPeriod = "daily"|"weekly"|"monthly"|string;
export type UsageLimits = UsageLimit[];
export type ValueStringList = String[];
export type VpcSecurityGroupIdList = String[];
export interface VpcSecurityGroupMembership {
/**
* The identifier of the VPC security group.
*/
VpcSecurityGroupId?: String;
/**
* The status of the VPC security group.
*/
Status?: String;
}
export type VpcSecurityGroupMembershipList = VpcSecurityGroupMembership[];
/**
* 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 = "2012-12-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 Redshift client.
*/
export import Types = Redshift;
}
export = Redshift;