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

Inherits:
Struct
  • Object
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

Instance Attribute Details

#job_idString

The Batch job ID of the job to cancel.

Returns:

  • (String)


172
173
174
175
176
177
# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 172

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

#reasonString

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 Batch activity logs.

Returns:

  • (String)


172
173
174
175
176
177
# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 172

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