Amazon IoT TwinMaker · JSON Structure

Iot Twinmaker Property Definition Response Structure

An object that contains response data from a property definition request.

Type: object Properties: 11 Required: 8
3D VisualizationDigital TwinIndustrial IoTIoT

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

Properties

dataType isTimeSeries isRequiredInEntity isExternalId isStoredExternally isImported isFinal isInherited defaultValue configuration displayName

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-property-definition-response-structure.json",
  "name": "PropertyDefinitionResponse",
  "description": "An object that contains response data from a property definition request.",
  "type": "object",
  "properties": {
    "dataType": {
      "allOf": [
        {
          "$ref": "#/components/schemas/DataType"
        },
        {
          "description": "An object that contains information about the data type."
        }
      ]
    },
    "isTimeSeries": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Boolean"
        },
        {
          "description": "A Boolean value that specifies whether the property consists of time series data."
        }
      ]
    },
    "isRequiredInEntity": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Boolean"
        },
        {
          "description": "A Boolean value that specifies whether the property is required in an entity."
        }
      ]
    },
    "isExternalId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Boolean"
        },
        {
          "description": "A Boolean value that specifies whether the property ID comes from an external data store."
        }
      ]
    },
    "isStoredExternally": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Boolean"
        },
        {
          "description": "A Boolean value that specifies whether the property is stored externally."
        }
      ]
    },
    "isImported": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Boolean"
        },
        {
          "description": "A Boolean value that specifies whether the property definition is imported from an external data store."
        }
      ]
    },
    "isFinal": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Boolean"
        },
        {
          "description": "A Boolean value that specifies whether the property definition can be updated."
        }
      ]
    },
    "isInherited": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Boolean"
        },
        {
          "description": "A Boolean value that specifies whether the property definition is inherited from a parent entity."
        }
      ]
    },
    "defaultValue": {
      "allOf": [
        {
          "$ref": "#/components/schemas/DataValue"
        },
        {
          "description": "An object that contains the default value."
        }
      ]
    },
    "configuration": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Configuration"
        },
        {
          "description": "A mapping that specifies configuration information about the property."
        }
      ]
    },
    "displayName": {
      "allOf": [
        {
          "$ref": "#/components/schemas/PropertyDisplayName"
        },
        {
          "description": "A friendly name for the property."
        }
      ]
    }
  },
  "required": [
    "dataType",
    "isTimeSeries",
    "isRequiredInEntity",
    "isExternalId",
    "isStoredExternally",
    "isImported",
    "isFinal",
    "isInherited"
  ]
}