DeleteCommentCommand

Deletes the specified comment from the document version.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { WorkDocsClient, DeleteCommentCommand } from "@aws-sdk/client-workdocs"; // ES Modules import
// const { WorkDocsClient, DeleteCommentCommand } = require("@aws-sdk/client-workdocs"); // CommonJS import
const client = new WorkDocsClient(config);
const input = { // DeleteCommentRequest
  AuthenticationToken: "STRING_VALUE",
  DocumentId: "STRING_VALUE", // required
  VersionId: "STRING_VALUE", // required
  CommentId: "STRING_VALUE", // required
};
const command = new DeleteCommentCommand(input);
const response = await client.send(command);
// {};

DeleteCommentCommand Input

See DeleteCommentCommandInput for more details

Parameter
Type
Description
CommentId
Required
string | undefined

The ID of the comment.

DocumentId
Required
string | undefined

The ID of the document.

VersionId
Required
string | undefined

The ID of the document version.

AuthenticationToken
string | undefined

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

DeleteCommentCommand Output

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.

Throws

Name
Fault
Details
DocumentLockedForCommentsException
client

This exception is thrown when the document is locked for comments and user tries to create or delete a comment on that document.

EntityNotExistsException
client

The resource does not exist.

FailedDependencyException
client

The 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.

ProhibitedStateException
client

The specified document version is not in the INITIALIZED state.

ServiceUnavailableException
server

One or more of the dependencies is unavailable.

UnauthorizedOperationException
client

The operation is not permitted.

UnauthorizedResourceAccessException
client

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

WorkDocsServiceException
Base exception class for all service exceptions from WorkDocs service.