Skip to content

DescribeAssetResponse

Source code in docs_src/capo_iotsitewise/types/describe_asset_response.py 
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
class DescribeAssetResponse(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, if any.</p>"""
    asset_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>"""
    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 that was used to create the asset.</p>"""
    asset_properties: "capo_iotsitewise.types.asset_properties.AssetProperties"
    """<p>The list of asset properties for the asset.</p> <p>This object doesn't include properties that you define in composite models. You can find composite model properties in the <code>assetCompositeModels</code> object.</p>"""
    asset_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>"""
    asset_composite_models: NotRequired[
        "capo_iotsitewise.types.asset_composite_models.AssetCompositeModels"
    ]
    """<p>The composite models for the asset.</p>"""
    asset_creation_date: "capo_iotsitewise.types.timestamp.Timestamp"
    """<p>The date the asset was created, in Unix epoch time.</p>"""
    asset_last_update_date: "capo_iotsitewise.types.timestamp.Timestamp"
    """<p>The date the asset was last updated, in Unix epoch time.</p>"""
    asset_status: "capo_iotsitewise.types.asset_status.AssetStatus"
    """<p>The current status of the asset, which contains a state and any error message.</p>"""
    asset_description: NotRequired["capo_iotsitewise.types.description.Description"]
    """<p>A description for the asset.</p>"""
    asset_composite_model_summaries: NotRequired[
        "capo_iotsitewise.types.asset_composite_model_summaries.AssetCompositeModelSummaries"
    ]
    """<p>The list of the immediate child custom composite model summaries for the asset.</p>"""

asset_arn instance-attribute 

asset_arn: ARN

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

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

asset_composite_model_summaries instance-attribute 

asset_composite_model_summaries: NotRequired[AssetCompositeModelSummaries]

The list of the immediate child custom composite model summaries for the asset.

asset_composite_models instance-attribute 

asset_composite_models: NotRequired[AssetCompositeModels]

The composite models for the asset.

asset_creation_date instance-attribute 

asset_creation_date: Timestamp

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

asset_description instance-attribute 

asset_description: NotRequired[Description]

A description for the asset.

asset_external_id instance-attribute 

asset_external_id: NotRequired[ExternalId]

The external ID of the asset, if any.

asset_hierarchies instance-attribute 

asset_hierarchies: AssetHierarchies

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

asset_id instance-attribute 

asset_id: ID

The ID of the asset, in UUID format.

asset_last_update_date instance-attribute 

asset_last_update_date: Timestamp

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

asset_model_id instance-attribute 

asset_model_id: ID

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

asset_name instance-attribute 

asset_name: Name

The name of the asset.

asset_properties instance-attribute 

asset_properties: AssetProperties

The list of asset properties for the asset.

This object doesn't include properties that you define in composite models. You can find composite model properties in the assetCompositeModels object.

asset_status instance-attribute 

asset_status: AssetStatus

The current status of the asset, which contains a state and any error message.