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§
- Abort
Document Version Upload Request - Activate
User Request - Activate
User Response - Activity
Describes the activity information.
- AddResource
Permissions Request - AddResource
Permissions Response - Comment
Describes a comment.
- Comment
Metadata Describes the metadata of a comment.
- Create
Comment Request - Create
Comment Response - Create
Custom Metadata Request - Create
Custom Metadata Response - Create
Folder Request - Create
Folder Response - Create
Labels Request - Create
Labels Response - Create
Notification Subscription Request - Create
Notification Subscription Response - Create
User Request - Create
User Response - Deactivate
User Request - Delete
Comment Request - Delete
Custom Metadata Request - Delete
Custom Metadata Response - Delete
Document Request - Delete
Folder Contents Request - Delete
Folder Request - Delete
Labels Request - Delete
Labels Response - Delete
Notification Subscription Request - Delete
User Request - Describe
Activities Request - Describe
Activities Response - Describe
Comments Request - Describe
Comments Response - Describe
Document Versions Request - Describe
Document Versions Response - Describe
Folder Contents Request - Describe
Folder Contents Response - Describe
Groups Request - Describe
Groups Response - Describe
Notification Subscriptions Request - Describe
Notification Subscriptions Response - Describe
Resource Permissions Request - Describe
Resource Permissions Response - Describe
Root Folders Request - Describe
Root Folders Response - Describe
Users Request - Describe
Users Response - Document
Metadata Describes the document.
- Document
Version Metadata Describes a version of a document.
- Folder
Metadata Describes a folder.
- GetCurrent
User Request - GetCurrent
User Response - GetDocument
Path Request - GetDocument
Path Response - GetDocument
Request - GetDocument
Response - GetDocument
Version Request - GetDocument
Version Response - GetFolder
Path Request - GetFolder
Path Response - GetFolder
Request - GetFolder
Response - GetResources
Request - GetResources
Response - Group
Metadata Describes the metadata of a user group.
- Initiate
Document Version Upload Request - Initiate
Document Version Upload Response - Notification
Options Set of options which defines notification preferences of given action.
- Participants
Describes the users or user groups.
- Permission
Info Describes the permissions.
- Principal
Describes a resource.
- Remove
AllResource Permissions Request - Remove
Resource Permission Request - Resource
Metadata Describes the metadata of a resource.
- Resource
Path Describes the path information of a resource.
- Resource
Path Component Describes the resource path.
- Share
Principal Describes the recipient type and ID, if available.
- Share
Result Describes the share results of a resource.
- Storage
Rule Type Describes the storage for a user.
- Subscription
Describes a subscription.
- Update
Document Request - Update
Document Version Request - Update
Folder Request - Update
User Request - Update
User Response - Upload
Metadata Describes the upload.
- User
Describes a user.
- User
Metadata Describes the metadata of the user.
- User
Storage Metadata Describes the storage for a user.
- Workdocs
Client - A client for the Amazon WorkDocs API.
Enums§
- Abort
Document Version Upload Error - Errors returned by AbortDocumentVersionUpload
- Activate
User Error - Errors returned by ActivateUser
- AddResource
Permissions Error - Errors returned by AddResourcePermissions
- Create
Comment Error - Errors returned by CreateComment
- Create
Custom Metadata Error - Errors returned by CreateCustomMetadata
- Create
Folder Error - Errors returned by CreateFolder
- Create
Labels Error - Errors returned by CreateLabels
- Create
Notification Subscription Error - Errors returned by CreateNotificationSubscription
- Create
User Error - Errors returned by CreateUser
- Deactivate
User Error - Errors returned by DeactivateUser
- Delete
Comment Error - Errors returned by DeleteComment
- Delete
Custom Metadata Error - Errors returned by DeleteCustomMetadata
- Delete
Document Error - Errors returned by DeleteDocument
- Delete
Folder Contents Error - Errors returned by DeleteFolderContents
- Delete
Folder Error - Errors returned by DeleteFolder
- Delete
Labels Error - Errors returned by DeleteLabels
- Delete
Notification Subscription Error - Errors returned by DeleteNotificationSubscription
- Delete
User Error - Errors returned by DeleteUser
- Describe
Activities Error - Errors returned by DescribeActivities
- Describe
Comments Error - Errors returned by DescribeComments
- Describe
Document Versions Error - Errors returned by DescribeDocumentVersions
- Describe
Folder Contents Error - Errors returned by DescribeFolderContents
- Describe
Groups Error - Errors returned by DescribeGroups
- Describe
Notification Subscriptions Error - Errors returned by DescribeNotificationSubscriptions
- Describe
Resource Permissions Error - Errors returned by DescribeResourcePermissions
- Describe
Root Folders Error - Errors returned by DescribeRootFolders
- Describe
Users Error - Errors returned by DescribeUsers
- GetCurrent
User Error - Errors returned by GetCurrentUser
- GetDocument
Error - Errors returned by GetDocument
- GetDocument
Path Error - Errors returned by GetDocumentPath
- GetDocument
Version Error - Errors returned by GetDocumentVersion
- GetFolder
Error - Errors returned by GetFolder
- GetFolder
Path Error - Errors returned by GetFolderPath
- GetResources
Error - Errors returned by GetResources
- Initiate
Document Version Upload Error - Errors returned by InitiateDocumentVersionUpload
- Remove
AllResource Permissions Error - Errors returned by RemoveAllResourcePermissions
- Remove
Resource Permission Error - Errors returned by RemoveResourcePermission
- Update
Document Error - Errors returned by UpdateDocument
- Update
Document Version Error - Errors returned by UpdateDocumentVersion
- Update
Folder Error - Errors returned by UpdateFolder
- Update
User Error - Errors returned by UpdateUser
Traits§
- Workdocs
- Trait representing the capabilities of the Amazon WorkDocs API. Amazon WorkDocs clients implement this trait.