Package software.amazon.awssdk.services.directory

Interface DirectoryAsyncClient

All Superinterfaces:

AutoCloseable

@Generated("software.amazon.awssdk:codegen")
public interface DirectoryAsyncClient
extends AutoCloseable

Service client for accessing Directory Service asynchronously. This can be created using the static builder() method. AWS Directory Service

AWS Directory Service is a web service that makes it easy for you to setup and run directories in the AWS cloud, or connect your AWS resources with an existing on-premises Microsoft Active Directory. This guide provides detailed information about AWS Directory Service operations, data types, parameters, and errors. For information about AWS Directory Services features, see AWS Directory Service and the AWS Directory Service Administration Guide.

AWS 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 AWS Directory Service and other AWS services. For more information about the AWS SDKs, including how to download and install them, see Tools for Amazon Web Services.

Method Summary

Modifier and Type	Method	Description
default CompletableFuture<AddIpRoutesResponse>	addIpRoutes(AddIpRoutesRequest addIpRoutesRequest)	If the DNS server for your on-premises domain uses a publicly addressable IP address, you must add a CIDR address block to correctly route traffic to and from your Microsoft AD on Amazon Web Services.
default CompletableFuture<AddTagsToResourceResponse>	addTagsToResource(AddTagsToResourceRequest addTagsToResourceRequest)	Adds or overwrites one or more tags for the specified directory.
static DirectoryAsyncClientBuilder	builder()	Create a builder that can be used to configure and create a DirectoryAsyncClient.
default CompletableFuture<CancelSchemaExtensionResponse>	cancelSchemaExtension(CancelSchemaExtensionRequest cancelSchemaExtensionRequest)	Cancels an in-progress schema extension to a Microsoft AD directory.
default CompletableFuture<ConnectDirectoryResponse>	connectDirectory(ConnectDirectoryRequest connectDirectoryRequest)	Creates an AD Connector to connect to an on-premises directory.
static DirectoryAsyncClient	create()	Create a DirectoryAsyncClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.
default CompletableFuture<CreateAliasResponse>	createAlias(CreateAliasRequest createAliasRequest)	Creates an alias for a directory and assigns the alias to the directory.
default CompletableFuture<CreateComputerResponse>	createComputer(CreateComputerRequest createComputerRequest)	Creates a computer account in the specified directory, and joins the computer to the directory.
default CompletableFuture<CreateConditionalForwarderResponse>	createConditionalForwarder(CreateConditionalForwarderRequest createConditionalForwarderRequest)	Creates a conditional forwarder associated with your AWS directory.
default CompletableFuture<CreateDirectoryResponse>	createDirectory(CreateDirectoryRequest createDirectoryRequest)	Creates a Simple AD directory.
default CompletableFuture<CreateMicrosoftADResponse>	createMicrosoftAD(CreateMicrosoftADRequest createMicrosoftADRequest)	Creates a Microsoft AD in the AWS cloud.
default CompletableFuture<CreateSnapshotResponse>	createSnapshot(CreateSnapshotRequest createSnapshotRequest)	Creates a snapshot of a Simple AD or Microsoft AD directory in the AWS cloud.
default CompletableFuture<CreateTrustResponse>	createTrust(CreateTrustRequest createTrustRequest)	AWS Directory Service for Microsoft Active Directory allows you to configure trust relationships.
default CompletableFuture<DeleteConditionalForwarderResponse>	deleteConditionalForwarder(DeleteConditionalForwarderRequest deleteConditionalForwarderRequest)	Deletes a conditional forwarder that has been set up for your AWS directory.
default CompletableFuture<DeleteDirectoryResponse>	deleteDirectory(DeleteDirectoryRequest deleteDirectoryRequest)	Deletes an AWS Directory Service directory.
default CompletableFuture<DeleteSnapshotResponse>	deleteSnapshot(DeleteSnapshotRequest deleteSnapshotRequest)	Deletes a directory snapshot.
default CompletableFuture<DeleteTrustResponse>	deleteTrust(DeleteTrustRequest deleteTrustRequest)	Deletes an existing trust relationship between your Microsoft AD in the AWS cloud and an external domain.
default CompletableFuture<DeregisterEventTopicResponse>	deregisterEventTopic(DeregisterEventTopicRequest deregisterEventTopicRequest)	Removes the specified directory as a publisher to the specified SNS topic.
default CompletableFuture<DescribeConditionalForwardersResponse>	describeConditionalForwarders(DescribeConditionalForwardersRequest describeConditionalForwardersRequest)	Obtains information about the conditional forwarders for this account.
default CompletableFuture<DescribeDirectoriesResponse>	describeDirectories(DescribeDirectoriesRequest describeDirectoriesRequest)	Obtains information about the directories that belong to this account.
default CompletableFuture<DescribeEventTopicsResponse>	describeEventTopics(DescribeEventTopicsRequest describeEventTopicsRequest)	Obtains information about which SNS topics receive status messages from the specified directory.
default CompletableFuture<DescribeSnapshotsResponse>	describeSnapshots(DescribeSnapshotsRequest describeSnapshotsRequest)	Obtains information about the directory snapshots that belong to this account.
default CompletableFuture<DescribeTrustsResponse>	describeTrusts(DescribeTrustsRequest describeTrustsRequest)	Obtains information about the trust relationships for this account.
default CompletableFuture<DisableRadiusResponse>	disableRadius(DisableRadiusRequest disableRadiusRequest)	Disables multi-factor authentication (MFA) with the Remote Authentication Dial In User Service (RADIUS) server for an AD Connector directory.
default CompletableFuture<DisableSsoResponse>	disableSso(DisableSsoRequest disableSsoRequest)	Disables single-sign on for a directory.
default CompletableFuture<EnableRadiusResponse>	enableRadius(EnableRadiusRequest enableRadiusRequest)	Enables multi-factor authentication (MFA) with the Remote Authentication Dial In User Service (RADIUS) server for an AD Connector directory.
default CompletableFuture<EnableSsoResponse>	enableSso(EnableSsoRequest enableSsoRequest)	Enables single sign-on for a directory.
default CompletableFuture<GetDirectoryLimitsResponse>	getDirectoryLimits(GetDirectoryLimitsRequest getDirectoryLimitsRequest)	Obtains directory limit information for the current region.
default CompletableFuture<GetSnapshotLimitsResponse>	getSnapshotLimits(GetSnapshotLimitsRequest getSnapshotLimitsRequest)	Obtains the manual snapshot limits for a directory.
default CompletableFuture<ListIpRoutesResponse>	listIpRoutes(ListIpRoutesRequest listIpRoutesRequest)	Lists the address blocks that you have added to a directory.
default CompletableFuture<ListSchemaExtensionsResponse>	listSchemaExtensions(ListSchemaExtensionsRequest listSchemaExtensionsRequest)	Lists all schema extensions applied to a Microsoft AD Directory.
default CompletableFuture<ListTagsForResourceResponse>	listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)	Lists all tags on a directory.
default CompletableFuture<RegisterEventTopicResponse>	registerEventTopic(RegisterEventTopicRequest registerEventTopicRequest)	Associates a directory with an SNS topic.
default CompletableFuture<RemoveIpRoutesResponse>	removeIpRoutes(RemoveIpRoutesRequest removeIpRoutesRequest)	Removes IP address blocks from a directory.
default CompletableFuture<RemoveTagsFromResourceResponse>	removeTagsFromResource(RemoveTagsFromResourceRequest removeTagsFromResourceRequest)	Removes tags from a directory.
default CompletableFuture<RestoreFromSnapshotResponse>	restoreFromSnapshot(RestoreFromSnapshotRequest restoreFromSnapshotRequest)	Restores a directory using an existing directory snapshot.
default CompletableFuture<StartSchemaExtensionResponse>	startSchemaExtension(StartSchemaExtensionRequest startSchemaExtensionRequest)	Applies a schema extension to a Microsoft AD directory.
default CompletableFuture<UpdateConditionalForwarderResponse>	updateConditionalForwarder(UpdateConditionalForwarderRequest updateConditionalForwarderRequest)	Updates a conditional forwarder that has been set up for your AWS directory.
default CompletableFuture<UpdateRadiusResponse>	updateRadius(UpdateRadiusRequest updateRadiusRequest)	Updates the Remote Authentication Dial In User Service (RADIUS) server information for an AD Connector directory.
default CompletableFuture<VerifyTrustResponse>	verifyTrust(VerifyTrustRequest verifyTrustRequest)	AWS Directory Service for Microsoft Active Directory allows you to configure and verify trust relationships.

