Interface DirectoryAsyncClient

All Superinterfaces:
AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient
@Generated("software.amazon.awssdk:codegen") @SdkPublicApi @ThreadSafe public interface DirectoryAsyncClient extends AwsClient
Service client for accessing Directory Service asynchronously. This can be created using the static builder() method.The asynchronous client performs non-blocking I/O when configured with any SdkAsyncHttpClient supported in the SDK. However, full non-blocking is not guaranteed as the async client may perform blocking calls in some cases such as credentials retrieval and endpoint discovery as part of the async API call. 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 Details

  • Method Details

    • acceptSharedDirectory

      default CompletableFuture<AcceptSharedDirectoryResponse> acceptSharedDirectory(AcceptSharedDirectoryRequest acceptSharedDirectoryRequest)

      Accepts a directory sharing request that was sent from the directory owner account.

      Parameters:
      acceptSharedDirectoryRequest -
      Returns:
      A Java Future containing the result of the AcceptSharedDirectory operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException 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 type.
      See Also:

    • acceptSharedDirectory

      default CompletableFuture<AcceptSharedDirectoryResponse> acceptSharedDirectory(Consumer<AcceptSharedDirectoryRequest.Builder> acceptSharedDirectoryRequest)

      Accepts a directory sharing request that was sent from the directory owner account.


      This is a convenience which creates an instance of the AcceptSharedDirectoryRequest.Builder avoiding the need to create one manually via AcceptSharedDirectoryRequest.builder()

      Parameters:
      acceptSharedDirectoryRequest - A Consumer that will call methods on AcceptSharedDirectoryRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the AcceptSharedDirectory operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException 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 type.
      See Also:

    • addIpRoutes

      default CompletableFuture<AddIpRoutesResponse> addIpRoutes(AddIpRoutesRequest addIpRoutesRequest)

      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.

      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • 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.
      • SdkException 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 type.
      See Also:

    • addIpRoutes

      default CompletableFuture<AddIpRoutesResponse> addIpRoutes(Consumer<AddIpRoutesRequest.Builder> addIpRoutesRequest)

      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.


      This is a convenience which creates an instance of the AddIpRoutesRequest.Builder avoiding the need to create one manually via AddIpRoutesRequest.builder()

      Parameters:
      addIpRoutesRequest - A Consumer that will call methods on AddIpRoutesRequest.Builder to create a request.
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • 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.
      • SdkException 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 type.
      See Also:

    • addRegion

      default CompletableFuture<AddRegionResponse> addRegion(AddRegionRequest addRegionRequest)

      Adds two domain controllers in the specified Region for the specified directory.

      Parameters:
      addRegionRequest -
      Returns:
      A Java Future containing the result of the AddRegion operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • DirectoryUnavailableException The specified directory is unavailable.
      • 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 You do not have sufficient access to perform this action.
      • ClientException A client exception has occurred.
      • ServiceException An exception has occurred in Directory Service.
      • SdkException 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 type.
      See Also:

    • addRegion

      default CompletableFuture<AddRegionResponse> addRegion(Consumer<AddRegionRequest.Builder> addRegionRequest)

      Adds two domain controllers in the specified Region for the specified directory.


      This is a convenience which creates an instance of the AddRegionRequest.Builder avoiding the need to create one manually via AddRegionRequest.builder()

      Parameters:
      addRegionRequest - A Consumer that will call methods on AddRegionRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the AddRegion operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • DirectoryUnavailableException The specified directory is unavailable.
      • 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 You do not have sufficient access to perform this action.
      • ClientException A client exception has occurred.
      • ServiceException An exception has occurred in Directory Service.
      • SdkException 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 type.
      See Also:

    • 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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException 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 type.
      See Also:

    • addTagsToResource

      default CompletableFuture<AddTagsToResourceResponse> addTagsToResource(Consumer<AddTagsToResourceRequest.Builder> 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.


      This is a convenience which creates an instance of the AddTagsToResourceRequest.Builder avoiding the need to create one manually via AddTagsToResourceRequest.builder()

      Parameters:
      addTagsToResourceRequest - A Consumer that will call methods on AddTagsToResourceRequest.Builder to create a request.
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException 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 type.
      See Also:

    • 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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • EntityDoesNotExistException The specified entity could not be found.
      • ClientException A client exception has occurred.
      • ServiceException An exception has occurred in Directory Service.
      • SdkException 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 type.
      See Also:

    • cancelSchemaExtension

      default CompletableFuture<CancelSchemaExtensionResponse> cancelSchemaExtension(Consumer<CancelSchemaExtensionRequest.Builder> 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.


      This is a convenience which creates an instance of the CancelSchemaExtensionRequest.Builder avoiding the need to create one manually via CancelSchemaExtensionRequest.builder()

      Parameters:
      cancelSchemaExtensionRequest - A Consumer that will call methods on CancelSchemaExtensionRequest.Builder to create a request.
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • EntityDoesNotExistException The specified entity could not be found.
      • ClientException A client exception has occurred.
      • ServiceException An exception has occurred in Directory Service.
      • SdkException 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 type.
      See Also:

    • connectDirectory

      default CompletableFuture<ConnectDirectoryResponse> connectDirectory(ConnectDirectoryRequest connectDirectoryRequest)

      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.

      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException 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 type.
      See Also:

    • connectDirectory

      default CompletableFuture<ConnectDirectoryResponse> connectDirectory(Consumer<ConnectDirectoryRequest.Builder> connectDirectoryRequest)

      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.


      This is a convenience which creates an instance of the ConnectDirectoryRequest.Builder avoiding the need to create one manually via ConnectDirectoryRequest.builder()

      Parameters:
      connectDirectoryRequest - A Consumer that will call methods on ConnectDirectoryRequest.Builder to create a request. 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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException 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 type.
      See Also:

    • 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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException 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 type.
      See Also:

    • createAlias

      default CompletableFuture<CreateAliasResponse> createAlias(Consumer<CreateAliasRequest.Builder> 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.


      This is a convenience which creates an instance of the CreateAliasRequest.Builder avoiding the need to create one manually via CreateAliasRequest.builder()

      Parameters:
      createAliasRequest - A Consumer that will call methods on CreateAliasRequest.Builder to create a request. 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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException 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 type.
      See Also:

    • createComputer

      default CompletableFuture<CreateComputerResponse> createComputer(CreateComputerRequest createComputerRequest)

      Creates an Active Directory computer object in the specified 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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AuthenticationFailedException An authentication error occurred.
      • DirectoryUnavailableException The specified directory is unavailable.
      • 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.
      • SdkException 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 type.
      See Also:

    • createComputer

      default CompletableFuture<CreateComputerResponse> createComputer(Consumer<CreateComputerRequest.Builder> createComputerRequest)

      Creates an Active Directory computer object in the specified directory.


      This is a convenience which creates an instance of the CreateComputerRequest.Builder avoiding the need to create one manually via CreateComputerRequest.builder()

      Parameters:
      createComputerRequest - A Consumer that will call methods on CreateComputerRequest.Builder to create a request. 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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AuthenticationFailedException An authentication error occurred.
      • DirectoryUnavailableException The specified directory is unavailable.
      • 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.
      • SdkException 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 type.
      See Also:

    • createConditionalForwarder

      default CompletableFuture<CreateConditionalForwarderResponse> createConditionalForwarder(CreateConditionalForwarderRequest createConditionalForwarderRequest)

      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.

      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:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • EntityAlreadyExistsException The specified entity already exists.
      • EntityDoesNotExistException The specified entity could not be found.
      • DirectoryUnavailableException The specified directory is unavailable.
      • 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.
      • SdkException 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 type.
      See Also:

    • createConditionalForwarder

      default CompletableFuture<CreateConditionalForwarderResponse> createConditionalForwarder(Consumer<CreateConditionalForwarderRequest.Builder> createConditionalForwarderRequest)

      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.


      This is a convenience which creates an instance of the CreateConditionalForwarderRequest.Builder avoiding the need to create one manually via CreateConditionalForwarderRequest.builder()

      Parameters:
      createConditionalForwarderRequest - A Consumer that will call methods on CreateConditionalForwarderRequest.Builder to create a request. 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:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • EntityAlreadyExistsException The specified entity already exists.
      • EntityDoesNotExistException The specified entity could not be found.
      • DirectoryUnavailableException The specified directory is unavailable.
      • 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.
      • SdkException 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 type.
      See Also:

    • createDirectory

      default CompletableFuture<CreateDirectoryResponse> createDirectory(CreateDirectoryRequest createDirectoryRequest)

      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.

      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException 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 type.
      See Also:

    • createDirectory

      default CompletableFuture<CreateDirectoryResponse> createDirectory(Consumer<CreateDirectoryRequest.Builder> createDirectoryRequest)

      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.


      This is a convenience which creates an instance of the CreateDirectoryRequest.Builder avoiding the need to create one manually via CreateDirectoryRequest.builder()

      Parameters:
      createDirectoryRequest - A Consumer that will call methods on CreateDirectoryRequest.Builder to create a request. 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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException 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 type.
      See Also:

    • createHybridAD

      default CompletableFuture<CreateHybridAdResponse> createHybridAD(CreateHybridAdRequest createHybridAdRequest)

      Creates a hybrid directory that connects your self-managed Active Directory (AD) infrastructure and Amazon Web Services.

      You must have a successful directory assessment using StartADAssessment to validate your environment compatibility before you use this operation.

      Updates are applied asynchronously. Use DescribeDirectories to monitor the progress of directory creation.

      Parameters:
      createHybridAdRequest -
      Returns:
      A Java Future containing the result of the CreateHybridAD operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ClientException A client exception has occurred.
      • ServiceException An exception has occurred in Directory Service.
      • InvalidParameterException One or more parameters are not valid.
      • UnsupportedOperationException The operation is not supported.
      • 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.
      • AdAssessmentLimitExceededException A directory assessment is automatically created when you create a hybrid directory. There are two types of assessments: CUSTOMER and SYSTEM. Your Amazon Web Services account has a limit of 100 CUSTOMER directory assessments.

        If you attempt to create a hybrid directory; and you already have 100 CUSTOMER directory assessments;, you will encounter an error. Delete assessments to free up capacity before trying again.

        You can request an increase to your CUSTOMER directory assessment quota by contacting customer support or delete existing CUSTOMER directory assessments; to free up capacity.

      • EntityDoesNotExistException The specified entity could not be found.
      • SdkException 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 type.
      See Also:

    • createHybridAD

      default CompletableFuture<CreateHybridAdResponse> createHybridAD(Consumer<CreateHybridAdRequest.Builder> createHybridAdRequest)

      Creates a hybrid directory that connects your self-managed Active Directory (AD) infrastructure and Amazon Web Services.

      You must have a successful directory assessment using StartADAssessment to validate your environment compatibility before you use this operation.

      Updates are applied asynchronously. Use DescribeDirectories to monitor the progress of directory creation.


      This is a convenience which creates an instance of the CreateHybridAdRequest.Builder avoiding the need to create one manually via CreateHybridAdRequest.builder()

      Parameters:
      createHybridAdRequest - A Consumer that will call methods on CreateHybridAdRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateHybridAD operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ClientException A client exception has occurred.
      • ServiceException An exception has occurred in Directory Service.
      • InvalidParameterException One or more parameters are not valid.
      • UnsupportedOperationException The operation is not supported.
      • 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.
      • AdAssessmentLimitExceededException A directory assessment is automatically created when you create a hybrid directory. There are two types of assessments: CUSTOMER and SYSTEM. Your Amazon Web Services account has a limit of 100 CUSTOMER directory assessments.

        If you attempt to create a hybrid directory; and you already have 100 CUSTOMER directory assessments;, you will encounter an error. Delete assessments to free up capacity before trying again.

        You can request an increase to your CUSTOMER directory assessment quota by contacting customer support or delete existing CUSTOMER directory assessments; to free up capacity.

      • EntityDoesNotExistException The specified entity could not be found.
      • SdkException 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 type.
      See Also:

    • createLogSubscription

      default CompletableFuture<CreateLogSubscriptionResponse> createLogSubscription(CreateLogSubscriptionRequest createLogSubscriptionRequest)

      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.

      Parameters:
      createLogSubscriptionRequest -
      Returns:
      A Java Future containing the result of the CreateLogSubscription operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException 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 type.
      See Also:

    • createLogSubscription

      default CompletableFuture<CreateLogSubscriptionResponse> createLogSubscription(Consumer<CreateLogSubscriptionRequest.Builder> createLogSubscriptionRequest)

      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.


      This is a convenience which creates an instance of the CreateLogSubscriptionRequest.Builder avoiding the need to create one manually via CreateLogSubscriptionRequest.builder()

      Parameters:
      createLogSubscriptionRequest - A Consumer that will call methods on CreateLogSubscriptionRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateLogSubscription operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException 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 type.
      See Also:

    • createMicrosoftAD

      default CompletableFuture<CreateMicrosoftAdResponse> createMicrosoftAD(CreateMicrosoftAdRequest createMicrosoftAdRequest)

      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.

      Parameters:
      createMicrosoftAdRequest - Creates an Managed Microsoft AD directory.
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException 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 type.
      See Also:

    • createMicrosoftAD

      default CompletableFuture<CreateMicrosoftAdResponse> createMicrosoftAD(Consumer<CreateMicrosoftAdRequest.Builder> createMicrosoftAdRequest)

      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.


      This is a convenience which creates an instance of the CreateMicrosoftAdRequest.Builder avoiding the need to create one manually via CreateMicrosoftAdRequest.builder()

      Parameters:
      createMicrosoftAdRequest - A Consumer that will call methods on CreateMicrosoftAdRequest.Builder to create a request. Creates an Managed Microsoft AD directory.
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException 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 type.
      See Also:

    • createSnapshot

      default CompletableFuture<CreateSnapshotResponse> createSnapshot(CreateSnapshotRequest createSnapshotRequest)

      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.

      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException 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 type.
      See Also:

    • createSnapshot

      default CompletableFuture<CreateSnapshotResponse> createSnapshot(Consumer<CreateSnapshotRequest.Builder> createSnapshotRequest)

      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.


      This is a convenience which creates an instance of the CreateSnapshotRequest.Builder avoiding the need to create one manually via CreateSnapshotRequest.builder()

      Parameters:
      createSnapshotRequest - A Consumer that will call methods on CreateSnapshotRequest.Builder to create a request. 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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException 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 type.
      See Also:

    • createTrust

      default CompletableFuture<CreateTrustResponse> createTrust(CreateTrustRequest 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. You can create either a forest trust or an external trust.

      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:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException 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 type.
      See Also:

    • createTrust

      default CompletableFuture<CreateTrustResponse> createTrust(Consumer<CreateTrustRequest.Builder> 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. You can create either a forest trust or an external trust.


      This is a convenience which creates an instance of the CreateTrustRequest.Builder avoiding the need to create one manually via CreateTrustRequest.builder()

      Parameters:
      createTrustRequest - A Consumer that will call methods on CreateTrustRequest.Builder to create a 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.

      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException 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 type.
      See Also:

    • deleteADAssessment

      default CompletableFuture<DeleteAdAssessmentResponse> deleteADAssessment(DeleteAdAssessmentRequest deleteAdAssessmentRequest)

      Deletes a directory assessment and all associated data. This operation permanently removes the assessment results, validation reports, and configuration information.

      You cannot delete system-initiated assessments. You can delete customer-created assessments even if they are in progress.

      Parameters:
      deleteAdAssessmentRequest -
      Returns:
      A Java Future containing the result of the DeleteADAssessment operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ClientException A client exception has occurred.
      • ServiceException An exception has occurred in Directory Service.
      • InvalidParameterException One or more parameters are not valid.
      • UnsupportedOperationException The operation is not supported.
      • EntityDoesNotExistException The specified entity could not be found.
      • SdkException 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 type.
      See Also:

    • deleteADAssessment

      default CompletableFuture<DeleteAdAssessmentResponse> deleteADAssessment(Consumer<DeleteAdAssessmentRequest.Builder> deleteAdAssessmentRequest)

      Deletes a directory assessment and all associated data. This operation permanently removes the assessment results, validation reports, and configuration information.

      You cannot delete system-initiated assessments. You can delete customer-created assessments even if they are in progress.


      This is a convenience which creates an instance of the DeleteAdAssessmentRequest.Builder avoiding the need to create one manually via DeleteAdAssessmentRequest.builder()

      Parameters:
      deleteAdAssessmentRequest - A Consumer that will call methods on DeleteAdAssessmentRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteADAssessment operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ClientException A client exception has occurred.
      • ServiceException An exception has occurred in Directory Service.
      • InvalidParameterException One or more parameters are not valid.
      • UnsupportedOperationException The operation is not supported.
      • EntityDoesNotExistException The specified entity could not be found.
      • SdkException 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 type.
      See Also:

    • deleteConditionalForwarder

      default CompletableFuture<DeleteConditionalForwarderResponse> deleteConditionalForwarder(DeleteConditionalForwarderRequest deleteConditionalForwarderRequest)

      Deletes a conditional forwarder that has been set up for your Amazon Web Services 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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • EntityDoesNotExistException The specified entity could not be found.
      • DirectoryUnavailableException The specified directory is unavailable.
      • 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.
      • SdkException 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 type.
      See Also:

    • deleteConditionalForwarder

      default CompletableFuture<DeleteConditionalForwarderResponse> deleteConditionalForwarder(Consumer<DeleteConditionalForwarderRequest.Builder> deleteConditionalForwarderRequest)

      Deletes a conditional forwarder that has been set up for your Amazon Web Services directory.


      This is a convenience which creates an instance of the DeleteConditionalForwarderRequest.Builder avoiding the need to create one manually via DeleteConditionalForwarderRequest.builder()

      Parameters:
      deleteConditionalForwarderRequest - A Consumer that will call methods on DeleteConditionalForwarderRequest.Builder to create a request. 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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • EntityDoesNotExistException The specified entity could not be found.
      • DirectoryUnavailableException The specified directory is unavailable.
      • 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.
      • SdkException 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 type.
      See Also:

    • deleteDirectory

      default CompletableFuture<DeleteDirectoryResponse> deleteDirectory(DeleteDirectoryRequest deleteDirectoryRequest)

      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.

      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • EntityDoesNotExistException The specified entity could not be found.
      • ClientException A client exception has occurred.
      • ServiceException An exception has occurred in Directory Service.
      • SdkException 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 type.
      See Also:

    • deleteDirectory

      default CompletableFuture<DeleteDirectoryResponse> deleteDirectory(Consumer<DeleteDirectoryRequest.Builder> deleteDirectoryRequest)

      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.


      This is a convenience which creates an instance of the DeleteDirectoryRequest.Builder avoiding the need to create one manually via DeleteDirectoryRequest.builder()

      Parameters:
      deleteDirectoryRequest - A Consumer that will call methods on DeleteDirectoryRequest.Builder to create a request. 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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • EntityDoesNotExistException The specified entity could not be found.
      • ClientException A client exception has occurred.
      • ServiceException An exception has occurred in Directory Service.
      • SdkException 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 type.
      See Also:

    • deleteLogSubscription

      default CompletableFuture<DeleteLogSubscriptionResponse> deleteLogSubscription(DeleteLogSubscriptionRequest deleteLogSubscriptionRequest)

      Deletes the specified log subscription.

      Parameters:
      deleteLogSubscriptionRequest -
      Returns:
      A Java Future containing the result of the DeleteLogSubscription operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException 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 type.
      See Also:

    • deleteLogSubscription

      default CompletableFuture<DeleteLogSubscriptionResponse> deleteLogSubscription(Consumer<DeleteLogSubscriptionRequest.Builder> deleteLogSubscriptionRequest)

      Deletes the specified log subscription.


      This is a convenience which creates an instance of the DeleteLogSubscriptionRequest.Builder avoiding the need to create one manually via DeleteLogSubscriptionRequest.builder()

      Parameters:
      deleteLogSubscriptionRequest - A Consumer that will call methods on DeleteLogSubscriptionRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteLogSubscription operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException 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 type.
      See Also:

    • 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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException 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 type.
      See Also:

    • deleteSnapshot

      default CompletableFuture<DeleteSnapshotResponse> deleteSnapshot(Consumer<DeleteSnapshotRequest.Builder> deleteSnapshotRequest)

      Deletes a directory snapshot.


      This is a convenience which creates an instance of the DeleteSnapshotRequest.Builder avoiding the need to create one manually via DeleteSnapshotRequest.builder()

      Parameters:
      deleteSnapshotRequest - A Consumer that will call methods on DeleteSnapshotRequest.Builder to create a request. 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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException 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 type.
      See Also:

    • deleteTrust

      default CompletableFuture<DeleteTrustResponse> deleteTrust(DeleteTrustRequest deleteTrustRequest)

      Deletes an existing trust relationship between your Managed Microsoft AD directory and an external domain.

      Parameters:
      deleteTrustRequest - Deletes the local side of an existing trust relationship between the Managed Microsoft AD directory 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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException 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 type.
      See Also:

    • deleteTrust

      default CompletableFuture<DeleteTrustResponse> deleteTrust(Consumer<DeleteTrustRequest.Builder> deleteTrustRequest)

      Deletes an existing trust relationship between your Managed Microsoft AD directory and an external domain.


      This is a convenience which creates an instance of the DeleteTrustRequest.Builder avoiding the need to create one manually via DeleteTrustRequest.builder()

      Parameters:
      deleteTrustRequest - A Consumer that will call methods on DeleteTrustRequest.Builder to create a request. Deletes the local side of an existing trust relationship between the Managed Microsoft AD directory 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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException 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 type.
      See Also:

    • deregisterCertificate

      default CompletableFuture<DeregisterCertificateResponse> deregisterCertificate(DeregisterCertificateRequest deregisterCertificateRequest)

      Deletes from the system the certificate that was registered for secure LDAP or client certificate authentication.

      Parameters:
      deregisterCertificateRequest -
      Returns:
      A Java Future containing the result of the DeregisterCertificate operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • DirectoryUnavailableException The specified directory is unavailable.
      • 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.
      • SdkException 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 type.
      See Also:

    • deregisterCertificate

      default CompletableFuture<DeregisterCertificateResponse> deregisterCertificate(Consumer<DeregisterCertificateRequest.Builder> deregisterCertificateRequest)

      Deletes from the system the certificate that was registered for secure LDAP or client certificate authentication.


      This is a convenience which creates an instance of the DeregisterCertificateRequest.Builder avoiding the need to create one manually via DeregisterCertificateRequest.builder()

      Parameters:
      deregisterCertificateRequest - A Consumer that will call methods on DeregisterCertificateRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeregisterCertificate operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • DirectoryUnavailableException The specified directory is unavailable.
      • 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.
      • SdkException 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 type.
      See Also:

    • deregisterEventTopic

      default CompletableFuture<DeregisterEventTopicResponse> deregisterEventTopic(DeregisterEventTopicRequest deregisterEventTopicRequest)

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

      Parameters:
      deregisterEventTopicRequest - Removes the specified directory as a publisher to the specified Amazon 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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException 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 type.
      See Also:

    • deregisterEventTopic

      default CompletableFuture<DeregisterEventTopicResponse> deregisterEventTopic(Consumer<DeregisterEventTopicRequest.Builder> deregisterEventTopicRequest)

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


      This is a convenience which creates an instance of the DeregisterEventTopicRequest.Builder avoiding the need to create one manually via DeregisterEventTopicRequest.builder()

      Parameters:
      deregisterEventTopicRequest - A Consumer that will call methods on DeregisterEventTopicRequest.Builder to create a request. Removes the specified directory as a publisher to the specified Amazon 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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException 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 type.
      See Also:

    • describeADAssessment

      default CompletableFuture<DescribeAdAssessmentResponse> describeADAssessment(DescribeAdAssessmentRequest describeAdAssessmentRequest)

      Retrieves detailed information about a directory assessment, including its current status, validation results, and configuration details. Use this operation to monitor assessment progress and review results.

      Parameters:
      describeAdAssessmentRequest -
      Returns:
      A Java Future containing the result of the DescribeADAssessment operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ClientException A client exception has occurred.
      • ServiceException An exception has occurred in Directory Service.
      • InvalidParameterException One or more parameters are not valid.
      • UnsupportedOperationException The operation is not supported.
      • EntityDoesNotExistException The specified entity could not be found.
      • SdkException 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 type.
      See Also:

    • describeADAssessment

      default CompletableFuture<DescribeAdAssessmentResponse> describeADAssessment(Consumer<DescribeAdAssessmentRequest.Builder> describeAdAssessmentRequest)

      Retrieves detailed information about a directory assessment, including its current status, validation results, and configuration details. Use this operation to monitor assessment progress and review results.


      This is a convenience which creates an instance of the DescribeAdAssessmentRequest.Builder avoiding the need to create one manually via DescribeAdAssessmentRequest.builder()

      Parameters:
      describeAdAssessmentRequest - A Consumer that will call methods on DescribeAdAssessmentRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeADAssessment operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ClientException A client exception has occurred.
      • ServiceException An exception has occurred in Directory Service.
      • InvalidParameterException One or more parameters are not valid.
      • UnsupportedOperationException The operation is not supported.
      • EntityDoesNotExistException The specified entity could not be found.
      • SdkException 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 type.
      See Also:

    • describeCAEnrollmentPolicy

      default CompletableFuture<DescribeCaEnrollmentPolicyResponse> describeCAEnrollmentPolicy(DescribeCaEnrollmentPolicyRequest describeCaEnrollmentPolicyRequest)

      Retrieves detailed information about the certificate authority (CA) enrollment policy for the specified directory. This policy determines how client certificates are automatically enrolled and managed through Amazon Web Services Private Certificate Authority.

      Parameters:
      describeCaEnrollmentPolicyRequest - Contains the inputs for the DescribeCAEnrollmentPolicy operation.
      Returns:
      A Java Future containing the result of the DescribeCAEnrollmentPolicy operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • DirectoryDoesNotExistException The specified directory does not exist in the system.
      • UnsupportedOperationException The operation is not supported.
      • ClientException A client exception has occurred.
      • ServiceException An exception has occurred in Directory Service.
      • SdkException 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 type.
      See Also:

    • describeCAEnrollmentPolicy

      default CompletableFuture<DescribeCaEnrollmentPolicyResponse> describeCAEnrollmentPolicy(Consumer<DescribeCaEnrollmentPolicyRequest.Builder> describeCaEnrollmentPolicyRequest)

      Retrieves detailed information about the certificate authority (CA) enrollment policy for the specified directory. This policy determines how client certificates are automatically enrolled and managed through Amazon Web Services Private Certificate Authority.


      This is a convenience which creates an instance of the DescribeCaEnrollmentPolicyRequest.Builder avoiding the need to create one manually via DescribeCaEnrollmentPolicyRequest.builder()

      Parameters:
      describeCaEnrollmentPolicyRequest - A Consumer that will call methods on DescribeCaEnrollmentPolicyRequest.Builder to create a request. Contains the inputs for the DescribeCAEnrollmentPolicy operation.
      Returns:
      A Java Future containing the result of the DescribeCAEnrollmentPolicy operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • DirectoryDoesNotExistException The specified directory does not exist in the system.
      • UnsupportedOperationException The operation is not supported.
      • ClientException A client exception has occurred.
      • ServiceException An exception has occurred in Directory Service.
      • SdkException 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 type.
      See Also:

    • describeCertificate

      default CompletableFuture<DescribeCertificateResponse> describeCertificate(DescribeCertificateRequest describeCertificateRequest)

      Displays information about the certificate registered for secure LDAP or client certificate authentication.

      Parameters:
      describeCertificateRequest -
      Returns:
      A Java Future containing the result of the DescribeCertificate operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException 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 type.
      See Also:

    • describeCertificate

      default CompletableFuture<DescribeCertificateResponse> describeCertificate(Consumer<DescribeCertificateRequest.Builder> describeCertificateRequest)

      Displays information about the certificate registered for secure LDAP or client certificate authentication.


      This is a convenience which creates an instance of the DescribeCertificateRequest.Builder avoiding the need to create one manually via DescribeCertificateRequest.builder()

      Parameters:
      describeCertificateRequest - A Consumer that will call methods on DescribeCertificateRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeCertificate operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException 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 type.
      See Also:

    • describeClientAuthenticationSettings

      default CompletableFuture<DescribeClientAuthenticationSettingsResponse> describeClientAuthenticationSettings(DescribeClientAuthenticationSettingsRequest describeClientAuthenticationSettingsRequest)

      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.

      Parameters:
      describeClientAuthenticationSettingsRequest -
      Returns:
      A Java Future containing the result of the DescribeClientAuthenticationSettings operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • DirectoryDoesNotExistException The specified directory does not exist in the system.
      • UnsupportedOperationException The operation is not supported.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • InvalidParameterException One or more parameters are not valid.
      • ClientException A client exception has occurred.
      • ServiceException An exception has occurred in Directory Service.
      • SdkException 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 type.
      See Also:

    • describeClientAuthenticationSettings

      default CompletableFuture<DescribeClientAuthenticationSettingsResponse> describeClientAuthenticationSettings(Consumer<DescribeClientAuthenticationSettingsRequest.Builder> describeClientAuthenticationSettingsRequest)

      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.


      This is a convenience which creates an instance of the DescribeClientAuthenticationSettingsRequest.Builder avoiding the need to create one manually via DescribeClientAuthenticationSettingsRequest.builder()

      Parameters:
      describeClientAuthenticationSettingsRequest - A Consumer that will call methods on DescribeClientAuthenticationSettingsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeClientAuthenticationSettings operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • DirectoryDoesNotExistException The specified directory does not exist in the system.
      • UnsupportedOperationException The operation is not supported.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • InvalidParameterException One or more parameters are not valid.
      • ClientException A client exception has occurred.
      • ServiceException An exception has occurred in Directory Service.
      • SdkException 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 type.
      See Also:

    • describeClientAuthenticationSettingsPaginator

      default DescribeClientAuthenticationSettingsPublisher describeClientAuthenticationSettingsPaginator(DescribeClientAuthenticationSettingsRequest describeClientAuthenticationSettingsRequest)

      This is a variant of describeClientAuthenticationSettings(software.amazon.awssdk.services.directory.model.DescribeClientAuthenticationSettingsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.directory.paginators.DescribeClientAuthenticationSettingsPublisher publisher = client.describeClientAuthenticationSettingsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.directory.paginators.DescribeClientAuthenticationSettingsPublisher publisher = client.describeClientAuthenticationSettingsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.directory.model.DescribeClientAuthenticationSettingsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.directory.model.DescribeClientAuthenticationSettingsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of Limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the describeClientAuthenticationSettings(software.amazon.awssdk.services.directory.model.DescribeClientAuthenticationSettingsRequest) operation.

      Parameters:
      describeClientAuthenticationSettingsRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • DirectoryDoesNotExistException The specified directory does not exist in the system.
      • UnsupportedOperationException The operation is not supported.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • InvalidParameterException One or more parameters are not valid.
      • ClientException A client exception has occurred.
      • ServiceException An exception has occurred in Directory Service.
      • SdkException 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 type.
      See Also:

    • describeClientAuthenticationSettingsPaginator

      default DescribeClientAuthenticationSettingsPublisher describeClientAuthenticationSettingsPaginator(Consumer<DescribeClientAuthenticationSettingsRequest.Builder> describeClientAuthenticationSettingsRequest)

      This is a variant of describeClientAuthenticationSettings(software.amazon.awssdk.services.directory.model.DescribeClientAuthenticationSettingsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.directory.paginators.DescribeClientAuthenticationSettingsPublisher publisher = client.describeClientAuthenticationSettingsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.directory.paginators.DescribeClientAuthenticationSettingsPublisher publisher = client.describeClientAuthenticationSettingsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.directory.model.DescribeClientAuthenticationSettingsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.directory.model.DescribeClientAuthenticationSettingsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of Limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the describeClientAuthenticationSettings(software.amazon.awssdk.services.directory.model.DescribeClientAuthenticationSettingsRequest) operation.


      This is a convenience which creates an instance of the DescribeClientAuthenticationSettingsRequest.Builder avoiding the need to create one manually via DescribeClientAuthenticationSettingsRequest.builder()

      Parameters:
      describeClientAuthenticationSettingsRequest - A Consumer that will call methods on DescribeClientAuthenticationSettingsRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • DirectoryDoesNotExistException The specified directory does not exist in the system.
      • UnsupportedOperationException The operation is not supported.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • InvalidParameterException One or more parameters are not valid.
      • ClientException A client exception has occurred.
      • ServiceException An exception has occurred in Directory Service.
      • SdkException 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 type.
      See Also:

    • 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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • EntityDoesNotExistException The specified entity could not be found.
      • DirectoryUnavailableException The specified directory is unavailable.
      • 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.
      • SdkException 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 type.
      See Also:

    • describeConditionalForwarders

      default CompletableFuture<DescribeConditionalForwardersResponse> describeConditionalForwarders(Consumer<DescribeConditionalForwardersRequest.Builder> 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.


      This is a convenience which creates an instance of the DescribeConditionalForwardersRequest.Builder avoiding the need to create one manually via DescribeConditionalForwardersRequest.builder()

      Parameters:
      describeConditionalForwardersRequest - A Consumer that will call methods on DescribeConditionalForwardersRequest.Builder to create a request. 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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • EntityDoesNotExistException The specified entity could not be found.
      • DirectoryUnavailableException The specified directory is unavailable.
      • 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.
      • SdkException 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 type.
      See Also:

    • 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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException 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 type.
      See Also:

    • describeDirectories

      default CompletableFuture<DescribeDirectoriesResponse> describeDirectories(Consumer<DescribeDirectoriesRequest.Builder> 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.


      This is a convenience which creates an instance of the DescribeDirectoriesRequest.Builder avoiding the need to create one manually via DescribeDirectoriesRequest.builder()

      Parameters:
      describeDirectoriesRequest - A Consumer that will call methods on DescribeDirectoriesRequest.Builder to create a request. 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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException 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 type.
      See Also:

    • describeDirectories

      default CompletableFuture<DescribeDirectoriesResponse> describeDirectories()

      Obtains information about the directories that belong to this account.

      You can retrieve information about specific directories by passing the directory identifiers in the DirectoryIds parameter. Otherwise, all directories that belong to the current account are returned.

      This operation supports pagination with the use of the NextToken request and response parameters. If more results are available, the DescribeDirectoriesResult.NextToken member contains a token that you pass in the next call to DescribeDirectories to retrieve the next set of items.

      You can also specify a maximum number of return results with the Limit parameter.

      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException 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 type.
      See Also:

    • describeDirectoriesPaginator

      default DescribeDirectoriesPublisher describeDirectoriesPaginator()

      This is a variant of describeDirectories(software.amazon.awssdk.services.directory.model.DescribeDirectoriesRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.directory.paginators.DescribeDirectoriesPublisher publisher = client.describeDirectoriesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.directory.paginators.DescribeDirectoriesPublisher publisher = client.describeDirectoriesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.directory.model.DescribeDirectoriesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.directory.model.DescribeDirectoriesResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of Limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the describeDirectories(software.amazon.awssdk.services.directory.model.DescribeDirectoriesRequest) operation.

      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException 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 type.
      See Also:

    • describeDirectoriesPaginator

      default DescribeDirectoriesPublisher describeDirectoriesPaginator(DescribeDirectoriesRequest describeDirectoriesRequest)

      This is a variant of describeDirectories(software.amazon.awssdk.services.directory.model.DescribeDirectoriesRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.directory.paginators.DescribeDirectoriesPublisher publisher = client.describeDirectoriesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.directory.paginators.DescribeDirectoriesPublisher publisher = client.describeDirectoriesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.directory.model.DescribeDirectoriesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.directory.model.DescribeDirectoriesResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of Limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the describeDirectories(software.amazon.awssdk.services.directory.model.DescribeDirectoriesRequest) operation.

      Parameters:
      describeDirectoriesRequest - Contains the inputs for the DescribeDirectories operation.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException 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 type.
      See Also:

    • describeDirectoriesPaginator

      default DescribeDirectoriesPublisher describeDirectoriesPaginator(Consumer<DescribeDirectoriesRequest.Builder> describeDirectoriesRequest)

      This is a variant of describeDirectories(software.amazon.awssdk.services.directory.model.DescribeDirectoriesRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.directory.paginators.DescribeDirectoriesPublisher publisher = client.describeDirectoriesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.directory.paginators.DescribeDirectoriesPublisher publisher = client.describeDirectoriesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.directory.model.DescribeDirectoriesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.directory.model.DescribeDirectoriesResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of Limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the describeDirectories(software.amazon.awssdk.services.directory.model.DescribeDirectoriesRequest) operation.


      This is a convenience which creates an instance of the DescribeDirectoriesRequest.Builder avoiding the need to create one manually via DescribeDirectoriesRequest.builder()

      Parameters:
      describeDirectoriesRequest - A Consumer that will call methods on DescribeDirectoriesRequest.Builder to create a request. Contains the inputs for the DescribeDirectories operation.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException 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 type.
      See Also:

    • describeDirectoryDataAccess

      default CompletableFuture<DescribeDirectoryDataAccessResponse> describeDirectoryDataAccess(DescribeDirectoryDataAccessRequest describeDirectoryDataAccessRequest)

      Obtains status of directory data access enablement through the Directory Service Data API for the specified directory.

      Parameters:
      describeDirectoryDataAccessRequest -
      Returns:
      A Java Future containing the result of the DescribeDirectoryDataAccess operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • DirectoryDoesNotExistException The specified directory does not exist in the system.
      • UnsupportedOperationException The operation is not supported.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ClientException A client exception has occurred.
      • ServiceException An exception has occurred in Directory Service.
      • SdkException 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 type.
      See Also:

    • describeDirectoryDataAccess

      default CompletableFuture<DescribeDirectoryDataAccessResponse> describeDirectoryDataAccess(Consumer<DescribeDirectoryDataAccessRequest.Builder> describeDirectoryDataAccessRequest)

      Obtains status of directory data access enablement through the Directory Service Data API for the specified directory.


      This is a convenience which creates an instance of the DescribeDirectoryDataAccessRequest.Builder avoiding the need to create one manually via DescribeDirectoryDataAccessRequest.builder()

      Parameters:
      describeDirectoryDataAccessRequest - A Consumer that will call methods on DescribeDirectoryDataAccessRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeDirectoryDataAccess operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • DirectoryDoesNotExistException The specified directory does not exist in the system.
      • UnsupportedOperationException The operation is not supported.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ClientException A client exception has occurred.
      • ServiceException An exception has occurred in Directory Service.
      • SdkException 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 type.
      See Also:

    • describeDomainControllers

      default CompletableFuture<DescribeDomainControllersResponse> describeDomainControllers(DescribeDomainControllersRequest describeDomainControllersRequest)

      Provides information about any domain controllers in your directory.

      Parameters:
      describeDomainControllersRequest -
      Returns:
      A Java Future containing the result of the DescribeDomainControllers operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException 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 type.
      See Also:

    • describeDomainControllers

      default CompletableFuture<DescribeDomainControllersResponse> describeDomainControllers(Consumer<DescribeDomainControllersRequest.Builder> describeDomainControllersRequest)

      Provides information about any domain controllers in your directory.


      This is a convenience which creates an instance of the DescribeDomainControllersRequest.Builder avoiding the need to create one manually via DescribeDomainControllersRequest.builder()

      Parameters:
      describeDomainControllersRequest - A Consumer that will call methods on DescribeDomainControllersRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeDomainControllers operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException 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 type.
      See Also:

    • describeDomainControllersPaginator

      default DescribeDomainControllersPublisher describeDomainControllersPaginator(DescribeDomainControllersRequest describeDomainControllersRequest)

      This is a variant of describeDomainControllers(software.amazon.awssdk.services.directory.model.DescribeDomainControllersRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.directory.paginators.DescribeDomainControllersPublisher publisher = client.describeDomainControllersPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.directory.paginators.DescribeDomainControllersPublisher publisher = client.describeDomainControllersPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.directory.model.DescribeDomainControllersResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.directory.model.DescribeDomainControllersResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of Limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the describeDomainControllers(software.amazon.awssdk.services.directory.model.DescribeDomainControllersRequest) operation.

      Parameters:
      describeDomainControllersRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException 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 type.
      See Also:

    • describeDomainControllersPaginator

      default DescribeDomainControllersPublisher describeDomainControllersPaginator(Consumer<DescribeDomainControllersRequest.Builder> describeDomainControllersRequest)

      This is a variant of describeDomainControllers(software.amazon.awssdk.services.directory.model.DescribeDomainControllersRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.directory.paginators.DescribeDomainControllersPublisher publisher = client.describeDomainControllersPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.directory.paginators.DescribeDomainControllersPublisher publisher = client.describeDomainControllersPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.directory.model.DescribeDomainControllersResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.directory.model.DescribeDomainControllersResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of Limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the describeDomainControllers(software.amazon.awssdk.services.directory.model.DescribeDomainControllersRequest) operation.


      This is a convenience which creates an instance of the DescribeDomainControllersRequest.Builder avoiding the need to create one manually via DescribeDomainControllersRequest.builder()

      Parameters:
      describeDomainControllersRequest - A Consumer that will call methods on DescribeDomainControllersRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException 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 type.
      See Also:

    • describeEventTopics

      default CompletableFuture<DescribeEventTopicsResponse> describeEventTopics(DescribeEventTopicsRequest describeEventTopicsRequest)

      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.

      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException 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 type.
      See Also:

    • describeEventTopics

      default CompletableFuture<DescribeEventTopicsResponse> describeEventTopics(Consumer<DescribeEventTopicsRequest.Builder> describeEventTopicsRequest)

      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.


      This is a convenience which creates an instance of the DescribeEventTopicsRequest.Builder avoiding the need to create one manually via DescribeEventTopicsRequest.builder()

      Parameters:
      describeEventTopicsRequest - A Consumer that will call methods on DescribeEventTopicsRequest.Builder to create a request. 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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException 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 type.
      See Also:

    • describeEventTopics

      default CompletableFuture<DescribeEventTopicsResponse> describeEventTopics()

      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.

      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException 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 type.
      See Also:

    • describeHybridADUpdate

      default CompletableFuture<DescribeHybridAdUpdateResponse> describeHybridADUpdate(DescribeHybridAdUpdateRequest describeHybridAdUpdateRequest)

      Retrieves information about update activities for a hybrid directory. This operation provides details about configuration changes, administrator account updates, and self-managed instance settings (IDs and DNS IPs).

      Parameters:
      describeHybridAdUpdateRequest -
      Returns:
      A Java Future containing the result of the DescribeHybridADUpdate operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ClientException A client exception has occurred.
      • ServiceException An exception has occurred in Directory Service.
      • UnsupportedOperationException The operation is not supported.
      • DirectoryDoesNotExistException The specified directory does not exist in the system.
      • InvalidParameterException One or more parameters are not valid.
      • InvalidNextTokenException The NextToken value is not valid.
      • SdkException 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 type.
      See Also:

    • describeHybridADUpdate

      default CompletableFuture<DescribeHybridAdUpdateResponse> describeHybridADUpdate(Consumer<DescribeHybridAdUpdateRequest.Builder> describeHybridAdUpdateRequest)

      Retrieves information about update activities for a hybrid directory. This operation provides details about configuration changes, administrator account updates, and self-managed instance settings (IDs and DNS IPs).


      This is a convenience which creates an instance of the DescribeHybridAdUpdateRequest.Builder avoiding the need to create one manually via DescribeHybridAdUpdateRequest.builder()

      Parameters:
      describeHybridAdUpdateRequest - A Consumer that will call methods on DescribeHybridAdUpdateRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeHybridADUpdate operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ClientException A client exception has occurred.
      • ServiceException An exception has occurred in Directory Service.
      • UnsupportedOperationException The operation is not supported.
      • DirectoryDoesNotExistException The specified directory does not exist in the system.
      • InvalidParameterException One or more parameters are not valid.
      • InvalidNextTokenException The NextToken value is not valid.
      • SdkException 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 type.
      See Also:

    • describeLDAPSSettings

      default CompletableFuture<DescribeLdapsSettingsResponse> describeLDAPSSettings(DescribeLdapsSettingsRequest describeLdapsSettingsRequest)

      Describes the status of LDAP security for the specified directory.

      Parameters:
      describeLdapsSettingsRequest -
      Returns:
      A Java Future containing the result of the DescribeLDAPSSettings operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException 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 type.
      See Also:

    • describeLDAPSSettings

      default CompletableFuture<DescribeLdapsSettingsResponse> describeLDAPSSettings(Consumer<DescribeLdapsSettingsRequest.Builder> describeLdapsSettingsRequest)

      Describes the status of LDAP security for the specified directory.


      This is a convenience which creates an instance of the DescribeLdapsSettingsRequest.Builder avoiding the need to create one manually via DescribeLdapsSettingsRequest.builder()

      Parameters:
      describeLdapsSettingsRequest - A Consumer that will call methods on DescribeLdapsSettingsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeLDAPSSettings operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException 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 type.
      See Also:

    • describeLDAPSSettingsPaginator

      default DescribeLDAPSSettingsPublisher describeLDAPSSettingsPaginator(DescribeLdapsSettingsRequest describeLdapsSettingsRequest)

      This is a variant of describeLDAPSSettings(software.amazon.awssdk.services.directory.model.DescribeLdapsSettingsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.directory.paginators.DescribeLDAPSSettingsPublisher publisher = client.describeLDAPSSettingsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.directory.paginators.DescribeLDAPSSettingsPublisher publisher = client.describeLDAPSSettingsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.directory.model.DescribeLdapsSettingsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.directory.model.DescribeLdapsSettingsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of Limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the describeLDAPSSettings(software.amazon.awssdk.services.directory.model.DescribeLdapsSettingsRequest) operation.

      Parameters:
      describeLdapsSettingsRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException 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 type.
      See Also:

    • describeLDAPSSettingsPaginator

      default DescribeLDAPSSettingsPublisher describeLDAPSSettingsPaginator(Consumer<DescribeLdapsSettingsRequest.Builder> describeLdapsSettingsRequest)

      This is a variant of describeLDAPSSettings(software.amazon.awssdk.services.directory.model.DescribeLdapsSettingsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.directory.paginators.DescribeLDAPSSettingsPublisher publisher = client.describeLDAPSSettingsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.directory.paginators.DescribeLDAPSSettingsPublisher publisher = client.describeLDAPSSettingsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.directory.model.DescribeLdapsSettingsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.directory.model.DescribeLdapsSettingsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of Limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the describeLDAPSSettings(software.amazon.awssdk.services.directory.model.DescribeLdapsSettingsRequest) operation.


      This is a convenience which creates an instance of the DescribeLdapsSettingsRequest.Builder avoiding the need to create one manually via DescribeLdapsSettingsRequest.builder()

      Parameters:
      describeLdapsSettingsRequest - A Consumer that will call methods on DescribeLdapsSettingsRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException 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 type.
      See Also:

    • describeRegions

      default CompletableFuture<DescribeRegionsResponse> describeRegions(DescribeRegionsRequest describeRegionsRequest)

      Provides information about the Regions that are configured for multi-Region replication.

      Parameters:
      describeRegionsRequest -
      Returns:
      A Java Future containing the result of the DescribeRegions operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 You do not have sufficient access to perform this action.
      • ClientException A client exception has occurred.
      • ServiceException An exception has occurred in Directory Service.
      • SdkException 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 type.
      See Also:

    • describeRegions

      default CompletableFuture<DescribeRegionsResponse> describeRegions(Consumer<DescribeRegionsRequest.Builder> describeRegionsRequest)

      Provides information about the Regions that are configured for multi-Region replication.


      This is a convenience which creates an instance of the DescribeRegionsRequest.Builder avoiding the need to create one manually via DescribeRegionsRequest.builder()

      Parameters:
      describeRegionsRequest - A Consumer that will call methods on DescribeRegionsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeRegions operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 You do not have sufficient access to perform this action.
      • ClientException A client exception has occurred.
      • ServiceException An exception has occurred in Directory Service.
      • SdkException 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 type.
      See Also:

    • describeRegionsPaginator

      default DescribeRegionsPublisher describeRegionsPaginator(DescribeRegionsRequest describeRegionsRequest)

      This is a variant of describeRegions(software.amazon.awssdk.services.directory.model.DescribeRegionsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.directory.paginators.DescribeRegionsPublisher publisher = client.describeRegionsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.directory.paginators.DescribeRegionsPublisher publisher = client.describeRegionsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.directory.model.DescribeRegionsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.directory.model.DescribeRegionsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the describeRegions(software.amazon.awssdk.services.directory.model.DescribeRegionsRequest) operation.

      Parameters:
      describeRegionsRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 You do not have sufficient access to perform this action.
      • ClientException A client exception has occurred.
      • ServiceException An exception has occurred in Directory Service.
      • SdkException 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 type.
      See Also:

    • describeRegionsPaginator

      default DescribeRegionsPublisher describeRegionsPaginator(Consumer<DescribeRegionsRequest.Builder> describeRegionsRequest)

      This is a variant of describeRegions(software.amazon.awssdk.services.directory.model.DescribeRegionsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.directory.paginators.DescribeRegionsPublisher publisher = client.describeRegionsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.directory.paginators.DescribeRegionsPublisher publisher = client.describeRegionsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.directory.model.DescribeRegionsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.directory.model.DescribeRegionsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the describeRegions(software.amazon.awssdk.services.directory.model.DescribeRegionsRequest) operation.


      This is a convenience which creates an instance of the DescribeRegionsRequest.Builder avoiding the need to create one manually via DescribeRegionsRequest.builder()

      Parameters:
      describeRegionsRequest - A Consumer that will call methods on DescribeRegionsRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 You do not have sufficient access to perform this action.
      • ClientException A client exception has occurred.
      • ServiceException An exception has occurred in Directory Service.
      • SdkException 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 type.
      See Also:

    • describeSettings

      default CompletableFuture<DescribeSettingsResponse> describeSettings(DescribeSettingsRequest describeSettingsRequest)

      Retrieves information about the configurable settings for the specified directory.

      Parameters:
      describeSettingsRequest -
      Returns:
      A Java Future containing the result of the DescribeSettings operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException 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 type.
      See Also:

    • describeSettings

      default CompletableFuture<DescribeSettingsResponse> describeSettings(Consumer<DescribeSettingsRequest.Builder> describeSettingsRequest)

      Retrieves information about the configurable settings for the specified directory.


      This is a convenience which creates an instance of the DescribeSettingsRequest.Builder avoiding the need to create one manually via DescribeSettingsRequest.builder()

      Parameters:
      describeSettingsRequest - A Consumer that will call methods on DescribeSettingsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeSettings operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException 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 type.
      See Also:

    • describeSharedDirectories

      default CompletableFuture<DescribeSharedDirectoriesResponse> describeSharedDirectories(DescribeSharedDirectoriesRequest describeSharedDirectoriesRequest)

      Returns the shared directories in your account.

      Parameters:
      describeSharedDirectoriesRequest -
      Returns:
      A Java Future containing the result of the DescribeSharedDirectories operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException 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 type.
      See Also:

    • describeSharedDirectories

      default CompletableFuture<DescribeSharedDirectoriesResponse> describeSharedDirectories(Consumer<DescribeSharedDirectoriesRequest.Builder> describeSharedDirectoriesRequest)

      Returns the shared directories in your account.


      This is a convenience which creates an instance of the DescribeSharedDirectoriesRequest.Builder avoiding the need to create one manually via DescribeSharedDirectoriesRequest.builder()

      Parameters:
      describeSharedDirectoriesRequest - A Consumer that will call methods on DescribeSharedDirectoriesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeSharedDirectories operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException 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 type.
      See Also:

    • describeSharedDirectoriesPaginator

      default DescribeSharedDirectoriesPublisher describeSharedDirectoriesPaginator(DescribeSharedDirectoriesRequest describeSharedDirectoriesRequest)

      This is a variant of describeSharedDirectories(software.amazon.awssdk.services.directory.model.DescribeSharedDirectoriesRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.directory.paginators.DescribeSharedDirectoriesPublisher publisher = client.describeSharedDirectoriesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.directory.paginators.DescribeSharedDirectoriesPublisher publisher = client.describeSharedDirectoriesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.directory.model.DescribeSharedDirectoriesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.directory.model.DescribeSharedDirectoriesResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of Limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the describeSharedDirectories(software.amazon.awssdk.services.directory.model.DescribeSharedDirectoriesRequest) operation.

      Parameters:
      describeSharedDirectoriesRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException 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 type.
      See Also:

    • describeSharedDirectoriesPaginator

      default DescribeSharedDirectoriesPublisher describeSharedDirectoriesPaginator(Consumer<DescribeSharedDirectoriesRequest.Builder> describeSharedDirectoriesRequest)

      This is a variant of describeSharedDirectories(software.amazon.awssdk.services.directory.model.DescribeSharedDirectoriesRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.directory.paginators.DescribeSharedDirectoriesPublisher publisher = client.describeSharedDirectoriesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.directory.paginators.DescribeSharedDirectoriesPublisher publisher = client.describeSharedDirectoriesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.directory.model.DescribeSharedDirectoriesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.directory.model.DescribeSharedDirectoriesResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of Limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the describeSharedDirectories(software.amazon.awssdk.services.directory.model.DescribeSharedDirectoriesRequest) operation.


      This is a convenience which creates an instance of the DescribeSharedDirectoriesRequest.Builder avoiding the need to create one manually via DescribeSharedDirectoriesRequest.builder()

      Parameters:
      describeSharedDirectoriesRequest - A Consumer that will call methods on DescribeSharedDirectoriesRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException 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 type.
      See Also:

    • 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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException 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 type.
      See Also:

    • describeSnapshots

      default CompletableFuture<DescribeSnapshotsResponse> describeSnapshots(Consumer<DescribeSnapshotsRequest.Builder> 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.


      This is a convenience which creates an instance of the DescribeSnapshotsRequest.Builder avoiding the need to create one manually via DescribeSnapshotsRequest.builder()

      Parameters:
      describeSnapshotsRequest - A Consumer that will call methods on DescribeSnapshotsRequest.Builder to create a request. 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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException 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 type.
      See Also:

    • describeSnapshots

      default CompletableFuture<DescribeSnapshotsResponse> describeSnapshots()

      Obtains information about the directory snapshots that belong to this account.

      This operation supports pagination with the use of the NextToken request and response parameters. If more results are available, the DescribeSnapshots.NextToken member contains a token that you pass in the next call to DescribeSnapshots to retrieve the next set of items.

      You can also specify a maximum number of return results with the Limit parameter.

      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException 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 type.
      See Also:

    • describeSnapshotsPaginator

      default DescribeSnapshotsPublisher describeSnapshotsPaginator()

      This is a variant of describeSnapshots(software.amazon.awssdk.services.directory.model.DescribeSnapshotsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.directory.paginators.DescribeSnapshotsPublisher publisher = client.describeSnapshotsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.directory.paginators.DescribeSnapshotsPublisher publisher = client.describeSnapshotsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.directory.model.DescribeSnapshotsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.directory.model.DescribeSnapshotsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of Limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the describeSnapshots(software.amazon.awssdk.services.directory.model.DescribeSnapshotsRequest) operation.

      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException 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 type.
      See Also:

    • describeSnapshotsPaginator

      default DescribeSnapshotsPublisher describeSnapshotsPaginator(DescribeSnapshotsRequest describeSnapshotsRequest)

      This is a variant of describeSnapshots(software.amazon.awssdk.services.directory.model.DescribeSnapshotsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.directory.paginators.DescribeSnapshotsPublisher publisher = client.describeSnapshotsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.directory.paginators.DescribeSnapshotsPublisher publisher = client.describeSnapshotsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.directory.model.DescribeSnapshotsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.directory.model.DescribeSnapshotsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of Limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the describeSnapshots(software.amazon.awssdk.services.directory.model.DescribeSnapshotsRequest) operation.

      Parameters:
      describeSnapshotsRequest - Contains the inputs for the DescribeSnapshots operation.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException 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 type.
      See Also:

    • describeSnapshotsPaginator

      default DescribeSnapshotsPublisher describeSnapshotsPaginator(Consumer<DescribeSnapshotsRequest.Builder> describeSnapshotsRequest)

      This is a variant of describeSnapshots(software.amazon.awssdk.services.directory.model.DescribeSnapshotsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.directory.paginators.DescribeSnapshotsPublisher publisher = client.describeSnapshotsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.directory.paginators.DescribeSnapshotsPublisher publisher = client.describeSnapshotsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.directory.model.DescribeSnapshotsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.directory.model.DescribeSnapshotsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of Limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the describeSnapshots(software.amazon.awssdk.services.directory.model.DescribeSnapshotsRequest) operation.


      This is a convenience which creates an instance of the DescribeSnapshotsRequest.Builder avoiding the need to create one manually via DescribeSnapshotsRequest.builder()

      Parameters:
      describeSnapshotsRequest - A Consumer that will call methods on DescribeSnapshotsRequest.Builder to create a request. Contains the inputs for the DescribeSnapshots operation.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException 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 type.
      See Also:

    • 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 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:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException 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 type.
      See Also:

    • describeTrusts

      default CompletableFuture<DescribeTrustsResponse> describeTrusts(Consumer<DescribeTrustsRequest.Builder> 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.


      This is a convenience which creates an instance of the DescribeTrustsRequest.Builder avoiding the need to create one manually via DescribeTrustsRequest.builder()

      Parameters:
      describeTrustsRequest - A Consumer that will call methods on DescribeTrustsRequest.Builder to create a request. 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:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException 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 type.
      See Also:

    • describeTrusts

      default CompletableFuture<DescribeTrustsResponse> describeTrusts()

      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.

      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException 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 type.
      See Also:

    • describeTrustsPaginator

      default DescribeTrustsPublisher describeTrustsPaginator()

      This is a variant of describeTrusts(software.amazon.awssdk.services.directory.model.DescribeTrustsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.directory.paginators.DescribeTrustsPublisher publisher = client.describeTrustsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.directory.paginators.DescribeTrustsPublisher publisher = client.describeTrustsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.directory.model.DescribeTrustsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.directory.model.DescribeTrustsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of Limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the describeTrusts(software.amazon.awssdk.services.directory.model.DescribeTrustsRequest) operation.

      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException 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 type.
      See Also:

    • describeTrustsPaginator

      default DescribeTrustsPublisher describeTrustsPaginator(DescribeTrustsRequest describeTrustsRequest)

      This is a variant of describeTrusts(software.amazon.awssdk.services.directory.model.DescribeTrustsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.directory.paginators.DescribeTrustsPublisher publisher = client.describeTrustsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.directory.paginators.DescribeTrustsPublisher publisher = client.describeTrustsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.directory.model.DescribeTrustsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.directory.model.DescribeTrustsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of Limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the describeTrusts(software.amazon.awssdk.services.directory.model.DescribeTrustsRequest) operation.

      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:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException 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 type.
      See Also:

    • describeTrustsPaginator

      default DescribeTrustsPublisher describeTrustsPaginator(Consumer<DescribeTrustsRequest.Builder> describeTrustsRequest)

      This is a variant of describeTrusts(software.amazon.awssdk.services.directory.model.DescribeTrustsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.directory.paginators.DescribeTrustsPublisher publisher = client.describeTrustsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.directory.paginators.DescribeTrustsPublisher publisher = client.describeTrustsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.directory.model.DescribeTrustsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.directory.model.DescribeTrustsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of Limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the describeTrusts(software.amazon.awssdk.services.directory.model.DescribeTrustsRequest) operation.


      This is a convenience which creates an instance of the DescribeTrustsRequest.Builder avoiding the need to create one manually via DescribeTrustsRequest.builder()

      Parameters:
      describeTrustsRequest - A Consumer that will call methods on DescribeTrustsRequest.Builder to create a request. 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:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException 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 type.
      See Also:

    • describeUpdateDirectory

      default CompletableFuture<DescribeUpdateDirectoryResponse> describeUpdateDirectory(DescribeUpdateDirectoryRequest describeUpdateDirectoryRequest)

      Describes the updates of a directory for a particular update type.

      Parameters:
      describeUpdateDirectoryRequest -
      Returns:
      A Java Future containing the result of the DescribeUpdateDirectory operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • DirectoryDoesNotExistException The specified directory does not exist in the system.
      • InvalidParameterException One or more parameters are not valid.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ClientException A client exception has occurred.
      • ServiceException An exception has occurred in Directory Service.
      • InvalidNextTokenException The NextToken value is not valid.
      • SdkException 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 type.
      See Also:

    • describeUpdateDirectory

      default CompletableFuture<DescribeUpdateDirectoryResponse> describeUpdateDirectory(Consumer<DescribeUpdateDirectoryRequest.Builder> describeUpdateDirectoryRequest)

      Describes the updates of a directory for a particular update type.


      This is a convenience which creates an instance of the DescribeUpdateDirectoryRequest.Builder avoiding the need to create one manually via DescribeUpdateDirectoryRequest.builder()

      Parameters:
      describeUpdateDirectoryRequest - A Consumer that will call methods on DescribeUpdateDirectoryRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeUpdateDirectory operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • DirectoryDoesNotExistException The specified directory does not exist in the system.
      • InvalidParameterException One or more parameters are not valid.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ClientException A client exception has occurred.
      • ServiceException An exception has occurred in Directory Service.
      • InvalidNextTokenException The NextToken value is not valid.
      • SdkException 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 type.
      See Also:

    • describeUpdateDirectoryPaginator

      default DescribeUpdateDirectoryPublisher describeUpdateDirectoryPaginator(DescribeUpdateDirectoryRequest describeUpdateDirectoryRequest)

      This is a variant of describeUpdateDirectory(software.amazon.awssdk.services.directory.model.DescribeUpdateDirectoryRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.directory.paginators.DescribeUpdateDirectoryPublisher publisher = client.describeUpdateDirectoryPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.directory.paginators.DescribeUpdateDirectoryPublisher publisher = client.describeUpdateDirectoryPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.directory.model.DescribeUpdateDirectoryResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.directory.model.DescribeUpdateDirectoryResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the describeUpdateDirectory(software.amazon.awssdk.services.directory.model.DescribeUpdateDirectoryRequest) operation.

      Parameters:
      describeUpdateDirectoryRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • DirectoryDoesNotExistException The specified directory does not exist in the system.
      • InvalidParameterException One or more parameters are not valid.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ClientException A client exception has occurred.
      • ServiceException An exception has occurred in Directory Service.
      • InvalidNextTokenException The NextToken value is not valid.
      • SdkException 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 type.
      See Also:

    • describeUpdateDirectoryPaginator

      default DescribeUpdateDirectoryPublisher describeUpdateDirectoryPaginator(Consumer<DescribeUpdateDirectoryRequest.Builder> describeUpdateDirectoryRequest)

      This is a variant of describeUpdateDirectory(software.amazon.awssdk.services.directory.model.DescribeUpdateDirectoryRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.directory.paginators.DescribeUpdateDirectoryPublisher publisher = client.describeUpdateDirectoryPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.directory.paginators.DescribeUpdateDirectoryPublisher publisher = client.describeUpdateDirectoryPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.directory.model.DescribeUpdateDirectoryResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.directory.model.DescribeUpdateDirectoryResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the describeUpdateDirectory(software.amazon.awssdk.services.directory.model.DescribeUpdateDirectoryRequest) operation.


      This is a convenience which creates an instance of the DescribeUpdateDirectoryRequest.Builder avoiding the need to create one manually via DescribeUpdateDirectoryRequest.builder()

      Parameters:
      describeUpdateDirectoryRequest - A Consumer that will call methods on DescribeUpdateDirectoryRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • DirectoryDoesNotExistException The specified directory does not exist in the system.
      • InvalidParameterException One or more parameters are not valid.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ClientException A client exception has occurred.
      • ServiceException An exception has occurred in Directory Service.
      • InvalidNextTokenException The NextToken value is not valid.
      • SdkException 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 type.
      See Also:

    • disableCAEnrollmentPolicy

      default CompletableFuture<DisableCaEnrollmentPolicyResponse> disableCAEnrollmentPolicy(DisableCaEnrollmentPolicyRequest disableCaEnrollmentPolicyRequest)

      Disables the certificate authority (CA) enrollment policy for the specified directory. This stops automatic certificate enrollment and management for domain-joined clients, but does not affect existing certificates.

      Disabling the CA enrollment policy prevents new certificates from being automatically enrolled, but existing certificates remain valid and functional until they expire.

      Parameters:
      disableCaEnrollmentPolicyRequest - Contains the inputs for the DisableCAEnrollmentPolicy operation.
      Returns:
      A Java Future containing the result of the DisableCAEnrollmentPolicy operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • DirectoryDoesNotExistException The specified directory does not exist in the system.
      • DirectoryUnavailableException The specified directory is unavailable.
      • InvalidParameterException One or more parameters are not valid.
      • DisableAlreadyInProgressException A disable operation for CA enrollment policy is already in progress for this directory.
      • EntityDoesNotExistException The specified entity could not be found.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ClientException A client exception has occurred.
      • ServiceException An exception has occurred in Directory Service.
      • SdkException 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 type.
      See Also:

    • disableCAEnrollmentPolicy

      default CompletableFuture<DisableCaEnrollmentPolicyResponse> disableCAEnrollmentPolicy(Consumer<DisableCaEnrollmentPolicyRequest.Builder> disableCaEnrollmentPolicyRequest)

      Disables the certificate authority (CA) enrollment policy for the specified directory. This stops automatic certificate enrollment and management for domain-joined clients, but does not affect existing certificates.

      Disabling the CA enrollment policy prevents new certificates from being automatically enrolled, but existing certificates remain valid and functional until they expire.


      This is a convenience which creates an instance of the DisableCaEnrollmentPolicyRequest.Builder avoiding the need to create one manually via DisableCaEnrollmentPolicyRequest.builder()

      Parameters:
      disableCaEnrollmentPolicyRequest - A Consumer that will call methods on DisableCaEnrollmentPolicyRequest.Builder to create a request. Contains the inputs for the DisableCAEnrollmentPolicy operation.
      Returns:
      A Java Future containing the result of the DisableCAEnrollmentPolicy operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • DirectoryDoesNotExistException The specified directory does not exist in the system.
      • DirectoryUnavailableException The specified directory is unavailable.
      • InvalidParameterException One or more parameters are not valid.
      • DisableAlreadyInProgressException A disable operation for CA enrollment policy is already in progress for this directory.
      • EntityDoesNotExistException The specified entity could not be found.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ClientException A client exception has occurred.
      • ServiceException An exception has occurred in Directory Service.
      • SdkException 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 type.
      See Also:

    • disableClientAuthentication

      default CompletableFuture<DisableClientAuthenticationResponse> disableClientAuthentication(DisableClientAuthenticationRequest disableClientAuthenticationRequest)

      Disables alternative client authentication methods for the specified directory.

      Parameters:
      disableClientAuthenticationRequest -
      Returns:
      A Java Future containing the result of the DisableClientAuthentication operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • DirectoryDoesNotExistException The specified directory does not exist in the system.
      • UnsupportedOperationException The operation is not supported.
      • InvalidClientAuthStatusException Client authentication is already enabled.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ClientException A client exception has occurred.
      • ServiceException An exception has occurred in Directory Service.
      • SdkException 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 type.
      See Also:

    • disableClientAuthentication

      default CompletableFuture<DisableClientAuthenticationResponse> disableClientAuthentication(Consumer<DisableClientAuthenticationRequest.Builder> disableClientAuthenticationRequest)

      Disables alternative client authentication methods for the specified directory.


      This is a convenience which creates an instance of the DisableClientAuthenticationRequest.Builder avoiding the need to create one manually via DisableClientAuthenticationRequest.builder()

      Parameters:
      disableClientAuthenticationRequest - A Consumer that will call methods on DisableClientAuthenticationRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DisableClientAuthentication operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • DirectoryDoesNotExistException The specified directory does not exist in the system.
      • UnsupportedOperationException The operation is not supported.
      • InvalidClientAuthStatusException Client authentication is already enabled.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ClientException A client exception has occurred.
      • ServiceException An exception has occurred in Directory Service.
      • SdkException 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 type.
      See Also:

    • disableDirectoryDataAccess

      default CompletableFuture<DisableDirectoryDataAccessResponse> disableDirectoryDataAccess(DisableDirectoryDataAccessRequest disableDirectoryDataAccessRequest)

      Deactivates access to directory data via the Directory Service Data API for the specified directory. For more information, see Directory Service Data API Reference.

      Parameters:
      disableDirectoryDataAccessRequest -
      Returns:
      A Java Future containing the result of the DisableDirectoryDataAccess operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • DirectoryDoesNotExistException The specified directory does not exist in the system.
      • DirectoryUnavailableException The specified directory is unavailable.
      • UnsupportedOperationException The operation is not supported.
      • DirectoryInDesiredStateException The directory is already updated to desired update type settings.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ClientException A client exception has occurred.
      • ServiceException An exception has occurred in Directory Service.
      • SdkException 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 type.
      See Also:

    • disableDirectoryDataAccess

      default CompletableFuture<DisableDirectoryDataAccessResponse> disableDirectoryDataAccess(Consumer<DisableDirectoryDataAccessRequest.Builder> disableDirectoryDataAccessRequest)

      Deactivates access to directory data via the Directory Service Data API for the specified directory. For more information, see Directory Service Data API Reference.


      This is a convenience which creates an instance of the DisableDirectoryDataAccessRequest.Builder avoiding the need to create one manually via DisableDirectoryDataAccessRequest.builder()

      Parameters:
      disableDirectoryDataAccessRequest - A Consumer that will call methods on DisableDirectoryDataAccessRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DisableDirectoryDataAccess operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • DirectoryDoesNotExistException The specified directory does not exist in the system.
      • DirectoryUnavailableException The specified directory is unavailable.
      • UnsupportedOperationException The operation is not supported.
      • DirectoryInDesiredStateException The directory is already updated to desired update type settings.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ClientException A client exception has occurred.
      • ServiceException An exception has occurred in Directory Service.
      • SdkException 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 type.
      See Also:

    • disableLDAPS

      default CompletableFuture<DisableLdapsResponse> disableLDAPS(DisableLdapsRequest disableLdapsRequest)

      Deactivates LDAP secure calls for the specified directory.

      Parameters:
      disableLdapsRequest -
      Returns:
      A Java Future containing the result of the DisableLDAPS operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • DirectoryUnavailableException The specified directory is unavailable.
      • 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.
      • SdkException 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 type.
      See Also:

    • disableLDAPS

      default CompletableFuture<DisableLdapsResponse> disableLDAPS(Consumer<DisableLdapsRequest.Builder> disableLdapsRequest)

      Deactivates LDAP secure calls for the specified directory.


      This is a convenience which creates an instance of the DisableLdapsRequest.Builder avoiding the need to create one manually via DisableLdapsRequest.builder()

      Parameters:
      disableLdapsRequest - A Consumer that will call methods on DisableLdapsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DisableLDAPS operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • DirectoryUnavailableException The specified directory is unavailable.
      • 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.
      • SdkException 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 type.
      See Also:

    • 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 or Microsoft AD 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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • EntityDoesNotExistException The specified entity could not be found.
      • ClientException A client exception has occurred.
      • ServiceException An exception has occurred in Directory Service.
      • SdkException 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 type.
      See Also:

    • disableRadius

      default CompletableFuture<DisableRadiusResponse> disableRadius(Consumer<DisableRadiusRequest.Builder> disableRadiusRequest)

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


      This is a convenience which creates an instance of the DisableRadiusRequest.Builder avoiding the need to create one manually via DisableRadiusRequest.builder()

      Parameters:
      disableRadiusRequest - A Consumer that will call methods on DisableRadiusRequest.Builder to create a request. 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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • EntityDoesNotExistException The specified entity could not be found.
      • ClientException A client exception has occurred.
      • ServiceException An exception has occurred in Directory Service.
      • SdkException 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 type.
      See Also:

    • 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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException 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 type.
      See Also:

    • disableSso

      default CompletableFuture<DisableSsoResponse> disableSso(Consumer<DisableSsoRequest.Builder> disableSsoRequest)

      Disables single-sign on for a directory.


      This is a convenience which creates an instance of the DisableSsoRequest.Builder avoiding the need to create one manually via DisableSsoRequest.builder()

      Parameters:
      disableSsoRequest - A Consumer that will call methods on DisableSsoRequest.Builder to create a request. 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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException 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 type.
      See Also:

    • enableCAEnrollmentPolicy

      default CompletableFuture<EnableCaEnrollmentPolicyResponse> enableCAEnrollmentPolicy(EnableCaEnrollmentPolicyRequest enableCaEnrollmentPolicyRequest)

      Enables certificate authority (CA) enrollment policy for the specified directory. This allows domain-joined clients to automatically request and receive certificates from the specified Amazon Web Services Private Certificate Authority.

      Before enabling CA enrollment, ensure that the PCA connector is properly configured and accessible from the directory. The connector must be in an active state and have the necessary permissions.

      Parameters:
      enableCaEnrollmentPolicyRequest - Contains the inputs for the EnableCAEnrollmentPolicy operation.
      Returns:
      A Java Future containing the result of the EnableCAEnrollmentPolicy operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • DirectoryDoesNotExistException The specified directory does not exist in the system.
      • DirectoryUnavailableException The specified directory is unavailable.
      • InvalidParameterException One or more parameters are not valid.
      • EntityAlreadyExistsException The specified entity already exists.
      • EntityDoesNotExistException The specified entity could not be found.
      • EnableAlreadyInProgressException An enable operation for CA enrollment policy is already in progress for this directory.
      • ClientException A client exception has occurred.
      • ServiceException An exception has occurred in Directory Service.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • SdkException 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 type.
      See Also:

    • enableCAEnrollmentPolicy

      default CompletableFuture<EnableCaEnrollmentPolicyResponse> enableCAEnrollmentPolicy(Consumer<EnableCaEnrollmentPolicyRequest.Builder> enableCaEnrollmentPolicyRequest)

      Enables certificate authority (CA) enrollment policy for the specified directory. This allows domain-joined clients to automatically request and receive certificates from the specified Amazon Web Services Private Certificate Authority.

      Before enabling CA enrollment, ensure that the PCA connector is properly configured and accessible from the directory. The connector must be in an active state and have the necessary permissions.


      This is a convenience which creates an instance of the EnableCaEnrollmentPolicyRequest.Builder avoiding the need to create one manually via EnableCaEnrollmentPolicyRequest.builder()

      Parameters:
      enableCaEnrollmentPolicyRequest - A Consumer that will call methods on EnableCaEnrollmentPolicyRequest.Builder to create a request. Contains the inputs for the EnableCAEnrollmentPolicy operation.
      Returns:
      A Java Future containing the result of the EnableCAEnrollmentPolicy operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • DirectoryDoesNotExistException The specified directory does not exist in the system.
      • DirectoryUnavailableException The specified directory is unavailable.
      • InvalidParameterException One or more parameters are not valid.
      • EntityAlreadyExistsException The specified entity already exists.
      • EntityDoesNotExistException The specified entity could not be found.
      • EnableAlreadyInProgressException An enable operation for CA enrollment policy is already in progress for this directory.
      • ClientException A client exception has occurred.
      • ServiceException An exception has occurred in Directory Service.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • SdkException 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 type.
      See Also:

    • enableClientAuthentication

      default CompletableFuture<EnableClientAuthenticationResponse> enableClientAuthentication(EnableClientAuthenticationRequest enableClientAuthenticationRequest)

      Enables alternative client authentication methods for the specified directory.

      Parameters:
      enableClientAuthenticationRequest -
      Returns:
      A Java Future containing the result of the EnableClientAuthentication operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • DirectoryDoesNotExistException The specified directory does not exist in the system.
      • UnsupportedOperationException The operation is not supported.
      • InvalidClientAuthStatusException Client authentication is already enabled.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • 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.
      • SdkException 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 type.
      See Also:

    • enableClientAuthentication

      default CompletableFuture<EnableClientAuthenticationResponse> enableClientAuthentication(Consumer<EnableClientAuthenticationRequest.Builder> enableClientAuthenticationRequest)

      Enables alternative client authentication methods for the specified directory.


      This is a convenience which creates an instance of the EnableClientAuthenticationRequest.Builder avoiding the need to create one manually via EnableClientAuthenticationRequest.builder()

      Parameters:
      enableClientAuthenticationRequest - A Consumer that will call methods on EnableClientAuthenticationRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the EnableClientAuthentication operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • DirectoryDoesNotExistException The specified directory does not exist in the system.
      • UnsupportedOperationException The operation is not supported.
      • InvalidClientAuthStatusException Client authentication is already enabled.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • 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.
      • SdkException 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 type.
      See Also:

    • enableDirectoryDataAccess

      default CompletableFuture<EnableDirectoryDataAccessResponse> enableDirectoryDataAccess(EnableDirectoryDataAccessRequest enableDirectoryDataAccessRequest)

      Enables access to directory data via the Directory Service Data API for the specified directory. For more information, see Directory Service Data API Reference.

      Parameters:
      enableDirectoryDataAccessRequest -
      Returns:
      A Java Future containing the result of the EnableDirectoryDataAccess operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • DirectoryDoesNotExistException The specified directory does not exist in the system.
      • DirectoryUnavailableException The specified directory is unavailable.
      • UnsupportedOperationException The operation is not supported.
      • DirectoryInDesiredStateException The directory is already updated to desired update type settings.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ClientException A client exception has occurred.
      • ServiceException An exception has occurred in Directory Service.
      • SdkException 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 type.
      See Also:

    • enableDirectoryDataAccess

      default CompletableFuture<EnableDirectoryDataAccessResponse> enableDirectoryDataAccess(Consumer<EnableDirectoryDataAccessRequest.Builder> enableDirectoryDataAccessRequest)

      Enables access to directory data via the Directory Service Data API for the specified directory. For more information, see Directory Service Data API Reference.


      This is a convenience which creates an instance of the EnableDirectoryDataAccessRequest.Builder avoiding the need to create one manually via EnableDirectoryDataAccessRequest.builder()

      Parameters:
      enableDirectoryDataAccessRequest - A Consumer that will call methods on EnableDirectoryDataAccessRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the EnableDirectoryDataAccess operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • DirectoryDoesNotExistException The specified directory does not exist in the system.
      • DirectoryUnavailableException The specified directory is unavailable.
      • UnsupportedOperationException The operation is not supported.
      • DirectoryInDesiredStateException The directory is already updated to desired update type settings.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ClientException A client exception has occurred.
      • ServiceException An exception has occurred in Directory Service.
      • SdkException 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 type.
      See Also:

    • enableLDAPS

      default CompletableFuture<EnableLdapsResponse> enableLDAPS(EnableLdapsRequest enableLdapsRequest)

      Activates the switch for the specific directory to always use LDAP secure calls.

      Parameters:
      enableLdapsRequest -
      Returns:
      A Java Future containing the result of the EnableLDAPS operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • DirectoryUnavailableException The specified directory is unavailable.
      • 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.
      • SdkException 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 type.
      See Also:

    • enableLDAPS

      default CompletableFuture<EnableLdapsResponse> enableLDAPS(Consumer<EnableLdapsRequest.Builder> enableLdapsRequest)

      Activates the switch for the specific directory to always use LDAP secure calls.


      This is a convenience which creates an instance of the EnableLdapsRequest.Builder avoiding the need to create one manually via EnableLdapsRequest.builder()

      Parameters:
      enableLdapsRequest - A Consumer that will call methods on EnableLdapsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the EnableLDAPS operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • DirectoryUnavailableException The specified directory is unavailable.
      • 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.
      • SdkException 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 type.
      See Also:

    • 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 or Microsoft AD 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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException 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 type.
      See Also:

    • enableRadius

      default CompletableFuture<EnableRadiusResponse> enableRadius(Consumer<EnableRadiusRequest.Builder> enableRadiusRequest)

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


      This is a convenience which creates an instance of the EnableRadiusRequest.Builder avoiding the need to create one manually via EnableRadiusRequest.builder()

      Parameters:
      enableRadiusRequest - A Consumer that will call methods on EnableRadiusRequest.Builder to create a request. 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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException 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 type.
      See Also:

    • enableSso

      default CompletableFuture<EnableSsoResponse> enableSso(EnableSsoRequest enableSsoRequest)

      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.

      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException 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 type.
      See Also:

    • enableSso

      default CompletableFuture<EnableSsoResponse> enableSso(Consumer<EnableSsoRequest.Builder> enableSsoRequest)

      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.


      This is a convenience which creates an instance of the EnableSsoRequest.Builder avoiding the need to create one manually via EnableSsoRequest.builder()

      Parameters:
      enableSsoRequest - A Consumer that will call methods on EnableSsoRequest.Builder to create a request. 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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException 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 type.
      See Also:

    • 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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • EntityDoesNotExistException The specified entity could not be found.
      • ClientException A client exception has occurred.
      • ServiceException An exception has occurred in Directory Service.
      • SdkException 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 type.
      See Also:

    • getDirectoryLimits

      default CompletableFuture<GetDirectoryLimitsResponse> getDirectoryLimits(Consumer<GetDirectoryLimitsRequest.Builder> getDirectoryLimitsRequest)

      Obtains directory limit information for the current Region.


      This is a convenience which creates an instance of the GetDirectoryLimitsRequest.Builder avoiding the need to create one manually via GetDirectoryLimitsRequest.builder()

      Parameters:
      getDirectoryLimitsRequest - A Consumer that will call methods on GetDirectoryLimitsRequest.Builder to create a request. 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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • EntityDoesNotExistException The specified entity could not be found.
      • ClientException A client exception has occurred.
      • ServiceException An exception has occurred in Directory Service.
      • SdkException 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 type.
      See Also:

    • getDirectoryLimits

      default CompletableFuture<GetDirectoryLimitsResponse> getDirectoryLimits()

      Obtains directory limit information for the current Region.

      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • EntityDoesNotExistException The specified entity could not be found.
      • ClientException A client exception has occurred.
      • ServiceException An exception has occurred in Directory Service.
      • SdkException 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 type.
      See Also:

    • 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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • EntityDoesNotExistException The specified entity could not be found.
      • ClientException A client exception has occurred.
      • ServiceException An exception has occurred in Directory Service.
      • SdkException 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 type.
      See Also:

    • getSnapshotLimits

      default CompletableFuture<GetSnapshotLimitsResponse> getSnapshotLimits(Consumer<GetSnapshotLimitsRequest.Builder> getSnapshotLimitsRequest)

      Obtains the manual snapshot limits for a directory.


      This is a convenience which creates an instance of the GetSnapshotLimitsRequest.Builder avoiding the need to create one manually via GetSnapshotLimitsRequest.builder()

      Parameters:
      getSnapshotLimitsRequest - A Consumer that will call methods on GetSnapshotLimitsRequest.Builder to create a request. 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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • EntityDoesNotExistException The specified entity could not be found.
      • ClientException A client exception has occurred.
      • ServiceException An exception has occurred in Directory Service.
      • SdkException 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 type.
      See Also:

    • listADAssessments

      default CompletableFuture<ListAdAssessmentsResponse> listADAssessments(ListAdAssessmentsRequest listAdAssessmentsRequest)

      Retrieves a list of directory assessments for the specified directory or all assessments in your account. Use this operation to monitor assessment status and manage multiple assessments.

      Parameters:
      listAdAssessmentsRequest -
      Returns:
      A Java Future containing the result of the ListADAssessments operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ClientException A client exception has occurred.
      • ServiceException An exception has occurred in Directory Service.
      • InvalidParameterException One or more parameters are not valid.
      • UnsupportedOperationException The operation is not supported.
      • DirectoryDoesNotExistException The specified directory does not exist in the system.
      • SdkException 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 type.
      See Also:

    • listADAssessments

      default CompletableFuture<ListAdAssessmentsResponse> listADAssessments(Consumer<ListAdAssessmentsRequest.Builder> listAdAssessmentsRequest)

      Retrieves a list of directory assessments for the specified directory or all assessments in your account. Use this operation to monitor assessment status and manage multiple assessments.


      This is a convenience which creates an instance of the ListAdAssessmentsRequest.Builder avoiding the need to create one manually via ListAdAssessmentsRequest.builder()

      Parameters:
      listAdAssessmentsRequest - A Consumer that will call methods on ListAdAssessmentsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListADAssessments operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ClientException A client exception has occurred.
      • ServiceException An exception has occurred in Directory Service.
      • InvalidParameterException One or more parameters are not valid.
      • UnsupportedOperationException The operation is not supported.
      • DirectoryDoesNotExistException The specified directory does not exist in the system.
      • SdkException 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 type.
      See Also:

    • listADAssessmentsPaginator

      default ListADAssessmentsPublisher listADAssessmentsPaginator(ListAdAssessmentsRequest listAdAssessmentsRequest)

      This is a variant of listADAssessments(software.amazon.awssdk.services.directory.model.ListAdAssessmentsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.directory.paginators.ListADAssessmentsPublisher publisher = client.listADAssessmentsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.directory.paginators.ListADAssessmentsPublisher publisher = client.listADAssessmentsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.directory.model.ListAdAssessmentsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.directory.model.ListAdAssessmentsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of Limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listADAssessments(software.amazon.awssdk.services.directory.model.ListAdAssessmentsRequest) operation.

      Parameters:
      listAdAssessmentsRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ClientException A client exception has occurred.
      • ServiceException An exception has occurred in Directory Service.
      • InvalidParameterException One or more parameters are not valid.
      • UnsupportedOperationException The operation is not supported.
      • DirectoryDoesNotExistException The specified directory does not exist in the system.
      • SdkException 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 type.
      See Also:

    • listADAssessmentsPaginator

      default ListADAssessmentsPublisher listADAssessmentsPaginator(Consumer<ListAdAssessmentsRequest.Builder> listAdAssessmentsRequest)

      This is a variant of listADAssessments(software.amazon.awssdk.services.directory.model.ListAdAssessmentsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.directory.paginators.ListADAssessmentsPublisher publisher = client.listADAssessmentsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.directory.paginators.ListADAssessmentsPublisher publisher = client.listADAssessmentsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.directory.model.ListAdAssessmentsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.directory.model.ListAdAssessmentsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of Limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listADAssessments(software.amazon.awssdk.services.directory.model.ListAdAssessmentsRequest) operation.


      This is a convenience which creates an instance of the ListAdAssessmentsRequest.Builder avoiding the need to create one manually via ListAdAssessmentsRequest.builder()

      Parameters:
      listAdAssessmentsRequest - A Consumer that will call methods on ListAdAssessmentsRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ClientException A client exception has occurred.
      • ServiceException An exception has occurred in Directory Service.
      • InvalidParameterException One or more parameters are not valid.
      • UnsupportedOperationException The operation is not supported.
      • DirectoryDoesNotExistException The specified directory does not exist in the system.
      • SdkException 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 type.
      See Also:

    • listCertificates

      default CompletableFuture<ListCertificatesResponse> listCertificates(ListCertificatesRequest listCertificatesRequest)

      For the specified directory, lists all the certificates registered for a secure LDAP or client certificate authentication.

      Parameters:
      listCertificatesRequest -
      Returns:
      A Java Future containing the result of the ListCertificates operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException 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 type.
      See Also:

    • listCertificates

      default CompletableFuture<ListCertificatesResponse> listCertificates(Consumer<ListCertificatesRequest.Builder> listCertificatesRequest)

      For the specified directory, lists all the certificates registered for a secure LDAP or client certificate authentication.


      This is a convenience which creates an instance of the ListCertificatesRequest.Builder avoiding the need to create one manually via ListCertificatesRequest.builder()

      Parameters:
      listCertificatesRequest - A Consumer that will call methods on ListCertificatesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListCertificates operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException 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 type.
      See Also:

    • listCertificatesPaginator

      default ListCertificatesPublisher listCertificatesPaginator(ListCertificatesRequest listCertificatesRequest)

      This is a variant of listCertificates(software.amazon.awssdk.services.directory.model.ListCertificatesRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.directory.paginators.ListCertificatesPublisher publisher = client.listCertificatesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.directory.paginators.ListCertificatesPublisher publisher = client.listCertificatesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.directory.model.ListCertificatesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.directory.model.ListCertificatesResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of Limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listCertificates(software.amazon.awssdk.services.directory.model.ListCertificatesRequest) operation.

      Parameters:
      listCertificatesRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException 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 type.
      See Also:

    • listCertificatesPaginator

      default ListCertificatesPublisher listCertificatesPaginator(Consumer<ListCertificatesRequest.Builder> listCertificatesRequest)

      This is a variant of listCertificates(software.amazon.awssdk.services.directory.model.ListCertificatesRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.directory.paginators.ListCertificatesPublisher publisher = client.listCertificatesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.directory.paginators.ListCertificatesPublisher publisher = client.listCertificatesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.directory.model.ListCertificatesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.directory.model.ListCertificatesResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of Limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listCertificates(software.amazon.awssdk.services.directory.model.ListCertificatesRequest) operation.


      This is a convenience which creates an instance of the ListCertificatesRequest.Builder avoiding the need to create one manually via ListCertificatesRequest.builder()

      Parameters:
      listCertificatesRequest - A Consumer that will call methods on ListCertificatesRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException 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 type.
      See Also:

    • 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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException 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 type.
      See Also:

    • listIpRoutes

      default CompletableFuture<ListIpRoutesResponse> listIpRoutes(Consumer<ListIpRoutesRequest.Builder> listIpRoutesRequest)

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


      This is a convenience which creates an instance of the ListIpRoutesRequest.Builder avoiding the need to create one manually via ListIpRoutesRequest.builder()

      Parameters:
      listIpRoutesRequest - A Consumer that will call methods on ListIpRoutesRequest.Builder to create a request.
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException 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 type.
      See Also:

    • listIpRoutesPaginator

      default ListIpRoutesPublisher listIpRoutesPaginator(ListIpRoutesRequest listIpRoutesRequest)

      This is a variant of listIpRoutes(software.amazon.awssdk.services.directory.model.ListIpRoutesRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.directory.paginators.ListIpRoutesPublisher publisher = client.listIpRoutesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.directory.paginators.ListIpRoutesPublisher publisher = client.listIpRoutesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.directory.model.ListIpRoutesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.directory.model.ListIpRoutesResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of Limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listIpRoutes(software.amazon.awssdk.services.directory.model.ListIpRoutesRequest) operation.

      Parameters:
      listIpRoutesRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException 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 type.
      See Also:

    • listIpRoutesPaginator

      default ListIpRoutesPublisher listIpRoutesPaginator(Consumer<ListIpRoutesRequest.Builder> listIpRoutesRequest)

      This is a variant of listIpRoutes(software.amazon.awssdk.services.directory.model.ListIpRoutesRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.directory.paginators.ListIpRoutesPublisher publisher = client.listIpRoutesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.directory.paginators.ListIpRoutesPublisher publisher = client.listIpRoutesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.directory.model.ListIpRoutesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.directory.model.ListIpRoutesResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of Limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listIpRoutes(software.amazon.awssdk.services.directory.model.ListIpRoutesRequest) operation.


      This is a convenience which creates an instance of the ListIpRoutesRequest.Builder avoiding the need to create one manually via ListIpRoutesRequest.builder()

      Parameters:
      listIpRoutesRequest - A Consumer that will call methods on ListIpRoutesRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException 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 type.
      See Also:

    • listLogSubscriptions

      default CompletableFuture<ListLogSubscriptionsResponse> listLogSubscriptions(ListLogSubscriptionsRequest listLogSubscriptionsRequest)

      Lists the active log subscriptions for the Amazon Web Services account.

      Parameters:
      listLogSubscriptionsRequest -
      Returns:
      A Java Future containing the result of the ListLogSubscriptions operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException 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 type.
      See Also:

    • listLogSubscriptions

      default CompletableFuture<ListLogSubscriptionsResponse> listLogSubscriptions(Consumer<ListLogSubscriptionsRequest.Builder> listLogSubscriptionsRequest)

      Lists the active log subscriptions for the Amazon Web Services account.


      This is a convenience which creates an instance of the ListLogSubscriptionsRequest.Builder avoiding the need to create one manually via ListLogSubscriptionsRequest.builder()

      Parameters:
      listLogSubscriptionsRequest - A Consumer that will call methods on ListLogSubscriptionsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListLogSubscriptions operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException 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 type.
      See Also:

    • listLogSubscriptions

      default CompletableFuture<ListLogSubscriptionsResponse> listLogSubscriptions()

      Lists the active log subscriptions for the Amazon Web Services account.

      Returns:
      A Java Future containing the result of the ListLogSubscriptions operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException 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 type.
      See Also:

    • listLogSubscriptionsPaginator

      default ListLogSubscriptionsPublisher listLogSubscriptionsPaginator()

      This is a variant of listLogSubscriptions(software.amazon.awssdk.services.directory.model.ListLogSubscriptionsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.directory.paginators.ListLogSubscriptionsPublisher publisher = client.listLogSubscriptionsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.directory.paginators.ListLogSubscriptionsPublisher publisher = client.listLogSubscriptionsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.directory.model.ListLogSubscriptionsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.directory.model.ListLogSubscriptionsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of Limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listLogSubscriptions(software.amazon.awssdk.services.directory.model.ListLogSubscriptionsRequest) operation.

      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException 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 type.
      See Also:

    • listLogSubscriptionsPaginator

      default ListLogSubscriptionsPublisher listLogSubscriptionsPaginator(ListLogSubscriptionsRequest listLogSubscriptionsRequest)

      This is a variant of listLogSubscriptions(software.amazon.awssdk.services.directory.model.ListLogSubscriptionsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.directory.paginators.ListLogSubscriptionsPublisher publisher = client.listLogSubscriptionsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.directory.paginators.ListLogSubscriptionsPublisher publisher = client.listLogSubscriptionsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.directory.model.ListLogSubscriptionsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.directory.model.ListLogSubscriptionsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of Limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listLogSubscriptions(software.amazon.awssdk.services.directory.model.ListLogSubscriptionsRequest) operation.

      Parameters:
      listLogSubscriptionsRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException 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 type.
      See Also:

    • listLogSubscriptionsPaginator

      default ListLogSubscriptionsPublisher listLogSubscriptionsPaginator(Consumer<ListLogSubscriptionsRequest.Builder> listLogSubscriptionsRequest)

      This is a variant of listLogSubscriptions(software.amazon.awssdk.services.directory.model.ListLogSubscriptionsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.directory.paginators.ListLogSubscriptionsPublisher publisher = client.listLogSubscriptionsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.directory.paginators.ListLogSubscriptionsPublisher publisher = client.listLogSubscriptionsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.directory.model.ListLogSubscriptionsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.directory.model.ListLogSubscriptionsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of Limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listLogSubscriptions(software.amazon.awssdk.services.directory.model.ListLogSubscriptionsRequest) operation.


      This is a convenience which creates an instance of the ListLogSubscriptionsRequest.Builder avoiding the need to create one manually via ListLogSubscriptionsRequest.builder()

      Parameters:
      listLogSubscriptionsRequest - A Consumer that will call methods on ListLogSubscriptionsRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException 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 type.
      See Also:

    • 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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException 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 type.
      See Also:

    • listSchemaExtensions

      default CompletableFuture<ListSchemaExtensionsResponse> listSchemaExtensions(Consumer<ListSchemaExtensionsRequest.Builder> listSchemaExtensionsRequest)

      Lists all schema extensions applied to a Microsoft AD Directory.


      This is a convenience which creates an instance of the ListSchemaExtensionsRequest.Builder avoiding the need to create one manually via ListSchemaExtensionsRequest.builder()

      Parameters:
      listSchemaExtensionsRequest - A Consumer that will call methods on ListSchemaExtensionsRequest.Builder to create a request.
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException 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 type.
      See Also:

    • listSchemaExtensionsPaginator

      default ListSchemaExtensionsPublisher listSchemaExtensionsPaginator(ListSchemaExtensionsRequest listSchemaExtensionsRequest)

      This is a variant of listSchemaExtensions(software.amazon.awssdk.services.directory.model.ListSchemaExtensionsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.directory.paginators.ListSchemaExtensionsPublisher publisher = client.listSchemaExtensionsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.directory.paginators.ListSchemaExtensionsPublisher publisher = client.listSchemaExtensionsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.directory.model.ListSchemaExtensionsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.directory.model.ListSchemaExtensionsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of Limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listSchemaExtensions(software.amazon.awssdk.services.directory.model.ListSchemaExtensionsRequest) operation.

      Parameters:
      listSchemaExtensionsRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException 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 type.
      See Also:

    • listSchemaExtensionsPaginator

      default ListSchemaExtensionsPublisher listSchemaExtensionsPaginator(Consumer<ListSchemaExtensionsRequest.Builder> listSchemaExtensionsRequest)

      This is a variant of listSchemaExtensions(software.amazon.awssdk.services.directory.model.ListSchemaExtensionsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.directory.paginators.ListSchemaExtensionsPublisher publisher = client.listSchemaExtensionsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.directory.paginators.ListSchemaExtensionsPublisher publisher = client.listSchemaExtensionsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.directory.model.ListSchemaExtensionsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.directory.model.ListSchemaExtensionsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of Limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listSchemaExtensions(software.amazon.awssdk.services.directory.model.ListSchemaExtensionsRequest) operation.


      This is a convenience which creates an instance of the ListSchemaExtensionsRequest.Builder avoiding the need to create one manually via ListSchemaExtensionsRequest.builder()

      Parameters:
      listSchemaExtensionsRequest - A Consumer that will call methods on ListSchemaExtensionsRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException 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 type.
      See Also:

    • 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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException 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 type.
      See Also:

    • listTagsForResource

      default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)

      Lists all tags on a directory.


      This is a convenience which creates an instance of the ListTagsForResourceRequest.Builder avoiding the need to create one manually via ListTagsForResourceRequest.builder()

      Parameters:
      listTagsForResourceRequest - A Consumer that will call methods on ListTagsForResourceRequest.Builder to create a request.
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException 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 type.
      See Also:

    • listTagsForResourcePaginator

      default ListTagsForResourcePublisher listTagsForResourcePaginator(ListTagsForResourceRequest listTagsForResourceRequest)

      This is a variant of listTagsForResource(software.amazon.awssdk.services.directory.model.ListTagsForResourceRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.directory.paginators.ListTagsForResourcePublisher publisher = client.listTagsForResourcePaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.directory.paginators.ListTagsForResourcePublisher publisher = client.listTagsForResourcePaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.directory.model.ListTagsForResourceResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.directory.model.ListTagsForResourceResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of Limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listTagsForResource(software.amazon.awssdk.services.directory.model.ListTagsForResourceRequest) operation.

      Parameters:
      listTagsForResourceRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException 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 type.
      See Also:

    • listTagsForResourcePaginator

      default ListTagsForResourcePublisher listTagsForResourcePaginator(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)

      This is a variant of listTagsForResource(software.amazon.awssdk.services.directory.model.ListTagsForResourceRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.directory.paginators.ListTagsForResourcePublisher publisher = client.listTagsForResourcePaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.directory.paginators.ListTagsForResourcePublisher publisher = client.listTagsForResourcePaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.directory.model.ListTagsForResourceResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.directory.model.ListTagsForResourceResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of Limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listTagsForResource(software.amazon.awssdk.services.directory.model.ListTagsForResourceRequest) operation.


      This is a convenience which creates an instance of the ListTagsForResourceRequest.Builder avoiding the need to create one manually via ListTagsForResourceRequest.builder()

      Parameters:
      listTagsForResourceRequest - A Consumer that will call methods on ListTagsForResourceRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException 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 type.
      See Also:

    • registerCertificate

      default CompletableFuture<RegisterCertificateResponse> registerCertificate(RegisterCertificateRequest registerCertificateRequest)

      Registers a certificate for a secure LDAP or client certificate authentication.

      Parameters:
      registerCertificateRequest -
      Returns:
      A Java Future containing the result of the RegisterCertificate operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • DirectoryUnavailableException The specified directory is unavailable.
      • 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.
      • SdkException 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 type.
      See Also:

    • registerCertificate

      default CompletableFuture<RegisterCertificateResponse> registerCertificate(Consumer<RegisterCertificateRequest.Builder> registerCertificateRequest)

      Registers a certificate for a secure LDAP or client certificate authentication.


      This is a convenience which creates an instance of the RegisterCertificateRequest.Builder avoiding the need to create one manually via RegisterCertificateRequest.builder()

      Parameters:
      registerCertificateRequest - A Consumer that will call methods on RegisterCertificateRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the RegisterCertificate operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • DirectoryUnavailableException The specified directory is unavailable.
      • 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.
      • SdkException 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 type.
      See Also:

    • registerEventTopic

      default CompletableFuture<RegisterEventTopicResponse> registerEventTopic(RegisterEventTopicRequest registerEventTopicRequest)

      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.

      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException 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 type.
      See Also:

    • registerEventTopic

      default CompletableFuture<RegisterEventTopicResponse> registerEventTopic(Consumer<RegisterEventTopicRequest.Builder> registerEventTopicRequest)

      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.


      This is a convenience which creates an instance of the RegisterEventTopicRequest.Builder avoiding the need to create one manually via RegisterEventTopicRequest.builder()

      Parameters:
      registerEventTopicRequest - A Consumer that will call methods on RegisterEventTopicRequest.Builder to create a request. 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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException 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 type.
      See Also:

    • rejectSharedDirectory

      default CompletableFuture<RejectSharedDirectoryResponse> rejectSharedDirectory(RejectSharedDirectoryRequest rejectSharedDirectoryRequest)

      Rejects a directory sharing request that was sent from the directory owner account.

      Parameters:
      rejectSharedDirectoryRequest -
      Returns:
      A Java Future containing the result of the RejectSharedDirectory operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException 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 type.
      See Also:

    • rejectSharedDirectory

      default CompletableFuture<RejectSharedDirectoryResponse> rejectSharedDirectory(Consumer<RejectSharedDirectoryRequest.Builder> rejectSharedDirectoryRequest)

      Rejects a directory sharing request that was sent from the directory owner account.


      This is a convenience which creates an instance of the RejectSharedDirectoryRequest.Builder avoiding the need to create one manually via RejectSharedDirectoryRequest.builder()

      Parameters:
      rejectSharedDirectoryRequest - A Consumer that will call methods on RejectSharedDirectoryRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the RejectSharedDirectory operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException 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 type.
      See Also:

    • 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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • EntityDoesNotExistException The specified entity could not be found.
      • InvalidParameterException One or more parameters are not valid.
      • DirectoryUnavailableException The specified directory is unavailable.
      • ClientException A client exception has occurred.
      • ServiceException An exception has occurred in Directory Service.
      • SdkException 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 type.
      See Also:

    • removeIpRoutes

      default CompletableFuture<RemoveIpRoutesResponse> removeIpRoutes(Consumer<RemoveIpRoutesRequest.Builder> removeIpRoutesRequest)

      Removes IP address blocks from a directory.


      This is a convenience which creates an instance of the RemoveIpRoutesRequest.Builder avoiding the need to create one manually via RemoveIpRoutesRequest.builder()

      Parameters:
      removeIpRoutesRequest - A Consumer that will call methods on RemoveIpRoutesRequest.Builder to create a request.
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • EntityDoesNotExistException The specified entity could not be found.
      • InvalidParameterException One or more parameters are not valid.
      • DirectoryUnavailableException The specified directory is unavailable.
      • ClientException A client exception has occurred.
      • ServiceException An exception has occurred in Directory Service.
      • SdkException 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 type.
      See Also:

    • removeRegion

      default CompletableFuture<RemoveRegionResponse> removeRegion(RemoveRegionRequest removeRegionRequest)

      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.

      Parameters:
      removeRegionRequest -
      Returns:
      A Java Future containing the result of the RemoveRegion operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • DirectoryUnavailableException The specified directory is unavailable.
      • DirectoryDoesNotExistException The specified directory does not exist in the system.
      • UnsupportedOperationException The operation is not supported.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ClientException A client exception has occurred.
      • ServiceException An exception has occurred in Directory Service.
      • SdkException 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 type.
      See Also:

    • removeRegion

      default CompletableFuture<RemoveRegionResponse> removeRegion(Consumer<RemoveRegionRequest.Builder> removeRegionRequest)

      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.


      This is a convenience which creates an instance of the RemoveRegionRequest.Builder avoiding the need to create one manually via RemoveRegionRequest.builder()

      Parameters:
      removeRegionRequest - A Consumer that will call methods on RemoveRegionRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the RemoveRegion operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • DirectoryUnavailableException The specified directory is unavailable.
      • DirectoryDoesNotExistException The specified directory does not exist in the system.
      • UnsupportedOperationException The operation is not supported.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ClientException A client exception has occurred.
      • ServiceException An exception has occurred in Directory Service.
      • SdkException 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 type.
      See Also:

    • 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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException 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 type.
      See Also:

    • removeTagsFromResource

      default CompletableFuture<RemoveTagsFromResourceResponse> removeTagsFromResource(Consumer<RemoveTagsFromResourceRequest.Builder> removeTagsFromResourceRequest)

      Removes tags from a directory.


      This is a convenience which creates an instance of the RemoveTagsFromResourceRequest.Builder avoiding the need to create one manually via RemoveTagsFromResourceRequest.builder()

      Parameters:
      removeTagsFromResourceRequest - A Consumer that will call methods on RemoveTagsFromResourceRequest.Builder to create a request.
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException 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 type.
      See Also:

    • resetUserPassword

      default CompletableFuture<ResetUserPasswordResponse> resetUserPassword(ResetUserPasswordRequest resetUserPasswordRequest)

      Resets the password for any user in your Managed Microsoft AD or Simple AD directory. Disabled users will become enabled and can be authenticated following the API call.

      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.

      Parameters:
      resetUserPasswordRequest -
      Returns:
      A Java Future containing the result of the ResetUserPassword operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • DirectoryUnavailableException The specified directory is unavailable.
      • 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.
      • SdkException 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 type.
      See Also:

    • resetUserPassword

      default CompletableFuture<ResetUserPasswordResponse> resetUserPassword(Consumer<ResetUserPasswordRequest.Builder> resetUserPasswordRequest)

      Resets the password for any user in your Managed Microsoft AD or Simple AD directory. Disabled users will become enabled and can be authenticated following the API call.

      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.


      This is a convenience which creates an instance of the ResetUserPasswordRequest.Builder avoiding the need to create one manually via ResetUserPasswordRequest.builder()

      Parameters:
      resetUserPasswordRequest - A Consumer that will call methods on ResetUserPasswordRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ResetUserPassword operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • DirectoryUnavailableException The specified directory is unavailable.
      • 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.
      • SdkException 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 type.
      See Also:

    • 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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException 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 type.
      See Also:

    • restoreFromSnapshot

      default CompletableFuture<RestoreFromSnapshotResponse> restoreFromSnapshot(Consumer<RestoreFromSnapshotRequest.Builder> 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.


      This is a convenience which creates an instance of the RestoreFromSnapshotRequest.Builder avoiding the need to create one manually via RestoreFromSnapshotRequest.builder()

      Parameters:
      restoreFromSnapshotRequest - A Consumer that will call methods on RestoreFromSnapshotRequest.Builder to create a request. 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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException 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 type.
      See Also:

    • shareDirectory

      default CompletableFuture<ShareDirectoryResponse> shareDirectory(ShareDirectoryRequest shareDirectoryRequest)

      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.

      Parameters:
      shareDirectoryRequest -
      Returns:
      A Java Future containing the result of the ShareDirectory operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 You do not have sufficient access to perform this action.
      • UnsupportedOperationException The operation is not supported.
      • ServiceException An exception has occurred in Directory Service.
      • SdkException 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 type.
      See Also:

    • shareDirectory

      default CompletableFuture<ShareDirectoryResponse> shareDirectory(Consumer<ShareDirectoryRequest.Builder> shareDirectoryRequest)

      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.


      This is a convenience which creates an instance of the ShareDirectoryRequest.Builder avoiding the need to create one manually via ShareDirectoryRequest.builder()

      Parameters:
      shareDirectoryRequest - A Consumer that will call methods on ShareDirectoryRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ShareDirectory operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 You do not have sufficient access to perform this action.
      • UnsupportedOperationException The operation is not supported.
      • ServiceException An exception has occurred in Directory Service.
      • SdkException 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 type.
      See Also:

    • startADAssessment

      default CompletableFuture<StartAdAssessmentResponse> startADAssessment(StartAdAssessmentRequest startAdAssessmentRequest)

      Initiates a directory assessment to validate your self-managed AD environment for hybrid domain join. The assessment checks compatibility and connectivity of the self-managed AD environment.

      A directory assessment is automatically created when you create a hybrid directory. There are two types of assessments: CUSTOMER and SYSTEM. Your Amazon Web Services account has a limit of 100 CUSTOMER directory assessments.

      The assessment process typically takes 30 minutes or more to complete. The assessment process is asynchronous and you can monitor it with DescribeADAssessment.

      The InstanceIds must have a one-to-one correspondence with CustomerDnsIps, meaning that if the IP address for instance i-10243410 is 10.24.34.100 and the IP address for instance i-10243420 is 10.24.34.200, then the input arrays must maintain the same order relationship, either [10.24.34.100, 10.24.34.200] paired with [i-10243410, i-10243420] or [10.24.34.200, 10.24.34.100] paired with [i-10243420, i-10243410].

      Note: You must provide exactly one DirectoryId or AssessmentConfiguration.

      Parameters:
      startAdAssessmentRequest -
      Returns:
      A Java Future containing the result of the StartADAssessment operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ClientException A client exception has occurred.
      • ServiceException An exception has occurred in Directory Service.
      • InvalidParameterException One or more parameters are not valid.
      • UnsupportedOperationException The operation is not supported.
      • DirectoryDoesNotExistException The specified directory does not exist in the system.
      • AdAssessmentLimitExceededException A directory assessment is automatically created when you create a hybrid directory. There are two types of assessments: CUSTOMER and SYSTEM. Your Amazon Web Services account has a limit of 100 CUSTOMER directory assessments.

        If you attempt to create a hybrid directory; and you already have 100 CUSTOMER directory assessments;, you will encounter an error. Delete assessments to free up capacity before trying again.

        You can request an increase to your CUSTOMER directory assessment quota by contacting customer support or delete existing CUSTOMER directory assessments; to free up capacity.

      • SdkException 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 type.
      See Also:

    • startADAssessment

      default CompletableFuture<StartAdAssessmentResponse> startADAssessment(Consumer<StartAdAssessmentRequest.Builder> startAdAssessmentRequest)

      Initiates a directory assessment to validate your self-managed AD environment for hybrid domain join. The assessment checks compatibility and connectivity of the self-managed AD environment.

      A directory assessment is automatically created when you create a hybrid directory. There are two types of assessments: CUSTOMER and SYSTEM. Your Amazon Web Services account has a limit of 100 CUSTOMER directory assessments.

      The assessment process typically takes 30 minutes or more to complete. The assessment process is asynchronous and you can monitor it with DescribeADAssessment.

      The InstanceIds must have a one-to-one correspondence with CustomerDnsIps, meaning that if the IP address for instance i-10243410 is 10.24.34.100 and the IP address for instance i-10243420 is 10.24.34.200, then the input arrays must maintain the same order relationship, either [10.24.34.100, 10.24.34.200] paired with [i-10243410, i-10243420] or [10.24.34.200, 10.24.34.100] paired with [i-10243420, i-10243410].

      Note: You must provide exactly one DirectoryId or AssessmentConfiguration.


      This is a convenience which creates an instance of the StartAdAssessmentRequest.Builder avoiding the need to create one manually via StartAdAssessmentRequest.builder()

      Parameters:
      startAdAssessmentRequest - A Consumer that will call methods on StartAdAssessmentRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the StartADAssessment operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ClientException A client exception has occurred.
      • ServiceException An exception has occurred in Directory Service.
      • InvalidParameterException One or more parameters are not valid.
      • UnsupportedOperationException The operation is not supported.
      • DirectoryDoesNotExistException The specified directory does not exist in the system.
      • AdAssessmentLimitExceededException A directory assessment is automatically created when you create a hybrid directory. There are two types of assessments: CUSTOMER and SYSTEM. Your Amazon Web Services account has a limit of 100 CUSTOMER directory assessments.

        If you attempt to create a hybrid directory; and you already have 100 CUSTOMER directory assessments;, you will encounter an error. Delete assessments to free up capacity before trying again.

        You can request an increase to your CUSTOMER directory assessment quota by contacting customer support or delete existing CUSTOMER directory assessments; to free up capacity.

      • SdkException 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 type.
      See Also:

    • 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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • DirectoryUnavailableException The specified directory is unavailable.
      • 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.
      • SdkException 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 type.
      See Also:

    • startSchemaExtension

      default CompletableFuture<StartSchemaExtensionResponse> startSchemaExtension(Consumer<StartSchemaExtensionRequest.Builder> startSchemaExtensionRequest)

      Applies a schema extension to a Microsoft AD directory.


      This is a convenience which creates an instance of the StartSchemaExtensionRequest.Builder avoiding the need to create one manually via StartSchemaExtensionRequest.builder()

      Parameters:
      startSchemaExtensionRequest - A Consumer that will call methods on StartSchemaExtensionRequest.Builder to create a request.
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • DirectoryUnavailableException The specified directory is unavailable.
      • 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.
      • SdkException 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 type.
      See Also:

    • unshareDirectory

      default CompletableFuture<UnshareDirectoryResponse> unshareDirectory(UnshareDirectoryRequest unshareDirectoryRequest)

      Stops the directory sharing between the directory owner and consumer accounts.

      Parameters:
      unshareDirectoryRequest -
      Returns:
      A Java Future containing the result of the UnshareDirectory operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException 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 type.
      See Also:

    • unshareDirectory

      default CompletableFuture<UnshareDirectoryResponse> unshareDirectory(Consumer<UnshareDirectoryRequest.Builder> unshareDirectoryRequest)

      Stops the directory sharing between the directory owner and consumer accounts.


      This is a convenience which creates an instance of the UnshareDirectoryRequest.Builder avoiding the need to create one manually via UnshareDirectoryRequest.builder()

      Parameters:
      unshareDirectoryRequest - A Consumer that will call methods on UnshareDirectoryRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UnshareDirectory operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException 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 type.
      See Also:

    • updateConditionalForwarder

      default CompletableFuture<UpdateConditionalForwarderResponse> updateConditionalForwarder(UpdateConditionalForwarderRequest updateConditionalForwarderRequest)

      Updates a conditional forwarder that has been set up for your Amazon Web Services 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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • EntityDoesNotExistException The specified entity could not be found.
      • DirectoryUnavailableException The specified directory is unavailable.
      • 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.
      • SdkException 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 type.
      See Also:

    • updateConditionalForwarder

      default CompletableFuture<UpdateConditionalForwarderResponse> updateConditionalForwarder(Consumer<UpdateConditionalForwarderRequest.Builder> updateConditionalForwarderRequest)

      Updates a conditional forwarder that has been set up for your Amazon Web Services directory.


      This is a convenience which creates an instance of the UpdateConditionalForwarderRequest.Builder avoiding the need to create one manually via UpdateConditionalForwarderRequest.builder()

      Parameters:
      updateConditionalForwarderRequest - A Consumer that will call methods on UpdateConditionalForwarderRequest.Builder to create a request. 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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • EntityDoesNotExistException The specified entity could not be found.
      • DirectoryUnavailableException The specified directory is unavailable.
      • 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.
      • SdkException 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 type.
      See Also:

    • updateDirectorySetup

      default CompletableFuture<UpdateDirectorySetupResponse> updateDirectorySetup(UpdateDirectorySetupRequest updateDirectorySetupRequest)

      Updates directory configuration for the specified update type.

      Parameters:
      updateDirectorySetupRequest -
      Returns:
      A Java Future containing the result of the UpdateDirectorySetup operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • UnsupportedOperationException The operation is not supported.
      • DirectoryInDesiredStateException The directory is already updated to desired update type settings.
      • DirectoryUnavailableException The specified directory is unavailable.
      • 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 You do not have sufficient access to perform this action.
      • ClientException A client exception has occurred.
      • ServiceException An exception has occurred in Directory Service.
      • SdkException 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 type.
      See Also:

    • updateDirectorySetup

      default CompletableFuture<UpdateDirectorySetupResponse> updateDirectorySetup(Consumer<UpdateDirectorySetupRequest.Builder> updateDirectorySetupRequest)

      Updates directory configuration for the specified update type.


      This is a convenience which creates an instance of the UpdateDirectorySetupRequest.Builder avoiding the need to create one manually via UpdateDirectorySetupRequest.builder()

      Parameters:
      updateDirectorySetupRequest - A Consumer that will call methods on UpdateDirectorySetupRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateDirectorySetup operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • UnsupportedOperationException The operation is not supported.
      • DirectoryInDesiredStateException The directory is already updated to desired update type settings.
      • DirectoryUnavailableException The specified directory is unavailable.
      • 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 You do not have sufficient access to perform this action.
      • ClientException A client exception has occurred.
      • ServiceException An exception has occurred in Directory Service.
      • SdkException 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 type.
      See Also:

    • updateHybridAD

      default CompletableFuture<UpdateHybridAdResponse> updateHybridAD(UpdateHybridAdRequest updateHybridAdRequest)

      Updates the configuration of an existing hybrid directory. You can recover hybrid directory administrator account or modify self-managed instance settings.

      Updates are applied asynchronously. Use DescribeHybridADUpdate to monitor the progress of configuration changes.

      The InstanceIds must have a one-to-one correspondence with CustomerDnsIps, meaning that if the IP address for instance i-10243410 is 10.24.34.100 and the IP address for instance i-10243420 is 10.24.34.200, then the input arrays must maintain the same order relationship, either [10.24.34.100, 10.24.34.200] paired with [i-10243410, i-10243420] or [10.24.34.200, 10.24.34.100] paired with [i-10243420, i-10243410].

      You must provide at least one update to UpdateHybridADRequestinvalid input: '&#36'HybridAdministratorAccountUpdate or UpdateHybridADRequestinvalid input: '&#36'SelfManagedInstancesSettings.

      Parameters:
      updateHybridAdRequest -
      Returns:
      A Java Future containing the result of the UpdateHybridAD operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ClientException A client exception has occurred.
      • ServiceException An exception has occurred in Directory Service.
      • UnsupportedOperationException The operation is not supported.
      • InvalidParameterException One or more parameters are not valid.
      • DirectoryDoesNotExistException The specified directory does not exist in the system.
      • AdAssessmentLimitExceededException A directory assessment is automatically created when you create a hybrid directory. There are two types of assessments: CUSTOMER and SYSTEM. Your Amazon Web Services account has a limit of 100 CUSTOMER directory assessments.

        If you attempt to create a hybrid directory; and you already have 100 CUSTOMER directory assessments;, you will encounter an error. Delete assessments to free up capacity before trying again.

        You can request an increase to your CUSTOMER directory assessment quota by contacting customer support or delete existing CUSTOMER directory assessments; to free up capacity.

      • SdkException 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 type.
      See Also:

    • updateHybridAD

      default CompletableFuture<UpdateHybridAdResponse> updateHybridAD(Consumer<UpdateHybridAdRequest.Builder> updateHybridAdRequest)

      Updates the configuration of an existing hybrid directory. You can recover hybrid directory administrator account or modify self-managed instance settings.

      Updates are applied asynchronously. Use DescribeHybridADUpdate to monitor the progress of configuration changes.

      The InstanceIds must have a one-to-one correspondence with CustomerDnsIps, meaning that if the IP address for instance i-10243410 is 10.24.34.100 and the IP address for instance i-10243420 is 10.24.34.200, then the input arrays must maintain the same order relationship, either [10.24.34.100, 10.24.34.200] paired with [i-10243410, i-10243420] or [10.24.34.200, 10.24.34.100] paired with [i-10243420, i-10243410].

      You must provide at least one update to UpdateHybridADRequestinvalid input: '&#36'HybridAdministratorAccountUpdate or UpdateHybridADRequestinvalid input: '&#36'SelfManagedInstancesSettings.


      This is a convenience which creates an instance of the UpdateHybridAdRequest.Builder avoiding the need to create one manually via UpdateHybridAdRequest.builder()

      Parameters:
      updateHybridAdRequest - A Consumer that will call methods on UpdateHybridAdRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateHybridAD operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ClientException A client exception has occurred.
      • ServiceException An exception has occurred in Directory Service.
      • UnsupportedOperationException The operation is not supported.
      • InvalidParameterException One or more parameters are not valid.
      • DirectoryDoesNotExistException The specified directory does not exist in the system.
      • AdAssessmentLimitExceededException A directory assessment is automatically created when you create a hybrid directory. There are two types of assessments: CUSTOMER and SYSTEM. Your Amazon Web Services account has a limit of 100 CUSTOMER directory assessments.

        If you attempt to create a hybrid directory; and you already have 100 CUSTOMER directory assessments;, you will encounter an error. Delete assessments to free up capacity before trying again.

        You can request an increase to your CUSTOMER directory assessment quota by contacting customer support or delete existing CUSTOMER directory assessments; to free up capacity.

      • SdkException 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 type.
      See Also:

    • updateNumberOfDomainControllers

      default CompletableFuture<UpdateNumberOfDomainControllersResponse> updateNumberOfDomainControllers(UpdateNumberOfDomainControllersRequest updateNumberOfDomainControllersRequest)

      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.

      Parameters:
      updateNumberOfDomainControllersRequest -
      Returns:
      A Java Future containing the result of the UpdateNumberOfDomainControllers operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • EntityDoesNotExistException The specified entity could not be found.
      • DirectoryUnavailableException The specified directory is unavailable.
      • 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.
      • SdkException 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 type.
      See Also:

    • updateNumberOfDomainControllers

      default CompletableFuture<UpdateNumberOfDomainControllersResponse> updateNumberOfDomainControllers(Consumer<UpdateNumberOfDomainControllersRequest.Builder> updateNumberOfDomainControllersRequest)

      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.


      This is a convenience which creates an instance of the UpdateNumberOfDomainControllersRequest.Builder avoiding the need to create one manually via UpdateNumberOfDomainControllersRequest.builder()

      Parameters:
      updateNumberOfDomainControllersRequest - A Consumer that will call methods on UpdateNumberOfDomainControllersRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateNumberOfDomainControllers operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • EntityDoesNotExistException The specified entity could not be found.
      • DirectoryUnavailableException The specified directory is unavailable.
      • 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.
      • SdkException 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 type.
      See Also:

    • updateRadius

      default CompletableFuture<UpdateRadiusResponse> updateRadius(UpdateRadiusRequest updateRadiusRequest)

      Updates the Remote Authentication Dial In User Service (RADIUS) server information for an AD Connector or Microsoft AD 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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException 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 type.
      See Also:

    • updateRadius

      default CompletableFuture<UpdateRadiusResponse> updateRadius(Consumer<UpdateRadiusRequest.Builder> updateRadiusRequest)

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


      This is a convenience which creates an instance of the UpdateRadiusRequest.Builder avoiding the need to create one manually via UpdateRadiusRequest.builder()

      Parameters:
      updateRadiusRequest - A Consumer that will call methods on UpdateRadiusRequest.Builder to create a request. 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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException 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 type.
      See Also:

    • updateSettings

      default CompletableFuture<UpdateSettingsResponse> updateSettings(UpdateSettingsRequest updateSettingsRequest)

      Updates the configurable settings for the specified directory.

      Parameters:
      updateSettingsRequest -
      Returns:
      A Java Future containing the result of the UpdateSettings operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • DirectoryDoesNotExistException The specified directory does not exist in the system.
      • UnsupportedOperationException The operation is not supported.
      • DirectoryUnavailableException The specified directory is unavailable.
      • 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.
      • SdkException 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 type.
      See Also:

    • updateSettings

      default CompletableFuture<UpdateSettingsResponse> updateSettings(Consumer<UpdateSettingsRequest.Builder> updateSettingsRequest)

      Updates the configurable settings for the specified directory.


      This is a convenience which creates an instance of the UpdateSettingsRequest.Builder avoiding the need to create one manually via UpdateSettingsRequest.builder()

      Parameters:
      updateSettingsRequest - A Consumer that will call methods on UpdateSettingsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateSettings operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • DirectoryDoesNotExistException The specified directory does not exist in the system.
      • UnsupportedOperationException The operation is not supported.
      • DirectoryUnavailableException The specified directory is unavailable.
      • 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.
      • SdkException 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 type.
      See Also:

    • updateTrust

      default CompletableFuture<UpdateTrustResponse> updateTrust(UpdateTrustRequest updateTrustRequest)

      Updates the trust that has been set up between your Managed Microsoft AD directory and an self-managed Active Directory.

      Parameters:
      updateTrustRequest -
      Returns:
      A Java Future containing the result of the UpdateTrust operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException 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 type.
      See Also:

    • updateTrust

      default CompletableFuture<UpdateTrustResponse> updateTrust(Consumer<UpdateTrustRequest.Builder> updateTrustRequest)

      Updates the trust that has been set up between your Managed Microsoft AD directory and an self-managed Active Directory.


      This is a convenience which creates an instance of the UpdateTrustRequest.Builder avoiding the need to create one manually via UpdateTrustRequest.builder()

      Parameters:
      updateTrustRequest - A Consumer that will call methods on UpdateTrustRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateTrust operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException 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 type.
      See Also:

    • verifyTrust

      default CompletableFuture<VerifyTrustResponse> verifyTrust(VerifyTrustRequest verifyTrustRequest)

      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.

      Parameters:
      verifyTrustRequest - Initiates the verification of an existing trust relationship between an Managed Microsoft AD directory 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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException 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 type.
      See Also:

    • verifyTrust

      default CompletableFuture<VerifyTrustResponse> verifyTrust(Consumer<VerifyTrustRequest.Builder> verifyTrustRequest)

      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.


      This is a convenience which creates an instance of the VerifyTrustRequest.Builder avoiding the need to create one manually via VerifyTrustRequest.builder()

      Parameters:
      verifyTrustRequest - A Consumer that will call methods on VerifyTrustRequest.Builder to create a request. Initiates the verification of an existing trust relationship between an Managed Microsoft AD directory 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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException 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 type.
      See Also:

    • waiter

      default DirectoryAsyncWaiter waiter()
      Create an instance of DirectoryAsyncWaiter using this client.

      Waiters created via this method are managed by the SDK and resources will be released when the service client is closed.

      Returns:
      an instance of DirectoryAsyncWaiter

    • serviceClientConfiguration

      default DirectoryServiceClientConfiguration serviceClientConfiguration()
      Description copied from interface: SdkClient
      The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration
      Specified by:
      serviceClientConfiguration in interface AwsClient
      Specified by:
      serviceClientConfiguration in interface SdkClient
      Returns:
      SdkServiceClientConfiguration

    • 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.