Menu
AWS IoT
API Reference

UpdateThingGroup

Update a thing group.

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 requires the following URI parameters.

thingGroupName

The thing group to update.

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.

expectedVersion

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

thingGroupProperties

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.

version

The version of the updated thing group.

Type: Long

Errors

InternalFailureException

An unexpected error has occurred.

HTTP Status Code: 500

InvalidRequestException

The request is not valid.

HTTP Status Code: 400

ResourceNotFoundException

The specified resource does not exist.

HTTP Status Code: 404

ThrottlingException

The rate exceeds the limit.

HTTP Status Code: 429

VersionConflictException

An exception thrown when the version of a thing passed to a command is different than the version specified with the --version parameter.

HTTP Status Code: 409

See Also

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