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

Class: Aws::WorkDocs::Types::GetDocumentPathRequest

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

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

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)


1686
1687
1688
1689
1690
1691
1692
1693
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb', line 1686

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

#document_idString

The ID of the document.

Returns:

  • (String)


1686
1687
1688
1689
1690
1691
1692
1693
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb', line 1686

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

#fieldsString

A comma-separated list of values. Specify NAME to include the names of the parent folders.

Returns:

  • (String)


1686
1687
1688
1689
1690
1691
1692
1693
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb', line 1686

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

#limitInteger

The maximum number of levels in the hierarchy to return.

Returns:

  • (Integer)


1686
1687
1688
1689
1690
1691
1692
1693
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb', line 1686

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

#markerString

This value is not supported.

Returns:

  • (String)


1686
1687
1688
1689
1690
1691
1692
1693
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb', line 1686

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