/thing-groups/{thingGroupName}

The AWS IoT Wireless multi-region endpoint

https://api.iotwireless.{region}.amazonaws.com

GET

Describe a thing group.

Requires permission to access the DescribeThingGroup action.

Request Example

Shell

JavaScript

Java

Swift

curl --location -g --request GET 'https://api.iotwireless.{region}.amazonaws.com/thing-groups/'

Response Example

200 - Example 1

{
    "thingGroupName": "string",
    "thingGroupId": "string",
    "thingGroupArn": "string",
    "version": 0,
    "thingGroupProperties": {
        "thingGroupDescription": "string",
        "attributePayload": {
            "attributes": {
                "property1": "string",
                "property2": "string"
            },
            "merge": true
        }
    },
    "thingGroupMetadata": {
        "parentGroupName": "string",
        "rootToParentThingGroups": [],
        "creationDate": "string"
    },
    "indexName": "string",
    "queryString": "string",
    "queryVersion": "string",
    "status": "ACTIVE"
}

Request

Path Params

thingGroupName

string

required

The name of the thing group.

Responses

🟢200Success

application/json

Body

thingGroupName

string

optional

The name of the thing group.

>= 1 characters<= 128 characters

Match pattern:

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

thingGroupId

string

optional

The thing group ID.

>= 1 characters<= 128 characters

Match pattern:

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

thingGroupArn

string

optional

The thing group ARN.

version

integer

optional

The version of the thing group.

thingGroupProperties

object

optional

The thing group properties.

thingGroupDescription

string

optional

The thing group description.

<= 2028 characters

Match pattern:

[\p{Graph}\x20]*

attributePayload

object

optional

The thing group attributes in JSON format.

thingGroupMetadata

object

optional

Thing group metadata.

parentGroupName

string

optional

The parent thing group name.

>= 1 characters<= 128 characters

Match pattern:

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

rootToParentThingGroups

array[object (GroupNameAndArn) {2}]

optional

The root parent thing group.

creationDate

string <date-time>

optional

The UNIX timestamp of when the thing group was created.

indexName

string

optional

The dynamic thing group index name.

>= 1 characters<= 128 characters

Match pattern:

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

queryString

string

optional

The dynamic thing group search query string.

>= 1 characters

queryVersion

string

optional

The dynamic thing group query version.

status

enum<string>

optional

The dynamic thing group status.

Allowed values:

ACTIVEBUILDINGREBUILDING

🟠480InvalidRequestException

🟠481ThrottlingException

🟠482InternalFailureException

🟠483ResourceNotFoundException

Modified at 2022-09-10 23:12:15

/thing-groups/{thingGroupName}