/thing-groups

The AWS IoT Wireless multi-region endpoint

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

GET

/thing-groups

List the thing groups in your account.

Requires permission to access the ListThingGroups 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

{
    "thingGroups": [],
    "nextToken": "string"
}

Request

Query Params

nextToken

string

optional

To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.

maxResults

integer

optional

The maximum number of results to return at one time.

parentGroup

string

optional

A filter that limits the results to those with the specified parent group.

namePrefixFilter

string

optional

A filter that limits the results to those with the specified name prefix.

recursive

string

optional

If true, return child groups as well.

Responses

🟢200Success

application/json

Body

thingGroups

array[object (GroupNameAndArn) {2}]

optional

The thing groups.

groupName

string

optional

The group name.

>= 1 characters<= 128 characters

Match pattern:

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

groupArn

string

optional

The group ARN.

nextToken

string

optional

The token to use to get the next set of results. Will not be returned if operation has returned all results.

<= 4096 characters

🟠480InvalidRequestException

🟠481InternalFailureException

🟠482ResourceNotFoundException

🟠483ThrottlingException

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

/security-profiles/{securityProfileName}/targets

/things/{thingName}/thing-groups