Package software.amazon.awssdk.services.workdocs

Interface WorkDocsAsyncClient

All Superinterfaces:

AutoCloseable

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

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

The 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-premise or off-premise 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 anti-virus or data loss prevention. The APIs, in conjunction with Amazon CloudTrail, allow these applications to detect when changes occur in Amazon WorkDocs, so the application can take the necessary actions and replace the target file. The application can also choose to email the user if the target file violates the policy.

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

All Amazon WorkDocs APIs are Amazon authenticated, certificate-signed APIs. They not only require the use of the AWS 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.

Method Summary

Modifier and Type	Method	Description
default CompletableFuture<AbortDocumentVersionUploadResponse>	abortDocumentVersionUpload(AbortDocumentVersionUploadRequest abortDocumentVersionUploadRequest)	Aborts the upload of the specified document version that was previously initiated by InitiateDocumentVersionUpload.
default CompletableFuture<ActivateUserResponse>	activateUser(ActivateUserRequest activateUserRequest)	Activates the specified user.
default CompletableFuture<AddResourcePermissionsResponse>	addResourcePermissions(AddResourcePermissionsRequest addResourcePermissionsRequest)	Creates a set of permissions for the specified folder or document.
static WorkDocsAsyncClientBuilder	builder()	Create a builder that can be used to configure and create a WorkDocsAsyncClient.
static WorkDocsAsyncClient	create()	Create a WorkDocsAsyncClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.
default CompletableFuture<CreateCommentResponse>	createComment(CreateCommentRequest createCommentRequest)	Adds a new comment to the specified document version.
default CompletableFuture<CreateCustomMetadataResponse>	createCustomMetadata(CreateCustomMetadataRequest createCustomMetadataRequest)	Adds one or more custom properties to the specified resource (a folder, document, or version).
default CompletableFuture<CreateFolderResponse>	createFolder(CreateFolderRequest createFolderRequest)	Creates a folder with the specified name and parent folder.
default CompletableFuture<CreateLabelsResponse>	createLabels(CreateLabelsRequest createLabelsRequest)	Adds the specified list of labels to the given resource (a document or folder)
default CompletableFuture<CreateNotificationSubscriptionResponse>	createNotificationSubscription(CreateNotificationSubscriptionRequest createNotificationSubscriptionRequest)	Configure WorkDocs to use Amazon SNS notifications.
default CompletableFuture<CreateUserResponse>	createUser(CreateUserRequest createUserRequest)	Creates a user in a Simple AD or Microsoft AD directory.
default CompletableFuture<DeactivateUserResponse>	deactivateUser(DeactivateUserRequest deactivateUserRequest)	Deactivates the specified user, which revokes the user's access to Amazon WorkDocs.
default CompletableFuture<DeleteCommentResponse>	deleteComment(DeleteCommentRequest deleteCommentRequest)	Deletes the specified comment from the document version.
default CompletableFuture<DeleteCustomMetadataResponse>	deleteCustomMetadata(DeleteCustomMetadataRequest deleteCustomMetadataRequest)	Deletes custom metadata from the specified resource.
default CompletableFuture<DeleteDocumentResponse>	deleteDocument(DeleteDocumentRequest deleteDocumentRequest)	Permanently deletes the specified document and its associated metadata.
default CompletableFuture<DeleteFolderResponse>	deleteFolder(DeleteFolderRequest deleteFolderRequest)	Permanently deletes the specified folder and its contents.
default CompletableFuture<DeleteFolderContentsResponse>	deleteFolderContents(DeleteFolderContentsRequest deleteFolderContentsRequest)	Deletes the contents of the specified folder.
default CompletableFuture<DeleteLabelsResponse>	deleteLabels(DeleteLabelsRequest deleteLabelsRequest)	Deletes the specified list of labels from a resource.
default CompletableFuture<DeleteNotificationSubscriptionResponse>	deleteNotificationSubscription(DeleteNotificationSubscriptionRequest deleteNotificationSubscriptionRequest)	Deletes the specified subscription from the specified organization.
default CompletableFuture<DeleteUserResponse>	deleteUser(DeleteUserRequest deleteUserRequest)	Deletes the specified user from a Simple AD or Microsoft AD directory.
default CompletableFuture<DescribeActivitiesResponse>	describeActivities(DescribeActivitiesRequest describeActivitiesRequest)	Describes the user activities in a specified time period.
default CompletableFuture<DescribeCommentsResponse>	describeComments(DescribeCommentsRequest describeCommentsRequest)	List all the comments for the specified document version.
default CompletableFuture<DescribeDocumentVersionsResponse>	describeDocumentVersions(DescribeDocumentVersionsRequest describeDocumentVersionsRequest)	Retrieves the document versions for the specified document.
default CompletableFuture<DescribeFolderContentsResponse>	describeFolderContents(DescribeFolderContentsRequest describeFolderContentsRequest)	Describes the contents of the specified folder, including its documents and subfolders.
default CompletableFuture<DescribeNotificationSubscriptionsResponse>	describeNotificationSubscriptions(DescribeNotificationSubscriptionsRequest describeNotificationSubscriptionsRequest)	Lists the specified notification subscriptions.
default CompletableFuture<DescribeResourcePermissionsResponse>	describeResourcePermissions(DescribeResourcePermissionsRequest describeResourcePermissionsRequest)	Describes the permissions of a specified resource.
default CompletableFuture<DescribeRootFoldersResponse>	describeRootFolders(DescribeRootFoldersRequest describeRootFoldersRequest)	Describes the current user's special folders; the RootFolder and the RecyleBin.
default CompletableFuture<DescribeUsersResponse>	describeUsers(DescribeUsersRequest describeUsersRequest)	Describes the specified users.
default CompletableFuture<GetCurrentUserResponse>	getCurrentUser(GetCurrentUserRequest getCurrentUserRequest)	Retrieves details of the current user for whom the authentication token was generated.
default CompletableFuture<GetDocumentResponse>	getDocument(GetDocumentRequest getDocumentRequest)	Retrieves details of a document.
default CompletableFuture<GetDocumentPathResponse>	getDocumentPath(GetDocumentPathRequest getDocumentPathRequest)	Retrieves the path information (the hierarchy from the root folder) for the requested document.
default CompletableFuture<GetDocumentVersionResponse>	getDocumentVersion(GetDocumentVersionRequest getDocumentVersionRequest)	Retrieves version metadata for the specified document.
default CompletableFuture<GetFolderResponse>	getFolder(GetFolderRequest getFolderRequest)	Retrieves the metadata of the specified folder.
default CompletableFuture<GetFolderPathResponse>	getFolderPath(GetFolderPathRequest getFolderPathRequest)	Retrieves the path information (the hierarchy from the root folder) for the specified folder.
default CompletableFuture<InitiateDocumentVersionUploadResponse>	initiateDocumentVersionUpload(InitiateDocumentVersionUploadRequest initiateDocumentVersionUploadRequest)	Creates a new document object and version object.
default CompletableFuture<RemoveAllResourcePermissionsResponse>	removeAllResourcePermissions(RemoveAllResourcePermissionsRequest removeAllResourcePermissionsRequest)	Removes all the permissions from the specified resource.
default CompletableFuture<RemoveResourcePermissionResponse>	removeResourcePermission(RemoveResourcePermissionRequest removeResourcePermissionRequest)	Removes the permission for the specified principal from the specified resource.
default CompletableFuture<UpdateDocumentResponse>	updateDocument(UpdateDocumentRequest updateDocumentRequest)	Updates the specified attributes of a document.
default CompletableFuture<UpdateDocumentVersionResponse>	updateDocumentVersion(UpdateDocumentVersionRequest updateDocumentVersionRequest)	Changes the status of the document version to ACTIVE.
default CompletableFuture<UpdateFolderResponse>	updateFolder(UpdateFolderRequest updateFolderRequest)	Updates the specified attributes of the specified folder.
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.

