Amazon IoT TwinMaker · JSON Structure

Iot Twinmaker Component Update Request Structure

The component update request.

Type: object Properties: 5
3D VisualizationDigital TwinIndustrial IoTIoT

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

Properties

updateType description componentTypeId propertyUpdates propertyGroupUpdates

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-twinmaker/refs/heads/main/json-structure/iot-twinmaker-component-update-request-structure.json",
  "name": "ComponentUpdateRequest",
  "description": "The component update request.",
  "type": "object",
  "properties": {
    "updateType": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ComponentUpdateType"
        },
        {
          "description": "The update type of the component update request."
        }
      ]
    },
    "description": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Description"
        },
        {
          "description": "The description of the component type."
        }
      ]
    },
    "componentTypeId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ComponentTypeId"
        },
        {
          "description": "The ID of the component type."
        }
      ]
    },
    "propertyUpdates": {
      "allOf": [
        {
          "$ref": "#/components/schemas/PropertyRequests"
        },
        {
          "description": "An object that maps strings to the properties to set in the component type update. Each string in the mapping must be unique to this object."
        }
      ]
    },
    "propertyGroupUpdates": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ComponentPropertyGroupRequests"
        },
        {
          "description": "The property group updates."
        }
      ]
    }
  }
}