/dynamic-thing-groups/{thingGroupName}

The AWS IoT Wireless multi-region endpoint

https://api.iotwireless.{region}.amazonaws.com

POST

/dynamic-thing-groups/{thingGroupName}

Creates a dynamic thing group.

Requires permission to access the CreateDynamicThingGroup action.

Request Example

Shell

JavaScript

Java

Swift

curl --location -g --request POST 'https://api.iotwireless.{region}.amazonaws.com/dynamic-thing-groups/' \
--header 'Content-Type: application/json' \
--data-raw '{
    "thingGroupProperties": {
        "thingGroupDescription": "string",
        "attributePayload": {
            "attributes": {
                "property1": "string",
                "property2": "string"
            },
            "merge": true
        }
    },
    "indexName": "string",
    "queryString": "string",
    "queryVersion": "string",
    "tags": [
        {
            "Key": "string",
            "Value": "string"
        }
    ]
}'

Response Example

200 - Example 1

{
    "thingGroupName": "string",
    "thingGroupArn": "string",
    "thingGroupId": "string",
    "indexName": "string",
    "queryString": "string",
    "queryVersion": "string"
}

Request

Path Params

thingGroupName

string

required

The dynamic thing group name to create.

Body Params application/json

thingGroupProperties

object

optional

Thing group properties.

thingGroupDescription

string

optional

The thing group description.

<= 2028 characters

Match pattern:

[\p{Graph}\x20]*

attributePayload

object

optional

The thing group attributes in JSON format.

indexName

string

optional

The dynamic thing group index name.

>= 1 characters<= 128 characters

Match pattern:

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

queryString

string

required

The dynamic thing group search query string.

See Query Syntax for information about query string syntax.

>= 1 characters

queryVersion

string

optional

The dynamic thing group query version.

tags

array[object (Tag) {2}]

optional

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

Key

string

required

The tag's key value.

>= 1 characters<= 128 characters

Value

string

required

The tag's value.

>= 0 characters<= 256 characters

Examples

Responses

🟢200Success

application/json

Body

thingGroupName

string

optional

The dynamic thing group name.

>= 1 characters<= 128 characters

Match pattern:

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

thingGroupArn

string

optional

The dynamic thing group ARN.

thingGroupId

string

optional

The dynamic thing group ID.

>= 1 characters<= 128 characters

Match pattern:

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

indexName

string

optional

The dynamic thing group index name.

>= 1 characters<= 128 characters

Match pattern:

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

queryString

string

optional

The dynamic thing group search query string.

>= 1 characters

queryVersion

string

optional

The dynamic thing group query version.

🟠480InvalidRequestException

🟠481ResourceAlreadyExistsException

🟠482ResourceNotFoundException

🟠483ThrottlingException

🟠484InternalFailureException

🟠485InvalidQueryException

🟠486LimitExceededException

Modified at 2022-09-10 23:12:13

/log-levels/{ResourceIdentifier}

/service-endpoint