Amazon IoT TwinMaker · JSON Structure

Iot Twinmaker Component Response Structure

An object that returns information about a component type create or update request.

Type: object Properties: 8
3D VisualizationDigital TwinIndustrial IoTIoT

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

Properties

componentName description componentTypeId status definedIn properties propertyGroups syncSource

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-response-structure.json",
  "name": "ComponentResponse",
  "description": "An object that returns information about a component type create or update request.",
  "type": "object",
  "properties": {
    "componentName": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Name"
        },
        {
          "description": "The name of the component."
        }
      ]
    },
    "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."
        }
      ]
    },
    "status": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Status"
        },
        {
          "description": "The status of the component type."
        }
      ]
    },
    "definedIn": {
      "allOf": [
        {
          "$ref": "#/components/schemas/String"
        },
        {
          "description": "The name of the property definition set in the request."
        }
      ]
    },
    "properties": {
      "description": "An object that maps strings to the properties to set in the component type. Each string in the mapping must be unique to this object."
    },
    "propertyGroups": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ComponentPropertyGroupResponses"
        },
        {
          "description": "The property groups."
        }
      ]
    },
    "syncSource": {
      "allOf": [
        {
          "$ref": "#/components/schemas/SyncSource"
        },
        {
          "description": "The syncSource of the sync job, if this entity was created by a sync job."
        }
      ]
    }
  }
}