WorkDocs / Client / delete_comment

delete_comment

WorkDocs.Client.delete_comment(**kwargs)

Deletes the specified comment from the document version.

See also: AWS API Documentation

Request Syntax

response = client.delete_comment(
    AuthenticationToken='string',
    DocumentId='string',
    VersionId='string',
    CommentId='string'
)
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.

  • VersionId (string) –

    [REQUIRED]

    The ID of the document version.

  • CommentId (string) –

    [REQUIRED]

    The ID of the comment.

Returns:

None

Exceptions

  • WorkDocs.Client.exceptions.EntityNotExistsException

  • WorkDocs.Client.exceptions.ProhibitedStateException

  • WorkDocs.Client.exceptions.UnauthorizedOperationException

  • WorkDocs.Client.exceptions.UnauthorizedResourceAccessException

  • WorkDocs.Client.exceptions.FailedDependencyException

  • WorkDocs.Client.exceptions.ServiceUnavailableException

  • WorkDocs.Client.exceptions.DocumentLockedForCommentsException