CloudDirectory / Paginator / ListObjectParentPaths

ListObjectParentPaths

class CloudDirectory.Paginator.ListObjectParentPaths

paginator = client.get_paginator('list_object_parent_paths')

paginate(**kwargs)

Creates an iterator that will paginate through responses from CloudDirectory.Client.list_object_parent_paths().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    DirectoryArn='string',
    ObjectReference={
        'Selector': 'string'
    },
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• DirectoryArn (string) –

  [REQUIRED]

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

• ObjectReference (dict) –

  [REQUIRED]

  The reference that identifies the object whose parent paths are listed.

  • Selector (string) –

    A path selector supports easy selection of an object by the parent/child links leading to it from the directory root. Use the link names from each parent/child link to construct the path. Path selectors start with a slash (/) and link names are separated by slashes. For more information about paths, see Access Objects. You can identify an object in one of the following ways:

    • $ObjectIdentifier - An object identifier is an opaque string provided by Amazon Cloud Directory. When creating objects, the system will provide you with the identifier of the created object. An object’s identifier is immutable and no two objects will ever share the same object identifier. To identify an object with ObjectIdentifier, the ObjectIdentifier must be wrapped in double quotes.

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

    • #SomeBatchReference - Identifies the object in a batch call

• PaginationConfig (dict) –

  A dictionary that provides parameters to control pagination.

  • MaxItems (integer) –

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • PageSize (integer) –

    The size of each page.

  • StartingToken (string) –

    A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:

dict

Returns:

Response Syntax

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

}

Response Structure

• (dict) –

  • PathToObjectIdentifiersList (list) –

    Returns the path to the ObjectIdentifiers that are associated with the directory.

    • (dict) –

      Returns the path to the ObjectIdentifiers that is associated with the directory.

      • Path (string) –

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

      • ObjectIdentifiers (list) –

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

        • (string) –