Skip to content

AssetModelCompositeModelSummary

Source code in docs_src/capo_iotsitewise/types/asset_model_composite_model_summary.py 
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
class AssetModelCompositeModelSummary(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>The external ID of a composite model on this asset model. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids">Using external IDs</a> in the <i>IoT SiteWise User Guide</i>.</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 composite model type. Valid values are <code>AWS/ALARM</code>, <code>CUSTOM</code>, or <code> AWS/L4E_ANOMALY</code>.</p>"""
    description: NotRequired["capo_iotsitewise.types.description.Description"]
    """<p>The description of the composite model that this summary describes..</p>"""
    path: NotRequired[
        "capo_iotsitewise.types.asset_model_composite_model_path.AssetModelCompositeModelPath"
    ]
    """<p>The path that includes all the pieces that make up the composite model.</p>"""

description instance-attribute 

description: NotRequired[Description]

The description of the composite model that this summary describes..

external_id instance-attribute 

external_id: NotRequired[ExternalId]

The external ID of a composite model on this asset model. For more information, see Using external IDs in the IoT SiteWise User Guide.

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 

path: NotRequired[AssetModelCompositeModelPath]

The path that includes all the pieces that make up the composite model.

type instance-attribute 

type: Name

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