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

Package-level declarations

Types

CertificateId

class CertificateId : AbstractValue<String>

The SHA-256 of the DER-encoded certificate, as 64 hex characters.

CertificateMode

enum CertificateMode : Enum<CertificateMode>

CertificateStatus

enum CertificateStatus : Enum<CertificateStatus>

JobExecutionStatus

enum JobExecutionStatus : Enum<JobExecutionStatus>

JobId

class JobId : AbstractValue<String>

A job identifier, unique within the account. AWS allows only alphanumerics, "-" and "_", which is what lets it be dropped straight into the /jobs/{jobId} path.

JobStatus

enum JobStatus : Enum<JobStatus>

S3Location

@JsonSerializable

data class S3Location(val bucket: String, val key: String, val version: String? = null)

Where the file's bytes live. version pins an object version on a versioned bucket.

StreamFile

@JsonSerializable

data class StreamFile(val fileId: Int, val s3Location: S3Location)

One file in a stream, addressed by a fileId of 0 to 255 which the device names when it asks for blocks. A stream carries 1 to 50 of these.

StreamId

class StreamId : AbstractValue<String>

A stream identifier, unique within the account. AWS allows only alphanumerics, "-" and "_", which is what lets it be dropped straight into the /streams/{streamId} path.

TargetSelection

enum TargetSelection : Enum<TargetSelection>

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.

TimeoutConfig

@JsonSerializable

data class TimeoutConfig(val inProgressTimeoutInMinutes: Long? = null)

The amount of time each device has to finish its execution of the job, in minutes (1 to 10080). The timer starts when the execution status is set to IN_PROGRESS.