WorkDocs / Client / update_document

update_document#

WorkDocs.Client.update_document(**kwargs)#

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

See also: AWS API Documentation

Request Syntax

response = client.update_document(
    AuthenticationToken='string',
    DocumentId='string',
    Name='string',
    ParentFolderId='string',
    ResourceState='ACTIVE'|'RESTORING'|'RECYCLING'|'RECYCLED'
)
Parameters:

  • AuthenticationToken (string) – Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.

  • DocumentId (string) –

    [REQUIRED]

    The ID of the document.

  • Name (string) – The name of the document.

  • ParentFolderId (string) – The ID of the parent folder.

  • ResourceState (string) – The resource state of the document. Only ACTIVE and RECYCLED are supported.

Returns:

None

Exceptions

  • WorkDocs.Client.exceptions.EntityNotExistsException

  • WorkDocs.Client.exceptions.EntityAlreadyExistsException

  • WorkDocs.Client.exceptions.LimitExceededException

  • WorkDocs.Client.exceptions.ProhibitedStateException

  • WorkDocs.Client.exceptions.ConflictingOperationException

  • WorkDocs.Client.exceptions.ConcurrentModificationException

  • WorkDocs.Client.exceptions.UnauthorizedOperationException

  • WorkDocs.Client.exceptions.UnauthorizedResourceAccessException

  • WorkDocs.Client.exceptions.FailedDependencyException

  • WorkDocs.Client.exceptions.ServiceUnavailableException