AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

List all the comments for the specified document version.

Note:

This is an asynchronous operation using the standard naming convention for .NET 4.5 or higher. For .NET 3.5 the operation is implemented as a pair of methods using the standard naming convention of BeginDescribeComments and EndDescribeComments.

Namespace: Amazon.WorkDocs
Assembly: AWSSDK.WorkDocs.dll
Version: 3.x.y.z

Syntax

C#
public virtual Task<DescribeCommentsResponse> DescribeCommentsAsync(
         DescribeCommentsRequest request,
         CancellationToken cancellationToken
)

Parameters

request
Type: Amazon.WorkDocs.Model.DescribeCommentsRequest

Container for the necessary parameters to execute the DescribeComments service method.

cancellationToken
Type: System.Threading.CancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Return Value


The response from the DescribeComments service method, as returned by WorkDocs.

Exceptions

ExceptionCondition
EntityNotExistsException The resource does not exist.
FailedDependencyException 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 The specified document version is not in the INITIALIZED state.
ServiceUnavailableException One or more of the dependencies is unavailable.
UnauthorizedOperationException The operation is not permitted.
UnauthorizedResourceAccessException The caller does not have access to perform the action on the resource.

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5

See Also