Skip to content

UpdateEntityRequest

Source code in docs_src/capo_iottwinmaker/types/update_entity_request.py
class UpdateEntityRequest(TypedDict, closed=True):
    workspace_id: "capo_iottwinmaker.types.id.Id"
    """<p>The ID of the workspace that contains the entity.</p>"""
    entity_id: "capo_iottwinmaker.types.entity_id.EntityId"
    """<p>The ID of the entity.</p>"""
    entity_name: NotRequired["capo_iottwinmaker.types.entity_name.EntityName"]
    """<p>The name of the entity.</p>"""
    description: NotRequired["capo_iottwinmaker.types.description.Description"]
    """<p>The description of the entity.</p>"""
    component_updates: NotRequired[
        "capo_iottwinmaker.types.component_updates_map_request.ComponentUpdatesMapRequest"
    ]
    """<p>An object that maps strings to the component updates in the request. Each string in the mapping must be unique to this object.</p>"""
    composite_component_updates: NotRequired[
        "capo_iottwinmaker.types.composite_component_updates_map_request.CompositeComponentUpdatesMapRequest"
    ]
    """<p>This is an object that maps strings to <code>compositeComponent</code> updates in the request. Each key of the map represents the <code>componentPath</code> of the <code>compositeComponent</code>.</p>"""
    parent_entity_update: NotRequired[
        "capo_iottwinmaker.types.parent_entity_update_request.ParentEntityUpdateRequest"
    ]
    """<p>An object that describes the update request for a parent entity.</p>"""

component_updates instance-attribute

component_updates: NotRequired[ComponentUpdatesMapRequest]

An object that maps strings to the component updates in the request. Each string in the mapping must be unique to this object.

composite_component_updates instance-attribute

composite_component_updates: NotRequired[CompositeComponentUpdatesMapRequest]

This is an object that maps strings to compositeComponent updates in the request. Each key of the map represents the componentPath of the compositeComponent.

description instance-attribute

description: NotRequired[Description]

The description of the entity.

entity_id instance-attribute

entity_id: EntityId

The ID of the entity.

entity_name instance-attribute

entity_name: NotRequired[EntityName]

The name of the entity.

parent_entity_update instance-attribute

parent_entity_update: NotRequired[ParentEntityUpdateRequest]

An object that describes the update request for a parent entity.

workspace_id instance-attribute

workspace_id: Id

The ID of the workspace that contains the entity.