:doc:`IoT <../../iot>` / Client / update_thing_group

******************
update_thing_group
******************



.. py:method:: IoT.Client.update_thing_group(**kwargs)

  

  Update a thing group.

   

  Requires permission to access the `UpdateThingGroup <https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions>`__ action.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/iot-2015-05-28/UpdateThingGroup>`_  


  **Request Syntax**
  ::

    response = client.update_thing_group(
        thingGroupName='string',
        thingGroupProperties={
            'thingGroupDescription': 'string',
            'attributePayload': {
                'attributes': {
                    'string': 'string'
                },
                'merge': True|False
            }
        },
        expectedVersion=123
    )
    
  :type thingGroupName: string
  :param thingGroupName: **[REQUIRED]** 

    The thing group to update.

    

  
  :type thingGroupProperties: dict
  :param thingGroupProperties: **[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``.

          

        

      
    
  
  :type expectedVersion: integer
  :param expectedVersion: 

    The expected version of the thing group. If this does not match the version of the thing group being updated, the update will fail.

    

  
  
  :rtype: dict
  :returns: 
    
    **Response Syntax**

    
    ::

      {
          'version': 123
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **version** *(integer) --* 

        The version of the updated thing group.

        
  
  **Exceptions**
  
  *   :py:class:`IoT.Client.exceptions.InvalidRequestException`

  
  *   :py:class:`IoT.Client.exceptions.VersionConflictException`

  
  *   :py:class:`IoT.Client.exceptions.ThrottlingException`

  
  *   :py:class:`IoT.Client.exceptions.InternalFailureException`

  
  *   :py:class:`IoT.Client.exceptions.ResourceNotFoundException`

  