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

Class: Aws::WorkDocs::Types::DescribeDocumentVersionsRequest

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 DescribeDocumentVersionsRequest data as a hash:

{
  authentication_token: "AuthenticationHeaderType",
  document_id: "ResourceIdType", # required
  marker: "PageMarkerType",
  limit: 1,
  include: "FieldNamesType",
  fields: "FieldNamesType",
}

Instance Attribute Summary collapse

Instance Attribute Details

#authentication_tokenString

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

Returns:

  • (String)


1071
1072
1073
1074
1075
1076
1077
1078
1079
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb', line 1071

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

#document_idString

The ID of the document.

Returns:

  • (String)


1071
1072
1073
1074
1075
1076
1077
1078
1079
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb', line 1071

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

#fieldsString

Specify "SOURCE" to include initialized versions and a URL for the source document.

Returns:

  • (String)


1071
1072
1073
1074
1075
1076
1077
1078
1079
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb', line 1071

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

#includeString

A comma-separated list of values. Specify "INITIALIZED" to include incomplete versions.

Returns:

  • (String)


1071
1072
1073
1074
1075
1076
1077
1078
1079
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb', line 1071

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

#limitInteger

The maximum number of versions to return with this call.

Returns:

  • (Integer)


1071
1072
1073
1074
1075
1076
1077
1078
1079
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb', line 1071

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

#markerString

The marker for the next set of results. (You received this marker from a previous call.)

Returns:

  • (String)


1071
1072
1073
1074
1075
1076
1077
1078
1079
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb', line 1071

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