@Generated(value="software.amazon.awssdk:codegen") public interface WorkDocsAsyncClient extends SdkClient
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 CompletableFuture<AbortDocumentVersionUploadResponse> |
abortDocumentVersionUpload(AbortDocumentVersionUploadRequest abortDocumentVersionUploadRequest)
Aborts the upload of the specified document version that was previously initiated by
InitiateDocumentVersionUpload.
|
default CompletableFuture<AbortDocumentVersionUploadResponse> |
abortDocumentVersionUpload(Consumer<AbortDocumentVersionUploadRequest.Builder> abortDocumentVersionUploadRequest)
Aborts the upload of the specified document version that was previously initiated by
InitiateDocumentVersionUpload.
|
default CompletableFuture<ActivateUserResponse> |
activateUser(ActivateUserRequest activateUserRequest)
Activates the specified user.
|
default CompletableFuture<ActivateUserResponse> |
activateUser(Consumer<ActivateUserRequest.Builder> activateUserRequest)
Activates the specified user.
|
default CompletableFuture<AddResourcePermissionsResponse> |
addResourcePermissions(AddResourcePermissionsRequest addResourcePermissionsRequest)
Creates a set of permissions for the specified folder or document.
|
default CompletableFuture<AddResourcePermissionsResponse> |
addResourcePermissions(Consumer<AddResourcePermissionsRequest.Builder> addResourcePermissionsRequest)
Creates a set of permissions for the specified folder or document.
|
static WorkDocsAsyncClientBuilder |
builder()
Create a builder that can be used to configure and create a
WorkDocsAsyncClient . |
static WorkDocsAsyncClient |
create()
Create a
WorkDocsAsyncClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider . |
default CompletableFuture<CreateCommentResponse> |
createComment(Consumer<CreateCommentRequest.Builder> createCommentRequest)
Adds a new comment to the specified document version.
|
default CompletableFuture<CreateCommentResponse> |
createComment(CreateCommentRequest createCommentRequest)
Adds a new comment to the specified document version.
|
default CompletableFuture<CreateCustomMetadataResponse> |
createCustomMetadata(Consumer<CreateCustomMetadataRequest.Builder> createCustomMetadataRequest)
Adds one or more custom properties to the specified resource (a folder, document, or version).
|
default CompletableFuture<CreateCustomMetadataResponse> |
createCustomMetadata(CreateCustomMetadataRequest createCustomMetadataRequest)
Adds one or more custom properties to the specified resource (a folder, document, or version).
|
default CompletableFuture<CreateFolderResponse> |
createFolder(Consumer<CreateFolderRequest.Builder> createFolderRequest)
Creates a folder with the specified name and parent folder.
|
default CompletableFuture<CreateFolderResponse> |
createFolder(CreateFolderRequest createFolderRequest)
Creates a folder with the specified name and parent folder.
|
default CompletableFuture<CreateLabelsResponse> |
createLabels(Consumer<CreateLabelsRequest.Builder> createLabelsRequest)
Adds the specified list of labels to the given resource (a document or folder)
|
default CompletableFuture<CreateLabelsResponse> |
createLabels(CreateLabelsRequest createLabelsRequest)
Adds the specified list of labels to the given resource (a document or folder)
|
default CompletableFuture<CreateNotificationSubscriptionResponse> |
createNotificationSubscription(Consumer<CreateNotificationSubscriptionRequest.Builder> createNotificationSubscriptionRequest)
Configure WorkDocs to use Amazon SNS notifications.
|
default CompletableFuture<CreateNotificationSubscriptionResponse> |
createNotificationSubscription(CreateNotificationSubscriptionRequest createNotificationSubscriptionRequest)
Configure WorkDocs to use Amazon SNS notifications.
|
default CompletableFuture<CreateUserResponse> |
createUser(Consumer<CreateUserRequest.Builder> createUserRequest)
Creates a user in a Simple AD or Microsoft AD directory.
|
default CompletableFuture<CreateUserResponse> |
createUser(CreateUserRequest createUserRequest)
Creates a user in a Simple AD or Microsoft AD directory.
|
default CompletableFuture<DeactivateUserResponse> |
deactivateUser(Consumer<DeactivateUserRequest.Builder> deactivateUserRequest)
Deactivates the specified user, which revokes the user's access to Amazon WorkDocs.
|
default CompletableFuture<DeactivateUserResponse> |
deactivateUser(DeactivateUserRequest deactivateUserRequest)
Deactivates the specified user, which revokes the user's access to Amazon WorkDocs.
|
default CompletableFuture<DeleteCommentResponse> |
deleteComment(Consumer<DeleteCommentRequest.Builder> deleteCommentRequest)
Deletes the specified comment from the document version.
|
default CompletableFuture<DeleteCommentResponse> |
deleteComment(DeleteCommentRequest deleteCommentRequest)
Deletes the specified comment from the document version.
|
default CompletableFuture<DeleteCustomMetadataResponse> |
deleteCustomMetadata(Consumer<DeleteCustomMetadataRequest.Builder> deleteCustomMetadataRequest)
Deletes custom metadata from the specified resource.
|
default CompletableFuture<DeleteCustomMetadataResponse> |
deleteCustomMetadata(DeleteCustomMetadataRequest deleteCustomMetadataRequest)
Deletes custom metadata from the specified resource.
|
default CompletableFuture<DeleteDocumentResponse> |
deleteDocument(Consumer<DeleteDocumentRequest.Builder> deleteDocumentRequest)
Permanently deletes the specified document and its associated metadata.
|
default CompletableFuture<DeleteDocumentResponse> |
deleteDocument(DeleteDocumentRequest deleteDocumentRequest)
Permanently deletes the specified document and its associated metadata.
|
default CompletableFuture<DeleteFolderResponse> |
deleteFolder(Consumer<DeleteFolderRequest.Builder> deleteFolderRequest)
Permanently deletes the specified folder and its contents.
|
default CompletableFuture<DeleteFolderResponse> |
deleteFolder(DeleteFolderRequest deleteFolderRequest)
Permanently deletes the specified folder and its contents.
|
default CompletableFuture<DeleteFolderContentsResponse> |
deleteFolderContents(Consumer<DeleteFolderContentsRequest.Builder> deleteFolderContentsRequest)
Deletes the contents of the specified folder.
|
default CompletableFuture<DeleteFolderContentsResponse> |
deleteFolderContents(DeleteFolderContentsRequest deleteFolderContentsRequest)
Deletes the contents of the specified folder.
|
default CompletableFuture<DeleteLabelsResponse> |
deleteLabels(Consumer<DeleteLabelsRequest.Builder> deleteLabelsRequest)
Deletes the specified list of labels from a resource.
|
default CompletableFuture<DeleteLabelsResponse> |
deleteLabels(DeleteLabelsRequest deleteLabelsRequest)
Deletes the specified list of labels from a resource.
|
default CompletableFuture<DeleteNotificationSubscriptionResponse> |
deleteNotificationSubscription(Consumer<DeleteNotificationSubscriptionRequest.Builder> deleteNotificationSubscriptionRequest)
Deletes the specified subscription from the specified organization.
|
default CompletableFuture<DeleteNotificationSubscriptionResponse> |
deleteNotificationSubscription(DeleteNotificationSubscriptionRequest deleteNotificationSubscriptionRequest)
Deletes the specified subscription from the specified organization.
|
default CompletableFuture<DeleteUserResponse> |
deleteUser(Consumer<DeleteUserRequest.Builder> deleteUserRequest)
Deletes the specified user from a Simple AD or Microsoft AD directory.
|
default CompletableFuture<DeleteUserResponse> |
deleteUser(DeleteUserRequest deleteUserRequest)
Deletes the specified user from a Simple AD or Microsoft AD directory.
|
default CompletableFuture<DescribeActivitiesResponse> |
describeActivities(Consumer<DescribeActivitiesRequest.Builder> describeActivitiesRequest)
Describes the user activities in a specified time period.
|
default CompletableFuture<DescribeActivitiesResponse> |
describeActivities(DescribeActivitiesRequest describeActivitiesRequest)
Describes the user activities in a specified time period.
|
default CompletableFuture<DescribeCommentsResponse> |
describeComments(Consumer<DescribeCommentsRequest.Builder> describeCommentsRequest)
List all the comments for the specified document version.
|
default CompletableFuture<DescribeCommentsResponse> |
describeComments(DescribeCommentsRequest describeCommentsRequest)
List all the comments for the specified document version.
|
default CompletableFuture<DescribeDocumentVersionsResponse> |
describeDocumentVersions(Consumer<DescribeDocumentVersionsRequest.Builder> describeDocumentVersionsRequest)
Retrieves the document versions for the specified document.
|
default CompletableFuture<DescribeDocumentVersionsResponse> |
describeDocumentVersions(DescribeDocumentVersionsRequest describeDocumentVersionsRequest)
Retrieves the document versions for the specified document.
|
default DescribeDocumentVersionsPublisher |
describeDocumentVersionsPaginator(Consumer<DescribeDocumentVersionsRequest.Builder> describeDocumentVersionsRequest)
Retrieves the document versions for the specified document.
|
default DescribeDocumentVersionsPublisher |
describeDocumentVersionsPaginator(DescribeDocumentVersionsRequest describeDocumentVersionsRequest)
Retrieves the document versions for the specified document.
|
default CompletableFuture<DescribeFolderContentsResponse> |
describeFolderContents(Consumer<DescribeFolderContentsRequest.Builder> describeFolderContentsRequest)
Describes the contents of the specified folder, including its documents and subfolders.
|
default CompletableFuture<DescribeFolderContentsResponse> |
describeFolderContents(DescribeFolderContentsRequest describeFolderContentsRequest)
Describes the contents of the specified folder, including its documents and subfolders.
|
default DescribeFolderContentsPublisher |
describeFolderContentsPaginator(Consumer<DescribeFolderContentsRequest.Builder> describeFolderContentsRequest)
Describes the contents of the specified folder, including its documents and subfolders.
|
default DescribeFolderContentsPublisher |
describeFolderContentsPaginator(DescribeFolderContentsRequest describeFolderContentsRequest)
Describes the contents of the specified folder, including its documents and subfolders.
|
default CompletableFuture<DescribeGroupsResponse> |
describeGroups(Consumer<DescribeGroupsRequest.Builder> describeGroupsRequest)
Describes the groups specified by query.
|
default CompletableFuture<DescribeGroupsResponse> |
describeGroups(DescribeGroupsRequest describeGroupsRequest)
Describes the groups specified by query.
|
default CompletableFuture<DescribeNotificationSubscriptionsResponse> |
describeNotificationSubscriptions(Consumer<DescribeNotificationSubscriptionsRequest.Builder> describeNotificationSubscriptionsRequest)
Lists the specified notification subscriptions.
|
default CompletableFuture<DescribeNotificationSubscriptionsResponse> |
describeNotificationSubscriptions(DescribeNotificationSubscriptionsRequest describeNotificationSubscriptionsRequest)
Lists the specified notification subscriptions.
|
default CompletableFuture<DescribeResourcePermissionsResponse> |
describeResourcePermissions(Consumer<DescribeResourcePermissionsRequest.Builder> describeResourcePermissionsRequest)
Describes the permissions of a specified resource.
|
default CompletableFuture<DescribeResourcePermissionsResponse> |
describeResourcePermissions(DescribeResourcePermissionsRequest describeResourcePermissionsRequest)
Describes the permissions of a specified resource.
|
default CompletableFuture<DescribeRootFoldersResponse> |
describeRootFolders(Consumer<DescribeRootFoldersRequest.Builder> describeRootFoldersRequest)
Describes the current user's special folders; the
RootFolder and the RecycleBin . |
default CompletableFuture<DescribeRootFoldersResponse> |
describeRootFolders(DescribeRootFoldersRequest describeRootFoldersRequest)
Describes the current user's special folders; the
RootFolder and the RecycleBin . |
default CompletableFuture<DescribeUsersResponse> |
describeUsers(Consumer<DescribeUsersRequest.Builder> describeUsersRequest)
Describes the specified users.
|
default CompletableFuture<DescribeUsersResponse> |
describeUsers(DescribeUsersRequest describeUsersRequest)
Describes the specified users.
|
default DescribeUsersPublisher |
describeUsersPaginator(Consumer<DescribeUsersRequest.Builder> describeUsersRequest)
Describes the specified users.
|
default DescribeUsersPublisher |
describeUsersPaginator(DescribeUsersRequest describeUsersRequest)
Describes the specified users.
|
default CompletableFuture<GetCurrentUserResponse> |
getCurrentUser(Consumer<GetCurrentUserRequest.Builder> getCurrentUserRequest)
Retrieves details of the current user for whom the authentication token was generated.
|
default CompletableFuture<GetCurrentUserResponse> |
getCurrentUser(GetCurrentUserRequest getCurrentUserRequest)
Retrieves details of the current user for whom the authentication token was generated.
|
default CompletableFuture<GetDocumentResponse> |
getDocument(Consumer<GetDocumentRequest.Builder> getDocumentRequest)
Retrieves details of a document.
|
default CompletableFuture<GetDocumentResponse> |
getDocument(GetDocumentRequest getDocumentRequest)
Retrieves details of a document.
|
default CompletableFuture<GetDocumentPathResponse> |
getDocumentPath(Consumer<GetDocumentPathRequest.Builder> getDocumentPathRequest)
Retrieves the path information (the hierarchy from the root folder) for the requested document.
|
default CompletableFuture<GetDocumentPathResponse> |
getDocumentPath(GetDocumentPathRequest getDocumentPathRequest)
Retrieves the path information (the hierarchy from the root folder) for the requested document.
|
default CompletableFuture<GetDocumentVersionResponse> |
getDocumentVersion(Consumer<GetDocumentVersionRequest.Builder> getDocumentVersionRequest)
Retrieves version metadata for the specified document.
|
default CompletableFuture<GetDocumentVersionResponse> |
getDocumentVersion(GetDocumentVersionRequest getDocumentVersionRequest)
Retrieves version metadata for the specified document.
|
default CompletableFuture<GetFolderResponse> |
getFolder(Consumer<GetFolderRequest.Builder> getFolderRequest)
Retrieves the metadata of the specified folder.
|
default CompletableFuture<GetFolderResponse> |
getFolder(GetFolderRequest getFolderRequest)
Retrieves the metadata of the specified folder.
|
default CompletableFuture<GetFolderPathResponse> |
getFolderPath(Consumer<GetFolderPathRequest.Builder> getFolderPathRequest)
Retrieves the path information (the hierarchy from the root folder) for the specified folder.
|
default CompletableFuture<GetFolderPathResponse> |
getFolderPath(GetFolderPathRequest getFolderPathRequest)
Retrieves the path information (the hierarchy from the root folder) for the specified folder.
|
default CompletableFuture<InitiateDocumentVersionUploadResponse> |
initiateDocumentVersionUpload(Consumer<InitiateDocumentVersionUploadRequest.Builder> initiateDocumentVersionUploadRequest)
Creates a new document object and version object.
|
default CompletableFuture<InitiateDocumentVersionUploadResponse> |
initiateDocumentVersionUpload(InitiateDocumentVersionUploadRequest initiateDocumentVersionUploadRequest)
Creates a new document object and version object.
|
default CompletableFuture<RemoveAllResourcePermissionsResponse> |
removeAllResourcePermissions(Consumer<RemoveAllResourcePermissionsRequest.Builder> removeAllResourcePermissionsRequest)
Removes all the permissions from the specified resource.
|
default CompletableFuture<RemoveAllResourcePermissionsResponse> |
removeAllResourcePermissions(RemoveAllResourcePermissionsRequest removeAllResourcePermissionsRequest)
Removes all the permissions from the specified resource.
|
default CompletableFuture<RemoveResourcePermissionResponse> |
removeResourcePermission(Consumer<RemoveResourcePermissionRequest.Builder> removeResourcePermissionRequest)
Removes the permission for the specified principal from the specified resource.
|
default CompletableFuture<RemoveResourcePermissionResponse> |
removeResourcePermission(RemoveResourcePermissionRequest removeResourcePermissionRequest)
Removes the permission for the specified principal from the specified resource.
|
default CompletableFuture<UpdateDocumentResponse> |
updateDocument(Consumer<UpdateDocumentRequest.Builder> updateDocumentRequest)
Updates the specified attributes of a document.
|
default CompletableFuture<UpdateDocumentResponse> |
updateDocument(UpdateDocumentRequest updateDocumentRequest)
Updates the specified attributes of a document.
|
default CompletableFuture<UpdateDocumentVersionResponse> |
updateDocumentVersion(Consumer<UpdateDocumentVersionRequest.Builder> updateDocumentVersionRequest)
Changes the status of the document version to ACTIVE.
|
default CompletableFuture<UpdateDocumentVersionResponse> |
updateDocumentVersion(UpdateDocumentVersionRequest updateDocumentVersionRequest)
Changes the status of the document version to ACTIVE.
|
default CompletableFuture<UpdateFolderResponse> |
updateFolder(Consumer<UpdateFolderRequest.Builder> updateFolderRequest)
Updates the specified attributes of the specified folder.
|
default CompletableFuture<UpdateFolderResponse> |
updateFolder(UpdateFolderRequest updateFolderRequest)
Updates the specified attributes of the specified folder.
|
default CompletableFuture<UpdateUserResponse> |
updateUser(Consumer<UpdateUserRequest.Builder> updateUserRequest)
Updates the specified attributes of the specified user, and grants or revokes administrative privileges to the
Amazon WorkDocs site.
|
default CompletableFuture<UpdateUserResponse> |
updateUser(UpdateUserRequest updateUserRequest)
Updates the specified attributes of the specified user, and grants or revokes administrative privileges to the
Amazon WorkDocs site.
|
serviceName
close
static final String SERVICE_NAME
static WorkDocsAsyncClient create()
WorkDocsAsyncClient
with the region loaded from the
DefaultAwsRegionProviderChain
and credentials loaded from the
DefaultCredentialsProvider
.static WorkDocsAsyncClientBuilder builder()
WorkDocsAsyncClient
.default CompletableFuture<AbortDocumentVersionUploadResponse> abortDocumentVersionUpload(AbortDocumentVersionUploadRequest abortDocumentVersionUploadRequest)
Aborts the upload of the specified document version that was previously initiated by InitiateDocumentVersionUpload. The client should make this call only when it no longer intends to upload the document version, or fails to do so.
abortDocumentVersionUploadRequest
- default CompletableFuture<AbortDocumentVersionUploadResponse> abortDocumentVersionUpload(Consumer<AbortDocumentVersionUploadRequest.Builder> abortDocumentVersionUploadRequest)
Aborts the upload of the specified document version that was previously initiated by InitiateDocumentVersionUpload. The client should make this call only when it no longer intends to upload the document version, or fails to do so.
This is a convenience which creates an instance of the AbortDocumentVersionUploadRequest.Builder
avoiding
the need to create one manually via AbortDocumentVersionUploadRequest.builder()
abortDocumentVersionUploadRequest
- A Consumer
that will call methods on AbortDocumentVersionUploadRequest.Builder
to create a
request.default CompletableFuture<ActivateUserResponse> activateUser(ActivateUserRequest activateUserRequest)
Activates the specified user. Only active users can access Amazon WorkDocs.
activateUserRequest
- default CompletableFuture<ActivateUserResponse> activateUser(Consumer<ActivateUserRequest.Builder> activateUserRequest)
Activates the specified user. Only active users can access Amazon WorkDocs.
This is a convenience which creates an instance of the ActivateUserRequest.Builder
avoiding the need to
create one manually via ActivateUserRequest.builder()
activateUserRequest
- A Consumer
that will call methods on ActivateUserRequest.Builder
to create a request.default CompletableFuture<AddResourcePermissionsResponse> addResourcePermissions(AddResourcePermissionsRequest addResourcePermissionsRequest)
Creates a set of permissions for the specified folder or document. The resource permissions are overwritten if the principals already have different permissions.
addResourcePermissionsRequest
- default CompletableFuture<AddResourcePermissionsResponse> addResourcePermissions(Consumer<AddResourcePermissionsRequest.Builder> addResourcePermissionsRequest)
Creates a set of permissions for the specified folder or document. The resource permissions are overwritten if the principals already have different permissions.
This is a convenience which creates an instance of the AddResourcePermissionsRequest.Builder
avoiding the
need to create one manually via AddResourcePermissionsRequest.builder()
addResourcePermissionsRequest
- A Consumer
that will call methods on AddResourcePermissionsRequest.Builder
to create a
request.default CompletableFuture<CreateCommentResponse> createComment(CreateCommentRequest createCommentRequest)
Adds a new comment to the specified document version.
createCommentRequest
- default CompletableFuture<CreateCommentResponse> createComment(Consumer<CreateCommentRequest.Builder> createCommentRequest)
Adds a new comment to the specified document version.
This is a convenience which creates an instance of the CreateCommentRequest.Builder
avoiding the need to
create one manually via CreateCommentRequest.builder()
createCommentRequest
- A Consumer
that will call methods on CreateCommentRequest.Builder
to create a request.default CompletableFuture<CreateCustomMetadataResponse> createCustomMetadata(CreateCustomMetadataRequest createCustomMetadataRequest)
Adds one or more custom properties to the specified resource (a folder, document, or version).
createCustomMetadataRequest
- default CompletableFuture<CreateCustomMetadataResponse> createCustomMetadata(Consumer<CreateCustomMetadataRequest.Builder> createCustomMetadataRequest)
Adds one or more custom properties to the specified resource (a folder, document, or version).
This is a convenience which creates an instance of the CreateCustomMetadataRequest.Builder
avoiding the
need to create one manually via CreateCustomMetadataRequest.builder()
createCustomMetadataRequest
- A Consumer
that will call methods on CreateCustomMetadataRequest.Builder
to create a
request.default CompletableFuture<CreateFolderResponse> createFolder(CreateFolderRequest createFolderRequest)
Creates a folder with the specified name and parent folder.
createFolderRequest
- default CompletableFuture<CreateFolderResponse> createFolder(Consumer<CreateFolderRequest.Builder> createFolderRequest)
Creates a folder with the specified name and parent folder.
This is a convenience which creates an instance of the CreateFolderRequest.Builder
avoiding the need to
create one manually via CreateFolderRequest.builder()
createFolderRequest
- A Consumer
that will call methods on CreateFolderRequest.Builder
to create a request.default CompletableFuture<CreateLabelsResponse> createLabels(CreateLabelsRequest createLabelsRequest)
Adds the specified list of labels to the given resource (a document or folder)
createLabelsRequest
- default CompletableFuture<CreateLabelsResponse> createLabels(Consumer<CreateLabelsRequest.Builder> createLabelsRequest)
Adds the specified list of labels to the given resource (a document or folder)
This is a convenience which creates an instance of the CreateLabelsRequest.Builder
avoiding the need to
create one manually via CreateLabelsRequest.builder()
createLabelsRequest
- A Consumer
that will call methods on CreateLabelsRequest.Builder
to create a request.default CompletableFuture<CreateNotificationSubscriptionResponse> createNotificationSubscription(CreateNotificationSubscriptionRequest createNotificationSubscriptionRequest)
Configure WorkDocs to use Amazon SNS notifications.
The endpoint receives a confirmation message, and must confirm the subscription. For more information, see Confirm the Subscription in the Amazon Simple Notification Service Developer Guide.
createNotificationSubscriptionRequest
- default CompletableFuture<CreateNotificationSubscriptionResponse> createNotificationSubscription(Consumer<CreateNotificationSubscriptionRequest.Builder> createNotificationSubscriptionRequest)
Configure WorkDocs to use Amazon SNS notifications.
The endpoint receives a confirmation message, and must confirm the subscription. For more information, see Confirm the Subscription in the Amazon Simple Notification Service Developer Guide.
This is a convenience which creates an instance of the CreateNotificationSubscriptionRequest.Builder
avoiding the need to create one manually via CreateNotificationSubscriptionRequest.builder()
createNotificationSubscriptionRequest
- A Consumer
that will call methods on CreateNotificationSubscriptionRequest.Builder
to
create a request.default CompletableFuture<CreateUserResponse> createUser(CreateUserRequest createUserRequest)
Creates a user in a Simple AD or Microsoft AD directory. The status of a newly created user is "ACTIVE". New users can access Amazon WorkDocs.
createUserRequest
- default CompletableFuture<CreateUserResponse> createUser(Consumer<CreateUserRequest.Builder> createUserRequest)
Creates a user in a Simple AD or Microsoft AD directory. The status of a newly created user is "ACTIVE". New users can access Amazon WorkDocs.
This is a convenience which creates an instance of the CreateUserRequest.Builder
avoiding the need to
create one manually via CreateUserRequest.builder()
createUserRequest
- A Consumer
that will call methods on CreateUserRequest.Builder
to create a request.default CompletableFuture<DeactivateUserResponse> deactivateUser(DeactivateUserRequest deactivateUserRequest)
Deactivates the specified user, which revokes the user's access to Amazon WorkDocs.
deactivateUserRequest
- default CompletableFuture<DeactivateUserResponse> deactivateUser(Consumer<DeactivateUserRequest.Builder> deactivateUserRequest)
Deactivates the specified user, which revokes the user's access to Amazon WorkDocs.
This is a convenience which creates an instance of the DeactivateUserRequest.Builder
avoiding the need to
create one manually via DeactivateUserRequest.builder()
deactivateUserRequest
- A Consumer
that will call methods on DeactivateUserRequest.Builder
to create a request.default CompletableFuture<DeleteCommentResponse> deleteComment(DeleteCommentRequest deleteCommentRequest)
Deletes the specified comment from the document version.
deleteCommentRequest
- default CompletableFuture<DeleteCommentResponse> deleteComment(Consumer<DeleteCommentRequest.Builder> deleteCommentRequest)
Deletes the specified comment from the document version.
This is a convenience which creates an instance of the DeleteCommentRequest.Builder
avoiding the need to
create one manually via DeleteCommentRequest.builder()
deleteCommentRequest
- A Consumer
that will call methods on DeleteCommentRequest.Builder
to create a request.default CompletableFuture<DeleteCustomMetadataResponse> deleteCustomMetadata(DeleteCustomMetadataRequest deleteCustomMetadataRequest)
Deletes custom metadata from the specified resource.
deleteCustomMetadataRequest
- default CompletableFuture<DeleteCustomMetadataResponse> deleteCustomMetadata(Consumer<DeleteCustomMetadataRequest.Builder> deleteCustomMetadataRequest)
Deletes custom metadata from the specified resource.
This is a convenience which creates an instance of the DeleteCustomMetadataRequest.Builder
avoiding the
need to create one manually via DeleteCustomMetadataRequest.builder()
deleteCustomMetadataRequest
- A Consumer
that will call methods on DeleteCustomMetadataRequest.Builder
to create a
request.default CompletableFuture<DeleteDocumentResponse> deleteDocument(DeleteDocumentRequest deleteDocumentRequest)
Permanently deletes the specified document and its associated metadata.
deleteDocumentRequest
- default CompletableFuture<DeleteDocumentResponse> deleteDocument(Consumer<DeleteDocumentRequest.Builder> deleteDocumentRequest)
Permanently deletes the specified document and its associated metadata.
This is a convenience which creates an instance of the DeleteDocumentRequest.Builder
avoiding the need to
create one manually via DeleteDocumentRequest.builder()
deleteDocumentRequest
- A Consumer
that will call methods on DeleteDocumentRequest.Builder
to create a request.default CompletableFuture<DeleteFolderResponse> deleteFolder(DeleteFolderRequest deleteFolderRequest)
Permanently deletes the specified folder and its contents.
deleteFolderRequest
- default CompletableFuture<DeleteFolderResponse> deleteFolder(Consumer<DeleteFolderRequest.Builder> deleteFolderRequest)
Permanently deletes the specified folder and its contents.
This is a convenience which creates an instance of the DeleteFolderRequest.Builder
avoiding the need to
create one manually via DeleteFolderRequest.builder()
deleteFolderRequest
- A Consumer
that will call methods on DeleteFolderRequest.Builder
to create a request.default CompletableFuture<DeleteFolderContentsResponse> deleteFolderContents(DeleteFolderContentsRequest deleteFolderContentsRequest)
Deletes the contents of the specified folder.
deleteFolderContentsRequest
- default CompletableFuture<DeleteFolderContentsResponse> deleteFolderContents(Consumer<DeleteFolderContentsRequest.Builder> deleteFolderContentsRequest)
Deletes the contents of the specified folder.
This is a convenience which creates an instance of the DeleteFolderContentsRequest.Builder
avoiding the
need to create one manually via DeleteFolderContentsRequest.builder()
deleteFolderContentsRequest
- A Consumer
that will call methods on DeleteFolderContentsRequest.Builder
to create a
request.default CompletableFuture<DeleteLabelsResponse> deleteLabels(DeleteLabelsRequest deleteLabelsRequest)
Deletes the specified list of labels from a resource.
deleteLabelsRequest
- default CompletableFuture<DeleteLabelsResponse> deleteLabels(Consumer<DeleteLabelsRequest.Builder> deleteLabelsRequest)
Deletes the specified list of labels from a resource.
This is a convenience which creates an instance of the DeleteLabelsRequest.Builder
avoiding the need to
create one manually via DeleteLabelsRequest.builder()
deleteLabelsRequest
- A Consumer
that will call methods on DeleteLabelsRequest.Builder
to create a request.default CompletableFuture<DeleteNotificationSubscriptionResponse> deleteNotificationSubscription(DeleteNotificationSubscriptionRequest deleteNotificationSubscriptionRequest)
Deletes the specified subscription from the specified organization.
deleteNotificationSubscriptionRequest
- default CompletableFuture<DeleteNotificationSubscriptionResponse> deleteNotificationSubscription(Consumer<DeleteNotificationSubscriptionRequest.Builder> deleteNotificationSubscriptionRequest)
Deletes the specified subscription from the specified organization.
This is a convenience which creates an instance of the DeleteNotificationSubscriptionRequest.Builder
avoiding the need to create one manually via DeleteNotificationSubscriptionRequest.builder()
deleteNotificationSubscriptionRequest
- A Consumer
that will call methods on DeleteNotificationSubscriptionRequest.Builder
to
create a request.default CompletableFuture<DeleteUserResponse> deleteUser(DeleteUserRequest deleteUserRequest)
Deletes the specified user from a Simple AD or Microsoft AD directory.
deleteUserRequest
- default CompletableFuture<DeleteUserResponse> deleteUser(Consumer<DeleteUserRequest.Builder> deleteUserRequest)
Deletes the specified user from a Simple AD or Microsoft AD directory.
This is a convenience which creates an instance of the DeleteUserRequest.Builder
avoiding the need to
create one manually via DeleteUserRequest.builder()
deleteUserRequest
- A Consumer
that will call methods on DeleteUserRequest.Builder
to create a request.default CompletableFuture<DescribeActivitiesResponse> describeActivities(DescribeActivitiesRequest describeActivitiesRequest)
Describes the user activities in a specified time period.
describeActivitiesRequest
- default CompletableFuture<DescribeActivitiesResponse> describeActivities(Consumer<DescribeActivitiesRequest.Builder> describeActivitiesRequest)
Describes the user activities in a specified time period.
This is a convenience which creates an instance of the DescribeActivitiesRequest.Builder
avoiding the
need to create one manually via DescribeActivitiesRequest.builder()
describeActivitiesRequest
- A Consumer
that will call methods on DescribeActivitiesRequest.Builder
to create a
request.default CompletableFuture<DescribeCommentsResponse> describeComments(DescribeCommentsRequest describeCommentsRequest)
List all the comments for the specified document version.
describeCommentsRequest
- default CompletableFuture<DescribeCommentsResponse> describeComments(Consumer<DescribeCommentsRequest.Builder> describeCommentsRequest)
List all the comments for the specified document version.
This is a convenience which creates an instance of the DescribeCommentsRequest.Builder
avoiding the need
to create one manually via DescribeCommentsRequest.builder()
describeCommentsRequest
- A Consumer
that will call methods on DescribeCommentsRequest.Builder
to create a request.default CompletableFuture<DescribeDocumentVersionsResponse> describeDocumentVersions(DescribeDocumentVersionsRequest describeDocumentVersionsRequest)
Retrieves the document versions for the specified document.
By default, only active versions are returned.
describeDocumentVersionsRequest
- default CompletableFuture<DescribeDocumentVersionsResponse> describeDocumentVersions(Consumer<DescribeDocumentVersionsRequest.Builder> describeDocumentVersionsRequest)
Retrieves the document versions for the specified document.
By default, only active versions are returned.
This is a convenience which creates an instance of the DescribeDocumentVersionsRequest.Builder
avoiding
the need to create one manually via DescribeDocumentVersionsRequest.builder()
describeDocumentVersionsRequest
- A Consumer
that will call methods on DescribeDocumentVersionsRequest.Builder
to create a
request.default DescribeDocumentVersionsPublisher describeDocumentVersionsPaginator(DescribeDocumentVersionsRequest describeDocumentVersionsRequest)
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 publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the forEach helper method
software.amazon.awssdk.services.workdocs.paginators.DescribeDocumentVersionsPublisher publisher = client.describeDocumentVersionsPaginator(request);
CompletableFuture<Void> future = publisher.forEach(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.workdocs.paginators.DescribeDocumentVersionsPublisher publisher = client.describeDocumentVersionsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.workdocs.model.DescribeDocumentVersionsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.workdocs.model.DescribeDocumentVersionsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Note: If you prefer to have control on service calls, use the
describeDocumentVersions(software.amazon.awssdk.services.workdocs.model.DescribeDocumentVersionsRequest)
operation.
describeDocumentVersionsRequest
- default DescribeDocumentVersionsPublisher describeDocumentVersionsPaginator(Consumer<DescribeDocumentVersionsRequest.Builder> describeDocumentVersionsRequest)
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 publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the forEach helper method
software.amazon.awssdk.services.workdocs.paginators.DescribeDocumentVersionsPublisher publisher = client.describeDocumentVersionsPaginator(request);
CompletableFuture<Void> future = publisher.forEach(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.workdocs.paginators.DescribeDocumentVersionsPublisher publisher = client.describeDocumentVersionsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.workdocs.model.DescribeDocumentVersionsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.workdocs.model.DescribeDocumentVersionsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Note: If you prefer to have control on service calls, use the
describeDocumentVersions(software.amazon.awssdk.services.workdocs.model.DescribeDocumentVersionsRequest)
operation.
This is a convenience which creates an instance of the DescribeDocumentVersionsRequest.Builder
avoiding
the need to create one manually via DescribeDocumentVersionsRequest.builder()
describeDocumentVersionsRequest
- A Consumer
that will call methods on DescribeDocumentVersionsRequest.Builder
to create a
request.default CompletableFuture<DescribeFolderContentsResponse> describeFolderContents(DescribeFolderContentsRequest describeFolderContentsRequest)
Describes the contents of the specified folder, including its documents and subfolders.
By default, Amazon WorkDocs returns the first 100 active document and folder metadata items. If there are more results, the response includes a marker that you can use to request the next set of results. You can also request initialized documents.
describeFolderContentsRequest
- default CompletableFuture<DescribeFolderContentsResponse> describeFolderContents(Consumer<DescribeFolderContentsRequest.Builder> describeFolderContentsRequest)
Describes the contents of the specified folder, including its documents and subfolders.
By default, Amazon WorkDocs returns the first 100 active document and folder metadata items. If there are more results, the response includes a marker that you can use to request the next set of results. You can also request initialized documents.
This is a convenience which creates an instance of the DescribeFolderContentsRequest.Builder
avoiding the
need to create one manually via DescribeFolderContentsRequest.builder()
describeFolderContentsRequest
- A Consumer
that will call methods on DescribeFolderContentsRequest.Builder
to create a
request.default DescribeFolderContentsPublisher describeFolderContentsPaginator(DescribeFolderContentsRequest describeFolderContentsRequest)
Describes the contents of the specified folder, including its documents and subfolders.
By default, Amazon WorkDocs returns the first 100 active document and folder metadata items. If there are more results, the response includes a marker that you can use to request the next set of results. You can also request initialized documents.
This is a variant of
describeFolderContents(software.amazon.awssdk.services.workdocs.model.DescribeFolderContentsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the forEach helper method
software.amazon.awssdk.services.workdocs.paginators.DescribeFolderContentsPublisher publisher = client.describeFolderContentsPaginator(request);
CompletableFuture<Void> future = publisher.forEach(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.workdocs.paginators.DescribeFolderContentsPublisher publisher = client.describeFolderContentsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.workdocs.model.DescribeFolderContentsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.workdocs.model.DescribeFolderContentsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Note: If you prefer to have control on service calls, use the
describeFolderContents(software.amazon.awssdk.services.workdocs.model.DescribeFolderContentsRequest)
operation.
describeFolderContentsRequest
- default DescribeFolderContentsPublisher describeFolderContentsPaginator(Consumer<DescribeFolderContentsRequest.Builder> describeFolderContentsRequest)
Describes the contents of the specified folder, including its documents and subfolders.
By default, Amazon WorkDocs returns the first 100 active document and folder metadata items. If there are more results, the response includes a marker that you can use to request the next set of results. You can also request initialized documents.
This is a variant of
describeFolderContents(software.amazon.awssdk.services.workdocs.model.DescribeFolderContentsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the forEach helper method
software.amazon.awssdk.services.workdocs.paginators.DescribeFolderContentsPublisher publisher = client.describeFolderContentsPaginator(request);
CompletableFuture<Void> future = publisher.forEach(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.workdocs.paginators.DescribeFolderContentsPublisher publisher = client.describeFolderContentsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.workdocs.model.DescribeFolderContentsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.workdocs.model.DescribeFolderContentsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Note: If you prefer to have control on service calls, use the
describeFolderContents(software.amazon.awssdk.services.workdocs.model.DescribeFolderContentsRequest)
operation.
This is a convenience which creates an instance of the DescribeFolderContentsRequest.Builder
avoiding the
need to create one manually via DescribeFolderContentsRequest.builder()
describeFolderContentsRequest
- A Consumer
that will call methods on DescribeFolderContentsRequest.Builder
to create a
request.default CompletableFuture<DescribeGroupsResponse> describeGroups(DescribeGroupsRequest describeGroupsRequest)
Describes the groups specified by query.
describeGroupsRequest
- default CompletableFuture<DescribeGroupsResponse> describeGroups(Consumer<DescribeGroupsRequest.Builder> describeGroupsRequest)
Describes the groups specified by query.
This is a convenience which creates an instance of the DescribeGroupsRequest.Builder
avoiding the need to
create one manually via DescribeGroupsRequest.builder()
describeGroupsRequest
- A Consumer
that will call methods on DescribeGroupsRequest.Builder
to create a request.default CompletableFuture<DescribeNotificationSubscriptionsResponse> describeNotificationSubscriptions(DescribeNotificationSubscriptionsRequest describeNotificationSubscriptionsRequest)
Lists the specified notification subscriptions.
describeNotificationSubscriptionsRequest
- default CompletableFuture<DescribeNotificationSubscriptionsResponse> describeNotificationSubscriptions(Consumer<DescribeNotificationSubscriptionsRequest.Builder> describeNotificationSubscriptionsRequest)
Lists the specified notification subscriptions.
This is a convenience which creates an instance of the DescribeNotificationSubscriptionsRequest.Builder
avoiding the need to create one manually via DescribeNotificationSubscriptionsRequest.builder()
describeNotificationSubscriptionsRequest
- A Consumer
that will call methods on DescribeNotificationSubscriptionsRequest.Builder
to
create a request.default CompletableFuture<DescribeResourcePermissionsResponse> describeResourcePermissions(DescribeResourcePermissionsRequest describeResourcePermissionsRequest)
Describes the permissions of a specified resource.
describeResourcePermissionsRequest
- default CompletableFuture<DescribeResourcePermissionsResponse> describeResourcePermissions(Consumer<DescribeResourcePermissionsRequest.Builder> describeResourcePermissionsRequest)
Describes the permissions of a specified resource.
This is a convenience which creates an instance of the DescribeResourcePermissionsRequest.Builder
avoiding the need to create one manually via DescribeResourcePermissionsRequest.builder()
describeResourcePermissionsRequest
- A Consumer
that will call methods on DescribeResourcePermissionsRequest.Builder
to create
a request.default CompletableFuture<DescribeRootFoldersResponse> describeRootFolders(DescribeRootFoldersRequest describeRootFoldersRequest)
Describes the current user's special folders; the RootFolder
and the RecycleBin
.
RootFolder
is the root of user's files and folders and RecycleBin
is the root of
recycled items. This is not a valid action for SigV4 (administrative API) clients.
describeRootFoldersRequest
- default CompletableFuture<DescribeRootFoldersResponse> describeRootFolders(Consumer<DescribeRootFoldersRequest.Builder> describeRootFoldersRequest)
Describes the current user's special folders; the RootFolder
and the RecycleBin
.
RootFolder
is the root of user's files and folders and RecycleBin
is the root of
recycled items. This is not a valid action for SigV4 (administrative API) clients.
This is a convenience which creates an instance of the DescribeRootFoldersRequest.Builder
avoiding the
need to create one manually via DescribeRootFoldersRequest.builder()
describeRootFoldersRequest
- A Consumer
that will call methods on DescribeRootFoldersRequest.Builder
to create a
request.default CompletableFuture<DescribeUsersResponse> describeUsers(DescribeUsersRequest describeUsersRequest)
Describes the specified users. You can describe all users or filter the results (for example, by status or organization).
By default, Amazon WorkDocs returns the first 24 active or pending users. If there are more results, the response includes a marker that you can use to request the next set of results.
describeUsersRequest
- default CompletableFuture<DescribeUsersResponse> describeUsers(Consumer<DescribeUsersRequest.Builder> describeUsersRequest)
Describes the specified users. You can describe all users or filter the results (for example, by status or organization).
By default, Amazon WorkDocs returns the first 24 active or pending users. If there are more results, the response includes a marker that you can use to request the next set of results.
This is a convenience which creates an instance of the DescribeUsersRequest.Builder
avoiding the need to
create one manually via DescribeUsersRequest.builder()
describeUsersRequest
- A Consumer
that will call methods on DescribeUsersRequest.Builder
to create a request.default DescribeUsersPublisher describeUsersPaginator(DescribeUsersRequest describeUsersRequest)
Describes the specified users. You can describe all users or filter the results (for example, by status or organization).
By default, Amazon WorkDocs returns the first 24 active or pending users. If there are more results, the response includes a marker that you can use to request the next set of results.
This is a variant of describeUsers(software.amazon.awssdk.services.workdocs.model.DescribeUsersRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the forEach helper method
software.amazon.awssdk.services.workdocs.paginators.DescribeUsersPublisher publisher = client.describeUsersPaginator(request);
CompletableFuture<Void> future = publisher.forEach(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.workdocs.paginators.DescribeUsersPublisher publisher = client.describeUsersPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.workdocs.model.DescribeUsersResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.workdocs.model.DescribeUsersResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Note: If you prefer to have control on service calls, use the
describeUsers(software.amazon.awssdk.services.workdocs.model.DescribeUsersRequest)
operation.
describeUsersRequest
- default DescribeUsersPublisher describeUsersPaginator(Consumer<DescribeUsersRequest.Builder> describeUsersRequest)
Describes the specified users. You can describe all users or filter the results (for example, by status or organization).
By default, Amazon WorkDocs returns the first 24 active or pending users. If there are more results, the response includes a marker that you can use to request the next set of results.
This is a variant of describeUsers(software.amazon.awssdk.services.workdocs.model.DescribeUsersRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the forEach helper method
software.amazon.awssdk.services.workdocs.paginators.DescribeUsersPublisher publisher = client.describeUsersPaginator(request);
CompletableFuture<Void> future = publisher.forEach(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.workdocs.paginators.DescribeUsersPublisher publisher = client.describeUsersPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.workdocs.model.DescribeUsersResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.workdocs.model.DescribeUsersResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Note: If you prefer to have control on service calls, use the
describeUsers(software.amazon.awssdk.services.workdocs.model.DescribeUsersRequest)
operation.
This is a convenience which creates an instance of the DescribeUsersRequest.Builder
avoiding the need to
create one manually via DescribeUsersRequest.builder()
describeUsersRequest
- A Consumer
that will call methods on DescribeUsersRequest.Builder
to create a request.default CompletableFuture<GetCurrentUserResponse> getCurrentUser(GetCurrentUserRequest getCurrentUserRequest)
Retrieves details of the current user for whom the authentication token was generated. This is not a valid action for SigV4 (administrative API) clients.
getCurrentUserRequest
- default CompletableFuture<GetCurrentUserResponse> getCurrentUser(Consumer<GetCurrentUserRequest.Builder> getCurrentUserRequest)
Retrieves details of the current user for whom the authentication token was generated. This is not a valid action for SigV4 (administrative API) clients.
This is a convenience which creates an instance of the GetCurrentUserRequest.Builder
avoiding the need to
create one manually via GetCurrentUserRequest.builder()
getCurrentUserRequest
- A Consumer
that will call methods on GetCurrentUserRequest.Builder
to create a request.default CompletableFuture<GetDocumentResponse> getDocument(GetDocumentRequest getDocumentRequest)
Retrieves details of a document.
getDocumentRequest
- default CompletableFuture<GetDocumentResponse> getDocument(Consumer<GetDocumentRequest.Builder> getDocumentRequest)
Retrieves details of a document.
This is a convenience which creates an instance of the GetDocumentRequest.Builder
avoiding the need to
create one manually via GetDocumentRequest.builder()
getDocumentRequest
- A Consumer
that will call methods on GetDocumentRequest.Builder
to create a request.default CompletableFuture<GetDocumentPathResponse> getDocumentPath(GetDocumentPathRequest getDocumentPathRequest)
Retrieves the path information (the hierarchy from the root folder) for the requested document.
By default, Amazon WorkDocs returns a maximum of 100 levels upwards from the requested document and only includes the IDs of the parent folders in the path. You can limit the maximum number of levels. You can also request the names of the parent folders.
getDocumentPathRequest
- default CompletableFuture<GetDocumentPathResponse> getDocumentPath(Consumer<GetDocumentPathRequest.Builder> getDocumentPathRequest)
Retrieves the path information (the hierarchy from the root folder) for the requested document.
By default, Amazon WorkDocs returns a maximum of 100 levels upwards from the requested document and only includes the IDs of the parent folders in the path. You can limit the maximum number of levels. You can also request the names of the parent folders.
This is a convenience which creates an instance of the GetDocumentPathRequest.Builder
avoiding the need
to create one manually via GetDocumentPathRequest.builder()
getDocumentPathRequest
- A Consumer
that will call methods on GetDocumentPathRequest.Builder
to create a request.default CompletableFuture<GetDocumentVersionResponse> getDocumentVersion(GetDocumentVersionRequest getDocumentVersionRequest)
Retrieves version metadata for the specified document.
getDocumentVersionRequest
- default CompletableFuture<GetDocumentVersionResponse> getDocumentVersion(Consumer<GetDocumentVersionRequest.Builder> getDocumentVersionRequest)
Retrieves version metadata for the specified document.
This is a convenience which creates an instance of the GetDocumentVersionRequest.Builder
avoiding the
need to create one manually via GetDocumentVersionRequest.builder()
getDocumentVersionRequest
- A Consumer
that will call methods on GetDocumentVersionRequest.Builder
to create a
request.default CompletableFuture<GetFolderResponse> getFolder(GetFolderRequest getFolderRequest)
Retrieves the metadata of the specified folder.
getFolderRequest
- default CompletableFuture<GetFolderResponse> getFolder(Consumer<GetFolderRequest.Builder> getFolderRequest)
Retrieves the metadata of the specified folder.
This is a convenience which creates an instance of the GetFolderRequest.Builder
avoiding the need to
create one manually via GetFolderRequest.builder()
getFolderRequest
- A Consumer
that will call methods on GetFolderRequest.Builder
to create a request.default CompletableFuture<GetFolderPathResponse> getFolderPath(GetFolderPathRequest getFolderPathRequest)
Retrieves the path information (the hierarchy from the root folder) for the specified folder.
By default, Amazon WorkDocs returns a maximum of 100 levels upwards from the requested folder and only includes the IDs of the parent folders in the path. You can limit the maximum number of levels. You can also request the parent folder names.
getFolderPathRequest
- default CompletableFuture<GetFolderPathResponse> getFolderPath(Consumer<GetFolderPathRequest.Builder> getFolderPathRequest)
Retrieves the path information (the hierarchy from the root folder) for the specified folder.
By default, Amazon WorkDocs returns a maximum of 100 levels upwards from the requested folder and only includes the IDs of the parent folders in the path. You can limit the maximum number of levels. You can also request the parent folder names.
This is a convenience which creates an instance of the GetFolderPathRequest.Builder
avoiding the need to
create one manually via GetFolderPathRequest.builder()
getFolderPathRequest
- A Consumer
that will call methods on GetFolderPathRequest.Builder
to create a request.default CompletableFuture<InitiateDocumentVersionUploadResponse> initiateDocumentVersionUpload(InitiateDocumentVersionUploadRequest initiateDocumentVersionUploadRequest)
Creates a new document object and version object.
The client specifies the parent folder ID and name of the document to upload. The ID is optionally specified when creating a new version of an existing document. This is the first step to upload a document. Next, upload the document to the URL returned from the call, and then call UpdateDocumentVersion.
To cancel the document upload, call AbortDocumentVersionUpload.
initiateDocumentVersionUploadRequest
- default CompletableFuture<InitiateDocumentVersionUploadResponse> initiateDocumentVersionUpload(Consumer<InitiateDocumentVersionUploadRequest.Builder> initiateDocumentVersionUploadRequest)
Creates a new document object and version object.
The client specifies the parent folder ID and name of the document to upload. The ID is optionally specified when creating a new version of an existing document. This is the first step to upload a document. Next, upload the document to the URL returned from the call, and then call UpdateDocumentVersion.
To cancel the document upload, call AbortDocumentVersionUpload.
This is a convenience which creates an instance of the InitiateDocumentVersionUploadRequest.Builder
avoiding the need to create one manually via InitiateDocumentVersionUploadRequest.builder()
initiateDocumentVersionUploadRequest
- A Consumer
that will call methods on InitiateDocumentVersionUploadRequest.Builder
to
create a request.default CompletableFuture<RemoveAllResourcePermissionsResponse> removeAllResourcePermissions(RemoveAllResourcePermissionsRequest removeAllResourcePermissionsRequest)
Removes all the permissions from the specified resource.
removeAllResourcePermissionsRequest
- default CompletableFuture<RemoveAllResourcePermissionsResponse> removeAllResourcePermissions(Consumer<RemoveAllResourcePermissionsRequest.Builder> removeAllResourcePermissionsRequest)
Removes all the permissions from the specified resource.
This is a convenience which creates an instance of the RemoveAllResourcePermissionsRequest.Builder
avoiding the need to create one manually via RemoveAllResourcePermissionsRequest.builder()
removeAllResourcePermissionsRequest
- A Consumer
that will call methods on RemoveAllResourcePermissionsRequest.Builder
to create
a request.default CompletableFuture<RemoveResourcePermissionResponse> removeResourcePermission(RemoveResourcePermissionRequest removeResourcePermissionRequest)
Removes the permission for the specified principal from the specified resource.
removeResourcePermissionRequest
- default CompletableFuture<RemoveResourcePermissionResponse> removeResourcePermission(Consumer<RemoveResourcePermissionRequest.Builder> removeResourcePermissionRequest)
Removes the permission for the specified principal from the specified resource.
This is a convenience which creates an instance of the RemoveResourcePermissionRequest.Builder
avoiding
the need to create one manually via RemoveResourcePermissionRequest.builder()
removeResourcePermissionRequest
- A Consumer
that will call methods on RemoveResourcePermissionRequest.Builder
to create a
request.default CompletableFuture<UpdateDocumentResponse> updateDocument(UpdateDocumentRequest updateDocumentRequest)
Updates the specified attributes of a document. The user must have access to both the document and its parent folder, if applicable.
updateDocumentRequest
- default CompletableFuture<UpdateDocumentResponse> updateDocument(Consumer<UpdateDocumentRequest.Builder> updateDocumentRequest)
Updates the specified attributes of a document. The user must have access to both the document and its parent folder, if applicable.
This is a convenience which creates an instance of the UpdateDocumentRequest.Builder
avoiding the need to
create one manually via UpdateDocumentRequest.builder()
updateDocumentRequest
- A Consumer
that will call methods on UpdateDocumentRequest.Builder
to create a request.default CompletableFuture<UpdateDocumentVersionResponse> updateDocumentVersion(UpdateDocumentVersionRequest updateDocumentVersionRequest)
Changes the status of the document version to ACTIVE.
Amazon WorkDocs also sets its document container to ACTIVE. This is the last step in a document upload, after the client uploads the document to an S3-presigned URL returned by InitiateDocumentVersionUpload.
updateDocumentVersionRequest
- default CompletableFuture<UpdateDocumentVersionResponse> updateDocumentVersion(Consumer<UpdateDocumentVersionRequest.Builder> updateDocumentVersionRequest)
Changes the status of the document version to ACTIVE.
Amazon WorkDocs also sets its document container to ACTIVE. This is the last step in a document upload, after the client uploads the document to an S3-presigned URL returned by InitiateDocumentVersionUpload.
This is a convenience which creates an instance of the UpdateDocumentVersionRequest.Builder
avoiding the
need to create one manually via UpdateDocumentVersionRequest.builder()
updateDocumentVersionRequest
- A Consumer
that will call methods on UpdateDocumentVersionRequest.Builder
to create a
request.default CompletableFuture<UpdateFolderResponse> updateFolder(UpdateFolderRequest updateFolderRequest)
Updates the specified attributes of the specified folder. The user must have access to both the folder and its parent folder, if applicable.
updateFolderRequest
- default CompletableFuture<UpdateFolderResponse> updateFolder(Consumer<UpdateFolderRequest.Builder> updateFolderRequest)
Updates the specified attributes of the specified folder. The user must have access to both the folder and its parent folder, if applicable.
This is a convenience which creates an instance of the UpdateFolderRequest.Builder
avoiding the need to
create one manually via UpdateFolderRequest.builder()
updateFolderRequest
- A Consumer
that will call methods on UpdateFolderRequest.Builder
to create a request.default CompletableFuture<UpdateUserResponse> updateUser(UpdateUserRequest updateUserRequest)
Updates the specified attributes of the specified user, and grants or revokes administrative privileges to the Amazon WorkDocs site.
updateUserRequest
- default CompletableFuture<UpdateUserResponse> updateUser(Consumer<UpdateUserRequest.Builder> updateUserRequest)
Updates the specified attributes of the specified user, and grants or revokes administrative privileges to the Amazon WorkDocs site.
This is a convenience which creates an instance of the UpdateUserRequest.Builder
avoiding the need to
create one manually via UpdateUserRequest.builder()
updateUserRequest
- A Consumer
that will call methods on UpdateUserRequest.Builder
to create a request.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.