AWS IoT Data Plane

2015/10/08 - AWS IoT Data Plane - 4 new api methods

UpdateThingShadow (new) Link ¶

Updates the thing shadow for the specified thing.

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

Request Syntax

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

string

param thingName:

[REQUIRED]

The name of the thing.

type payload:

bytes or seekable file-like object

param payload:

[REQUIRED]

The state information, in JSON format.

rtype:

dict

returns:

Response Syntax

{
    'payload': b'bytes'|file
}

Response Structure

  • (dict) --

    The output from the UpdateThingShadow operation.

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

      The state information, in JSON format.

GetThingShadow (new) Link ¶

Gets the thing shadow for the specified thing.

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

Request Syntax

client.get_thing_shadow(
    thingName='string'
)
type thingName:

string

param thingName:

[REQUIRED]

The name of the thing.

rtype:

dict

returns:

Response Syntax

{
    'payload': StreamingBody()
}

Response Structure

  • (dict) --

    The output from the GetThingShadow operation.

    • payload (:class:`.StreamingBody`) --

      The state information, in JSON format.

Publish (new) Link ¶

Publishes state information.

For more information, see HTTP Protocol in the AWS IoT Developer Guide.

Request Syntax

client.publish(
    topic='string',
    qos=123,
    payload=b'bytes'|file
)
type topic:

string

param topic:

[REQUIRED]

The name of the MQTT topic.

type qos:

integer

param qos:

The Quality of Service (QoS) level.

type payload:

bytes or seekable file-like object

param payload:

The state information, in JSON format.

returns:

None

DeleteThingShadow (new) Link ¶

Deletes the thing shadow for the specified thing.

For more information, see DeleteThingShadow in the AWS IoT Developer Guide.

Request Syntax

client.delete_thing_shadow(
    thingName='string'
)
type thingName:

string

param thingName:

[REQUIRED]

The name of the thing.

rtype:

dict

returns:

Response Syntax

{
    'payload': StreamingBody()
}

Response Structure

  • (dict) --

    The output from the DeleteThingShadow operation.

    • payload (:class:`.StreamingBody`) --

      The state information, in JSON format.