iotjobsdataplane/aws.sdk.kotlin.services.iotjobsdataplane

Package-level declarations

Types

interface IotJobsDataPlaneClient : SdkClient

IoT Jobs is a service that allows you to define a set of jobs — remote operations that are sent to and executed on one or more devices connected to Amazon Web Services IoT Core. For example, you can define a job that instructs a set of devices to download and install application or firmware updates, reboot, rotate certificates, or perform remote troubleshooting operations.

Properties

SdkVersion

const val SdkVersion: String

ServiceApiVersion

const val ServiceApiVersion: String

ServiceId

const val ServiceId: String

Inherited functions

describeJobExecution

inline suspend fun IotJobsDataPlaneClient.describeJobExecution(crossinline block: DescribeJobExecutionRequest.Builder.() -> Unit): DescribeJobExecutionResponse

Gets details of a job execution.

getPendingJobExecutions

inline suspend fun IotJobsDataPlaneClient.getPendingJobExecutions(crossinline block: GetPendingJobExecutionsRequest.Builder.() -> Unit): GetPendingJobExecutionsResponse

Gets the list of all jobs for a thing that are not in a terminal status.

startCommandExecution

inline suspend fun IotJobsDataPlaneClient.startCommandExecution(crossinline block: StartCommandExecutionRequest.Builder.() -> Unit): StartCommandExecutionResponse

Using the command created with the CreateCommand API, start a command execution on a specific device.

startNextPendingJobExecution

inline suspend fun IotJobsDataPlaneClient.startNextPendingJobExecution(crossinline block: StartNextPendingJobExecutionRequest.Builder.() -> Unit): StartNextPendingJobExecutionResponse

Gets and starts the next pending (status IN_PROGRESS or QUEUED) job execution for a thing.

updateJobExecution

inline suspend fun IotJobsDataPlaneClient.updateJobExecution(crossinline block: UpdateJobExecutionRequest.Builder.() -> Unit): UpdateJobExecutionResponse

Updates the status of a job execution.

withConfig

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

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.