PropertyValue

An object that contains information about a value for a time series property.

3D VisualizationDigital TwinIndustrial IoTIoT

Properties

Name Type Description
timestamp object
value object
time object
View JSON Schema on GitHub

JSON Schema

iot-twinmaker-property-value-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-iot-twinmaker/refs/heads/main/json-schema/iot-twinmaker-property-value-schema.json",
  "title": "PropertyValue",
  "description": "An object that contains information about a value for a time series property.",
  "type": "object",
  "properties": {
    "timestamp": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Timestamp"
        },
        {
          "deprecated": true,
          "description": "The timestamp of a value for a time series property.This field is deprecated and will throw an error in the future. Use time instead."
        }
      ]
    },
    "value": {
      "allOf": [
        {
          "$ref": "#/components/schemas/DataValue"
        },
        {
          "description": "An object that specifies a value for a time series property."
        }
      ]
    },
    "time": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Time"
        },
        {
          "description": "<p>ISO8601 DateTime of a value for a time series property.</p> <p>The time for when the property value was recorded in ISO 8601 format: <i>YYYY-MM-DDThh:mm:ss[.SSSSSSSSS][Z/\u00b1HH:mm]</i>.</p> <ul> <li> <p> <i>[YYYY]</i>: year</p> </li> <li> <p> <i>[MM]</i>: month</p> </li> <li> <p> <i>[DD]</i>: day</p> </li> <li> <p> <i>[hh]</i>: hour</p> </li> <li> <p> <i>[mm]</i>: minute</p> </li> <li> <p> <i>[ss]</i>: seconds</p> </li> <li> <p> <i>[.SSSSSSSSS]</i>: additional precision, where precedence is maintained. For example: [.573123] is equal to 573123000 nanoseconds.</p> </li> <li> <p> <i>Z</i>: default timezone UTC</p> </li> <li> <p> <i>\u00b1 HH:mm</i>: time zone offset in Hours and Minutes.</p> </li> </ul> <p> <i>Required sub-fields</i>: YYYY-MM-DDThh:mm:ss and [Z/\u00b1HH:mm]</p>"
        }
      ]
    }
  },
  "required": [
    "value"
  ]
}