# Amazon WorkDocs API

> Amazon WorkDocs API on Apizie: 44 endpoints (Retrieves version metadata for the specified document., Changes the status of the document version to ACTIVE. Amazon WorkDocs also sets its document container to…, Aborts the upload of the specified document version that was previously initiated by…, Activates the specified user. Only active users can access Amazon WorkDocs., …) returned as clean JSON through one API key. Send your own provider key in the x-upstream-key header. Call it over REST at https://zieapi.vercel.app/v1/cloud:amazonaws-workdocs/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `cloud:amazonaws-workdocs`
- Category: Cloud
- Status: byok
- Source: https://github.com/mermade/aws2openapi
- Page: https://zieapi.vercel.app/api/cloud/amazonaws-workdocs
- OpenAPI: https://zieapi.vercel.app/api/cloud/amazonaws-workdocs/openapi.json

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…

## Endpoints

### Retrieves version metadata for the specified document.
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-workdocs/get-document-version` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| Authentication | string | no | Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API. |
| DocumentId | string | yes | The ID of the document. |
| VersionId | string | yes | The version ID of the document. |
| fields | string | no | A comma-separated list of values. Specify "SOURCE" to include a URL for the source document. |
| includeCustomMetadata | boolean | no | Set this to TRUE to include custom metadata in the response. |

### Changes the status of the document version to ACTIVE. Amazon WorkDocs also sets its document container to…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-workdocs/update-document-version` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| Authentication | string | no | Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API. |
| DocumentId | string | yes | The ID of the document. |
| VersionId | string | yes | The version ID of the document. |
| body | object | yes | JSON request body |

### Aborts the upload of the specified document version that was previously initiated by…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-workdocs/abort-document-version-upload` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| Authentication | string | no | Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API. |
| DocumentId | string | yes | The ID of the document. |
| VersionId | string | yes | The ID of the version. |

### Activates the specified user. Only active users can access Amazon WorkDocs.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-workdocs/activate-user` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| UserId | string | yes | The ID of the user. |
| Authentication | string | no | Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API. |

### Deactivates the specified user, which revokes the user's access to Amazon WorkDocs.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-workdocs/deactivate-user` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| UserId | string | yes | The ID of the user. |
| Authentication | string | no | Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API. |

### Describes the permissions of a specified resource.
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-workdocs/describe-resource-permissions` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| Authentication | string | no | Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API. |
| ResourceId | string | yes | The ID of the resource. |
| principalId | string | no | The ID of the principal to filter permissions by. |
| limit | integer | no | The maximum number of items to return with this call. |
| marker | string | no | The marker for the next set of results. (You received this marker from a previous call) |
| Limit | string | no | Pagination limit |
| Marker | string | no | Pagination token |

### Creates a set of permissions for the specified folder or document. The resource permissions are overwritten…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-workdocs/add-resource-permissions` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| Authentication | string | no | Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API. |
| ResourceId | string | yes | The ID of the resource. |
| body | object | yes | JSON request body |

### Removes all the permissions from the specified resource.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-workdocs/remove-all-resource-permissions` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| Authentication | string | no | Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API. |
| ResourceId | string | yes | The ID of the resource. |

### Adds a new comment to the specified document version.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-workdocs/create-comment` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| Authentication | string | no | Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API. |
| DocumentId | string | yes | The ID of the document. |
| VersionId | string | yes | The ID of the document version. |
| body | object | yes | JSON request body |

### Adds one or more custom properties to the specified resource (a folder, document, or version).
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-workdocs/create-custom-metadata` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| Authentication | string | no | Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API. |
| ResourceId | string | yes | The ID of the resource. |
| versionid | string | no | The ID of the version, if the custom metadata is being added to a document version. |
| body | object | yes | JSON request body |

### Deletes custom metadata from the specified resource.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-workdocs/delete-custom-metadata` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| Authentication | string | no | Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API. |
| ResourceId | string | yes | The ID of the resource, either a document or folder. |
| versionId | string | no | The ID of the version, if the custom metadata is being deleted from a document version. |
| keys | array | no | List of properties to remove. |
| deleteAll | boolean | no | Flag to indicate removal of all custom metadata properties from the specified resource. |

