AWSDirectoryServiceClient (AWS SDK for Java

java.lang.Object
- com.amazonaws.AmazonWebServiceClient
- - com.amazonaws.services.directory.AWSDirectoryServiceClient

All Implemented Interfaces:

AWSDirectoryService

Direct Known Subclasses:

AWSDirectoryServiceAsyncClient
```
@ThreadSafe
 @Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AWSDirectoryServiceClient
extends AmazonWebServiceClient
implements AWSDirectoryService
```
Client for accessing Directory Service. All service calls made using this client are blocking, and will not return until the service call completes.
Directory Service
Directory Service is a web service that makes it easy for you to setup and run directories in the Amazon Web Services cloud, or connect your Amazon Web Services resources with an existing self-managed Microsoft Active Directory. This guide provides detailed information about Directory Service operations, data types, parameters, and errors. For information about Directory Services features, see Directory Service and the Directory Service Administration Guide.

Amazon Web Services provides SDKs that consist of libraries and sample code for various programming languages and platforms (Java, Ruby, .Net, iOS, Android, etc.). The SDKs provide a convenient way to create programmatic access to Directory Service and other Amazon Web Services services. For more information about the Amazon Web Services SDKs, including how to download and install them, see Tools for Amazon Web Services.

Field Summary
- Fields inherited from class com.amazonaws.AmazonWebServiceClient
  LOGGING_AWS_REQUEST_METRIC
- Fields inherited from interface com.amazonaws.services.directory.AWSDirectoryService
  ENDPOINT_PREFIX

Constructor Summary

Constructors
Constructor and Description
`AWSDirectoryServiceClient()` Deprecated. use `AWSDirectoryServiceClientBuilder.defaultClient()`
`AWSDirectoryServiceClient(AWSCredentials awsCredentials)` Deprecated. use `AwsClientBuilder.withCredentials(AWSCredentialsProvider)` for example: `AWSDirectoryServiceClientBuilder.standard().withCredentials(new AWSStaticCredentialsProvider(awsCredentials)).build();`
`AWSDirectoryServiceClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration)` Deprecated. use `AwsClientBuilder.withCredentials(AWSCredentialsProvider)` and `AwsClientBuilder.withClientConfiguration(ClientConfiguration)`
`AWSDirectoryServiceClient(AWSCredentialsProvider awsCredentialsProvider)` Deprecated. use `AwsClientBuilder.withCredentials(AWSCredentialsProvider)`
`AWSDirectoryServiceClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration)` Deprecated. use `AwsClientBuilder.withCredentials(AWSCredentialsProvider)` and `AwsClientBuilder.withClientConfiguration(ClientConfiguration)`
`AWSDirectoryServiceClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, RequestMetricCollector requestMetricCollector)` Deprecated. use `AwsClientBuilder.withCredentials(AWSCredentialsProvider)` and `AwsClientBuilder.withClientConfiguration(ClientConfiguration)` and `AwsClientBuilder.withMetricsCollector(RequestMetricCollector)`
`AWSDirectoryServiceClient(ClientConfiguration clientConfiguration)` Deprecated. use `AwsClientBuilder.withClientConfiguration(ClientConfiguration)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AcceptSharedDirectoryResult`	`acceptSharedDirectory(AcceptSharedDirectoryRequest request)` Accepts a directory sharing request that was sent from the directory owner account.
`AddIpRoutesResult`	`addIpRoutes(AddIpRoutesRequest request)` If the DNS server for your self-managed 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.
`AddRegionResult`	`addRegion(AddRegionRequest request)` Adds two domain controllers in the specified Region for the specified directory.
`AddTagsToResourceResult`	`addTagsToResource(AddTagsToResourceRequest request)` Adds or overwrites one or more tags for the specified directory.
`static AWSDirectoryServiceClientBuilder`	`builder()`
`CancelSchemaExtensionResult`	`cancelSchemaExtension(CancelSchemaExtensionRequest request)` Cancels an in-progress schema extension to a Microsoft AD directory.
`ConnectDirectoryResult`	`connectDirectory(ConnectDirectoryRequest request)` Creates an AD Connector to connect to a self-managed directory.
`CreateAliasResult`	`createAlias(CreateAliasRequest request)` Creates an alias for a directory and assigns the alias to the directory.
`CreateComputerResult`	`createComputer(CreateComputerRequest request)` Creates an Active Directory computer object in the specified directory.
`CreateConditionalForwarderResult`	`createConditionalForwarder(CreateConditionalForwarderRequest request)` Creates a conditional forwarder associated with your Amazon Web Services directory.
`CreateDirectoryResult`	`createDirectory(CreateDirectoryRequest request)` Creates a Simple AD directory.
`CreateLogSubscriptionResult`	`createLogSubscription(CreateLogSubscriptionRequest request)` Creates a subscription to forward real-time Directory Service domain controller security logs to the specified Amazon CloudWatch log group in your Amazon Web Services account.
`CreateMicrosoftADResult`	`createMicrosoftAD(CreateMicrosoftADRequest request)` Creates a Microsoft AD directory in the Amazon Web Services Cloud.
`CreateSnapshotResult`	`createSnapshot(CreateSnapshotRequest request)` Creates a snapshot of a Simple AD or Microsoft AD directory in the Amazon Web Services cloud.
`CreateTrustResult`	`createTrust(CreateTrustRequest request)` Directory Service for Microsoft Active Directory allows you to configure trust relationships.
`DeleteConditionalForwarderResult`	`deleteConditionalForwarder(DeleteConditionalForwarderRequest request)` Deletes a conditional forwarder that has been set up for your Amazon Web Services directory.
`DeleteDirectoryResult`	`deleteDirectory(DeleteDirectoryRequest request)` Deletes an Directory Service directory.
`DeleteLogSubscriptionResult`	`deleteLogSubscription(DeleteLogSubscriptionRequest request)` Deletes the specified log subscription.
`DeleteSnapshotResult`	`deleteSnapshot(DeleteSnapshotRequest request)` Deletes a directory snapshot.
`DeleteTrustResult`	`deleteTrust(DeleteTrustRequest request)` Deletes an existing trust relationship between your Managed Microsoft AD directory and an external domain.
`DeregisterCertificateResult`	`deregisterCertificate(DeregisterCertificateRequest request)` Deletes from the system the certificate that was registered for secure LDAP or client certificate authentication.
`DeregisterEventTopicResult`	`deregisterEventTopic(DeregisterEventTopicRequest request)` Removes the specified directory as a publisher to the specified Amazon SNS topic.
`DescribeCertificateResult`	`describeCertificate(DescribeCertificateRequest request)` Displays information about the certificate registered for secure LDAP or client certificate authentication.
`DescribeClientAuthenticationSettingsResult`	`describeClientAuthenticationSettings(DescribeClientAuthenticationSettingsRequest request)` Retrieves information about the type of client authentication for the specified directory, if the type is specified.
`DescribeConditionalForwardersResult`	`describeConditionalForwarders(DescribeConditionalForwardersRequest request)` Obtains information about the conditional forwarders for this account.
`DescribeDirectoriesResult`	`describeDirectories()` Simplified method form for invoking the DescribeDirectories operation.
`DescribeDirectoriesResult`	`describeDirectories(DescribeDirectoriesRequest request)` Obtains information about the directories that belong to this account.
`DescribeDomainControllersResult`	`describeDomainControllers(DescribeDomainControllersRequest request)` Provides information about any domain controllers in your directory.
`DescribeEventTopicsResult`	`describeEventTopics(DescribeEventTopicsRequest request)` Obtains information about which Amazon SNS topics receive status messages from the specified directory.
`DescribeLDAPSSettingsResult`	`describeLDAPSSettings(DescribeLDAPSSettingsRequest request)` Describes the status of LDAP security for the specified directory.
`DescribeRegionsResult`	`describeRegions(DescribeRegionsRequest request)` Provides information about the Regions that are configured for multi-Region replication.
`DescribeSettingsResult`	`describeSettings(DescribeSettingsRequest request)` Retrieves information about the configurable settings for the specified directory.
`DescribeSharedDirectoriesResult`	`describeSharedDirectories(DescribeSharedDirectoriesRequest request)` Returns the shared directories in your account.
`DescribeSnapshotsResult`	`describeSnapshots()` Simplified method form for invoking the DescribeSnapshots operation.
`DescribeSnapshotsResult`	`describeSnapshots(DescribeSnapshotsRequest request)` Obtains information about the directory snapshots that belong to this account.
`DescribeTrustsResult`	`describeTrusts(DescribeTrustsRequest request)` Obtains information about the trust relationships for this account.
`DescribeUpdateDirectoryResult`	`describeUpdateDirectory(DescribeUpdateDirectoryRequest request)` Describes the updates of a directory for a particular update type.
`DisableClientAuthenticationResult`	`disableClientAuthentication(DisableClientAuthenticationRequest request)` Disables alternative client authentication methods for the specified directory.
`DisableLDAPSResult`	`disableLDAPS(DisableLDAPSRequest request)` Deactivates LDAP secure calls for the specified directory.
`DisableRadiusResult`	`disableRadius(DisableRadiusRequest request)` Disables multi-factor authentication (MFA) with the Remote Authentication Dial In User Service (RADIUS) server for an AD Connector or Microsoft AD directory.
`DisableSsoResult`	`disableSso(DisableSsoRequest request)` Disables single-sign on for a directory.
`EnableClientAuthenticationResult`	`enableClientAuthentication(EnableClientAuthenticationRequest request)` Enables alternative client authentication methods for the specified directory.
`EnableLDAPSResult`	`enableLDAPS(EnableLDAPSRequest request)` Activates the switch for the specific directory to always use LDAP secure calls.
`EnableRadiusResult`	`enableRadius(EnableRadiusRequest request)` Enables multi-factor authentication (MFA) with the Remote Authentication Dial In User Service (RADIUS) server for an AD Connector or Microsoft AD directory.
`EnableSsoResult`	`enableSso(EnableSsoRequest request)` Enables single sign-on for a directory.
`ResponseMetadata`	`getCachedResponseMetadata(AmazonWebServiceRequest request)` Returns additional metadata for a previously executed successful, request, typically used for debugging issues where a service isn't acting as expected.
`GetDirectoryLimitsResult`	`getDirectoryLimits()` Simplified method form for invoking the GetDirectoryLimits operation.
`GetDirectoryLimitsResult`	`getDirectoryLimits(GetDirectoryLimitsRequest request)` Obtains directory limit information for the current Region.
`GetSnapshotLimitsResult`	`getSnapshotLimits(GetSnapshotLimitsRequest request)` Obtains the manual snapshot limits for a directory.
`ListCertificatesResult`	`listCertificates(ListCertificatesRequest request)` For the specified directory, lists all the certificates registered for a secure LDAP or client certificate authentication.
`ListIpRoutesResult`	`listIpRoutes(ListIpRoutesRequest request)` Lists the address blocks that you have added to a directory.
`ListLogSubscriptionsResult`	`listLogSubscriptions(ListLogSubscriptionsRequest request)` Lists the active log subscriptions for the Amazon Web Services account.
`ListSchemaExtensionsResult`	`listSchemaExtensions(ListSchemaExtensionsRequest request)` Lists all schema extensions applied to a Microsoft AD Directory.
`ListTagsForResourceResult`	`listTagsForResource(ListTagsForResourceRequest request)` Lists all tags on a directory.
`RegisterCertificateResult`	`registerCertificate(RegisterCertificateRequest request)` Registers a certificate for a secure LDAP or client certificate authentication.
`RegisterEventTopicResult`	`registerEventTopic(RegisterEventTopicRequest request)` Associates a directory with an Amazon SNS topic.
`RejectSharedDirectoryResult`	`rejectSharedDirectory(RejectSharedDirectoryRequest request)` Rejects a directory sharing request that was sent from the directory owner account.
`RemoveIpRoutesResult`	`removeIpRoutes(RemoveIpRoutesRequest request)` Removes IP address blocks from a directory.
`RemoveRegionResult`	`removeRegion(RemoveRegionRequest request)` Stops all replication and removes the domain controllers from the specified Region.
`RemoveTagsFromResourceResult`	`removeTagsFromResource(RemoveTagsFromResourceRequest request)` Removes tags from a directory.
`ResetUserPasswordResult`	`resetUserPassword(ResetUserPasswordRequest request)` Resets the password for any user in your Managed Microsoft AD or Simple AD directory.
`RestoreFromSnapshotResult`	`restoreFromSnapshot(RestoreFromSnapshotRequest request)` Restores a directory using an existing directory snapshot.
`ShareDirectoryResult`	`shareDirectory(ShareDirectoryRequest request)` Shares a specified directory (`DirectoryId`) in your Amazon Web Services account (directory owner) with another Amazon Web Services account (directory consumer).
`void`	`shutdown()` Shuts down this client object, releasing any resources that might be held open.
`StartSchemaExtensionResult`	`startSchemaExtension(StartSchemaExtensionRequest request)` Applies a schema extension to a Microsoft AD directory.
`UnshareDirectoryResult`	`unshareDirectory(UnshareDirectoryRequest request)` Stops the directory sharing between the directory owner and consumer accounts.
`UpdateConditionalForwarderResult`	`updateConditionalForwarder(UpdateConditionalForwarderRequest request)` Updates a conditional forwarder that has been set up for your Amazon Web Services directory.
`UpdateDirectorySetupResult`	`updateDirectorySetup(UpdateDirectorySetupRequest request)` Updates the directory for a particular update type.
`UpdateNumberOfDomainControllersResult`	`updateNumberOfDomainControllers(UpdateNumberOfDomainControllersRequest request)` Adds or removes domain controllers to or from the directory.
`UpdateRadiusResult`	`updateRadius(UpdateRadiusRequest request)` Updates the Remote Authentication Dial In User Service (RADIUS) server information for an AD Connector or Microsoft AD directory.
`UpdateSettingsResult`	`updateSettings(UpdateSettingsRequest request)` Updates the configurable settings for the specified directory.
`UpdateTrustResult`	`updateTrust(UpdateTrustRequest request)` Updates the trust that has been set up between your Managed Microsoft AD directory and an self-managed Active Directory.
`VerifyTrustResult`	`verifyTrust(VerifyTrustRequest request)` Directory Service for Microsoft Active Directory allows you to configure and verify trust relationships.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.amazonaws.services.directory.AWSDirectoryService
setEndpoint, setRegion

- Constructor Detail
  - AWSDirectoryServiceClient
```
@Deprecated
public AWSDirectoryServiceClient()
```
    Deprecated. use AWSDirectoryServiceClientBuilder.defaultClient()
    Constructs a new client to invoke service methods on Directory Service. A credentials provider chain will be used that searches for credentials in this order:
    - Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_KEY
    - Java System Properties - aws.accessKeyId and aws.secretKey
    - Instance profile credentials delivered through the Amazon EC2 metadata service
    All service calls made using this new client object are blocking, and will not return until the service call completes.
    See Also:
    
    DefaultAWSCredentialsProviderChain
  - AWSDirectoryServiceClient
```
@Deprecated
public AWSDirectoryServiceClient(ClientConfiguration clientConfiguration)
```
    Deprecated. use AwsClientBuilder.withClientConfiguration(ClientConfiguration)
    Constructs a new client to invoke service methods on Directory Service. A credentials provider chain will be used that searches for credentials in this order:
    - Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_KEY
    - Java System Properties - aws.accessKeyId and aws.secretKey
    - Instance profile credentials delivered through the Amazon EC2 metadata service
    All service calls made using this new client object are blocking, and will not return until the service call completes.
    Parameters:
    
    clientConfiguration - The client configuration options controlling how this client connects to Directory Service (ex: proxy settings, retry counts, etc.).
    
    See Also:
    
    DefaultAWSCredentialsProviderChain
  - AWSDirectoryServiceClient
```
@Deprecated
public AWSDirectoryServiceClient(AWSCredentials awsCredentials)
```
    Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) for example: AWSDirectoryServiceClientBuilder.standard().withCredentials(new AWSStaticCredentialsProvider(awsCredentials)).build();
    
    Constructs a new client to invoke service methods on Directory Service using the specified AWS account credentials.
    All service calls made using this new client object are blocking, and will not return until the service call completes.
    
    Parameters:
    
    awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.
  - AWSDirectoryServiceClient
