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

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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb

Overview

Note:

When making an API call, you may pass DescribeCommentsRequest data as a 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)


1012
1013
1014
1015
1016
1017
1018
1019
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb', line 1012

class DescribeCommentsRequest < Struct.new(
  :authentication_token,
  :document_id,
  :version_id,
  :limit,
  :marker)
  include Aws::Structure
end

#document_idString

The ID of the document.

Returns:

  • (String)


1012
1013
1014
1015
1016
1017
1018
1019
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb', line 1012

class DescribeCommentsRequest < Struct.new(
  :authentication_token,
  :document_id,
  :version_id,
  :limit,
  :marker)
  include Aws::Structure
end

#limitInteger

The maximum number of items to return.

Returns:

  • (Integer)


1012
1013
1014
1015
1016
1017
1018
1019
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb', line 1012

class DescribeCommentsRequest < Struct.new(
  :authentication_token,
  :document_id,
  :version_id,
  :limit,
  :marker)
  include Aws::Structure
end

#markerString

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

Returns:

  • (String)


1012
1013
1014
1015
1016
1017
1018
1019
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb', line 1012

class DescribeCommentsRequest < Struct.new(
  :authentication_token,
  :document_id,
  :version_id,
  :limit,
  :marker)
  include Aws::Structure
end

#version_idString

The ID of the document version.

Returns:

  • (String)


1012
1013
1014
1015
1016
1017
1018
1019
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb', line 1012

class DescribeCommentsRequest < Struct.new(
  :authentication_token,
  :document_id,
  :version_id,
  :limit,
  :marker)
  include Aws::Structure
end