object_parent_paths

Creates, updates, deletes, gets or lists an object_parent_paths resource.

Overview

Name	object_parent_paths
Type	Resource
Id	aws.clouddirectory.object_parent_paths

Fields

The following fields are returned by SELECT queries:

list_object_parent_paths

Name	Datatype	Description
object_identifiers	array	Lists ObjectIdentifiers starting from directory root to the object in the request.
path	string	The path that is used to identify the object starting from directory root.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_object_parent_paths	select	x-amz-data-partition, region		Retrieves all available parent paths for any object type such as node, leaf node, policy node, and index node objects. For more information about objects, see Directory Structure. Use this API to evaluate all parents for an object. The call returns all objects from the root of the directory up to the requested object. The API returns the number of paths based on user-defined MaxResults, in case there are multiple paths to the parent. The order of the paths and nodes returned is consistent among multiple API calls unless the objects are deleted or moved. Paths not leading to the directory root are ignored from the target object.

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
region	string	AWS region (default: us-east-1)
x-amz-data-partition	string	The ARN of the directory to which the parent path applies.

SELECT examples

list_object_parent_paths

Retrieves all available parent paths for any object type such as node, leaf node, policy node, and index node objects. For more information about objects, see Directory Structure. Use this API to evaluate all parents for an object. The call returns all objects from the root of the directory up to the requested object. The API returns the number of paths based on user-defined MaxResults, in case there are multiple paths to the parent. The order of the paths and nodes returned is consistent among multiple API calls unless the objects are deleted or moved. Paths not leading to the directory root are ignored from the target object.

SELECT
object_identifiers,
path
FROM aws.clouddirectory.object_parent_paths
WHERE `x-amz-data-partition` = '{{ x-amz-data-partition }}' -- required
AND region = '{{ region }}' -- required
;