Skip to content

BatchWriteOperation

Source code in docs_src/capo_clouddirectory/types/batch_write_operation.py
class BatchWriteOperation(TypedDict, closed=True):
    create_object: NotRequired[
        "capo_clouddirectory.types.batch_create_object.BatchCreateObject"
    ]
    """<p>Creates an object.</p>"""
    attach_object: NotRequired[
        "capo_clouddirectory.types.batch_attach_object.BatchAttachObject"
    ]
    """<p>Attaches an object to a <a>Directory</a>.</p>"""
    detach_object: NotRequired[
        "capo_clouddirectory.types.batch_detach_object.BatchDetachObject"
    ]
    """<p>Detaches an object from a <a>Directory</a>.</p>"""
    update_object_attributes: NotRequired[
        "capo_clouddirectory.types.batch_update_object_attributes.BatchUpdateObjectAttributes"
    ]
    """<p>Updates a given object's attributes.</p>"""
    delete_object: NotRequired[
        "capo_clouddirectory.types.batch_delete_object.BatchDeleteObject"
    ]
    """<p>Deletes an object in a <a>Directory</a>.</p>"""
    add_facet_to_object: NotRequired[
        "capo_clouddirectory.types.batch_add_facet_to_object.BatchAddFacetToObject"
    ]
    """<p>A batch operation that adds a facet to an object.</p>"""
    remove_facet_from_object: NotRequired[
        "capo_clouddirectory.types.batch_remove_facet_from_object.BatchRemoveFacetFromObject"
    ]
    """<p>A batch operation that removes a facet from an object.</p>"""
    attach_policy: NotRequired[
        "capo_clouddirectory.types.batch_attach_policy.BatchAttachPolicy"
    ]
    """<p>Attaches a policy object to a regular object. An object can have a limited number of attached policies.</p>"""
    detach_policy: NotRequired[
        "capo_clouddirectory.types.batch_detach_policy.BatchDetachPolicy"
    ]
    """<p>Detaches a policy from a <a>Directory</a>.</p>"""
    create_index: NotRequired[
        "capo_clouddirectory.types.batch_create_index.BatchCreateIndex"
    ]
    """<p>Creates an index object. See <a href="https://docs.aws.amazon.com/clouddirectory/latest/developerguide/indexing_search.htm">Indexing and search</a> for more information.</p>"""
    attach_to_index: NotRequired[
        "capo_clouddirectory.types.batch_attach_to_index.BatchAttachToIndex"
    ]
    """<p>Attaches the specified object to the specified index.</p>"""
    detach_from_index: NotRequired[
        "capo_clouddirectory.types.batch_detach_from_index.BatchDetachFromIndex"
    ]
    """<p>Detaches the specified object from the specified index.</p>"""
    attach_typed_link: NotRequired[
        "capo_clouddirectory.types.batch_attach_typed_link.BatchAttachTypedLink"
    ]
    """<p>Attaches a typed link to a specified source and target object. 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>"""
    detach_typed_link: NotRequired[
        "capo_clouddirectory.types.batch_detach_typed_link.BatchDetachTypedLink"
    ]
    """<p>Detaches a typed link from a specified source and target object. 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>"""
    update_link_attributes: NotRequired[
        "capo_clouddirectory.types.batch_update_link_attributes.BatchUpdateLinkAttributes"
    ]
    """<p>Updates a given object's attributes.</p>"""

add_facet_to_object instance-attribute

add_facet_to_object: NotRequired[BatchAddFacetToObject]

A batch operation that adds a facet to an object.

attach_object instance-attribute

attach_object: NotRequired[BatchAttachObject]

Attaches an object to a Directory.

attach_policy instance-attribute

attach_policy: NotRequired[BatchAttachPolicy]

Attaches a policy object to a regular object. An object can have a limited number of attached policies.

attach_to_index instance-attribute

attach_to_index: NotRequired[BatchAttachToIndex]

Attaches the specified object to the specified index.

attach_typed_link: NotRequired[BatchAttachTypedLink]

Attaches a typed link to a specified source and target object. For more information, see Typed Links.

create_index instance-attribute

create_index: NotRequired[BatchCreateIndex]

Creates an index object. See Indexing and search for more information.

create_object instance-attribute

create_object: NotRequired[BatchCreateObject]

Creates an object.

delete_object instance-attribute

delete_object: NotRequired[BatchDeleteObject]

Deletes an object in a Directory.

detach_from_index instance-attribute

detach_from_index: NotRequired[BatchDetachFromIndex]

Detaches the specified object from the specified index.

detach_object instance-attribute

detach_object: NotRequired[BatchDetachObject]

Detaches an object from a Directory.

detach_policy instance-attribute

detach_policy: NotRequired[BatchDetachPolicy]

Detaches a policy from a Directory.

detach_typed_link: NotRequired[BatchDetachTypedLink]

Detaches a typed link from a specified source and target object. For more information, see Typed Links.

remove_facet_from_object instance-attribute

remove_facet_from_object: NotRequired[BatchRemoveFacetFromObject]

A batch operation that removes a facet from an object.

update_link_attributes: NotRequired[BatchUpdateLinkAttributes]

Updates a given object's attributes.

update_object_attributes instance-attribute

update_object_attributes: NotRequired[BatchUpdateObjectAttributes]

Updates a given object's attributes.