Methods inherited from interface java.lang.AutoCloseable

close

Method Detail

create

static DirectoryAsyncClient create()

Create a DirectoryAsyncClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

builder

static DirectoryAsyncClientBuilder builder()

Create a builder that can be used to configure and create a DirectoryAsyncClient.

addIpRoutes

default CompletableFuture<AddIpRoutesResponse> addIpRoutes(AddIpRoutesRequest addIpRoutesRequest)

If the DNS server for your on-premises domain uses a publicly addressable IP address, you must add a CIDR address block to correctly route traffic to and from your Microsoft AD on Amazon Web Services. AddIpRoutes adds this address block. You can also use AddIpRoutes to facilitate routing traffic that uses public IP ranges from your Microsoft AD on AWS to a peer VPC.

Before you call AddIpRoutes, ensure that all of the required permissions have been explicitly granted through a policy. For details about what permissions are required to run the AddIpRoutes operation, see AWS Directory Service API Permissions: Actions, Resources, and Conditions Reference.

Parameters:

addIpRoutesRequest -

Returns:

A Java Future containing the result of the AddIpRoutes operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• 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 AWS Directory Service.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• DirectoryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

addTagsToResource

default CompletableFuture<AddTagsToResourceResponse> addTagsToResource(AddTagsToResourceRequest addTagsToResourceRequest)

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.

