Amazon IoT Core · JSON Structure

Iot Core Describe Thing Group Response Structure

DescribeThingGroupResponse schema

Type: object Properties: 10

Device ManagementIoTMQTTMessage Routing

DescribeThingGroupResponse is a JSON Structure definition published by Amazon IoT Core, describing 10 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

thingGroupName thingGroupId thingGroupArn version thingGroupProperties thingGroupMetadata indexName queryString queryVersion status

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-iot-core/refs/heads/main/json-structure/iot-core-describe-thing-group-response-structure.json",
  "name": "DescribeThingGroupResponse",
  "description": "DescribeThingGroupResponse schema",
  "type": "object",
  "properties": {
    "thingGroupName": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ThingGroupName"
        },
        {
          "description": "The name of the thing group."
        }
      ]
    },
    "thingGroupId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ThingGroupId"
        },
        {
          "description": "The thing group ID."
        }
      ]
    },
    "thingGroupArn": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ThingGroupArn"
        },
        {
          "description": "The thing group ARN."
        }
      ]
    },
    "version": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Version"
        },
        {
          "description": "The version of the thing group."
        }
      ]
    },
    "thingGroupProperties": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ThingGroupProperties"
        },
        {
          "description": "The thing group properties."
        }
      ]
    },
    "thingGroupMetadata": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ThingGroupMetadata"
        },
        {
          "description": "Thing group metadata."
        }
      ]
    },
    "indexName": {
      "allOf": [
        {
          "$ref": "#/components/schemas/IndexName"
        },
        {
          "description": "The dynamic thing group index name."
        }
      ]
    },
    "queryString": {
      "allOf": [
        {
          "$ref": "#/components/schemas/QueryString"
        },
        {
          "description": "The dynamic thing group search query string."
        }
      ]
    },
    "queryVersion": {
      "allOf": [
        {
          "$ref": "#/components/schemas/QueryVersion"
        },
        {
          "description": "The dynamic thing group query version."
        }
      ]
    },
    "status": {
      "allOf": [
        {
          "$ref": "#/components/schemas/DynamicGroupStatus"
        },
        {
          "description": "The dynamic thing group status."
        }
      ]
    }
  }
}