AmazonWorkDocsClient (AWS SDK for Java

java.lang.Object
- com.amazonaws.AmazonWebServiceClient
- - com.amazonaws.services.workdocs.AmazonWorkDocsClient

All Implemented Interfaces:

AmazonWorkDocs

Direct Known Subclasses:

AmazonWorkDocsAsyncClient
```
@ThreadSafe
 @Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AmazonWorkDocsClient
extends AmazonWebServiceClient
implements AmazonWorkDocs
```
Client for accessing Amazon WorkDocs. All service calls made using this client are blocking, and will not return until the service call completes.

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 inherited from class com.amazonaws.AmazonWebServiceClient
  LOGGING_AWS_REQUEST_METRIC
- Fields inherited from interface com.amazonaws.services.workdocs.AmazonWorkDocs
  ENDPOINT_PREFIX

Method Summary

All Methods Static Methods Instance Methods Concrete 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.
`static AmazonWorkDocsClientBuilder`	`builder()`
`CreateFolderResult`	`createFolder(CreateFolderRequest createFolderRequest)` Creates a folder with the specified name and parent 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.
`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.
`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.
`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 sub-folders.
`DescribeNotificationSubscriptionsResult`	`describeNotificationSubscriptions(DescribeNotificationSubscriptionsRequest describeNotificationSubscriptionsRequest)` Lists the specified notification subscriptions.
`DescribeResourcePermissionsResult`	`describeResourcePermissions(DescribeResourcePermissionsRequest describeResourcePermissionsRequest)` Describes the permissions of a specified resource.
`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.
`GetDocumentResult`	`getDocument(GetDocumentRequest getDocumentRequest)` Retrieves the specified document object.
`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.
`UpdateDocumentResult`	`updateDocument(UpdateDocumentRequest updateDocumentRequest)` Updates the specified attributes of the specified 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.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.amazonaws.services.workdocs.AmazonWorkDocs
shutdown

- Method Detail
  - builder
```
public static AmazonWorkDocsClientBuilder builder()
```
  - abortDocumentVersionUpload
```
public 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 or fails to upload the document version.
    
    Specified by:
    
    abortDocumentVersionUpload in interface AmazonWorkDocs
    
    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
```
public ActivateUserResult activateUser(ActivateUserRequest activateUserRequest)
```
    Activates the specified user. Only active users can access Amazon WorkDocs.
    
    Specified by:
    
    activateUser in interface AmazonWorkDocs
    
    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
```
public 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.
    
    Specified by:
    
    addResourcePermissions in interface AmazonWorkDocs
    
    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
  - createFolder
```
public CreateFolderResult createFolder(CreateFolderRequest createFolderRequest)
```
    Creates a folder with the specified name and parent folder.
    
    Specified by:
    
    createFolder in interface AmazonWorkDocs
    
    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 - You've exceeded the maximum of 100,000 folders under the parent folder.
    
    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
  - createNotificationSubscription
```
public 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.
    
    Specified by:
    
    createNotificationSubscription in interface AmazonWorkDocs
    
    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
```
public 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.
    
    Specified by:
    
    createUser in interface AmazonWorkDocs
    
    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
```
public DeactivateUserResult deactivateUser(DeactivateUserRequest deactivateUserRequest)
```
    Deactivates the specified user, which revokes the user's access to Amazon WorkDocs.
    
    Specified by:
    
    deactivateUser in interface AmazonWorkDocs
    
    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
  - deleteDocument
```
public DeleteDocumentResult deleteDocument(DeleteDocumentRequest deleteDocumentRequest)
```
    Permanently deletes the specified document and its associated metadata.
    
    Specified by:
    
    deleteDocument in interface AmazonWorkDocs
    
    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
```
public DeleteFolderResult deleteFolder(DeleteFolderRequest deleteFolderRequest)
```
    Permanently deletes the specified folder and its contents.
    
    Specified by:
    
    deleteFolder in interface AmazonWorkDocs
    
    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
```
public DeleteFolderContentsResult deleteFolderContents(DeleteFolderContentsRequest deleteFolderContentsRequest)
```
    Deletes the contents of the specified folder.
    
    Specified by:
    
    deleteFolderContents in interface AmazonWorkDocs
    
    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
  - deleteNotificationSubscription
```
public DeleteNotificationSubscriptionResult deleteNotificationSubscription(DeleteNotificationSubscriptionRequest deleteNotificationSubscriptionRequest)
```
    Deletes the specified subscription from the specified organization.
    
    Specified by:
    
    deleteNotificationSubscription in interface AmazonWorkDocs
    
    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
```
public DeleteUserResult deleteUser(DeleteUserRequest deleteUserRequest)
```
    Deletes the specified user from a Simple AD or Microsoft AD directory.
    
    Specified by:
    
    deleteUser in interface AmazonWorkDocs
    
    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
  - describeDocumentVersions
```
public DescribeDocumentVersionsResult describeDocumentVersions(DescribeDocumentVersionsRequest describeDocumentVersionsRequest)
```
    Retrieves the document versions for the specified document.
    
    By default, only active versions are returned.
    
    Specified by:
    
    describeDocumentVersions in interface AmazonWorkDocs
    
    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
```
public DescribeFolderContentsResult describeFolderContents(DescribeFolderContentsRequest describeFolderContentsRequest)
```
    Describes the contents of the specified folder, including its documents and sub-folders.
    
    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.
    
    Specified by:
    
    describeFolderContents in interface AmazonWorkDocs
    
    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
```
public DescribeNotificationSubscriptionsResult describeNotificationSubscriptions(DescribeNotificationSubscriptionsRequest describeNotificationSubscriptionsRequest)
```
    Lists the specified notification subscriptions.
    
    Specified by:
    
    describeNotificationSubscriptions in interface AmazonWorkDocs
    
    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
```
public DescribeResourcePermissionsResult describeResourcePermissions(DescribeResourcePermissionsRequest describeResourcePermissionsRequest)
```
    Describes the permissions of a specified resource.
    
    Specified by:
    
    describeResourcePermissions in interface AmazonWorkDocs
    
    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
  - describeUsers
```
public 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.
    
    Specified by:
    
    describeUsers in interface AmazonWorkDocs
    
    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
  - getDocument
```
public GetDocumentResult getDocument(GetDocumentRequest getDocumentRequest)
```
    Retrieves the specified document object.
    
    Specified by:
    
    getDocument in interface AmazonWorkDocs
    
    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
```
public 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.
    
    Specified by:
    
    getDocumentPath in interface AmazonWorkDocs
    
    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
```
public GetDocumentVersionResult getDocumentVersion(GetDocumentVersionRequest getDocumentVersionRequest)
```
    Retrieves version metadata for the specified document.
    
    Specified by:
    
    getDocumentVersion in interface AmazonWorkDocs
    
    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
```
public GetFolderResult getFolder(GetFolderRequest getFolderRequest)
```
    Retrieves the metadata of the specified folder.
    
    Specified by:
    
    getFolder in interface AmazonWorkDocs
    
    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
```
public 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.
    
    Specified by:
    
    getFolderPath in interface AmazonWorkDocs
    
    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
```
public 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.
    
    Specified by:
    
    initiateDocumentVersionUpload in interface AmazonWorkDocs
    
    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.
    
    See Also:
    
    AWS API Documentation
  - removeAllResourcePermissions
```
public RemoveAllResourcePermissionsResult removeAllResourcePermissions(RemoveAllResourcePermissionsRequest removeAllResourcePermissionsRequest)
```
    Removes all the permissions from the specified resource.
    
    Specified by:
    
    removeAllResourcePermissions in interface AmazonWorkDocs
    
    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
```
public RemoveResourcePermissionResult removeResourcePermission(RemoveResourcePermissionRequest removeResourcePermissionRequest)
```
    Removes the permission for the specified principal from the specified resource.
    
    Specified by:
    
    removeResourcePermission in interface AmazonWorkDocs
    
    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
```
public UpdateDocumentResult updateDocument(UpdateDocumentRequest updateDocumentRequest)
```
    Updates the specified attributes of the specified document. The user must have access to both the document and its parent folder, if applicable.
    
    Specified by:
    
    updateDocument in interface AmazonWorkDocs
    
    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 - You've exceeded the maximum of 100,000 folders under the parent folder.
    
    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
```
public 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.
    
    Specified by:
    
    updateDocumentVersion in interface AmazonWorkDocs
    
    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
```
public 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.
    
    Specified by:
    
    updateFolder in interface AmazonWorkDocs
    
    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 - You've exceeded the maximum of 100,000 folders under the parent folder.
    
    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
```
public UpdateUserResult updateUser(UpdateUserRequest updateUserRequest)
```
    Updates the specified attributes of the specified user, and grants or revokes administrative privileges to the Amazon WorkDocs site.
    
    Specified by:
    
    updateUser in interface AmazonWorkDocs
    
    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
  - getCachedResponseMetadata
```
public 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 the request.
    
    Specified by:
    
    getCachedResponseMetadata in interface AmazonWorkDocs
    
    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?

Class AmazonWorkDocsClient

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceClient

Fields inherited from interface com.amazonaws.services.workdocs.AmazonWorkDocs

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceClient

Methods inherited from class java.lang.Object

Methods inherited from interface com.amazonaws.services.workdocs.AmazonWorkDocs

Method Detail

builder

abortDocumentVersionUpload

activateUser

addResourcePermissions

createFolder

createNotificationSubscription

createUser

deactivateUser

deleteDocument

deleteFolder

deleteFolderContents

deleteNotificationSubscription

deleteUser

describeDocumentVersions

describeFolderContents

describeNotificationSubscriptions

describeResourcePermissions

describeUsers

getDocument

getDocumentPath

getDocumentVersion

getFolder

getFolderPath

initiateDocumentVersionUpload

removeAllResourcePermissions

removeResourcePermission

updateDocument

updateDocumentVersion

updateFolder

updateUser

getCachedResponseMetadata