Amazonka.IoT.Types.JobExecution

Documentation

data JobExecution

The job execution object represents the execution of a job on a particular device.

See: newJobExecution smart constructor.

Constructors

JobExecution'

Fields

• approximateSecondsBeforeTimedOut :: Maybe Integer

  The estimated number of seconds that remain before the job execution status will be changed to TIMED_OUT. The timeout interval can be anywhere between 1 minute and 7 days (1 to 10080 minutes). The actual job execution timeout can occur up to 60 seconds later than the estimated duration. This value will not be included if the job execution has reached a terminal status.

• executionNumber :: Maybe Integer

  A string (consisting of the digits "0" through "9") which identifies this particular job execution on this particular device. It can be used in commands which return or update job execution information.

• forceCanceled :: Maybe Bool

  Will be true if the job execution was canceled with the optional force parameter set to true.

• jobId :: Maybe Text

  The unique identifier you assigned to the job when it was created.

• lastUpdatedAt :: Maybe POSIX

  The time, in seconds since the epoch, when the job execution was last updated.

• queuedAt :: Maybe POSIX

  The time, in seconds since the epoch, when the job execution was queued.

• startedAt :: Maybe POSIX

  The time, in seconds since the epoch, when the job execution started.

• status :: Maybe JobExecutionStatus

  The status of the job execution (IN_PROGRESS, QUEUED, FAILED, SUCCEEDED, TIMED_OUT, CANCELED, or REJECTED).

• statusDetails :: Maybe JobExecutionStatusDetails

  A collection of name/value pairs that describe the status of the job execution.

• thingArn :: Maybe Text

  The ARN of the thing on which the job execution is running.

• versionNumber :: Maybe Integer

  The version of the job execution. Job execution versions are incremented each time they are updated by a device.

Instances

FromJSON JobExecution

Defined in Amazonka.IoT.Types.JobExecution

Methods

parseJSON :: Value -> Parser JobExecution

parseJSONList :: Value -> Parser [JobExecution]

Generic JobExecution

Defined in Amazonka.IoT.Types.JobExecution

Associated Types

type Rep JobExecution :: Type -> Type

Methods

from :: JobExecution -> Rep JobExecution x

to :: Rep JobExecution x -> JobExecution

Read JobExecution

Defined in Amazonka.IoT.Types.JobExecution

Methods

readsPrec :: Int -> ReadS JobExecution

readList :: ReadS [JobExecution]

readPrec :: ReadPrec JobExecution

readListPrec :: ReadPrec [JobExecution]

Show JobExecution

Defined in Amazonka.IoT.Types.JobExecution

Methods

showsPrec :: Int -> JobExecution -> ShowS

show :: JobExecution -> String

showList :: [JobExecution] -> ShowS

NFData JobExecution

Defined in Amazonka.IoT.Types.JobExecution

Methods

rnf :: JobExecution -> ()

Eq JobExecution

Defined in Amazonka.IoT.Types.JobExecution

Methods

(==) :: JobExecution -> JobExecution -> Bool

(/=) :: JobExecution -> JobExecution -> Bool

Hashable JobExecution

Defined in Amazonka.IoT.Types.JobExecution

Methods

hashWithSalt :: Int -> JobExecution -> Int

hash :: JobExecution -> Int

type Rep JobExecution

Defined in Amazonka.IoT.Types.JobExecution

type Rep JobExecution = D1 ('MetaData "JobExecution" "Amazonka.IoT.Types.JobExecution" "amazonka-iot-2.0-6w03vgAfmrM1SG22OsNJXL" 'False) (C1 ('MetaCons "JobExecution'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "approximateSecondsBeforeTimedOut") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer)) :*: S1 ('MetaSel ('Just "executionNumber") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer))) :*: (S1 ('MetaSel ('Just "forceCanceled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: (S1 ('MetaSel ('Just "jobId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "lastUpdatedAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX))))) :*: ((S1 ('MetaSel ('Just "queuedAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: (S1 ('MetaSel ('Just "startedAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe JobExecutionStatus)))) :*: (S1 ('MetaSel ('Just "statusDetails") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe JobExecutionStatusDetails)) :*: (S1 ('MetaSel ('Just "thingArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "versionNumber") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer)))))))

