Skip to content

JobSummary

Source code in docs_src/capo_iot/types/job_summary.py
class JobSummary(TypedDict, closed=True):
    job_arn: NotRequired["capo_iot.types.job_arn.JobArn"]
    """<p>The job ARN.</p>"""
    job_id: NotRequired["capo_iot.types.job_id.JobId"]
    """<p>The unique identifier you assigned to this job when it was created.</p>"""
    thing_group_id: NotRequired["capo_iot.types.thing_group_id.ThingGroupId"]
    """<p>The ID of the thing group.</p>"""
    target_selection: NotRequired["capo_iot.types.target_selection.TargetSelection"]
    """<p>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.</p> <note> <p>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.</p> </note>"""
    status: NotRequired["capo_iot.types.job_status.JobStatus"]
    """<p>The job summary status.</p>"""
    created_at: NotRequired["capo_iot.types.date_type.DateType"]
    """<p>The time, in seconds since the epoch, when the job was created.</p>"""
    last_updated_at: NotRequired["capo_iot.types.date_type.DateType"]
    """<p>The time, in seconds since the epoch, when the job was last updated.</p>"""
    completed_at: NotRequired["capo_iot.types.date_type.DateType"]
    """<p>The time, in seconds since the epoch, when the job completed.</p>"""
    is_concurrent: NotRequired[
        "capo_iot.types.boolean_wrapper_object.BooleanWrapperObject"
    ]
    """<p>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.</p>"""

completed_at instance-attribute

completed_at: NotRequired[DateType]

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

created_at instance-attribute

created_at: NotRequired[DateType]

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

is_concurrent instance-attribute

is_concurrent: NotRequired[BooleanWrapperObject]

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.

job_arn instance-attribute

job_arn: NotRequired[JobArn]

The job ARN.

job_id instance-attribute

job_id: NotRequired[JobId]

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

last_updated_at instance-attribute

last_updated_at: NotRequired[DateType]

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

status instance-attribute

status: NotRequired[JobStatus]

The job summary status.

target_selection instance-attribute

target_selection: NotRequired[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.

thing_group_id instance-attribute

thing_group_id: NotRequired[ThingGroupId]

The ID of the thing group.