### Creates a folder with the specified name and parent folder.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-workdocs/create-folder` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| Authentication | string | no | Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API. |
| body | object | yes | JSON request body |

### Adds the specified list of labels to the given resource (a document or folder)
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-workdocs/create-labels` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| ResourceId | string | yes | The ID of the resource. |
| Authentication | string | no | Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API. |
| body | object | yes | JSON request body |

### Deletes the specified list of labels from a resource.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-workdocs/delete-labels` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| ResourceId | string | yes | The ID of the resource. |
| Authentication | string | no | Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API. |
| labels | array | no | List of labels to delete from the resource. |
| deleteAll | boolean | no | Flag to request removal of all labels from the specified resource. |

### Lists the specified notification subscriptions.
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-workdocs/describe-notification-subscriptions` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| OrganizationId | string | yes | The ID of the organization. |
| marker | string | no | The marker for the next set of results. (You received this marker from a previous call.) |
| limit | integer | no | The maximum number of items to return with this call. |
| Limit | string | no | Pagination limit |
| Marker | string | no | Pagination token |

### Configure Amazon WorkDocs to use Amazon SNS notifications. The endpoint receives a confirmation message, and…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-workdocs/create-notification-subscription` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| OrganizationId | string | yes | The ID of the organization. |
| body | object | yes | JSON request body |

### Describes the specified users. You can describe all users or filter the results (for example, by status or…
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-workdocs/describe-users` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| Authentication | string | no | Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API. |
| organizationId | string | no | The ID of the organization. |
| userIds | string | no | The IDs of the users. |
| query | string | no | A query to filter users by user name. Remember the following about the Userids and Query parameters: If you don't use either parameter,… |
| include | string | no | The state of the users. Specify "ALL" to include inactive users. |
| order | string | no | The order for the results. |
| sort | string | no | The sorting criteria. |
| marker | string | no | The marker for the next set of results. (You received this marker from a previous call.) |
| limit | integer | no | The maximum number of items to return. |
| fields | string | no | A comma-separated list of values. Specify "STORAGE_METADATA" to include the user storage quota and utilization information. |
| Limit | string | no | Pagination limit |
| Marker | string | no | Pagination token |

### Creates a user in a Simple AD or Microsoft AD directory. The status of a newly created user is "ACTIVE". New…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-workdocs/create-user` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| Authentication | string | no | Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API. |
| body | object | yes | JSON request body |

### Deletes the specified comment from the document version.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-workdocs/delete-comment` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| Authentication | string | no | Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API. |
| DocumentId | string | yes | The ID of the document. |
| VersionId | string | yes | The ID of the document version. |
| CommentId | string | yes | The ID of the comment. |

### Retrieves details of a document.
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-workdocs/get-document` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| Authentication | string | no | Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API. |
| DocumentId | string | yes | The ID of the document. |
| includeCustomMetadata | boolean | no | Set this to TRUE to include custom metadata in the response. |

### Updates the specified attributes of a document. The user must have access to both the document and its…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-workdocs/update-document` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| Authentication | string | no | Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API. |
| DocumentId | string | yes | The ID of the document. |
| body | object | yes | JSON request body |

### Permanently deletes the specified document and its associated metadata.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-workdocs/delete-document` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| Authentication | string | no | Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API. |
| DocumentId | string | yes | The ID of the document. |

### Deletes a specific version of a document.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-workdocs/delete-document-version` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| Authentication | string | no | Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API. |
| DocumentId | string | yes | The ID of the document associated with the version being deleted. |
| VersionId | string | yes | The ID of the version being deleted. |
| deletePriorVersions | boolean | yes | Deletes all versions of a document prior to the current version. |

### Retrieves the metadata of the specified folder.
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-workdocs/get-folder` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| Authentication | string | no | Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API. |
| FolderId | string | yes | The ID of the folder. |
| includeCustomMetadata | boolean | no | Set to TRUE to include custom metadata in the response. |

### Updates the specified attributes of the specified folder. The user must have access to both the folder and…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-workdocs/update-folder` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| Authentication | string | no | Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API. |
| FolderId | string | yes | The ID of the folder. |
| body | object | yes | JSON request body |

