Amazon IoT SiteWise · JSON Structure

Iot Sitewise Property Notification Structure

Contains asset property value notification information. When the notification state is enabled, IoT SiteWise publishes property value updates to a unique MQTT topic. For more information, see Interacting with other services in the IoT SiteWise User Guide.

Type: object Properties: 2 Required: 2
Asset ManagementIndustrial IoTIoTTime Series Data

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

Properties

topic state

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-property-notification-structure.json",
  "name": "PropertyNotification",
  "description": "Contains asset property value notification information. When the notification state is enabled, IoT SiteWise publishes property value updates to a unique MQTT topic. For more information, see <a href=\"https://docs.aws.amazon.com/iot-sitewise/latest/userguide/interact-with-other-services.html\">Interacting with other services</a> in the <i>IoT SiteWise User Guide</i>.",
  "type": "object",
  "properties": {
    "topic": {
      "allOf": [
        {
          "$ref": "#/components/schemas/PropertyNotificationTopic"
        },
        {
          "description": "The MQTT topic to which IoT SiteWise publishes property value update notifications."
        }
      ]
    },
    "state": {
      "allOf": [
        {
          "$ref": "#/components/schemas/PropertyNotificationState"
        },
        {
          "description": "The current notification state."
        }
      ]
    }
  },
  "required": [
    "topic",
    "state"
  ]
}