IoT / Client / cancel_job

cancel_job#

IoT.Client.cancel_job(**kwargs)#

Cancels a job.

Requires permission to access the CancelJob action.

Request Syntax

response = client.cancel_job(
    jobId='string',
    reasonCode='string',
    comment='string',
    force=True|False
)

Parameters:

jobId (string) –
[REQUIRED]

The unique identifier you assigned to this job when it was created.
reasonCode (string) – (Optional)A reason code string that explains why the job was canceled.
comment (string) – An optional comment string describing why the job was canceled.
force (boolean) –
(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.

Return type:

dict

Returns:

Response Syntax

{
    'jobArn': 'string',
    'jobId': 'string',
    'description': 'string'
}

Response Structure

Exceptions