ComponentResponse

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

3D VisualizationDigital TwinIndustrial IoTIoT

Properties

Name Type Description
componentName object
description object
componentTypeId object
status object
definedIn object
properties object 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 object
syncSource object
View JSON Schema on GitHub

JSON Schema

iot-twinmaker-component-response-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-iot-twinmaker/refs/heads/main/json-schema/iot-twinmaker-component-response-schema.json",
  "title": "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."
        }
      ]
    }
  }
}