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

Inherits:

Struct

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

show all

Defined in:: gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb

Overview

Contains the parameters for CancelJob.

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#job_id ⇒ String
The 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 Batch job ID of the job to cancel.

Returns:

(String)

# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 245

class CancelJobRequest < Struct.new(
  :job_id,
  :reason)
  SENSITIVE = []
  include Aws::Structure
end

#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. It is also recorded in the Batch activity logs.

This parameter has as limit of 1024 characters.