Skip to content

GetComponentTypeResponse

Source code in docs_src/capo_iottwinmaker/types/get_component_type_response.py
class GetComponentTypeResponse(TypedDict, closed=True):
    workspace_id: "capo_iottwinmaker.types.id.Id"
    """<p>The ID of the workspace that contains the component type.</p>"""
    is_singleton: NotRequired["capo_iottwinmaker.types.boolean.Boolean"]
    """<p>A Boolean value that specifies whether an entity can have more than one component of this type.</p>"""
    component_type_id: "capo_iottwinmaker.types.component_type_id.ComponentTypeId"
    """<p>The ID of the component type.</p>"""
    description: NotRequired["capo_iottwinmaker.types.description.Description"]
    """<p>The description of the component type.</p>"""
    property_definitions: NotRequired[
        "capo_iottwinmaker.types.property_definitions_response.PropertyDefinitionsResponse"
    ]
    """<p>An object that maps strings to the property definitions in the component type. Each string in the mapping must be unique to this object.</p>"""
    extends_from: NotRequired["capo_iottwinmaker.types.extends_from.ExtendsFrom"]
    """<p>The name of the parent component type that this component type extends.</p>"""
    functions: NotRequired[
        "capo_iottwinmaker.types.functions_response.FunctionsResponse"
    ]
    """<p>An object that maps strings to the functions in the component type. Each string in the mapping must be unique to this object.</p>"""
    creation_date_time: "capo_iottwinmaker.types.timestamp.Timestamp"
    """<p>The date and time when the component type was created.</p>"""
    update_date_time: "capo_iottwinmaker.types.timestamp.Timestamp"
    """<p>The date and time when the component was last updated.</p>"""
    arn: "capo_iottwinmaker.types.twin_maker_arn.TwinMakerArn"
    """<p>The ARN of the component type.</p>"""
    is_abstract: NotRequired["capo_iottwinmaker.types.boolean.Boolean"]
    """<p>A Boolean value that specifies whether the component type is abstract.</p>"""
    is_schema_initialized: NotRequired["capo_iottwinmaker.types.boolean.Boolean"]
    """<p>A Boolean value that specifies whether the component type has a schema initializer and that the schema initializer has run.</p>"""
    status: NotRequired["capo_iottwinmaker.types.status.Status"]
    """<p>The current status of the component type.</p>"""
    property_groups: NotRequired[
        "capo_iottwinmaker.types.property_groups_response.PropertyGroupsResponse"
    ]
    """<p>The maximum number of results to return at one time. The default is 25.</p> <p>Valid Range: Minimum value of 1. Maximum value of 250.</p>"""
    sync_source: NotRequired["capo_iottwinmaker.types.sync_source.SyncSource"]
    """<p>The syncSource of the SyncJob, if this entity was created by a SyncJob.</p>"""
    component_type_name: NotRequired[
        "capo_iottwinmaker.types.component_type_name.ComponentTypeName"
    ]
    """<p>The component type name.</p>"""
    composite_component_types: NotRequired[
        "capo_iottwinmaker.types.composite_component_types_response.CompositeComponentTypesResponse"
    ]
    """<p>This is an object that maps strings to <code>compositeComponentTypes</code> of the <code>componentType</code>. <code>CompositeComponentType</code> is referenced by <code>componentTypeId</code>.</p>"""

arn instance-attribute

The ARN of the component type.

component_type_id instance-attribute

component_type_id: ComponentTypeId

The ID of the component type.

component_type_name instance-attribute

component_type_name: NotRequired[ComponentTypeName]

The component type name.

composite_component_types instance-attribute

composite_component_types: NotRequired[CompositeComponentTypesResponse]

This is an object that maps strings to compositeComponentTypes of the componentType. CompositeComponentType is referenced by componentTypeId.

creation_date_time instance-attribute

creation_date_time: Timestamp

The date and time when the component type was created.

description instance-attribute

description: NotRequired[Description]

The description of the component type.

extends_from instance-attribute

extends_from: NotRequired[ExtendsFrom]

The name of the parent component type that this component type extends.

functions instance-attribute

functions: NotRequired[FunctionsResponse]

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

is_abstract instance-attribute

is_abstract: NotRequired[Boolean]

A Boolean value that specifies whether the component type is abstract.

is_schema_initialized instance-attribute

is_schema_initialized: NotRequired[Boolean]

A Boolean value that specifies whether the component type has a schema initializer and that the schema initializer has run.

is_singleton instance-attribute

is_singleton: NotRequired[Boolean]

A Boolean value that specifies whether an entity can have more than one component of this type.

property_definitions instance-attribute

property_definitions: NotRequired[PropertyDefinitionsResponse]

An object that maps strings to the property definitions in the component type. Each string in the mapping must be unique to this object.

property_groups instance-attribute

property_groups: NotRequired[PropertyGroupsResponse]

The maximum number of results to return at one time. The default is 25.

Valid Range: Minimum value of 1. Maximum value of 250.

status instance-attribute

status: NotRequired[Status]

The current status of the component type.

sync_source instance-attribute

sync_source: NotRequired[SyncSource]

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

update_date_time instance-attribute

update_date_time: Timestamp

The date and time when the component was last updated.

workspace_id instance-attribute

workspace_id: Id

The ID of the workspace that contains the component type.