AssetProperties

AssetProperties schema

Asset ManagementIndustrial IoTIoTTime Series Data
View JSON Schema on GitHub

JSON Schema

iot-sitewise-asset-properties-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-properties-schema.json",
  "title": "AssetProperties",
  "description": "AssetProperties schema",
  "type": "array",
  "items": {
    "type": "object",
    "required": [
      "id",
      "name",
      "dataType"
    ],
    "properties": {
      "id": {
        "allOf": [
          {
            "$ref": "#/components/schemas/ID"
          },
          {
            "description": "The ID of the asset property."
          }
        ]
      },
      "name": {
        "allOf": [
          {
            "$ref": "#/components/schemas/Name"
          },
          {
            "description": "The name of the property."
          }
        ]
      },
      "alias": {
        "allOf": [
          {
            "$ref": "#/components/schemas/PropertyAlias"
          },
          {
            "description": "The alias that identifies the property, such as an OPC-UA server data stream path (for example, <code>/company/windfarm/3/turbine/7/temperature</code>). For more information, see <a href=\"https://docs.aws.amazon.com/iot-sitewise/latest/userguide/connect-data-streams.html\">Mapping industrial data streams to asset properties</a> in the <i>IoT SiteWise User Guide</i>."
          }
        ]
      },
      "notification": {
        "allOf": [
          {
            "$ref": "#/components/schemas/PropertyNotification"
          },
          {
            "description": "The asset property's notification topic and state. For more information, see <a href=\"https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_UpdateAssetProperty.html\">UpdateAssetProperty</a>."
          }
        ]
      },
      "dataType": {
        "allOf": [
          {
            "$ref": "#/components/schemas/PropertyDataType"
          },
          {
            "description": "The data type of the asset property."
          }
        ]
      },
      "dataTypeSpec": {
        "allOf": [
          {
            "$ref": "#/components/schemas/Name"
          },
          {
            "description": "The data type of the structure for this property. This parameter exists on properties that have the <code>STRUCT</code> data type."
          }
        ]
      },
      "unit": {
        "allOf": [
          {
            "$ref": "#/components/schemas/PropertyUnit"
          },
          {
            "description": "The unit (such as <code>Newtons</code> or <code>RPM</code>) of the asset property."
          }
        ]
      }
    },
    "description": "Contains asset property information."
  }
}