Iot Sitewise Asset Hierarchy Structure

Describes an asset hierarchy that contains a hierarchy's name and ID.

Type: object Properties: 2 Required: 1

Asset ManagementIndustrial IoTIoTTime Series Data

AssetHierarchy 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

id name

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

JSON Structure

{
  "$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-hierarchy-structure.json",
  "name": "AssetHierarchy",
  "description": "Describes an asset hierarchy that contains a hierarchy's name and ID.",
  "type": "object",
  "properties": {
    "id": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ID"
        },
        {
          "description": "The ID of the hierarchy. This ID is a <code>hierarchyId</code>."
        }
      ]
    },
    "name": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Name"
        },
        {
          "description": "The hierarchy name provided in the <a href=\"https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_CreateAssetModel.html\">CreateAssetModel</a> or <a href=\"https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_UpdateAssetModel.html\">UpdateAssetModel</a> API operation."
        }
      ]
    }
  },
  "required": [
    "name"
  ]
}