Methods inherited from interface java.lang.AutoCloseable

close

Method Detail

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.

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

See Also:

AWS API Documentation

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

See Also:

AWS API Documentation

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

See Also:

AWS API Documentation

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

See Also:

AWS API Documentation

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

See Also:

AWS API Documentation

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

See Also:

AWS API Documentation

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

See Also:

AWS API Documentation

createNotificationSubscription

default CompletableFuture<CreateNotificationSubscriptionResponse> createNotificationSubscription(CreateNotificationSubscriptionRequest createNotificationSubscriptionRequest)

Configure WorkDocs to use Amazon SNS notifications.

The endpoint receives a confirmation message, and must confirm the subscription. For more information, see Confirm the Subscription in the Amazon Simple Notification Service 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.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• WorkDocsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

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

See Also:

AWS API Documentation

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

See Also:

AWS API Documentation

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

See Also:

AWS API Documentation

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

See Also:

AWS API Documentation

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

See Also:

AWS API Documentation

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

See Also:

AWS API Documentation

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.
• UnauthorizedOperationException The operation is not permitted.
• UnauthorizedResourceAccessException The caller does not have access to perform the action on the resource.
• FailedDependencyException The AWS 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.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• WorkDocsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

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

See Also:

AWS API Documentation

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

See Also:

AWS API Documentation

deleteUser

default CompletableFuture<DeleteUserResponse> deleteUser(DeleteUserRequest deleteUserRequest)

Deletes the specified user from a Simple AD or Microsoft AD directory.

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

See Also:

AWS API Documentation

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

See Also:

AWS API Documentation

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

See Also:

AWS API Documentation

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

See Also:

AWS API Documentation

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

See Also:

AWS API Documentation

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

See Also:

AWS API Documentation

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.

• UnauthorizedOperationException The operation is not permitted.
• UnauthorizedResourceAccessException The caller does not have access to perform the action on the resource.
• FailedDependencyException The AWS 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.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• WorkDocsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

describeRootFolders

default CompletableFuture<DescribeRootFoldersResponse> describeRootFolders(DescribeRootFoldersRequest describeRootFoldersRequest)

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

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

See Also:

AWS API Documentation

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.

• UnauthorizedOperationException The operation is not permitted.
• UnauthorizedResourceAccessException The caller does not have access to perform the action on the resource.
• FailedDependencyException The AWS 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 and/or limit fields are not valid.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• WorkDocsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

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.

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

See Also:

AWS API Documentation

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

See Also:

AWS API Documentation

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

See Also:

AWS API Documentation

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

See Also:

AWS API Documentation

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

See Also:

AWS API Documentation

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

See Also:

AWS API Documentation

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

See Also:

AWS API Documentation

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

See Also:

AWS API Documentation

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

See Also:

AWS API Documentation

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 folders under the parent folder has been exceeded.
• ProhibitedStateException The specified document version is not in the INITIALIZED state.
• 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 AWS 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.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• WorkDocsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

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

See Also:

AWS API Documentation

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

See Also:

AWS API Documentation

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

See Also:

AWS API Documentation