@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.
|
DeleteDocumentVersionResult |
deleteDocumentVersion(DeleteDocumentVersionRequest request)
Deletes a specific version of a document.
|
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.
|
RestoreDocumentVersionsResult |
restoreDocumentVersions(RestoreDocumentVersionsRequest request)
Recovers a deleted version of an Amazon WorkDocs document.
|
SearchResourcesResult |
searchResources(SearchResourcesRequest request)
Searches metadata and the content of folders, documents, document versions, and comments.
|
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)
AmazonWorkDocs
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.
abortDocumentVersionUpload
in interface AmazonWorkDocs
public ActivateUserResult activateUser(ActivateUserRequest request)
AmazonWorkDocs
Activates the specified user. Only active users can access Amazon WorkDocs.
activateUser
in interface AmazonWorkDocs
public AddResourcePermissionsResult addResourcePermissions(AddResourcePermissionsRequest request)
AmazonWorkDocs
Creates 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 AmazonWorkDocs
public CreateCommentResult createComment(CreateCommentRequest request)
AmazonWorkDocs
Adds a new comment to the specified document version.
createComment
in interface AmazonWorkDocs
public CreateCustomMetadataResult createCustomMetadata(CreateCustomMetadataRequest request)
AmazonWorkDocs
Adds one or more custom properties to the specified resource (a folder, document, or version).
createCustomMetadata
in interface AmazonWorkDocs
public CreateFolderResult createFolder(CreateFolderRequest request)
AmazonWorkDocs
Creates a folder with the specified name and parent folder.
createFolder
in interface AmazonWorkDocs
public CreateLabelsResult createLabels(CreateLabelsRequest request)
AmazonWorkDocs
Adds the specified list of labels to the given resource (a document or folder)
createLabels
in interface AmazonWorkDocs
public CreateNotificationSubscriptionResult createNotificationSubscription(CreateNotificationSubscriptionRequest request)
AmazonWorkDocs
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.
createNotificationSubscription
in interface AmazonWorkDocs
public CreateUserResult createUser(CreateUserRequest request)
AmazonWorkDocs
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.
createUser
in interface AmazonWorkDocs
public DeactivateUserResult deactivateUser(DeactivateUserRequest request)
AmazonWorkDocs
Deactivates the specified user, which revokes the user's access to Amazon WorkDocs.
deactivateUser
in interface AmazonWorkDocs
public DeleteCommentResult deleteComment(DeleteCommentRequest request)
AmazonWorkDocs
Deletes the specified comment from the document version.
deleteComment
in interface AmazonWorkDocs
public DeleteCustomMetadataResult deleteCustomMetadata(DeleteCustomMetadataRequest request)
AmazonWorkDocs
Deletes custom metadata from the specified resource.
deleteCustomMetadata
in interface AmazonWorkDocs
public DeleteDocumentResult deleteDocument(DeleteDocumentRequest request)
AmazonWorkDocs
Permanently deletes the specified document and its associated metadata.
deleteDocument
in interface AmazonWorkDocs
public DeleteDocumentVersionResult deleteDocumentVersion(DeleteDocumentVersionRequest request)
AmazonWorkDocs
Deletes a specific version of a document.
deleteDocumentVersion
in interface AmazonWorkDocs
public DeleteFolderResult deleteFolder(DeleteFolderRequest request)
AmazonWorkDocs
Permanently deletes the specified folder and its contents.
deleteFolder
in interface AmazonWorkDocs
public DeleteFolderContentsResult deleteFolderContents(DeleteFolderContentsRequest request)
AmazonWorkDocs
Deletes the contents of the specified folder.
deleteFolderContents
in interface AmazonWorkDocs
public DeleteLabelsResult deleteLabels(DeleteLabelsRequest request)
AmazonWorkDocs
Deletes the specified list of labels from a resource.
deleteLabels
in interface AmazonWorkDocs
public DeleteNotificationSubscriptionResult deleteNotificationSubscription(DeleteNotificationSubscriptionRequest request)
AmazonWorkDocs
Deletes the specified subscription from the specified organization.
deleteNotificationSubscription
in interface AmazonWorkDocs
public DeleteUserResult deleteUser(DeleteUserRequest request)
AmazonWorkDocs
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.
deleteUser
in interface AmazonWorkDocs
public DescribeActivitiesResult describeActivities(DescribeActivitiesRequest request)
AmazonWorkDocs
Describes the user activities in a specified time period.
describeActivities
in interface AmazonWorkDocs
public DescribeCommentsResult describeComments(DescribeCommentsRequest request)
AmazonWorkDocs
List all the comments for the specified document version.
describeComments
in interface AmazonWorkDocs
public DescribeDocumentVersionsResult describeDocumentVersions(DescribeDocumentVersionsRequest request)
AmazonWorkDocs
Retrieves the document versions for the specified document.
By default, only active versions are returned.
describeDocumentVersions
in interface AmazonWorkDocs
public DescribeFolderContentsResult describeFolderContents(DescribeFolderContentsRequest request)
AmazonWorkDocs
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.
describeFolderContents
in interface AmazonWorkDocs
public DescribeGroupsResult describeGroups(DescribeGroupsRequest request)
AmazonWorkDocs
Describes the groups specified by the query. Groups are defined by the underlying Active Directory.
describeGroups
in interface AmazonWorkDocs
public DescribeNotificationSubscriptionsResult describeNotificationSubscriptions(DescribeNotificationSubscriptionsRequest request)
AmazonWorkDocs
Lists the specified notification subscriptions.
describeNotificationSubscriptions
in interface AmazonWorkDocs
public DescribeResourcePermissionsResult describeResourcePermissions(DescribeResourcePermissionsRequest request)
AmazonWorkDocs
Describes the permissions of a specified resource.
describeResourcePermissions
in interface AmazonWorkDocs
public 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 AmazonWorkDocs
public DescribeUsersResult describeUsers(DescribeUsersRequest request)
AmazonWorkDocs
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.
describeUsers
in interface AmazonWorkDocs
public GetCurrentUserResult getCurrentUser(GetCurrentUserRequest request)
AmazonWorkDocs
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.
getCurrentUser
in interface AmazonWorkDocs
public GetDocumentResult getDocument(GetDocumentRequest request)
AmazonWorkDocs
Retrieves details of a document.
getDocument
in interface AmazonWorkDocs
public GetDocumentPathResult getDocumentPath(GetDocumentPathRequest request)
AmazonWorkDocs
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.
getDocumentPath
in interface AmazonWorkDocs
public GetDocumentVersionResult getDocumentVersion(GetDocumentVersionRequest request)
AmazonWorkDocs
Retrieves version metadata for the specified document.
getDocumentVersion
in interface AmazonWorkDocs
public GetFolderResult getFolder(GetFolderRequest request)
AmazonWorkDocs
Retrieves the metadata of the specified folder.
getFolder
in interface AmazonWorkDocs
public GetFolderPathResult getFolderPath(GetFolderPathRequest request)
AmazonWorkDocs
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.
getFolderPath
in interface AmazonWorkDocs
public 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 AmazonWorkDocs
public InitiateDocumentVersionUploadResult initiateDocumentVersionUpload(InitiateDocumentVersionUploadRequest request)
AmazonWorkDocs
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.
initiateDocumentVersionUpload
in interface AmazonWorkDocs
public RemoveAllResourcePermissionsResult removeAllResourcePermissions(RemoveAllResourcePermissionsRequest request)
AmazonWorkDocs
Removes all the permissions from the specified resource.
removeAllResourcePermissions
in interface AmazonWorkDocs
public RemoveResourcePermissionResult removeResourcePermission(RemoveResourcePermissionRequest request)
AmazonWorkDocs
Removes the permission for the specified principal from the specified resource.
removeResourcePermission
in interface AmazonWorkDocs
public RestoreDocumentVersionsResult restoreDocumentVersions(RestoreDocumentVersionsRequest request)
AmazonWorkDocs
Recovers a deleted version of an Amazon WorkDocs document.
restoreDocumentVersions
in interface AmazonWorkDocs
public SearchResourcesResult searchResources(SearchResourcesRequest request)
AmazonWorkDocs
Searches metadata and the content of folders, documents, document versions, and comments.
searchResources
in interface AmazonWorkDocs
public UpdateDocumentResult updateDocument(UpdateDocumentRequest request)
AmazonWorkDocs
Updates the specified attributes of a document. The user must have access to both the document and its parent folder, if applicable.
updateDocument
in interface AmazonWorkDocs
public UpdateDocumentVersionResult updateDocumentVersion(UpdateDocumentVersionRequest request)
AmazonWorkDocs
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.
updateDocumentVersion
in interface AmazonWorkDocs
public UpdateFolderResult updateFolder(UpdateFolderRequest request)
AmazonWorkDocs
Updates 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 AmazonWorkDocs
public UpdateUserResult updateUser(UpdateUserRequest request)
AmazonWorkDocs
Updates the specified attributes of the specified user, and grants or revokes administrative privileges to the Amazon WorkDocs site.
updateUser
in interface AmazonWorkDocs
public void shutdown()
AmazonWorkDocs
shutdown
in interface AmazonWorkDocs
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
AmazonWorkDocs
Response 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 AmazonWorkDocs
request
- The originally executed request.