newJobExecution :: JobExecution

Create a value of JobExecution with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:approximateSecondsBeforeTimedOut:JobExecution', jobExecution_approximateSecondsBeforeTimedOut - The estimated number of seconds that remain before the job execution status will be changed to TIMED_OUT. The timeout interval can be anywhere between 1 minute and 7 days (1 to 10080 minutes). The actual job execution timeout can occur up to 60 seconds later than the estimated duration. This value will not be included if the job execution has reached a terminal status.

$sel:executionNumber:JobExecution', jobExecution_executionNumber - A string (consisting of the digits "0" through "9") which identifies this particular job execution on this particular device. It can be used in commands which return or update job execution information.

$sel:forceCanceled:JobExecution', jobExecution_forceCanceled - Will be true if the job execution was canceled with the optional force parameter set to true.

$sel:jobId:JobExecution', jobExecution_jobId - The unique identifier you assigned to the job when it was created.

$sel:lastUpdatedAt:JobExecution', jobExecution_lastUpdatedAt - The time, in seconds since the epoch, when the job execution was last updated.

$sel:queuedAt:JobExecution', jobExecution_queuedAt - The time, in seconds since the epoch, when the job execution was queued.

$sel:startedAt:JobExecution', jobExecution_startedAt - The time, in seconds since the epoch, when the job execution started.

$sel:status:JobExecution', jobExecution_status - The status of the job execution (IN_PROGRESS, QUEUED, FAILED, SUCCEEDED, TIMED_OUT, CANCELED, or REJECTED).

$sel:statusDetails:JobExecution', jobExecution_statusDetails - A collection of name/value pairs that describe the status of the job execution.

$sel:thingArn:JobExecution', jobExecution_thingArn - The ARN of the thing on which the job execution is running.

$sel:versionNumber:JobExecution', jobExecution_versionNumber - The version of the job execution. Job execution versions are incremented each time they are updated by a device.

jobExecution_approximateSecondsBeforeTimedOut :: Lens' JobExecution (Maybe Integer)

The estimated number of seconds that remain before the job execution status will be changed to TIMED_OUT. The timeout interval can be anywhere between 1 minute and 7 days (1 to 10080 minutes). The actual job execution timeout can occur up to 60 seconds later than the estimated duration. This value will not be included if the job execution has reached a terminal status.

jobExecution_executionNumber :: Lens' JobExecution (Maybe Integer)

A string (consisting of the digits "0" through "9") which identifies this particular job execution on this particular device. It can be used in commands which return or update job execution information.

jobExecution_forceCanceled :: Lens' JobExecution (Maybe Bool)

Will be true if the job execution was canceled with the optional force parameter set to true.

jobExecution_jobId :: Lens' JobExecution (Maybe Text)

The unique identifier you assigned to the job when it was created.

jobExecution_lastUpdatedAt :: Lens' JobExecution (Maybe UTCTime)

The time, in seconds since the epoch, when the job execution was last updated.

jobExecution_queuedAt :: Lens' JobExecution (Maybe UTCTime)

The time, in seconds since the epoch, when the job execution was queued.

jobExecution_startedAt :: Lens' JobExecution (Maybe UTCTime)

The time, in seconds since the epoch, when the job execution started.

jobExecution_status :: Lens' JobExecution (Maybe JobExecutionStatus)

The status of the job execution (IN_PROGRESS, QUEUED, FAILED, SUCCEEDED, TIMED_OUT, CANCELED, or REJECTED).

jobExecution_statusDetails :: Lens' JobExecution (Maybe JobExecutionStatusDetails)

A collection of name/value pairs that describe the status of the job execution.

jobExecution_thingArn :: Lens' JobExecution (Maybe Text)

The ARN of the thing on which the job execution is running.

jobExecution_versionNumber :: Lens' JobExecution (Maybe Integer)

The version of the job execution. Job execution versions are incremented each time they are updated by a device.