Skip to content

JobExecution

Source code in docs_src/capo_iot_jobs_data_plane/types/job_execution.py
class JobExecution(TypedDict, closed=True):
    job_id: NotRequired["capo_iot_jobs_data_plane.types.job_id.JobId"]
    """<p>The unique identifier you assigned to this job when it was created.</p>"""
    thing_name: NotRequired["capo_iot_jobs_data_plane.types.thing_name.ThingName"]
    """<p>The name of the thing that is executing the job.</p>"""
    status: NotRequired[
        "capo_iot_jobs_data_plane.types.job_execution_status.JobExecutionStatus"
    ]
    """<p>The status of the job execution. Can be one of: "QUEUED", "IN_PROGRESS", "FAILED", "SUCCESS", "CANCELED", "TIMED_OUT", "REJECTED", or "REMOVED".</p>"""
    status_details: NotRequired["capo_iot_jobs_data_plane.types.details_map.DetailsMap"]
    """<p>A collection of name/value pairs that describe the status of the job execution.</p> <p>The maximum length of the value in the name/value pair is 1,024 characters.</p>"""
    queued_at: "capo_iot_jobs_data_plane.types.queued_at.QueuedAt"
    """<p>The time, in seconds since the epoch, when the job execution was enqueued.</p>"""
    started_at: NotRequired["capo_iot_jobs_data_plane.types.started_at.StartedAt"]
    """<p>The time, in seconds since the epoch, when the job execution was started.</p>"""
    last_updated_at: "capo_iot_jobs_data_plane.types.last_updated_at.LastUpdatedAt"
    """<p>The time, in seconds since the epoch, when the job execution was last updated. </p>"""
    approximate_seconds_before_timed_out: NotRequired[
        "capo_iot_jobs_data_plane.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 actual job execution timeout can occur up to 60 seconds later than the estimated duration.</p>"""
    version_number: "capo_iot_jobs_data_plane.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>"""
    execution_number: NotRequired[
        "capo_iot_jobs_data_plane.types.execution_number.ExecutionNumber"
    ]
    """<p>A number that identifies a particular job execution on a particular device. It can be used later in commands that return or update job execution information.</p>"""
    job_document: NotRequired["capo_iot_jobs_data_plane.types.job_document.JobDocument"]
    """<p>The content of the job document.</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 actual job execution timeout can occur up to 60 seconds later than the estimated duration.

execution_number instance-attribute

execution_number: NotRequired[ExecutionNumber]

A number that identifies a particular job execution on a particular device. It can be used later in commands that return or update job execution information.

job_document instance-attribute

job_document: NotRequired[JobDocument]

The content of the job document.

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: LastUpdatedAt

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

queued_at instance-attribute

queued_at: QueuedAt

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

started_at instance-attribute

started_at: NotRequired[StartedAt]

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

status instance-attribute

status: NotRequired[JobExecutionStatus]

The status of the job execution. Can be one of: "QUEUED", "IN_PROGRESS", "FAILED", "SUCCESS", "CANCELED", "TIMED_OUT", "REJECTED", or "REMOVED".

status_details instance-attribute

status_details: NotRequired[DetailsMap]

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

The maximum length of the value in the name/value pair is 1,024 characters.

thing_name instance-attribute

thing_name: NotRequired[ThingName]

The name of the thing that is executing the job.

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.