Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

Note: You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . iot ]

create-dynamic-thing-group

Description

Creates a dynamic thing group.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  create-dynamic-thing-group
--thing-group-name <value>
[--thing-group-properties <value>]
[--index-name <value>]
--query-string <value>
[--query-version <value>]
[--tags <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--thing-group-name (string)

The dynamic thing group name to create.

--thing-group-properties (structure)

The dynamic thing group properties.

Shorthand Syntax:

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

JSON Syntax:

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

--index-name (string)

The dynamic thing group index name.

Note

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.

Note

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.

Shorthand Syntax:

Key=string,Value=string ...

JSON Syntax:

[
  {
    "Key": "string",
    "Value": "string"
  }
  ...
]

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI 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.

--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. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.

Examples

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"

Output:

{
    "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.

Output

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.