Documentation

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

See: newJobExecution smart constructor.

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.

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.

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.

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

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

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

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

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

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

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

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

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