CloudDirectory / Client / list_object_parents

list_object_parents#

CloudDirectory.Client.list_object_parents(**kwargs)#

Lists parent objects that are associated with a given object in pagination fashion.

See also: AWS API Documentation

Request Syntax

response = client.list_object_parents(
    DirectoryArn='string',
    ObjectReference={
        'Selector': 'string'
    },
    NextToken='string',
    MaxResults=123,
    ConsistencyLevel='SERIALIZABLE'|'EVENTUAL',
    IncludeAllLinksToEachParent=True|False
)
Parameters:

  • DirectoryArn (string) –

    [REQUIRED]

    The Amazon Resource Name (ARN) that is associated with the Directory where the object resides. For more information, see arns.

  • ObjectReference (dict) –

    [REQUIRED]

    The reference that identifies the object for which parent objects are being 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

  • NextToken (string) – The pagination token.

  • MaxResults (integer) – The maximum number of items to be retrieved in a single call. This is an approximate number.

  • ConsistencyLevel (string) – Represents the manner and timing in which the successful write or update of an object is reflected in a subsequent read operation of that same object.

  • IncludeAllLinksToEachParent (boolean) – When set to True, returns all ListObjectParentsResponse$ParentLinks. There could be multiple links between a parent-child pair.

Return type:

dict

Returns:

Response Syntax

{
    'Parents': {
        'string': 'string'
    },
    'NextToken': 'string',
    'ParentLinks': [
        {
            'ObjectIdentifier': 'string',
            'LinkName': 'string'
        },
    ]
}

Response Structure

  • (dict) –

    • Parents (dict) –

      The parent structure, which is a map with key as the ObjectIdentifier and LinkName as the value.

      • (string) –

        • (string) –

    • NextToken (string) –

      The pagination token.

    • ParentLinks (list) –

      Returns a list of parent reference and LinkName Tuples.

      • (dict) –

        A pair of ObjectIdentifier and LinkName.

        • ObjectIdentifier (string) –

          The ID that is associated with the object.

        • LinkName (string) –

          The name of the link between the parent and the child object.

Exceptions