IoT / Client / update_dynamic_thing_group

update_dynamic_thing_group

IoT.Client.update_dynamic_thing_group(**kwargs)

Updates a dynamic thing group.

Requires permission to access the UpdateDynamicThingGroup action.

See also: AWS API Documentation

Request Syntax

response = client.update_dynamic_thing_group(
    thingGroupName='string',
    thingGroupProperties={
        'thingGroupDescription': 'string',
        'attributePayload': {
            'attributes': {
                'string': 'string'
            },
            'merge': True|False
        }
    },
    expectedVersion=123,
    indexName='string',
    queryString='string',
    queryVersion='string'
)

Parameters:

• thingGroupName (string) –

  [REQUIRED]

  The name of the dynamic thing group to update.

• thingGroupProperties (dict) –

  [REQUIRED]

  The dynamic thing group properties to update.

  • 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 dynamic thing group to update.

• indexName (string) –

  The dynamic thing group index to update.

  Note

  Currently one index is supported: AWS_Things.

• queryString (string) – The dynamic thing group search query string to update.

• queryVersion (string) –

  The dynamic thing group query version to update.

  Note

  Currently one query version is supported: “2017-09-30”. If not specified, the query version defaults to this value.

Return type:

dict

Returns:

Response Syntax

{
    'version': 123
}

Response Structure

• (dict) –

  • version (integer) –

    The dynamic thing group version.

Exceptions

• IoT.Client.exceptions.InvalidRequestException

• IoT.Client.exceptions.VersionConflictException

• IoT.Client.exceptions.ThrottlingException

• IoT.Client.exceptions.InternalFailureException

• IoT.Client.exceptions.ResourceNotFoundException

• IoT.Client.exceptions.InvalidQueryException