[ aws . iot ]



Creates a dynamic thing group.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.


--thing-group-name <value>
[--thing-group-properties <value>]
[--index-name <value>]
--query-string <value>
[--query-version <value>]
[--tags <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--cli-auto-prompt <value>]


--thing-group-name (string)

The dynamic thing group name to create.

--thing-group-properties (structure)

The dynamic thing group properties.

thingGroupDescription -> (string)

The thing group description.

attributePayload -> (structure)

The thing group attributes in JSON format.

attributes -> (map)

A JSON string containing up to three key-value pair in JSON format. For example:


key -> (string)

value -> (string)

merge -> (boolean)

Specifies whether the list of attributes provided in the AttributePayload is merged with the attributes stored in the registry, instead of overwriting them.

To remove an attribute, call UpdateThing with an empty attribute value.


The merge attribute is only valid when calling UpdateThing or UpdateThingGroup .

Shorthand Syntax:


JSON Syntax:

  "thingGroupDescription": "string",
  "attributePayload": {
    "attributes": {"string": "string"
    "merge": true|false

--index-name (string)

The dynamic thing group index name.


Currently one index is supported: “AWS_Things”.

--query-string (string)

The dynamic thing group search query string.

See Query Syntax for information about query string syntax.

--query-version (string)

The dynamic thing group query version.


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

--tags (list)

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


A set of key/value pairs that are used to manage the resource.

Key -> (string)

The tag’s key.

Value -> (string)

The tag’s value.

Shorthand Syntax:

Key=string,Value=string ...

JSON Syntax:

    "Key": "string",
    "Value": "string"

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

--cli-auto-prompt (boolean) Automatically prompt for CLI input parameters.

See ‘aws help’ for descriptions of global parameters.


To create a dynamic thing group

The following create-dynamic-thing-group example creates a dynamic thing group that contains any thing with a temperature attribute that is greater than 60 degrees. You must enable AWS IoT fleet indexing before you can use dynamic thing groups.

aws iot create-dynamic-thing-group \
    --thing-group-name "RoomTooWarm" \
    --query-string "attributes.temperature>60"


    "thingGroupName": "RoomTooWarm",
    "thingGroupArn": "arn:aws:iot:us-west-2:123456789012:thinggroup/RoomTooWarm",
    "thingGroupId": "9d52492a-fc87-43f4-b6e2-e571d2ffcad1",
    "indexName": "AWS_Things",
    "queryString": "attributes.temperature>60",
    "queryVersion": "2017-09-30"

For more information, see Dynamic Thing Groups in the AWS IoT Developers Guide.


thingGroupName -> (string)

The dynamic thing group name.

thingGroupArn -> (string)

The dynamic thing group ARN.

thingGroupId -> (string)

The dynamic thing group ID.

indexName -> (string)

The dynamic thing group index name.

queryString -> (string)

The dynamic thing group search query string.

queryVersion -> (string)

The dynamic thing group query version.