Skip to content

TerminateJobRequest

Source code in docs_src/capo_batch/types/terminate_job_request.py
class TerminateJobRequest(TypedDict, closed=True):
    job_id: NotRequired["capo_batch.types.string.String"]
    """<p>The Batch job ID of the job to terminate.</p>"""
    reason: NotRequired["capo_batch.types.string.String"]
    """<p>A message to attach to the job that explains the reason for terminating 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 terminate.

reason instance-attribute

reason: NotRequired[String]

A message to attach to the job that explains the reason for terminating 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.