Parameters:

addTagsToResourceRequest -

Returns:

A Java Future containing the result of the AddTagsToResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• 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 AWS Directory Service.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• DirectoryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

cancelSchemaExtension

default CompletableFuture<CancelSchemaExtensionResponse> cancelSchemaExtension(CancelSchemaExtensionRequest cancelSchemaExtensionRequest)

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.

Parameters:

cancelSchemaExtensionRequest -

Returns:

A Java Future containing the result of the CancelSchemaExtension operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• EntityDoesNotExistException The specified entity could not be found.
• ClientException A client exception has occurred.
• ServiceException An exception has occurred in AWS Directory Service.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• DirectoryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

connectDirectory

default CompletableFuture<ConnectDirectoryResponse> connectDirectory(ConnectDirectoryRequest connectDirectoryRequest)

Creates an AD Connector to connect to an on-premises directory.

Before you call ConnectDirectory, ensure that all of the required permissions have been explicitly granted through a policy. For details about what permissions are required to run the ConnectDirectory operation, see AWS Directory Service API Permissions: Actions, Resources, and Conditions Reference.

Parameters:

connectDirectoryRequest - Contains the inputs for the ConnectDirectory operation.

Returns:

A Java Future containing the result of the ConnectDirectory operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• 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 AWS Directory Service.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• DirectoryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

createAlias

default CompletableFuture<CreateAliasResponse> createAlias(CreateAliasRequest createAliasRequest)

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.

Parameters:

createAliasRequest - Contains the inputs for the CreateAlias operation.

Returns:

A Java Future containing the result of the CreateAlias operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• 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 AWS Directory Service.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• DirectoryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

createComputer

default CompletableFuture<CreateComputerResponse> createComputer(CreateComputerRequest createComputerRequest)

Creates a computer account in the specified directory, and joins the computer to the directory.

Parameters:

createComputerRequest - Contains the inputs for the CreateComputer operation.

Returns:

