Skip to content

AssetModelCompositeModelDefinition

Source code in docs_src/capo_iotsitewise/types/asset_model_composite_model_definition.py 
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
class AssetModelCompositeModelDefinition(TypedDict, closed=True):
    id: NotRequired["capo_iotsitewise.types.id.ID"]
    """<p>The ID to assign to the composite model, if desired. IoT SiteWise automatically generates a unique ID for you, so this parameter is never required. However, if you prefer to supply your own ID instead, you can specify it here in UUID format. If you specify your own ID, it must be globally unique.</p>"""
    external_id: NotRequired["capo_iotsitewise.types.external_id.ExternalId"]
    """<p>An external ID to assign to the composite model. The external ID must be unique among composite models within 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.</p>"""
    description: NotRequired["capo_iotsitewise.types.description.Description"]
    """<p>The description of the composite model.</p>"""
    type: "capo_iotsitewise.types.name.Name"
    """<p>The type of the composite model. For alarm composite models, this type is <code>AWS/ALARM</code>.</p>"""
    properties: NotRequired[
        "capo_iotsitewise.types.asset_model_property_definitions.AssetModelPropertyDefinitions"
    ]
    """<p>The asset property definitions for this composite model.</p>"""

description instance-attribute 

description: NotRequired[Description]

The description of the composite model.

external_id instance-attribute 

external_id: NotRequired[ExternalId]

An external ID to assign to the composite model. The external ID must be unique among composite models within this asset model. For more information, see Using external IDs in the IoT SiteWise User Guide.

id instance-attribute 

id: NotRequired[ID]

The ID to assign to the composite model, if desired. IoT SiteWise automatically generates a unique ID for you, so this parameter is never required. However, if you prefer to supply your own ID instead, you can specify it here in UUID format. If you specify your own ID, it must be globally unique.

name instance-attribute 

name: Name

The name of the composite model.

properties instance-attribute 

properties: NotRequired[AssetModelPropertyDefinitions]

The asset property definitions for this composite model.

type instance-attribute 

type: Name

The type of the composite model. For alarm composite models, this type is AWS/ALARM.