package awso-async
Install
dune-project
Dependency
Authors
Maintainers
Sources
sha256=e0e7510192b7e45871cff5c60e5162a77a9fa103b6924136fb1fea5db2092b26
sha512=51a18cf74c122b021bd84ef5728b7c5b2d5e767f03d5cd2387d886edc34a68cf54a3183e2d6c4939b4c8d3e0c0e406c869d019f2ee9a0903ae4cf7ca725572f0
doc/awso-async.iot-data/Awso_iot_data_async/index.html
Module Awso_iot_data_asyncSource
val delete_connection :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_iot_data.Values.DeleteConnectionRequest.t ->
(unit, unit) Result.t Async.Deferred.tval delete_thing_shadow :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_iot_data.Values.DeleteThingShadowRequest.t ->
(Awso_iot_data.Values.DeleteThingShadowResponse.t,
Awso_iot_data.Values.DeleteThingShadowResponse.error)
Result.t
Async.Deferred.tval get_retained_message :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_iot_data.Values.GetRetainedMessageRequest.t ->
(Awso_iot_data.Values.GetRetainedMessageResponse.t,
Awso_iot_data.Values.GetRetainedMessageResponse.error)
Result.t
Async.Deferred.tval get_thing_shadow :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_iot_data.Values.GetThingShadowRequest.t ->
(Awso_iot_data.Values.GetThingShadowResponse.t,
Awso_iot_data.Values.GetThingShadowResponse.error)
Result.t
Async.Deferred.tval list_named_shadows_for_thing :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_iot_data.Values.ListNamedShadowsForThingRequest.t ->
(Awso_iot_data.Values.ListNamedShadowsForThingResponse.t,
Awso_iot_data.Values.ListNamedShadowsForThingResponse.error)
Result.t
Async.Deferred.tval list_retained_messages :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_iot_data.Values.ListRetainedMessagesRequest.t ->
(Awso_iot_data.Values.ListRetainedMessagesResponse.t,
Awso_iot_data.Values.ListRetainedMessagesResponse.error)
Result.t
Async.Deferred.tval publish :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_iot_data.Values.PublishRequest.t ->
(unit, unit) Result.t Async.Deferred.tval update_thing_shadow :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_iot_data.Values.UpdateThingShadowRequest.t ->
(Awso_iot_data.Values.UpdateThingShadowResponse.t,
Awso_iot_data.Values.UpdateThingShadowResponse.error)
Result.t
Async.Deferred.tinclude module type of struct include Awso_iot_data.Values end
val structure_to_value_aux :
('a * 'b option) list ->
f:(('a * 'b) list -> 'c) ->
[> `Structure of 'c ]val structure_to_wrapped_value :
wrapper:'a ->
response:'a ->
('b * 'c option) list ->
[> `Structure of ('a * [> `Structure of ('b * 'c) list ]) list ]Information about a single retained message.
The specified version does not match the version of the document.
An unexpected error has occurred.
The request is not valid.
The specified combination of HTTP verb and URI is not supported.
The payload exceeds the maximum size allowed.
The service is temporarily unavailable.
The rate exceeds the limit.
You are not authorized to perform this operation.
module UnsupportedDocumentEncodingException =
Awso_iot_data.Values.UnsupportedDocumentEncodingExceptionThe document encoding is not supported.
The specified resource does not exist.
The output from the UpdateThingShadow operation.
The input for the UpdateThingShadow operation.
The input for the Publish operation.
Lists summary information about the retained messages stored for the account. This action returns only the topic names of the retained messages. It doesn't return any message payloads. Although this action doesn't return a message payload, it can still incur messaging costs. To get the message payload of a retained message, call GetRetainedMessage with the topic name of the retained message. Requires permission to access the ListRetainedMessages action. For more information about messaging costs, see Amazon Web Services IoT Core pricing - Messaging.
Lists summary information about the retained messages stored for the account. This action returns only the topic names of the retained messages. It doesn't return any message payloads. Although this action doesn't return a message payload, it can still incur messaging costs. To get the message payload of a retained message, call GetRetainedMessage with the topic name of the retained message. Requires permission to access the ListRetainedMessages action. For more information about messaging costs, see Amazon Web Services IoT Core pricing - Messaging.
module ListNamedShadowsForThingResponse =
Awso_iot_data.Values.ListNamedShadowsForThingResponseLists the shadows for the specified thing. Requires permission to access the ListNamedShadowsForThing action.
Lists the shadows for the specified thing. Requires permission to access the ListNamedShadowsForThing action.
The output from the GetThingShadow operation.
The input for the GetThingShadow operation.
The output from the GetRetainedMessage operation.
The input for the GetRetainedMessage operation.
The caller isn't authorized to make the request.
The output from the DeleteThingShadow operation.
The input for the DeleteThingShadow operation.
Disconnects a connected MQTT client from Amazon Web Services IoT Core. When you disconnect a client, Amazon Web Services IoT Core closes the client's network connection and optionally cleans the session state.