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

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
}

Instance Attribute Summary collapse

Instance Attribute Details

#job_idString

The AWS Batch job ID of the job to cancel.

Returns:

  • (String)


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

class CancelJobRequest < Struct.new(
  :job_id,
  :reason)
  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)


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

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