[ aws . iot ]

create-thing-group

Description

Create a thing group.

Note

This is a control plane operation. See Authorization for information about authorizing control plane actions.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  create-thing-group
--thing-group-name <value>
[--parent-group-name <value>]
[--thing-group-properties <value>]
[--tags <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--cli-auto-prompt <value>]

Options

--thing-group-name (string)

The thing group name to create.

--parent-group-name (string)

The name of the parent thing group.

--thing-group-properties (structure)

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

{\"attributes\":{\"string1\":\"string2\"}}

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.

Note

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

Shorthand Syntax:

thingGroupDescription=string,attributePayload={attributes={KeyName1=string,KeyName2=string},merge=boolean}

JSON Syntax:

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

--tags (list)

Metadata which can be used to manage the thing group.

(structure)

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.

Examples

Example 1: To create a thing group

The following create-thing-group example creates a thing group named LightBulbs with a description and two attributes.

aws iot create-thing-group \
    --thing-group-name LightBulbs \
    --thing-group-properties "thingGroupDescription=\"Generic bulb group\", attributePayload={attributes={Manufacturer=AnyCompany,wattage=60}}"

Output:

{
    "thingGroupName": "LightBulbs",
    "thingGroupArn": "arn:aws:iot:us-west-2:123456789012:thinggroup/LightBulbs",
    "thingGroupId": "9198bf9f-1e76-4a88-8e8c-e7140142c331"
}

Example 2: To create a thing group that’s part of a parent group

The following create-thing-group creates a thing group named HalogenBulbs that has a parent thing group named LightBulbs.

aws iot create-thing-group \
    --thing-group-name HalogenBulbs \
    --parent-group-name LightBulbs

Output:

{
    "thingGroupName": "HalogenBulbs",
    "thingGroupArn": "arn:aws:iot:us-west-2:123456789012:thinggroup/HalogenBulbs",
    "thingGroupId": "f4ec6b84-b42b-499d-9ce1-4dbd4d4f6f6e"
}

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

Output

thingGroupName -> (string)

The thing group name.

thingGroupArn -> (string)

The thing group ARN.

thingGroupId -> (string)

The thing group ID.