iotsecuretunneling/aws.sdk.kotlin.services.iotsecuretunneling

Package-level declarations

Types

IotSecureTunnelingClient

interface IotSecureTunnelingClient : SdkClient

IoT Secure Tunneling creates remote connections to devices deployed in the field.

Properties

SdkVersion

const val SdkVersion: String

ServiceApiVersion

const val ServiceApiVersion: String

ServiceId

const val ServiceId: String

Inherited functions

closeTunnel

inline suspend fun IotSecureTunnelingClient.closeTunnel(crossinline block: CloseTunnelRequest.Builder.() -> Unit): CloseTunnelResponse

Closes a tunnel identified by the unique tunnel id. When a CloseTunnel request is received, we close the WebSocket connections between the client and proxy server so no data can be transmitted.

describeTunnel

inline suspend fun IotSecureTunnelingClient.describeTunnel(crossinline block: DescribeTunnelRequest.Builder.() -> Unit): DescribeTunnelResponse

Gets information about a tunnel identified by the unique tunnel id.

listTagsForResource

inline suspend fun IotSecureTunnelingClient.listTagsForResource(crossinline block: ListTagsForResourceRequest.Builder.() -> Unit): ListTagsForResourceResponse

Lists the tags for the specified resource.

listTunnels

inline suspend fun IotSecureTunnelingClient.listTunnels(crossinline block: ListTunnelsRequest.Builder.() -> Unit): ListTunnelsResponse

List all tunnels for an Amazon Web Services account. Tunnels are listed by creation time in descending order, newer tunnels will be listed before older tunnels.

openTunnel

inline suspend fun IotSecureTunnelingClient.openTunnel(crossinline block: OpenTunnelRequest.Builder.() -> Unit): OpenTunnelResponse

Creates a new tunnel, and returns two client access tokens for clients to use to connect to the IoT Secure Tunneling proxy server.

rotateTunnelAccessToken

inline suspend fun IotSecureTunnelingClient.rotateTunnelAccessToken(crossinline block: RotateTunnelAccessTokenRequest.Builder.() -> Unit): RotateTunnelAccessTokenResponse

Revokes the current client access token (CAT) and returns new CAT for clients to use when reconnecting to secure tunneling to access the same tunnel.

tagResource

inline suspend fun IotSecureTunnelingClient.tagResource(crossinline block: TagResourceRequest.Builder.() -> Unit): TagResourceResponse

A resource tag.

untagResource

inline suspend fun IotSecureTunnelingClient.untagResource(crossinline block: UntagResourceRequest.Builder.() -> Unit): UntagResourceResponse

Removes a tag from a resource.

withConfig

fun IotSecureTunnelingClient.withConfig(block: IotSecureTunnelingClient.Config.Builder.() -> Unit): IotSecureTunnelingClient

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.