Skip to content

GetEntityResponse

Source code in docs_src/capo_iottwinmaker/types/get_entity_response.py
class GetEntityResponse(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>"""
    status: "capo_iottwinmaker.types.status.Status"
    """<p>The current status of the entity.</p>"""
    workspace_id: "capo_iottwinmaker.types.id.Id"
    """<p>The ID of the workspace.</p>"""
    description: NotRequired["capo_iottwinmaker.types.description.Description"]
    """<p>The description of the entity.</p>"""
    components: NotRequired["capo_iottwinmaker.types.components_map.ComponentsMap"]
    """<p>An object that maps strings to the components in the entity. Each string in the mapping must be unique to this object.</p>"""
    parent_entity_id: "capo_iottwinmaker.types.parent_entity_id.ParentEntityId"
    """<p>The ID of the parent entity for this entity.</p>"""
    has_child_entities: "capo_iottwinmaker.types.boolean.Boolean"
    """<p>A Boolean value that specifies whether the entity has associated child entities.</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 date and time when the entity was last updated.</p>"""
    sync_source: NotRequired["capo_iottwinmaker.types.sync_source.SyncSource"]
    """<p>The syncSource of the sync job, if this entity was created by a sync job.</p>"""
    are_all_components_returned: NotRequired["capo_iottwinmaker.types.boolean.Boolean"]
    """<p>This flag notes whether all components are returned in the API response. The maximum number of components returned is 30.</p>"""

are_all_components_returned instance-attribute

are_all_components_returned: NotRequired[Boolean]

This flag notes whether all components are returned in the API response. The maximum number of components returned is 30.

arn instance-attribute

The ARN of the entity.

components instance-attribute

components: NotRequired[ComponentsMap]

An object that maps strings to the components in the entity. Each string in the mapping must be unique to this object.

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

A Boolean value that specifies whether the entity has associated child entities.

parent_entity_id instance-attribute

parent_entity_id: ParentEntityId

The ID of the parent entity for this entity.

status instance-attribute

status: Status

The current status of the entity.

sync_source instance-attribute

sync_source: NotRequired[SyncSource]

The syncSource of the sync job, if this entity was created by a sync job.

update_date_time instance-attribute

update_date_time: Timestamp

The date and time when the entity was last updated.

workspace_id instance-attribute

workspace_id: Id

The ID of the workspace.