Method: Aws::WorkDocs::Client#describe_folder_contents

Defined in:

lib/aws-sdk-workdocs/client.rb

#describe_folder_contents(params = {}) ⇒ Types::DescribeFolderContentsResponse

Describes the contents of the specified folder, including its documents and subfolders.

By default, Amazon WorkDocs returns the first 100 active document and folder metadata items. If there are more results, the response includes a marker that you can use to request the next set of results. You can also request initialized documents.

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_folder_contents({
  authentication_token: "AuthenticationHeaderType",
  folder_id: "ResourceIdType", # required
  sort: "DATE", # accepts DATE, NAME
  order: "ASCENDING", # accepts ASCENDING, DESCENDING
  limit: 1,
  marker: "PageMarkerType",
  type: "ALL", # accepts ALL, DOCUMENT, FOLDER
  include: "FieldNamesType",
})

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.documents #=> Array
resp.documents[0].id #=> String
resp.documents[0].creator_id #=> String
resp.documents[0].parent_folder_id #=> String
resp.documents[0].created_timestamp #=> Time
resp.documents[0].modified_timestamp #=> Time
resp.documents[0].latest_version_metadata.id #=> String
resp.documents[0].latest_version_metadata.name #=> String
resp.documents[0].latest_version_metadata.content_type #=> String
resp.documents[0].latest_version_metadata.size #=> Integer
resp.documents[0].latest_version_metadata.signature #=> String
resp.documents[0].latest_version_metadata.status #=> String, one of "INITIALIZED", "ACTIVE"
resp.documents[0].latest_version_metadata.created_timestamp #=> Time
resp.documents[0].latest_version_metadata.modified_timestamp #=> Time
resp.documents[0].latest_version_metadata.content_created_timestamp #=> Time
resp.documents[0].latest_version_metadata.content_modified_timestamp #=> Time
resp.documents[0].latest_version_metadata.creator_id #=> String
resp.documents[0].latest_version_metadata.thumbnail #=> Hash
resp.documents[0].latest_version_metadata.thumbnail["DocumentThumbnailType"] #=> String
resp.documents[0].latest_version_metadata.source #=> Hash
resp.documents[0].latest_version_metadata.source["DocumentSourceType"] #=> String
resp.documents[0].resource_state #=> String, one of "ACTIVE", "RESTORING", "RECYCLING", "RECYCLED"
resp.documents[0].labels #=> Array
resp.documents[0].labels[0] #=> String
resp.marker #=> 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.

• :sort (String) —

  The sorting criteria.

• :order (String) —

  The order for the contents of the folder.

• :limit (Integer) —

  The maximum number of items to return with this call.

• :marker (String) —

  The marker for the next set of results. This marker was received from a previous call.

• :type (String) —

  The type of items.

• :include (String) —

  The contents to include. Specify “INITIALIZED” to include initialized documents.

Returns:

• (Types::DescribeFolderContentsResponse) —

  Returns a response object which responds to the following methods:

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

  • #documents => Array<Types::DocumentMetadata>

  • #marker => String

See Also:

• AWS API Documentation

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

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