You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::WorkDocs::Types::DescribeCommentsRequest

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing DescribeCommentsRequest as input to an Aws::Client method, you can use a vanilla Hash:

{
  authentication_token: "AuthenticationHeaderType",
  document_id: "ResourceIdType", # required
  version_id: "DocumentVersionIdType", # required
  limit: 1,
  marker: "MarkerType",
}

Instance Attribute Summary collapse

Instance Attribute Details

#authentication_tokenString

Amazon WorkDocs authentication token. Do not set this field when using administrative API actions, as in accessing the API using AWS credentials.

Returns:

  • (String)

    Amazon WorkDocs authentication token.

#document_idString

The ID of the document.

Returns:

  • (String)

    The ID of the document.

#limitInteger

The maximum number of items to return.

Returns:

  • (Integer)

    The maximum number of items to return.

#markerString

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

Returns:

  • (String)

    The marker for the next set of results.

#version_idString

The ID of the document version.

Returns:

  • (String)

    The ID of the document version.