AWS.IoTDataPlane (aws-elixir v0.8.0) View Source

AWS IoT

AWS IoT-Data enables secure, bi-directional communication between Internet-connected things (such as sensors, actuators, embedded devices, or smart appliances) and the AWS cloud.

It implements a broker for applications and things to publish messages over HTTP (Publish) and retrieve, update, and delete shadows. A shadow is a persistent representation of your things and their state in the AWS cloud.

Find the endpoint address for actions in the AWS IoT data plane by running this CLI command:

aws iot describe-endpoint --endpoint-type iot:Data-ATS

The service name used by AWS Signature Version 4 to sign requests is: iotdevicegateway.

Link to this section Summary

Link to this section Functions

Link to this function

delete_thing_shadow(client, thing_name, input, options \\ [])

View Source

Deletes the shadow for the specified thing.

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

Link to this function

get_thing_shadow(client, thing_name, shadow_name \\ nil, options \\ [])

View Source

Gets the shadow for the specified thing.

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

Link to this function

list_named_shadows_for_thing(client, thing_name, next_token \\ nil, page_size \\ nil, options \\ [])

View Source

Lists the shadows for the specified thing.

Link to this function

publish(client, topic, input, options \\ [])

View Source

Publishes state information.

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

Link to this function

update_thing_shadow(client, thing_name, input, options \\ [])

View Source

Updates the shadow for the specified thing.

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