dms.d.ts
208 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
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-base';
interface Blob {}
declare class DMS extends Service {
/**
* Constructs a service object. This object has one method for each API operation.
*/
constructor(options?: DMS.Types.ClientConfiguration)
config: Config & DMS.Types.ClientConfiguration;
/**
* Adds metadata tags to an AWS DMS resource, including replication instance, endpoint, security group, and migration task. These tags can also be used with cost allocation reporting to track cost associated with DMS resources, or used in a Condition statement in an IAM policy for DMS. For more information, see Tag data type description.
*/
addTagsToResource(params: DMS.Types.AddTagsToResourceMessage, callback?: (err: AWSError, data: DMS.Types.AddTagsToResourceResponse) => void): Request<DMS.Types.AddTagsToResourceResponse, AWSError>;
/**
* Adds metadata tags to an AWS DMS resource, including replication instance, endpoint, security group, and migration task. These tags can also be used with cost allocation reporting to track cost associated with DMS resources, or used in a Condition statement in an IAM policy for DMS. For more information, see Tag data type description.
*/
addTagsToResource(callback?: (err: AWSError, data: DMS.Types.AddTagsToResourceResponse) => void): Request<DMS.Types.AddTagsToResourceResponse, AWSError>;
/**
* Applies a pending maintenance action to a resource (for example, to a replication instance).
*/
applyPendingMaintenanceAction(params: DMS.Types.ApplyPendingMaintenanceActionMessage, callback?: (err: AWSError, data: DMS.Types.ApplyPendingMaintenanceActionResponse) => void): Request<DMS.Types.ApplyPendingMaintenanceActionResponse, AWSError>;
/**
* Applies a pending maintenance action to a resource (for example, to a replication instance).
*/
applyPendingMaintenanceAction(callback?: (err: AWSError, data: DMS.Types.ApplyPendingMaintenanceActionResponse) => void): Request<DMS.Types.ApplyPendingMaintenanceActionResponse, AWSError>;
/**
* Cancels a single premigration assessment run. This operation prevents any individual assessments from running if they haven't started running. It also attempts to cancel any individual assessments that are currently running.
*/
cancelReplicationTaskAssessmentRun(params: DMS.Types.CancelReplicationTaskAssessmentRunMessage, callback?: (err: AWSError, data: DMS.Types.CancelReplicationTaskAssessmentRunResponse) => void): Request<DMS.Types.CancelReplicationTaskAssessmentRunResponse, AWSError>;
/**
* Cancels a single premigration assessment run. This operation prevents any individual assessments from running if they haven't started running. It also attempts to cancel any individual assessments that are currently running.
*/
cancelReplicationTaskAssessmentRun(callback?: (err: AWSError, data: DMS.Types.CancelReplicationTaskAssessmentRunResponse) => void): Request<DMS.Types.CancelReplicationTaskAssessmentRunResponse, AWSError>;
/**
* Creates an endpoint using the provided settings.
*/
createEndpoint(params: DMS.Types.CreateEndpointMessage, callback?: (err: AWSError, data: DMS.Types.CreateEndpointResponse) => void): Request<DMS.Types.CreateEndpointResponse, AWSError>;
/**
* Creates an endpoint using the provided settings.
*/
createEndpoint(callback?: (err: AWSError, data: DMS.Types.CreateEndpointResponse) => void): Request<DMS.Types.CreateEndpointResponse, AWSError>;
/**
* Creates an AWS DMS event notification subscription. You can specify the type of source (SourceType) you want to be notified of, provide a list of AWS DMS source IDs (SourceIds) that triggers the events, and provide a list of event categories (EventCategories) for events you want to be notified of. If you specify both the SourceType and SourceIds, such as SourceType = replication-instance and SourceIdentifier = my-replinstance, you will be notified of all the replication instance events for the specified source. If you specify a SourceType but don't specify a SourceIdentifier, you receive notice of the events for that source type for all your AWS DMS sources. If you don't specify either SourceType nor SourceIdentifier, you will be notified of events generated from all AWS DMS sources belonging to your customer account. For more information about AWS DMS events, see Working with Events and Notifications in the AWS Database Migration Service User Guide.
*/
createEventSubscription(params: DMS.Types.CreateEventSubscriptionMessage, callback?: (err: AWSError, data: DMS.Types.CreateEventSubscriptionResponse) => void): Request<DMS.Types.CreateEventSubscriptionResponse, AWSError>;
/**
* Creates an AWS DMS event notification subscription. You can specify the type of source (SourceType) you want to be notified of, provide a list of AWS DMS source IDs (SourceIds) that triggers the events, and provide a list of event categories (EventCategories) for events you want to be notified of. If you specify both the SourceType and SourceIds, such as SourceType = replication-instance and SourceIdentifier = my-replinstance, you will be notified of all the replication instance events for the specified source. If you specify a SourceType but don't specify a SourceIdentifier, you receive notice of the events for that source type for all your AWS DMS sources. If you don't specify either SourceType nor SourceIdentifier, you will be notified of events generated from all AWS DMS sources belonging to your customer account. For more information about AWS DMS events, see Working with Events and Notifications in the AWS Database Migration Service User Guide.
*/
createEventSubscription(callback?: (err: AWSError, data: DMS.Types.CreateEventSubscriptionResponse) => void): Request<DMS.Types.CreateEventSubscriptionResponse, AWSError>;
/**
* Creates the replication instance using the specified parameters. AWS DMS requires that your account have certain roles with appropriate permissions before you can create a replication instance. For information on the required roles, see Creating the IAM Roles to Use With the AWS CLI and AWS DMS API. For information on the required permissions, see IAM Permissions Needed to Use AWS DMS.
*/
createReplicationInstance(params: DMS.Types.CreateReplicationInstanceMessage, callback?: (err: AWSError, data: DMS.Types.CreateReplicationInstanceResponse) => void): Request<DMS.Types.CreateReplicationInstanceResponse, AWSError>;
/**
* Creates the replication instance using the specified parameters. AWS DMS requires that your account have certain roles with appropriate permissions before you can create a replication instance. For information on the required roles, see Creating the IAM Roles to Use With the AWS CLI and AWS DMS API. For information on the required permissions, see IAM Permissions Needed to Use AWS DMS.
*/
createReplicationInstance(callback?: (err: AWSError, data: DMS.Types.CreateReplicationInstanceResponse) => void): Request<DMS.Types.CreateReplicationInstanceResponse, AWSError>;
/**
* Creates a replication subnet group given a list of the subnet IDs in a VPC.
*/
createReplicationSubnetGroup(params: DMS.Types.CreateReplicationSubnetGroupMessage, callback?: (err: AWSError, data: DMS.Types.CreateReplicationSubnetGroupResponse) => void): Request<DMS.Types.CreateReplicationSubnetGroupResponse, AWSError>;
/**
* Creates a replication subnet group given a list of the subnet IDs in a VPC.
*/
createReplicationSubnetGroup(callback?: (err: AWSError, data: DMS.Types.CreateReplicationSubnetGroupResponse) => void): Request<DMS.Types.CreateReplicationSubnetGroupResponse, AWSError>;
/**
* Creates a replication task using the specified parameters.
*/
createReplicationTask(params: DMS.Types.CreateReplicationTaskMessage, callback?: (err: AWSError, data: DMS.Types.CreateReplicationTaskResponse) => void): Request<DMS.Types.CreateReplicationTaskResponse, AWSError>;
/**
* Creates a replication task using the specified parameters.
*/
createReplicationTask(callback?: (err: AWSError, data: DMS.Types.CreateReplicationTaskResponse) => void): Request<DMS.Types.CreateReplicationTaskResponse, AWSError>;
/**
* Deletes the specified certificate.
*/
deleteCertificate(params: DMS.Types.DeleteCertificateMessage, callback?: (err: AWSError, data: DMS.Types.DeleteCertificateResponse) => void): Request<DMS.Types.DeleteCertificateResponse, AWSError>;
/**
* Deletes the specified certificate.
*/
deleteCertificate(callback?: (err: AWSError, data: DMS.Types.DeleteCertificateResponse) => void): Request<DMS.Types.DeleteCertificateResponse, AWSError>;
/**
* Deletes the connection between a replication instance and an endpoint.
*/
deleteConnection(params: DMS.Types.DeleteConnectionMessage, callback?: (err: AWSError, data: DMS.Types.DeleteConnectionResponse) => void): Request<DMS.Types.DeleteConnectionResponse, AWSError>;
/**
* Deletes the connection between a replication instance and an endpoint.
*/
deleteConnection(callback?: (err: AWSError, data: DMS.Types.DeleteConnectionResponse) => void): Request<DMS.Types.DeleteConnectionResponse, AWSError>;
/**
* Deletes the specified endpoint. All tasks associated with the endpoint must be deleted before you can delete the endpoint.
*/
deleteEndpoint(params: DMS.Types.DeleteEndpointMessage, callback?: (err: AWSError, data: DMS.Types.DeleteEndpointResponse) => void): Request<DMS.Types.DeleteEndpointResponse, AWSError>;
/**
* Deletes the specified endpoint. All tasks associated with the endpoint must be deleted before you can delete the endpoint.
*/
deleteEndpoint(callback?: (err: AWSError, data: DMS.Types.DeleteEndpointResponse) => void): Request<DMS.Types.DeleteEndpointResponse, AWSError>;
/**
* Deletes an AWS DMS event subscription.
*/
deleteEventSubscription(params: DMS.Types.DeleteEventSubscriptionMessage, callback?: (err: AWSError, data: DMS.Types.DeleteEventSubscriptionResponse) => void): Request<DMS.Types.DeleteEventSubscriptionResponse, AWSError>;
/**
* Deletes an AWS DMS event subscription.
*/
deleteEventSubscription(callback?: (err: AWSError, data: DMS.Types.DeleteEventSubscriptionResponse) => void): Request<DMS.Types.DeleteEventSubscriptionResponse, AWSError>;
/**
* Deletes the specified replication instance. You must delete any migration tasks that are associated with the replication instance before you can delete it.
*/
deleteReplicationInstance(params: DMS.Types.DeleteReplicationInstanceMessage, callback?: (err: AWSError, data: DMS.Types.DeleteReplicationInstanceResponse) => void): Request<DMS.Types.DeleteReplicationInstanceResponse, AWSError>;
/**
* Deletes the specified replication instance. You must delete any migration tasks that are associated with the replication instance before you can delete it.
*/
deleteReplicationInstance(callback?: (err: AWSError, data: DMS.Types.DeleteReplicationInstanceResponse) => void): Request<DMS.Types.DeleteReplicationInstanceResponse, AWSError>;
/**
* Deletes a subnet group.
*/
deleteReplicationSubnetGroup(params: DMS.Types.DeleteReplicationSubnetGroupMessage, callback?: (err: AWSError, data: DMS.Types.DeleteReplicationSubnetGroupResponse) => void): Request<DMS.Types.DeleteReplicationSubnetGroupResponse, AWSError>;
/**
* Deletes a subnet group.
*/
deleteReplicationSubnetGroup(callback?: (err: AWSError, data: DMS.Types.DeleteReplicationSubnetGroupResponse) => void): Request<DMS.Types.DeleteReplicationSubnetGroupResponse, AWSError>;
/**
* Deletes the specified replication task.
*/
deleteReplicationTask(params: DMS.Types.DeleteReplicationTaskMessage, callback?: (err: AWSError, data: DMS.Types.DeleteReplicationTaskResponse) => void): Request<DMS.Types.DeleteReplicationTaskResponse, AWSError>;
/**
* Deletes the specified replication task.
*/
deleteReplicationTask(callback?: (err: AWSError, data: DMS.Types.DeleteReplicationTaskResponse) => void): Request<DMS.Types.DeleteReplicationTaskResponse, AWSError>;
/**
* Deletes the record of a single premigration assessment run. This operation removes all metadata that AWS DMS maintains about this assessment run. However, the operation leaves untouched all information about this assessment run that is stored in your Amazon S3 bucket.
*/
deleteReplicationTaskAssessmentRun(params: DMS.Types.DeleteReplicationTaskAssessmentRunMessage, callback?: (err: AWSError, data: DMS.Types.DeleteReplicationTaskAssessmentRunResponse) => void): Request<DMS.Types.DeleteReplicationTaskAssessmentRunResponse, AWSError>;
/**
* Deletes the record of a single premigration assessment run. This operation removes all metadata that AWS DMS maintains about this assessment run. However, the operation leaves untouched all information about this assessment run that is stored in your Amazon S3 bucket.
*/
deleteReplicationTaskAssessmentRun(callback?: (err: AWSError, data: DMS.Types.DeleteReplicationTaskAssessmentRunResponse) => void): Request<DMS.Types.DeleteReplicationTaskAssessmentRunResponse, AWSError>;
/**
* Lists all of the AWS DMS attributes for a customer account. These attributes include AWS DMS quotas for the account and a unique account identifier in a particular DMS region. DMS quotas include a list of resource quotas supported by the account, such as the number of replication instances allowed. The description for each resource quota, includes the quota name, current usage toward that quota, and the quota's maximum value. DMS uses the unique account identifier to name each artifact used by DMS in the given region. This command does not take any parameters.
*/
describeAccountAttributes(params: DMS.Types.DescribeAccountAttributesMessage, callback?: (err: AWSError, data: DMS.Types.DescribeAccountAttributesResponse) => void): Request<DMS.Types.DescribeAccountAttributesResponse, AWSError>;
/**
* Lists all of the AWS DMS attributes for a customer account. These attributes include AWS DMS quotas for the account and a unique account identifier in a particular DMS region. DMS quotas include a list of resource quotas supported by the account, such as the number of replication instances allowed. The description for each resource quota, includes the quota name, current usage toward that quota, and the quota's maximum value. DMS uses the unique account identifier to name each artifact used by DMS in the given region. This command does not take any parameters.
*/
describeAccountAttributes(callback?: (err: AWSError, data: DMS.Types.DescribeAccountAttributesResponse) => void): Request<DMS.Types.DescribeAccountAttributesResponse, AWSError>;
/**
* Provides a list of individual assessments that you can specify for a new premigration assessment run, given one or more parameters. If you specify an existing migration task, this operation provides the default individual assessments you can specify for that task. Otherwise, the specified parameters model elements of a possible migration task on which to base a premigration assessment run. To use these migration task modeling parameters, you must specify an existing replication instance, a source database engine, a target database engine, and a migration type. This combination of parameters potentially limits the default individual assessments available for an assessment run created for a corresponding migration task. If you specify no parameters, this operation provides a list of all possible individual assessments that you can specify for an assessment run. If you specify any one of the task modeling parameters, you must specify all of them or the operation cannot provide a list of individual assessments. The only parameter that you can specify alone is for an existing migration task. The specified task definition then determines the default list of individual assessments that you can specify in an assessment run for the task.
*/
describeApplicableIndividualAssessments(params: DMS.Types.DescribeApplicableIndividualAssessmentsMessage, callback?: (err: AWSError, data: DMS.Types.DescribeApplicableIndividualAssessmentsResponse) => void): Request<DMS.Types.DescribeApplicableIndividualAssessmentsResponse, AWSError>;
/**
* Provides a list of individual assessments that you can specify for a new premigration assessment run, given one or more parameters. If you specify an existing migration task, this operation provides the default individual assessments you can specify for that task. Otherwise, the specified parameters model elements of a possible migration task on which to base a premigration assessment run. To use these migration task modeling parameters, you must specify an existing replication instance, a source database engine, a target database engine, and a migration type. This combination of parameters potentially limits the default individual assessments available for an assessment run created for a corresponding migration task. If you specify no parameters, this operation provides a list of all possible individual assessments that you can specify for an assessment run. If you specify any one of the task modeling parameters, you must specify all of them or the operation cannot provide a list of individual assessments. The only parameter that you can specify alone is for an existing migration task. The specified task definition then determines the default list of individual assessments that you can specify in an assessment run for the task.
*/
describeApplicableIndividualAssessments(callback?: (err: AWSError, data: DMS.Types.DescribeApplicableIndividualAssessmentsResponse) => void): Request<DMS.Types.DescribeApplicableIndividualAssessmentsResponse, AWSError>;
/**
* Provides a description of the certificate.
*/
describeCertificates(params: DMS.Types.DescribeCertificatesMessage, callback?: (err: AWSError, data: DMS.Types.DescribeCertificatesResponse) => void): Request<DMS.Types.DescribeCertificatesResponse, AWSError>;
/**
* Provides a description of the certificate.
*/
describeCertificates(callback?: (err: AWSError, data: DMS.Types.DescribeCertificatesResponse) => void): Request<DMS.Types.DescribeCertificatesResponse, AWSError>;
/**
* Describes the status of the connections that have been made between the replication instance and an endpoint. Connections are created when you test an endpoint.
*/
describeConnections(params: DMS.Types.DescribeConnectionsMessage, callback?: (err: AWSError, data: DMS.Types.DescribeConnectionsResponse) => void): Request<DMS.Types.DescribeConnectionsResponse, AWSError>;
/**
* Describes the status of the connections that have been made between the replication instance and an endpoint. Connections are created when you test an endpoint.
*/
describeConnections(callback?: (err: AWSError, data: DMS.Types.DescribeConnectionsResponse) => void): Request<DMS.Types.DescribeConnectionsResponse, AWSError>;
/**
* Returns information about the type of endpoints available.
*/
describeEndpointTypes(params: DMS.Types.DescribeEndpointTypesMessage, callback?: (err: AWSError, data: DMS.Types.DescribeEndpointTypesResponse) => void): Request<DMS.Types.DescribeEndpointTypesResponse, AWSError>;
/**
* Returns information about the type of endpoints available.
*/
describeEndpointTypes(callback?: (err: AWSError, data: DMS.Types.DescribeEndpointTypesResponse) => void): Request<DMS.Types.DescribeEndpointTypesResponse, AWSError>;
/**
* Returns information about the endpoints for your account in the current region.
*/
describeEndpoints(params: DMS.Types.DescribeEndpointsMessage, callback?: (err: AWSError, data: DMS.Types.DescribeEndpointsResponse) => void): Request<DMS.Types.DescribeEndpointsResponse, AWSError>;
/**
* Returns information about the endpoints for your account in the current region.
*/
describeEndpoints(callback?: (err: AWSError, data: DMS.Types.DescribeEndpointsResponse) => void): Request<DMS.Types.DescribeEndpointsResponse, AWSError>;
/**
* Lists categories for all event source types, or, if specified, for a specified source type. You can see a list of the event categories and source types in Working with Events and Notifications in the AWS Database Migration Service User Guide.
*/
describeEventCategories(params: DMS.Types.DescribeEventCategoriesMessage, callback?: (err: AWSError, data: DMS.Types.DescribeEventCategoriesResponse) => void): Request<DMS.Types.DescribeEventCategoriesResponse, AWSError>;
/**
* Lists categories for all event source types, or, if specified, for a specified source type. You can see a list of the event categories and source types in Working with Events and Notifications in the AWS Database Migration Service User Guide.
*/
describeEventCategories(callback?: (err: AWSError, data: DMS.Types.DescribeEventCategoriesResponse) => void): Request<DMS.Types.DescribeEventCategoriesResponse, AWSError>;
/**
* Lists all the event subscriptions for a customer account. The description of a subscription includes SubscriptionName, SNSTopicARN, CustomerID, SourceType, SourceID, CreationTime, and Status. If you specify SubscriptionName, this action lists the description for that subscription.
*/
describeEventSubscriptions(params: DMS.Types.DescribeEventSubscriptionsMessage, callback?: (err: AWSError, data: DMS.Types.DescribeEventSubscriptionsResponse) => void): Request<DMS.Types.DescribeEventSubscriptionsResponse, AWSError>;
/**
* Lists all the event subscriptions for a customer account. The description of a subscription includes SubscriptionName, SNSTopicARN, CustomerID, SourceType, SourceID, CreationTime, and Status. If you specify SubscriptionName, this action lists the description for that subscription.
*/
describeEventSubscriptions(callback?: (err: AWSError, data: DMS.Types.DescribeEventSubscriptionsResponse) => void): Request<DMS.Types.DescribeEventSubscriptionsResponse, AWSError>;
/**
* Lists events for a given source identifier and source type. You can also specify a start and end time. For more information on AWS DMS events, see Working with Events and Notifications in the AWS Database Migration User Guide.
*/
describeEvents(params: DMS.Types.DescribeEventsMessage, callback?: (err: AWSError, data: DMS.Types.DescribeEventsResponse) => void): Request<DMS.Types.DescribeEventsResponse, AWSError>;
/**
* Lists events for a given source identifier and source type. You can also specify a start and end time. For more information on AWS DMS events, see Working with Events and Notifications in the AWS Database Migration User Guide.
*/
describeEvents(callback?: (err: AWSError, data: DMS.Types.DescribeEventsResponse) => void): Request<DMS.Types.DescribeEventsResponse, AWSError>;
/**
* Returns information about the replication instance types that can be created in the specified region.
*/
describeOrderableReplicationInstances(params: DMS.Types.DescribeOrderableReplicationInstancesMessage, callback?: (err: AWSError, data: DMS.Types.DescribeOrderableReplicationInstancesResponse) => void): Request<DMS.Types.DescribeOrderableReplicationInstancesResponse, AWSError>;
/**
* Returns information about the replication instance types that can be created in the specified region.
*/
describeOrderableReplicationInstances(callback?: (err: AWSError, data: DMS.Types.DescribeOrderableReplicationInstancesResponse) => void): Request<DMS.Types.DescribeOrderableReplicationInstancesResponse, AWSError>;
/**
* For internal use only
*/
describePendingMaintenanceActions(params: DMS.Types.DescribePendingMaintenanceActionsMessage, callback?: (err: AWSError, data: DMS.Types.DescribePendingMaintenanceActionsResponse) => void): Request<DMS.Types.DescribePendingMaintenanceActionsResponse, AWSError>;
/**
* For internal use only
*/
describePendingMaintenanceActions(callback?: (err: AWSError, data: DMS.Types.DescribePendingMaintenanceActionsResponse) => void): Request<DMS.Types.DescribePendingMaintenanceActionsResponse, AWSError>;
/**
* Returns the status of the RefreshSchemas operation.
*/
describeRefreshSchemasStatus(params: DMS.Types.DescribeRefreshSchemasStatusMessage, callback?: (err: AWSError, data: DMS.Types.DescribeRefreshSchemasStatusResponse) => void): Request<DMS.Types.DescribeRefreshSchemasStatusResponse, AWSError>;
/**
* Returns the status of the RefreshSchemas operation.
*/
describeRefreshSchemasStatus(callback?: (err: AWSError, data: DMS.Types.DescribeRefreshSchemasStatusResponse) => void): Request<DMS.Types.DescribeRefreshSchemasStatusResponse, AWSError>;
/**
* Returns information about the task logs for the specified task.
*/
describeReplicationInstanceTaskLogs(params: DMS.Types.DescribeReplicationInstanceTaskLogsMessage, callback?: (err: AWSError, data: DMS.Types.DescribeReplicationInstanceTaskLogsResponse) => void): Request<DMS.Types.DescribeReplicationInstanceTaskLogsResponse, AWSError>;
/**
* Returns information about the task logs for the specified task.
*/
describeReplicationInstanceTaskLogs(callback?: (err: AWSError, data: DMS.Types.DescribeReplicationInstanceTaskLogsResponse) => void): Request<DMS.Types.DescribeReplicationInstanceTaskLogsResponse, AWSError>;
/**
* Returns information about replication instances for your account in the current region.
*/
describeReplicationInstances(params: DMS.Types.DescribeReplicationInstancesMessage, callback?: (err: AWSError, data: DMS.Types.DescribeReplicationInstancesResponse) => void): Request<DMS.Types.DescribeReplicationInstancesResponse, AWSError>;
/**
* Returns information about replication instances for your account in the current region.
*/
describeReplicationInstances(callback?: (err: AWSError, data: DMS.Types.DescribeReplicationInstancesResponse) => void): Request<DMS.Types.DescribeReplicationInstancesResponse, AWSError>;
/**
* Returns information about the replication subnet groups.
*/
describeReplicationSubnetGroups(params: DMS.Types.DescribeReplicationSubnetGroupsMessage, callback?: (err: AWSError, data: DMS.Types.DescribeReplicationSubnetGroupsResponse) => void): Request<DMS.Types.DescribeReplicationSubnetGroupsResponse, AWSError>;
/**
* Returns information about the replication subnet groups.
*/
describeReplicationSubnetGroups(callback?: (err: AWSError, data: DMS.Types.DescribeReplicationSubnetGroupsResponse) => void): Request<DMS.Types.DescribeReplicationSubnetGroupsResponse, AWSError>;
/**
* Returns the task assessment results from Amazon S3. This action always returns the latest results.
*/
describeReplicationTaskAssessmentResults(params: DMS.Types.DescribeReplicationTaskAssessmentResultsMessage, callback?: (err: AWSError, data: DMS.Types.DescribeReplicationTaskAssessmentResultsResponse) => void): Request<DMS.Types.DescribeReplicationTaskAssessmentResultsResponse, AWSError>;
/**
* Returns the task assessment results from Amazon S3. This action always returns the latest results.
*/
describeReplicationTaskAssessmentResults(callback?: (err: AWSError, data: DMS.Types.DescribeReplicationTaskAssessmentResultsResponse) => void): Request<DMS.Types.DescribeReplicationTaskAssessmentResultsResponse, AWSError>;
/**
* Returns a paginated list of premigration assessment runs based on filter settings. These filter settings can specify a combination of premigration assessment runs, migration tasks, replication instances, and assessment run status values. This operation doesn't return information about individual assessments. For this information, see the DescribeReplicationTaskIndividualAssessments operation.
*/
describeReplicationTaskAssessmentRuns(params: DMS.Types.DescribeReplicationTaskAssessmentRunsMessage, callback?: (err: AWSError, data: DMS.Types.DescribeReplicationTaskAssessmentRunsResponse) => void): Request<DMS.Types.DescribeReplicationTaskAssessmentRunsResponse, AWSError>;
/**
* Returns a paginated list of premigration assessment runs based on filter settings. These filter settings can specify a combination of premigration assessment runs, migration tasks, replication instances, and assessment run status values. This operation doesn't return information about individual assessments. For this information, see the DescribeReplicationTaskIndividualAssessments operation.
*/
describeReplicationTaskAssessmentRuns(callback?: (err: AWSError, data: DMS.Types.DescribeReplicationTaskAssessmentRunsResponse) => void): Request<DMS.Types.DescribeReplicationTaskAssessmentRunsResponse, AWSError>;
/**
* Returns a paginated list of individual assessments based on filter settings. These filter settings can specify a combination of premigration assessment runs, migration tasks, and assessment status values.
*/
describeReplicationTaskIndividualAssessments(params: DMS.Types.DescribeReplicationTaskIndividualAssessmentsMessage, callback?: (err: AWSError, data: DMS.Types.DescribeReplicationTaskIndividualAssessmentsResponse) => void): Request<DMS.Types.DescribeReplicationTaskIndividualAssessmentsResponse, AWSError>;
/**
* Returns a paginated list of individual assessments based on filter settings. These filter settings can specify a combination of premigration assessment runs, migration tasks, and assessment status values.
*/
describeReplicationTaskIndividualAssessments(callback?: (err: AWSError, data: DMS.Types.DescribeReplicationTaskIndividualAssessmentsResponse) => void): Request<DMS.Types.DescribeReplicationTaskIndividualAssessmentsResponse, AWSError>;
/**
* Returns information about replication tasks for your account in the current region.
*/
describeReplicationTasks(params: DMS.Types.DescribeReplicationTasksMessage, callback?: (err: AWSError, data: DMS.Types.DescribeReplicationTasksResponse) => void): Request<DMS.Types.DescribeReplicationTasksResponse, AWSError>;
/**
* Returns information about replication tasks for your account in the current region.
*/
describeReplicationTasks(callback?: (err: AWSError, data: DMS.Types.DescribeReplicationTasksResponse) => void): Request<DMS.Types.DescribeReplicationTasksResponse, AWSError>;
/**
* Returns information about the schema for the specified endpoint.
*/
describeSchemas(params: DMS.Types.DescribeSchemasMessage, callback?: (err: AWSError, data: DMS.Types.DescribeSchemasResponse) => void): Request<DMS.Types.DescribeSchemasResponse, AWSError>;
/**
* Returns information about the schema for the specified endpoint.
*/
describeSchemas(callback?: (err: AWSError, data: DMS.Types.DescribeSchemasResponse) => void): Request<DMS.Types.DescribeSchemasResponse, AWSError>;
/**
* Returns table statistics on the database migration task, including table name, rows inserted, rows updated, and rows deleted. Note that the "last updated" column the DMS console only indicates the time that AWS DMS last updated the table statistics record for a table. It does not indicate the time of the last update to the table.
*/
describeTableStatistics(params: DMS.Types.DescribeTableStatisticsMessage, callback?: (err: AWSError, data: DMS.Types.DescribeTableStatisticsResponse) => void): Request<DMS.Types.DescribeTableStatisticsResponse, AWSError>;
/**
* Returns table statistics on the database migration task, including table name, rows inserted, rows updated, and rows deleted. Note that the "last updated" column the DMS console only indicates the time that AWS DMS last updated the table statistics record for a table. It does not indicate the time of the last update to the table.
*/
describeTableStatistics(callback?: (err: AWSError, data: DMS.Types.DescribeTableStatisticsResponse) => void): Request<DMS.Types.DescribeTableStatisticsResponse, AWSError>;
/**
* Uploads the specified certificate.
*/
importCertificate(params: DMS.Types.ImportCertificateMessage, callback?: (err: AWSError, data: DMS.Types.ImportCertificateResponse) => void): Request<DMS.Types.ImportCertificateResponse, AWSError>;
/**
* Uploads the specified certificate.
*/
importCertificate(callback?: (err: AWSError, data: DMS.Types.ImportCertificateResponse) => void): Request<DMS.Types.ImportCertificateResponse, AWSError>;
/**
* Lists all metadata tags attached to an AWS DMS resource, including replication instance, endpoint, security group, and migration task. For more information, see Tag data type description.
*/
listTagsForResource(params: DMS.Types.ListTagsForResourceMessage, callback?: (err: AWSError, data: DMS.Types.ListTagsForResourceResponse) => void): Request<DMS.Types.ListTagsForResourceResponse, AWSError>;
/**
* Lists all metadata tags attached to an AWS DMS resource, including replication instance, endpoint, security group, and migration task. For more information, see Tag data type description.
*/
listTagsForResource(callback?: (err: AWSError, data: DMS.Types.ListTagsForResourceResponse) => void): Request<DMS.Types.ListTagsForResourceResponse, AWSError>;
/**
* Modifies the specified endpoint.
*/
modifyEndpoint(params: DMS.Types.ModifyEndpointMessage, callback?: (err: AWSError, data: DMS.Types.ModifyEndpointResponse) => void): Request<DMS.Types.ModifyEndpointResponse, AWSError>;
/**
* Modifies the specified endpoint.
*/
modifyEndpoint(callback?: (err: AWSError, data: DMS.Types.ModifyEndpointResponse) => void): Request<DMS.Types.ModifyEndpointResponse, AWSError>;
/**
* Modifies an existing AWS DMS event notification subscription.
*/
modifyEventSubscription(params: DMS.Types.ModifyEventSubscriptionMessage, callback?: (err: AWSError, data: DMS.Types.ModifyEventSubscriptionResponse) => void): Request<DMS.Types.ModifyEventSubscriptionResponse, AWSError>;
/**
* Modifies an existing AWS DMS event notification subscription.
*/
modifyEventSubscription(callback?: (err: AWSError, data: DMS.Types.ModifyEventSubscriptionResponse) => void): Request<DMS.Types.ModifyEventSubscriptionResponse, AWSError>;
/**
* Modifies the replication instance to apply new settings. You can change one or more parameters by specifying these parameters and the new values in the request. Some settings are applied during the maintenance window.
*/
modifyReplicationInstance(params: DMS.Types.ModifyReplicationInstanceMessage, callback?: (err: AWSError, data: DMS.Types.ModifyReplicationInstanceResponse) => void): Request<DMS.Types.ModifyReplicationInstanceResponse, AWSError>;
/**
* Modifies the replication instance to apply new settings. You can change one or more parameters by specifying these parameters and the new values in the request. Some settings are applied during the maintenance window.
*/
modifyReplicationInstance(callback?: (err: AWSError, data: DMS.Types.ModifyReplicationInstanceResponse) => void): Request<DMS.Types.ModifyReplicationInstanceResponse, AWSError>;
/**
* Modifies the settings for the specified replication subnet group.
*/
modifyReplicationSubnetGroup(params: DMS.Types.ModifyReplicationSubnetGroupMessage, callback?: (err: AWSError, data: DMS.Types.ModifyReplicationSubnetGroupResponse) => void): Request<DMS.Types.ModifyReplicationSubnetGroupResponse, AWSError>;
/**
* Modifies the settings for the specified replication subnet group.
*/
modifyReplicationSubnetGroup(callback?: (err: AWSError, data: DMS.Types.ModifyReplicationSubnetGroupResponse) => void): Request<DMS.Types.ModifyReplicationSubnetGroupResponse, AWSError>;
/**
* Modifies the specified replication task. You can't modify the task endpoints. The task must be stopped before you can modify it. For more information about AWS DMS tasks, see Working with Migration Tasks in the AWS Database Migration Service User Guide.
*/
modifyReplicationTask(params: DMS.Types.ModifyReplicationTaskMessage, callback?: (err: AWSError, data: DMS.Types.ModifyReplicationTaskResponse) => void): Request<DMS.Types.ModifyReplicationTaskResponse, AWSError>;
/**
* Modifies the specified replication task. You can't modify the task endpoints. The task must be stopped before you can modify it. For more information about AWS DMS tasks, see Working with Migration Tasks in the AWS Database Migration Service User Guide.
*/
modifyReplicationTask(callback?: (err: AWSError, data: DMS.Types.ModifyReplicationTaskResponse) => void): Request<DMS.Types.ModifyReplicationTaskResponse, AWSError>;
/**
* Reboots a replication instance. Rebooting results in a momentary outage, until the replication instance becomes available again.
*/
rebootReplicationInstance(params: DMS.Types.RebootReplicationInstanceMessage, callback?: (err: AWSError, data: DMS.Types.RebootReplicationInstanceResponse) => void): Request<DMS.Types.RebootReplicationInstanceResponse, AWSError>;
/**
* Reboots a replication instance. Rebooting results in a momentary outage, until the replication instance becomes available again.
*/
rebootReplicationInstance(callback?: (err: AWSError, data: DMS.Types.RebootReplicationInstanceResponse) => void): Request<DMS.Types.RebootReplicationInstanceResponse, AWSError>;
/**
* Populates the schema for the specified endpoint. This is an asynchronous operation and can take several minutes. You can check the status of this operation by calling the DescribeRefreshSchemasStatus operation.
*/
refreshSchemas(params: DMS.Types.RefreshSchemasMessage, callback?: (err: AWSError, data: DMS.Types.RefreshSchemasResponse) => void): Request<DMS.Types.RefreshSchemasResponse, AWSError>;
/**
* Populates the schema for the specified endpoint. This is an asynchronous operation and can take several minutes. You can check the status of this operation by calling the DescribeRefreshSchemasStatus operation.
*/
refreshSchemas(callback?: (err: AWSError, data: DMS.Types.RefreshSchemasResponse) => void): Request<DMS.Types.RefreshSchemasResponse, AWSError>;
/**
* Reloads the target database table with the source data.
*/
reloadTables(params: DMS.Types.ReloadTablesMessage, callback?: (err: AWSError, data: DMS.Types.ReloadTablesResponse) => void): Request<DMS.Types.ReloadTablesResponse, AWSError>;
/**
* Reloads the target database table with the source data.
*/
reloadTables(callback?: (err: AWSError, data: DMS.Types.ReloadTablesResponse) => void): Request<DMS.Types.ReloadTablesResponse, AWSError>;
/**
* Removes metadata tags from an AWS DMS resource, including replication instance, endpoint, security group, and migration task. For more information, see Tag data type description.
*/
removeTagsFromResource(params: DMS.Types.RemoveTagsFromResourceMessage, callback?: (err: AWSError, data: DMS.Types.RemoveTagsFromResourceResponse) => void): Request<DMS.Types.RemoveTagsFromResourceResponse, AWSError>;
/**
* Removes metadata tags from an AWS DMS resource, including replication instance, endpoint, security group, and migration task. For more information, see Tag data type description.
*/
removeTagsFromResource(callback?: (err: AWSError, data: DMS.Types.RemoveTagsFromResourceResponse) => void): Request<DMS.Types.RemoveTagsFromResourceResponse, AWSError>;
/**
* Starts the replication task. For more information about AWS DMS tasks, see Working with Migration Tasks in the AWS Database Migration Service User Guide.
*/
startReplicationTask(params: DMS.Types.StartReplicationTaskMessage, callback?: (err: AWSError, data: DMS.Types.StartReplicationTaskResponse) => void): Request<DMS.Types.StartReplicationTaskResponse, AWSError>;
/**
* Starts the replication task. For more information about AWS DMS tasks, see Working with Migration Tasks in the AWS Database Migration Service User Guide.
*/
startReplicationTask(callback?: (err: AWSError, data: DMS.Types.StartReplicationTaskResponse) => void): Request<DMS.Types.StartReplicationTaskResponse, AWSError>;
/**
* Starts the replication task assessment for unsupported data types in the source database.
*/
startReplicationTaskAssessment(params: DMS.Types.StartReplicationTaskAssessmentMessage, callback?: (err: AWSError, data: DMS.Types.StartReplicationTaskAssessmentResponse) => void): Request<DMS.Types.StartReplicationTaskAssessmentResponse, AWSError>;
/**
* Starts the replication task assessment for unsupported data types in the source database.
*/
startReplicationTaskAssessment(callback?: (err: AWSError, data: DMS.Types.StartReplicationTaskAssessmentResponse) => void): Request<DMS.Types.StartReplicationTaskAssessmentResponse, AWSError>;
/**
* Starts a new premigration assessment run for one or more individual assessments of a migration task. The assessments that you can specify depend on the source and target database engine and the migration type defined for the given task. To run this operation, your migration task must already be created. After you run this operation, you can review the status of each individual assessment. You can also run the migration task manually after the assessment run and its individual assessments complete.
*/
startReplicationTaskAssessmentRun(params: DMS.Types.StartReplicationTaskAssessmentRunMessage, callback?: (err: AWSError, data: DMS.Types.StartReplicationTaskAssessmentRunResponse) => void): Request<DMS.Types.StartReplicationTaskAssessmentRunResponse, AWSError>;
/**
* Starts a new premigration assessment run for one or more individual assessments of a migration task. The assessments that you can specify depend on the source and target database engine and the migration type defined for the given task. To run this operation, your migration task must already be created. After you run this operation, you can review the status of each individual assessment. You can also run the migration task manually after the assessment run and its individual assessments complete.
*/
startReplicationTaskAssessmentRun(callback?: (err: AWSError, data: DMS.Types.StartReplicationTaskAssessmentRunResponse) => void): Request<DMS.Types.StartReplicationTaskAssessmentRunResponse, AWSError>;
/**
* Stops the replication task.
*/
stopReplicationTask(params: DMS.Types.StopReplicationTaskMessage, callback?: (err: AWSError, data: DMS.Types.StopReplicationTaskResponse) => void): Request<DMS.Types.StopReplicationTaskResponse, AWSError>;
/**
* Stops the replication task.
*/
stopReplicationTask(callback?: (err: AWSError, data: DMS.Types.StopReplicationTaskResponse) => void): Request<DMS.Types.StopReplicationTaskResponse, AWSError>;
/**
* Tests the connection between the replication instance and the endpoint.
*/
testConnection(params: DMS.Types.TestConnectionMessage, callback?: (err: AWSError, data: DMS.Types.TestConnectionResponse) => void): Request<DMS.Types.TestConnectionResponse, AWSError>;
/**
* Tests the connection between the replication instance and the endpoint.
*/
testConnection(callback?: (err: AWSError, data: DMS.Types.TestConnectionResponse) => void): Request<DMS.Types.TestConnectionResponse, AWSError>;
/**
* Waits for the testConnectionSucceeds state by periodically calling the underlying DMS.describeConnectionsoperation every 5 seconds (at most 60 times). Wait until testing connection succeeds.
*/
waitFor(state: "testConnectionSucceeds", params: DMS.Types.DescribeConnectionsMessage & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: DMS.Types.DescribeConnectionsResponse) => void): Request<DMS.Types.DescribeConnectionsResponse, AWSError>;
/**
* Waits for the testConnectionSucceeds state by periodically calling the underlying DMS.describeConnectionsoperation every 5 seconds (at most 60 times). Wait until testing connection succeeds.
*/
waitFor(state: "testConnectionSucceeds", callback?: (err: AWSError, data: DMS.Types.DescribeConnectionsResponse) => void): Request<DMS.Types.DescribeConnectionsResponse, AWSError>;
/**
* Waits for the endpointDeleted state by periodically calling the underlying DMS.describeEndpointsoperation every 5 seconds (at most 60 times). Wait until testing endpoint is deleted.
*/
waitFor(state: "endpointDeleted", params: DMS.Types.DescribeEndpointsMessage & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: DMS.Types.DescribeEndpointsResponse) => void): Request<DMS.Types.DescribeEndpointsResponse, AWSError>;
/**
* Waits for the endpointDeleted state by periodically calling the underlying DMS.describeEndpointsoperation every 5 seconds (at most 60 times). Wait until testing endpoint is deleted.
*/
waitFor(state: "endpointDeleted", callback?: (err: AWSError, data: DMS.Types.DescribeEndpointsResponse) => void): Request<DMS.Types.DescribeEndpointsResponse, AWSError>;
/**
* Waits for the replicationInstanceAvailable state by periodically calling the underlying DMS.describeReplicationInstancesoperation every 60 seconds (at most 60 times). Wait until DMS replication instance is available.
*/
waitFor(state: "replicationInstanceAvailable", params: DMS.Types.DescribeReplicationInstancesMessage & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: DMS.Types.DescribeReplicationInstancesResponse) => void): Request<DMS.Types.DescribeReplicationInstancesResponse, AWSError>;
/**
* Waits for the replicationInstanceAvailable state by periodically calling the underlying DMS.describeReplicationInstancesoperation every 60 seconds (at most 60 times). Wait until DMS replication instance is available.
*/
waitFor(state: "replicationInstanceAvailable", callback?: (err: AWSError, data: DMS.Types.DescribeReplicationInstancesResponse) => void): Request<DMS.Types.DescribeReplicationInstancesResponse, AWSError>;
/**
* Waits for the replicationInstanceDeleted state by periodically calling the underlying DMS.describeReplicationInstancesoperation every 15 seconds (at most 60 times). Wait until DMS replication instance is deleted.
*/
waitFor(state: "replicationInstanceDeleted", params: DMS.Types.DescribeReplicationInstancesMessage & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: DMS.Types.DescribeReplicationInstancesResponse) => void): Request<DMS.Types.DescribeReplicationInstancesResponse, AWSError>;
/**
* Waits for the replicationInstanceDeleted state by periodically calling the underlying DMS.describeReplicationInstancesoperation every 15 seconds (at most 60 times). Wait until DMS replication instance is deleted.
*/
waitFor(state: "replicationInstanceDeleted", callback?: (err: AWSError, data: DMS.Types.DescribeReplicationInstancesResponse) => void): Request<DMS.Types.DescribeReplicationInstancesResponse, AWSError>;
/**
* Waits for the replicationTaskReady state by periodically calling the underlying DMS.describeReplicationTasksoperation every 15 seconds (at most 60 times). Wait until DMS replication task is ready.
*/
waitFor(state: "replicationTaskReady", params: DMS.Types.DescribeReplicationTasksMessage & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: DMS.Types.DescribeReplicationTasksResponse) => void): Request<DMS.Types.DescribeReplicationTasksResponse, AWSError>;
/**
* Waits for the replicationTaskReady state by periodically calling the underlying DMS.describeReplicationTasksoperation every 15 seconds (at most 60 times). Wait until DMS replication task is ready.
*/
waitFor(state: "replicationTaskReady", callback?: (err: AWSError, data: DMS.Types.DescribeReplicationTasksResponse) => void): Request<DMS.Types.DescribeReplicationTasksResponse, AWSError>;
/**
* Waits for the replicationTaskStopped state by periodically calling the underlying DMS.describeReplicationTasksoperation every 15 seconds (at most 60 times). Wait until DMS replication task is stopped.
*/
waitFor(state: "replicationTaskStopped", params: DMS.Types.DescribeReplicationTasksMessage & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: DMS.Types.DescribeReplicationTasksResponse) => void): Request<DMS.Types.DescribeReplicationTasksResponse, AWSError>;
/**
* Waits for the replicationTaskStopped state by periodically calling the underlying DMS.describeReplicationTasksoperation every 15 seconds (at most 60 times). Wait until DMS replication task is stopped.
*/
waitFor(state: "replicationTaskStopped", callback?: (err: AWSError, data: DMS.Types.DescribeReplicationTasksResponse) => void): Request<DMS.Types.DescribeReplicationTasksResponse, AWSError>;
/**
* Waits for the replicationTaskRunning state by periodically calling the underlying DMS.describeReplicationTasksoperation every 15 seconds (at most 60 times). Wait until DMS replication task is running.
*/
waitFor(state: "replicationTaskRunning", params: DMS.Types.DescribeReplicationTasksMessage & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: DMS.Types.DescribeReplicationTasksResponse) => void): Request<DMS.Types.DescribeReplicationTasksResponse, AWSError>;
/**
* Waits for the replicationTaskRunning state by periodically calling the underlying DMS.describeReplicationTasksoperation every 15 seconds (at most 60 times). Wait until DMS replication task is running.
*/
waitFor(state: "replicationTaskRunning", callback?: (err: AWSError, data: DMS.Types.DescribeReplicationTasksResponse) => void): Request<DMS.Types.DescribeReplicationTasksResponse, AWSError>;
/**
* Waits for the replicationTaskDeleted state by periodically calling the underlying DMS.describeReplicationTasksoperation every 15 seconds (at most 60 times). Wait until DMS replication task is deleted.
*/
waitFor(state: "replicationTaskDeleted", params: DMS.Types.DescribeReplicationTasksMessage & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: DMS.Types.DescribeReplicationTasksResponse) => void): Request<DMS.Types.DescribeReplicationTasksResponse, AWSError>;
/**
* Waits for the replicationTaskDeleted state by periodically calling the underlying DMS.describeReplicationTasksoperation every 15 seconds (at most 60 times). Wait until DMS replication task is deleted.
*/
waitFor(state: "replicationTaskDeleted", callback?: (err: AWSError, data: DMS.Types.DescribeReplicationTasksResponse) => void): Request<DMS.Types.DescribeReplicationTasksResponse, AWSError>;
}
declare namespace DMS {
export interface AccountQuota {
/**
* The name of the AWS DMS quota for this AWS account.
*/
AccountQuotaName?: String;
/**
* The amount currently used toward the quota maximum.
*/
Used?: Long;
/**
* The maximum allowed value for the quota.
*/
Max?: Long;
}
export type AccountQuotaList = AccountQuota[];
export interface AddTagsToResourceMessage {
/**
* Identifies the AWS DMS resource to which tags should be added. The value for this parameter is an Amazon Resource Name (ARN). For AWS DMS, you can tag a replication instance, an endpoint, or a replication task.
*/
ResourceArn: String;
/**
* One or more tags to be assigned to the resource.
*/
Tags: TagList;
}
export interface AddTagsToResourceResponse {
}
export interface ApplyPendingMaintenanceActionMessage {
/**
* The Amazon Resource Name (ARN) of the AWS DMS resource that the pending maintenance action applies to.
*/
ReplicationInstanceArn: String;
/**
* The pending maintenance action to apply to this resource.
*/
ApplyAction: String;
/**
* A value that specifies the type of opt-in request, or undoes an opt-in request. You can't undo an opt-in request of type immediate. Valid values: immediate - Apply the maintenance action immediately. next-maintenance - Apply the maintenance action during the next maintenance window for the resource. undo-opt-in - Cancel any existing next-maintenance opt-in requests.
*/
OptInType: String;
}
export interface ApplyPendingMaintenanceActionResponse {
/**
* The AWS DMS resource that the pending maintenance action will be applied to.
*/
ResourcePendingMaintenanceActions?: ResourcePendingMaintenanceActions;
}
export type AuthMechanismValue = "default"|"mongodb_cr"|"scram_sha_1"|string;
export type AuthTypeValue = "no"|"password"|string;
export interface AvailabilityZone {
/**
* The name of the Availability Zone.
*/
Name?: String;
}
export type AvailabilityZonesList = String[];
export type Boolean = boolean;
export type BooleanOptional = boolean;
export interface CancelReplicationTaskAssessmentRunMessage {
/**
* Amazon Resource Name (ARN) of the premigration assessment run to be canceled.
*/
ReplicationTaskAssessmentRunArn: String;
}
export interface CancelReplicationTaskAssessmentRunResponse {
/**
* The ReplicationTaskAssessmentRun object for the canceled assessment run.
*/
ReplicationTaskAssessmentRun?: ReplicationTaskAssessmentRun;
}
export interface Certificate {
/**
* A customer-assigned name for the certificate. Identifiers must begin with a letter and must contain only ASCII letters, digits, and hyphens. They can't end with a hyphen or contain two consecutive hyphens.
*/
CertificateIdentifier?: String;
/**
* The date that the certificate was created.
*/
CertificateCreationDate?: TStamp;
/**
* The contents of a .pem file, which contains an X.509 certificate.
*/
CertificatePem?: String;
/**
* The location of an imported Oracle Wallet certificate for use with SSL.
*/
CertificateWallet?: CertificateWallet;
/**
* The Amazon Resource Name (ARN) for the certificate.
*/
CertificateArn?: String;
/**
* The owner of the certificate.
*/
CertificateOwner?: String;
/**
* The beginning date that the certificate is valid.
*/
ValidFromDate?: TStamp;
/**
* The final date that the certificate is valid.
*/
ValidToDate?: TStamp;
/**
* The signing algorithm for the certificate.
*/
SigningAlgorithm?: String;
/**
* The key length of the cryptographic algorithm being used.
*/
KeyLength?: IntegerOptional;
}
export type CertificateList = Certificate[];
export type CertificateWallet = Buffer|Uint8Array|Blob|string;
export type CharLengthSemantics = "default"|"char"|"byte"|string;
export type CompressionTypeValue = "none"|"gzip"|string;
export interface Connection {
/**
* The ARN of the replication instance.
*/
ReplicationInstanceArn?: String;
/**
* The ARN string that uniquely identifies the endpoint.
*/
EndpointArn?: String;
/**
* The connection status. This parameter can return one of the following values: "successful" "testing" "failed" "deleting"
*/
Status?: String;
/**
* The error message when the connection last failed.
*/
LastFailureMessage?: String;
/**
* The identifier of the endpoint. Identifiers must begin with a letter and must contain only ASCII letters, digits, and hyphens. They can't end with a hyphen or contain two consecutive hyphens.
*/
EndpointIdentifier?: String;
/**
* The replication instance identifier. This parameter is stored as a lowercase string.
*/
ReplicationInstanceIdentifier?: String;
}
export type ConnectionList = Connection[];
export interface CreateEndpointMessage {
/**
* The database endpoint identifier. Identifiers must begin with a letter and must contain only ASCII letters, digits, and hyphens. They can't end with a hyphen, or contain two consecutive hyphens.
*/
EndpointIdentifier: String;
/**
* The type of endpoint. Valid values are source and target.
*/
EndpointType: ReplicationEndpointTypeValue;
/**
* The type of engine for the endpoint. Valid values, depending on the EndpointType value, include "mysql", "oracle", "postgres", "mariadb", "aurora", "aurora-postgresql", "redshift", "s3", "db2", "azuredb", "sybase", "dynamodb", "mongodb", "kinesis", "kafka", "elasticsearch", "docdb", "sqlserver", and "neptune".
*/
EngineName: String;
/**
* The user name to be used to log in to the endpoint database.
*/
Username?: String;
/**
* The password to be used to log in to the endpoint database.
*/
Password?: SecretString;
/**
* The name of the server where the endpoint database resides.
*/
ServerName?: String;
/**
* The port used by the endpoint database.
*/
Port?: IntegerOptional;
/**
* The name of the endpoint database.
*/
DatabaseName?: String;
/**
* Additional attributes associated with the connection. Each attribute is specified as a name-value pair associated by an equal sign (=). Multiple attributes are separated by a semicolon (;) with no additional white space. For information on the attributes available for connecting your source or target endpoint, see Working with AWS DMS Endpoints in the AWS Database Migration Service User Guide.
*/
ExtraConnectionAttributes?: String;
/**
* An AWS KMS key identifier that is used to encrypt the connection parameters for the endpoint. If you don't specify a value for the KmsKeyId parameter, then AWS DMS uses your default encryption key. AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS Region.
*/
KmsKeyId?: String;
/**
* One or more tags to be assigned to the endpoint.
*/
Tags?: TagList;
/**
* The Amazon Resource Name (ARN) for the certificate.
*/
CertificateArn?: String;
/**
* The Secure Sockets Layer (SSL) mode to use for the SSL connection. The default is none
*/
SslMode?: DmsSslModeValue;
/**
* The Amazon Resource Name (ARN) for the service access role that you want to use to create the endpoint.
*/
ServiceAccessRoleArn?: String;
/**
* The external table definition.
*/
ExternalTableDefinition?: String;
/**
* Settings in JSON format for the target Amazon DynamoDB endpoint. For information about other available settings, see Using Object Mapping to Migrate Data to DynamoDB in the AWS Database Migration Service User Guide.
*/
DynamoDbSettings?: DynamoDbSettings;
/**
* Settings in JSON format for the target Amazon S3 endpoint. For more information about the available settings, see Extra Connection Attributes When Using Amazon S3 as a Target for AWS DMS in the AWS Database Migration Service User Guide.
*/
S3Settings?: S3Settings;
/**
* The settings in JSON format for the DMS transfer type of source endpoint. Possible settings include the following: ServiceAccessRoleArn - The IAM role that has permission to access the Amazon S3 bucket. BucketName - The name of the S3 bucket to use. CompressionType - An optional parameter to use GZIP to compress the target files. To use GZIP, set this value to NONE (the default). To keep the files uncompressed, don't use this value. Shorthand syntax for these settings is as follows: ServiceAccessRoleArn=string,BucketName=string,CompressionType=string JSON syntax for these settings is as follows: { "ServiceAccessRoleArn": "string", "BucketName": "string", "CompressionType": "none"|"gzip" }
*/
DmsTransferSettings?: DmsTransferSettings;
/**
* Settings in JSON format for the source MongoDB endpoint. For more information about the available settings, see Using MongoDB as a Target for AWS Database Migration Service in the AWS Database Migration Service User Guide.
*/
MongoDbSettings?: MongoDbSettings;
/**
* Settings in JSON format for the target endpoint for Amazon Kinesis Data Streams. For more information about the available settings, see Using Amazon Kinesis Data Streams as a Target for AWS Database Migration Service in the AWS Database Migration Service User Guide.
*/
KinesisSettings?: KinesisSettings;
/**
* Settings in JSON format for the target Apache Kafka endpoint. For more information about the available settings, see Using Apache Kafka as a Target for AWS Database Migration Service in the AWS Database Migration Service User Guide.
*/
KafkaSettings?: KafkaSettings;
/**
* Settings in JSON format for the target Elasticsearch endpoint. For more information about the available settings, see Extra Connection Attributes When Using Elasticsearch as a Target for AWS DMS in the AWS Database Migration Service User Guide.
*/
ElasticsearchSettings?: ElasticsearchSettings;
/**
* Settings in JSON format for the target Amazon Neptune endpoint. For more information about the available settings, see Specifying Endpoint Settings for Amazon Neptune as a Target in the AWS Database Migration Service User Guide.
*/
NeptuneSettings?: NeptuneSettings;
RedshiftSettings?: RedshiftSettings;
/**
* Settings in JSON format for the source and target PostgreSQL endpoint. For information about other available settings, see Extra connection attributes when using PostgreSQL as a source for AWS DMS and Extra connection attributes when using PostgreSQL as a target for AWS DMS in the AWS Database Migration Service User Guide.
*/
PostgreSQLSettings?: PostgreSQLSettings;
/**
* Settings in JSON format for the source and target MySQL endpoint. For information about other available settings, see Extra connection attributes when using MySQL as a source for AWS DMS and Extra connection attributes when using a MySQL-compatible database as a target for AWS DMS in the AWS Database Migration Service User Guide.
*/
MySQLSettings?: MySQLSettings;
/**
* Settings in JSON format for the source and target Oracle endpoint. For information about other available settings, see Extra connection attributes when using Oracle as a source for AWS DMS and Extra connection attributes when using Oracle as a target for AWS DMS in the AWS Database Migration Service User Guide.
*/
OracleSettings?: OracleSettings;
/**
* Settings in JSON format for the source and target SAP ASE endpoint. For information about other available settings, see Extra connection attributes when using SAP ASE as a source for AWS DMS and Extra connection attributes when using SAP ASE as a target for AWS DMS in the AWS Database Migration Service User Guide.
*/
SybaseSettings?: SybaseSettings;
/**
* Settings in JSON format for the source and target Microsoft SQL Server endpoint. For information about other available settings, see Extra connection attributes when using SQL Server as a source for AWS DMS and Extra connection attributes when using SQL Server as a target for AWS DMS in the AWS Database Migration Service User Guide.
*/
MicrosoftSQLServerSettings?: MicrosoftSQLServerSettings;
/**
* Settings in JSON format for the source IBM Db2 LUW endpoint. For information about other available settings, see Extra connection attributes when using Db2 LUW as a source for AWS DMS in the AWS Database Migration Service User Guide.
*/
IBMDb2Settings?: IBMDb2Settings;
}
export interface CreateEndpointResponse {
/**
* The endpoint that was created.
*/
Endpoint?: Endpoint;
}
export interface CreateEventSubscriptionMessage {
/**
* The name of the AWS DMS event notification subscription. This name must be less than 255 characters.
*/
SubscriptionName: String;
/**
* The Amazon Resource Name (ARN) of the Amazon SNS topic created for event notification. The ARN is created by Amazon SNS when you create a topic and subscribe to it.
*/
SnsTopicArn: String;
/**
* The type of AWS DMS resource that generates the events. For example, if you want to be notified of events generated by a replication instance, you set this parameter to replication-instance. If this value isn't specified, all events are returned. Valid values: replication-instance | replication-task
*/
SourceType?: String;
/**
* A list of event categories for a source type that you want to subscribe to. For more information, see Working with Events and Notifications in the AWS Database Migration Service User Guide.
*/
EventCategories?: EventCategoriesList;
/**
* A list of identifiers for which AWS DMS provides notification events. If you don't specify a value, notifications are provided for all sources. If you specify multiple values, they must be of the same type. For example, if you specify a database instance ID, then all of the other values must be database instance IDs.
*/
SourceIds?: SourceIdsList;
/**
* A Boolean value; set to true to activate the subscription, or set to false to create the subscription but not activate it.
*/
Enabled?: BooleanOptional;
/**
* One or more tags to be assigned to the event subscription.
*/
Tags?: TagList;
}
export interface CreateEventSubscriptionResponse {
/**
* The event subscription that was created.
*/
EventSubscription?: EventSubscription;
}
export interface CreateReplicationInstanceMessage {
/**
* The replication instance identifier. This parameter is stored as a lowercase string. Constraints: Must contain 1-63 alphanumeric characters or hyphens. First character must be a letter. Can't end with a hyphen or contain two consecutive hyphens. Example: myrepinstance
*/
ReplicationInstanceIdentifier: String;
/**
* The amount of storage (in gigabytes) to be initially allocated for the replication instance.
*/
AllocatedStorage?: IntegerOptional;
/**
* The compute and memory capacity of the replication instance as defined for the specified replication instance class. For example to specify the instance class dms.c4.large, set this parameter to "dms.c4.large". For more information on the settings and capacities for the available replication instance classes, see Selecting the right AWS DMS replication instance for your migration.
*/
ReplicationInstanceClass: String;
/**
* Specifies the VPC security group to be used with the replication instance. The VPC security group must work with the VPC containing the replication instance.
*/
VpcSecurityGroupIds?: VpcSecurityGroupIdList;
/**
* The Availability Zone where the replication instance will be created. The default value is a random, system-chosen Availability Zone in the endpoint's AWS Region, for example: us-east-1d
*/
AvailabilityZone?: String;
/**
* A subnet group to associate with the replication instance.
*/
ReplicationSubnetGroupIdentifier?: String;
/**
* The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC). Format: ddd:hh24:mi-ddd:hh24:mi Default: A 30-minute window selected at random from an 8-hour block of time per AWS Region, occurring on a random day of the week. Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun Constraints: Minimum 30-minute window.
*/
PreferredMaintenanceWindow?: String;
/**
* Specifies whether the replication instance is a Multi-AZ deployment. You can't set the AvailabilityZone parameter if the Multi-AZ parameter is set to true.
*/
MultiAZ?: BooleanOptional;
/**
* The engine version number of the replication instance. If an engine version number is not specified when a replication instance is created, the default is the latest engine version available.
*/
EngineVersion?: String;
/**
* A value that indicates whether minor engine upgrades are applied automatically to the replication instance during the maintenance window. This parameter defaults to true. Default: true
*/
AutoMinorVersionUpgrade?: BooleanOptional;
/**
* One or more tags to be assigned to the replication instance.
*/
Tags?: TagList;
/**
* An AWS KMS key identifier that is used to encrypt the data on the replication instance. If you don't specify a value for the KmsKeyId parameter, then AWS DMS uses your default encryption key. AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS Region.
*/
KmsKeyId?: String;
/**
* Specifies the accessibility options for the replication instance. A value of true represents an instance with a public IP address. A value of false represents an instance with a private IP address. The default value is true.
*/
PubliclyAccessible?: BooleanOptional;
/**
* A list of custom DNS name servers supported for the replication instance to access your on-premise source or target database. This list overrides the default name servers supported by the replication instance. You can specify a comma-separated list of internet addresses for up to four on-premise DNS name servers. For example: "1.1.1.1,2.2.2.2,3.3.3.3,4.4.4.4"
*/
DnsNameServers?: String;
}
export interface CreateReplicationInstanceResponse {
/**
* The replication instance that was created.
*/
ReplicationInstance?: ReplicationInstance;
}
export interface CreateReplicationSubnetGroupMessage {
/**
* The name for the replication subnet group. This value is stored as a lowercase string. Constraints: Must contain no more than 255 alphanumeric characters, periods, spaces, underscores, or hyphens. Must not be "default". Example: mySubnetgroup
*/
ReplicationSubnetGroupIdentifier: String;
/**
* The description for the subnet group.
*/
ReplicationSubnetGroupDescription: String;
/**
* One or more subnet IDs to be assigned to the subnet group.
*/
SubnetIds: SubnetIdentifierList;
/**
* One or more tags to be assigned to the subnet group.
*/
Tags?: TagList;
}
export interface CreateReplicationSubnetGroupResponse {
/**
* The replication subnet group that was created.
*/
ReplicationSubnetGroup?: ReplicationSubnetGroup;
}
export interface CreateReplicationTaskMessage {
/**
* An identifier for the replication task. Constraints: Must contain 1-255 alphanumeric characters or hyphens. First character must be a letter. Cannot end with a hyphen or contain two consecutive hyphens.
*/
ReplicationTaskIdentifier: String;
/**
* An Amazon Resource Name (ARN) that uniquely identifies the source endpoint.
*/
SourceEndpointArn: String;
/**
* An Amazon Resource Name (ARN) that uniquely identifies the target endpoint.
*/
TargetEndpointArn: String;
/**
* The Amazon Resource Name (ARN) of a replication instance.
*/
ReplicationInstanceArn: String;
/**
* The migration type. Valid values: full-load | cdc | full-load-and-cdc
*/
MigrationType: MigrationTypeValue;
/**
* The table mappings for the task, in JSON format. For more information, see Using Table Mapping to Specify Task Settings in the AWS Database Migration Service User Guide.
*/
TableMappings: String;
/**
* Overall settings for the task, in JSON format. For more information, see Specifying Task Settings for AWS Database Migration Service Tasks in the AWS Database Migration User Guide.
*/
ReplicationTaskSettings?: String;
/**
* Indicates the start time for a change data capture (CDC) operation. Use either CdcStartTime or CdcStartPosition to specify when you want a CDC operation to start. Specifying both values results in an error. Timestamp Example: --cdc-start-time “2018-03-08T12:12:12”
*/
CdcStartTime?: TStamp;
/**
* Indicates when you want a change data capture (CDC) operation to start. Use either CdcStartPosition or CdcStartTime to specify when you want a CDC operation to start. Specifying both values results in an error. The value can be in date, checkpoint, or LSN/SCN format. Date Example: --cdc-start-position “2018-03-08T12:12:12” Checkpoint Example: --cdc-start-position "checkpoint:V1#27#mysql-bin-changelog.157832:1975:-1:2002:677883278264080:mysql-bin-changelog.157832:1876#0#0#*#0#93" LSN Example: --cdc-start-position “mysql-bin-changelog.000024:373” When you use this task setting with a source PostgreSQL database, a logical replication slot should already be created and associated with the source endpoint. You can verify this by setting the slotName extra connection attribute to the name of this logical replication slot. For more information, see Extra Connection Attributes When Using PostgreSQL as a Source for AWS DMS.
*/
CdcStartPosition?: String;
/**
* Indicates when you want a change data capture (CDC) operation to stop. The value can be either server time or commit time. Server time example: --cdc-stop-position “server_time:2018-02-09T12:12:12” Commit time example: --cdc-stop-position “commit_time: 2018-02-09T12:12:12 “
*/
CdcStopPosition?: String;
/**
* One or more tags to be assigned to the replication task.
*/
Tags?: TagList;
/**
* Supplemental information that the task requires to migrate the data for certain source and target endpoints. For more information, see Specifying Supplemental Data for Task Settings in the AWS Database Migration Service User Guide.
*/
TaskData?: String;
}
export interface CreateReplicationTaskResponse {
/**
* The replication task that was created.
*/
ReplicationTask?: ReplicationTask;
}
export type DataFormatValue = "csv"|"parquet"|string;
export type DatePartitionDelimiterValue = "SLASH"|"UNDERSCORE"|"DASH"|"NONE"|string;
export type DatePartitionSequenceValue = "YYYYMMDD"|"YYYYMMDDHH"|"YYYYMM"|"MMYYYYDD"|"DDMMYYYY"|string;
export interface DeleteCertificateMessage {
/**
* The Amazon Resource Name (ARN) of the deleted certificate.
*/
CertificateArn: String;
}
export interface DeleteCertificateResponse {
/**
* The Secure Sockets Layer (SSL) certificate.
*/
Certificate?: Certificate;
}
export interface DeleteConnectionMessage {
/**
* The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.
*/
EndpointArn: String;
/**
* The Amazon Resource Name (ARN) of the replication instance.
*/
ReplicationInstanceArn: String;
}
export interface DeleteConnectionResponse {
/**
* The connection that is being deleted.
*/
Connection?: Connection;
}
export interface DeleteEndpointMessage {
/**
* The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.
*/
EndpointArn: String;
}
export interface DeleteEndpointResponse {
/**
* The endpoint that was deleted.
*/
Endpoint?: Endpoint;
}
export interface DeleteEventSubscriptionMessage {
/**
* The name of the DMS event notification subscription to be deleted.
*/
SubscriptionName: String;
}
export interface DeleteEventSubscriptionResponse {
/**
* The event subscription that was deleted.
*/
EventSubscription?: EventSubscription;
}
export interface DeleteReplicationInstanceMessage {
/**
* The Amazon Resource Name (ARN) of the replication instance to be deleted.
*/
ReplicationInstanceArn: String;
}
export interface DeleteReplicationInstanceResponse {
/**
* The replication instance that was deleted.
*/
ReplicationInstance?: ReplicationInstance;
}
export interface DeleteReplicationSubnetGroupMessage {
/**
* The subnet group name of the replication instance.
*/
ReplicationSubnetGroupIdentifier: String;
}
export interface DeleteReplicationSubnetGroupResponse {
}
export interface DeleteReplicationTaskAssessmentRunMessage {
/**
* Amazon Resource Name (ARN) of the premigration assessment run to be deleted.
*/
ReplicationTaskAssessmentRunArn: String;
}
export interface DeleteReplicationTaskAssessmentRunResponse {
/**
* The ReplicationTaskAssessmentRun object for the deleted assessment run.
*/
ReplicationTaskAssessmentRun?: ReplicationTaskAssessmentRun;
}
export interface DeleteReplicationTaskMessage {
/**
* The Amazon Resource Name (ARN) of the replication task to be deleted.
*/
ReplicationTaskArn: String;
}
export interface DeleteReplicationTaskResponse {
/**
* The deleted replication task.
*/
ReplicationTask?: ReplicationTask;
}
export interface DescribeAccountAttributesMessage {
}
export interface DescribeAccountAttributesResponse {
/**
* Account quota information.
*/
AccountQuotas?: AccountQuotaList;
/**
* A unique AWS DMS identifier for an account in a particular AWS Region. The value of this identifier has the following format: c99999999999. DMS uses this identifier to name artifacts. For example, DMS uses this identifier to name the default Amazon S3 bucket for storing task assessment reports in a given AWS Region. The format of this S3 bucket name is the following: dms-AccountNumber-UniqueAccountIdentifier. Here is an example name for this default S3 bucket: dms-111122223333-c44445555666. AWS DMS supports the UniqueAccountIdentifier parameter in versions 3.1.4 and later.
*/
UniqueAccountIdentifier?: String;
}
export interface DescribeApplicableIndividualAssessmentsMessage {
/**
* Amazon Resource Name (ARN) of a migration task on which you want to base the default list of individual assessments.
*/
ReplicationTaskArn?: String;
/**
* ARN of a replication instance on which you want to base the default list of individual assessments.
*/
ReplicationInstanceArn?: String;
/**
* Name of a database engine that the specified replication instance supports as a source.
*/
SourceEngineName?: String;
/**
* Name of a database engine that the specified replication instance supports as a target.
*/
TargetEngineName?: String;
/**
* Name of the migration type that each provided individual assessment must support.
*/
MigrationType?: MigrationTypeValue;
/**
* 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;
/**
* Optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
*/
Marker?: String;
}
export interface DescribeApplicableIndividualAssessmentsResponse {
/**
* List of names for the individual assessments supported by the premigration assessment run that you start based on the specified request parameters. For more information on the available individual assessments, including compatibility with different migration task configurations, see Working with premigration assessment runs in the AWS Database Migration Service User Guide.
*/
IndividualAssessmentNames?: IndividualAssessmentNameList;
/**
* Pagination token returned for you to pass to a subsequent request. If you pass this token as the Marker value in a subsequent request, the response includes only records beyond the marker, up to the value specified in the request by MaxRecords.
*/
Marker?: String;
}
export interface DescribeCertificatesMessage {
/**
* Filters applied to the certificates described in the form of key-value pairs.
*/
Filters?: FilterList;
/**
* 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. Default: 10
*/
MaxRecords?: IntegerOptional;
/**
* An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
*/
Marker?: String;
}
export interface DescribeCertificatesResponse {
/**
* The pagination token.
*/
Marker?: String;
/**
* The Secure Sockets Layer (SSL) certificates associated with the replication instance.
*/
Certificates?: CertificateList;
}
export interface DescribeConnectionsMessage {
/**
* The filters applied to the connection. Valid filter names: endpoint-arn | replication-instance-arn
*/
Filters?: FilterList;
/**
* 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. Default: 100 Constraints: Minimum 20, maximum 100.
*/
MaxRecords?: IntegerOptional;
/**
* An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
*/
Marker?: String;
}
export interface DescribeConnectionsResponse {
/**
* An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
*/
Marker?: String;
/**
* A description of the connections.
*/
Connections?: ConnectionList;
}
export interface DescribeEndpointTypesMessage {
/**
* Filters applied to the endpoint types. Valid filter names: engine-name | endpoint-type
*/
Filters?: FilterList;
/**
* 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. Default: 100 Constraints: Minimum 20, maximum 100.
*/
MaxRecords?: IntegerOptional;
/**
* An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
*/
Marker?: String;
}
export interface DescribeEndpointTypesResponse {
/**
* An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
*/
Marker?: String;
/**
* The types of endpoints that are supported.
*/
SupportedEndpointTypes?: SupportedEndpointTypeList;
}
export interface DescribeEndpointsMessage {
/**
* Filters applied to the endpoints. Valid filter names: endpoint-arn | endpoint-type | endpoint-id | engine-name
*/
Filters?: FilterList;
/**
* 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. Default: 100 Constraints: Minimum 20, maximum 100.
*/
MaxRecords?: IntegerOptional;
/**
* An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
*/
Marker?: String;
}
export interface DescribeEndpointsResponse {
/**
* An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
*/
Marker?: String;
/**
* Endpoint description.
*/
Endpoints?: EndpointList;
}
export interface DescribeEventCategoriesMessage {
/**
* The type of AWS DMS resource that generates events. Valid values: replication-instance | replication-task
*/
SourceType?: String;
/**
* Filters applied to the event categories.
*/
Filters?: FilterList;
}
export interface DescribeEventCategoriesResponse {
/**
* A list of event categories.
*/
EventCategoryGroupList?: EventCategoryGroupList;
}
export interface DescribeEventSubscriptionsMessage {
/**
* The name of the AWS DMS event subscription to be described.
*/
SubscriptionName?: String;
/**
* Filters applied to event subscriptions.
*/
Filters?: FilterList;
/**
* 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. Default: 100 Constraints: Minimum 20, maximum 100.
*/
MaxRecords?: IntegerOptional;
/**
* An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
*/
Marker?: String;
}
export interface DescribeEventSubscriptionsResponse {
/**
* An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
*/
Marker?: String;
/**
* A list of event subscriptions.
*/
EventSubscriptionsList?: EventSubscriptionsList;
}
export interface DescribeEventsMessage {
/**
* The identifier of an event source.
*/
SourceIdentifier?: String;
/**
* The type of AWS DMS resource that generates events. Valid values: replication-instance | replication-task
*/
SourceType?: SourceType;
/**
* The start time for the events to be listed.
*/
StartTime?: TStamp;
/**
* The end time for the events to be listed.
*/
EndTime?: TStamp;
/**
* The duration of the events to be listed.
*/
Duration?: IntegerOptional;
/**
* A list of event categories for the source type that you've chosen.
*/
EventCategories?: EventCategoriesList;
/**
* Filters applied to events.
*/
Filters?: FilterList;
/**
* 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. Default: 100 Constraints: Minimum 20, maximum 100.
*/
MaxRecords?: IntegerOptional;
/**
* An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
*/
Marker?: String;
}
export interface DescribeEventsResponse {
/**
* An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
*/
Marker?: String;
/**
* The events described.
*/
Events?: EventList;
}
export interface DescribeOrderableReplicationInstancesMessage {
/**
* 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. Default: 100 Constraints: Minimum 20, maximum 100.
*/
MaxRecords?: IntegerOptional;
/**
* An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
*/
Marker?: String;
}
export interface DescribeOrderableReplicationInstancesResponse {
/**
* The order-able replication instances available.
*/
OrderableReplicationInstances?: OrderableReplicationInstanceList;
/**
* An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
*/
Marker?: String;
}
export interface DescribePendingMaintenanceActionsMessage {
/**
* The Amazon Resource Name (ARN) of the replication instance.
*/
ReplicationInstanceArn?: String;
/**
*
*/
Filters?: FilterList;
/**
* An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
*/
Marker?: 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. Default: 100 Constraints: Minimum 20, maximum 100.
*/
MaxRecords?: IntegerOptional;
}
export interface DescribePendingMaintenanceActionsResponse {
/**
* The pending maintenance action.
*/
PendingMaintenanceActions?: PendingMaintenanceActions;
/**
* An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
*/
Marker?: String;
}
export interface DescribeRefreshSchemasStatusMessage {
/**
* The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.
*/
EndpointArn: String;
}
export interface DescribeRefreshSchemasStatusResponse {
/**
* The status of the schema.
*/
RefreshSchemasStatus?: RefreshSchemasStatus;
}
export interface DescribeReplicationInstanceTaskLogsMessage {
/**
* The Amazon Resource Name (ARN) of the replication instance.
*/
ReplicationInstanceArn: 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. Default: 100 Constraints: Minimum 20, maximum 100.
*/
MaxRecords?: IntegerOptional;
/**
* An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
*/
Marker?: String;
}
export interface DescribeReplicationInstanceTaskLogsResponse {
/**
* The Amazon Resource Name (ARN) of the replication instance.
*/
ReplicationInstanceArn?: String;
/**
* An array of replication task log metadata. Each member of the array contains the replication task name, ARN, and task log size (in bytes).
*/
ReplicationInstanceTaskLogs?: ReplicationInstanceTaskLogsList;
/**
* An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
*/
Marker?: String;
}
export interface DescribeReplicationInstancesMessage {
/**
* Filters applied to replication instances. Valid filter names: replication-instance-arn | replication-instance-id | replication-instance-class | engine-version
*/
Filters?: FilterList;
/**
* 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. Default: 100 Constraints: Minimum 20, maximum 100.
*/
MaxRecords?: IntegerOptional;
/**
* An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
*/
Marker?: String;
}
export interface DescribeReplicationInstancesResponse {
/**
* An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
*/
Marker?: String;
/**
* The replication instances described.
*/
ReplicationInstances?: ReplicationInstanceList;
}
export interface DescribeReplicationSubnetGroupsMessage {
/**
* Filters applied to replication subnet groups. Valid filter names: replication-subnet-group-id
*/
Filters?: FilterList;
/**
* 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. Default: 100 Constraints: Minimum 20, maximum 100.
*/
MaxRecords?: IntegerOptional;
/**
* An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
*/
Marker?: String;
}
export interface DescribeReplicationSubnetGroupsResponse {
/**
* An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
*/
Marker?: String;
/**
* A description of the replication subnet groups.
*/
ReplicationSubnetGroups?: ReplicationSubnetGroups;
}
export interface DescribeReplicationTaskAssessmentResultsMessage {
/**
* The Amazon Resource Name (ARN) string that uniquely identifies the task. When this input parameter is specified, the API returns only one result and ignore the values of the MaxRecords and Marker parameters.
*/
ReplicationTaskArn?: 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. Default: 100 Constraints: Minimum 20, maximum 100.
*/
MaxRecords?: IntegerOptional;
/**
* An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
*/
Marker?: String;
}
export interface DescribeReplicationTaskAssessmentResultsResponse {
/**
* An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
*/
Marker?: String;
/**
* - The Amazon S3 bucket where the task assessment report is located.
*/
BucketName?: String;
/**
* The task assessment report.
*/
ReplicationTaskAssessmentResults?: ReplicationTaskAssessmentResultList;
}
export interface DescribeReplicationTaskAssessmentRunsMessage {
/**
* Filters applied to the premigration assessment runs described in the form of key-value pairs. Valid filter names: replication-task-assessment-run-arn, replication-task-arn, replication-instance-arn, status
*/
Filters?: FilterList;
/**
* 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 request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
*/
Marker?: String;
}
export interface DescribeReplicationTaskAssessmentRunsResponse {
/**
* A pagination token returned for you to pass to a subsequent request. If you pass this token as the Marker value in a subsequent request, the response includes only records beyond the marker, up to the value specified in the request by MaxRecords.
*/
Marker?: String;
/**
* One or more premigration assessment runs as specified by Filters.
*/
ReplicationTaskAssessmentRuns?: ReplicationTaskAssessmentRunList;
}
export interface DescribeReplicationTaskIndividualAssessmentsMessage {
/**
* Filters applied to the individual assessments described in the form of key-value pairs. Valid filter names: replication-task-assessment-run-arn, replication-task-arn, status
*/
Filters?: FilterList;
/**
* 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 request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
*/
Marker?: String;
}
export interface DescribeReplicationTaskIndividualAssessmentsResponse {
/**
* A pagination token returned for you to pass to a subsequent request. If you pass this token as the Marker value in a subsequent request, the response includes only records beyond the marker, up to the value specified in the request by MaxRecords.
*/
Marker?: String;
/**
* One or more individual assessments as specified by Filters.
*/
ReplicationTaskIndividualAssessments?: ReplicationTaskIndividualAssessmentList;
}
export interface DescribeReplicationTasksMessage {
/**
* Filters applied to replication tasks. Valid filter names: replication-task-arn | replication-task-id | migration-type | endpoint-arn | replication-instance-arn
*/
Filters?: FilterList;
/**
* 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. Default: 100 Constraints: Minimum 20, maximum 100.
*/
MaxRecords?: IntegerOptional;
/**
* An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
*/
Marker?: String;
/**
* An option to set to avoid returning information about settings. Use this to reduce overhead when setting information is too large. To use this option, choose true; otherwise, choose false (the default).
*/
WithoutSettings?: BooleanOptional;
}
export interface DescribeReplicationTasksResponse {
/**
* An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
*/
Marker?: String;
/**
* A description of the replication tasks.
*/
ReplicationTasks?: ReplicationTaskList;
}
export interface DescribeSchemasMessage {
/**
* The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.
*/
EndpointArn: 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. Default: 100 Constraints: Minimum 20, maximum 100.
*/
MaxRecords?: IntegerOptional;
/**
* An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
*/
Marker?: String;
}
export interface DescribeSchemasResponse {
/**
* An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
*/
Marker?: String;
/**
* The described schema.
*/
Schemas?: SchemaList;
}
export interface DescribeTableStatisticsMessage {
/**
* The Amazon Resource Name (ARN) of the replication task.
*/
ReplicationTaskArn: 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. Default: 100 Constraints: Minimum 20, maximum 500.
*/
MaxRecords?: IntegerOptional;
/**
* An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
*/
Marker?: String;
/**
* Filters applied to table statistics. Valid filter names: schema-name | table-name | table-state A combination of filters creates an AND condition where each record matches all specified filters.
*/
Filters?: FilterList;
}
export interface DescribeTableStatisticsResponse {
/**
* The Amazon Resource Name (ARN) of the replication task.
*/
ReplicationTaskArn?: String;
/**
* The table statistics.
*/
TableStatistics?: TableStatisticsList;
/**
* An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
*/
Marker?: String;
}
export type DmsSslModeValue = "none"|"require"|"verify-ca"|"verify-full"|string;
export interface DmsTransferSettings {
/**
* The IAM role that has permission to access the Amazon S3 bucket.
*/
ServiceAccessRoleArn?: String;
/**
* The name of the S3 bucket to use.
*/
BucketName?: String;
}
export interface DynamoDbSettings {
/**
* The Amazon Resource Name (ARN) used by the service access IAM role.
*/
ServiceAccessRoleArn: String;
}
export interface ElasticsearchSettings {
/**
* The Amazon Resource Name (ARN) used by service to access the IAM role.
*/
ServiceAccessRoleArn: String;
/**
* The endpoint for the Elasticsearch cluster. AWS DMS uses HTTPS if a transport protocol (http/https) is not specified.
*/
EndpointUri: String;
/**
* The maximum percentage of records that can fail to be written before a full load operation stops. To avoid early failure, this counter is only effective after 1000 records are transferred. Elasticsearch also has the concept of error monitoring during the last 10 minutes of an Observation Window. If transfer of all records fail in the last 10 minutes, the full load operation stops.
*/
FullLoadErrorPercentage?: IntegerOptional;
/**
* The maximum number of seconds for which DMS retries failed API requests to the Elasticsearch cluster.
*/
ErrorRetryDuration?: IntegerOptional;
}
export type EncodingTypeValue = "plain"|"plain-dictionary"|"rle-dictionary"|string;
export type EncryptionModeValue = "sse-s3"|"sse-kms"|string;
export interface Endpoint {
/**
* The database endpoint identifier. Identifiers must begin with a letter and must contain only ASCII letters, digits, and hyphens. They can't end with a hyphen or contain two consecutive hyphens.
*/
EndpointIdentifier?: String;
/**
* The type of endpoint. Valid values are source and target.
*/
EndpointType?: ReplicationEndpointTypeValue;
/**
* The database engine name. Valid values, depending on the EndpointType, include "mysql", "oracle", "postgres", "mariadb", "aurora", "aurora-postgresql", "redshift", "s3", "db2", "azuredb", "sybase", "dynamodb", "mongodb", "kinesis", "kafka", "elasticsearch", "documentdb", "sqlserver", and "neptune".
*/
EngineName?: String;
/**
* The expanded name for the engine name. For example, if the EngineName parameter is "aurora," this value would be "Amazon Aurora MySQL."
*/
EngineDisplayName?: String;
/**
* The user name used to connect to the endpoint.
*/
Username?: String;
/**
* The name of the server at the endpoint.
*/
ServerName?: String;
/**
* The port value used to access the endpoint.
*/
Port?: IntegerOptional;
/**
* The name of the database at the endpoint.
*/
DatabaseName?: String;
/**
* Additional connection attributes used to connect to the endpoint.
*/
ExtraConnectionAttributes?: String;
/**
* The status of the endpoint.
*/
Status?: String;
/**
* An AWS KMS key identifier that is used to encrypt the connection parameters for the endpoint. If you don't specify a value for the KmsKeyId parameter, then AWS DMS uses your default encryption key. AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS Region.
*/
KmsKeyId?: String;
/**
* The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.
*/
EndpointArn?: String;
/**
* The Amazon Resource Name (ARN) used for SSL connection to the endpoint.
*/
CertificateArn?: String;
/**
* The SSL mode used to connect to the endpoint. The default value is none.
*/
SslMode?: DmsSslModeValue;
/**
* The Amazon Resource Name (ARN) used by the service access IAM role.
*/
ServiceAccessRoleArn?: String;
/**
* The external table definition.
*/
ExternalTableDefinition?: String;
/**
* Value returned by a call to CreateEndpoint that can be used for cross-account validation. Use it on a subsequent call to CreateEndpoint to create the endpoint with a cross-account.
*/
ExternalId?: String;
/**
* The settings for the DynamoDB target endpoint. For more information, see the DynamoDBSettings structure.
*/
DynamoDbSettings?: DynamoDbSettings;
/**
* The settings for the S3 target endpoint. For more information, see the S3Settings structure.
*/
S3Settings?: S3Settings;
/**
* The settings in JSON format for the DMS transfer type of source endpoint. Possible settings include the following: ServiceAccessRoleArn - The IAM role that has permission to access the Amazon S3 bucket. BucketName - The name of the S3 bucket to use. CompressionType - An optional parameter to use GZIP to compress the target files. To use GZIP, set this value to NONE (the default). To keep the files uncompressed, don't use this value. Shorthand syntax for these settings is as follows: ServiceAccessRoleArn=string,BucketName=string,CompressionType=string JSON syntax for these settings is as follows: { "ServiceAccessRoleArn": "string", "BucketName": "string", "CompressionType": "none"|"gzip" }
*/
DmsTransferSettings?: DmsTransferSettings;
/**
* The settings for the MongoDB source endpoint. For more information, see the MongoDbSettings structure.
*/
MongoDbSettings?: MongoDbSettings;
/**
* The settings for the Amazon Kinesis target endpoint. For more information, see the KinesisSettings structure.
*/
KinesisSettings?: KinesisSettings;
/**
* The settings for the Apache Kafka target endpoint. For more information, see the KafkaSettings structure.
*/
KafkaSettings?: KafkaSettings;
/**
* The settings for the Elasticsearch source endpoint. For more information, see the ElasticsearchSettings structure.
*/
ElasticsearchSettings?: ElasticsearchSettings;
/**
* The settings for the Amazon Neptune target endpoint. For more information, see the NeptuneSettings structure.
*/
NeptuneSettings?: NeptuneSettings;
/**
* Settings for the Amazon Redshift endpoint.
*/
RedshiftSettings?: RedshiftSettings;
/**
* The settings for the PostgreSQL source and target endpoint. For more information, see the PostgreSQLSettings structure.
*/
PostgreSQLSettings?: PostgreSQLSettings;
/**
* The settings for the MySQL source and target endpoint. For more information, see the MySQLSettings structure.
*/
MySQLSettings?: MySQLSettings;
/**
* The settings for the Oracle source and target endpoint. For more information, see the OracleSettings structure.
*/
OracleSettings?: OracleSettings;
/**
* The settings for the SAP ASE source and target endpoint. For more information, see the SybaseSettings structure.
*/
SybaseSettings?: SybaseSettings;
/**
* The settings for the Microsoft SQL Server source and target endpoint. For more information, see the MicrosoftSQLServerSettings structure.
*/
MicrosoftSQLServerSettings?: MicrosoftSQLServerSettings;
/**
* The settings for the IBM Db2 LUW source endpoint. For more information, see the IBMDb2Settings structure.
*/
IBMDb2Settings?: IBMDb2Settings;
}
export type EndpointList = Endpoint[];
export interface Event {
/**
* The identifier of an event source.
*/
SourceIdentifier?: String;
/**
* The type of AWS DMS resource that generates events. Valid values: replication-instance | endpoint | replication-task
*/
SourceType?: SourceType;
/**
* The event message.
*/
Message?: String;
/**
* The event categories available for the specified source type.
*/
EventCategories?: EventCategoriesList;
/**
* The date of the event.
*/
Date?: TStamp;
}
export type EventCategoriesList = String[];
export interface EventCategoryGroup {
/**
* The type of AWS DMS resource that generates events. Valid values: replication-instance | replication-server | security-group | replication-task
*/
SourceType?: String;
/**
* A list of event categories from a source type that you've chosen.
*/
EventCategories?: EventCategoriesList;
}
export type EventCategoryGroupList = EventCategoryGroup[];
export type EventList = Event[];
export interface EventSubscription {
/**
* The AWS customer account associated with the AWS DMS event notification subscription.
*/
CustomerAwsId?: String;
/**
* The AWS DMS event notification subscription Id.
*/
CustSubscriptionId?: String;
/**
* The topic ARN of the AWS DMS event notification subscription.
*/
SnsTopicArn?: String;
/**
* The status of the AWS DMS event notification subscription. Constraints: Can be one of the following: creating | modifying | deleting | active | no-permission | topic-not-exist The status "no-permission" indicates that AWS DMS no longer has permission to post to the SNS topic. The status "topic-not-exist" indicates that the topic was deleted after the subscription was created.
*/
Status?: String;
/**
* The time the AWS DMS event notification subscription was created.
*/
SubscriptionCreationTime?: String;
/**
* The type of AWS DMS resource that generates events. Valid values: replication-instance | replication-server | security-group | replication-task
*/
SourceType?: String;
/**
* A list of source Ids for the event subscription.
*/
SourceIdsList?: SourceIdsList;
/**
* A lists of event categories.
*/
EventCategoriesList?: EventCategoriesList;
/**
* Boolean value that indicates if the event subscription is enabled.
*/
Enabled?: Boolean;
}
export type EventSubscriptionsList = EventSubscription[];
export type ExcludeTestList = String[];
export interface Filter {
/**
* The name of the filter as specified for a Describe* or similar operation.
*/
Name: String;
/**
* The filter value, which can specify one or more values used to narrow the returned results.
*/
Values: FilterValueList;
}
export type FilterList = Filter[];
export type FilterValueList = String[];
export interface IBMDb2Settings {
/**
* Database name for the endpoint.
*/
DatabaseName?: String;
/**
* Endpoint connection password.
*/
Password?: SecretString;
/**
* Endpoint TCP port.
*/
Port?: IntegerOptional;
/**
* Fully qualified domain name of the endpoint.
*/
ServerName?: String;
/**
* Enables ongoing replication (CDC) as a BOOLEAN value. The default is true.
*/
SetDataCaptureChanges?: BooleanOptional;
/**
* For ongoing replication (CDC), use CurrentLSN to specify a log sequence number (LSN) where you want the replication to start.
*/
CurrentLsn?: String;
/**
* Maximum number of bytes per read, as a NUMBER value. The default is 64 KB.
*/
MaxKBytesPerRead?: IntegerOptional;
/**
* Endpoint connection user name.
*/
Username?: String;
}
export interface ImportCertificateMessage {
/**
* A customer-assigned name for the certificate. Identifiers must begin with a letter and must contain only ASCII letters, digits, and hyphens. They can't end with a hyphen or contain two consecutive hyphens.
*/
CertificateIdentifier: String;
/**
* The contents of a .pem file, which contains an X.509 certificate.
*/
CertificatePem?: String;
/**
* The location of an imported Oracle Wallet certificate for use with SSL.
*/
CertificateWallet?: CertificateWallet;
/**
* The tags associated with the certificate.
*/
Tags?: TagList;
}
export interface ImportCertificateResponse {
/**
* The certificate to be uploaded.
*/
Certificate?: Certificate;
}
export type IncludeTestList = String[];
export type IndividualAssessmentNameList = String[];
export type Integer = number;
export type IntegerOptional = number;
export interface KafkaSettings {
/**
* The broker location and port of the Kafka broker that hosts your Kafka instance. Specify the broker in the form broker-hostname-or-ip:port . For example, "ec2-12-345-678-901.compute-1.amazonaws.com:2345".
*/
Broker?: String;
/**
* The topic to which you migrate the data. If you don't specify a topic, AWS DMS specifies "kafka-default-topic" as the migration topic.
*/
Topic?: String;
/**
* The output format for the records created on the endpoint. The message format is JSON (default) or JSON_UNFORMATTED (a single line with no tab).
*/
MessageFormat?: MessageFormatValue;
/**
* Provides detailed transaction information from the source database. This information includes a commit timestamp, a log position, and values for transaction_id, previous transaction_id, and transaction_record_id (the record offset within a transaction). The default is false.
*/
IncludeTransactionDetails?: BooleanOptional;
/**
* Shows the partition value within the Kafka message output, unless the partition type is schema-table-type. The default is false.
*/
IncludePartitionValue?: BooleanOptional;
/**
* Prefixes schema and table names to partition values, when the partition type is primary-key-type. Doing this increases data distribution among Kafka partitions. For example, suppose that a SysBench schema has thousands of tables and each table has only limited range for a primary key. In this case, the same primary key is sent from thousands of tables to the same partition, which causes throttling. The default is false.
*/
PartitionIncludeSchemaTable?: BooleanOptional;
/**
* Includes any data definition language (DDL) operations that change the table in the control data, such as rename-table, drop-table, add-column, drop-column, and rename-column. The default is false.
*/
IncludeTableAlterOperations?: BooleanOptional;
/**
* Shows detailed control information for table definition, column definition, and table and column changes in the Kafka message output. The default is false.
*/
IncludeControlDetails?: BooleanOptional;
/**
* The maximum size in bytes for records created on the endpoint The default is 1,000,000.
*/
MessageMaxBytes?: IntegerOptional;
/**
* Include NULL and empty columns for records migrated to the endpoint. The default is false.
*/
IncludeNullAndEmpty?: BooleanOptional;
}
export type KeyList = String[];
export interface KinesisSettings {
/**
* The Amazon Resource Name (ARN) for the Amazon Kinesis Data Streams endpoint.
*/
StreamArn?: String;
/**
* The output format for the records created on the endpoint. The message format is JSON (default) or JSON_UNFORMATTED (a single line with no tab).
*/
MessageFormat?: MessageFormatValue;
/**
* The Amazon Resource Name (ARN) for the AWS Identity and Access Management (IAM) role that AWS DMS uses to write to the Kinesis data stream.
*/
ServiceAccessRoleArn?: String;
/**
* Provides detailed transaction information from the source database. This information includes a commit timestamp, a log position, and values for transaction_id, previous transaction_id, and transaction_record_id (the record offset within a transaction). The default is false.
*/
IncludeTransactionDetails?: BooleanOptional;
/**
* Shows the partition value within the Kinesis message output, unless the partition type is schema-table-type. The default is false.
*/
IncludePartitionValue?: BooleanOptional;
/**
* Prefixes schema and table names to partition values, when the partition type is primary-key-type. Doing this increases data distribution among Kinesis shards. For example, suppose that a SysBench schema has thousands of tables and each table has only limited range for a primary key. In this case, the same primary key is sent from thousands of tables to the same shard, which causes throttling. The default is false.
*/
PartitionIncludeSchemaTable?: BooleanOptional;
/**
* Includes any data definition language (DDL) operations that change the table in the control data, such as rename-table, drop-table, add-column, drop-column, and rename-column. The default is false.
*/
IncludeTableAlterOperations?: BooleanOptional;
/**
* Shows detailed control information for table definition, column definition, and table and column changes in the Kinesis message output. The default is false.
*/
IncludeControlDetails?: BooleanOptional;
/**
* Include NULL and empty columns for records migrated to the endpoint. The default is false.
*/
IncludeNullAndEmpty?: BooleanOptional;
}
export interface ListTagsForResourceMessage {
/**
* The Amazon Resource Name (ARN) string that uniquely identifies the AWS DMS resource.
*/
ResourceArn: String;
}
export interface ListTagsForResourceResponse {
/**
* A list of tags for the resource.
*/
TagList?: TagList;
}
export type Long = number;
export type MessageFormatValue = "json"|"json-unformatted"|string;
export interface MicrosoftSQLServerSettings {
/**
* Endpoint TCP port.
*/
Port?: IntegerOptional;
/**
* The maximum size of the packets (in bytes) used to transfer data using BCP.
*/
BcpPacketSize?: IntegerOptional;
/**
* Database name for the endpoint.
*/
DatabaseName?: String;
/**
* Specify a filegroup for the AWS DMS internal tables. When the replication task starts, all the internal AWS DMS control tables (awsdms_ apply_exception, awsdms_apply, awsdms_changes) are created on the specified filegroup.
*/
ControlTablesFileGroup?: String;
/**
* Endpoint connection password.
*/
Password?: SecretString;
/**
* When this attribute is set to Y, AWS DMS only reads changes from transaction log backups and doesn't read from the active transaction log file during ongoing replication. Setting this parameter to Y enables you to control active transaction log file growth during full load and ongoing replication tasks. However, it can add some source latency to ongoing replication.
*/
ReadBackupOnly?: BooleanOptional;
/**
* Use this attribute to minimize the need to access the backup log and enable AWS DMS to prevent truncation using one of the following two methods. Start transactions in the database: This is the default method. When this method is used, AWS DMS prevents TLOG truncation by mimicking a transaction in the database. As long as such a transaction is open, changes that appear after the transaction started aren't truncated. If you need Microsoft Replication to be enabled in your database, then you must choose this method. Exclusively use sp_repldone within a single task: When this method is used, AWS DMS reads the changes and then uses sp_repldone to mark the TLOG transactions as ready for truncation. Although this method doesn't involve any transactional activities, it can only be used when Microsoft Replication isn't running. Also, when using this method, only one AWS DMS task can access the database at any given time. Therefore, if you need to run parallel AWS DMS tasks against the same database, use the default method.
*/
SafeguardPolicy?: SafeguardPolicy;
/**
* Fully qualified domain name of the endpoint.
*/
ServerName?: String;
/**
* Endpoint connection user name.
*/
Username?: String;
/**
* Use this to attribute to transfer data for full-load operations using BCP. When the target table contains an identity column that does not exist in the source table, you must disable the use BCP for loading table option.
*/
UseBcpFullLoad?: BooleanOptional;
}
export type MigrationTypeValue = "full-load"|"cdc"|"full-load-and-cdc"|string;
export interface ModifyEndpointMessage {
/**
* The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.
*/
EndpointArn: String;
/**
* The database endpoint identifier. Identifiers must begin with a letter and must contain only ASCII letters, digits, and hyphens. They can't end with a hyphen or contain two consecutive hyphens.
*/
EndpointIdentifier?: String;
/**
* The type of endpoint. Valid values are source and target.
*/
EndpointType?: ReplicationEndpointTypeValue;
/**
* The type of engine for the endpoint. Valid values, depending on the EndpointType, include "mysql", "oracle", "postgres", "mariadb", "aurora", "aurora-postgresql", "redshift", "s3", "db2", "azuredb", "sybase", "dynamodb", "mongodb", "kinesis", "kafka", "elasticsearch", "documentdb", "sqlserver", and "neptune".
*/
EngineName?: String;
/**
* The user name to be used to login to the endpoint database.
*/
Username?: String;
/**
* The password to be used to login to the endpoint database.
*/
Password?: SecretString;
/**
* The name of the server where the endpoint database resides.
*/
ServerName?: String;
/**
* The port used by the endpoint database.
*/
Port?: IntegerOptional;
/**
* The name of the endpoint database.
*/
DatabaseName?: String;
/**
* Additional attributes associated with the connection. To reset this parameter, pass the empty string ("") as an argument.
*/
ExtraConnectionAttributes?: String;
/**
* The Amazon Resource Name (ARN) of the certificate used for SSL connection.
*/
CertificateArn?: String;
/**
* The SSL mode used to connect to the endpoint. The default value is none.
*/
SslMode?: DmsSslModeValue;
/**
* The Amazon Resource Name (ARN) for the service access role you want to use to modify the endpoint.
*/
ServiceAccessRoleArn?: String;
/**
* The external table definition.
*/
ExternalTableDefinition?: String;
/**
* Settings in JSON format for the target Amazon DynamoDB endpoint. For information about other available settings, see Using Object Mapping to Migrate Data to DynamoDB in the AWS Database Migration Service User Guide.
*/
DynamoDbSettings?: DynamoDbSettings;
/**
* Settings in JSON format for the target Amazon S3 endpoint. For more information about the available settings, see Extra Connection Attributes When Using Amazon S3 as a Target for AWS DMS in the AWS Database Migration Service User Guide.
*/
S3Settings?: S3Settings;
/**
* The settings in JSON format for the DMS transfer type of source endpoint. Attributes include the following: serviceAccessRoleArn - The AWS Identity and Access Management (IAM) role that has permission to access the Amazon S3 bucket. BucketName - The name of the S3 bucket to use. compressionType - An optional parameter to use GZIP to compress the target files. Either set this parameter to NONE (the default) or don't use it to leave the files uncompressed. Shorthand syntax for these settings is as follows: ServiceAccessRoleArn=string ,BucketName=string,CompressionType=string JSON syntax for these settings is as follows: { "ServiceAccessRoleArn": "string", "BucketName": "string", "CompressionType": "none"|"gzip" }
*/
DmsTransferSettings?: DmsTransferSettings;
/**
* Settings in JSON format for the source MongoDB endpoint. For more information about the available settings, see the configuration properties section in Using MongoDB as a Target for AWS Database Migration Service in the AWS Database Migration Service User Guide.
*/
MongoDbSettings?: MongoDbSettings;
/**
* Settings in JSON format for the target endpoint for Amazon Kinesis Data Streams. For more information about the available settings, see Using Amazon Kinesis Data Streams as a Target for AWS Database Migration Service in the AWS Database Migration Service User Guide.
*/
KinesisSettings?: KinesisSettings;
/**
* Settings in JSON format for the target Apache Kafka endpoint. For more information about the available settings, see Using Apache Kafka as a Target for AWS Database Migration Service in the AWS Database Migration Service User Guide.
*/
KafkaSettings?: KafkaSettings;
/**
* Settings in JSON format for the target Elasticsearch endpoint. For more information about the available settings, see Extra Connection Attributes When Using Elasticsearch as a Target for AWS DMS in the AWS Database Migration Service User Guide.
*/
ElasticsearchSettings?: ElasticsearchSettings;
/**
* Settings in JSON format for the target Amazon Neptune endpoint. For more information about the available settings, see Specifying Endpoint Settings for Amazon Neptune as a Target in the AWS Database Migration Service User Guide.
*/
NeptuneSettings?: NeptuneSettings;
RedshiftSettings?: RedshiftSettings;
/**
* Settings in JSON format for the source and target PostgreSQL endpoint. For information about other available settings, see Extra connection attributes when using PostgreSQL as a source for AWS DMS and Extra connection attributes when using PostgreSQL as a target for AWS DMS in the AWS Database Migration Service User Guide.
*/
PostgreSQLSettings?: PostgreSQLSettings;
/**
* Settings in JSON format for the source and target MySQL endpoint. For information about other available settings, see Extra connection attributes when using MySQL as a source for AWS DMS and Extra connection attributes when using a MySQL-compatible database as a target for AWS DMS in the AWS Database Migration Service User Guide.
*/
MySQLSettings?: MySQLSettings;
/**
* Settings in JSON format for the source and target Oracle endpoint. For information about other available settings, see Extra connection attributes when using Oracle as a source for AWS DMS and Extra connection attributes when using Oracle as a target for AWS DMS in the AWS Database Migration Service User Guide.
*/
OracleSettings?: OracleSettings;
/**
* Settings in JSON format for the source and target SAP ASE endpoint. For information about other available settings, see Extra connection attributes when using SAP ASE as a source for AWS DMS and Extra connection attributes when using SAP ASE as a target for AWS DMS in the AWS Database Migration Service User Guide.
*/
SybaseSettings?: SybaseSettings;
/**
* Settings in JSON format for the source and target Microsoft SQL Server endpoint. For information about other available settings, see Extra connection attributes when using SQL Server as a source for AWS DMS and Extra connection attributes when using SQL Server as a target for AWS DMS in the AWS Database Migration Service User Guide.
*/
MicrosoftSQLServerSettings?: MicrosoftSQLServerSettings;
/**
* Settings in JSON format for the source IBM Db2 LUW endpoint. For information about other available settings, see Extra connection attributes when using Db2 LUW as a source for AWS DMS in the AWS Database Migration Service User Guide.
*/
IBMDb2Settings?: IBMDb2Settings;
}
export interface ModifyEndpointResponse {
/**
* The modified endpoint.
*/
Endpoint?: Endpoint;
}
export interface ModifyEventSubscriptionMessage {
/**
* The name of the AWS DMS event notification subscription to be modified.
*/
SubscriptionName: String;
/**
* The Amazon Resource Name (ARN) of the Amazon SNS topic created for event notification. The ARN is created by Amazon SNS when you create a topic and subscribe to it.
*/
SnsTopicArn?: String;
/**
* The type of AWS DMS resource that generates the events you want to subscribe to. Valid values: replication-instance | replication-task
*/
SourceType?: String;
/**
* A list of event categories for a source type that you want to subscribe to. Use the DescribeEventCategories action to see a list of event categories.
*/
EventCategories?: EventCategoriesList;
/**
* A Boolean value; set to true to activate the subscription.
*/
Enabled?: BooleanOptional;
}
export interface ModifyEventSubscriptionResponse {
/**
* The modified event subscription.
*/
EventSubscription?: EventSubscription;
}
export interface ModifyReplicationInstanceMessage {
/**
* The Amazon Resource Name (ARN) of the replication instance.
*/
ReplicationInstanceArn: String;
/**
* The amount of storage (in gigabytes) to be allocated for the replication instance.
*/
AllocatedStorage?: IntegerOptional;
/**
* Indicates whether the changes should be applied immediately or during the next maintenance window.
*/
ApplyImmediately?: Boolean;
/**
* The compute and memory capacity of the replication instance as defined for the specified replication instance class. For example to specify the instance class dms.c4.large, set this parameter to "dms.c4.large". For more information on the settings and capacities for the available replication instance classes, see Selecting the right AWS DMS replication instance for your migration.
*/
ReplicationInstanceClass?: String;
/**
* Specifies the VPC security group to be used with the replication instance. The VPC security group must work with the VPC containing the replication instance.
*/
VpcSecurityGroupIds?: VpcSecurityGroupIdList;
/**
* The weekly time range (in UTC) during which system maintenance can occur, which might result in an outage. Changing this parameter does not result in an outage, except in the following situation, and the change is asynchronously applied as soon as possible. If moving this window to the current time, there must be at least 30 minutes between the current time and end of the window to ensure pending changes are applied. Default: Uses existing setting Format: ddd:hh24:mi-ddd:hh24:mi Valid Days: Mon | Tue | Wed | Thu | Fri | Sat | Sun Constraints: Must be at least 30 minutes
*/
PreferredMaintenanceWindow?: String;
/**
* Specifies whether the replication instance is a Multi-AZ deployment. You can't set the AvailabilityZone parameter if the Multi-AZ parameter is set to true.
*/
MultiAZ?: BooleanOptional;
/**
* The engine version number of the replication instance. When modifying a major engine version of an instance, also set AllowMajorVersionUpgrade to true.
*/
EngineVersion?: String;
/**
* Indicates that major version upgrades are allowed. Changing this parameter does not result in an outage, and the change is asynchronously applied as soon as possible. This parameter must be set to true when specifying a value for the EngineVersion parameter that is a different major version than the replication instance's current version.
*/
AllowMajorVersionUpgrade?: Boolean;
/**
* A value that indicates that minor version upgrades are applied automatically to the replication instance during the maintenance window. Changing this parameter doesn't result in an outage, except in the case dsecribed following. The change is asynchronously applied as soon as possible. An outage does result if these factors apply: This parameter is set to true during the maintenance window. A newer minor version is available. AWS DMS has enabled automatic patching for the given engine version.
*/
AutoMinorVersionUpgrade?: BooleanOptional;
/**
* The replication instance identifier. This parameter is stored as a lowercase string.
*/
ReplicationInstanceIdentifier?: String;
}
export interface ModifyReplicationInstanceResponse {
/**
* The modified replication instance.
*/
ReplicationInstance?: ReplicationInstance;
}
export interface ModifyReplicationSubnetGroupMessage {
/**
* The name of the replication instance subnet group.
*/
ReplicationSubnetGroupIdentifier: String;
/**
* A description for the replication instance subnet group.
*/
ReplicationSubnetGroupDescription?: String;
/**
* A list of subnet IDs.
*/
SubnetIds: SubnetIdentifierList;
}
export interface ModifyReplicationSubnetGroupResponse {
/**
* The modified replication subnet group.
*/
ReplicationSubnetGroup?: ReplicationSubnetGroup;
}
export interface ModifyReplicationTaskMessage {
/**
* The Amazon Resource Name (ARN) of the replication task.
*/
ReplicationTaskArn: String;
/**
* The replication task identifier. Constraints: Must contain 1-255 alphanumeric characters or hyphens. First character must be a letter. Cannot end with a hyphen or contain two consecutive hyphens.
*/
ReplicationTaskIdentifier?: String;
/**
* The migration type. Valid values: full-load | cdc | full-load-and-cdc
*/
MigrationType?: MigrationTypeValue;
/**
* When using the AWS CLI or boto3, provide the path of the JSON file that contains the table mappings. Precede the path with file://. When working with the DMS API, provide the JSON as the parameter value, for example: --table-mappings file://mappingfile.json
*/
TableMappings?: String;
/**
* JSON file that contains settings for the task, such as task metadata settings.
*/
ReplicationTaskSettings?: String;
/**
* Indicates the start time for a change data capture (CDC) operation. Use either CdcStartTime or CdcStartPosition to specify when you want a CDC operation to start. Specifying both values results in an error. Timestamp Example: --cdc-start-time “2018-03-08T12:12:12”
*/
CdcStartTime?: TStamp;
/**
* Indicates when you want a change data capture (CDC) operation to start. Use either CdcStartPosition or CdcStartTime to specify when you want a CDC operation to start. Specifying both values results in an error. The value can be in date, checkpoint, or LSN/SCN format. Date Example: --cdc-start-position “2018-03-08T12:12:12” Checkpoint Example: --cdc-start-position "checkpoint:V1#27#mysql-bin-changelog.157832:1975:-1:2002:677883278264080:mysql-bin-changelog.157832:1876#0#0#*#0#93" LSN Example: --cdc-start-position “mysql-bin-changelog.000024:373” When you use this task setting with a source PostgreSQL database, a logical replication slot should already be created and associated with the source endpoint. You can verify this by setting the slotName extra connection attribute to the name of this logical replication slot. For more information, see Extra Connection Attributes When Using PostgreSQL as a Source for AWS DMS.
*/
CdcStartPosition?: String;
/**
* Indicates when you want a change data capture (CDC) operation to stop. The value can be either server time or commit time. Server time example: --cdc-stop-position “server_time:2018-02-09T12:12:12” Commit time example: --cdc-stop-position “commit_time: 2018-02-09T12:12:12 “
*/
CdcStopPosition?: String;
/**
* Supplemental information that the task requires to migrate the data for certain source and target endpoints. For more information, see Specifying Supplemental Data for Task Settings in the AWS Database Migration Service User Guide.
*/
TaskData?: String;
}
export interface ModifyReplicationTaskResponse {
/**
* The replication task that was modified.
*/
ReplicationTask?: ReplicationTask;
}
export interface MongoDbSettings {
/**
* The user name you use to access the MongoDB source endpoint.
*/
Username?: String;
/**
* The password for the user account you use to access the MongoDB source endpoint.
*/
Password?: SecretString;
/**
* The name of the server on the MongoDB source endpoint.
*/
ServerName?: String;
/**
* The port value for the MongoDB source endpoint.
*/
Port?: IntegerOptional;
/**
* The database name on the MongoDB source endpoint.
*/
DatabaseName?: String;
/**
* The authentication type you use to access the MongoDB source endpoint. When when set to "no", user name and password parameters are not used and can be empty.
*/
AuthType?: AuthTypeValue;
/**
* The authentication mechanism you use to access the MongoDB source endpoint. For the default value, in MongoDB version 2.x, "default" is "mongodb_cr". For MongoDB version 3.x or later, "default" is "scram_sha_1". This setting isn't used when AuthType is set to "no".
*/
AuthMechanism?: AuthMechanismValue;
/**
* Specifies either document or table mode. Default value is "none". Specify "none" to use document mode. Specify "one" to use table mode.
*/
NestingLevel?: NestingLevelValue;
/**
* Specifies the document ID. Use this setting when NestingLevel is set to "none". Default value is "false".
*/
ExtractDocId?: String;
/**
* Indicates the number of documents to preview to determine the document organization. Use this setting when NestingLevel is set to "one". Must be a positive value greater than 0. Default value is 1000.
*/
DocsToInvestigate?: String;
/**
* The MongoDB database name. This setting isn't used when AuthType is set to "no". The default is "admin".
*/
AuthSource?: String;
/**
* The AWS KMS key identifier that is used to encrypt the content on the replication instance. If you don't specify a value for the KmsKeyId parameter, then AWS DMS uses your default encryption key. AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS Region.
*/
KmsKeyId?: String;
}
export interface MySQLSettings {
/**
* Specifies a script to run immediately after AWS DMS connects to the endpoint. The migration task continues running regardless if the SQL statement succeeds or fails.
*/
AfterConnectScript?: String;
/**
* Database name for the endpoint.
*/
DatabaseName?: String;
/**
* Specifies how often to check the binary log for new changes/events when the database is idle. Example: eventsPollInterval=5; In the example, AWS DMS checks for changes in the binary logs every five seconds.
*/
EventsPollInterval?: IntegerOptional;
/**
* Specifies where to migrate source tables on the target, either to a single database or multiple databases. Example: targetDbType=MULTIPLE_DATABASES
*/
TargetDbType?: TargetDbType;
/**
* Specifies the maximum size (in KB) of any .csv file used to transfer data to a MySQL-compatible database. Example: maxFileSize=512
*/
MaxFileSize?: IntegerOptional;
/**
* Improves performance when loading data into the MySQLcompatible target database. Specifies how many threads to use to load the data into the MySQL-compatible target database. Setting a large number of threads can have an adverse effect on database performance, because a separate connection is required for each thread. Example: parallelLoadThreads=1
*/
ParallelLoadThreads?: IntegerOptional;
/**
* Endpoint connection password.
*/
Password?: SecretString;
/**
* Endpoint TCP port.
*/
Port?: IntegerOptional;
/**
* Fully qualified domain name of the endpoint.
*/
ServerName?: String;
/**
* Specifies the time zone for the source MySQL database. Example: serverTimezone=US/Pacific; Note: Do not enclose time zones in single quotes.
*/
ServerTimezone?: String;
/**
* Endpoint connection user name.
*/
Username?: String;
}
export interface NeptuneSettings {
/**
* The Amazon Resource Name (ARN) of the service role that you created for the Neptune target endpoint. For more information, see Creating an IAM Service Role for Accessing Amazon Neptune as a Target in the AWS Database Migration Service User Guide.
*/
ServiceAccessRoleArn?: String;
/**
* The name of the Amazon S3 bucket where AWS DMS can temporarily store migrated graph data in .csv files before bulk-loading it to the Neptune target database. AWS DMS maps the SQL source data to graph data before storing it in these .csv files.
*/
S3BucketName: String;
/**
* A folder path where you want AWS DMS to store migrated graph data in the S3 bucket specified by S3BucketName
*/
S3BucketFolder: String;
/**
* The number of milliseconds for AWS DMS to wait to retry a bulk-load of migrated graph data to the Neptune target database before raising an error. The default is 250.
*/
ErrorRetryDuration?: IntegerOptional;
/**
* The maximum size in kilobytes of migrated graph data stored in a .csv file before AWS DMS bulk-loads the data to the Neptune target database. The default is 1,048,576 KB. If the bulk load is successful, AWS DMS clears the bucket, ready to store the next batch of migrated graph data.
*/
MaxFileSize?: IntegerOptional;
/**
* The number of times for AWS DMS to retry a bulk load of migrated graph data to the Neptune target database before raising an error. The default is 5.
*/
MaxRetryCount?: IntegerOptional;
/**
* If you want AWS Identity and Access Management (IAM) authorization enabled for this endpoint, set this parameter to true. Then attach the appropriate IAM policy document to your service role specified by ServiceAccessRoleArn. The default is false.
*/
IamAuthEnabled?: BooleanOptional;
}
export type NestingLevelValue = "none"|"one"|string;
export interface OracleSettings {
/**
* Set this attribute to set up table-level supplemental logging for the Oracle database. This attribute enables PRIMARY KEY supplemental logging on all tables selected for a migration task. If you use this option, you still need to enable database-level supplemental logging.
*/
AddSupplementalLogging?: BooleanOptional;
/**
* Specifies the destination of the archived redo logs. The value should be the same as the DEST_ID number in the v$archived_log table. When working with multiple log destinations (DEST_ID), we recommend that you to specify an archived redo logs location identifier. Doing this improves performance by ensuring that the correct logs are accessed from the outset.
*/
ArchivedLogDestId?: IntegerOptional;
/**
* Set this attribute with archivedLogDestId in a primary/ standby setup. This attribute is useful in the case of a switchover. In this case, AWS DMS needs to know which destination to get archive redo logs from to read changes. This need arises because the previous primary instance is now a standby instance after switchover.
*/
AdditionalArchivedLogDestId?: IntegerOptional;
/**
* Set this attribute to true to enable replication of Oracle tables containing columns that are nested tables or defined types.
*/
AllowSelectNestedTables?: BooleanOptional;
/**
* Set this attribute to change the number of threads that DMS configures to perform a Change Data Capture (CDC) load using Oracle Automatic Storage Management (ASM). You can specify an integer value between 2 (the default) and 8 (the maximum). Use this attribute together with the readAheadBlocks attribute.
*/
ParallelAsmReadThreads?: IntegerOptional;
/**
* Set this attribute to change the number of read-ahead blocks that DMS configures to perform a Change Data Capture (CDC) load using Oracle Automatic Storage Management (ASM). You can specify an integer value between 1000 (the default) and 200,000 (the maximum).
*/
ReadAheadBlocks?: IntegerOptional;
/**
* Set this attribute to false in order to use the Binary Reader to capture change data for an Amazon RDS for Oracle as the source. This tells the DMS instance to not access redo logs through any specified path prefix replacement using direct file access.
*/
AccessAlternateDirectly?: BooleanOptional;
/**
* Set this attribute to true in order to use the Binary Reader to capture change data for an Amazon RDS for Oracle as the source. This tells the DMS instance to use any specified prefix replacement to access all online redo logs.
*/
UseAlternateFolderForOnline?: BooleanOptional;
/**
* Set this string attribute to the required value in order to use the Binary Reader to capture change data for an Amazon RDS for Oracle as the source. This value specifies the default Oracle root used to access the redo logs.
*/
OraclePathPrefix?: String;
/**
* Set this string attribute to the required value in order to use the Binary Reader to capture change data for an Amazon RDS for Oracle as the source. This value specifies the path prefix used to replace the default Oracle root to access the redo logs.
*/
UsePathPrefix?: String;
/**
* Set this attribute to true in order to use the Binary Reader to capture change data for an Amazon RDS for Oracle as the source. This setting tells DMS instance to replace the default Oracle root with the specified usePathPrefix setting to access the redo logs.
*/
ReplacePathPrefix?: BooleanOptional;
/**
* Set this attribute to enable homogenous tablespace replication and create existing tables or indexes under the same tablespace on the target.
*/
EnableHomogenousTablespace?: BooleanOptional;
/**
* When set to true, this attribute helps to increase the commit rate on the Oracle target database by writing directly to tables and not writing a trail to database logs.
*/
DirectPathNoLog?: BooleanOptional;
/**
* When this field is set to Y, AWS DMS only accesses the archived redo logs. If the archived redo logs are stored on Oracle ASM only, the AWS DMS user account needs to be granted ASM privileges.
*/
ArchivedLogsOnly?: BooleanOptional;
/**
* For an Oracle source endpoint, your Oracle Automatic Storage Management (ASM) password. You can set this value from the asm_user_password value. You set this value as part of the comma-separated value that you set to the Password request parameter when you create the endpoint to access transaction logs using Binary Reader. For more information, see Configuration for change data capture (CDC) on an Oracle source database.
*/
AsmPassword?: SecretString;
/**
* For an Oracle source endpoint, your ASM server address. You can set this value from the asm_server value. You set asm_server as part of the extra connection attribute string to access an Oracle server with Binary Reader that uses ASM. For more information, see Configuration for change data capture (CDC) on an Oracle source database.
*/
AsmServer?: String;
/**
* For an Oracle source endpoint, your ASM user name. You can set this value from the asm_user value. You set asm_user as part of the extra connection attribute string to access an Oracle server with Binary Reader that uses ASM. For more information, see Configuration for change data capture (CDC) on an Oracle source database.
*/
AsmUser?: String;
/**
* Specifies whether the length of a character column is in bytes or in characters. To indicate that the character column length is in characters, set this attribute to CHAR. Otherwise, the character column length is in bytes. Example: charLengthSemantics=CHAR;
*/
CharLengthSemantics?: CharLengthSemantics;
/**
* Database name for the endpoint.
*/
DatabaseName?: String;
/**
* When set to true, this attribute specifies a parallel load when useDirectPathFullLoad is set to Y. This attribute also only applies when you use the AWS DMS parallel load feature. Note that the target table cannot have any constraints or indexes.
*/
DirectPathParallelLoad?: BooleanOptional;
/**
* When set to true, this attribute causes a task to fail if the actual size of an LOB column is greater than the specified LobMaxSize. If a task is set to limited LOB mode and this option is set to true, the task fails instead of truncating the LOB data.
*/
FailTasksOnLobTruncation?: BooleanOptional;
/**
* Specifies the number scale. You can select a scale up to 38, or you can select FLOAT. By default, the NUMBER data type is converted to precision 38, scale 10. Example: numberDataTypeScale=12
*/
NumberDatatypeScale?: IntegerOptional;
/**
* Endpoint connection password.
*/
Password?: SecretString;
/**
* Endpoint TCP port.
*/
Port?: IntegerOptional;
/**
* When set to true, this attribute supports tablespace replication.
*/
ReadTableSpaceName?: BooleanOptional;
/**
* Specifies the number of seconds that the system waits before resending a query. Example: retryInterval=6;
*/
RetryInterval?: IntegerOptional;
/**
* For an Oracle source endpoint, the transparent data encryption (TDE) password required by AWM DMS to access Oracle redo logs encrypted by TDE using Binary Reader. It is also the TDE_Password part of the comma-separated value you set to the Password request parameter when you create the endpoint. The SecurityDbEncryptian setting is related to this SecurityDbEncryptionName setting. For more information, see Supported encryption methods for using Oracle as a source for AWS DMS in the AWS Database Migration Service User Guide.
*/
SecurityDbEncryption?: SecretString;
/**
* For an Oracle source endpoint, the name of a key used for the transparent data encryption (TDE) of the columns and tablespaces in an Oracle source database that is encrypted using TDE. The key value is the value of the SecurityDbEncryption setting. For more information on setting the key name value of SecurityDbEncryptionName, see the information and example for setting the securityDbEncryptionName extra connection attribute in Supported encryption methods for using Oracle as a source for AWS DMS in the AWS Database Migration Service User Guide.
*/
SecurityDbEncryptionName?: String;
/**
* Fully qualified domain name of the endpoint.
*/
ServerName?: String;
/**
* Endpoint connection user name.
*/
Username?: String;
}
export interface OrderableReplicationInstance {
/**
* The version of the replication engine.
*/
EngineVersion?: String;
/**
* The compute and memory capacity of the replication instance as defined for the specified replication instance class. For example to specify the instance class dms.c4.large, set this parameter to "dms.c4.large". For more information on the settings and capacities for the available replication instance classes, see Selecting the right AWS DMS replication instance for your migration.
*/
ReplicationInstanceClass?: String;
/**
* The type of storage used by the replication instance.
*/
StorageType?: String;
/**
* The minimum amount of storage (in gigabytes) that can be allocated for the replication instance.
*/
MinAllocatedStorage?: Integer;
/**
* The minimum amount of storage (in gigabytes) that can be allocated for the replication instance.
*/
MaxAllocatedStorage?: Integer;
/**
* The default amount of storage (in gigabytes) that is allocated for the replication instance.
*/
DefaultAllocatedStorage?: Integer;
/**
* The amount of storage (in gigabytes) that is allocated for the replication instance.
*/
IncludedAllocatedStorage?: Integer;
/**
* List of Availability Zones for this replication instance.
*/
AvailabilityZones?: AvailabilityZonesList;
/**
* The value returned when the specified EngineVersion of the replication instance is in Beta or test mode. This indicates some features might not work as expected. AWS DMS supports the ReleaseStatus parameter in versions 3.1.4 and later.
*/
ReleaseStatus?: ReleaseStatusValues;
}
export type OrderableReplicationInstanceList = OrderableReplicationInstance[];
export type ParquetVersionValue = "parquet-1-0"|"parquet-2-0"|string;
export interface PendingMaintenanceAction {
/**
* The type of pending maintenance action that is available for the resource.
*/
Action?: String;
/**
* The date of the maintenance window when the action is to be applied. The maintenance action is applied to the resource during its first maintenance window after this date. If this date is specified, any next-maintenance opt-in requests are ignored.
*/
AutoAppliedAfterDate?: TStamp;
/**
* The date when the maintenance action will be automatically applied. The maintenance action is applied to the resource on this date regardless of the maintenance window for the resource. If this date is specified, any immediate opt-in requests are ignored.
*/
ForcedApplyDate?: TStamp;
/**
* The type of opt-in request that has been received for the resource.
*/
OptInStatus?: String;
/**
* The effective date when the pending maintenance action will be applied to the resource. This date takes into account opt-in requests received from the ApplyPendingMaintenanceAction API operation, and also the AutoAppliedAfterDate and ForcedApplyDate parameter values. This value is blank if an opt-in request has not been received and nothing has been specified for AutoAppliedAfterDate or ForcedApplyDate.
*/
CurrentApplyDate?: TStamp;
/**
* A description providing more detail about the maintenance action.
*/
Description?: String;
}
export type PendingMaintenanceActionDetails = PendingMaintenanceAction[];
export type PendingMaintenanceActions = ResourcePendingMaintenanceActions[];
export interface PostgreSQLSettings {
/**
* For use with change data capture (CDC) only, this attribute has AWS DMS bypass foreign keys and user triggers to reduce the time it takes to bulk load data. Example: afterConnectScript=SET session_replication_role='replica'
*/
AfterConnectScript?: String;
/**
* To capture DDL events, AWS DMS creates various artifacts in the PostgreSQL database when the task starts. You can later remove these artifacts. If this value is set to N, you don't have to create tables or triggers on the source database.
*/
CaptureDdls?: BooleanOptional;
/**
* Specifies the maximum size (in KB) of any .csv file used to transfer data to PostgreSQL. Example: maxFileSize=512
*/
MaxFileSize?: IntegerOptional;
/**
* Database name for the endpoint.
*/
DatabaseName?: String;
/**
* The schema in which the operational DDL database artifacts are created. Example: ddlArtifactsSchema=xyzddlschema;
*/
DdlArtifactsSchema?: String;
/**
* Sets the client statement timeout for the PostgreSQL instance, in seconds. The default value is 60 seconds. Example: executeTimeout=100;
*/
ExecuteTimeout?: IntegerOptional;
/**
* When set to true, this value causes a task to fail if the actual size of a LOB column is greater than the specified LobMaxSize. If task is set to Limited LOB mode and this option is set to true, the task fails instead of truncating the LOB data.
*/
FailTasksOnLobTruncation?: BooleanOptional;
/**
* Endpoint connection password.
*/
Password?: SecretString;
/**
* Endpoint TCP port.
*/
Port?: IntegerOptional;
/**
* Fully qualified domain name of the endpoint.
*/
ServerName?: String;
/**
* Endpoint connection user name.
*/
Username?: String;
/**
* Sets the name of a previously created logical replication slot for a CDC load of the PostgreSQL source instance. When used with the AWS DMS API CdcStartPosition request parameter, this attribute also enables using native CDC start points.
*/
SlotName?: String;
}
export interface RebootReplicationInstanceMessage {
/**
* The Amazon Resource Name (ARN) of the replication instance.
*/
ReplicationInstanceArn: String;
/**
* If this parameter is true, the reboot is conducted through a Multi-AZ failover. (If the instance isn't configured for Multi-AZ, then you can't specify true.)
*/
ForceFailover?: BooleanOptional;
}
export interface RebootReplicationInstanceResponse {
/**
* The replication instance that is being rebooted.
*/
ReplicationInstance?: ReplicationInstance;
}
export interface RedshiftSettings {
/**
* A value that indicates to allow any date format, including invalid formats such as 00/00/00 00:00:00, to be loaded without generating an error. You can choose true or false (the default). This parameter applies only to TIMESTAMP and DATE columns. Always use ACCEPTANYDATE with the DATEFORMAT parameter. If the date format for the data doesn't match the DATEFORMAT specification, Amazon Redshift inserts a NULL value into that field.
*/
AcceptAnyDate?: BooleanOptional;
/**
* Code to run after connecting. This parameter should contain the code itself, not the name of a file containing the code.
*/
AfterConnectScript?: String;
/**
* An S3 folder where the comma-separated-value (.csv) files are stored before being uploaded to the target Redshift cluster. For full load mode, AWS DMS converts source records into .csv files and loads them to the BucketFolder/TableID path. AWS DMS uses the Redshift COPY command to upload the .csv files to the target table. The files are deleted once the COPY operation has finished. For more information, see Amazon Redshift Database Developer Guide For change-data-capture (CDC) mode, AWS DMS creates a NetChanges table, and loads the .csv files to this BucketFolder/NetChangesTableID path.
*/
BucketFolder?: String;
/**
* The name of the intermediate S3 bucket used to store .csv files before uploading data to Redshift.
*/
BucketName?: String;
/**
* A value that sets the amount of time to wait (in milliseconds) before timing out, beginning from when you initially establish a connection.
*/
ConnectionTimeout?: IntegerOptional;
/**
* The name of the Amazon Redshift data warehouse (service) that you are working with.
*/
DatabaseName?: String;
/**
* The date format that you are using. Valid values are auto (case-sensitive), your date format string enclosed in quotes, or NULL. If this parameter is left unset (NULL), it defaults to a format of 'YYYY-MM-DD'. Using auto recognizes most strings, even some that aren't supported when you use a date format string. If your date and time values use formats different from each other, set this to auto.
*/
DateFormat?: String;
/**
* A value that specifies whether AWS DMS should migrate empty CHAR and VARCHAR fields as NULL. A value of true sets empty CHAR and VARCHAR fields to null. The default is false.
*/
EmptyAsNull?: BooleanOptional;
/**
* The type of server-side encryption that you want to use for your data. This encryption type is part of the endpoint settings or the extra connections attributes for Amazon S3. You can choose either SSE_S3 (the default) or SSE_KMS. For the ModifyEndpoint operation, you can change the existing value of the EncryptionMode parameter from SSE_KMS to SSE_S3. But you can’t change the existing value from SSE_S3 to SSE_KMS. To use SSE_S3, create an AWS Identity and Access Management (IAM) role with a policy that allows "arn:aws:s3:::*" to use the following actions: "s3:PutObject", "s3:ListBucket"
*/
EncryptionMode?: EncryptionModeValue;
/**
* The number of threads used to upload a single file. This parameter accepts a value from 1 through 64. It defaults to 10. The number of parallel streams used to upload a single .csv file to an S3 bucket using S3 Multipart Upload. For more information, see Multipart upload overview. FileTransferUploadStreams accepts a value from 1 through 64. It defaults to 10.
*/
FileTransferUploadStreams?: IntegerOptional;
/**
* The amount of time to wait (in milliseconds) before timing out of operations performed by AWS DMS on a Redshift cluster, such as Redshift COPY, INSERT, DELETE, and UPDATE.
*/
LoadTimeout?: IntegerOptional;
/**
* The maximum size (in KB) of any .csv file used to load data on an S3 bucket and transfer data to Amazon Redshift. It defaults to 1048576KB (1 GB).
*/
MaxFileSize?: IntegerOptional;
/**
* The password for the user named in the username property.
*/
Password?: SecretString;
/**
* The port number for Amazon Redshift. The default value is 5439.
*/
Port?: IntegerOptional;
/**
* A value that specifies to remove surrounding quotation marks from strings in the incoming data. All characters within the quotation marks, including delimiters, are retained. Choose true to remove quotation marks. The default is false.
*/
RemoveQuotes?: BooleanOptional;
/**
* A list of characters that you want to replace. Use with ReplaceChars.
*/
ReplaceInvalidChars?: String;
/**
* A value that specifies to replaces the invalid characters specified in ReplaceInvalidChars, substituting the specified characters instead. The default is "?".
*/
ReplaceChars?: String;
/**
* The name of the Amazon Redshift cluster you are using.
*/
ServerName?: String;
/**
* The Amazon Resource Name (ARN) of the IAM role that has access to the Amazon Redshift service.
*/
ServiceAccessRoleArn?: String;
/**
* The AWS KMS key ID. If you are using SSE_KMS for the EncryptionMode, provide this key ID. The key that you use needs an attached policy that enables IAM user permissions and allows use of the key.
*/
ServerSideEncryptionKmsKeyId?: String;
/**
* The time format that you want to use. Valid values are auto (case-sensitive), 'timeformat_string', 'epochsecs', or 'epochmillisecs'. It defaults to 10. Using auto recognizes most strings, even some that aren't supported when you use a time format string. If your date and time values use formats different from each other, set this parameter to auto.
*/
TimeFormat?: String;
/**
* A value that specifies to remove the trailing white space characters from a VARCHAR string. This parameter applies only to columns with a VARCHAR data type. Choose true to remove unneeded white space. The default is false.
*/
TrimBlanks?: BooleanOptional;
/**
* A value that specifies to truncate data in columns to the appropriate number of characters, so that the data fits in the column. This parameter applies only to columns with a VARCHAR or CHAR data type, and rows with a size of 4 MB or less. Choose true to truncate data. The default is false.
*/
TruncateColumns?: BooleanOptional;
/**
* An Amazon Redshift user name for a registered user.
*/
Username?: String;
/**
* The size (in KB) of the in-memory file write buffer used when generating .csv files on the local disk at the DMS replication instance. The default value is 1000 (buffer size is 1000KB).
*/
WriteBufferSize?: IntegerOptional;
}
export interface RefreshSchemasMessage {
/**
* The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.
*/
EndpointArn: String;
/**
* The Amazon Resource Name (ARN) of the replication instance.
*/
ReplicationInstanceArn: String;
}
export interface RefreshSchemasResponse {
/**
* The status of the refreshed schema.
*/
RefreshSchemasStatus?: RefreshSchemasStatus;
}
export interface RefreshSchemasStatus {
/**
* The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.
*/
EndpointArn?: String;
/**
* The Amazon Resource Name (ARN) of the replication instance.
*/
ReplicationInstanceArn?: String;
/**
* The status of the schema.
*/
Status?: RefreshSchemasStatusTypeValue;
/**
* The date the schema was last refreshed.
*/
LastRefreshDate?: TStamp;
/**
* The last failure message for the schema.
*/
LastFailureMessage?: String;
}
export type RefreshSchemasStatusTypeValue = "successful"|"failed"|"refreshing"|string;
export type ReleaseStatusValues = "beta"|string;
export type ReloadOptionValue = "data-reload"|"validate-only"|string;
export interface ReloadTablesMessage {
/**
* The Amazon Resource Name (ARN) of the replication task.
*/
ReplicationTaskArn: String;
/**
* The name and schema of the table to be reloaded.
*/
TablesToReload: TableListToReload;
/**
* Options for reload. Specify data-reload to reload the data and re-validate it if validation is enabled. Specify validate-only to re-validate the table. This option applies only when validation is enabled for the task. Valid values: data-reload, validate-only Default value is data-reload.
*/
ReloadOption?: ReloadOptionValue;
}
export interface ReloadTablesResponse {
/**
* The Amazon Resource Name (ARN) of the replication task.
*/
ReplicationTaskArn?: String;
}
export interface RemoveTagsFromResourceMessage {
/**
* An AWS DMS resource from which you want to remove tag(s). The value for this parameter is an Amazon Resource Name (ARN).
*/
ResourceArn: String;
/**
* The tag key (name) of the tag to be removed.
*/
TagKeys: KeyList;
}
export interface RemoveTagsFromResourceResponse {
}
export type ReplicationEndpointTypeValue = "source"|"target"|string;
export interface ReplicationInstance {
/**
* The replication instance identifier is a required parameter. This parameter is stored as a lowercase string. Constraints: Must contain 1-63 alphanumeric characters or hyphens. First character must be a letter. Cannot end with a hyphen or contain two consecutive hyphens. Example: myrepinstance
*/
ReplicationInstanceIdentifier?: String;
/**
* The compute and memory capacity of the replication instance as defined for the specified replication instance class. It is a required parameter, although a defualt value is pre-selected in the DMS console. For more information on the settings and capacities for the available replication instance classes, see Selecting the right AWS DMS replication instance for your migration.
*/
ReplicationInstanceClass?: String;
/**
* The status of the replication instance. The possible return values include: "available" "creating" "deleted" "deleting" "failed" "modifying" "upgrading" "rebooting" "resetting-master-credentials" "storage-full" "incompatible-credentials" "incompatible-network" "maintenance"
*/
ReplicationInstanceStatus?: String;
/**
* The amount of storage (in gigabytes) that is allocated for the replication instance.
*/
AllocatedStorage?: Integer;
/**
* The time the replication instance was created.
*/
InstanceCreateTime?: TStamp;
/**
* The VPC security group for the instance.
*/
VpcSecurityGroups?: VpcSecurityGroupMembershipList;
/**
* The Availability Zone for the instance.
*/
AvailabilityZone?: String;
/**
* The subnet group for the replication instance.
*/
ReplicationSubnetGroup?: ReplicationSubnetGroup;
/**
* The maintenance window times for the replication instance. Any pending upgrades to the replication instance are performed during this time.
*/
PreferredMaintenanceWindow?: String;
/**
* The pending modification values.
*/
PendingModifiedValues?: ReplicationPendingModifiedValues;
/**
* Specifies whether the replication instance is a Multi-AZ deployment. You can't set the AvailabilityZone parameter if the Multi-AZ parameter is set to true.
*/
MultiAZ?: Boolean;
/**
* The engine version number of the replication instance. If an engine version number is not specified when a replication instance is created, the default is the latest engine version available. When modifying a major engine version of an instance, also set AllowMajorVersionUpgrade to true.
*/
EngineVersion?: String;
/**
* Boolean value indicating if minor version upgrades will be automatically applied to the instance.
*/
AutoMinorVersionUpgrade?: Boolean;
/**
* An AWS KMS key identifier that is used to encrypt the data on the replication instance. If you don't specify a value for the KmsKeyId parameter, then AWS DMS uses your default encryption key. AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS Region.
*/
KmsKeyId?: String;
/**
* The Amazon Resource Name (ARN) of the replication instance.
*/
ReplicationInstanceArn?: String;
/**
* The public IP address of the replication instance.
*/
ReplicationInstancePublicIpAddress?: String;
/**
* The private IP address of the replication instance.
*/
ReplicationInstancePrivateIpAddress?: String;
/**
* One or more public IP addresses for the replication instance.
*/
ReplicationInstancePublicIpAddresses?: ReplicationInstancePublicIpAddressList;
/**
* One or more private IP addresses for the replication instance.
*/
ReplicationInstancePrivateIpAddresses?: ReplicationInstancePrivateIpAddressList;
/**
* Specifies the accessibility options for the replication instance. A value of true represents an instance with a public IP address. A value of false represents an instance with a private IP address. The default value is true.
*/
PubliclyAccessible?: Boolean;
/**
* The Availability Zone of the standby replication instance in a Multi-AZ deployment.
*/
SecondaryAvailabilityZone?: String;
/**
* The expiration date of the free replication instance that is part of the Free DMS program.
*/
FreeUntil?: TStamp;
/**
* The DNS name servers supported for the replication instance to access your on-premise source or target database.
*/
DnsNameServers?: String;
}
export type ReplicationInstanceList = ReplicationInstance[];
export type ReplicationInstancePrivateIpAddressList = String[];
export type ReplicationInstancePublicIpAddressList = String[];
export interface ReplicationInstanceTaskLog {
/**
* The name of the replication task.
*/
ReplicationTaskName?: String;
/**
* The Amazon Resource Name (ARN) of the replication task.
*/
ReplicationTaskArn?: String;
/**
* The size, in bytes, of the replication task log.
*/
ReplicationInstanceTaskLogSize?: Long;
}
export type ReplicationInstanceTaskLogsList = ReplicationInstanceTaskLog[];
export interface ReplicationPendingModifiedValues {
/**
* The compute and memory capacity of the replication instance as defined for the specified replication instance class. For more information on the settings and capacities for the available replication instance classes, see Selecting the right AWS DMS replication instance for your migration.
*/
ReplicationInstanceClass?: String;
/**
* The amount of storage (in gigabytes) that is allocated for the replication instance.
*/
AllocatedStorage?: IntegerOptional;
/**
* Specifies whether the replication instance is a Multi-AZ deployment. You can't set the AvailabilityZone parameter if the Multi-AZ parameter is set to true.
*/
MultiAZ?: BooleanOptional;
/**
* The engine version number of the replication instance.
*/
EngineVersion?: String;
}
export interface ReplicationSubnetGroup {
/**
* The identifier of the replication instance subnet group.
*/
ReplicationSubnetGroupIdentifier?: String;
/**
* A description for the replication subnet group.
*/
ReplicationSubnetGroupDescription?: String;
/**
* The ID of the VPC.
*/
VpcId?: String;
/**
* The status of the subnet group.
*/
SubnetGroupStatus?: String;
/**
* The subnets that are in the subnet group.
*/
Subnets?: SubnetList;
}
export type ReplicationSubnetGroups = ReplicationSubnetGroup[];
export interface ReplicationTask {
/**
* The user-assigned replication task identifier or name. Constraints: Must contain 1-255 alphanumeric characters or hyphens. First character must be a letter. Cannot end with a hyphen or contain two consecutive hyphens.
*/
ReplicationTaskIdentifier?: String;
/**
* The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.
*/
SourceEndpointArn?: String;
/**
* The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.
*/
TargetEndpointArn?: String;
/**
* The Amazon Resource Name (ARN) of the replication instance.
*/
ReplicationInstanceArn?: String;
/**
* The type of migration.
*/
MigrationType?: MigrationTypeValue;
/**
* Table mappings specified in the task.
*/
TableMappings?: String;
/**
* The settings for the replication task.
*/
ReplicationTaskSettings?: String;
/**
* The status of the replication task.
*/
Status?: String;
/**
* The last error (failure) message generated for the replication task.
*/
LastFailureMessage?: String;
/**
* The reason the replication task was stopped. This response parameter can return one of the following values: "STOP_REASON_FULL_LOAD_COMPLETED" – Full-load migration completed. "STOP_REASON_CACHED_CHANGES_APPLIED" – Change data capture (CDC) load completed. "STOP_REASON_CACHED_CHANGES_NOT_APPLIED" – In a full-load and CDC migration, the full-load stopped as specified before starting the CDC migration. "STOP_REASON_SERVER_TIME" – The migration stopped at the specified server time.
*/
StopReason?: String;
/**
* The date the replication task was created.
*/
ReplicationTaskCreationDate?: TStamp;
/**
* The date the replication task is scheduled to start.
*/
ReplicationTaskStartDate?: TStamp;
/**
* Indicates when you want a change data capture (CDC) operation to start. Use either CdcStartPosition or CdcStartTime to specify when you want the CDC operation to start. Specifying both values results in an error. The value can be in date, checkpoint, or LSN/SCN format. Date Example: --cdc-start-position “2018-03-08T12:12:12” Checkpoint Example: --cdc-start-position "checkpoint:V1#27#mysql-bin-changelog.157832:1975:-1:2002:677883278264080:mysql-bin-changelog.157832:1876#0#0#*#0#93" LSN Example: --cdc-start-position “mysql-bin-changelog.000024:373”
*/
CdcStartPosition?: String;
/**
* Indicates when you want a change data capture (CDC) operation to stop. The value can be either server time or commit time. Server time example: --cdc-stop-position “server_time:2018-02-09T12:12:12” Commit time example: --cdc-stop-position “commit_time: 2018-02-09T12:12:12 “
*/
CdcStopPosition?: String;
/**
* Indicates the last checkpoint that occurred during a change data capture (CDC) operation. You can provide this value to the CdcStartPosition parameter to start a CDC operation that begins at that checkpoint.
*/
RecoveryCheckpoint?: String;
/**
* The Amazon Resource Name (ARN) of the replication task.
*/
ReplicationTaskArn?: String;
/**
* The statistics for the task, including elapsed time, tables loaded, and table errors.
*/
ReplicationTaskStats?: ReplicationTaskStats;
/**
* Supplemental information that the task requires to migrate the data for certain source and target endpoints. For more information, see Specifying Supplemental Data for Task Settings in the AWS Database Migration Service User Guide.
*/
TaskData?: String;
}
export interface ReplicationTaskAssessmentResult {
/**
* The replication task identifier of the task on which the task assessment was run.
*/
ReplicationTaskIdentifier?: String;
/**
* The Amazon Resource Name (ARN) of the replication task.
*/
ReplicationTaskArn?: String;
/**
* The date the task assessment was completed.
*/
ReplicationTaskLastAssessmentDate?: TStamp;
/**
* The status of the task assessment.
*/
AssessmentStatus?: String;
/**
* The file containing the results of the task assessment.
*/
AssessmentResultsFile?: String;
/**
* The task assessment results in JSON format.
*/
AssessmentResults?: String;
/**
* The URL of the S3 object containing the task assessment results.
*/
S3ObjectUrl?: String;
}
export type ReplicationTaskAssessmentResultList = ReplicationTaskAssessmentResult[];
export interface ReplicationTaskAssessmentRun {
/**
* Amazon Resource Name (ARN) of this assessment run.
*/
ReplicationTaskAssessmentRunArn?: String;
/**
* ARN of the migration task associated with this premigration assessment run.
*/
ReplicationTaskArn?: String;
/**
* Assessment run status. This status can have one of the following values: "cancelling" – The assessment run was canceled by the CancelReplicationTaskAssessmentRun operation. "deleting" – The assessment run was deleted by the DeleteReplicationTaskAssessmentRun operation. "failed" – At least one individual assessment completed with a failed status. "error-provisioning" – An internal error occurred while resources were provisioned (during provisioning status). "error-executing" – An internal error occurred while individual assessments ran (during running status). "invalid state" – The assessment run is in an unknown state. "passed" – All individual assessments have completed, and none has a failed status. "provisioning" – Resources required to run individual assessments are being provisioned. "running" – Individual assessments are being run. "starting" – The assessment run is starting, but resources are not yet being provisioned for individual assessments.
*/
Status?: String;
/**
* Date on which the assessment run was created using the StartReplicationTaskAssessmentRun operation.
*/
ReplicationTaskAssessmentRunCreationDate?: TStamp;
/**
* Indication of the completion progress for the individual assessments specified to run.
*/
AssessmentProgress?: ReplicationTaskAssessmentRunProgress;
/**
* Last message generated by an individual assessment failure.
*/
LastFailureMessage?: String;
/**
* ARN of the service role used to start the assessment run using the StartReplicationTaskAssessmentRun operation.
*/
ServiceAccessRoleArn?: String;
/**
* Amazon S3 bucket where AWS DMS stores the results of this assessment run.
*/
ResultLocationBucket?: String;
/**
* Folder in an Amazon S3 bucket where AWS DMS stores the results of this assessment run.
*/
ResultLocationFolder?: String;
/**
* Encryption mode used to encrypt the assessment run results.
*/
ResultEncryptionMode?: String;
/**
* ARN of the AWS KMS encryption key used to encrypt the assessment run results.
*/
ResultKmsKeyArn?: String;
/**
* Unique name of the assessment run.
*/
AssessmentRunName?: String;
}
export type ReplicationTaskAssessmentRunList = ReplicationTaskAssessmentRun[];
export interface ReplicationTaskAssessmentRunProgress {
/**
* The number of individual assessments that are specified to run.
*/
IndividualAssessmentCount?: Integer;
/**
* The number of individual assessments that have completed, successfully or not.
*/
IndividualAssessmentCompletedCount?: Integer;
}
export interface ReplicationTaskIndividualAssessment {
/**
* Amazon Resource Name (ARN) of this individual assessment.
*/
ReplicationTaskIndividualAssessmentArn?: String;
/**
* ARN of the premigration assessment run that is created to run this individual assessment.
*/
ReplicationTaskAssessmentRunArn?: String;
/**
* Name of this individual assessment.
*/
IndividualAssessmentName?: String;
/**
* Individual assessment status. This status can have one of the following values: "cancelled" "error" "failed" "passed" "pending" "running"
*/
Status?: String;
/**
* Date when this individual assessment was started as part of running the StartReplicationTaskAssessmentRun operation.
*/
ReplicationTaskIndividualAssessmentStartDate?: TStamp;
}
export type ReplicationTaskIndividualAssessmentList = ReplicationTaskIndividualAssessment[];
export type ReplicationTaskList = ReplicationTask[];
export interface ReplicationTaskStats {
/**
* The percent complete for the full load migration task.
*/
FullLoadProgressPercent?: Integer;
/**
* The elapsed time of the task, in milliseconds.
*/
ElapsedTimeMillis?: Long;
/**
* The number of tables loaded for this task.
*/
TablesLoaded?: Integer;
/**
* The number of tables currently loading for this task.
*/
TablesLoading?: Integer;
/**
* The number of tables queued for this task.
*/
TablesQueued?: Integer;
/**
* The number of errors that have occurred during this task.
*/
TablesErrored?: Integer;
/**
* The date the replication task was started either with a fresh start or a target reload.
*/
FreshStartDate?: TStamp;
/**
* The date the replication task was started either with a fresh start or a resume. For more information, see StartReplicationTaskType.
*/
StartDate?: TStamp;
/**
* The date the replication task was stopped.
*/
StopDate?: TStamp;
/**
* The date the replication task full load was started.
*/
FullLoadStartDate?: TStamp;
/**
* The date the replication task full load was completed.
*/
FullLoadFinishDate?: TStamp;
}
export interface ResourcePendingMaintenanceActions {
/**
* The Amazon Resource Name (ARN) of the DMS resource that the pending maintenance action applies to. For information about creating an ARN, see Constructing an Amazon Resource Name (ARN) for AWS DMS in the DMS documentation.
*/
ResourceIdentifier?: String;
/**
* Detailed information about the pending maintenance action.
*/
PendingMaintenanceActionDetails?: PendingMaintenanceActionDetails;
}
export interface S3Settings {
/**
* The Amazon Resource Name (ARN) used by the service access IAM role. It is a required parameter that enables DMS to write and read objects from an 3S bucket.
*/
ServiceAccessRoleArn?: String;
/**
* Specifies how tables are defined in the S3 source files only.
*/
ExternalTableDefinition?: String;
/**
* The delimiter used to separate rows in the .csv file for both source and target. The default is a carriage return (\n).
*/
CsvRowDelimiter?: String;
/**
* The delimiter used to separate columns in the .csv file for both source and target. The default is a comma.
*/
CsvDelimiter?: String;
/**
* An optional parameter to set a folder name in the S3 bucket. If provided, tables are created in the path bucketFolder/schema_name/table_name/. If this parameter isn't specified, then the path used is schema_name/table_name/.
*/
BucketFolder?: String;
/**
* The name of the S3 bucket.
*/
BucketName?: String;
/**
* An optional parameter to use GZIP to compress the target files. Set to GZIP to compress the target files. Either set this parameter to NONE (the default) or don't use it to leave the files uncompressed. This parameter applies to both .csv and .parquet file formats.
*/
CompressionType?: CompressionTypeValue;
/**
* The type of server-side encryption that you want to use for your data. This encryption type is part of the endpoint settings or the extra connections attributes for Amazon S3. You can choose either SSE_S3 (the default) or SSE_KMS. For the ModifyEndpoint operation, you can change the existing value of the EncryptionMode parameter from SSE_KMS to SSE_S3. But you can’t change the existing value from SSE_S3 to SSE_KMS. To use SSE_S3, you need an AWS Identity and Access Management (IAM) role with permission to allow "arn:aws:s3:::dms-*" to use the following actions: s3:CreateBucket s3:ListBucket s3:DeleteBucket s3:GetBucketLocation s3:GetObject s3:PutObject s3:DeleteObject s3:GetObjectVersion s3:GetBucketPolicy s3:PutBucketPolicy s3:DeleteBucketPolicy
*/
EncryptionMode?: EncryptionModeValue;
/**
* If you are using SSE_KMS for the EncryptionMode, provide the AWS KMS key ID. The key that you use needs an attached policy that enables AWS Identity and Access Management (IAM) user permissions and allows use of the key. Here is a CLI example: aws dms create-endpoint --endpoint-identifier value --endpoint-type target --engine-name s3 --s3-settings ServiceAccessRoleArn=value,BucketFolder=value,BucketName=value,EncryptionMode=SSE_KMS,ServerSideEncryptionKmsKeyId=value
*/
ServerSideEncryptionKmsKeyId?: String;
/**
* The format of the data that you want to use for output. You can choose one of the following: csv : This is a row-based file format with comma-separated values (.csv). parquet : Apache Parquet (.parquet) is a columnar storage file format that features efficient compression and provides faster query response.
*/
DataFormat?: DataFormatValue;
/**
* The type of encoding you are using: RLE_DICTIONARY uses a combination of bit-packing and run-length encoding to store repeated values more efficiently. This is the default. PLAIN doesn't use encoding at all. Values are stored as they are. PLAIN_DICTIONARY builds a dictionary of the values encountered in a given column. The dictionary is stored in a dictionary page for each column chunk.
*/
EncodingType?: EncodingTypeValue;
/**
* The maximum size of an encoded dictionary page of a column. If the dictionary page exceeds this, this column is stored using an encoding type of PLAIN. This parameter defaults to 1024 * 1024 bytes (1 MiB), the maximum size of a dictionary page before it reverts to PLAIN encoding. This size is used for .parquet file format only.
*/
DictPageSizeLimit?: IntegerOptional;
/**
* The number of rows in a row group. A smaller row group size provides faster reads. But as the number of row groups grows, the slower writes become. This parameter defaults to 10,000 rows. This number is used for .parquet file format only. If you choose a value larger than the maximum, RowGroupLength is set to the max row group length in bytes (64 * 1024 * 1024).
*/
RowGroupLength?: IntegerOptional;
/**
* The size of one data page in bytes. This parameter defaults to 1024 * 1024 bytes (1 MiB). This number is used for .parquet file format only.
*/
DataPageSize?: IntegerOptional;
/**
* The version of the Apache Parquet format that you want to use: parquet_1_0 (the default) or parquet_2_0.
*/
ParquetVersion?: ParquetVersionValue;
/**
* A value that enables statistics for Parquet pages and row groups. Choose true to enable statistics, false to disable. Statistics include NULL, DISTINCT, MAX, and MIN values. This parameter defaults to true. This value is used for .parquet file format only.
*/
EnableStatistics?: BooleanOptional;
/**
* A value that enables a full load to write INSERT operations to the comma-separated value (.csv) output files only to indicate how the rows were added to the source database. AWS DMS supports the IncludeOpForFullLoad parameter in versions 3.1.4 and later. For full load, records can only be inserted. By default (the false setting), no information is recorded in these output files for a full load to indicate that the rows were inserted at the source database. If IncludeOpForFullLoad is set to true or y, the INSERT is recorded as an I annotation in the first field of the .csv file. This allows the format of your target records from a full load to be consistent with the target records from a CDC load. This setting works together with the CdcInsertsOnly and the CdcInsertsAndUpdates parameters for output to .csv files only. For more information about how these settings work together, see Indicating Source DB Operations in Migrated S3 Data in the AWS Database Migration Service User Guide..
*/
IncludeOpForFullLoad?: BooleanOptional;
/**
* A value that enables a change data capture (CDC) load to write only INSERT operations to .csv or columnar storage (.parquet) output files. By default (the false setting), the first field in a .csv or .parquet record contains the letter I (INSERT), U (UPDATE), or D (DELETE). These values indicate whether the row was inserted, updated, or deleted at the source database for a CDC load to the target. If CdcInsertsOnly is set to true or y, only INSERTs from the source database are migrated to the .csv or .parquet file. For .csv format only, how these INSERTs are recorded depends on the value of IncludeOpForFullLoad. If IncludeOpForFullLoad is set to true, the first field of every CDC record is set to I to indicate the INSERT operation at the source. If IncludeOpForFullLoad is set to false, every CDC record is written without a first field to indicate the INSERT operation at the source. For more information about how these settings work together, see Indicating Source DB Operations in Migrated S3 Data in the AWS Database Migration Service User Guide.. AWS DMS supports the interaction described preceding between the CdcInsertsOnly and IncludeOpForFullLoad parameters in versions 3.1.4 and later. CdcInsertsOnly and CdcInsertsAndUpdates can't both be set to true for the same endpoint. Set either CdcInsertsOnly or CdcInsertsAndUpdates to true for the same endpoint, but not both.
*/
CdcInsertsOnly?: BooleanOptional;
/**
* A value that when nonblank causes AWS DMS to add a column with timestamp information to the endpoint data for an Amazon S3 target. AWS DMS supports the TimestampColumnName parameter in versions 3.1.4 and later. DMS includes an additional STRING column in the .csv or .parquet object files of your migrated data when you set TimestampColumnName to a nonblank value. For a full load, each row of this timestamp column contains a timestamp for when the data was transferred from the source to the target by DMS. For a change data capture (CDC) load, each row of the timestamp column contains the timestamp for the commit of that row in the source database. The string format for this timestamp column value is yyyy-MM-dd HH:mm:ss.SSSSSS. By default, the precision of this value is in microseconds. For a CDC load, the rounding of the precision depends on the commit timestamp supported by DMS for the source database. When the AddColumnName parameter is set to true, DMS also includes a name for the timestamp column that you set with TimestampColumnName.
*/
TimestampColumnName?: String;
/**
* A value that specifies the precision of any TIMESTAMP column values that are written to an Amazon S3 object file in .parquet format. AWS DMS supports the ParquetTimestampInMillisecond parameter in versions 3.1.4 and later. When ParquetTimestampInMillisecond is set to true or y, AWS DMS writes all TIMESTAMP columns in a .parquet formatted file with millisecond precision. Otherwise, DMS writes them with microsecond precision. Currently, Amazon Athena and AWS Glue can handle only millisecond precision for TIMESTAMP values. Set this parameter to true for S3 endpoint object files that are .parquet formatted only if you plan to query or process the data with Athena or AWS Glue. AWS DMS writes any TIMESTAMP column values written to an S3 file in .csv format with microsecond precision. Setting ParquetTimestampInMillisecond has no effect on the string format of the timestamp column value that is inserted by setting the TimestampColumnName parameter.
*/
ParquetTimestampInMillisecond?: BooleanOptional;
/**
* A value that enables a change data capture (CDC) load to write INSERT and UPDATE operations to .csv or .parquet (columnar storage) output files. The default setting is false, but when CdcInsertsAndUpdates is set to true or y, only INSERTs and UPDATEs from the source database are migrated to the .csv or .parquet file. For .csv file format only, how these INSERTs and UPDATEs are recorded depends on the value of the IncludeOpForFullLoad parameter. If IncludeOpForFullLoad is set to true, the first field of every CDC record is set to either I or U to indicate INSERT and UPDATE operations at the source. But if IncludeOpForFullLoad is set to false, CDC records are written without an indication of INSERT or UPDATE operations at the source. For more information about how these settings work together, see Indicating Source DB Operations in Migrated S3 Data in the AWS Database Migration Service User Guide.. AWS DMS supports the use of the CdcInsertsAndUpdates parameter in versions 3.3.1 and later. CdcInsertsOnly and CdcInsertsAndUpdates can't both be set to true for the same endpoint. Set either CdcInsertsOnly or CdcInsertsAndUpdates to true for the same endpoint, but not both.
*/
CdcInsertsAndUpdates?: BooleanOptional;
/**
* When set to true, this parameter partitions S3 bucket folders based on transaction commit dates. The default value is false. For more information about date-based folder partitoning, see Using date-based folder partitioning
*/
DatePartitionEnabled?: BooleanOptional;
/**
* Identifies the sequence of the date format to use during folder partitioning. The default value is YYYYMMDD. Use this parameter when DatePartitionedEnabled is set to true.
*/
DatePartitionSequence?: DatePartitionSequenceValue;
/**
* Specifies a date separating delimiter to use during folder partitioning. The default value is SLASH (/). Use this parameter when DatePartitionedEnabled is set to true.
*/
DatePartitionDelimiter?: DatePartitionDelimiterValue;
}
export type SafeguardPolicy = "rely-on-sql-server-replication-agent"|"exclusive-automatic-truncation"|"shared-automatic-truncation"|string;
export type SchemaList = String[];
export type SecretString = string;
export type SourceIdsList = String[];
export type SourceType = "replication-instance"|string;
export interface StartReplicationTaskAssessmentMessage {
/**
* The Amazon Resource Name (ARN) of the replication task.
*/
ReplicationTaskArn: String;
}
export interface StartReplicationTaskAssessmentResponse {
/**
* The assessed replication task.
*/
ReplicationTask?: ReplicationTask;
}
export interface StartReplicationTaskAssessmentRunMessage {
/**
* Amazon Resource Name (ARN) of the migration task associated with the premigration assessment run that you want to start.
*/
ReplicationTaskArn: String;
/**
* ARN of a service role needed to start the assessment run.
*/
ServiceAccessRoleArn: String;
/**
* Amazon S3 bucket where you want AWS DMS to store the results of this assessment run.
*/
ResultLocationBucket: String;
/**
* Folder within an Amazon S3 bucket where you want AWS DMS to store the results of this assessment run.
*/
ResultLocationFolder?: String;
/**
* Encryption mode that you can specify to encrypt the results of this assessment run. If you don't specify this request parameter, AWS DMS stores the assessment run results without encryption. You can specify one of the options following: "SSE_S3" – The server-side encryption provided as a default by Amazon S3. "SSE_KMS" – AWS Key Management Service (AWS KMS) encryption. This encryption can use either a custom KMS encryption key that you specify or the default KMS encryption key that DMS provides.
*/
ResultEncryptionMode?: String;
/**
* ARN of a custom KMS encryption key that you specify when you set ResultEncryptionMode to "SSE_KMS".
*/
ResultKmsKeyArn?: String;
/**
* Unique name to identify the assessment run.
*/
AssessmentRunName: String;
/**
* Space-separated list of names for specific individual assessments that you want to include. These names come from the default list of individual assessments that AWS DMS supports for the associated migration task. This task is specified by ReplicationTaskArn. You can't set a value for IncludeOnly if you also set a value for Exclude in the API operation. To identify the names of the default individual assessments that AWS DMS supports for the associated migration task, run the DescribeApplicableIndividualAssessments operation using its own ReplicationTaskArn request parameter.
*/
IncludeOnly?: IncludeTestList;
/**
* Space-separated list of names for specific individual assessments that you want to exclude. These names come from the default list of individual assessments that AWS DMS supports for the associated migration task. This task is specified by ReplicationTaskArn. You can't set a value for Exclude if you also set a value for IncludeOnly in the API operation. To identify the names of the default individual assessments that AWS DMS supports for the associated migration task, run the DescribeApplicableIndividualAssessments operation using its own ReplicationTaskArn request parameter.
*/
Exclude?: ExcludeTestList;
}
export interface StartReplicationTaskAssessmentRunResponse {
/**
* The premigration assessment run that was started.
*/
ReplicationTaskAssessmentRun?: ReplicationTaskAssessmentRun;
}
export interface StartReplicationTaskMessage {
/**
* The Amazon Resource Name (ARN) of the replication task to be started.
*/
ReplicationTaskArn: String;
/**
* The type of replication task.
*/
StartReplicationTaskType: StartReplicationTaskTypeValue;
/**
* Indicates the start time for a change data capture (CDC) operation. Use either CdcStartTime or CdcStartPosition to specify when you want a CDC operation to start. Specifying both values results in an error. Timestamp Example: --cdc-start-time “2018-03-08T12:12:12”
*/
CdcStartTime?: TStamp;
/**
* Indicates when you want a change data capture (CDC) operation to start. Use either CdcStartPosition or CdcStartTime to specify when you want a CDC operation to start. Specifying both values results in an error. The value can be in date, checkpoint, or LSN/SCN format. Date Example: --cdc-start-position “2018-03-08T12:12:12” Checkpoint Example: --cdc-start-position "checkpoint:V1#27#mysql-bin-changelog.157832:1975:-1:2002:677883278264080:mysql-bin-changelog.157832:1876#0#0#*#0#93" LSN Example: --cdc-start-position “mysql-bin-changelog.000024:373” When you use this task setting with a source PostgreSQL database, a logical replication slot should already be created and associated with the source endpoint. You can verify this by setting the slotName extra connection attribute to the name of this logical replication slot. For more information, see Extra Connection Attributes When Using PostgreSQL as a Source for AWS DMS.
*/
CdcStartPosition?: String;
/**
* Indicates when you want a change data capture (CDC) operation to stop. The value can be either server time or commit time. Server time example: --cdc-stop-position “server_time:2018-02-09T12:12:12” Commit time example: --cdc-stop-position “commit_time: 2018-02-09T12:12:12 “
*/
CdcStopPosition?: String;
}
export interface StartReplicationTaskResponse {
/**
* The replication task started.
*/
ReplicationTask?: ReplicationTask;
}
export type StartReplicationTaskTypeValue = "start-replication"|"resume-processing"|"reload-target"|string;
export interface StopReplicationTaskMessage {
/**
* The Amazon Resource Name(ARN) of the replication task to be stopped.
*/
ReplicationTaskArn: String;
}
export interface StopReplicationTaskResponse {
/**
* The replication task stopped.
*/
ReplicationTask?: ReplicationTask;
}
export type String = string;
export interface Subnet {
/**
* The subnet identifier.
*/
SubnetIdentifier?: String;
/**
* The Availability Zone of the subnet.
*/
SubnetAvailabilityZone?: AvailabilityZone;
/**
* The status of the subnet.
*/
SubnetStatus?: String;
}
export type SubnetIdentifierList = String[];
export type SubnetList = Subnet[];
export interface SupportedEndpointType {
/**
* The database engine name. Valid values, depending on the EndpointType, include "mysql", "oracle", "postgres", "mariadb", "aurora", "aurora-postgresql", "redshift", "s3", "db2", "azuredb", "sybase", "dynamodb", "mongodb", "kinesis", "kafka", "elasticsearch", "documentdb", "sqlserver", and "neptune".
*/
EngineName?: String;
/**
* Indicates if Change Data Capture (CDC) is supported.
*/
SupportsCDC?: Boolean;
/**
* The type of endpoint. Valid values are source and target.
*/
EndpointType?: ReplicationEndpointTypeValue;
/**
* The earliest AWS DMS engine version that supports this endpoint engine. Note that endpoint engines released with AWS DMS versions earlier than 3.1.1 do not return a value for this parameter.
*/
ReplicationInstanceEngineMinimumVersion?: String;
/**
* The expanded name for the engine name. For example, if the EngineName parameter is "aurora," this value would be "Amazon Aurora MySQL."
*/
EngineDisplayName?: String;
}
export type SupportedEndpointTypeList = SupportedEndpointType[];
export interface SybaseSettings {
/**
* Database name for the endpoint.
*/
DatabaseName?: String;
/**
* Endpoint connection password.
*/
Password?: SecretString;
/**
* Endpoint TCP port.
*/
Port?: IntegerOptional;
/**
* Fully qualified domain name of the endpoint.
*/
ServerName?: String;
/**
* Endpoint connection user name.
*/
Username?: String;
}
export type TStamp = Date;
export type TableListToReload = TableToReload[];
export interface TableStatistics {
/**
* The schema name.
*/
SchemaName?: String;
/**
* The name of the table.
*/
TableName?: String;
/**
* The number of insert actions performed on a table.
*/
Inserts?: Long;
/**
* The number of delete actions performed on a table.
*/
Deletes?: Long;
/**
* The number of update actions performed on a table.
*/
Updates?: Long;
/**
* The data definition language (DDL) used to build and modify the structure of your tables.
*/
Ddls?: Long;
/**
* The number of rows added during the full load operation.
*/
FullLoadRows?: Long;
/**
* The number of rows that failed conditional checks during the full load operation (valid only for migrations where DynamoDB is the target).
*/
FullLoadCondtnlChkFailedRows?: Long;
/**
* The number of rows that failed to load during the full load operation (valid only for migrations where DynamoDB is the target).
*/
FullLoadErrorRows?: Long;
/**
* The time when the full load operation started.
*/
FullLoadStartTime?: TStamp;
/**
* The time when the full load operation completed.
*/
FullLoadEndTime?: TStamp;
/**
* A value that indicates if the table was reloaded (true) or loaded as part of a new full load operation (false).
*/
FullLoadReloaded?: BooleanOptional;
/**
* The last time a table was updated.
*/
LastUpdateTime?: TStamp;
/**
* The state of the tables described. Valid states: Table does not exist | Before load | Full load | Table completed | Table cancelled | Table error | Table all | Table updates | Table is being reloaded
*/
TableState?: String;
/**
* The number of records that have yet to be validated.
*/
ValidationPendingRecords?: Long;
/**
* The number of records that failed validation.
*/
ValidationFailedRecords?: Long;
/**
* The number of records that couldn't be validated.
*/
ValidationSuspendedRecords?: Long;
/**
* The validation state of the table. This parameter can have the following values: Not enabled – Validation isn't enabled for the table in the migration task. Pending records – Some records in the table are waiting for validation. Mismatched records – Some records in the table don't match between the source and target. Suspended records – Some records in the table couldn't be validated. No primary key –The table couldn't be validated because it has no primary key. Table error – The table wasn't validated because it's in an error state and some data wasn't migrated. Validated – All rows in the table are validated. If the table is updated, the status can change from Validated. Error – The table couldn't be validated because of an unexpected error. Pending validation – The table is waiting validation. Preparing table – Preparing the table enabled in the migration task for validation. Pending revalidation – All rows in the table are pending validation after the table was updated.
*/
ValidationState?: String;
/**
* Additional details about the state of validation.
*/
ValidationStateDetails?: String;
}
export type TableStatisticsList = TableStatistics[];
export interface TableToReload {
/**
* The schema name of the table to be reloaded.
*/
SchemaName: String;
/**
* The table name of the table to be reloaded.
*/
TableName: String;
}
export interface Tag {
/**
* A key is the required name of the tag. The string value can be 1-128 Unicode characters in length and can't be prefixed with "aws:" or "dms:". The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', '/', '=', '+', '-' (Java regular expressions: "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-]*)$").
*/
Key?: String;
/**
* A value is the optional value of the tag. The string value can be 1-256 Unicode characters in length and can't be prefixed with "aws:" or "dms:". The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', '/', '=', '+', '-' (Java regular expressions: "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-]*)$").
*/
Value?: String;
}
export type TagList = Tag[];
export type TargetDbType = "specific-database"|"multiple-databases"|string;
export interface TestConnectionMessage {
/**
* The Amazon Resource Name (ARN) of the replication instance.
*/
ReplicationInstanceArn: String;
/**
* The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.
*/
EndpointArn: String;
}
export interface TestConnectionResponse {
/**
* The connection tested.
*/
Connection?: Connection;
}
export type VpcSecurityGroupIdList = String[];
export interface VpcSecurityGroupMembership {
/**
* The VPC security group ID.
*/
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 = "2016-01-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 DMS client.
*/
export import Types = DMS;
}
export = DMS;