```
@Deprecated
public AWSDirectoryServiceClient(AWSCredentials awsCredentials,
                                             ClientConfiguration clientConfiguration)
```
    Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) and AwsClientBuilder.withClientConfiguration(ClientConfiguration)
    
    Constructs a new client to invoke service methods on Directory Service using the specified AWS account credentials and client configuration options.
    All service calls made using this new client object are blocking, and will not return until the service call completes.
    
    Parameters:
    
    awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.
    
    clientConfiguration - The client configuration options controlling how this client connects to Directory Service (ex: proxy settings, retry counts, etc.).
  - AWSDirectoryServiceClient
```
@Deprecated
public AWSDirectoryServiceClient(AWSCredentialsProvider awsCredentialsProvider)
```
    Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider)
    
    Constructs a new client to invoke service methods on Directory Service using the specified AWS account credentials provider.
    All service calls made using this new client object are blocking, and will not return until the service call completes.
    
    Parameters:
    
    awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.
  - AWSDirectoryServiceClient
```
@Deprecated
public AWSDirectoryServiceClient(AWSCredentialsProvider awsCredentialsProvider,
                                             ClientConfiguration clientConfiguration)
```
    Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) and AwsClientBuilder.withClientConfiguration(ClientConfiguration)
    
    Constructs a new client to invoke service methods on Directory Service using the specified AWS account credentials provider and client configuration options.
    All service calls made using this new client object are blocking, and will not return until the service call completes.
    
    Parameters:
    
    awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.
    
    clientConfiguration - The client configuration options controlling how this client connects to Directory Service (ex: proxy settings, retry counts, etc.).
  - AWSDirectoryServiceClient
```
@Deprecated
public AWSDirectoryServiceClient(AWSCredentialsProvider awsCredentialsProvider,
                                             ClientConfiguration clientConfiguration,
                                             RequestMetricCollector requestMetricCollector)
```
    Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) and AwsClientBuilder.withClientConfiguration(ClientConfiguration) and AwsClientBuilder.withMetricsCollector(RequestMetricCollector)
    
    Constructs a new client to invoke service methods on Directory Service using the specified AWS account credentials provider, client configuration options, and request metric collector.
    All service calls made using this new client object are blocking, and will not return until the service call completes.
    
    Parameters:
    
    awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.
    
    clientConfiguration - The client configuration options controlling how this client connects to Directory Service (ex: proxy settings, retry counts, etc.).
    
    requestMetricCollector - optional request metric collector
- Method Detail
  - builder
```
public static AWSDirectoryServiceClientBuilder builder()
```
  - acceptSharedDirectory
```
public AcceptSharedDirectoryResult acceptSharedDirectory(AcceptSharedDirectoryRequest request)
```
    Accepts a directory sharing request that was sent from the directory owner account.
    
    Specified by:
    
    acceptSharedDirectory in interface AWSDirectoryService
    
    Parameters:
    
    acceptSharedDirectoryRequest -
    
    Returns:
    
    Result of the AcceptSharedDirectory operation returned by the service.
    
    Throws:
    
    InvalidParameterException - One or more parameters are not valid.
    
    EntityDoesNotExistException - The specified entity could not be found.
    
    DirectoryAlreadySharedException - The specified directory has already been shared with this Amazon Web Services account.
    
    ClientException - A client exception has occurred.
    
    ServiceException - An exception has occurred in Directory Service.
    
    See Also:
    
    AWS API Documentation
  - addIpRoutes
```
public AddIpRoutesResult addIpRoutes(AddIpRoutesRequest request)
```
    If the DNS server for your self-managed 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 Amazon Web Services 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 Directory Service API Permissions: Actions, Resources, and Conditions Reference.
    
    Specified by:
    
    addIpRoutes in interface AWSDirectoryService
    
    Parameters:
    
    addIpRoutesRequest -
    
    Returns:
    
    Result of the AddIpRoutes operation returned by the service.
    
    Throws:
    
    EntityDoesNotExistException - The specified entity could not be found.
    
    EntityAlreadyExistsException - The specified entity already exists.
    
    InvalidParameterException - One or more parameters are not valid.
    
    DirectoryUnavailableException - The specified directory is unavailable or could not be found.
    
    IpRouteLimitExceededException - The maximum allowed number of IP addresses was exceeded. The default limit is 100 IP address blocks.
    
    ClientException - A client exception has occurred.
    
    ServiceException - An exception has occurred in Directory Service.
    
    See Also:
    
    AWS API Documentation
  - addRegion
