IoTDataPlane / Client / update_thing_shadow

update_thing_shadow#

IoTDataPlane.Client.update_thing_shadow(**kwargs)#

Updates the shadow for the specified thing.

Requires permission to access the UpdateThingShadow action.

For more information, see UpdateThingShadow in the IoT Developer Guide.

See also: AWS API Documentation

Request Syntax

response = client.update_thing_shadow(
    thingName='string',
    shadowName='string',
    payload=b'bytes'|file
)
Parameters:

  • thingName (string) –

    [REQUIRED]

    The name of the thing.

  • shadowName (string) – The name of the shadow.

  • payload (bytes or seekable file-like object) –

    [REQUIRED]

    The state information, in JSON format.

Return type:

dict

Returns:

Response Syntax

{
    'payload': StreamingBody()
}

Response Structure

  • (dict) –

    The output from the UpdateThingShadow operation.

    • payload (StreamingBody) –

      The state information, in JSON format.

Exceptions