UNPKG

103 kBTypeScriptView Raw
1import {Request} from '../lib/request';
2import {Response} from '../lib/response';
3import {AWSError} from '../lib/error';
4import {Service} from '../lib/service';
5import {ServiceConfigurationOptions} from '../lib/service';
6import {ConfigBase as Config} from '../lib/config';
7interface Blob {}
8declare class DirectoryService extends Service {
9 /**
10 * Constructs a service object. This object has one method for each API operation.
11 */
12 constructor(options?: DirectoryService.Types.ClientConfiguration)
13 config: Config & DirectoryService.Types.ClientConfiguration;
14 /**
15 * Accepts a directory sharing request that was sent from the directory owner account.
16 */
17 acceptSharedDirectory(params: DirectoryService.Types.AcceptSharedDirectoryRequest, callback?: (err: AWSError, data: DirectoryService.Types.AcceptSharedDirectoryResult) => void): Request<DirectoryService.Types.AcceptSharedDirectoryResult, AWSError>;
18 /**
19 * Accepts a directory sharing request that was sent from the directory owner account.
20 */
21 acceptSharedDirectory(callback?: (err: AWSError, data: DirectoryService.Types.AcceptSharedDirectoryResult) => void): Request<DirectoryService.Types.AcceptSharedDirectoryResult, AWSError>;
22 /**
23 * 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.
24 */
25 addIpRoutes(params: DirectoryService.Types.AddIpRoutesRequest, callback?: (err: AWSError, data: DirectoryService.Types.AddIpRoutesResult) => void): Request<DirectoryService.Types.AddIpRoutesResult, AWSError>;
26 /**
27 * 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.
28 */
29 addIpRoutes(callback?: (err: AWSError, data: DirectoryService.Types.AddIpRoutesResult) => void): Request<DirectoryService.Types.AddIpRoutesResult, AWSError>;
30 /**
31 * 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.
32 */
33 addTagsToResource(params: DirectoryService.Types.AddTagsToResourceRequest, callback?: (err: AWSError, data: DirectoryService.Types.AddTagsToResourceResult) => void): Request<DirectoryService.Types.AddTagsToResourceResult, AWSError>;
34 /**
35 * 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.
36 */
37 addTagsToResource(callback?: (err: AWSError, data: DirectoryService.Types.AddTagsToResourceResult) => void): Request<DirectoryService.Types.AddTagsToResourceResult, AWSError>;
38 /**
39 * 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.
40 */
41 cancelSchemaExtension(params: DirectoryService.Types.CancelSchemaExtensionRequest, callback?: (err: AWSError, data: DirectoryService.Types.CancelSchemaExtensionResult) => void): Request<DirectoryService.Types.CancelSchemaExtensionResult, AWSError>;
42 /**
43 * 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.
44 */
45 cancelSchemaExtension(callback?: (err: AWSError, data: DirectoryService.Types.CancelSchemaExtensionResult) => void): Request<DirectoryService.Types.CancelSchemaExtensionResult, AWSError>;
46 /**
47 * 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.
48 */
49 connectDirectory(params: DirectoryService.Types.ConnectDirectoryRequest, callback?: (err: AWSError, data: DirectoryService.Types.ConnectDirectoryResult) => void): Request<DirectoryService.Types.ConnectDirectoryResult, AWSError>;
50 /**
51 * 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.
52 */
53 connectDirectory(callback?: (err: AWSError, data: DirectoryService.Types.ConnectDirectoryResult) => void): Request<DirectoryService.Types.ConnectDirectoryResult, AWSError>;
54 /**
55 * 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://&lt;alias&gt;.awsapps.com. After an alias has been created, it cannot be deleted or reused, so this operation should only be used when absolutely necessary.
56 */
57 createAlias(params: DirectoryService.Types.CreateAliasRequest, callback?: (err: AWSError, data: DirectoryService.Types.CreateAliasResult) => void): Request<DirectoryService.Types.CreateAliasResult, AWSError>;
58 /**
59 * 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://&lt;alias&gt;.awsapps.com. After an alias has been created, it cannot be deleted or reused, so this operation should only be used when absolutely necessary.
60 */
61 createAlias(callback?: (err: AWSError, data: DirectoryService.Types.CreateAliasResult) => void): Request<DirectoryService.Types.CreateAliasResult, AWSError>;
62 /**
63 * Creates a computer account in the specified directory, and joins the computer to the directory.
64 */
65 createComputer(params: DirectoryService.Types.CreateComputerRequest, callback?: (err: AWSError, data: DirectoryService.Types.CreateComputerResult) => void): Request<DirectoryService.Types.CreateComputerResult, AWSError>;
66 /**
67 * Creates a computer account in the specified directory, and joins the computer to the directory.
68 */
69 createComputer(callback?: (err: AWSError, data: DirectoryService.Types.CreateComputerResult) => void): Request<DirectoryService.Types.CreateComputerResult, AWSError>;
70 /**
71 * 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.
72 */
73 createConditionalForwarder(params: DirectoryService.Types.CreateConditionalForwarderRequest, callback?: (err: AWSError, data: DirectoryService.Types.CreateConditionalForwarderResult) => void): Request<DirectoryService.Types.CreateConditionalForwarderResult, AWSError>;
74 /**
75 * 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.
76 */
77 createConditionalForwarder(callback?: (err: AWSError, data: DirectoryService.Types.CreateConditionalForwarderResult) => void): Request<DirectoryService.Types.CreateConditionalForwarderResult, AWSError>;
78 /**
79 * Creates a Simple AD directory. 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.
80 */
81 createDirectory(params: DirectoryService.Types.CreateDirectoryRequest, callback?: (err: AWSError, data: DirectoryService.Types.CreateDirectoryResult) => void): Request<DirectoryService.Types.CreateDirectoryResult, AWSError>;
82 /**
83 * Creates a Simple AD directory. 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.
84 */
85 createDirectory(callback?: (err: AWSError, data: DirectoryService.Types.CreateDirectoryResult) => void): Request<DirectoryService.Types.CreateDirectoryResult, AWSError>;
86 /**
87 * Creates a subscription to forward real time Directory Service domain controller security logs to the specified CloudWatch log group in your AWS account.
88 */
89 createLogSubscription(params: DirectoryService.Types.CreateLogSubscriptionRequest, callback?: (err: AWSError, data: DirectoryService.Types.CreateLogSubscriptionResult) => void): Request<DirectoryService.Types.CreateLogSubscriptionResult, AWSError>;
90 /**
91 * Creates a subscription to forward real time Directory Service domain controller security logs to the specified CloudWatch log group in your AWS account.
92 */
93 createLogSubscription(callback?: (err: AWSError, data: DirectoryService.Types.CreateLogSubscriptionResult) => void): Request<DirectoryService.Types.CreateLogSubscriptionResult, AWSError>;
94 /**
95 * Creates an AWS Managed Microsoft AD directory. 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.
96 */
97 createMicrosoftAD(params: DirectoryService.Types.CreateMicrosoftADRequest, callback?: (err: AWSError, data: DirectoryService.Types.CreateMicrosoftADResult) => void): Request<DirectoryService.Types.CreateMicrosoftADResult, AWSError>;
98 /**
99 * Creates an AWS Managed Microsoft AD directory. 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.
100 */
101 createMicrosoftAD(callback?: (err: AWSError, data: DirectoryService.Types.CreateMicrosoftADResult) => void): Request<DirectoryService.Types.CreateMicrosoftADResult, AWSError>;
102 /**
103 * Creates a snapshot of a Simple AD or Microsoft AD directory in the AWS cloud. You cannot take snapshots of AD Connector directories.
104 */
105 createSnapshot(params: DirectoryService.Types.CreateSnapshotRequest, callback?: (err: AWSError, data: DirectoryService.Types.CreateSnapshotResult) => void): Request<DirectoryService.Types.CreateSnapshotResult, AWSError>;
106 /**
107 * Creates a snapshot of a Simple AD or Microsoft AD directory in the AWS cloud. You cannot take snapshots of AD Connector directories.
108 */
109 createSnapshot(callback?: (err: AWSError, data: DirectoryService.Types.CreateSnapshotResult) => void): Request<DirectoryService.Types.CreateSnapshotResult, AWSError>;
110 /**
111 * 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.
112 */
113 createTrust(params: DirectoryService.Types.CreateTrustRequest, callback?: (err: AWSError, data: DirectoryService.Types.CreateTrustResult) => void): Request<DirectoryService.Types.CreateTrustResult, AWSError>;
114 /**
115 * 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.
116 */
117 createTrust(callback?: (err: AWSError, data: DirectoryService.Types.CreateTrustResult) => void): Request<DirectoryService.Types.CreateTrustResult, AWSError>;
118 /**
119 * Deletes a conditional forwarder that has been set up for your AWS directory.
120 */
121 deleteConditionalForwarder(params: DirectoryService.Types.DeleteConditionalForwarderRequest, callback?: (err: AWSError, data: DirectoryService.Types.DeleteConditionalForwarderResult) => void): Request<DirectoryService.Types.DeleteConditionalForwarderResult, AWSError>;
122 /**
123 * Deletes a conditional forwarder that has been set up for your AWS directory.
124 */
125 deleteConditionalForwarder(callback?: (err: AWSError, data: DirectoryService.Types.DeleteConditionalForwarderResult) => void): Request<DirectoryService.Types.DeleteConditionalForwarderResult, AWSError>;
126 /**
127 * 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.
128 */
129 deleteDirectory(params: DirectoryService.Types.DeleteDirectoryRequest, callback?: (err: AWSError, data: DirectoryService.Types.DeleteDirectoryResult) => void): Request<DirectoryService.Types.DeleteDirectoryResult, AWSError>;
130 /**
131 * 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.
132 */
133 deleteDirectory(callback?: (err: AWSError, data: DirectoryService.Types.DeleteDirectoryResult) => void): Request<DirectoryService.Types.DeleteDirectoryResult, AWSError>;
134 /**
135 * Deletes the specified log subscription.
136 */
137 deleteLogSubscription(params: DirectoryService.Types.DeleteLogSubscriptionRequest, callback?: (err: AWSError, data: DirectoryService.Types.DeleteLogSubscriptionResult) => void): Request<DirectoryService.Types.DeleteLogSubscriptionResult, AWSError>;
138 /**
139 * Deletes the specified log subscription.
140 */
141 deleteLogSubscription(callback?: (err: AWSError, data: DirectoryService.Types.DeleteLogSubscriptionResult) => void): Request<DirectoryService.Types.DeleteLogSubscriptionResult, AWSError>;
142 /**
143 * Deletes a directory snapshot.
144 */
145 deleteSnapshot(params: DirectoryService.Types.DeleteSnapshotRequest, callback?: (err: AWSError, data: DirectoryService.Types.DeleteSnapshotResult) => void): Request<DirectoryService.Types.DeleteSnapshotResult, AWSError>;
146 /**
147 * Deletes a directory snapshot.
148 */
149 deleteSnapshot(callback?: (err: AWSError, data: DirectoryService.Types.DeleteSnapshotResult) => void): Request<DirectoryService.Types.DeleteSnapshotResult, AWSError>;
150 /**
151 * Deletes an existing trust relationship between your AWS Managed Microsoft AD directory and an external domain.
152 */
153 deleteTrust(params: DirectoryService.Types.DeleteTrustRequest, callback?: (err: AWSError, data: DirectoryService.Types.DeleteTrustResult) => void): Request<DirectoryService.Types.DeleteTrustResult, AWSError>;
154 /**
155 * Deletes an existing trust relationship between your AWS Managed Microsoft AD directory and an external domain.
156 */
157 deleteTrust(callback?: (err: AWSError, data: DirectoryService.Types.DeleteTrustResult) => void): Request<DirectoryService.Types.DeleteTrustResult, AWSError>;
158 /**
159 * Removes the specified directory as a publisher to the specified SNS topic.
160 */
161 deregisterEventTopic(params: DirectoryService.Types.DeregisterEventTopicRequest, callback?: (err: AWSError, data: DirectoryService.Types.DeregisterEventTopicResult) => void): Request<DirectoryService.Types.DeregisterEventTopicResult, AWSError>;
162 /**
163 * Removes the specified directory as a publisher to the specified SNS topic.
164 */
165 deregisterEventTopic(callback?: (err: AWSError, data: DirectoryService.Types.DeregisterEventTopicResult) => void): Request<DirectoryService.Types.DeregisterEventTopicResult, AWSError>;
166 /**
167 * 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.
168 */
169 describeConditionalForwarders(params: DirectoryService.Types.DescribeConditionalForwardersRequest, callback?: (err: AWSError, data: DirectoryService.Types.DescribeConditionalForwardersResult) => void): Request<DirectoryService.Types.DescribeConditionalForwardersResult, AWSError>;
170 /**
171 * 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.
172 */
173 describeConditionalForwarders(callback?: (err: AWSError, data: DirectoryService.Types.DescribeConditionalForwardersResult) => void): Request<DirectoryService.Types.DescribeConditionalForwardersResult, AWSError>;
174 /**
175 * 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.
176 */
177 describeDirectories(params: DirectoryService.Types.DescribeDirectoriesRequest, callback?: (err: AWSError, data: DirectoryService.Types.DescribeDirectoriesResult) => void): Request<DirectoryService.Types.DescribeDirectoriesResult, AWSError>;
178 /**
179 * 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.
180 */
181 describeDirectories(callback?: (err: AWSError, data: DirectoryService.Types.DescribeDirectoriesResult) => void): Request<DirectoryService.Types.DescribeDirectoriesResult, AWSError>;
182 /**
183 * Provides information about any domain controllers in your directory.
184 */
185 describeDomainControllers(params: DirectoryService.Types.DescribeDomainControllersRequest, callback?: (err: AWSError, data: DirectoryService.Types.DescribeDomainControllersResult) => void): Request<DirectoryService.Types.DescribeDomainControllersResult, AWSError>;
186 /**
187 * Provides information about any domain controllers in your directory.
188 */
189 describeDomainControllers(callback?: (err: AWSError, data: DirectoryService.Types.DescribeDomainControllersResult) => void): Request<DirectoryService.Types.DescribeDomainControllersResult, AWSError>;
190 /**
191 * 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.
192 */
193 describeEventTopics(params: DirectoryService.Types.DescribeEventTopicsRequest, callback?: (err: AWSError, data: DirectoryService.Types.DescribeEventTopicsResult) => void): Request<DirectoryService.Types.DescribeEventTopicsResult, AWSError>;
194 /**
195 * 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.
196 */
197 describeEventTopics(callback?: (err: AWSError, data: DirectoryService.Types.DescribeEventTopicsResult) => void): Request<DirectoryService.Types.DescribeEventTopicsResult, AWSError>;
198 /**
199 * Returns the shared directories in your account.
200 */
201 describeSharedDirectories(params: DirectoryService.Types.DescribeSharedDirectoriesRequest, callback?: (err: AWSError, data: DirectoryService.Types.DescribeSharedDirectoriesResult) => void): Request<DirectoryService.Types.DescribeSharedDirectoriesResult, AWSError>;
202 /**
203 * Returns the shared directories in your account.
204 */
205 describeSharedDirectories(callback?: (err: AWSError, data: DirectoryService.Types.DescribeSharedDirectoriesResult) => void): Request<DirectoryService.Types.DescribeSharedDirectoriesResult, AWSError>;
206 /**
207 * 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.
208 */
209 describeSnapshots(params: DirectoryService.Types.DescribeSnapshotsRequest, callback?: (err: AWSError, data: DirectoryService.Types.DescribeSnapshotsResult) => void): Request<DirectoryService.Types.DescribeSnapshotsResult, AWSError>;
210 /**
211 * 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.
212 */
213 describeSnapshots(callback?: (err: AWSError, data: DirectoryService.Types.DescribeSnapshotsResult) => void): Request<DirectoryService.Types.DescribeSnapshotsResult, AWSError>;
214 /**
215 * 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.
216 */
217 describeTrusts(params: DirectoryService.Types.DescribeTrustsRequest, callback?: (err: AWSError, data: DirectoryService.Types.DescribeTrustsResult) => void): Request<DirectoryService.Types.DescribeTrustsResult, AWSError>;
218 /**
219 * 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.
220 */
221 describeTrusts(callback?: (err: AWSError, data: DirectoryService.Types.DescribeTrustsResult) => void): Request<DirectoryService.Types.DescribeTrustsResult, AWSError>;
222 /**
223 * Disables multi-factor authentication (MFA) with the Remote Authentication Dial In User Service (RADIUS) server for an AD Connector or Microsoft AD directory.
224 */
225 disableRadius(params: DirectoryService.Types.DisableRadiusRequest, callback?: (err: AWSError, data: DirectoryService.Types.DisableRadiusResult) => void): Request<DirectoryService.Types.DisableRadiusResult, AWSError>;
226 /**
227 * Disables multi-factor authentication (MFA) with the Remote Authentication Dial In User Service (RADIUS) server for an AD Connector or Microsoft AD directory.
228 */
229 disableRadius(callback?: (err: AWSError, data: DirectoryService.Types.DisableRadiusResult) => void): Request<DirectoryService.Types.DisableRadiusResult, AWSError>;
230 /**
231 * Disables single-sign on for a directory.
232 */
233 disableSso(params: DirectoryService.Types.DisableSsoRequest, callback?: (err: AWSError, data: DirectoryService.Types.DisableSsoResult) => void): Request<DirectoryService.Types.DisableSsoResult, AWSError>;
234 /**
235 * Disables single-sign on for a directory.
236 */
237 disableSso(callback?: (err: AWSError, data: DirectoryService.Types.DisableSsoResult) => void): Request<DirectoryService.Types.DisableSsoResult, AWSError>;
238 /**
239 * Enables multi-factor authentication (MFA) with the Remote Authentication Dial In User Service (RADIUS) server for an AD Connector or Microsoft AD directory.
240 */
241 enableRadius(params: DirectoryService.Types.EnableRadiusRequest, callback?: (err: AWSError, data: DirectoryService.Types.EnableRadiusResult) => void): Request<DirectoryService.Types.EnableRadiusResult, AWSError>;
242 /**
243 * Enables multi-factor authentication (MFA) with the Remote Authentication Dial In User Service (RADIUS) server for an AD Connector or Microsoft AD directory.
244 */
245 enableRadius(callback?: (err: AWSError, data: DirectoryService.Types.EnableRadiusResult) => void): Request<DirectoryService.Types.EnableRadiusResult, AWSError>;
246 /**
247 * Enables single sign-on for a directory.
248 */
249 enableSso(params: DirectoryService.Types.EnableSsoRequest, callback?: (err: AWSError, data: DirectoryService.Types.EnableSsoResult) => void): Request<DirectoryService.Types.EnableSsoResult, AWSError>;
250 /**
251 * Enables single sign-on for a directory.
252 */
253 enableSso(callback?: (err: AWSError, data: DirectoryService.Types.EnableSsoResult) => void): Request<DirectoryService.Types.EnableSsoResult, AWSError>;
254 /**
255 * Obtains directory limit information for the current region.
256 */
257 getDirectoryLimits(params: DirectoryService.Types.GetDirectoryLimitsRequest, callback?: (err: AWSError, data: DirectoryService.Types.GetDirectoryLimitsResult) => void): Request<DirectoryService.Types.GetDirectoryLimitsResult, AWSError>;
258 /**
259 * Obtains directory limit information for the current region.
260 */
261 getDirectoryLimits(callback?: (err: AWSError, data: DirectoryService.Types.GetDirectoryLimitsResult) => void): Request<DirectoryService.Types.GetDirectoryLimitsResult, AWSError>;
262 /**
263 * Obtains the manual snapshot limits for a directory.
264 */
265 getSnapshotLimits(params: DirectoryService.Types.GetSnapshotLimitsRequest, callback?: (err: AWSError, data: DirectoryService.Types.GetSnapshotLimitsResult) => void): Request<DirectoryService.Types.GetSnapshotLimitsResult, AWSError>;
266 /**
267 * Obtains the manual snapshot limits for a directory.
268 */
269 getSnapshotLimits(callback?: (err: AWSError, data: DirectoryService.Types.GetSnapshotLimitsResult) => void): Request<DirectoryService.Types.GetSnapshotLimitsResult, AWSError>;
270 /**
271 * Lists the address blocks that you have added to a directory.
272 */
273 listIpRoutes(params: DirectoryService.Types.ListIpRoutesRequest, callback?: (err: AWSError, data: DirectoryService.Types.ListIpRoutesResult) => void): Request<DirectoryService.Types.ListIpRoutesResult, AWSError>;
274 /**
275 * Lists the address blocks that you have added to a directory.
276 */
277 listIpRoutes(callback?: (err: AWSError, data: DirectoryService.Types.ListIpRoutesResult) => void): Request<DirectoryService.Types.ListIpRoutesResult, AWSError>;
278 /**
279 * Lists the active log subscriptions for the AWS account.
280 */
281 listLogSubscriptions(params: DirectoryService.Types.ListLogSubscriptionsRequest, callback?: (err: AWSError, data: DirectoryService.Types.ListLogSubscriptionsResult) => void): Request<DirectoryService.Types.ListLogSubscriptionsResult, AWSError>;
282 /**
283 * Lists the active log subscriptions for the AWS account.
284 */
285 listLogSubscriptions(callback?: (err: AWSError, data: DirectoryService.Types.ListLogSubscriptionsResult) => void): Request<DirectoryService.Types.ListLogSubscriptionsResult, AWSError>;
286 /**
287 * Lists all schema extensions applied to a Microsoft AD Directory.
288 */
289 listSchemaExtensions(params: DirectoryService.Types.ListSchemaExtensionsRequest, callback?: (err: AWSError, data: DirectoryService.Types.ListSchemaExtensionsResult) => void): Request<DirectoryService.Types.ListSchemaExtensionsResult, AWSError>;
290 /**
291 * Lists all schema extensions applied to a Microsoft AD Directory.
292 */
293 listSchemaExtensions(callback?: (err: AWSError, data: DirectoryService.Types.ListSchemaExtensionsResult) => void): Request<DirectoryService.Types.ListSchemaExtensionsResult, AWSError>;
294 /**
295 * Lists all tags on a directory.
296 */
297 listTagsForResource(params: DirectoryService.Types.ListTagsForResourceRequest, callback?: (err: AWSError, data: DirectoryService.Types.ListTagsForResourceResult) => void): Request<DirectoryService.Types.ListTagsForResourceResult, AWSError>;
298 /**
299 * Lists all tags on a directory.
300 */
301 listTagsForResource(callback?: (err: AWSError, data: DirectoryService.Types.ListTagsForResourceResult) => void): Request<DirectoryService.Types.ListTagsForResourceResult, AWSError>;
302 /**
303 * 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.
304 */
305 registerEventTopic(params: DirectoryService.Types.RegisterEventTopicRequest, callback?: (err: AWSError, data: DirectoryService.Types.RegisterEventTopicResult) => void): Request<DirectoryService.Types.RegisterEventTopicResult, AWSError>;
306 /**
307 * 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.
308 */
309 registerEventTopic(callback?: (err: AWSError, data: DirectoryService.Types.RegisterEventTopicResult) => void): Request<DirectoryService.Types.RegisterEventTopicResult, AWSError>;
310 /**
311 * Rejects a directory sharing request that was sent from the directory owner account.
312 */
313 rejectSharedDirectory(params: DirectoryService.Types.RejectSharedDirectoryRequest, callback?: (err: AWSError, data: DirectoryService.Types.RejectSharedDirectoryResult) => void): Request<DirectoryService.Types.RejectSharedDirectoryResult, AWSError>;
314 /**
315 * Rejects a directory sharing request that was sent from the directory owner account.
316 */
317 rejectSharedDirectory(callback?: (err: AWSError, data: DirectoryService.Types.RejectSharedDirectoryResult) => void): Request<DirectoryService.Types.RejectSharedDirectoryResult, AWSError>;
318 /**
319 * Removes IP address blocks from a directory.
320 */
321 removeIpRoutes(params: DirectoryService.Types.RemoveIpRoutesRequest, callback?: (err: AWSError, data: DirectoryService.Types.RemoveIpRoutesResult) => void): Request<DirectoryService.Types.RemoveIpRoutesResult, AWSError>;
322 /**
323 * Removes IP address blocks from a directory.
324 */
325 removeIpRoutes(callback?: (err: AWSError, data: DirectoryService.Types.RemoveIpRoutesResult) => void): Request<DirectoryService.Types.RemoveIpRoutesResult, AWSError>;
326 /**
327 * Removes tags from a directory.
328 */
329 removeTagsFromResource(params: DirectoryService.Types.RemoveTagsFromResourceRequest, callback?: (err: AWSError, data: DirectoryService.Types.RemoveTagsFromResourceResult) => void): Request<DirectoryService.Types.RemoveTagsFromResourceResult, AWSError>;
330 /**
331 * Removes tags from a directory.
332 */
333 removeTagsFromResource(callback?: (err: AWSError, data: DirectoryService.Types.RemoveTagsFromResourceResult) => void): Request<DirectoryService.Types.RemoveTagsFromResourceResult, AWSError>;
334 /**
335 * Resets the password for any user in your AWS Managed Microsoft AD or Simple AD directory.
336 */
337 resetUserPassword(params: DirectoryService.Types.ResetUserPasswordRequest, callback?: (err: AWSError, data: DirectoryService.Types.ResetUserPasswordResult) => void): Request<DirectoryService.Types.ResetUserPasswordResult, AWSError>;
338 /**
339 * Resets the password for any user in your AWS Managed Microsoft AD or Simple AD directory.
340 */
341 resetUserPassword(callback?: (err: AWSError, data: DirectoryService.Types.ResetUserPasswordResult) => void): Request<DirectoryService.Types.ResetUserPasswordResult, AWSError>;
342 /**
343 * 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.
344 */
345 restoreFromSnapshot(params: DirectoryService.Types.RestoreFromSnapshotRequest, callback?: (err: AWSError, data: DirectoryService.Types.RestoreFromSnapshotResult) => void): Request<DirectoryService.Types.RestoreFromSnapshotResult, AWSError>;
346 /**
347 * 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.
348 */
349 restoreFromSnapshot(callback?: (err: AWSError, data: DirectoryService.Types.RestoreFromSnapshotResult) => void): Request<DirectoryService.Types.RestoreFromSnapshotResult, AWSError>;
350 /**
351 * 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.
352 */
353 shareDirectory(params: DirectoryService.Types.ShareDirectoryRequest, callback?: (err: AWSError, data: DirectoryService.Types.ShareDirectoryResult) => void): Request<DirectoryService.Types.ShareDirectoryResult, AWSError>;
354 /**
355 * 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.
356 */
357 shareDirectory(callback?: (err: AWSError, data: DirectoryService.Types.ShareDirectoryResult) => void): Request<DirectoryService.Types.ShareDirectoryResult, AWSError>;
358 /**
359 * Applies a schema extension to a Microsoft AD directory.
360 */
361 startSchemaExtension(params: DirectoryService.Types.StartSchemaExtensionRequest, callback?: (err: AWSError, data: DirectoryService.Types.StartSchemaExtensionResult) => void): Request<DirectoryService.Types.StartSchemaExtensionResult, AWSError>;
362 /**
363 * Applies a schema extension to a Microsoft AD directory.
364 */
365 startSchemaExtension(callback?: (err: AWSError, data: DirectoryService.Types.StartSchemaExtensionResult) => void): Request<DirectoryService.Types.StartSchemaExtensionResult, AWSError>;
366 /**
367 * Stops the directory sharing between the directory owner and consumer accounts.
368 */
369 unshareDirectory(params: DirectoryService.Types.UnshareDirectoryRequest, callback?: (err: AWSError, data: DirectoryService.Types.UnshareDirectoryResult) => void): Request<DirectoryService.Types.UnshareDirectoryResult, AWSError>;
370 /**
371 * Stops the directory sharing between the directory owner and consumer accounts.
372 */
373 unshareDirectory(callback?: (err: AWSError, data: DirectoryService.Types.UnshareDirectoryResult) => void): Request<DirectoryService.Types.UnshareDirectoryResult, AWSError>;
374 /**
375 * Updates a conditional forwarder that has been set up for your AWS directory.
376 */
377 updateConditionalForwarder(params: DirectoryService.Types.UpdateConditionalForwarderRequest, callback?: (err: AWSError, data: DirectoryService.Types.UpdateConditionalForwarderResult) => void): Request<DirectoryService.Types.UpdateConditionalForwarderResult, AWSError>;
378 /**
379 * Updates a conditional forwarder that has been set up for your AWS directory.
380 */
381 updateConditionalForwarder(callback?: (err: AWSError, data: DirectoryService.Types.UpdateConditionalForwarderResult) => void): Request<DirectoryService.Types.UpdateConditionalForwarderResult, AWSError>;
382 /**
383 * 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.
384 */
385 updateNumberOfDomainControllers(params: DirectoryService.Types.UpdateNumberOfDomainControllersRequest, callback?: (err: AWSError, data: DirectoryService.Types.UpdateNumberOfDomainControllersResult) => void): Request<DirectoryService.Types.UpdateNumberOfDomainControllersResult, AWSError>;
386 /**
387 * 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.
388 */
389 updateNumberOfDomainControllers(callback?: (err: AWSError, data: DirectoryService.Types.UpdateNumberOfDomainControllersResult) => void): Request<DirectoryService.Types.UpdateNumberOfDomainControllersResult, AWSError>;
390 /**
391 * Updates the Remote Authentication Dial In User Service (RADIUS) server information for an AD Connector or Microsoft AD directory.
392 */
393 updateRadius(params: DirectoryService.Types.UpdateRadiusRequest, callback?: (err: AWSError, data: DirectoryService.Types.UpdateRadiusResult) => void): Request<DirectoryService.Types.UpdateRadiusResult, AWSError>;
394 /**
395 * Updates the Remote Authentication Dial In User Service (RADIUS) server information for an AD Connector or Microsoft AD directory.
396 */
397 updateRadius(callback?: (err: AWSError, data: DirectoryService.Types.UpdateRadiusResult) => void): Request<DirectoryService.Types.UpdateRadiusResult, AWSError>;
398 /**
399 * Updates the trust that has been set up between your AWS Managed Microsoft AD directory and an on-premises Active Directory.
400 */
401 updateTrust(params: DirectoryService.Types.UpdateTrustRequest, callback?: (err: AWSError, data: DirectoryService.Types.UpdateTrustResult) => void): Request<DirectoryService.Types.UpdateTrustResult, AWSError>;
402 /**
403 * Updates the trust that has been set up between your AWS Managed Microsoft AD directory and an on-premises Active Directory.
404 */
405 updateTrust(callback?: (err: AWSError, data: DirectoryService.Types.UpdateTrustResult) => void): Request<DirectoryService.Types.UpdateTrustResult, AWSError>;
406 /**
407 * 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.
408 */
409 verifyTrust(params: DirectoryService.Types.VerifyTrustRequest, callback?: (err: AWSError, data: DirectoryService.Types.VerifyTrustResult) => void): Request<DirectoryService.Types.VerifyTrustResult, AWSError>;
410 /**
411 * 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.
412 */
413 verifyTrust(callback?: (err: AWSError, data: DirectoryService.Types.VerifyTrustResult) => void): Request<DirectoryService.Types.VerifyTrustResult, AWSError>;
414}
415declare namespace DirectoryService {
416 export interface AcceptSharedDirectoryRequest {
417 /**
418 * Identifier of the shared directory in the directory consumer account. This identifier is different for each directory owner account.
419 */
420 SharedDirectoryId: DirectoryId;
421 }
422 export interface AcceptSharedDirectoryResult {
423 /**
424 * The shared directory in the directory consumer account.
425 */
426 SharedDirectory?: SharedDirectory;
427 }
428 export type AccessUrl = string;
429 export interface AddIpRoutesRequest {
430 /**
431 * Identifier (ID) of the directory to which to add the address block.
432 */
433 DirectoryId: DirectoryId;
434 /**
435 * 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.
436 */
437 IpRoutes: IpRoutes;
438 /**
439 * 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.
440 */
441 UpdateSecurityGroupForDirectoryControllers?: UpdateSecurityGroupForDirectoryControllers;
442 }
443 export interface AddIpRoutesResult {
444 }
445 export interface AddTagsToResourceRequest {
446 /**
447 * Identifier (ID) for the directory to which to add the tag.
448 */
449 ResourceId: ResourceId;
450 /**
451 * The tags to be assigned to the directory.
452 */
453 Tags: Tags;
454 }
455 export interface AddTagsToResourceResult {
456 }
457 export type AddedDateTime = Date;
458 export type AliasName = string;
459 export interface Attribute {
460 /**
461 * The name of the attribute.
462 */
463 Name?: AttributeName;
464 /**
465 * The value of the attribute.
466 */
467 Value?: AttributeValue;
468 }
469 export type AttributeName = string;
470 export type AttributeValue = string;
471 export type Attributes = Attribute[];
472 export type AvailabilityZone = string;
473 export type AvailabilityZones = AvailabilityZone[];
474 export interface CancelSchemaExtensionRequest {
475 /**
476 * The identifier of the directory whose schema extension will be canceled.
477 */
478 DirectoryId: DirectoryId;
479 /**
480 * The identifier of the schema extension that will be canceled.
481 */
482 SchemaExtensionId: SchemaExtensionId;
483 }
484 export interface CancelSchemaExtensionResult {
485 }
486 export type CidrIp = string;
487 export type CidrIps = CidrIp[];
488 export type CloudOnlyDirectoriesLimitReached = boolean;
489 export interface Computer {
490 /**
491 * The identifier of the computer.
492 */
493 ComputerId?: SID;
494 /**
495 * The computer name.
496 */
497 ComputerName?: ComputerName;
498 /**
499 * An array of Attribute objects containing the LDAP attributes that belong to the computer account.
500 */
501 ComputerAttributes?: Attributes;
502 }
503 export type ComputerName = string;
504 export type ComputerPassword = string;
505 export interface ConditionalForwarder {
506 /**
507 * The fully qualified domain name (FQDN) of the remote domains pointed to by the conditional forwarder.
508 */
509 RemoteDomainName?: RemoteDomainName;
510 /**
511 * 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.
512 */
513 DnsIpAddrs?: DnsIpAddrs;
514 /**
515 * 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.
516 */
517 ReplicationScope?: ReplicationScope;
518 }
519 export type ConditionalForwarders = ConditionalForwarder[];
520 export interface ConnectDirectoryRequest {
521 /**
522 * The fully qualified name of the on-premises directory, such as corp.example.com.
523 */
524 Name: DirectoryName;
525 /**
526 * The NetBIOS name of the on-premises directory, such as CORP.
527 */
528 ShortName?: DirectoryShortName;
529 /**
530 * The password for the on-premises user account.
531 */
532 Password: ConnectPassword;
533 /**
534 * A textual description for the directory.
535 */
536 Description?: Description;
537 /**
538 * The size of the directory.
539 */
540 Size: DirectorySize;
541 /**
542 * A DirectoryConnectSettings object that contains additional information for the operation.
543 */
544 ConnectSettings: DirectoryConnectSettings;
545 /**
546 * The tags to be assigned to AD Connector.
547 */
548 Tags?: Tags;
549 }
550 export interface ConnectDirectoryResult {
551 /**
552 * The identifier of the new directory.
553 */
554 DirectoryId?: DirectoryId;
555 }
556 export type ConnectPassword = string;
557 export type ConnectedDirectoriesLimitReached = boolean;
558 export interface CreateAliasRequest {
559 /**
560 * The identifier of the directory for which to create the alias.
561 */
562 DirectoryId: DirectoryId;
563 /**
564 * The requested alias. The alias must be unique amongst all aliases in AWS. This operation throws an EntityAlreadyExistsException error if the alias already exists.
565 */
566 Alias: AliasName;
567 }
568 export interface CreateAliasResult {
569 /**
570 * The identifier of the directory.
571 */
572 DirectoryId?: DirectoryId;
573 /**
574 * The alias for the directory.
575 */
576 Alias?: AliasName;
577 }
578 export interface CreateComputerRequest {
579 /**
580 * The identifier of the directory in which to create the computer account.
581 */
582 DirectoryId: DirectoryId;
583 /**
584 * The name of the computer account.
585 */
586 ComputerName: ComputerName;
587 /**
588 * 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.
589 */
590 Password: ComputerPassword;
591 /**
592 * The fully-qualified distinguished name of the organizational unit to place the computer account in.
593 */
594 OrganizationalUnitDistinguishedName?: OrganizationalUnitDN;
595 /**
596 * An array of Attribute objects that contain any LDAP attributes to apply to the computer account.
597 */
598 ComputerAttributes?: Attributes;
599 }
600 export interface CreateComputerResult {
601 /**
602 * A Computer object that represents the computer account.
603 */
604 Computer?: Computer;
605 }
606 export interface CreateConditionalForwarderRequest {
607 /**
608 * The directory ID of the AWS directory for which you are creating the conditional forwarder.
609 */
610 DirectoryId: DirectoryId;
611 /**
612 * The fully qualified domain name (FQDN) of the remote domain with which you will set up a trust relationship.
613 */
614 RemoteDomainName: RemoteDomainName;
615 /**
616 * The IP addresses of the remote DNS server associated with RemoteDomainName.
617 */
618 DnsIpAddrs: DnsIpAddrs;
619 }
620 export interface CreateConditionalForwarderResult {
621 }
622 export interface CreateDirectoryRequest {
623 /**
624 * The fully qualified name for the directory, such as corp.example.com.
625 */
626 Name: DirectoryName;
627 /**
628 * The short name of the directory, such as CORP.
629 */
630 ShortName?: DirectoryShortName;
631 /**
632 * The password for the directory administrator. The directory creation process creates a directory administrator account with the user name Administrator and this password.
633 */
634 Password: Password;
635 /**
636 * A textual description for the directory.
637 */
638 Description?: Description;
639 /**
640 * The size of the directory.
641 */
642 Size: DirectorySize;
643 /**
644 * A DirectoryVpcSettings object that contains additional information for the operation.
645 */
646 VpcSettings?: DirectoryVpcSettings;
647 /**
648 * The tags to be assigned to the Simple AD directory.
649 */
650 Tags?: Tags;
651 }
652 export interface CreateDirectoryResult {
653 /**
654 * The identifier of the directory that was created.
655 */
656 DirectoryId?: DirectoryId;
657 }
658 export interface CreateLogSubscriptionRequest {
659 /**
660 * Identifier (ID) of the directory to which you want to subscribe and receive real-time logs to your specified CloudWatch log group.
661 */
662 DirectoryId: DirectoryId;
663 /**
664 * The name of the CloudWatch log group where the real-time domain controller logs are forwarded.
665 */
666 LogGroupName: LogGroupName;
667 }
668 export interface CreateLogSubscriptionResult {
669 }
670 export interface CreateMicrosoftADRequest {
671 /**
672 * The fully qualified domain name for the directory, such as corp.example.com. This name will resolve inside your VPC only. It does not need to be publicly resolvable.
673 */
674 Name: DirectoryName;
675 /**
676 * The NetBIOS name for your domain. A short identifier 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.
677 */
678 ShortName?: DirectoryShortName;
679 /**
680 * The password for the default administrative user named Admin.
681 */
682 Password: Password;
683 /**
684 * A textual description for the directory. This label will appear on the AWS console Directory Details page after the directory is created.
685 */
686 Description?: Description;
687 /**
688 * Contains VPC information for the CreateDirectory or CreateMicrosoftAD operation.
689 */
690 VpcSettings: DirectoryVpcSettings;
691 /**
692 * AWS Managed Microsoft AD is available in two editions: Standard and Enterprise. Enterprise is the default.
693 */
694 Edition?: DirectoryEdition;
695 /**
696 * The tags to be assigned to the AWS Managed Microsoft AD directory.
697 */
698 Tags?: Tags;
699 }
700 export interface CreateMicrosoftADResult {
701 /**
702 * The identifier of the directory that was created.
703 */
704 DirectoryId?: DirectoryId;
705 }
706 export type CreateSnapshotBeforeSchemaExtension = boolean;
707 export interface CreateSnapshotRequest {
708 /**
709 * The identifier of the directory of which to take a snapshot.
710 */
711 DirectoryId: DirectoryId;
712 /**
713 * The descriptive name to apply to the snapshot.
714 */
715 Name?: SnapshotName;
716 }
717 export interface CreateSnapshotResult {
718 /**
719 * The identifier of the snapshot that was created.
720 */
721 SnapshotId?: SnapshotId;
722 }
723 export interface CreateTrustRequest {
724 /**
725 * The Directory ID of the AWS Managed Microsoft AD directory for which to establish the trust relationship.
726 */
727 DirectoryId: DirectoryId;
728 /**
729 * The Fully Qualified Domain Name (FQDN) of the external domain for which to create the trust relationship.
730 */
731 RemoteDomainName: RemoteDomainName;
732 /**
733 * The trust password. The must be the same password that was used when creating the trust relationship on the external domain.
734 */
735 TrustPassword: TrustPassword;
736 /**
737 * The direction of the trust relationship.
738 */
739 TrustDirection: TrustDirection;
740 /**
741 * The trust relationship type. Forest is the default.
742 */
743 TrustType?: TrustType;
744 /**
745 * The IP addresses of the remote DNS server associated with RemoteDomainName.
746 */
747 ConditionalForwarderIpAddrs?: DnsIpAddrs;
748 /**
749 * Optional parameter to enable selective authentication for the trust.
750 */
751 SelectiveAuth?: SelectiveAuth;
752 }
753 export interface CreateTrustResult {
754 /**
755 * A unique identifier for the trust relationship that was created.
756 */
757 TrustId?: TrustId;
758 }
759 export type CreatedDateTime = Date;
760 export type CustomerId = string;
761 export type CustomerUserName = string;
762 export type DeleteAssociatedConditionalForwarder = boolean;
763 export interface DeleteConditionalForwarderRequest {
764 /**
765 * The directory ID for which you are deleting the conditional forwarder.
766 */
767 DirectoryId: DirectoryId;
768 /**
769 * The fully qualified domain name (FQDN) of the remote domain with which you are deleting the conditional forwarder.
770 */
771 RemoteDomainName: RemoteDomainName;
772 }
773 export interface DeleteConditionalForwarderResult {
774 }
775 export interface DeleteDirectoryRequest {
776 /**
777 * The identifier of the directory to delete.
778 */
779 DirectoryId: DirectoryId;
780 }
781 export interface DeleteDirectoryResult {
782 /**
783 * The directory identifier.
784 */
785 DirectoryId?: DirectoryId;
786 }
787 export interface DeleteLogSubscriptionRequest {
788 /**
789 * Identifier (ID) of the directory whose log subscription you want to delete.
790 */
791 DirectoryId: DirectoryId;
792 }
793 export interface DeleteLogSubscriptionResult {
794 }
795 export interface DeleteSnapshotRequest {
796 /**
797 * The identifier of the directory snapshot to be deleted.
798 */
799 SnapshotId: SnapshotId;
800 }
801 export interface DeleteSnapshotResult {
802 /**
803 * The identifier of the directory snapshot that was deleted.
804 */
805 SnapshotId?: SnapshotId;
806 }
807 export interface DeleteTrustRequest {
808 /**
809 * The Trust ID of the trust relationship to be deleted.
810 */
811 TrustId: TrustId;
812 /**
813 * Delete a conditional forwarder as part of a DeleteTrustRequest.
814 */
815 DeleteAssociatedConditionalForwarder?: DeleteAssociatedConditionalForwarder;
816 }
817 export interface DeleteTrustResult {
818 /**
819 * The Trust ID of the trust relationship that was deleted.
820 */
821 TrustId?: TrustId;
822 }
823 export interface DeregisterEventTopicRequest {
824 /**
825 * The Directory ID to remove as a publisher. This directory will no longer send messages to the specified SNS topic.
826 */
827 DirectoryId: DirectoryId;
828 /**
829 * The name of the SNS topic from which to remove the directory as a publisher.
830 */
831 TopicName: TopicName;
832 }
833 export interface DeregisterEventTopicResult {
834 }
835 export interface DescribeConditionalForwardersRequest {
836 /**
837 * The directory ID for which to get the list of associated conditional forwarders.
838 */
839 DirectoryId: DirectoryId;
840 /**
841 * 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.
842 */
843 RemoteDomainNames?: RemoteDomainNames;
844 }
845 export interface DescribeConditionalForwardersResult {
846 /**
847 * The list of conditional forwarders that have been created.
848 */
849 ConditionalForwarders?: ConditionalForwarders;
850 }
851 export interface DescribeDirectoriesRequest {
852 /**
853 * 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.
854 */
855 DirectoryIds?: DirectoryIds;
856 /**
857 * The DescribeDirectoriesResult.NextToken value from a previous call to DescribeDirectories. Pass null if this is the first call.
858 */
859 NextToken?: NextToken;
860 /**
861 * 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.
862 */
863 Limit?: Limit;
864 }
865 export interface DescribeDirectoriesResult {
866 /**
867 * 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.
868 */
869 DirectoryDescriptions?: DirectoryDescriptions;
870 /**
871 * 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.
872 */
873 NextToken?: NextToken;
874 }
875 export interface DescribeDomainControllersRequest {
876 /**
877 * Identifier of the directory for which to retrieve the domain controller information.
878 */
879 DirectoryId: DirectoryId;
880 /**
881 * A list of identifiers for the domain controllers whose information will be provided.
882 */
883 DomainControllerIds?: DomainControllerIds;
884 /**
885 * The DescribeDomainControllers.NextToken value from a previous call to DescribeDomainControllers. Pass null if this is the first call.
886 */
887 NextToken?: NextToken;
888 /**
889 * The maximum number of items to return.
890 */
891 Limit?: Limit;
892 }
893 export interface DescribeDomainControllersResult {
894 /**
895 * List of the DomainController objects that were retrieved.
896 */
897 DomainControllers?: DomainControllers;
898 /**
899 * 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.
900 */
901 NextToken?: NextToken;
902 }
903 export interface DescribeEventTopicsRequest {
904 /**
905 * 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.
906 */
907 DirectoryId?: DirectoryId;
908 /**
909 * 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.
910 */
911 TopicNames?: TopicNames;
912 }
913 export interface DescribeEventTopicsResult {
914 /**
915 * A list of SNS topic names that receive status messages from the specified Directory ID.
916 */
917 EventTopics?: EventTopics;
918 }
919 export interface DescribeSharedDirectoriesRequest {
920 /**
921 * Returns the identifier of the directory in the directory owner account.
922 */
923 OwnerDirectoryId: DirectoryId;
924 /**
925 * A list of identifiers of all shared directories in your account.
926 */
927 SharedDirectoryIds?: DirectoryIds;
928 /**
929 * The DescribeSharedDirectoriesResult.NextToken value from a previous call to DescribeSharedDirectories. Pass null if this is the first call.
930 */
931 NextToken?: NextToken;
932 /**
933 * The number of shared directories to return in the response object.
934 */
935 Limit?: Limit;
936 }
937 export interface DescribeSharedDirectoriesResult {
938 /**
939 * A list of all shared directories in your account.
940 */
941 SharedDirectories?: SharedDirectories;
942 /**
943 * 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.
944 */
945 NextToken?: NextToken;
946 }
947 export interface DescribeSnapshotsRequest {
948 /**
949 * The identifier of the directory for which to retrieve snapshot information.
950 */
951 DirectoryId?: DirectoryId;
952 /**
953 * 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.
954 */
955 SnapshotIds?: SnapshotIds;
956 /**
957 * The DescribeSnapshotsResult.NextToken value from a previous call to DescribeSnapshots. Pass null if this is the first call.
958 */
959 NextToken?: NextToken;
960 /**
961 * The maximum number of objects to return.
962 */
963 Limit?: Limit;
964 }
965 export interface DescribeSnapshotsResult {
966 /**
967 * 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.
968 */
969 Snapshots?: Snapshots;
970 /**
971 * If not null, more results are available. Pass this value in the NextToken member of a subsequent call to DescribeSnapshots.
972 */
973 NextToken?: NextToken;
974 }
975 export interface DescribeTrustsRequest {
976 /**
977 * The Directory ID of the AWS directory that is a part of the requested trust relationship.
978 */
979 DirectoryId?: DirectoryId;
980 /**
981 * 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.
982 */
983 TrustIds?: TrustIds;
984 /**
985 * The DescribeTrustsResult.NextToken value from a previous call to DescribeTrusts. Pass null if this is the first call.
986 */
987 NextToken?: NextToken;
988 /**
989 * The maximum number of objects to return.
990 */
991 Limit?: Limit;
992 }
993 export interface DescribeTrustsResult {
994 /**
995 * 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.
996 */
997 Trusts?: Trusts;
998 /**
999 * 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.
1000 */
1001 NextToken?: NextToken;
1002 }
1003 export type Description = string;
1004 export type DesiredNumberOfDomainControllers = number;
1005 export interface DirectoryConnectSettings {
1006 /**
1007 * The identifier of the VPC in which the AD Connector is created.
1008 */
1009 VpcId: VpcId;
1010 /**
1011 * A list of subnet identifiers in the VPC in which the AD Connector is created.
1012 */
1013 SubnetIds: SubnetIds;
1014 /**
1015 * A list of one or more IP addresses of DNS servers or domain controllers in the on-premises directory.
1016 */
1017 CustomerDnsIps: DnsIpAddrs;
1018 /**
1019 * 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
1020 */
1021 CustomerUserName: UserName;
1022 }
1023 export interface DirectoryConnectSettingsDescription {
1024 /**
1025 * The identifier of the VPC that the AD Connector is in.
1026 */
1027 VpcId?: VpcId;
1028 /**
1029 * A list of subnet identifiers in the VPC that the AD connector is in.
1030 */
1031 SubnetIds?: SubnetIds;
1032 /**
1033 * The user name of the service account in the on-premises directory.
1034 */
1035 CustomerUserName?: UserName;
1036 /**
1037 * The security group identifier for the AD Connector directory.
1038 */
1039 SecurityGroupId?: SecurityGroupId;
1040 /**
1041 * A list of the Availability Zones that the directory is in.
1042 */
1043 AvailabilityZones?: AvailabilityZones;
1044 /**
1045 * The IP addresses of the AD Connector servers.
1046 */
1047 ConnectIps?: IpAddrs;
1048 }
1049 export interface DirectoryDescription {
1050 /**
1051 * The directory identifier.
1052 */
1053 DirectoryId?: DirectoryId;
1054 /**
1055 * The fully qualified name of the directory.
1056 */
1057 Name?: DirectoryName;
1058 /**
1059 * The short name of the directory.
1060 */
1061 ShortName?: DirectoryShortName;
1062 /**
1063 * The directory size.
1064 */
1065 Size?: DirectorySize;
1066 /**
1067 * The edition associated with this directory.
1068 */
1069 Edition?: DirectoryEdition;
1070 /**
1071 * The alias for the directory. If no alias has been created for the directory, the alias is the directory identifier, such as d-XXXXXXXXXX.
1072 */
1073 Alias?: AliasName;
1074 /**
1075 * The access URL for the directory, such as http://&lt;alias&gt;.awsapps.com. If no alias has been created for the directory, &lt;alias&gt; is the directory identifier, such as d-XXXXXXXXXX.
1076 */
1077 AccessUrl?: AccessUrl;
1078 /**
1079 * The textual description for the directory.
1080 */
1081 Description?: Description;
1082 /**
1083 * 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.
1084 */
1085 DnsIpAddrs?: DnsIpAddrs;
1086 /**
1087 * The current stage of the directory.
1088 */
1089 Stage?: DirectoryStage;
1090 /**
1091 * Current directory status of the shared AWS Managed Microsoft AD directory.
1092 */
1093 ShareStatus?: ShareStatus;
1094 /**
1095 * 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).
1096 */
1097 ShareMethod?: ShareMethod;
1098 /**
1099 * 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.
1100 */
1101 ShareNotes?: Notes;
1102 /**
1103 * Specifies when the directory was created.
1104 */
1105 LaunchTime?: LaunchTime;
1106 /**
1107 * The date and time that the stage was last updated.
1108 */
1109 StageLastUpdatedDateTime?: LastUpdatedDateTime;
1110 /**
1111 * The directory size.
1112 */
1113 Type?: DirectoryType;
1114 /**
1115 * 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.
1116 */
1117 VpcSettings?: DirectoryVpcSettingsDescription;
1118 /**
1119 * 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.
1120 */
1121 ConnectSettings?: DirectoryConnectSettingsDescription;
1122 /**
1123 * A RadiusSettings object that contains information about the RADIUS server configured for this directory.
1124 */
1125 RadiusSettings?: RadiusSettings;
1126 /**
1127 * The status of the RADIUS MFA server connection.
1128 */
1129 RadiusStatus?: RadiusStatus;
1130 /**
1131 * Additional information about the directory stage.
1132 */
1133 StageReason?: StageReason;
1134 /**
1135 * Indicates if single sign-on is enabled for the directory. For more information, see EnableSso and DisableSso.
1136 */
1137 SsoEnabled?: SsoEnabled;
1138 /**
1139 * The desired number of domain controllers in the directory if the directory is Microsoft AD.
1140 */
1141 DesiredNumberOfDomainControllers?: DesiredNumberOfDomainControllers;
1142 /**
1143 * Describes the AWS Managed Microsoft AD directory in the directory owner account.
1144 */
1145 OwnerDirectoryDescription?: OwnerDirectoryDescription;
1146 }
1147 export type DirectoryDescriptions = DirectoryDescription[];
1148 export type DirectoryEdition = "Enterprise"|"Standard"|string;
1149 export type DirectoryId = string;
1150 export type DirectoryIds = DirectoryId[];
1151 export interface DirectoryLimits {
1152 /**
1153 * The maximum number of cloud directories allowed in the region.
1154 */
1155 CloudOnlyDirectoriesLimit?: Limit;
1156 /**
1157 * The current number of cloud directories in the region.
1158 */
1159 CloudOnlyDirectoriesCurrentCount?: Limit;
1160 /**
1161 * Indicates if the cloud directory limit has been reached.
1162 */
1163 CloudOnlyDirectoriesLimitReached?: CloudOnlyDirectoriesLimitReached;
1164 /**
1165 * The maximum number of AWS Managed Microsoft AD directories allowed in the region.
1166 */
1167 CloudOnlyMicrosoftADLimit?: Limit;
1168 /**
1169 * The current number of AWS Managed Microsoft AD directories in the region.
1170 */
1171 CloudOnlyMicrosoftADCurrentCount?: Limit;
1172 /**
1173 * Indicates if the AWS Managed Microsoft AD directory limit has been reached.
1174 */
1175 CloudOnlyMicrosoftADLimitReached?: CloudOnlyDirectoriesLimitReached;
1176 /**
1177 * The maximum number of connected directories allowed in the region.
1178 */
1179 ConnectedDirectoriesLimit?: Limit;
1180 /**
1181 * The current number of connected directories in the region.
1182 */
1183 ConnectedDirectoriesCurrentCount?: Limit;
1184 /**
1185 * Indicates if the connected directory limit has been reached.
1186 */
1187 ConnectedDirectoriesLimitReached?: ConnectedDirectoriesLimitReached;
1188 }
1189 export type DirectoryName = string;
1190 export type DirectoryShortName = string;
1191 export type DirectorySize = "Small"|"Large"|string;
1192 export type DirectoryStage = "Requested"|"Creating"|"Created"|"Active"|"Inoperable"|"Impaired"|"Restoring"|"RestoreFailed"|"Deleting"|"Deleted"|"Failed"|string;
1193 export type DirectoryType = "SimpleAD"|"ADConnector"|"MicrosoftAD"|"SharedMicrosoftAD"|string;
1194 export interface DirectoryVpcSettings {
1195 /**
1196 * The identifier of the VPC in which to create the directory.
1197 */
1198 VpcId: VpcId;
1199 /**
1200 * 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.
1201 */
1202 SubnetIds: SubnetIds;
1203 }
1204 export interface DirectoryVpcSettingsDescription {
1205 /**
1206 * The identifier of the VPC that the directory is in.
1207 */
1208 VpcId?: VpcId;
1209 /**
1210 * The identifiers of the subnets for the directory servers.
1211 */
1212 SubnetIds?: SubnetIds;
1213 /**
1214 * The domain controller security group identifier for the directory.
1215 */
1216 SecurityGroupId?: SecurityGroupId;
1217 /**
1218 * The list of Availability Zones that the directory is in.
1219 */
1220 AvailabilityZones?: AvailabilityZones;
1221 }
1222 export interface DisableRadiusRequest {
1223 /**
1224 * The identifier of the directory for which to disable MFA.
1225 */
1226 DirectoryId: DirectoryId;
1227 }
1228 export interface DisableRadiusResult {
1229 }
1230 export interface DisableSsoRequest {
1231 /**
1232 * The identifier of the directory for which to disable single-sign on.
1233 */
1234 DirectoryId: DirectoryId;
1235 /**
1236 * 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.
1237 */
1238 UserName?: UserName;
1239 /**
1240 * 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.
1241 */
1242 Password?: ConnectPassword;
1243 }
1244 export interface DisableSsoResult {
1245 }
1246 export type DnsIpAddrs = IpAddr[];
1247 export interface DomainController {
1248 /**
1249 * Identifier of the directory where the domain controller resides.
1250 */
1251 DirectoryId?: DirectoryId;
1252 /**
1253 * Identifies a specific domain controller in the directory.
1254 */
1255 DomainControllerId?: DomainControllerId;
1256 /**
1257 * The IP address of the domain controller.
1258 */
1259 DnsIpAddr?: IpAddr;
1260 /**
1261 * The identifier of the VPC that contains the domain controller.
1262 */
1263 VpcId?: VpcId;
1264 /**
1265 * Identifier of the subnet in the VPC that contains the domain controller.
1266 */
1267 SubnetId?: SubnetId;
1268 /**
1269 * The Availability Zone where the domain controller is located.
1270 */
1271 AvailabilityZone?: AvailabilityZone;
1272 /**
1273 * The status of the domain controller.
1274 */
1275 Status?: DomainControllerStatus;
1276 /**
1277 * A description of the domain controller state.
1278 */
1279 StatusReason?: DomainControllerStatusReason;
1280 /**
1281 * Specifies when the domain controller was created.
1282 */
1283 LaunchTime?: LaunchTime;
1284 /**
1285 * The date and time that the status was last updated.
1286 */
1287 StatusLastUpdatedDateTime?: LastUpdatedDateTime;
1288 }
1289 export type DomainControllerId = string;
1290 export type DomainControllerIds = DomainControllerId[];
1291 export type DomainControllerStatus = "Creating"|"Active"|"Impaired"|"Restoring"|"Deleting"|"Deleted"|"Failed"|string;
1292 export type DomainControllerStatusReason = string;
1293 export type DomainControllers = DomainController[];
1294 export interface EnableRadiusRequest {
1295 /**
1296 * The identifier of the directory for which to enable MFA.
1297 */
1298 DirectoryId: DirectoryId;
1299 /**
1300 * A RadiusSettings object that contains information about the RADIUS server.
1301 */
1302 RadiusSettings: RadiusSettings;
1303 }
1304 export interface EnableRadiusResult {
1305 }
1306 export interface EnableSsoRequest {
1307 /**
1308 * The identifier of the directory for which to enable single-sign on.
1309 */
1310 DirectoryId: DirectoryId;
1311 /**
1312 * 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.
1313 */
1314 UserName?: UserName;
1315 /**
1316 * 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.
1317 */
1318 Password?: ConnectPassword;
1319 }
1320 export interface EnableSsoResult {
1321 }
1322 export type EndDateTime = Date;
1323 export interface EventTopic {
1324 /**
1325 * The Directory ID of an AWS Directory Service directory that will publish status messages to an SNS topic.
1326 */
1327 DirectoryId?: DirectoryId;
1328 /**
1329 * The name of an AWS SNS topic the receives status messages from the directory.
1330 */
1331 TopicName?: TopicName;
1332 /**
1333 * The SNS topic ARN (Amazon Resource Name).
1334 */
1335 TopicArn?: TopicArn;
1336 /**
1337 * The date and time of when you associated your directory with the SNS topic.
1338 */
1339 CreatedDateTime?: CreatedDateTime;
1340 /**
1341 * The topic registration status.
1342 */
1343 Status?: TopicStatus;
1344 }
1345 export type EventTopics = EventTopic[];
1346 export interface GetDirectoryLimitsRequest {
1347 }
1348 export interface GetDirectoryLimitsResult {
1349 /**
1350 * A DirectoryLimits object that contains the directory limits for the current region.
1351 */
1352 DirectoryLimits?: DirectoryLimits;
1353 }
1354 export interface GetSnapshotLimitsRequest {
1355 /**
1356 * Contains the identifier of the directory to obtain the limits for.
1357 */
1358 DirectoryId: DirectoryId;
1359 }
1360 export interface GetSnapshotLimitsResult {
1361 /**
1362 * A SnapshotLimits object that contains the manual snapshot limits for the specified directory.
1363 */
1364 SnapshotLimits?: SnapshotLimits;
1365 }
1366 export type IpAddr = string;
1367 export type IpAddrs = IpAddr[];
1368 export interface IpRoute {
1369 /**
1370 * 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.
1371 */
1372 CidrIp?: CidrIp;
1373 /**
1374 * Description of the address block.
1375 */
1376 Description?: Description;
1377 }
1378 export interface IpRouteInfo {
1379 /**
1380 * Identifier (ID) of the directory associated with the IP addresses.
1381 */
1382 DirectoryId?: DirectoryId;
1383 /**
1384 * IP address block in the IpRoute.
1385 */
1386 CidrIp?: CidrIp;
1387 /**
1388 * The status of the IP address block.
1389 */
1390 IpRouteStatusMsg?: IpRouteStatusMsg;
1391 /**
1392 * The date and time the address block was added to the directory.
1393 */
1394 AddedDateTime?: AddedDateTime;
1395 /**
1396 * The reason for the IpRouteStatusMsg.
1397 */
1398 IpRouteStatusReason?: IpRouteStatusReason;
1399 /**
1400 * Description of the IpRouteInfo.
1401 */
1402 Description?: Description;
1403 }
1404 export type IpRouteStatusMsg = "Adding"|"Added"|"Removing"|"Removed"|"AddFailed"|"RemoveFailed"|string;
1405 export type IpRouteStatusReason = string;
1406 export type IpRoutes = IpRoute[];
1407 export type IpRoutesInfo = IpRouteInfo[];
1408 export type LastUpdatedDateTime = Date;
1409 export type LaunchTime = Date;
1410 export type LdifContent = string;
1411 export type Limit = number;
1412 export interface ListIpRoutesRequest {
1413 /**
1414 * Identifier (ID) of the directory for which you want to retrieve the IP addresses.
1415 */
1416 DirectoryId: DirectoryId;
1417 /**
1418 * The ListIpRoutes.NextToken value from a previous call to ListIpRoutes. Pass null if this is the first call.
1419 */
1420 NextToken?: NextToken;
1421 /**
1422 * Maximum number of items to return. If this value is zero, the maximum number of items is specified by the limitations of the operation.
1423 */
1424 Limit?: Limit;
1425 }
1426 export interface ListIpRoutesResult {
1427 /**
1428 * A list of IpRoutes.
1429 */
1430 IpRoutesInfo?: IpRoutesInfo;
1431 /**
1432 * 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.
1433 */
1434 NextToken?: NextToken;
1435 }
1436 export interface ListLogSubscriptionsRequest {
1437 /**
1438 * 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.
1439 */
1440 DirectoryId?: DirectoryId;
1441 /**
1442 * The token for the next set of items to return.
1443 */
1444 NextToken?: NextToken;
1445 /**
1446 * The maximum number of items returned.
1447 */
1448 Limit?: Limit;
1449 }
1450 export interface ListLogSubscriptionsResult {
1451 /**
1452 * A list of active LogSubscription objects for calling the AWS account.
1453 */
1454 LogSubscriptions?: LogSubscriptions;
1455 /**
1456 * The token for the next set of items to return.
1457 */
1458 NextToken?: NextToken;
1459 }
1460 export interface ListSchemaExtensionsRequest {
1461 /**
1462 * The identifier of the directory from which to retrieve the schema extension information.
1463 */
1464 DirectoryId: DirectoryId;
1465 /**
1466 * The ListSchemaExtensions.NextToken value from a previous call to ListSchemaExtensions. Pass null if this is the first call.
1467 */
1468 NextToken?: NextToken;
1469 /**
1470 * The maximum number of items to return.
1471 */
1472 Limit?: Limit;
1473 }
1474 export interface ListSchemaExtensionsResult {
1475 /**
1476 * Information about the schema extensions applied to the directory.
1477 */
1478 SchemaExtensionsInfo?: SchemaExtensionsInfo;
1479 /**
1480 * 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.
1481 */
1482 NextToken?: NextToken;
1483 }
1484 export interface ListTagsForResourceRequest {
1485 /**
1486 * Identifier (ID) of the directory for which you want to retrieve tags.
1487 */
1488 ResourceId: ResourceId;
1489 /**
1490 * Reserved for future use.
1491 */
1492 NextToken?: NextToken;
1493 /**
1494 * Reserved for future use.
1495 */
1496 Limit?: Limit;
1497 }
1498 export interface ListTagsForResourceResult {
1499 /**
1500 * List of tags returned by the ListTagsForResource operation.
1501 */
1502 Tags?: Tags;
1503 /**
1504 * Reserved for future use.
1505 */
1506 NextToken?: NextToken;
1507 }
1508 export type LogGroupName = string;
1509 export interface LogSubscription {
1510 /**
1511 * Identifier (ID) of the directory that you want to associate with the log subscription.
1512 */
1513 DirectoryId?: DirectoryId;
1514 /**
1515 * The name of the log group.
1516 */
1517 LogGroupName?: LogGroupName;
1518 /**
1519 * The date and time that the log subscription was created.
1520 */
1521 SubscriptionCreatedDateTime?: SubscriptionCreatedDateTime;
1522 }
1523 export type LogSubscriptions = LogSubscription[];
1524 export type ManualSnapshotsLimitReached = boolean;
1525 export type NextToken = string;
1526 export type Notes = string;
1527 export type OrganizationalUnitDN = string;
1528 export interface OwnerDirectoryDescription {
1529 /**
1530 * Identifier of the AWS Managed Microsoft AD directory in the directory owner account.
1531 */
1532 DirectoryId?: DirectoryId;
1533 /**
1534 * Identifier of the directory owner account.
1535 */
1536 AccountId?: CustomerId;
1537 /**
1538 * IP address of the directory’s domain controllers.
1539 */
1540 DnsIpAddrs?: DnsIpAddrs;
1541 /**
1542 * Information about the VPC settings for the directory.
1543 */
1544 VpcSettings?: DirectoryVpcSettingsDescription;
1545 /**
1546 * A RadiusSettings object that contains information about the RADIUS server.
1547 */
1548 RadiusSettings?: RadiusSettings;
1549 /**
1550 * Information about the status of the RADIUS server.
1551 */
1552 RadiusStatus?: RadiusStatus;
1553 }
1554 export type Password = string;
1555 export type PortNumber = number;
1556 export type RadiusAuthenticationProtocol = "PAP"|"CHAP"|"MS-CHAPv1"|"MS-CHAPv2"|string;
1557 export type RadiusDisplayLabel = string;
1558 export type RadiusRetries = number;
1559 export interface RadiusSettings {
1560 /**
1561 * An array of strings that contains the IP addresses of the RADIUS server endpoints, or the IP addresses of your RADIUS server load balancer.
1562 */
1563 RadiusServers?: Servers;
1564 /**
1565 * 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.
1566 */
1567 RadiusPort?: PortNumber;
1568 /**
1569 * The amount of time, in seconds, to wait for the RADIUS server to respond.
1570 */
1571 RadiusTimeout?: RadiusTimeout;
1572 /**
1573 * The maximum number of times that communication with the RADIUS server is attempted.
1574 */
1575 RadiusRetries?: RadiusRetries;
1576 /**
1577 * Required for enabling RADIUS on the directory.
1578 */
1579 SharedSecret?: RadiusSharedSecret;
1580 /**
1581 * The protocol specified for your RADIUS endpoints.
1582 */
1583 AuthenticationProtocol?: RadiusAuthenticationProtocol;
1584 /**
1585 * Not currently used.
1586 */
1587 DisplayLabel?: RadiusDisplayLabel;
1588 /**
1589 * Not currently used.
1590 */
1591 UseSameUsername?: UseSameUsername;
1592 }
1593 export type RadiusSharedSecret = string;
1594 export type RadiusStatus = "Creating"|"Completed"|"Failed"|string;
1595 export type RadiusTimeout = number;
1596 export interface RegisterEventTopicRequest {
1597 /**
1598 * The Directory ID that will publish status messages to the SNS topic.
1599 */
1600 DirectoryId: DirectoryId;
1601 /**
1602 * 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.
1603 */
1604 TopicName: TopicName;
1605 }
1606 export interface RegisterEventTopicResult {
1607 }
1608 export interface RejectSharedDirectoryRequest {
1609 /**
1610 * Identifier of the shared directory in the directory consumer account. This identifier is different for each directory owner account.
1611 */
1612 SharedDirectoryId: DirectoryId;
1613 }
1614 export interface RejectSharedDirectoryResult {
1615 /**
1616 * Identifier of the shared directory in the directory consumer account.
1617 */
1618 SharedDirectoryId?: DirectoryId;
1619 }
1620 export type RemoteDomainName = string;
1621 export type RemoteDomainNames = RemoteDomainName[];
1622 export interface RemoveIpRoutesRequest {
1623 /**
1624 * Identifier (ID) of the directory from which you want to remove the IP addresses.
1625 */
1626 DirectoryId: DirectoryId;
1627 /**
1628 * IP address blocks that you want to remove.
1629 */
1630 CidrIps: CidrIps;
1631 }
1632 export interface RemoveIpRoutesResult {
1633 }
1634 export interface RemoveTagsFromResourceRequest {
1635 /**
1636 * Identifier (ID) of the directory from which to remove the tag.
1637 */
1638 ResourceId: ResourceId;
1639 /**
1640 * The tag key (name) of the tag to be removed.
1641 */
1642 TagKeys: TagKeys;
1643 }
1644 export interface RemoveTagsFromResourceResult {
1645 }
1646 export type ReplicationScope = "Domain"|string;
1647 export type RequestId = string;
1648 export interface ResetUserPasswordRequest {
1649 /**
1650 * Identifier of the AWS Managed Microsoft AD or Simple AD directory in which the user resides.
1651 */
1652 DirectoryId: DirectoryId;
1653 /**
1654 * The user name of the user whose password will be reset.
1655 */
1656 UserName: CustomerUserName;
1657 /**
1658 * The new password that will be reset.
1659 */
1660 NewPassword: UserPassword;
1661 }
1662 export interface ResetUserPasswordResult {
1663 }
1664 export type ResourceId = string;
1665 export interface RestoreFromSnapshotRequest {
1666 /**
1667 * The identifier of the snapshot to restore from.
1668 */
1669 SnapshotId: SnapshotId;
1670 }
1671 export interface RestoreFromSnapshotResult {
1672 }
1673 export type SID = string;
1674 export type SchemaExtensionId = string;
1675 export interface SchemaExtensionInfo {
1676 /**
1677 * The identifier of the directory to which the schema extension is applied.
1678 */
1679 DirectoryId?: DirectoryId;
1680 /**
1681 * The identifier of the schema extension.
1682 */
1683 SchemaExtensionId?: SchemaExtensionId;
1684 /**
1685 * A description of the schema extension.
1686 */
1687 Description?: Description;
1688 /**
1689 * The current status of the schema extension.
1690 */
1691 SchemaExtensionStatus?: SchemaExtensionStatus;
1692 /**
1693 * The reason for the SchemaExtensionStatus.
1694 */
1695 SchemaExtensionStatusReason?: SchemaExtensionStatusReason;
1696 /**
1697 * The date and time that the schema extension started being applied to the directory.
1698 */
1699 StartDateTime?: StartDateTime;
1700 /**
1701 * The date and time that the schema extension was completed.
1702 */
1703 EndDateTime?: EndDateTime;
1704 }
1705 export type SchemaExtensionStatus = "Initializing"|"CreatingSnapshot"|"UpdatingSchema"|"Replicating"|"CancelInProgress"|"RollbackInProgress"|"Cancelled"|"Failed"|"Completed"|string;
1706 export type SchemaExtensionStatusReason = string;
1707 export type SchemaExtensionsInfo = SchemaExtensionInfo[];
1708 export type SecurityGroupId = string;
1709 export type SelectiveAuth = "Enabled"|"Disabled"|string;
1710 export type Server = string;
1711 export type Servers = Server[];
1712 export interface ShareDirectoryRequest {
1713 /**
1714 * Identifier of the AWS Managed Microsoft AD directory that you want to share with other AWS accounts.
1715 */
1716 DirectoryId: DirectoryId;
1717 /**
1718 * 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.
1719 */
1720 ShareNotes?: Notes;
1721 /**
1722 * Identifier for the directory consumer account with whom the directory is to be shared.
1723 */
1724 ShareTarget: ShareTarget;
1725 /**
1726 * 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).
1727 */
1728 ShareMethod: ShareMethod;
1729 }
1730 export interface ShareDirectoryResult {
1731 /**
1732 * Identifier of the directory that is stored in the directory consumer account that is shared from the specified directory (DirectoryId).
1733 */
1734 SharedDirectoryId?: DirectoryId;
1735 }
1736 export type ShareMethod = "ORGANIZATIONS"|"HANDSHAKE"|string;
1737 export type ShareStatus = "Shared"|"PendingAcceptance"|"Rejected"|"Rejecting"|"RejectFailed"|"Sharing"|"ShareFailed"|"Deleted"|"Deleting"|string;
1738 export interface ShareTarget {
1739 /**
1740 * Identifier of the directory consumer account.
1741 */
1742 Id: TargetId;
1743 /**
1744 * Type of identifier to be used in the Id field.
1745 */
1746 Type: TargetType;
1747 }
1748 export type SharedDirectories = SharedDirectory[];
1749 export interface SharedDirectory {
1750 /**
1751 * Identifier of the directory owner account, which contains the directory that has been shared to the consumer account.
1752 */
1753 OwnerAccountId?: CustomerId;
1754 /**
1755 * Identifier of the directory in the directory owner account.
1756 */
1757 OwnerDirectoryId?: DirectoryId;
1758 /**
1759 * 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).
1760 */
1761 ShareMethod?: ShareMethod;
1762 /**
1763 * Identifier of the directory consumer account that has access to the shared directory (OwnerDirectoryId) in the directory owner account.
1764 */
1765 SharedAccountId?: CustomerId;
1766 /**
1767 * Identifier of the shared directory in the directory consumer account. This identifier is different for each directory owner account.
1768 */
1769 SharedDirectoryId?: DirectoryId;
1770 /**
1771 * Current directory status of the shared AWS Managed Microsoft AD directory.
1772 */
1773 ShareStatus?: ShareStatus;
1774 /**
1775 * 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.
1776 */
1777 ShareNotes?: Notes;
1778 /**
1779 * The date and time that the shared directory was created.
1780 */
1781 CreatedDateTime?: CreatedDateTime;
1782 /**
1783 * The date and time that the shared directory was last updated.
1784 */
1785 LastUpdatedDateTime?: LastUpdatedDateTime;
1786 }
1787 export interface Snapshot {
1788 /**
1789 * The directory identifier.
1790 */
1791 DirectoryId?: DirectoryId;
1792 /**
1793 * The snapshot identifier.
1794 */
1795 SnapshotId?: SnapshotId;
1796 /**
1797 * The snapshot type.
1798 */
1799 Type?: SnapshotType;
1800 /**
1801 * The descriptive name of the snapshot.
1802 */
1803 Name?: SnapshotName;
1804 /**
1805 * The snapshot status.
1806 */
1807 Status?: SnapshotStatus;
1808 /**
1809 * The date and time that the snapshot was taken.
1810 */
1811 StartTime?: StartTime;
1812 }
1813 export type SnapshotId = string;
1814 export type SnapshotIds = SnapshotId[];
1815 export interface SnapshotLimits {
1816 /**
1817 * The maximum number of manual snapshots allowed.
1818 */
1819 ManualSnapshotsLimit?: Limit;
1820 /**
1821 * The current number of manual snapshots of the directory.
1822 */
1823 ManualSnapshotsCurrentCount?: Limit;
1824 /**
1825 * Indicates if the manual snapshot limit has been reached.
1826 */
1827 ManualSnapshotsLimitReached?: ManualSnapshotsLimitReached;
1828 }
1829 export type SnapshotName = string;
1830 export type SnapshotStatus = "Creating"|"Completed"|"Failed"|string;
1831 export type SnapshotType = "Auto"|"Manual"|string;
1832 export type Snapshots = Snapshot[];
1833 export type SsoEnabled = boolean;
1834 export type StageReason = string;
1835 export type StartDateTime = Date;
1836 export interface StartSchemaExtensionRequest {
1837 /**
1838 * The identifier of the directory for which the schema extension will be applied to.
1839 */
1840 DirectoryId: DirectoryId;
1841 /**
1842 * If true, creates a snapshot of the directory before applying the schema extension.
1843 */
1844 CreateSnapshotBeforeSchemaExtension: CreateSnapshotBeforeSchemaExtension;
1845 /**
1846 * 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.
1847 */
1848 LdifContent: LdifContent;
1849 /**
1850 * A description of the schema extension.
1851 */
1852 Description: Description;
1853 }
1854 export interface StartSchemaExtensionResult {
1855 /**
1856 * The identifier of the schema extension that will be applied.
1857 */
1858 SchemaExtensionId?: SchemaExtensionId;
1859 }
1860 export type StartTime = Date;
1861 export type StateLastUpdatedDateTime = Date;
1862 export type SubnetId = string;
1863 export type SubnetIds = SubnetId[];
1864 export type SubscriptionCreatedDateTime = Date;
1865 export interface Tag {
1866 /**
1867 * 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}_.:/=+\\-]*)$").
1868 */
1869 Key: TagKey;
1870 /**
1871 * 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}_.:/=+\\-]*)$").
1872 */
1873 Value: TagValue;
1874 }
1875 export type TagKey = string;
1876 export type TagKeys = TagKey[];
1877 export type TagValue = string;
1878 export type Tags = Tag[];
1879 export type TargetId = string;
1880 export type TargetType = "ACCOUNT"|string;
1881 export type TopicArn = string;
1882 export type TopicName = string;
1883 export type TopicNames = TopicName[];
1884 export type TopicStatus = "Registered"|"Topic not found"|"Failed"|"Deleted"|string;
1885 export interface Trust {
1886 /**
1887 * The Directory ID of the AWS directory involved in the trust relationship.
1888 */
1889 DirectoryId?: DirectoryId;
1890 /**
1891 * The unique ID of the trust relationship.
1892 */
1893 TrustId?: TrustId;
1894 /**
1895 * The Fully Qualified Domain Name (FQDN) of the external domain involved in the trust relationship.
1896 */
1897 RemoteDomainName?: RemoteDomainName;
1898 /**
1899 * The trust relationship type. Forest is the default.
1900 */
1901 TrustType?: TrustType;
1902 /**
1903 * The trust relationship direction.
1904 */
1905 TrustDirection?: TrustDirection;
1906 /**
1907 * The trust relationship state.
1908 */
1909 TrustState?: TrustState;
1910 /**
1911 * The date and time that the trust relationship was created.
1912 */
1913 CreatedDateTime?: CreatedDateTime;
1914 /**
1915 * The date and time that the trust relationship was last updated.
1916 */
1917 LastUpdatedDateTime?: LastUpdatedDateTime;
1918 /**
1919 * The date and time that the TrustState was last updated.
1920 */
1921 StateLastUpdatedDateTime?: StateLastUpdatedDateTime;
1922 /**
1923 * The reason for the TrustState.
1924 */
1925 TrustStateReason?: TrustStateReason;
1926 /**
1927 * Current state of selective authentication for the trust.
1928 */
1929 SelectiveAuth?: SelectiveAuth;
1930 }
1931 export type TrustDirection = "One-Way: Outgoing"|"One-Way: Incoming"|"Two-Way"|string;
1932 export type TrustId = string;
1933 export type TrustIds = TrustId[];
1934 export type TrustPassword = string;
1935 export type TrustState = "Creating"|"Created"|"Verifying"|"VerifyFailed"|"Verified"|"Updating"|"UpdateFailed"|"Updated"|"Deleting"|"Deleted"|"Failed"|string;
1936 export type TrustStateReason = string;
1937 export type TrustType = "Forest"|"External"|string;
1938 export type Trusts = Trust[];
1939 export interface UnshareDirectoryRequest {
1940 /**
1941 * The identifier of the AWS Managed Microsoft AD directory that you want to stop sharing.
1942 */
1943 DirectoryId: DirectoryId;
1944 /**
1945 * Identifier for the directory consumer account with whom the directory has to be unshared.
1946 */
1947 UnshareTarget: UnshareTarget;
1948 }
1949 export interface UnshareDirectoryResult {
1950 /**
1951 * Identifier of the directory stored in the directory consumer account that is to be unshared from the specified directory (DirectoryId).
1952 */
1953 SharedDirectoryId?: DirectoryId;
1954 }
1955 export interface UnshareTarget {
1956 /**
1957 * Identifier of the directory consumer account.
1958 */
1959 Id: TargetId;
1960 /**
1961 * Type of identifier to be used in the Id field.
1962 */
1963 Type: TargetType;
1964 }
1965 export interface UpdateConditionalForwarderRequest {
1966 /**
1967 * The directory ID of the AWS directory for which to update the conditional forwarder.
1968 */
1969 DirectoryId: DirectoryId;
1970 /**
1971 * The fully qualified domain name (FQDN) of the remote domain with which you will set up a trust relationship.
1972 */
1973 RemoteDomainName: RemoteDomainName;
1974 /**
1975 * The updated IP addresses of the remote DNS server associated with the conditional forwarder.
1976 */
1977 DnsIpAddrs: DnsIpAddrs;
1978 }
1979 export interface UpdateConditionalForwarderResult {
1980 }
1981 export interface UpdateNumberOfDomainControllersRequest {
1982 /**
1983 * Identifier of the directory to which the domain controllers will be added or removed.
1984 */
1985 DirectoryId: DirectoryId;
1986 /**
1987 * The number of domain controllers desired in the directory.
1988 */
1989 DesiredNumber: DesiredNumberOfDomainControllers;
1990 }
1991 export interface UpdateNumberOfDomainControllersResult {
1992 }
1993 export interface UpdateRadiusRequest {
1994 /**
1995 * The identifier of the directory for which to update the RADIUS server information.
1996 */
1997 DirectoryId: DirectoryId;
1998 /**
1999 * A RadiusSettings object that contains information about the RADIUS server.
2000 */
2001 RadiusSettings: RadiusSettings;
2002 }
2003 export interface UpdateRadiusResult {
2004 }
2005 export type UpdateSecurityGroupForDirectoryControllers = boolean;
2006 export interface UpdateTrustRequest {
2007 /**
2008 * Identifier of the trust relationship.
2009 */
2010 TrustId: TrustId;
2011 /**
2012 * Updates selective authentication for the trust.
2013 */
2014 SelectiveAuth?: SelectiveAuth;
2015 }
2016 export interface UpdateTrustResult {
2017 RequestId?: RequestId;
2018 /**
2019 * Identifier of the trust relationship.
2020 */
2021 TrustId?: TrustId;
2022 }
2023 export type UseSameUsername = boolean;
2024 export type UserName = string;
2025 export type UserPassword = string;
2026 export interface VerifyTrustRequest {
2027 /**
2028 * The unique Trust ID of the trust relationship to verify.
2029 */
2030 TrustId: TrustId;
2031 }
2032 export interface VerifyTrustResult {
2033 /**
2034 * The unique Trust ID of the trust relationship that was verified.
2035 */
2036 TrustId?: TrustId;
2037 }
2038 export type VpcId = string;
2039 /**
2040 * 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.
2041 */
2042 export type apiVersion = "2015-04-16"|"latest"|string;
2043 export interface ClientApiVersions {
2044 /**
2045 * 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.
2046 */
2047 apiVersion?: apiVersion;
2048 }
2049 export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions;
2050 /**
2051 * Contains interfaces for use with the DirectoryService client.
2052 */
2053 export import Types = DirectoryService;
2054}
2055export = DirectoryService;