@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 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.
LOGGING_AWS_REQUEST_METRICENDPOINT_PREFIXabortDocumentVersionUpload, activateUser, addResourcePermissions, builder, createComment, createCustomMetadata, createFolder, createLabels, createNotificationSubscription, createUser, deactivateUser, deleteComment, deleteCustomMetadata, deleteDocument, 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, updateDocument, updateDocumentVersion, updateFolder, updateUseraddRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffsetequals, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitabortDocumentVersionUpload, activateUser, addResourcePermissions, createComment, createCustomMetadata, createFolder, createLabels, createNotificationSubscription, createUser, deactivateUser, deleteComment, deleteCustomMetadata, deleteDocument, 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, updateDocument, updateDocumentVersion, updateFolder, updateUserpublic static AmazonWorkDocsAsyncClientBuilder asyncBuilder()
public ExecutorService getExecutorService()
public Future<AbortDocumentVersionUploadResult> abortDocumentVersionUploadAsync(AbortDocumentVersionUploadRequest request)
AmazonWorkDocsAsyncAborts 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 AmazonWorkDocsAsyncpublic Future<AbortDocumentVersionUploadResult> abortDocumentVersionUploadAsync(AbortDocumentVersionUploadRequest request, AsyncHandler<AbortDocumentVersionUploadRequest,AbortDocumentVersionUploadResult> asyncHandler)
AmazonWorkDocsAsyncAborts 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 AmazonWorkDocsAsyncasyncHandler - 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)
AmazonWorkDocsAsyncActivates the specified user. Only active users can access Amazon WorkDocs.
activateUserAsync in interface AmazonWorkDocsAsyncpublic Future<ActivateUserResult> activateUserAsync(ActivateUserRequest request, AsyncHandler<ActivateUserRequest,ActivateUserResult> asyncHandler)
AmazonWorkDocsAsyncActivates the specified user. Only active users can access Amazon WorkDocs.
activateUserAsync in interface AmazonWorkDocsAsyncasyncHandler - 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)
AmazonWorkDocsAsyncCreates 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 AmazonWorkDocsAsyncpublic Future<AddResourcePermissionsResult> addResourcePermissionsAsync(AddResourcePermissionsRequest request, AsyncHandler<AddResourcePermissionsRequest,AddResourcePermissionsResult> asyncHandler)
AmazonWorkDocsAsyncCreates 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 AmazonWorkDocsAsyncasyncHandler - 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)
AmazonWorkDocsAsyncAdds a new comment to the specified document version.
createCommentAsync in interface AmazonWorkDocsAsyncpublic Future<CreateCommentResult> createCommentAsync(CreateCommentRequest request, AsyncHandler<CreateCommentRequest,CreateCommentResult> asyncHandler)
AmazonWorkDocsAsyncAdds a new comment to the specified document version.
createCommentAsync in interface AmazonWorkDocsAsyncasyncHandler - 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)
AmazonWorkDocsAsyncAdds one or more custom properties to the specified resource (a folder, document, or version).
createCustomMetadataAsync in interface AmazonWorkDocsAsyncpublic Future<CreateCustomMetadataResult> createCustomMetadataAsync(CreateCustomMetadataRequest request, AsyncHandler<CreateCustomMetadataRequest,CreateCustomMetadataResult> asyncHandler)
AmazonWorkDocsAsyncAdds one or more custom properties to the specified resource (a folder, document, or version).
createCustomMetadataAsync in interface AmazonWorkDocsAsyncasyncHandler - 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)
AmazonWorkDocsAsyncCreates a folder with the specified name and parent folder.
createFolderAsync in interface AmazonWorkDocsAsyncpublic Future<CreateFolderResult> createFolderAsync(CreateFolderRequest request, AsyncHandler<CreateFolderRequest,CreateFolderResult> asyncHandler)
AmazonWorkDocsAsyncCreates a folder with the specified name and parent folder.
createFolderAsync in interface AmazonWorkDocsAsyncasyncHandler - 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)
AmazonWorkDocsAsyncAdds the specified list of labels to the given resource (a document or folder)
createLabelsAsync in interface AmazonWorkDocsAsyncpublic Future<CreateLabelsResult> createLabelsAsync(CreateLabelsRequest request, AsyncHandler<CreateLabelsRequest,CreateLabelsResult> asyncHandler)
AmazonWorkDocsAsyncAdds the specified list of labels to the given resource (a document or folder)
createLabelsAsync in interface AmazonWorkDocsAsyncasyncHandler - 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)
AmazonWorkDocsAsyncConfigure Amazon WorkDocs to use Amazon SNS notifications. The endpoint receives a confirmation message, and must confirm the subscription.
For more information, see Subscribe to Notifications in the Amazon WorkDocs Developer Guide.
createNotificationSubscriptionAsync in interface AmazonWorkDocsAsyncpublic Future<CreateNotificationSubscriptionResult> createNotificationSubscriptionAsync(CreateNotificationSubscriptionRequest request, AsyncHandler<CreateNotificationSubscriptionRequest,CreateNotificationSubscriptionResult> asyncHandler)
AmazonWorkDocsAsyncConfigure Amazon WorkDocs to use Amazon SNS notifications. The endpoint receives a confirmation message, and must confirm the subscription.
For more information, see Subscribe to Notifications in the Amazon WorkDocs Developer Guide.
createNotificationSubscriptionAsync in interface AmazonWorkDocsAsyncasyncHandler - 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)
AmazonWorkDocsAsyncCreates 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 AmazonWorkDocsAsyncpublic Future<CreateUserResult> createUserAsync(CreateUserRequest request, AsyncHandler<CreateUserRequest,CreateUserResult> asyncHandler)
AmazonWorkDocsAsyncCreates 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 AmazonWorkDocsAsyncasyncHandler - 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)
AmazonWorkDocsAsyncDeactivates the specified user, which revokes the user's access to Amazon WorkDocs.
deactivateUserAsync in interface AmazonWorkDocsAsyncpublic Future<DeactivateUserResult> deactivateUserAsync(DeactivateUserRequest request, AsyncHandler<DeactivateUserRequest,DeactivateUserResult> asyncHandler)
AmazonWorkDocsAsyncDeactivates the specified user, which revokes the user's access to Amazon WorkDocs.
deactivateUserAsync in interface AmazonWorkDocsAsyncasyncHandler - 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)
AmazonWorkDocsAsyncDeletes the specified comment from the document version.
deleteCommentAsync in interface AmazonWorkDocsAsyncpublic Future<DeleteCommentResult> deleteCommentAsync(DeleteCommentRequest request, AsyncHandler<DeleteCommentRequest,DeleteCommentResult> asyncHandler)
AmazonWorkDocsAsyncDeletes the specified comment from the document version.
deleteCommentAsync in interface AmazonWorkDocsAsyncasyncHandler - 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)
AmazonWorkDocsAsyncDeletes custom metadata from the specified resource.
deleteCustomMetadataAsync in interface AmazonWorkDocsAsyncpublic Future<DeleteCustomMetadataResult> deleteCustomMetadataAsync(DeleteCustomMetadataRequest request, AsyncHandler<DeleteCustomMetadataRequest,DeleteCustomMetadataResult> asyncHandler)
AmazonWorkDocsAsyncDeletes custom metadata from the specified resource.
deleteCustomMetadataAsync in interface AmazonWorkDocsAsyncasyncHandler - 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)
AmazonWorkDocsAsyncPermanently deletes the specified document and its associated metadata.
deleteDocumentAsync in interface AmazonWorkDocsAsyncpublic Future<DeleteDocumentResult> deleteDocumentAsync(DeleteDocumentRequest request, AsyncHandler<DeleteDocumentRequest,DeleteDocumentResult> asyncHandler)
AmazonWorkDocsAsyncPermanently deletes the specified document and its associated metadata.
deleteDocumentAsync in interface AmazonWorkDocsAsyncasyncHandler - 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)
AmazonWorkDocsAsyncPermanently deletes the specified folder and its contents.
deleteFolderAsync in interface AmazonWorkDocsAsyncpublic Future<DeleteFolderResult> deleteFolderAsync(DeleteFolderRequest request, AsyncHandler<DeleteFolderRequest,DeleteFolderResult> asyncHandler)
AmazonWorkDocsAsyncPermanently deletes the specified folder and its contents.
deleteFolderAsync in interface AmazonWorkDocsAsyncasyncHandler - 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)
AmazonWorkDocsAsyncDeletes the contents of the specified folder.
deleteFolderContentsAsync in interface AmazonWorkDocsAsyncpublic Future<DeleteFolderContentsResult> deleteFolderContentsAsync(DeleteFolderContentsRequest request, AsyncHandler<DeleteFolderContentsRequest,DeleteFolderContentsResult> asyncHandler)
AmazonWorkDocsAsyncDeletes the contents of the specified folder.
deleteFolderContentsAsync in interface AmazonWorkDocsAsyncasyncHandler - 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)
AmazonWorkDocsAsyncDeletes the specified list of labels from a resource.
deleteLabelsAsync in interface AmazonWorkDocsAsyncpublic Future<DeleteLabelsResult> deleteLabelsAsync(DeleteLabelsRequest request, AsyncHandler<DeleteLabelsRequest,DeleteLabelsResult> asyncHandler)
AmazonWorkDocsAsyncDeletes the specified list of labels from a resource.
deleteLabelsAsync in interface AmazonWorkDocsAsyncasyncHandler - 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)
AmazonWorkDocsAsyncDeletes the specified subscription from the specified organization.
deleteNotificationSubscriptionAsync in interface AmazonWorkDocsAsyncpublic Future<DeleteNotificationSubscriptionResult> deleteNotificationSubscriptionAsync(DeleteNotificationSubscriptionRequest request, AsyncHandler<DeleteNotificationSubscriptionRequest,DeleteNotificationSubscriptionResult> asyncHandler)
AmazonWorkDocsAsyncDeletes the specified subscription from the specified organization.
deleteNotificationSubscriptionAsync in interface AmazonWorkDocsAsyncasyncHandler - 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)
AmazonWorkDocsAsyncDeletes the specified user from a Simple AD or Microsoft AD directory.
deleteUserAsync in interface AmazonWorkDocsAsyncpublic Future<DeleteUserResult> deleteUserAsync(DeleteUserRequest request, AsyncHandler<DeleteUserRequest,DeleteUserResult> asyncHandler)
AmazonWorkDocsAsyncDeletes the specified user from a Simple AD or Microsoft AD directory.
deleteUserAsync in interface AmazonWorkDocsAsyncasyncHandler - 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)
AmazonWorkDocsAsyncDescribes the user activities in a specified time period.
describeActivitiesAsync in interface AmazonWorkDocsAsyncpublic Future<DescribeActivitiesResult> describeActivitiesAsync(DescribeActivitiesRequest request, AsyncHandler<DescribeActivitiesRequest,DescribeActivitiesResult> asyncHandler)
AmazonWorkDocsAsyncDescribes the user activities in a specified time period.
describeActivitiesAsync in interface AmazonWorkDocsAsyncasyncHandler - 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)
AmazonWorkDocsAsyncList all the comments for the specified document version.
describeCommentsAsync in interface AmazonWorkDocsAsyncpublic Future<DescribeCommentsResult> describeCommentsAsync(DescribeCommentsRequest request, AsyncHandler<DescribeCommentsRequest,DescribeCommentsResult> asyncHandler)
AmazonWorkDocsAsyncList all the comments for the specified document version.
describeCommentsAsync in interface AmazonWorkDocsAsyncasyncHandler - 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)
AmazonWorkDocsAsyncRetrieves the document versions for the specified document.
By default, only active versions are returned.
describeDocumentVersionsAsync in interface AmazonWorkDocsAsyncpublic Future<DescribeDocumentVersionsResult> describeDocumentVersionsAsync(DescribeDocumentVersionsRequest request, AsyncHandler<DescribeDocumentVersionsRequest,DescribeDocumentVersionsResult> asyncHandler)
AmazonWorkDocsAsyncRetrieves the document versions for the specified document.
By default, only active versions are returned.
describeDocumentVersionsAsync in interface AmazonWorkDocsAsyncasyncHandler - 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)
AmazonWorkDocsAsyncDescribes 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 AmazonWorkDocsAsyncpublic Future<DescribeFolderContentsResult> describeFolderContentsAsync(DescribeFolderContentsRequest request, AsyncHandler<DescribeFolderContentsRequest,DescribeFolderContentsResult> asyncHandler)
AmazonWorkDocsAsyncDescribes 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 AmazonWorkDocsAsyncasyncHandler - 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)
AmazonWorkDocsAsyncDescribes the groups specified by the query. Groups are defined by the underlying Active Directory.
describeGroupsAsync in interface AmazonWorkDocsAsyncpublic Future<DescribeGroupsResult> describeGroupsAsync(DescribeGroupsRequest request, AsyncHandler<DescribeGroupsRequest,DescribeGroupsResult> asyncHandler)
AmazonWorkDocsAsyncDescribes the groups specified by the query. Groups are defined by the underlying Active Directory.
describeGroupsAsync in interface AmazonWorkDocsAsyncasyncHandler - 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)
AmazonWorkDocsAsyncLists the specified notification subscriptions.
describeNotificationSubscriptionsAsync in interface AmazonWorkDocsAsyncpublic Future<DescribeNotificationSubscriptionsResult> describeNotificationSubscriptionsAsync(DescribeNotificationSubscriptionsRequest request, AsyncHandler<DescribeNotificationSubscriptionsRequest,DescribeNotificationSubscriptionsResult> asyncHandler)
AmazonWorkDocsAsyncLists the specified notification subscriptions.
describeNotificationSubscriptionsAsync in interface AmazonWorkDocsAsyncasyncHandler - 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)
AmazonWorkDocsAsyncDescribes the permissions of a specified resource.
describeResourcePermissionsAsync in interface AmazonWorkDocsAsyncpublic Future<DescribeResourcePermissionsResult> describeResourcePermissionsAsync(DescribeResourcePermissionsRequest request, AsyncHandler<DescribeResourcePermissionsRequest,DescribeResourcePermissionsResult> asyncHandler)
AmazonWorkDocsAsyncDescribes the permissions of a specified resource.
describeResourcePermissionsAsync in interface AmazonWorkDocsAsyncasyncHandler - 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 AmazonWorkDocsAsyncpublic 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 AmazonWorkDocsAsyncasyncHandler - 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)
AmazonWorkDocsAsyncDescribes 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 AmazonWorkDocsAsyncpublic Future<DescribeUsersResult> describeUsersAsync(DescribeUsersRequest request, AsyncHandler<DescribeUsersRequest,DescribeUsersResult> asyncHandler)
AmazonWorkDocsAsyncDescribes 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 AmazonWorkDocsAsyncasyncHandler - 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)
AmazonWorkDocsAsyncRetrieves 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 AmazonWorkDocsAsyncpublic Future<GetCurrentUserResult> getCurrentUserAsync(GetCurrentUserRequest request, AsyncHandler<GetCurrentUserRequest,GetCurrentUserResult> asyncHandler)
AmazonWorkDocsAsyncRetrieves 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 AmazonWorkDocsAsyncasyncHandler - 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)
AmazonWorkDocsAsyncRetrieves details of a document.
getDocumentAsync in interface AmazonWorkDocsAsyncpublic Future<GetDocumentResult> getDocumentAsync(GetDocumentRequest request, AsyncHandler<GetDocumentRequest,GetDocumentResult> asyncHandler)
AmazonWorkDocsAsyncRetrieves details of a document.
getDocumentAsync in interface AmazonWorkDocsAsyncasyncHandler - 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)
AmazonWorkDocsAsyncRetrieves 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 AmazonWorkDocsAsyncpublic Future<GetDocumentPathResult> getDocumentPathAsync(GetDocumentPathRequest request, AsyncHandler<GetDocumentPathRequest,GetDocumentPathResult> asyncHandler)
AmazonWorkDocsAsyncRetrieves 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 AmazonWorkDocsAsyncasyncHandler - 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)
AmazonWorkDocsAsyncRetrieves version metadata for the specified document.
getDocumentVersionAsync in interface AmazonWorkDocsAsyncpublic Future<GetDocumentVersionResult> getDocumentVersionAsync(GetDocumentVersionRequest request, AsyncHandler<GetDocumentVersionRequest,GetDocumentVersionResult> asyncHandler)
AmazonWorkDocsAsyncRetrieves version metadata for the specified document.
getDocumentVersionAsync in interface AmazonWorkDocsAsyncasyncHandler - 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)
AmazonWorkDocsAsyncRetrieves the metadata of the specified folder.
getFolderAsync in interface AmazonWorkDocsAsyncpublic Future<GetFolderResult> getFolderAsync(GetFolderRequest request, AsyncHandler<GetFolderRequest,GetFolderResult> asyncHandler)
AmazonWorkDocsAsyncRetrieves the metadata of the specified folder.
getFolderAsync in interface AmazonWorkDocsAsyncasyncHandler - 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)
AmazonWorkDocsAsyncRetrieves 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 AmazonWorkDocsAsyncpublic Future<GetFolderPathResult> getFolderPathAsync(GetFolderPathRequest request, AsyncHandler<GetFolderPathRequest,GetFolderPathResult> asyncHandler)
AmazonWorkDocsAsyncRetrieves 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 AmazonWorkDocsAsyncasyncHandler - 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 AmazonWorkDocsAsyncpublic 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 AmazonWorkDocsAsyncasyncHandler - 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)
AmazonWorkDocsAsyncCreates 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 AmazonWorkDocsAsyncpublic Future<InitiateDocumentVersionUploadResult> initiateDocumentVersionUploadAsync(InitiateDocumentVersionUploadRequest request, AsyncHandler<InitiateDocumentVersionUploadRequest,InitiateDocumentVersionUploadResult> asyncHandler)
AmazonWorkDocsAsyncCreates 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 AmazonWorkDocsAsyncasyncHandler - 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)
AmazonWorkDocsAsyncRemoves all the permissions from the specified resource.
removeAllResourcePermissionsAsync in interface AmazonWorkDocsAsyncpublic Future<RemoveAllResourcePermissionsResult> removeAllResourcePermissionsAsync(RemoveAllResourcePermissionsRequest request, AsyncHandler<RemoveAllResourcePermissionsRequest,RemoveAllResourcePermissionsResult> asyncHandler)
AmazonWorkDocsAsyncRemoves all the permissions from the specified resource.
removeAllResourcePermissionsAsync in interface AmazonWorkDocsAsyncasyncHandler - 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)
AmazonWorkDocsAsyncRemoves the permission for the specified principal from the specified resource.
removeResourcePermissionAsync in interface AmazonWorkDocsAsyncpublic Future<RemoveResourcePermissionResult> removeResourcePermissionAsync(RemoveResourcePermissionRequest request, AsyncHandler<RemoveResourcePermissionRequest,RemoveResourcePermissionResult> asyncHandler)
AmazonWorkDocsAsyncRemoves the permission for the specified principal from the specified resource.
removeResourcePermissionAsync in interface AmazonWorkDocsAsyncasyncHandler - 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)
AmazonWorkDocsAsyncUpdates the specified attributes of a document. The user must have access to both the document and its parent folder, if applicable.
updateDocumentAsync in interface AmazonWorkDocsAsyncpublic Future<UpdateDocumentResult> updateDocumentAsync(UpdateDocumentRequest request, AsyncHandler<UpdateDocumentRequest,UpdateDocumentResult> asyncHandler)
AmazonWorkDocsAsyncUpdates the specified attributes of a document. The user must have access to both the document and its parent folder, if applicable.
updateDocumentAsync in interface AmazonWorkDocsAsyncasyncHandler - 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)
AmazonWorkDocsAsyncChanges 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 AmazonWorkDocsAsyncpublic Future<UpdateDocumentVersionResult> updateDocumentVersionAsync(UpdateDocumentVersionRequest request, AsyncHandler<UpdateDocumentVersionRequest,UpdateDocumentVersionResult> asyncHandler)
AmazonWorkDocsAsyncChanges 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 AmazonWorkDocsAsyncasyncHandler - 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)
AmazonWorkDocsAsyncUpdates 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 AmazonWorkDocsAsyncpublic Future<UpdateFolderResult> updateFolderAsync(UpdateFolderRequest request, AsyncHandler<UpdateFolderRequest,UpdateFolderResult> asyncHandler)
AmazonWorkDocsAsyncUpdates 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 AmazonWorkDocsAsyncasyncHandler - 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)
AmazonWorkDocsAsyncUpdates the specified attributes of the specified user, and grants or revokes administrative privileges to the Amazon WorkDocs site.
updateUserAsync in interface AmazonWorkDocsAsyncpublic Future<UpdateUserResult> updateUserAsync(UpdateUserRequest request, AsyncHandler<UpdateUserRequest,UpdateUserResult> asyncHandler)
AmazonWorkDocsAsyncUpdates the specified attributes of the specified user, and grants or revokes administrative privileges to the Amazon WorkDocs site.
updateUserAsync in interface AmazonWorkDocsAsyncasyncHandler - 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 AmazonWorkDocsshutdown in class AmazonWorkDocsClient