Skip to content

DescribeAssetCompositeModelResponse

Source code in docs_src/capo_iotsitewise/types/describe_asset_composite_model_response.py
class DescribeAssetCompositeModelResponse(TypedDict, closed=True):
    asset_id: "capo_iotsitewise.types.id.ID"
    """<p>The ID of the asset, in UUID format. This ID uniquely identifies the asset within IoT SiteWise and can be used with other IoT SiteWise APIs.</p>"""
    asset_composite_model_id: "capo_iotsitewise.types.id.ID"
    """<p>The ID of a composite model on this asset.</p>"""
    asset_composite_model_external_id: NotRequired[
        "capo_iotsitewise.types.external_id.ExternalId"
    ]
    """<p>An external ID to assign to the asset model.</p> <p>If the composite model is a component-based composite model, or one nested inside a component model, you can only set the external ID using <code>UpdateAssetModelCompositeModel</code> and specifying the derived ID of the model or property from the created model it's a part of.</p>"""
    asset_composite_model_path: (
        "capo_iotsitewise.types.asset_composite_model_path.AssetCompositeModelPath"
    )
    """<p>The path to the composite model listing the parent composite models.</p>"""
    asset_composite_model_name: "capo_iotsitewise.types.name.Name"
    """<p>The unique, friendly name for the composite model.</p>"""
    asset_composite_model_description: "capo_iotsitewise.types.description.Description"
    """<p>A description for the composite model.</p>"""
    asset_composite_model_type: "capo_iotsitewise.types.name.Name"
    """<p>The composite model type. Valid values are <code>AWS/ALARM</code>, <code>CUSTOM</code>, or <code> AWS/L4E_ANOMALY</code>.</p>"""
    asset_composite_model_properties: (
        "capo_iotsitewise.types.asset_properties.AssetProperties"
    )
    """<p>The property definitions of the composite model that was used to create the asset.</p>"""
    asset_composite_model_summaries: "capo_iotsitewise.types.asset_composite_model_summaries.AssetCompositeModelSummaries"
    """<p>The list of composite model summaries.</p>"""
    action_definitions: NotRequired[
        "capo_iotsitewise.types.action_definitions.ActionDefinitions"
    ]
    """<p>The available actions for a composite model on this asset.</p>"""

action_definitions instance-attribute

action_definitions: NotRequired[ActionDefinitions]

The available actions for a composite model on this asset.

asset_composite_model_description instance-attribute

asset_composite_model_description: Description

A description for the composite model.

asset_composite_model_external_id instance-attribute

asset_composite_model_external_id: NotRequired[ExternalId]

An external ID to assign to the asset model.

If the composite model is a component-based composite model, or one nested inside a component model, you can only set the external ID using UpdateAssetModelCompositeModel and specifying the derived ID of the model or property from the created model it's a part of.

asset_composite_model_id instance-attribute

asset_composite_model_id: ID

The ID of a composite model on this asset.

asset_composite_model_name instance-attribute

asset_composite_model_name: Name

The unique, friendly name for the composite model.

asset_composite_model_path instance-attribute

asset_composite_model_path: AssetCompositeModelPath

The path to the composite model listing the parent composite models.

asset_composite_model_properties instance-attribute

asset_composite_model_properties: AssetProperties

The property definitions of the composite model that was used to create the asset.

asset_composite_model_summaries instance-attribute

asset_composite_model_summaries: AssetCompositeModelSummaries

The list of composite model summaries.

asset_composite_model_type instance-attribute

asset_composite_model_type: Name

The composite model type. Valid values are AWS/ALARM, CUSTOM, or AWS/L4E_ANOMALY.

asset_id instance-attribute

asset_id: ID

The ID of the asset, in UUID format. This ID uniquely identifies the asset within IoT SiteWise and can be used with other IoT SiteWise APIs.