Skip to content

CancelJobRequest

Source code in docs_src/capo_iot/types/cancel_job_request.py 
14
15
16
17
18
19
20
21
22
class CancelJobRequest(TypedDict, closed=True):
    job_id: "capo_iot.types.job_id.JobId"
    """<p>The unique identifier you assigned to this job when it was created.</p>"""
    reason_code: NotRequired["capo_iot.types.reason_code.ReasonCode"]
    """<p>(Optional)A reason code string that explains why the job was canceled.</p>"""
    comment: NotRequired["capo_iot.types.comment.Comment"]
    """<p>An optional comment string describing why the job was canceled.</p>"""
    force: "capo_iot.types.force_flag.ForceFlag"
    """<p>(Optional) If <code>true</code> job executions with status "IN_PROGRESS" and "QUEUED" are canceled, otherwise only job executions with status "QUEUED" are canceled. The default is <code>false</code>.</p> <p>Canceling a job which is "IN_PROGRESS", will cause a device which is executing the job to be unable to update the job execution status. Use caution and ensure that each device executing a job which is canceled is able to recover to a valid state.</p>"""

comment instance-attribute 

comment: NotRequired[Comment]

An optional comment string describing why the job was canceled.

force instance-attribute 

force: ForceFlag

(Optional) If true job executions with status "IN_PROGRESS" and "QUEUED" are canceled, otherwise only job executions with status "QUEUED" are canceled. The default is false.

Canceling a job which is "IN_PROGRESS", will cause a device which is executing the job to be unable to update the job execution status. Use caution and ensure that each device executing a job which is canceled is able to recover to a valid state.

job_id instance-attribute 

job_id: JobId

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

reason_code instance-attribute 

reason_code: NotRequired[ReasonCode]

(Optional)A reason code string that explains why the job was canceled.