WorkDocs / Client / delete_document_version

delete_document_version#

WorkDocs.Client.delete_document_version(**kwargs)#

Deletes a specific version of a document.

See also: AWS API Documentation

Request Syntax

response = client.delete_document_version(
    AuthenticationToken='string',
    DocumentId='string',
    VersionId='string',
    DeletePriorVersions=True|False
)
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 associated with the version being deleted.

  • VersionId (string) –

    [REQUIRED]

    The ID of the version being deleted.

  • DeletePriorVersions (boolean) –

    [REQUIRED]

    Deletes all versions of a document prior to the current version.

Returns:

None

Exceptions

  • WorkDocs.Client.exceptions.EntityNotExistsException

  • WorkDocs.Client.exceptions.ProhibitedStateException

  • WorkDocs.Client.exceptions.ConflictingOperationException

  • WorkDocs.Client.exceptions.ConcurrentModificationException

  • WorkDocs.Client.exceptions.UnauthorizedResourceAccessException

  • WorkDocs.Client.exceptions.FailedDependencyException

  • WorkDocs.Client.exceptions.InvalidOperationException

  • WorkDocs.Client.exceptions.UnauthorizedOperationException