CloudDirectory / Client / list_object_children

list_object_children#

CloudDirectory.Client.list_object_children(**kwargs)#

Returns a paginated list of child objects that are associated with a given object.

See also: AWS API Documentation

Request Syntax

response = client.list_object_children(
    DirectoryArn='string',
    ObjectReference={
        'Selector': 'string'
    },
    NextToken='string',
    MaxResults=123,
    ConsistencyLevel='SERIALIZABLE'|'EVENTUAL'
)
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 child 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.

Return type:

dict

Returns:

Response Syntax

{
    'Children': {
        'string': 'string'
    },
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • Children (dict) –

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

      • (string) –

        • (string) –

    • NextToken (string) –

      The pagination token.

Exceptions

  • CloudDirectory.Client.exceptions.InternalServiceException

  • CloudDirectory.Client.exceptions.InvalidArnException

  • CloudDirectory.Client.exceptions.RetryableConflictException

  • CloudDirectory.Client.exceptions.ValidationException

  • CloudDirectory.Client.exceptions.LimitExceededException

  • CloudDirectory.Client.exceptions.AccessDeniedException

  • CloudDirectory.Client.exceptions.DirectoryNotEnabledException

  • CloudDirectory.Client.exceptions.ResourceNotFoundException

  • CloudDirectory.Client.exceptions.InvalidNextTokenException

  • CloudDirectory.Client.exceptions.NotNodeException