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

IoT data

IoT data enables secure, bi-directional communication between Internet-connected things (such as sensors, actuators, embedded devices, or smart appliances) and the Amazon Web Services 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 Amazon Web Services cloud.

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

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

The service name used by Amazon Web ServicesSignature Version 4 to sign requests is: iotdevicegateway.

Summary

Functions

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

Deletes the shadow for the specified thing.

get_retained_message(client, topic, options \\ [])

Gets the details of a single retained message for the specified topic.

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

Gets the shadow for the specified thing.

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

Lists the shadows for the specified thing.

list_retained_messages(client, max_results \\ nil, next_token \\ nil, options \\ [])

Lists summary information about the retained messages stored for the account.

metadata()

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

Publishes an MQTT message.

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

Updates the shadow for the specified thing.

Functions

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

Deletes the shadow for the specified thing.

Requires permission to access the DeleteThingShadow action.

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

get_retained_message(client, topic, options \\ [])

Gets the details of a single retained message for the specified topic.

This action returns the message payload of the retained message, which can incur messaging costs. To list only the topic names of the retained messages, call ListRetainedMessages. Requires permission to access the GetRetainedMessage action.

For more information about messaging costs, see Amazon Web Services IoT Core pricing - Messaging.

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

Gets the shadow for the specified thing.

Requires permission to access the GetThingShadow action.

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

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

Lists the shadows for the specified thing.

Requires permission to access the ListNamedShadowsForThing action.

list_retained_messages(client, max_results \\ nil, next_token \\ nil, options \\ [])

Lists summary information about the retained messages stored for the account.

This action returns only the topic names of the retained messages. It doesn't return any message payloads. Although this action doesn't return a message payload, it can still incur messaging costs.

To get the message payload of a retained message, call GetRetainedMessage with the topic name of the retained message.

Requires permission to access the ListRetainedMessages action.

For more information about messaging costs, see Amazon Web Services IoT Core pricing - Messaging.

metadata()

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

Publishes an MQTT message.

Requires permission to access the Publish action.

For more information about MQTT messages, see MQTT Protocol in the IoT Developer Guide.

For more information about messaging costs, see Amazon Web Services IoT Core pricing - Messaging.

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

Updates the shadow for the specified thing.

Requires permission to access the UpdateThingShadow action.

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