AWS IoT
API Reference

The AWS Documentation website is getting a new look!
Try it now and let us know what you think. Switch to the new look >>

You can return to the original look by selecting English in the language selector above.

UpdateDynamicThingGroup

Updates a dynamic thing group.

Request Syntax

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

URI Request Parameters

The request requires the following URI parameters.

thingGroupName

The name of the dynamic 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 dynamic thing group to update.

Type: Long

Required: No

indexName

The dynamic thing group index to update.

Note

Currently one index is supported: 'AWS_Things'.

Type: String

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

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

Required: No

queryString

The dynamic thing group search query string to update.

Type: String

Length Constraints: Minimum length of 1.

Required: No

queryVersion

The dynamic thing group query version to update.

Note

Currently one query version is supported: "2017-09-30". If not specified, the query version defaults to this value.

Type: String

Required: No

thingGroupProperties

The dynamic thing group properties to update.

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 dynamic thing group version.

Type: Long

Errors

InternalFailureException

An unexpected error has occurred.

HTTP Status Code: 500

InvalidQueryException

The query is invalid.

HTTP Status Code: 400

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 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 AWS SDKs, see the following: