Skip to content

CancelJobRequest

Source code in docs_src/capo_batch/types/cancel_job_request.py 
11
12
13
14
15
class CancelJobRequest(TypedDict, closed=True):
    job_id: NotRequired["capo_batch.types.string.String"]
    """<p>The Batch job ID of the job to cancel.</p>"""
    reason: NotRequired["capo_batch.types.string.String"]
    """<p>A message to attach to the job that explains the reason for cancelling it. This message is returned by future <a>DescribeJobs</a> operations on the job. It is also recorded in the Batch activity logs.</p> <p>This parameter has a limit of 1024 characters.</p>"""

job_id instance-attribute 

job_id: NotRequired[String]

The Batch job ID of the job to cancel.

reason instance-attribute 

reason: NotRequired[String]

A message to attach to the job that explains the reason for cancelling it. This message is returned by future DescribeJobs operations on the job. It is also recorded in the Batch activity logs.

This parameter has a limit of 1024 characters.