Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
Amazonka.IoTData.Lens
Description
Synopsis
- deleteThingShadow_shadowName :: Lens' DeleteThingShadow (Maybe Text)
- deleteThingShadow_thingName :: Lens' DeleteThingShadow Text
- deleteThingShadowResponse_httpStatus :: Lens' DeleteThingShadowResponse Int
- deleteThingShadowResponse_payload :: Lens' DeleteThingShadowResponse ByteString
- getRetainedMessage_topic :: Lens' GetRetainedMessage Text
- getRetainedMessageResponse_lastModifiedTime :: Lens' GetRetainedMessageResponse (Maybe Integer)
- getRetainedMessageResponse_payload :: Lens' GetRetainedMessageResponse (Maybe ByteString)
- getRetainedMessageResponse_qos :: Lens' GetRetainedMessageResponse (Maybe Natural)
- getRetainedMessageResponse_topic :: Lens' GetRetainedMessageResponse (Maybe Text)
- getRetainedMessageResponse_httpStatus :: Lens' GetRetainedMessageResponse Int
- 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_nextToken :: Lens' ListNamedShadowsForThingResponse (Maybe Text)
- listNamedShadowsForThingResponse_results :: Lens' ListNamedShadowsForThingResponse (Maybe [Text])
- listNamedShadowsForThingResponse_timestamp :: Lens' ListNamedShadowsForThingResponse (Maybe Integer)
- listNamedShadowsForThingResponse_httpStatus :: Lens' ListNamedShadowsForThingResponse Int
- listRetainedMessages_maxResults :: Lens' ListRetainedMessages (Maybe Natural)
- listRetainedMessages_nextToken :: Lens' ListRetainedMessages (Maybe Text)
- listRetainedMessagesResponse_nextToken :: Lens' ListRetainedMessagesResponse (Maybe Text)
- listRetainedMessagesResponse_retainedTopics :: Lens' ListRetainedMessagesResponse (Maybe [RetainedMessageSummary])
- listRetainedMessagesResponse_httpStatus :: Lens' ListRetainedMessagesResponse Int
- publish_contentType :: Lens' Publish (Maybe Text)
- publish_correlationData :: Lens' Publish (Maybe Text)
- publish_messageExpiry :: Lens' Publish (Maybe Integer)
- publish_payload :: Lens' Publish (Maybe ByteString)
- publish_payloadFormatIndicator :: Lens' Publish (Maybe PayloadFormatIndicator)
- publish_qos :: Lens' Publish (Maybe Natural)
- publish_responseTopic :: Lens' Publish (Maybe Text)
- publish_retain :: Lens' Publish (Maybe Bool)
- publish_userProperties :: Lens' Publish (Maybe Text)
- publish_topic :: Lens' Publish Text
- 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
- retainedMessageSummary_lastModifiedTime :: Lens' RetainedMessageSummary (Maybe Integer)
- retainedMessageSummary_payloadSize :: Lens' RetainedMessageSummary (Maybe Integer)
- retainedMessageSummary_qos :: Lens' RetainedMessageSummary (Maybe Natural)
- retainedMessageSummary_topic :: Lens' RetainedMessageSummary (Maybe Text)
Operations
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.
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_qos :: Lens' GetRetainedMessageResponse (Maybe Natural) Source #
The quality of service (QoS) level used to publish the retained message.
getRetainedMessageResponse_topic :: Lens' GetRetainedMessageResponse (Maybe Text) Source #
The topic name to which the retained message was published.
getRetainedMessageResponse_httpStatus :: Lens' GetRetainedMessageResponse Int Source #
The response's http status code.
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_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_results :: Lens' ListNamedShadowsForThingResponse (Maybe [Text]) Source #
The list of shadows for the specified thing.
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.
ListRetainedMessages
listRetainedMessages_maxResults :: Lens' ListRetainedMessages (Maybe Natural) Source #
The maximum number of results to return at one time.
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.
listRetainedMessagesResponse_nextToken :: Lens' ListRetainedMessagesResponse (Maybe Text) Source #
The token for the next set of results, or null if there are no additional results.
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_httpStatus :: Lens' ListRetainedMessagesResponse Int Source #
The response's http status code.
Publish
publish_contentType :: Lens' Publish (Maybe Text) Source #
A UTF-8 encoded string that describes the content of the publishing message.
publish_correlationData :: Lens' Publish (Maybe Text) Source #
The base64-encoded binary data used by the sender of the request message
to identify which request the response message is for when it's
received. correlationData
is an HTTP header value in the API.
publish_messageExpiry :: Lens' Publish (Maybe Integer) Source #
A user-defined integer value that represents the message expiry interval
in seconds. If absent, the message doesn't expire. For more information
about the limits of messageExpiry
, see
Amazon Web Services IoT Core message broker and protocol limits and quotas
from the Amazon Web Services Reference Guide.
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 Amazon Web Services IoT
Core.
publish_payloadFormatIndicator :: Lens' Publish (Maybe PayloadFormatIndicator) Source #
An Enum
string value that indicates whether the payload is formatted
as UTF-8. payloadFormatIndicator
is an HTTP header value in the API.
publish_qos :: Lens' Publish (Maybe Natural) Source #
The Quality of Service (QoS) level. The default QoS level is 0.
publish_responseTopic :: Lens' Publish (Maybe Text) Source #
A UTF-8 encoded string that's used as the topic name for a response message. The response topic is used to describe the topic which the receiver should publish to as part of the request-response flow. The topic must not contain wildcard characters.
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_userProperties :: Lens' Publish (Maybe Text) Source #
A JSON string that contains an array of JSON objects. If you don’t use
Amazon Web Services SDK or CLI, you must encode the JSON string to
base64 format before adding it to the HTTP header. userProperties
is
an HTTP header value in the API.
The following example userProperties
parameter is a JSON string which
represents two User Properties. Note that it needs to be base64-encoded:
[{"deviceName": "alpha"}, {"deviceCnt": "45"}]
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.
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_payloadSize :: Lens' RetainedMessageSummary (Maybe Integer) Source #
The size of the retained message's payload in bytes.
retainedMessageSummary_qos :: Lens' RetainedMessageSummary (Maybe Natural) Source #
The quality of service (QoS) level used to publish the retained message.
retainedMessageSummary_topic :: Lens' RetainedMessageSummary (Maybe Text) Source #
The topic name to which the retained message was published.