Iot Sitewise Associate Assets Request Structure

AssociateAssetsRequest schema

Type: object Properties: 3 Required: 2

Asset ManagementIndustrial IoTIoTTime Series Data

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

Properties

hierarchyId childAssetId clientToken

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-associate-assets-request-structure.json",
  "name": "AssociateAssetsRequest",
  "description": "AssociateAssetsRequest schema",
  "type": "object",
  "properties": {
    "hierarchyId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ID"
        },
        {
          "description": "The ID of a hierarchy in the parent asset's model. Hierarchies allow different groupings of assets to be formed that all come from the same asset model. For more information, see <a href=\"https://docs.aws.amazon.com/iot-sitewise/latest/userguide/asset-hierarchies.html\">Asset hierarchies</a> in the <i>IoT SiteWise User Guide</i>."
        }
      ]
    },
    "childAssetId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ID"
        },
        {
          "description": "The ID of the child asset to be associated."
        }
      ]
    },
    "clientToken": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ClientToken"
        },
        {
          "description": "A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required."
        }
      ]
    }
  },
  "required": [
    "hierarchyId",
    "childAssetId"
  ]
}