```
public AddRegionResult addRegion(AddRegionRequest request)
```
    Adds two domain controllers in the specified Region for the specified directory.
    
    Specified by:
    
    addRegion in interface AWSDirectoryService
    
    Parameters:
    
    addRegionRequest -
    
    Returns:
    
    Result of the AddRegion operation returned by the service.
    
    Throws:
    
    DirectoryUnavailableException - The specified directory is unavailable or could not be found.
    
    InvalidParameterException - One or more parameters are not valid.
    
    EntityDoesNotExistException - The specified entity could not be found.
    
    DirectoryAlreadyInRegionException - The Region you specified is the same Region where the Managed Microsoft AD directory was created. Specify a different Region and try again.
    
    UnsupportedOperationException - The operation is not supported.
    
    DirectoryDoesNotExistException - The specified directory does not exist in the system.
    
    RegionLimitExceededException - You have reached the limit for maximum number of simultaneous Region replications per directory.
    
    AccessDeniedException - Client authentication is not available in this region at this time.
    
    ClientException - A client exception has occurred.
    
    ServiceException - An exception has occurred in Directory Service.
    
    See Also:
    
    AWS API Documentation
  - addTagsToResource
```
public AddTagsToResourceResult addTagsToResource(AddTagsToResourceRequest request)
```
    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.
    
    Specified by:
    
    addTagsToResource in interface AWSDirectoryService
    
    Parameters:
    
    addTagsToResourceRequest -
    
    Returns:
    
    Result of the AddTagsToResource operation returned by the service.
    
    Throws:
    
    EntityDoesNotExistException - The specified entity could not be found.
    
    InvalidParameterException - One or more parameters are not valid.
    
    TagLimitExceededException - The maximum allowed number of tags was exceeded.
    
    ClientException - A client exception has occurred.
    
    ServiceException - An exception has occurred in Directory Service.
    
    See Also:
    
    AWS API Documentation
  - cancelSchemaExtension
```
public CancelSchemaExtensionResult cancelSchemaExtension(CancelSchemaExtensionRequest request)
```
    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.
    
    Specified by:
    
    cancelSchemaExtension in interface AWSDirectoryService
    
    Parameters:
    
    cancelSchemaExtensionRequest -
    
    Returns:
    
    Result of the CancelSchemaExtension operation returned by the service.
    
    Throws:
    
    EntityDoesNotExistException - The specified entity could not be found.
    
    ClientException - A client exception has occurred.
    
    ServiceException - An exception has occurred in Directory Service.
    
    See Also:
    
    AWS API Documentation
  - connectDirectory
```
public ConnectDirectoryResult connectDirectory(ConnectDirectoryRequest request)
```
    Creates an AD Connector to connect to a self-managed 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 Directory Service API Permissions: Actions, Resources, and Conditions Reference.
    
    Specified by:
    
    connectDirectory in interface AWSDirectoryService
    
    Parameters:
    
    connectDirectoryRequest - Contains the inputs for the ConnectDirectory operation.
    
    Returns:
    
    Result of the ConnectDirectory operation returned by the service.
    
    Throws:
    
    DirectoryLimitExceededException - The maximum number of directories in the region has been reached. You can use the GetDirectoryLimits operation to determine your directory limits in the region.
    
    InvalidParameterException - One or more parameters are not valid.
    
    ClientException - A client exception has occurred.
    
    ServiceException - An exception has occurred in Directory Service.
    
    See Also:
    
    AWS API Documentation
  - createAlias
```
public CreateAliasResult createAlias(CreateAliasRequest request)
```
    Creates an alias for a directory and assigns the alias to the directory. The alias is used to construct the access URL for the directory, such as http://<alias>.awsapps.com.
    
    After an alias has been created, it cannot be deleted or reused, so this operation should only be used when absolutely necessary.
    
    Specified by:
    
    createAlias in interface AWSDirectoryService
    
    Parameters:
    
    createAliasRequest - Contains the inputs for the CreateAlias operation.
    
    Returns:
    
    Result of the CreateAlias operation returned by the service.
    
    Throws:
    
    EntityAlreadyExistsException - The specified entity already exists.
    
    EntityDoesNotExistException - The specified entity could not be found.
    
    InvalidParameterException - One or more parameters are not valid.
    
    ClientException - A client exception has occurred.
    
    ServiceException - An exception has occurred in Directory Service.
    
    See Also:
    
    AWS API Documentation
  - createComputer
```
public CreateComputerResult createComputer(CreateComputerRequest request)
```
    Creates an Active Directory computer object in the specified directory.
    
    Specified by:
    
    createComputer in interface AWSDirectoryService
    
    Parameters:
    
    createComputerRequest - Contains the inputs for the CreateComputer operation.
    
    Returns:
    
    Result of the CreateComputer operation returned by the service.
    
    Throws:
    
    AuthenticationFailedException - An authentication error occurred.
    
    DirectoryUnavailableException - The specified directory is unavailable or could not be found.
    
    EntityAlreadyExistsException - The specified entity already exists.
    
    EntityDoesNotExistException - The specified entity could not be found.
    
    InvalidParameterException - One or more parameters are not valid.
    
    UnsupportedOperationException - The operation is not supported.
    
    ClientException - A client exception has occurred.
    
    ServiceException - An exception has occurred in Directory Service.
    
    See Also:
    
    AWS API Documentation
  - createConditionalForwarder
```
public CreateConditionalForwarderResult createConditionalForwarder(CreateConditionalForwarderRequest request)
```
    Creates a conditional forwarder associated with your Amazon Web Services directory. Conditional forwarders are required in order to set up a trust relationship with another domain. The conditional forwarder points to the trusted domain.
    
    Specified by:
    
    createConditionalForwarder in interface AWSDirectoryService
    
    Parameters:
    
    createConditionalForwarderRequest - Initiates the creation of a conditional forwarder for your 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.
    
    Throws:
    
    EntityAlreadyExistsException - The specified entity already exists.
    
    EntityDoesNotExistException - The specified entity could not be found.
    
    DirectoryUnavailableException - The specified directory is unavailable or could not be found.
    
    InvalidParameterException - One or more parameters are not valid.
    
    UnsupportedOperationException - The operation is not supported.
    
    ClientException - A client exception has occurred.
    
    ServiceException - An exception has occurred in Directory Service.
    
    See Also:
    
    AWS API Documentation
  - createDirectory
```
public CreateDirectoryResult createDirectory(CreateDirectoryRequest request)
```
    Creates a Simple AD directory. For more information, see Simple Active Directory in the 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 Directory Service API Permissions: Actions, Resources, and Conditions Reference.
    
    Specified by:
    
    createDirectory in interface AWSDirectoryService
    
    Parameters:
    
    createDirectoryRequest - Contains the inputs for the CreateDirectory operation.
    
    Returns:
    
    Result of the CreateDirectory operation returned by the service.
    
    Throws:
    
    DirectoryLimitExceededException - The maximum number of directories in the region has been reached. You can use the GetDirectoryLimits operation to determine your directory limits in the region.
    
    InvalidParameterException - One or more parameters are not valid.
    
    ClientException - A client exception has occurred.
    
    ServiceException - An exception has occurred in Directory Service.
    
    See Also:
    
    AWS API Documentation
  - createLogSubscription
```
public CreateLogSubscriptionResult createLogSubscription(CreateLogSubscriptionRequest request)
```
    Creates a subscription to forward real-time Directory Service domain controller security logs to the specified Amazon CloudWatch log group in your Amazon Web Services account.
    
    Specified by:
    
    createLogSubscription in interface AWSDirectoryService
    
    Parameters:
    
    createLogSubscriptionRequest -
    
    Returns:
    
    Result of the CreateLogSubscription operation returned by the service.
    
    Throws:
    
    EntityAlreadyExistsException - The specified entity already exists.
    
    EntityDoesNotExistException - The specified entity could not be found.
    
    UnsupportedOperationException - The operation is not supported.
    
    InsufficientPermissionsException - The account does not have sufficient permission to perform the operation.
    
    ClientException - A client exception has occurred.
    
    ServiceException - An exception has occurred in Directory Service.
    
    See Also:
    
    AWS API Documentation
  - createMicrosoftAD
```
public CreateMicrosoftADResult createMicrosoftAD(CreateMicrosoftADRequest request)
```
    Creates a Microsoft AD directory in the Amazon Web Services Cloud. For more information, see Managed Microsoft AD in the 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 Directory Service API Permissions: Actions, Resources, and Conditions Reference.
    
    Specified by:
    
    createMicrosoftAD in interface AWSDirectoryService
    
    Parameters:
    
    createMicrosoftADRequest - Creates an Managed Microsoft AD directory.
    
    Returns:
    
    Result of the CreateMicrosoftAD operation returned by the service.
    
    Throws:
    
    DirectoryLimitExceededException - The maximum number of directories in the region has been reached. You can use the GetDirectoryLimits operation to determine your directory limits in the region.
    
    InvalidParameterException - One or more parameters are not valid.
    
    ClientException - A client exception has occurred.
    
    ServiceException - An exception has occurred in Directory Service.
    
    UnsupportedOperationException - The operation is not supported.
    
    See Also:
    
    AWS API Documentation
  - createSnapshot
```
public CreateSnapshotResult createSnapshot(CreateSnapshotRequest request)
```
    Creates a snapshot of a Simple AD or Microsoft AD directory in the Amazon Web Services cloud.
    
    You cannot take snapshots of AD Connector directories.
    
    Specified by:
    
    createSnapshot in interface AWSDirectoryService
    
    Parameters:
    
    createSnapshotRequest - Contains the inputs for the CreateSnapshot operation.
    
    Returns:
    
    Result of the CreateSnapshot operation returned by the service.
    
    Throws:
    
    EntityDoesNotExistException - The specified entity could not be found.
    
    InvalidParameterException - One or more parameters are not valid.
    
    SnapshotLimitExceededException - The maximum number of manual snapshots for the directory has been reached. You can use the GetSnapshotLimits operation to determine the snapshot limits for a directory.
    
    ClientException - A client exception has occurred.
    
    ServiceException - An exception has occurred in Directory Service.
    
    See Also:
    
    AWS API Documentation
  - createTrust
