Interface DirectoryServiceDataAsyncClient

All Superinterfaces:
AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient
@Generated("software.amazon.awssdk:codegen") @ThreadSafe public interface DirectoryServiceDataAsyncClient extends AwsClient
Service client for accessing AWS Directory Service Data 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.

Amazon Web Services Directory Service Data is an extension of Directory Service. This API reference provides detailed information about Directory Service Data operations and object types.

With Directory Service Data, you can create, read, update, and delete users, groups, and memberships from your Managed Microsoft AD without additional costs and without deploying dedicated management instances. You can also perform built-in object management tasks across directories without direct network connectivity, which simplifies provisioning and access management to achieve fully automated deployments. Directory Service Data supports user and group write operations, such as CreateUser and CreateGroup, within the organizational unit (OU) of your Managed Microsoft AD. Directory Service Data supports read operations, such as ListUsers and ListGroups, on all users, groups, and group memberships within your Managed Microsoft AD and across trusted realms. Directory Service Data supports adding and removing group members in your OU and the Amazon Web Services Delegated Groups OU, so you can grant and deny access to specific roles and permissions. For more information, see Manage users and groups in the Directory Service Administration Guide.

Directory management operations and configuration changes made against the Directory Service API will also reflect in Directory Service Data API with eventual consistency. You can expect a short delay between management changes, such as adding a new directory trust and calling the Directory Service Data API for the newly created trusted realm.

Directory Service Data connects to your Managed Microsoft AD domain controllers and performs operations on underlying directory objects. When you create your Managed Microsoft AD, you choose subnets for domain controllers that Directory Service creates on your behalf. If a domain controller is unavailable, Directory Service Data uses an available domain controller. As a result, you might notice eventual consistency while objects replicate from one domain controller to another domain controller. For more information, see What gets created in the Directory Service Administration Guide. Directory limits vary by Managed Microsoft AD edition:

  • Standard edition – Supports 8 transactions per second (TPS) for read operations and 4 TPS for write operations per directory. There's a concurrency limit of 10 concurrent requests.

  • Enterprise edition – Supports 16 transactions per second (TPS) for read operations and 8 TPS for write operations per directory. There's a concurrency limit of 10 concurrent requests.

  • Amazon Web Services Account - Supports a total of 100 TPS for Directory Service Data operations across all directories.

