Skip to content

CancelJobsRequest

Source code in docs_src/capo_batch/types/cancel_jobs_request.py 
12
13
14
15
16
class CancelJobsRequest(TypedDict, closed=True):
    jobs: NotRequired["capo_batch.types.string_list.StringList"]
    """<p>An array of up to 50 Batch job IDs of the jobs 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>"""

jobs instance-attribute 

jobs: NotRequired[StringList]

An array of up to 50 Batch job IDs of the jobs 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.