http4k-connect-amazon-iotjobsdataplane/org.http4k.connect.amazon.iotjobsdataplane.model

Package-level declarations

Types

@JsonSerializable

data class JobExecution(val jobId: JobId, val status: JobExecutionStatus, val versionNumber: Long, val thingName: ThingName? = null, val statusDetails: Map<String, String>? = null, val queuedAt: Timestamp? = null, val startedAt: Timestamp? = null, val lastUpdatedAt: Timestamp? = null, val approximateSecondsBeforeTimedOut: Long? = null, val executionNumber: Long? = null, val jobDocument: String? = null)

A job execution as the jobs data plane reports it. Unlike the control plane, the status details are a bare map and the job document travels inline. All timestamps are seconds since the epoch.

JobExecutionStatus

enum JobExecutionStatus : Enum<JobExecutionStatus>

Of these, a device may only set IN_PROGRESS, SUCCEEDED, FAILED and REJECTED through UpdateJobExecution.

JobId

class JobId : AbstractValue<String>

A job identifier as the jobs data plane accepts it: alphanumerics, "-" and "_", or the reserved literal $next which addresses the device's next pending execution.

ThingName

class ThingName : AbstractValue<String>

AWS does not allow slashes in a thing name, which is what lets it be dropped straight into the /things/{thingName}/jobs path.