CreateComponentTypeRequest

CreateComponentTypeRequest schema

3D VisualizationDigital TwinIndustrial IoTIoT

Properties

Name Type Description
isSingleton object
description object
propertyDefinitions object
extendsFrom object
functions object
tags object
propertyGroups object
componentTypeName object
View JSON Schema on GitHub

JSON Schema

iot-twinmaker-create-component-type-request-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-create-component-type-request-schema.json",
  "title": "CreateComponentTypeRequest",
  "description": "CreateComponentTypeRequest schema",
  "type": "object",
  "properties": {
    "isSingleton": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Boolean"
        },
        {
          "description": "A Boolean value that specifies whether an entity can have more than one component of this type."
        }
      ]
    },
    "description": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Description"
        },
        {
          "description": "The description of the component type."
        }
      ]
    },
    "propertyDefinitions": {
      "allOf": [
        {
          "$ref": "#/components/schemas/PropertyDefinitionsRequest"
        },
        {
          "description": "An object that maps strings to the property definitions in the component type. Each string in the mapping must be unique to this object."
        }
      ]
    },
    "extendsFrom": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ExtendsFrom"
        },
        {
          "description": "Specifies the parent component type to extend."
        }
      ]
    },
    "functions": {
      "allOf": [
        {
          "$ref": "#/components/schemas/FunctionsRequest"
        },
        {
          "description": "An object that maps strings to the functions in the component type. Each string in the mapping must be unique to this object."
        }
      ]
    },
    "tags": {
      "allOf": [
        {
          "$ref": "#/components/schemas/TagMap"
        },
        {
          "description": "Metadata that you can use to manage the component type."
        }
      ]
    },
    "propertyGroups": {
      "allOf": [
        {
          "$ref": "#/components/schemas/PropertyGroupsRequest"
        },
        {
          "description": "<p/>"
        }
      ]
    },
    "componentTypeName": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ComponentTypeName"
        },
        {
          "description": "A friendly name for the component type."
        }
      ]
    }
  }
}