Amazon IoT TwinMaker · JSON Structure

Iot Twinmaker Create Entity Request Structure

CreateEntityRequest schema

Type: object Properties: 6 Required: 1
3D VisualizationDigital TwinIndustrial IoTIoT

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

Properties

entityId entityName description components parentEntityId tags

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-create-entity-request-structure.json",
  "name": "CreateEntityRequest",
  "description": "CreateEntityRequest schema",
  "type": "object",
  "properties": {
    "entityId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/EntityId"
        },
        {
          "description": "The ID of the entity."
        }
      ]
    },
    "entityName": {
      "allOf": [
        {
          "$ref": "#/components/schemas/EntityName"
        },
        {
          "description": "The name of the entity."
        }
      ]
    },
    "description": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Description"
        },
        {
          "description": "The description of the entity."
        }
      ]
    },
    "components": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ComponentsMapRequest"
        },
        {
          "description": "An object that maps strings to the components in the entity. Each string in the mapping must be unique to this object."
        }
      ]
    },
    "parentEntityId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ParentEntityId"
        },
        {
          "description": "The ID of the entity's parent entity."
        }
      ]
    },
    "tags": {
      "allOf": [
        {
          "$ref": "#/components/schemas/TagMap"
        },
        {
          "description": "Metadata that you can use to manage the entity."
        }
      ]
    }
  },
  "required": [
    "entityName"
  ]
}