iotdataplane/aws.sdk.kotlin.services.iotdataplane/IotDataPlaneClient

IotDataPlaneClient

interface IotDataPlaneClient : SdkClient

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.

Properties

Link copied to clipboard
abstract override val config: IotDataPlaneClient.Config

IotDataPlaneClient's configuration

Functions

Link copied to clipboard
abstract suspend fun deleteThingShadow(input: DeleteThingShadowRequest): DeleteThingShadowResponse

Deletes the shadow for the specified thing.

Link copied to clipboard
abstract suspend fun getRetainedMessage(input: GetRetainedMessageRequest): GetRetainedMessageResponse

Gets the details of a single retained message for the specified topic.

Link copied to clipboard
abstract suspend fun getThingShadow(input: GetThingShadowRequest): GetThingShadowResponse

Gets the shadow for the specified thing.

Link copied to clipboard
abstract suspend fun listNamedShadowsForThing(input: ListNamedShadowsForThingRequest): ListNamedShadowsForThingResponse

Lists the shadows for the specified thing.

Link copied to clipboard
abstract suspend fun listRetainedMessages(input: ListRetainedMessagesRequest = ListRetainedMessagesRequest { }): ListRetainedMessagesResponse

Lists summary information about the retained messages stored for the account.

Link copied to clipboard
abstract suspend fun publish(input: PublishRequest): PublishResponse

Publishes an MQTT message.

Link copied to clipboard
abstract suspend fun updateThingShadow(input: UpdateThingShadowRequest): UpdateThingShadowResponse

Updates the shadow for the specified thing.

Inherited functions

Link copied to clipboard
expect abstract fun close()
Link copied to clipboard
inline suspend fun IotDataPlaneClient.deleteThingShadow(crossinline block: DeleteThingShadowRequest.Builder.() -> Unit): DeleteThingShadowResponse

Deletes the shadow for the specified thing.

Link copied to clipboard
inline suspend fun IotDataPlaneClient.getRetainedMessage(crossinline block: GetRetainedMessageRequest.Builder.() -> Unit): GetRetainedMessageResponse

Gets the details of a single retained message for the specified topic.

Link copied to clipboard
inline suspend fun IotDataPlaneClient.getThingShadow(crossinline block: GetThingShadowRequest.Builder.() -> Unit): GetThingShadowResponse

Gets the shadow for the specified thing.

Link copied to clipboard
inline suspend fun IotDataPlaneClient.listNamedShadowsForThing(crossinline block: ListNamedShadowsForThingRequest.Builder.() -> Unit): ListNamedShadowsForThingResponse

Lists the shadows for the specified thing.

Link copied to clipboard
inline suspend fun IotDataPlaneClient.listRetainedMessages(crossinline block: ListRetainedMessagesRequest.Builder.() -> Unit): ListRetainedMessagesResponse

Lists summary information about the retained messages stored for the account.

Link copied to clipboard
Link copied to clipboard
inline suspend fun IotDataPlaneClient.publish(crossinline block: PublishRequest.Builder.() -> Unit): PublishResponse

Publishes an MQTT message.

Link copied to clipboard
inline suspend fun IotDataPlaneClient.updateThingShadow(crossinline block: UpdateThingShadowRequest.Builder.() -> Unit): UpdateThingShadowResponse

Updates the shadow for the specified thing.

Link copied to clipboard
fun IotDataPlaneClient.withConfig(block: IotDataPlaneClient.Config.Builder.() -> Unit): IotDataPlaneClient

Create a copy of the client with one or more configuration values overridden. This method allows the caller to perform scoped config overrides for one or more client operations.