v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-142381,278956.3 KB

Describe a thing group.

Requires permission to access the DescribeThingGroup action.

get/thing-groups/{thingGroupName}

Path parameters

thingGroupNamestring required

The name of the thing group.

Response

Success

thingGroupNamestring

The name of the thing group.

thingGroupIdstring

The thing group ID.

thingGroupArnstring

The thing group ARN.

versioninteger

The version of the thing group.

indexNamestring

The dynamic thing group index name.

queryStringstring

The dynamic thing group search query string.

queryVersionstring

The dynamic thing group query version.

status'ACTIVE' | 'BUILDING' | 'REBUILDING'

The dynamic thing group status.