A Java Future containing the result of the CreateComputer operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• 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 AWS Directory Service.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• DirectoryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

createConditionalForwarder

default CompletableFuture<CreateConditionalForwarderResponse> createConditionalForwarder(CreateConditionalForwarderRequest createConditionalForwarderRequest)

Creates a conditional forwarder associated with your AWS directory. Conditional forwarders are required in order to set up a trust relationship with another domain. The conditional forwarder points to the trusted domain.

Parameters:

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

Returns:

A Java Future containing the result of the CreateConditionalForwarder operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• 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 AWS Directory Service.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• DirectoryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

createDirectory

default CompletableFuture<CreateDirectoryResponse> createDirectory(CreateDirectoryRequest createDirectoryRequest)

Creates a Simple AD directory.

Before you call CreateDirectory, ensure that all of the required permissions have been explicitly granted through a policy. For details about what permissions are required to run the CreateDirectory operation, see AWS Directory Service API Permissions: Actions, Resources, and Conditions Reference.

Parameters:

createDirectoryRequest - Contains the inputs for the CreateDirectory operation.

Returns:

A Java Future containing the result of the CreateDirectory operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• 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 AWS Directory Service.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• DirectoryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

createMicrosoftAD

default CompletableFuture<CreateMicrosoftADResponse> createMicrosoftAD(CreateMicrosoftADRequest createMicrosoftADRequest)

Creates a Microsoft AD in the AWS cloud.

Before you call CreateMicrosoftAD, ensure that all of the required permissions have been explicitly granted through a policy. For details about what permissions are required to run the CreateMicrosoftAD operation, see AWS Directory Service API Permissions: Actions, Resources, and Conditions Reference.

Parameters:

createMicrosoftADRequest - Creates a Microsoft AD in the AWS cloud.

Returns:

A Java Future containing the result of the CreateMicrosoftAD operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• 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 AWS Directory Service.
• UnsupportedOperationException The operation is not supported.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• DirectoryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

createSnapshot

default CompletableFuture<CreateSnapshotResponse> createSnapshot(CreateSnapshotRequest createSnapshotRequest)

Creates a snapshot of a Simple AD or Microsoft AD directory in the AWS cloud.

You cannot take snapshots of AD Connector directories.

Parameters:

createSnapshotRequest - Contains the inputs for the CreateSnapshot operation.

Returns:

A Java Future containing the result of the CreateSnapshot operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• 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 AWS Directory Service.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• DirectoryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

createTrust

default CompletableFuture<CreateTrustResponse> createTrust(CreateTrustRequest createTrustRequest)

AWS Directory Service for Microsoft Active Directory allows you to configure trust relationships. For example, you can establish a trust between your Microsoft AD in the AWS cloud, and your existing on-premises Microsoft Active Directory. This would allow you to provide users and groups access to resources in either domain, with a single set of credentials.

This action initiates the creation of the AWS side of a trust relationship between a Microsoft AD in the AWS cloud and an external domain.

Parameters:

createTrustRequest - AWS Directory Service for Microsoft Active Directory allows you to configure trust relationships. For example, you can establish a trust between your Microsoft AD in the AWS cloud, and your existing on-premises Microsoft Active Directory. This would allow you to provide users and groups access to resources in either domain, with a single set of credentials.

This action initiates the creation of the AWS side of a trust relationship between a Microsoft AD in the AWS cloud and an external domain.

Returns:

A Java Future containing the result of the CreateTrust operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• 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 AWS Directory Service.
• UnsupportedOperationException The operation is not supported.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• DirectoryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

deleteConditionalForwarder

default CompletableFuture<DeleteConditionalForwarderResponse> deleteConditionalForwarder(DeleteConditionalForwarderRequest deleteConditionalForwarderRequest)

Deletes a conditional forwarder that has been set up for your AWS directory.

Parameters:

deleteConditionalForwarderRequest - Deletes a conditional forwarder.

Returns:

A Java Future containing the result of the DeleteConditionalForwarder operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• 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 AWS Directory Service.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• DirectoryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

