Skip to content

AssociatedAssetsSummary

Source code in docs_src/capo_iotsitewise/types/associated_assets_summary.py
class AssociatedAssetsSummary(TypedDict, closed=True):
    id: "capo_iotsitewise.types.id.ID"
    """<p>The ID of the asset, in UUID format.</p>"""
    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>"""
    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, which has the following format.</p> <p> <code>arn:${Partition}:iotsitewise:${Region}:${Account}:asset/${AssetId}</code> </p>"""
    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 used to create the asset.</p>"""
    creation_date: "capo_iotsitewise.types.timestamp.Timestamp"
    """<p>The date the asset was created, in Unix epoch time.</p>"""
    last_update_date: "capo_iotsitewise.types.timestamp.Timestamp"
    """<p>The date the asset was last updated, in Unix epoch time.</p>"""
    status: "capo_iotsitewise.types.asset_status.AssetStatus"
    """<p>The current status of the asset.</p>"""
    hierarchies: "capo_iotsitewise.types.asset_hierarchies.AssetHierarchies"
    """<p>A list of asset hierarchies that each contain a <code>hierarchyId</code>. A hierarchy specifies allowed parent/child asset relationships.</p>"""
    description: NotRequired["capo_iotsitewise.types.description.Description"]
    """<p>A description for the asset.</p>"""

arn instance-attribute

arn: ARN

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

arn:${Partition}:iotsitewise:${Region}:${Account}:asset/${AssetId}

asset_model_id instance-attribute

asset_model_id: ID

The ID of the asset model used to create the asset.

creation_date instance-attribute

creation_date: Timestamp

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

description instance-attribute

description: NotRequired[Description]

A description for the asset.

external_id instance-attribute

external_id: NotRequired[ExternalId]

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

hierarchies instance-attribute

hierarchies: AssetHierarchies

A list of asset hierarchies that each contain a hierarchyId. A hierarchy specifies allowed parent/child asset relationships.

id instance-attribute

id: ID

The ID of the asset, in UUID format.

last_update_date instance-attribute

last_update_date: Timestamp

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

name instance-attribute

name: Name

The name of the asset.

status instance-attribute

status: AssetStatus

The current status of the asset.