Menu
AWS IoT
Developer Guide

DescribeThingGroup

Describe a thing group.

Request syntax:

GET /thing-groups/thingGroupName

URI Request Parameters:

Name

Type

Req?

Description

thingGroupName

ThingGroupName

yes

The name of the thing group.

Response syntax:

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

Response Body Parameters:

Name

Type

Req?

Description

thingGroupName

ThingGroupName

no

The name of the thing group.

thingGroupId

ThingGroupId

no

The thing group ID.

thingGroupArn

ThingGroupArn

no

The thing group ARN.

version

Version

no

The version of the thing group.

thingGroupProperties

ThingGroupProperties

no

The thing group properties.

thingGroupMetadata

ThingGroupMetadata

no

Thing group metadata.

Errors:

InvalidRequestException

The contents of the request were invalid. For example, this code is returned when an UpdateJobExecution request contains invalid status details. The message contains details about the error.

HTTP response code: 400

ThrottlingException

The rate exceeds the limit.

HTTP response code: 429

InternalFailureException

An unexpected error has occurred.

HTTP response code: 500

ResourceNotFoundException

The specified resource does not exist.

HTTP response code: 404

CLI

Synopsis:

aws iot describe-thing-group \ --thing-group-name <value> \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

cli-input-json format:

{ "thingGroupName": "string" }

cli-input-json fields:

Name

Type

Description

thingGroupName

string

length max:128 min:1

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

The name of the thing group.

Output:

{ "thingGroupName": "string", "thingGroupId": "string", "thingGroupArn": "string", "version": "long", "thingGroupProperties": { "thingGroupDescription": "string", "attributePayload": { "attributes": { "string": "string" }, "merge": "boolean" } }, "thingGroupMetadata": { "parentGroupName": "string", "rootToParentThingGroups": [ { "groupName": "string", "groupArn": "string" } ], "creationDate": "timestamp" } }

cli output fields:

Name

Type

Description

thingGroupName

string

length max:128 min:1

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

The name of the thing group.

thingGroupId

string

length max:128 min:1

pattern: [a-zA-Z0-9-]+

The thing group ID.

thingGroupArn

string

The thing group ARN.

version

long

The version of the thing group.

thingGroupProperties

ThingGroupProperties

The thing group properties.

thingGroupDescription

string

length max:2028

pattern: [\\p{Graph} ]*

The thing group description.

attributePayload

AttributePayload

The thing group attributes in JSON format.

attributes

map

key: AttributeName

value: AttributeValue

A JSON string containing up to three key-value pair in JSON format. For example:

\"attributes\":{\"string1\":\"string2\"}

AttributeName

string

length max:128

pattern: [a-zA-Z0-9_.,@/:#-]+

AttributeValue

string

length max:800

pattern: [a-zA-Z0-9_.,@/:#-]*

merge

boolean

Specifies whether the list of attributes provided in the AttributePayload is merged with the attributes stored in the registry, instead of overwriting them.

To remove an attribute, call UpdateThing with an empty attribute value.

Note

The merge attribute is only valid when calling UpdateThing.

thingGroupMetadata

ThingGroupMetadata

Thing group metadata.

parentGroupName

string

length max:128 min:1

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

The parent thing group name.

rootToParentThingGroups

list

member: GroupNameAndArn

java class: java.util.List

The root parent thing group.

GroupNameAndArn

GroupNameAndArn

groupName

string

length max:128 min:1

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

The group name.

groupArn

string

The group ARN.

creationDate

timestamp

The UNIX timestamp of when the thing group was created.

On this page: