Amazon IoT SiteWise · JSON Structure

Iot Sitewise Asset Model Property Definition Structure

Contains an asset model property definition. This property definition is applied to all assets created from the asset model.

Type: object Properties: 5 Required: 3
Asset ManagementIndustrial IoTIoTTime Series Data

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

Properties

name dataType dataTypeSpec unit type

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-model-property-definition-structure.json",
  "name": "AssetModelPropertyDefinition",
  "description": "Contains an asset model property definition. This property definition is applied to all assets created from the asset model.",
  "type": "object",
  "properties": {
    "name": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Name"
        },
        {
          "description": "The name of the property definition."
        }
      ]
    },
    "dataType": {
      "allOf": [
        {
          "$ref": "#/components/schemas/PropertyDataType"
        },
        {
          "description": "<p>The data type of the property definition.</p> <p>If you specify <code>STRUCT</code>, you must also specify <code>dataTypeSpec</code> to identify the type of the structure for this property.</p>"
        }
      ]
    },
    "dataTypeSpec": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Name"
        },
        {
          "description": "<p>The data type of the structure for this property. This parameter is required on properties that have the <code>STRUCT</code> data type.</p> <p>The options for this parameter depend on the type of the composite model in which you define this property. Use <code>AWS/ALARM_STATE</code> for alarm state in alarm composite models.</p>"
        }
      ]
    },
    "unit": {
      "allOf": [
        {
          "$ref": "#/components/schemas/PropertyUnit"
        },
        {
          "description": "The unit of the property definition, such as <code>Newtons</code> or <code>RPM</code>."
        }
      ]
    },
    "type": {
      "allOf": [
        {
          "$ref": "#/components/schemas/PropertyType"
        },
        {
          "description": "The property definition type (see <code>PropertyType</code>). You can only specify one type in a property definition."
        }
      ]
    }
  },
  "required": [
    "name",
    "dataType",
    "type"
  ]
}