Skip to content

DescribeAssetPropertyResponse

Source code in docs_src/capo_iotsitewise/types/describe_asset_property_response.py 
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
class DescribeAssetPropertyResponse(TypedDict, closed=True):
    asset_id: "capo_iotsitewise.types.id.ID"
    """<p>The ID of the asset, in UUID format.</p>"""
    asset_external_id: NotRequired["capo_iotsitewise.types.external_id.ExternalId"]
    """<p>The external ID of the asset. 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>"""
    asset_name: "capo_iotsitewise.types.name.Name"
    """<p>The name of the asset.</p>"""
    asset_model_id: "capo_iotsitewise.types.id.ID"
    """<p>The ID of the asset model, in UUID format.</p>"""
    asset_property: NotRequired["capo_iotsitewise.types.property.Property"]
    """<p>The asset property's definition, alias, and notification state.</p> <p>This response includes this object for normal asset properties. If you describe an asset property in a composite model, this response includes the asset property information in <code>compositeModel</code>.</p>"""
    composite_model: NotRequired[
        "capo_iotsitewise.types.composite_model_property.CompositeModelProperty"
    ]
    """<p>The composite model that declares this asset property, if this asset property exists in a composite model.</p>"""

asset_external_id instance-attribute 

asset_external_id: NotRequired[ExternalId]

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

asset_id instance-attribute 

asset_id: ID

The ID of the asset, in UUID format.

asset_model_id instance-attribute 

asset_model_id: ID

The ID of the asset model, in UUID format.

asset_name instance-attribute 

asset_name: Name

The name of the asset.

asset_property instance-attribute 

asset_property: NotRequired[Property]

The asset property's definition, alias, and notification state.

This response includes this object for normal asset properties. If you describe an asset property in a composite model, this response includes the asset property information in compositeModel.

composite_model instance-attribute 

composite_model: NotRequired[CompositeModelProperty]

The composite model that declares this asset property, if this asset property exists in a composite model.