Skip to content

DeleteEntityRequest

Source code in docs_src/capo_iottwinmaker/types/delete_entity_request.py
class DeleteEntityRequest(TypedDict, closed=True):
    workspace_id: "capo_iottwinmaker.types.id.Id"
    """<p>The ID of the workspace that contains the entity to delete.</p>"""
    entity_id: "capo_iottwinmaker.types.entity_id.EntityId"
    """<p>The ID of the entity to delete.</p>"""
    is_recursive: NotRequired["capo_iottwinmaker.types.boolean.Boolean"]
    """<p>A Boolean value that specifies whether the operation deletes child entities.</p>"""

entity_id instance-attribute

entity_id: EntityId

The ID of the entity to delete.

is_recursive instance-attribute

is_recursive: NotRequired[Boolean]

A Boolean value that specifies whether the operation deletes child entities.

workspace_id instance-attribute

workspace_id: Id

The ID of the workspace that contains the entity to delete.