| Copyright | (c) 2013-2021 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
Amazonka.IoTData.Lens
Description
Synopsis
- getThingShadow_shadowName :: Lens' GetThingShadow (Maybe Text)
- getThingShadow_thingName :: Lens' GetThingShadow Text
- getThingShadowResponse_payload :: Lens' GetThingShadowResponse (Maybe ByteString)
- getThingShadowResponse_httpStatus :: Lens' GetThingShadowResponse Int
- listNamedShadowsForThing_nextToken :: Lens' ListNamedShadowsForThing (Maybe Text)
- listNamedShadowsForThing_pageSize :: Lens' ListNamedShadowsForThing (Maybe Natural)
- listNamedShadowsForThing_thingName :: Lens' ListNamedShadowsForThing Text
- listNamedShadowsForThingResponse_results :: Lens' ListNamedShadowsForThingResponse (Maybe [Text])
- listNamedShadowsForThingResponse_nextToken :: Lens' ListNamedShadowsForThingResponse (Maybe Text)
- listNamedShadowsForThingResponse_timestamp :: Lens' ListNamedShadowsForThingResponse (Maybe Integer)
- listNamedShadowsForThingResponse_httpStatus :: Lens' ListNamedShadowsForThingResponse Int
- deleteThingShadow_shadowName :: Lens' DeleteThingShadow (Maybe Text)
- deleteThingShadow_thingName :: Lens' DeleteThingShadow Text
- deleteThingShadowResponse_httpStatus :: Lens' DeleteThingShadowResponse Int
- deleteThingShadowResponse_payload :: Lens' DeleteThingShadowResponse ByteString
- updateThingShadow_shadowName :: Lens' UpdateThingShadow (Maybe Text)
- updateThingShadow_thingName :: Lens' UpdateThingShadow Text
- updateThingShadow_payload :: Lens' UpdateThingShadow ByteString
- updateThingShadowResponse_payload :: Lens' UpdateThingShadowResponse (Maybe ByteString)
- updateThingShadowResponse_httpStatus :: Lens' UpdateThingShadowResponse Int
- listRetainedMessages_nextToken :: Lens' ListRetainedMessages (Maybe Text)
- listRetainedMessages_maxResults :: Lens' ListRetainedMessages (Maybe Natural)
- listRetainedMessagesResponse_retainedTopics :: Lens' ListRetainedMessagesResponse (Maybe [RetainedMessageSummary])
- listRetainedMessagesResponse_nextToken :: Lens' ListRetainedMessagesResponse (Maybe Text)
- listRetainedMessagesResponse_httpStatus :: Lens' ListRetainedMessagesResponse Int
- getRetainedMessage_topic :: Lens' GetRetainedMessage Text
- getRetainedMessageResponse_lastModifiedTime :: Lens' GetRetainedMessageResponse (Maybe Integer)
- getRetainedMessageResponse_payload :: Lens' GetRetainedMessageResponse (Maybe ByteString)
- getRetainedMessageResponse_topic :: Lens' GetRetainedMessageResponse (Maybe Text)
- getRetainedMessageResponse_qos :: Lens' GetRetainedMessageResponse (Maybe Natural)
- getRetainedMessageResponse_httpStatus :: Lens' GetRetainedMessageResponse Int
- publish_retain :: Lens' Publish (Maybe Bool)
- publish_payload :: Lens' Publish (Maybe ByteString)
- publish_qos :: Lens' Publish (Maybe Natural)
- publish_topic :: Lens' Publish Text
- retainedMessageSummary_lastModifiedTime :: Lens' RetainedMessageSummary (Maybe Integer)
- retainedMessageSummary_topic :: Lens' RetainedMessageSummary (Maybe Text)
- retainedMessageSummary_qos :: Lens' RetainedMessageSummary (Maybe Natural)
- retainedMessageSummary_payloadSize :: Lens' RetainedMessageSummary (Maybe Integer)
Operations
GetThingShadow
getThingShadow_shadowName :: Lens' GetThingShadow (Maybe Text) Source #
The name of the shadow.
getThingShadow_thingName :: Lens' GetThingShadow Text Source #
The name of the thing.
getThingShadowResponse_payload :: Lens' GetThingShadowResponse (Maybe ByteString) Source #
The state information, in JSON format.
getThingShadowResponse_httpStatus :: Lens' GetThingShadowResponse Int Source #
The response's http status code.
ListNamedShadowsForThing
listNamedShadowsForThing_nextToken :: Lens' ListNamedShadowsForThing (Maybe Text) Source #
The token to retrieve the next set of results.
listNamedShadowsForThing_pageSize :: Lens' ListNamedShadowsForThing (Maybe Natural) Source #
The result page size.
listNamedShadowsForThing_thingName :: Lens' ListNamedShadowsForThing Text Source #
The name of the thing.
listNamedShadowsForThingResponse_results :: Lens' ListNamedShadowsForThingResponse (Maybe [Text]) Source #
The list of shadows for the specified thing.
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.
listNamedShadowsForThingResponse_httpStatus :: Lens' ListNamedShadowsForThingResponse Int Source #
The response's http status code.
DeleteThingShadow
deleteThingShadow_shadowName :: Lens' DeleteThingShadow (Maybe Text) Source #
The name of the shadow.
deleteThingShadow_thingName :: Lens' DeleteThingShadow Text Source #
The name of the thing.
deleteThingShadowResponse_httpStatus :: Lens' DeleteThingShadowResponse Int Source #
The response's http status code.
deleteThingShadowResponse_payload :: Lens' DeleteThingShadowResponse ByteString Source #
The state information, in JSON format.
UpdateThingShadow
updateThingShadow_shadowName :: Lens' UpdateThingShadow (Maybe Text) Source #
The name of the shadow.
updateThingShadow_thingName :: Lens' UpdateThingShadow Text Source #
The name of the thing.
updateThingShadow_payload :: Lens' UpdateThingShadow ByteString Source #
The state information, in JSON format.
updateThingShadowResponse_payload :: Lens' UpdateThingShadowResponse (Maybe ByteString) Source #
The state information, in JSON format.
updateThingShadowResponse_httpStatus :: Lens' UpdateThingShadowResponse Int Source #
The response's http status code.
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.
listRetainedMessagesResponse_httpStatus :: Lens' ListRetainedMessagesResponse Int Source #
The response's http status code.
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.
getRetainedMessageResponse_httpStatus :: Lens' GetRetainedMessageResponse Int Source #
The response's http status code.
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.
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.