DescribeCommentsCommand

Suggest an Edit

List all the comments for the specified document version.

Example Syntax

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

import { WorkDocsClient, DescribeCommentsCommand } from "@aws-sdk/client-workdocs"; // ES Modules import
// const { WorkDocsClient, DescribeCommentsCommand } = require("@aws-sdk/client-workdocs"); // CommonJS import
const client = new WorkDocsClient(config);
const input = { // DescribeCommentsRequest
  AuthenticationToken: "STRING_VALUE",
  DocumentId: "STRING_VALUE", // required
  VersionId: "STRING_VALUE", // required
  Limit: Number("int"),
  Marker: "STRING_VALUE",
};
const command = new DescribeCommentsCommand(input);
const response = await client.send(command);
// { // DescribeCommentsResponse
//   Comments: [ // CommentList
//     { // Comment
//       CommentId: "STRING_VALUE", // required
//       ParentId: "STRING_VALUE",
//       ThreadId: "STRING_VALUE",
//       Text: "STRING_VALUE",
//       Contributor: { // User
//         Id: "STRING_VALUE",
//         Username: "STRING_VALUE",
//         EmailAddress: "STRING_VALUE",
//         GivenName: "STRING_VALUE",
//         Surname: "STRING_VALUE",
//         OrganizationId: "STRING_VALUE",
//         RootFolderId: "STRING_VALUE",
//         RecycleBinFolderId: "STRING_VALUE",
//         Status: "ACTIVE" || "INACTIVE" || "PENDING",
//         Type: "USER" || "ADMIN" || "POWERUSER" || "MINIMALUSER" || "WORKSPACESUSER",
//         CreatedTimestamp: new Date("TIMESTAMP"),
//         ModifiedTimestamp: new Date("TIMESTAMP"),
//         TimeZoneId: "STRING_VALUE",
//         Locale: "en" || "fr" || "ko" || "de" || "es" || "ja" || "ru" || "zh_CN" || "zh_TW" || "pt_BR" || "default",
//         Storage: { // UserStorageMetadata
//           StorageUtilizedInBytes: Number("long"),
//           StorageRule: { // StorageRuleType
//             StorageAllocatedInBytes: Number("long"),
//             StorageType: "UNLIMITED" || "QUOTA",
//           },
//         },
//       },
//       CreatedTimestamp: new Date("TIMESTAMP"),
//       Status: "DRAFT" || "PUBLISHED" || "DELETED",
//       Visibility: "PUBLIC" || "PRIVATE",
//       RecipientId: "STRING_VALUE",
//     },
//   ],
//   Marker: "STRING_VALUE",
// };

DescribeCommentsCommand Input

See DescribeCommentsCommandInput for more details

Parameter
Type
Description
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.

Limit
number | undefined

The maximum number of items to return.

Marker
string | undefined

The marker for the next set of results. This marker was received from a previous call.

DescribeCommentsCommand Output

See DescribeCommentsCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
Comments
Comment[] | undefined

The list of comments for the specified document version.

Marker
string | undefined

The marker for the next set of results. This marker was received from a previous call.

Throws

Name
Fault
Details
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.