UpdateThingGroup - Amazon IoT
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).


Update a thing group.

Requires permission to access the UpdateThingGroup action.

Request Syntax

PATCH /thing-groups/thingGroupName HTTP/1.1 Content-type: application/json { "expectedVersion": number, "thingGroupProperties": { "attributePayload": { "attributes": { "string" : "string" }, "merge": boolean }, "thingGroupDescription": "string" } }

URI Request Parameters

The request uses the following URI parameters.


The thing group to update.

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

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

Required: Yes

Request Body

The request accepts the following data in JSON format.


The expected version of the thing group. If this does not match the version of the thing group being updated, the update will fail.

Type: Long

Required: No


The thing group properties.

Type: ThingGroupProperties object

Required: Yes

Response Syntax

HTTP/1.1 200 Content-type: application/json { "version": number }

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.


The version of the updated thing group.

Type: Long



An unexpected error has occurred.

HTTP Status Code: 500


The request is not valid.

HTTP Status Code: 400


The specified resource does not exist.

HTTP Status Code: 404


The rate exceeds the limit.

HTTP Status Code: 400


An exception thrown when the version of an entity specified with the expectedVersion parameter does not match the latest version in the system.

HTTP Status Code: 409

See Also

For more information about using this API in one of the language-specific Amazon SDKs, see the following: