[ aws . iot ]



Update a thing group.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.


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


--thing-group-name (string)

The thing group to update.

--thing-group-properties (structure)

The thing group properties.

Shorthand Syntax:


JSON Syntax:

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

--expected-version (long)

The expected version of the thing group. If this does not match the version of the thing group being updated, the update will fail.

--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 update the definition for a thing group

The following update-thing-group example updates the definition for the specified thing group, changing the description and two attributes.

aws iot update-thing-group \
    --thing-group-name HalogenBulbs \
    --thing-group-properties "thingGroupDescription=\"Halogen bulb group\", attributePayload={attributes={Manufacturer=AnyCompany,wattage=60}}"


    "version": 2

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


version -> (long)

The version of the updated thing group.