@Generated(value="software.amazon.awssdk:codegen") public interface WorkDocsClient extends SdkClient, SdkAutoCloseable
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-premises or off-premises file system or service. Users can insert files into a user directory structure, as well as allow for basic metadata changes, such as modifications to the permissions of files.
Security: Support security applications are supported for users who have additional security needs, such as antivirus or data loss prevention. The API actions, along with AWS CloudTrail, allow these applications to detect when changes occur in Amazon WorkDocs. Then, the application can take the necessary actions and replace the target file. If the target file violates the policy, the application can also choose to email the user.
eDiscovery/Analytics: General administrative applications are supported, such as eDiscovery and analytics. These applications can choose to mimic or record the actions in an Amazon WorkDocs site, along with AWS CloudTrail, to replicate data for eDiscovery, backup, or analytical applications.
All Amazon WorkDocs API actions are Amazon authenticated and certificate-signed. They not only require the use of the 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 and Description |
|---|---|
static String |
SERVICE_NAME |
| Modifier and Type | Method and Description |
|---|---|
default AbortDocumentVersionUploadResponse |
abortDocumentVersionUpload(AbortDocumentVersionUploadRequest abortDocumentVersionUploadRequest)
Aborts the upload of the specified document version that was previously initiated by
InitiateDocumentVersionUpload.
|
default AbortDocumentVersionUploadResponse |
abortDocumentVersionUpload(Consumer<AbortDocumentVersionUploadRequest.Builder> 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 ActivateUserResponse |
activateUser(Consumer<ActivateUserRequest.Builder> activateUserRequest)
Activates the specified user.
|
default AddResourcePermissionsResponse |
addResourcePermissions(AddResourcePermissionsRequest addResourcePermissionsRequest)
Creates a set of permissions for the specified folder or document.
|
default AddResourcePermissionsResponse |
addResourcePermissions(Consumer<AddResourcePermissionsRequest.Builder> 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(Consumer<CreateCommentRequest.Builder> createCommentRequest)
Adds a new comment to the specified document version.
|
default CreateCommentResponse |
createComment(CreateCommentRequest createCommentRequest)
Adds a new comment to the specified document version.
|
default CreateCustomMetadataResponse |
createCustomMetadata(Consumer<CreateCustomMetadataRequest.Builder> createCustomMetadataRequest)
Adds one or more custom properties to the specified resource (a folder, document, or version).
|
default CreateCustomMetadataResponse |
createCustomMetadata(CreateCustomMetadataRequest createCustomMetadataRequest)
Adds one or more custom properties to the specified resource (a folder, document, or version).
|
default CreateFolderResponse |
createFolder(Consumer<CreateFolderRequest.Builder> createFolderRequest)
Creates a folder with the specified name and parent folder.
|
default CreateFolderResponse |
createFolder(CreateFolderRequest createFolderRequest)
Creates a folder with the specified name and parent folder.
|
default CreateLabelsResponse |
createLabels(Consumer<CreateLabelsRequest.Builder> createLabelsRequest)
Adds the specified list of labels to the given resource (a document or folder)
|
default CreateLabelsResponse |
createLabels(CreateLabelsRequest createLabelsRequest)
Adds the specified list of labels to the given resource (a document or folder)
|
default CreateNotificationSubscriptionResponse |
createNotificationSubscription(Consumer<CreateNotificationSubscriptionRequest.Builder> createNotificationSubscriptionRequest)
Configure WorkDocs to use Amazon SNS notifications.
|
default CreateNotificationSubscriptionResponse |
createNotificationSubscription(CreateNotificationSubscriptionRequest createNotificationSubscriptionRequest)
Configure WorkDocs to use Amazon SNS notifications.
|
default CreateUserResponse |
createUser(Consumer<CreateUserRequest.Builder> createUserRequest)
Creates a user in a Simple AD or Microsoft AD directory.
|
default CreateUserResponse |
createUser(CreateUserRequest createUserRequest)
Creates a user in a Simple AD or Microsoft AD directory.
|
default DeactivateUserResponse |
deactivateUser(Consumer<DeactivateUserRequest.Builder> deactivateUserRequest)
Deactivates the specified user, which revokes the user's access to Amazon WorkDocs.
|
default DeactivateUserResponse |
deactivateUser(DeactivateUserRequest deactivateUserRequest)
Deactivates the specified user, which revokes the user's access to Amazon WorkDocs.
|
default DeleteCommentResponse |
deleteComment(Consumer<DeleteCommentRequest.Builder> deleteCommentRequest)
Deletes the specified comment from the document version.
|
default DeleteCommentResponse |
deleteComment(DeleteCommentRequest deleteCommentRequest)
Deletes the specified comment from the document version.
|
default DeleteCustomMetadataResponse |
deleteCustomMetadata(Consumer<DeleteCustomMetadataRequest.Builder> deleteCustomMetadataRequest)
Deletes custom metadata from the specified resource.
|
default DeleteCustomMetadataResponse |
deleteCustomMetadata(DeleteCustomMetadataRequest deleteCustomMetadataRequest)
Deletes custom metadata from the specified resource.
|
default DeleteDocumentResponse |
deleteDocument(Consumer<DeleteDocumentRequest.Builder> deleteDocumentRequest)
Permanently deletes the specified document and its associated metadata.
|
default DeleteDocumentResponse |
deleteDocument(DeleteDocumentRequest deleteDocumentRequest)
Permanently deletes the specified document and its associated metadata.
|
default DeleteFolderResponse |
deleteFolder(Consumer<DeleteFolderRequest.Builder> deleteFolderRequest)
Permanently deletes the specified folder and its contents.
|
default DeleteFolderResponse |
deleteFolder(DeleteFolderRequest deleteFolderRequest)
Permanently deletes the specified folder and its contents.
|
default DeleteFolderContentsResponse |
deleteFolderContents(Consumer<DeleteFolderContentsRequest.Builder> deleteFolderContentsRequest)
Deletes the contents of the specified folder.
|
default DeleteFolderContentsResponse |
deleteFolderContents(DeleteFolderContentsRequest deleteFolderContentsRequest)
Deletes the contents of the specified folder.
|
default DeleteLabelsResponse |
deleteLabels(Consumer<DeleteLabelsRequest.Builder> deleteLabelsRequest)
Deletes the specified list of labels from a resource.
|
default DeleteLabelsResponse |
deleteLabels(DeleteLabelsRequest deleteLabelsRequest)
Deletes the specified list of labels from a resource.
|
default DeleteNotificationSubscriptionResponse |
deleteNotificationSubscription(Consumer<DeleteNotificationSubscriptionRequest.Builder> deleteNotificationSubscriptionRequest)
Deletes the specified subscription from the specified organization.
|
default DeleteNotificationSubscriptionResponse |
deleteNotificationSubscription(DeleteNotificationSubscriptionRequest deleteNotificationSubscriptionRequest)
Deletes the specified subscription from the specified organization.
|
default DeleteUserResponse |
deleteUser(Consumer<DeleteUserRequest.Builder> deleteUserRequest)
Deletes the specified user from a Simple AD or Microsoft AD directory.
|
default DeleteUserResponse |
deleteUser(DeleteUserRequest deleteUserRequest)
Deletes the specified user from a Simple AD or Microsoft AD directory.
|
default DescribeActivitiesResponse |
describeActivities(Consumer<DescribeActivitiesRequest.Builder> describeActivitiesRequest)
Describes the user activities in a specified time period.
|
default DescribeActivitiesResponse |
describeActivities(DescribeActivitiesRequest describeActivitiesRequest)
Describes the user activities in a specified time period.
|
default DescribeCommentsResponse |
describeComments(Consumer<DescribeCommentsRequest.Builder> describeCommentsRequest)
List all the comments for the specified document version.
|
default DescribeCommentsResponse |
describeComments(DescribeCommentsRequest describeCommentsRequest)
List all the comments for the specified document version.
|
default DescribeDocumentVersionsResponse |
describeDocumentVersions(Consumer<DescribeDocumentVersionsRequest.Builder> describeDocumentVersionsRequest)
Retrieves the document versions for the specified document.
|
default DescribeDocumentVersionsResponse |
describeDocumentVersions(DescribeDocumentVersionsRequest describeDocumentVersionsRequest)
Retrieves the document versions for the specified document.
|
default DescribeDocumentVersionsIterable |
describeDocumentVersionsPaginator(DescribeDocumentVersionsRequest describeDocumentVersionsRequest)
Retrieves the document versions for the specified document.
|
default DescribeFolderContentsResponse |
describeFolderContents(Consumer<DescribeFolderContentsRequest.Builder> describeFolderContentsRequest)
Describes the contents of the specified folder, including its documents and subfolders.
|
default DescribeFolderContentsResponse |
describeFolderContents(DescribeFolderContentsRequest describeFolderContentsRequest)
Describes the contents of the specified folder, including its documents and subfolders.
|
default DescribeFolderContentsIterable |
describeFolderContentsPaginator(DescribeFolderContentsRequest describeFolderContentsRequest)
Describes the contents of the specified folder, including its documents and subfolders.
|
default DescribeGroupsResponse |
describeGroups(Consumer<DescribeGroupsRequest.Builder> describeGroupsRequest)
Describes the groups specified by query.
|
default DescribeGroupsResponse |
describeGroups(DescribeGroupsRequest describeGroupsRequest)
Describes the groups specified by query.
|
default DescribeNotificationSubscriptionsResponse |
describeNotificationSubscriptions(Consumer<DescribeNotificationSubscriptionsRequest.Builder> describeNotificationSubscriptionsRequest)
Lists the specified notification subscriptions.
|
default DescribeNotificationSubscriptionsResponse |
describeNotificationSubscriptions(DescribeNotificationSubscriptionsRequest describeNotificationSubscriptionsRequest)
Lists the specified notification subscriptions.
|
default DescribeResourcePermissionsResponse |
describeResourcePermissions(Consumer<DescribeResourcePermissionsRequest.Builder> describeResourcePermissionsRequest)
Describes the permissions of a specified resource.
|
default DescribeResourcePermissionsResponse |
describeResourcePermissions(DescribeResourcePermissionsRequest describeResourcePermissionsRequest)
Describes the permissions of a specified resource.
|
default DescribeRootFoldersResponse |
describeRootFolders(Consumer<DescribeRootFoldersRequest.Builder> describeRootFoldersRequest)
Describes the current user's special folders; the
RootFolder and the RecycleBin. |
default DescribeRootFoldersResponse |
describeRootFolders(DescribeRootFoldersRequest describeRootFoldersRequest)
Describes the current user's special folders; the
RootFolder and the RecycleBin. |
default DescribeUsersResponse |
describeUsers(Consumer<DescribeUsersRequest.Builder> describeUsersRequest)
Describes the specified users.
|
default DescribeUsersResponse |
describeUsers(DescribeUsersRequest describeUsersRequest)
Describes the specified users.
|
default DescribeUsersIterable |
describeUsersPaginator(DescribeUsersRequest describeUsersRequest)
Describes the specified users.
|
default GetCurrentUserResponse |
getCurrentUser(Consumer<GetCurrentUserRequest.Builder> getCurrentUserRequest)
Retrieves details of the current user for whom the authentication token was generated.
|
default GetCurrentUserResponse |
getCurrentUser(GetCurrentUserRequest getCurrentUserRequest)
Retrieves details of the current user for whom the authentication token was generated.
|
default GetDocumentResponse |
getDocument(Consumer<GetDocumentRequest.Builder> getDocumentRequest)
Retrieves details of a document.
|
default GetDocumentResponse |
getDocument(GetDocumentRequest getDocumentRequest)
Retrieves details of a document.
|
default GetDocumentPathResponse |
getDocumentPath(Consumer<GetDocumentPathRequest.Builder> getDocumentPathRequest)
Retrieves the path information (the hierarchy from the root folder) for the requested document.
|
default GetDocumentPathResponse |
getDocumentPath(GetDocumentPathRequest getDocumentPathRequest)
Retrieves the path information (the hierarchy from the root folder) for the requested document.
|
default GetDocumentVersionResponse |
getDocumentVersion(Consumer<GetDocumentVersionRequest.Builder> getDocumentVersionRequest)
Retrieves version metadata for the specified document.
|
default GetDocumentVersionResponse |
getDocumentVersion(GetDocumentVersionRequest getDocumentVersionRequest)
Retrieves version metadata for the specified document.
|
default GetFolderResponse |
getFolder(Consumer<GetFolderRequest.Builder> getFolderRequest)
Retrieves the metadata of the specified folder.
|
default GetFolderResponse |
getFolder(GetFolderRequest getFolderRequest)
Retrieves the metadata of the specified folder.
|
default GetFolderPathResponse |
getFolderPath(Consumer<GetFolderPathRequest.Builder> getFolderPathRequest)
Retrieves the path information (the hierarchy from the root folder) for 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(Consumer<InitiateDocumentVersionUploadRequest.Builder> initiateDocumentVersionUploadRequest)
Creates a new document object and version object.
|
default InitiateDocumentVersionUploadResponse |
initiateDocumentVersionUpload(InitiateDocumentVersionUploadRequest initiateDocumentVersionUploadRequest)
Creates a new document object and version object.
|
default RemoveAllResourcePermissionsResponse |
removeAllResourcePermissions(Consumer<RemoveAllResourcePermissionsRequest.Builder> removeAllResourcePermissionsRequest)
Removes all the permissions from the specified resource.
|
default RemoveAllResourcePermissionsResponse |
removeAllResourcePermissions(RemoveAllResourcePermissionsRequest removeAllResourcePermissionsRequest)
Removes all the permissions from the specified resource.
|
default RemoveResourcePermissionResponse |
removeResourcePermission(Consumer<RemoveResourcePermissionRequest.Builder> removeResourcePermissionRequest)
Removes the permission for the specified principal 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(Consumer<UpdateDocumentRequest.Builder> updateDocumentRequest)
Updates the specified attributes of a document.
|
default UpdateDocumentResponse |
updateDocument(UpdateDocumentRequest updateDocumentRequest)
Updates the specified attributes of a document.
|
default UpdateDocumentVersionResponse |
updateDocumentVersion(Consumer<UpdateDocumentVersionRequest.Builder> updateDocumentVersionRequest)
Changes the status of the document version to ACTIVE.
|
default UpdateDocumentVersionResponse |
updateDocumentVersion(UpdateDocumentVersionRequest updateDocumentVersionRequest)
Changes the status of the document version to ACTIVE.
|
default UpdateFolderResponse |
updateFolder(Consumer<UpdateFolderRequest.Builder> updateFolderRequest)
Updates the specified attributes of the specified folder.
|
default UpdateFolderResponse |
updateFolder(UpdateFolderRequest updateFolderRequest)
Updates the specified attributes of the specified folder.
|
default UpdateUserResponse |
updateUser(Consumer<UpdateUserRequest.Builder> updateUserRequest)
Updates the specified attributes of the specified user, and grants or revokes administrative privileges to the
Amazon WorkDocs site.
|
default UpdateUserResponse |
updateUser(UpdateUserRequest updateUserRequest)
Updates the specified attributes of the specified user, and grants or revokes administrative privileges to the
Amazon WorkDocs site.
|
serviceNameclosestatic 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, SdkServiceException, 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkDocsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceExceptiondefault AbortDocumentVersionUploadResponse abortDocumentVersionUpload(Consumer<AbortDocumentVersionUploadRequest.Builder> abortDocumentVersionUploadRequest) throws EntityNotExistsException, ProhibitedStateException, UnauthorizedOperationException, UnauthorizedResourceAccessException, FailedDependencyException, ServiceUnavailableException, SdkServiceException, 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkDocsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceExceptiondefault ActivateUserResponse activateUser(ActivateUserRequest activateUserRequest) throws EntityNotExistsException, UnauthorizedOperationException, UnauthorizedResourceAccessException, FailedDependencyException, ServiceUnavailableException, SdkServiceException, 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkDocsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceExceptiondefault ActivateUserResponse activateUser(Consumer<ActivateUserRequest.Builder> activateUserRequest) throws EntityNotExistsException, UnauthorizedOperationException, UnauthorizedResourceAccessException, FailedDependencyException, ServiceUnavailableException, SdkServiceException, 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkDocsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceExceptiondefault AddResourcePermissionsResponse addResourcePermissions(AddResourcePermissionsRequest addResourcePermissionsRequest) throws UnauthorizedOperationException, UnauthorizedResourceAccessException, FailedDependencyException, ServiceUnavailableException, SdkServiceException, 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkDocsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceExceptiondefault AddResourcePermissionsResponse addResourcePermissions(Consumer<AddResourcePermissionsRequest.Builder> addResourcePermissionsRequest) throws UnauthorizedOperationException, UnauthorizedResourceAccessException, FailedDependencyException, ServiceUnavailableException, SdkServiceException, 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkDocsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceExceptiondefault CreateCommentResponse createComment(CreateCommentRequest createCommentRequest) throws EntityNotExistsException, ProhibitedStateException, UnauthorizedOperationException, UnauthorizedResourceAccessException, FailedDependencyException, ServiceUnavailableException, DocumentLockedForCommentsException, SdkServiceException, 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkDocsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceExceptiondefault CreateCommentResponse createComment(Consumer<CreateCommentRequest.Builder> createCommentRequest) throws EntityNotExistsException, ProhibitedStateException, UnauthorizedOperationException, UnauthorizedResourceAccessException, FailedDependencyException, ServiceUnavailableException, DocumentLockedForCommentsException, SdkServiceException, 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkDocsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceExceptiondefault CreateCustomMetadataResponse createCustomMetadata(CreateCustomMetadataRequest createCustomMetadataRequest) throws EntityNotExistsException, UnauthorizedOperationException, UnauthorizedResourceAccessException, ProhibitedStateException, CustomMetadataLimitExceededException, FailedDependencyException, ServiceUnavailableException, SdkServiceException, 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkDocsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceExceptiondefault CreateCustomMetadataResponse createCustomMetadata(Consumer<CreateCustomMetadataRequest.Builder> createCustomMetadataRequest) throws EntityNotExistsException, UnauthorizedOperationException, UnauthorizedResourceAccessException, ProhibitedStateException, CustomMetadataLimitExceededException, FailedDependencyException, ServiceUnavailableException, SdkServiceException, 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkDocsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceExceptiondefault CreateFolderResponse createFolder(CreateFolderRequest createFolderRequest) throws EntityNotExistsException, EntityAlreadyExistsException, ProhibitedStateException, LimitExceededException, UnauthorizedOperationException, UnauthorizedResourceAccessException, FailedDependencyException, ServiceUnavailableException, SdkServiceException, 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkDocsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceExceptiondefault CreateFolderResponse createFolder(Consumer<CreateFolderRequest.Builder> createFolderRequest) throws EntityNotExistsException, EntityAlreadyExistsException, ProhibitedStateException, LimitExceededException, UnauthorizedOperationException, UnauthorizedResourceAccessException, FailedDependencyException, ServiceUnavailableException, SdkServiceException, 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkDocsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceExceptiondefault CreateLabelsResponse createLabels(CreateLabelsRequest createLabelsRequest) throws EntityNotExistsException, UnauthorizedOperationException, UnauthorizedResourceAccessException, FailedDependencyException, ServiceUnavailableException, TooManyLabelsException, SdkServiceException, 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkDocsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceExceptiondefault CreateLabelsResponse createLabels(Consumer<CreateLabelsRequest.Builder> createLabelsRequest) throws EntityNotExistsException, UnauthorizedOperationException, UnauthorizedResourceAccessException, FailedDependencyException, ServiceUnavailableException, TooManyLabelsException, SdkServiceException, 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkDocsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceExceptiondefault CreateNotificationSubscriptionResponse createNotificationSubscription(CreateNotificationSubscriptionRequest createNotificationSubscriptionRequest) throws UnauthorizedResourceAccessException, TooManySubscriptionsException, ServiceUnavailableException, SdkServiceException, 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkDocsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceExceptiondefault CreateNotificationSubscriptionResponse createNotificationSubscription(Consumer<CreateNotificationSubscriptionRequest.Builder> createNotificationSubscriptionRequest) throws UnauthorizedResourceAccessException, TooManySubscriptionsException, ServiceUnavailableException, SdkServiceException, 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkDocsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceExceptiondefault CreateUserResponse createUser(CreateUserRequest createUserRequest) throws EntityAlreadyExistsException, UnauthorizedOperationException, UnauthorizedResourceAccessException, FailedDependencyException, ServiceUnavailableException, SdkServiceException, 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkDocsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceExceptiondefault CreateUserResponse createUser(Consumer<CreateUserRequest.Builder> createUserRequest) throws EntityAlreadyExistsException, UnauthorizedOperationException, UnauthorizedResourceAccessException, FailedDependencyException, ServiceUnavailableException, SdkServiceException, 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkDocsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceExceptiondefault DeactivateUserResponse deactivateUser(DeactivateUserRequest deactivateUserRequest) throws EntityNotExistsException, UnauthorizedOperationException, UnauthorizedResourceAccessException, FailedDependencyException, ServiceUnavailableException, SdkServiceException, 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkDocsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceExceptiondefault DeactivateUserResponse deactivateUser(Consumer<DeactivateUserRequest.Builder> deactivateUserRequest) throws EntityNotExistsException, UnauthorizedOperationException, UnauthorizedResourceAccessException, FailedDependencyException, ServiceUnavailableException, SdkServiceException, 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkDocsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceExceptiondefault DeleteCommentResponse deleteComment(DeleteCommentRequest deleteCommentRequest) throws EntityNotExistsException, ProhibitedStateException, UnauthorizedOperationException, UnauthorizedResourceAccessException, FailedDependencyException, ServiceUnavailableException, DocumentLockedForCommentsException, SdkServiceException, 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkDocsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceExceptiondefault DeleteCommentResponse deleteComment(Consumer<DeleteCommentRequest.Builder> deleteCommentRequest) throws EntityNotExistsException, ProhibitedStateException, UnauthorizedOperationException, UnauthorizedResourceAccessException, FailedDependencyException, ServiceUnavailableException, DocumentLockedForCommentsException, SdkServiceException, 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkDocsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceExceptiondefault DeleteCustomMetadataResponse deleteCustomMetadata(DeleteCustomMetadataRequest deleteCustomMetadataRequest) throws EntityNotExistsException, UnauthorizedOperationException, UnauthorizedResourceAccessException, ProhibitedStateException, FailedDependencyException, ServiceUnavailableException, SdkServiceException, 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkDocsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceExceptiondefault DeleteCustomMetadataResponse deleteCustomMetadata(Consumer<DeleteCustomMetadataRequest.Builder> deleteCustomMetadataRequest) throws EntityNotExistsException, UnauthorizedOperationException, UnauthorizedResourceAccessException, ProhibitedStateException, FailedDependencyException, ServiceUnavailableException, SdkServiceException, 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkDocsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceExceptiondefault DeleteDocumentResponse deleteDocument(DeleteDocumentRequest deleteDocumentRequest) throws EntityNotExistsException, ProhibitedStateException, ConcurrentModificationException, UnauthorizedOperationException, UnauthorizedResourceAccessException, FailedDependencyException, ServiceUnavailableException, SdkServiceException, 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkDocsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceExceptiondefault DeleteDocumentResponse deleteDocument(Consumer<DeleteDocumentRequest.Builder> deleteDocumentRequest) throws EntityNotExistsException, ProhibitedStateException, ConcurrentModificationException, UnauthorizedOperationException, UnauthorizedResourceAccessException, FailedDependencyException, ServiceUnavailableException, SdkServiceException, 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkDocsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceExceptiondefault DeleteFolderResponse deleteFolder(DeleteFolderRequest deleteFolderRequest) throws EntityNotExistsException, ProhibitedStateException, ConcurrentModificationException, UnauthorizedOperationException, UnauthorizedResourceAccessException, FailedDependencyException, ServiceUnavailableException, SdkServiceException, 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkDocsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceExceptiondefault DeleteFolderResponse deleteFolder(Consumer<DeleteFolderRequest.Builder> deleteFolderRequest) throws EntityNotExistsException, ProhibitedStateException, ConcurrentModificationException, UnauthorizedOperationException, UnauthorizedResourceAccessException, FailedDependencyException, ServiceUnavailableException, SdkServiceException, 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkDocsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceExceptiondefault DeleteFolderContentsResponse deleteFolderContents(DeleteFolderContentsRequest deleteFolderContentsRequest) throws EntityNotExistsException, UnauthorizedOperationException, UnauthorizedResourceAccessException, FailedDependencyException, ServiceUnavailableException, SdkServiceException, 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkDocsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceExceptiondefault DeleteFolderContentsResponse deleteFolderContents(Consumer<DeleteFolderContentsRequest.Builder> deleteFolderContentsRequest) throws EntityNotExistsException, UnauthorizedOperationException, UnauthorizedResourceAccessException, FailedDependencyException, ServiceUnavailableException, SdkServiceException, 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkDocsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceExceptiondefault DeleteLabelsResponse deleteLabels(DeleteLabelsRequest deleteLabelsRequest) throws EntityNotExistsException, UnauthorizedOperationException, UnauthorizedResourceAccessException, FailedDependencyException, ServiceUnavailableException, SdkServiceException, 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkDocsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceExceptiondefault DeleteLabelsResponse deleteLabels(Consumer<DeleteLabelsRequest.Builder> deleteLabelsRequest) throws EntityNotExistsException, UnauthorizedOperationException, UnauthorizedResourceAccessException, FailedDependencyException, ServiceUnavailableException, SdkServiceException, 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkDocsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceExceptiondefault DeleteNotificationSubscriptionResponse deleteNotificationSubscription(DeleteNotificationSubscriptionRequest deleteNotificationSubscriptionRequest) throws UnauthorizedResourceAccessException, EntityNotExistsException, ServiceUnavailableException, ProhibitedStateException, SdkServiceException, 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkDocsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceExceptiondefault DeleteNotificationSubscriptionResponse deleteNotificationSubscription(Consumer<DeleteNotificationSubscriptionRequest.Builder> deleteNotificationSubscriptionRequest) throws UnauthorizedResourceAccessException, EntityNotExistsException, ServiceUnavailableException, ProhibitedStateException, SdkServiceException, 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkDocsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceExceptiondefault DeleteUserResponse deleteUser(DeleteUserRequest deleteUserRequest) throws EntityNotExistsException, UnauthorizedOperationException, UnauthorizedResourceAccessException, FailedDependencyException, ServiceUnavailableException, SdkServiceException, 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkDocsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceExceptiondefault DeleteUserResponse deleteUser(Consumer<DeleteUserRequest.Builder> deleteUserRequest) throws EntityNotExistsException, UnauthorizedOperationException, UnauthorizedResourceAccessException, FailedDependencyException, ServiceUnavailableException, SdkServiceException, 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkDocsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceExceptiondefault DescribeActivitiesResponse describeActivities(DescribeActivitiesRequest describeActivitiesRequest) throws UnauthorizedOperationException, UnauthorizedResourceAccessException, InvalidArgumentException, FailedDependencyException, ServiceUnavailableException, SdkServiceException, 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 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkDocsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceExceptiondefault DescribeActivitiesResponse describeActivities(Consumer<DescribeActivitiesRequest.Builder> describeActivitiesRequest) throws UnauthorizedOperationException, UnauthorizedResourceAccessException, InvalidArgumentException, FailedDependencyException, ServiceUnavailableException, SdkServiceException, 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 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkDocsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceExceptiondefault DescribeCommentsResponse describeComments(DescribeCommentsRequest describeCommentsRequest) throws EntityNotExistsException, ProhibitedStateException, UnauthorizedOperationException, UnauthorizedResourceAccessException, FailedDependencyException, ServiceUnavailableException, SdkServiceException, 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkDocsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceExceptiondefault DescribeCommentsResponse describeComments(Consumer<DescribeCommentsRequest.Builder> describeCommentsRequest) throws EntityNotExistsException, ProhibitedStateException, UnauthorizedOperationException, UnauthorizedResourceAccessException, FailedDependencyException, ServiceUnavailableException, SdkServiceException, 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkDocsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceExceptiondefault DescribeDocumentVersionsResponse describeDocumentVersions(DescribeDocumentVersionsRequest describeDocumentVersionsRequest) throws EntityNotExistsException, UnauthorizedOperationException, UnauthorizedResourceAccessException, InvalidArgumentException, FailedDependencyException, ServiceUnavailableException, ProhibitedStateException, SdkServiceException, 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 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkDocsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceExceptiondefault DescribeDocumentVersionsResponse describeDocumentVersions(Consumer<DescribeDocumentVersionsRequest.Builder> describeDocumentVersionsRequest) throws EntityNotExistsException, UnauthorizedOperationException, UnauthorizedResourceAccessException, InvalidArgumentException, FailedDependencyException, ServiceUnavailableException, ProhibitedStateException, SdkServiceException, 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 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkDocsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceExceptiondefault DescribeDocumentVersionsIterable describeDocumentVersionsPaginator(DescribeDocumentVersionsRequest describeDocumentVersionsRequest) throws EntityNotExistsException, UnauthorizedOperationException, UnauthorizedResourceAccessException, InvalidArgumentException, FailedDependencyException, ServiceUnavailableException, ProhibitedStateException, SdkServiceException, SdkClientException, WorkDocsException
Retrieves the document versions for the specified document.
By default, only active versions are returned.
This is a variant of
describeDocumentVersions(software.amazon.awssdk.services.workdocs.model.DescribeDocumentVersionsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.workdocs.paginators.DescribeDocumentVersionsIterable responses = client.describeDocumentVersionsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.workdocs.paginators.DescribeDocumentVersionsIterable responses = client
.describeDocumentVersionsPaginator(request);
for (software.amazon.awssdk.services.workdocs.model.DescribeDocumentVersionsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.workdocs.paginators.DescribeDocumentVersionsIterable responses = client.describeDocumentVersionsPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
describeDocumentVersions(software.amazon.awssdk.services.workdocs.model.DescribeDocumentVersionsRequest)
operation.
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 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkDocsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceExceptiondefault DescribeFolderContentsResponse describeFolderContents(DescribeFolderContentsRequest describeFolderContentsRequest) throws EntityNotExistsException, UnauthorizedResourceAccessException, InvalidArgumentException, FailedDependencyException, ServiceUnavailableException, ProhibitedStateException, SdkServiceException, 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 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkDocsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceExceptiondefault DescribeFolderContentsResponse describeFolderContents(Consumer<DescribeFolderContentsRequest.Builder> describeFolderContentsRequest) throws EntityNotExistsException, UnauthorizedResourceAccessException, InvalidArgumentException, FailedDependencyException, ServiceUnavailableException, ProhibitedStateException, SdkServiceException, 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 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkDocsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceExceptiondefault DescribeFolderContentsIterable describeFolderContentsPaginator(DescribeFolderContentsRequest describeFolderContentsRequest) throws EntityNotExistsException, UnauthorizedResourceAccessException, InvalidArgumentException, FailedDependencyException, ServiceUnavailableException, ProhibitedStateException, SdkServiceException, 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.
This is a variant of
describeFolderContents(software.amazon.awssdk.services.workdocs.model.DescribeFolderContentsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.workdocs.paginators.DescribeFolderContentsIterable responses = client.describeFolderContentsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.workdocs.paginators.DescribeFolderContentsIterable responses = client
.describeFolderContentsPaginator(request);
for (software.amazon.awssdk.services.workdocs.model.DescribeFolderContentsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.workdocs.paginators.DescribeFolderContentsIterable responses = client.describeFolderContentsPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
describeFolderContents(software.amazon.awssdk.services.workdocs.model.DescribeFolderContentsRequest)
operation.
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 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkDocsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceExceptiondefault DescribeGroupsResponse describeGroups(DescribeGroupsRequest describeGroupsRequest) throws UnauthorizedOperationException, UnauthorizedResourceAccessException, FailedDependencyException, ServiceUnavailableException, SdkServiceException, SdkClientException, WorkDocsException
Describes the groups specified by query.
describeGroupsRequest - 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkDocsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceExceptiondefault DescribeGroupsResponse describeGroups(Consumer<DescribeGroupsRequest.Builder> describeGroupsRequest) throws UnauthorizedOperationException, UnauthorizedResourceAccessException, FailedDependencyException, ServiceUnavailableException, SdkServiceException, SdkClientException, WorkDocsException
Describes the groups specified by query.
describeGroupsRequest - 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkDocsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceExceptiondefault DescribeNotificationSubscriptionsResponse describeNotificationSubscriptions(DescribeNotificationSubscriptionsRequest describeNotificationSubscriptionsRequest) throws UnauthorizedResourceAccessException, EntityNotExistsException, ServiceUnavailableException, SdkServiceException, 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkDocsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceExceptiondefault DescribeNotificationSubscriptionsResponse describeNotificationSubscriptions(Consumer<DescribeNotificationSubscriptionsRequest.Builder> describeNotificationSubscriptionsRequest) throws UnauthorizedResourceAccessException, EntityNotExistsException, ServiceUnavailableException, SdkServiceException, 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkDocsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceExceptiondefault DescribeResourcePermissionsResponse describeResourcePermissions(DescribeResourcePermissionsRequest describeResourcePermissionsRequest) throws UnauthorizedOperationException, UnauthorizedResourceAccessException, FailedDependencyException, ServiceUnavailableException, SdkServiceException, 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkDocsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceExceptiondefault DescribeResourcePermissionsResponse describeResourcePermissions(Consumer<DescribeResourcePermissionsRequest.Builder> describeResourcePermissionsRequest) throws UnauthorizedOperationException, UnauthorizedResourceAccessException, FailedDependencyException, ServiceUnavailableException, SdkServiceException, 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkDocsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceExceptiondefault DescribeRootFoldersResponse describeRootFolders(DescribeRootFoldersRequest describeRootFoldersRequest) throws UnauthorizedOperationException, UnauthorizedResourceAccessException, InvalidArgumentException, FailedDependencyException, ServiceUnavailableException, SdkServiceException, SdkClientException, WorkDocsException
Describes the current user's special folders; the RootFolder and the RecycleBin.
RootFolder is the root of user's files and folders and RecycleBin is the root of
recycled items. This is not a valid action for SigV4 (administrative API) clients.
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 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkDocsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceExceptiondefault DescribeRootFoldersResponse describeRootFolders(Consumer<DescribeRootFoldersRequest.Builder> describeRootFoldersRequest) throws UnauthorizedOperationException, UnauthorizedResourceAccessException, InvalidArgumentException, FailedDependencyException, ServiceUnavailableException, SdkServiceException, SdkClientException, WorkDocsException
Describes the current user's special folders; the RootFolder and the RecycleBin.
RootFolder is the root of user's files and folders and RecycleBin is the root of
recycled items. This is not a valid action for SigV4 (administrative API) clients.
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 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkDocsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceExceptiondefault DescribeUsersResponse describeUsers(DescribeUsersRequest describeUsersRequest) throws UnauthorizedOperationException, UnauthorizedResourceAccessException, FailedDependencyException, ServiceUnavailableException, InvalidArgumentException, SdkServiceException, 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 or limit fields are not valid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkDocsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceExceptiondefault DescribeUsersResponse describeUsers(Consumer<DescribeUsersRequest.Builder> describeUsersRequest) throws UnauthorizedOperationException, UnauthorizedResourceAccessException, FailedDependencyException, ServiceUnavailableException, InvalidArgumentException, SdkServiceException, 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 or limit fields are not valid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkDocsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceExceptiondefault DescribeUsersIterable describeUsersPaginator(DescribeUsersRequest describeUsersRequest) throws UnauthorizedOperationException, UnauthorizedResourceAccessException, FailedDependencyException, ServiceUnavailableException, InvalidArgumentException, SdkServiceException, 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.
This is a variant of describeUsers(software.amazon.awssdk.services.workdocs.model.DescribeUsersRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.workdocs.paginators.DescribeUsersIterable responses = client.describeUsersPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.workdocs.paginators.DescribeUsersIterable responses = client.describeUsersPaginator(request);
for (software.amazon.awssdk.services.workdocs.model.DescribeUsersResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.workdocs.paginators.DescribeUsersIterable responses = client.describeUsersPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
describeUsers(software.amazon.awssdk.services.workdocs.model.DescribeUsersRequest) operation.
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 or limit fields are not valid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkDocsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceExceptiondefault GetCurrentUserResponse getCurrentUser(GetCurrentUserRequest getCurrentUserRequest) throws EntityNotExistsException, UnauthorizedOperationException, UnauthorizedResourceAccessException, FailedDependencyException, ServiceUnavailableException, SdkServiceException, 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkDocsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceExceptiondefault GetCurrentUserResponse getCurrentUser(Consumer<GetCurrentUserRequest.Builder> getCurrentUserRequest) throws EntityNotExistsException, UnauthorizedOperationException, UnauthorizedResourceAccessException, FailedDependencyException, ServiceUnavailableException, SdkServiceException, 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkDocsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceExceptiondefault GetDocumentResponse getDocument(GetDocumentRequest getDocumentRequest) throws EntityNotExistsException, UnauthorizedOperationException, UnauthorizedResourceAccessException, InvalidArgumentException, FailedDependencyException, ServiceUnavailableException, InvalidPasswordException, SdkServiceException, 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 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.InvalidPasswordException - The password is invalid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkDocsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceExceptiondefault GetDocumentResponse getDocument(Consumer<GetDocumentRequest.Builder> getDocumentRequest) throws EntityNotExistsException, UnauthorizedOperationException, UnauthorizedResourceAccessException, InvalidArgumentException, FailedDependencyException, ServiceUnavailableException, InvalidPasswordException, SdkServiceException, 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 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.InvalidPasswordException - The password is invalid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkDocsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceExceptiondefault GetDocumentPathResponse getDocumentPath(GetDocumentPathRequest getDocumentPathRequest) throws EntityNotExistsException, UnauthorizedOperationException, UnauthorizedResourceAccessException, FailedDependencyException, ServiceUnavailableException, SdkServiceException, 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkDocsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceExceptiondefault GetDocumentPathResponse getDocumentPath(Consumer<GetDocumentPathRequest.Builder> getDocumentPathRequest) throws EntityNotExistsException, UnauthorizedOperationException, UnauthorizedResourceAccessException, FailedDependencyException, ServiceUnavailableException, SdkServiceException, 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkDocsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceExceptiondefault GetDocumentVersionResponse getDocumentVersion(GetDocumentVersionRequest getDocumentVersionRequest) throws EntityNotExistsException, UnauthorizedOperationException, UnauthorizedResourceAccessException, FailedDependencyException, ServiceUnavailableException, ProhibitedStateException, InvalidPasswordException, SdkServiceException, 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.InvalidPasswordException - The password is invalid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkDocsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceExceptiondefault GetDocumentVersionResponse getDocumentVersion(Consumer<GetDocumentVersionRequest.Builder> getDocumentVersionRequest) throws EntityNotExistsException, UnauthorizedOperationException, UnauthorizedResourceAccessException, FailedDependencyException, ServiceUnavailableException, ProhibitedStateException, InvalidPasswordException, SdkServiceException, 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.InvalidPasswordException - The password is invalid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkDocsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceExceptiondefault GetFolderResponse getFolder(GetFolderRequest getFolderRequest) throws EntityNotExistsException, UnauthorizedOperationException, UnauthorizedResourceAccessException, InvalidArgumentException, FailedDependencyException, ServiceUnavailableException, ProhibitedStateException, SdkServiceException, 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 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkDocsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceExceptiondefault GetFolderResponse getFolder(Consumer<GetFolderRequest.Builder> getFolderRequest) throws EntityNotExistsException, UnauthorizedOperationException, UnauthorizedResourceAccessException, InvalidArgumentException, FailedDependencyException, ServiceUnavailableException, ProhibitedStateException, SdkServiceException, 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 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkDocsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceExceptiondefault GetFolderPathResponse getFolderPath(GetFolderPathRequest getFolderPathRequest) throws EntityNotExistsException, UnauthorizedOperationException, UnauthorizedResourceAccessException, FailedDependencyException, ServiceUnavailableException, SdkServiceException, 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkDocsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceExceptiondefault GetFolderPathResponse getFolderPath(Consumer<GetFolderPathRequest.Builder> getFolderPathRequest) throws EntityNotExistsException, UnauthorizedOperationException, UnauthorizedResourceAccessException, FailedDependencyException, ServiceUnavailableException, SdkServiceException, 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkDocsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceExceptiondefault InitiateDocumentVersionUploadResponse initiateDocumentVersionUpload(InitiateDocumentVersionUploadRequest initiateDocumentVersionUploadRequest) throws EntityNotExistsException, EntityAlreadyExistsException, StorageLimitExceededException, StorageLimitWillExceedException, ProhibitedStateException, UnauthorizedOperationException, UnauthorizedResourceAccessException, FailedDependencyException, ServiceUnavailableException, DraftUploadOutOfSyncException, ResourceAlreadyCheckedOutException, SdkServiceException, 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkDocsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceExceptiondefault InitiateDocumentVersionUploadResponse initiateDocumentVersionUpload(Consumer<InitiateDocumentVersionUploadRequest.Builder> initiateDocumentVersionUploadRequest) throws EntityNotExistsException, EntityAlreadyExistsException, StorageLimitExceededException, StorageLimitWillExceedException, ProhibitedStateException, UnauthorizedOperationException, UnauthorizedResourceAccessException, FailedDependencyException, ServiceUnavailableException, DraftUploadOutOfSyncException, ResourceAlreadyCheckedOutException, SdkServiceException, 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkDocsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceExceptiondefault RemoveAllResourcePermissionsResponse removeAllResourcePermissions(RemoveAllResourcePermissionsRequest removeAllResourcePermissionsRequest) throws UnauthorizedOperationException, UnauthorizedResourceAccessException, FailedDependencyException, ServiceUnavailableException, SdkServiceException, 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkDocsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceExceptiondefault RemoveAllResourcePermissionsResponse removeAllResourcePermissions(Consumer<RemoveAllResourcePermissionsRequest.Builder> removeAllResourcePermissionsRequest) throws UnauthorizedOperationException, UnauthorizedResourceAccessException, FailedDependencyException, ServiceUnavailableException, SdkServiceException, 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkDocsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceExceptiondefault RemoveResourcePermissionResponse removeResourcePermission(RemoveResourcePermissionRequest removeResourcePermissionRequest) throws UnauthorizedOperationException, UnauthorizedResourceAccessException, FailedDependencyException, ServiceUnavailableException, SdkServiceException, 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkDocsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceExceptiondefault RemoveResourcePermissionResponse removeResourcePermission(Consumer<RemoveResourcePermissionRequest.Builder> removeResourcePermissionRequest) throws UnauthorizedOperationException, UnauthorizedResourceAccessException, FailedDependencyException, ServiceUnavailableException, SdkServiceException, 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkDocsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceExceptiondefault UpdateDocumentResponse updateDocument(UpdateDocumentRequest updateDocumentRequest) throws EntityNotExistsException, EntityAlreadyExistsException, LimitExceededException, ProhibitedStateException, ConcurrentModificationException, UnauthorizedOperationException, UnauthorizedResourceAccessException, FailedDependencyException, ServiceUnavailableException, SdkServiceException, 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkDocsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceExceptiondefault UpdateDocumentResponse updateDocument(Consumer<UpdateDocumentRequest.Builder> updateDocumentRequest) throws EntityNotExistsException, EntityAlreadyExistsException, LimitExceededException, ProhibitedStateException, ConcurrentModificationException, UnauthorizedOperationException, UnauthorizedResourceAccessException, FailedDependencyException, ServiceUnavailableException, SdkServiceException, 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkDocsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceExceptiondefault UpdateDocumentVersionResponse updateDocumentVersion(UpdateDocumentVersionRequest updateDocumentVersionRequest) throws EntityNotExistsException, ProhibitedStateException, ConcurrentModificationException, InvalidOperationException, UnauthorizedOperationException, UnauthorizedResourceAccessException, FailedDependencyException, ServiceUnavailableException, SdkServiceException, 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkDocsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceExceptiondefault UpdateDocumentVersionResponse updateDocumentVersion(Consumer<UpdateDocumentVersionRequest.Builder> updateDocumentVersionRequest) throws EntityNotExistsException, ProhibitedStateException, ConcurrentModificationException, InvalidOperationException, UnauthorizedOperationException, UnauthorizedResourceAccessException, FailedDependencyException, ServiceUnavailableException, SdkServiceException, 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkDocsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceExceptiondefault UpdateFolderResponse updateFolder(UpdateFolderRequest updateFolderRequest) throws EntityNotExistsException, EntityAlreadyExistsException, ProhibitedStateException, ConcurrentModificationException, LimitExceededException, UnauthorizedOperationException, UnauthorizedResourceAccessException, FailedDependencyException, ServiceUnavailableException, SdkServiceException, 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkDocsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceExceptiondefault UpdateFolderResponse updateFolder(Consumer<UpdateFolderRequest.Builder> updateFolderRequest) throws EntityNotExistsException, EntityAlreadyExistsException, ProhibitedStateException, ConcurrentModificationException, LimitExceededException, UnauthorizedOperationException, UnauthorizedResourceAccessException, FailedDependencyException, ServiceUnavailableException, SdkServiceException, 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkDocsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceExceptiondefault UpdateUserResponse updateUser(UpdateUserRequest updateUserRequest) throws EntityNotExistsException, UnauthorizedOperationException, UnauthorizedResourceAccessException, IllegalUserStateException, FailedDependencyException, ServiceUnavailableException, DeactivatingLastSystemUserException, InvalidArgumentException, SdkServiceException, 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.InvalidArgumentException - The pagination marker or limit fields are not valid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkDocsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceExceptiondefault UpdateUserResponse updateUser(Consumer<UpdateUserRequest.Builder> updateUserRequest) throws EntityNotExistsException, UnauthorizedOperationException, UnauthorizedResourceAccessException, IllegalUserStateException, FailedDependencyException, ServiceUnavailableException, DeactivatingLastSystemUserException, InvalidArgumentException, SdkServiceException, 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.InvalidArgumentException - The pagination marker or limit fields are not valid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.WorkDocsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceExceptionstatic ServiceMetadata serviceMetadata()
Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.