deleteDirectory

default CompletableFuture<DeleteDirectoryResponse> deleteDirectory(DeleteDirectoryRequest deleteDirectoryRequest)

Deletes an AWS Directory Service directory.

Before you call DeleteDirectory, ensure that all of the required permissions have been explicitly granted through a policy. For details about what permissions are required to run the DeleteDirectory operation, see AWS Directory Service API Permissions: Actions, Resources, and Conditions Reference.

Parameters:

deleteDirectoryRequest - Contains the inputs for the DeleteDirectory operation.

Returns:

A Java Future containing the result of the DeleteDirectory operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• EntityDoesNotExistException The specified entity could not be found.
• ClientException A client exception has occurred.
• ServiceException An exception has occurred in AWS Directory Service.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• DirectoryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

deleteSnapshot

default CompletableFuture<DeleteSnapshotResponse> deleteSnapshot(DeleteSnapshotRequest deleteSnapshotRequest)

Deletes a directory snapshot.

Parameters:

deleteSnapshotRequest - Contains the inputs for the DeleteSnapshot operation.

Returns:

A Java Future containing the result of the DeleteSnapshot operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• 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 AWS Directory Service.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• DirectoryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

deleteTrust

default CompletableFuture<DeleteTrustResponse> deleteTrust(DeleteTrustRequest deleteTrustRequest)

Deletes an existing trust relationship between your Microsoft AD in the AWS cloud and an external domain.

Parameters:

deleteTrustRequest - Deletes the local side of an existing trust relationship between the Microsoft AD in the AWS cloud and the external domain.

Returns:

A Java Future containing the result of the DeleteTrust operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• 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 AWS Directory Service.
• UnsupportedOperationException The operation is not supported.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• DirectoryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

deregisterEventTopic

default CompletableFuture<DeregisterEventTopicResponse> deregisterEventTopic(DeregisterEventTopicRequest deregisterEventTopicRequest)

Removes the specified directory as a publisher to the specified SNS topic.

Parameters:

deregisterEventTopicRequest - Removes the specified directory as a publisher to the specified SNS topic.

Returns:

A Java Future containing the result of the DeregisterEventTopic operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• 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 AWS Directory Service.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• DirectoryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

describeConditionalForwarders

default CompletableFuture<DescribeConditionalForwardersResponse> describeConditionalForwarders(DescribeConditionalForwardersRequest describeConditionalForwardersRequest)

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.

Parameters:

describeConditionalForwardersRequest - Describes a conditional forwarder.

Returns:

A Java Future containing the result of the DescribeConditionalForwarders operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• 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 AWS Directory Service.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• DirectoryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

describeDirectories

default CompletableFuture<DescribeDirectoriesResponse> describeDirectories(DescribeDirectoriesRequest describeDirectoriesRequest)

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.

Parameters:

describeDirectoriesRequest - Contains the inputs for the DescribeDirectories operation.

Returns:

A Java Future containing the result of the DescribeDirectories operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• 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 AWS Directory Service.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• DirectoryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

describeEventTopics

default CompletableFuture<DescribeEventTopicsResponse> describeEventTopics(DescribeEventTopicsRequest describeEventTopicsRequest)

Obtains information about which SNS topics receive status messages from the specified directory.

If no input parameters are provided, such as DirectoryId or TopicName, this request describes all of the associations in the account.

Parameters:

describeEventTopicsRequest - Describes event topics.

Returns:

A Java Future containing the result of the DescribeEventTopics operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• 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 AWS Directory Service.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• DirectoryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

describeSnapshots

default CompletableFuture<DescribeSnapshotsResponse> describeSnapshots(DescribeSnapshotsRequest describeSnapshotsRequest)

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.

Parameters:

describeSnapshotsRequest - Contains the inputs for the DescribeSnapshots operation.

Returns:

A Java Future containing the result of the DescribeSnapshots operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• 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 AWS Directory Service.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• DirectoryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

describeTrusts

