UpdateDocument - Amazon WorkDocs

UpdateDocument

Important

Notice: New customer sign-ups and account upgrades are no longer available for Amazon WorkDocs. Learn about migration steps here: How to migrate data from Amazon WorkDocs.

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

Request Syntax

PATCH /api/v1/documents/DocumentId HTTP/1.1 Authentication: AuthenticationToken Content-type: application/json { "Name": "string", "ParentFolderId": "string", "ResourceState": "string" }

URI Request Parameters

The request uses the following URI parameters.

AuthenticationToken

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

Length Constraints: Minimum length of 1. Maximum length of 8199.

DocumentId

The ID of the document.

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: [\w+-.@]+

Required: Yes

Request Body

The request accepts the following data in JSON format.

Name

The name of the document.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Pattern: [\u0020-\u202D\u202F-\uFFFF]+

Required: No

ParentFolderId

The ID of the parent folder.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: [\w+-.@]+

Required: No

ResourceState

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

Type: String

Valid Values: ACTIVE | RESTORING | RECYCLING | RECYCLED

Required: No

Response Syntax

HTTP/1.1 200

Response Elements

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

Errors

For information about the errors that are common to all actions, see Common Errors.

ConcurrentModificationException

The resource hierarchy is changing.

HTTP Status Code: 409

ConflictingOperationException

Another operation is in progress on the resource that conflicts with the current operation.

HTTP Status Code: 409

EntityAlreadyExistsException

The resource already exists.

HTTP Status Code: 409

EntityNotExistsException

The resource does not exist.

HTTP Status Code: 404

FailedDependencyException

The AWS Directory Service cannot reach an on-premises instance. Or a dependency under the control of the organization is failing, such as a connected Active Directory.

HTTP Status Code: 424

LimitExceededException

The maximum of 100,000 files and folders under the parent folder has been exceeded.

HTTP Status Code: 409

ProhibitedStateException

The specified document version is not in the INITIALIZED state.

HTTP Status Code: 409

ServiceUnavailableException

One or more of the dependencies is unavailable.

HTTP Status Code: 503

UnauthorizedOperationException

The operation is not permitted.

HTTP Status Code: 403

UnauthorizedResourceAccessException

The caller does not have access to perform the action on the resource.

HTTP Status Code: 404

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: