Method: Aws::WorkDocs::Client#describe_root_folders

Defined in:

lib/aws-sdk-workdocs/client.rb

#describe_root_folders(params = {}) ⇒ Types::DescribeRootFoldersResponse

Describes the current user’s special folders; the RootFolder and the RecycleBin. RootFolder is the root of user’s files and folders and RecycleBin is the root of recycled items. This is not a valid action for SigV4 (administrative API) clients.

This action requires an authentication token. To get an authentication token, register an application with Amazon WorkDocs. For more information, see [Authentication and Access Control for User Applications] in the *Amazon WorkDocs Developer Guide*.

[1]: docs.aws.amazon.com/workdocs/latest/developerguide/wd-auth-user.html

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values

resp = client.describe_root_folders({
  authentication_token: "AuthenticationHeaderType", # required
  limit: 1,
  marker: "PageMarkerType",
})

Response structure

resp.folders #=> Array
resp.folders[0].id #=> String
resp.folders[0].name #=> String
resp.folders[0].creator_id #=> String
resp.folders[0].parent_folder_id #=> String
resp.folders[0].created_timestamp #=> Time
resp.folders[0].modified_timestamp #=> Time
resp.folders[0].resource_state #=> String, one of "ACTIVE", "RESTORING", "RECYCLING", "RECYCLED"
resp.folders[0].signature #=> String
resp.folders[0].labels #=> Array
resp.folders[0].labels[0] #=> String
resp.folders[0].size #=> Integer
resp.folders[0].latest_version_size #=> Integer
resp.marker #=> String

Parameters:

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

  ({})

Options Hash (params):

• :authentication_token (required, String) —

  Amazon WorkDocs authentication token.

• :limit (Integer) —

  The maximum number of items to return.

• :marker (String) —

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

Returns:

• (Types::DescribeRootFoldersResponse) —

  Returns a response object which responds to the following methods:

  • #folders => Array<Types::FolderMetadata>

  • #marker => String

See Also:

• AWS API Documentation

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

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