| Package | Description |
|---|---|
| software.amazon.awssdk.services.workdocs |
The Amazon WorkDocs API is designed for the following use cases:
|
| Modifier and Type | Method and Description |
|---|---|
default AbortDocumentVersionUploadResponse |
WorkDocsClient.abortDocumentVersionUpload(AbortDocumentVersionUploadRequest abortDocumentVersionUploadRequest)
Aborts the upload of the specified document version that was previously initiated by
InitiateDocumentVersionUpload.
|
default AbortDocumentVersionUploadResponse |
WorkDocsClient.abortDocumentVersionUpload(Consumer<AbortDocumentVersionUploadRequest.Builder> abortDocumentVersionUploadRequest)
Aborts the upload of the specified document version that was previously initiated by
InitiateDocumentVersionUpload.
|
default ActivateUserResponse |
WorkDocsClient.activateUser(ActivateUserRequest activateUserRequest)
Activates the specified user.
|
default ActivateUserResponse |
WorkDocsClient.activateUser(Consumer<ActivateUserRequest.Builder> activateUserRequest)
Activates the specified user.
|
default AddResourcePermissionsResponse |
WorkDocsClient.addResourcePermissions(AddResourcePermissionsRequest addResourcePermissionsRequest)
Creates a set of permissions for the specified folder or document.
|
default AddResourcePermissionsResponse |
WorkDocsClient.addResourcePermissions(Consumer<AddResourcePermissionsRequest.Builder> addResourcePermissionsRequest)
Creates a set of permissions for the specified folder or document.
|
default CreateCommentResponse |
WorkDocsClient.createComment(Consumer<CreateCommentRequest.Builder> createCommentRequest)
Adds a new comment to the specified document version.
|
default CreateCommentResponse |
WorkDocsClient.createComment(CreateCommentRequest createCommentRequest)
Adds a new comment to the specified document version.
|
default CreateCustomMetadataResponse |
WorkDocsClient.createCustomMetadata(Consumer<CreateCustomMetadataRequest.Builder> createCustomMetadataRequest)
Adds one or more custom properties to the specified resource (a folder, document, or version).
|
default CreateCustomMetadataResponse |
WorkDocsClient.createCustomMetadata(CreateCustomMetadataRequest createCustomMetadataRequest)
Adds one or more custom properties to the specified resource (a folder, document, or version).
|
default CreateFolderResponse |
WorkDocsClient.createFolder(Consumer<CreateFolderRequest.Builder> createFolderRequest)
Creates a folder with the specified name and parent folder.
|
default CreateFolderResponse |
WorkDocsClient.createFolder(CreateFolderRequest createFolderRequest)
Creates a folder with the specified name and parent folder.
|
default CreateLabelsResponse |
WorkDocsClient.createLabels(Consumer<CreateLabelsRequest.Builder> createLabelsRequest)
Adds the specified list of labels to the given resource (a document or folder)
|
default CreateLabelsResponse |
WorkDocsClient.createLabels(CreateLabelsRequest createLabelsRequest)
Adds the specified list of labels to the given resource (a document or folder)
|
default CreateUserResponse |
WorkDocsClient.createUser(Consumer<CreateUserRequest.Builder> createUserRequest)
Creates a user in a Simple AD or Microsoft AD directory.
|
default CreateUserResponse |
WorkDocsClient.createUser(CreateUserRequest createUserRequest)
Creates a user in a Simple AD or Microsoft AD directory.
|
default DeactivateUserResponse |
WorkDocsClient.deactivateUser(Consumer<DeactivateUserRequest.Builder> deactivateUserRequest)
Deactivates the specified user, which revokes the user's access to Amazon WorkDocs.
|
default DeactivateUserResponse |
WorkDocsClient.deactivateUser(DeactivateUserRequest deactivateUserRequest)
Deactivates the specified user, which revokes the user's access to Amazon WorkDocs.
|
default DeleteCommentResponse |
WorkDocsClient.deleteComment(Consumer<DeleteCommentRequest.Builder> deleteCommentRequest)
Deletes the specified comment from the document version.
|
default DeleteCommentResponse |
WorkDocsClient.deleteComment(DeleteCommentRequest deleteCommentRequest)
Deletes the specified comment from the document version.
|
default DeleteCustomMetadataResponse |
WorkDocsClient.deleteCustomMetadata(Consumer<DeleteCustomMetadataRequest.Builder> deleteCustomMetadataRequest)
Deletes custom metadata from the specified resource.
|
default DeleteCustomMetadataResponse |
WorkDocsClient.deleteCustomMetadata(DeleteCustomMetadataRequest deleteCustomMetadataRequest)
Deletes custom metadata from the specified resource.
|
default DeleteDocumentResponse |
WorkDocsClient.deleteDocument(Consumer<DeleteDocumentRequest.Builder> deleteDocumentRequest)
Permanently deletes the specified document and its associated metadata.
|
default DeleteDocumentResponse |
WorkDocsClient.deleteDocument(DeleteDocumentRequest deleteDocumentRequest)
Permanently deletes the specified document and its associated metadata.
|
default DeleteDocumentVersionResponse |
WorkDocsClient.deleteDocumentVersion(Consumer<DeleteDocumentVersionRequest.Builder> deleteDocumentVersionRequest)
Deletes a specific version of a document.
|
default DeleteDocumentVersionResponse |
WorkDocsClient.deleteDocumentVersion(DeleteDocumentVersionRequest deleteDocumentVersionRequest)
Deletes a specific version of a document.
|
default DeleteFolderResponse |
WorkDocsClient.deleteFolder(Consumer<DeleteFolderRequest.Builder> deleteFolderRequest)
Permanently deletes the specified folder and its contents.
|
default DeleteFolderResponse |
WorkDocsClient.deleteFolder(DeleteFolderRequest deleteFolderRequest)
Permanently deletes the specified folder and its contents.
|
default DeleteFolderContentsResponse |
WorkDocsClient.deleteFolderContents(Consumer<DeleteFolderContentsRequest.Builder> deleteFolderContentsRequest)
Deletes the contents of the specified folder.
|
default DeleteFolderContentsResponse |
WorkDocsClient.deleteFolderContents(DeleteFolderContentsRequest deleteFolderContentsRequest)
Deletes the contents of the specified folder.
|
default DeleteLabelsResponse |
WorkDocsClient.deleteLabels(Consumer<DeleteLabelsRequest.Builder> deleteLabelsRequest)
Deletes the specified list of labels from a resource.
|
default DeleteLabelsResponse |
WorkDocsClient.deleteLabels(DeleteLabelsRequest deleteLabelsRequest)
Deletes the specified list of labels from a resource.
|
default DeleteUserResponse |
WorkDocsClient.deleteUser(Consumer<DeleteUserRequest.Builder> deleteUserRequest)
Deletes the specified user from a Simple AD or Microsoft AD directory.
|
default DeleteUserResponse |
WorkDocsClient.deleteUser(DeleteUserRequest deleteUserRequest)
Deletes the specified user from a Simple AD or Microsoft AD directory.
|
default DescribeActivitiesResponse |
WorkDocsClient.describeActivities(Consumer<DescribeActivitiesRequest.Builder> describeActivitiesRequest)
Describes the user activities in a specified time period.
|
default DescribeActivitiesResponse |
WorkDocsClient.describeActivities(DescribeActivitiesRequest describeActivitiesRequest)
Describes the user activities in a specified time period.
|
default DescribeActivitiesIterable |
WorkDocsClient.describeActivitiesPaginator(Consumer<DescribeActivitiesRequest.Builder> describeActivitiesRequest)
Describes the user activities in a specified time period.
|
default DescribeActivitiesIterable |
WorkDocsClient.describeActivitiesPaginator(DescribeActivitiesRequest describeActivitiesRequest)
Describes the user activities in a specified time period.
|
default DescribeCommentsResponse |
WorkDocsClient.describeComments(Consumer<DescribeCommentsRequest.Builder> describeCommentsRequest)
List all the comments for the specified document version.
|
default DescribeCommentsResponse |
WorkDocsClient.describeComments(DescribeCommentsRequest describeCommentsRequest)
List all the comments for the specified document version.
|
default DescribeCommentsIterable |
WorkDocsClient.describeCommentsPaginator(Consumer<DescribeCommentsRequest.Builder> describeCommentsRequest)
List all the comments for the specified document version.
|
default DescribeCommentsIterable |
WorkDocsClient.describeCommentsPaginator(DescribeCommentsRequest describeCommentsRequest)
List all the comments for the specified document version.
|
default DescribeDocumentVersionsResponse |
WorkDocsClient.describeDocumentVersions(Consumer<DescribeDocumentVersionsRequest.Builder> describeDocumentVersionsRequest)
Retrieves the document versions for the specified document.
|
default DescribeDocumentVersionsResponse |
WorkDocsClient.describeDocumentVersions(DescribeDocumentVersionsRequest describeDocumentVersionsRequest)
Retrieves the document versions for the specified document.
|
default DescribeDocumentVersionsIterable |
WorkDocsClient.describeDocumentVersionsPaginator(Consumer<DescribeDocumentVersionsRequest.Builder> describeDocumentVersionsRequest)
Retrieves the document versions for the specified document.
|
default DescribeDocumentVersionsIterable |
WorkDocsClient.describeDocumentVersionsPaginator(DescribeDocumentVersionsRequest describeDocumentVersionsRequest)
Retrieves the document versions for the specified document.
|
default DescribeGroupsResponse |
WorkDocsClient.describeGroups(Consumer<DescribeGroupsRequest.Builder> describeGroupsRequest)
Describes the groups specified by the query.
|
default DescribeGroupsResponse |
WorkDocsClient.describeGroups(DescribeGroupsRequest describeGroupsRequest)
Describes the groups specified by the query.
|
default DescribeGroupsIterable |
WorkDocsClient.describeGroupsPaginator(Consumer<DescribeGroupsRequest.Builder> describeGroupsRequest)
Describes the groups specified by the query.
|
default DescribeGroupsIterable |
WorkDocsClient.describeGroupsPaginator(DescribeGroupsRequest describeGroupsRequest)
Describes the groups specified by the query.
|
default DescribeResourcePermissionsResponse |
WorkDocsClient.describeResourcePermissions(Consumer<DescribeResourcePermissionsRequest.Builder> describeResourcePermissionsRequest)
Describes the permissions of a specified resource.
|
default DescribeResourcePermissionsResponse |
WorkDocsClient.describeResourcePermissions(DescribeResourcePermissionsRequest describeResourcePermissionsRequest)
Describes the permissions of a specified resource.
|
default DescribeResourcePermissionsIterable |
WorkDocsClient.describeResourcePermissionsPaginator(Consumer<DescribeResourcePermissionsRequest.Builder> describeResourcePermissionsRequest)
Describes the permissions of a specified resource.
|
default DescribeResourcePermissionsIterable |
WorkDocsClient.describeResourcePermissionsPaginator(DescribeResourcePermissionsRequest describeResourcePermissionsRequest)
Describes the permissions of a specified resource.
|
default DescribeRootFoldersResponse |
WorkDocsClient.describeRootFolders(Consumer<DescribeRootFoldersRequest.Builder> describeRootFoldersRequest)
Describes the current user's special folders; the
RootFolder and the RecycleBin. |
default DescribeRootFoldersResponse |
WorkDocsClient.describeRootFolders(DescribeRootFoldersRequest describeRootFoldersRequest)
Describes the current user's special folders; the
RootFolder and the RecycleBin. |
default DescribeRootFoldersIterable |
WorkDocsClient.describeRootFoldersPaginator(Consumer<DescribeRootFoldersRequest.Builder> describeRootFoldersRequest)
Describes the current user's special folders; the
RootFolder and the RecycleBin. |
default DescribeRootFoldersIterable |
WorkDocsClient.describeRootFoldersPaginator(DescribeRootFoldersRequest describeRootFoldersRequest)
Describes the current user's special folders; the
RootFolder and the RecycleBin. |
default DescribeUsersResponse |
WorkDocsClient.describeUsers(Consumer<DescribeUsersRequest.Builder> describeUsersRequest)
Describes the specified users.
|
default DescribeUsersResponse |
WorkDocsClient.describeUsers(DescribeUsersRequest describeUsersRequest)
Describes the specified users.
|
default DescribeUsersIterable |
WorkDocsClient.describeUsersPaginator(Consumer<DescribeUsersRequest.Builder> describeUsersRequest)
Describes the specified users.
|
default DescribeUsersIterable |
WorkDocsClient.describeUsersPaginator(DescribeUsersRequest describeUsersRequest)
Describes the specified users.
|
default GetCurrentUserResponse |
WorkDocsClient.getCurrentUser(Consumer<GetCurrentUserRequest.Builder> getCurrentUserRequest)
Retrieves details of the current user for whom the authentication token was generated.
|
default GetCurrentUserResponse |
WorkDocsClient.getCurrentUser(GetCurrentUserRequest getCurrentUserRequest)
Retrieves details of the current user for whom the authentication token was generated.
|
default GetDocumentResponse |
WorkDocsClient.getDocument(Consumer<GetDocumentRequest.Builder> getDocumentRequest)
Retrieves details of a document.
|
default GetDocumentResponse |
WorkDocsClient.getDocument(GetDocumentRequest getDocumentRequest)
Retrieves details of a document.
|
default GetDocumentPathResponse |
WorkDocsClient.getDocumentPath(Consumer<GetDocumentPathRequest.Builder> getDocumentPathRequest)
Retrieves the path information (the hierarchy from the root folder) for the requested document.
|
default GetDocumentPathResponse |
WorkDocsClient.getDocumentPath(GetDocumentPathRequest getDocumentPathRequest)
Retrieves the path information (the hierarchy from the root folder) for the requested document.
|
default GetDocumentVersionResponse |
WorkDocsClient.getDocumentVersion(Consumer<GetDocumentVersionRequest.Builder> getDocumentVersionRequest)
Retrieves version metadata for the specified document.
|
default GetDocumentVersionResponse |
WorkDocsClient.getDocumentVersion(GetDocumentVersionRequest getDocumentVersionRequest)
Retrieves version metadata for the specified document.
|
default GetFolderResponse |
WorkDocsClient.getFolder(Consumer<GetFolderRequest.Builder> getFolderRequest)
Retrieves the metadata of the specified folder.
|
default GetFolderResponse |
WorkDocsClient.getFolder(GetFolderRequest getFolderRequest)
Retrieves the metadata of the specified folder.
|
default GetFolderPathResponse |
WorkDocsClient.getFolderPath(Consumer<GetFolderPathRequest.Builder> getFolderPathRequest)
Retrieves the path information (the hierarchy from the root folder) for the specified folder.
|
default GetFolderPathResponse |
WorkDocsClient.getFolderPath(GetFolderPathRequest getFolderPathRequest)
Retrieves the path information (the hierarchy from the root folder) for the specified folder.
|
default GetResourcesResponse |
WorkDocsClient.getResources(Consumer<GetResourcesRequest.Builder> getResourcesRequest)
Retrieves a collection of resources, including folders and documents.
|
default GetResourcesResponse |
WorkDocsClient.getResources(GetResourcesRequest getResourcesRequest)
Retrieves a collection of resources, including folders and documents.
|
default InitiateDocumentVersionUploadResponse |
WorkDocsClient.initiateDocumentVersionUpload(Consumer<InitiateDocumentVersionUploadRequest.Builder> initiateDocumentVersionUploadRequest)
Creates a new document object and version object.
|
default InitiateDocumentVersionUploadResponse |
WorkDocsClient.initiateDocumentVersionUpload(InitiateDocumentVersionUploadRequest initiateDocumentVersionUploadRequest)
Creates a new document object and version object.
|
default RemoveAllResourcePermissionsResponse |
WorkDocsClient.removeAllResourcePermissions(Consumer<RemoveAllResourcePermissionsRequest.Builder> removeAllResourcePermissionsRequest)
Removes all the permissions from the specified resource.
|
default RemoveAllResourcePermissionsResponse |
WorkDocsClient.removeAllResourcePermissions(RemoveAllResourcePermissionsRequest removeAllResourcePermissionsRequest)
Removes all the permissions from the specified resource.
|
default RemoveResourcePermissionResponse |
WorkDocsClient.removeResourcePermission(Consumer<RemoveResourcePermissionRequest.Builder> removeResourcePermissionRequest)
Removes the permission for the specified principal from the specified resource.
|
default RemoveResourcePermissionResponse |
WorkDocsClient.removeResourcePermission(RemoveResourcePermissionRequest removeResourcePermissionRequest)
Removes the permission for the specified principal from the specified resource.
|
default RestoreDocumentVersionsResponse |
WorkDocsClient.restoreDocumentVersions(Consumer<RestoreDocumentVersionsRequest.Builder> restoreDocumentVersionsRequest)
Recovers a deleted version of an Amazon WorkDocs document.
|
default RestoreDocumentVersionsResponse |
WorkDocsClient.restoreDocumentVersions(RestoreDocumentVersionsRequest restoreDocumentVersionsRequest)
Recovers a deleted version of an Amazon WorkDocs document.
|
default SearchResourcesResponse |
WorkDocsClient.searchResources(Consumer<SearchResourcesRequest.Builder> searchResourcesRequest)
Searches metadata and the content of folders, documents, document versions, and comments.
|
default SearchResourcesResponse |
WorkDocsClient.searchResources(SearchResourcesRequest searchResourcesRequest)
Searches metadata and the content of folders, documents, document versions, and comments.
|
default SearchResourcesIterable |
WorkDocsClient.searchResourcesPaginator(Consumer<SearchResourcesRequest.Builder> searchResourcesRequest)
Searches metadata and the content of folders, documents, document versions, and comments.
|
default SearchResourcesIterable |
WorkDocsClient.searchResourcesPaginator(SearchResourcesRequest searchResourcesRequest)
Searches metadata and the content of folders, documents, document versions, and comments.
|
default UpdateDocumentResponse |
WorkDocsClient.updateDocument(Consumer<UpdateDocumentRequest.Builder> updateDocumentRequest)
Updates the specified attributes of a document.
|
default UpdateDocumentResponse |
WorkDocsClient.updateDocument(UpdateDocumentRequest updateDocumentRequest)
Updates the specified attributes of a document.
|
default UpdateDocumentVersionResponse |
WorkDocsClient.updateDocumentVersion(Consumer<UpdateDocumentVersionRequest.Builder> updateDocumentVersionRequest)
Changes the status of the document version to ACTIVE.
|
default UpdateDocumentVersionResponse |
WorkDocsClient.updateDocumentVersion(UpdateDocumentVersionRequest updateDocumentVersionRequest)
Changes the status of the document version to ACTIVE.
|
default UpdateFolderResponse |
WorkDocsClient.updateFolder(Consumer<UpdateFolderRequest.Builder> updateFolderRequest)
Updates the specified attributes of the specified folder.
|
default UpdateFolderResponse |
WorkDocsClient.updateFolder(UpdateFolderRequest updateFolderRequest)
Updates the specified attributes of the specified folder.
|
default UpdateUserResponse |
WorkDocsClient.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 |
WorkDocsClient.updateUser(UpdateUserRequest updateUserRequest)
Updates the specified attributes of the specified user, and grants or revokes administrative privileges to the
Amazon WorkDocs site.
|
Copyright © 2023. All rights reserved.