Amazon IoT TwinMaker · JSON Structure

Iot Twinmaker Component Type Summary Structure

An object that contains information about a component type.

Type: object Properties: 7 Required: 4
3D VisualizationDigital TwinIndustrial IoTIoT

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

Properties

arn componentTypeId creationDateTime updateDateTime description status componentTypeName

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-type-summary-structure.json",
  "name": "ComponentTypeSummary",
  "description": "An object that contains information about a component type.",
  "type": "object",
  "properties": {
    "arn": {
      "allOf": [
        {
          "$ref": "#/components/schemas/TwinMakerArn"
        },
        {
          "description": "The ARN of the component type."
        }
      ]
    },
    "componentTypeId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ComponentTypeId"
        },
        {
          "description": "The ID of the component type."
        }
      ]
    },
    "creationDateTime": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Timestamp"
        },
        {
          "description": "The date and time when the component type was created."
        }
      ]
    },
    "updateDateTime": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Timestamp"
        },
        {
          "description": "The date and time when the component type was last updated."
        }
      ]
    },
    "description": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Description"
        },
        {
          "description": "The description of the component type."
        }
      ]
    },
    "status": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Status"
        },
        {
          "description": "The current status of the component type."
        }
      ]
    },
    "componentTypeName": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ComponentTypeName"
        },
        {
          "description": "The component type name."
        }
      ]
    }
  },
  "required": [
    "arn",
    "componentTypeId",
    "creationDateTime",
    "updateDateTime"
  ]
}