Method: Aws::WorkDocs::Client#get_folder_path

Defined in:

lib/aws-sdk-workdocs/client.rb

#get_folder_path(params = {}) ⇒ Types::GetFolderPathResponse

Retrieves the path information (the hierarchy from the root folder) for the specified folder.

By default, Amazon WorkDocs returns a maximum of 100 levels upwards from the requested folder and only includes the IDs of the parent folders in the path. You can limit the maximum number of levels. You can also request the parent folder names.

Examples:

Request syntax with placeholder values

resp = client.get_folder_path({
  authentication_token: "AuthenticationHeaderType",
  folder_id: "IdType", # required
  limit: 1,
  fields: "FieldNamesType",
  marker: "PageMarkerType",
})

Response structure

resp.path.components #=> Array
resp.path.components[0].id #=> String
resp.path.components[0].name #=> String

Parameters:

• params (Hash) (defaults to: {}) —

  ({})

Options Hash (params):

• :authentication_token (String) —

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

• :folder_id (required, String) —

  The ID of the folder.

• :limit (Integer) —

  The maximum number of levels in the hierarchy to return.

• :fields (String) —

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

• :marker (String) —

  This value is not supported.

Returns:

• (Types::GetFolderPathResponse) —

  Returns a response object which responds to the following methods:

  • #path => Types::ResourcePath

See Also:

• AWS API Documentation

# File 'lib/aws-sdk-workdocs/client.rb', line 2337

def get_folder_path(params = {}, options = {})
  req = build_request(:get_folder_path, params)
  req.send_request(options)
end