UpdateJobExecution

data class UpdateJobExecution(val thingName: ThingName, val jobId: JobId, val status: JobExecutionStatus, val statusDetails: Map<String, String>? = null, val expectedVersion: Long? = null, val includeJobExecutionState: Boolean? = null, val includeJobDocument: Boolean? = null, val executionNumber: Long? = null, val stepTimeoutInMinutes: Long? = null) : IotJobsDataPlaneAction<UpdatedJobExecution> (source)

Updates the status of a job execution. A device may only set IN_PROGRESS, SUCCEEDED, FAILED or REJECTED. When expectedVersion does not match the stored version the update is rejected with 409; the AWS docs call this "a VersionMismatch error" but the service model declares no such exception, so it surfaces under the operation's only declared 409, InvalidStateTransitionException. When statusDetails is not specified the stored details are unchanged; when specified they replace the stored map. includeJobExecutionState and includeJobDocument both default to false on the server.

Constructors

Link copied to clipboard
constructor(thingName: ThingName, jobId: JobId, status: JobExecutionStatus, statusDetails: Map<String, String>? = null, expectedVersion: Long? = null, includeJobExecutionState: Boolean? = null, includeJobDocument: Boolean? = null, executionNumber: Long? = null, stepTimeoutInMinutes: Long? = null)

Properties

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

Functions

Link copied to clipboard
open override fun toRequest(): Request
Link copied to clipboard
open override fun toResult(response: Response): Result<UpdatedJobExecution, RemoteFailure>