Skip to content

JobExecution

Source code in docs_src/capo_iot/types/job_execution.py
class JobExecution(TypedDict, closed=True):
    job_id: NotRequired["capo_iot.types.job_id.JobId"]
    """<p>The unique identifier you assigned to the job when it was created.</p>"""
    status: NotRequired["capo_iot.types.job_execution_status.JobExecutionStatus"]
    """<p>The status of the job execution (IN_PROGRESS, QUEUED, FAILED, SUCCEEDED, TIMED_OUT, CANCELED, or REJECTED).</p>"""
    force_canceled: NotRequired["capo_iot.types.forced.Forced"]
    """<p>Will be <code>true</code> if the job execution was canceled with the optional <code>force</code> parameter set to <code>true</code>.</p>"""
    status_details: NotRequired[
        "capo_iot.types.job_execution_status_details.JobExecutionStatusDetails"
    ]
    """<p>A collection of name/value pairs that describe the status of the job execution.</p>"""
    thing_arn: NotRequired["capo_iot.types.thing_arn.ThingArn"]
    """<p>The ARN of the thing on which the job execution is running.</p>"""
    queued_at: NotRequired["capo_iot.types.date_type.DateType"]
    """<p>The time, in seconds since the epoch, when the job execution was queued.</p>"""
    started_at: NotRequired["capo_iot.types.date_type.DateType"]
    """<p>The time, in seconds since the epoch, when the job execution started.</p>"""
    last_updated_at: NotRequired["capo_iot.types.date_type.DateType"]
    """<p>The time, in seconds since the epoch, when the job execution was last updated.</p>"""
    execution_number: NotRequired["capo_iot.types.execution_number.ExecutionNumber"]
    """<p>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. </p>"""
    version_number: "capo_iot.types.version_number.VersionNumber"
    """<p>The version of the job execution. Job execution versions are incremented each time they are updated by a device.</p>"""
    approximate_seconds_before_timed_out: NotRequired[
        "capo_iot.types.approximate_seconds_before_timed_out.ApproximateSecondsBeforeTimedOut"
    ]
    """<p>The estimated number of seconds that remain before the job execution status will be changed to <code>TIMED_OUT</code>. 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.</p>"""

approximate_seconds_before_timed_out instance-attribute

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

execution_number instance-attribute

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

force_canceled instance-attribute

force_canceled: NotRequired[Forced]

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

job_id instance-attribute

job_id: NotRequired[JobId]

The unique identifier you assigned to the 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 execution was last updated.

queued_at instance-attribute

queued_at: NotRequired[DateType]

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

started_at instance-attribute

started_at: NotRequired[DateType]

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

status instance-attribute

status: NotRequired[JobExecutionStatus]

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

status_details instance-attribute

status_details: NotRequired[JobExecutionStatusDetails]

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

thing_arn instance-attribute

thing_arn: NotRequired[ThingArn]

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

version_number instance-attribute

version_number: VersionNumber

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