Amazon IoT Device Management · JSON Structure

Iot Device Management Attribute Payload Structure

The attribute payload.

Type: object Properties: 2
Device ManagementFleet ManagementIoTOTA Updates

AttributePayload is a JSON Structure definition published by Amazon IoT Device Management, describing 2 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

attributes merge

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-device-management/refs/heads/main/json-structure/iot-device-management-attribute-payload-structure.json",
  "name": "AttributePayload",
  "description": "The attribute payload.",
  "type": "object",
  "properties": {
    "attributes": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Attributes"
        },
        {
          "description": "<p>A JSON string containing up to three key-value pair in JSON format. For example:</p> <p> <code>{\\\"attributes\\\":{\\\"string1\\\":\\\"string2\\\"}}</code> </p>"
        }
      ]
    },
    "merge": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Flag"
        },
        {
          "description": "<p>Specifies whether the list of attributes provided in the <code>AttributePayload</code> is merged with the attributes stored in the registry, instead of overwriting them.</p> <p>To remove an attribute, call <code>UpdateThing</code> with an empty attribute value.</p> <note> <p>The <code>merge</code> attribute is only valid when calling <code>UpdateThing</code> or <code>UpdateThingGroup</code>.</p> </note>"
        }
      ]
    }
  }
}