UNPKG

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