Amazon CloudDirectory

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 directory root are ignored from the target object.

See also: AWS API Documentation

Request Syntax

client.list_object_parent_paths(
    DirectoryArn='string',
    ObjectReference={
        'Selector': 'string'
    },
    NextToken='string',
    MaxResults=123
)

type DirectoryArn:

string

param DirectoryArn:

[REQUIRED]

The ARN of the directory to which the parent path applies.

type ObjectReference:

dict

param ObjectReference:

[REQUIRED]

Reference that identifies the object whose parent paths are listed.

• Selector (string) --

  Allows you to specify an object. You can identify an object in one of the following ways:

  • $ObjectIdentifier - Identifies the object by ObjectIdentifier

  • /some/path - Identifies the object based on path

  • #SomeBatchReference - Identifies the object in a batch call

type NextToken:

string

param NextToken:

The pagination token.

type MaxResults:

integer

param MaxResults:

Maximum number of items to be retrieved in a single call. This is an approximate number.

rtype:

dict

returns:

Response Syntax

{
    'PathToObjectIdentifiersList': [
        {
            'Path': 'string',
            'ObjectIdentifiers': [
                'string',
            ]
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) --

  • PathToObjectIdentifiersList (list) --

    Returns the path to the ObjectIdentifiers associated with the directory.

    • (dict) --

      Returns the path to the ObjectIdentifiers associated with the directory.

      • Path (string) --

        The path used to identify the object starting from directory root.

      • ObjectIdentifiers (list) --

        Lists ObjectIdentifiers starting from directory root to the object in the request.

        • (string) --

  • NextToken (string) --

    The pagination token.