You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::Batch::Types::CancelJobRequest

Inherits:

Struct

Object
Struct
Aws::Batch::Types::CancelJobRequest

show all

Defined in:: (unknown)

Overview

Note:

When passing CancelJobRequest as input to an Aws::Client method, you can use a vanilla Hash:

{
  job_id: "String", # required
  reason: "String", # required
}

Instance Attribute Summary collapse

#job_id ⇒ String
The AWS Batch job ID of the job to cancel.
#reason ⇒ String
A message to attach to the job that explains the reason for canceling it.

Instance Attribute Details

#job_id ⇒ `String`

The AWS Batch job ID of the job to cancel.

Returns:

(String) —
The AWS Batch job ID of the job to cancel.

#reason ⇒ `String`

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