/thing-groups/{thingGroupName}

The AWS IoT Wireless multi-region endpoint

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

POST

Create a thing group.

Requires permission to access the CreateThingGroup action.

Request Example

Shell

JavaScript

Java

Swift

curl --location -g --request POST 'https://api.iotwireless.{region}.amazonaws.com/thing-groups/' \
--header 'Content-Type: application/json' \
--data-raw '{
    "parentGroupName": "string",
    "thingGroupProperties": {
        "thingGroupDescription": "string",
        "attributePayload": {
            "attributes": {
                "property1": "string",
                "property2": "string"
            },
            "merge": true
        }
    },
    "tags": [
        {
            "Key": "string",
            "Value": "string"
        }
    ]
}'

Response Example

200 - Example 1

{
    "thingGroupName": "string",
    "thingGroupArn": "string",
    "thingGroupId": "string"
}

Request

Path Params

thingGroupName

string

required

The thing group name to create.

Body Params application/json

parentGroupName

string

optional

The name of the parent thing group.

>= 1 characters<= 128 characters

Match pattern:

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

thingGroupProperties

object

optional

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.

Responses

🟢200Success

application/json

Body

thingGroupName

string

optional

The thing group name.

>= 1 characters<= 128 characters

Match pattern:

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

thingGroupArn

string

optional

The thing group ARN.

thingGroupId

string

optional

The thing group ID.

>= 1 characters<= 128 characters

Match pattern:

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

🟠480InvalidRequestException

🟠481ResourceAlreadyExistsException

🟠482ThrottlingException

🟠483InternalFailureException

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

/things/{thingName}

/thing-groups/{thingGroupName}