iot1clickdevicesservice/aws.sdk.kotlin.services.iot1clickdevicesservice/Iot1ClickDevicesClient

Iot1ClickDevicesClient

interface Iot1ClickDevicesClient : SdkClient

Describes all of the AWS IoT 1-Click device-related API operations for the service. Also provides sample requests, responses, and errors for the supported web services protocols.

Types

Builder

class Builder : AbstractSdkClientBuilder<Iot1ClickDevicesClient.Config, Iot1ClickDevicesClient.Config.Builder, Iot1ClickDevicesClient>

Companion

object Companion : AbstractAwsSdkClientFactory<Iot1ClickDevicesClient.Config, Iot1ClickDevicesClient.Config.Builder, Iot1ClickDevicesClient, Iot1ClickDevicesClient.Builder>

Config

class Config : AwsSdkClientConfig, CredentialsProviderConfig, HttpAuthConfig, HttpClientConfig, HttpEngineConfig, RetryClientConfig, RetryStrategyClientConfig, SdkClientConfig, TelemetryConfig

Properties

config

abstract override val config: Iot1ClickDevicesClient.Config

Iot1ClickDevicesClient's configuration

Functions

claimDevicesByClaimCode

abstract suspend fun claimDevicesByClaimCode(input: ClaimDevicesByClaimCodeRequest): ClaimDevicesByClaimCodeResponse

Adds device(s) to your account (i.e., claim one or more devices) if and only if you received a claim code with the device(s).

describeDevice

abstract suspend fun describeDevice(input: DescribeDeviceRequest): DescribeDeviceResponse

Given a device ID, returns a DescribeDeviceResponse object describing the details of the device.

finalizeDeviceClaim

abstract suspend fun finalizeDeviceClaim(input: FinalizeDeviceClaimRequest): FinalizeDeviceClaimResponse

Given a device ID, finalizes the claim request for the associated device.

getDeviceMethods

abstract suspend fun getDeviceMethods(input: GetDeviceMethodsRequest): GetDeviceMethodsResponse

Given a device ID, returns the invokable methods associated with the device.

initiateDeviceClaim

abstract suspend fun initiateDeviceClaim(input: InitiateDeviceClaimRequest): InitiateDeviceClaimResponse

Given a device ID, initiates a claim request for the associated device.

invokeDeviceMethod

abstract suspend fun invokeDeviceMethod(input: InvokeDeviceMethodRequest): InvokeDeviceMethodResponse

Given a device ID, issues a request to invoke a named device method (with possible parameters). See the "Example POST" code snippet below.

listDeviceEvents

abstract suspend fun listDeviceEvents(input: ListDeviceEventsRequest): ListDeviceEventsResponse

Using a device ID, returns a DeviceEventsResponse object containing an array of events for the device.

listDevices

abstract suspend fun listDevices(input: ListDevicesRequest = ListDevicesRequest { }): ListDevicesResponse

Lists the 1-Click compatible devices associated with your AWS account.

listTagsForResource

abstract suspend fun listTagsForResource(input: ListTagsForResourceRequest): ListTagsForResourceResponse

Lists the tags associated with the specified resource ARN.

tagResource

abstract suspend fun tagResource(input: TagResourceRequest): TagResourceResponse

Adds or updates the tags associated with the resource ARN. See AWS IoT 1-Click Service Limits for the maximum number of tags allowed per resource.

unclaimDevice

abstract suspend fun unclaimDevice(input: UnclaimDeviceRequest): UnclaimDeviceResponse

Disassociates a device from your AWS account using its device ID.

untagResource

abstract suspend fun untagResource(input: UntagResourceRequest): UntagResourceResponse

Using tag keys, deletes the tags (key/value pairs) associated with the specified resource ARN.

updateDeviceState

abstract suspend fun updateDeviceState(input: UpdateDeviceStateRequest): UpdateDeviceStateResponse

Using a Boolean value (true or false), this operation enables or disables the device given a device ID.

Inherited functions

claimDevicesByClaimCode

inline suspend fun Iot1ClickDevicesClient.claimDevicesByClaimCode(crossinline block: ClaimDevicesByClaimCodeRequest.Builder.() -> Unit): ClaimDevicesByClaimCodeResponse

Adds device(s) to your account (i.e., claim one or more devices) if and only if you received a claim code with the device(s).

expect abstract fun close()

describeDevice

inline suspend fun Iot1ClickDevicesClient.describeDevice(crossinline block: DescribeDeviceRequest.Builder.() -> Unit): DescribeDeviceResponse

Given a device ID, returns a DescribeDeviceResponse object describing the details of the device.

finalizeDeviceClaim

inline suspend fun Iot1ClickDevicesClient.finalizeDeviceClaim(crossinline block: FinalizeDeviceClaimRequest.Builder.() -> Unit): FinalizeDeviceClaimResponse

Given a device ID, finalizes the claim request for the associated device.

getDeviceMethods

inline suspend fun Iot1ClickDevicesClient.getDeviceMethods(crossinline block: GetDeviceMethodsRequest.Builder.() -> Unit): GetDeviceMethodsResponse

Given a device ID, returns the invokable methods associated with the device.

initiateDeviceClaim

inline suspend fun Iot1ClickDevicesClient.initiateDeviceClaim(crossinline block: InitiateDeviceClaimRequest.Builder.() -> Unit): InitiateDeviceClaimResponse

Given a device ID, initiates a claim request for the associated device.

invokeDeviceMethod

inline suspend fun Iot1ClickDevicesClient.invokeDeviceMethod(crossinline block: InvokeDeviceMethodRequest.Builder.() -> Unit): InvokeDeviceMethodResponse

Given a device ID, issues a request to invoke a named device method (with possible parameters). See the "Example POST" code snippet below.

listDeviceEvents

inline suspend fun Iot1ClickDevicesClient.listDeviceEvents(crossinline block: ListDeviceEventsRequest.Builder.() -> Unit): ListDeviceEventsResponse

Using a device ID, returns a DeviceEventsResponse object containing an array of events for the device.

listDevices

inline suspend fun Iot1ClickDevicesClient.listDevices(crossinline block: ListDevicesRequest.Builder.() -> Unit): ListDevicesResponse

Lists the 1-Click compatible devices associated with your AWS account.

listTagsForResource

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

Lists the tags associated with the specified resource ARN.

tagResource

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

Adds or updates the tags associated with the resource ARN. See AWS IoT 1-Click Service Limits for the maximum number of tags allowed per resource.

unclaimDevice

inline suspend fun Iot1ClickDevicesClient.unclaimDevice(crossinline block: UnclaimDeviceRequest.Builder.() -> Unit): UnclaimDeviceResponse

Disassociates a device from your AWS account using its device ID.

untagResource

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

Using tag keys, deletes the tags (key/value pairs) associated with the specified resource ARN.

updateDeviceState

inline suspend fun Iot1ClickDevicesClient.updateDeviceState(crossinline block: UpdateDeviceStateRequest.Builder.() -> Unit): UpdateDeviceStateResponse

Using a Boolean value (true or false), this operation enables or disables the device given a device ID.

withConfig

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

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.