| 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
Description
Derived from API version 2015-05-28 of the AWS service descriptions, licensed under Apache 2.0.
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.
Synopsis
- defaultService :: Service
- _ConflictException :: AsError a => Fold a ServiceError
- _InternalFailureException :: AsError a => Fold a ServiceError
- _InvalidRequestException :: AsError a => Fold a ServiceError
- _MethodNotAllowedException :: AsError a => Fold a ServiceError
- _RequestEntityTooLargeException :: AsError a => Fold a ServiceError
- _ResourceNotFoundException :: AsError a => Fold a ServiceError
- _ServiceUnavailableException :: AsError a => Fold a ServiceError
- _ThrottlingException :: AsError a => Fold a ServiceError
- _UnauthorizedException :: AsError a => Fold a ServiceError
- _UnsupportedDocumentEncodingException :: AsError a => Fold a ServiceError
- data DeleteThingShadow = DeleteThingShadow' (Maybe Text) Text
- newDeleteThingShadow :: Text -> DeleteThingShadow
- data DeleteThingShadowResponse = DeleteThingShadowResponse' Int ByteString
- newDeleteThingShadowResponse :: Int -> ByteString -> DeleteThingShadowResponse
- data GetRetainedMessage = GetRetainedMessage' Text
- newGetRetainedMessage :: Text -> GetRetainedMessage
- data GetRetainedMessageResponse = GetRetainedMessageResponse' (Maybe Integer) (Maybe Base64) (Maybe Natural) (Maybe Text) Int
- newGetRetainedMessageResponse :: Int -> GetRetainedMessageResponse
- data GetThingShadow = GetThingShadow' (Maybe Text) Text
- newGetThingShadow :: Text -> GetThingShadow
- data GetThingShadowResponse = GetThingShadowResponse' (Maybe ByteString) Int
- newGetThingShadowResponse :: Int -> GetThingShadowResponse
- data ListNamedShadowsForThing = ListNamedShadowsForThing' (Maybe Text) (Maybe Natural) Text
- newListNamedShadowsForThing :: Text -> ListNamedShadowsForThing
- data ListNamedShadowsForThingResponse = ListNamedShadowsForThingResponse' (Maybe Text) (Maybe [Text]) (Maybe Integer) Int
- newListNamedShadowsForThingResponse :: Int -> ListNamedShadowsForThingResponse
- data ListRetainedMessages = ListRetainedMessages' (Maybe Natural) (Maybe Text)
- newListRetainedMessages :: ListRetainedMessages
- data ListRetainedMessagesResponse = ListRetainedMessagesResponse' (Maybe Text) (Maybe [RetainedMessageSummary]) Int
- newListRetainedMessagesResponse :: Int -> ListRetainedMessagesResponse
- data Publish = Publish' (Maybe Text) (Maybe Text) (Maybe Integer) (Maybe ByteString) (Maybe PayloadFormatIndicator) (Maybe Natural) (Maybe Text) (Maybe Bool) (Maybe Text) Text
- newPublish :: Text -> Publish
- data PublishResponse = PublishResponse' {
- newPublishResponse :: PublishResponse
- data UpdateThingShadow = UpdateThingShadow' (Maybe Text) Text ByteString
- newUpdateThingShadow :: Text -> ByteString -> UpdateThingShadow
- data UpdateThingShadowResponse = UpdateThingShadowResponse' (Maybe ByteString) Int
- newUpdateThingShadowResponse :: Int -> UpdateThingShadowResponse
- newtype PayloadFormatIndicator where
- data RetainedMessageSummary = RetainedMessageSummary' (Maybe Integer) (Maybe Integer) (Maybe Natural) (Maybe Text)
- newRetainedMessageSummary :: RetainedMessageSummary
Service Configuration
defaultService :: Service Source #
API version 2015-05-28 of the Amazon IoT Data Plane SDK configuration.
Errors
Error matchers are designed for use with the functions provided by
Control.Exception.Lens.
This allows catching (and rethrowing) service specific errors returned
by IoTData.
ConflictException
_ConflictException :: AsError a => Fold a ServiceError Source #
The specified version does not match the version of the document.
InternalFailureException
_InternalFailureException :: AsError a => Fold a ServiceError Source #
An unexpected error has occurred.
InvalidRequestException
_InvalidRequestException :: AsError a => Fold a ServiceError Source #
The request is not valid.
MethodNotAllowedException
_MethodNotAllowedException :: AsError a => Fold a ServiceError Source #
The specified combination of HTTP verb and URI is not supported.
RequestEntityTooLargeException
_RequestEntityTooLargeException :: AsError a => Fold a ServiceError Source #
The payload exceeds the maximum size allowed.
ResourceNotFoundException
_ResourceNotFoundException :: AsError a => Fold a ServiceError Source #
The specified resource does not exist.
ServiceUnavailableException
_ServiceUnavailableException :: AsError a => Fold a ServiceError Source #
The service is temporarily unavailable.
ThrottlingException
_ThrottlingException :: AsError a => Fold a ServiceError Source #
The rate exceeds the limit.
UnauthorizedException
_UnauthorizedException :: AsError a => Fold a ServiceError Source #
You are not authorized to perform this operation.
UnsupportedDocumentEncodingException
_UnsupportedDocumentEncodingException :: AsError a => Fold a ServiceError Source #
The document encoding is not supported.
Waiters
Waiters poll by repeatedly sending a request until some remote success condition
configured by the Wait specification is fulfilled. The Wait specification
determines how many attempts should be made, in addition to delay and retry strategies.
Operations
Some AWS operations return results that are incomplete and require subsequent
requests in order to obtain the entire result set. The process of sending
subsequent requests to continue where a previous request left off is called
pagination. For example, the ListObjects operation of Amazon S3 returns up to
1000 objects at a time, and you must send subsequent requests with the
appropriate Marker in order to retrieve the next page of results.
Operations that have an AWSPager instance can transparently perform subsequent
requests, correctly setting Markers and other request facets to iterate through
the entire result set of a truncated API operation. Operations which support
this have an additional note in the documentation.
Many operations have the ability to filter results on the server side. See the individual operation parameters for details.
DeleteThingShadow
data DeleteThingShadow Source #
The input for the DeleteThingShadow operation.
See: newDeleteThingShadow smart constructor.
Constructors
| DeleteThingShadow' (Maybe Text) Text |
Instances
Arguments
| :: Text | |
| -> DeleteThingShadow |
Create a value of DeleteThingShadow with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:shadowName:DeleteThingShadow', deleteThingShadow_shadowName - The name of the shadow.
$sel:thingName:DeleteThingShadow', deleteThingShadow_thingName - The name of the thing.
data DeleteThingShadowResponse Source #
The output from the DeleteThingShadow operation.
See: newDeleteThingShadowResponse smart constructor.
Constructors
| DeleteThingShadowResponse' Int ByteString |
Instances
newDeleteThingShadowResponse Source #
Arguments
| :: Int | |
| -> ByteString | |
| -> DeleteThingShadowResponse |
Create a value of DeleteThingShadowResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:DeleteThingShadowResponse', deleteThingShadowResponse_httpStatus - The response's http status code.
$sel:payload:DeleteThingShadowResponse', deleteThingShadowResponse_payload - The state information, in JSON format.
GetRetainedMessage
data GetRetainedMessage Source #
The input for the GetRetainedMessage operation.
See: newGetRetainedMessage smart constructor.
Constructors
| GetRetainedMessage' Text |
Instances
newGetRetainedMessage Source #
Arguments
| :: Text | |
| -> GetRetainedMessage |
Create a value of GetRetainedMessage with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
GetRetainedMessage, getRetainedMessage_topic - The topic name of the retained message to retrieve.
data GetRetainedMessageResponse Source #
The output from the GetRetainedMessage operation.
See: newGetRetainedMessageResponse smart constructor.
Constructors
| GetRetainedMessageResponse' (Maybe Integer) (Maybe Base64) (Maybe Natural) (Maybe Text) Int |
Instances
newGetRetainedMessageResponse Source #
Create a value of GetRetainedMessageResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
GetRetainedMessageResponse, getRetainedMessageResponse_lastModifiedTime - The Epoch date and time, in milliseconds, when the retained message was
stored by IoT.
$sel:payload:GetRetainedMessageResponse', getRetainedMessageResponse_payload - 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, getRetainedMessageResponse_qos - The quality of service (QoS) level used to publish the retained message.
GetRetainedMessage, getRetainedMessageResponse_topic - The topic name to which the retained message was published.
$sel:httpStatus:GetRetainedMessageResponse', getRetainedMessageResponse_httpStatus - The response's http status code.
GetThingShadow
data GetThingShadow Source #
The input for the GetThingShadow operation.
See: newGetThingShadow smart constructor.
Constructors
| GetThingShadow' (Maybe Text) Text |
Instances
Arguments
| :: Text | |
| -> GetThingShadow |
Create a value of GetThingShadow with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:shadowName:GetThingShadow', getThingShadow_shadowName - The name of the shadow.
$sel:thingName:GetThingShadow', getThingShadow_thingName - The name of the thing.
data GetThingShadowResponse Source #
The output from the GetThingShadow operation.
See: newGetThingShadowResponse smart constructor.
Constructors
| GetThingShadowResponse' (Maybe ByteString) Int |
Instances
newGetThingShadowResponse Source #
Create a value of GetThingShadowResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:payload:GetThingShadowResponse', getThingShadowResponse_payload - The state information, in JSON format.
$sel:httpStatus:GetThingShadowResponse', getThingShadowResponse_httpStatus - The response's http status code.
ListNamedShadowsForThing
data ListNamedShadowsForThing Source #
See: newListNamedShadowsForThing smart constructor.
Instances
newListNamedShadowsForThing Source #
Create a value of ListNamedShadowsForThing with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ListNamedShadowsForThing, listNamedShadowsForThing_nextToken - The token to retrieve the next set of results.
$sel:pageSize:ListNamedShadowsForThing', listNamedShadowsForThing_pageSize - The result page size.
$sel:thingName:ListNamedShadowsForThing', listNamedShadowsForThing_thingName - The name of the thing.
data ListNamedShadowsForThingResponse Source #
See: newListNamedShadowsForThingResponse smart constructor.
Instances
newListNamedShadowsForThingResponse Source #
Create a value of ListNamedShadowsForThingResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ListNamedShadowsForThing, listNamedShadowsForThingResponse_nextToken - The token to use to get the next set of results, or null if there
are no additional results.
$sel:results:ListNamedShadowsForThingResponse', listNamedShadowsForThingResponse_results - The list of shadows for the specified thing.
$sel:timestamp:ListNamedShadowsForThingResponse', listNamedShadowsForThingResponse_timestamp - The Epoch date and time the response was generated by IoT.
$sel:httpStatus:ListNamedShadowsForThingResponse', listNamedShadowsForThingResponse_httpStatus - The response's http status code.
ListRetainedMessages (Paginated)
data ListRetainedMessages Source #
See: newListRetainedMessages smart constructor.
Constructors
| ListRetainedMessages' (Maybe Natural) (Maybe Text) |
Instances
newListRetainedMessages :: ListRetainedMessages Source #
Create a value of ListRetainedMessages with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:maxResults:ListRetainedMessages', listRetainedMessages_maxResults - The maximum number of results to return at one time.
ListRetainedMessages, listRetainedMessages_nextToken - To retrieve the next set of results, the nextToken value from a
previous response; otherwise null to receive the first set of
results.
data ListRetainedMessagesResponse Source #
See: newListRetainedMessagesResponse smart constructor.
Constructors
| ListRetainedMessagesResponse' (Maybe Text) (Maybe [RetainedMessageSummary]) Int |
Instances
newListRetainedMessagesResponse Source #
Create a value of ListRetainedMessagesResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ListRetainedMessages, listRetainedMessagesResponse_nextToken - The token for the next set of results, or null if there are no
additional results.
$sel:retainedTopics:ListRetainedMessagesResponse', listRetainedMessagesResponse_retainedTopics - A summary list the account's retained messages. The information
returned doesn't include the message payloads of the retained messages.
$sel:httpStatus:ListRetainedMessagesResponse', listRetainedMessagesResponse_httpStatus - The response's http status code.
Publish
The input for the Publish operation.
See: newPublish smart constructor.
Constructors
| Publish' (Maybe Text) (Maybe Text) (Maybe Integer) (Maybe ByteString) (Maybe PayloadFormatIndicator) (Maybe Natural) (Maybe Text) (Maybe Bool) (Maybe Text) Text |
Instances
Create a value of Publish with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:contentType:Publish', publish_contentType - A UTF-8 encoded string that describes the content of the publishing
message.
$sel:correlationData:Publish', publish_correlationData - 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.
$sel:messageExpiry:Publish', publish_messageExpiry - 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.
$sel:payload:Publish', publish_payload - 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.
$sel:payloadFormatIndicator:Publish', publish_payloadFormatIndicator - An Enum string value that indicates whether the payload is formatted
as UTF-8. payloadFormatIndicator is an HTTP header value in the API.
Publish, publish_qos - The Quality of Service (QoS) level. The default QoS level is 0.
$sel:responseTopic:Publish', publish_responseTopic - 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.
$sel:retain:Publish', publish_retain - 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
$sel:userProperties:Publish', publish_userProperties - 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"}]Publish, publish_topic - The name of the MQTT topic.
data PublishResponse Source #
See: newPublishResponse smart constructor.
Constructors
| PublishResponse' | |
Instances
| Generic PublishResponse Source # | |
Defined in Amazonka.IoTData.Publish Associated Types type Rep PublishResponse :: Type -> Type # Methods from :: PublishResponse -> Rep PublishResponse x # to :: Rep PublishResponse x -> PublishResponse # | |
| Read PublishResponse Source # | |
Defined in Amazonka.IoTData.Publish Methods readsPrec :: Int -> ReadS PublishResponse # readList :: ReadS [PublishResponse] # | |
| Show PublishResponse Source # | |
Defined in Amazonka.IoTData.Publish Methods showsPrec :: Int -> PublishResponse -> ShowS # show :: PublishResponse -> String # showList :: [PublishResponse] -> ShowS # | |
| NFData PublishResponse Source # | |
Defined in Amazonka.IoTData.Publish Methods rnf :: PublishResponse -> () # | |
| Eq PublishResponse Source # | |
Defined in Amazonka.IoTData.Publish Methods (==) :: PublishResponse -> PublishResponse -> Bool # (/=) :: PublishResponse -> PublishResponse -> Bool # | |
| type Rep PublishResponse Source # | |
newPublishResponse :: PublishResponse Source #
Create a value of PublishResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
UpdateThingShadow
data UpdateThingShadow Source #
The input for the UpdateThingShadow operation.
See: newUpdateThingShadow smart constructor.
Constructors
| UpdateThingShadow' (Maybe Text) Text ByteString |
Instances
Create a value of UpdateThingShadow with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:shadowName:UpdateThingShadow', updateThingShadow_shadowName - The name of the shadow.
$sel:thingName:UpdateThingShadow', updateThingShadow_thingName - The name of the thing.
UpdateThingShadow, updateThingShadow_payload - The state information, in JSON format.
data UpdateThingShadowResponse Source #
The output from the UpdateThingShadow operation.
See: newUpdateThingShadowResponse smart constructor.
Constructors
| UpdateThingShadowResponse' (Maybe ByteString) Int |
Instances
newUpdateThingShadowResponse Source #
Create a value of UpdateThingShadowResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
UpdateThingShadow, updateThingShadowResponse_payload - The state information, in JSON format.
$sel:httpStatus:UpdateThingShadowResponse', updateThingShadowResponse_httpStatus - The response's http status code.
Types
PayloadFormatIndicator
newtype PayloadFormatIndicator Source #
Constructors
| PayloadFormatIndicator' | |
Fields | |
Bundled Patterns
| pattern PayloadFormatIndicator_UNSPECIFIED_BYTES :: PayloadFormatIndicator | |
| pattern PayloadFormatIndicator_UTF8_DATA :: PayloadFormatIndicator |
Instances
RetainedMessageSummary
data RetainedMessageSummary Source #
Information about a single retained message.
See: newRetainedMessageSummary smart constructor.
Instances
newRetainedMessageSummary :: RetainedMessageSummary Source #
Create a value of RetainedMessageSummary with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:lastModifiedTime:RetainedMessageSummary', retainedMessageSummary_lastModifiedTime - The Epoch date and time, in milliseconds, when the retained message was
stored by IoT.
$sel:payloadSize:RetainedMessageSummary', retainedMessageSummary_payloadSize - The size of the retained message's payload in bytes.
$sel:qos:RetainedMessageSummary', retainedMessageSummary_qos - The quality of service (QoS) level used to publish the retained message.
$sel:topic:RetainedMessageSummary', retainedMessageSummary_topic - The topic name to which the retained message was published.