```
public CreateTrustResult createTrust(CreateTrustRequest request)
```
    Directory Service for Microsoft Active Directory allows you to configure trust relationships. For example, you can establish a trust between your Managed Microsoft AD directory, and your existing self-managed 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 Amazon Web Services side of a trust relationship between an Managed Microsoft AD directory and an external domain. You can create either a forest trust or an external trust.
    
    Specified by:
    
    createTrust in interface AWSDirectoryService
    
    Parameters:
    
    createTrustRequest - Directory Service for Microsoft Active Directory allows you to configure trust relationships. For example, you can establish a trust between your Managed Microsoft AD directory, and your existing self-managed 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 Amazon Web Services side of a trust relationship between an Managed Microsoft AD directory and an external domain.
    
    Returns:
    
    Result of the CreateTrust operation returned by the service.
    
    Throws:
    
    EntityAlreadyExistsException - The specified entity already exists.
    
    EntityDoesNotExistException - The specified entity could not be found.
    
    InvalidParameterException - One or more parameters are not valid.
    
    ClientException - A client exception has occurred.
    
    ServiceException - An exception has occurred in Directory Service.
    
    UnsupportedOperationException - The operation is not supported.
    
    See Also:
    
    AWS API Documentation
  - deleteConditionalForwarder
```
public DeleteConditionalForwarderResult deleteConditionalForwarder(DeleteConditionalForwarderRequest request)
```
    Deletes a conditional forwarder that has been set up for your Amazon Web Services directory.
    
    Specified by:
    
    deleteConditionalForwarder in interface AWSDirectoryService
    
    Parameters:
    
    deleteConditionalForwarderRequest - Deletes a conditional forwarder.
    
    Returns:
    
    Result of the DeleteConditionalForwarder operation returned by the service.
    
    Throws:
    
    EntityDoesNotExistException - The specified entity could not be found.
    
    DirectoryUnavailableException - The specified directory is unavailable or could not be found.
    
    InvalidParameterException - One or more parameters are not valid.
    
    UnsupportedOperationException - The operation is not supported.
    
    ClientException - A client exception has occurred.
    
    ServiceException - An exception has occurred in Directory Service.
    
    See Also:
    
    AWS API Documentation
  - deleteDirectory
```
public DeleteDirectoryResult deleteDirectory(DeleteDirectoryRequest request)
```
    Deletes an 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 Directory Service API Permissions: Actions, Resources, and Conditions Reference.
    
    Specified by:
    
    deleteDirectory in interface AWSDirectoryService
    
    Parameters:
    
    deleteDirectoryRequest - Contains the inputs for the DeleteDirectory operation.
    
    Returns:
    
    Result of the DeleteDirectory operation returned by the service.
    
    Throws:
    
    EntityDoesNotExistException - The specified entity could not be found.
    
    ClientException - A client exception has occurred.
    
    ServiceException - An exception has occurred in Directory Service.
    
    See Also:
    
    AWS API Documentation
  - deleteLogSubscription
```
public DeleteLogSubscriptionResult deleteLogSubscription(DeleteLogSubscriptionRequest request)
```
    Deletes the specified log subscription.
    
    Specified by:
    
    deleteLogSubscription in interface AWSDirectoryService
    
    Parameters:
    
    deleteLogSubscriptionRequest -
    
    Returns:
    
    Result of the DeleteLogSubscription operation returned by the service.
    
    Throws:
    
    EntityDoesNotExistException - The specified entity could not be found.
    
    UnsupportedOperationException - The operation is not supported.
    
    ClientException - A client exception has occurred.
    
    ServiceException - An exception has occurred in Directory Service.
    
    See Also:
    
    AWS API Documentation
  - deleteSnapshot
```
public DeleteSnapshotResult deleteSnapshot(DeleteSnapshotRequest request)
```
    Deletes a directory snapshot.
    
    Specified by:
    
    deleteSnapshot in interface AWSDirectoryService
    
    Parameters:
    
    deleteSnapshotRequest - Contains the inputs for the DeleteSnapshot operation.
    
    Returns:
    
    Result of the DeleteSnapshot operation returned by the service.
    
    Throws:
    
    EntityDoesNotExistException - The specified entity could not be found.
    
    InvalidParameterException - One or more parameters are not valid.
    
    ClientException - A client exception has occurred.
    
    ServiceException - An exception has occurred in Directory Service.
    
    See Also:
    
    AWS API Documentation
  - deleteTrust
```
public DeleteTrustResult deleteTrust(DeleteTrustRequest request)
```
    Deletes an existing trust relationship between your Managed Microsoft AD directory and an external domain.
    
    Specified by:
    
    deleteTrust in interface AWSDirectoryService
    
    Parameters:
    
    deleteTrustRequest - Deletes the local side of an existing trust relationship between the Managed Microsoft AD directory and the external domain.
    
    Returns:
    
    Result of the DeleteTrust operation returned by the service.
    
    Throws:
    
    EntityDoesNotExistException - The specified entity could not be found.
    
    InvalidParameterException - One or more parameters are not valid.
    
    ClientException - A client exception has occurred.
    
    ServiceException - An exception has occurred in Directory Service.
    
    UnsupportedOperationException - The operation is not supported.
    
    See Also:
    
    AWS API Documentation
  - deregisterCertificate
```
public DeregisterCertificateResult deregisterCertificate(DeregisterCertificateRequest request)
```
    Deletes from the system the certificate that was registered for secure LDAP or client certificate authentication.
    
    Specified by:
    
    deregisterCertificate in interface AWSDirectoryService
    
    Parameters:
    
    deregisterCertificateRequest -
    
    Returns:
    
    Result of the DeregisterCertificate operation returned by the service.
    
    Throws:
    
    DirectoryUnavailableException - The specified directory is unavailable or could not be found.
    
    DirectoryDoesNotExistException - The specified directory does not exist in the system.
    
    CertificateDoesNotExistException - The certificate is not present in the system for describe or deregister activities.
    
    CertificateInUseException - The certificate is being used for the LDAP security connection and cannot be removed without disabling LDAP security.
    
    UnsupportedOperationException - The operation is not supported.
    
    InvalidParameterException - One or more parameters are not valid.
    
    ClientException - A client exception has occurred.
    
    ServiceException - An exception has occurred in Directory Service.
    
    See Also:
    
    AWS API Documentation
  - deregisterEventTopic
```
public DeregisterEventTopicResult deregisterEventTopic(DeregisterEventTopicRequest request)
```
    Removes the specified directory as a publisher to the specified Amazon SNS topic.
    
    Specified by:
    
    deregisterEventTopic in interface AWSDirectoryService
    
    Parameters:
    
    deregisterEventTopicRequest - Removes the specified directory as a publisher to the specified Amazon SNS topic.
    
    Returns:
    
    Result of the DeregisterEventTopic operation returned by the service.
    
    Throws:
    
    EntityDoesNotExistException - The specified entity could not be found.
    
    InvalidParameterException - One or more parameters are not valid.
    
    ClientException - A client exception has occurred.
    
    ServiceException - An exception has occurred in Directory Service.
    
    See Also:
    
    AWS API Documentation
  - describeCertificate
```
public DescribeCertificateResult describeCertificate(DescribeCertificateRequest request)
```
    Displays information about the certificate registered for secure LDAP or client certificate authentication.
    
    Specified by:
    
    describeCertificate in interface AWSDirectoryService
    
    Parameters:
    
    describeCertificateRequest -
    
    Returns:
    
    Result of the DescribeCertificate operation returned by the service.
    
    Throws:
    
    DirectoryDoesNotExistException - The specified directory does not exist in the system.
    
    UnsupportedOperationException - The operation is not supported.
    
    CertificateDoesNotExistException - The certificate is not present in the system for describe or deregister activities.
    
    InvalidParameterException - One or more parameters are not valid.
    
    ClientException - A client exception has occurred.
    
    ServiceException - An exception has occurred in Directory Service.
    
    See Also:
    
    AWS API Documentation
  - describeClientAuthenticationSettings
```
public DescribeClientAuthenticationSettingsResult describeClientAuthenticationSettings(DescribeClientAuthenticationSettingsRequest request)
```
    Retrieves information about the type of client authentication for the specified directory, if the type is specified. If no type is specified, information about all client authentication types that are supported for the specified directory is retrieved. Currently, only SmartCard is supported.
    
    Specified by:
    
    describeClientAuthenticationSettings in interface AWSDirectoryService
    
    Parameters:
    
    describeClientAuthenticationSettingsRequest -
    
    Returns:
    
    Result of the DescribeClientAuthenticationSettings operation returned by the service.
    
    Throws:
    
    DirectoryDoesNotExistException - The specified directory does not exist in the system.
    
    UnsupportedOperationException - The operation is not supported.
    
    AccessDeniedException - Client authentication is not available in this region at this time.
    
    InvalidParameterException - One or more parameters are not valid.
    
    ClientException - A client exception has occurred.
    
    ServiceException - An exception has occurred in Directory Service.
    
    See Also:
    
    AWS API Documentation
  - describeConditionalForwarders
```
public DescribeConditionalForwardersResult describeConditionalForwarders(DescribeConditionalForwardersRequest request)
```
    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.
    
    Specified by:
    
    describeConditionalForwarders in interface AWSDirectoryService
    
    Parameters:
    
    describeConditionalForwardersRequest - Describes a conditional forwarder.
    
    Returns:
    
    Result of the DescribeConditionalForwarders operation returned by the service.
    
    Throws:
    
    EntityDoesNotExistException - The specified entity could not be found.
    
    DirectoryUnavailableException - The specified directory is unavailable or could not be found.
    
    InvalidParameterException - One or more parameters are not valid.
    
    UnsupportedOperationException - The operation is not supported.
    
    ClientException - A client exception has occurred.
    
    ServiceException - An exception has occurred in Directory Service.
    
    See Also:
    
    AWS API Documentation
  - describeDirectories
