Skip to content

AssetModelPropertySummary

Source code in docs_src/capo_iotsitewise/types/asset_model_property_summary.py 
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
class AssetModelPropertySummary(TypedDict, closed=True):
    id: NotRequired["capo_iotsitewise.types.id.ID"]
    """<p>The ID of the property.</p>"""
    external_id: NotRequired["capo_iotsitewise.types.external_id.ExternalId"]
    """<p>The external ID of the property. 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 property.</p>"""
    data_type: "capo_iotsitewise.types.property_data_type.PropertyDataType"
    """<p>The data type of the property.</p>"""
    data_type_spec: NotRequired["capo_iotsitewise.types.name.Name"]
    """<p>The data type of the structure for this property. This parameter exists on properties that have the <code>STRUCT</code> data type.</p>"""
    unit: NotRequired["capo_iotsitewise.types.property_unit.PropertyUnit"]
    """<p>The unit (such as <code>Newtons</code> or <code>RPM</code>) of the property.</p>"""
    type: "capo_iotsitewise.types.property_type.PropertyType"
    asset_model_composite_model_id: NotRequired["capo_iotsitewise.types.id.ID"]
    """<p> The ID of the composite model that contains the asset model property. </p>"""
    path: NotRequired[
        "capo_iotsitewise.types.asset_model_property_path.AssetModelPropertyPath"
    ]
    """<p>The structured path to the property from the root of the asset model.</p>"""
    interface_summaries: NotRequired[
        "capo_iotsitewise.types.interface_summaries.InterfaceSummaries"
    ]
    """<p>A list of interface summaries that describe which interfaces this property belongs to, including the interface asset model ID and the corresponding property ID in the interface.</p>"""

asset_model_composite_model_id instance-attribute 

asset_model_composite_model_id: NotRequired[ID]

The ID of the composite model that contains the asset model property.

data_type instance-attribute 

data_type: PropertyDataType

The data type of the property.

data_type_spec instance-attribute 

data_type_spec: NotRequired[Name]

The data type of the structure for this property. This parameter exists on properties that have the STRUCT data type.

external_id instance-attribute 

external_id: NotRequired[ExternalId]

The external ID of the property. For more information, see Using external IDs in the IoT SiteWise User Guide.

id instance-attribute 

id: NotRequired[ID]

The ID of the property.

interface_summaries instance-attribute 

interface_summaries: NotRequired[InterfaceSummaries]

A list of interface summaries that describe which interfaces this property belongs to, including the interface asset model ID and the corresponding property ID in the interface.

name instance-attribute 

name: Name

The name of the property.

path instance-attribute 

path: NotRequired[AssetModelPropertyPath]

The structured path to the property from the root of the asset model.

type instance-attribute 

type: PropertyType

unit instance-attribute 

unit: NotRequired[PropertyUnit]

The unit (such as Newtons or RPM) of the property.