default CompletableFuture<DescribeTrustsResponse> describeTrusts(DescribeTrustsRequest describeTrustsRequest)

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.

Parameters:

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

Returns:

A Java Future containing the result of the DescribeTrusts operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• 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 AWS Directory Service.
• UnsupportedOperationException The operation is not supported.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• DirectoryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

disableRadius

default CompletableFuture<DisableRadiusResponse> disableRadius(DisableRadiusRequest disableRadiusRequest)

Disables multi-factor authentication (MFA) with the Remote Authentication Dial In User Service (RADIUS) server for an AD Connector directory.

Parameters:

disableRadiusRequest - Contains the inputs for the DisableRadius operation.

Returns:

A Java Future containing the result of the DisableRadius operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• EntityDoesNotExistException The specified entity could not be found.
• ClientException A client exception has occurred.
• ServiceException An exception has occurred in AWS Directory Service.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• DirectoryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

disableSso

default CompletableFuture<DisableSsoResponse> disableSso(DisableSsoRequest disableSsoRequest)

Disables single-sign on for a directory.

Parameters:

disableSsoRequest - Contains the inputs for the DisableSso operation.

Returns:

A Java Future containing the result of the DisableSso operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• 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 AWS Directory Service.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• DirectoryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

enableRadius

default CompletableFuture<EnableRadiusResponse> enableRadius(EnableRadiusRequest enableRadiusRequest)

Enables multi-factor authentication (MFA) with the Remote Authentication Dial In User Service (RADIUS) server for an AD Connector directory.

Parameters:

enableRadiusRequest - Contains the inputs for the EnableRadius operation.

Returns:

A Java Future containing the result of the EnableRadius operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• 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 AWS Directory Service.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• DirectoryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

enableSso

default CompletableFuture<EnableSsoResponse> enableSso(EnableSsoRequest enableSsoRequest)

Enables single sign-on for a directory.

Parameters:

enableSsoRequest - Contains the inputs for the EnableSso operation.

Returns:

A Java Future containing the result of the EnableSso operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• 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 AWS Directory Service.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• DirectoryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

getDirectoryLimits

default CompletableFuture<GetDirectoryLimitsResponse> getDirectoryLimits(GetDirectoryLimitsRequest getDirectoryLimitsRequest)

Obtains directory limit information for the current region.

Parameters:

getDirectoryLimitsRequest - Contains the inputs for the GetDirectoryLimits operation.

Returns:

A Java Future containing the result of the GetDirectoryLimits operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• EntityDoesNotExistException The specified entity could not be found.
• ClientException A client exception has occurred.
• ServiceException An exception has occurred in AWS Directory Service.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• DirectoryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

getSnapshotLimits

default CompletableFuture<GetSnapshotLimitsResponse> getSnapshotLimits(GetSnapshotLimitsRequest getSnapshotLimitsRequest)

Obtains the manual snapshot limits for a directory.

Parameters:

getSnapshotLimitsRequest - Contains the inputs for the GetSnapshotLimits operation.

Returns:

A Java Future containing the result of the GetSnapshotLimits operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• EntityDoesNotExistException The specified entity could not be found.
• ClientException A client exception has occurred.
• ServiceException An exception has occurred in AWS Directory Service.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• DirectoryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

listIpRoutes

default CompletableFuture<ListIpRoutesResponse> listIpRoutes(ListIpRoutesRequest listIpRoutesRequest)

Lists the address blocks that you have added to a directory.

Parameters:

listIpRoutesRequest -

Returns:

A Java Future containing the result of the ListIpRoutes operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• 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 AWS Directory Service.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• DirectoryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

listSchemaExtensions

default CompletableFuture<ListSchemaExtensionsResponse> listSchemaExtensions(ListSchemaExtensionsRequest listSchemaExtensionsRequest)

Lists all schema extensions applied to a Microsoft AD Directory.

Parameters:

listSchemaExtensionsRequest -

Returns:

A Java Future containing the result of the ListSchemaExtensions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• 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 AWS Directory Service.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• DirectoryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