```
public DescribeDirectoriesResult describeDirectories(DescribeDirectoriesRequest request)
```
    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.
    
    Specified by:
    
    describeDirectories in interface AWSDirectoryService
    
    Parameters:
    
    describeDirectoriesRequest - Contains the inputs for the DescribeDirectories operation.
    
    Returns:
    
    Result of the DescribeDirectories operation returned by the service.
    
    Throws:
    
    EntityDoesNotExistException - The specified entity could not be found.
    
    InvalidParameterException - One or more parameters are not valid.
    
    InvalidNextTokenException - The NextToken value is not valid.
    
    ClientException - A client exception has occurred.
    
    ServiceException - An exception has occurred in Directory Service.
    
    See Also:
    
    AWS API Documentation
  - describeDirectories
```
public DescribeDirectoriesResult describeDirectories()
```
    Description copied from interface: AWSDirectoryService
    
    Simplified method form for invoking the DescribeDirectories operation.
    
    Specified by:
    
    describeDirectories in interface AWSDirectoryService
    
    See Also:
    
    AWSDirectoryService.describeDirectories(DescribeDirectoriesRequest)
  - describeDomainControllers
```
public DescribeDomainControllersResult describeDomainControllers(DescribeDomainControllersRequest request)
```
    Provides information about any domain controllers in your directory.
    
    Specified by:
    
    describeDomainControllers in interface AWSDirectoryService
    
    Parameters:
    
    describeDomainControllersRequest -
    
    Returns:
    
    Result of the DescribeDomainControllers operation returned by the service.
    
    Throws:
    
    EntityDoesNotExistException - The specified entity could not be found.
    
    InvalidNextTokenException - The NextToken value is not valid.
    
    InvalidParameterException - One or more parameters are not valid.
    
    ClientException - A client exception has occurred.
    
    ServiceException - An exception has occurred in Directory Service.
    
    UnsupportedOperationException - The operation is not supported.
    
    See Also:
    
    AWS API Documentation
  - describeEventTopics
```
public DescribeEventTopicsResult describeEventTopics(DescribeEventTopicsRequest request)
```
    Obtains information about which Amazon 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.
    
    Specified by:
    
    describeEventTopics in interface AWSDirectoryService
    
    Parameters:
    
    describeEventTopicsRequest - Describes event topics.
    
    Returns:
    
    Result of the DescribeEventTopics operation returned by the service.
    
    Throws:
    
    EntityDoesNotExistException - The specified entity could not be found.
    
    InvalidParameterException - One or more parameters are not valid.
    
    ClientException - A client exception has occurred.
    
    ServiceException - An exception has occurred in Directory Service.
    
    See Also:
    
    AWS API Documentation
  - describeLDAPSSettings
```
public DescribeLDAPSSettingsResult describeLDAPSSettings(DescribeLDAPSSettingsRequest request)
```
    Describes the status of LDAP security for the specified directory.
    
    Specified by:
    
    describeLDAPSSettings in interface AWSDirectoryService
    
    Parameters:
    
    describeLDAPSSettingsRequest -
    
    Returns:
    
    Result of the DescribeLDAPSSettings operation returned by the service.
    
    Throws:
    
    DirectoryDoesNotExistException - The specified directory does not exist in the system.
    
    UnsupportedOperationException - The operation is not supported.
    
    InvalidNextTokenException - The NextToken value is not valid.
    
    InvalidParameterException - One or more parameters are not valid.
    
    ClientException - A client exception has occurred.
    
    ServiceException - An exception has occurred in Directory Service.
    
    See Also:
    
    AWS API Documentation
  - describeRegions
```
public DescribeRegionsResult describeRegions(DescribeRegionsRequest request)
```
    Provides information about the Regions that are configured for multi-Region replication.
    
    Specified by:
    
    describeRegions in interface AWSDirectoryService
    
    Parameters:
    
    describeRegionsRequest -
    
    Returns:
    
    Result of the DescribeRegions operation returned by the service.
    
    Throws:
    
    InvalidParameterException - One or more parameters are not valid.
    
    DirectoryDoesNotExistException - The specified directory does not exist in the system.
    
    UnsupportedOperationException - The operation is not supported.
    
    InvalidNextTokenException - The NextToken value is not valid.
    
    AccessDeniedException - Client authentication is not available in this region at this time.
    
    ClientException - A client exception has occurred.
    
    ServiceException - An exception has occurred in Directory Service.
    
    See Also:
    
    AWS API Documentation
  - describeSettings
```
public DescribeSettingsResult describeSettings(DescribeSettingsRequest request)
```
    Retrieves information about the configurable settings for the specified directory.
    
    Specified by:
    
    describeSettings in interface AWSDirectoryService
    
    Parameters:
    
    describeSettingsRequest -
    
    Returns:
    
    Result of the DescribeSettings operation returned by the service.
    
    Throws:
    
    DirectoryDoesNotExistException - The specified directory does not exist in the system.
    
    UnsupportedOperationException - The operation is not supported.
    
    InvalidParameterException - One or more parameters are not valid.
    
    InvalidNextTokenException - The NextToken value is not valid.
    
    ClientException - A client exception has occurred.
    
    ServiceException - An exception has occurred in Directory Service.
    
    See Also:
    
    AWS API Documentation
  - describeSharedDirectories
```
public DescribeSharedDirectoriesResult describeSharedDirectories(DescribeSharedDirectoriesRequest request)
```
    Returns the shared directories in your account.
    
    Specified by:
    
    describeSharedDirectories in interface AWSDirectoryService
    
    Parameters:
    
    describeSharedDirectoriesRequest -
    
    Returns:
    
    Result of the DescribeSharedDirectories operation returned by the service.
    
    Throws:
    
    EntityDoesNotExistException - The specified entity could not be found.
    
    InvalidNextTokenException - The NextToken value is not valid.
    
    InvalidParameterException - One or more parameters are not valid.
    
    UnsupportedOperationException - The operation is not supported.
    
    ClientException - A client exception has occurred.
    
    ServiceException - An exception has occurred in Directory Service.
    
    See Also:
    
    AWS API Documentation
  - describeSnapshots
```
public DescribeSnapshotsResult describeSnapshots(DescribeSnapshotsRequest request)
```
    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.
    
    Specified by:
    
    describeSnapshots in interface AWSDirectoryService
    
    Parameters:
    
    describeSnapshotsRequest - Contains the inputs for the DescribeSnapshots operation.
    
    Returns:
    
    Result of the DescribeSnapshots operation returned by the service.
    
    Throws:
    
    EntityDoesNotExistException - The specified entity could not be found.
    
    InvalidParameterException - One or more parameters are not valid.
    
    InvalidNextTokenException - The NextToken value is not valid.
    
    ClientException - A client exception has occurred.
    
    ServiceException - An exception has occurred in Directory Service.
    
    See Also:
    
    AWS API Documentation
  - describeSnapshots
```
public DescribeSnapshotsResult describeSnapshots()
```
    Description copied from interface: AWSDirectoryService
    
    Simplified method form for invoking the DescribeSnapshots operation.
    
    Specified by:
    
    describeSnapshots in interface AWSDirectoryService
    
    See Also:
    
    AWSDirectoryService.describeSnapshots(DescribeSnapshotsRequest)
  - describeTrusts
```
public DescribeTrustsResult describeTrusts(DescribeTrustsRequest request)
```
    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.
    
    Specified by:
    
    describeTrusts in interface AWSDirectoryService
    
    Parameters:
    
    describeTrustsRequest - Describes the trust relationships for a particular Managed Microsoft AD directory. If no input parameters are provided, such as directory ID or trust ID, this request describes all the trust relationships.
    
    Returns:
    
    Result of the DescribeTrusts operation returned by the service.
    
    Throws:
    
    EntityDoesNotExistException - The specified entity could not be found.
    
    InvalidNextTokenException - The NextToken value is not valid.
    
    InvalidParameterException - One or more parameters are not valid.
    
    ClientException - A client exception has occurred.
    
    ServiceException - An exception has occurred in Directory Service.
    
    UnsupportedOperationException - The operation is not supported.
    
    See Also:
    
    AWS API Documentation
  - describeUpdateDirectory
```
public DescribeUpdateDirectoryResult describeUpdateDirectory(DescribeUpdateDirectoryRequest request)
```
    Describes the updates of a directory for a particular update type.
    
    Specified by:
    
    describeUpdateDirectory in interface AWSDirectoryService
    
    Parameters:
    
    describeUpdateDirectoryRequest -
    
    Returns:
    
    Result of the DescribeUpdateDirectory operation returned by the service.
    
    Throws:
    
    DirectoryDoesNotExistException - The specified directory does not exist in the system.
    
    InvalidParameterException - One or more parameters are not valid.
    
    AccessDeniedException - Client authentication is not available in this region at this time.
    
    ClientException - A client exception has occurred.
    
    ServiceException - An exception has occurred in Directory Service.
    
    InvalidNextTokenException - The NextToken value is not valid.
    
    See Also:
    
    AWS API Documentation
  - disableClientAuthentication
```
public DisableClientAuthenticationResult disableClientAuthentication(DisableClientAuthenticationRequest request)
```
    Disables alternative client authentication methods for the specified directory.
    
    Specified by:
    
    disableClientAuthentication in interface AWSDirectoryService
    
    Parameters:
    
    disableClientAuthenticationRequest -
    
    Returns:
    
    Result of the DisableClientAuthentication operation returned by the service.
    
    Throws:
    
    DirectoryDoesNotExistException - The specified directory does not exist in the system.
    
    UnsupportedOperationException - The operation is not supported.
    
    InvalidClientAuthStatusException - Client authentication is already enabled.
    
    AccessDeniedException - Client authentication is not available in this region at this time.
    
    ClientException - A client exception has occurred.
    
    ServiceException - An exception has occurred in Directory Service.
    
    See Also:
    
    AWS API Documentation
  - disableLDAPS
