Menu
AWS IoT
API Reference

CreateThingGroup

Create a thing group.

Request Syntax

POST /thing-groups/thingGroupName HTTP/1.1
Content-type: application/json

{
   "parentGroupName": "string",
   "thingGroupProperties": { 
      "attributePayload": { 
         "attributes": { 
            "string" : "string" 
         },
         "merge": boolean
      },
      "thingGroupDescription": "string"
   }
}

URI Request Parameters

The request requires the following URI parameters.

thingGroupName

The thing group name to create.

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

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

Request Body

The request accepts the following data in JSON format.

parentGroupName

The name of the parent thing group.

Type: String

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

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

Required: No

thingGroupProperties

The thing group properties.

Type: ThingGroupProperties object

Required: No

Response Syntax

HTTP/1.1 200
Content-type: application/json

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

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\-]+

thingGroupName

The thing group name.

Type: String

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

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

Errors

InternalFailureException

An unexpected error has occurred.

HTTP Status Code: 500

InvalidRequestException

The request is not valid.

HTTP Status Code: 400

ResourceAlreadyExistsException

The resource already exists.

HTTP Status Code: 409

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: