Edit on GitHub

Iot Data Plane

This page documents function available when using the Iot_Data_Plane module, created with @service Iot_Data_Plane.

Index

Documentation

Main.Iot_Data_Plane.delete_thing_shadow — Method
delete_thing_shadow(thing_name)
delete_thing_shadow(thing_name, params::Dict{String,<:Any})

Deletes the shadow for the specified thing. For more information, see DeleteThingShadow in the AWS IoT Developer Guide.

Arguments

  • thing_name: The name of the thing.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "name": The name of the shadow.
source
Main.Iot_Data_Plane.get_thing_shadow — Method
get_thing_shadow(thing_name)
get_thing_shadow(thing_name, params::Dict{String,<:Any})

Gets the shadow for the specified thing. For more information, see GetThingShadow in the AWS IoT Developer Guide.

Arguments

  • thing_name: The name of the thing.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "name": The name of the shadow.
source
Main.Iot_Data_Plane.list_named_shadows_for_thing — Method
list_named_shadows_for_thing(thing_name)
list_named_shadows_for_thing(thing_name, params::Dict{String,<:Any})

Lists the shadows for the specified thing.

Arguments

  • thing_name: The name of the thing.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "nextToken": The token to retrieve the next set of results.
  • "pageSize": The result page size.
source
Main.Iot_Data_Plane.publish — Method
publish(topic)
publish(topic, params::Dict{String,<:Any})

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

Arguments

  • topic: The name of the MQTT topic.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "payload": The state information, in JSON format.
  • "qos": The Quality of Service (QoS) level.
source
Main.Iot_Data_Plane.update_thing_shadow — Method
update_thing_shadow(payload, thing_name)
update_thing_shadow(payload, thing_name, params::Dict{String,<:Any})

Updates the shadow for the specified thing. For more information, see UpdateThingShadow in the AWS IoT Developer Guide.

Arguments

  • payload: The state information, in JSON format.
  • thing_name: The name of the thing.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "name": The name of the shadow.
source