logo
Expand description

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-premises or off-premises file system or service. Users can insert files into a user directory structure, as well as allow for basic metadata changes, such as modifications to the permissions of files.

  • Security: Support security applications are supported for users who have additional security needs, such as antivirus or data loss prevention. The API actions, along with AWS CloudTrail, allow these applications to detect when changes occur in Amazon WorkDocs. Then, the application can take the necessary actions and replace the target file. If the target file violates the policy, the application can also choose to email the user.

  • eDiscovery/Analytics: General administrative applications are supported, such as eDiscovery and analytics. These applications can choose to mimic or record the actions in an Amazon WorkDocs site, along with AWS CloudTrail, to replicate data for eDiscovery, backup, or analytical applications.

All Amazon WorkDocs API actions are Amazon authenticated and certificate-signed. They not only require the use of the 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.

If you’re using the service, you’re probably looking for WorkdocsClient and Workdocs.

Structs

Describes the activity information.

Describes a comment.

Describes the metadata of a comment.

Describes the document.

Describes a version of a document.

Describes a folder.

Describes the metadata of a user group.

Set of options which defines notification preferences of given action.

Describes the users or user groups.

Describes the permissions.

Describes a resource.

Describes the metadata of a resource.

Describes the path information of a resource.

Describes the resource path.

Describes the recipient type and ID, if available.

Describes the share results of a resource.

Describes the storage for a user.

Describes a subscription.

Describes the upload.

Describes a user.

Describes the metadata of the user.

Describes the storage for a user.

A client for the Amazon WorkDocs API.

Enums

Errors returned by AbortDocumentVersionUpload

Errors returned by ActivateUser

Errors returned by AddResourcePermissions

Errors returned by CreateComment

Errors returned by CreateCustomMetadata

Errors returned by CreateFolder

Errors returned by CreateLabels

Errors returned by CreateNotificationSubscription

Errors returned by CreateUser

Errors returned by DeactivateUser

Errors returned by DeleteComment

Errors returned by DeleteCustomMetadata

Errors returned by DeleteDocument

Errors returned by DeleteFolderContents

Errors returned by DeleteFolder

Errors returned by DeleteLabels

Errors returned by DeleteNotificationSubscription

Errors returned by DeleteUser

Errors returned by DescribeActivities

Errors returned by DescribeComments

Errors returned by DescribeDocumentVersions

Errors returned by DescribeFolderContents

Errors returned by DescribeGroups

Errors returned by DescribeNotificationSubscriptions

Errors returned by DescribeResourcePermissions

Errors returned by DescribeRootFolders

Errors returned by DescribeUsers

Errors returned by GetCurrentUser

Errors returned by GetDocument

Errors returned by GetDocumentPath

Errors returned by GetDocumentVersion

Errors returned by GetFolder

Errors returned by GetFolderPath

Errors returned by GetResources

Errors returned by InitiateDocumentVersionUpload

Errors returned by RemoveAllResourcePermissions

Errors returned by RemoveResourcePermission

Errors returned by UpdateDocument

Errors returned by UpdateDocumentVersion

Errors returned by UpdateFolder

Errors returned by UpdateUser

Traits

Trait representing the capabilities of the Amazon WorkDocs API. Amazon WorkDocs clients implement this trait.