AWS IoT
API Reference

CreateDynamicThingGroup

Creates a dynamic thing group.

Request Syntax

POST /dynamic-thing-groups/thingGroupName HTTP/1.1 Content-type: application/json { "indexName": "string", "queryString": "string", "queryVersion": "string", "tags": [ { "Key": "string", "Value": "string" } ], "thingGroupProperties": { "attributePayload": { "attributes": { "string" : "string" }, "merge": boolean }, "thingGroupDescription": "string" } }

URI Request Parameters

The request requires the following URI parameters.

thingGroupName

The dynamic 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.

indexName

The dynamic thing group index name.

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.

See Query Syntax for information about query string syntax.

Type: String

Length Constraints: Minimum length of 1.

Required: Yes

queryVersion

The dynamic thing group query version.

Note

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

Type: String

Required: No

tags

Metadata which can be used to manage the dynamic thing group.

Type: Array of Tag objects

Required: No

thingGroupProperties

The dynamic thing group properties.

Type: ThingGroupProperties object

Required: No

Response Syntax

HTTP/1.1 200 Content-type: application/json { "indexName": "string", "queryString": "string", "queryVersion": "string", "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.

indexName

The dynamic thing group index name.

Type: String

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

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

queryString

The dynamic thing group search query string.

Type: String

Length Constraints: Minimum length of 1.

queryVersion

The dynamic thing group query version.

Type: String

thingGroupArn

The dynamic thing group ARN.

Type: String

thingGroupId

The dynamic thing group ID.

Type: String

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

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

thingGroupName

The dynamic 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

InvalidQueryException

The query is invalid.

HTTP Status Code: 400

InvalidRequestException

The request is not valid.

HTTP Status Code: 400

LimitExceededException

A limit has been exceeded.

HTTP Status Code: 410

ResourceAlreadyExistsException

The resource already exists.

HTTP Status Code: 409

ResourceNotFoundException

The specified resource does not exist.

HTTP Status Code: 404

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: