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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb

Overview

Note:

When making an API call, you may pass CancelJobRequest data as a hash:

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

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#job_idString

The AWS Batch job ID of the job to cancel.

Returns:

  • (String)


186
187
188
189
190
191
# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 186

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

Returns:

  • (String)


186
187
188
189
190
191
# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 186

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