Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

UpdateDynamicThingGroup

Updates a dynamic thing group.

Requires permission to access the UpdateDynamicThingGroup action.

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 uses 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:_-]+

Required: Yes

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.

message: The message for the exception.

HTTP Status Code: 500

InvalidQueryException

The query is invalid.

message: The message for the exception.

HTTP Status Code: 400

InvalidRequestException

The request is not valid.

message: The message for the exception.

HTTP Status Code: 400

ResourceNotFoundException

The specified resource does not exist.

message: The message for the exception.

HTTP Status Code: 404

ThrottlingException

The rate exceeds the limit.

message: The message for the exception.

HTTP Status Code: 400

VersionConflictException

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

message: The message for the exception.

HTTP Status Code: 409