AssetModelHierarchy

Describes an asset hierarchy that contains a hierarchy's name, ID, and child asset model ID that specifies the type of asset that can be in this hierarchy.

Asset ManagementIndustrial IoTIoTTime Series Data

Properties

Name Type Description
id object
name object
childAssetModelId object
View JSON Schema on GitHub

JSON Schema

iot-sitewise-asset-model-hierarchy-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-iot-sitewise/refs/heads/main/json-schema/iot-sitewise-asset-model-hierarchy-schema.json",
  "title": "AssetModelHierarchy",
  "description": "Describes an asset hierarchy that contains a hierarchy's name, ID, and child asset model ID that specifies the type of asset that can be in this hierarchy.",
  "type": "object",
  "properties": {
    "id": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ID"
        },
        {
          "description": "The ID of the asset model hierarchy. This ID is a <code>hierarchyId</code>."
        }
      ]
    },
    "name": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Name"
        },
        {
          "description": "The name of the asset model hierarchy that you specify by using 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."
        }
      ]
    },
    "childAssetModelId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ID"
        },
        {
          "description": "The ID of the asset model. All assets in this hierarchy must be instances of the <code>childAssetModelId</code> asset model."
        }
      ]
    }
  },
  "required": [
    "name",
    "childAssetModelId"
  ]
}