CreateEntityRequest ¶

class CreateEntityRequest(TypedDict, closed=True):
    workspace_id: "capo_iottwinmaker.types.id.Id"
    """<p>The ID of the workspace that contains the entity.</p>"""
    entity_id: NotRequired["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>"""
    description: NotRequired["capo_iottwinmaker.types.description.Description"]
    """<p>The description of the entity.</p>"""
    components: NotRequired[
        "capo_iottwinmaker.types.components_map_request.ComponentsMapRequest"
    ]
    """<p>An object that maps strings to the components in the entity. Each string in the mapping must be unique to this object.</p>"""
    composite_components: NotRequired[
        "capo_iottwinmaker.types.composite_components_map_request.CompositeComponentsMapRequest"
    ]
    """<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_id: NotRequired[
        "capo_iottwinmaker.types.parent_entity_id.ParentEntityId"
    ]
    """<p>The ID of the entity's parent entity.</p>"""
    tags: NotRequired["capo_iottwinmaker.types.tag_map.TagMap"]
    """<p>Metadata that you can use to manage the entity.</p>"""