@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public interface AmazonWorkDocsAsync extends AmazonWorkDocs
AsyncHandler can be used to receive
notification when an asynchronous operation completes.
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
AbstractAmazonWorkDocsAsync instead.
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.
ENDPOINT_PREFIXabortDocumentVersionUpload, 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, shutdown, updateDocument, updateDocumentVersion, updateFolder, updateUserFuture<AbortDocumentVersionUploadResult> abortDocumentVersionUploadAsync(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 - Future<AbortDocumentVersionUploadResult> abortDocumentVersionUploadAsync(AbortDocumentVersionUploadRequest abortDocumentVersionUploadRequest, AsyncHandler<AbortDocumentVersionUploadRequest,AbortDocumentVersionUploadResult> asyncHandler)
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 - 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.Future<ActivateUserResult> activateUserAsync(ActivateUserRequest activateUserRequest)
Activates the specified user. Only active users can access Amazon WorkDocs.
activateUserRequest - Future<ActivateUserResult> activateUserAsync(ActivateUserRequest activateUserRequest, AsyncHandler<ActivateUserRequest,ActivateUserResult> asyncHandler)
Activates the specified user. Only active users can access Amazon WorkDocs.
activateUserRequest - 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.Future<AddResourcePermissionsResult> addResourcePermissionsAsync(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 - Future<AddResourcePermissionsResult> addResourcePermissionsAsync(AddResourcePermissionsRequest addResourcePermissionsRequest, AsyncHandler<AddResourcePermissionsRequest,AddResourcePermissionsResult> asyncHandler)
Creates a set of permissions for the specified folder or document. The resource permissions are overwritten if the principals already have different permissions.
addResourcePermissionsRequest - 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.Future<CreateCommentResult> createCommentAsync(CreateCommentRequest createCommentRequest)
Adds a new comment to the specified document version.
createCommentRequest - Future<CreateCommentResult> createCommentAsync(CreateCommentRequest createCommentRequest, AsyncHandler<CreateCommentRequest,CreateCommentResult> asyncHandler)
Adds a new comment to the specified document version.
createCommentRequest - 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.Future<CreateCustomMetadataResult> createCustomMetadataAsync(CreateCustomMetadataRequest createCustomMetadataRequest)
Adds one or more custom properties to the specified resource (a folder, document, or version).
createCustomMetadataRequest - Future<CreateCustomMetadataResult> createCustomMetadataAsync(CreateCustomMetadataRequest createCustomMetadataRequest, AsyncHandler<CreateCustomMetadataRequest,CreateCustomMetadataResult> asyncHandler)
Adds one or more custom properties to the specified resource (a folder, document, or version).
createCustomMetadataRequest - 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.Future<CreateFolderResult> createFolderAsync(CreateFolderRequest createFolderRequest)
Creates a folder with the specified name and parent folder.
createFolderRequest - Future<CreateFolderResult> createFolderAsync(CreateFolderRequest createFolderRequest, AsyncHandler<CreateFolderRequest,CreateFolderResult> asyncHandler)
Creates a folder with the specified name and parent folder.
createFolderRequest - 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.Future<CreateLabelsResult> createLabelsAsync(CreateLabelsRequest createLabelsRequest)
Adds the specified list of labels to the given resource (a document or folder)
createLabelsRequest - Future<CreateLabelsResult> createLabelsAsync(CreateLabelsRequest createLabelsRequest, AsyncHandler<CreateLabelsRequest,CreateLabelsResult> asyncHandler)
Adds the specified list of labels to the given resource (a document or folder)
createLabelsRequest - 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.Future<CreateNotificationSubscriptionResult> createNotificationSubscriptionAsync(CreateNotificationSubscriptionRequest createNotificationSubscriptionRequest)
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.
createNotificationSubscriptionRequest - Future<CreateNotificationSubscriptionResult> createNotificationSubscriptionAsync(CreateNotificationSubscriptionRequest createNotificationSubscriptionRequest, AsyncHandler<CreateNotificationSubscriptionRequest,CreateNotificationSubscriptionResult> asyncHandler)
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.
createNotificationSubscriptionRequest - 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.Future<CreateUserResult> createUserAsync(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 - Future<CreateUserResult> createUserAsync(CreateUserRequest createUserRequest, AsyncHandler<CreateUserRequest,CreateUserResult> asyncHandler)
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 - 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.Future<DeactivateUserResult> deactivateUserAsync(DeactivateUserRequest deactivateUserRequest)
Deactivates the specified user, which revokes the user's access to Amazon WorkDocs.
deactivateUserRequest - Future<DeactivateUserResult> deactivateUserAsync(DeactivateUserRequest deactivateUserRequest, AsyncHandler<DeactivateUserRequest,DeactivateUserResult> asyncHandler)
Deactivates the specified user, which revokes the user's access to Amazon WorkDocs.
deactivateUserRequest - 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.Future<DeleteCommentResult> deleteCommentAsync(DeleteCommentRequest deleteCommentRequest)
Deletes the specified comment from the document version.
deleteCommentRequest - Future<DeleteCommentResult> deleteCommentAsync(DeleteCommentRequest deleteCommentRequest, AsyncHandler<DeleteCommentRequest,DeleteCommentResult> asyncHandler)
Deletes the specified comment from the document version.
deleteCommentRequest - 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.Future<DeleteCustomMetadataResult> deleteCustomMetadataAsync(DeleteCustomMetadataRequest deleteCustomMetadataRequest)
Deletes custom metadata from the specified resource.
deleteCustomMetadataRequest - Future<DeleteCustomMetadataResult> deleteCustomMetadataAsync(DeleteCustomMetadataRequest deleteCustomMetadataRequest, AsyncHandler<DeleteCustomMetadataRequest,DeleteCustomMetadataResult> asyncHandler)
Deletes custom metadata from the specified resource.
deleteCustomMetadataRequest - 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.Future<DeleteDocumentResult> deleteDocumentAsync(DeleteDocumentRequest deleteDocumentRequest)
Permanently deletes the specified document and its associated metadata.
deleteDocumentRequest - Future<DeleteDocumentResult> deleteDocumentAsync(DeleteDocumentRequest deleteDocumentRequest, AsyncHandler<DeleteDocumentRequest,DeleteDocumentResult> asyncHandler)
Permanently deletes the specified document and its associated metadata.
deleteDocumentRequest - 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.Future<DeleteDocumentVersionResult> deleteDocumentVersionAsync(DeleteDocumentVersionRequest deleteDocumentVersionRequest)
Deletes a specific version of a document.
deleteDocumentVersionRequest - Future<DeleteDocumentVersionResult> deleteDocumentVersionAsync(DeleteDocumentVersionRequest deleteDocumentVersionRequest, AsyncHandler<DeleteDocumentVersionRequest,DeleteDocumentVersionResult> asyncHandler)
Deletes a specific version of a document.
deleteDocumentVersionRequest - 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.Future<DeleteFolderResult> deleteFolderAsync(DeleteFolderRequest deleteFolderRequest)
Permanently deletes the specified folder and its contents.
deleteFolderRequest - Future<DeleteFolderResult> deleteFolderAsync(DeleteFolderRequest deleteFolderRequest, AsyncHandler<DeleteFolderRequest,DeleteFolderResult> asyncHandler)
Permanently deletes the specified folder and its contents.
deleteFolderRequest - 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.Future<DeleteFolderContentsResult> deleteFolderContentsAsync(DeleteFolderContentsRequest deleteFolderContentsRequest)
Deletes the contents of the specified folder.
deleteFolderContentsRequest - Future<DeleteFolderContentsResult> deleteFolderContentsAsync(DeleteFolderContentsRequest deleteFolderContentsRequest, AsyncHandler<DeleteFolderContentsRequest,DeleteFolderContentsResult> asyncHandler)
Deletes the contents of the specified folder.
deleteFolderContentsRequest - 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.Future<DeleteLabelsResult> deleteLabelsAsync(DeleteLabelsRequest deleteLabelsRequest)
Deletes the specified list of labels from a resource.
deleteLabelsRequest - Future<DeleteLabelsResult> deleteLabelsAsync(DeleteLabelsRequest deleteLabelsRequest, AsyncHandler<DeleteLabelsRequest,DeleteLabelsResult> asyncHandler)
Deletes the specified list of labels from a resource.
deleteLabelsRequest - 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.Future<DeleteNotificationSubscriptionResult> deleteNotificationSubscriptionAsync(DeleteNotificationSubscriptionRequest deleteNotificationSubscriptionRequest)
Deletes the specified subscription from the specified organization.
deleteNotificationSubscriptionRequest - Future<DeleteNotificationSubscriptionResult> deleteNotificationSubscriptionAsync(DeleteNotificationSubscriptionRequest deleteNotificationSubscriptionRequest, AsyncHandler<DeleteNotificationSubscriptionRequest,DeleteNotificationSubscriptionResult> asyncHandler)
Deletes the specified subscription from the specified organization.
deleteNotificationSubscriptionRequest - 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.Future<DeleteUserResult> deleteUserAsync(DeleteUserRequest deleteUserRequest)
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.
deleteUserRequest - Future<DeleteUserResult> deleteUserAsync(DeleteUserRequest deleteUserRequest, AsyncHandler<DeleteUserRequest,DeleteUserResult> asyncHandler)
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.
deleteUserRequest - 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.Future<DescribeActivitiesResult> describeActivitiesAsync(DescribeActivitiesRequest describeActivitiesRequest)
Describes the user activities in a specified time period.
describeActivitiesRequest - Future<DescribeActivitiesResult> describeActivitiesAsync(DescribeActivitiesRequest describeActivitiesRequest, AsyncHandler<DescribeActivitiesRequest,DescribeActivitiesResult> asyncHandler)
Describes the user activities in a specified time period.
describeActivitiesRequest - 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.Future<DescribeCommentsResult> describeCommentsAsync(DescribeCommentsRequest describeCommentsRequest)
List all the comments for the specified document version.
describeCommentsRequest - Future<DescribeCommentsResult> describeCommentsAsync(DescribeCommentsRequest describeCommentsRequest, AsyncHandler<DescribeCommentsRequest,DescribeCommentsResult> asyncHandler)
List all the comments for the specified document version.
describeCommentsRequest - 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.Future<DescribeDocumentVersionsResult> describeDocumentVersionsAsync(DescribeDocumentVersionsRequest describeDocumentVersionsRequest)
Retrieves the document versions for the specified document.
By default, only active versions are returned.
describeDocumentVersionsRequest - Future<DescribeDocumentVersionsResult> describeDocumentVersionsAsync(DescribeDocumentVersionsRequest describeDocumentVersionsRequest, AsyncHandler<DescribeDocumentVersionsRequest,DescribeDocumentVersionsResult> asyncHandler)
Retrieves the document versions for the specified document.
By default, only active versions are returned.
describeDocumentVersionsRequest - 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.Future<DescribeFolderContentsResult> describeFolderContentsAsync(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 - Future<DescribeFolderContentsResult> describeFolderContentsAsync(DescribeFolderContentsRequest describeFolderContentsRequest, AsyncHandler<DescribeFolderContentsRequest,DescribeFolderContentsResult> asyncHandler)
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 - 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.Future<DescribeGroupsResult> describeGroupsAsync(DescribeGroupsRequest describeGroupsRequest)
Describes the groups specified by the query. Groups are defined by the underlying Active Directory.
describeGroupsRequest - Future<DescribeGroupsResult> describeGroupsAsync(DescribeGroupsRequest describeGroupsRequest, AsyncHandler<DescribeGroupsRequest,DescribeGroupsResult> asyncHandler)
Describes the groups specified by the query. Groups are defined by the underlying Active Directory.
describeGroupsRequest - 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.Future<DescribeNotificationSubscriptionsResult> describeNotificationSubscriptionsAsync(DescribeNotificationSubscriptionsRequest describeNotificationSubscriptionsRequest)
Lists the specified notification subscriptions.
describeNotificationSubscriptionsRequest - Future<DescribeNotificationSubscriptionsResult> describeNotificationSubscriptionsAsync(DescribeNotificationSubscriptionsRequest describeNotificationSubscriptionsRequest, AsyncHandler<DescribeNotificationSubscriptionsRequest,DescribeNotificationSubscriptionsResult> asyncHandler)
Lists the specified notification subscriptions.
describeNotificationSubscriptionsRequest - 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.Future<DescribeResourcePermissionsResult> describeResourcePermissionsAsync(DescribeResourcePermissionsRequest describeResourcePermissionsRequest)
Describes the permissions of a specified resource.
describeResourcePermissionsRequest - Future<DescribeResourcePermissionsResult> describeResourcePermissionsAsync(DescribeResourcePermissionsRequest describeResourcePermissionsRequest, AsyncHandler<DescribeResourcePermissionsRequest,DescribeResourcePermissionsResult> asyncHandler)
Describes the permissions of a specified resource.
describeResourcePermissionsRequest - 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.Future<DescribeRootFoldersResult> describeRootFoldersAsync(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.
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.
describeRootFoldersRequest - Future<DescribeRootFoldersResult> describeRootFoldersAsync(DescribeRootFoldersRequest describeRootFoldersRequest, AsyncHandler<DescribeRootFoldersRequest,DescribeRootFoldersResult> asyncHandler)
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.
describeRootFoldersRequest - 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.Future<DescribeUsersResult> describeUsersAsync(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 - Future<DescribeUsersResult> describeUsersAsync(DescribeUsersRequest describeUsersRequest, AsyncHandler<DescribeUsersRequest,DescribeUsersResult> asyncHandler)
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 - 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.Future<GetCurrentUserResult> getCurrentUserAsync(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.
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.
getCurrentUserRequest - Future<GetCurrentUserResult> getCurrentUserAsync(GetCurrentUserRequest getCurrentUserRequest, AsyncHandler<GetCurrentUserRequest,GetCurrentUserResult> asyncHandler)
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.
getCurrentUserRequest - 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.Future<GetDocumentResult> getDocumentAsync(GetDocumentRequest getDocumentRequest)
Retrieves details of a document.
getDocumentRequest - Future<GetDocumentResult> getDocumentAsync(GetDocumentRequest getDocumentRequest, AsyncHandler<GetDocumentRequest,GetDocumentResult> asyncHandler)
Retrieves details of a document.
getDocumentRequest - 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.Future<GetDocumentPathResult> getDocumentPathAsync(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 - Future<GetDocumentPathResult> getDocumentPathAsync(GetDocumentPathRequest getDocumentPathRequest, AsyncHandler<GetDocumentPathRequest,GetDocumentPathResult> asyncHandler)
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 - 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.Future<GetDocumentVersionResult> getDocumentVersionAsync(GetDocumentVersionRequest getDocumentVersionRequest)
Retrieves version metadata for the specified document.
getDocumentVersionRequest - Future<GetDocumentVersionResult> getDocumentVersionAsync(GetDocumentVersionRequest getDocumentVersionRequest, AsyncHandler<GetDocumentVersionRequest,GetDocumentVersionResult> asyncHandler)
Retrieves version metadata for the specified document.
getDocumentVersionRequest - 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.Future<GetFolderResult> getFolderAsync(GetFolderRequest getFolderRequest)
Retrieves the metadata of the specified folder.
getFolderRequest - Future<GetFolderResult> getFolderAsync(GetFolderRequest getFolderRequest, AsyncHandler<GetFolderRequest,GetFolderResult> asyncHandler)
Retrieves the metadata of the specified folder.
getFolderRequest - 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.Future<GetFolderPathResult> getFolderPathAsync(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 - Future<GetFolderPathResult> getFolderPathAsync(GetFolderPathRequest getFolderPathRequest, AsyncHandler<GetFolderPathRequest,GetFolderPathResult> asyncHandler)
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 - 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.Future<GetResourcesResult> getResourcesAsync(GetResourcesRequest getResourcesRequest)
Retrieves a collection of resources, including folders and documents. The only CollectionType
supported is SHARED_WITH_ME.
getResourcesRequest - Future<GetResourcesResult> getResourcesAsync(GetResourcesRequest getResourcesRequest, AsyncHandler<GetResourcesRequest,GetResourcesResult> asyncHandler)
Retrieves a collection of resources, including folders and documents. The only CollectionType
supported is SHARED_WITH_ME.
getResourcesRequest - 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.Future<InitiateDocumentVersionUploadResult> initiateDocumentVersionUploadAsync(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 - Future<InitiateDocumentVersionUploadResult> initiateDocumentVersionUploadAsync(InitiateDocumentVersionUploadRequest initiateDocumentVersionUploadRequest, AsyncHandler<InitiateDocumentVersionUploadRequest,InitiateDocumentVersionUploadResult> asyncHandler)
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 - 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.Future<RemoveAllResourcePermissionsResult> removeAllResourcePermissionsAsync(RemoveAllResourcePermissionsRequest removeAllResourcePermissionsRequest)
Removes all the permissions from the specified resource.
removeAllResourcePermissionsRequest - Future<RemoveAllResourcePermissionsResult> removeAllResourcePermissionsAsync(RemoveAllResourcePermissionsRequest removeAllResourcePermissionsRequest, AsyncHandler<RemoveAllResourcePermissionsRequest,RemoveAllResourcePermissionsResult> asyncHandler)
Removes all the permissions from the specified resource.
removeAllResourcePermissionsRequest - 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.Future<RemoveResourcePermissionResult> removeResourcePermissionAsync(RemoveResourcePermissionRequest removeResourcePermissionRequest)
Removes the permission for the specified principal from the specified resource.
removeResourcePermissionRequest - Future<RemoveResourcePermissionResult> removeResourcePermissionAsync(RemoveResourcePermissionRequest removeResourcePermissionRequest, AsyncHandler<RemoveResourcePermissionRequest,RemoveResourcePermissionResult> asyncHandler)
Removes the permission for the specified principal from the specified resource.
removeResourcePermissionRequest - 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.Future<RestoreDocumentVersionsResult> restoreDocumentVersionsAsync(RestoreDocumentVersionsRequest restoreDocumentVersionsRequest)
Recovers a deleted version of an Amazon WorkDocs document.
restoreDocumentVersionsRequest - Future<RestoreDocumentVersionsResult> restoreDocumentVersionsAsync(RestoreDocumentVersionsRequest restoreDocumentVersionsRequest, AsyncHandler<RestoreDocumentVersionsRequest,RestoreDocumentVersionsResult> asyncHandler)
Recovers a deleted version of an Amazon WorkDocs document.
restoreDocumentVersionsRequest - 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.Future<SearchResourcesResult> searchResourcesAsync(SearchResourcesRequest searchResourcesRequest)
Searches metadata and the content of folders, documents, document versions, and comments.
searchResourcesRequest - Future<SearchResourcesResult> searchResourcesAsync(SearchResourcesRequest searchResourcesRequest, AsyncHandler<SearchResourcesRequest,SearchResourcesResult> asyncHandler)
Searches metadata and the content of folders, documents, document versions, and comments.
searchResourcesRequest - 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.Future<UpdateDocumentResult> updateDocumentAsync(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 - Future<UpdateDocumentResult> updateDocumentAsync(UpdateDocumentRequest updateDocumentRequest, AsyncHandler<UpdateDocumentRequest,UpdateDocumentResult> asyncHandler)
Updates the specified attributes of a document. The user must have access to both the document and its parent folder, if applicable.
updateDocumentRequest - 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.Future<UpdateDocumentVersionResult> updateDocumentVersionAsync(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 - Future<UpdateDocumentVersionResult> updateDocumentVersionAsync(UpdateDocumentVersionRequest updateDocumentVersionRequest, AsyncHandler<UpdateDocumentVersionRequest,UpdateDocumentVersionResult> asyncHandler)
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 - 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.Future<UpdateFolderResult> updateFolderAsync(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 - Future<UpdateFolderResult> updateFolderAsync(UpdateFolderRequest updateFolderRequest, AsyncHandler<UpdateFolderRequest,UpdateFolderResult> asyncHandler)
Updates the specified attributes of the specified folder. The user must have access to both the folder and its parent folder, if applicable.
updateFolderRequest - 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.Future<UpdateUserResult> updateUserAsync(UpdateUserRequest updateUserRequest)
Updates the specified attributes of the specified user, and grants or revokes administrative privileges to the Amazon WorkDocs site.
updateUserRequest - Future<UpdateUserResult> updateUserAsync(UpdateUserRequest updateUserRequest, AsyncHandler<UpdateUserRequest,UpdateUserResult> asyncHandler)
Updates the specified attributes of the specified user, and grants or revokes administrative privileges to the Amazon WorkDocs site.
updateUserRequest - 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.