libZSservicesZSamazonka-iot-dataplaneZSamazonka-iot-dataplane
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.IoTData.Lens

Description

 
Synopsis

Operations

GetThingShadow

ListNamedShadowsForThing

listNamedShadowsForThing_nextToken :: Lens' ListNamedShadowsForThing (Maybe Text) Source #

The token to retrieve the next set of results.

listNamedShadowsForThingResponse_nextToken :: Lens' ListNamedShadowsForThingResponse (Maybe Text) Source #

The token to use to get the next set of results, or null if there are no additional results.

listNamedShadowsForThingResponse_timestamp :: Lens' ListNamedShadowsForThingResponse (Maybe Integer) Source #

The Epoch date and time the response was generated by IoT.

DeleteThingShadow

UpdateThingShadow

updateThingShadow_payload :: Lens' UpdateThingShadow ByteString Source #

The state information, in JSON format.

ListRetainedMessages

listRetainedMessages_nextToken :: Lens' ListRetainedMessages (Maybe Text) Source #

To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.

listRetainedMessages_maxResults :: Lens' ListRetainedMessages (Maybe Natural) Source #

The maximum number of results to return at one time.

listRetainedMessagesResponse_retainedTopics :: Lens' ListRetainedMessagesResponse (Maybe [RetainedMessageSummary]) Source #

A summary list the account's retained messages. The information returned doesn't include the message payloads of the retained messages.

listRetainedMessagesResponse_nextToken :: Lens' ListRetainedMessagesResponse (Maybe Text) Source #

The token for the next set of results, or null if there are no additional results.

GetRetainedMessage

getRetainedMessage_topic :: Lens' GetRetainedMessage Text Source #

The topic name of the retained message to retrieve.

getRetainedMessageResponse_lastModifiedTime :: Lens' GetRetainedMessageResponse (Maybe Integer) Source #

The Epoch date and time, in milliseconds, when the retained message was stored by IoT.

getRetainedMessageResponse_payload :: Lens' GetRetainedMessageResponse (Maybe ByteString) Source #

The Base64-encoded message payload of the retained message body.-- -- Note: This Lens automatically encodes and decodes Base64 data. -- The underlying isomorphism will encode to Base64 representation during -- serialisation, and decode from Base64 representation during deserialisation. -- This Lens accepts and returns only raw unencoded data.

getRetainedMessageResponse_topic :: Lens' GetRetainedMessageResponse (Maybe Text) Source #

The topic name to which the retained message was published.

getRetainedMessageResponse_qos :: Lens' GetRetainedMessageResponse (Maybe Natural) Source #

The quality of service (QoS) level used to publish the retained message.

Publish

publish_retain :: Lens' Publish (Maybe Bool) Source #

A Boolean value that determines whether to set the RETAIN flag when the message is published.

Setting the RETAIN flag causes the message to be retained and sent to new subscribers to the topic.

Valid values: true | false

Default value: false

publish_payload :: Lens' Publish (Maybe ByteString) Source #

The message body. MQTT accepts text, binary, and empty (null) message payloads.

Publishing an empty (null) payload with retain = true deletes the retained message identified by topic from IoT Core.

publish_qos :: Lens' Publish (Maybe Natural) Source #

The Quality of Service (QoS) level.

publish_topic :: Lens' Publish Text Source #

The name of the MQTT topic.

Types

RetainedMessageSummary

retainedMessageSummary_lastModifiedTime :: Lens' RetainedMessageSummary (Maybe Integer) Source #

The Epoch date and time, in milliseconds, when the retained message was stored by IoT.

retainedMessageSummary_topic :: Lens' RetainedMessageSummary (Maybe Text) Source #

The topic name to which the retained message was published.

retainedMessageSummary_qos :: Lens' RetainedMessageSummary (Maybe Natural) Source #

The quality of service (QoS) level used to publish the retained message.

retainedMessageSummary_payloadSize :: Lens' RetainedMessageSummary (Maybe Integer) Source #

The size of the retained message's payload in bytes.