@ThreadSafe @Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AmazonWorkDocsAsyncClient extends AmazonWorkDocsClient implements AmazonWorkDocsAsync
AsyncHandler
can be used to receive
notification when an asynchronous operation completes.
The Amazon 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 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 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 Amazon Web Services 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.
The pricing for Amazon WorkDocs APIs varies depending on the API call type for these actions:
READ (Get*)
WRITE (Activate*, Add*, Create*, Deactivate*, Initiate*, Update*)
LIST (Describe*)
DELETE*, CANCEL
For information about Amazon WorkDocs API pricing, see Amazon WorkDocs Pricing.
LOGGING_AWS_REQUEST_METRIC
ENDPOINT_PREFIX
abortDocumentVersionUpload, activateUser, addResourcePermissions, builder, createComment, createCustomMetadata, createFolder, createLabels, createNotificationSubscription, createUser, deactivateUser, deleteComment, deleteCustomMetadata, deleteDocument, deleteDocumentVersion, deleteFolder, deleteFolderContents, deleteLabels, deleteNotificationSubscription, deleteUser, describeActivities, describeComments, describeDocumentVersions, describeFolderContents, describeGroups, describeNotificationSubscriptions, describeResourcePermissions, describeRootFolders, describeUsers, getCachedResponseMetadata, getCurrentUser, getDocument, getDocumentPath, getDocumentVersion, getFolder, getFolderPath, getResources, initiateDocumentVersionUpload, removeAllResourcePermissions, removeResourcePermission, restoreDocumentVersions, searchResources, updateDocument, updateDocumentVersion, updateFolder, updateUser
addRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffset
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
abortDocumentVersionUpload, activateUser, addResourcePermissions, createComment, createCustomMetadata, createFolder, createLabels, createNotificationSubscription, createUser, deactivateUser, deleteComment, deleteCustomMetadata, deleteDocument, deleteDocumentVersion, deleteFolder, deleteFolderContents, deleteLabels, deleteNotificationSubscription, deleteUser, describeActivities, describeComments, describeDocumentVersions, describeFolderContents, describeGroups, describeNotificationSubscriptions, describeResourcePermissions, describeRootFolders, describeUsers, getCachedResponseMetadata, getCurrentUser, getDocument, getDocumentPath, getDocumentVersion, getFolder, getFolderPath, getResources, initiateDocumentVersionUpload, removeAllResourcePermissions, removeResourcePermission, restoreDocumentVersions, searchResources, updateDocument, updateDocumentVersion, updateFolder, updateUser
public static AmazonWorkDocsAsyncClientBuilder asyncBuilder()
public ExecutorService getExecutorService()
public Future<AbortDocumentVersionUploadResult> abortDocumentVersionUploadAsync(AbortDocumentVersionUploadRequest request)
AmazonWorkDocsAsync
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.
abortDocumentVersionUploadAsync
in interface AmazonWorkDocsAsync
public Future<AbortDocumentVersionUploadResult> abortDocumentVersionUploadAsync(AbortDocumentVersionUploadRequest request, AsyncHandler<AbortDocumentVersionUploadRequest,AbortDocumentVersionUploadResult> asyncHandler)
AmazonWorkDocsAsync
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.
abortDocumentVersionUploadAsync
in interface AmazonWorkDocsAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ActivateUserResult> activateUserAsync(ActivateUserRequest request)
AmazonWorkDocsAsync
Activates the specified user. Only active users can access Amazon WorkDocs.
activateUserAsync
in interface AmazonWorkDocsAsync
public Future<ActivateUserResult> activateUserAsync(ActivateUserRequest request, AsyncHandler<ActivateUserRequest,ActivateUserResult> asyncHandler)
AmazonWorkDocsAsync
Activates the specified user. Only active users can access Amazon WorkDocs.
activateUserAsync
in interface AmazonWorkDocsAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<AddResourcePermissionsResult> addResourcePermissionsAsync(AddResourcePermissionsRequest request)
AmazonWorkDocsAsync
Creates a set of permissions for the specified folder or document. The resource permissions are overwritten if the principals already have different permissions.
addResourcePermissionsAsync
in interface AmazonWorkDocsAsync
public Future<AddResourcePermissionsResult> addResourcePermissionsAsync(AddResourcePermissionsRequest request, AsyncHandler<AddResourcePermissionsRequest,AddResourcePermissionsResult> asyncHandler)
AmazonWorkDocsAsync
Creates a set of permissions for the specified folder or document. The resource permissions are overwritten if the principals already have different permissions.
addResourcePermissionsAsync
in interface AmazonWorkDocsAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<CreateCommentResult> createCommentAsync(CreateCommentRequest request)
AmazonWorkDocsAsync
Adds a new comment to the specified document version.
createCommentAsync
in interface AmazonWorkDocsAsync
public Future<CreateCommentResult> createCommentAsync(CreateCommentRequest request, AsyncHandler<CreateCommentRequest,CreateCommentResult> asyncHandler)
AmazonWorkDocsAsync
Adds a new comment to the specified document version.
createCommentAsync
in interface AmazonWorkDocsAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<CreateCustomMetadataResult> createCustomMetadataAsync(CreateCustomMetadataRequest request)
AmazonWorkDocsAsync
Adds one or more custom properties to the specified resource (a folder, document, or version).
createCustomMetadataAsync
in interface AmazonWorkDocsAsync
public Future<CreateCustomMetadataResult> createCustomMetadataAsync(CreateCustomMetadataRequest request, AsyncHandler<CreateCustomMetadataRequest,CreateCustomMetadataResult> asyncHandler)
AmazonWorkDocsAsync
Adds one or more custom properties to the specified resource (a folder, document, or version).
createCustomMetadataAsync
in interface AmazonWorkDocsAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<CreateFolderResult> createFolderAsync(CreateFolderRequest request)
AmazonWorkDocsAsync
Creates a folder with the specified name and parent folder.
createFolderAsync
in interface AmazonWorkDocsAsync
public Future<CreateFolderResult> createFolderAsync(CreateFolderRequest request, AsyncHandler<CreateFolderRequest,CreateFolderResult> asyncHandler)
AmazonWorkDocsAsync
Creates a folder with the specified name and parent folder.
createFolderAsync
in interface AmazonWorkDocsAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<CreateLabelsResult> createLabelsAsync(CreateLabelsRequest request)
AmazonWorkDocsAsync
Adds the specified list of labels to the given resource (a document or folder)
createLabelsAsync
in interface AmazonWorkDocsAsync
public Future<CreateLabelsResult> createLabelsAsync(CreateLabelsRequest request, AsyncHandler<CreateLabelsRequest,CreateLabelsResult> asyncHandler)
AmazonWorkDocsAsync
Adds the specified list of labels to the given resource (a document or folder)
createLabelsAsync
in interface AmazonWorkDocsAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<CreateNotificationSubscriptionResult> createNotificationSubscriptionAsync(CreateNotificationSubscriptionRequest request)
AmazonWorkDocsAsync
Configure Amazon WorkDocs to use Amazon SNS notifications. The endpoint receives a confirmation message, and must confirm the subscription.
For more information, see Setting up notifications for an IAM user or role in the Amazon WorkDocs Developer Guide.
createNotificationSubscriptionAsync
in interface AmazonWorkDocsAsync
public Future<CreateNotificationSubscriptionResult> createNotificationSubscriptionAsync(CreateNotificationSubscriptionRequest request, AsyncHandler<CreateNotificationSubscriptionRequest,CreateNotificationSubscriptionResult> asyncHandler)
AmazonWorkDocsAsync
Configure Amazon WorkDocs to use Amazon SNS notifications. The endpoint receives a confirmation message, and must confirm the subscription.
For more information, see Setting up notifications for an IAM user or role in the Amazon WorkDocs Developer Guide.
createNotificationSubscriptionAsync
in interface AmazonWorkDocsAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<CreateUserResult> createUserAsync(CreateUserRequest request)
AmazonWorkDocsAsync
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.
createUserAsync
in interface AmazonWorkDocsAsync
public Future<CreateUserResult> createUserAsync(CreateUserRequest request, AsyncHandler<CreateUserRequest,CreateUserResult> asyncHandler)
AmazonWorkDocsAsync
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.
createUserAsync
in interface AmazonWorkDocsAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DeactivateUserResult> deactivateUserAsync(DeactivateUserRequest request)
AmazonWorkDocsAsync
Deactivates the specified user, which revokes the user's access to Amazon WorkDocs.
deactivateUserAsync
in interface AmazonWorkDocsAsync
public Future<DeactivateUserResult> deactivateUserAsync(DeactivateUserRequest request, AsyncHandler<DeactivateUserRequest,DeactivateUserResult> asyncHandler)
AmazonWorkDocsAsync
Deactivates the specified user, which revokes the user's access to Amazon WorkDocs.
deactivateUserAsync
in interface AmazonWorkDocsAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DeleteCommentResult> deleteCommentAsync(DeleteCommentRequest request)
AmazonWorkDocsAsync
Deletes the specified comment from the document version.
deleteCommentAsync
in interface AmazonWorkDocsAsync
public Future<DeleteCommentResult> deleteCommentAsync(DeleteCommentRequest request, AsyncHandler<DeleteCommentRequest,DeleteCommentResult> asyncHandler)
AmazonWorkDocsAsync
Deletes the specified comment from the document version.
deleteCommentAsync
in interface AmazonWorkDocsAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DeleteCustomMetadataResult> deleteCustomMetadataAsync(DeleteCustomMetadataRequest request)
AmazonWorkDocsAsync
Deletes custom metadata from the specified resource.
deleteCustomMetadataAsync
in interface AmazonWorkDocsAsync
public Future<DeleteCustomMetadataResult> deleteCustomMetadataAsync(DeleteCustomMetadataRequest request, AsyncHandler<DeleteCustomMetadataRequest,DeleteCustomMetadataResult> asyncHandler)
AmazonWorkDocsAsync
Deletes custom metadata from the specified resource.
deleteCustomMetadataAsync
in interface AmazonWorkDocsAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DeleteDocumentResult> deleteDocumentAsync(DeleteDocumentRequest request)
AmazonWorkDocsAsync
Permanently deletes the specified document and its associated metadata.
deleteDocumentAsync
in interface AmazonWorkDocsAsync
public Future<DeleteDocumentResult> deleteDocumentAsync(DeleteDocumentRequest request, AsyncHandler<DeleteDocumentRequest,DeleteDocumentResult> asyncHandler)
AmazonWorkDocsAsync
Permanently deletes the specified document and its associated metadata.
deleteDocumentAsync
in interface AmazonWorkDocsAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DeleteDocumentVersionResult> deleteDocumentVersionAsync(DeleteDocumentVersionRequest request)
AmazonWorkDocsAsync
Deletes a specific version of a document.
deleteDocumentVersionAsync
in interface AmazonWorkDocsAsync
public Future<DeleteDocumentVersionResult> deleteDocumentVersionAsync(DeleteDocumentVersionRequest request, AsyncHandler<DeleteDocumentVersionRequest,DeleteDocumentVersionResult> asyncHandler)
AmazonWorkDocsAsync
Deletes a specific version of a document.
deleteDocumentVersionAsync
in interface AmazonWorkDocsAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DeleteFolderResult> deleteFolderAsync(DeleteFolderRequest request)
AmazonWorkDocsAsync
Permanently deletes the specified folder and its contents.
deleteFolderAsync
in interface AmazonWorkDocsAsync
public Future<DeleteFolderResult> deleteFolderAsync(DeleteFolderRequest request, AsyncHandler<DeleteFolderRequest,DeleteFolderResult> asyncHandler)
AmazonWorkDocsAsync
Permanently deletes the specified folder and its contents.
deleteFolderAsync
in interface AmazonWorkDocsAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DeleteFolderContentsResult> deleteFolderContentsAsync(DeleteFolderContentsRequest request)
AmazonWorkDocsAsync
Deletes the contents of the specified folder.
deleteFolderContentsAsync
in interface AmazonWorkDocsAsync
public Future<DeleteFolderContentsResult> deleteFolderContentsAsync(DeleteFolderContentsRequest request, AsyncHandler<DeleteFolderContentsRequest,DeleteFolderContentsResult> asyncHandler)
AmazonWorkDocsAsync
Deletes the contents of the specified folder.
deleteFolderContentsAsync
in interface AmazonWorkDocsAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DeleteLabelsResult> deleteLabelsAsync(DeleteLabelsRequest request)
AmazonWorkDocsAsync
Deletes the specified list of labels from a resource.
deleteLabelsAsync
in interface AmazonWorkDocsAsync
public Future<DeleteLabelsResult> deleteLabelsAsync(DeleteLabelsRequest request, AsyncHandler<DeleteLabelsRequest,DeleteLabelsResult> asyncHandler)
AmazonWorkDocsAsync
Deletes the specified list of labels from a resource.
deleteLabelsAsync
in interface AmazonWorkDocsAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DeleteNotificationSubscriptionResult> deleteNotificationSubscriptionAsync(DeleteNotificationSubscriptionRequest request)
AmazonWorkDocsAsync
Deletes the specified subscription from the specified organization.
deleteNotificationSubscriptionAsync
in interface AmazonWorkDocsAsync
public Future<DeleteNotificationSubscriptionResult> deleteNotificationSubscriptionAsync(DeleteNotificationSubscriptionRequest request, AsyncHandler<DeleteNotificationSubscriptionRequest,DeleteNotificationSubscriptionResult> asyncHandler)
AmazonWorkDocsAsync
Deletes the specified subscription from the specified organization.
deleteNotificationSubscriptionAsync
in interface AmazonWorkDocsAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DeleteUserResult> deleteUserAsync(DeleteUserRequest request)
AmazonWorkDocsAsync
Deletes the specified user from a Simple AD or Microsoft AD directory.
Deleting a user immediately and permanently deletes all content in that user's folder structure. Site retention policies do NOT apply to this type of deletion.
deleteUserAsync
in interface AmazonWorkDocsAsync
public Future<DeleteUserResult> deleteUserAsync(DeleteUserRequest request, AsyncHandler<DeleteUserRequest,DeleteUserResult> asyncHandler)
AmazonWorkDocsAsync
Deletes the specified user from a Simple AD or Microsoft AD directory.
Deleting a user immediately and permanently deletes all content in that user's folder structure. Site retention policies do NOT apply to this type of deletion.
deleteUserAsync
in interface AmazonWorkDocsAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeActivitiesResult> describeActivitiesAsync(DescribeActivitiesRequest request)
AmazonWorkDocsAsync
Describes the user activities in a specified time period.
describeActivitiesAsync
in interface AmazonWorkDocsAsync
public Future<DescribeActivitiesResult> describeActivitiesAsync(DescribeActivitiesRequest request, AsyncHandler<DescribeActivitiesRequest,DescribeActivitiesResult> asyncHandler)
AmazonWorkDocsAsync
Describes the user activities in a specified time period.
describeActivitiesAsync
in interface AmazonWorkDocsAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeCommentsResult> describeCommentsAsync(DescribeCommentsRequest request)
AmazonWorkDocsAsync
List all the comments for the specified document version.
describeCommentsAsync
in interface AmazonWorkDocsAsync
public Future<DescribeCommentsResult> describeCommentsAsync(DescribeCommentsRequest request, AsyncHandler<DescribeCommentsRequest,DescribeCommentsResult> asyncHandler)
AmazonWorkDocsAsync
List all the comments for the specified document version.
describeCommentsAsync
in interface AmazonWorkDocsAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeDocumentVersionsResult> describeDocumentVersionsAsync(DescribeDocumentVersionsRequest request)
AmazonWorkDocsAsync
Retrieves the document versions for the specified document.
By default, only active versions are returned.
describeDocumentVersionsAsync
in interface AmazonWorkDocsAsync
public Future<DescribeDocumentVersionsResult> describeDocumentVersionsAsync(DescribeDocumentVersionsRequest request, AsyncHandler<DescribeDocumentVersionsRequest,DescribeDocumentVersionsResult> asyncHandler)
AmazonWorkDocsAsync
Retrieves the document versions for the specified document.
By default, only active versions are returned.
describeDocumentVersionsAsync
in interface AmazonWorkDocsAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeFolderContentsResult> describeFolderContentsAsync(DescribeFolderContentsRequest request)
AmazonWorkDocsAsync
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.
describeFolderContentsAsync
in interface AmazonWorkDocsAsync
public Future<DescribeFolderContentsResult> describeFolderContentsAsync(DescribeFolderContentsRequest request, AsyncHandler<DescribeFolderContentsRequest,DescribeFolderContentsResult> asyncHandler)
AmazonWorkDocsAsync
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.
describeFolderContentsAsync
in interface AmazonWorkDocsAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeGroupsResult> describeGroupsAsync(DescribeGroupsRequest request)
AmazonWorkDocsAsync
Describes the groups specified by the query. Groups are defined by the underlying Active Directory.
describeGroupsAsync
in interface AmazonWorkDocsAsync
public Future<DescribeGroupsResult> describeGroupsAsync(DescribeGroupsRequest request, AsyncHandler<DescribeGroupsRequest,DescribeGroupsResult> asyncHandler)
AmazonWorkDocsAsync
Describes the groups specified by the query. Groups are defined by the underlying Active Directory.
describeGroupsAsync
in interface AmazonWorkDocsAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeNotificationSubscriptionsResult> describeNotificationSubscriptionsAsync(DescribeNotificationSubscriptionsRequest request)
AmazonWorkDocsAsync
Lists the specified notification subscriptions.
describeNotificationSubscriptionsAsync
in interface AmazonWorkDocsAsync
public Future<DescribeNotificationSubscriptionsResult> describeNotificationSubscriptionsAsync(DescribeNotificationSubscriptionsRequest request, AsyncHandler<DescribeNotificationSubscriptionsRequest,DescribeNotificationSubscriptionsResult> asyncHandler)
AmazonWorkDocsAsync
Lists the specified notification subscriptions.
describeNotificationSubscriptionsAsync
in interface AmazonWorkDocsAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeResourcePermissionsResult> describeResourcePermissionsAsync(DescribeResourcePermissionsRequest request)
AmazonWorkDocsAsync
Describes the permissions of a specified resource.
describeResourcePermissionsAsync
in interface AmazonWorkDocsAsync
public Future<DescribeResourcePermissionsResult> describeResourcePermissionsAsync(DescribeResourcePermissionsRequest request, AsyncHandler<DescribeResourcePermissionsRequest,DescribeResourcePermissionsResult> asyncHandler)
AmazonWorkDocsAsync
Describes the permissions of a specified resource.
describeResourcePermissionsAsync
in interface AmazonWorkDocsAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeRootFoldersResult> describeRootFoldersAsync(DescribeRootFoldersRequest request)
AmazonWorkDocsAsync
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 action requires an authentication token. To get an authentication token, register an application with Amazon WorkDocs. For more information, see Authentication and Access Control for User Applications in the Amazon WorkDocs Developer Guide.
describeRootFoldersAsync
in interface AmazonWorkDocsAsync
public Future<DescribeRootFoldersResult> describeRootFoldersAsync(DescribeRootFoldersRequest request, AsyncHandler<DescribeRootFoldersRequest,DescribeRootFoldersResult> asyncHandler)
AmazonWorkDocsAsync
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 action requires an authentication token. To get an authentication token, register an application with Amazon WorkDocs. For more information, see Authentication and Access Control for User Applications in the Amazon WorkDocs Developer Guide.
describeRootFoldersAsync
in interface AmazonWorkDocsAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeUsersResult> describeUsersAsync(DescribeUsersRequest request)
AmazonWorkDocsAsync
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.
describeUsersAsync
in interface AmazonWorkDocsAsync
public Future<DescribeUsersResult> describeUsersAsync(DescribeUsersRequest request, AsyncHandler<DescribeUsersRequest,DescribeUsersResult> asyncHandler)
AmazonWorkDocsAsync
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.
describeUsersAsync
in interface AmazonWorkDocsAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<GetCurrentUserResult> getCurrentUserAsync(GetCurrentUserRequest request)
AmazonWorkDocsAsync
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 action requires an authentication token. To get an authentication token, register an application with Amazon WorkDocs. For more information, see Authentication and Access Control for User Applications in the Amazon WorkDocs Developer Guide.
getCurrentUserAsync
in interface AmazonWorkDocsAsync
public Future<GetCurrentUserResult> getCurrentUserAsync(GetCurrentUserRequest request, AsyncHandler<GetCurrentUserRequest,GetCurrentUserResult> asyncHandler)
AmazonWorkDocsAsync
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 action requires an authentication token. To get an authentication token, register an application with Amazon WorkDocs. For more information, see Authentication and Access Control for User Applications in the Amazon WorkDocs Developer Guide.
getCurrentUserAsync
in interface AmazonWorkDocsAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<GetDocumentResult> getDocumentAsync(GetDocumentRequest request)
AmazonWorkDocsAsync
Retrieves details of a document.
getDocumentAsync
in interface AmazonWorkDocsAsync
public Future<GetDocumentResult> getDocumentAsync(GetDocumentRequest request, AsyncHandler<GetDocumentRequest,GetDocumentResult> asyncHandler)
AmazonWorkDocsAsync
Retrieves details of a document.
getDocumentAsync
in interface AmazonWorkDocsAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<GetDocumentPathResult> getDocumentPathAsync(GetDocumentPathRequest request)
AmazonWorkDocsAsync
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.
getDocumentPathAsync
in interface AmazonWorkDocsAsync
public Future<GetDocumentPathResult> getDocumentPathAsync(GetDocumentPathRequest request, AsyncHandler<GetDocumentPathRequest,GetDocumentPathResult> asyncHandler)
AmazonWorkDocsAsync
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.
getDocumentPathAsync
in interface AmazonWorkDocsAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<GetDocumentVersionResult> getDocumentVersionAsync(GetDocumentVersionRequest request)
AmazonWorkDocsAsync
Retrieves version metadata for the specified document.
getDocumentVersionAsync
in interface AmazonWorkDocsAsync
public Future<GetDocumentVersionResult> getDocumentVersionAsync(GetDocumentVersionRequest request, AsyncHandler<GetDocumentVersionRequest,GetDocumentVersionResult> asyncHandler)
AmazonWorkDocsAsync
Retrieves version metadata for the specified document.
getDocumentVersionAsync
in interface AmazonWorkDocsAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<GetFolderResult> getFolderAsync(GetFolderRequest request)
AmazonWorkDocsAsync
Retrieves the metadata of the specified folder.
getFolderAsync
in interface AmazonWorkDocsAsync
public Future<GetFolderResult> getFolderAsync(GetFolderRequest request, AsyncHandler<GetFolderRequest,GetFolderResult> asyncHandler)
AmazonWorkDocsAsync
Retrieves the metadata of the specified folder.
getFolderAsync
in interface AmazonWorkDocsAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<GetFolderPathResult> getFolderPathAsync(GetFolderPathRequest request)
AmazonWorkDocsAsync
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.
getFolderPathAsync
in interface AmazonWorkDocsAsync
public Future<GetFolderPathResult> getFolderPathAsync(GetFolderPathRequest request, AsyncHandler<GetFolderPathRequest,GetFolderPathResult> asyncHandler)
AmazonWorkDocsAsync
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.
getFolderPathAsync
in interface AmazonWorkDocsAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<GetResourcesResult> getResourcesAsync(GetResourcesRequest request)
AmazonWorkDocsAsync
Retrieves a collection of resources, including folders and documents. The only CollectionType
supported is SHARED_WITH_ME
.
getResourcesAsync
in interface AmazonWorkDocsAsync
public Future<GetResourcesResult> getResourcesAsync(GetResourcesRequest request, AsyncHandler<GetResourcesRequest,GetResourcesResult> asyncHandler)
AmazonWorkDocsAsync
Retrieves a collection of resources, including folders and documents. The only CollectionType
supported is SHARED_WITH_ME
.
getResourcesAsync
in interface AmazonWorkDocsAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<InitiateDocumentVersionUploadResult> initiateDocumentVersionUploadAsync(InitiateDocumentVersionUploadRequest request)
AmazonWorkDocsAsync
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.
initiateDocumentVersionUploadAsync
in interface AmazonWorkDocsAsync
public Future<InitiateDocumentVersionUploadResult> initiateDocumentVersionUploadAsync(InitiateDocumentVersionUploadRequest request, AsyncHandler<InitiateDocumentVersionUploadRequest,InitiateDocumentVersionUploadResult> asyncHandler)
AmazonWorkDocsAsync
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.
initiateDocumentVersionUploadAsync
in interface AmazonWorkDocsAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<RemoveAllResourcePermissionsResult> removeAllResourcePermissionsAsync(RemoveAllResourcePermissionsRequest request)
AmazonWorkDocsAsync
Removes all the permissions from the specified resource.
removeAllResourcePermissionsAsync
in interface AmazonWorkDocsAsync
public Future<RemoveAllResourcePermissionsResult> removeAllResourcePermissionsAsync(RemoveAllResourcePermissionsRequest request, AsyncHandler<RemoveAllResourcePermissionsRequest,RemoveAllResourcePermissionsResult> asyncHandler)
AmazonWorkDocsAsync
Removes all the permissions from the specified resource.
removeAllResourcePermissionsAsync
in interface AmazonWorkDocsAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<RemoveResourcePermissionResult> removeResourcePermissionAsync(RemoveResourcePermissionRequest request)
AmazonWorkDocsAsync
Removes the permission for the specified principal from the specified resource.
removeResourcePermissionAsync
in interface AmazonWorkDocsAsync
public Future<RemoveResourcePermissionResult> removeResourcePermissionAsync(RemoveResourcePermissionRequest request, AsyncHandler<RemoveResourcePermissionRequest,RemoveResourcePermissionResult> asyncHandler)
AmazonWorkDocsAsync
Removes the permission for the specified principal from the specified resource.
removeResourcePermissionAsync
in interface AmazonWorkDocsAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<RestoreDocumentVersionsResult> restoreDocumentVersionsAsync(RestoreDocumentVersionsRequest request)
AmazonWorkDocsAsync
Recovers a deleted version of an Amazon WorkDocs document.
restoreDocumentVersionsAsync
in interface AmazonWorkDocsAsync
public Future<RestoreDocumentVersionsResult> restoreDocumentVersionsAsync(RestoreDocumentVersionsRequest request, AsyncHandler<RestoreDocumentVersionsRequest,RestoreDocumentVersionsResult> asyncHandler)
AmazonWorkDocsAsync
Recovers a deleted version of an Amazon WorkDocs document.
restoreDocumentVersionsAsync
in interface AmazonWorkDocsAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<SearchResourcesResult> searchResourcesAsync(SearchResourcesRequest request)
AmazonWorkDocsAsync
Searches metadata and the content of folders, documents, document versions, and comments.
searchResourcesAsync
in interface AmazonWorkDocsAsync
public Future<SearchResourcesResult> searchResourcesAsync(SearchResourcesRequest request, AsyncHandler<SearchResourcesRequest,SearchResourcesResult> asyncHandler)
AmazonWorkDocsAsync
Searches metadata and the content of folders, documents, document versions, and comments.
searchResourcesAsync
in interface AmazonWorkDocsAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<UpdateDocumentResult> updateDocumentAsync(UpdateDocumentRequest request)
AmazonWorkDocsAsync
Updates the specified attributes of a document. The user must have access to both the document and its parent folder, if applicable.
updateDocumentAsync
in interface AmazonWorkDocsAsync
public Future<UpdateDocumentResult> updateDocumentAsync(UpdateDocumentRequest request, AsyncHandler<UpdateDocumentRequest,UpdateDocumentResult> asyncHandler)
AmazonWorkDocsAsync
Updates the specified attributes of a document. The user must have access to both the document and its parent folder, if applicable.
updateDocumentAsync
in interface AmazonWorkDocsAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<UpdateDocumentVersionResult> updateDocumentVersionAsync(UpdateDocumentVersionRequest request)
AmazonWorkDocsAsync
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.
updateDocumentVersionAsync
in interface AmazonWorkDocsAsync
public Future<UpdateDocumentVersionResult> updateDocumentVersionAsync(UpdateDocumentVersionRequest request, AsyncHandler<UpdateDocumentVersionRequest,UpdateDocumentVersionResult> asyncHandler)
AmazonWorkDocsAsync
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.
updateDocumentVersionAsync
in interface AmazonWorkDocsAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<UpdateFolderResult> updateFolderAsync(UpdateFolderRequest request)
AmazonWorkDocsAsync
Updates the specified attributes of the specified folder. The user must have access to both the folder and its parent folder, if applicable.
updateFolderAsync
in interface AmazonWorkDocsAsync
public Future<UpdateFolderResult> updateFolderAsync(UpdateFolderRequest request, AsyncHandler<UpdateFolderRequest,UpdateFolderResult> asyncHandler)
AmazonWorkDocsAsync
Updates the specified attributes of the specified folder. The user must have access to both the folder and its parent folder, if applicable.
updateFolderAsync
in interface AmazonWorkDocsAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<UpdateUserResult> updateUserAsync(UpdateUserRequest request)
AmazonWorkDocsAsync
Updates the specified attributes of the specified user, and grants or revokes administrative privileges to the Amazon WorkDocs site.
updateUserAsync
in interface AmazonWorkDocsAsync
public Future<UpdateUserResult> updateUserAsync(UpdateUserRequest request, AsyncHandler<UpdateUserRequest,UpdateUserResult> asyncHandler)
AmazonWorkDocsAsync
Updates the specified attributes of the specified user, and grants or revokes administrative privileges to the Amazon WorkDocs site.
updateUserAsync
in interface AmazonWorkDocsAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public void shutdown()
getExecutorService().shutdown()
followed by getExecutorService().awaitTermination()
prior to
calling this method.shutdown
in interface AmazonWorkDocs
shutdown
in class AmazonWorkDocsClient