Class: Aws::Batch::Types::CancelJobsRequest

Inherits:

Struct

Object
Struct
Aws::Batch::Types::CancelJobsRequest

show all

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

Overview

Specifies the jobs to cancel and the reason for the cancellation.

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#jobs ⇒ Array<String>
An array of up to 50 Batch job IDs of the jobs to cancel.
#reason ⇒ String
A message to attach to the job that explains the reason for cancelling it.

Instance Attribute Details

#jobs ⇒ `Array<String>`

An array of up to 50 Batch job IDs of the jobs to cancel.

Returns:

(Array<String>)

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

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

#reason ⇒ `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.