AutoCloseable@Generated("software.amazon.awssdk:codegen") public interface WorkDocsClient extends AutoCloseable
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.
| Modifier and Type | Field | Description |
|---|---|---|
static String |
SERVICE_NAME |
| Modifier and Type | Method | Description |
|---|---|---|
default AbortDocumentVersionUploadResponse |
abortDocumentVersionUpload(AbortDocumentVersionUploadRequest abortDocumentVersionUploadRequest) |
Aborts the upload of the specified document version that was previously initiated by
InitiateDocumentVersionUpload.
|
default ActivateUserResponse |
activateUser(ActivateUserRequest activateUserRequest) |
Activates the specified user.
|
default AddResourcePermissionsResponse |
addResourcePermissions(AddResourcePermissionsRequest addResourcePermissionsRequest) |
Creates a set of permissions for the specified folder or document.
|
static WorkDocsClientBuilder |
builder() |
Create a builder that can be used to configure and create a
WorkDocsClient. |
static WorkDocsClient |
create() |
Create a
WorkDocsClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider. |
default CreateCommentResponse |
createComment(CreateCommentRequest createCommentRequest) |
Adds a new comment to the specified document version.
|
default CreateCustomMetadataResponse |
createCustomMetadata(CreateCustomMetadataRequest createCustomMetadataRequest) |
Adds one or more custom properties to the specified resource (a folder, document, or version).
|
default CreateFolderResponse |
createFolder(CreateFolderRequest createFolderRequest) |
Creates a folder with the specified name and parent folder.
|
default CreateLabelsResponse |
createLabels(CreateLabelsRequest createLabelsRequest) |
Adds the specified list of labels to the given resource (a document or folder)
|
default CreateNotificationSubscriptionResponse |
createNotificationSubscription(CreateNotificationSubscriptionRequest createNotificationSubscriptionRequest) |
Configure WorkDocs to use Amazon SNS notifications.
|
default CreateUserResponse |
createUser(CreateUserRequest createUserRequest) |
Creates a user in a Simple AD or Microsoft AD directory.
|
default DeactivateUserResponse |
deactivateUser(DeactivateUserRequest deactivateUserRequest) |
Deactivates the specified user, which revokes the user's access to Amazon WorkDocs.
|
default DeleteCommentResponse |
deleteComment(DeleteCommentRequest deleteCommentRequest) |
Deletes the specified comment from the document version.
|
default DeleteCustomMetadataResponse |
deleteCustomMetadata(DeleteCustomMetadataRequest deleteCustomMetadataRequest) |
Deletes custom metadata from the specified resource.
|
default DeleteDocumentResponse |
deleteDocument(DeleteDocumentRequest deleteDocumentRequest) |
Permanently deletes the specified document and its associated metadata.
|
default DeleteFolderResponse |
deleteFolder(DeleteFolderRequest deleteFolderRequest) |
Permanently deletes the specified folder and its contents.
|
default DeleteFolderContentsResponse |
deleteFolderContents(DeleteFolderContentsRequest deleteFolderContentsRequest) |
Deletes the contents of the specified folder.
|
default DeleteLabelsResponse |
deleteLabels(DeleteLabelsRequest deleteLabelsRequest) |
Deletes the specified list of labels from a resource.
|
default DeleteNotificationSubscriptionResponse |
deleteNotificationSubscription(DeleteNotificationSubscriptionRequest deleteNotificationSubscriptionRequest) |
Deletes the specified subscription from the specified organization.
|
default DeleteUserResponse |
deleteUser(DeleteUserRequest deleteUserRequest) |
Deletes the specified user from a Simple AD or Microsoft AD directory.
|
default DescribeActivitiesResponse |
describeActivities(DescribeActivitiesRequest describeActivitiesRequest) |
Describes the user activities in a specified time period.
|
default DescribeCommentsResponse |
describeComments(DescribeCommentsRequest describeCommentsRequest) |
List all the comments for the specified document version.
|
default DescribeDocumentVersionsResponse |
describeDocumentVersions(DescribeDocumentVersionsRequest describeDocumentVersionsRequest) |
Retrieves the document versions for the specified document.
|
default DescribeFolderContentsResponse |
describeFolderContents(DescribeFolderContentsRequest describeFolderContentsRequest) |
Describes the contents of the specified folder, including its documents and subfolders.
|
default DescribeNotificationSubscriptionsResponse |
describeNotificationSubscriptions(DescribeNotificationSubscriptionsRequest describeNotificationSubscriptionsRequest) |
Lists the specified notification subscriptions.
|
default DescribeResourcePermissionsResponse |
describeResourcePermissions(DescribeResourcePermissionsRequest describeResourcePermissionsRequest) |
Describes the permissions of a specified resource.
|
default DescribeRootFoldersResponse |
describeRootFolders(DescribeRootFoldersRequest describeRootFoldersRequest) |
Describes the current user's special folders; the
RootFolder and the RecyleBin. |
default DescribeUsersResponse |
describeUsers(DescribeUsersRequest describeUsersRequest) |
Describes the specified users.
|
default GetCurrentUserResponse |
getCurrentUser(GetCurrentUserRequest getCurrentUserRequest) |
Retrieves details of the current user for whom the authentication token was generated.
|
default GetDocumentResponse |
getDocument(GetDocumentRequest getDocumentRequest) |
Retrieves details of a document.
|
default GetDocumentPathResponse |
getDocumentPath(GetDocumentPathRequest getDocumentPathRequest) |
Retrieves the path information (the hierarchy from the root folder) for the requested document.
|
default GetDocumentVersionResponse |
getDocumentVersion(GetDocumentVersionRequest getDocumentVersionRequest) |
Retrieves version metadata for the specified document.
|
default GetFolderResponse |
getFolder(GetFolderRequest getFolderRequest) |
Retrieves the metadata of the specified folder.
|
default GetFolderPathResponse |
getFolderPath(GetFolderPathRequest getFolderPathRequest) |
Retrieves the path information (the hierarchy from the root folder) for the specified folder.
|
default InitiateDocumentVersionUploadResponse |
initiateDocumentVersionUpload(InitiateDocumentVersionUploadRequest initiateDocumentVersionUploadRequest) |
Creates a new document object and version object.
|
default RemoveAllResourcePermissionsResponse |
removeAllResourcePermissions(RemoveAllResourcePermissionsRequest removeAllResourcePermissionsRequest) |
Removes all the permissions from the specified resource.
|
default RemoveResourcePermissionResponse |
removeResourcePermission(RemoveResourcePermissionRequest removeResourcePermissionRequest) |
Removes the permission for the specified principal from the specified resource.
|
static ServiceMetadata |
serviceMetadata() |
|
default UpdateDocumentResponse |
updateDocument(UpdateDocumentRequest updateDocumentRequest) |
Updates the specified attributes of a document.
|
default UpdateDocumentVersionResponse |
updateDocumentVersion(UpdateDocumentVersionRequest updateDocumentVersionRequest) |
Changes the status of the document version to ACTIVE.
|
default UpdateFolderResponse |
updateFolder(UpdateFolderRequest updateFolderRequest) |
Updates the specified attributes of the specified folder.
|
default UpdateUserResponse |
updateUser(UpdateUserRequest updateUserRequest) |
Updates the specified attributes of the specified user, and grants or revokes administrative privileges to the
Amazon WorkDocs site.
|
closestatic final String SERVICE_NAME
static WorkDocsClient create()
WorkDocsClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider.static WorkDocsClientBuilder builder()
WorkDocsClient.default AbortDocumentVersionUploadResponse abortDocumentVersionUpload(AbortDocumentVersionUploadRequest abortDocumentVersionUploadRequest) throws EntityNotExistsException, ProhibitedStateException, UnauthorizedOperationException, UnauthorizedResourceAccessException, FailedDependencyException, ServiceUnavailableException, SdkBaseException, SdkClientException, WorkDocsException
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.
abortDocumentVersionUploadRequest - 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 exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault ActivateUserResponse activateUser(ActivateUserRequest activateUserRequest) throws EntityNotExistsException, UnauthorizedOperationException, UnauthorizedResourceAccessException, FailedDependencyException, ServiceUnavailableException, SdkBaseException, SdkClientException, WorkDocsException
Activates the specified user. Only active users can access Amazon WorkDocs.
activateUserRequest - 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 exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault AddResourcePermissionsResponse addResourcePermissions(AddResourcePermissionsRequest addResourcePermissionsRequest) throws UnauthorizedOperationException, UnauthorizedResourceAccessException, FailedDependencyException, ServiceUnavailableException, SdkBaseException, SdkClientException, WorkDocsException
Creates a set of permissions for the specified folder or document. The resource permissions are overwritten if the principals already have different permissions.
addResourcePermissionsRequest - 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 exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault CreateCommentResponse createComment(CreateCommentRequest createCommentRequest) throws EntityNotExistsException, ProhibitedStateException, UnauthorizedOperationException, UnauthorizedResourceAccessException, FailedDependencyException, ServiceUnavailableException, DocumentLockedForCommentsException, SdkBaseException, SdkClientException, WorkDocsException
Adds a new comment to the specified document version.
createCommentRequest - 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 exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault CreateCustomMetadataResponse createCustomMetadata(CreateCustomMetadataRequest createCustomMetadataRequest) throws EntityNotExistsException, UnauthorizedOperationException, UnauthorizedResourceAccessException, ProhibitedStateException, CustomMetadataLimitExceededException, FailedDependencyException, ServiceUnavailableException, SdkBaseException, SdkClientException, WorkDocsException
Adds one or more custom properties to the specified resource (a folder, document, or version).
createCustomMetadataRequest - 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 exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault CreateFolderResponse createFolder(CreateFolderRequest createFolderRequest) throws EntityNotExistsException, EntityAlreadyExistsException, ProhibitedStateException, LimitExceededException, UnauthorizedOperationException, UnauthorizedResourceAccessException, FailedDependencyException, ServiceUnavailableException, SdkBaseException, SdkClientException, WorkDocsException
Creates a folder with the specified name and parent folder.
createFolderRequest - 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 exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault CreateLabelsResponse createLabels(CreateLabelsRequest createLabelsRequest) throws EntityNotExistsException, UnauthorizedOperationException, UnauthorizedResourceAccessException, FailedDependencyException, ServiceUnavailableException, TooManyLabelsException, SdkBaseException, SdkClientException, WorkDocsException
Adds the specified list of labels to the given resource (a document or folder)
createLabelsRequest - 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 exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault CreateNotificationSubscriptionResponse createNotificationSubscription(CreateNotificationSubscriptionRequest createNotificationSubscriptionRequest) throws UnauthorizedResourceAccessException, TooManySubscriptionsException, ServiceUnavailableException, SdkBaseException, SdkClientException, WorkDocsException
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.
createNotificationSubscriptionRequest - 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 exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault CreateUserResponse createUser(CreateUserRequest createUserRequest) throws EntityAlreadyExistsException, UnauthorizedOperationException, UnauthorizedResourceAccessException, FailedDependencyException, ServiceUnavailableException, SdkBaseException, SdkClientException, WorkDocsException
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.
createUserRequest - 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 exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DeactivateUserResponse deactivateUser(DeactivateUserRequest deactivateUserRequest) throws EntityNotExistsException, UnauthorizedOperationException, UnauthorizedResourceAccessException, FailedDependencyException, ServiceUnavailableException, SdkBaseException, SdkClientException, WorkDocsException
Deactivates the specified user, which revokes the user's access to Amazon WorkDocs.
deactivateUserRequest - 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 exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DeleteCommentResponse deleteComment(DeleteCommentRequest deleteCommentRequest) throws EntityNotExistsException, ProhibitedStateException, UnauthorizedOperationException, UnauthorizedResourceAccessException, FailedDependencyException, ServiceUnavailableException, DocumentLockedForCommentsException, SdkBaseException, SdkClientException, WorkDocsException
Deletes the specified comment from the document version.
deleteCommentRequest - 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 exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DeleteCustomMetadataResponse deleteCustomMetadata(DeleteCustomMetadataRequest deleteCustomMetadataRequest) throws EntityNotExistsException, UnauthorizedOperationException, UnauthorizedResourceAccessException, ProhibitedStateException, FailedDependencyException, ServiceUnavailableException, SdkBaseException, SdkClientException, WorkDocsException
Deletes custom metadata from the specified resource.
deleteCustomMetadataRequest - 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 exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DeleteDocumentResponse deleteDocument(DeleteDocumentRequest deleteDocumentRequest) throws EntityNotExistsException, ProhibitedStateException, ConcurrentModificationException, UnauthorizedOperationException, UnauthorizedResourceAccessException, FailedDependencyException, ServiceUnavailableException, SdkBaseException, SdkClientException, WorkDocsException
Permanently deletes the specified document and its associated metadata.
deleteDocumentRequest - 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 exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DeleteFolderResponse deleteFolder(DeleteFolderRequest deleteFolderRequest) throws EntityNotExistsException, ProhibitedStateException, ConcurrentModificationException, UnauthorizedOperationException, UnauthorizedResourceAccessException, FailedDependencyException, ServiceUnavailableException, SdkBaseException, SdkClientException, WorkDocsException
Permanently deletes the specified folder and its contents.
deleteFolderRequest - 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 exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DeleteFolderContentsResponse deleteFolderContents(DeleteFolderContentsRequest deleteFolderContentsRequest) throws EntityNotExistsException, UnauthorizedOperationException, UnauthorizedResourceAccessException, FailedDependencyException, ServiceUnavailableException, SdkBaseException, SdkClientException, WorkDocsException
Deletes the contents of the specified folder.
deleteFolderContentsRequest - 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 exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DeleteLabelsResponse deleteLabels(DeleteLabelsRequest deleteLabelsRequest) throws EntityNotExistsException, UnauthorizedOperationException, UnauthorizedResourceAccessException, FailedDependencyException, ServiceUnavailableException, SdkBaseException, SdkClientException, WorkDocsException
Deletes the specified list of labels from a resource.
deleteLabelsRequest - 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 exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DeleteNotificationSubscriptionResponse deleteNotificationSubscription(DeleteNotificationSubscriptionRequest deleteNotificationSubscriptionRequest) throws UnauthorizedResourceAccessException, EntityNotExistsException, ServiceUnavailableException, ProhibitedStateException, SdkBaseException, SdkClientException, WorkDocsException
Deletes the specified subscription from the specified organization.
deleteNotificationSubscriptionRequest - 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 exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DeleteUserResponse deleteUser(DeleteUserRequest deleteUserRequest) throws EntityNotExistsException, UnauthorizedOperationException, UnauthorizedResourceAccessException, FailedDependencyException, ServiceUnavailableException, SdkBaseException, SdkClientException, WorkDocsException
Deletes the specified user from a Simple AD or Microsoft AD directory.
deleteUserRequest - 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 exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DescribeActivitiesResponse describeActivities(DescribeActivitiesRequest describeActivitiesRequest) throws UnauthorizedOperationException, UnauthorizedResourceAccessException, InvalidArgumentException, FailedDependencyException, ServiceUnavailableException, SdkBaseException, SdkClientException, WorkDocsException
Describes the user activities in a specified time period.
describeActivitiesRequest - 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 exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DescribeCommentsResponse describeComments(DescribeCommentsRequest describeCommentsRequest) throws EntityNotExistsException, ProhibitedStateException, UnauthorizedOperationException, UnauthorizedResourceAccessException, FailedDependencyException, ServiceUnavailableException, SdkBaseException, SdkClientException, WorkDocsException
List all the comments for the specified document version.
describeCommentsRequest - 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 exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DescribeDocumentVersionsResponse describeDocumentVersions(DescribeDocumentVersionsRequest describeDocumentVersionsRequest) throws EntityNotExistsException, UnauthorizedOperationException, UnauthorizedResourceAccessException, InvalidArgumentException, FailedDependencyException, ServiceUnavailableException, ProhibitedStateException, SdkBaseException, SdkClientException, WorkDocsException
Retrieves the document versions for the specified document.
By default, only active versions are returned.
describeDocumentVersionsRequest - 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 exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DescribeFolderContentsResponse describeFolderContents(DescribeFolderContentsRequest describeFolderContentsRequest) throws EntityNotExistsException, UnauthorizedResourceAccessException, InvalidArgumentException, FailedDependencyException, ServiceUnavailableException, ProhibitedStateException, SdkBaseException, SdkClientException, WorkDocsException
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.
describeFolderContentsRequest - 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 exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DescribeNotificationSubscriptionsResponse describeNotificationSubscriptions(DescribeNotificationSubscriptionsRequest describeNotificationSubscriptionsRequest) throws UnauthorizedResourceAccessException, EntityNotExistsException, ServiceUnavailableException, SdkBaseException, SdkClientException, WorkDocsException
Lists the specified notification subscriptions.
describeNotificationSubscriptionsRequest - 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 exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DescribeResourcePermissionsResponse describeResourcePermissions(DescribeResourcePermissionsRequest describeResourcePermissionsRequest) throws UnauthorizedOperationException, UnauthorizedResourceAccessException, FailedDependencyException, ServiceUnavailableException, SdkBaseException, SdkClientException, WorkDocsException
Describes the permissions of a specified resource.
describeResourcePermissionsRequest - 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 exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DescribeRootFoldersResponse describeRootFolders(DescribeRootFoldersRequest describeRootFoldersRequest) throws UnauthorizedOperationException, UnauthorizedResourceAccessException, InvalidArgumentException, FailedDependencyException, ServiceUnavailableException, SdkBaseException, SdkClientException, WorkDocsException
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.
describeRootFoldersRequest - 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 exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DescribeUsersResponse describeUsers(DescribeUsersRequest describeUsersRequest) throws UnauthorizedOperationException, UnauthorizedResourceAccessException, FailedDependencyException, ServiceUnavailableException, InvalidArgumentException, SdkBaseException, SdkClientException, WorkDocsException
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.
describeUsersRequest - 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 exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault GetCurrentUserResponse getCurrentUser(GetCurrentUserRequest getCurrentUserRequest) throws EntityNotExistsException, UnauthorizedOperationException, UnauthorizedResourceAccessException, FailedDependencyException, ServiceUnavailableException, SdkBaseException, SdkClientException, WorkDocsException
Retrieves details of the current user for whom the authentication token was generated. This is not a valid action for SigV4 (administrative API) clients.
getCurrentUserRequest - 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 exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault GetDocumentResponse getDocument(GetDocumentRequest getDocumentRequest) throws EntityNotExistsException, UnauthorizedOperationException, UnauthorizedResourceAccessException, InvalidArgumentException, FailedDependencyException, ServiceUnavailableException, SdkBaseException, SdkClientException, WorkDocsException
Retrieves details of a document.
getDocumentRequest - 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 exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault GetDocumentPathResponse getDocumentPath(GetDocumentPathRequest getDocumentPathRequest) throws EntityNotExistsException, UnauthorizedOperationException, UnauthorizedResourceAccessException, FailedDependencyException, ServiceUnavailableException, SdkBaseException, SdkClientException, WorkDocsException
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.
getDocumentPathRequest - 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 exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault GetDocumentVersionResponse getDocumentVersion(GetDocumentVersionRequest getDocumentVersionRequest) throws EntityNotExistsException, UnauthorizedOperationException, UnauthorizedResourceAccessException, FailedDependencyException, ServiceUnavailableException, ProhibitedStateException, SdkBaseException, SdkClientException, WorkDocsException
Retrieves version metadata for the specified document.
getDocumentVersionRequest - 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 exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault GetFolderResponse getFolder(GetFolderRequest getFolderRequest) throws EntityNotExistsException, UnauthorizedOperationException, UnauthorizedResourceAccessException, InvalidArgumentException, FailedDependencyException, ServiceUnavailableException, ProhibitedStateException, SdkBaseException, SdkClientException, WorkDocsException
Retrieves the metadata of the specified folder.
getFolderRequest - 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 exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault GetFolderPathResponse getFolderPath(GetFolderPathRequest getFolderPathRequest) throws EntityNotExistsException, UnauthorizedOperationException, UnauthorizedResourceAccessException, FailedDependencyException, ServiceUnavailableException, SdkBaseException, SdkClientException, WorkDocsException
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.
getFolderPathRequest - 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 exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault InitiateDocumentVersionUploadResponse initiateDocumentVersionUpload(InitiateDocumentVersionUploadRequest initiateDocumentVersionUploadRequest) throws EntityNotExistsException, EntityAlreadyExistsException, StorageLimitExceededException, StorageLimitWillExceedException, ProhibitedStateException, UnauthorizedOperationException, UnauthorizedResourceAccessException, FailedDependencyException, ServiceUnavailableException, DraftUploadOutOfSyncException, ResourceAlreadyCheckedOutException, SdkBaseException, SdkClientException, WorkDocsException
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.
initiateDocumentVersionUploadRequest - 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 exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault RemoveAllResourcePermissionsResponse removeAllResourcePermissions(RemoveAllResourcePermissionsRequest removeAllResourcePermissionsRequest) throws UnauthorizedOperationException, UnauthorizedResourceAccessException, FailedDependencyException, ServiceUnavailableException, SdkBaseException, SdkClientException, WorkDocsException
Removes all the permissions from the specified resource.
removeAllResourcePermissionsRequest - 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 exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault RemoveResourcePermissionResponse removeResourcePermission(RemoveResourcePermissionRequest removeResourcePermissionRequest) throws UnauthorizedOperationException, UnauthorizedResourceAccessException, FailedDependencyException, ServiceUnavailableException, SdkBaseException, SdkClientException, WorkDocsException
Removes the permission for the specified principal from the specified resource.
removeResourcePermissionRequest - 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 exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault UpdateDocumentResponse updateDocument(UpdateDocumentRequest updateDocumentRequest) throws EntityNotExistsException, EntityAlreadyExistsException, LimitExceededException, ProhibitedStateException, ConcurrentModificationException, UnauthorizedOperationException, UnauthorizedResourceAccessException, FailedDependencyException, ServiceUnavailableException, SdkBaseException, SdkClientException, WorkDocsException
Updates the specified attributes of a document. The user must have access to both the document and its parent folder, if applicable.
updateDocumentRequest - 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 exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault UpdateDocumentVersionResponse updateDocumentVersion(UpdateDocumentVersionRequest updateDocumentVersionRequest) throws EntityNotExistsException, ProhibitedStateException, ConcurrentModificationException, InvalidOperationException, UnauthorizedOperationException, UnauthorizedResourceAccessException, FailedDependencyException, ServiceUnavailableException, SdkBaseException, SdkClientException, WorkDocsException
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.
updateDocumentVersionRequest - 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 exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault UpdateFolderResponse updateFolder(UpdateFolderRequest updateFolderRequest) throws EntityNotExistsException, EntityAlreadyExistsException, ProhibitedStateException, ConcurrentModificationException, LimitExceededException, UnauthorizedOperationException, UnauthorizedResourceAccessException, FailedDependencyException, ServiceUnavailableException, SdkBaseException, SdkClientException, WorkDocsException
Updates the specified attributes of the specified folder. The user must have access to both the folder and its parent folder, if applicable.
updateFolderRequest - 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 exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault UpdateUserResponse updateUser(UpdateUserRequest updateUserRequest) throws EntityNotExistsException, UnauthorizedOperationException, UnauthorizedResourceAccessException, IllegalUserStateException, FailedDependencyException, ServiceUnavailableException, DeactivatingLastSystemUserException, SdkBaseException, SdkClientException, WorkDocsException
Updates the specified attributes of the specified user, and grants or revokes administrative privileges to the Amazon WorkDocs site.
updateUserRequest - 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 exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typestatic ServiceMetadata serviceMetadata()
Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.