[ aws . iot ]

describe-thing-group

Description

Describe a thing group.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

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

Options

--thing-group-name (string)

The name of the thing group.

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

To get information about a thing group

The following describe-thing-group example gets information about the thing group named HalogenBulbs.

aws iot describe-thing-group \
    --thing-group-name HalogenBulbs

Output:

{
    "thingGroupName": "HalogenBulbs",
    "thingGroupId": "f4ec6b84-b42b-499d-9ce1-4dbd4d4f6f6e",
    "thingGroupArn": "arn:aws:iot:us-west-2:123456789012:thinggroup/HalogenBulbs",
    "version": 1,
    "thingGroupProperties": {},
    "thingGroupMetadata": {
        "parentGroupName": "LightBulbs",
        "rootToParentThingGroups": [
            {
                "groupName": "LightBulbs",
                "groupArn": "arn:aws:iot:us-west-2:123456789012:thinggroup/LightBulbs"
            }
        ],
        "creationDate": 1559927609.897
    }
}

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

Output

thingGroupName -> (string)

The name of the thing group.

thingGroupId -> (string)

The thing group ID.

thingGroupArn -> (string)

The thing group ARN.

version -> (long)

The version of the thing group.

thingGroupProperties -> (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 .

thingGroupMetadata -> (structure)

Thing group metadata.

parentGroupName -> (string)

The parent thing group name.

rootToParentThingGroups -> (list)

The root parent thing group.

(structure)

The name and ARN of a group.

groupName -> (string)

The group name.

groupArn -> (string)

The group ARN.

creationDate -> (timestamp)

The UNIX timestamp of when the thing group was created.

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.

status -> (string)

The dynamic thing group status.