listTagsForResource

default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)

Lists all tags on a directory.

Parameters:

listTagsForResourceRequest -

Returns:

A Java Future containing the result of the ListTagsForResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• 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 AWS Directory Service.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• DirectoryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

registerEventTopic

default CompletableFuture<RegisterEventTopicResponse> registerEventTopic(RegisterEventTopicRequest registerEventTopicRequest)

Associates a directory with an SNS topic. This establishes the directory as a publisher to the specified SNS topic. You can then receive email or text (SMS) messages when the status of your directory changes. You get notified if your directory goes from an Active status to an Impaired or Inoperable status. You also receive a notification when the directory returns to an Active status.

Parameters:

registerEventTopicRequest - Registers a new event topic.

Returns:

A Java Future containing the result of the RegisterEventTopic operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• 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 AWS Directory Service.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• DirectoryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

removeIpRoutes

default CompletableFuture<RemoveIpRoutesResponse> removeIpRoutes(RemoveIpRoutesRequest removeIpRoutesRequest)

Removes IP address blocks from a directory.

Parameters:

removeIpRoutesRequest -

Returns:

A Java Future containing the result of the RemoveIpRoutes operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• 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 AWS Directory Service.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• DirectoryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

removeTagsFromResource

default CompletableFuture<RemoveTagsFromResourceResponse> removeTagsFromResource(RemoveTagsFromResourceRequest removeTagsFromResourceRequest)

Removes tags from a directory.

Parameters:

removeTagsFromResourceRequest -

Returns:

A Java Future containing the result of the RemoveTagsFromResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• 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 AWS Directory Service.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• DirectoryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

restoreFromSnapshot

default CompletableFuture<RestoreFromSnapshotResponse> restoreFromSnapshot(RestoreFromSnapshotRequest restoreFromSnapshotRequest)

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.

Parameters:

restoreFromSnapshotRequest - An object representing the inputs for the RestoreFromSnapshot operation.

Returns:

A Java Future containing the result of the RestoreFromSnapshot operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• 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 AWS Directory Service.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• DirectoryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

startSchemaExtension

default CompletableFuture<StartSchemaExtensionResponse> startSchemaExtension(StartSchemaExtensionRequest startSchemaExtensionRequest)

Applies a schema extension to a Microsoft AD directory.

Parameters:

startSchemaExtensionRequest -

Returns:

A Java Future containing the result of the StartSchemaExtension operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• 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 AWS Directory Service.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• DirectoryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

updateConditionalForwarder

default CompletableFuture<UpdateConditionalForwarderResponse> updateConditionalForwarder(UpdateConditionalForwarderRequest updateConditionalForwarderRequest)

Updates a conditional forwarder that has been set up for your AWS directory.

Parameters:

updateConditionalForwarderRequest - Updates a conditional forwarder.

Returns:

A Java Future containing the result of the UpdateConditionalForwarder operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• 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 AWS Directory Service.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• DirectoryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

updateRadius

default CompletableFuture<UpdateRadiusResponse> updateRadius(UpdateRadiusRequest updateRadiusRequest)

Updates the Remote Authentication Dial In User Service (RADIUS) server information for an AD Connector directory.

Parameters:

updateRadiusRequest - Contains the inputs for the UpdateRadius operation.

Returns:

A Java Future containing the result of the UpdateRadius operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• 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 AWS Directory Service.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• DirectoryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

verifyTrust

default CompletableFuture<VerifyTrustResponse> verifyTrust(VerifyTrustRequest verifyTrustRequest)

AWS Directory Service for Microsoft Active Directory allows you to configure and verify trust relationships.

This action verifies a trust relationship between your Microsoft AD in the AWS cloud and an external domain.

Parameters:

verifyTrustRequest - Initiates the verification of an existing trust relationship between a Microsoft AD in the AWS cloud and an external domain.

Returns:

A Java Future containing the result of the VerifyTrust operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• 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 AWS Directory Service.
• UnsupportedOperationException The operation is not supported.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• DirectoryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation