Data retrieval APIs for Amazon WorkDocs
Amazon WorkDocs provides the following APIs for data retrieval.
Actions | Description | Access level |
---|---|---|
CheckAlias | Check an alias | Read |
DescribeActivities | Fetch user activities in a specified time period | List |
DescribeAvailableDirectories | Describe available directories | List |
DescribeComments | List all the comments for the specified document version | List |
DescribeDocumentVersions | Retrieve the document versions for the specified document | List |
DescribeFolderContents | Describe the contents of the specified folder, including its documents and sub-folders | List |
DescribeGroups | Describe the user groups | List |
DescribeInstanceExports | Describe the export history for an instance | List |
DescribeInstances | Describe instances | List |
DescribeNotificationPermissions | Describe principals that are allowed to call notification subscription APIs for a given WorkDocs site | List |
DescribeNotificationSubscriptions | List the specified notification subscriptions | List |
DescribeResourcePermissions | View a description of a specified resource's permissions | List |
DescribeRootFolders | Describe the root folders | List |
DescribeUsers | View a description of the specified users. You can describe all users or filter the results (for example, by status or organization) | List |
DownloadDocumentVersion | Download a specified document version | Read |
GetCurrentUser | Retrieve the details of the current user | Read |
GetDocument | Retrieve the specified document object | Read |
GetDocumentPath | Retrieve the path information (the hierarchy from the root folder) for the requested document | Read |
GetDocumentVersion | Retrieve version metadata for the specified document | Read |
GetFolder | Retrieve the metadata of the specified folder | Read |
GetFolderPath | Retrieve the path information (the hierarchy from the root folder) for the specified folder | Read |
GetGroup | Retrieve details for the specified group | Read |
GetResources | Get a collection of resources | Read |
SearchResources | Search metadata and the content of resources | List |