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

Class: Aws::Batch::Types::TerminateJobRequest

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 TerminateJobRequest data as a hash:

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

Instance Attribute Summary collapse

Instance Attribute Details

#job_idString

Job IDs to be terminated. Up to 100 jobs can be specified.

Returns:

  • (String)


1824
1825
1826
1827
1828
# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 1824

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

#reasonString

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. This message is also recorded in the AWS Batch activity logs.

Returns:

  • (String)


1824
1825
1826
1827
1828
# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 1824

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