Interface WorkDocsAsyncClient

All Superinterfaces:
AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient

@Generated("software.amazon.awssdk:codegen") @ThreadSafe public interface WorkDocsAsyncClient extends AwsClient
Service client for accessing Amazon WorkDocs asynchronously. This can be created using the static builder() method.The asynchronous client performs non-blocking I/O when configured with any
invalid reference
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.

The Amazon WorkDocs API is designed for the following use cases:

  • File Migration: File migration applications are supported for users who want to migrate their files from an on-premises or off-premises file system or service. Users can insert files into a user directory structure, as well as allow for basic metadata changes, such as modifications to the permissions of files.

  • Security: Support security applications are supported for users who have additional security needs, such as antivirus or data loss prevention. The API actions, along with CloudTrail, allow these applications to detect when changes occur in Amazon WorkDocs. Then, the application can take the necessary actions and replace the target file. If the target file violates the policy, the application can also choose to email the user.

  • eDiscovery/Analytics: General administrative applications are supported, such as eDiscovery and analytics. These applications can choose to mimic or record the actions in an Amazon WorkDocs site, along with CloudTrail, to replicate data for eDiscovery, backup, or analytical applications.

All Amazon WorkDocs API actions are Amazon authenticated and certificate-signed. They not only require the use of the Amazon Web Services SDK, but also allow for the exclusive use of IAM users and roles to help facilitate access, trust, and permission policies. By creating a role and allowing an IAM user to access the Amazon WorkDocs site, the IAM user gains full administrative visibility into the entire Amazon WorkDocs site (or as set in the IAM policy). This includes, but is not limited to, the ability to modify file permissions and upload any file to any user. This allows developers to perform the three use cases above, as well as give users the ability to grant access on a selective basis using the IAM model.

The pricing for Amazon WorkDocs APIs varies depending on the API call type for these actions:

  • READ (Get*)

  • WRITE (Activate*, Add*, Create*, Deactivate*, Initiate*, Update*)

  • LIST (Describe*)

  • DELETE*, CANCEL

