Skip to content

Property

Source code in docs_src/capo_iotsitewise/types/property.py 
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
class Property(TypedDict, closed=True):
    id: "capo_iotsitewise.types.id.ID"
    """<p>The ID of the asset property.</p>"""
    external_id: NotRequired["capo_iotsitewise.types.external_id.ExternalId"]
    """<p>The external ID of the asset 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>"""
    alias: NotRequired["capo_iotsitewise.types.property_alias.PropertyAlias"]
    """<p>The alias that identifies the property, such as an OPC-UA server data stream path (for example, <code>/company/windfarm/3/turbine/7/temperature</code>). For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/connect-data-streams.html">Mapping industrial data streams to asset properties</a> in the <i>IoT SiteWise User Guide</i>.</p>"""
    notification: NotRequired[
        "capo_iotsitewise.types.property_notification.PropertyNotification"
    ]
    """<p>The asset property's notification topic and state. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_UpdateAssetProperty.html">UpdateAssetProperty</a>.</p>"""
    data_type: "capo_iotsitewise.types.property_data_type.PropertyDataType"
    """<p>The property 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 asset property.</p>"""
    type: NotRequired["capo_iotsitewise.types.property_type.PropertyType"]
    """<p>The property type (see <code>PropertyType</code>). A property contains one type.</p>"""
    path: NotRequired["capo_iotsitewise.types.asset_property_path.AssetPropertyPath"]
    """<p>The structured path to the property from the root of the asset.</p>"""

alias instance-attribute 

alias: NotRequired[PropertyAlias]

The alias that identifies the property, such as an OPC-UA server data stream path (for example, /company/windfarm/3/turbine/7/temperature). For more information, see Mapping industrial data streams to asset properties in the IoT SiteWise User Guide.

data_type instance-attribute 

data_type: PropertyDataType

The property data type.

external_id instance-attribute 

external_id: NotRequired[ExternalId]

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

id instance-attribute 

id: ID

The ID of the asset property.

name instance-attribute 

name: Name

The name of the property.

notification instance-attribute 

notification: NotRequired[PropertyNotification]

The asset property's notification topic and state. For more information, see UpdateAssetProperty.

path instance-attribute 

path: NotRequired[AssetPropertyPath]

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

type instance-attribute 

type: NotRequired[PropertyType]

The property type (see PropertyType). A property contains one type.

unit instance-attribute 

unit: NotRequired[PropertyUnit]

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