IoT / Client / describe_thing_group

describe_thing_group

IoT.Client.describe_thing_group(**kwargs)

Describe a thing group.

Requires permission to access the DescribeThingGroup action.

See also: AWS API Documentation

Request Syntax

response = client.describe_thing_group(
    thingGroupName='string'
)

Parameters:

thingGroupName (string) –

[REQUIRED]

The name of the thing group.

Return type:

dict

Returns:

Response Syntax

{
    'thingGroupName': 'string',
    'thingGroupId': 'string',
    'thingGroupArn': 'string',
    'version': 123,
    'thingGroupProperties': {
        'thingGroupDescription': 'string',
        'attributePayload': {
            'attributes': {
                'string': 'string'
            },
            'merge': True|False
        }
    },
    'thingGroupMetadata': {
        'parentGroupName': 'string',
        'rootToParentThingGroups': [
            {
                'groupName': 'string',
                'groupArn': 'string'
            },
        ],
        'creationDate': datetime(2015, 1, 1)
    },
    'indexName': 'string',
    'queryString': 'string',
    'queryVersion': 'string',
    'status': 'ACTIVE'|'BUILDING'|'REBUILDING'
}

Response Structure

• (dict) –

  • thingGroupName (string) –

    The name of the thing group.

  • thingGroupId (string) –

    The thing group ID.

  • thingGroupArn (string) –

    The thing group ARN.

  • version (integer) –

    The version of the thing group.

  • thingGroupProperties (dict) –

    The thing group properties.

    • thingGroupDescription (string) –

      The thing group description.

    • attributePayload (dict) –

      The thing group attributes in JSON format.

      • attributes (dict) –

        A JSON string containing up to three key-value pair in JSON format. For example:

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

        • (string) –

          • (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 (dict) –

    Thing group metadata.

    • parentGroupName (string) –

      The parent thing group name.

    • rootToParentThingGroups (list) –

      The root parent thing group.

      • (dict) –

        The name and ARN of a group.

        • groupName (string) –

          The group name.

        • groupArn (string) –

          The group ARN.

    • creationDate (datetime) –

      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.

Exceptions

• IoT.Client.exceptions.InvalidRequestException

• IoT.Client.exceptions.ThrottlingException

• IoT.Client.exceptions.InternalFailureException

• IoT.Client.exceptions.ResourceNotFoundException