### Permanently deletes the specified folder and its contents.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-workdocs/delete-folder` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| Authentication | string | no | Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API. |
| FolderId | string | yes | The ID of the folder. |

### Describes the contents of the specified folder, including its documents and subfolders. By default, Amazon…
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-workdocs/describe-folder-contents` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| Authentication | string | no | Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API. |
| FolderId | string | yes | The ID of the folder. |
| sort | string | no | The sorting criteria. |
| order | string | no | The order for the contents of the folder. |
| limit | integer | no | The maximum number of items to return with this call. |
| marker | string | no | The marker for the next set of results. This marker was received from a previous call. |
| type | string | no | The type of items. |
| include | string | no | The contents to include. Specify "INITIALIZED" to include initialized documents. |
| Limit | string | no | Pagination limit |
| Marker | string | no | Pagination token |

### Deletes the contents of the specified folder.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-workdocs/delete-folder-contents` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| Authentication | string | no | Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API. |
| FolderId | string | yes | The ID of the folder. |

### Deletes the specified subscription from the specified organization.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-workdocs/delete-notification-subscription` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| SubscriptionId | string | yes | The ID of the subscription. |
| OrganizationId | string | yes | The ID of the organization. |

### Updates the specified attributes of the specified user, and grants or revokes administrative privileges to…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-workdocs/update-user` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| Authentication | string | no | Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API. |
| UserId | string | yes | The ID of the user. |
| body | object | yes | JSON request body |

### Deletes the specified user from a Simple AD or Microsoft AD directory. Deleting a user immediately and…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-workdocs/delete-user` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| Authentication | string | no | Amazon WorkDocs authentication token. Do not set this field when using administrative API actions, as in accessing the API using Amazon… |
| UserId | string | yes | The ID of the user. |

### Describes the user activities in a specified time period.
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-workdocs/describe-activities` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| Authentication | string | no | Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API. |
| startTime | string | no | The timestamp that determines the starting time of the activities. The response includes the activities performed after the specified… |
| endTime | string | no | The timestamp that determines the end time of the activities. The response includes the activities performed before the specified timestamp. |
| organizationId | string | no | The ID of the organization. This is a mandatory parameter when using administrative API (SigV4) requests. |
| activityTypes | string | no | Specifies which activity types to include in the response. If this field is left empty, all activity types are returned. |
| resourceId | string | no | The document or folder ID for which to describe activity types. |
| userId | string | no | The ID of the user who performed the action. The response includes activities pertaining to this user. This is an optional parameter and… |
| includeIndirectActivities | boolean | no | Includes indirect activities. An indirect activity results from a direct activity performed on a parent resource. For example, sharing a… |
| limit | integer | no | The maximum number of items to return. |
| marker | string | no | The marker for the next set of results. |
| Limit | string | no | Pagination limit |
| Marker | string | no | Pagination token |

### List all the comments for the specified document version.
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-workdocs/describe-comments` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| Authentication | string | no | Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API. |
| DocumentId | string | yes | The ID of the document. |
| VersionId | string | yes | The ID of the document version. |
| limit | integer | no | The maximum number of items to return. |
| marker | string | no | The marker for the next set of results. This marker was received from a previous call. |
| Limit | string | no | Pagination limit |
| Marker | string | no | Pagination token |

### Retrieves the document versions for the specified document. By default, only active versions are returned.
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-workdocs/describe-document-versions` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| Authentication | string | no | Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API. |
| DocumentId | string | yes | The ID of the document. |
| marker | string | no | The marker for the next set of results. (You received this marker from a previous call.) |
| limit | integer | no | The maximum number of versions to return with this call. |
| include | string | no | A comma-separated list of values. Specify "INITIALIZED" to include incomplete versions. |
| fields | string | no | Specify "SOURCE" to include initialized versions and a URL for the source document. |
| Limit | string | no | Pagination limit |
| Marker | string | no | Pagination token |

### Describes the groups specified by the query. Groups are defined by the underlying Active Directory.
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-workdocs/describe-groups` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| Authentication | string | no | Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API. |
| searchQuery | string | yes | A query to describe groups by group name. |
| organizationId | string | no | The ID of the organization. |
| marker | string | no | The marker for the next set of results. (You received this marker from a previous call.) |
| limit | integer | no | The maximum number of items to return with this call. |
| Limit | string | no | Pagination limit |
| Marker | string | no | Pagination token |

