Skip to content

DescribeAssetModelRequest

Source code in docs_src/capo_iotsitewise/types/describe_asset_model_request.py 
13
14
15
16
17
18
19
20
21
class DescribeAssetModelRequest(TypedDict, closed=True):
    asset_model_id: "capo_iotsitewise.types.custom_id.CustomID"
    """<p>The ID of the asset model. This can be either the actual ID in UUID format, or else <code>externalId:</code> followed by the external ID, if it has one. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references">Referencing objects with external IDs</a> in the <i>IoT SiteWise User Guide</i>.</p>"""
    exclude_properties: "capo_iotsitewise.types.exclude_properties.ExcludeProperties"
    """<p> Whether or not to exclude asset model properties from the response. </p>"""
    asset_model_version: NotRequired[
        "capo_iotsitewise.types.asset_model_version_filter.AssetModelVersionFilter"
    ]
    """<p>The version alias that specifies the latest or active version of the asset model. The details are returned in the response. The default value is <code>LATEST</code>. See <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/model-active-version.html"> Asset model versions</a> in the <i>IoT SiteWise User Guide</i>.</p>"""

asset_model_id instance-attribute 

asset_model_id: CustomID

The ID of the asset model. This can be either the actual ID in UUID format, or else externalId: followed by the external ID, if it has one. For more information, see Referencing objects with external IDs in the IoT SiteWise User Guide.

asset_model_version instance-attribute 

asset_model_version: NotRequired[AssetModelVersionFilter]

The version alias that specifies the latest or active version of the asset model. The details are returned in the response. The default value is LATEST. See Asset model versions in the IoT SiteWise User Guide.

exclude_properties instance-attribute 

exclude_properties: ExcludeProperties

Whether or not to exclude asset model properties from the response.