Directory Service Data only supports the Managed Microsoft AD directory type and is only available in the primary Amazon Web Services Region. For more information, see Managed Microsoft AD and Primary vs additional Regions in the Directory Service Administration Guide.

  • Field Details

  • Method Details

    • addGroupMember

      default CompletableFuture<AddGroupMemberResponse> addGroupMember(AddGroupMemberRequest addGroupMemberRequest)

      Adds an existing user, group, or computer as a group member.

      Parameters:
      addGroupMemberRequest -
      Returns:
      A Java Future containing the result of the AddGroupMember 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.
      • ResourceNotFoundException The resource couldn't be found.
      • AccessDeniedException You don't have permission to perform the request or access the directory. It can also occur when the DirectoryId doesn't exist or the user, member, or group might be outside of your organizational unit (OU).

        Make sure that you have the authentication and authorization to perform the action. Review the directory information in the request, and make sure that the object isn't outside of your OU.

      • InternalServerException The operation didn't succeed because an internal error occurred. Try again later.
      • ValidationException The request isn't valid. Review the details in the error message to update the invalid parameters or values in your request.
      • DirectoryUnavailableException The request could not be completed due to a problem in the configuration or current state of the specified directory.
      • ConflictException This error will occur when you try to create a resource that conflicts with an existing object. It can also occur when adding a member to a group that the member is already in.

        This error can be caused by a request sent within the 8-hour idempotency window with the same client token but different input parameters. Client tokens should not be re-used across different requests. After 8 hours, any request with the same client token is treated as a new request.

      • ThrottlingException The limit on the number of requests per second has been exceeded.
      • 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.
      • DirectoryServiceDataException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • addGroupMember

      default CompletableFuture<AddGroupMemberResponse> addGroupMember(Consumer<AddGroupMemberRequest.Builder> addGroupMemberRequest)

      Adds an existing user, group, or computer as a group member.


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

      Parameters:
      addGroupMemberRequest - A Consumer that will call methods on AddGroupMemberRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the AddGroupMember 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.
      • ResourceNotFoundException The resource couldn't be found.
      • AccessDeniedException You don't have permission to perform the request or access the directory. It can also occur when the DirectoryId doesn't exist or the user, member, or group might be outside of your organizational unit (OU).

        Make sure that you have the authentication and authorization to perform the action. Review the directory information in the request, and make sure that the object isn't outside of your OU.

      • InternalServerException The operation didn't succeed because an internal error occurred. Try again later.
      • ValidationException The request isn't valid. Review the details in the error message to update the invalid parameters or values in your request.
      • DirectoryUnavailableException The request could not be completed due to a problem in the configuration or current state of the specified directory.
      • ConflictException This error will occur when you try to create a resource that conflicts with an existing object. It can also occur when adding a member to a group that the member is already in.

        This error can be caused by a request sent within the 8-hour idempotency window with the same client token but different input parameters. Client tokens should not be re-used across different requests. After 8 hours, any request with the same client token is treated as a new request.

      • ThrottlingException The limit on the number of requests per second has been exceeded.
      • 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.
      • DirectoryServiceDataException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createGroup

      default CompletableFuture<CreateGroupResponse> createGroup(CreateGroupRequest createGroupRequest)

      Creates a new group.

      Parameters:
      createGroupRequest -
      Returns:
      A Java Future containing the result of the CreateGroup 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.
      • AccessDeniedException You don't have permission to perform the request or access the directory. It can also occur when the DirectoryId doesn't exist or the user, member, or group might be outside of your organizational unit (OU).

        Make sure that you have the authentication and authorization to perform the action. Review the directory information in the request, and make sure that the object isn't outside of your OU.

      • InternalServerException The operation didn't succeed because an internal error occurred. Try again later.
      • ValidationException The request isn't valid. Review the details in the error message to update the invalid parameters or values in your request.
      • DirectoryUnavailableException The request could not be completed due to a problem in the configuration or current state of the specified directory.
      • ConflictException This error will occur when you try to create a resource that conflicts with an existing object. It can also occur when adding a member to a group that the member is already in.

        This error can be caused by a request sent within the 8-hour idempotency window with the same client token but different input parameters. Client tokens should not be re-used across different requests. After 8 hours, any request with the same client token is treated as a new request.

      • ThrottlingException The limit on the number of requests per second has been exceeded.
      • 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.
      • DirectoryServiceDataException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createGroup

      default CompletableFuture<CreateGroupResponse> createGroup(Consumer<CreateGroupRequest.Builder> createGroupRequest)

      Creates a new group.


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

      Parameters:
      createGroupRequest - A Consumer that will call methods on CreateGroupRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateGroup 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.
      • AccessDeniedException You don't have permission to perform the request or access the directory. It can also occur when the DirectoryId doesn't exist or the user, member, or group might be outside of your organizational unit (OU).

        Make sure that you have the authentication and authorization to perform the action. Review the directory information in the request, and make sure that the object isn't outside of your OU.

      • InternalServerException The operation didn't succeed because an internal error occurred. Try again later.
      • ValidationException The request isn't valid. Review the details in the error message to update the invalid parameters or values in your request.
      • DirectoryUnavailableException The request could not be completed due to a problem in the configuration or current state of the specified directory.
      • ConflictException This error will occur when you try to create a resource that conflicts with an existing object. It can also occur when adding a member to a group that the member is already in.

        This error can be caused by a request sent within the 8-hour idempotency window with the same client token but different input parameters. Client tokens should not be re-used across different requests. After 8 hours, any request with the same client token is treated as a new request.

      • ThrottlingException The limit on the number of requests per second has been exceeded.
      • 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.
      • DirectoryServiceDataException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createUser

      default CompletableFuture<CreateUserResponse> createUser(CreateUserRequest createUserRequest)

      Creates a new user.

      Parameters:
      createUserRequest -
      Returns:
      A Java Future containing the result of the CreateUser 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.
      • AccessDeniedException You don't have permission to perform the request or access the directory. It can also occur when the DirectoryId doesn't exist or the user, member, or group might be outside of your organizational unit (OU).

        Make sure that you have the authentication and authorization to perform the action. Review the directory information in the request, and make sure that the object isn't outside of your OU.

      • InternalServerException The operation didn't succeed because an internal error occurred. Try again later.
      • ValidationException The request isn't valid. Review the details in the error message to update the invalid parameters or values in your request.
      • DirectoryUnavailableException The request could not be completed due to a problem in the configuration or current state of the specified directory.
      • ConflictException This error will occur when you try to create a resource that conflicts with an existing object. It can also occur when adding a member to a group that the member is already in.

        This error can be caused by a request sent within the 8-hour idempotency window with the same client token but different input parameters. Client tokens should not be re-used across different requests. After 8 hours, any request with the same client token is treated as a new request.

      • ThrottlingException The limit on the number of requests per second has been exceeded.
      • 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.
      • DirectoryServiceDataException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createUser

      default CompletableFuture<CreateUserResponse> createUser(Consumer<CreateUserRequest.Builder> createUserRequest)

      Creates a new user.


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

      Parameters:
      createUserRequest - A Consumer that will call methods on CreateUserRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateUser 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.
      • AccessDeniedException You don't have permission to perform the request or access the directory. It can also occur when the DirectoryId doesn't exist or the user, member, or group might be outside of your organizational unit (OU).

        Make sure that you have the authentication and authorization to perform the action. Review the directory information in the request, and make sure that the object isn't outside of your OU.

      • InternalServerException The operation didn't succeed because an internal error occurred. Try again later.
      • ValidationException The request isn't valid. Review the details in the error message to update the invalid parameters or values in your request.
      • DirectoryUnavailableException The request could not be completed due to a problem in the configuration or current state of the specified directory.
      • ConflictException This error will occur when you try to create a resource that conflicts with an existing object. It can also occur when adding a member to a group that the member is already in.

        This error can be caused by a request sent within the 8-hour idempotency window with the same client token but different input parameters. Client tokens should not be re-used across different requests. After 8 hours, any request with the same client token is treated as a new request.

      • ThrottlingException The limit on the number of requests per second has been exceeded.
      • 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.
      • DirectoryServiceDataException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteGroup

      default CompletableFuture<DeleteGroupResponse> deleteGroup(DeleteGroupRequest deleteGroupRequest)

      Deletes a group.

      Parameters:
      deleteGroupRequest -
      Returns:
      A Java Future containing the result of the DeleteGroup 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.
      • ResourceNotFoundException The resource couldn't be found.
      • AccessDeniedException You don't have permission to perform the request or access the directory. It can also occur when the DirectoryId doesn't exist or the user, member, or group might be outside of your organizational unit (OU).

        Make sure that you have the authentication and authorization to perform the action. Review the directory information in the request, and make sure that the object isn't outside of your OU.

      • InternalServerException The operation didn't succeed because an internal error occurred. Try again later.
      • ValidationException The request isn't valid. Review the details in the error message to update the invalid parameters or values in your request.
      • DirectoryUnavailableException The request could not be completed due to a problem in the configuration or current state of the specified directory.
      • ConflictException This error will occur when you try to create a resource that conflicts with an existing object. It can also occur when adding a member to a group that the member is already in.

        This error can be caused by a request sent within the 8-hour idempotency window with the same client token but different input parameters. Client tokens should not be re-used across different requests. After 8 hours, any request with the same client token is treated as a new request.

      • ThrottlingException The limit on the number of requests per second has been exceeded.
      • 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.
      • DirectoryServiceDataException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteGroup

      default CompletableFuture<DeleteGroupResponse> deleteGroup(Consumer<DeleteGroupRequest.Builder> deleteGroupRequest)

      Deletes a group.


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

      Parameters:
      deleteGroupRequest - A Consumer that will call methods on DeleteGroupRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteGroup 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.
      • ResourceNotFoundException The resource couldn't be found.
      • AccessDeniedException You don't have permission to perform the request or access the directory. It can also occur when the DirectoryId doesn't exist or the user, member, or group might be outside of your organizational unit (OU).

        Make sure that you have the authentication and authorization to perform the action. Review the directory information in the request, and make sure that the object isn't outside of your OU.

      • InternalServerException The operation didn't succeed because an internal error occurred. Try again later.
      • ValidationException The request isn't valid. Review the details in the error message to update the invalid parameters or values in your request.
      • DirectoryUnavailableException The request could not be completed due to a problem in the configuration or current state of the specified directory.
      • ConflictException This error will occur when you try to create a resource that conflicts with an existing object. It can also occur when adding a member to a group that the member is already in.

        This error can be caused by a request sent within the 8-hour idempotency window with the same client token but different input parameters. Client tokens should not be re-used across different requests. After 8 hours, any request with the same client token is treated as a new request.

      • ThrottlingException The limit on the number of requests per second has been exceeded.
      • 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.
      • DirectoryServiceDataException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteUser

      default CompletableFuture<DeleteUserResponse> deleteUser(DeleteUserRequest deleteUserRequest)

      Deletes a user.

      Parameters:
      deleteUserRequest -
      Returns:
      A Java Future containing the result of the DeleteUser 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.
      • ResourceNotFoundException The resource couldn't be found.
      • AccessDeniedException You don't have permission to perform the request or access the directory. It can also occur when the DirectoryId doesn't exist or the user, member, or group might be outside of your organizational unit (OU).

        Make sure that you have the authentication and authorization to perform the action. Review the directory information in the request, and make sure that the object isn't outside of your OU.

      • InternalServerException The operation didn't succeed because an internal error occurred. Try again later.
      • ValidationException The request isn't valid. Review the details in the error message to update the invalid parameters or values in your request.
      • DirectoryUnavailableException The request could not be completed due to a problem in the configuration or current state of the specified directory.
      • ConflictException This error will occur when you try to create a resource that conflicts with an existing object. It can also occur when adding a member to a group that the member is already in.

        This error can be caused by a request sent within the 8-hour idempotency window with the same client token but different input parameters. Client tokens should not be re-used across different requests. After 8 hours, any request with the same client token is treated as a new request.

      • ThrottlingException The limit on the number of requests per second has been exceeded.
      • 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.
      • DirectoryServiceDataException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteUser

      default CompletableFuture<DeleteUserResponse> deleteUser(Consumer<DeleteUserRequest.Builder> deleteUserRequest)

      Deletes a user.


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

      Parameters:
      deleteUserRequest - A Consumer that will call methods on DeleteUserRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteUser 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.
      • ResourceNotFoundException The resource couldn't be found.
      • AccessDeniedException You don't have permission to perform the request or access the directory. It can also occur when the DirectoryId doesn't exist or the user, member, or group might be outside of your organizational unit (OU).

        Make sure that you have the authentication and authorization to perform the action. Review the directory information in the request, and make sure that the object isn't outside of your OU.

      • InternalServerException The operation didn't succeed because an internal error occurred. Try again later.
      • ValidationException The request isn't valid. Review the details in the error message to update the invalid parameters or values in your request.
      • DirectoryUnavailableException The request could not be completed due to a problem in the configuration or current state of the specified directory.
      • ConflictException This error will occur when you try to create a resource that conflicts with an existing object. It can also occur when adding a member to a group that the member is already in.

        This error can be caused by a request sent within the 8-hour idempotency window with the same client token but different input parameters. Client tokens should not be re-used across different requests. After 8 hours, any request with the same client token is treated as a new request.

      • ThrottlingException The limit on the number of requests per second has been exceeded.
      • 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.
      • DirectoryServiceDataException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeGroup

      default CompletableFuture<DescribeGroupResponse> describeGroup(DescribeGroupRequest describeGroupRequest)

      Returns information about a specific group.

      Parameters:
      describeGroupRequest -
      Returns:
      A Java Future containing the result of the DescribeGroup 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.
      • ResourceNotFoundException The resource couldn't be found.
      • AccessDeniedException You don't have permission to perform the request or access the directory. It can also occur when the DirectoryId doesn't exist or the user, member, or group might be outside of your organizational unit (OU).

        Make sure that you have the authentication and authorization to perform the action. Review the directory information in the request, and make sure that the object isn't outside of your OU.

      • InternalServerException The operation didn't succeed because an internal error occurred. Try again later.
      • ValidationException The request isn't valid. Review the details in the error message to update the invalid parameters or values in your request.
      • DirectoryUnavailableException The request could not be completed due to a problem in the configuration or current state of the specified directory.
      • ThrottlingException The limit on the number of requests per second has been exceeded.
      • 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.
      • DirectoryServiceDataException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeGroup

      default CompletableFuture<DescribeGroupResponse> describeGroup(Consumer<DescribeGroupRequest.Builder> describeGroupRequest)

      Returns information about a specific group.


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

      Parameters:
      describeGroupRequest - A Consumer that will call methods on DescribeGroupRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeGroup 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.
      • ResourceNotFoundException The resource couldn't be found.
      • AccessDeniedException You don't have permission to perform the request or access the directory. It can also occur when the DirectoryId doesn't exist or the user, member, or group might be outside of your organizational unit (OU).

        Make sure that you have the authentication and authorization to perform the action. Review the directory information in the request, and make sure that the object isn't outside of your OU.

      • InternalServerException The operation didn't succeed because an internal error occurred. Try again later.
      • ValidationException The request isn't valid. Review the details in the error message to update the invalid parameters or values in your request.
      • DirectoryUnavailableException The request could not be completed due to a problem in the configuration or current state of the specified directory.
      • ThrottlingException The limit on the number of requests per second has been exceeded.
      • 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.
      • DirectoryServiceDataException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeUser

      default CompletableFuture<DescribeUserResponse> describeUser(DescribeUserRequest describeUserRequest)

      Returns information about a specific user.

      Parameters:
      describeUserRequest -
      Returns:
      A Java Future containing the result of the DescribeUser 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.
      • ResourceNotFoundException The resource couldn't be found.
      • AccessDeniedException You don't have permission to perform the request or access the directory. It can also occur when the DirectoryId doesn't exist or the user, member, or group might be outside of your organizational unit (OU).

        Make sure that you have the authentication and authorization to perform the action. Review the directory information in the request, and make sure that the object isn't outside of your OU.

      • InternalServerException The operation didn't succeed because an internal error occurred. Try again later.
      • ValidationException The request isn't valid. Review the details in the error message to update the invalid parameters or values in your request.
      • DirectoryUnavailableException The request could not be completed due to a problem in the configuration or current state of the specified directory.
      • ThrottlingException The limit on the number of requests per second has been exceeded.
      • 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.
      • DirectoryServiceDataException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeUser

      default CompletableFuture<DescribeUserResponse> describeUser(Consumer<DescribeUserRequest.Builder> describeUserRequest)

      Returns information about a specific user.


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

      Parameters:
      describeUserRequest - A Consumer that will call methods on DescribeUserRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeUser 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.
      • ResourceNotFoundException The resource couldn't be found.
      • AccessDeniedException You don't have permission to perform the request or access the directory. It can also occur when the DirectoryId doesn't exist or the user, member, or group might be outside of your organizational unit (OU).

        Make sure that you have the authentication and authorization to perform the action. Review the directory information in the request, and make sure that the object isn't outside of your OU.

      • InternalServerException The operation didn't succeed because an internal error occurred. Try again later.
      • ValidationException The request isn't valid. Review the details in the error message to update the invalid parameters or values in your request.
      • DirectoryUnavailableException The request could not be completed due to a problem in the configuration or current state of the specified directory.
      • ThrottlingException The limit on the number of requests per second has been exceeded.
      • 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.
      • DirectoryServiceDataException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • disableUser

      default CompletableFuture<DisableUserResponse> disableUser(DisableUserRequest disableUserRequest)

      Deactivates an active user account. For information about how to enable an inactive user account, see ResetUserPassword in the Directory Service API Reference.

      Parameters:
      disableUserRequest -
      Returns:
      A Java Future containing the result of the DisableUser 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.
      • ResourceNotFoundException The resource couldn't be found.
      • AccessDeniedException You don't have permission to perform the request or access the directory. It can also occur when the DirectoryId doesn't exist or the user, member, or group might be outside of your organizational unit (OU).

        Make sure that you have the authentication and authorization to perform the action. Review the directory information in the request, and make sure that the object isn't outside of your OU.

      • InternalServerException The operation didn't succeed because an internal error occurred. Try again later.
      • ValidationException The request isn't valid. Review the details in the error message to update the invalid parameters or values in your request.
      • DirectoryUnavailableException The request could not be completed due to a problem in the configuration or current state of the specified directory.
      • ConflictException This error will occur when you try to create a resource that conflicts with an existing object. It can also occur when adding a member to a group that the member is already in.

        This error can be caused by a request sent within the 8-hour idempotency window with the same client token but different input parameters. Client tokens should not be re-used across different requests. After 8 hours, any request with the same client token is treated as a new request.

      • ThrottlingException The limit on the number of requests per second has been exceeded.
      • 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.
      • DirectoryServiceDataException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • disableUser

      default CompletableFuture<DisableUserResponse> disableUser(Consumer<DisableUserRequest.Builder> disableUserRequest)

      Deactivates an active user account. For information about how to enable an inactive user account, see ResetUserPassword in the Directory Service API Reference.


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

      Parameters:
      disableUserRequest - A Consumer that will call methods on DisableUserRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DisableUser 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.
      • ResourceNotFoundException The resource couldn't be found.
      • AccessDeniedException You don't have permission to perform the request or access the directory. It can also occur when the DirectoryId doesn't exist or the user, member, or group might be outside of your organizational unit (OU).

        Make sure that you have the authentication and authorization to perform the action. Review the directory information in the request, and make sure that the object isn't outside of your OU.

      • InternalServerException The operation didn't succeed because an internal error occurred. Try again later.
      • ValidationException The request isn't valid. Review the details in the error message to update the invalid parameters or values in your request.
      • DirectoryUnavailableException The request could not be completed due to a problem in the configuration or current state of the specified directory.
      • ConflictException This error will occur when you try to create a resource that conflicts with an existing object. It can also occur when adding a member to a group that the member is already in.

        This error can be caused by a request sent within the 8-hour idempotency window with the same client token but different input parameters. Client tokens should not be re-used across different requests. After 8 hours, any request with the same client token is treated as a new request.

      • ThrottlingException The limit on the number of requests per second has been exceeded.
      • 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.
      • DirectoryServiceDataException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listGroupMembers

      default CompletableFuture<ListGroupMembersResponse> listGroupMembers(ListGroupMembersRequest listGroupMembersRequest)

      Returns member information for the specified group.

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

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

      Parameters:
      listGroupMembersRequest -
      Returns:
      A Java Future containing the result of the ListGroupMembers 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.
      • ResourceNotFoundException The resource couldn't be found.
      • AccessDeniedException You don't have permission to perform the request or access the directory. It can also occur when the DirectoryId doesn't exist or the user, member, or group might be outside of your organizational unit (OU).

        Make sure that you have the authentication and authorization to perform the action. Review the directory information in the request, and make sure that the object isn't outside of your OU.

      • InternalServerException The operation didn't succeed because an internal error occurred. Try again later.
      • ValidationException The request isn't valid. Review the details in the error message to update the invalid parameters or values in your request.
      • DirectoryUnavailableException The request could not be completed due to a problem in the configuration or current state of the specified directory.
      • ThrottlingException The limit on the number of requests per second has been exceeded.
      • 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.
      • DirectoryServiceDataException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listGroupMembers

      default CompletableFuture<ListGroupMembersResponse> listGroupMembers(Consumer<ListGroupMembersRequest.Builder> listGroupMembersRequest)

      Returns member information for the specified group.

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

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


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

      Parameters:
      listGroupMembersRequest - A Consumer that will call methods on ListGroupMembersRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListGroupMembers 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.
      • ResourceNotFoundException The resource couldn't be found.
      • AccessDeniedException You don't have permission to perform the request or access the directory. It can also occur when the DirectoryId doesn't exist or the user, member, or group might be outside of your organizational unit (OU).

        Make sure that you have the authentication and authorization to perform the action. Review the directory information in the request, and make sure that the object isn't outside of your OU.

      • InternalServerException The operation didn't succeed because an internal error occurred. Try again later.
      • ValidationException The request isn't valid. Review the details in the error message to update the invalid parameters or values in your request.
      • DirectoryUnavailableException The request could not be completed due to a problem in the configuration or current state of the specified directory.
      • ThrottlingException The limit on the number of requests per second has been exceeded.
      • 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.
      • DirectoryServiceDataException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listGroupMembersPaginator

      default ListGroupMembersPublisher listGroupMembersPaginator(ListGroupMembersRequest listGroupMembersRequest)

      This is a variant of listGroupMembers(software.amazon.awssdk.services.directoryservicedata.model.ListGroupMembersRequest) 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.directoryservicedata.paginators.ListGroupMembersPublisher publisher = client.listGroupMembersPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.directoryservicedata.paginators.ListGroupMembersPublisher publisher = client.listGroupMembersPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.directoryservicedata.model.ListGroupMembersResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.directoryservicedata.model.ListGroupMembersResponse 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 MaxResults 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 listGroupMembers(software.amazon.awssdk.services.directoryservicedata.model.ListGroupMembersRequest) operation.

      Parameters:
      listGroupMembersRequest -
      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.
      • ResourceNotFoundException The resource couldn't be found.
      • AccessDeniedException You don't have permission to perform the request or access the directory. It can also occur when the DirectoryId doesn't exist or the user, member, or group might be outside of your organizational unit (OU).

        Make sure that you have the authentication and authorization to perform the action. Review the directory information in the request, and make sure that the object isn't outside of your OU.

      • InternalServerException The operation didn't succeed because an internal error occurred. Try again later.
      • ValidationException The request isn't valid. Review the details in the error message to update the invalid parameters or values in your request.
      • DirectoryUnavailableException The request could not be completed due to a problem in the configuration or current state of the specified directory.
      • ThrottlingException The limit on the number of requests per second has been exceeded.
      • 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.
      • DirectoryServiceDataException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listGroupMembersPaginator

      default ListGroupMembersPublisher listGroupMembersPaginator(Consumer<ListGroupMembersRequest.Builder> listGroupMembersRequest)

      This is a variant of listGroupMembers(software.amazon.awssdk.services.directoryservicedata.model.ListGroupMembersRequest) 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.directoryservicedata.paginators.ListGroupMembersPublisher publisher = client.listGroupMembersPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.directoryservicedata.paginators.ListGroupMembersPublisher publisher = client.listGroupMembersPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.directoryservicedata.model.ListGroupMembersResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.directoryservicedata.model.ListGroupMembersResponse 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 MaxResults 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 listGroupMembers(software.amazon.awssdk.services.directoryservicedata.model.ListGroupMembersRequest) operation.


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

      Parameters:
      listGroupMembersRequest - A Consumer that will call methods on ListGroupMembersRequest.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.
      • ResourceNotFoundException The resource couldn't be found.
      • AccessDeniedException You don't have permission to perform the request or access the directory. It can also occur when the DirectoryId doesn't exist or the user, member, or group might be outside of your organizational unit (OU).

        Make sure that you have the authentication and authorization to perform the action. Review the directory information in the request, and make sure that the object isn't outside of your OU.

      • InternalServerException The operation didn't succeed because an internal error occurred. Try again later.
      • ValidationException The request isn't valid. Review the details in the error message to update the invalid parameters or values in your request.
      • DirectoryUnavailableException The request could not be completed due to a problem in the configuration or current state of the specified directory.
      • ThrottlingException The limit on the number of requests per second has been exceeded.
      • 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.
      • DirectoryServiceDataException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listGroups

      default CompletableFuture<ListGroupsResponse> listGroups(ListGroupsRequest listGroupsRequest)

      Returns group information for the specified directory.

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

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

      Parameters:
      listGroupsRequest -
      Returns:
      A Java Future containing the result of the ListGroups 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.
      • AccessDeniedException You don't have permission to perform the request or access the directory. It can also occur when the DirectoryId doesn't exist or the user, member, or group might be outside of your organizational unit (OU).

        Make sure that you have the authentication and authorization to perform the action. Review the directory information in the request, and make sure that the object isn't outside of your OU.

      • InternalServerException The operation didn't succeed because an internal error occurred. Try again later.
      • ValidationException The request isn't valid. Review the details in the error message to update the invalid parameters or values in your request.
      • DirectoryUnavailableException The request could not be completed due to a problem in the configuration or current state of the specified directory.
      • ThrottlingException The limit on the number of requests per second has been exceeded.
      • 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.
      • DirectoryServiceDataException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listGroups

      default CompletableFuture<ListGroupsResponse> listGroups(Consumer<ListGroupsRequest.Builder> listGroupsRequest)

      Returns group information for the specified directory.

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

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


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

      Parameters:
      listGroupsRequest - A Consumer that will call methods on ListGroupsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListGroups 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.
      • AccessDeniedException You don't have permission to perform the request or access the directory. It can also occur when the DirectoryId doesn't exist or the user, member, or group might be outside of your organizational unit (OU).

        Make sure that you have the authentication and authorization to perform the action. Review the directory information in the request, and make sure that the object isn't outside of your OU.

      • InternalServerException The operation didn't succeed because an internal error occurred. Try again later.
      • ValidationException The request isn't valid. Review the details in the error message to update the invalid parameters or values in your request.
      • DirectoryUnavailableException The request could not be completed due to a problem in the configuration or current state of the specified directory.
      • ThrottlingException The limit on the number of requests per second has been exceeded.
      • 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.
      • DirectoryServiceDataException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listGroupsForMember

      default CompletableFuture<ListGroupsForMemberResponse> listGroupsForMember(ListGroupsForMemberRequest listGroupsForMemberRequest)

      Returns group information for the specified member.

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

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

      Parameters:
      listGroupsForMemberRequest -
      Returns:
      A Java Future containing the result of the ListGroupsForMember 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.
      • ResourceNotFoundException The resource couldn't be found.
      • AccessDeniedException You don't have permission to perform the request or access the directory. It can also occur when the DirectoryId doesn't exist or the user, member, or group might be outside of your organizational unit (OU).

        Make sure that you have the authentication and authorization to perform the action. Review the directory information in the request, and make sure that the object isn't outside of your OU.

      • InternalServerException The operation didn't succeed because an internal error occurred. Try again later.
      • ValidationException The request isn't valid. Review the details in the error message to update the invalid parameters or values in your request.
      • DirectoryUnavailableException The request could not be completed due to a problem in the configuration or current state of the specified directory.
      • ThrottlingException The limit on the number of requests per second has been exceeded.
      • 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.
      • DirectoryServiceDataException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listGroupsForMember

      default CompletableFuture<ListGroupsForMemberResponse> listGroupsForMember(Consumer<ListGroupsForMemberRequest.Builder> listGroupsForMemberRequest)

      Returns group information for the specified member.

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

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


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

      Parameters:
      listGroupsForMemberRequest - A Consumer that will call methods on ListGroupsForMemberRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListGroupsForMember 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.
      • ResourceNotFoundException The resource couldn't be found.
      • AccessDeniedException You don't have permission to perform the request or access the directory. It can also occur when the DirectoryId doesn't exist or the user, member, or group might be outside of your organizational unit (OU).

        Make sure that you have the authentication and authorization to perform the action. Review the directory information in the request, and make sure that the object isn't outside of your OU.

      • InternalServerException The operation didn't succeed because an internal error occurred. Try again later.
      • ValidationException The request isn't valid. Review the details in the error message to update the invalid parameters or values in your request.
      • DirectoryUnavailableException The request could not be completed due to a problem in the configuration or current state of the specified directory.
      • ThrottlingException The limit on the number of requests per second has been exceeded.
      • 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.
      • DirectoryServiceDataException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listGroupsForMemberPaginator

      default ListGroupsForMemberPublisher listGroupsForMemberPaginator(ListGroupsForMemberRequest listGroupsForMemberRequest)

      This is a variant of listGroupsForMember(software.amazon.awssdk.services.directoryservicedata.model.ListGroupsForMemberRequest) 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.directoryservicedata.paginators.ListGroupsForMemberPublisher publisher = client.listGroupsForMemberPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.directoryservicedata.paginators.ListGroupsForMemberPublisher publisher = client.listGroupsForMemberPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.directoryservicedata.model.ListGroupsForMemberResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.directoryservicedata.model.ListGroupsForMemberResponse 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 MaxResults 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 listGroupsForMember(software.amazon.awssdk.services.directoryservicedata.model.ListGroupsForMemberRequest) operation.

      Parameters:
      listGroupsForMemberRequest -
      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.
      • ResourceNotFoundException The resource couldn't be found.
      • AccessDeniedException You don't have permission to perform the request or access the directory. It can also occur when the DirectoryId doesn't exist or the user, member, or group might be outside of your organizational unit (OU).

        Make sure that you have the authentication and authorization to perform the action. Review the directory information in the request, and make sure that the object isn't outside of your OU.

      • InternalServerException The operation didn't succeed because an internal error occurred. Try again later.
      • ValidationException The request isn't valid. Review the details in the error message to update the invalid parameters or values in your request.
      • DirectoryUnavailableException The request could not be completed due to a problem in the configuration or current state of the specified directory.
      • ThrottlingException The limit on the number of requests per second has been exceeded.
      • 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.
      • DirectoryServiceDataException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listGroupsForMemberPaginator

      default ListGroupsForMemberPublisher listGroupsForMemberPaginator(Consumer<ListGroupsForMemberRequest.Builder> listGroupsForMemberRequest)

      This is a variant of listGroupsForMember(software.amazon.awssdk.services.directoryservicedata.model.ListGroupsForMemberRequest) 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.directoryservicedata.paginators.ListGroupsForMemberPublisher publisher = client.listGroupsForMemberPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.directoryservicedata.paginators.ListGroupsForMemberPublisher publisher = client.listGroupsForMemberPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.directoryservicedata.model.ListGroupsForMemberResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.directoryservicedata.model.ListGroupsForMemberResponse 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 MaxResults 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 listGroupsForMember(software.amazon.awssdk.services.directoryservicedata.model.ListGroupsForMemberRequest) operation.


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

      Parameters:
      listGroupsForMemberRequest - A Consumer that will call methods on ListGroupsForMemberRequest.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.
      • ResourceNotFoundException The resource couldn't be found.
      • AccessDeniedException You don't have permission to perform the request or access the directory. It can also occur when the DirectoryId doesn't exist or the user, member, or group might be outside of your organizational unit (OU).

        Make sure that you have the authentication and authorization to perform the action. Review the directory information in the request, and make sure that the object isn't outside of your OU.

      • InternalServerException The operation didn't succeed because an internal error occurred. Try again later.
      • ValidationException The request isn't valid. Review the details in the error message to update the invalid parameters or values in your request.
      • DirectoryUnavailableException The request could not be completed due to a problem in the configuration or current state of the specified directory.
      • ThrottlingException The limit on the number of requests per second has been exceeded.
      • 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.
      • DirectoryServiceDataException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listGroupsPaginator

      default ListGroupsPublisher listGroupsPaginator(ListGroupsRequest listGroupsRequest)

      This is a variant of listGroups(software.amazon.awssdk.services.directoryservicedata.model.ListGroupsRequest) 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.directoryservicedata.paginators.ListGroupsPublisher publisher = client.listGroupsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.directoryservicedata.paginators.ListGroupsPublisher publisher = client.listGroupsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.directoryservicedata.model.ListGroupsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.directoryservicedata.model.ListGroupsResponse 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 MaxResults 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 listGroups(software.amazon.awssdk.services.directoryservicedata.model.ListGroupsRequest) operation.

      Parameters:
      listGroupsRequest -
      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.
      • AccessDeniedException You don't have permission to perform the request or access the directory. It can also occur when the DirectoryId doesn't exist or the user, member, or group might be outside of your organizational unit (OU).

        Make sure that you have the authentication and authorization to perform the action. Review the directory information in the request, and make sure that the object isn't outside of your OU.

      • InternalServerException The operation didn't succeed because an internal error occurred. Try again later.
      • ValidationException The request isn't valid. Review the details in the error message to update the invalid parameters or values in your request.
      • DirectoryUnavailableException The request could not be completed due to a problem in the configuration or current state of the specified directory.
      • ThrottlingException The limit on the number of requests per second has been exceeded.
      • 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.
      • DirectoryServiceDataException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listGroupsPaginator

      default ListGroupsPublisher listGroupsPaginator(Consumer<ListGroupsRequest.Builder> listGroupsRequest)

      This is a variant of listGroups(software.amazon.awssdk.services.directoryservicedata.model.ListGroupsRequest) 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.directoryservicedata.paginators.ListGroupsPublisher publisher = client.listGroupsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.directoryservicedata.paginators.ListGroupsPublisher publisher = client.listGroupsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.directoryservicedata.model.ListGroupsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.directoryservicedata.model.ListGroupsResponse 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 MaxResults 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 listGroups(software.amazon.awssdk.services.directoryservicedata.model.ListGroupsRequest) operation.


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

      Parameters:
      listGroupsRequest - A Consumer that will call methods on ListGroupsRequest.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.
      • AccessDeniedException You don't have permission to perform the request or access the directory. It can also occur when the DirectoryId doesn't exist or the user, member, or group might be outside of your organizational unit (OU).

        Make sure that you have the authentication and authorization to perform the action. Review the directory information in the request, and make sure that the object isn't outside of your OU.

      • InternalServerException The operation didn't succeed because an internal error occurred. Try again later.
      • ValidationException The request isn't valid. Review the details in the error message to update the invalid parameters or values in your request.
      • DirectoryUnavailableException The request could not be completed due to a problem in the configuration or current state of the specified directory.
      • ThrottlingException The limit on the number of requests per second has been exceeded.
      • 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.
      • DirectoryServiceDataException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listUsers

      default CompletableFuture<ListUsersResponse> listUsers(ListUsersRequest listUsersRequest)

      Returns user information for the specified directory.

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

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

      Parameters:
      listUsersRequest -
      Returns:
      A Java Future containing the result of the ListUsers 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.
      • AccessDeniedException You don't have permission to perform the request or access the directory. It can also occur when the DirectoryId doesn't exist or the user, member, or group might be outside of your organizational unit (OU).

        Make sure that you have the authentication and authorization to perform the action. Review the directory information in the request, and make sure that the object isn't outside of your OU.

      • InternalServerException The operation didn't succeed because an internal error occurred. Try again later.
      • ValidationException The request isn't valid. Review the details in the error message to update the invalid parameters or values in your request.
      • DirectoryUnavailableException The request could not be completed due to a problem in the configuration or current state of the specified directory.
      • ThrottlingException The limit on the number of requests per second has been exceeded.
      • 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.
      • DirectoryServiceDataException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listUsers

      default CompletableFuture<ListUsersResponse> listUsers(Consumer<ListUsersRequest.Builder> listUsersRequest)

      Returns user information for the specified directory.

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

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


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

      Parameters:
      listUsersRequest - A Consumer that will call methods on ListUsersRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListUsers 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.
      • AccessDeniedException You don't have permission to perform the request or access the directory. It can also occur when the DirectoryId doesn't exist or the user, member, or group might be outside of your organizational unit (OU).

        Make sure that you have the authentication and authorization to perform the action. Review the directory information in the request, and make sure that the object isn't outside of your OU.

      • InternalServerException The operation didn't succeed because an internal error occurred. Try again later.
      • ValidationException The request isn't valid. Review the details in the error message to update the invalid parameters or values in your request.
      • DirectoryUnavailableException The request could not be completed due to a problem in the configuration or current state of the specified directory.
      • ThrottlingException The limit on the number of requests per second has been exceeded.
      • 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.
      • DirectoryServiceDataException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listUsersPaginator

      default ListUsersPublisher listUsersPaginator(ListUsersRequest listUsersRequest)

      This is a variant of listUsers(software.amazon.awssdk.services.directoryservicedata.model.ListUsersRequest) 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.directoryservicedata.paginators.ListUsersPublisher publisher = client.listUsersPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.directoryservicedata.paginators.ListUsersPublisher publisher = client.listUsersPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.directoryservicedata.model.ListUsersResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.directoryservicedata.model.ListUsersResponse 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 MaxResults 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 listUsers(software.amazon.awssdk.services.directoryservicedata.model.ListUsersRequest) operation.

      Parameters:
      listUsersRequest -
      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.
      • AccessDeniedException You don't have permission to perform the request or access the directory. It can also occur when the DirectoryId doesn't exist or the user, member, or group might be outside of your organizational unit (OU).

        Make sure that you have the authentication and authorization to perform the action. Review the directory information in the request, and make sure that the object isn't outside of your OU.

      • InternalServerException The operation didn't succeed because an internal error occurred. Try again later.
      • ValidationException The request isn't valid. Review the details in the error message to update the invalid parameters or values in your request.
      • DirectoryUnavailableException The request could not be completed due to a problem in the configuration or current state of the specified directory.
      • ThrottlingException The limit on the number of requests per second has been exceeded.
      • 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.
      • DirectoryServiceDataException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listUsersPaginator

      default ListUsersPublisher listUsersPaginator(Consumer<ListUsersRequest.Builder> listUsersRequest)

      This is a variant of listUsers(software.amazon.awssdk.services.directoryservicedata.model.ListUsersRequest) 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.directoryservicedata.paginators.ListUsersPublisher publisher = client.listUsersPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.directoryservicedata.paginators.ListUsersPublisher publisher = client.listUsersPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.directoryservicedata.model.ListUsersResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.directoryservicedata.model.ListUsersResponse 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 MaxResults 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 listUsers(software.amazon.awssdk.services.directoryservicedata.model.ListUsersRequest) operation.


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

      Parameters:
      listUsersRequest - A Consumer that will call methods on ListUsersRequest.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.
      • AccessDeniedException You don't have permission to perform the request or access the directory. It can also occur when the DirectoryId doesn't exist or the user, member, or group might be outside of your organizational unit (OU).

        Make sure that you have the authentication and authorization to perform the action. Review the directory information in the request, and make sure that the object isn't outside of your OU.

      • InternalServerException The operation didn't succeed because an internal error occurred. Try again later.
      • ValidationException The request isn't valid. Review the details in the error message to update the invalid parameters or values in your request.
      • DirectoryUnavailableException The request could not be completed due to a problem in the configuration or current state of the specified directory.
      • ThrottlingException The limit on the number of requests per second has been exceeded.
      • 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.
      • DirectoryServiceDataException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • removeGroupMember

      default CompletableFuture<RemoveGroupMemberResponse> removeGroupMember(RemoveGroupMemberRequest removeGroupMemberRequest)

      Removes a member from a group.

      Parameters:
      removeGroupMemberRequest -
      Returns:
      A Java Future containing the result of the RemoveGroupMember 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.
      • ResourceNotFoundException The resource couldn't be found.
      • AccessDeniedException You don't have permission to perform the request or access the directory. It can also occur when the DirectoryId doesn't exist or the user, member, or group might be outside of your organizational unit (OU).

        Make sure that you have the authentication and authorization to perform the action. Review the directory information in the request, and make sure that the object isn't outside of your OU.

      • InternalServerException The operation didn't succeed because an internal error occurred. Try again later.
      • ValidationException The request isn't valid. Review the details in the error message to update the invalid parameters or values in your request.
      • DirectoryUnavailableException The request could not be completed due to a problem in the configuration or current state of the specified directory.
      • ConflictException This error will occur when you try to create a resource that conflicts with an existing object. It can also occur when adding a member to a group that the member is already in.

        This error can be caused by a request sent within the 8-hour idempotency window with the same client token but different input parameters. Client tokens should not be re-used across different requests. After 8 hours, any request with the same client token is treated as a new request.

      • ThrottlingException The limit on the number of requests per second has been exceeded.
      • 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.
      • DirectoryServiceDataException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • removeGroupMember

      default CompletableFuture<RemoveGroupMemberResponse> removeGroupMember(Consumer<RemoveGroupMemberRequest.Builder> removeGroupMemberRequest)

      Removes a member from a group.


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

      Parameters:
      removeGroupMemberRequest - A Consumer that will call methods on RemoveGroupMemberRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the RemoveGroupMember 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.
      • ResourceNotFoundException The resource couldn't be found.
      • AccessDeniedException You don't have permission to perform the request or access the directory. It can also occur when the DirectoryId doesn't exist or the user, member, or group might be outside of your organizational unit (OU).

        Make sure that you have the authentication and authorization to perform the action. Review the directory information in the request, and make sure that the object isn't outside of your OU.

      • InternalServerException The operation didn't succeed because an internal error occurred. Try again later.
      • ValidationException The request isn't valid. Review the details in the error message to update the invalid parameters or values in your request.
      • DirectoryUnavailableException The request could not be completed due to a problem in the configuration or current state of the specified directory.
      • ConflictException This error will occur when you try to create a resource that conflicts with an existing object. It can also occur when adding a member to a group that the member is already in.

        This error can be caused by a request sent within the 8-hour idempotency window with the same client token but different input parameters. Client tokens should not be re-used across different requests. After 8 hours, any request with the same client token is treated as a new request.

      • ThrottlingException The limit on the number of requests per second has been exceeded.
      • 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.
      • DirectoryServiceDataException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • searchGroups

      default CompletableFuture<SearchGroupsResponse> searchGroups(SearchGroupsRequest searchGroupsRequest)

      Searches the specified directory for a group. You can find groups that match the SearchString parameter with the value of their attributes included in the SearchString parameter.

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

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

      Parameters:
      searchGroupsRequest -
      Returns:
      A Java Future containing the result of the SearchGroups 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.
      • AccessDeniedException You don't have permission to perform the request or access the directory. It can also occur when the DirectoryId doesn't exist or the user, member, or group might be outside of your organizational unit (OU).

        Make sure that you have the authentication and authorization to perform the action. Review the directory information in the request, and make sure that the object isn't outside of your OU.

      • InternalServerException The operation didn't succeed because an internal error occurred. Try again later.
      • ValidationException The request isn't valid. Review the details in the error message to update the invalid parameters or values in your request.
      • DirectoryUnavailableException The request could not be completed due to a problem in the configuration or current state of the specified directory.
      • ThrottlingException The limit on the number of requests per second has been exceeded.
      • 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.
      • DirectoryServiceDataException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • searchGroups

      default CompletableFuture<SearchGroupsResponse> searchGroups(Consumer<SearchGroupsRequest.Builder> searchGroupsRequest)

      Searches the specified directory for a group. You can find groups that match the SearchString parameter with the value of their attributes included in the SearchString parameter.

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

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


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

      Parameters:
      searchGroupsRequest - A Consumer that will call methods on SearchGroupsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the SearchGroups 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.
      • AccessDeniedException You don't have permission to perform the request or access the directory. It can also occur when the DirectoryId doesn't exist or the user, member, or group might be outside of your organizational unit (OU).

        Make sure that you have the authentication and authorization to perform the action. Review the directory information in the request, and make sure that the object isn't outside of your OU.

      • InternalServerException The operation didn't succeed because an internal error occurred. Try again later.
      • ValidationException The request isn't valid. Review the details in the error message to update the invalid parameters or values in your request.
      • DirectoryUnavailableException The request could not be completed due to a problem in the configuration or current state of the specified directory.
      • ThrottlingException The limit on the number of requests per second has been exceeded.
      • 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.
      • DirectoryServiceDataException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • searchGroupsPaginator

      default SearchGroupsPublisher searchGroupsPaginator(SearchGroupsRequest searchGroupsRequest)

      This is a variant of searchGroups(software.amazon.awssdk.services.directoryservicedata.model.SearchGroupsRequest) 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.directoryservicedata.paginators.SearchGroupsPublisher publisher = client.searchGroupsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.directoryservicedata.paginators.SearchGroupsPublisher publisher = client.searchGroupsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.directoryservicedata.model.SearchGroupsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.directoryservicedata.model.SearchGroupsResponse 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 MaxResults 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 searchGroups(software.amazon.awssdk.services.directoryservicedata.model.SearchGroupsRequest) operation.

      Parameters:
      searchGroupsRequest -
      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.
      • AccessDeniedException You don't have permission to perform the request or access the directory. It can also occur when the DirectoryId doesn't exist or the user, member, or group might be outside of your organizational unit (OU).

        Make sure that you have the authentication and authorization to perform the action. Review the directory information in the request, and make sure that the object isn't outside of your OU.

      • InternalServerException The operation didn't succeed because an internal error occurred. Try again later.
      • ValidationException The request isn't valid. Review the details in the error message to update the invalid parameters or values in your request.
      • DirectoryUnavailableException The request could not be completed due to a problem in the configuration or current state of the specified directory.
      • ThrottlingException The limit on the number of requests per second has been exceeded.
      • 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.
      • DirectoryServiceDataException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • searchGroupsPaginator

      default SearchGroupsPublisher searchGroupsPaginator(Consumer<SearchGroupsRequest.Builder> searchGroupsRequest)

      This is a variant of searchGroups(software.amazon.awssdk.services.directoryservicedata.model.SearchGroupsRequest) 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.directoryservicedata.paginators.SearchGroupsPublisher publisher = client.searchGroupsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.directoryservicedata.paginators.SearchGroupsPublisher publisher = client.searchGroupsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.directoryservicedata.model.SearchGroupsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.directoryservicedata.model.SearchGroupsResponse 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 MaxResults 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 searchGroups(software.amazon.awssdk.services.directoryservicedata.model.SearchGroupsRequest) operation.


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

      Parameters:
      searchGroupsRequest - A Consumer that will call methods on SearchGroupsRequest.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.
      • AccessDeniedException You don't have permission to perform the request or access the directory. It can also occur when the DirectoryId doesn't exist or the user, member, or group might be outside of your organizational unit (OU).

        Make sure that you have the authentication and authorization to perform the action. Review the directory information in the request, and make sure that the object isn't outside of your OU.

      • InternalServerException The operation didn't succeed because an internal error occurred. Try again later.
      • ValidationException The request isn't valid. Review the details in the error message to update the invalid parameters or values in your request.
      • DirectoryUnavailableException The request could not be completed due to a problem in the configuration or current state of the specified directory.
      • ThrottlingException The limit on the number of requests per second has been exceeded.
      • 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.
      • DirectoryServiceDataException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • searchUsers

      default CompletableFuture<SearchUsersResponse> searchUsers(SearchUsersRequest searchUsersRequest)

      Searches the specified directory for a user. You can find users that match the SearchString parameter with the value of their attributes included in the SearchString parameter.

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

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

      Parameters:
      searchUsersRequest -
      Returns:
      A Java Future containing the result of the SearchUsers 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.
      • AccessDeniedException You don't have permission to perform the request or access the directory. It can also occur when the DirectoryId doesn't exist or the user, member, or group might be outside of your organizational unit (OU).

        Make sure that you have the authentication and authorization to perform the action. Review the directory information in the request, and make sure that the object isn't outside of your OU.

      • InternalServerException The operation didn't succeed because an internal error occurred. Try again later.
      • ValidationException The request isn't valid. Review the details in the error message to update the invalid parameters or values in your request.
      • DirectoryUnavailableException The request could not be completed due to a problem in the configuration or current state of the specified directory.
      • ThrottlingException The limit on the number of requests per second has been exceeded.
      • 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.
      • DirectoryServiceDataException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • searchUsers

      default CompletableFuture<SearchUsersResponse> searchUsers(Consumer<SearchUsersRequest.Builder> searchUsersRequest)

      Searches the specified directory for a user. You can find users that match the SearchString parameter with the value of their attributes included in the SearchString parameter.

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

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


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

      Parameters:
      searchUsersRequest - A Consumer that will call methods on SearchUsersRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the SearchUsers 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.
      • AccessDeniedException You don't have permission to perform the request or access the directory. It can also occur when the DirectoryId doesn't exist or the user, member, or group might be outside of your organizational unit (OU).

        Make sure that you have the authentication and authorization to perform the action. Review the directory information in the request, and make sure that the object isn't outside of your OU.

      • InternalServerException The operation didn't succeed because an internal error occurred. Try again later.
      • ValidationException The request isn't valid. Review the details in the error message to update the invalid parameters or values in your request.
      • DirectoryUnavailableException The request could not be completed due to a problem in the configuration or current state of the specified directory.
      • ThrottlingException The limit on the number of requests per second has been exceeded.
      • 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.
      • DirectoryServiceDataException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • searchUsersPaginator

      default SearchUsersPublisher searchUsersPaginator(SearchUsersRequest searchUsersRequest)

      This is a variant of searchUsers(software.amazon.awssdk.services.directoryservicedata.model.SearchUsersRequest) 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.directoryservicedata.paginators.SearchUsersPublisher publisher = client.searchUsersPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.directoryservicedata.paginators.SearchUsersPublisher publisher = client.searchUsersPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.directoryservicedata.model.SearchUsersResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.directoryservicedata.model.SearchUsersResponse 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 MaxResults 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 searchUsers(software.amazon.awssdk.services.directoryservicedata.model.SearchUsersRequest) operation.

      Parameters:
      searchUsersRequest -
      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.
      • AccessDeniedException You don't have permission to perform the request or access the directory. It can also occur when the DirectoryId doesn't exist or the user, member, or group might be outside of your organizational unit (OU).

        Make sure that you have the authentication and authorization to perform the action. Review the directory information in the request, and make sure that the object isn't outside of your OU.

      • InternalServerException The operation didn't succeed because an internal error occurred. Try again later.
      • ValidationException The request isn't valid. Review the details in the error message to update the invalid parameters or values in your request.
      • DirectoryUnavailableException The request could not be completed due to a problem in the configuration or current state of the specified directory.
      • ThrottlingException The limit on the number of requests per second has been exceeded.
      • 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.
      • DirectoryServiceDataException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • searchUsersPaginator

      default SearchUsersPublisher searchUsersPaginator(Consumer<SearchUsersRequest.Builder> searchUsersRequest)

      This is a variant of searchUsers(software.amazon.awssdk.services.directoryservicedata.model.SearchUsersRequest) 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.directoryservicedata.paginators.SearchUsersPublisher publisher = client.searchUsersPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.directoryservicedata.paginators.SearchUsersPublisher publisher = client.searchUsersPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.directoryservicedata.model.SearchUsersResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.directoryservicedata.model.SearchUsersResponse 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 MaxResults 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 searchUsers(software.amazon.awssdk.services.directoryservicedata.model.SearchUsersRequest) operation.


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

      Parameters:
      searchUsersRequest - A Consumer that will call methods on SearchUsersRequest.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.
      • AccessDeniedException You don't have permission to perform the request or access the directory. It can also occur when the DirectoryId doesn't exist or the user, member, or group might be outside of your organizational unit (OU).

        Make sure that you have the authentication and authorization to perform the action. Review the directory information in the request, and make sure that the object isn't outside of your OU.

      • InternalServerException The operation didn't succeed because an internal error occurred. Try again later.
      • ValidationException The request isn't valid. Review the details in the error message to update the invalid parameters or values in your request.
      • DirectoryUnavailableException The request could not be completed due to a problem in the configuration or current state of the specified directory.
      • ThrottlingException The limit on the number of requests per second has been exceeded.
      • 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.
      • DirectoryServiceDataException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateGroup

      default CompletableFuture<UpdateGroupResponse> updateGroup(UpdateGroupRequest updateGroupRequest)

      Updates group information.

      Parameters:
      updateGroupRequest -
      Returns:
      A Java Future containing the result of the UpdateGroup 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.
      • ResourceNotFoundException The resource couldn't be found.
      • AccessDeniedException You don't have permission to perform the request or access the directory. It can also occur when the DirectoryId doesn't exist or the user, member, or group might be outside of your organizational unit (OU).

        Make sure that you have the authentication and authorization to perform the action. Review the directory information in the request, and make sure that the object isn't outside of your OU.

      • InternalServerException The operation didn't succeed because an internal error occurred. Try again later.
      • ValidationException The request isn't valid. Review the details in the error message to update the invalid parameters or values in your request.
      • DirectoryUnavailableException The request could not be completed due to a problem in the configuration or current state of the specified directory.
      • ConflictException This error will occur when you try to create a resource that conflicts with an existing object. It can also occur when adding a member to a group that the member is already in.

        This error can be caused by a request sent within the 8-hour idempotency window with the same client token but different input parameters. Client tokens should not be re-used across different requests. After 8 hours, any request with the same client token is treated as a new request.

      • ThrottlingException The limit on the number of requests per second has been exceeded.
      • 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.
      • DirectoryServiceDataException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateGroup

      default CompletableFuture<UpdateGroupResponse> updateGroup(Consumer<UpdateGroupRequest.Builder> updateGroupRequest)

      Updates group information.


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

      Parameters:
      updateGroupRequest - A Consumer that will call methods on UpdateGroupRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateGroup 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.
      • ResourceNotFoundException The resource couldn't be found.
      • AccessDeniedException You don't have permission to perform the request or access the directory. It can also occur when the DirectoryId doesn't exist or the user, member, or group might be outside of your organizational unit (OU).

        Make sure that you have the authentication and authorization to perform the action. Review the directory information in the request, and make sure that the object isn't outside of your OU.

      • InternalServerException The operation didn't succeed because an internal error occurred. Try again later.
      • ValidationException The request isn't valid. Review the details in the error message to update the invalid parameters or values in your request.
      • DirectoryUnavailableException The request could not be completed due to a problem in the configuration or current state of the specified directory.
      • ConflictException This error will occur when you try to create a resource that conflicts with an existing object. It can also occur when adding a member to a group that the member is already in.

        This error can be caused by a request sent within the 8-hour idempotency window with the same client token but different input parameters. Client tokens should not be re-used across different requests. After 8 hours, any request with the same client token is treated as a new request.

      • ThrottlingException The limit on the number of requests per second has been exceeded.
      • 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.
      • DirectoryServiceDataException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateUser

      default CompletableFuture<UpdateUserResponse> updateUser(UpdateUserRequest updateUserRequest)

      Updates user information.

      Parameters:
      updateUserRequest -
      Returns:
      A Java Future containing the result of the UpdateUser 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.
      • ResourceNotFoundException The resource couldn't be found.
      • AccessDeniedException You don't have permission to perform the request or access the directory. It can also occur when the DirectoryId doesn't exist or the user, member, or group might be outside of your organizational unit (OU).

        Make sure that you have the authentication and authorization to perform the action. Review the directory information in the request, and make sure that the object isn't outside of your OU.

      • InternalServerException The operation didn't succeed because an internal error occurred. Try again later.
      • ValidationException The request isn't valid. Review the details in the error message to update the invalid parameters or values in your request.
      • DirectoryUnavailableException The request could not be completed due to a problem in the configuration or current state of the specified directory.
      • ConflictException This error will occur when you try to create a resource that conflicts with an existing object. It can also occur when adding a member to a group that the member is already in.

        This error can be caused by a request sent within the 8-hour idempotency window with the same client token but different input parameters. Client tokens should not be re-used across different requests. After 8 hours, any request with the same client token is treated as a new request.

      • ThrottlingException The limit on the number of requests per second has been exceeded.
      • 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.
      • DirectoryServiceDataException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateUser

      default CompletableFuture<UpdateUserResponse> updateUser(Consumer<UpdateUserRequest.Builder> updateUserRequest)

      Updates user information.


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

      Parameters:
      updateUserRequest - A Consumer that will call methods on UpdateUserRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateUser 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.
      • ResourceNotFoundException The resource couldn't be found.
      • AccessDeniedException You don't have permission to perform the request or access the directory. It can also occur when the DirectoryId doesn't exist or the user, member, or group might be outside of your organizational unit (OU).

        Make sure that you have the authentication and authorization to perform the action. Review the directory information in the request, and make sure that the object isn't outside of your OU.

      • InternalServerException The operation didn't succeed because an internal error occurred. Try again later.
      • ValidationException The request isn't valid. Review the details in the error message to update the invalid parameters or values in your request.
      • DirectoryUnavailableException The request could not be completed due to a problem in the configuration or current state of the specified directory.
      • ConflictException This error will occur when you try to create a resource that conflicts with an existing object. It can also occur when adding a member to a group that the member is already in.

        This error can be caused by a request sent within the 8-hour idempotency window with the same client token but different input parameters. Client tokens should not be re-used across different requests. After 8 hours, any request with the same client token is treated as a new request.

      • ThrottlingException The limit on the number of requests per second has been exceeded.
      • 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.
      • DirectoryServiceDataException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • serviceClientConfiguration

      default DirectoryServiceDataServiceClientConfiguration 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 DirectoryServiceDataAsyncClient create()
      Create a DirectoryServiceDataAsyncClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

    • builder

      static DirectoryServiceDataAsyncClientBuilder builder()
      Create a builder that can be used to configure and create a DirectoryServiceDataAsyncClient.