Skip to content

AssetModelSummary

Source code in docs_src/capo_iotsitewise/types/asset_model_summary.py 
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
class AssetModelSummary(TypedDict, closed=True):
    id: "capo_iotsitewise.types.id.ID"
    """<p>The ID of the asset model (used with IoT SiteWise API operations).</p>"""
    external_id: NotRequired["capo_iotsitewise.types.external_id.ExternalId"]
    """<p>The external ID of the 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>"""
    arn: "capo_iotsitewise.types.arn.ARN"
    """<p>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">ARN</a> of the asset model, which has the following format.</p> <p> <code>arn:${Partition}:iotsitewise:${Region}:${Account}:asset-model/${AssetModelId}</code> </p>"""
    name: "capo_iotsitewise.types.name.Name"
    """<p>The name of the asset model.</p>"""
    asset_model_type: NotRequired[
        "capo_iotsitewise.types.asset_model_type.AssetModelType"
    ]
    """<p>The type of asset model.</p> <ul> <li> <p> <b>ASSET_MODEL</b> – (default) An asset model that you can use to create assets. Can't be included as a component in another asset model.</p> </li> <li> <p> <b>COMPONENT_MODEL</b> – A reusable component that you can include in the composite models of other asset models. You can't create assets directly from this type of asset model. </p> </li> </ul>"""
    description: "capo_iotsitewise.types.description.Description"
    """<p>The asset model description.</p>"""
    creation_date: "capo_iotsitewise.types.timestamp.Timestamp"
    """<p>The date the asset model was created, in Unix epoch time.</p>"""
    last_update_date: "capo_iotsitewise.types.timestamp.Timestamp"
    """<p>The date the asset model was last updated, in Unix epoch time.</p>"""
    status: "capo_iotsitewise.types.asset_model_status.AssetModelStatus"
    """<p>The current status of the asset model.</p>"""
    version: NotRequired["capo_iotsitewise.types.version.Version"]
    """<p>The version number of the asset model.</p>"""

arn instance-attribute 

arn: ARN

The ARN of the asset model, which has the following format.

arn:${Partition}:iotsitewise:${Region}:${Account}:asset-model/${AssetModelId}

asset_model_type instance-attribute 

asset_model_type: NotRequired[AssetModelType]

The type of asset model.

  • ASSET_MODEL – (default) An asset model that you can use to create assets. Can't be included as a component in another asset model.

  • COMPONENT_MODEL – A reusable component that you can include in the composite models of other asset models. You can't create assets directly from this type of asset model.

creation_date instance-attribute 

creation_date: Timestamp

The date the asset model was created, in Unix epoch time.

description instance-attribute 

description: Description

The asset model description.

external_id instance-attribute 

external_id: NotRequired[ExternalId]

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

id instance-attribute 

id: ID

The ID of the asset model (used with IoT SiteWise API operations).

last_update_date instance-attribute 

last_update_date: Timestamp

The date the asset model was last updated, in Unix epoch time.

name instance-attribute 

name: Name

The name of the asset model.

status instance-attribute 

status: AssetModelStatus

The current status of the asset model.

version instance-attribute 

version: NotRequired[Version]

The version number of the asset model.