Status

An object that represents the status of an entity, component, component type, or workspace.

3D VisualizationDigital TwinIndustrial IoTIoT

Properties

Name Type Description
state object
error object
View JSON Schema on GitHub

JSON Schema

iot-twinmaker-status-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-status-schema.json",
  "title": "Status",
  "description": "An object that represents the status of an entity, component, component type, or workspace.",
  "type": "object",
  "properties": {
    "state": {
      "allOf": [
        {
          "$ref": "#/components/schemas/State"
        },
        {
          "description": "The current state of the entity, component, component type, or workspace."
        }
      ]
    },
    "error": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ErrorDetails"
        },
        {
          "description": "The error message."
        }
      ]
    }
  }
}