@ThreadSafe @Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AmazonWorkDocsClient extends AmazonWebServiceClient implements AmazonWorkDocs
The Amazon WorkDocs API is designed for the following use cases:
File Migration: File migration applications are supported for users who want to migrate their files from an on-premises or off-premises file system or service. Users can insert files into a user directory structure, as well as allow for basic metadata changes, such as modifications to the permissions of files.
Security: Support security applications are supported for users who have additional security needs, such as antivirus or data loss prevention. The API actions, along with CloudTrail, allow these applications to detect when changes occur in Amazon WorkDocs. Then, the application can take the necessary actions and replace the target file. If the target file violates the policy, the application can also choose to email the user.
eDiscovery/Analytics: General administrative applications are supported, such as eDiscovery and analytics. These applications can choose to mimic or record the actions in an Amazon WorkDocs site, along with CloudTrail, to replicate data for eDiscovery, backup, or analytical applications.
All Amazon WorkDocs API actions are Amazon authenticated and certificate-signed. They not only require the use of the Amazon Web Services SDK, but also allow for the exclusive use of IAM users and roles to help facilitate access, trust, and permission policies. By creating a role and allowing an IAM user to access the Amazon WorkDocs site, the IAM user gains full administrative visibility into the entire Amazon WorkDocs site (or as set in the IAM policy). This includes, but is not limited to, the ability to modify file permissions and upload any file to any user. This allows developers to perform the three use cases above, as well as give users the ability to grant access on a selective basis using the IAM model.
The pricing for Amazon WorkDocs APIs varies depending on the API call type for these actions:
READ (Get*)
WRITE (Activate*, Add*, Create*, Deactivate*, Initiate*, Update*)
LIST (Describe*)
DELETE*, CANCEL
For information about Amazon WorkDocs API pricing, see Amazon WorkDocs Pricing.
LOGGING_AWS_REQUEST_METRICENDPOINT_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.
|
static AmazonWorkDocsClientBuilder |
builder() |
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.
|
addRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffsetpublic static AmazonWorkDocsClientBuilder builder()
public AbortDocumentVersionUploadResult abortDocumentVersionUpload(AbortDocumentVersionUploadRequest request)
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 AmazonWorkDocsabortDocumentVersionUploadRequest - EntityNotExistsException - The resource does not exist.ProhibitedStateException - The specified document version is not in the INITIALIZED state.UnauthorizedOperationException - The operation is not permitted.UnauthorizedResourceAccessException - The caller does not have access to perform the action on the resource.FailedDependencyException - The Directory Service cannot reach an on-premises instance. Or a dependency under the control of the
organization is failing, such as a connected Active Directory.ServiceUnavailableException - One or more of the dependencies is unavailable.ConcurrentModificationException - The resource hierarchy is changing.public ActivateUserResult activateUser(ActivateUserRequest request)
Activates the specified user. Only active users can access Amazon WorkDocs.
activateUser in interface AmazonWorkDocsactivateUserRequest - EntityNotExistsException - The resource does not exist.UnauthorizedOperationException - The operation is not permitted.UnauthorizedResourceAccessException - The caller does not have access to perform the action on the resource.FailedDependencyException - The Directory Service cannot reach an on-premises instance. Or a dependency under the control of the
organization is failing, such as a connected Active Directory.ServiceUnavailableException - One or more of the dependencies is unavailable.public AddResourcePermissionsResult addResourcePermissions(AddResourcePermissionsRequest request)
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 AmazonWorkDocsaddResourcePermissionsRequest - UnauthorizedOperationException - The operation is not permitted.UnauthorizedResourceAccessException - The caller does not have access to perform the action on the resource.FailedDependencyException - The Directory Service cannot reach an on-premises instance. Or a dependency under the control of the
organization is failing, such as a connected Active Directory.ServiceUnavailableException - One or more of the dependencies is unavailable.ProhibitedStateException - The specified document version is not in the INITIALIZED state.public CreateCommentResult createComment(CreateCommentRequest request)
Adds a new comment to the specified document version.
createComment in interface AmazonWorkDocscreateCommentRequest - EntityNotExistsException - The resource does not exist.ProhibitedStateException - The specified document version is not in the INITIALIZED state.UnauthorizedOperationException - The operation is not permitted.UnauthorizedResourceAccessException - The caller does not have access to perform the action on the resource.FailedDependencyException - The Directory Service cannot reach an on-premises instance. Or a dependency under the control of the
organization is failing, such as a connected Active Directory.ServiceUnavailableException - One or more of the dependencies is unavailable.DocumentLockedForCommentsException - This exception is thrown when the document is locked for comments and user tries to create or delete a
comment on that document.InvalidCommentOperationException - The requested operation is not allowed on the specified comment object.public CreateCustomMetadataResult createCustomMetadata(CreateCustomMetadataRequest request)
Adds one or more custom properties to the specified resource (a folder, document, or version).
createCustomMetadata in interface AmazonWorkDocscreateCustomMetadataRequest - EntityNotExistsException - The resource does not exist.UnauthorizedOperationException - The operation is not permitted.UnauthorizedResourceAccessException - The caller does not have access to perform the action on the resource.ProhibitedStateException - The specified document version is not in the INITIALIZED state.CustomMetadataLimitExceededException - The limit has been reached on the number of custom properties for the specified resource.FailedDependencyException - The Directory Service cannot reach an on-premises instance. Or a dependency under the control of the
organization is failing, such as a connected Active Directory.ServiceUnavailableException - One or more of the dependencies is unavailable.public CreateFolderResult createFolder(CreateFolderRequest request)
Creates a folder with the specified name and parent folder.
createFolder in interface AmazonWorkDocscreateFolderRequest - EntityNotExistsException - The resource does not exist.EntityAlreadyExistsException - The resource already exists.ProhibitedStateException - The specified document version is not in the INITIALIZED state.ConflictingOperationException - Another operation is in progress on the resource that conflicts with the current operation.ConcurrentModificationException - The resource hierarchy is changing.LimitExceededException - The maximum of 100,000 files and folders under the parent folder has been exceeded.UnauthorizedOperationException - The operation is not permitted.UnauthorizedResourceAccessException - The caller does not have access to perform the action on the resource.FailedDependencyException - The Directory Service cannot reach an on-premises instance. Or a dependency under the control of the
organization is failing, such as a connected Active Directory.ServiceUnavailableException - One or more of the dependencies is unavailable.public CreateLabelsResult createLabels(CreateLabelsRequest request)
Adds the specified list of labels to the given resource (a document or folder)
createLabels in interface AmazonWorkDocscreateLabelsRequest - EntityNotExistsException - The resource does not exist.UnauthorizedOperationException - The operation is not permitted.UnauthorizedResourceAccessException - The caller does not have access to perform the action on the resource.FailedDependencyException - The Directory Service cannot reach an on-premises instance. Or a dependency under the control of the
organization is failing, such as a connected Active Directory.ServiceUnavailableException - One or more of the dependencies is unavailable.TooManyLabelsException - The limit has been reached on the number of labels for the specified resource.public CreateNotificationSubscriptionResult createNotificationSubscription(CreateNotificationSubscriptionRequest request)
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 AmazonWorkDocscreateNotificationSubscriptionRequest - UnauthorizedResourceAccessException - The caller does not have access to perform the action on the resource.TooManySubscriptionsException - You've reached the limit on the number of subscriptions for the WorkDocs instance.ServiceUnavailableException - One or more of the dependencies is unavailable.InvalidArgumentException - The pagination marker or limit fields are not valid.public CreateUserResult createUser(CreateUserRequest request)
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 AmazonWorkDocscreateUserRequest - EntityAlreadyExistsException - The resource already exists.UnauthorizedOperationException - The operation is not permitted.UnauthorizedResourceAccessException - The caller does not have access to perform the action on the resource.FailedDependencyException - The Directory Service cannot reach an on-premises instance. Or a dependency under the control of the
organization is failing, such as a connected Active Directory.ServiceUnavailableException - One or more of the dependencies is unavailable.public DeactivateUserResult deactivateUser(DeactivateUserRequest request)
Deactivates the specified user, which revokes the user's access to Amazon WorkDocs.
deactivateUser in interface AmazonWorkDocsdeactivateUserRequest - EntityNotExistsException - The resource does not exist.UnauthorizedOperationException - The operation is not permitted.UnauthorizedResourceAccessException - The caller does not have access to perform the action on the resource.FailedDependencyException - The Directory Service cannot reach an on-premises instance. Or a dependency under the control of the
organization is failing, such as a connected Active Directory.ServiceUnavailableException - One or more of the dependencies is unavailable.public DeleteCommentResult deleteComment(DeleteCommentRequest request)
Deletes the specified comment from the document version.
deleteComment in interface AmazonWorkDocsdeleteCommentRequest - EntityNotExistsException - The resource does not exist.ProhibitedStateException - The specified document version is not in the INITIALIZED state.UnauthorizedOperationException - The operation is not permitted.UnauthorizedResourceAccessException - The caller does not have access to perform the action on the resource.FailedDependencyException - The Directory Service cannot reach an on-premises instance. Or a dependency under the control of the
organization is failing, such as a connected Active Directory.ServiceUnavailableException - One or more of the dependencies is unavailable.DocumentLockedForCommentsException - This exception is thrown when the document is locked for comments and user tries to create or delete a
comment on that document.public DeleteCustomMetadataResult deleteCustomMetadata(DeleteCustomMetadataRequest request)
Deletes custom metadata from the specified resource.
deleteCustomMetadata in interface AmazonWorkDocsdeleteCustomMetadataRequest - EntityNotExistsException - The resource does not exist.UnauthorizedOperationException - The operation is not permitted.UnauthorizedResourceAccessException - The caller does not have access to perform the action on the resource.ProhibitedStateException - The specified document version is not in the INITIALIZED state.FailedDependencyException - The Directory Service cannot reach an on-premises instance. Or a dependency under the control of the
organization is failing, such as a connected Active Directory.ServiceUnavailableException - One or more of the dependencies is unavailable.public DeleteDocumentResult deleteDocument(DeleteDocumentRequest request)
Permanently deletes the specified document and its associated metadata.
deleteDocument in interface AmazonWorkDocsdeleteDocumentRequest - EntityNotExistsException - The resource does not exist.LimitExceededException - The maximum of 100,000 files and folders under the parent folder has been exceeded.ProhibitedStateException - The specified document version is not in the INITIALIZED state.ConflictingOperationException - Another operation is in progress on the resource that conflicts with the current operation.ConcurrentModificationException - The resource hierarchy is changing.UnauthorizedOperationException - The operation is not permitted.UnauthorizedResourceAccessException - The caller does not have access to perform the action on the resource.FailedDependencyException - The Directory Service cannot reach an on-premises instance. Or a dependency under the control of the
organization is failing, such as a connected Active Directory.ServiceUnavailableException - One or more of the dependencies is unavailable.public DeleteDocumentVersionResult deleteDocumentVersion(DeleteDocumentVersionRequest request)
Deletes a specific version of a document.
deleteDocumentVersion in interface AmazonWorkDocsdeleteDocumentVersionRequest - EntityNotExistsException - The resource does not exist.ProhibitedStateException - The specified document version is not in the INITIALIZED state.ConflictingOperationException - Another operation is in progress on the resource that conflicts with the current operation.ConcurrentModificationException - The resource hierarchy is changing.UnauthorizedResourceAccessException - The caller does not have access to perform the action on the resource.FailedDependencyException - The Directory Service cannot reach an on-premises instance. Or a dependency under the control of the
organization is failing, such as a connected Active Directory.InvalidOperationException - The operation is invalid.UnauthorizedOperationException - The operation is not permitted.public DeleteFolderResult deleteFolder(DeleteFolderRequest request)
Permanently deletes the specified folder and its contents.
deleteFolder in interface AmazonWorkDocsdeleteFolderRequest - EntityNotExistsException - The resource does not exist.LimitExceededException - The maximum of 100,000 files and folders under the parent folder has been exceeded.ProhibitedStateException - The specified document version is not in the INITIALIZED state.ConflictingOperationException - Another operation is in progress on the resource that conflicts with the current operation.ConcurrentModificationException - The resource hierarchy is changing.UnauthorizedOperationException - The operation is not permitted.UnauthorizedResourceAccessException - The caller does not have access to perform the action on the resource.FailedDependencyException - The Directory Service cannot reach an on-premises instance. Or a dependency under the control of the
organization is failing, such as a connected Active Directory.ServiceUnavailableException - One or more of the dependencies is unavailable.public DeleteFolderContentsResult deleteFolderContents(DeleteFolderContentsRequest request)
Deletes the contents of the specified folder.
deleteFolderContents in interface AmazonWorkDocsdeleteFolderContentsRequest - EntityNotExistsException - The resource does not exist.ProhibitedStateException - The specified document version is not in the INITIALIZED state.ConflictingOperationException - Another operation is in progress on the resource that conflicts with the current operation.UnauthorizedOperationException - The operation is not permitted.UnauthorizedResourceAccessException - The caller does not have access to perform the action on the resource.FailedDependencyException - The Directory Service cannot reach an on-premises instance. Or a dependency under the control of the
organization is failing, such as a connected Active Directory.ServiceUnavailableException - One or more of the dependencies is unavailable.public DeleteLabelsResult deleteLabels(DeleteLabelsRequest request)
Deletes the specified list of labels from a resource.
deleteLabels in interface AmazonWorkDocsdeleteLabelsRequest - EntityNotExistsException - The resource does not exist.UnauthorizedOperationException - The operation is not permitted.UnauthorizedResourceAccessException - The caller does not have access to perform the action on the resource.FailedDependencyException - The Directory Service cannot reach an on-premises instance. Or a dependency under the control of the
organization is failing, such as a connected Active Directory.ServiceUnavailableException - One or more of the dependencies is unavailable.ProhibitedStateException - The specified document version is not in the INITIALIZED state.public DeleteNotificationSubscriptionResult deleteNotificationSubscription(DeleteNotificationSubscriptionRequest request)
Deletes the specified subscription from the specified organization.
deleteNotificationSubscription in interface AmazonWorkDocsdeleteNotificationSubscriptionRequest - UnauthorizedResourceAccessException - The caller does not have access to perform the action on the resource.EntityNotExistsException - The resource does not exist.ServiceUnavailableException - One or more of the dependencies is unavailable.ProhibitedStateException - The specified document version is not in the INITIALIZED state.public DeleteUserResult deleteUser(DeleteUserRequest request)
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 AmazonWorkDocsdeleteUserRequest - EntityNotExistsException - The resource does not exist.UnauthorizedOperationException - The operation is not permitted.UnauthorizedResourceAccessException - The caller does not have access to perform the action on the resource.FailedDependencyException - The Directory Service cannot reach an on-premises instance. Or a dependency under the control of the
organization is failing, such as a connected Active Directory.ServiceUnavailableException - One or more of the dependencies is unavailable.public DescribeActivitiesResult describeActivities(DescribeActivitiesRequest request)
Describes the user activities in a specified time period.
describeActivities in interface AmazonWorkDocsdescribeActivitiesRequest - UnauthorizedOperationException - The operation is not permitted.UnauthorizedResourceAccessException - The caller does not have access to perform the action on the resource.InvalidArgumentException - The pagination marker or limit fields are not valid.FailedDependencyException - The Directory Service cannot reach an on-premises instance. Or a dependency under the control of the
organization is failing, such as a connected Active Directory.ServiceUnavailableException - One or more of the dependencies is unavailable.public DescribeCommentsResult describeComments(DescribeCommentsRequest request)
List all the comments for the specified document version.
describeComments in interface AmazonWorkDocsdescribeCommentsRequest - EntityNotExistsException - The resource does not exist.ProhibitedStateException - The specified document version is not in the INITIALIZED state.UnauthorizedOperationException - The operation is not permitted.UnauthorizedResourceAccessException - The caller does not have access to perform the action on the resource.FailedDependencyException - The Directory Service cannot reach an on-premises instance. Or a dependency under the control of the
organization is failing, such as a connected Active Directory.ServiceUnavailableException - One or more of the dependencies is unavailable.public DescribeDocumentVersionsResult describeDocumentVersions(DescribeDocumentVersionsRequest request)
Retrieves the document versions for the specified document.
By default, only active versions are returned.
describeDocumentVersions in interface AmazonWorkDocsdescribeDocumentVersionsRequest - EntityNotExistsException - The resource does not exist.UnauthorizedOperationException - The operation is not permitted.UnauthorizedResourceAccessException - The caller does not have access to perform the action on the resource.InvalidArgumentException - The pagination marker or limit fields are not valid.FailedDependencyException - The Directory Service cannot reach an on-premises instance. Or a dependency under the control of the
organization is failing, such as a connected Active Directory.ServiceUnavailableException - One or more of the dependencies is unavailable.ProhibitedStateException - The specified document version is not in the INITIALIZED state.InvalidPasswordException - The password is invalid.public DescribeFolderContentsResult describeFolderContents(DescribeFolderContentsRequest request)
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 AmazonWorkDocsdescribeFolderContentsRequest - EntityNotExistsException - The resource does not exist.UnauthorizedResourceAccessException - The caller does not have access to perform the action on the resource.InvalidArgumentException - The pagination marker or limit fields are not valid.FailedDependencyException - The Directory Service cannot reach an on-premises instance. Or a dependency under the control of the
organization is failing, such as a connected Active Directory.ServiceUnavailableException - One or more of the dependencies is unavailable.ProhibitedStateException - The specified document version is not in the INITIALIZED state.public DescribeGroupsResult describeGroups(DescribeGroupsRequest request)
Describes the groups specified by the query. Groups are defined by the underlying Active Directory.
describeGroups in interface AmazonWorkDocsdescribeGroupsRequest - UnauthorizedOperationException - The operation is not permitted.UnauthorizedResourceAccessException - The caller does not have access to perform the action on the resource.FailedDependencyException - The Directory Service cannot reach an on-premises instance. Or a dependency under the control of the
organization is failing, such as a connected Active Directory.ServiceUnavailableException - One or more of the dependencies is unavailable.public DescribeNotificationSubscriptionsResult describeNotificationSubscriptions(DescribeNotificationSubscriptionsRequest request)
Lists the specified notification subscriptions.
describeNotificationSubscriptions in interface AmazonWorkDocsdescribeNotificationSubscriptionsRequest - UnauthorizedResourceAccessException - The caller does not have access to perform the action on the resource.EntityNotExistsException - The resource does not exist.ServiceUnavailableException - One or more of the dependencies is unavailable.public DescribeResourcePermissionsResult describeResourcePermissions(DescribeResourcePermissionsRequest request)
Describes the permissions of a specified resource.
describeResourcePermissions in interface AmazonWorkDocsdescribeResourcePermissionsRequest - InvalidArgumentException - The pagination marker or limit fields are not valid.UnauthorizedOperationException - The operation is not permitted.UnauthorizedResourceAccessException - The caller does not have access to perform the action on the resource.FailedDependencyException - The Directory Service cannot reach an on-premises instance. Or a dependency under the control of the
organization is failing, such as a connected Active Directory.ServiceUnavailableException - One or more of the dependencies is unavailable.public DescribeRootFoldersResult describeRootFolders(DescribeRootFoldersRequest request)
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 AmazonWorkDocsdescribeRootFoldersRequest - UnauthorizedOperationException - The operation is not permitted.UnauthorizedResourceAccessException - The caller does not have access to perform the action on the resource.InvalidArgumentException - The pagination marker or limit fields are not valid.FailedDependencyException - The Directory Service cannot reach an on-premises instance. Or a dependency under the control of the
organization is failing, such as a connected Active Directory.ServiceUnavailableException - One or more of the dependencies is unavailable.public DescribeUsersResult describeUsers(DescribeUsersRequest request)
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 AmazonWorkDocsdescribeUsersRequest - EntityNotExistsException - The resource does not exist.UnauthorizedOperationException - The operation is not permitted.UnauthorizedResourceAccessException - The caller does not have access to perform the action on the resource.FailedDependencyException - The Directory Service cannot reach an on-premises instance. Or a dependency under the control of the
organization is failing, such as a connected Active Directory.ServiceUnavailableException - One or more of the dependencies is unavailable.InvalidArgumentException - The pagination marker or limit fields are not valid.RequestedEntityTooLargeException - The response is too large to return. The request must include a filter to reduce the size of the
response.public GetCurrentUserResult getCurrentUser(GetCurrentUserRequest request)
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 AmazonWorkDocsgetCurrentUserRequest - EntityNotExistsException - The resource does not exist.UnauthorizedOperationException - The operation is not permitted.UnauthorizedResourceAccessException - The caller does not have access to perform the action on the resource.FailedDependencyException - The Directory Service cannot reach an on-premises instance. Or a dependency under the control of the
organization is failing, such as a connected Active Directory.ServiceUnavailableException - One or more of the dependencies is unavailable.public GetDocumentResult getDocument(GetDocumentRequest request)
Retrieves details of a document.
getDocument in interface AmazonWorkDocsgetDocumentRequest - EntityNotExistsException - The resource does not exist.UnauthorizedOperationException - The operation is not permitted.UnauthorizedResourceAccessException - The caller does not have access to perform the action on the resource.InvalidArgumentException - The pagination marker or limit fields are not valid.FailedDependencyException - The Directory Service cannot reach an on-premises instance. Or a dependency under the control of the
organization is failing, such as a connected Active Directory.ServiceUnavailableException - One or more of the dependencies is unavailable.InvalidPasswordException - The password is invalid.public GetDocumentPathResult getDocumentPath(GetDocumentPathRequest request)
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 AmazonWorkDocsgetDocumentPathRequest - EntityNotExistsException - The resource does not exist.UnauthorizedOperationException - The operation is not permitted.UnauthorizedResourceAccessException - The caller does not have access to perform the action on the resource.FailedDependencyException - The Directory Service cannot reach an on-premises instance. Or a dependency under the control of the
organization is failing, such as a connected Active Directory.ServiceUnavailableException - One or more of the dependencies is unavailable.public GetDocumentVersionResult getDocumentVersion(GetDocumentVersionRequest request)
Retrieves version metadata for the specified document.
getDocumentVersion in interface AmazonWorkDocsgetDocumentVersionRequest - EntityNotExistsException - The resource does not exist.UnauthorizedOperationException - The operation is not permitted.UnauthorizedResourceAccessException - The caller does not have access to perform the action on the resource.FailedDependencyException - The Directory Service cannot reach an on-premises instance. Or a dependency under the control of the
organization is failing, such as a connected Active Directory.ServiceUnavailableException - One or more of the dependencies is unavailable.ProhibitedStateException - The specified document version is not in the INITIALIZED state.InvalidPasswordException - The password is invalid.public GetFolderResult getFolder(GetFolderRequest request)
Retrieves the metadata of the specified folder.
getFolder in interface AmazonWorkDocsgetFolderRequest - EntityNotExistsException - The resource does not exist.UnauthorizedOperationException - The operation is not permitted.UnauthorizedResourceAccessException - The caller does not have access to perform the action on the resource.InvalidArgumentException - The pagination marker or limit fields are not valid.FailedDependencyException - The Directory Service cannot reach an on-premises instance. Or a dependency under the control of the
organization is failing, such as a connected Active Directory.ServiceUnavailableException - One or more of the dependencies is unavailable.ProhibitedStateException - The specified document version is not in the INITIALIZED state.public GetFolderPathResult getFolderPath(GetFolderPathRequest request)
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 AmazonWorkDocsgetFolderPathRequest - EntityNotExistsException - The resource does not exist.UnauthorizedOperationException - The operation is not permitted.UnauthorizedResourceAccessException - The caller does not have access to perform the action on the resource.FailedDependencyException - The Directory Service cannot reach an on-premises instance. Or a dependency under the control of the
organization is failing, such as a connected Active Directory.ServiceUnavailableException - One or more of the dependencies is unavailable.public GetResourcesResult getResources(GetResourcesRequest request)
Retrieves a collection of resources, including folders and documents. The only CollectionType
supported is SHARED_WITH_ME.
getResources in interface AmazonWorkDocsgetResourcesRequest - UnauthorizedResourceAccessException - The caller does not have access to perform the action on the resource.UnauthorizedOperationException - The operation is not permitted.InvalidArgumentException - The pagination marker or limit fields are not valid.FailedDependencyException - The Directory Service cannot reach an on-premises instance. Or a dependency under the control of the
organization is failing, such as a connected Active Directory.ServiceUnavailableException - One or more of the dependencies is unavailable.public InitiateDocumentVersionUploadResult initiateDocumentVersionUpload(InitiateDocumentVersionUploadRequest request)
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 AmazonWorkDocsinitiateDocumentVersionUploadRequest - EntityNotExistsException - The resource does not exist.EntityAlreadyExistsException - The resource already exists.StorageLimitExceededException - The storage limit has been exceeded.StorageLimitWillExceedException - The storage limit will be exceeded.LimitExceededException - The maximum of 100,000 files and folders under the parent folder has been exceeded.ProhibitedStateException - The specified document version is not in the INITIALIZED state.UnauthorizedOperationException - The operation is not permitted.UnauthorizedResourceAccessException - The caller does not have access to perform the action on the resource.FailedDependencyException - The Directory Service cannot reach an on-premises instance. Or a dependency under the control of the
organization is failing, such as a connected Active Directory.ServiceUnavailableException - One or more of the dependencies is unavailable.DraftUploadOutOfSyncException - This exception is thrown when a valid checkout ID is not presented on document version upload calls for a
document that has been checked out from Web client.ResourceAlreadyCheckedOutException - The resource is already checked out.InvalidPasswordException - The password is invalid.InvalidArgumentException - The pagination marker or limit fields are not valid.public RemoveAllResourcePermissionsResult removeAllResourcePermissions(RemoveAllResourcePermissionsRequest request)
Removes all the permissions from the specified resource.
removeAllResourcePermissions in interface AmazonWorkDocsremoveAllResourcePermissionsRequest - UnauthorizedOperationException - The operation is not permitted.UnauthorizedResourceAccessException - The caller does not have access to perform the action on the resource.FailedDependencyException - The Directory Service cannot reach an on-premises instance. Or a dependency under the control of the
organization is failing, such as a connected Active Directory.ServiceUnavailableException - One or more of the dependencies is unavailable.public RemoveResourcePermissionResult removeResourcePermission(RemoveResourcePermissionRequest request)
Removes the permission for the specified principal from the specified resource.
removeResourcePermission in interface AmazonWorkDocsremoveResourcePermissionRequest - UnauthorizedOperationException - The operation is not permitted.UnauthorizedResourceAccessException - The caller does not have access to perform the action on the resource.FailedDependencyException - The Directory Service cannot reach an on-premises instance. Or a dependency under the control of the
organization is failing, such as a connected Active Directory.ServiceUnavailableException - One or more of the dependencies is unavailable.public RestoreDocumentVersionsResult restoreDocumentVersions(RestoreDocumentVersionsRequest request)
Recovers a deleted version of an Amazon WorkDocs document.
restoreDocumentVersions in interface AmazonWorkDocsrestoreDocumentVersionsRequest - EntityNotExistsException - The resource does not exist.ProhibitedStateException - The specified document version is not in the INITIALIZED state.ConflictingOperationException - Another operation is in progress on the resource that conflicts with the current operation.ConcurrentModificationException - The resource hierarchy is changing.UnauthorizedResourceAccessException - The caller does not have access to perform the action on the resource.FailedDependencyException - The Directory Service cannot reach an on-premises instance. Or a dependency under the control of the
organization is failing, such as a connected Active Directory.InvalidOperationException - The operation is invalid.UnauthorizedOperationException - The operation is not permitted.public SearchResourcesResult searchResources(SearchResourcesRequest request)
Searches metadata and the content of folders, documents, document versions, and comments.
searchResources in interface AmazonWorkDocssearchResourcesRequest - InvalidArgumentException - The pagination marker or limit fields are not valid.UnauthorizedResourceAccessException - The caller does not have access to perform the action on the resource.UnauthorizedOperationException - The operation is not permitted.ServiceUnavailableException - One or more of the dependencies is unavailable.public UpdateDocumentResult updateDocument(UpdateDocumentRequest request)
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 AmazonWorkDocsupdateDocumentRequest - EntityNotExistsException - The resource does not exist.EntityAlreadyExistsException - The resource already exists.LimitExceededException - The maximum of 100,000 files and folders under the parent folder has been exceeded.ProhibitedStateException - The specified document version is not in the INITIALIZED state.ConflictingOperationException - Another operation is in progress on the resource that conflicts with the current operation.ConcurrentModificationException - The resource hierarchy is changing.UnauthorizedOperationException - The operation is not permitted.UnauthorizedResourceAccessException - The caller does not have access to perform the action on the resource.FailedDependencyException - The Directory Service cannot reach an on-premises instance. Or a dependency under the control of the
organization is failing, such as a connected Active Directory.ServiceUnavailableException - One or more of the dependencies is unavailable.public UpdateDocumentVersionResult updateDocumentVersion(UpdateDocumentVersionRequest request)
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 AmazonWorkDocsupdateDocumentVersionRequest - EntityNotExistsException - The resource does not exist.ProhibitedStateException - The specified document version is not in the INITIALIZED state.ConcurrentModificationException - The resource hierarchy is changing.InvalidOperationException - The operation is invalid.UnauthorizedOperationException - The operation is not permitted.UnauthorizedResourceAccessException - The caller does not have access to perform the action on the resource.FailedDependencyException - The Directory Service cannot reach an on-premises instance. Or a dependency under the control of the
organization is failing, such as a connected Active Directory.ServiceUnavailableException - One or more of the dependencies is unavailable.public UpdateFolderResult updateFolder(UpdateFolderRequest request)
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 AmazonWorkDocsupdateFolderRequest - EntityNotExistsException - The resource does not exist.EntityAlreadyExistsException - The resource already exists.ProhibitedStateException - The specified document version is not in the INITIALIZED state.ConflictingOperationException - Another operation is in progress on the resource that conflicts with the current operation.ConcurrentModificationException - The resource hierarchy is changing.LimitExceededException - The maximum of 100,000 files and folders under the parent folder has been exceeded.UnauthorizedOperationException - The operation is not permitted.UnauthorizedResourceAccessException - The caller does not have access to perform the action on the resource.FailedDependencyException - The Directory Service cannot reach an on-premises instance. Or a dependency under the control of the
organization is failing, such as a connected Active Directory.ServiceUnavailableException - One or more of the dependencies is unavailable.public UpdateUserResult updateUser(UpdateUserRequest request)
Updates the specified attributes of the specified user, and grants or revokes administrative privileges to the Amazon WorkDocs site.
updateUser in interface AmazonWorkDocsupdateUserRequest - EntityNotExistsException - The resource does not exist.UnauthorizedOperationException - The operation is not permitted.UnauthorizedResourceAccessException - The caller does not have access to perform the action on the resource.IllegalUserStateException - The user is undergoing transfer of ownership.ProhibitedStateException - The specified document version is not in the INITIALIZED state.FailedDependencyException - The Directory Service cannot reach an on-premises instance. Or a dependency under the control of the
organization is failing, such as a connected Active Directory.ServiceUnavailableException - One or more of the dependencies is unavailable.DeactivatingLastSystemUserException - The last user in the organization is being deactivated.InvalidArgumentException - The pagination marker or limit fields are not valid.public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
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 the request.
getCachedResponseMetadata in interface AmazonWorkDocsrequest - The originally executed requestpublic void shutdown()
AmazonWebServiceClientshutdown in interface AmazonWorkDocsshutdown in class AmazonWebServiceClient