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.
Describe a thing group.
Requires permission to access the DescribeThingGroup action.
See also: AWS API Documentation
describe-thing-group
--thing-group-name <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
--thing-group-name
(string)
The name of the thing group.
--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.
--debug
(boolean)
Turn on debug logging.
--endpoint-url
(string)
Override command's default URL with the given URL.
--no-verify-ssl
(boolean)
By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.
--no-paginate
(boolean)
Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.
--output
(string)
The formatting style for command output.
--query
(string)
A JMESPath query to use in filtering the response data.
--profile
(string)
Use a specific profile from your credential file.
--region
(string)
The region to use. Overrides config/env settings.
--version
(string)
Display the version of this tool.
--color
(string)
Turn on/off color output.
--no-sign-request
(boolean)
Do not sign requests. Credentials will not be loaded if this argument is provided.
--ca-bundle
(string)
The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.
--cli-read-timeout
(int)
The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.
--cli-connect-timeout
(int)
The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.
To use the following examples, you must have the AWS CLI installed and configured. See the Getting started guide in the AWS CLI User Guide for more information.
Unless otherwise stated, all examples have unix-like quotation rules. These examples will need to be adapted to your terminal's quoting rules. See Using quotation marks with strings in the AWS CLI User Guide .
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.
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
Themerge
attribute is only valid when callingUpdateThing
orUpdateThingGroup
.
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.