Amazon IoT TwinMaker · JSON Structure

Iot Twinmaker Update Entity Request Structure

UpdateEntityRequest schema

Type: object Properties: 4
3D VisualizationDigital TwinIndustrial IoTIoT

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

Properties

entityName description componentUpdates parentEntityUpdate

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-update-entity-request-structure.json",
  "name": "UpdateEntityRequest",
  "description": "UpdateEntityRequest schema",
  "type": "object",
  "properties": {
    "entityName": {
      "allOf": [
        {
          "$ref": "#/components/schemas/EntityName"
        },
        {
          "description": "The name of the entity."
        }
      ]
    },
    "description": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Description"
        },
        {
          "description": "The description of the entity."
        }
      ]
    },
    "componentUpdates": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ComponentUpdatesMapRequest"
        },
        {
          "description": "An object that maps strings to the component updates in the request. Each string in the mapping must be unique to this object."
        }
      ]
    },
    "parentEntityUpdate": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ParentEntityUpdateRequest"
        },
        {
          "description": "An object that describes the update request for a parent entity."
        }
      ]
    }
  }
}