Menu
AWS IoT
API Reference

DescribeThingGroup

Describe a thing group.

Request Syntax

GET /thing-groups/thingGroupName HTTP/1.1

URI Request Parameters

The request requires the following URI parameters.

thingGroupName

The name of the thing group.

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: [a-zA-Z0-9:_-]+

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200 Content-type: application/json { "thingGroupArn": "string", "thingGroupId": "string", "thingGroupMetadata": { "creationDate": number, "parentGroupName": "string", "rootToParentThingGroups": [ { "groupArn": "string", "groupName": "string" } ] }, "thingGroupName": "string", "thingGroupProperties": { "attributePayload": { "attributes": { "string" : "string" }, "merge": boolean }, "thingGroupDescription": "string" }, "version": number }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

thingGroupArn

The thing group ARN.

Type: String

thingGroupId

The thing group ID.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: [a-zA-Z0-9\-]+

thingGroupMetadata

Thing group metadata.

Type: ThingGroupMetadata object

thingGroupName

The name of the thing group.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: [a-zA-Z0-9:_-]+

thingGroupProperties

The thing group properties.

Type: ThingGroupProperties object

version

The version of the thing group.

Type: Long

Errors

InternalFailureException

An unexpected error has occurred.

HTTP Status Code: 500

InvalidRequestException

The request is not valid.

HTTP Status Code: 400

ResourceNotFoundException

The specified resource does not exist.

HTTP Status Code: 404

ThrottlingException

The rate exceeds the limit.

HTTP Status Code: 429

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: