Documentation

The job summary.

See: newJobSummary smart constructor.

Create a value of JobSummary 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:completedAt:JobSummary', jobSummary_completedAt - The time, in seconds since the epoch, when the job completed.

$sel:createdAt:JobSummary', jobSummary_createdAt - The time, in seconds since the epoch, when the job was created.

$sel:isConcurrent:JobSummary', jobSummary_isConcurrent - Indicates whether a job is concurrent. Will be true when a job is rolling out new job executions or canceling previously created executions, otherwise false.

$sel:jobArn:JobSummary', jobSummary_jobArn - The job ARN.

$sel:jobId:JobSummary', jobSummary_jobId - The unique identifier you assigned to this job when it was created.

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

$sel:status:JobSummary', jobSummary_status - The job summary status.

$sel:targetSelection:JobSummary', jobSummary_targetSelection - Specifies whether the job will continue to run (CONTINUOUS), or will be complete after all those things specified as targets have completed the job (SNAPSHOT). If continuous, the job may also be run on a thing when a change is detected in a target. For example, a job will run on a thing when the thing is added to a target group, even after the job was completed by all things originally in the group.

We recommend that you use continuous jobs instead of snapshot jobs for dynamic thing group targets. By using continuous jobs, devices that join the group receive the job execution even after the job has been created.

$sel:thingGroupId:JobSummary', jobSummary_thingGroupId - The ID of the thing group.

The time, in seconds since the epoch, when the job completed.

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

Indicates whether a job is concurrent. Will be true when a job is rolling out new job executions or canceling previously created executions, otherwise false.

The job ARN.

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

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

The job summary status.

Specifies whether the job will continue to run (CONTINUOUS), or will be complete after all those things specified as targets have completed the job (SNAPSHOT). If continuous, the job may also be run on a thing when a change is detected in a target. For example, a job will run on a thing when the thing is added to a target group, even after the job was completed by all things originally in the group.

We recommend that you use continuous jobs instead of snapshot jobs for dynamic thing group targets. By using continuous jobs, devices that join the group receive the job execution even after the job has been created.

The ID of the thing group.