```
public DisableLDAPSResult disableLDAPS(DisableLDAPSRequest request)
```
    Deactivates LDAP secure calls for the specified directory.
    
    Specified by:
    
    disableLDAPS in interface AWSDirectoryService
    
    Parameters:
    
    disableLDAPSRequest -
    
    Returns:
    
    Result of the DisableLDAPS operation returned by the service.
    
    Throws:
    
    DirectoryUnavailableException - The specified directory is unavailable or could not be found.
    
    DirectoryDoesNotExistException - The specified directory does not exist in the system.
    
    InvalidLDAPSStatusException - The LDAP activities could not be performed because they are limited by the LDAPS status.
    
    UnsupportedOperationException - The operation is not supported.
    
    InvalidParameterException - One or more parameters are not valid.
    
    ClientException - A client exception has occurred.
    
    ServiceException - An exception has occurred in Directory Service.
    
    See Also:
    
    AWS API Documentation
  - disableRadius
```
public DisableRadiusResult disableRadius(DisableRadiusRequest request)
```
    Disables multi-factor authentication (MFA) with the Remote Authentication Dial In User Service (RADIUS) server for an AD Connector or Microsoft AD directory.
    
    Specified by:
    
    disableRadius in interface AWSDirectoryService
    
    Parameters:
    
    disableRadiusRequest - Contains the inputs for the DisableRadius operation.
    
    Returns:
    
    Result of the DisableRadius operation returned by the service.
    
    Throws:
    
    EntityDoesNotExistException - The specified entity could not be found.
    
    ClientException - A client exception has occurred.
    
    ServiceException - An exception has occurred in Directory Service.
    
    See Also:
    
    AWS API Documentation
  - disableSso
```
public DisableSsoResult disableSso(DisableSsoRequest request)
```
    Disables single-sign on for a directory.
    
    Specified by:
    
    disableSso in interface AWSDirectoryService
    
    Parameters:
    
    disableSsoRequest - Contains the inputs for the DisableSso operation.
    
    Returns:
    
    Result of the DisableSso operation returned by the service.
    
    Throws:
    
    EntityDoesNotExistException - The specified entity could not be found.
    
    InsufficientPermissionsException - The account does not have sufficient permission to perform the operation.
    
    AuthenticationFailedException - An authentication error occurred.
    
    ClientException - A client exception has occurred.
    
    ServiceException - An exception has occurred in Directory Service.
    
    See Also:
    
    AWS API Documentation
  - enableClientAuthentication
```
public EnableClientAuthenticationResult enableClientAuthentication(EnableClientAuthenticationRequest request)
```
    Enables alternative client authentication methods for the specified directory.
    
    Specified by:
    
    enableClientAuthentication in interface AWSDirectoryService
    
    Parameters:
    
    enableClientAuthenticationRequest -
    
    Returns:
    
    Result of the EnableClientAuthentication operation returned by the service.
    
    Throws:
    
    DirectoryDoesNotExistException - The specified directory does not exist in the system.
    
    UnsupportedOperationException - The operation is not supported.
    
    InvalidClientAuthStatusException - Client authentication is already enabled.
    
    AccessDeniedException - Client authentication is not available in this region at this time.
    
    NoAvailableCertificateException - Client authentication setup could not be completed because at least one valid certificate must be registered in the system.
    
    ClientException - A client exception has occurred.
    
    ServiceException - An exception has occurred in Directory Service.
    
    See Also:
    
    AWS API Documentation
  - enableLDAPS
```
public EnableLDAPSResult enableLDAPS(EnableLDAPSRequest request)
```
    Activates the switch for the specific directory to always use LDAP secure calls.
    
    Specified by:
    
    enableLDAPS in interface AWSDirectoryService
    
    Parameters:
    
    enableLDAPSRequest -
    
    Returns:
    
    Result of the EnableLDAPS operation returned by the service.
    
    Throws:
    
    DirectoryUnavailableException - The specified directory is unavailable or could not be found.
    
    DirectoryDoesNotExistException - The specified directory does not exist in the system.
    
    NoAvailableCertificateException - Client authentication setup could not be completed because at least one valid certificate must be registered in the system.
    
    InvalidLDAPSStatusException - The LDAP activities could not be performed because they are limited by the LDAPS status.
    
    UnsupportedOperationException - The operation is not supported.
    
    InvalidParameterException - One or more parameters are not valid.
    
    ClientException - A client exception has occurred.
    
    ServiceException - An exception has occurred in Directory Service.
    
    See Also:
    
    AWS API Documentation
  - enableRadius
```
public EnableRadiusResult enableRadius(EnableRadiusRequest request)
```
    Enables multi-factor authentication (MFA) with the Remote Authentication Dial In User Service (RADIUS) server for an AD Connector or Microsoft AD directory.
    
    Specified by:
    
    enableRadius in interface AWSDirectoryService
    
    Parameters:
    
    enableRadiusRequest - Contains the inputs for the EnableRadius operation.
    
    Returns:
    
    Result of the EnableRadius operation returned by the service.
    
    Throws:
    
    InvalidParameterException - One or more parameters are not valid.
    
    EntityAlreadyExistsException - The specified entity already exists.
    
    EntityDoesNotExistException - The specified entity could not be found.
    
    ClientException - A client exception has occurred.
    
    ServiceException - An exception has occurred in Directory Service.
    
    See Also:
    
    AWS API Documentation
  - enableSso
```
public EnableSsoResult enableSso(EnableSsoRequest request)
```
    Enables single sign-on for a directory. Single sign-on allows users in your directory to access certain Amazon Web Services services from a computer joined to the directory without having to enter their credentials separately.
    
    Specified by:
    
    enableSso in interface AWSDirectoryService
    
    Parameters:
    
    enableSsoRequest - Contains the inputs for the EnableSso operation.
    
    Returns:
    
    Result of the EnableSso operation returned by the service.
    
    Throws:
    
    EntityDoesNotExistException - The specified entity could not be found.
    
    InsufficientPermissionsException - The account does not have sufficient permission to perform the operation.
    
    AuthenticationFailedException - An authentication error occurred.
    
    ClientException - A client exception has occurred.
    
    ServiceException - An exception has occurred in Directory Service.
    
    See Also:
    
    AWS API Documentation
  - getDirectoryLimits
```
public GetDirectoryLimitsResult getDirectoryLimits(GetDirectoryLimitsRequest request)
```
    Obtains directory limit information for the current Region.
    
    Specified by:
    
    getDirectoryLimits in interface AWSDirectoryService
    
    Parameters:
    
    getDirectoryLimitsRequest - Contains the inputs for the GetDirectoryLimits operation.
    
    Returns:
    
    Result of the GetDirectoryLimits operation returned by the service.
    
    Throws:
    
    EntityDoesNotExistException - The specified entity could not be found.
    
    ClientException - A client exception has occurred.
    
    ServiceException - An exception has occurred in Directory Service.
    
    See Also:
    
    AWS API Documentation
  - getDirectoryLimits
```
public GetDirectoryLimitsResult getDirectoryLimits()
```
    Description copied from interface: AWSDirectoryService
    
    Simplified method form for invoking the GetDirectoryLimits operation.
    
    Specified by:
    
    getDirectoryLimits in interface AWSDirectoryService
    
    See Also:
    
    AWSDirectoryService.getDirectoryLimits(GetDirectoryLimitsRequest)
  - getSnapshotLimits
```
public GetSnapshotLimitsResult getSnapshotLimits(GetSnapshotLimitsRequest request)
```
    Obtains the manual snapshot limits for a directory.
    
    Specified by:
    
    getSnapshotLimits in interface AWSDirectoryService
    
    Parameters:
    
    getSnapshotLimitsRequest - Contains the inputs for the GetSnapshotLimits operation.
    
    Returns:
    
    Result of the GetSnapshotLimits operation returned by the service.
    
    Throws:
    
    EntityDoesNotExistException - The specified entity could not be found.
    
    ClientException - A client exception has occurred.
    
    ServiceException - An exception has occurred in Directory Service.
    
    See Also:
    
    AWS API Documentation
  - listCertificates
```
public ListCertificatesResult listCertificates(ListCertificatesRequest request)
```
    For the specified directory, lists all the certificates registered for a secure LDAP or client certificate authentication.
    
    Specified by:
    
    listCertificates in interface AWSDirectoryService
    
    Parameters:
    
    listCertificatesRequest -
    
    Returns:
    
    Result of the ListCertificates operation returned by the service.
    
    Throws:
    
    DirectoryDoesNotExistException - The specified directory does not exist in the system.
    
    UnsupportedOperationException - The operation is not supported.
    
    InvalidParameterException - One or more parameters are not valid.
    
    InvalidNextTokenException - The NextToken value is not valid.
    
    ClientException - A client exception has occurred.
    
    ServiceException - An exception has occurred in Directory Service.
    
    See Also:
    
    AWS API Documentation
  - listIpRoutes
```
public ListIpRoutesResult listIpRoutes(ListIpRoutesRequest request)
```
    Lists the address blocks that you have added to a directory.
    
    Specified by:
    
    listIpRoutes in interface AWSDirectoryService
    
    Parameters:
    
    listIpRoutesRequest -
    
    Returns:
    
    Result of the ListIpRoutes operation returned by the service.
    
    Throws:
    
    EntityDoesNotExistException - The specified entity could not be found.
    
    InvalidNextTokenException - The NextToken value is not valid.
    
    InvalidParameterException - One or more parameters are not valid.
    
    ClientException - A client exception has occurred.
    
    ServiceException - An exception has occurred in Directory Service.
    
    See Also:
    
    AWS API Documentation
  - listLogSubscriptions
```
public ListLogSubscriptionsResult listLogSubscriptions(ListLogSubscriptionsRequest request)
```
    Lists the active log subscriptions for the Amazon Web Services account.
    
    Specified by:
    
    listLogSubscriptions in interface AWSDirectoryService
    
    Parameters:
    
    listLogSubscriptionsRequest -
    
    Returns:
    
    Result of the ListLogSubscriptions operation returned by the service.
    
    Throws:
    
    EntityDoesNotExistException - The specified entity could not be found.
    
    InvalidNextTokenException - The NextToken value is not valid.
    
    ClientException - A client exception has occurred.
    
    ServiceException - An exception has occurred in Directory Service.
    
    See Also:
    
    AWS API Documentation
  - listSchemaExtensions
