Skip to content

BatchReadOperation

Source code in docs_src/capo_clouddirectory/types/batch_read_operation.py
class BatchReadOperation(TypedDict, closed=True):
    list_object_attributes: NotRequired[
        "capo_clouddirectory.types.batch_list_object_attributes.BatchListObjectAttributes"
    ]
    """<p>Lists all attributes that are associated with an object.</p>"""
    list_object_children: NotRequired[
        "capo_clouddirectory.types.batch_list_object_children.BatchListObjectChildren"
    ]
    """<p>Returns a paginated list of child objects that are associated with a given object.</p>"""
    list_attached_indices: NotRequired[
        "capo_clouddirectory.types.batch_list_attached_indices.BatchListAttachedIndices"
    ]
    """<p>Lists indices attached to an object.</p>"""
    list_object_parent_paths: NotRequired[
        "capo_clouddirectory.types.batch_list_object_parent_paths.BatchListObjectParentPaths"
    ]
    """<p>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 <a href="https://docs.aws.amazon.com/clouddirectory/latest/developerguide/key_concepts_directorystructure.html">Directory Structure</a>.</p>"""
    get_object_information: NotRequired[
        "capo_clouddirectory.types.batch_get_object_information.BatchGetObjectInformation"
    ]
    """<p>Retrieves metadata about an object.</p>"""
    get_object_attributes: NotRequired[
        "capo_clouddirectory.types.batch_get_object_attributes.BatchGetObjectAttributes"
    ]
    """<p>Retrieves attributes within a facet that are associated with an object.</p>"""
    list_object_parents: NotRequired[
        "capo_clouddirectory.types.batch_list_object_parents.BatchListObjectParents"
    ]
    """<p>Lists parent objects that are associated with a given object in pagination fashion.</p>"""
    list_object_policies: NotRequired[
        "capo_clouddirectory.types.batch_list_object_policies.BatchListObjectPolicies"
    ]
    """<p>Returns policies attached to an object in pagination fashion.</p>"""
    list_policy_attachments: NotRequired[
        "capo_clouddirectory.types.batch_list_policy_attachments.BatchListPolicyAttachments"
    ]
    """<p>Returns all of the <code>ObjectIdentifiers</code> to which a given policy is attached.</p>"""
    lookup_policy: NotRequired[
        "capo_clouddirectory.types.batch_lookup_policy.BatchLookupPolicy"
    ]
    """<p>Lists all policies from the root of the <a>Directory</a> to the object specified. If there are no policies present, an empty list is returned. If policies are present, and if some objects don't have the policies attached, it returns the <code>ObjectIdentifier</code> for such objects. If policies are present, it returns <code>ObjectIdentifier</code>, <code>policyId</code>, and <code>policyType</code>. Paths that don't lead to the root from the target object are ignored. For more information, see <a href="https://docs.aws.amazon.com/clouddirectory/latest/developerguide/key_concepts_directory.html#key_concepts_policies">Policies</a>.</p>"""
    list_index: NotRequired["capo_clouddirectory.types.batch_list_index.BatchListIndex"]
    """<p>Lists objects attached to the specified index.</p>"""
    list_outgoing_typed_links: NotRequired[
        "capo_clouddirectory.types.batch_list_outgoing_typed_links.BatchListOutgoingTypedLinks"
    ]
    """<p>Returns a paginated list of all the outgoing <a>TypedLinkSpecifier</a> information for an object. It also supports filtering by typed link facet and identity attributes. For more information, see <a href="https://docs.aws.amazon.com/clouddirectory/latest/developerguide/directory_objects_links.html#directory_objects_links_typedlink">Typed Links</a>.</p>"""
    list_incoming_typed_links: NotRequired[
        "capo_clouddirectory.types.batch_list_incoming_typed_links.BatchListIncomingTypedLinks"
    ]
    """<p>Returns a paginated list of all the incoming <a>TypedLinkSpecifier</a> information for an object. It also supports filtering by typed link facet and identity attributes. For more information, see <a href="https://docs.aws.amazon.com/clouddirectory/latest/developerguide/directory_objects_links.html#directory_objects_links_typedlink">Typed Links</a>.</p>"""
    get_link_attributes: NotRequired[
        "capo_clouddirectory.types.batch_get_link_attributes.BatchGetLinkAttributes"
    ]
    """<p>Retrieves attributes that are associated with a typed link.</p>"""
get_link_attributes: NotRequired[BatchGetLinkAttributes]

Retrieves attributes that are associated with a typed link.

get_object_attributes instance-attribute

get_object_attributes: NotRequired[BatchGetObjectAttributes]

Retrieves attributes within a facet that are associated with an object.

get_object_information instance-attribute

get_object_information: NotRequired[BatchGetObjectInformation]

Retrieves metadata about an object.

list_attached_indices instance-attribute

list_attached_indices: NotRequired[BatchListAttachedIndices]

Lists indices attached to an object.

list_incoming_typed_links: NotRequired[BatchListIncomingTypedLinks]

Returns a paginated list of all the incoming TypedLinkSpecifier information for an object. It also supports filtering by typed link facet and identity attributes. For more information, see Typed Links.

list_index instance-attribute

list_index: NotRequired[BatchListIndex]

Lists objects attached to the specified index.

list_object_attributes instance-attribute

list_object_attributes: NotRequired[BatchListObjectAttributes]

Lists all attributes that are associated with an object.

list_object_children instance-attribute

list_object_children: NotRequired[BatchListObjectChildren]

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

list_object_parent_paths instance-attribute

list_object_parent_paths: NotRequired[BatchListObjectParentPaths]

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.

list_object_parents instance-attribute

list_object_parents: NotRequired[BatchListObjectParents]

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

list_object_policies instance-attribute

list_object_policies: NotRequired[BatchListObjectPolicies]

Returns policies attached to an object in pagination fashion.

list_outgoing_typed_links: NotRequired[BatchListOutgoingTypedLinks]

Returns a paginated list of all the outgoing TypedLinkSpecifier information for an object. It also supports filtering by typed link facet and identity attributes. For more information, see Typed Links.

list_policy_attachments instance-attribute

list_policy_attachments: NotRequired[BatchListPolicyAttachments]

Returns all of the ObjectIdentifiers to which a given policy is attached.

lookup_policy instance-attribute

lookup_policy: NotRequired[BatchLookupPolicy]

Lists all policies from the root of the Directory to the object specified. If there are no policies present, an empty list is returned. If policies are present, and if some objects don't have the policies attached, it returns the ObjectIdentifier for such objects. If policies are present, it returns ObjectIdentifier, policyId, and policyType. Paths that don't lead to the root from the target object are ignored. For more information, see Policies.