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

Inherits:

Struct

• Object
• Struct
• Aws::WorkDocs::Types::GetDocumentPathRequest

Includes:

Structure

Defined in:

lib/aws-sdk-workdocs/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[:authentication_token]

Instance Attribute Summary

• #authentication_token ⇒ String

  Amazon WorkDocs authentication token.

• #document_id ⇒ String

  The ID of the document.

• #fields ⇒ String

  A comma-separated list of values.

• #limit ⇒ Integer

  The maximum number of levels in the hierarchy to return.

• #marker ⇒ String

  This value is not supported.

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)

# File 'lib/aws-sdk-workdocs/types.rb', line 1762

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

#document_id ⇒ String

The ID of the document.

Returns:

• (String)

# File 'lib/aws-sdk-workdocs/types.rb', line 1762

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

#fields ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-workdocs/types.rb', line 1762

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

#limit ⇒ Integer

The maximum number of levels in the hierarchy to return.

Returns:

• (Integer)

# File 'lib/aws-sdk-workdocs/types.rb', line 1762

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

#marker ⇒ String

This value is not supported.

Returns:

• (String)

# File 'lib/aws-sdk-workdocs/types.rb', line 1762

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