Skip to content

AssetRelationshipSummary

Source code in docs_src/capo_iotsitewise/types/asset_relationship_summary.py 
14
15
16
17
18
19
20
21
22
class AssetRelationshipSummary(TypedDict, closed=True):
    hierarchy_info: NotRequired[
        "capo_iotsitewise.types.asset_hierarchy_info.AssetHierarchyInfo"
    ]
    """<p>The assets that are related through an asset hierarchy.</p> <p>This object is present if the <code>relationshipType</code> is <code>HIERARCHY</code>.</p>"""
    relationship_type: (
        "capo_iotsitewise.types.asset_relationship_type.AssetRelationshipType"
    )
    """<p>The relationship type of the assets in this relationship. This value is one of the following:</p> <ul> <li> <p> <code>HIERARCHY</code> – The assets are related through an asset hierarchy. If you specify this relationship type, this asset relationship includes the <code>hierarchyInfo</code> object.</p> </li> </ul>"""

hierarchy_info instance-attribute 

hierarchy_info: NotRequired[AssetHierarchyInfo]

The assets that are related through an asset hierarchy.

This object is present if the relationshipType is HIERARCHY.

relationship_type instance-attribute 

relationship_type: AssetRelationshipType

The relationship type of the assets in this relationship. This value is one of the following:

  • HIERARCHY – The assets are related through an asset hierarchy. If you specify this relationship type, this asset relationship includes the hierarchyInfo object.