Class: Aws::WorkDocs::Types::GetFolderPathRequest

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

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

Constant Summary collapse

SENSITIVE =
[:authentication_token]

Instance Attribute Summary collapse

Instance Attribute Details

#authentication_tokenString

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

Returns:

  • (String)


2111
2112
2113
2114
2115
2116
2117
2118
2119
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb', line 2111

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

#fieldsString

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

Returns:

  • (String)


2111
2112
2113
2114
2115
2116
2117
2118
2119
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb', line 2111

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

#folder_idString

The ID of the folder.

Returns:

  • (String)


2111
2112
2113
2114
2115
2116
2117
2118
2119
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb', line 2111

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

#limitInteger

The maximum number of levels in the hierarchy to return.

Returns:

  • (Integer)


2111
2112
2113
2114
2115
2116
2117
2118
2119
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb', line 2111

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

#markerString

This value is not supported.

Returns:

  • (String)


2111
2112
2113
2114
2115
2116
2117
2118
2119
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb', line 2111

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