### Describes the current user's special folders; the RootFolder and the RecycleBin . RootFolder is the root of…
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-workdocs/describe-root-folders` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| Authentication | string | yes | Amazon WorkDocs authentication token. |
| limit | integer | no | The maximum number of items to return. |
| marker | string | no | The marker for the next set of results. (You received this marker from a previous call.) |
| Limit | string | no | Pagination limit |
| Marker | string | no | Pagination token |

### Retrieves details of the current user for whom the authentication token was generated. This is not a valid…
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-workdocs/get-current-user` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| Authentication | string | yes | Amazon WorkDocs authentication token. |

### Retrieves the path information (the hierarchy from the root folder) for the requested document. By default,…
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-workdocs/get-document-path` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| Authentication | string | no | Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API. |
| DocumentId | string | yes | The ID of the document. |
| limit | integer | no | The maximum number of levels in the hierarchy to return. |
| fields | string | no | A comma-separated list of values. Specify NAME to include the names of the parent folders. |
| marker | string | no | This value is not supported. |

### Retrieves the path information (the hierarchy from the root folder) for the specified folder. By default,…
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-workdocs/get-folder-path` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| Authentication | string | no | Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API. |
| FolderId | string | yes | The ID of the folder. |
| limit | integer | no | The maximum number of levels in the hierarchy to return. |
| fields | string | no | A comma-separated list of values. Specify "NAME" to include the names of the parent folders. |
| marker | string | no | This value is not supported. |

### Retrieves a collection of resources, including folders and documents. The only CollectionType supported is…
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-workdocs/get-resources` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| Authentication | string | no | The Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API. |
| userId | string | no | The user ID for the resource collection. This is a required field for accessing the API operation using IAM credentials. |
| collectionType | string | no | The collection type. |
| limit | integer | no | The maximum number of resources to return. |
| marker | string | no | The marker for the next set of results. This marker was received from a previous call. |

### Creates a new document object and version object. The client specifies the parent folder ID and name of the…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-workdocs/initiate-document-version-upload` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| Authentication | string | no | Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API. |
| body | object | yes | JSON request body |

### Removes the permission for the specified principal from the specified resource.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-workdocs/remove-resource-permission` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| Authentication | string | no | Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API. |
| ResourceId | string | yes | The ID of the resource. |
| PrincipalId | string | yes | The principal ID of the resource. |
| type | string | no | The principal type of the resource. |

### Recovers a deleted version of an Amazon WorkDocs document.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-workdocs/restore-document-versions` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| Authentication | string | no | Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API. |
| DocumentId | string | yes | The ID of the document. |

### Searches metadata and the content of folders, documents, document versions, and comments.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-workdocs/search-resources` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| Authentication | string | no | Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API. |
| Limit | string | no | Pagination limit |
| Marker | string | no | Pagination token |
| body | object | yes | JSON request body |

## Example
```
curl "https://zieapi.vercel.app/v1/cloud:amazonaws-workdocs/get-document-version" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the Amazon WorkDocs API?
Create a free Apizie key, then send GET https://zieapi.vercel.app/v1/cloud:amazonaws-workdocs/get-document-version with the header x-api-key. Every endpoint returns { project, data, timestamp }.

### Is the Amazon WorkDocs API free on Apizie?
Yes. The Free plan includes 1,000 requests a month at 100 requests a minute, no credit card. Amazon WorkDocs itself also needs your own key from amazonaws.com.

### Can AI agents use the Amazon WorkDocs API?
Yes. Add the Apizie MCP server (https://zieapi.vercel.app/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key cloud:amazonaws-workdocs.

### What is the status of the Amazon WorkDocs API?
Needs your own provider key (bring your own key)