Method Detail

setEndpoint

Overrides the default endpoint for this client ("https://ds.us-east-1.amazonaws.com"). Callers can use this
method to control which AWS region they want to work with.

Callers can pass in just the endpoint (ex: "ds.us-east-1.amazonaws.com") or a full URL, including the protocol
(ex: "https://ds.us-east-1.amazonaws.com"). If the protocol is not specified here, the default protocol from this
client's ClientConfiguration will be used, which by default is HTTPS.

This method is not threadsafe. An endpoint should be configured when the client is created and before any
service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in
transit or retrying.

endpoint - The endpoint (ex: "ds.us-east-1.amazonaws.com") or a full URL, including the protocol (ex:
"https://ds.us-east-1.amazonaws.com") of the region specific AWS endpoint this client will communicate
with.

setRegion

An alternative to AWSDirectoryService.setEndpoint(String), sets the regional endpoint for this client's
service calls. Callers can use this method to control which AWS region they want to work with.

By default, all service endpoints in all regions use the https protocol. To use http instead, specify it in the
ClientConfiguration supplied at construction.

This method is not threadsafe. A region should be configured when the client is created and before any service
requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit
or retrying.

addIpRoutes

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.

cancelSchemaExtension

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.

createConditionalForwarder

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.

request - Initiates the creation of a conditional forwarder for your AWS Directory Service for Microsoft Active
Directory. Conditional forwarders are required in order to set up a trust relationship with another
domain.

Returns:

Result of the CreateConditionalForwarder operation returned by the service.

createTrust

AWS Directory Service for Microsoft Active Directory allows you to configure trust relationships. For example,
you can establish a trust between your Microsoft AD in the AWS cloud, 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 a Microsoft AD in the AWS
cloud and an external domain.

request - AWS Directory Service for Microsoft Active Directory allows you to configure trust relationships. For
example, you can establish a trust between your Microsoft AD in the AWS cloud, 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 a Microsoft AD in the
AWS cloud and an external domain.

describeDirectories

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.

describeSnapshots

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.

request - Describes the trust relationships for a particular Microsoft AD in the AWS cloud. If no input parameters
are are provided, such as directory ID or trust ID, this request describes all the trust relationships.

registerEventTopic

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.

restoreFromSnapshot

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.

updateNumberOfDomainControllers

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.

shutdown

Shuts down this client object, releasing any resources that might be held open. This is an optional method, and
callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client
has been shutdown, it should not be used to make any more requests.

getCachedResponseMetadata

Returns additional metadata for a previously executed successful request, typically used for debugging issues
where a service isn't acting as expected. This data isn't considered part of the result data returned by an
operation, so it's available through this separate, diagnostic interface.

Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic
information for an executed request, you should use this method to retrieve it as soon as possible after
executing a request.