Skip to content

EntitySummary

Source code in docs_src/capo_iottwinmaker/types/entity_summary.py
class EntitySummary(TypedDict, closed=True):
    entity_id: "capo_iottwinmaker.types.entity_id.EntityId"
    """<p>The ID of the entity.</p>"""
    entity_name: "capo_iottwinmaker.types.entity_name.EntityName"
    """<p>The name of the entity.</p>"""
    arn: "capo_iottwinmaker.types.twin_maker_arn.TwinMakerArn"
    """<p>The ARN of the entity.</p>"""
    parent_entity_id: NotRequired[
        "capo_iottwinmaker.types.parent_entity_id.ParentEntityId"
    ]
    """<p>The ID of the parent entity.</p>"""
    status: "capo_iottwinmaker.types.status.Status"
    """<p>The current status of the entity.</p>"""
    description: NotRequired["capo_iottwinmaker.types.description.Description"]
    """<p>The description of the entity.</p>"""
    has_child_entities: NotRequired["capo_iottwinmaker.types.boolean.Boolean"]
    """<p>An <b>eventual</b> Boolean value that specifies whether the entity has child entities or not.</p>"""
    creation_date_time: "capo_iottwinmaker.types.timestamp.Timestamp"
    """<p>The date and time when the entity was created.</p>"""
    update_date_time: "capo_iottwinmaker.types.timestamp.Timestamp"
    """<p>The last date and time when the entity was updated.</p>"""

arn instance-attribute

The ARN of the entity.

creation_date_time instance-attribute

creation_date_time: Timestamp

The date and time when the entity was created.

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: EntityName

The name of the entity.

has_child_entities instance-attribute

has_child_entities: NotRequired[Boolean]

An eventual Boolean value that specifies whether the entity has child entities or not.

parent_entity_id instance-attribute

parent_entity_id: NotRequired[ParentEntityId]

The ID of the parent entity.

status instance-attribute

status: Status

The current status of the entity.

update_date_time instance-attribute

update_date_time: Timestamp

The last date and time when the entity was updated.