Amazon WorkDocs
The Amazon WorkDocs API is designed for the following use cases: File Migration: File migration applications are supported for users who want to migrate their…
Productivity & workspace#openapi#cloud
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
The Amazon WorkDocs API is designed for the following use cases:
File Migration: File migration applications are supported for users who
want to migrate their files from an on-premises or off-premises file system or
service. Users can insert files into a user directory structure, as well as
allow for basic metadata changes, such as modifications to the permissions of
files.
Security: Support security applications are supported for users who have
additional security needs, such as antivirus or data loss prevention. The API
actions, along with CloudTrail, allow these applications to detect when
changes occur in Amazon WorkDocs. Then, the application can take the necessary
actions and replace the target file. If the target file violates the policy, the
application can also choose to email the user.
eDiscovery/Analytics: General administrative applications are supported,
such as eDiscovery and analytics. These applications can choose to mimic or
record the actions in an Amazon WorkDocs site, along with CloudTrail, to
replicate data for eDiscovery, backup, or analytical applications.
All Amazon WorkDocs API actions are Amazon authenticated and certificate-signed.
They not only require the use of the Amazon Web Services SDK, but also allow for the exclusive use of
IAM users and roles to help facilitate access, trust, and permission policies. By
creating a role and allowing an IAM user to access the Amazon WorkDocs site, the
IAM user gains full administrative visibility into the entire Amazon WorkDocs site (or as
set in the IAM policy). This includes, but is not limited to, the ability to modify file
permissions and upload any file to any user. This allows developers to perform the three
use cases above, as well as give users the ability to grant access on a selective basis
using the IAM model.
The pricing for Amazon WorkDocs APIs varies depending on the API call type for these actions:
READ (Get*)
WRITE (Activate, Add, Create, Deactivate, Initiate, Update)
LIST (Describe*)
DELETE*, CANCEL
For information about Amazon WorkDocs API pricing, see Amazon WorkDocs Pricing .
Endpoints 44
- GETGet document version
/api/v1/documents/:DocumentId/versions/:VersionId?fields=string&includeCustomMetadata=trueRetrieves version metadata for the specified document. - DELETEAbort document version upload
/api/v1/documents/:DocumentId/versions/:VersionIdAborts the upload of the specified document version that was previously initiated by InitiateDocumentVersionUpload . The client should make this call only… - PATCHUpdate document version
/api/v1/documents/:DocumentId/versions/:VersionIdChanges 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,… - POSTActivate user
/api/v1/users/:UserId/activationActivates the specified user. Only active users can access Amazon WorkDocs. - DELETEDeactivate user
/api/v1/users/:UserId/activationDeactivates the specified user, which revokes the user's access to Amazon WorkDocs. - GETDescribe resource permissions
/api/v1/resources/:ResourceId/permissions?principalId=string&limit=0&marker=stringDescribes the permissions of a specified resource. - POSTAdd resource permissions
/api/v1/resources/:ResourceId/permissionsCreates a set of permissions for the specified folder or document. The resource permissions are overwritten if the principals already have different… - DELETERemove all resource permissions
/api/v1/resources/:ResourceId/permissionsRemoves all the permissions from the specified resource. - POSTCreate comment
/api/v1/documents/:DocumentId/versions/:VersionId/commentAdds a new comment to the specified document version. - PUTCreate custom metadata
/api/v1/resources/:ResourceId/customMetadata?versionid=stringAdds one or more custom properties to the specified resource (a folder, document, or version). - DELETEDelete custom metadata
/api/v1/resources/:ResourceId/customMetadata?versionId=string&keys=&deleteAll=trueDeletes custom metadata from the specified resource. - POSTCreate folder
/api/v1/foldersCreates a folder with the specified name and parent folder. - PUTCreate labels
/api/v1/resources/:ResourceId/labelsAdds the specified list of labels to the given resource (a document or folder) - DELETEDelete labels
/api/v1/resources/:ResourceId/labels?labels=&deleteAll=trueDeletes the specified list of labels from a resource. - GETDescribe notification subscriptions
/api/v1/organizations/:OrganizationId/subscriptions?marker=string&limit=0Lists the specified notification subscriptions. - POSTCreate notification subscription
/api/v1/organizations/:OrganizationId/subscriptionsConfigure Amazon WorkDocs to use Amazon SNS notifications. The endpoint receives a confirmation message, and must confirm the subscription. For more… - GETDescribe users
/api/v1/users?organizationId=string&userIds=string&query=string&include=string&order=string&sort=string&marker=string&limit=0&fields=stringDescribes the specified users. You can describe all users or filter the results (for example, by status or organization). By default, Amazon WorkDocs returns… - POSTCreate user
/api/v1/usersCreates 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. - DELETEDelete comment
/api/v1/documents/:DocumentId/versions/:VersionId/comment/:CommentIdDeletes the specified comment from the document version. - GETGet document
/api/v1/documents/:DocumentId?includeCustomMetadata=trueRetrieves details of a document. - DELETEDelete document
/api/v1/documents/:DocumentIdPermanently deletes the specified document and its associated metadata. - PATCHUpdate document
/api/v1/documents/:DocumentIdUpdates the specified attributes of a document. The user must have access to both the document and its parent folder, if applicable. - DELETEDelete document version
/api/v1/documentVersions/:DocumentId/versions/:VersionId?deletePriorVersions=trueDeletes a specific version of a document. - GETGet folder
/api/v1/folders/:FolderId?includeCustomMetadata=trueRetrieves the metadata of the specified folder. - DELETEDelete folder
/api/v1/folders/:FolderIdPermanently deletes the specified folder and its contents. - PATCHUpdate folder
/api/v1/folders/:FolderIdUpdates the specified attributes of the specified folder. The user must have access to both the folder and its parent folder, if applicable. - GETDescribe folder contents
/api/v1/folders/:FolderId/contents?sort=string&order=string&limit=0&marker=string&type=string&include=stringDescribes the contents of the specified folder, including its documents and subfolders. By default, Amazon WorkDocs returns the first 100 active document and… - DELETEDelete folder contents
/api/v1/folders/:FolderId/contentsDeletes the contents of the specified folder. - DELETEDelete notification subscription
/api/v1/organizations/:OrganizationId/subscriptions/:SubscriptionIdDeletes the specified subscription from the specified organization. - DELETEDelete user
/api/v1/users/:UserIdDeletes the specified user from a Simple AD or Microsoft AD directory. Deleting a user immediately and permanently deletes all content in that user's folder… - PATCHUpdate user
/api/v1/users/:UserIdUpdates the specified attributes of the specified user, and grants or revokes administrative privileges to the Amazon WorkDocs site. - GETDescribe activities
/api/v1/activities?startTime=string&endTime=string&organizationId=string&activityTypes=string&resourceId=string&userId=string&includeIndirectActivities=true&limit=0&marker=stringDescribes the user activities in a specified time period. - GETDescribe comments
/api/v1/documents/:DocumentId/versions/:VersionId/comments?limit=0&marker=stringList all the comments for the specified document version. - GETDescribe document versions
/api/v1/documents/:DocumentId/versions?marker=string&limit=0&include=string&fields=stringRetrieves the document versions for the specified document. By default, only active versions are returned. - GETDescribe groups
/api/v1/groups?searchQuery=string&organizationId=string&marker=string&limit=0Describes the groups specified by the query. Groups are defined by the underlying Active Directory. - GETDescribe root folders
/api/v1/me/root?limit=0&marker=stringDescribes the current user's special folders; the RootFolder and the RecycleBin . RootFolder is the root of user's files and folders and RecycleBin is the… - GETGet current user
/api/v1/meRetrieves details of the current user for whom the authentication token was generated. This is not a valid action for SigV4 (administrative API) clients. This… - GETGet document path
/api/v1/documents/:DocumentId/path?limit=0&fields=string&marker=stringRetrieves the path information (the hierarchy from the root folder) for the requested document. By default, Amazon WorkDocs returns a maximum of 100 levels… - GETGet folder path
/api/v1/folders/:FolderId/path?limit=0&fields=string&marker=stringRetrieves the path information (the hierarchy from the root folder) for the specified folder. By default, Amazon WorkDocs returns a maximum of 100 levels… - GETGet resources
/api/v1/resources?userId=string&collectionType=string&limit=0&marker=stringRetrieves a collection of resources, including folders and documents. The only CollectionType supported is SHARED_WITH_ME . - POSTInitiate document version upload
/api/v1/documentsCreates 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… - DELETERemove resource permission
/api/v1/resources/:ResourceId/permissions/:PrincipalId?type=stringRemoves the permission for the specified principal from the specified resource. - POSTRestore document versions
/api/v1/documentVersions/restore/:DocumentIdRecovers a deleted version of an Amazon WorkDocs document. - POSTSearch resources
/api/v1/searchSearches metadata and the content of folders, documents, document versions, and comments.
API details
- Base URL
https://workdocs.{region}.amazonaws.com- Authentication
- AWS Signature Version 4 (requests signed with your AWS access key)
- Operations
- 44 operations on 29 pathsGET 16DELETE 13POST 9PATCH 4PUT 2
- Description format
- AWS Smithy model, API version
2016-05-01 - Links
- Documentation · OpenAPI document
- Listed from
- AWS Smithy API model (aws/api-models-aws) (Apache-2.0)
How to test the Amazon WorkDocs in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the Amazon WorkDocs collection, without the publisher's secrets.
- Add your credentialsThis API uses AWS Signature Version 4 (requests signed with your AWS access key). Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “Get document version” (GET /api/v1/documents/:DocumentId/versions/:VersionId?fields=string&includeCustomMetadata=true), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the Amazon WorkDocs?
The Amazon WorkDocs API is designed for the following use cases: File Migration: File migration applications are supported for users who want to migrate their… It is listed under Productivity & workspace and has 44 endpoints.
Who publishes the Amazon WorkDocs?
It is listed from Amazon Web Services, Inc.'s public API description (an OpenAPI document), not published by Amazon Web Services, Inc. on Swastik Codes. Anyone who controls amazonaws.com can claim the profile by adding a DNS TXT record.
What is the base URL of the Amazon WorkDocs?
Requests go to https://workdocs.{region}.amazonaws.com. Endpoint paths are added to this base URL.
How do I authenticate with the Amazon WorkDocs?
With AWS Signature Version 4 (requests signed with your AWS access key).
How many endpoints does the Amazon WorkDocs have?
44 operations on 29 paths (16 GET, 13 DELETE, 9 POST, 4 PATCH, 2 PUT).
Is forking the Amazon WorkDocs free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.