iotdataplane/aws.sdk.kotlin.services.iotdataplane

Package-level declarations

Types

interface IotDataPlaneClient : SdkClient

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.

Properties

SdkVersion

const val SdkVersion: String

ServiceApiVersion

const val ServiceApiVersion: String

ServiceId

const val ServiceId: String

Inherited functions

deleteConnection

inline suspend fun IotDataPlaneClient.deleteConnection(crossinline block: DeleteConnectionRequest.Builder.() -> Unit): DeleteConnectionResponse

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.

deleteThingShadow

inline suspend fun IotDataPlaneClient.deleteThingShadow(crossinline block: DeleteThingShadowRequest.Builder.() -> Unit): DeleteThingShadowResponse

Deletes the shadow for the specified thing.

getConnection

inline suspend fun IotDataPlaneClient.getConnection(crossinline block: GetConnectionRequest.Builder.() -> Unit): GetConnectionResponse

Retrieves connection information for the specified MQTT client.

getRetainedMessage

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

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

getThingShadow

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

Gets the shadow for the specified thing.

listNamedShadowsForThing

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

Lists the shadows for the specified thing.

listRetainedMessages

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

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

listSubscriptions

inline suspend fun IotDataPlaneClient.listSubscriptions(crossinline block: ListSubscriptionsRequest.Builder.() -> Unit): ListSubscriptionsResponse

Returns a list of all subscriptions for MQTT clients with active sessions, including offline clients with persistent sessions.

publish

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

Publishes an MQTT message.

sendDirectMessage

inline suspend fun IotDataPlaneClient.sendDirectMessage(crossinline block: SendDirectMessageRequest.Builder.() -> Unit): SendDirectMessageResponse

Sends an MQTT message directly to a specific client identified by its client ID.

updateThingShadow

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

Updates the shadow for the specified thing.

withConfig

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.