IoT / Client / update_thing_group

update_thing_group#

IoT.Client.update_thing_group(**kwargs)#

Update a thing group.

Requires permission to access the UpdateThingGroup action.

See also: AWS API Documentation

Request Syntax

response = client.update_thing_group(
    thingGroupName='string',
    thingGroupProperties={
        'thingGroupDescription': 'string',
        'attributePayload': {
            'attributes': {
                'string': 'string'
            },
            'merge': True|False
        }
    },
    expectedVersion=123
)
Parameters:

  • thingGroupName (string) –

    [REQUIRED]

    The thing group to update.

  • thingGroupProperties (dict) –

    [REQUIRED]

    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.

  • expectedVersion (integer) – The expected version of the thing group. If this does not match the version of the thing group being updated, the update will fail.

Return type:

dict

Returns:

Response Syntax

{
    'version': 123
}

Response Structure

  • (dict) –

    • version (integer) –

      The version of the updated thing group.

Exceptions

  • IoT.Client.exceptions.InvalidRequestException

  • IoT.Client.exceptions.VersionConflictException

  • IoT.Client.exceptions.ThrottlingException

  • IoT.Client.exceptions.InternalFailureException

  • IoT.Client.exceptions.ResourceNotFoundException