document_paths

Creates, updates, deletes, gets or lists a document_paths resource.

Overview

Name	document_paths
Type	Resource
Id	aws.workdocs.document_paths

Fields

The following fields are returned by SELECT queries:

get_document_path

Name	Datatype	Description
components	array	The components of the resource path.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_document_path	select	document_id, region	Authentication, limit, fields, marker	Retrieves the path information (the hierarchy from the root folder) for the requested document. By default, Amazon WorkDocs returns a maximum of 100 levels upwards from the requested document 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 names of the parent folders.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
document_id	string	The ID of the document.
region	string	AWS region (default: us-east-1)
Authentication	string	Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.
fields	string	A comma-separated list of values. Specify NAME to include the names of the parent folders.
limit	integer	The maximum number of levels in the hierarchy to return.
marker	string	This value is not supported.

SELECT examples

get_document_path

Retrieves the path information (the hierarchy from the root folder) for the requested document. By default, Amazon WorkDocs returns a maximum of 100 levels upwards from the requested document 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 names of the parent folders.

SELECT
components
FROM aws.workdocs.document_paths
WHERE document_id = '{{ document_id }}' -- required
AND region = '{{ region }}' -- required
AND Authentication = '{{ Authentication }}'
AND limit = '{{ limit }}'
AND fields = '{{ fields }}'
AND marker = '{{ marker }}'
;