```
public ListSchemaExtensionsResult listSchemaExtensions(ListSchemaExtensionsRequest request)
```
    Lists all schema extensions applied to a Microsoft AD Directory.
    
    Specified by:
    
    listSchemaExtensions in interface AWSDirectoryService
    
    Parameters:
    
    listSchemaExtensionsRequest -
    
    Returns:
    
    Result of the ListSchemaExtensions operation returned by the service.
    
    Throws:
    
    InvalidNextTokenException - The NextToken value is not valid.
    
    EntityDoesNotExistException - The specified entity could not be found.
    
    ClientException - A client exception has occurred.
    
    ServiceException - An exception has occurred in Directory Service.
    
    See Also:
    
    AWS API Documentation
  - listTagsForResource
```
public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
```
    Lists all tags on a directory.
    
    Specified by:
    
    listTagsForResource in interface AWSDirectoryService
    
    Parameters:
    
    listTagsForResourceRequest -
    
    Returns:
    
    Result of the ListTagsForResource operation returned by the service.
    
    Throws:
    
    EntityDoesNotExistException - The specified entity could not be found.
    
    InvalidNextTokenException - The NextToken value is not valid.
    
    InvalidParameterException - One or more parameters are not valid.
    
    ClientException - A client exception has occurred.
    
    ServiceException - An exception has occurred in Directory Service.
    
    See Also:
    
    AWS API Documentation
  - registerCertificate
```
public RegisterCertificateResult registerCertificate(RegisterCertificateRequest request)
```
    Registers a certificate for a secure LDAP or client certificate authentication.
    
    Specified by:
    
    registerCertificate in interface AWSDirectoryService
    
    Parameters:
    
    registerCertificateRequest -
    
    Returns:
    
    Result of the RegisterCertificate operation returned by the service.
    
    Throws:
    
    DirectoryUnavailableException - The specified directory is unavailable or could not be found.
    
    DirectoryDoesNotExistException - The specified directory does not exist in the system.
    
    InvalidCertificateException - The certificate PEM that was provided has incorrect encoding.
    
    CertificateLimitExceededException - The certificate could not be added because the certificate limit has been reached.
    
    CertificateAlreadyExistsException - The certificate has already been registered into the system.
    
    UnsupportedOperationException - The operation is not supported.
    
    InvalidParameterException - One or more parameters are not valid.
    
    ClientException - A client exception has occurred.
    
    ServiceException - An exception has occurred in Directory Service.
    
    See Also:
    
    AWS API Documentation
  - registerEventTopic
```
public RegisterEventTopicResult registerEventTopic(RegisterEventTopicRequest request)
```
    Associates a directory with an Amazon SNS topic. This establishes the directory as a publisher to the specified Amazon 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.
    
    Specified by:
    
    registerEventTopic in interface AWSDirectoryService
    
    Parameters:
    
    registerEventTopicRequest - Registers a new event topic.
    
    Returns:
    
    Result of the RegisterEventTopic operation returned by the service.
    
    Throws:
    
    EntityDoesNotExistException - The specified entity could not be found.
    
    InvalidParameterException - One or more parameters are not valid.
    
    ClientException - A client exception has occurred.
    
    ServiceException - An exception has occurred in Directory Service.
    
    See Also:
    
    AWS API Documentation
  - rejectSharedDirectory
```
public RejectSharedDirectoryResult rejectSharedDirectory(RejectSharedDirectoryRequest request)
```
    Rejects a directory sharing request that was sent from the directory owner account.
    
    Specified by:
    
    rejectSharedDirectory in interface AWSDirectoryService
    
    Parameters:
    
    rejectSharedDirectoryRequest -
    
    Returns:
    
    Result of the RejectSharedDirectory operation returned by the service.
    
    Throws:
    
    InvalidParameterException - One or more parameters are not valid.
    
    EntityDoesNotExistException - The specified entity could not be found.
    
    DirectoryAlreadySharedException - The specified directory has already been shared with this Amazon Web Services account.
    
    ClientException - A client exception has occurred.
    
    ServiceException - An exception has occurred in Directory Service.
    
    See Also:
    
    AWS API Documentation
  - removeIpRoutes
```
public RemoveIpRoutesResult removeIpRoutes(RemoveIpRoutesRequest request)
```
    Removes IP address blocks from a directory.
    
    Specified by:
    
    removeIpRoutes in interface AWSDirectoryService
    
    Parameters:
    
    removeIpRoutesRequest -
    
    Returns:
    
    Result of the RemoveIpRoutes operation returned by the service.
    
    Throws:
    
    EntityDoesNotExistException - The specified entity could not be found.
    
    InvalidParameterException - One or more parameters are not valid.
    
    DirectoryUnavailableException - The specified directory is unavailable or could not be found.
    
    ClientException - A client exception has occurred.
    
    ServiceException - An exception has occurred in Directory Service.
    
    See Also:
    
    AWS API Documentation
  - removeRegion
```
public RemoveRegionResult removeRegion(RemoveRegionRequest request)
```
    Stops all replication and removes the domain controllers from the specified Region. You cannot remove the primary Region with this operation. Instead, use the DeleteDirectory API.
    
    Specified by:
    
    removeRegion in interface AWSDirectoryService
    
    Parameters:
    
    removeRegionRequest -
    
    Returns:
    
    Result of the RemoveRegion operation returned by the service.
    
    Throws:
    
    DirectoryUnavailableException - The specified directory is unavailable or could not be found.
    
    DirectoryDoesNotExistException - The specified directory does not exist in the system.
    
    UnsupportedOperationException - The operation is not supported.
    
    AccessDeniedException - Client authentication is not available in this region at this time.
    
    ClientException - A client exception has occurred.
    
    ServiceException - An exception has occurred in Directory Service.
    
    See Also:
    
    AWS API Documentation
  - removeTagsFromResource
```
public RemoveTagsFromResourceResult removeTagsFromResource(RemoveTagsFromResourceRequest request)
```
    Removes tags from a directory.
    
    Specified by:
    
    removeTagsFromResource in interface AWSDirectoryService
    
    Parameters:
    
    removeTagsFromResourceRequest -
    
    Returns:
    
    Result of the RemoveTagsFromResource operation returned by the service.
    
    Throws:
    
    EntityDoesNotExistException - The specified entity could not be found.
    
    InvalidParameterException - One or more parameters are not valid.
    
    ClientException - A client exception has occurred.
    
    ServiceException - An exception has occurred in Directory Service.
    
    See Also:
    
    AWS API Documentation
  - resetUserPassword
```
public ResetUserPasswordResult resetUserPassword(ResetUserPasswordRequest request)
```
    Resets the password for any user in your 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 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 Amazon Web Services Reserved OU. For more information about the OU structure for an Managed Microsoft AD directory, see What Gets Created in the Directory Service Administration Guide.
    Specified by:
    
    resetUserPassword in interface AWSDirectoryService
    
    Parameters:
    
    resetUserPasswordRequest -
    
    Returns:
    
    Result of the ResetUserPassword operation returned by the service.
    
    Throws:
    
    DirectoryUnavailableException - The specified directory is unavailable or could not be found.
    
    UserDoesNotExistException - The user provided a username that does not exist in your directory.
    
    InvalidPasswordException - The new password provided by the user does not meet the password complexity requirements defined in your directory.
    
    UnsupportedOperationException - The operation is not supported.
    
    EntityDoesNotExistException - The specified entity could not be found.
    
    ClientException - A client exception has occurred.
    
    ServiceException - An exception has occurred in Directory Service.
    
    See Also:
    
    AWS API Documentation
  - restoreFromSnapshot
```
public RestoreFromSnapshotResult restoreFromSnapshot(RestoreFromSnapshotRequest request)
```
    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.
    
    Specified by:
    
    restoreFromSnapshot in interface AWSDirectoryService
    
    Parameters:
    
    restoreFromSnapshotRequest - An object representing the inputs for the RestoreFromSnapshot operation.
    
    Returns:
    
    Result of the RestoreFromSnapshot operation returned by the service.
    
    Throws:
    
    EntityDoesNotExistException - The specified entity could not be found.
    
    InvalidParameterException - One or more parameters are not valid.
    
    ClientException - A client exception has occurred.
    
    ServiceException - An exception has occurred in Directory Service.
    
    See Also:
    
    AWS API Documentation
  - shareDirectory
```
public ShareDirectoryResult shareDirectory(ShareDirectoryRequest request)
```
    Shares a specified directory (DirectoryId) in your Amazon Web Services account (directory owner) with another Amazon Web Services account (directory consumer). With this operation you can use your directory from any Amazon Web Services account and from any Amazon VPC within an Amazon Web Services Region.
    
    When you share your Managed Microsoft AD directory, 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 Amazon Web Services accounts inside the same Amazon Web Services organization (ORGANIZATIONS). It also determines whether you can share the directory with any other Amazon Web Services 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.
    
    Specified by:
    
    shareDirectory in interface AWSDirectoryService
    
    Parameters:
    
    shareDirectoryRequest -
    
    Returns:
    
    Result of the ShareDirectory operation returned by the service.
    
    Throws:
    
    DirectoryAlreadySharedException - The specified directory has already been shared with this Amazon Web Services account.
    
    EntityDoesNotExistException - The specified entity could not be found.
    
    InvalidTargetException - The specified shared target is not valid.
    
    InvalidParameterException - One or more parameters are not valid.
    
    ClientException - A client exception has occurred.
    
    ShareLimitExceededException - The maximum number of Amazon Web Services accounts that you can share with this directory has been reached.
    
    OrganizationsException - Exception encountered while trying to access your Amazon Web Services organization.
    
    AccessDeniedException - Client authentication is not available in this region at this time.
    
    UnsupportedOperationException - The operation is not supported.
    
    ServiceException - An exception has occurred in Directory Service.
    
    See Also:
    
    AWS API Documentation
  - startSchemaExtension
```
public StartSchemaExtensionResult startSchemaExtension(StartSchemaExtensionRequest request)
```
    Applies a schema extension to a Microsoft AD directory.
    
    Specified by:
    
    startSchemaExtension in interface AWSDirectoryService
    
    Parameters:
    
    startSchemaExtensionRequest -
    
    Returns:
    
    Result of the StartSchemaExtension operation returned by the service.
    
    Throws:
    
    DirectoryUnavailableException - The specified directory is unavailable or could not be found.
    
    EntityDoesNotExistException - The specified entity could not be found.
    
    InvalidParameterException - One or more parameters are not valid.
    
    SnapshotLimitExceededException - The maximum number of manual snapshots for the directory has been reached. You can use the GetSnapshotLimits operation to determine the snapshot limits for a directory.
    
    ClientException - A client exception has occurred.
    
    ServiceException - An exception has occurred in Directory Service.
    
    See Also:
    
    AWS API Documentation
  - unshareDirectory
