@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AbstractAmazonWorkDocs extends Object implements AmazonWorkDocs
AmazonWorkDocs. Convenient method forms pass through to the corresponding overload
that takes a request object, which throws an UnsupportedOperationException.ENDPOINT_PREFIX| Modifier and Type | Method and Description |
|---|---|
AbortDocumentVersionUploadResult |
abortDocumentVersionUpload(AbortDocumentVersionUploadRequest request)
Aborts the upload of the specified document version that was previously initiated by
InitiateDocumentVersionUpload.
|
ActivateUserResult |
activateUser(ActivateUserRequest request)
Activates the specified user.
|
AddResourcePermissionsResult |
addResourcePermissions(AddResourcePermissionsRequest request)
Creates a set of permissions for the specified folder or document.
|
CreateCommentResult |
createComment(CreateCommentRequest request)
Adds a new comment to the specified document version.
|
CreateCustomMetadataResult |
createCustomMetadata(CreateCustomMetadataRequest request)
Adds one or more custom properties to the specified resource (a folder, document, or version).
|
CreateFolderResult |
createFolder(CreateFolderRequest request)
Creates a folder with the specified name and parent folder.
|
CreateLabelsResult |
createLabels(CreateLabelsRequest request)
Adds the specified list of labels to the given resource (a document or folder)
|
CreateNotificationSubscriptionResult |
createNotificationSubscription(CreateNotificationSubscriptionRequest request)
Configure Amazon WorkDocs to use Amazon SNS notifications.
|
CreateUserResult |
createUser(CreateUserRequest request)
Creates a user in a Simple AD or Microsoft AD directory.
|
DeactivateUserResult |
deactivateUser(DeactivateUserRequest request)
Deactivates the specified user, which revokes the user's access to Amazon WorkDocs.
|
DeleteCommentResult |
deleteComment(DeleteCommentRequest request)
Deletes the specified comment from the document version.
|
DeleteCustomMetadataResult |
deleteCustomMetadata(DeleteCustomMetadataRequest request)
Deletes custom metadata from the specified resource.
|
DeleteDocumentResult |
deleteDocument(DeleteDocumentRequest request)
Permanently deletes the specified document and its associated metadata.
|
DeleteFolderResult |
deleteFolder(DeleteFolderRequest request)
Permanently deletes the specified folder and its contents.
|
DeleteFolderContentsResult |
deleteFolderContents(DeleteFolderContentsRequest request)
Deletes the contents of the specified folder.
|
DeleteLabelsResult |
deleteLabels(DeleteLabelsRequest request)
Deletes the specified list of labels from a resource.
|
DeleteNotificationSubscriptionResult |
deleteNotificationSubscription(DeleteNotificationSubscriptionRequest request)
Deletes the specified subscription from the specified organization.
|
DeleteUserResult |
deleteUser(DeleteUserRequest request)
Deletes the specified user from a Simple AD or Microsoft AD directory.
|
DescribeActivitiesResult |
describeActivities(DescribeActivitiesRequest request)
Describes the user activities in a specified time period.
|
DescribeCommentsResult |
describeComments(DescribeCommentsRequest request)
List all the comments for the specified document version.
|
DescribeDocumentVersionsResult |
describeDocumentVersions(DescribeDocumentVersionsRequest request)
Retrieves the document versions for the specified document.
|
DescribeFolderContentsResult |
describeFolderContents(DescribeFolderContentsRequest request)
Describes the contents of the specified folder, including its documents and subfolders.
|
DescribeGroupsResult |
describeGroups(DescribeGroupsRequest request)
Describes the groups specified by the query.
|
DescribeNotificationSubscriptionsResult |
describeNotificationSubscriptions(DescribeNotificationSubscriptionsRequest request)
Lists the specified notification subscriptions.
|
DescribeResourcePermissionsResult |
describeResourcePermissions(DescribeResourcePermissionsRequest request)
Describes the permissions of a specified resource.
|
DescribeRootFoldersResult |
describeRootFolders(DescribeRootFoldersRequest request)
Describes the current user's special folders; the
RootFolder and the RecycleBin. |
DescribeUsersResult |
describeUsers(DescribeUsersRequest request)
Describes the specified users.
|
ResponseMetadata |
getCachedResponseMetadata(AmazonWebServiceRequest request)
Returns additional metadata for a previously executed successful request, typically used for debugging issues
where a service isn't acting as expected.
|
GetCurrentUserResult |
getCurrentUser(GetCurrentUserRequest request)
Retrieves details of the current user for whom the authentication token was generated.
|
GetDocumentResult |
getDocument(GetDocumentRequest request)
Retrieves details of a document.
|
GetDocumentPathResult |
getDocumentPath(GetDocumentPathRequest request)
Retrieves the path information (the hierarchy from the root folder) for the requested document.
|
GetDocumentVersionResult |
getDocumentVersion(GetDocumentVersionRequest request)
Retrieves version metadata for the specified document.
|
GetFolderResult |
getFolder(GetFolderRequest request)
Retrieves the metadata of the specified folder.
|
GetFolderPathResult |
getFolderPath(GetFolderPathRequest request)
Retrieves the path information (the hierarchy from the root folder) for the specified folder.
|
GetResourcesResult |
getResources(GetResourcesRequest request)
Retrieves a collection of resources, including folders and documents.
|
InitiateDocumentVersionUploadResult |
initiateDocumentVersionUpload(InitiateDocumentVersionUploadRequest request)
Creates a new document object and version object.
|
RemoveAllResourcePermissionsResult |
removeAllResourcePermissions(RemoveAllResourcePermissionsRequest request)
Removes all the permissions from the specified resource.
|
RemoveResourcePermissionResult |
removeResourcePermission(RemoveResourcePermissionRequest request)
Removes the permission for the specified principal from the specified resource.
|
void |
shutdown()
Shuts down this client object, releasing any resources that might be held open.
|
UpdateDocumentResult |
updateDocument(UpdateDocumentRequest request)
Updates the specified attributes of a document.
|
UpdateDocumentVersionResult |
updateDocumentVersion(UpdateDocumentVersionRequest request)
Changes the status of the document version to ACTIVE.
|
UpdateFolderResult |
updateFolder(UpdateFolderRequest request)
Updates the specified attributes of the specified folder.
|
UpdateUserResult |
updateUser(UpdateUserRequest request)
Updates the specified attributes of the specified user, and grants or revokes administrative privileges to the
Amazon WorkDocs site.
|
public AbortDocumentVersionUploadResult abortDocumentVersionUpload(AbortDocumentVersionUploadRequest request)
AmazonWorkDocsAborts 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.
abortDocumentVersionUpload in interface AmazonWorkDocspublic ActivateUserResult activateUser(ActivateUserRequest request)
AmazonWorkDocsActivates the specified user. Only active users can access Amazon WorkDocs.
activateUser in interface AmazonWorkDocspublic AddResourcePermissionsResult addResourcePermissions(AddResourcePermissionsRequest request)
AmazonWorkDocsCreates a set of permissions for the specified folder or document. The resource permissions are overwritten if the principals already have different permissions.
addResourcePermissions in interface AmazonWorkDocspublic CreateCommentResult createComment(CreateCommentRequest request)
AmazonWorkDocsAdds a new comment to the specified document version.
createComment in interface AmazonWorkDocspublic CreateCustomMetadataResult createCustomMetadata(CreateCustomMetadataRequest request)
AmazonWorkDocsAdds one or more custom properties to the specified resource (a folder, document, or version).
createCustomMetadata in interface AmazonWorkDocspublic CreateFolderResult createFolder(CreateFolderRequest request)
AmazonWorkDocsCreates a folder with the specified name and parent folder.
createFolder in interface AmazonWorkDocspublic CreateLabelsResult createLabels(CreateLabelsRequest request)
AmazonWorkDocsAdds the specified list of labels to the given resource (a document or folder)
createLabels in interface AmazonWorkDocspublic CreateNotificationSubscriptionResult createNotificationSubscription(CreateNotificationSubscriptionRequest request)
AmazonWorkDocsConfigure 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.
createNotificationSubscription in interface AmazonWorkDocspublic CreateUserResult createUser(CreateUserRequest request)
AmazonWorkDocsCreates 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.
createUser in interface AmazonWorkDocspublic DeactivateUserResult deactivateUser(DeactivateUserRequest request)
AmazonWorkDocsDeactivates the specified user, which revokes the user's access to Amazon WorkDocs.
deactivateUser in interface AmazonWorkDocspublic DeleteCommentResult deleteComment(DeleteCommentRequest request)
AmazonWorkDocsDeletes the specified comment from the document version.
deleteComment in interface AmazonWorkDocspublic DeleteCustomMetadataResult deleteCustomMetadata(DeleteCustomMetadataRequest request)
AmazonWorkDocsDeletes custom metadata from the specified resource.
deleteCustomMetadata in interface AmazonWorkDocspublic DeleteDocumentResult deleteDocument(DeleteDocumentRequest request)
AmazonWorkDocsPermanently deletes the specified document and its associated metadata.
deleteDocument in interface AmazonWorkDocspublic DeleteFolderResult deleteFolder(DeleteFolderRequest request)
AmazonWorkDocsPermanently deletes the specified folder and its contents.
deleteFolder in interface AmazonWorkDocspublic DeleteFolderContentsResult deleteFolderContents(DeleteFolderContentsRequest request)
AmazonWorkDocsDeletes the contents of the specified folder.
deleteFolderContents in interface AmazonWorkDocspublic DeleteLabelsResult deleteLabels(DeleteLabelsRequest request)
AmazonWorkDocsDeletes the specified list of labels from a resource.
deleteLabels in interface AmazonWorkDocspublic DeleteNotificationSubscriptionResult deleteNotificationSubscription(DeleteNotificationSubscriptionRequest request)
AmazonWorkDocsDeletes the specified subscription from the specified organization.
deleteNotificationSubscription in interface AmazonWorkDocspublic DeleteUserResult deleteUser(DeleteUserRequest request)
AmazonWorkDocsDeletes the specified user from a Simple AD or Microsoft AD directory.
deleteUser in interface AmazonWorkDocspublic DescribeActivitiesResult describeActivities(DescribeActivitiesRequest request)
AmazonWorkDocsDescribes the user activities in a specified time period.
describeActivities in interface AmazonWorkDocspublic DescribeCommentsResult describeComments(DescribeCommentsRequest request)
AmazonWorkDocsList all the comments for the specified document version.
describeComments in interface AmazonWorkDocspublic DescribeDocumentVersionsResult describeDocumentVersions(DescribeDocumentVersionsRequest request)
AmazonWorkDocsRetrieves the document versions for the specified document.
By default, only active versions are returned.
describeDocumentVersions in interface AmazonWorkDocspublic DescribeFolderContentsResult describeFolderContents(DescribeFolderContentsRequest request)
AmazonWorkDocsDescribes 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.
describeFolderContents in interface AmazonWorkDocspublic DescribeGroupsResult describeGroups(DescribeGroupsRequest request)
AmazonWorkDocsDescribes the groups specified by the query. Groups are defined by the underlying Active Directory.
describeGroups in interface AmazonWorkDocspublic DescribeNotificationSubscriptionsResult describeNotificationSubscriptions(DescribeNotificationSubscriptionsRequest request)
AmazonWorkDocsLists the specified notification subscriptions.
describeNotificationSubscriptions in interface AmazonWorkDocspublic DescribeResourcePermissionsResult describeResourcePermissions(DescribeResourcePermissionsRequest request)
AmazonWorkDocsDescribes the permissions of a specified resource.
describeResourcePermissions in interface AmazonWorkDocspublic DescribeRootFoldersResult describeRootFolders(DescribeRootFoldersRequest request)
AmazonWorkDocs
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.
describeRootFolders in interface AmazonWorkDocspublic DescribeUsersResult describeUsers(DescribeUsersRequest request)
AmazonWorkDocsDescribes 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.
describeUsers in interface AmazonWorkDocspublic GetCurrentUserResult getCurrentUser(GetCurrentUserRequest request)
AmazonWorkDocsRetrieves 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.
getCurrentUser in interface AmazonWorkDocspublic GetDocumentResult getDocument(GetDocumentRequest request)
AmazonWorkDocsRetrieves details of a document.
getDocument in interface AmazonWorkDocspublic GetDocumentPathResult getDocumentPath(GetDocumentPathRequest request)
AmazonWorkDocsRetrieves 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.
getDocumentPath in interface AmazonWorkDocspublic GetDocumentVersionResult getDocumentVersion(GetDocumentVersionRequest request)
AmazonWorkDocsRetrieves version metadata for the specified document.
getDocumentVersion in interface AmazonWorkDocspublic GetFolderResult getFolder(GetFolderRequest request)
AmazonWorkDocsRetrieves the metadata of the specified folder.
getFolder in interface AmazonWorkDocspublic GetFolderPathResult getFolderPath(GetFolderPathRequest request)
AmazonWorkDocsRetrieves 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.
getFolderPath in interface AmazonWorkDocspublic GetResourcesResult getResources(GetResourcesRequest request)
AmazonWorkDocs
Retrieves a collection of resources, including folders and documents. The only CollectionType
supported is SHARED_WITH_ME.
getResources in interface AmazonWorkDocspublic InitiateDocumentVersionUploadResult initiateDocumentVersionUpload(InitiateDocumentVersionUploadRequest request)
AmazonWorkDocsCreates 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.
initiateDocumentVersionUpload in interface AmazonWorkDocspublic RemoveAllResourcePermissionsResult removeAllResourcePermissions(RemoveAllResourcePermissionsRequest request)
AmazonWorkDocsRemoves all the permissions from the specified resource.
removeAllResourcePermissions in interface AmazonWorkDocspublic RemoveResourcePermissionResult removeResourcePermission(RemoveResourcePermissionRequest request)
AmazonWorkDocsRemoves the permission for the specified principal from the specified resource.
removeResourcePermission in interface AmazonWorkDocspublic UpdateDocumentResult updateDocument(UpdateDocumentRequest request)
AmazonWorkDocsUpdates the specified attributes of a document. The user must have access to both the document and its parent folder, if applicable.
updateDocument in interface AmazonWorkDocspublic UpdateDocumentVersionResult updateDocumentVersion(UpdateDocumentVersionRequest request)
AmazonWorkDocsChanges 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.
updateDocumentVersion in interface AmazonWorkDocspublic UpdateFolderResult updateFolder(UpdateFolderRequest request)
AmazonWorkDocsUpdates the specified attributes of the specified folder. The user must have access to both the folder and its parent folder, if applicable.
updateFolder in interface AmazonWorkDocspublic UpdateUserResult updateUser(UpdateUserRequest request)
AmazonWorkDocsUpdates the specified attributes of the specified user, and grants or revokes administrative privileges to the Amazon WorkDocs site.
updateUser in interface AmazonWorkDocspublic void shutdown()
AmazonWorkDocsshutdown in interface AmazonWorkDocspublic ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
AmazonWorkDocsResponse metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.
getCachedResponseMetadata in interface AmazonWorkDocsrequest - The originally executed request.