iot/aws.sdk.kotlin.services.iot.model/CancelJobExecutionRequest

CancelJobExecutionRequest

class CancelJobExecutionRequest

Types

Builder

class Builder

Companion

object Companion

Properties

expectedVersion

val expectedVersion: Long?

(Optional) The expected current version of the job execution. Each time you update the job execution, its version is incremented. If the version of the job execution stored in Jobs does not match, the update is rejected with a VersionMismatch error, and an ErrorResponse that contains the current job execution status data is returned. (This makes it unnecessary to perform a separate DescribeJobExecution request in order to obtain the job execution status data.)

force

val force: Boolean?

(Optional) If true the job execution will be canceled if it has status IN_PROGRESS or QUEUED, otherwise the job execution will be canceled only if it has status QUEUED. If you attempt to cancel a job execution that is IN_PROGRESS, and you do not set force to true, then an InvalidStateTransitionException will be thrown. The default is false.

jobId

val jobId: String?

The ID of the job to be canceled.

statusDetails

val statusDetails: Map<String, String>?

A collection of name/value pairs that describe the status of the job execution. If not specified, the statusDetails are unchanged. You can specify at most 10 name/value pairs.

thingName

val thingName: String?

The name of the thing whose execution of the job will be canceled.

Functions

copy

inline fun copy(block: CancelJobExecutionRequest.Builder.() -> Unit = {}): CancelJobExecutionRequest

equals

open operator override fun equals(other: Any?): Boolean

hashCode

open override fun hashCode(): Int

toString

open override fun toString(): String