Skip to content

AssetCompositeModelSummary

Source code in docs_src/capo_iotsitewise/types/asset_composite_model_summary.py
class AssetCompositeModelSummary(TypedDict, closed=True):
    id: "capo_iotsitewise.types.id.ID"
    """<p>The ID of the composite model that this summary describes.</p>"""
    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 derived 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>"""
    name: "capo_iotsitewise.types.name.Name"
    """<p>The name of the composite model that this summary describes.</p>"""
    type: "capo_iotsitewise.types.name.Name"
    """<p>The type of asset model.</p> <ul> <li> <p> <b>ASSET_MODEL</b> – (default) An asset model that you can use to create assets. Can't be included as a component in another asset model.</p> </li> <li> <p> <b>COMPONENT_MODEL</b> – A reusable component that you can include in the composite models of other asset models. You can't create assets directly from this type of asset model. </p> </li> </ul>"""
    description: "capo_iotsitewise.types.description.Description"
    """<p>A description of the composite model that this summary describes.</p>"""
    path: "capo_iotsitewise.types.asset_composite_model_path.AssetCompositeModelPath"
    """<p>The path that includes all the components of the asset model for the asset.</p>"""

description instance-attribute

description: Description

A description of the composite model that this summary describes.

external_id instance-attribute

external_id: NotRequired[ExternalId]

An external ID to assign to the asset model.

If the composite model is a derived 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.

id instance-attribute

id: ID

The ID of the composite model that this summary describes.

name instance-attribute

name: Name

The name of the composite model that this summary describes.

path instance-attribute

The path that includes all the components of the asset model for the asset.

type instance-attribute

type: Name

The type of asset model.

  • ASSET_MODEL – (default) An asset model that you can use to create assets. Can't be included as a component in another asset model.

  • COMPONENT_MODEL – A reusable component that you can include in the composite models of other asset models. You can't create assets directly from this type of asset model.