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

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

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[:authentication_token]

Instance Attribute Summary collapse

Instance Attribute Details

#authentication_token ⇒ String

Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.

Returns:

  • (String) 


942
943
944
945
946
947
948
949
950
 
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb', line 942

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

#document_id ⇒ String

The ID of the document.

Returns:

  • (String) 


942
943
944
945
946
947
948
949
950
 
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb', line 942

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

#limit ⇒ Integer

The maximum number of items to return.

Returns:

  • (Integer) 


942
943
944
945
946
947
948
949
950
 
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb', line 942

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

#marker ⇒ String

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

Returns:

  • (String) 


942
943
944
945
946
947
948
949
950
 
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb', line 942

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

#version_id ⇒ String

The ID of the document version.

Returns:

  • (String) 


942
943
944
945
946
947
948
949
950
 
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb', line 942

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