directoryservice.d.ts
113 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
import {Request} from '../lib/request';
import {Response} from '../lib/response';
import {AWSError} from '../lib/error';
import {Service} from '../lib/service';
import {ServiceConfigurationOptions} from '../lib/service';
import {ConfigBase as Config} from '../lib/config';
interface Blob {}
declare class DirectoryService extends Service {
/**
* Constructs a service object. This object has one method for each API operation.
*/
constructor(options?: DirectoryService.Types.ClientConfiguration)
config: Config & DirectoryService.Types.ClientConfiguration;
/**
* Accepts a directory sharing request that was sent from the directory owner account.
*/
acceptSharedDirectory(params: DirectoryService.Types.AcceptSharedDirectoryRequest, callback?: (err: AWSError, data: DirectoryService.Types.AcceptSharedDirectoryResult) => void): Request<DirectoryService.Types.AcceptSharedDirectoryResult, AWSError>;
/**
* Accepts a directory sharing request that was sent from the directory owner account.
*/
acceptSharedDirectory(callback?: (err: AWSError, data: DirectoryService.Types.AcceptSharedDirectoryResult) => void): Request<DirectoryService.Types.AcceptSharedDirectoryResult, AWSError>;
/**
* If the DNS server for your on-premises domain uses a publicly addressable IP address, you must add a CIDR address block to correctly route traffic to and from your Microsoft AD on Amazon Web Services. AddIpRoutes adds this address block. You can also use AddIpRoutes to facilitate routing traffic that uses public IP ranges from your Microsoft AD on AWS to a peer VPC. Before you call AddIpRoutes, ensure that all of the required permissions have been explicitly granted through a policy. For details about what permissions are required to run the AddIpRoutes operation, see AWS Directory Service API Permissions: Actions, Resources, and Conditions Reference.
*/
addIpRoutes(params: DirectoryService.Types.AddIpRoutesRequest, callback?: (err: AWSError, data: DirectoryService.Types.AddIpRoutesResult) => void): Request<DirectoryService.Types.AddIpRoutesResult, AWSError>;
/**
* If the DNS server for your on-premises domain uses a publicly addressable IP address, you must add a CIDR address block to correctly route traffic to and from your Microsoft AD on Amazon Web Services. AddIpRoutes adds this address block. You can also use AddIpRoutes to facilitate routing traffic that uses public IP ranges from your Microsoft AD on AWS to a peer VPC. Before you call AddIpRoutes, ensure that all of the required permissions have been explicitly granted through a policy. For details about what permissions are required to run the AddIpRoutes operation, see AWS Directory Service API Permissions: Actions, Resources, and Conditions Reference.
*/
addIpRoutes(callback?: (err: AWSError, data: DirectoryService.Types.AddIpRoutesResult) => void): Request<DirectoryService.Types.AddIpRoutesResult, AWSError>;
/**
* Adds or overwrites one or more tags for the specified directory. Each directory can have a maximum of 50 tags. Each tag consists of a key and optional value. Tag keys must be unique to each resource.
*/
addTagsToResource(params: DirectoryService.Types.AddTagsToResourceRequest, callback?: (err: AWSError, data: DirectoryService.Types.AddTagsToResourceResult) => void): Request<DirectoryService.Types.AddTagsToResourceResult, AWSError>;
/**
* Adds or overwrites one or more tags for the specified directory. Each directory can have a maximum of 50 tags. Each tag consists of a key and optional value. Tag keys must be unique to each resource.
*/
addTagsToResource(callback?: (err: AWSError, data: DirectoryService.Types.AddTagsToResourceResult) => void): Request<DirectoryService.Types.AddTagsToResourceResult, AWSError>;
/**
* Cancels an in-progress schema extension to a Microsoft AD directory. Once a schema extension has started replicating to all domain controllers, the task can no longer be canceled. A schema extension can be canceled during any of the following states; Initializing, CreatingSnapshot, and UpdatingSchema.
*/
cancelSchemaExtension(params: DirectoryService.Types.CancelSchemaExtensionRequest, callback?: (err: AWSError, data: DirectoryService.Types.CancelSchemaExtensionResult) => void): Request<DirectoryService.Types.CancelSchemaExtensionResult, AWSError>;
/**
* Cancels an in-progress schema extension to a Microsoft AD directory. Once a schema extension has started replicating to all domain controllers, the task can no longer be canceled. A schema extension can be canceled during any of the following states; Initializing, CreatingSnapshot, and UpdatingSchema.
*/
cancelSchemaExtension(callback?: (err: AWSError, data: DirectoryService.Types.CancelSchemaExtensionResult) => void): Request<DirectoryService.Types.CancelSchemaExtensionResult, AWSError>;
/**
* Creates an AD Connector to connect to an on-premises directory. Before you call ConnectDirectory, ensure that all of the required permissions have been explicitly granted through a policy. For details about what permissions are required to run the ConnectDirectory operation, see AWS Directory Service API Permissions: Actions, Resources, and Conditions Reference.
*/
connectDirectory(params: DirectoryService.Types.ConnectDirectoryRequest, callback?: (err: AWSError, data: DirectoryService.Types.ConnectDirectoryResult) => void): Request<DirectoryService.Types.ConnectDirectoryResult, AWSError>;
/**
* Creates an AD Connector to connect to an on-premises directory. Before you call ConnectDirectory, ensure that all of the required permissions have been explicitly granted through a policy. For details about what permissions are required to run the ConnectDirectory operation, see AWS Directory Service API Permissions: Actions, Resources, and Conditions Reference.
*/
connectDirectory(callback?: (err: AWSError, data: DirectoryService.Types.ConnectDirectoryResult) => void): Request<DirectoryService.Types.ConnectDirectoryResult, AWSError>;
/**
* Creates an alias for a directory and assigns the alias to the directory. The alias is used to construct the access URL for the directory, such as http://<alias>.awsapps.com. After an alias has been created, it cannot be deleted or reused, so this operation should only be used when absolutely necessary.
*/
createAlias(params: DirectoryService.Types.CreateAliasRequest, callback?: (err: AWSError, data: DirectoryService.Types.CreateAliasResult) => void): Request<DirectoryService.Types.CreateAliasResult, AWSError>;
/**
* Creates an alias for a directory and assigns the alias to the directory. The alias is used to construct the access URL for the directory, such as http://<alias>.awsapps.com. After an alias has been created, it cannot be deleted or reused, so this operation should only be used when absolutely necessary.
*/
createAlias(callback?: (err: AWSError, data: DirectoryService.Types.CreateAliasResult) => void): Request<DirectoryService.Types.CreateAliasResult, AWSError>;
/**
* Creates a computer account in the specified directory, and joins the computer to the directory.
*/
createComputer(params: DirectoryService.Types.CreateComputerRequest, callback?: (err: AWSError, data: DirectoryService.Types.CreateComputerResult) => void): Request<DirectoryService.Types.CreateComputerResult, AWSError>;
/**
* Creates a computer account in the specified directory, and joins the computer to the directory.
*/
createComputer(callback?: (err: AWSError, data: DirectoryService.Types.CreateComputerResult) => void): Request<DirectoryService.Types.CreateComputerResult, AWSError>;
/**
* Creates a conditional forwarder associated with your AWS directory. Conditional forwarders are required in order to set up a trust relationship with another domain. The conditional forwarder points to the trusted domain.
*/
createConditionalForwarder(params: DirectoryService.Types.CreateConditionalForwarderRequest, callback?: (err: AWSError, data: DirectoryService.Types.CreateConditionalForwarderResult) => void): Request<DirectoryService.Types.CreateConditionalForwarderResult, AWSError>;
/**
* Creates a conditional forwarder associated with your AWS directory. Conditional forwarders are required in order to set up a trust relationship with another domain. The conditional forwarder points to the trusted domain.
*/
createConditionalForwarder(callback?: (err: AWSError, data: DirectoryService.Types.CreateConditionalForwarderResult) => void): Request<DirectoryService.Types.CreateConditionalForwarderResult, AWSError>;
/**
* Creates a Simple AD directory. For more information, see Simple Active Directory in the AWS Directory Service Admin Guide. Before you call CreateDirectory, ensure that all of the required permissions have been explicitly granted through a policy. For details about what permissions are required to run the CreateDirectory operation, see AWS Directory Service API Permissions: Actions, Resources, and Conditions Reference.
*/
createDirectory(params: DirectoryService.Types.CreateDirectoryRequest, callback?: (err: AWSError, data: DirectoryService.Types.CreateDirectoryResult) => void): Request<DirectoryService.Types.CreateDirectoryResult, AWSError>;
/**
* Creates a Simple AD directory. For more information, see Simple Active Directory in the AWS Directory Service Admin Guide. Before you call CreateDirectory, ensure that all of the required permissions have been explicitly granted through a policy. For details about what permissions are required to run the CreateDirectory operation, see AWS Directory Service API Permissions: Actions, Resources, and Conditions Reference.
*/
createDirectory(callback?: (err: AWSError, data: DirectoryService.Types.CreateDirectoryResult) => void): Request<DirectoryService.Types.CreateDirectoryResult, AWSError>;
/**
* Creates a subscription to forward real-time Directory Service domain controller security logs to the specified Amazon CloudWatch log group in your AWS account.
*/
createLogSubscription(params: DirectoryService.Types.CreateLogSubscriptionRequest, callback?: (err: AWSError, data: DirectoryService.Types.CreateLogSubscriptionResult) => void): Request<DirectoryService.Types.CreateLogSubscriptionResult, AWSError>;
/**
* Creates a subscription to forward real-time Directory Service domain controller security logs to the specified Amazon CloudWatch log group in your AWS account.
*/
createLogSubscription(callback?: (err: AWSError, data: DirectoryService.Types.CreateLogSubscriptionResult) => void): Request<DirectoryService.Types.CreateLogSubscriptionResult, AWSError>;
/**
* Creates a Microsoft AD directory in the AWS Cloud. For more information, see AWS Managed Microsoft AD in the AWS Directory Service Admin Guide. Before you call CreateMicrosoftAD, ensure that all of the required permissions have been explicitly granted through a policy. For details about what permissions are required to run the CreateMicrosoftAD operation, see AWS Directory Service API Permissions: Actions, Resources, and Conditions Reference.
*/
createMicrosoftAD(params: DirectoryService.Types.CreateMicrosoftADRequest, callback?: (err: AWSError, data: DirectoryService.Types.CreateMicrosoftADResult) => void): Request<DirectoryService.Types.CreateMicrosoftADResult, AWSError>;
/**
* Creates a Microsoft AD directory in the AWS Cloud. For more information, see AWS Managed Microsoft AD in the AWS Directory Service Admin Guide. Before you call CreateMicrosoftAD, ensure that all of the required permissions have been explicitly granted through a policy. For details about what permissions are required to run the CreateMicrosoftAD operation, see AWS Directory Service API Permissions: Actions, Resources, and Conditions Reference.
*/
createMicrosoftAD(callback?: (err: AWSError, data: DirectoryService.Types.CreateMicrosoftADResult) => void): Request<DirectoryService.Types.CreateMicrosoftADResult, AWSError>;
/**
* Creates a snapshot of a Simple AD or Microsoft AD directory in the AWS cloud. You cannot take snapshots of AD Connector directories.
*/
createSnapshot(params: DirectoryService.Types.CreateSnapshotRequest, callback?: (err: AWSError, data: DirectoryService.Types.CreateSnapshotResult) => void): Request<DirectoryService.Types.CreateSnapshotResult, AWSError>;
/**
* Creates a snapshot of a Simple AD or Microsoft AD directory in the AWS cloud. You cannot take snapshots of AD Connector directories.
*/
createSnapshot(callback?: (err: AWSError, data: DirectoryService.Types.CreateSnapshotResult) => void): Request<DirectoryService.Types.CreateSnapshotResult, AWSError>;
/**
* AWS Directory Service for Microsoft Active Directory allows you to configure trust relationships. For example, you can establish a trust between your AWS Managed Microsoft AD directory, and your existing on-premises Microsoft Active Directory. This would allow you to provide users and groups access to resources in either domain, with a single set of credentials. This action initiates the creation of the AWS side of a trust relationship between an AWS Managed Microsoft AD directory and an external domain. You can create either a forest trust or an external trust.
*/
createTrust(params: DirectoryService.Types.CreateTrustRequest, callback?: (err: AWSError, data: DirectoryService.Types.CreateTrustResult) => void): Request<DirectoryService.Types.CreateTrustResult, AWSError>;
/**
* AWS Directory Service for Microsoft Active Directory allows you to configure trust relationships. For example, you can establish a trust between your AWS Managed Microsoft AD directory, and your existing on-premises Microsoft Active Directory. This would allow you to provide users and groups access to resources in either domain, with a single set of credentials. This action initiates the creation of the AWS side of a trust relationship between an AWS Managed Microsoft AD directory and an external domain. You can create either a forest trust or an external trust.
*/
createTrust(callback?: (err: AWSError, data: DirectoryService.Types.CreateTrustResult) => void): Request<DirectoryService.Types.CreateTrustResult, AWSError>;
/**
* Deletes a conditional forwarder that has been set up for your AWS directory.
*/
deleteConditionalForwarder(params: DirectoryService.Types.DeleteConditionalForwarderRequest, callback?: (err: AWSError, data: DirectoryService.Types.DeleteConditionalForwarderResult) => void): Request<DirectoryService.Types.DeleteConditionalForwarderResult, AWSError>;
/**
* Deletes a conditional forwarder that has been set up for your AWS directory.
*/
deleteConditionalForwarder(callback?: (err: AWSError, data: DirectoryService.Types.DeleteConditionalForwarderResult) => void): Request<DirectoryService.Types.DeleteConditionalForwarderResult, AWSError>;
/**
* Deletes an AWS Directory Service directory. Before you call DeleteDirectory, ensure that all of the required permissions have been explicitly granted through a policy. For details about what permissions are required to run the DeleteDirectory operation, see AWS Directory Service API Permissions: Actions, Resources, and Conditions Reference.
*/
deleteDirectory(params: DirectoryService.Types.DeleteDirectoryRequest, callback?: (err: AWSError, data: DirectoryService.Types.DeleteDirectoryResult) => void): Request<DirectoryService.Types.DeleteDirectoryResult, AWSError>;
/**
* Deletes an AWS Directory Service directory. Before you call DeleteDirectory, ensure that all of the required permissions have been explicitly granted through a policy. For details about what permissions are required to run the DeleteDirectory operation, see AWS Directory Service API Permissions: Actions, Resources, and Conditions Reference.
*/
deleteDirectory(callback?: (err: AWSError, data: DirectoryService.Types.DeleteDirectoryResult) => void): Request<DirectoryService.Types.DeleteDirectoryResult, AWSError>;
/**
* Deletes the specified log subscription.
*/
deleteLogSubscription(params: DirectoryService.Types.DeleteLogSubscriptionRequest, callback?: (err: AWSError, data: DirectoryService.Types.DeleteLogSubscriptionResult) => void): Request<DirectoryService.Types.DeleteLogSubscriptionResult, AWSError>;
/**
* Deletes the specified log subscription.
*/
deleteLogSubscription(callback?: (err: AWSError, data: DirectoryService.Types.DeleteLogSubscriptionResult) => void): Request<DirectoryService.Types.DeleteLogSubscriptionResult, AWSError>;
/**
* Deletes a directory snapshot.
*/
deleteSnapshot(params: DirectoryService.Types.DeleteSnapshotRequest, callback?: (err: AWSError, data: DirectoryService.Types.DeleteSnapshotResult) => void): Request<DirectoryService.Types.DeleteSnapshotResult, AWSError>;
/**
* Deletes a directory snapshot.
*/
deleteSnapshot(callback?: (err: AWSError, data: DirectoryService.Types.DeleteSnapshotResult) => void): Request<DirectoryService.Types.DeleteSnapshotResult, AWSError>;
/**
* Deletes an existing trust relationship between your AWS Managed Microsoft AD directory and an external domain.
*/
deleteTrust(params: DirectoryService.Types.DeleteTrustRequest, callback?: (err: AWSError, data: DirectoryService.Types.DeleteTrustResult) => void): Request<DirectoryService.Types.DeleteTrustResult, AWSError>;
/**
* Deletes an existing trust relationship between your AWS Managed Microsoft AD directory and an external domain.
*/
deleteTrust(callback?: (err: AWSError, data: DirectoryService.Types.DeleteTrustResult) => void): Request<DirectoryService.Types.DeleteTrustResult, AWSError>;
/**
* Deletes from the system the certificate that was registered for a secured LDAP connection.
*/
deregisterCertificate(params: DirectoryService.Types.DeregisterCertificateRequest, callback?: (err: AWSError, data: DirectoryService.Types.DeregisterCertificateResult) => void): Request<DirectoryService.Types.DeregisterCertificateResult, AWSError>;
/**
* Deletes from the system the certificate that was registered for a secured LDAP connection.
*/
deregisterCertificate(callback?: (err: AWSError, data: DirectoryService.Types.DeregisterCertificateResult) => void): Request<DirectoryService.Types.DeregisterCertificateResult, AWSError>;
/**
* Removes the specified directory as a publisher to the specified SNS topic.
*/
deregisterEventTopic(params: DirectoryService.Types.DeregisterEventTopicRequest, callback?: (err: AWSError, data: DirectoryService.Types.DeregisterEventTopicResult) => void): Request<DirectoryService.Types.DeregisterEventTopicResult, AWSError>;
/**
* Removes the specified directory as a publisher to the specified SNS topic.
*/
deregisterEventTopic(callback?: (err: AWSError, data: DirectoryService.Types.DeregisterEventTopicResult) => void): Request<DirectoryService.Types.DeregisterEventTopicResult, AWSError>;
/**
* Displays information about the certificate registered for a secured LDAP connection.
*/
describeCertificate(params: DirectoryService.Types.DescribeCertificateRequest, callback?: (err: AWSError, data: DirectoryService.Types.DescribeCertificateResult) => void): Request<DirectoryService.Types.DescribeCertificateResult, AWSError>;
/**
* Displays information about the certificate registered for a secured LDAP connection.
*/
describeCertificate(callback?: (err: AWSError, data: DirectoryService.Types.DescribeCertificateResult) => void): Request<DirectoryService.Types.DescribeCertificateResult, AWSError>;
/**
* Obtains information about the conditional forwarders for this account. If no input parameters are provided for RemoteDomainNames, this request describes all conditional forwarders for the specified directory ID.
*/
describeConditionalForwarders(params: DirectoryService.Types.DescribeConditionalForwardersRequest, callback?: (err: AWSError, data: DirectoryService.Types.DescribeConditionalForwardersResult) => void): Request<DirectoryService.Types.DescribeConditionalForwardersResult, AWSError>;
/**
* Obtains information about the conditional forwarders for this account. If no input parameters are provided for RemoteDomainNames, this request describes all conditional forwarders for the specified directory ID.
*/
describeConditionalForwarders(callback?: (err: AWSError, data: DirectoryService.Types.DescribeConditionalForwardersResult) => void): Request<DirectoryService.Types.DescribeConditionalForwardersResult, AWSError>;
/**
* Obtains information about the directories that belong to this account. You can retrieve information about specific directories by passing the directory identifiers in the DirectoryIds parameter. Otherwise, all directories that belong to the current account are returned. This operation supports pagination with the use of the NextToken request and response parameters. If more results are available, the DescribeDirectoriesResult.NextToken member contains a token that you pass in the next call to DescribeDirectories to retrieve the next set of items. You can also specify a maximum number of return results with the Limit parameter.
*/
describeDirectories(params: DirectoryService.Types.DescribeDirectoriesRequest, callback?: (err: AWSError, data: DirectoryService.Types.DescribeDirectoriesResult) => void): Request<DirectoryService.Types.DescribeDirectoriesResult, AWSError>;
/**
* Obtains information about the directories that belong to this account. You can retrieve information about specific directories by passing the directory identifiers in the DirectoryIds parameter. Otherwise, all directories that belong to the current account are returned. This operation supports pagination with the use of the NextToken request and response parameters. If more results are available, the DescribeDirectoriesResult.NextToken member contains a token that you pass in the next call to DescribeDirectories to retrieve the next set of items. You can also specify a maximum number of return results with the Limit parameter.
*/
describeDirectories(callback?: (err: AWSError, data: DirectoryService.Types.DescribeDirectoriesResult) => void): Request<DirectoryService.Types.DescribeDirectoriesResult, AWSError>;
/**
* Provides information about any domain controllers in your directory.
*/
describeDomainControllers(params: DirectoryService.Types.DescribeDomainControllersRequest, callback?: (err: AWSError, data: DirectoryService.Types.DescribeDomainControllersResult) => void): Request<DirectoryService.Types.DescribeDomainControllersResult, AWSError>;
/**
* Provides information about any domain controllers in your directory.
*/
describeDomainControllers(callback?: (err: AWSError, data: DirectoryService.Types.DescribeDomainControllersResult) => void): Request<DirectoryService.Types.DescribeDomainControllersResult, AWSError>;
/**
* Obtains information about which SNS topics receive status messages from the specified directory. If no input parameters are provided, such as DirectoryId or TopicName, this request describes all of the associations in the account.
*/
describeEventTopics(params: DirectoryService.Types.DescribeEventTopicsRequest, callback?: (err: AWSError, data: DirectoryService.Types.DescribeEventTopicsResult) => void): Request<DirectoryService.Types.DescribeEventTopicsResult, AWSError>;
/**
* Obtains information about which SNS topics receive status messages from the specified directory. If no input parameters are provided, such as DirectoryId or TopicName, this request describes all of the associations in the account.
*/
describeEventTopics(callback?: (err: AWSError, data: DirectoryService.Types.DescribeEventTopicsResult) => void): Request<DirectoryService.Types.DescribeEventTopicsResult, AWSError>;
/**
* Describes the status of LDAP security for the specified directory.
*/
describeLDAPSSettings(params: DirectoryService.Types.DescribeLDAPSSettingsRequest, callback?: (err: AWSError, data: DirectoryService.Types.DescribeLDAPSSettingsResult) => void): Request<DirectoryService.Types.DescribeLDAPSSettingsResult, AWSError>;
/**
* Describes the status of LDAP security for the specified directory.
*/
describeLDAPSSettings(callback?: (err: AWSError, data: DirectoryService.Types.DescribeLDAPSSettingsResult) => void): Request<DirectoryService.Types.DescribeLDAPSSettingsResult, AWSError>;
/**
* Returns the shared directories in your account.
*/
describeSharedDirectories(params: DirectoryService.Types.DescribeSharedDirectoriesRequest, callback?: (err: AWSError, data: DirectoryService.Types.DescribeSharedDirectoriesResult) => void): Request<DirectoryService.Types.DescribeSharedDirectoriesResult, AWSError>;
/**
* Returns the shared directories in your account.
*/
describeSharedDirectories(callback?: (err: AWSError, data: DirectoryService.Types.DescribeSharedDirectoriesResult) => void): Request<DirectoryService.Types.DescribeSharedDirectoriesResult, AWSError>;
/**
* Obtains information about the directory snapshots that belong to this account. This operation supports pagination with the use of the NextToken request and response parameters. If more results are available, the DescribeSnapshots.NextToken member contains a token that you pass in the next call to DescribeSnapshots to retrieve the next set of items. You can also specify a maximum number of return results with the Limit parameter.
*/
describeSnapshots(params: DirectoryService.Types.DescribeSnapshotsRequest, callback?: (err: AWSError, data: DirectoryService.Types.DescribeSnapshotsResult) => void): Request<DirectoryService.Types.DescribeSnapshotsResult, AWSError>;
/**
* Obtains information about the directory snapshots that belong to this account. This operation supports pagination with the use of the NextToken request and response parameters. If more results are available, the DescribeSnapshots.NextToken member contains a token that you pass in the next call to DescribeSnapshots to retrieve the next set of items. You can also specify a maximum number of return results with the Limit parameter.
*/
describeSnapshots(callback?: (err: AWSError, data: DirectoryService.Types.DescribeSnapshotsResult) => void): Request<DirectoryService.Types.DescribeSnapshotsResult, AWSError>;
/**
* Obtains information about the trust relationships for this account. If no input parameters are provided, such as DirectoryId or TrustIds, this request describes all the trust relationships belonging to the account.
*/
describeTrusts(params: DirectoryService.Types.DescribeTrustsRequest, callback?: (err: AWSError, data: DirectoryService.Types.DescribeTrustsResult) => void): Request<DirectoryService.Types.DescribeTrustsResult, AWSError>;
/**
* Obtains information about the trust relationships for this account. If no input parameters are provided, such as DirectoryId or TrustIds, this request describes all the trust relationships belonging to the account.
*/
describeTrusts(callback?: (err: AWSError, data: DirectoryService.Types.DescribeTrustsResult) => void): Request<DirectoryService.Types.DescribeTrustsResult, AWSError>;
/**
* Deactivates LDAP secure calls for the specified directory.
*/
disableLDAPS(params: DirectoryService.Types.DisableLDAPSRequest, callback?: (err: AWSError, data: DirectoryService.Types.DisableLDAPSResult) => void): Request<DirectoryService.Types.DisableLDAPSResult, AWSError>;
/**
* Deactivates LDAP secure calls for the specified directory.
*/
disableLDAPS(callback?: (err: AWSError, data: DirectoryService.Types.DisableLDAPSResult) => void): Request<DirectoryService.Types.DisableLDAPSResult, AWSError>;
/**
* Disables multi-factor authentication (MFA) with the Remote Authentication Dial In User Service (RADIUS) server for an AD Connector or Microsoft AD directory.
*/
disableRadius(params: DirectoryService.Types.DisableRadiusRequest, callback?: (err: AWSError, data: DirectoryService.Types.DisableRadiusResult) => void): Request<DirectoryService.Types.DisableRadiusResult, AWSError>;
/**
* Disables multi-factor authentication (MFA) with the Remote Authentication Dial In User Service (RADIUS) server for an AD Connector or Microsoft AD directory.
*/
disableRadius(callback?: (err: AWSError, data: DirectoryService.Types.DisableRadiusResult) => void): Request<DirectoryService.Types.DisableRadiusResult, AWSError>;
/**
* Disables single-sign on for a directory.
*/
disableSso(params: DirectoryService.Types.DisableSsoRequest, callback?: (err: AWSError, data: DirectoryService.Types.DisableSsoResult) => void): Request<DirectoryService.Types.DisableSsoResult, AWSError>;
/**
* Disables single-sign on for a directory.
*/
disableSso(callback?: (err: AWSError, data: DirectoryService.Types.DisableSsoResult) => void): Request<DirectoryService.Types.DisableSsoResult, AWSError>;
/**
* Activates the switch for the specific directory to always use LDAP secure calls.
*/
enableLDAPS(params: DirectoryService.Types.EnableLDAPSRequest, callback?: (err: AWSError, data: DirectoryService.Types.EnableLDAPSResult) => void): Request<DirectoryService.Types.EnableLDAPSResult, AWSError>;
/**
* Activates the switch for the specific directory to always use LDAP secure calls.
*/
enableLDAPS(callback?: (err: AWSError, data: DirectoryService.Types.EnableLDAPSResult) => void): Request<DirectoryService.Types.EnableLDAPSResult, AWSError>;
/**
* Enables multi-factor authentication (MFA) with the Remote Authentication Dial In User Service (RADIUS) server for an AD Connector or Microsoft AD directory.
*/
enableRadius(params: DirectoryService.Types.EnableRadiusRequest, callback?: (err: AWSError, data: DirectoryService.Types.EnableRadiusResult) => void): Request<DirectoryService.Types.EnableRadiusResult, AWSError>;
/**
* Enables multi-factor authentication (MFA) with the Remote Authentication Dial In User Service (RADIUS) server for an AD Connector or Microsoft AD directory.
*/
enableRadius(callback?: (err: AWSError, data: DirectoryService.Types.EnableRadiusResult) => void): Request<DirectoryService.Types.EnableRadiusResult, AWSError>;
/**
* Enables single sign-on for a directory. Single sign-on allows users in your directory to access certain AWS services from a computer joined to the directory without having to enter their credentials separately.
*/
enableSso(params: DirectoryService.Types.EnableSsoRequest, callback?: (err: AWSError, data: DirectoryService.Types.EnableSsoResult) => void): Request<DirectoryService.Types.EnableSsoResult, AWSError>;
/**
* Enables single sign-on for a directory. Single sign-on allows users in your directory to access certain AWS services from a computer joined to the directory without having to enter their credentials separately.
*/
enableSso(callback?: (err: AWSError, data: DirectoryService.Types.EnableSsoResult) => void): Request<DirectoryService.Types.EnableSsoResult, AWSError>;
/**
* Obtains directory limit information for the current Region.
*/
getDirectoryLimits(params: DirectoryService.Types.GetDirectoryLimitsRequest, callback?: (err: AWSError, data: DirectoryService.Types.GetDirectoryLimitsResult) => void): Request<DirectoryService.Types.GetDirectoryLimitsResult, AWSError>;
/**
* Obtains directory limit information for the current Region.
*/
getDirectoryLimits(callback?: (err: AWSError, data: DirectoryService.Types.GetDirectoryLimitsResult) => void): Request<DirectoryService.Types.GetDirectoryLimitsResult, AWSError>;
/**
* Obtains the manual snapshot limits for a directory.
*/
getSnapshotLimits(params: DirectoryService.Types.GetSnapshotLimitsRequest, callback?: (err: AWSError, data: DirectoryService.Types.GetSnapshotLimitsResult) => void): Request<DirectoryService.Types.GetSnapshotLimitsResult, AWSError>;
/**
* Obtains the manual snapshot limits for a directory.
*/
getSnapshotLimits(callback?: (err: AWSError, data: DirectoryService.Types.GetSnapshotLimitsResult) => void): Request<DirectoryService.Types.GetSnapshotLimitsResult, AWSError>;
/**
* For the specified directory, lists all the certificates registered for a secured LDAP connection.
*/
listCertificates(params: DirectoryService.Types.ListCertificatesRequest, callback?: (err: AWSError, data: DirectoryService.Types.ListCertificatesResult) => void): Request<DirectoryService.Types.ListCertificatesResult, AWSError>;
/**
* For the specified directory, lists all the certificates registered for a secured LDAP connection.
*/
listCertificates(callback?: (err: AWSError, data: DirectoryService.Types.ListCertificatesResult) => void): Request<DirectoryService.Types.ListCertificatesResult, AWSError>;
/**
* Lists the address blocks that you have added to a directory.
*/
listIpRoutes(params: DirectoryService.Types.ListIpRoutesRequest, callback?: (err: AWSError, data: DirectoryService.Types.ListIpRoutesResult) => void): Request<DirectoryService.Types.ListIpRoutesResult, AWSError>;
/**
* Lists the address blocks that you have added to a directory.
*/
listIpRoutes(callback?: (err: AWSError, data: DirectoryService.Types.ListIpRoutesResult) => void): Request<DirectoryService.Types.ListIpRoutesResult, AWSError>;
/**
* Lists the active log subscriptions for the AWS account.
*/
listLogSubscriptions(params: DirectoryService.Types.ListLogSubscriptionsRequest, callback?: (err: AWSError, data: DirectoryService.Types.ListLogSubscriptionsResult) => void): Request<DirectoryService.Types.ListLogSubscriptionsResult, AWSError>;
/**
* Lists the active log subscriptions for the AWS account.
*/
listLogSubscriptions(callback?: (err: AWSError, data: DirectoryService.Types.ListLogSubscriptionsResult) => void): Request<DirectoryService.Types.ListLogSubscriptionsResult, AWSError>;
/**
* Lists all schema extensions applied to a Microsoft AD Directory.
*/
listSchemaExtensions(params: DirectoryService.Types.ListSchemaExtensionsRequest, callback?: (err: AWSError, data: DirectoryService.Types.ListSchemaExtensionsResult) => void): Request<DirectoryService.Types.ListSchemaExtensionsResult, AWSError>;
/**
* Lists all schema extensions applied to a Microsoft AD Directory.
*/
listSchemaExtensions(callback?: (err: AWSError, data: DirectoryService.Types.ListSchemaExtensionsResult) => void): Request<DirectoryService.Types.ListSchemaExtensionsResult, AWSError>;
/**
* Lists all tags on a directory.
*/
listTagsForResource(params: DirectoryService.Types.ListTagsForResourceRequest, callback?: (err: AWSError, data: DirectoryService.Types.ListTagsForResourceResult) => void): Request<DirectoryService.Types.ListTagsForResourceResult, AWSError>;
/**
* Lists all tags on a directory.
*/
listTagsForResource(callback?: (err: AWSError, data: DirectoryService.Types.ListTagsForResourceResult) => void): Request<DirectoryService.Types.ListTagsForResourceResult, AWSError>;
/**
* Registers a certificate for secured LDAP connection.
*/
registerCertificate(params: DirectoryService.Types.RegisterCertificateRequest, callback?: (err: AWSError, data: DirectoryService.Types.RegisterCertificateResult) => void): Request<DirectoryService.Types.RegisterCertificateResult, AWSError>;
/**
* Registers a certificate for secured LDAP connection.
*/
registerCertificate(callback?: (err: AWSError, data: DirectoryService.Types.RegisterCertificateResult) => void): Request<DirectoryService.Types.RegisterCertificateResult, AWSError>;
/**
* Associates a directory with an SNS topic. This establishes the directory as a publisher to the specified SNS topic. You can then receive email or text (SMS) messages when the status of your directory changes. You get notified if your directory goes from an Active status to an Impaired or Inoperable status. You also receive a notification when the directory returns to an Active status.
*/
registerEventTopic(params: DirectoryService.Types.RegisterEventTopicRequest, callback?: (err: AWSError, data: DirectoryService.Types.RegisterEventTopicResult) => void): Request<DirectoryService.Types.RegisterEventTopicResult, AWSError>;
/**
* Associates a directory with an SNS topic. This establishes the directory as a publisher to the specified SNS topic. You can then receive email or text (SMS) messages when the status of your directory changes. You get notified if your directory goes from an Active status to an Impaired or Inoperable status. You also receive a notification when the directory returns to an Active status.
*/
registerEventTopic(callback?: (err: AWSError, data: DirectoryService.Types.RegisterEventTopicResult) => void): Request<DirectoryService.Types.RegisterEventTopicResult, AWSError>;
/**
* Rejects a directory sharing request that was sent from the directory owner account.
*/
rejectSharedDirectory(params: DirectoryService.Types.RejectSharedDirectoryRequest, callback?: (err: AWSError, data: DirectoryService.Types.RejectSharedDirectoryResult) => void): Request<DirectoryService.Types.RejectSharedDirectoryResult, AWSError>;
/**
* Rejects a directory sharing request that was sent from the directory owner account.
*/
rejectSharedDirectory(callback?: (err: AWSError, data: DirectoryService.Types.RejectSharedDirectoryResult) => void): Request<DirectoryService.Types.RejectSharedDirectoryResult, AWSError>;
/**
* Removes IP address blocks from a directory.
*/
removeIpRoutes(params: DirectoryService.Types.RemoveIpRoutesRequest, callback?: (err: AWSError, data: DirectoryService.Types.RemoveIpRoutesResult) => void): Request<DirectoryService.Types.RemoveIpRoutesResult, AWSError>;
/**
* Removes IP address blocks from a directory.
*/
removeIpRoutes(callback?: (err: AWSError, data: DirectoryService.Types.RemoveIpRoutesResult) => void): Request<DirectoryService.Types.RemoveIpRoutesResult, AWSError>;
/**
* Removes tags from a directory.
*/
removeTagsFromResource(params: DirectoryService.Types.RemoveTagsFromResourceRequest, callback?: (err: AWSError, data: DirectoryService.Types.RemoveTagsFromResourceResult) => void): Request<DirectoryService.Types.RemoveTagsFromResourceResult, AWSError>;
/**
* Removes tags from a directory.
*/
removeTagsFromResource(callback?: (err: AWSError, data: DirectoryService.Types.RemoveTagsFromResourceResult) => void): Request<DirectoryService.Types.RemoveTagsFromResourceResult, AWSError>;
/**
* Resets the password for any user in your AWS Managed Microsoft AD or Simple AD directory. You can reset the password for any user in your directory with the following exceptions: For Simple AD, you cannot reset the password for any user that is a member of either the Domain Admins or Enterprise Admins group except for the administrator user. For AWS Managed Microsoft AD, you can only reset the password for a user that is in an OU based off of the NetBIOS name that you typed when you created your directory. For example, you cannot reset the password for a user in the AWS Reserved OU. For more information about the OU structure for an AWS Managed Microsoft AD directory, see What Gets Created in the AWS Directory Service Administration Guide.
*/
resetUserPassword(params: DirectoryService.Types.ResetUserPasswordRequest, callback?: (err: AWSError, data: DirectoryService.Types.ResetUserPasswordResult) => void): Request<DirectoryService.Types.ResetUserPasswordResult, AWSError>;
/**
* Resets the password for any user in your AWS Managed Microsoft AD or Simple AD directory. You can reset the password for any user in your directory with the following exceptions: For Simple AD, you cannot reset the password for any user that is a member of either the Domain Admins or Enterprise Admins group except for the administrator user. For AWS Managed Microsoft AD, you can only reset the password for a user that is in an OU based off of the NetBIOS name that you typed when you created your directory. For example, you cannot reset the password for a user in the AWS Reserved OU. For more information about the OU structure for an AWS Managed Microsoft AD directory, see What Gets Created in the AWS Directory Service Administration Guide.
*/
resetUserPassword(callback?: (err: AWSError, data: DirectoryService.Types.ResetUserPasswordResult) => void): Request<DirectoryService.Types.ResetUserPasswordResult, AWSError>;
/**
* Restores a directory using an existing directory snapshot. When you restore a directory from a snapshot, any changes made to the directory after the snapshot date are overwritten. This action returns as soon as the restore operation is initiated. You can monitor the progress of the restore operation by calling the DescribeDirectories operation with the directory identifier. When the DirectoryDescription.Stage value changes to Active, the restore operation is complete.
*/
restoreFromSnapshot(params: DirectoryService.Types.RestoreFromSnapshotRequest, callback?: (err: AWSError, data: DirectoryService.Types.RestoreFromSnapshotResult) => void): Request<DirectoryService.Types.RestoreFromSnapshotResult, AWSError>;
/**
* Restores a directory using an existing directory snapshot. When you restore a directory from a snapshot, any changes made to the directory after the snapshot date are overwritten. This action returns as soon as the restore operation is initiated. You can monitor the progress of the restore operation by calling the DescribeDirectories operation with the directory identifier. When the DirectoryDescription.Stage value changes to Active, the restore operation is complete.
*/
restoreFromSnapshot(callback?: (err: AWSError, data: DirectoryService.Types.RestoreFromSnapshotResult) => void): Request<DirectoryService.Types.RestoreFromSnapshotResult, AWSError>;
/**
* Shares a specified directory (DirectoryId) in your AWS account (directory owner) with another AWS account (directory consumer). With this operation you can use your directory from any AWS account and from any Amazon VPC within an AWS Region. When you share your AWS Managed Microsoft AD directory, AWS Directory Service creates a shared directory in the directory consumer account. This shared directory contains the metadata to provide access to the directory within the directory owner account. The shared directory is visible in all VPCs in the directory consumer account. The ShareMethod parameter determines whether the specified directory can be shared between AWS accounts inside the same AWS organization (ORGANIZATIONS). It also determines whether you can share the directory with any other AWS account either inside or outside of the organization (HANDSHAKE). The ShareNotes parameter is only used when HANDSHAKE is called, which sends a directory sharing request to the directory consumer.
*/
shareDirectory(params: DirectoryService.Types.ShareDirectoryRequest, callback?: (err: AWSError, data: DirectoryService.Types.ShareDirectoryResult) => void): Request<DirectoryService.Types.ShareDirectoryResult, AWSError>;
/**
* Shares a specified directory (DirectoryId) in your AWS account (directory owner) with another AWS account (directory consumer). With this operation you can use your directory from any AWS account and from any Amazon VPC within an AWS Region. When you share your AWS Managed Microsoft AD directory, AWS Directory Service creates a shared directory in the directory consumer account. This shared directory contains the metadata to provide access to the directory within the directory owner account. The shared directory is visible in all VPCs in the directory consumer account. The ShareMethod parameter determines whether the specified directory can be shared between AWS accounts inside the same AWS organization (ORGANIZATIONS). It also determines whether you can share the directory with any other AWS account either inside or outside of the organization (HANDSHAKE). The ShareNotes parameter is only used when HANDSHAKE is called, which sends a directory sharing request to the directory consumer.
*/
shareDirectory(callback?: (err: AWSError, data: DirectoryService.Types.ShareDirectoryResult) => void): Request<DirectoryService.Types.ShareDirectoryResult, AWSError>;
/**
* Applies a schema extension to a Microsoft AD directory.
*/
startSchemaExtension(params: DirectoryService.Types.StartSchemaExtensionRequest, callback?: (err: AWSError, data: DirectoryService.Types.StartSchemaExtensionResult) => void): Request<DirectoryService.Types.StartSchemaExtensionResult, AWSError>;
/**
* Applies a schema extension to a Microsoft AD directory.
*/
startSchemaExtension(callback?: (err: AWSError, data: DirectoryService.Types.StartSchemaExtensionResult) => void): Request<DirectoryService.Types.StartSchemaExtensionResult, AWSError>;
/**
* Stops the directory sharing between the directory owner and consumer accounts.
*/
unshareDirectory(params: DirectoryService.Types.UnshareDirectoryRequest, callback?: (err: AWSError, data: DirectoryService.Types.UnshareDirectoryResult) => void): Request<DirectoryService.Types.UnshareDirectoryResult, AWSError>;
/**
* Stops the directory sharing between the directory owner and consumer accounts.
*/
unshareDirectory(callback?: (err: AWSError, data: DirectoryService.Types.UnshareDirectoryResult) => void): Request<DirectoryService.Types.UnshareDirectoryResult, AWSError>;
/**
* Updates a conditional forwarder that has been set up for your AWS directory.
*/
updateConditionalForwarder(params: DirectoryService.Types.UpdateConditionalForwarderRequest, callback?: (err: AWSError, data: DirectoryService.Types.UpdateConditionalForwarderResult) => void): Request<DirectoryService.Types.UpdateConditionalForwarderResult, AWSError>;
/**
* Updates a conditional forwarder that has been set up for your AWS directory.
*/
updateConditionalForwarder(callback?: (err: AWSError, data: DirectoryService.Types.UpdateConditionalForwarderResult) => void): Request<DirectoryService.Types.UpdateConditionalForwarderResult, AWSError>;
/**
* Adds or removes domain controllers to or from the directory. Based on the difference between current value and new value (provided through this API call), domain controllers will be added or removed. It may take up to 45 minutes for any new domain controllers to become fully active once the requested number of domain controllers is updated. During this time, you cannot make another update request.
*/
updateNumberOfDomainControllers(params: DirectoryService.Types.UpdateNumberOfDomainControllersRequest, callback?: (err: AWSError, data: DirectoryService.Types.UpdateNumberOfDomainControllersResult) => void): Request<DirectoryService.Types.UpdateNumberOfDomainControllersResult, AWSError>;
/**
* Adds or removes domain controllers to or from the directory. Based on the difference between current value and new value (provided through this API call), domain controllers will be added or removed. It may take up to 45 minutes for any new domain controllers to become fully active once the requested number of domain controllers is updated. During this time, you cannot make another update request.
*/
updateNumberOfDomainControllers(callback?: (err: AWSError, data: DirectoryService.Types.UpdateNumberOfDomainControllersResult) => void): Request<DirectoryService.Types.UpdateNumberOfDomainControllersResult, AWSError>;
/**
* Updates the Remote Authentication Dial In User Service (RADIUS) server information for an AD Connector or Microsoft AD directory.
*/
updateRadius(params: DirectoryService.Types.UpdateRadiusRequest, callback?: (err: AWSError, data: DirectoryService.Types.UpdateRadiusResult) => void): Request<DirectoryService.Types.UpdateRadiusResult, AWSError>;
/**
* Updates the Remote Authentication Dial In User Service (RADIUS) server information for an AD Connector or Microsoft AD directory.
*/
updateRadius(callback?: (err: AWSError, data: DirectoryService.Types.UpdateRadiusResult) => void): Request<DirectoryService.Types.UpdateRadiusResult, AWSError>;
/**
* Updates the trust that has been set up between your AWS Managed Microsoft AD directory and an on-premises Active Directory.
*/
updateTrust(params: DirectoryService.Types.UpdateTrustRequest, callback?: (err: AWSError, data: DirectoryService.Types.UpdateTrustResult) => void): Request<DirectoryService.Types.UpdateTrustResult, AWSError>;
/**
* Updates the trust that has been set up between your AWS Managed Microsoft AD directory and an on-premises Active Directory.
*/
updateTrust(callback?: (err: AWSError, data: DirectoryService.Types.UpdateTrustResult) => void): Request<DirectoryService.Types.UpdateTrustResult, AWSError>;
/**
* AWS Directory Service for Microsoft Active Directory allows you to configure and verify trust relationships. This action verifies a trust relationship between your AWS Managed Microsoft AD directory and an external domain.
*/
verifyTrust(params: DirectoryService.Types.VerifyTrustRequest, callback?: (err: AWSError, data: DirectoryService.Types.VerifyTrustResult) => void): Request<DirectoryService.Types.VerifyTrustResult, AWSError>;
/**
* AWS Directory Service for Microsoft Active Directory allows you to configure and verify trust relationships. This action verifies a trust relationship between your AWS Managed Microsoft AD directory and an external domain.
*/
verifyTrust(callback?: (err: AWSError, data: DirectoryService.Types.VerifyTrustResult) => void): Request<DirectoryService.Types.VerifyTrustResult, AWSError>;
}
declare namespace DirectoryService {
export interface AcceptSharedDirectoryRequest {
/**
* Identifier of the shared directory in the directory consumer account. This identifier is different for each directory owner account.
*/
SharedDirectoryId: DirectoryId;
}
export interface AcceptSharedDirectoryResult {
/**
* The shared directory in the directory consumer account.
*/
SharedDirectory?: SharedDirectory;
}
export type AccessUrl = string;
export interface AddIpRoutesRequest {
/**
* Identifier (ID) of the directory to which to add the address block.
*/
DirectoryId: DirectoryId;
/**
* IP address blocks, using CIDR format, of the traffic to route. This is often the IP address block of the DNS server used for your on-premises domain.
*/
IpRoutes: IpRoutes;
/**
* If set to true, updates the inbound and outbound rules of the security group that has the description: "AWS created security group for directory ID directory controllers." Following are the new rules: Inbound: Type: Custom UDP Rule, Protocol: UDP, Range: 88, Source: 0.0.0.0/0 Type: Custom UDP Rule, Protocol: UDP, Range: 123, Source: 0.0.0.0/0 Type: Custom UDP Rule, Protocol: UDP, Range: 138, Source: 0.0.0.0/0 Type: Custom UDP Rule, Protocol: UDP, Range: 389, Source: 0.0.0.0/0 Type: Custom UDP Rule, Protocol: UDP, Range: 464, Source: 0.0.0.0/0 Type: Custom UDP Rule, Protocol: UDP, Range: 445, Source: 0.0.0.0/0 Type: Custom TCP Rule, Protocol: TCP, Range: 88, Source: 0.0.0.0/0 Type: Custom TCP Rule, Protocol: TCP, Range: 135, Source: 0.0.0.0/0 Type: Custom TCP Rule, Protocol: TCP, Range: 445, Source: 0.0.0.0/0 Type: Custom TCP Rule, Protocol: TCP, Range: 464, Source: 0.0.0.0/0 Type: Custom TCP Rule, Protocol: TCP, Range: 636, Source: 0.0.0.0/0 Type: Custom TCP Rule, Protocol: TCP, Range: 1024-65535, Source: 0.0.0.0/0 Type: Custom TCP Rule, Protocol: TCP, Range: 3268-33269, Source: 0.0.0.0/0 Type: DNS (UDP), Protocol: UDP, Range: 53, Source: 0.0.0.0/0 Type: DNS (TCP), Protocol: TCP, Range: 53, Source: 0.0.0.0/0 Type: LDAP, Protocol: TCP, Range: 389, Source: 0.0.0.0/0 Type: All ICMP, Protocol: All, Range: N/A, Source: 0.0.0.0/0 Outbound: Type: All traffic, Protocol: All, Range: All, Destination: 0.0.0.0/0 These security rules impact an internal network interface that is not exposed publicly.
*/
UpdateSecurityGroupForDirectoryControllers?: UpdateSecurityGroupForDirectoryControllers;
}
export interface AddIpRoutesResult {
}
export interface AddTagsToResourceRequest {
/**
* Identifier (ID) for the directory to which to add the tag.
*/
ResourceId: ResourceId;
/**
* The tags to be assigned to the directory.
*/
Tags: Tags;
}
export interface AddTagsToResourceResult {
}
export type AddedDateTime = Date;
export type AliasName = string;
export interface Attribute {
/**
* The name of the attribute.
*/
Name?: AttributeName;
/**
* The value of the attribute.
*/
Value?: AttributeValue;
}
export type AttributeName = string;
export type AttributeValue = string;
export type Attributes = Attribute[];
export type AvailabilityZone = string;
export type AvailabilityZones = AvailabilityZone[];
export interface CancelSchemaExtensionRequest {
/**
* The identifier of the directory whose schema extension will be canceled.
*/
DirectoryId: DirectoryId;
/**
* The identifier of the schema extension that will be canceled.
*/
SchemaExtensionId: SchemaExtensionId;
}
export interface CancelSchemaExtensionResult {
}
export interface Certificate {
/**
* The identifier of the certificate.
*/
CertificateId?: CertificateId;
/**
* The state of the certificate.
*/
State?: CertificateState;
/**
* Describes a state change for the certificate.
*/
StateReason?: CertificateStateReason;
/**
* The common name for the certificate.
*/
CommonName?: CertificateCN;
/**
* The date and time that the certificate was registered.
*/
RegisteredDateTime?: CertificateRegisteredDateTime;
/**
* The date and time when the certificate will expire.
*/
ExpiryDateTime?: CertificateExpiryDateTime;
}
export type CertificateCN = string;
export type CertificateData = string;
export type CertificateExpiryDateTime = Date;
export type CertificateId = string;
export interface CertificateInfo {
/**
* The identifier of the certificate.
*/
CertificateId?: CertificateId;
/**
* The common name for the certificate.
*/
CommonName?: CertificateCN;
/**
* The state of the certificate.
*/
State?: CertificateState;
}
export type CertificateRegisteredDateTime = Date;
export type CertificateState = "Registering"|"Registered"|"RegisterFailed"|"Deregistering"|"Deregistered"|"DeregisterFailed"|string;
export type CertificateStateReason = string;
export type CertificatesInfo = CertificateInfo[];
export type CidrIp = string;
export type CidrIps = CidrIp[];
export type CloudOnlyDirectoriesLimitReached = boolean;
export interface Computer {
/**
* The identifier of the computer.
*/
ComputerId?: SID;
/**
* The computer name.
*/
ComputerName?: ComputerName;
/**
* An array of Attribute objects containing the LDAP attributes that belong to the computer account.
*/
ComputerAttributes?: Attributes;
}
export type ComputerName = string;
export type ComputerPassword = string;
export interface ConditionalForwarder {
/**
* The fully qualified domain name (FQDN) of the remote domains pointed to by the conditional forwarder.
*/
RemoteDomainName?: RemoteDomainName;
/**
* The IP addresses of the remote DNS server associated with RemoteDomainName. This is the IP address of the DNS server that your conditional forwarder points to.
*/
DnsIpAddrs?: DnsIpAddrs;
/**
* The replication scope of the conditional forwarder. The only allowed value is Domain, which will replicate the conditional forwarder to all of the domain controllers for your AWS directory.
*/
ReplicationScope?: ReplicationScope;
}
export type ConditionalForwarders = ConditionalForwarder[];
export interface ConnectDirectoryRequest {
/**
* The fully qualified name of the on-premises directory, such as corp.example.com.
*/
Name: DirectoryName;
/**
* The NetBIOS name of the on-premises directory, such as CORP.
*/
ShortName?: DirectoryShortName;
/**
* The password for the on-premises user account.
*/
Password: ConnectPassword;
/**
* A description for the directory.
*/
Description?: Description;
/**
* The size of the directory.
*/
Size: DirectorySize;
/**
* A DirectoryConnectSettings object that contains additional information for the operation.
*/
ConnectSettings: DirectoryConnectSettings;
/**
* The tags to be assigned to AD Connector.
*/
Tags?: Tags;
}
export interface ConnectDirectoryResult {
/**
* The identifier of the new directory.
*/
DirectoryId?: DirectoryId;
}
export type ConnectPassword = string;
export type ConnectedDirectoriesLimitReached = boolean;
export interface CreateAliasRequest {
/**
* The identifier of the directory for which to create the alias.
*/
DirectoryId: DirectoryId;
/**
* The requested alias. The alias must be unique amongst all aliases in AWS. This operation throws an EntityAlreadyExistsException error if the alias already exists.
*/
Alias: AliasName;
}
export interface CreateAliasResult {
/**
* The identifier of the directory.
*/
DirectoryId?: DirectoryId;
/**
* The alias for the directory.
*/
Alias?: AliasName;
}
export interface CreateComputerRequest {
/**
* The identifier of the directory in which to create the computer account.
*/
DirectoryId: DirectoryId;
/**
* The name of the computer account.
*/
ComputerName: ComputerName;
/**
* A one-time password that is used to join the computer to the directory. You should generate a random, strong password to use for this parameter.
*/
Password: ComputerPassword;
/**
* The fully-qualified distinguished name of the organizational unit to place the computer account in.
*/
OrganizationalUnitDistinguishedName?: OrganizationalUnitDN;
/**
* An array of Attribute objects that contain any LDAP attributes to apply to the computer account.
*/
ComputerAttributes?: Attributes;
}
export interface CreateComputerResult {
/**
* A Computer object that represents the computer account.
*/
Computer?: Computer;
}
export interface CreateConditionalForwarderRequest {
/**
* The directory ID of the AWS directory for which you are creating the conditional forwarder.
*/
DirectoryId: DirectoryId;
/**
* The fully qualified domain name (FQDN) of the remote domain with which you will set up a trust relationship.
*/
RemoteDomainName: RemoteDomainName;
/**
* The IP addresses of the remote DNS server associated with RemoteDomainName.
*/
DnsIpAddrs: DnsIpAddrs;
}
export interface CreateConditionalForwarderResult {
}
export interface CreateDirectoryRequest {
/**
* The fully qualified name for the directory, such as corp.example.com.
*/
Name: DirectoryName;
/**
* The NetBIOS name of the directory, such as CORP.
*/
ShortName?: DirectoryShortName;
/**
* The password for the directory administrator. The directory creation process creates a directory administrator account with the user name Administrator and this password. If you need to change the password for the administrator account, you can use the ResetUserPassword API call.
*/
Password: Password;
/**
* A description for the directory.
*/
Description?: Description;
/**
* The size of the directory.
*/
Size: DirectorySize;
/**
* A DirectoryVpcSettings object that contains additional information for the operation.
*/
VpcSettings?: DirectoryVpcSettings;
/**
* The tags to be assigned to the Simple AD directory.
*/
Tags?: Tags;
}
export interface CreateDirectoryResult {
/**
* The identifier of the directory that was created.
*/
DirectoryId?: DirectoryId;
}
export interface CreateLogSubscriptionRequest {
/**
* Identifier of the directory to which you want to subscribe and receive real-time logs to your specified CloudWatch log group.
*/
DirectoryId: DirectoryId;
/**
* The name of the CloudWatch log group where the real-time domain controller logs are forwarded.
*/
LogGroupName: LogGroupName;
}
export interface CreateLogSubscriptionResult {
}
export interface CreateMicrosoftADRequest {
/**
* The fully qualified domain name for the AWS Managed Microsoft AD directory, such as corp.example.com. This name will resolve inside your VPC only. It does not need to be publicly resolvable.
*/
Name: DirectoryName;
/**
* The NetBIOS name for your domain, such as CORP. If you don't specify a NetBIOS name, it will default to the first part of your directory DNS. For example, CORP for the directory DNS corp.example.com.
*/
ShortName?: DirectoryShortName;
/**
* The password for the default administrative user named Admin. If you need to change the password for the administrator account, you can use the ResetUserPassword API call.
*/
Password: Password;
/**
* A description for the directory. This label will appear on the AWS console Directory Details page after the directory is created.
*/
Description?: Description;
/**
* Contains VPC information for the CreateDirectory or CreateMicrosoftAD operation.
*/
VpcSettings: DirectoryVpcSettings;
/**
* AWS Managed Microsoft AD is available in two editions: Standard and Enterprise. Enterprise is the default.
*/
Edition?: DirectoryEdition;
/**
* The tags to be assigned to the AWS Managed Microsoft AD directory.
*/
Tags?: Tags;
}
export interface CreateMicrosoftADResult {
/**
* The identifier of the directory that was created.
*/
DirectoryId?: DirectoryId;
}
export type CreateSnapshotBeforeSchemaExtension = boolean;
export interface CreateSnapshotRequest {
/**
* The identifier of the directory of which to take a snapshot.
*/
DirectoryId: DirectoryId;
/**
* The descriptive name to apply to the snapshot.
*/
Name?: SnapshotName;
}
export interface CreateSnapshotResult {
/**
* The identifier of the snapshot that was created.
*/
SnapshotId?: SnapshotId;
}
export interface CreateTrustRequest {
/**
* The Directory ID of the AWS Managed Microsoft AD directory for which to establish the trust relationship.
*/
DirectoryId: DirectoryId;
/**
* The Fully Qualified Domain Name (FQDN) of the external domain for which to create the trust relationship.
*/
RemoteDomainName: RemoteDomainName;
/**
* The trust password. The must be the same password that was used when creating the trust relationship on the external domain.
*/
TrustPassword: TrustPassword;
/**
* The direction of the trust relationship.
*/
TrustDirection: TrustDirection;
/**
* The trust relationship type. Forest is the default.
*/
TrustType?: TrustType;
/**
* The IP addresses of the remote DNS server associated with RemoteDomainName.
*/
ConditionalForwarderIpAddrs?: DnsIpAddrs;
/**
* Optional parameter to enable selective authentication for the trust.
*/
SelectiveAuth?: SelectiveAuth;
}
export interface CreateTrustResult {
/**
* A unique identifier for the trust relationship that was created.
*/
TrustId?: TrustId;
}
export type CreatedDateTime = Date;
export type CustomerId = string;
export type CustomerUserName = string;
export type DeleteAssociatedConditionalForwarder = boolean;
export interface DeleteConditionalForwarderRequest {
/**
* The directory ID for which you are deleting the conditional forwarder.
*/
DirectoryId: DirectoryId;
/**
* The fully qualified domain name (FQDN) of the remote domain with which you are deleting the conditional forwarder.
*/
RemoteDomainName: RemoteDomainName;
}
export interface DeleteConditionalForwarderResult {
}
export interface DeleteDirectoryRequest {
/**
* The identifier of the directory to delete.
*/
DirectoryId: DirectoryId;
}
export interface DeleteDirectoryResult {
/**
* The directory identifier.
*/
DirectoryId?: DirectoryId;
}
export interface DeleteLogSubscriptionRequest {
/**
* Identifier of the directory whose log subscription you want to delete.
*/
DirectoryId: DirectoryId;
}
export interface DeleteLogSubscriptionResult {
}
export interface DeleteSnapshotRequest {
/**
* The identifier of the directory snapshot to be deleted.
*/
SnapshotId: SnapshotId;
}
export interface DeleteSnapshotResult {
/**
* The identifier of the directory snapshot that was deleted.
*/
SnapshotId?: SnapshotId;
}
export interface DeleteTrustRequest {
/**
* The Trust ID of the trust relationship to be deleted.
*/
TrustId: TrustId;
/**
* Delete a conditional forwarder as part of a DeleteTrustRequest.
*/
DeleteAssociatedConditionalForwarder?: DeleteAssociatedConditionalForwarder;
}
export interface DeleteTrustResult {
/**
* The Trust ID of the trust relationship that was deleted.
*/
TrustId?: TrustId;
}
export interface DeregisterCertificateRequest {
/**
* The identifier of the directory.
*/
DirectoryId: DirectoryId;
/**
* The identifier of the certificate.
*/
CertificateId: CertificateId;
}
export interface DeregisterCertificateResult {
}
export interface DeregisterEventTopicRequest {
/**
* The Directory ID to remove as a publisher. This directory will no longer send messages to the specified SNS topic.
*/
DirectoryId: DirectoryId;
/**
* The name of the SNS topic from which to remove the directory as a publisher.
*/
TopicName: TopicName;
}
export interface DeregisterEventTopicResult {
}
export interface DescribeCertificateRequest {
/**
* The identifier of the directory.
*/
DirectoryId: DirectoryId;
/**
* The identifier of the certificate.
*/
CertificateId: CertificateId;
}
export interface DescribeCertificateResult {
/**
* Information about the certificate, including registered date time, certificate state, the reason for the state, expiration date time, and certificate common name.
*/
Certificate?: Certificate;
}
export interface DescribeConditionalForwardersRequest {
/**
* The directory ID for which to get the list of associated conditional forwarders.
*/
DirectoryId: DirectoryId;
/**
* The fully qualified domain names (FQDN) of the remote domains for which to get the list of associated conditional forwarders. If this member is null, all conditional forwarders are returned.
*/
RemoteDomainNames?: RemoteDomainNames;
}
export interface DescribeConditionalForwardersResult {
/**
* The list of conditional forwarders that have been created.
*/
ConditionalForwarders?: ConditionalForwarders;
}
export interface DescribeDirectoriesRequest {
/**
* A list of identifiers of the directories for which to obtain the information. If this member is null, all directories that belong to the current account are returned. An empty list results in an InvalidParameterException being thrown.
*/
DirectoryIds?: DirectoryIds;
/**
* The DescribeDirectoriesResult.NextToken value from a previous call to DescribeDirectories. Pass null if this is the first call.
*/
NextToken?: NextToken;
/**
* The maximum number of items to return. If this value is zero, the maximum number of items is specified by the limitations of the operation.
*/
Limit?: Limit;
}
export interface DescribeDirectoriesResult {
/**
* The list of DirectoryDescription objects that were retrieved. It is possible that this list contains less than the number of items specified in the Limit member of the request. This occurs if there are less than the requested number of items left to retrieve, or if the limitations of the operation have been exceeded.
*/
DirectoryDescriptions?: DirectoryDescriptions;
/**
* If not null, more results are available. Pass this value for the NextToken parameter in a subsequent call to DescribeDirectories to retrieve the next set of items.
*/
NextToken?: NextToken;
}
export interface DescribeDomainControllersRequest {
/**
* Identifier of the directory for which to retrieve the domain controller information.
*/
DirectoryId: DirectoryId;
/**
* A list of identifiers for the domain controllers whose information will be provided.
*/
DomainControllerIds?: DomainControllerIds;
/**
* The DescribeDomainControllers.NextToken value from a previous call to DescribeDomainControllers. Pass null if this is the first call.
*/
NextToken?: NextToken;
/**
* The maximum number of items to return.
*/
Limit?: Limit;
}
export interface DescribeDomainControllersResult {
/**
* List of the DomainController objects that were retrieved.
*/
DomainControllers?: DomainControllers;
/**
* If not null, more results are available. Pass this value for the NextToken parameter in a subsequent call to DescribeDomainControllers retrieve the next set of items.
*/
NextToken?: NextToken;
}
export interface DescribeEventTopicsRequest {
/**
* The Directory ID for which to get the list of associated SNS topics. If this member is null, associations for all Directory IDs are returned.
*/
DirectoryId?: DirectoryId;
/**
* A list of SNS topic names for which to obtain the information. If this member is null, all associations for the specified Directory ID are returned. An empty list results in an InvalidParameterException being thrown.
*/
TopicNames?: TopicNames;
}
export interface DescribeEventTopicsResult {
/**
* A list of SNS topic names that receive status messages from the specified Directory ID.
*/
EventTopics?: EventTopics;
}
export interface DescribeLDAPSSettingsRequest {
/**
* The identifier of the directory.
*/
DirectoryId: DirectoryId;
/**
* The type of LDAP security the customer wants to enable, either server or client. Currently supports only Client, (the default).
*/
Type?: LDAPSType;
/**
* The type of next token used for pagination.
*/
NextToken?: NextToken;
/**
* Specifies the number of items that should be displayed on one page.
*/
Limit?: PageLimit;
}
export interface DescribeLDAPSSettingsResult {
/**
* Information about LDAP security for the specified directory, including status of enablement, state last updated date time, and the reason for the state.
*/
LDAPSSettingsInfo?: LDAPSSettingsInfo;
/**
* The next token used to retrieve the LDAPS settings if the number of setting types exceeds page limit and there is another page.
*/
NextToken?: NextToken;
}
export interface DescribeSharedDirectoriesRequest {
/**
* Returns the identifier of the directory in the directory owner account.
*/
OwnerDirectoryId: DirectoryId;
/**
* A list of identifiers of all shared directories in your account.
*/
SharedDirectoryIds?: DirectoryIds;
/**
* The DescribeSharedDirectoriesResult.NextToken value from a previous call to DescribeSharedDirectories. Pass null if this is the first call.
*/
NextToken?: NextToken;
/**
* The number of shared directories to return in the response object.
*/
Limit?: Limit;
}
export interface DescribeSharedDirectoriesResult {
/**
* A list of all shared directories in your account.
*/
SharedDirectories?: SharedDirectories;
/**
* If not null, token that indicates that more results are available. Pass this value for the NextToken parameter in a subsequent call to DescribeSharedDirectories to retrieve the next set of items.
*/
NextToken?: NextToken;
}
export interface DescribeSnapshotsRequest {
/**
* The identifier of the directory for which to retrieve snapshot information.
*/
DirectoryId?: DirectoryId;
/**
* A list of identifiers of the snapshots to obtain the information for. If this member is null or empty, all snapshots are returned using the Limit and NextToken members.
*/
SnapshotIds?: SnapshotIds;
/**
* The DescribeSnapshotsResult.NextToken value from a previous call to DescribeSnapshots. Pass null if this is the first call.
*/
NextToken?: NextToken;
/**
* The maximum number of objects to return.
*/
Limit?: Limit;
}
export interface DescribeSnapshotsResult {
/**
* The list of Snapshot objects that were retrieved. It is possible that this list contains less than the number of items specified in the Limit member of the request. This occurs if there are less than the requested number of items left to retrieve, or if the limitations of the operation have been exceeded.
*/
Snapshots?: Snapshots;
/**
* If not null, more results are available. Pass this value in the NextToken member of a subsequent call to DescribeSnapshots.
*/
NextToken?: NextToken;
}
export interface DescribeTrustsRequest {
/**
* The Directory ID of the AWS directory that is a part of the requested trust relationship.
*/
DirectoryId?: DirectoryId;
/**
* A list of identifiers of the trust relationships for which to obtain the information. If this member is null, all trust relationships that belong to the current account are returned. An empty list results in an InvalidParameterException being thrown.
*/
TrustIds?: TrustIds;
/**
* The DescribeTrustsResult.NextToken value from a previous call to DescribeTrusts. Pass null if this is the first call.
*/
NextToken?: NextToken;
/**
* The maximum number of objects to return.
*/
Limit?: Limit;
}
export interface DescribeTrustsResult {
/**
* The list of Trust objects that were retrieved. It is possible that this list contains less than the number of items specified in the Limit member of the request. This occurs if there are less than the requested number of items left to retrieve, or if the limitations of the operation have been exceeded.
*/
Trusts?: Trusts;
/**
* If not null, more results are available. Pass this value for the NextToken parameter in a subsequent call to DescribeTrusts to retrieve the next set of items.
*/
NextToken?: NextToken;
}
export type Description = string;
export type DesiredNumberOfDomainControllers = number;
export interface DirectoryConnectSettings {
/**
* The identifier of the VPC in which the AD Connector is created.
*/
VpcId: VpcId;
/**
* A list of subnet identifiers in the VPC in which the AD Connector is created.
*/
SubnetIds: SubnetIds;
/**
* A list of one or more IP addresses of DNS servers or domain controllers in the on-premises directory.
*/
CustomerDnsIps: DnsIpAddrs;
/**
* The user name of an account in the on-premises directory that is used to connect to the directory. This account must have the following permissions: Read users and groups Create computer objects Join computers to the domain
*/
CustomerUserName: UserName;
}
export interface DirectoryConnectSettingsDescription {
/**
* The identifier of the VPC that the AD Connector is in.
*/
VpcId?: VpcId;
/**
* A list of subnet identifiers in the VPC that the AD Connector is in.
*/
SubnetIds?: SubnetIds;
/**
* The user name of the service account in the on-premises directory.
*/
CustomerUserName?: UserName;
/**
* The security group identifier for the AD Connector directory.
*/
SecurityGroupId?: SecurityGroupId;
/**
* A list of the Availability Zones that the directory is in.
*/
AvailabilityZones?: AvailabilityZones;
/**
* The IP addresses of the AD Connector servers.
*/
ConnectIps?: IpAddrs;
}
export interface DirectoryDescription {
/**
* The directory identifier.
*/
DirectoryId?: DirectoryId;
/**
* The fully qualified name of the directory.
*/
Name?: DirectoryName;
/**
* The short name of the directory.
*/
ShortName?: DirectoryShortName;
/**
* The directory size.
*/
Size?: DirectorySize;
/**
* The edition associated with this directory.
*/
Edition?: DirectoryEdition;
/**
* The alias for the directory. If no alias has been created for the directory, the alias is the directory identifier, such as d-XXXXXXXXXX.
*/
Alias?: AliasName;
/**
* The access URL for the directory, such as http://<alias>.awsapps.com. If no alias has been created for the directory, <alias> is the directory identifier, such as d-XXXXXXXXXX.
*/
AccessUrl?: AccessUrl;
/**
* The description for the directory.
*/
Description?: Description;
/**
* The IP addresses of the DNS servers for the directory. For a Simple AD or Microsoft AD directory, these are the IP addresses of the Simple AD or Microsoft AD directory servers. For an AD Connector directory, these are the IP addresses of the DNS servers or domain controllers in the on-premises directory to which the AD Connector is connected.
*/
DnsIpAddrs?: DnsIpAddrs;
/**
* The current stage of the directory.
*/
Stage?: DirectoryStage;
/**
* Current directory status of the shared AWS Managed Microsoft AD directory.
*/
ShareStatus?: ShareStatus;
/**
* The method used when sharing a directory to determine whether the directory should be shared within your AWS organization (ORGANIZATIONS) or with any AWS account by sending a shared directory request (HANDSHAKE).
*/
ShareMethod?: ShareMethod;
/**
* A directory share request that is sent by the directory owner to the directory consumer. The request includes a typed message to help the directory consumer administrator determine whether to approve or reject the share invitation.
*/
ShareNotes?: Notes;
/**
* Specifies when the directory was created.
*/
LaunchTime?: LaunchTime;
/**
* The date and time that the stage was last updated.
*/
StageLastUpdatedDateTime?: LastUpdatedDateTime;
/**
* The directory size.
*/
Type?: DirectoryType;
/**
* A DirectoryVpcSettingsDescription object that contains additional information about a directory. This member is only present if the directory is a Simple AD or Managed AD directory.
*/
VpcSettings?: DirectoryVpcSettingsDescription;
/**
* A DirectoryConnectSettingsDescription object that contains additional information about an AD Connector directory. This member is only present if the directory is an AD Connector directory.
*/
ConnectSettings?: DirectoryConnectSettingsDescription;
/**
* A RadiusSettings object that contains information about the RADIUS server configured for this directory.
*/
RadiusSettings?: RadiusSettings;
/**
* The status of the RADIUS MFA server connection.
*/
RadiusStatus?: RadiusStatus;
/**
* Additional information about the directory stage.
*/
StageReason?: StageReason;
/**
* Indicates if single sign-on is enabled for the directory. For more information, see EnableSso and DisableSso.
*/
SsoEnabled?: SsoEnabled;
/**
* The desired number of domain controllers in the directory if the directory is Microsoft AD.
*/
DesiredNumberOfDomainControllers?: DesiredNumberOfDomainControllers;
/**
* Describes the AWS Managed Microsoft AD directory in the directory owner account.
*/
OwnerDirectoryDescription?: OwnerDirectoryDescription;
}
export type DirectoryDescriptions = DirectoryDescription[];
export type DirectoryEdition = "Enterprise"|"Standard"|string;
export type DirectoryId = string;
export type DirectoryIds = DirectoryId[];
export interface DirectoryLimits {
/**
* The maximum number of cloud directories allowed in the Region.
*/
CloudOnlyDirectoriesLimit?: Limit;
/**
* The current number of cloud directories in the Region.
*/
CloudOnlyDirectoriesCurrentCount?: Limit;
/**
* Indicates if the cloud directory limit has been reached.
*/
CloudOnlyDirectoriesLimitReached?: CloudOnlyDirectoriesLimitReached;
/**
* The maximum number of AWS Managed Microsoft AD directories allowed in the region.
*/
CloudOnlyMicrosoftADLimit?: Limit;
/**
* The current number of AWS Managed Microsoft AD directories in the region.
*/
CloudOnlyMicrosoftADCurrentCount?: Limit;
/**
* Indicates if the AWS Managed Microsoft AD directory limit has been reached.
*/
CloudOnlyMicrosoftADLimitReached?: CloudOnlyDirectoriesLimitReached;
/**
* The maximum number of connected directories allowed in the Region.
*/
ConnectedDirectoriesLimit?: Limit;
/**
* The current number of connected directories in the Region.
*/
ConnectedDirectoriesCurrentCount?: Limit;
/**
* Indicates if the connected directory limit has been reached.
*/
ConnectedDirectoriesLimitReached?: ConnectedDirectoriesLimitReached;
}
export type DirectoryName = string;
export type DirectoryShortName = string;
export type DirectorySize = "Small"|"Large"|string;
export type DirectoryStage = "Requested"|"Creating"|"Created"|"Active"|"Inoperable"|"Impaired"|"Restoring"|"RestoreFailed"|"Deleting"|"Deleted"|"Failed"|string;
export type DirectoryType = "SimpleAD"|"ADConnector"|"MicrosoftAD"|"SharedMicrosoftAD"|string;
export interface DirectoryVpcSettings {
/**
* The identifier of the VPC in which to create the directory.
*/
VpcId: VpcId;
/**
* The identifiers of the subnets for the directory servers. The two subnets must be in different Availability Zones. AWS Directory Service creates a directory server and a DNS server in each of these subnets.
*/
SubnetIds: SubnetIds;
}
export interface DirectoryVpcSettingsDescription {
/**
* The identifier of the VPC that the directory is in.
*/
VpcId?: VpcId;
/**
* The identifiers of the subnets for the directory servers.
*/
SubnetIds?: SubnetIds;
/**
* The domain controller security group identifier for the directory.
*/
SecurityGroupId?: SecurityGroupId;
/**
* The list of Availability Zones that the directory is in.
*/
AvailabilityZones?: AvailabilityZones;
}
export interface DisableLDAPSRequest {
/**
* The identifier of the directory.
*/
DirectoryId: DirectoryId;
/**
* The type of LDAP security that the customer wants to enable. The security can be either server or client, but currently only the default Client is supported.
*/
Type?: LDAPSType;
}
export interface DisableLDAPSResult {
}
export interface DisableRadiusRequest {
/**
* The identifier of the directory for which to disable MFA.
*/
DirectoryId: DirectoryId;
}
export interface DisableRadiusResult {
}
export interface DisableSsoRequest {
/**
* The identifier of the directory for which to disable single-sign on.
*/
DirectoryId: DirectoryId;
/**
* The username of an alternate account to use to disable single-sign on. This is only used for AD Connector directories. This account must have privileges to remove a service principal name. If the AD Connector service account does not have privileges to remove a service principal name, you can specify an alternate account with the UserName and Password parameters. These credentials are only used to disable single sign-on and are not stored by the service. The AD Connector service account is not changed.
*/
UserName?: UserName;
/**
* The password of an alternate account to use to disable single-sign on. This is only used for AD Connector directories. For more information, see the UserName parameter.
*/
Password?: ConnectPassword;
}
export interface DisableSsoResult {
}
export type DnsIpAddrs = IpAddr[];
export interface DomainController {
/**
* Identifier of the directory where the domain controller resides.
*/
DirectoryId?: DirectoryId;
/**
* Identifies a specific domain controller in the directory.
*/
DomainControllerId?: DomainControllerId;
/**
* The IP address of the domain controller.
*/
DnsIpAddr?: IpAddr;
/**
* The identifier of the VPC that contains the domain controller.
*/
VpcId?: VpcId;
/**
* Identifier of the subnet in the VPC that contains the domain controller.
*/
SubnetId?: SubnetId;
/**
* The Availability Zone where the domain controller is located.
*/
AvailabilityZone?: AvailabilityZone;
/**
* The status of the domain controller.
*/
Status?: DomainControllerStatus;
/**
* A description of the domain controller state.
*/
StatusReason?: DomainControllerStatusReason;
/**
* Specifies when the domain controller was created.
*/
LaunchTime?: LaunchTime;
/**
* The date and time that the status was last updated.
*/
StatusLastUpdatedDateTime?: LastUpdatedDateTime;
}
export type DomainControllerId = string;
export type DomainControllerIds = DomainControllerId[];
export type DomainControllerStatus = "Creating"|"Active"|"Impaired"|"Restoring"|"Deleting"|"Deleted"|"Failed"|string;
export type DomainControllerStatusReason = string;
export type DomainControllers = DomainController[];
export interface EnableLDAPSRequest {
/**
* The identifier of the directory.
*/
DirectoryId: DirectoryId;
/**
* The type of LDAP security the customer wants to enable. The security can be either server or client, but currently only the default Client is supported.
*/
Type?: LDAPSType;
}
export interface EnableLDAPSResult {
}
export interface EnableRadiusRequest {
/**
* The identifier of the directory for which to enable MFA.
*/
DirectoryId: DirectoryId;
/**
* A RadiusSettings object that contains information about the RADIUS server.
*/
RadiusSettings: RadiusSettings;
}
export interface EnableRadiusResult {
}
export interface EnableSsoRequest {
/**
* The identifier of the directory for which to enable single-sign on.
*/
DirectoryId: DirectoryId;
/**
* The username of an alternate account to use to enable single-sign on. This is only used for AD Connector directories. This account must have privileges to add a service principal name. If the AD Connector service account does not have privileges to add a service principal name, you can specify an alternate account with the UserName and Password parameters. These credentials are only used to enable single sign-on and are not stored by the service. The AD Connector service account is not changed.
*/
UserName?: UserName;
/**
* The password of an alternate account to use to enable single-sign on. This is only used for AD Connector directories. For more information, see the UserName parameter.
*/
Password?: ConnectPassword;
}
export interface EnableSsoResult {
}
export type EndDateTime = Date;
export interface EventTopic {
/**
* The Directory ID of an AWS Directory Service directory that will publish status messages to an SNS topic.
*/
DirectoryId?: DirectoryId;
/**
* The name of an AWS SNS topic the receives status messages from the directory.
*/
TopicName?: TopicName;
/**
* The SNS topic ARN (Amazon Resource Name).
*/
TopicArn?: TopicArn;
/**
* The date and time of when you associated your directory with the SNS topic.
*/
CreatedDateTime?: CreatedDateTime;
/**
* The topic registration status.
*/
Status?: TopicStatus;
}
export type EventTopics = EventTopic[];
export interface GetDirectoryLimitsRequest {
}
export interface GetDirectoryLimitsResult {
/**
* A DirectoryLimits object that contains the directory limits for the current rRegion.
*/
DirectoryLimits?: DirectoryLimits;
}
export interface GetSnapshotLimitsRequest {
/**
* Contains the identifier of the directory to obtain the limits for.
*/
DirectoryId: DirectoryId;
}
export interface GetSnapshotLimitsResult {
/**
* A SnapshotLimits object that contains the manual snapshot limits for the specified directory.
*/
SnapshotLimits?: SnapshotLimits;
}
export type IpAddr = string;
export type IpAddrs = IpAddr[];
export interface IpRoute {
/**
* IP address block using CIDR format, for example 10.0.0.0/24. This is often the address block of the DNS server used for your on-premises domain. For a single IP address use a CIDR address block with /32. For example 10.0.0.0/32.
*/
CidrIp?: CidrIp;
/**
* Description of the address block.
*/
Description?: Description;
}
export interface IpRouteInfo {
/**
* Identifier (ID) of the directory associated with the IP addresses.
*/
DirectoryId?: DirectoryId;
/**
* IP address block in the IpRoute.
*/
CidrIp?: CidrIp;
/**
* The status of the IP address block.
*/
IpRouteStatusMsg?: IpRouteStatusMsg;
/**
* The date and time the address block was added to the directory.
*/
AddedDateTime?: AddedDateTime;
/**
* The reason for the IpRouteStatusMsg.
*/
IpRouteStatusReason?: IpRouteStatusReason;
/**
* Description of the IpRouteInfo.
*/
Description?: Description;
}
export type IpRouteStatusMsg = "Adding"|"Added"|"Removing"|"Removed"|"AddFailed"|"RemoveFailed"|string;
export type IpRouteStatusReason = string;
export type IpRoutes = IpRoute[];
export type IpRoutesInfo = IpRouteInfo[];
export interface LDAPSSettingInfo {
/**
* The state of the LDAPS settings.
*/
LDAPSStatus?: LDAPSStatus;
/**
* Describes a state change for LDAPS.
*/
LDAPSStatusReason?: LDAPSStatusReason;
/**
* The date and time when the LDAPS settings were last updated.
*/
LastUpdatedDateTime?: LastUpdatedDateTime;
}
export type LDAPSSettingsInfo = LDAPSSettingInfo[];
export type LDAPSStatus = "Enabling"|"Enabled"|"EnableFailed"|"Disabled"|string;
export type LDAPSStatusReason = string;
export type LDAPSType = "Client"|string;
export type LastUpdatedDateTime = Date;
export type LaunchTime = Date;
export type LdifContent = string;
export type Limit = number;
export interface ListCertificatesRequest {
/**
* The identifier of the directory.
*/
DirectoryId: DirectoryId;
/**
* A token for requesting another page of certificates if the NextToken response element indicates that more certificates are available. Use the value of the returned NextToken element in your request until the token comes back as null. Pass null if this is the first call.
*/
NextToken?: NextToken;
/**
* The number of items that should show up on one page
*/
Limit?: PageLimit;
}
export interface ListCertificatesResult {
/**
* Indicates whether another page of certificates is available when the number of available certificates exceeds the page limit.
*/
NextToken?: NextToken;
/**
* A list of certificates with basic details including certificate ID, certificate common name, certificate state.
*/
CertificatesInfo?: CertificatesInfo;
}
export interface ListIpRoutesRequest {
/**
* Identifier (ID) of the directory for which you want to retrieve the IP addresses.
*/
DirectoryId: DirectoryId;
/**
* The ListIpRoutes.NextToken value from a previous call to ListIpRoutes. Pass null if this is the first call.
*/
NextToken?: NextToken;
/**
* Maximum number of items to return. If this value is zero, the maximum number of items is specified by the limitations of the operation.
*/
Limit?: Limit;
}
export interface ListIpRoutesResult {
/**
* A list of IpRoutes.
*/
IpRoutesInfo?: IpRoutesInfo;
/**
* If not null, more results are available. Pass this value for the NextToken parameter in a subsequent call to ListIpRoutes to retrieve the next set of items.
*/
NextToken?: NextToken;
}
export interface ListLogSubscriptionsRequest {
/**
* If a DirectoryID is provided, lists only the log subscription associated with that directory. If no DirectoryId is provided, lists all log subscriptions associated with your AWS account. If there are no log subscriptions for the AWS account or the directory, an empty list will be returned.
*/
DirectoryId?: DirectoryId;
/**
* The token for the next set of items to return.
*/
NextToken?: NextToken;
/**
* The maximum number of items returned.
*/
Limit?: Limit;
}
export interface ListLogSubscriptionsResult {
/**
* A list of active LogSubscription objects for calling the AWS account.
*/
LogSubscriptions?: LogSubscriptions;
/**
* The token for the next set of items to return.
*/
NextToken?: NextToken;
}
export interface ListSchemaExtensionsRequest {
/**
* The identifier of the directory from which to retrieve the schema extension information.
*/
DirectoryId: DirectoryId;
/**
* The ListSchemaExtensions.NextToken value from a previous call to ListSchemaExtensions. Pass null if this is the first call.
*/
NextToken?: NextToken;
/**
* The maximum number of items to return.
*/
Limit?: Limit;
}
export interface ListSchemaExtensionsResult {
/**
* Information about the schema extensions applied to the directory.
*/
SchemaExtensionsInfo?: SchemaExtensionsInfo;
/**
* If not null, more results are available. Pass this value for the NextToken parameter in a subsequent call to ListSchemaExtensions to retrieve the next set of items.
*/
NextToken?: NextToken;
}
export interface ListTagsForResourceRequest {
/**
* Identifier (ID) of the directory for which you want to retrieve tags.
*/
ResourceId: ResourceId;
/**
* Reserved for future use.
*/
NextToken?: NextToken;
/**
* Reserved for future use.
*/
Limit?: Limit;
}
export interface ListTagsForResourceResult {
/**
* List of tags returned by the ListTagsForResource operation.
*/
Tags?: Tags;
/**
* Reserved for future use.
*/
NextToken?: NextToken;
}
export type LogGroupName = string;
export interface LogSubscription {
/**
* Identifier (ID) of the directory that you want to associate with the log subscription.
*/
DirectoryId?: DirectoryId;
/**
* The name of the log group.
*/
LogGroupName?: LogGroupName;
/**
* The date and time that the log subscription was created.
*/
SubscriptionCreatedDateTime?: SubscriptionCreatedDateTime;
}
export type LogSubscriptions = LogSubscription[];
export type ManualSnapshotsLimitReached = boolean;
export type NextToken = string;
export type Notes = string;
export type OrganizationalUnitDN = string;
export interface OwnerDirectoryDescription {
/**
* Identifier of the AWS Managed Microsoft AD directory in the directory owner account.
*/
DirectoryId?: DirectoryId;
/**
* Identifier of the directory owner account.
*/
AccountId?: CustomerId;
/**
* IP address of the directory’s domain controllers.
*/
DnsIpAddrs?: DnsIpAddrs;
/**
* Information about the VPC settings for the directory.
*/
VpcSettings?: DirectoryVpcSettingsDescription;
/**
* A RadiusSettings object that contains information about the RADIUS server.
*/
RadiusSettings?: RadiusSettings;
/**
* Information about the status of the RADIUS server.
*/
RadiusStatus?: RadiusStatus;
}
export type PageLimit = number;
export type Password = string;
export type PortNumber = number;
export type RadiusAuthenticationProtocol = "PAP"|"CHAP"|"MS-CHAPv1"|"MS-CHAPv2"|string;
export type RadiusDisplayLabel = string;
export type RadiusRetries = number;
export interface RadiusSettings {
/**
* An array of strings that contains the IP addresses of the RADIUS server endpoints, or the IP addresses of your RADIUS server load balancer.
*/
RadiusServers?: Servers;
/**
* The port that your RADIUS server is using for communications. Your on-premises network must allow inbound traffic over this port from the AWS Directory Service servers.
*/
RadiusPort?: PortNumber;
/**
* The amount of time, in seconds, to wait for the RADIUS server to respond.
*/
RadiusTimeout?: RadiusTimeout;
/**
* The maximum number of times that communication with the RADIUS server is attempted.
*/
RadiusRetries?: RadiusRetries;
/**
* Required for enabling RADIUS on the directory.
*/
SharedSecret?: RadiusSharedSecret;
/**
* The protocol specified for your RADIUS endpoints.
*/
AuthenticationProtocol?: RadiusAuthenticationProtocol;
/**
* Not currently used.
*/
DisplayLabel?: RadiusDisplayLabel;
/**
* Not currently used.
*/
UseSameUsername?: UseSameUsername;
}
export type RadiusSharedSecret = string;
export type RadiusStatus = "Creating"|"Completed"|"Failed"|string;
export type RadiusTimeout = number;
export interface RegisterCertificateRequest {
/**
* The identifier of the directory.
*/
DirectoryId: DirectoryId;
/**
* The certificate PEM string that needs to be registered.
*/
CertificateData: CertificateData;
}
export interface RegisterCertificateResult {
/**
* The identifier of the certificate.
*/
CertificateId?: CertificateId;
}
export interface RegisterEventTopicRequest {
/**
* The Directory ID that will publish status messages to the SNS topic.
*/
DirectoryId: DirectoryId;
/**
* The SNS topic name to which the directory will publish status messages. This SNS topic must be in the same region as the specified Directory ID.
*/
TopicName: TopicName;
}
export interface RegisterEventTopicResult {
}
export interface RejectSharedDirectoryRequest {
/**
* Identifier of the shared directory in the directory consumer account. This identifier is different for each directory owner account.
*/
SharedDirectoryId: DirectoryId;
}
export interface RejectSharedDirectoryResult {
/**
* Identifier of the shared directory in the directory consumer account.
*/
SharedDirectoryId?: DirectoryId;
}
export type RemoteDomainName = string;
export type RemoteDomainNames = RemoteDomainName[];
export interface RemoveIpRoutesRequest {
/**
* Identifier (ID) of the directory from which you want to remove the IP addresses.
*/
DirectoryId: DirectoryId;
/**
* IP address blocks that you want to remove.
*/
CidrIps: CidrIps;
}
export interface RemoveIpRoutesResult {
}
export interface RemoveTagsFromResourceRequest {
/**
* Identifier (ID) of the directory from which to remove the tag.
*/
ResourceId: ResourceId;
/**
* The tag key (name) of the tag to be removed.
*/
TagKeys: TagKeys;
}
export interface RemoveTagsFromResourceResult {
}
export type ReplicationScope = "Domain"|string;
export type RequestId = string;
export interface ResetUserPasswordRequest {
/**
* Identifier of the AWS Managed Microsoft AD or Simple AD directory in which the user resides.
*/
DirectoryId: DirectoryId;
/**
* The user name of the user whose password will be reset.
*/
UserName: CustomerUserName;
/**
* The new password that will be reset.
*/
NewPassword: UserPassword;
}
export interface ResetUserPasswordResult {
}
export type ResourceId = string;
export interface RestoreFromSnapshotRequest {
/**
* The identifier of the snapshot to restore from.
*/
SnapshotId: SnapshotId;
}
export interface RestoreFromSnapshotResult {
}
export type SID = string;
export type SchemaExtensionId = string;
export interface SchemaExtensionInfo {
/**
* The identifier of the directory to which the schema extension is applied.
*/
DirectoryId?: DirectoryId;
/**
* The identifier of the schema extension.
*/
SchemaExtensionId?: SchemaExtensionId;
/**
* A description of the schema extension.
*/
Description?: Description;
/**
* The current status of the schema extension.
*/
SchemaExtensionStatus?: SchemaExtensionStatus;
/**
* The reason for the SchemaExtensionStatus.
*/
SchemaExtensionStatusReason?: SchemaExtensionStatusReason;
/**
* The date and time that the schema extension started being applied to the directory.
*/
StartDateTime?: StartDateTime;
/**
* The date and time that the schema extension was completed.
*/
EndDateTime?: EndDateTime;
}
export type SchemaExtensionStatus = "Initializing"|"CreatingSnapshot"|"UpdatingSchema"|"Replicating"|"CancelInProgress"|"RollbackInProgress"|"Cancelled"|"Failed"|"Completed"|string;
export type SchemaExtensionStatusReason = string;
export type SchemaExtensionsInfo = SchemaExtensionInfo[];
export type SecurityGroupId = string;
export type SelectiveAuth = "Enabled"|"Disabled"|string;
export type Server = string;
export type Servers = Server[];
export interface ShareDirectoryRequest {
/**
* Identifier of the AWS Managed Microsoft AD directory that you want to share with other AWS accounts.
*/
DirectoryId: DirectoryId;
/**
* A directory share request that is sent by the directory owner to the directory consumer. The request includes a typed message to help the directory consumer administrator determine whether to approve or reject the share invitation.
*/
ShareNotes?: Notes;
/**
* Identifier for the directory consumer account with whom the directory is to be shared.
*/
ShareTarget: ShareTarget;
/**
* The method used when sharing a directory to determine whether the directory should be shared within your AWS organization (ORGANIZATIONS) or with any AWS account by sending a directory sharing request (HANDSHAKE).
*/
ShareMethod: ShareMethod;
}
export interface ShareDirectoryResult {
/**
* Identifier of the directory that is stored in the directory consumer account that is shared from the specified directory (DirectoryId).
*/
SharedDirectoryId?: DirectoryId;
}
export type ShareMethod = "ORGANIZATIONS"|"HANDSHAKE"|string;
export type ShareStatus = "Shared"|"PendingAcceptance"|"Rejected"|"Rejecting"|"RejectFailed"|"Sharing"|"ShareFailed"|"Deleted"|"Deleting"|string;
export interface ShareTarget {
/**
* Identifier of the directory consumer account.
*/
Id: TargetId;
/**
* Type of identifier to be used in the Id field.
*/
Type: TargetType;
}
export type SharedDirectories = SharedDirectory[];
export interface SharedDirectory {
/**
* Identifier of the directory owner account, which contains the directory that has been shared to the consumer account.
*/
OwnerAccountId?: CustomerId;
/**
* Identifier of the directory in the directory owner account.
*/
OwnerDirectoryId?: DirectoryId;
/**
* The method used when sharing a directory to determine whether the directory should be shared within your AWS organization (ORGANIZATIONS) or with any AWS account by sending a shared directory request (HANDSHAKE).
*/
ShareMethod?: ShareMethod;
/**
* Identifier of the directory consumer account that has access to the shared directory (OwnerDirectoryId) in the directory owner account.
*/
SharedAccountId?: CustomerId;
/**
* Identifier of the shared directory in the directory consumer account. This identifier is different for each directory owner account.
*/
SharedDirectoryId?: DirectoryId;
/**
* Current directory status of the shared AWS Managed Microsoft AD directory.
*/
ShareStatus?: ShareStatus;
/**
* A directory share request that is sent by the directory owner to the directory consumer. The request includes a typed message to help the directory consumer administrator determine whether to approve or reject the share invitation.
*/
ShareNotes?: Notes;
/**
* The date and time that the shared directory was created.
*/
CreatedDateTime?: CreatedDateTime;
/**
* The date and time that the shared directory was last updated.
*/
LastUpdatedDateTime?: LastUpdatedDateTime;
}
export interface Snapshot {
/**
* The directory identifier.
*/
DirectoryId?: DirectoryId;
/**
* The snapshot identifier.
*/
SnapshotId?: SnapshotId;
/**
* The snapshot type.
*/
Type?: SnapshotType;
/**
* The descriptive name of the snapshot.
*/
Name?: SnapshotName;
/**
* The snapshot status.
*/
Status?: SnapshotStatus;
/**
* The date and time that the snapshot was taken.
*/
StartTime?: StartTime;
}
export type SnapshotId = string;
export type SnapshotIds = SnapshotId[];
export interface SnapshotLimits {
/**
* The maximum number of manual snapshots allowed.
*/
ManualSnapshotsLimit?: Limit;
/**
* The current number of manual snapshots of the directory.
*/
ManualSnapshotsCurrentCount?: Limit;
/**
* Indicates if the manual snapshot limit has been reached.
*/
ManualSnapshotsLimitReached?: ManualSnapshotsLimitReached;
}
export type SnapshotName = string;
export type SnapshotStatus = "Creating"|"Completed"|"Failed"|string;
export type SnapshotType = "Auto"|"Manual"|string;
export type Snapshots = Snapshot[];
export type SsoEnabled = boolean;
export type StageReason = string;
export type StartDateTime = Date;
export interface StartSchemaExtensionRequest {
/**
* The identifier of the directory for which the schema extension will be applied to.
*/
DirectoryId: DirectoryId;
/**
* If true, creates a snapshot of the directory before applying the schema extension.
*/
CreateSnapshotBeforeSchemaExtension: CreateSnapshotBeforeSchemaExtension;
/**
* The LDIF file represented as a string. To construct the LdifContent string, precede each line as it would be formatted in an ldif file with \n. See the example request below for more details. The file size can be no larger than 1MB.
*/
LdifContent: LdifContent;
/**
* A description of the schema extension.
*/
Description: Description;
}
export interface StartSchemaExtensionResult {
/**
* The identifier of the schema extension that will be applied.
*/
SchemaExtensionId?: SchemaExtensionId;
}
export type StartTime = Date;
export type StateLastUpdatedDateTime = Date;
export type SubnetId = string;
export type SubnetIds = SubnetId[];
export type SubscriptionCreatedDateTime = Date;
export interface Tag {
/**
* Required name of the tag. The string value can be Unicode characters and cannot be prefixed with "aws:". The string can contain only the set of Unicode letters, digits, white-space, '_', '.', '/', '=', '+', '-' (Java regex: "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-]*)$").
*/
Key: TagKey;
/**
* The optional value of the tag. The string value can be Unicode characters. The string can contain only the set of Unicode letters, digits, white-space, '_', '.', '/', '=', '+', '-' (Java regex: "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-]*)$").
*/
Value: TagValue;
}
export type TagKey = string;
export type TagKeys = TagKey[];
export type TagValue = string;
export type Tags = Tag[];
export type TargetId = string;
export type TargetType = "ACCOUNT"|string;
export type TopicArn = string;
export type TopicName = string;
export type TopicNames = TopicName[];
export type TopicStatus = "Registered"|"Topic not found"|"Failed"|"Deleted"|string;
export interface Trust {
/**
* The Directory ID of the AWS directory involved in the trust relationship.
*/
DirectoryId?: DirectoryId;
/**
* The unique ID of the trust relationship.
*/
TrustId?: TrustId;
/**
* The Fully Qualified Domain Name (FQDN) of the external domain involved in the trust relationship.
*/
RemoteDomainName?: RemoteDomainName;
/**
* The trust relationship type. Forest is the default.
*/
TrustType?: TrustType;
/**
* The trust relationship direction.
*/
TrustDirection?: TrustDirection;
/**
* The trust relationship state.
*/
TrustState?: TrustState;
/**
* The date and time that the trust relationship was created.
*/
CreatedDateTime?: CreatedDateTime;
/**
* The date and time that the trust relationship was last updated.
*/
LastUpdatedDateTime?: LastUpdatedDateTime;
/**
* The date and time that the TrustState was last updated.
*/
StateLastUpdatedDateTime?: StateLastUpdatedDateTime;
/**
* The reason for the TrustState.
*/
TrustStateReason?: TrustStateReason;
/**
* Current state of selective authentication for the trust.
*/
SelectiveAuth?: SelectiveAuth;
}
export type TrustDirection = "One-Way: Outgoing"|"One-Way: Incoming"|"Two-Way"|string;
export type TrustId = string;
export type TrustIds = TrustId[];
export type TrustPassword = string;
export type TrustState = "Creating"|"Created"|"Verifying"|"VerifyFailed"|"Verified"|"Updating"|"UpdateFailed"|"Updated"|"Deleting"|"Deleted"|"Failed"|string;
export type TrustStateReason = string;
export type TrustType = "Forest"|"External"|string;
export type Trusts = Trust[];
export interface UnshareDirectoryRequest {
/**
* The identifier of the AWS Managed Microsoft AD directory that you want to stop sharing.
*/
DirectoryId: DirectoryId;
/**
* Identifier for the directory consumer account with whom the directory has to be unshared.
*/
UnshareTarget: UnshareTarget;
}
export interface UnshareDirectoryResult {
/**
* Identifier of the directory stored in the directory consumer account that is to be unshared from the specified directory (DirectoryId).
*/
SharedDirectoryId?: DirectoryId;
}
export interface UnshareTarget {
/**
* Identifier of the directory consumer account.
*/
Id: TargetId;
/**
* Type of identifier to be used in the Id field.
*/
Type: TargetType;
}
export interface UpdateConditionalForwarderRequest {
/**
* The directory ID of the AWS directory for which to update the conditional forwarder.
*/
DirectoryId: DirectoryId;
/**
* The fully qualified domain name (FQDN) of the remote domain with which you will set up a trust relationship.
*/
RemoteDomainName: RemoteDomainName;
/**
* The updated IP addresses of the remote DNS server associated with the conditional forwarder.
*/
DnsIpAddrs: DnsIpAddrs;
}
export interface UpdateConditionalForwarderResult {
}
export interface UpdateNumberOfDomainControllersRequest {
/**
* Identifier of the directory to which the domain controllers will be added or removed.
*/
DirectoryId: DirectoryId;
/**
* The number of domain controllers desired in the directory.
*/
DesiredNumber: DesiredNumberOfDomainControllers;
}
export interface UpdateNumberOfDomainControllersResult {
}
export interface UpdateRadiusRequest {
/**
* The identifier of the directory for which to update the RADIUS server information.
*/
DirectoryId: DirectoryId;
/**
* A RadiusSettings object that contains information about the RADIUS server.
*/
RadiusSettings: RadiusSettings;
}
export interface UpdateRadiusResult {
}
export type UpdateSecurityGroupForDirectoryControllers = boolean;
export interface UpdateTrustRequest {
/**
* Identifier of the trust relationship.
*/
TrustId: TrustId;
/**
* Updates selective authentication for the trust.
*/
SelectiveAuth?: SelectiveAuth;
}
export interface UpdateTrustResult {
RequestId?: RequestId;
/**
* Identifier of the trust relationship.
*/
TrustId?: TrustId;
}
export type UseSameUsername = boolean;
export type UserName = string;
export type UserPassword = string;
export interface VerifyTrustRequest {
/**
* The unique Trust ID of the trust relationship to verify.
*/
TrustId: TrustId;
}
export interface VerifyTrustResult {
/**
* The unique Trust ID of the trust relationship that was verified.
*/
TrustId?: TrustId;
}
export type VpcId = string;
/**
* 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 = "2015-04-16"|"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 DirectoryService client.
*/
export import Types = DirectoryService;
}
export = DirectoryService;