v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1444236171.7 KB

Updates the specified attributes of a document. The user must have access to both the document and its parent folder, if applicable.

patch/api/v1/documents/{DocumentId}

Path parameters

DocumentIdstring required

The ID of the document.

Headers

Authenticationstring password

Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.

Request body

Namestring password

The name of the document.

ParentFolderIdstring

The ID of the parent folder.

ResourceState'ACTIVE' | 'RESTORING' | 'RECYCLING' | 'RECYCLED'

The resource state of the document. Only ACTIVE and RECYCLED are supported.

Response

Success