For information about Amazon WorkDocs API pricing, see Amazon WorkDocs Pricing.

  • Field Details

  • Method Details

    • abortDocumentVersionUpload

      default CompletableFuture<AbortDocumentVersionUploadResponse> abortDocumentVersionUpload(AbortDocumentVersionUploadRequest abortDocumentVersionUploadRequest)

      Aborts the upload of the specified document version that was previously initiated by InitiateDocumentVersionUpload. The client should make this call only when it no longer intends to upload the document version, or fails to do so.

      Parameters:
      abortDocumentVersionUploadRequest -
      Returns:
      A Java Future containing the result of the AbortDocumentVersionUpload operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • EntityNotExistsException The resource does not exist.
      • ProhibitedStateException The specified document version is not in the INITIALIZED state.
      • UnauthorizedOperationException The operation is not permitted.
      • UnauthorizedResourceAccessException The caller does not have access to perform the action on the resource.
      • FailedDependencyException The Directory Service cannot reach an on-premises instance. Or a dependency under the control of the organization is failing, such as a connected Active Directory.
      • ServiceUnavailableException One or more of the dependencies is unavailable.
      • ConcurrentModificationException The resource hierarchy is changing.
      • 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.
      • WorkDocsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • abortDocumentVersionUpload

      default CompletableFuture<AbortDocumentVersionUploadResponse> abortDocumentVersionUpload(Consumer<AbortDocumentVersionUploadRequest.Builder> abortDocumentVersionUploadRequest)

      Aborts the upload of the specified document version that was previously initiated by InitiateDocumentVersionUpload. The client should make this call only when it no longer intends to upload the document version, or fails to do so.


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

      Parameters:
      abortDocumentVersionUploadRequest - A Consumer that will call methods on AbortDocumentVersionUploadRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the AbortDocumentVersionUpload operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • EntityNotExistsException The resource does not exist.
      • ProhibitedStateException The specified document version is not in the INITIALIZED state.
      • UnauthorizedOperationException The operation is not permitted.
      • UnauthorizedResourceAccessException The caller does not have access to perform the action on the resource.
      • FailedDependencyException The Directory Service cannot reach an on-premises instance. Or a dependency under the control of the organization is failing, such as a connected Active Directory.
      • ServiceUnavailableException One or more of the dependencies is unavailable.
      • ConcurrentModificationException The resource hierarchy is changing.
      • 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.
      • WorkDocsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • activateUser

      default CompletableFuture<ActivateUserResponse> activateUser(ActivateUserRequest activateUserRequest)

      Activates the specified user. Only active users can access Amazon WorkDocs.

      Parameters:
      activateUserRequest -
      Returns:
      A Java Future containing the result of the ActivateUser operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • EntityNotExistsException The resource does not exist.
      • UnauthorizedOperationException The operation is not permitted.
      • UnauthorizedResourceAccessException The caller does not have access to perform the action on the resource.
      • FailedDependencyException The Directory Service cannot reach an on-premises instance. Or a dependency under the control of the organization is failing, such as a connected Active Directory.
      • ServiceUnavailableException One or more of the dependencies is unavailable.
      • 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.
      • WorkDocsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • activateUser

      default CompletableFuture<ActivateUserResponse> activateUser(Consumer<ActivateUserRequest.Builder> activateUserRequest)

      Activates the specified user. Only active users can access Amazon WorkDocs.


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

      Parameters:
      activateUserRequest - A Consumer that will call methods on ActivateUserRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ActivateUser operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • EntityNotExistsException The resource does not exist.
      • UnauthorizedOperationException The operation is not permitted.
      • UnauthorizedResourceAccessException The caller does not have access to perform the action on the resource.
      • FailedDependencyException The Directory Service cannot reach an on-premises instance. Or a dependency under the control of the organization is failing, such as a connected Active Directory.
      • ServiceUnavailableException One or more of the dependencies is unavailable.
      • 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.
      • WorkDocsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • addResourcePermissions

      default CompletableFuture<AddResourcePermissionsResponse> addResourcePermissions(AddResourcePermissionsRequest addResourcePermissionsRequest)

      Creates a set of permissions for the specified folder or document. The resource permissions are overwritten if the principals already have different permissions.

      Parameters:
      addResourcePermissionsRequest -
      Returns:
      A Java Future containing the result of the AddResourcePermissions operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • UnauthorizedOperationException The operation is not permitted.
      • UnauthorizedResourceAccessException The caller does not have access to perform the action on the resource.
      • FailedDependencyException The Directory Service cannot reach an on-premises instance. Or a dependency under the control of the organization is failing, such as a connected Active Directory.
      • ServiceUnavailableException One or more of the dependencies is unavailable.
      • ProhibitedStateException The specified document version is not in the INITIALIZED state.
      • 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.
      • WorkDocsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • addResourcePermissions

      default CompletableFuture<AddResourcePermissionsResponse> addResourcePermissions(Consumer<AddResourcePermissionsRequest.Builder> addResourcePermissionsRequest)

      Creates a set of permissions for the specified folder or document. The resource permissions are overwritten if the principals already have different permissions.


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

      Parameters:
      addResourcePermissionsRequest - A Consumer that will call methods on AddResourcePermissionsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the AddResourcePermissions operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • UnauthorizedOperationException The operation is not permitted.
      • UnauthorizedResourceAccessException The caller does not have access to perform the action on the resource.
      • FailedDependencyException The Directory Service cannot reach an on-premises instance. Or a dependency under the control of the organization is failing, such as a connected Active Directory.
      • ServiceUnavailableException One or more of the dependencies is unavailable.
      • ProhibitedStateException The specified document version is not in the INITIALIZED state.
      • 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.
      • WorkDocsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • createComment

      default CompletableFuture<CreateCommentResponse> createComment(CreateCommentRequest createCommentRequest)

      Adds a new comment to the specified document version.

      Parameters:
      createCommentRequest -
      Returns:
      A Java Future containing the result of the CreateComment operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • EntityNotExistsException The resource does not exist.
      • ProhibitedStateException The specified document version is not in the INITIALIZED state.
      • UnauthorizedOperationException The operation is not permitted.
      • UnauthorizedResourceAccessException The caller does not have access to perform the action on the resource.
      • FailedDependencyException The Directory Service cannot reach an on-premises instance. Or a dependency under the control of the organization is failing, such as a connected Active Directory.
      • ServiceUnavailableException One or more of the dependencies is unavailable.
      • DocumentLockedForCommentsException This exception is thrown when the document is locked for comments and user tries to create or delete a comment on that document.
      • InvalidCommentOperationException The requested operation is not allowed on the specified comment object.
      • 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.
      • WorkDocsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • createComment

      default CompletableFuture<CreateCommentResponse> createComment(Consumer<CreateCommentRequest.Builder> createCommentRequest)

      Adds a new comment to the specified document version.


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

      Parameters:
      createCommentRequest - A Consumer that will call methods on CreateCommentRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateComment operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • EntityNotExistsException The resource does not exist.
      • ProhibitedStateException The specified document version is not in the INITIALIZED state.
      • UnauthorizedOperationException The operation is not permitted.
      • UnauthorizedResourceAccessException The caller does not have access to perform the action on the resource.
      • FailedDependencyException The Directory Service cannot reach an on-premises instance. Or a dependency under the control of the organization is failing, such as a connected Active Directory.
      • ServiceUnavailableException One or more of the dependencies is unavailable.
      • DocumentLockedForCommentsException This exception is thrown when the document is locked for comments and user tries to create or delete a comment on that document.
      • InvalidCommentOperationException The requested operation is not allowed on the specified comment object.
      • 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.
      • WorkDocsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • createCustomMetadata

      default CompletableFuture<CreateCustomMetadataResponse> createCustomMetadata(CreateCustomMetadataRequest createCustomMetadataRequest)

      Adds one or more custom properties to the specified resource (a folder, document, or version).

      Parameters:
      createCustomMetadataRequest -
      Returns:
      A Java Future containing the result of the CreateCustomMetadata operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • EntityNotExistsException The resource does not exist.
      • UnauthorizedOperationException The operation is not permitted.
      • UnauthorizedResourceAccessException The caller does not have access to perform the action on the resource.
      • ProhibitedStateException The specified document version is not in the INITIALIZED state.
      • CustomMetadataLimitExceededException The limit has been reached on the number of custom properties for the specified resource.
      • FailedDependencyException The Directory Service cannot reach an on-premises instance. Or a dependency under the control of the organization is failing, such as a connected Active Directory.
      • ServiceUnavailableException One or more of the dependencies is unavailable.
      • 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.
      • WorkDocsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • createCustomMetadata

      default CompletableFuture<CreateCustomMetadataResponse> createCustomMetadata(Consumer<CreateCustomMetadataRequest.Builder> createCustomMetadataRequest)

      Adds one or more custom properties to the specified resource (a folder, document, or version).


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

      Parameters:
      createCustomMetadataRequest - A Consumer that will call methods on CreateCustomMetadataRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateCustomMetadata operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • EntityNotExistsException The resource does not exist.
      • UnauthorizedOperationException The operation is not permitted.
      • UnauthorizedResourceAccessException The caller does not have access to perform the action on the resource.
      • ProhibitedStateException The specified document version is not in the INITIALIZED state.
      • CustomMetadataLimitExceededException The limit has been reached on the number of custom properties for the specified resource.
      • FailedDependencyException The Directory Service cannot reach an on-premises instance. Or a dependency under the control of the organization is failing, such as a connected Active Directory.
      • ServiceUnavailableException One or more of the dependencies is unavailable.
      • 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.
      • WorkDocsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • createFolder

      default CompletableFuture<CreateFolderResponse> createFolder(CreateFolderRequest createFolderRequest)

      Creates a folder with the specified name and parent folder.

      Parameters:
      createFolderRequest -
      Returns:
      A Java Future containing the result of the CreateFolder operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • EntityNotExistsException The resource does not exist.
      • EntityAlreadyExistsException The resource already exists.
      • ProhibitedStateException The specified document version is not in the INITIALIZED state.
      • ConflictingOperationException Another operation is in progress on the resource that conflicts with the current operation.
      • ConcurrentModificationException The resource hierarchy is changing.
      • LimitExceededException The maximum of 100,000 files and folders under the parent folder has been exceeded.
      • UnauthorizedOperationException The operation is not permitted.
      • UnauthorizedResourceAccessException The caller does not have access to perform the action on the resource.
      • FailedDependencyException The Directory Service cannot reach an on-premises instance. Or a dependency under the control of the organization is failing, such as a connected Active Directory.
      • ServiceUnavailableException One or more of the dependencies is unavailable.
      • 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.
      • WorkDocsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • createFolder

      default CompletableFuture<CreateFolderResponse> createFolder(Consumer<CreateFolderRequest.Builder> createFolderRequest)

      Creates a folder with the specified name and parent folder.


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

      Parameters:
      createFolderRequest - A Consumer that will call methods on CreateFolderRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateFolder operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • EntityNotExistsException The resource does not exist.
      • EntityAlreadyExistsException The resource already exists.
      • ProhibitedStateException The specified document version is not in the INITIALIZED state.
      • ConflictingOperationException Another operation is in progress on the resource that conflicts with the current operation.
      • ConcurrentModificationException The resource hierarchy is changing.
      • LimitExceededException The maximum of 100,000 files and folders under the parent folder has been exceeded.
      • UnauthorizedOperationException The operation is not permitted.
      • UnauthorizedResourceAccessException The caller does not have access to perform the action on the resource.
      • FailedDependencyException The Directory Service cannot reach an on-premises instance. Or a dependency under the control of the organization is failing, such as a connected Active Directory.
      • ServiceUnavailableException One or more of the dependencies is unavailable.
      • 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.
      • WorkDocsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • createLabels

      default CompletableFuture<CreateLabelsResponse> createLabels(CreateLabelsRequest createLabelsRequest)

      Adds the specified list of labels to the given resource (a document or folder)

      Parameters:
      createLabelsRequest -
      Returns:
      A Java Future containing the result of the CreateLabels operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • EntityNotExistsException The resource does not exist.
      • UnauthorizedOperationException The operation is not permitted.
      • UnauthorizedResourceAccessException The caller does not have access to perform the action on the resource.
      • FailedDependencyException The Directory Service cannot reach an on-premises instance. Or a dependency under the control of the organization is failing, such as a connected Active Directory.
      • ServiceUnavailableException One or more of the dependencies is unavailable.
      • TooManyLabelsException The limit has been reached on the number of labels for the specified resource.
      • 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.
      • WorkDocsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • createLabels

      default CompletableFuture<CreateLabelsResponse> createLabels(Consumer<CreateLabelsRequest.Builder> createLabelsRequest)

      Adds the specified list of labels to the given resource (a document or folder)


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

      Parameters:
      createLabelsRequest - A Consumer that will call methods on CreateLabelsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateLabels operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • EntityNotExistsException The resource does not exist.
      • UnauthorizedOperationException The operation is not permitted.
      • UnauthorizedResourceAccessException The caller does not have access to perform the action on the resource.
      • FailedDependencyException The Directory Service cannot reach an on-premises instance. Or a dependency under the control of the organization is failing, such as a connected Active Directory.
      • ServiceUnavailableException One or more of the dependencies is unavailable.
      • TooManyLabelsException The limit has been reached on the number of labels for the specified resource.
      • 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.
      • WorkDocsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • createNotificationSubscription

      default CompletableFuture<CreateNotificationSubscriptionResponse> createNotificationSubscription(CreateNotificationSubscriptionRequest createNotificationSubscriptionRequest)

      Configure Amazon WorkDocs to use Amazon SNS notifications. The endpoint receives a confirmation message, and must confirm the subscription.

      For more information, see Setting up notifications for an IAM user or role in the Amazon WorkDocs Developer Guide.

      Parameters:
      createNotificationSubscriptionRequest -
      Returns:
      A Java Future containing the result of the CreateNotificationSubscription operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • UnauthorizedResourceAccessException The caller does not have access to perform the action on the resource.
      • TooManySubscriptionsException You've reached the limit on the number of subscriptions for the WorkDocs instance.
      • ServiceUnavailableException One or more of the dependencies is unavailable.
      • InvalidArgumentException The pagination marker or limit fields are not valid.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • WorkDocsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • createNotificationSubscription

      default CompletableFuture<CreateNotificationSubscriptionResponse> createNotificationSubscription(Consumer<CreateNotificationSubscriptionRequest.Builder> createNotificationSubscriptionRequest)

      Configure Amazon WorkDocs to use Amazon SNS notifications. The endpoint receives a confirmation message, and must confirm the subscription.

      For more information, see Setting up notifications for an IAM user or role in the Amazon WorkDocs Developer Guide.


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

      Parameters:
      createNotificationSubscriptionRequest - A Consumer that will call methods on CreateNotificationSubscriptionRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateNotificationSubscription operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • UnauthorizedResourceAccessException The caller does not have access to perform the action on the resource.
      • TooManySubscriptionsException You've reached the limit on the number of subscriptions for the WorkDocs instance.
      • ServiceUnavailableException One or more of the dependencies is unavailable.
      • InvalidArgumentException The pagination marker or limit fields are not valid.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • WorkDocsException 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 user in a Simple AD or Microsoft AD directory. The status of a newly created user is "ACTIVE". New users can access Amazon WorkDocs.

      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.
      • EntityAlreadyExistsException The resource already exists.
      • UnauthorizedOperationException The operation is not permitted.
      • UnauthorizedResourceAccessException The caller does not have access to perform the action on the resource.
      • FailedDependencyException The Directory Service cannot reach an on-premises instance. Or a dependency under the control of the organization is failing, such as a connected Active Directory.
      • ServiceUnavailableException One or more of the dependencies is unavailable.
      • 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.
      • WorkDocsException 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 user in a Simple AD or Microsoft AD directory. The status of a newly created user is "ACTIVE". New users can access Amazon WorkDocs.


      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.
      • EntityAlreadyExistsException The resource already exists.
      • UnauthorizedOperationException The operation is not permitted.
      • UnauthorizedResourceAccessException The caller does not have access to perform the action on the resource.
      • FailedDependencyException The Directory Service cannot reach an on-premises instance. Or a dependency under the control of the organization is failing, such as a connected Active Directory.
      • ServiceUnavailableException One or more of the dependencies is unavailable.
      • 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.
      • WorkDocsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • deactivateUser

      default CompletableFuture<DeactivateUserResponse> deactivateUser(DeactivateUserRequest deactivateUserRequest)

      Deactivates the specified user, which revokes the user's access to Amazon WorkDocs.

      Parameters:
      deactivateUserRequest -
      Returns:
      A Java Future containing the result of the DeactivateUser operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • EntityNotExistsException The resource does not exist.
      • UnauthorizedOperationException The operation is not permitted.
      • UnauthorizedResourceAccessException The caller does not have access to perform the action on the resource.
      • FailedDependencyException The Directory Service cannot reach an on-premises instance. Or a dependency under the control of the organization is failing, such as a connected Active Directory.
      • ServiceUnavailableException One or more of the dependencies is unavailable.
      • 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.
      • WorkDocsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • deactivateUser

      default CompletableFuture<DeactivateUserResponse> deactivateUser(Consumer<DeactivateUserRequest.Builder> deactivateUserRequest)

      Deactivates the specified user, which revokes the user's access to Amazon WorkDocs.


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

      Parameters:
      deactivateUserRequest - A Consumer that will call methods on DeactivateUserRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeactivateUser operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • EntityNotExistsException The resource does not exist.
      • UnauthorizedOperationException The operation is not permitted.
      • UnauthorizedResourceAccessException The caller does not have access to perform the action on the resource.
      • FailedDependencyException The Directory Service cannot reach an on-premises instance. Or a dependency under the control of the organization is failing, such as a connected Active Directory.
      • ServiceUnavailableException One or more of the dependencies is unavailable.
      • 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.
      • WorkDocsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • deleteComment

      default CompletableFuture<DeleteCommentResponse> deleteComment(DeleteCommentRequest deleteCommentRequest)

      Deletes the specified comment from the document version.

      Parameters:
      deleteCommentRequest -
      Returns:
      A Java Future containing the result of the DeleteComment operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • EntityNotExistsException The resource does not exist.
      • ProhibitedStateException The specified document version is not in the INITIALIZED state.
      • UnauthorizedOperationException The operation is not permitted.
      • UnauthorizedResourceAccessException The caller does not have access to perform the action on the resource.
      • FailedDependencyException The Directory Service cannot reach an on-premises instance. Or a dependency under the control of the organization is failing, such as a connected Active Directory.
      • ServiceUnavailableException One or more of the dependencies is unavailable.
      • DocumentLockedForCommentsException This exception is thrown when the document is locked for comments and user tries to create or delete a comment on that document.
      • 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.
      • WorkDocsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • deleteComment

      default CompletableFuture<DeleteCommentResponse> deleteComment(Consumer<DeleteCommentRequest.Builder> deleteCommentRequest)

      Deletes the specified comment from the document version.


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

      Parameters:
      deleteCommentRequest - A Consumer that will call methods on DeleteCommentRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteComment operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • EntityNotExistsException The resource does not exist.
      • ProhibitedStateException The specified document version is not in the INITIALIZED state.
      • UnauthorizedOperationException The operation is not permitted.
      • UnauthorizedResourceAccessException The caller does not have access to perform the action on the resource.
      • FailedDependencyException The Directory Service cannot reach an on-premises instance. Or a dependency under the control of the organization is failing, such as a connected Active Directory.
      • ServiceUnavailableException One or more of the dependencies is unavailable.
      • DocumentLockedForCommentsException This exception is thrown when the document is locked for comments and user tries to create or delete a comment on that document.
      • 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.
      • WorkDocsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • deleteCustomMetadata

      default CompletableFuture<DeleteCustomMetadataResponse> deleteCustomMetadata(DeleteCustomMetadataRequest deleteCustomMetadataRequest)

      Deletes custom metadata from the specified resource.

      Parameters:
      deleteCustomMetadataRequest -
      Returns:
      A Java Future containing the result of the DeleteCustomMetadata operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • EntityNotExistsException The resource does not exist.
      • UnauthorizedOperationException The operation is not permitted.
      • UnauthorizedResourceAccessException The caller does not have access to perform the action on the resource.
      • ProhibitedStateException The specified document version is not in the INITIALIZED state.
      • FailedDependencyException The Directory Service cannot reach an on-premises instance. Or a dependency under the control of the organization is failing, such as a connected Active Directory.
      • ServiceUnavailableException One or more of the dependencies is unavailable.
      • 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.
      • WorkDocsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • deleteCustomMetadata

      default CompletableFuture<DeleteCustomMetadataResponse> deleteCustomMetadata(Consumer<DeleteCustomMetadataRequest.Builder> deleteCustomMetadataRequest)

      Deletes custom metadata from the specified resource.


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

      Parameters:
      deleteCustomMetadataRequest - A Consumer that will call methods on DeleteCustomMetadataRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteCustomMetadata operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • EntityNotExistsException The resource does not exist.
      • UnauthorizedOperationException The operation is not permitted.
      • UnauthorizedResourceAccessException The caller does not have access to perform the action on the resource.
      • ProhibitedStateException The specified document version is not in the INITIALIZED state.
      • FailedDependencyException The Directory Service cannot reach an on-premises instance. Or a dependency under the control of the organization is failing, such as a connected Active Directory.
      • ServiceUnavailableException One or more of the dependencies is unavailable.
      • 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.
      • WorkDocsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • deleteDocument

      default CompletableFuture<DeleteDocumentResponse> deleteDocument(DeleteDocumentRequest deleteDocumentRequest)

      Permanently deletes the specified document and its associated metadata.

      Parameters:
      deleteDocumentRequest -
      Returns:
      A Java Future containing the result of the DeleteDocument operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • EntityNotExistsException The resource does not exist.
      • LimitExceededException The maximum of 100,000 files and folders under the parent folder has been exceeded.
      • ProhibitedStateException The specified document version is not in the INITIALIZED state.
      • ConflictingOperationException Another operation is in progress on the resource that conflicts with the current operation.
      • ConcurrentModificationException The resource hierarchy is changing.
      • UnauthorizedOperationException The operation is not permitted.
      • UnauthorizedResourceAccessException The caller does not have access to perform the action on the resource.
      • FailedDependencyException The Directory Service cannot reach an on-premises instance. Or a dependency under the control of the organization is failing, such as a connected Active Directory.
      • ServiceUnavailableException One or more of the dependencies is unavailable.
      • 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.
      • WorkDocsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • deleteDocument

      default CompletableFuture<DeleteDocumentResponse> deleteDocument(Consumer<DeleteDocumentRequest.Builder> deleteDocumentRequest)

      Permanently deletes the specified document and its associated metadata.


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

      Parameters:
      deleteDocumentRequest - A Consumer that will call methods on DeleteDocumentRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteDocument operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • EntityNotExistsException The resource does not exist.
      • LimitExceededException The maximum of 100,000 files and folders under the parent folder has been exceeded.
      • ProhibitedStateException The specified document version is not in the INITIALIZED state.
      • ConflictingOperationException Another operation is in progress on the resource that conflicts with the current operation.
      • ConcurrentModificationException The resource hierarchy is changing.
      • UnauthorizedOperationException The operation is not permitted.
      • UnauthorizedResourceAccessException The caller does not have access to perform the action on the resource.
      • FailedDependencyException The Directory Service cannot reach an on-premises instance. Or a dependency under the control of the organization is failing, such as a connected Active Directory.
      • ServiceUnavailableException One or more of the dependencies is unavailable.
      • 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.
      • WorkDocsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • deleteDocumentVersion

      default CompletableFuture<DeleteDocumentVersionResponse> deleteDocumentVersion(DeleteDocumentVersionRequest deleteDocumentVersionRequest)

      Deletes a specific version of a document.

      Parameters:
      deleteDocumentVersionRequest -
      Returns:
      A Java Future containing the result of the DeleteDocumentVersion operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • EntityNotExistsException The resource does not exist.
      • ProhibitedStateException The specified document version is not in the INITIALIZED state.
      • ConflictingOperationException Another operation is in progress on the resource that conflicts with the current operation.
      • ConcurrentModificationException The resource hierarchy is changing.
      • UnauthorizedResourceAccessException The caller does not have access to perform the action on the resource.
      • FailedDependencyException The Directory Service cannot reach an on-premises instance. Or a dependency under the control of the organization is failing, such as a connected Active Directory.
      • InvalidOperationException The operation is invalid.
      • UnauthorizedOperationException The operation is not permitted.
      • 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.
      • WorkDocsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • deleteDocumentVersion

      default CompletableFuture<DeleteDocumentVersionResponse> deleteDocumentVersion(Consumer<DeleteDocumentVersionRequest.Builder> deleteDocumentVersionRequest)

      Deletes a specific version of a document.


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

      Parameters:
      deleteDocumentVersionRequest - A Consumer that will call methods on DeleteDocumentVersionRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteDocumentVersion operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • EntityNotExistsException The resource does not exist.
      • ProhibitedStateException The specified document version is not in the INITIALIZED state.
      • ConflictingOperationException Another operation is in progress on the resource that conflicts with the current operation.
      • ConcurrentModificationException The resource hierarchy is changing.
      • UnauthorizedResourceAccessException The caller does not have access to perform the action on the resource.
      • FailedDependencyException The Directory Service cannot reach an on-premises instance. Or a dependency under the control of the organization is failing, such as a connected Active Directory.
      • InvalidOperationException The operation is invalid.
      • UnauthorizedOperationException The operation is not permitted.
      • 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.
      • WorkDocsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • deleteFolder

      default CompletableFuture<DeleteFolderResponse> deleteFolder(DeleteFolderRequest deleteFolderRequest)

      Permanently deletes the specified folder and its contents.

      Parameters:
      deleteFolderRequest -
      Returns:
      A Java Future containing the result of the DeleteFolder operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • EntityNotExistsException The resource does not exist.
      • LimitExceededException The maximum of 100,000 files and folders under the parent folder has been exceeded.
      • ProhibitedStateException The specified document version is not in the INITIALIZED state.
      • ConflictingOperationException Another operation is in progress on the resource that conflicts with the current operation.
      • ConcurrentModificationException The resource hierarchy is changing.
      • UnauthorizedOperationException The operation is not permitted.
      • UnauthorizedResourceAccessException The caller does not have access to perform the action on the resource.
      • FailedDependencyException The Directory Service cannot reach an on-premises instance. Or a dependency under the control of the organization is failing, such as a connected Active Directory.
      • ServiceUnavailableException One or more of the dependencies is unavailable.
      • 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.
      • WorkDocsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • deleteFolder

      default CompletableFuture<DeleteFolderResponse> deleteFolder(Consumer<DeleteFolderRequest.Builder> deleteFolderRequest)

      Permanently deletes the specified folder and its contents.


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

      Parameters:
      deleteFolderRequest - A Consumer that will call methods on DeleteFolderRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteFolder operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • EntityNotExistsException The resource does not exist.
      • LimitExceededException The maximum of 100,000 files and folders under the parent folder has been exceeded.
      • ProhibitedStateException The specified document version is not in the INITIALIZED state.
      • ConflictingOperationException Another operation is in progress on the resource that conflicts with the current operation.
      • ConcurrentModificationException The resource hierarchy is changing.
      • UnauthorizedOperationException The operation is not permitted.
      • UnauthorizedResourceAccessException The caller does not have access to perform the action on the resource.
      • FailedDependencyException The Directory Service cannot reach an on-premises instance. Or a dependency under the control of the organization is failing, such as a connected Active Directory.
      • ServiceUnavailableException One or more of the dependencies is unavailable.
      • 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.
      • WorkDocsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • deleteFolderContents

      default CompletableFuture<DeleteFolderContentsResponse> deleteFolderContents(DeleteFolderContentsRequest deleteFolderContentsRequest)

      Deletes the contents of the specified folder.

      Parameters:
      deleteFolderContentsRequest -
      Returns:
      A Java Future containing the result of the DeleteFolderContents operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • EntityNotExistsException The resource does not exist.
      • ProhibitedStateException The specified document version is not in the INITIALIZED state.
      • ConflictingOperationException Another operation is in progress on the resource that conflicts with the current operation.
      • UnauthorizedOperationException The operation is not permitted.
      • UnauthorizedResourceAccessException The caller does not have access to perform the action on the resource.
      • FailedDependencyException The Directory Service cannot reach an on-premises instance. Or a dependency under the control of the organization is failing, such as a connected Active Directory.
      • ServiceUnavailableException One or more of the dependencies is unavailable.
      • 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.
      • WorkDocsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • deleteFolderContents

      default CompletableFuture<DeleteFolderContentsResponse> deleteFolderContents(Consumer<DeleteFolderContentsRequest.Builder> deleteFolderContentsRequest)

      Deletes the contents of the specified folder.


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

      Parameters:
      deleteFolderContentsRequest - A Consumer that will call methods on DeleteFolderContentsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteFolderContents operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • EntityNotExistsException The resource does not exist.
      • ProhibitedStateException The specified document version is not in the INITIALIZED state.
      • ConflictingOperationException Another operation is in progress on the resource that conflicts with the current operation.
      • UnauthorizedOperationException The operation is not permitted.
      • UnauthorizedResourceAccessException The caller does not have access to perform the action on the resource.
      • FailedDependencyException The Directory Service cannot reach an on-premises instance. Or a dependency under the control of the organization is failing, such as a connected Active Directory.
      • ServiceUnavailableException One or more of the dependencies is unavailable.
      • 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.
      • WorkDocsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • deleteLabels

      default CompletableFuture<DeleteLabelsResponse> deleteLabels(DeleteLabelsRequest deleteLabelsRequest)

      Deletes the specified list of labels from a resource.

      Parameters:
      deleteLabelsRequest -
      Returns:
      A Java Future containing the result of the DeleteLabels operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • EntityNotExistsException The resource does not exist.
      • UnauthorizedOperationException The operation is not permitted.
      • UnauthorizedResourceAccessException The caller does not have access to perform the action on the resource.
      • FailedDependencyException The Directory Service cannot reach an on-premises instance. Or a dependency under the control of the organization is failing, such as a connected Active Directory.
      • ServiceUnavailableException One or more of the dependencies is unavailable.
      • ProhibitedStateException The specified document version is not in the INITIALIZED state.
      • 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.
      • WorkDocsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • deleteLabels

      default CompletableFuture<DeleteLabelsResponse> deleteLabels(Consumer<DeleteLabelsRequest.Builder> deleteLabelsRequest)

      Deletes the specified list of labels from a resource.


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

      Parameters:
      deleteLabelsRequest - A Consumer that will call methods on DeleteLabelsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteLabels operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • EntityNotExistsException The resource does not exist.
      • UnauthorizedOperationException The operation is not permitted.
      • UnauthorizedResourceAccessException The caller does not have access to perform the action on the resource.
      • FailedDependencyException The Directory Service cannot reach an on-premises instance. Or a dependency under the control of the organization is failing, such as a connected Active Directory.
      • ServiceUnavailableException One or more of the dependencies is unavailable.
      • ProhibitedStateException The specified document version is not in the INITIALIZED state.
      • 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.
      • WorkDocsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • deleteNotificationSubscription

      default CompletableFuture<DeleteNotificationSubscriptionResponse> deleteNotificationSubscription(DeleteNotificationSubscriptionRequest deleteNotificationSubscriptionRequest)

      Deletes the specified subscription from the specified organization.

      Parameters:
      deleteNotificationSubscriptionRequest -
      Returns:
      A Java Future containing the result of the DeleteNotificationSubscription operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • UnauthorizedResourceAccessException The caller does not have access to perform the action on the resource.
      • EntityNotExistsException The resource does not exist.
      • ServiceUnavailableException One or more of the dependencies is unavailable.
      • ProhibitedStateException The specified document version is not in the INITIALIZED state.
      • 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.
      • WorkDocsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • deleteNotificationSubscription

      default CompletableFuture<DeleteNotificationSubscriptionResponse> deleteNotificationSubscription(Consumer<DeleteNotificationSubscriptionRequest.Builder> deleteNotificationSubscriptionRequest)

      Deletes the specified subscription from the specified organization.


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

      Parameters:
      deleteNotificationSubscriptionRequest - A Consumer that will call methods on DeleteNotificationSubscriptionRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteNotificationSubscription operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • UnauthorizedResourceAccessException The caller does not have access to perform the action on the resource.
      • EntityNotExistsException The resource does not exist.
      • ServiceUnavailableException One or more of the dependencies is unavailable.
      • ProhibitedStateException The specified document version is not in the INITIALIZED state.
      • 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.
      • WorkDocsException 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 the specified user from a Simple AD or Microsoft AD directory.

      Deleting a user immediately and permanently deletes all content in that user's folder structure. Site retention policies do NOT apply to this type of deletion.

      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.
      • EntityNotExistsException The resource does not exist.
      • UnauthorizedOperationException The operation is not permitted.
      • UnauthorizedResourceAccessException The caller does not have access to perform the action on the resource.
      • FailedDependencyException The Directory Service cannot reach an on-premises instance. Or a dependency under the control of the organization is failing, such as a connected Active Directory.
      • ServiceUnavailableException One or more of the dependencies is unavailable.
      • 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.
      • WorkDocsException 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 the specified user from a Simple AD or Microsoft AD directory.

      Deleting a user immediately and permanently deletes all content in that user's folder structure. Site retention policies do NOT apply to this type of deletion.


      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.
      • EntityNotExistsException The resource does not exist.
      • UnauthorizedOperationException The operation is not permitted.
      • UnauthorizedResourceAccessException The caller does not have access to perform the action on the resource.
      • FailedDependencyException The Directory Service cannot reach an on-premises instance. Or a dependency under the control of the organization is failing, such as a connected Active Directory.
      • ServiceUnavailableException One or more of the dependencies is unavailable.
      • 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.
      • WorkDocsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • describeActivities

      default CompletableFuture<DescribeActivitiesResponse> describeActivities(DescribeActivitiesRequest describeActivitiesRequest)

      Describes the user activities in a specified time period.

      Parameters:
      describeActivitiesRequest -
      Returns:
      A Java Future containing the result of the DescribeActivities operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • UnauthorizedOperationException The operation is not permitted.
      • UnauthorizedResourceAccessException The caller does not have access to perform the action on the resource.
      • InvalidArgumentException The pagination marker or limit fields are not valid.
      • FailedDependencyException The Directory Service cannot reach an on-premises instance. Or a dependency under the control of the organization is failing, such as a connected Active Directory.
      • ServiceUnavailableException One or more of the dependencies is unavailable.
      • 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.
      • WorkDocsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • describeActivities

      default CompletableFuture<DescribeActivitiesResponse> describeActivities(Consumer<DescribeActivitiesRequest.Builder> describeActivitiesRequest)

      Describes the user activities in a specified time period.


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

      Parameters:
      describeActivitiesRequest - A Consumer that will call methods on DescribeActivitiesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeActivities operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • UnauthorizedOperationException The operation is not permitted.
      • UnauthorizedResourceAccessException The caller does not have access to perform the action on the resource.
      • InvalidArgumentException The pagination marker or limit fields are not valid.
      • FailedDependencyException The Directory Service cannot reach an on-premises instance. Or a dependency under the control of the organization is failing, such as a connected Active Directory.
      • ServiceUnavailableException One or more of the dependencies is unavailable.
      • 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.
      • WorkDocsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • describeActivitiesPaginator

      default DescribeActivitiesPublisher describeActivitiesPaginator(DescribeActivitiesRequest describeActivitiesRequest)

      This is a variant of describeActivities(software.amazon.awssdk.services.workdocs.model.DescribeActivitiesRequest) 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.workdocs.paginators.DescribeActivitiesPublisher publisher = client.describeActivitiesPaginator(request);
       CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
       future.get();
       
       
      2) Using a custom subscriber
       
       software.amazon.awssdk.services.workdocs.paginators.DescribeActivitiesPublisher publisher = client.describeActivitiesPaginator(request);
       publisher.subscribe(new Subscriber<software.amazon.awssdk.services.workdocs.model.DescribeActivitiesResponse>() {
       
       public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
       
       
       public void onNext(software.amazon.awssdk.services.workdocs.model.DescribeActivitiesResponse response) { //... };
       });
       
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

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

      Note: If you prefer to have control on service calls, use the describeActivities(software.amazon.awssdk.services.workdocs.model.DescribeActivitiesRequest) operation.

      Parameters:
      describeActivitiesRequest -
      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.
      • UnauthorizedOperationException The operation is not permitted.
      • UnauthorizedResourceAccessException The caller does not have access to perform the action on the resource.
      • InvalidArgumentException The pagination marker or limit fields are not valid.
      • FailedDependencyException The Directory Service cannot reach an on-premises instance. Or a dependency under the control of the organization is failing, such as a connected Active Directory.
      • ServiceUnavailableException One or more of the dependencies is unavailable.
      • 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.
      • WorkDocsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • describeActivitiesPaginator

      default DescribeActivitiesPublisher describeActivitiesPaginator(Consumer<DescribeActivitiesRequest.Builder> describeActivitiesRequest)

      This is a variant of describeActivities(software.amazon.awssdk.services.workdocs.model.DescribeActivitiesRequest) 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.workdocs.paginators.DescribeActivitiesPublisher publisher = client.describeActivitiesPaginator(request);
       CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
       future.get();
       
       
      2) Using a custom subscriber
       
       software.amazon.awssdk.services.workdocs.paginators.DescribeActivitiesPublisher publisher = client.describeActivitiesPaginator(request);
       publisher.subscribe(new Subscriber<software.amazon.awssdk.services.workdocs.model.DescribeActivitiesResponse>() {
       
       public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
       
       
       public void onNext(software.amazon.awssdk.services.workdocs.model.DescribeActivitiesResponse response) { //... };
       });
       
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

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

      Note: If you prefer to have control on service calls, use the describeActivities(software.amazon.awssdk.services.workdocs.model.DescribeActivitiesRequest) operation.


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

      Parameters:
      describeActivitiesRequest - A Consumer that will call methods on DescribeActivitiesRequest.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.
      • UnauthorizedOperationException The operation is not permitted.
      • UnauthorizedResourceAccessException The caller does not have access to perform the action on the resource.
      • InvalidArgumentException The pagination marker or limit fields are not valid.
      • FailedDependencyException The Directory Service cannot reach an on-premises instance. Or a dependency under the control of the organization is failing, such as a connected Active Directory.
      • ServiceUnavailableException One or more of the dependencies is unavailable.
      • 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.
      • WorkDocsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • describeComments

      default CompletableFuture<DescribeCommentsResponse> describeComments(DescribeCommentsRequest describeCommentsRequest)

      List all the comments for the specified document version.

      Parameters:
      describeCommentsRequest -
      Returns:
      A Java Future containing the result of the DescribeComments operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • EntityNotExistsException The resource does not exist.
      • ProhibitedStateException The specified document version is not in the INITIALIZED state.
      • UnauthorizedOperationException The operation is not permitted.
      • UnauthorizedResourceAccessException The caller does not have access to perform the action on the resource.
      • FailedDependencyException The Directory Service cannot reach an on-premises instance. Or a dependency under the control of the organization is failing, such as a connected Active Directory.
      • ServiceUnavailableException One or more of the dependencies is unavailable.
      • 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.
      • WorkDocsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • describeComments

      default CompletableFuture<DescribeCommentsResponse> describeComments(Consumer<DescribeCommentsRequest.Builder> describeCommentsRequest)

      List all the comments for the specified document version.


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

      Parameters:
      describeCommentsRequest - A Consumer that will call methods on DescribeCommentsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeComments operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • EntityNotExistsException The resource does not exist.
      • ProhibitedStateException The specified document version is not in the INITIALIZED state.
      • UnauthorizedOperationException The operation is not permitted.
      • UnauthorizedResourceAccessException The caller does not have access to perform the action on the resource.
      • FailedDependencyException The Directory Service cannot reach an on-premises instance. Or a dependency under the control of the organization is failing, such as a connected Active Directory.
      • ServiceUnavailableException One or more of the dependencies is unavailable.
      • 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.
      • WorkDocsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • describeCommentsPaginator

      default DescribeCommentsPublisher describeCommentsPaginator(DescribeCommentsRequest describeCommentsRequest)

      This is a variant of describeComments(software.amazon.awssdk.services.workdocs.model.DescribeCommentsRequest) 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.workdocs.paginators.DescribeCommentsPublisher publisher = client.describeCommentsPaginator(request);
       CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
       future.get();
       
       
      2) Using a custom subscriber
       
       software.amazon.awssdk.services.workdocs.paginators.DescribeCommentsPublisher publisher = client.describeCommentsPaginator(request);
       publisher.subscribe(new Subscriber<software.amazon.awssdk.services.workdocs.model.DescribeCommentsResponse>() {
       
       public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
       
       
       public void onNext(software.amazon.awssdk.services.workdocs.model.DescribeCommentsResponse response) { //... };
       });
       
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

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

      Note: If you prefer to have control on service calls, use the describeComments(software.amazon.awssdk.services.workdocs.model.DescribeCommentsRequest) operation.

      Parameters:
      describeCommentsRequest -
      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.
      • EntityNotExistsException The resource does not exist.
      • ProhibitedStateException The specified document version is not in the INITIALIZED state.
      • UnauthorizedOperationException The operation is not permitted.
      • UnauthorizedResourceAccessException The caller does not have access to perform the action on the resource.
      • FailedDependencyException The Directory Service cannot reach an on-premises instance. Or a dependency under the control of the organization is failing, such as a connected Active Directory.
      • ServiceUnavailableException One or more of the dependencies is unavailable.
      • 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.
      • WorkDocsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • describeCommentsPaginator

      default DescribeCommentsPublisher describeCommentsPaginator(Consumer<DescribeCommentsRequest.Builder> describeCommentsRequest)

      This is a variant of describeComments(software.amazon.awssdk.services.workdocs.model.DescribeCommentsRequest) 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.workdocs.paginators.DescribeCommentsPublisher publisher = client.describeCommentsPaginator(request);
       CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
       future.get();
       
       
      2) Using a custom subscriber
       
       software.amazon.awssdk.services.workdocs.paginators.DescribeCommentsPublisher publisher = client.describeCommentsPaginator(request);
       publisher.subscribe(new Subscriber<software.amazon.awssdk.services.workdocs.model.DescribeCommentsResponse>() {
       
       public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
       
       
       public void onNext(software.amazon.awssdk.services.workdocs.model.DescribeCommentsResponse response) { //... };
       });
       
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

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

      Note: If you prefer to have control on service calls, use the describeComments(software.amazon.awssdk.services.workdocs.model.DescribeCommentsRequest) operation.


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

      Parameters:
      describeCommentsRequest - A Consumer that will call methods on DescribeCommentsRequest.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.
      • EntityNotExistsException The resource does not exist.
      • ProhibitedStateException The specified document version is not in the INITIALIZED state.
      • UnauthorizedOperationException The operation is not permitted.
      • UnauthorizedResourceAccessException The caller does not have access to perform the action on the resource.
      • FailedDependencyException The Directory Service cannot reach an on-premises instance. Or a dependency under the control of the organization is failing, such as a connected Active Directory.
      • ServiceUnavailableException One or more of the dependencies is unavailable.
      • 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.
      • WorkDocsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • describeDocumentVersions

      default CompletableFuture<DescribeDocumentVersionsResponse> describeDocumentVersions(DescribeDocumentVersionsRequest describeDocumentVersionsRequest)

      Retrieves the document versions for the specified document.

      By default, only active versions are returned.

      Parameters:
      describeDocumentVersionsRequest -
      Returns:
      A Java Future containing the result of the DescribeDocumentVersions operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • EntityNotExistsException The resource does not exist.
      • UnauthorizedOperationException The operation is not permitted.
      • UnauthorizedResourceAccessException The caller does not have access to perform the action on the resource.
      • InvalidArgumentException The pagination marker or limit fields are not valid.
      • FailedDependencyException The Directory Service cannot reach an on-premises instance. Or a dependency under the control of the organization is failing, such as a connected Active Directory.
      • ServiceUnavailableException One or more of the dependencies is unavailable.
      • ProhibitedStateException The specified document version is not in the INITIALIZED state.
      • InvalidPasswordException The password is invalid.
      • 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.
      • WorkDocsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • describeDocumentVersions

      default CompletableFuture<DescribeDocumentVersionsResponse> describeDocumentVersions(Consumer<DescribeDocumentVersionsRequest.Builder> describeDocumentVersionsRequest)

      Retrieves the document versions for the specified document.

      By default, only active versions are returned.


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

      Parameters:
      describeDocumentVersionsRequest - A Consumer that will call methods on DescribeDocumentVersionsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeDocumentVersions operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • EntityNotExistsException The resource does not exist.
      • UnauthorizedOperationException The operation is not permitted.
      • UnauthorizedResourceAccessException The caller does not have access to perform the action on the resource.
      • InvalidArgumentException The pagination marker or limit fields are not valid.
      • FailedDependencyException The Directory Service cannot reach an on-premises instance. Or a dependency under the control of the organization is failing, such as a connected Active Directory.
      • ServiceUnavailableException One or more of the dependencies is unavailable.
      • ProhibitedStateException The specified document version is not in the INITIALIZED state.
      • InvalidPasswordException The password is invalid.
      • 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.
      • WorkDocsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • describeDocumentVersionsPaginator

      default DescribeDocumentVersionsPublisher describeDocumentVersionsPaginator(DescribeDocumentVersionsRequest describeDocumentVersionsRequest)

      This is a variant of describeDocumentVersions(software.amazon.awssdk.services.workdocs.model.DescribeDocumentVersionsRequest) 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.workdocs.paginators.DescribeDocumentVersionsPublisher publisher = client.describeDocumentVersionsPaginator(request);
       CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
       future.get();
       
       
      2) Using a custom subscriber
       
       software.amazon.awssdk.services.workdocs.paginators.DescribeDocumentVersionsPublisher publisher = client.describeDocumentVersionsPaginator(request);
       publisher.subscribe(new Subscriber<software.amazon.awssdk.services.workdocs.model.DescribeDocumentVersionsResponse>() {
       
       public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
       
       
       public void onNext(software.amazon.awssdk.services.workdocs.model.DescribeDocumentVersionsResponse response) { //... };
       });
       
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

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

      Note: If you prefer to have control on service calls, use the describeDocumentVersions(software.amazon.awssdk.services.workdocs.model.DescribeDocumentVersionsRequest) operation.

      Parameters:
      describeDocumentVersionsRequest -
      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.
      • EntityNotExistsException The resource does not exist.
      • UnauthorizedOperationException The operation is not permitted.
      • UnauthorizedResourceAccessException The caller does not have access to perform the action on the resource.
      • InvalidArgumentException The pagination marker or limit fields are not valid.
      • FailedDependencyException The Directory Service cannot reach an on-premises instance. Or a dependency under the control of the organization is failing, such as a connected Active Directory.
      • ServiceUnavailableException One or more of the dependencies is unavailable.
      • ProhibitedStateException The specified document version is not in the INITIALIZED state.
      • InvalidPasswordException The password is invalid.
      • 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.
      • WorkDocsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • describeDocumentVersionsPaginator

      default DescribeDocumentVersionsPublisher describeDocumentVersionsPaginator(Consumer<DescribeDocumentVersionsRequest.Builder> describeDocumentVersionsRequest)

      This is a variant of describeDocumentVersions(software.amazon.awssdk.services.workdocs.model.DescribeDocumentVersionsRequest) 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.workdocs.paginators.DescribeDocumentVersionsPublisher publisher = client.describeDocumentVersionsPaginator(request);
       CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
       future.get();
       
       
      2) Using a custom subscriber
       
       software.amazon.awssdk.services.workdocs.paginators.DescribeDocumentVersionsPublisher publisher = client.describeDocumentVersionsPaginator(request);
       publisher.subscribe(new Subscriber<software.amazon.awssdk.services.workdocs.model.DescribeDocumentVersionsResponse>() {
       
       public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
       
       
       public void onNext(software.amazon.awssdk.services.workdocs.model.DescribeDocumentVersionsResponse response) { //... };
       });
       
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

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

      Note: If you prefer to have control on service calls, use the describeDocumentVersions(software.amazon.awssdk.services.workdocs.model.DescribeDocumentVersionsRequest) operation.


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

      Parameters:
      describeDocumentVersionsRequest - A Consumer that will call methods on DescribeDocumentVersionsRequest.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.
      • EntityNotExistsException The resource does not exist.
      • UnauthorizedOperationException The operation is not permitted.
      • UnauthorizedResourceAccessException The caller does not have access to perform the action on the resource.
      • InvalidArgumentException The pagination marker or limit fields are not valid.
      • FailedDependencyException The Directory Service cannot reach an on-premises instance. Or a dependency under the control of the organization is failing, such as a connected Active Directory.
      • ServiceUnavailableException One or more of the dependencies is unavailable.
      • ProhibitedStateException The specified document version is not in the INITIALIZED state.
      • InvalidPasswordException The password is invalid.
      • 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.
      • WorkDocsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • describeFolderContents

      default CompletableFuture<DescribeFolderContentsResponse> describeFolderContents(DescribeFolderContentsRequest describeFolderContentsRequest)

      Describes the contents of the specified folder, including its documents and subfolders.

      By default, Amazon WorkDocs returns the first 100 active document and folder metadata items. If there are more results, the response includes a marker that you can use to request the next set of results. You can also request initialized documents.

      Parameters:
      describeFolderContentsRequest -
      Returns:
      A Java Future containing the result of the DescribeFolderContents operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • EntityNotExistsException The resource does not exist.
      • UnauthorizedResourceAccessException The caller does not have access to perform the action on the resource.
      • InvalidArgumentException The pagination marker or limit fields are not valid.
      • FailedDependencyException The Directory Service cannot reach an on-premises instance. Or a dependency under the control of the organization is failing, such as a connected Active Directory.
      • ServiceUnavailableException One or more of the dependencies is unavailable.
      • ProhibitedStateException The specified document version is not in the INITIALIZED state.
      • 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.
      • WorkDocsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • describeFolderContents

      default CompletableFuture<DescribeFolderContentsResponse> describeFolderContents(Consumer<DescribeFolderContentsRequest.Builder> describeFolderContentsRequest)

      Describes the contents of the specified folder, including its documents and subfolders.

      By default, Amazon WorkDocs returns the first 100 active document and folder metadata items. If there are more results, the response includes a marker that you can use to request the next set of results. You can also request initialized documents.


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

      Parameters:
      describeFolderContentsRequest - A Consumer that will call methods on DescribeFolderContentsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeFolderContents operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • EntityNotExistsException The resource does not exist.
      • UnauthorizedResourceAccessException The caller does not have access to perform the action on the resource.
      • InvalidArgumentException The pagination marker or limit fields are not valid.
      • FailedDependencyException The Directory Service cannot reach an on-premises instance. Or a dependency under the control of the organization is failing, such as a connected Active Directory.
      • ServiceUnavailableException One or more of the dependencies is unavailable.
      • ProhibitedStateException The specified document version is not in the INITIALIZED state.
      • 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.
      • WorkDocsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • describeFolderContentsPaginator

      default DescribeFolderContentsPublisher describeFolderContentsPaginator(DescribeFolderContentsRequest describeFolderContentsRequest)

      This is a variant of describeFolderContents(software.amazon.awssdk.services.workdocs.model.DescribeFolderContentsRequest) 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.workdocs.paginators.DescribeFolderContentsPublisher publisher = client.describeFolderContentsPaginator(request);
       CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
       future.get();
       
       
      2) Using a custom subscriber
       
       software.amazon.awssdk.services.workdocs.paginators.DescribeFolderContentsPublisher publisher = client.describeFolderContentsPaginator(request);
       publisher.subscribe(new Subscriber<software.amazon.awssdk.services.workdocs.model.DescribeFolderContentsResponse>() {
       
       public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
       
       
       public void onNext(software.amazon.awssdk.services.workdocs.model.DescribeFolderContentsResponse response) { //... };
       });
       
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

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

      Note: If you prefer to have control on service calls, use the describeFolderContents(software.amazon.awssdk.services.workdocs.model.DescribeFolderContentsRequest) operation.

      Parameters:
      describeFolderContentsRequest -
      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.
      • EntityNotExistsException The resource does not exist.
      • UnauthorizedResourceAccessException The caller does not have access to perform the action on the resource.
      • InvalidArgumentException The pagination marker or limit fields are not valid.
      • FailedDependencyException The Directory Service cannot reach an on-premises instance. Or a dependency under the control of the organization is failing, such as a connected Active Directory.
      • ServiceUnavailableException One or more of the dependencies is unavailable.
      • ProhibitedStateException The specified document version is not in the INITIALIZED state.
      • 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.
      • WorkDocsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • describeFolderContentsPaginator

      default DescribeFolderContentsPublisher describeFolderContentsPaginator(Consumer<DescribeFolderContentsRequest.Builder> describeFolderContentsRequest)

      This is a variant of describeFolderContents(software.amazon.awssdk.services.workdocs.model.DescribeFolderContentsRequest) 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.workdocs.paginators.DescribeFolderContentsPublisher publisher = client.describeFolderContentsPaginator(request);
       CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
       future.get();
       
       
      2) Using a custom subscriber
       
       software.amazon.awssdk.services.workdocs.paginators.DescribeFolderContentsPublisher publisher = client.describeFolderContentsPaginator(request);
       publisher.subscribe(new Subscriber<software.amazon.awssdk.services.workdocs.model.DescribeFolderContentsResponse>() {
       
       public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
       
       
       public void onNext(software.amazon.awssdk.services.workdocs.model.DescribeFolderContentsResponse response) { //... };
       });
       
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

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

      Note: If you prefer to have control on service calls, use the describeFolderContents(software.amazon.awssdk.services.workdocs.model.DescribeFolderContentsRequest) operation.


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

      Parameters:
      describeFolderContentsRequest - A Consumer that will call methods on DescribeFolderContentsRequest.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.
      • EntityNotExistsException The resource does not exist.
      • UnauthorizedResourceAccessException The caller does not have access to perform the action on the resource.
      • InvalidArgumentException The pagination marker or limit fields are not valid.
      • FailedDependencyException The Directory Service cannot reach an on-premises instance. Or a dependency under the control of the organization is failing, such as a connected Active Directory.
      • ServiceUnavailableException One or more of the dependencies is unavailable.
      • ProhibitedStateException The specified document version is not in the INITIALIZED state.
      • 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.
      • WorkDocsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • describeGroups

      default CompletableFuture<DescribeGroupsResponse> describeGroups(DescribeGroupsRequest describeGroupsRequest)

      Describes the groups specified by the query. Groups are defined by the underlying Active Directory.

      Parameters:
      describeGroupsRequest -
      Returns:
      A Java Future containing the result of the DescribeGroups operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • UnauthorizedOperationException The operation is not permitted.
      • UnauthorizedResourceAccessException The caller does not have access to perform the action on the resource.
      • FailedDependencyException The Directory Service cannot reach an on-premises instance. Or a dependency under the control of the organization is failing, such as a connected Active Directory.
      • ServiceUnavailableException One or more of the dependencies is unavailable.
      • 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.
      • WorkDocsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • describeGroups

      default CompletableFuture<DescribeGroupsResponse> describeGroups(Consumer<DescribeGroupsRequest.Builder> describeGroupsRequest)

      Describes the groups specified by the query. Groups are defined by the underlying Active Directory.


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

      Parameters:
      describeGroupsRequest - A Consumer that will call methods on DescribeGroupsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeGroups operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • UnauthorizedOperationException The operation is not permitted.
      • UnauthorizedResourceAccessException The caller does not have access to perform the action on the resource.
      • FailedDependencyException The Directory Service cannot reach an on-premises instance. Or a dependency under the control of the organization is failing, such as a connected Active Directory.
      • ServiceUnavailableException One or more of the dependencies is unavailable.
      • 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.
      • WorkDocsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • describeGroupsPaginator

      default DescribeGroupsPublisher describeGroupsPaginator(DescribeGroupsRequest describeGroupsRequest)

      This is a variant of describeGroups(software.amazon.awssdk.services.workdocs.model.DescribeGroupsRequest) 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.workdocs.paginators.DescribeGroupsPublisher publisher = client.describeGroupsPaginator(request);
       CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
       future.get();
       
       
      2) Using a custom subscriber
       
       software.amazon.awssdk.services.workdocs.paginators.DescribeGroupsPublisher publisher = client.describeGroupsPaginator(request);
       publisher.subscribe(new Subscriber<software.amazon.awssdk.services.workdocs.model.DescribeGroupsResponse>() {
       
       public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
       
       
       public void onNext(software.amazon.awssdk.services.workdocs.model.DescribeGroupsResponse response) { //... };
       });
       
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

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

      Note: If you prefer to have control on service calls, use the describeGroups(software.amazon.awssdk.services.workdocs.model.DescribeGroupsRequest) operation.

      Parameters:
      describeGroupsRequest -
      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.
      • UnauthorizedOperationException The operation is not permitted.
      • UnauthorizedResourceAccessException The caller does not have access to perform the action on the resource.
      • FailedDependencyException The Directory Service cannot reach an on-premises instance. Or a dependency under the control of the organization is failing, such as a connected Active Directory.
      • ServiceUnavailableException One or more of the dependencies is unavailable.
      • 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.
      • WorkDocsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • describeGroupsPaginator

      default DescribeGroupsPublisher describeGroupsPaginator(Consumer<DescribeGroupsRequest.Builder> describeGroupsRequest)

      This is a variant of describeGroups(software.amazon.awssdk.services.workdocs.model.DescribeGroupsRequest) 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.workdocs.paginators.DescribeGroupsPublisher publisher = client.describeGroupsPaginator(request);
       CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
       future.get();
       
       
      2) Using a custom subscriber
       
       software.amazon.awssdk.services.workdocs.paginators.DescribeGroupsPublisher publisher = client.describeGroupsPaginator(request);
       publisher.subscribe(new Subscriber<software.amazon.awssdk.services.workdocs.model.DescribeGroupsResponse>() {
       
       public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
       
       
       public void onNext(software.amazon.awssdk.services.workdocs.model.DescribeGroupsResponse response) { //... };
       });
       
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

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

      Note: If you prefer to have control on service calls, use the describeGroups(software.amazon.awssdk.services.workdocs.model.DescribeGroupsRequest) operation.


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

      Parameters:
      describeGroupsRequest - A Consumer that will call methods on DescribeGroupsRequest.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.
      • UnauthorizedOperationException The operation is not permitted.
      • UnauthorizedResourceAccessException The caller does not have access to perform the action on the resource.
      • FailedDependencyException The Directory Service cannot reach an on-premises instance. Or a dependency under the control of the organization is failing, such as a connected Active Directory.
      • ServiceUnavailableException One or more of the dependencies is unavailable.
      • 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.
      • WorkDocsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • describeNotificationSubscriptions

      default CompletableFuture<DescribeNotificationSubscriptionsResponse> describeNotificationSubscriptions(DescribeNotificationSubscriptionsRequest describeNotificationSubscriptionsRequest)

      Lists the specified notification subscriptions.

      Parameters:
      describeNotificationSubscriptionsRequest -
      Returns:
      A Java Future containing the result of the DescribeNotificationSubscriptions operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • UnauthorizedResourceAccessException The caller does not have access to perform the action on the resource.
      • EntityNotExistsException The resource does not exist.
      • ServiceUnavailableException One or more of the dependencies is unavailable.
      • 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.
      • WorkDocsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • describeNotificationSubscriptions

      default CompletableFuture<DescribeNotificationSubscriptionsResponse> describeNotificationSubscriptions(Consumer<DescribeNotificationSubscriptionsRequest.Builder> describeNotificationSubscriptionsRequest)

      Lists the specified notification subscriptions.


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

      Parameters:
      describeNotificationSubscriptionsRequest - A Consumer that will call methods on DescribeNotificationSubscriptionsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeNotificationSubscriptions operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • UnauthorizedResourceAccessException The caller does not have access to perform the action on the resource.
      • EntityNotExistsException The resource does not exist.
      • ServiceUnavailableException One or more of the dependencies is unavailable.
      • 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.
      • WorkDocsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • describeNotificationSubscriptionsPaginator

      default DescribeNotificationSubscriptionsPublisher describeNotificationSubscriptionsPaginator(DescribeNotificationSubscriptionsRequest describeNotificationSubscriptionsRequest)

      This is a variant of describeNotificationSubscriptions(software.amazon.awssdk.services.workdocs.model.DescribeNotificationSubscriptionsRequest) 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.workdocs.paginators.DescribeNotificationSubscriptionsPublisher publisher = client.describeNotificationSubscriptionsPaginator(request);
       CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
       future.get();
       
       
      2) Using a custom subscriber
       
       software.amazon.awssdk.services.workdocs.paginators.DescribeNotificationSubscriptionsPublisher publisher = client.describeNotificationSubscriptionsPaginator(request);
       publisher.subscribe(new Subscriber<software.amazon.awssdk.services.workdocs.model.DescribeNotificationSubscriptionsResponse>() {
       
       public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
       
       
       public void onNext(software.amazon.awssdk.services.workdocs.model.DescribeNotificationSubscriptionsResponse response) { //... };
       });
       
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

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

      Note: If you prefer to have control on service calls, use the describeNotificationSubscriptions(software.amazon.awssdk.services.workdocs.model.DescribeNotificationSubscriptionsRequest) operation.

      Parameters:
      describeNotificationSubscriptionsRequest -
      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.
      • UnauthorizedResourceAccessException The caller does not have access to perform the action on the resource.
      • EntityNotExistsException The resource does not exist.
      • ServiceUnavailableException One or more of the dependencies is unavailable.
      • 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.
      • WorkDocsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • describeNotificationSubscriptionsPaginator

      default DescribeNotificationSubscriptionsPublisher describeNotificationSubscriptionsPaginator(Consumer<DescribeNotificationSubscriptionsRequest.Builder> describeNotificationSubscriptionsRequest)

      This is a variant of describeNotificationSubscriptions(software.amazon.awssdk.services.workdocs.model.DescribeNotificationSubscriptionsRequest) 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.workdocs.paginators.DescribeNotificationSubscriptionsPublisher publisher = client.describeNotificationSubscriptionsPaginator(request);
       CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
       future.get();
       
       
      2) Using a custom subscriber
       
       software.amazon.awssdk.services.workdocs.paginators.DescribeNotificationSubscriptionsPublisher publisher = client.describeNotificationSubscriptionsPaginator(request);
       publisher.subscribe(new Subscriber<software.amazon.awssdk.services.workdocs.model.DescribeNotificationSubscriptionsResponse>() {
       
       public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
       
       
       public void onNext(software.amazon.awssdk.services.workdocs.model.DescribeNotificationSubscriptionsResponse response) { //... };
       });
       
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

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

      Note: If you prefer to have control on service calls, use the describeNotificationSubscriptions(software.amazon.awssdk.services.workdocs.model.DescribeNotificationSubscriptionsRequest) operation.


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

      Parameters:
      describeNotificationSubscriptionsRequest - A Consumer that will call methods on DescribeNotificationSubscriptionsRequest.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.
      • UnauthorizedResourceAccessException The caller does not have access to perform the action on the resource.
      • EntityNotExistsException The resource does not exist.
      • ServiceUnavailableException One or more of the dependencies is unavailable.
      • 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.
      • WorkDocsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • describeResourcePermissions

      default CompletableFuture<DescribeResourcePermissionsResponse> describeResourcePermissions(DescribeResourcePermissionsRequest describeResourcePermissionsRequest)

      Describes the permissions of a specified resource.

      Parameters:
      describeResourcePermissionsRequest -
      Returns:
      A Java Future containing the result of the DescribeResourcePermissions operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • InvalidArgumentException The pagination marker or limit fields are not valid.
      • UnauthorizedOperationException The operation is not permitted.
      • UnauthorizedResourceAccessException The caller does not have access to perform the action on the resource.
      • FailedDependencyException The Directory Service cannot reach an on-premises instance. Or a dependency under the control of the organization is failing, such as a connected Active Directory.
      • ServiceUnavailableException One or more of the dependencies is unavailable.
      • 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.
      • WorkDocsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • describeResourcePermissions

      default CompletableFuture<DescribeResourcePermissionsResponse> describeResourcePermissions(Consumer<DescribeResourcePermissionsRequest.Builder> describeResourcePermissionsRequest)

      Describes the permissions of a specified resource.


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

      Parameters:
      describeResourcePermissionsRequest - A Consumer that will call methods on DescribeResourcePermissionsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeResourcePermissions operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • InvalidArgumentException The pagination marker or limit fields are not valid.
      • UnauthorizedOperationException The operation is not permitted.
      • UnauthorizedResourceAccessException The caller does not have access to perform the action on the resource.
      • FailedDependencyException The Directory Service cannot reach an on-premises instance. Or a dependency under the control of the organization is failing, such as a connected Active Directory.
      • ServiceUnavailableException One or more of the dependencies is unavailable.
      • 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.
      • WorkDocsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • describeResourcePermissionsPaginator

      default DescribeResourcePermissionsPublisher describeResourcePermissionsPaginator(DescribeResourcePermissionsRequest describeResourcePermissionsRequest)

      This is a variant of describeResourcePermissions(software.amazon.awssdk.services.workdocs.model.DescribeResourcePermissionsRequest) 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.workdocs.paginators.DescribeResourcePermissionsPublisher publisher = client.describeResourcePermissionsPaginator(request);
       CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
       future.get();
       
       
      2) Using a custom subscriber
       
       software.amazon.awssdk.services.workdocs.paginators.DescribeResourcePermissionsPublisher publisher = client.describeResourcePermissionsPaginator(request);
       publisher.subscribe(new Subscriber<software.amazon.awssdk.services.workdocs.model.DescribeResourcePermissionsResponse>() {
       
       public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
       
       
       public void onNext(software.amazon.awssdk.services.workdocs.model.DescribeResourcePermissionsResponse response) { //... };
       });
       
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

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

      Note: If you prefer to have control on service calls, use the describeResourcePermissions(software.amazon.awssdk.services.workdocs.model.DescribeResourcePermissionsRequest) operation.

      Parameters:
      describeResourcePermissionsRequest -
      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.
      • InvalidArgumentException The pagination marker or limit fields are not valid.
      • UnauthorizedOperationException The operation is not permitted.
      • UnauthorizedResourceAccessException The caller does not have access to perform the action on the resource.
      • FailedDependencyException The Directory Service cannot reach an on-premises instance. Or a dependency under the control of the organization is failing, such as a connected Active Directory.
      • ServiceUnavailableException One or more of the dependencies is unavailable.
      • 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.
      • WorkDocsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • describeResourcePermissionsPaginator

      default DescribeResourcePermissionsPublisher describeResourcePermissionsPaginator(Consumer<DescribeResourcePermissionsRequest.Builder> describeResourcePermissionsRequest)

      This is a variant of describeResourcePermissions(software.amazon.awssdk.services.workdocs.model.DescribeResourcePermissionsRequest) 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.workdocs.paginators.DescribeResourcePermissionsPublisher publisher = client.describeResourcePermissionsPaginator(request);
       CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
       future.get();
       
       
      2) Using a custom subscriber
       
       software.amazon.awssdk.services.workdocs.paginators.DescribeResourcePermissionsPublisher publisher = client.describeResourcePermissionsPaginator(request);
       publisher.subscribe(new Subscriber<software.amazon.awssdk.services.workdocs.model.DescribeResourcePermissionsResponse>() {
       
       public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
       
       
       public void onNext(software.amazon.awssdk.services.workdocs.model.DescribeResourcePermissionsResponse response) { //... };
       });
       
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

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

      Note: If you prefer to have control on service calls, use the describeResourcePermissions(software.amazon.awssdk.services.workdocs.model.DescribeResourcePermissionsRequest) operation.


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

      Parameters:
      describeResourcePermissionsRequest - A Consumer that will call methods on DescribeResourcePermissionsRequest.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.
      • InvalidArgumentException The pagination marker or limit fields are not valid.
      • UnauthorizedOperationException The operation is not permitted.
      • UnauthorizedResourceAccessException The caller does not have access to perform the action on the resource.
      • FailedDependencyException The Directory Service cannot reach an on-premises instance. Or a dependency under the control of the organization is failing, such as a connected Active Directory.
      • ServiceUnavailableException One or more of the dependencies is unavailable.
      • 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.
      • WorkDocsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • describeRootFolders

      default CompletableFuture<DescribeRootFoldersResponse> describeRootFolders(DescribeRootFoldersRequest describeRootFoldersRequest)

      Describes the current user's special folders; the RootFolder and the RecycleBin. RootFolder is the root of user's files and folders and RecycleBin is the root of recycled items. This is not a valid action for SigV4 (administrative API) clients.

      This action requires an authentication token. To get an authentication token, register an application with Amazon WorkDocs. For more information, see Authentication and Access Control for User Applications in the Amazon WorkDocs Developer Guide.

      Parameters:
      describeRootFoldersRequest -
      Returns:
      A Java Future containing the result of the DescribeRootFolders operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • UnauthorizedOperationException The operation is not permitted.
      • UnauthorizedResourceAccessException The caller does not have access to perform the action on the resource.
      • InvalidArgumentException The pagination marker or limit fields are not valid.
      • FailedDependencyException The Directory Service cannot reach an on-premises instance. Or a dependency under the control of the organization is failing, such as a connected Active Directory.
      • ServiceUnavailableException One or more of the dependencies is unavailable.
      • 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.
      • WorkDocsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • describeRootFolders

      default CompletableFuture<DescribeRootFoldersResponse> describeRootFolders(Consumer<DescribeRootFoldersRequest.Builder> describeRootFoldersRequest)

      Describes the current user's special folders; the RootFolder and the RecycleBin. RootFolder is the root of user's files and folders and RecycleBin is the root of recycled items. This is not a valid action for SigV4 (administrative API) clients.

      This action requires an authentication token. To get an authentication token, register an application with Amazon WorkDocs. For more information, see Authentication and Access Control for User Applications in the Amazon WorkDocs Developer Guide.


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

      Parameters:
      describeRootFoldersRequest - A Consumer that will call methods on DescribeRootFoldersRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeRootFolders operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • UnauthorizedOperationException The operation is not permitted.
      • UnauthorizedResourceAccessException The caller does not have access to perform the action on the resource.
      • InvalidArgumentException The pagination marker or limit fields are not valid.
      • FailedDependencyException The Directory Service cannot reach an on-premises instance. Or a dependency under the control of the organization is failing, such as a connected Active Directory.
      • ServiceUnavailableException One or more of the dependencies is unavailable.
      • 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.
      • WorkDocsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • describeRootFoldersPaginator

      default DescribeRootFoldersPublisher describeRootFoldersPaginator(DescribeRootFoldersRequest describeRootFoldersRequest)

      This is a variant of describeRootFolders(software.amazon.awssdk.services.workdocs.model.DescribeRootFoldersRequest) 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.workdocs.paginators.DescribeRootFoldersPublisher publisher = client.describeRootFoldersPaginator(request);
       CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
       future.get();
       
       
      2) Using a custom subscriber
       
       software.amazon.awssdk.services.workdocs.paginators.DescribeRootFoldersPublisher publisher = client.describeRootFoldersPaginator(request);
       publisher.subscribe(new Subscriber<software.amazon.awssdk.services.workdocs.model.DescribeRootFoldersResponse>() {
       
       public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
       
       
       public void onNext(software.amazon.awssdk.services.workdocs.model.DescribeRootFoldersResponse response) { //... };
       });
       
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

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

      Note: If you prefer to have control on service calls, use the describeRootFolders(software.amazon.awssdk.services.workdocs.model.DescribeRootFoldersRequest) operation.

      Parameters:
      describeRootFoldersRequest -
      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.
      • UnauthorizedOperationException The operation is not permitted.
      • UnauthorizedResourceAccessException The caller does not have access to perform the action on the resource.
      • InvalidArgumentException The pagination marker or limit fields are not valid.
      • FailedDependencyException The Directory Service cannot reach an on-premises instance. Or a dependency under the control of the organization is failing, such as a connected Active Directory.
      • ServiceUnavailableException One or more of the dependencies is unavailable.
      • 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.
      • WorkDocsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • describeRootFoldersPaginator

      default DescribeRootFoldersPublisher describeRootFoldersPaginator(Consumer<DescribeRootFoldersRequest.Builder> describeRootFoldersRequest)

      This is a variant of describeRootFolders(software.amazon.awssdk.services.workdocs.model.DescribeRootFoldersRequest) 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.workdocs.paginators.DescribeRootFoldersPublisher publisher = client.describeRootFoldersPaginator(request);
       CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
       future.get();
       
       
      2) Using a custom subscriber
       
       software.amazon.awssdk.services.workdocs.paginators.DescribeRootFoldersPublisher publisher = client.describeRootFoldersPaginator(request);
       publisher.subscribe(new Subscriber<software.amazon.awssdk.services.workdocs.model.DescribeRootFoldersResponse>() {
       
       public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
       
       
       public void onNext(software.amazon.awssdk.services.workdocs.model.DescribeRootFoldersResponse response) { //... };
       });
       
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

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

      Note: If you prefer to have control on service calls, use the describeRootFolders(software.amazon.awssdk.services.workdocs.model.DescribeRootFoldersRequest) operation.


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

      Parameters:
      describeRootFoldersRequest - A Consumer that will call methods on DescribeRootFoldersRequest.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.
      • UnauthorizedOperationException The operation is not permitted.
      • UnauthorizedResourceAccessException The caller does not have access to perform the action on the resource.
      • InvalidArgumentException The pagination marker or limit fields are not valid.
      • FailedDependencyException The Directory Service cannot reach an on-premises instance. Or a dependency under the control of the organization is failing, such as a connected Active Directory.
      • ServiceUnavailableException One or more of the dependencies is unavailable.
      • 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.
      • WorkDocsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • describeUsers

      default CompletableFuture<DescribeUsersResponse> describeUsers(DescribeUsersRequest describeUsersRequest)

      Describes the specified users. You can describe all users or filter the results (for example, by status or organization).

      By default, Amazon WorkDocs returns the first 24 active or pending users. If there are more results, the response includes a marker that you can use to request the next set of results.

      Parameters:
      describeUsersRequest -
      Returns:
      A Java Future containing the result of the DescribeUsers operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • EntityNotExistsException The resource does not exist.
      • UnauthorizedOperationException The operation is not permitted.
      • UnauthorizedResourceAccessException The caller does not have access to perform the action on the resource.
      • FailedDependencyException The Directory Service cannot reach an on-premises instance. Or a dependency under the control of the organization is failing, such as a connected Active Directory.
      • ServiceUnavailableException One or more of the dependencies is unavailable.
      • InvalidArgumentException The pagination marker or limit fields are not valid.
      • RequestedEntityTooLargeException The response is too large to return. The request must include a filter to reduce the size of the response.
      • 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.
      • WorkDocsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • describeUsers

      default CompletableFuture<DescribeUsersResponse> describeUsers(Consumer<DescribeUsersRequest.Builder> describeUsersRequest)

      Describes the specified users. You can describe all users or filter the results (for example, by status or organization).

      By default, Amazon WorkDocs returns the first 24 active or pending users. If there are more results, the response includes a marker that you can use to request the next set of results.


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

      Parameters:
      describeUsersRequest - A Consumer that will call methods on DescribeUsersRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeUsers operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • EntityNotExistsException The resource does not exist.
      • UnauthorizedOperationException The operation is not permitted.
      • UnauthorizedResourceAccessException The caller does not have access to perform the action on the resource.
      • FailedDependencyException The Directory Service cannot reach an on-premises instance. Or a dependency under the control of the organization is failing, such as a connected Active Directory.
      • ServiceUnavailableException One or more of the dependencies is unavailable.
      • InvalidArgumentException The pagination marker or limit fields are not valid.
      • RequestedEntityTooLargeException The response is too large to return. The request must include a filter to reduce the size of the response.
      • 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.
      • WorkDocsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • describeUsersPaginator

      default DescribeUsersPublisher describeUsersPaginator(DescribeUsersRequest describeUsersRequest)

      This is a variant of describeUsers(software.amazon.awssdk.services.workdocs.model.DescribeUsersRequest) 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.workdocs.paginators.DescribeUsersPublisher publisher = client.describeUsersPaginator(request);
       CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
       future.get();
       
       
      2) Using a custom subscriber
       
       software.amazon.awssdk.services.workdocs.paginators.DescribeUsersPublisher publisher = client.describeUsersPaginator(request);
       publisher.subscribe(new Subscriber<software.amazon.awssdk.services.workdocs.model.DescribeUsersResponse>() {
       
       public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
       
       
       public void onNext(software.amazon.awssdk.services.workdocs.model.DescribeUsersResponse response) { //... };
       });
       
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

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

      Note: If you prefer to have control on service calls, use the describeUsers(software.amazon.awssdk.services.workdocs.model.DescribeUsersRequest) operation.

      Parameters:
      describeUsersRequest -
      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.
      • EntityNotExistsException The resource does not exist.
      • UnauthorizedOperationException The operation is not permitted.
      • UnauthorizedResourceAccessException The caller does not have access to perform the action on the resource.
      • FailedDependencyException The Directory Service cannot reach an on-premises instance. Or a dependency under the control of the organization is failing, such as a connected Active Directory.
      • ServiceUnavailableException One or more of the dependencies is unavailable.
      • InvalidArgumentException The pagination marker or limit fields are not valid.
      • RequestedEntityTooLargeException The response is too large to return. The request must include a filter to reduce the size of the response.
      • 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.
      • WorkDocsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • describeUsersPaginator

      default DescribeUsersPublisher describeUsersPaginator(Consumer<DescribeUsersRequest.Builder> describeUsersRequest)

      This is a variant of describeUsers(software.amazon.awssdk.services.workdocs.model.DescribeUsersRequest) 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.workdocs.paginators.DescribeUsersPublisher publisher = client.describeUsersPaginator(request);
       CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
       future.get();
       
       
      2) Using a custom subscriber
       
       software.amazon.awssdk.services.workdocs.paginators.DescribeUsersPublisher publisher = client.describeUsersPaginator(request);
       publisher.subscribe(new Subscriber<software.amazon.awssdk.services.workdocs.model.DescribeUsersResponse>() {
       
       public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
       
       
       public void onNext(software.amazon.awssdk.services.workdocs.model.DescribeUsersResponse response) { //... };
       });
       
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

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

      Note: If you prefer to have control on service calls, use the describeUsers(software.amazon.awssdk.services.workdocs.model.DescribeUsersRequest) operation.


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

      Parameters:
      describeUsersRequest - A Consumer that will call methods on DescribeUsersRequest.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.
      • EntityNotExistsException The resource does not exist.
      • UnauthorizedOperationException The operation is not permitted.
      • UnauthorizedResourceAccessException The caller does not have access to perform the action on the resource.
      • FailedDependencyException The Directory Service cannot reach an on-premises instance. Or a dependency under the control of the organization is failing, such as a connected Active Directory.
      • ServiceUnavailableException One or more of the dependencies is unavailable.
      • InvalidArgumentException The pagination marker or limit fields are not valid.
      • RequestedEntityTooLargeException The response is too large to return. The request must include a filter to reduce the size of the response.
      • 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.
      • WorkDocsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • getCurrentUser

      default CompletableFuture<GetCurrentUserResponse> getCurrentUser(GetCurrentUserRequest getCurrentUserRequest)

      Retrieves details of the current user for whom the authentication token was generated. This is not a valid action for SigV4 (administrative API) clients.

      This action requires an authentication token. To get an authentication token, register an application with Amazon WorkDocs. For more information, see Authentication and Access Control for User Applications in the Amazon WorkDocs Developer Guide.

      Parameters:
      getCurrentUserRequest -
      Returns:
      A Java Future containing the result of the GetCurrentUser operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • EntityNotExistsException The resource does not exist.
      • UnauthorizedOperationException The operation is not permitted.
      • UnauthorizedResourceAccessException The caller does not have access to perform the action on the resource.
      • FailedDependencyException The Directory Service cannot reach an on-premises instance. Or a dependency under the control of the organization is failing, such as a connected Active Directory.
      • ServiceUnavailableException One or more of the dependencies is unavailable.
      • 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.
      • WorkDocsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • getCurrentUser

      default CompletableFuture<GetCurrentUserResponse> getCurrentUser(Consumer<GetCurrentUserRequest.Builder> getCurrentUserRequest)

      Retrieves details of the current user for whom the authentication token was generated. This is not a valid action for SigV4 (administrative API) clients.

      This action requires an authentication token. To get an authentication token, register an application with Amazon WorkDocs. For more information, see Authentication and Access Control for User Applications in the Amazon WorkDocs Developer Guide.


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

      Parameters:
      getCurrentUserRequest - A Consumer that will call methods on GetCurrentUserRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetCurrentUser operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • EntityNotExistsException The resource does not exist.
      • UnauthorizedOperationException The operation is not permitted.
      • UnauthorizedResourceAccessException The caller does not have access to perform the action on the resource.
      • FailedDependencyException The Directory Service cannot reach an on-premises instance. Or a dependency under the control of the organization is failing, such as a connected Active Directory.
      • ServiceUnavailableException One or more of the dependencies is unavailable.
      • 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.
      • WorkDocsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • getDocument

      default CompletableFuture<GetDocumentResponse> getDocument(GetDocumentRequest getDocumentRequest)

      Retrieves details of a document.

      Parameters:
      getDocumentRequest -
      Returns:
      A Java Future containing the result of the GetDocument operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • EntityNotExistsException The resource does not exist.
      • UnauthorizedOperationException The operation is not permitted.
      • UnauthorizedResourceAccessException The caller does not have access to perform the action on the resource.
      • InvalidArgumentException The pagination marker or limit fields are not valid.
      • FailedDependencyException The Directory Service cannot reach an on-premises instance. Or a dependency under the control of the organization is failing, such as a connected Active Directory.
      • ServiceUnavailableException One or more of the dependencies is unavailable.
      • InvalidPasswordException The password is invalid.
      • 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.
      • WorkDocsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • getDocument

      default CompletableFuture<GetDocumentResponse> getDocument(Consumer<GetDocumentRequest.Builder> getDocumentRequest)

      Retrieves details of a document.


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

      Parameters:
      getDocumentRequest - A Consumer that will call methods on GetDocumentRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetDocument operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • EntityNotExistsException The resource does not exist.
      • UnauthorizedOperationException The operation is not permitted.
      • UnauthorizedResourceAccessException The caller does not have access to perform the action on the resource.
      • InvalidArgumentException The pagination marker or limit fields are not valid.
      • FailedDependencyException The Directory Service cannot reach an on-premises instance. Or a dependency under the control of the organization is failing, such as a connected Active Directory.
      • ServiceUnavailableException One or more of the dependencies is unavailable.
      • InvalidPasswordException The password is invalid.
      • 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.
      • WorkDocsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • getDocumentPath

      default CompletableFuture<GetDocumentPathResponse> getDocumentPath(GetDocumentPathRequest getDocumentPathRequest)

      Retrieves the path information (the hierarchy from the root folder) for the requested document.

      By default, Amazon WorkDocs returns a maximum of 100 levels upwards from the requested document and only includes the IDs of the parent folders in the path. You can limit the maximum number of levels. You can also request the names of the parent folders.

      Parameters:
      getDocumentPathRequest -
      Returns:
      A Java Future containing the result of the GetDocumentPath operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • EntityNotExistsException The resource does not exist.
      • UnauthorizedOperationException The operation is not permitted.
      • UnauthorizedResourceAccessException The caller does not have access to perform the action on the resource.
      • FailedDependencyException The Directory Service cannot reach an on-premises instance. Or a dependency under the control of the organization is failing, such as a connected Active Directory.
      • ServiceUnavailableException One or more of the dependencies is unavailable.
      • 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.
      • WorkDocsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • getDocumentPath

      default CompletableFuture<GetDocumentPathResponse> getDocumentPath(Consumer<GetDocumentPathRequest.Builder> getDocumentPathRequest)

      Retrieves the path information (the hierarchy from the root folder) for the requested document.

      By default, Amazon WorkDocs returns a maximum of 100 levels upwards from the requested document and only includes the IDs of the parent folders in the path. You can limit the maximum number of levels. You can also request the names of the parent folders.


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

      Parameters:
      getDocumentPathRequest - A Consumer that will call methods on GetDocumentPathRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetDocumentPath operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • EntityNotExistsException The resource does not exist.
      • UnauthorizedOperationException The operation is not permitted.
      • UnauthorizedResourceAccessException The caller does not have access to perform the action on the resource.
      • FailedDependencyException The Directory Service cannot reach an on-premises instance. Or a dependency under the control of the organization is failing, such as a connected Active Directory.
      • ServiceUnavailableException One or more of the dependencies is unavailable.
      • 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.
      • WorkDocsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • getDocumentVersion

      default CompletableFuture<GetDocumentVersionResponse> getDocumentVersion(GetDocumentVersionRequest getDocumentVersionRequest)

      Retrieves version metadata for the specified document.

      Parameters:
      getDocumentVersionRequest -
      Returns:
      A Java Future containing the result of the GetDocumentVersion operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • EntityNotExistsException The resource does not exist.
      • UnauthorizedOperationException The operation is not permitted.
      • UnauthorizedResourceAccessException The caller does not have access to perform the action on the resource.
      • FailedDependencyException The Directory Service cannot reach an on-premises instance. Or a dependency under the control of the organization is failing, such as a connected Active Directory.
      • ServiceUnavailableException One or more of the dependencies is unavailable.
      • ProhibitedStateException The specified document version is not in the INITIALIZED state.
      • InvalidPasswordException The password is invalid.
      • 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.
      • WorkDocsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • getDocumentVersion

      default CompletableFuture<GetDocumentVersionResponse> getDocumentVersion(Consumer<GetDocumentVersionRequest.Builder> getDocumentVersionRequest)

      Retrieves version metadata for the specified document.


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

      Parameters:
      getDocumentVersionRequest - A Consumer that will call methods on GetDocumentVersionRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetDocumentVersion operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • EntityNotExistsException The resource does not exist.
      • UnauthorizedOperationException The operation is not permitted.
      • UnauthorizedResourceAccessException The caller does not have access to perform the action on the resource.
      • FailedDependencyException The Directory Service cannot reach an on-premises instance. Or a dependency under the control of the organization is failing, such as a connected Active Directory.
      • ServiceUnavailableException One or more of the dependencies is unavailable.
      • ProhibitedStateException The specified document version is not in the INITIALIZED state.
      • InvalidPasswordException The password is invalid.
      • 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.
      • WorkDocsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • getFolder

      default CompletableFuture<GetFolderResponse> getFolder(GetFolderRequest getFolderRequest)

      Retrieves the metadata of the specified folder.

      Parameters:
      getFolderRequest -
      Returns:
      A Java Future containing the result of the GetFolder operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • EntityNotExistsException The resource does not exist.
      • UnauthorizedOperationException The operation is not permitted.
      • UnauthorizedResourceAccessException The caller does not have access to perform the action on the resource.
      • InvalidArgumentException The pagination marker or limit fields are not valid.
      • FailedDependencyException The Directory Service cannot reach an on-premises instance. Or a dependency under the control of the organization is failing, such as a connected Active Directory.
      • ServiceUnavailableException One or more of the dependencies is unavailable.
      • ProhibitedStateException The specified document version is not in the INITIALIZED state.
      • 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.
      • WorkDocsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • getFolder

      default CompletableFuture<GetFolderResponse> getFolder(Consumer<GetFolderRequest.Builder> getFolderRequest)

      Retrieves the metadata of the specified folder.


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

      Parameters:
      getFolderRequest - A Consumer that will call methods on GetFolderRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetFolder operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • EntityNotExistsException The resource does not exist.
      • UnauthorizedOperationException The operation is not permitted.
      • UnauthorizedResourceAccessException The caller does not have access to perform the action on the resource.
      • InvalidArgumentException The pagination marker or limit fields are not valid.
      • FailedDependencyException The Directory Service cannot reach an on-premises instance. Or a dependency under the control of the organization is failing, such as a connected Active Directory.
      • ServiceUnavailableException One or more of the dependencies is unavailable.
      • ProhibitedStateException The specified document version is not in the INITIALIZED state.
      • 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.
      • WorkDocsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • getFolderPath

      default CompletableFuture<GetFolderPathResponse> getFolderPath(GetFolderPathRequest getFolderPathRequest)

      Retrieves the path information (the hierarchy from the root folder) for the specified folder.

      By default, Amazon WorkDocs returns a maximum of 100 levels upwards from the requested folder and only includes the IDs of the parent folders in the path. You can limit the maximum number of levels. You can also request the parent folder names.

      Parameters:
      getFolderPathRequest -
      Returns:
      A Java Future containing the result of the GetFolderPath operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • EntityNotExistsException The resource does not exist.
      • UnauthorizedOperationException The operation is not permitted.
      • UnauthorizedResourceAccessException The caller does not have access to perform the action on the resource.
      • FailedDependencyException The Directory Service cannot reach an on-premises instance. Or a dependency under the control of the organization is failing, such as a connected Active Directory.
      • ServiceUnavailableException One or more of the dependencies is unavailable.
      • 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.
      • WorkDocsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • getFolderPath

      default CompletableFuture<GetFolderPathResponse> getFolderPath(Consumer<GetFolderPathRequest.Builder> getFolderPathRequest)

      Retrieves the path information (the hierarchy from the root folder) for the specified folder.

      By default, Amazon WorkDocs returns a maximum of 100 levels upwards from the requested folder and only includes the IDs of the parent folders in the path. You can limit the maximum number of levels. You can also request the parent folder names.


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

      Parameters:
      getFolderPathRequest - A Consumer that will call methods on GetFolderPathRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetFolderPath operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • EntityNotExistsException The resource does not exist.
      • UnauthorizedOperationException The operation is not permitted.
      • UnauthorizedResourceAccessException The caller does not have access to perform the action on the resource.
      • FailedDependencyException The Directory Service cannot reach an on-premises instance. Or a dependency under the control of the organization is failing, such as a connected Active Directory.
      • ServiceUnavailableException One or more of the dependencies is unavailable.
      • 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.
      • WorkDocsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • getResources

      default CompletableFuture<GetResourcesResponse> getResources(GetResourcesRequest getResourcesRequest)

      Retrieves a collection of resources, including folders and documents. The only CollectionType supported is SHARED_WITH_ME.

      Parameters:
      getResourcesRequest -
      Returns:
      A Java Future containing the result of the GetResources operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • UnauthorizedResourceAccessException The caller does not have access to perform the action on the resource.
      • UnauthorizedOperationException The operation is not permitted.
      • InvalidArgumentException The pagination marker or limit fields are not valid.
      • FailedDependencyException The Directory Service cannot reach an on-premises instance. Or a dependency under the control of the organization is failing, such as a connected Active Directory.
      • ServiceUnavailableException One or more of the dependencies is unavailable.
      • 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.
      • WorkDocsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • getResources

      default CompletableFuture<GetResourcesResponse> getResources(Consumer<GetResourcesRequest.Builder> getResourcesRequest)

      Retrieves a collection of resources, including folders and documents. The only CollectionType supported is SHARED_WITH_ME.


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

      Parameters:
      getResourcesRequest - A Consumer that will call methods on GetResourcesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetResources operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • UnauthorizedResourceAccessException The caller does not have access to perform the action on the resource.
      • UnauthorizedOperationException The operation is not permitted.
      • InvalidArgumentException The pagination marker or limit fields are not valid.
      • FailedDependencyException The Directory Service cannot reach an on-premises instance. Or a dependency under the control of the organization is failing, such as a connected Active Directory.
      • ServiceUnavailableException One or more of the dependencies is unavailable.
      • 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.
      • WorkDocsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • initiateDocumentVersionUpload

      default CompletableFuture<InitiateDocumentVersionUploadResponse> initiateDocumentVersionUpload(InitiateDocumentVersionUploadRequest initiateDocumentVersionUploadRequest)

      Creates a new document object and version object.

      The client specifies the parent folder ID and name of the document to upload. The ID is optionally specified when creating a new version of an existing document. This is the first step to upload a document. Next, upload the document to the URL returned from the call, and then call UpdateDocumentVersion.

      To cancel the document upload, call AbortDocumentVersionUpload.

      Parameters:
      initiateDocumentVersionUploadRequest -
      Returns:
      A Java Future containing the result of the InitiateDocumentVersionUpload operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • EntityNotExistsException The resource does not exist.
      • EntityAlreadyExistsException The resource already exists.
      • StorageLimitExceededException The storage limit has been exceeded.
      • StorageLimitWillExceedException The storage limit will be exceeded.
      • LimitExceededException The maximum of 100,000 files and folders under the parent folder has been exceeded.
      • ProhibitedStateException The specified document version is not in the INITIALIZED state.
      • UnauthorizedOperationException The operation is not permitted.
      • UnauthorizedResourceAccessException The caller does not have access to perform the action on the resource.
      • FailedDependencyException The Directory Service cannot reach an on-premises instance. Or a dependency under the control of the organization is failing, such as a connected Active Directory.
      • ServiceUnavailableException One or more of the dependencies is unavailable.
      • DraftUploadOutOfSyncException This exception is thrown when a valid checkout ID is not presented on document version upload calls for a document that has been checked out from Web client.
      • ResourceAlreadyCheckedOutException The resource is already checked out.
      • InvalidPasswordException The password is invalid.
      • InvalidArgumentException The pagination marker or limit fields are not valid.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • WorkDocsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • initiateDocumentVersionUpload

      default CompletableFuture<InitiateDocumentVersionUploadResponse> initiateDocumentVersionUpload(Consumer<InitiateDocumentVersionUploadRequest.Builder> initiateDocumentVersionUploadRequest)

      Creates a new document object and version object.

      The client specifies the parent folder ID and name of the document to upload. The ID is optionally specified when creating a new version of an existing document. This is the first step to upload a document. Next, upload the document to the URL returned from the call, and then call UpdateDocumentVersion.

      To cancel the document upload, call AbortDocumentVersionUpload.


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

      Parameters:
      initiateDocumentVersionUploadRequest - A Consumer that will call methods on InitiateDocumentVersionUploadRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the InitiateDocumentVersionUpload operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • EntityNotExistsException The resource does not exist.
      • EntityAlreadyExistsException The resource already exists.
      • StorageLimitExceededException The storage limit has been exceeded.
      • StorageLimitWillExceedException The storage limit will be exceeded.
      • LimitExceededException The maximum of 100,000 files and folders under the parent folder has been exceeded.
      • ProhibitedStateException The specified document version is not in the INITIALIZED state.
      • UnauthorizedOperationException The operation is not permitted.
      • UnauthorizedResourceAccessException The caller does not have access to perform the action on the resource.
      • FailedDependencyException The Directory Service cannot reach an on-premises instance. Or a dependency under the control of the organization is failing, such as a connected Active Directory.
      • ServiceUnavailableException One or more of the dependencies is unavailable.
      • DraftUploadOutOfSyncException This exception is thrown when a valid checkout ID is not presented on document version upload calls for a document that has been checked out from Web client.
      • ResourceAlreadyCheckedOutException The resource is already checked out.
      • InvalidPasswordException The password is invalid.
      • InvalidArgumentException The pagination marker or limit fields are not valid.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • WorkDocsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • removeAllResourcePermissions

      default CompletableFuture<RemoveAllResourcePermissionsResponse> removeAllResourcePermissions(RemoveAllResourcePermissionsRequest removeAllResourcePermissionsRequest)

      Removes all the permissions from the specified resource.

      Parameters:
      removeAllResourcePermissionsRequest -
      Returns:
      A Java Future containing the result of the RemoveAllResourcePermissions operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • UnauthorizedOperationException The operation is not permitted.
      • UnauthorizedResourceAccessException The caller does not have access to perform the action on the resource.
      • FailedDependencyException The Directory Service cannot reach an on-premises instance. Or a dependency under the control of the organization is failing, such as a connected Active Directory.
      • ServiceUnavailableException One or more of the dependencies is unavailable.
      • 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.
      • WorkDocsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • removeAllResourcePermissions

      default CompletableFuture<RemoveAllResourcePermissionsResponse> removeAllResourcePermissions(Consumer<RemoveAllResourcePermissionsRequest.Builder> removeAllResourcePermissionsRequest)

      Removes all the permissions from the specified resource.


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

      Parameters:
      removeAllResourcePermissionsRequest - A Consumer that will call methods on RemoveAllResourcePermissionsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the RemoveAllResourcePermissions operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • UnauthorizedOperationException The operation is not permitted.
      • UnauthorizedResourceAccessException The caller does not have access to perform the action on the resource.
      • FailedDependencyException The Directory Service cannot reach an on-premises instance. Or a dependency under the control of the organization is failing, such as a connected Active Directory.
      • ServiceUnavailableException One or more of the dependencies is unavailable.
      • 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.
      • WorkDocsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • removeResourcePermission

      default CompletableFuture<RemoveResourcePermissionResponse> removeResourcePermission(RemoveResourcePermissionRequest removeResourcePermissionRequest)

      Removes the permission for the specified principal from the specified resource.

      Parameters:
      removeResourcePermissionRequest -
      Returns:
      A Java Future containing the result of the RemoveResourcePermission operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • UnauthorizedOperationException The operation is not permitted.
      • UnauthorizedResourceAccessException The caller does not have access to perform the action on the resource.
      • FailedDependencyException The Directory Service cannot reach an on-premises instance. Or a dependency under the control of the organization is failing, such as a connected Active Directory.
      • ServiceUnavailableException One or more of the dependencies is unavailable.
      • 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.
      • WorkDocsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • removeResourcePermission

      default CompletableFuture<RemoveResourcePermissionResponse> removeResourcePermission(Consumer<RemoveResourcePermissionRequest.Builder> removeResourcePermissionRequest)

      Removes the permission for the specified principal from the specified resource.


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

      Parameters:
      removeResourcePermissionRequest - A Consumer that will call methods on RemoveResourcePermissionRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the RemoveResourcePermission operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • UnauthorizedOperationException The operation is not permitted.
      • UnauthorizedResourceAccessException The caller does not have access to perform the action on the resource.
      • FailedDependencyException The Directory Service cannot reach an on-premises instance. Or a dependency under the control of the organization is failing, such as a connected Active Directory.
      • ServiceUnavailableException One or more of the dependencies is unavailable.
      • 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.
      • WorkDocsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • restoreDocumentVersions

      default CompletableFuture<RestoreDocumentVersionsResponse> restoreDocumentVersions(RestoreDocumentVersionsRequest restoreDocumentVersionsRequest)

      Recovers a deleted version of an Amazon WorkDocs document.

      Parameters:
      restoreDocumentVersionsRequest -
      Returns:
      A Java Future containing the result of the RestoreDocumentVersions operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • EntityNotExistsException The resource does not exist.
      • ProhibitedStateException The specified document version is not in the INITIALIZED state.
      • ConflictingOperationException Another operation is in progress on the resource that conflicts with the current operation.
      • ConcurrentModificationException The resource hierarchy is changing.
      • UnauthorizedResourceAccessException The caller does not have access to perform the action on the resource.
      • FailedDependencyException The Directory Service cannot reach an on-premises instance. Or a dependency under the control of the organization is failing, such as a connected Active Directory.
      • InvalidOperationException The operation is invalid.
      • UnauthorizedOperationException The operation is not permitted.
      • 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.
      • WorkDocsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • restoreDocumentVersions

      default CompletableFuture<RestoreDocumentVersionsResponse> restoreDocumentVersions(Consumer<RestoreDocumentVersionsRequest.Builder> restoreDocumentVersionsRequest)

      Recovers a deleted version of an Amazon WorkDocs document.


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

      Parameters:
      restoreDocumentVersionsRequest - A Consumer that will call methods on RestoreDocumentVersionsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the RestoreDocumentVersions operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • EntityNotExistsException The resource does not exist.
      • ProhibitedStateException The specified document version is not in the INITIALIZED state.
      • ConflictingOperationException Another operation is in progress on the resource that conflicts with the current operation.
      • ConcurrentModificationException The resource hierarchy is changing.
      • UnauthorizedResourceAccessException The caller does not have access to perform the action on the resource.
      • FailedDependencyException The Directory Service cannot reach an on-premises instance. Or a dependency under the control of the organization is failing, such as a connected Active Directory.
      • InvalidOperationException The operation is invalid.
      • UnauthorizedOperationException The operation is not permitted.
      • 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.
      • WorkDocsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • searchResources

      default CompletableFuture<SearchResourcesResponse> searchResources(SearchResourcesRequest searchResourcesRequest)

      Searches metadata and the content of folders, documents, document versions, and comments.

      Parameters:
      searchResourcesRequest -
      Returns:
      A Java Future containing the result of the SearchResources operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • InvalidArgumentException The pagination marker or limit fields are not valid.
      • UnauthorizedResourceAccessException The caller does not have access to perform the action on the resource.
      • UnauthorizedOperationException The operation is not permitted.
      • ServiceUnavailableException One or more of the dependencies is unavailable.
      • 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.
      • WorkDocsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • searchResources

      default CompletableFuture<SearchResourcesResponse> searchResources(Consumer<SearchResourcesRequest.Builder> searchResourcesRequest)

      Searches metadata and the content of folders, documents, document versions, and comments.


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

      Parameters:
      searchResourcesRequest - A Consumer that will call methods on SearchResourcesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the SearchResources operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • InvalidArgumentException The pagination marker or limit fields are not valid.
      • UnauthorizedResourceAccessException The caller does not have access to perform the action on the resource.
      • UnauthorizedOperationException The operation is not permitted.
      • ServiceUnavailableException One or more of the dependencies is unavailable.
      • 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.
      • WorkDocsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • searchResourcesPaginator

      default SearchResourcesPublisher searchResourcesPaginator(SearchResourcesRequest searchResourcesRequest)

      This is a variant of searchResources(software.amazon.awssdk.services.workdocs.model.SearchResourcesRequest) 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.workdocs.paginators.SearchResourcesPublisher publisher = client.searchResourcesPaginator(request);
       CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
       future.get();
       
       
      2) Using a custom subscriber
       
       software.amazon.awssdk.services.workdocs.paginators.SearchResourcesPublisher publisher = client.searchResourcesPaginator(request);
       publisher.subscribe(new Subscriber<software.amazon.awssdk.services.workdocs.model.SearchResourcesResponse>() {
       
       public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
       
       
       public void onNext(software.amazon.awssdk.services.workdocs.model.SearchResourcesResponse response) { //... };
       });
       
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

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

      Note: If you prefer to have control on service calls, use the searchResources(software.amazon.awssdk.services.workdocs.model.SearchResourcesRequest) operation.

      Parameters:
      searchResourcesRequest -
      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.
      • InvalidArgumentException The pagination marker or limit fields are not valid.
      • UnauthorizedResourceAccessException The caller does not have access to perform the action on the resource.
      • UnauthorizedOperationException The operation is not permitted.
      • ServiceUnavailableException One or more of the dependencies is unavailable.
      • 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.
      • WorkDocsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • searchResourcesPaginator

      default SearchResourcesPublisher searchResourcesPaginator(Consumer<SearchResourcesRequest.Builder> searchResourcesRequest)

      This is a variant of searchResources(software.amazon.awssdk.services.workdocs.model.SearchResourcesRequest) 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.workdocs.paginators.SearchResourcesPublisher publisher = client.searchResourcesPaginator(request);
       CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
       future.get();
       
       
      2) Using a custom subscriber
       
       software.amazon.awssdk.services.workdocs.paginators.SearchResourcesPublisher publisher = client.searchResourcesPaginator(request);
       publisher.subscribe(new Subscriber<software.amazon.awssdk.services.workdocs.model.SearchResourcesResponse>() {
       
       public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
       
       
       public void onNext(software.amazon.awssdk.services.workdocs.model.SearchResourcesResponse response) { //... };
       });
       
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

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

      Note: If you prefer to have control on service calls, use the searchResources(software.amazon.awssdk.services.workdocs.model.SearchResourcesRequest) operation.


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

      Parameters:
      searchResourcesRequest - A Consumer that will call methods on SearchResourcesRequest.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.
      • InvalidArgumentException The pagination marker or limit fields are not valid.
      • UnauthorizedResourceAccessException The caller does not have access to perform the action on the resource.
      • UnauthorizedOperationException The operation is not permitted.
      • ServiceUnavailableException One or more of the dependencies is unavailable.
      • 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.
      • WorkDocsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • updateDocument

      default CompletableFuture<UpdateDocumentResponse> updateDocument(UpdateDocumentRequest updateDocumentRequest)

      Updates the specified attributes of a document. The user must have access to both the document and its parent folder, if applicable.

      Parameters:
      updateDocumentRequest -
      Returns:
      A Java Future containing the result of the UpdateDocument operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • EntityNotExistsException The resource does not exist.
      • EntityAlreadyExistsException The resource already exists.
      • LimitExceededException The maximum of 100,000 files and folders under the parent folder has been exceeded.
      • ProhibitedStateException The specified document version is not in the INITIALIZED state.
      • ConflictingOperationException Another operation is in progress on the resource that conflicts with the current operation.
      • ConcurrentModificationException The resource hierarchy is changing.
      • UnauthorizedOperationException The operation is not permitted.
      • UnauthorizedResourceAccessException The caller does not have access to perform the action on the resource.
      • FailedDependencyException The Directory Service cannot reach an on-premises instance. Or a dependency under the control of the organization is failing, such as a connected Active Directory.
      • ServiceUnavailableException One or more of the dependencies is unavailable.
      • 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.
      • WorkDocsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • updateDocument

      default CompletableFuture<UpdateDocumentResponse> updateDocument(Consumer<UpdateDocumentRequest.Builder> updateDocumentRequest)

      Updates the specified attributes of a document. The user must have access to both the document and its parent folder, if applicable.


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

      Parameters:
      updateDocumentRequest - A Consumer that will call methods on UpdateDocumentRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateDocument operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • EntityNotExistsException The resource does not exist.
      • EntityAlreadyExistsException The resource already exists.
      • LimitExceededException The maximum of 100,000 files and folders under the parent folder has been exceeded.
      • ProhibitedStateException The specified document version is not in the INITIALIZED state.
      • ConflictingOperationException Another operation is in progress on the resource that conflicts with the current operation.
      • ConcurrentModificationException The resource hierarchy is changing.
      • UnauthorizedOperationException The operation is not permitted.
      • UnauthorizedResourceAccessException The caller does not have access to perform the action on the resource.
      • FailedDependencyException The Directory Service cannot reach an on-premises instance. Or a dependency under the control of the organization is failing, such as a connected Active Directory.
      • ServiceUnavailableException One or more of the dependencies is unavailable.
      • 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.
      • WorkDocsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • updateDocumentVersion

      default CompletableFuture<UpdateDocumentVersionResponse> updateDocumentVersion(UpdateDocumentVersionRequest updateDocumentVersionRequest)

      Changes the status of the document version to ACTIVE.

      Amazon WorkDocs also sets its document container to ACTIVE. This is the last step in a document upload, after the client uploads the document to an S3-presigned URL returned by InitiateDocumentVersionUpload.

      Parameters:
      updateDocumentVersionRequest -
      Returns:
      A Java Future containing the result of the UpdateDocumentVersion operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • EntityNotExistsException The resource does not exist.
      • ProhibitedStateException The specified document version is not in the INITIALIZED state.
      • ConcurrentModificationException The resource hierarchy is changing.
      • InvalidOperationException The operation is invalid.
      • UnauthorizedOperationException The operation is not permitted.
      • UnauthorizedResourceAccessException The caller does not have access to perform the action on the resource.
      • FailedDependencyException The Directory Service cannot reach an on-premises instance. Or a dependency under the control of the organization is failing, such as a connected Active Directory.
      • ServiceUnavailableException One or more of the dependencies is unavailable.
      • 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.
      • WorkDocsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • updateDocumentVersion

      default CompletableFuture<UpdateDocumentVersionResponse> updateDocumentVersion(Consumer<UpdateDocumentVersionRequest.Builder> updateDocumentVersionRequest)

      Changes the status of the document version to ACTIVE.

      Amazon WorkDocs also sets its document container to ACTIVE. This is the last step in a document upload, after the client uploads the document to an S3-presigned URL returned by InitiateDocumentVersionUpload.


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

      Parameters:
      updateDocumentVersionRequest - A Consumer that will call methods on UpdateDocumentVersionRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateDocumentVersion operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • EntityNotExistsException The resource does not exist.
      • ProhibitedStateException The specified document version is not in the INITIALIZED state.
      • ConcurrentModificationException The resource hierarchy is changing.
      • InvalidOperationException The operation is invalid.
      • UnauthorizedOperationException The operation is not permitted.
      • UnauthorizedResourceAccessException The caller does not have access to perform the action on the resource.
      • FailedDependencyException The Directory Service cannot reach an on-premises instance. Or a dependency under the control of the organization is failing, such as a connected Active Directory.
      • ServiceUnavailableException One or more of the dependencies is unavailable.
      • 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.
      • WorkDocsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • updateFolder

      default CompletableFuture<UpdateFolderResponse> updateFolder(UpdateFolderRequest updateFolderRequest)

      Updates the specified attributes of the specified folder. The user must have access to both the folder and its parent folder, if applicable.

      Parameters:
      updateFolderRequest -
      Returns:
      A Java Future containing the result of the UpdateFolder operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • EntityNotExistsException The resource does not exist.
      • EntityAlreadyExistsException The resource already exists.
      • ProhibitedStateException The specified document version is not in the INITIALIZED state.
      • ConflictingOperationException Another operation is in progress on the resource that conflicts with the current operation.
      • ConcurrentModificationException The resource hierarchy is changing.
      • LimitExceededException The maximum of 100,000 files and folders under the parent folder has been exceeded.
      • UnauthorizedOperationException The operation is not permitted.
      • UnauthorizedResourceAccessException The caller does not have access to perform the action on the resource.
      • FailedDependencyException The Directory Service cannot reach an on-premises instance. Or a dependency under the control of the organization is failing, such as a connected Active Directory.
      • ServiceUnavailableException One or more of the dependencies is unavailable.
      • 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.
      • WorkDocsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • updateFolder

      default CompletableFuture<UpdateFolderResponse> updateFolder(Consumer<UpdateFolderRequest.Builder> updateFolderRequest)

      Updates the specified attributes of the specified folder. The user must have access to both the folder and its parent folder, if applicable.


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

      Parameters:
      updateFolderRequest - A Consumer that will call methods on UpdateFolderRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateFolder operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • EntityNotExistsException The resource does not exist.
      • EntityAlreadyExistsException The resource already exists.
      • ProhibitedStateException The specified document version is not in the INITIALIZED state.
      • ConflictingOperationException Another operation is in progress on the resource that conflicts with the current operation.
      • ConcurrentModificationException The resource hierarchy is changing.
      • LimitExceededException The maximum of 100,000 files and folders under the parent folder has been exceeded.
      • UnauthorizedOperationException The operation is not permitted.
      • UnauthorizedResourceAccessException The caller does not have access to perform the action on the resource.
      • FailedDependencyException The Directory Service cannot reach an on-premises instance. Or a dependency under the control of the organization is failing, such as a connected Active Directory.
      • ServiceUnavailableException One or more of the dependencies is unavailable.
      • 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.
      • WorkDocsException 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 the specified attributes of the specified user, and grants or revokes administrative privileges to the Amazon WorkDocs site.

      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.
      • EntityNotExistsException The resource does not exist.
      • UnauthorizedOperationException The operation is not permitted.
      • UnauthorizedResourceAccessException The caller does not have access to perform the action on the resource.
      • IllegalUserStateException The user is undergoing transfer of ownership.
      • ProhibitedStateException The specified document version is not in the INITIALIZED state.
      • FailedDependencyException The Directory Service cannot reach an on-premises instance. Or a dependency under the control of the organization is failing, such as a connected Active Directory.
      • ServiceUnavailableException One or more of the dependencies is unavailable.
      • DeactivatingLastSystemUserException The last user in the organization is being deactivated.
      • InvalidArgumentException The pagination marker or limit fields are not valid.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • WorkDocsException 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 the specified attributes of the specified user, and grants or revokes administrative privileges to the Amazon WorkDocs site.


      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.
      • EntityNotExistsException The resource does not exist.
      • UnauthorizedOperationException The operation is not permitted.
      • UnauthorizedResourceAccessException The caller does not have access to perform the action on the resource.
      • IllegalUserStateException The user is undergoing transfer of ownership.
      • ProhibitedStateException The specified document version is not in the INITIALIZED state.
      • FailedDependencyException The Directory Service cannot reach an on-premises instance. Or a dependency under the control of the organization is failing, such as a connected Active Directory.
      • ServiceUnavailableException One or more of the dependencies is unavailable.
      • DeactivatingLastSystemUserException The last user in the organization is being deactivated.
      • InvalidArgumentException The pagination marker or limit fields are not valid.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • WorkDocsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • serviceClientConfiguration

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

      static WorkDocsAsyncClientBuilder builder()
      Create a builder that can be used to configure and create a WorkDocsAsyncClient.