AmazonWorkDocs (AWS SDK for Java

All Known Subinterfaces:

AmazonWorkDocsAsync

All Known Implementing Classes:

AbstractAmazonWorkDocs, AbstractAmazonWorkDocsAsync, AmazonWorkDocsAsyncClient, AmazonWorkDocsClient
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public interface AmazonWorkDocs
```
Interface for accessing Amazon WorkDocs.
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from AbstractAmazonWorkDocs instead.

The WorkDocs API is designed for the following use cases:
- File Migration: File migration applications are supported for users who want to migrate their files from an on-premise or off-premise 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 anti-virus or data loss prevention. The APIs, in conjunction with Amazon CloudTrail, allow these applications to detect when changes occur in Amazon WorkDocs, so the application can take the necessary actions and replace the target file. The application can also choose to email the user if the target file violates the policy.
- eDiscovery/Analytics: General administrative applications are supported, such as eDiscovery and analytics. These applications can choose to mimic and/or record the actions in an Amazon WorkDocs site, in conjunction with Amazon CloudTrails, to replicate data for eDiscovery, backup, or analytical applications.
All Amazon WorkDocs APIs are Amazon authenticated, certificate-signed APIs. They not only require the use of the AWS SDK, but also allow for the exclusive use of IAM users and roles to help facilitate access, trust, and permission policies. By creating a role and allowing an IAM user to access the Amazon WorkDocs site, the IAM user gains full administrative visibility into the entire Amazon WorkDocs site (or as set in the IAM policy). This includes, but is not limited to, the ability to modify file permissions and upload any file to any user. This allows developers to perform the three use cases above, as well as give users the ability to grant access on a selective basis using the IAM model.

Field Summary

Fields
Modifier and Type Field and Description

static String ENDPOINT_PREFIX
The region metadata service name for computing region endpoints.

Fields
Modifier and Type	Field and Description
`static String`	`ENDPOINT_PREFIX` The region metadata service name for computing region endpoints.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`AbortDocumentVersionUploadResult`	`abortDocumentVersionUpload(AbortDocumentVersionUploadRequest abortDocumentVersionUploadRequest)` Aborts the upload of the specified document version that was previously initiated by InitiateDocumentVersionUpload.
`ActivateUserResult`	`activateUser(ActivateUserRequest activateUserRequest)` Activates the specified user.
`AddResourcePermissionsResult`	`addResourcePermissions(AddResourcePermissionsRequest addResourcePermissionsRequest)` Creates a set of permissions for the specified folder or document.
`CreateCommentResult`	`createComment(CreateCommentRequest createCommentRequest)` Adds a new comment to the specified document version.
`CreateCustomMetadataResult`	`createCustomMetadata(CreateCustomMetadataRequest createCustomMetadataRequest)` Adds one or more custom properties to the specified resource (a folder, document, or version).
`CreateFolderResult`	`createFolder(CreateFolderRequest createFolderRequest)` Creates a folder with the specified name and parent folder.
`CreateLabelsResult`	`createLabels(CreateLabelsRequest createLabelsRequest)` Adds the specified list of labels to the given resource (a document or folder)
`CreateNotificationSubscriptionResult`	`createNotificationSubscription(CreateNotificationSubscriptionRequest createNotificationSubscriptionRequest)` Configure WorkDocs to use Amazon SNS notifications.
`CreateUserResult`	`createUser(CreateUserRequest createUserRequest)` Creates a user in a Simple AD or Microsoft AD directory.
`DeactivateUserResult`	`deactivateUser(DeactivateUserRequest deactivateUserRequest)` Deactivates the specified user, which revokes the user's access to Amazon WorkDocs.
`DeleteCommentResult`	`deleteComment(DeleteCommentRequest deleteCommentRequest)` Deletes the specified comment from the document version.
`DeleteCustomMetadataResult`	`deleteCustomMetadata(DeleteCustomMetadataRequest deleteCustomMetadataRequest)` Deletes custom metadata from the specified resource.
`DeleteDocumentResult`	`deleteDocument(DeleteDocumentRequest deleteDocumentRequest)` Permanently deletes the specified document and its associated metadata.
`DeleteFolderResult`	`deleteFolder(DeleteFolderRequest deleteFolderRequest)` Permanently deletes the specified folder and its contents.
`DeleteFolderContentsResult`	`deleteFolderContents(DeleteFolderContentsRequest deleteFolderContentsRequest)` Deletes the contents of the specified folder.
`DeleteLabelsResult`	`deleteLabels(DeleteLabelsRequest deleteLabelsRequest)` Deletes the specified list of labels from a resource.
`DeleteNotificationSubscriptionResult`	`deleteNotificationSubscription(DeleteNotificationSubscriptionRequest deleteNotificationSubscriptionRequest)` Deletes the specified subscription from the specified organization.
`DeleteUserResult`	`deleteUser(DeleteUserRequest deleteUserRequest)` Deletes the specified user from a Simple AD or Microsoft AD directory.
`DescribeActivitiesResult`	`describeActivities(DescribeActivitiesRequest describeActivitiesRequest)` Describes the user activities in a specified time period.
`DescribeCommentsResult`	`describeComments(DescribeCommentsRequest describeCommentsRequest)` List all the comments for the specified document version.
`DescribeDocumentVersionsResult`	`describeDocumentVersions(DescribeDocumentVersionsRequest describeDocumentVersionsRequest)` Retrieves the document versions for the specified document.
`DescribeFolderContentsResult`	`describeFolderContents(DescribeFolderContentsRequest describeFolderContentsRequest)` Describes the contents of the specified folder, including its documents and subfolders.
`DescribeNotificationSubscriptionsResult`	`describeNotificationSubscriptions(DescribeNotificationSubscriptionsRequest describeNotificationSubscriptionsRequest)` Lists the specified notification subscriptions.
`DescribeResourcePermissionsResult`	`describeResourcePermissions(DescribeResourcePermissionsRequest describeResourcePermissionsRequest)` Describes the permissions of a specified resource.
`DescribeRootFoldersResult`	`describeRootFolders(DescribeRootFoldersRequest describeRootFoldersRequest)` Describes the current user's special folders; the `RootFolder` and the `RecyleBin`.
`DescribeUsersResult`	`describeUsers(DescribeUsersRequest describeUsersRequest)` 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 getCurrentUserRequest)` Retrieves details of the current user for whom the authentication token was generated.
`GetDocumentResult`	`getDocument(GetDocumentRequest getDocumentRequest)` Retrieves details of a document.
`GetDocumentPathResult`	`getDocumentPath(GetDocumentPathRequest getDocumentPathRequest)` Retrieves the path information (the hierarchy from the root folder) for the requested document.
`GetDocumentVersionResult`	`getDocumentVersion(GetDocumentVersionRequest getDocumentVersionRequest)` Retrieves version metadata for the specified document.
`GetFolderResult`	`getFolder(GetFolderRequest getFolderRequest)` Retrieves the metadata of the specified folder.
`GetFolderPathResult`	`getFolderPath(GetFolderPathRequest getFolderPathRequest)` Retrieves the path information (the hierarchy from the root folder) for the specified folder.
`InitiateDocumentVersionUploadResult`	`initiateDocumentVersionUpload(InitiateDocumentVersionUploadRequest initiateDocumentVersionUploadRequest)` Creates a new document object and version object.
`RemoveAllResourcePermissionsResult`	`removeAllResourcePermissions(RemoveAllResourcePermissionsRequest removeAllResourcePermissionsRequest)` Removes all the permissions from the specified resource.
`RemoveResourcePermissionResult`	`removeResourcePermission(RemoveResourcePermissionRequest removeResourcePermissionRequest)` 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 updateDocumentRequest)` Updates the specified attributes of a document.
`UpdateDocumentVersionResult`	`updateDocumentVersion(UpdateDocumentVersionRequest updateDocumentVersionRequest)` Changes the status of the document version to ACTIVE.
`UpdateFolderResult`	`updateFolder(UpdateFolderRequest updateFolderRequest)` Updates the specified attributes of the specified folder.
`UpdateUserResult`	`updateUser(UpdateUserRequest updateUserRequest)` Updates the specified attributes of the specified user, and grants or revokes administrative privileges to the Amazon WorkDocs site.

- Field Detail
  - ENDPOINT_PREFIX
```
static final String ENDPOINT_PREFIX
```
    The region metadata service name for computing region endpoints. You can use this value to retrieve metadata (such as supported regions) of the service.
    
    See Also:
    
    RegionUtils.getRegionsForService(String), Constant Field Values
- Method Detail
  - abortDocumentVersionUpload
```
AbortDocumentVersionUploadResult abortDocumentVersionUpload(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.
    
    Parameters:
    
    abortDocumentVersionUploadRequest -
    
    Returns:
    
    Result of the AbortDocumentVersionUpload operation returned by the service.
    
    Throws:
    
    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 AWS 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.
    
    See Also:
    
    AWS API Documentation
  - activateUser
```
ActivateUserResult activateUser(ActivateUserRequest activateUserRequest)
```
    Activates the specified user. Only active users can access Amazon WorkDocs.
    
    Parameters:
    
    activateUserRequest -
    
    Returns:
    
    Result of the ActivateUser operation returned by the service.
    
    Throws:
    
    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 AWS 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.
    
    See Also:
    
    AWS API Documentation
  - addResourcePermissions
```
AddResourcePermissionsResult addResourcePermissions(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.
    
    Parameters:
    
    addResourcePermissionsRequest -
    
    Returns:
    
    Result of the AddResourcePermissions operation returned by the service.
    
    Throws:
    
    UnauthorizedOperationException - The operation is not permitted.
    
    UnauthorizedResourceAccessException - The caller does not have access to perform the action on the resource.
    
    FailedDependencyException - The AWS 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.
    
    See Also:
    
    AWS API Documentation
  - createComment
```
CreateCommentResult createComment(CreateCommentRequest createCommentRequest)
```
    Adds a new comment to the specified document version.
    
    Parameters:
    
    createCommentRequest -
    
    Returns:
    
    Result of the CreateComment operation returned by the service.
    
    Throws:
    
    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 AWS 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.
    
    See Also:
    
    AWS API Documentation
  - createCustomMetadata
```
CreateCustomMetadataResult createCustomMetadata(CreateCustomMetadataRequest createCustomMetadataRequest)
```
    Adds one or more custom properties to the specified resource (a folder, document, or version).
    
    Parameters:
    
    createCustomMetadataRequest -
    
    Returns:
    
    Result of the CreateCustomMetadata operation returned by the service.
    
    Throws:
    
    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 AWS 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.
    
    See Also:
    
    AWS API Documentation
  - createFolder
```
CreateFolderResult createFolder(CreateFolderRequest createFolderRequest)
```
    Creates a folder with the specified name and parent folder.
    
    Parameters:
    
    createFolderRequest -
    
    Returns:
    
    Result of the CreateFolder operation returned by the service.
    
    Throws:
    
    EntityNotExistsException - The resource does not exist.
    
    EntityAlreadyExistsException - The resource already exists.
    
    ProhibitedStateException - The specified document version is not in the INITIALIZED state.
    
    LimitExceededException - The maximum of 100,000 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 AWS 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.
    
    See Also:
    
    AWS API Documentation
  - createLabels
```
CreateLabelsResult createLabels(CreateLabelsRequest createLabelsRequest)
```
    Adds the specified list of labels to the given resource (a document or folder)
    
    Parameters:
    
    createLabelsRequest -
    
    Returns:
    
    Result of the CreateLabels operation returned by the service.
    
    Throws:
    
    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 AWS 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.
    
    See Also:
    
    AWS API Documentation
  - createNotificationSubscription
```
CreateNotificationSubscriptionResult createNotificationSubscription(CreateNotificationSubscriptionRequest createNotificationSubscriptionRequest)
```
    Configure WorkDocs to use Amazon SNS notifications.
    
    The endpoint receives a confirmation message, and must confirm the subscription. For more information, see Confirm the Subscription in the Amazon Simple Notification Service Developer Guide.
    
    Parameters:
    
    createNotificationSubscriptionRequest -
    
    Returns:
    
    Result of the CreateNotificationSubscription operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - createUser
```
CreateUserResult createUser(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.
    
    Parameters:
    
    createUserRequest -
    
    Returns:
    
    Result of the CreateUser operation returned by the service.
    
    Throws:
    
    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 AWS 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.
    
    See Also:
    
    AWS API Documentation
  - deactivateUser
```
DeactivateUserResult deactivateUser(DeactivateUserRequest deactivateUserRequest)
```
    Deactivates the specified user, which revokes the user's access to Amazon WorkDocs.
    
    Parameters:
    
    deactivateUserRequest -
    
    Returns:
    
    Result of the DeactivateUser operation returned by the service.
    
    Throws:
    
    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 AWS 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.
    
    See Also:
    
    AWS API Documentation
  - deleteComment
```
DeleteCommentResult deleteComment(DeleteCommentRequest deleteCommentRequest)
```
    Deletes the specified comment from the document version.
    
    Parameters:
    
    deleteCommentRequest -
    
    Returns:
    
    Result of the DeleteComment operation returned by the service.
    
    Throws:
    
    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 AWS 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.
    
    See Also:
    
    AWS API Documentation
  - deleteCustomMetadata
```
DeleteCustomMetadataResult deleteCustomMetadata(DeleteCustomMetadataRequest deleteCustomMetadataRequest)
```
    Deletes custom metadata from the specified resource.
    
    Parameters:
    
    deleteCustomMetadataRequest -
    
    Returns:
    
    Result of the DeleteCustomMetadata operation returned by the service.
    
    Throws:
    
    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 AWS 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.
    
    See Also:
    
    AWS API Documentation
  - deleteDocument
```
DeleteDocumentResult deleteDocument(DeleteDocumentRequest deleteDocumentRequest)
```
    Permanently deletes the specified document and its associated metadata.
    
    Parameters:
    
    deleteDocumentRequest -
    
    Returns:
    
    Result of the DeleteDocument operation returned by the service.
    
    Throws:
    
    EntityNotExistsException - The resource does not exist.
    
    ProhibitedStateException - The specified document version is not in the INITIALIZED state.
    
    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 AWS 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.
    
    See Also:
    
    AWS API Documentation
  - deleteFolder
```
DeleteFolderResult deleteFolder(DeleteFolderRequest deleteFolderRequest)
```
    Permanently deletes the specified folder and its contents.
    
    Parameters:
    
    deleteFolderRequest -
    
    Returns:
    
    Result of the DeleteFolder operation returned by the service.
    
    Throws:
    
    EntityNotExistsException - The resource does not exist.
    
    ProhibitedStateException - The specified document version is not in the INITIALIZED state.
    
    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 AWS 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.
    
    See Also:
    
    AWS API Documentation
  - deleteFolderContents
```
DeleteFolderContentsResult deleteFolderContents(DeleteFolderContentsRequest deleteFolderContentsRequest)
```
    Deletes the contents of the specified folder.
    
    Parameters:
    
    deleteFolderContentsRequest -
    
    Returns:
    
    Result of the DeleteFolderContents operation returned by the service.
    
    Throws:
    
    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 AWS 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.
    
    See Also:
    
    AWS API Documentation
  - deleteLabels
```
DeleteLabelsResult deleteLabels(DeleteLabelsRequest deleteLabelsRequest)
```
    Deletes the specified list of labels from a resource.
    
    Parameters:
    
    deleteLabelsRequest -
    
    Returns:
    
    Result of the DeleteLabels operation returned by the service.
    
    Throws:
    
    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 AWS 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.
    
    See Also:
    
    AWS API Documentation
  - deleteNotificationSubscription
```
DeleteNotificationSubscriptionResult deleteNotificationSubscription(DeleteNotificationSubscriptionRequest deleteNotificationSubscriptionRequest)
```
    Deletes the specified subscription from the specified organization.
    
    Parameters:
    
    deleteNotificationSubscriptionRequest -
    
    Returns:
    
    Result of the DeleteNotificationSubscription operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - deleteUser
```
DeleteUserResult deleteUser(DeleteUserRequest deleteUserRequest)
```
    Deletes the specified user from a Simple AD or Microsoft AD directory.
    
    Parameters:
    
    deleteUserRequest -
    
    Returns:
    
    Result of the DeleteUser operation returned by the service.
    
    Throws:
    
    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 AWS 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.
    
    See Also:
    
    AWS API Documentation
  - describeActivities
```
DescribeActivitiesResult describeActivities(DescribeActivitiesRequest describeActivitiesRequest)
```
    Describes the user activities in a specified time period.
    
    Parameters:
    
    describeActivitiesRequest -
    
    Returns:
    
    Result of the DescribeActivities operation returned by the service.
    
    Throws:
    
    UnauthorizedOperationException - The operation is not permitted.
    
    UnauthorizedResourceAccessException - The caller does not have access to perform the action on the resource.
    
    InvalidArgumentException - The pagination marker and/or limit fields are not valid.
    
    FailedDependencyException - The AWS 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.
    
    See Also:
    
    AWS API Documentation
  - describeComments
```
DescribeCommentsResult describeComments(DescribeCommentsRequest describeCommentsRequest)
```
    List all the comments for the specified document version.
    
    Parameters:
    
    describeCommentsRequest -
    
    Returns:
    
    Result of the DescribeComments operation returned by the service.
    
    Throws:
    
    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 AWS 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.
    
    See Also:
    
    AWS API Documentation
  - describeDocumentVersions
```
DescribeDocumentVersionsResult describeDocumentVersions(DescribeDocumentVersionsRequest describeDocumentVersionsRequest)
```
    Retrieves the document versions for the specified document.
    
    By default, only active versions are returned.
    
    Parameters:
    
    describeDocumentVersionsRequest -
    
    Returns:
    
    Result of the DescribeDocumentVersions operation returned by the service.
    
    Throws:
    
    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 and/or limit fields are not valid.
    
    FailedDependencyException - The AWS 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.
    
    See Also:
    
    AWS API Documentation
  - describeFolderContents
```
DescribeFolderContentsResult describeFolderContents(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.
    
    Parameters:
    
    describeFolderContentsRequest -
    
    Returns:
    
    Result of the DescribeFolderContents operation returned by the service.
    
    Throws:
    
    EntityNotExistsException - The resource does not exist.
    
    UnauthorizedResourceAccessException - The caller does not have access to perform the action on the resource.
    
    InvalidArgumentException - The pagination marker and/or limit fields are not valid.
    
    FailedDependencyException - The AWS 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.
    
    See Also:
    
    AWS API Documentation
  - describeNotificationSubscriptions
```
DescribeNotificationSubscriptionsResult describeNotificationSubscriptions(DescribeNotificationSubscriptionsRequest describeNotificationSubscriptionsRequest)
```
    Lists the specified notification subscriptions.
    
    Parameters:
    
    describeNotificationSubscriptionsRequest -
    
    Returns:
    
    Result of the DescribeNotificationSubscriptions operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - describeResourcePermissions
```
DescribeResourcePermissionsResult describeResourcePermissions(DescribeResourcePermissionsRequest describeResourcePermissionsRequest)
```
    Describes the permissions of a specified resource.
    
    Parameters:
    
    describeResourcePermissionsRequest -
    
    Returns:
    
    Result of the DescribeResourcePermissions operation returned by the service.
    
    Throws:
    
    UnauthorizedOperationException - The operation is not permitted.
    
    UnauthorizedResourceAccessException - The caller does not have access to perform the action on the resource.
    
    FailedDependencyException - The AWS 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.
    
    See Also:
    
    AWS API Documentation
  - describeRootFolders
```
DescribeRootFoldersResult describeRootFolders(DescribeRootFoldersRequest describeRootFoldersRequest)
```
    Describes the current user's special folders; the RootFolder and the RecyleBin. RootFolder is the root of user's files and folders and RecyleBin is the root of recycled items. This is not a valid action for SigV4 (administrative API) clients.
    
    Parameters:
    
    describeRootFoldersRequest -
    
    Returns:
    
    Result of the DescribeRootFolders operation returned by the service.
    
    Throws:
    
    UnauthorizedOperationException - The operation is not permitted.
    
    UnauthorizedResourceAccessException - The caller does not have access to perform the action on the resource.
    
    InvalidArgumentException - The pagination marker and/or limit fields are not valid.
    
    FailedDependencyException - The AWS 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.
    
    See Also:
    
    AWS API Documentation
  - describeUsers
```
DescribeUsersResult describeUsers(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.
    
    Parameters:
    
    describeUsersRequest -
    
    Returns:
    
    Result of the DescribeUsers operation returned by the service.
    
    Throws:
    
    UnauthorizedOperationException - The operation is not permitted.
    
    UnauthorizedResourceAccessException - The caller does not have access to perform the action on the resource.
    
    FailedDependencyException - The AWS 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 and/or limit fields are not valid.
    
    See Also:
    
    AWS API Documentation
  - getCurrentUser
```
GetCurrentUserResult getCurrentUser(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.
    
    Parameters:
    
    getCurrentUserRequest -
    
    Returns:
    
    Result of the GetCurrentUser operation returned by the service.
    
    Throws:
    
    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 AWS 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.
    
    See Also:
    
    AWS API Documentation
  - getDocument
```
GetDocumentResult getDocument(GetDocumentRequest getDocumentRequest)
```
    Retrieves details of a document.
    
    Parameters:
    
    getDocumentRequest -
    
    Returns:
    
    Result of the GetDocument operation returned by the service.
    
    Throws:
    
    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 and/or limit fields are not valid.
    
    FailedDependencyException - The AWS 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.
    
    See Also:
    
    AWS API Documentation
  - getDocumentPath
```
GetDocumentPathResult getDocumentPath(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.
    
    Parameters:
    
    getDocumentPathRequest -
    
    Returns:
    
    Result of the GetDocumentPath operation returned by the service.
    
    Throws:
    
    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 AWS 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.
    
    See Also:
    
    AWS API Documentation
  - getDocumentVersion
```
GetDocumentVersionResult getDocumentVersion(GetDocumentVersionRequest getDocumentVersionRequest)
```
    Retrieves version metadata for the specified document.
    
    Parameters:
    
    getDocumentVersionRequest -
    
    Returns:
    
    Result of the GetDocumentVersion operation returned by the service.
    
    Throws:
    
    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 AWS 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.
    
    See Also:
    
    AWS API Documentation
  - getFolder
```
GetFolderResult getFolder(GetFolderRequest getFolderRequest)
```
    Retrieves the metadata of the specified folder.
    
    Parameters:
    
    getFolderRequest -
    
    Returns:
    
    Result of the GetFolder operation returned by the service.
    
    Throws:
    
    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 and/or limit fields are not valid.
    
    FailedDependencyException - The AWS 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.
    
    See Also:
    
    AWS API Documentation
  - getFolderPath
```
GetFolderPathResult getFolderPath(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.
    
    Parameters:
    
    getFolderPathRequest -
    
    Returns:
    
    Result of the GetFolderPath operation returned by the service.
    
    Throws:
    
    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 AWS 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.
    
    See Also:
    
    AWS API Documentation
  - initiateDocumentVersionUpload
```
InitiateDocumentVersionUploadResult initiateDocumentVersionUpload(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.
    
    Parameters:
    
    initiateDocumentVersionUploadRequest -
    
    Returns:
    
    Result of the InitiateDocumentVersionUpload operation returned by the service.
    
    Throws:
    
    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.
    
    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 AWS 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.
    
    See Also:
    
    AWS API Documentation
  - removeAllResourcePermissions
```
RemoveAllResourcePermissionsResult removeAllResourcePermissions(RemoveAllResourcePermissionsRequest removeAllResourcePermissionsRequest)
```
    Removes all the permissions from the specified resource.
    
    Parameters:
    
    removeAllResourcePermissionsRequest -
    
    Returns:
    
    Result of the RemoveAllResourcePermissions operation returned by the service.
    
    Throws:
    
    UnauthorizedOperationException - The operation is not permitted.
    
    UnauthorizedResourceAccessException - The caller does not have access to perform the action on the resource.
    
    FailedDependencyException - The AWS 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.
    
    See Also:
    
    AWS API Documentation
  - removeResourcePermission
```
RemoveResourcePermissionResult removeResourcePermission(RemoveResourcePermissionRequest removeResourcePermissionRequest)
```
    Removes the permission for the specified principal from the specified resource.
    
    Parameters:
    
    removeResourcePermissionRequest -
    
    Returns:
    
    Result of the RemoveResourcePermission operation returned by the service.
    
    Throws:
    
    UnauthorizedOperationException - The operation is not permitted.
    
    UnauthorizedResourceAccessException - The caller does not have access to perform the action on the resource.
    
    FailedDependencyException - The AWS 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.
    
    See Also:
    
    AWS API Documentation
  - updateDocument
```
UpdateDocumentResult updateDocument(UpdateDocumentRequest updateDocumentRequest)
```
    Updates the specified attributes of a document. The user must have access to both the document and its parent folder, if applicable.
    
    Parameters:
    
    updateDocumentRequest -
    
    Returns:
    
    Result of the UpdateDocument operation returned by the service.
    
    Throws:
    
    EntityNotExistsException - The resource does not exist.
    
    EntityAlreadyExistsException - The resource already exists.
    
    LimitExceededException - The maximum of 100,000 folders under the parent folder has been exceeded.
    
    ProhibitedStateException - The specified document version is not in the INITIALIZED state.
    
    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 AWS 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.
    
    See Also:
    
    AWS API Documentation
  - updateDocumentVersion
```
UpdateDocumentVersionResult updateDocumentVersion(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.
    
    Parameters:
    
    updateDocumentVersionRequest -
    
    Returns:
    
    Result of the UpdateDocumentVersion operation returned by the service.
    
    Throws:
    
    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 AWS 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.
    
    See Also:
    
    AWS API Documentation
  - updateFolder
```
UpdateFolderResult updateFolder(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.
    
    Parameters:
    
    updateFolderRequest -
    
    Returns:
    
    Result of the UpdateFolder operation returned by the service.
    
    Throws:
    
    EntityNotExistsException - The resource does not exist.
    
    EntityAlreadyExistsException - The resource already exists.
    
    ProhibitedStateException - The specified document version is not in the INITIALIZED state.
    
    ConcurrentModificationException - The resource hierarchy is changing.
    
    LimitExceededException - The maximum of 100,000 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 AWS 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.
    
    See Also:
    
    AWS API Documentation
  - updateUser
```
UpdateUserResult updateUser(UpdateUserRequest updateUserRequest)
```
    Updates the specified attributes of the specified user, and grants or revokes administrative privileges to the Amazon WorkDocs site.
    
    Parameters:
    
    updateUserRequest -
    
    Returns:
    
    Result of the UpdateUser operation returned by the service.
    
    Throws:
    
    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.
    
    FailedDependencyException - The AWS 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.
    
    See Also:
    
    AWS API Documentation
  - shutdown
```
void shutdown()
```
    Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.
  - getCachedResponseMetadata
```
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. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.
    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.
    
    Parameters:
    
    request - The originally executed request.
    
    Returns:
    
    The response metadata for the specified request, or null if none is available.

Did this page help you?

Interface AmazonWorkDocs

Field Summary

Method Summary

Field Detail

ENDPOINT_PREFIX

Method Detail

abortDocumentVersionUpload

activateUser

addResourcePermissions

createComment

createCustomMetadata

createFolder

createLabels

createNotificationSubscription

createUser

deactivateUser

deleteComment

deleteCustomMetadata

deleteDocument

deleteFolder

deleteFolderContents

deleteLabels

deleteNotificationSubscription

deleteUser

describeActivities

describeComments

describeDocumentVersions

describeFolderContents

describeNotificationSubscriptions

describeResourcePermissions

describeRootFolders

describeUsers

getCurrentUser

getDocument

getDocumentPath

getDocumentVersion

getFolder

getFolderPath

initiateDocumentVersionUpload

removeAllResourcePermissions

removeResourcePermission

updateDocument

updateDocumentVersion

updateFolder

updateUser

shutdown

getCachedResponseMetadata