Amazon IoT TwinMaker · JSON Structure

Iot Twinmaker Get Property Value Request Structure

GetPropertyValueRequest schema

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

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

Properties

componentName componentTypeId entityId selectedProperties maxResults nextToken propertyGroupName tabularConditions

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-get-property-value-request-structure.json",
  "name": "GetPropertyValueRequest",
  "description": "GetPropertyValueRequest schema",
  "type": "object",
  "properties": {
    "componentName": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Name"
        },
        {
          "description": "The name of the component whose property values the operation returns."
        }
      ]
    },
    "componentTypeId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ComponentTypeId"
        },
        {
          "description": "The ID of the component type whose property values the operation returns."
        }
      ]
    },
    "entityId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/EntityId"
        },
        {
          "description": "The ID of the entity whose property values the operation returns."
        }
      ]
    },
    "selectedProperties": {
      "allOf": [
        {
          "$ref": "#/components/schemas/SelectedPropertyList"
        },
        {
          "description": "The properties whose values the operation returns."
        }
      ]
    },
    "maxResults": {
      "allOf": [
        {
          "$ref": "#/components/schemas/MaxResults"
        },
        {
          "description": "<p>The maximum number of results to return at one time. The default is 25.</p> <p>Valid Range: Minimum value of 1. Maximum value of 250.</p>"
        }
      ]
    },
    "nextToken": {
      "allOf": [
        {
          "$ref": "#/components/schemas/NextToken"
        },
        {
          "description": "The string that specifies the next page of results."
        }
      ]
    },
    "propertyGroupName": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Name"
        },
        {
          "description": "The property group name."
        }
      ]
    },
    "tabularConditions": {
      "allOf": [
        {
          "$ref": "#/components/schemas/TabularConditions"
        },
        {
          "description": "The tabular conditions."
        }
      ]
    }
  },
  "required": [
    "selectedProperties"
  ]
}