iotjobsdataplane/aws.sdk.kotlin.services.iotjobsdataplane/IotJobsDataPlaneClient

IotJobsDataPlaneClient

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.

Find the endpoint address for actions in the IoT jobs data plane by running this CLI command:

aws iot describe-endpoint --endpoint-type iot:Jobs

The service name used by Amazon Web Services Signature Version 4 to sign requests is: iot-jobs-data.

To create a job, you make a job document which is a description of the remote operations to be performed, and you specify a list of targets that should perform the operations. The targets can be individual things, thing groups or both.

IoT Jobs sends a message to inform the targets that a job is available. The target starts the execution of the job by downloading the job document, performing the operations it specifies, and reporting its progress to Amazon Web Services IoT Core. The Jobs service provides commands to track the progress of a job on a specific target and for all the targets of the job

Types

Builder

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

Companion

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

Config

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

Properties

config

abstract override val config: IotJobsDataPlaneClient.Config

IotJobsDataPlaneClient's configuration

Functions

describeJobExecution

abstract suspend fun describeJobExecution(input: DescribeJobExecutionRequest): DescribeJobExecutionResponse

Gets details of a job execution.

getPendingJobExecutions

abstract suspend fun getPendingJobExecutions(input: GetPendingJobExecutionsRequest): GetPendingJobExecutionsResponse

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

startCommandExecution

abstract suspend fun startCommandExecution(input: StartCommandExecutionRequest): StartCommandExecutionResponse

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

startNextPendingJobExecution

abstract suspend fun startNextPendingJobExecution(input: StartNextPendingJobExecutionRequest): StartNextPendingJobExecutionResponse

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

updateJobExecution

abstract suspend fun updateJobExecution(input: UpdateJobExecutionRequest): UpdateJobExecutionResponse

Updates the status of a job execution.

Inherited functions

expect abstract fun close()

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.