Select your cookie preferences

We use cookies and similar tools to enhance your experience, provide our services, deliver relevant advertising, and make improvements. Approved third parties also use these tools to help us deliver advertising and provide certain site features.

get_thing_shadow

IoTDataPlane.Client.get_thing_shadow(**kwargs)

Gets the shadow for the specified thing.

Requires permission to access the GetThingShadow action.

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

See also: AWS API Documentation

Request Syntax

response = client.get_thing_shadow(
    thingName='string',
    shadowName='string'
)
Parameters
  • thingName (string) --

    [REQUIRED]

    The name of the thing.

  • shadowName (string) -- The name of the shadow.
Return type

dict

Returns

Response Syntax

{
    'payload': StreamingBody()
}

Response Structure

  • (dict) --

    The output from the GetThingShadow operation.

    • payload (StreamingBody) --

      The state information, in JSON format.

Exceptions

  • IoTDataPlane.Client.exceptions.InvalidRequestException
  • IoTDataPlane.Client.exceptions.ResourceNotFoundException
  • IoTDataPlane.Client.exceptions.ThrottlingException
  • IoTDataPlane.Client.exceptions.UnauthorizedException
  • IoTDataPlane.Client.exceptions.ServiceUnavailableException
  • IoTDataPlane.Client.exceptions.InternalFailureException
  • IoTDataPlane.Client.exceptions.MethodNotAllowedException
  • IoTDataPlane.Client.exceptions.UnsupportedDocumentEncodingException