Amazon IoT SiteWise · JSON Structure

Iot Sitewise Asset Relationship Summary Structure

Contains information about assets that are related to one another.

Type: object Properties: 2 Required: 1
Asset ManagementIndustrial IoTIoTTime Series Data

AssetRelationshipSummary is a JSON Structure definition published by Amazon IoT SiteWise, describing 2 properties, of which 1 is required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

hierarchyInfo relationshipType

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑ 
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-iot-sitewise/refs/heads/main/json-structure/iot-sitewise-asset-relationship-summary-structure.json",
  "name": "AssetRelationshipSummary",
  "description": "Contains information about assets that are related to one another.",
  "type": "object",
  "properties": {
    "hierarchyInfo": {
      "allOf": [
        {
          "$ref": "#/components/schemas/AssetHierarchyInfo"
        },
        {
          "description": "<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>"
        }
      ]
    },
    "relationshipType": {
      "allOf": [
        {
          "$ref": "#/components/schemas/AssetRelationshipType"
        },
        {
          "description": "<p>The relationship type of the assets in this relationship. This value is one of the following:</p> <ul> <li> <p> <code>HIERARCHY</code> \u2013 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>"
        }
      ]
    }
  },
  "required": [
    "relationshipType"
  ]
}