import type { MetadataBearer as __MetadataBearer } from "@smithy/types"; import type { DescribeCommentsRequest, DescribeCommentsResponse } from "../models/models_0"; /** * @public */ export type { __MetadataBearer }; /** * @public * * The input for {@link DescribeCommentsCommand}. */ export interface DescribeCommentsCommandInput extends DescribeCommentsRequest { } /** * @public * * The output of {@link DescribeCommentsCommand}. */ export interface DescribeCommentsCommandOutput extends DescribeCommentsResponse, __MetadataBearer { } declare const DescribeCommentsCommand_base: { new (input: DescribeCommentsCommandInput): import("@smithy/core/client").CommandImpl; new (input: DescribeCommentsCommandInput): import("@smithy/core/client").CommandImpl; getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions; }; /** *

List all the comments for the specified document version.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript * import { WorkDocsClient, DescribeCommentsCommand } from "@aws-sdk/client-workdocs"; // ES Modules import * // const { WorkDocsClient, DescribeCommentsCommand } = require("@aws-sdk/client-workdocs"); // CommonJS import * // import type { WorkDocsClientConfig } from "@aws-sdk/client-workdocs"; * const config = {}; // type is WorkDocsClientConfig * 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", * // }; * * ``` * * @param DescribeCommentsCommandInput - {@link DescribeCommentsCommandInput} * @returns {@link DescribeCommentsCommandOutput} * @see {@link DescribeCommentsCommandInput} for command's `input` shape. * @see {@link DescribeCommentsCommandOutput} for command's `response` shape. * @see {@link WorkDocsClientResolvedConfig | config} for WorkDocsClient's `config` shape. * * @throws {@link EntityNotExistsException} (client fault) *

The resource does not exist.

* * @throws {@link FailedDependencyException} (client fault) *

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.

* * @throws {@link ProhibitedStateException} (client fault) *

The specified document version is not in the INITIALIZED state.

* * @throws {@link ServiceUnavailableException} (server fault) *

One or more of the dependencies is unavailable.

* * @throws {@link UnauthorizedOperationException} (client fault) *

The operation is not permitted.

* * @throws {@link UnauthorizedResourceAccessException} (client fault) *

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

* * @throws {@link WorkDocsServiceException} *

Base exception class for all service exceptions from WorkDocs service.

* * * @public */ export declare class DescribeCommentsCommand extends DescribeCommentsCommand_base { /** @internal type navigation helper, not in runtime. */ protected static __types: { api: { input: DescribeCommentsRequest; output: DescribeCommentsResponse; }; sdk: { input: DescribeCommentsCommandInput; output: DescribeCommentsCommandOutput; }; }; }