```
public UnshareDirectoryResult unshareDirectory(UnshareDirectoryRequest request)
```
    Stops the directory sharing between the directory owner and consumer accounts.
    
    Specified by:
    
    unshareDirectory in interface AWSDirectoryService
    
    Parameters:
    
    unshareDirectoryRequest -
    
    Returns:
    
    Result of the UnshareDirectory operation returned by the service.
    
    Throws:
    
    EntityDoesNotExistException - The specified entity could not be found.
    
    InvalidTargetException - The specified shared target is not valid.
    
    DirectoryNotSharedException - The specified directory has not been shared with this Amazon Web Services account.
    
    ClientException - A client exception has occurred.
    
    ServiceException - An exception has occurred in Directory Service.
    
    See Also:
    
    AWS API Documentation
  - updateConditionalForwarder
```
public UpdateConditionalForwarderResult updateConditionalForwarder(UpdateConditionalForwarderRequest request)
```
    Updates a conditional forwarder that has been set up for your Amazon Web Services directory.
    
    Specified by:
    
    updateConditionalForwarder in interface AWSDirectoryService
    
    Parameters:
    
    updateConditionalForwarderRequest - Updates a conditional forwarder.
    
    Returns:
    
    Result of the UpdateConditionalForwarder operation returned by the service.
    
    Throws:
    
    EntityDoesNotExistException - The specified entity could not be found.
    
    DirectoryUnavailableException - The specified directory is unavailable or could not be found.
    
    InvalidParameterException - One or more parameters are not valid.
    
    UnsupportedOperationException - The operation is not supported.
    
    ClientException - A client exception has occurred.
    
    ServiceException - An exception has occurred in Directory Service.
    
    See Also:
    
    AWS API Documentation
  - updateDirectorySetup
```
public UpdateDirectorySetupResult updateDirectorySetup(UpdateDirectorySetupRequest request)
```
    Updates the directory for a particular update type.
    
    Specified by:
    
    updateDirectorySetup in interface AWSDirectoryService
    
    Parameters:
    
    updateDirectorySetupRequest -
    
    Returns:
    
    Result of the UpdateDirectorySetup operation returned by the service.
    
    Throws:
    
    UnsupportedOperationException - The operation is not supported.
    
    DirectoryInDesiredStateException - The directory is already updated to desired update type settings.
    
    DirectoryUnavailableException - The specified directory is unavailable or could not be found.
    
    SnapshotLimitExceededException - The maximum number of manual snapshots for the directory has been reached. You can use the GetSnapshotLimits operation to determine the snapshot limits for a directory.
    
    InvalidParameterException - One or more parameters are not valid.
    
    DirectoryDoesNotExistException - The specified directory does not exist in the system.
    
    AccessDeniedException - Client authentication is not available in this region at this time.
    
    ClientException - A client exception has occurred.
    
    ServiceException - An exception has occurred in Directory Service.
    
    See Also:
    
    AWS API Documentation
  - updateNumberOfDomainControllers
```
public UpdateNumberOfDomainControllersResult updateNumberOfDomainControllers(UpdateNumberOfDomainControllersRequest request)
```
    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.
    
    Specified by:
    
    updateNumberOfDomainControllers in interface AWSDirectoryService
    
    Parameters:
    
    updateNumberOfDomainControllersRequest -
    
    Returns:
    
    Result of the UpdateNumberOfDomainControllers operation returned by the service.
    
    Throws:
    
    EntityDoesNotExistException - The specified entity could not be found.
    
    DirectoryUnavailableException - The specified directory is unavailable or could not be found.
    
    DomainControllerLimitExceededException - The maximum allowed number of domain controllers per directory was exceeded. The default limit per directory is 20 domain controllers.
    
    InvalidParameterException - One or more parameters are not valid.
    
    UnsupportedOperationException - The operation is not supported.
    
    ClientException - A client exception has occurred.
    
    ServiceException - An exception has occurred in Directory Service.
    
    See Also:
    
    AWS API Documentation
  - updateRadius
```
public UpdateRadiusResult updateRadius(UpdateRadiusRequest request)
```
    Updates the Remote Authentication Dial In User Service (RADIUS) server information for an AD Connector or Microsoft AD directory.
    
    Specified by:
    
    updateRadius in interface AWSDirectoryService
    
    Parameters:
    
    updateRadiusRequest - Contains the inputs for the UpdateRadius operation.
    
    Returns:
    
    Result of the UpdateRadius operation returned by the service.
    
    Throws:
    
    InvalidParameterException - One or more parameters are not valid.
    
    EntityDoesNotExistException - The specified entity could not be found.
    
    ClientException - A client exception has occurred.
    
    ServiceException - An exception has occurred in Directory Service.
    
    See Also:
    
    AWS API Documentation
  - updateSettings
```
public UpdateSettingsResult updateSettings(UpdateSettingsRequest request)
```
    Updates the configurable settings for the specified directory.
    
    Specified by:
    
    updateSettings in interface AWSDirectoryService
    
    Parameters:
    
    updateSettingsRequest -
    
    Returns:
    
    Result of the UpdateSettings operation returned by the service.
    
    Throws:
    
    DirectoryDoesNotExistException - The specified directory does not exist in the system.
    
    UnsupportedOperationException - The operation is not supported.
    
    DirectoryUnavailableException - The specified directory is unavailable or could not be found.
    
    IncompatibleSettingsException - The specified directory setting is not compatible with other settings.
    
    UnsupportedSettingsException - The specified directory setting is not supported.
    
    InvalidParameterException - One or more parameters are not valid.
    
    ClientException - A client exception has occurred.
    
    ServiceException - An exception has occurred in Directory Service.
    
    See Also:
    
    AWS API Documentation
  - updateTrust
```
public UpdateTrustResult updateTrust(UpdateTrustRequest request)
```
    Updates the trust that has been set up between your Managed Microsoft AD directory and an self-managed Active Directory.
    
    Specified by:
    
    updateTrust in interface AWSDirectoryService
    
    Parameters:
    
    updateTrustRequest -
    
    Returns:
    
    Result of the UpdateTrust operation returned by the service.
    
    Throws:
    
    EntityDoesNotExistException - The specified entity could not be found.
    
    InvalidParameterException - One or more parameters are not valid.
    
    ClientException - A client exception has occurred.
    
    ServiceException - An exception has occurred in Directory Service.
    
    See Also:
    
    AWS API Documentation
  - verifyTrust
```
public VerifyTrustResult verifyTrust(VerifyTrustRequest request)
```
    Directory Service for Microsoft Active Directory allows you to configure and verify trust relationships.
    
    This action verifies a trust relationship between your Managed Microsoft AD directory and an external domain.
    
    Specified by:
    
    verifyTrust in interface AWSDirectoryService
    
    Parameters:
    
    verifyTrustRequest - Initiates the verification of an existing trust relationship between an Managed Microsoft AD directory and an external domain.
    
    Returns:
    
    Result of the VerifyTrust operation returned by the service.
    
    Throws:
    
    EntityDoesNotExistException - The specified entity could not be found.
    
    InvalidParameterException - One or more parameters are not valid.
    
    ClientException - A client exception has occurred.
    
    ServiceException - An exception has occurred in Directory Service.
    
    UnsupportedOperationException - The operation is not supported.
    
    See Also:
    
    AWS API Documentation
  - getCachedResponseMetadata
```
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
```
    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 the request.
    
    Specified by:
    
    getCachedResponseMetadata in interface AWSDirectoryService
    
    Parameters:
    
    request - The originally executed request
    
    Returns:
    
    The response metadata for the specified request, or null if none is available.
  - shutdown
```
public void shutdown()
```
    Description copied from class: AmazonWebServiceClient
    
    Shuts down this client object, releasing any resources that might be held open. If this method is not invoked, resources may be leaked. Once a client has been shutdown, it should not be used to make any more requests.
    
    Specified by:
    
    shutdown in interface AWSDirectoryService
    
    Overrides:
    
    shutdown in class AmazonWebServiceClient

AWS SDK for Java 1.x API Reference - 1.12.509

Class AWSDirectoryServiceClient

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceClient

Fields inherited from interface com.amazonaws.services.directory.AWSDirectoryService

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceClient

Methods inherited from class java.lang.Object

Methods inherited from interface com.amazonaws.services.directory.AWSDirectoryService

Constructor Detail

AWSDirectoryServiceClient

AWSDirectoryServiceClient

AWSDirectoryServiceClient

AWSDirectoryServiceClient

AWSDirectoryServiceClient

AWSDirectoryServiceClient

AWSDirectoryServiceClient

Method Detail

builder

acceptSharedDirectory

addIpRoutes

addRegion

addTagsToResource

cancelSchemaExtension

connectDirectory

createAlias

createComputer

createConditionalForwarder

createDirectory

createLogSubscription

createMicrosoftAD

createSnapshot

createTrust

deleteConditionalForwarder

deleteDirectory

deleteLogSubscription

deleteSnapshot

deleteTrust

deregisterCertificate

deregisterEventTopic

describeCertificate

describeClientAuthenticationSettings

describeConditionalForwarders

describeDirectories

describeDirectories

describeDomainControllers

describeEventTopics

describeLDAPSSettings

describeRegions

describeSettings

describeSharedDirectories

describeSnapshots

describeSnapshots

describeTrusts

describeUpdateDirectory

disableClientAuthentication

disableLDAPS

disableRadius

disableSso

enableClientAuthentication

enableLDAPS

enableRadius

enableSso

getDirectoryLimits

getDirectoryLimits

getSnapshotLimits

listCertificates

listIpRoutes

listLogSubscriptions

listSchemaExtensions

listTagsForResource

registerCertificate

registerEventTopic

rejectSharedDirectory

removeIpRoutes

removeRegion

removeTagsFromResource

resetUserPassword

restoreFromSnapshot