aws-sdk-batch 1.0.0.rc1
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/lib/aws-sdk-batch.rb +47 -0
- data/lib/aws-sdk-batch/client.rb +1103 -0
- data/lib/aws-sdk-batch/client_api.rb +565 -0
- data/lib/aws-sdk-batch/customizations.rb +0 -0
- data/lib/aws-sdk-batch/errors.rb +14 -0
- data/lib/aws-sdk-batch/resource.rb +23 -0
- data/lib/aws-sdk-batch/types.rb +1785 -0
- metadata +80 -0
checksums.yaml
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
---
|
2
|
+
SHA1:
|
3
|
+
metadata.gz: e1b18741cd9dbbf4623867953705d34101a61e96
|
4
|
+
data.tar.gz: 511063841a6888b211b222d8f170a111fc23beb3
|
5
|
+
SHA512:
|
6
|
+
metadata.gz: 14ab93cee10b3e17960d9eb99aa876b10748b932dc36dd1963bfa7f2ce41b5acb2bfadd012b7d120ed326b1f93bae82c044ddcc04a83733e92fa7e10d4bf7608
|
7
|
+
data.tar.gz: 5086828ad9c837d4815227b4e63e24fbb396236ad885ce7b369097809e0c6a19c3f520a1bfe21f1531018df33c7a955f0821b2d2deb3a32813bd2861b171b9b2
|
@@ -0,0 +1,47 @@
|
|
1
|
+
# WARNING ABOUT GENERATED CODE
|
2
|
+
#
|
3
|
+
# This file is generated. See the contributing guide for more information:
|
4
|
+
# https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
|
5
|
+
#
|
6
|
+
# WARNING ABOUT GENERATED CODE
|
7
|
+
|
8
|
+
require 'aws-sdk-core'
|
9
|
+
require 'aws-sigv4'
|
10
|
+
|
11
|
+
require_relative 'aws-sdk-batch/types'
|
12
|
+
require_relative 'aws-sdk-batch/client_api'
|
13
|
+
require_relative 'aws-sdk-batch/client'
|
14
|
+
require_relative 'aws-sdk-batch/errors'
|
15
|
+
require_relative 'aws-sdk-batch/resource'
|
16
|
+
require_relative 'aws-sdk-batch/customizations'
|
17
|
+
|
18
|
+
# This module provides support for AWS Batch. This module is available in the
|
19
|
+
# `aws-sdk-batch` gem.
|
20
|
+
#
|
21
|
+
# # Client
|
22
|
+
#
|
23
|
+
# The {Client} class provides one method for each API operation. Operation
|
24
|
+
# methods each accept a hash of request parameters and return a response
|
25
|
+
# structure.
|
26
|
+
#
|
27
|
+
# See {Client} for more information.
|
28
|
+
#
|
29
|
+
# # Errors
|
30
|
+
#
|
31
|
+
# Errors returned from AWS Batch all
|
32
|
+
# extend {Errors::ServiceError}.
|
33
|
+
#
|
34
|
+
# begin
|
35
|
+
# # do stuff
|
36
|
+
# rescue Aws::Batch::Errors::ServiceError
|
37
|
+
# # rescues all service API errors
|
38
|
+
# end
|
39
|
+
#
|
40
|
+
# See {Errors} for more information.
|
41
|
+
#
|
42
|
+
# @service
|
43
|
+
module Aws::Batch
|
44
|
+
|
45
|
+
GEM_VERSION = '1.0.0.rc1'
|
46
|
+
|
47
|
+
end
|
@@ -0,0 +1,1103 @@
|
|
1
|
+
# WARNING ABOUT GENERATED CODE
|
2
|
+
#
|
3
|
+
# This file is generated. See the contributing guide for more information:
|
4
|
+
# https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
|
5
|
+
#
|
6
|
+
# WARNING ABOUT GENERATED CODE
|
7
|
+
|
8
|
+
require 'seahorse/client/plugins/content_length.rb'
|
9
|
+
require 'aws-sdk-core/plugins/credentials_configuration.rb'
|
10
|
+
require 'aws-sdk-core/plugins/logging.rb'
|
11
|
+
require 'aws-sdk-core/plugins/param_converter.rb'
|
12
|
+
require 'aws-sdk-core/plugins/param_validator.rb'
|
13
|
+
require 'aws-sdk-core/plugins/user_agent.rb'
|
14
|
+
require 'aws-sdk-core/plugins/helpful_socket_errors.rb'
|
15
|
+
require 'aws-sdk-core/plugins/retry_errors.rb'
|
16
|
+
require 'aws-sdk-core/plugins/global_configuration.rb'
|
17
|
+
require 'aws-sdk-core/plugins/regional_endpoint.rb'
|
18
|
+
require 'aws-sdk-core/plugins/response_paging.rb'
|
19
|
+
require 'aws-sdk-core/plugins/stub_responses.rb'
|
20
|
+
require 'aws-sdk-core/plugins/idempotency_token.rb'
|
21
|
+
require 'aws-sdk-core/plugins/signature_v4.rb'
|
22
|
+
require 'aws-sdk-core/plugins/protocols/rest_json.rb'
|
23
|
+
|
24
|
+
Aws::Plugins::GlobalConfiguration.add_identifier(:batch)
|
25
|
+
|
26
|
+
module Aws::Batch
|
27
|
+
class Client < Seahorse::Client::Base
|
28
|
+
|
29
|
+
include Aws::ClientStubs
|
30
|
+
|
31
|
+
@identifier = :batch
|
32
|
+
|
33
|
+
set_api(ClientApi::API)
|
34
|
+
|
35
|
+
add_plugin(Seahorse::Client::Plugins::ContentLength)
|
36
|
+
add_plugin(Aws::Plugins::CredentialsConfiguration)
|
37
|
+
add_plugin(Aws::Plugins::Logging)
|
38
|
+
add_plugin(Aws::Plugins::ParamConverter)
|
39
|
+
add_plugin(Aws::Plugins::ParamValidator)
|
40
|
+
add_plugin(Aws::Plugins::UserAgent)
|
41
|
+
add_plugin(Aws::Plugins::HelpfulSocketErrors)
|
42
|
+
add_plugin(Aws::Plugins::RetryErrors)
|
43
|
+
add_plugin(Aws::Plugins::GlobalConfiguration)
|
44
|
+
add_plugin(Aws::Plugins::RegionalEndpoint)
|
45
|
+
add_plugin(Aws::Plugins::ResponsePaging)
|
46
|
+
add_plugin(Aws::Plugins::StubResponses)
|
47
|
+
add_plugin(Aws::Plugins::IdempotencyToken)
|
48
|
+
add_plugin(Aws::Plugins::SignatureV4)
|
49
|
+
add_plugin(Aws::Plugins::Protocols::RestJson)
|
50
|
+
|
51
|
+
# @option options [required, Aws::CredentialProvider] :credentials
|
52
|
+
# Your AWS credentials. This can be an instance of any one of the
|
53
|
+
# following classes:
|
54
|
+
#
|
55
|
+
# * `Aws::Credentials` - Used for configuring static, non-refreshing
|
56
|
+
# credentials.
|
57
|
+
#
|
58
|
+
# * `Aws::InstanceProfileCredentials` - Used for loading credentials
|
59
|
+
# from an EC2 IMDS on an EC2 instance.
|
60
|
+
#
|
61
|
+
# * `Aws::SharedCredentials` - Used for loading credentials from a
|
62
|
+
# shared file, such as `~/.aws/config`.
|
63
|
+
#
|
64
|
+
# * `Aws::AssumeRoleCredentials` - Used when you need to assume a role.
|
65
|
+
#
|
66
|
+
# When `:credentials` are not configured directly, the following
|
67
|
+
# locations will be searched for credentials:
|
68
|
+
#
|
69
|
+
# * `Aws.config[:credentials]`
|
70
|
+
# * The `:access_key_id`, `:secret_access_key`, and `:session_token` options.
|
71
|
+
# * ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
|
72
|
+
# * `~/.aws/credentials`
|
73
|
+
# * `~/.aws/config`
|
74
|
+
# * EC2 IMDS instance profile - When used by default, the timeouts are
|
75
|
+
# very aggressive. Construct and pass an instance of
|
76
|
+
# `Aws::InstanceProfileCredentails` to enable retries and extended
|
77
|
+
# timeouts.
|
78
|
+
#
|
79
|
+
# @option options [required, String] :region
|
80
|
+
# The AWS region to connect to. The configured `:region` is
|
81
|
+
# used to determine the service `:endpoint`. When not passed,
|
82
|
+
# a default `:region` is search for in the following locations:
|
83
|
+
#
|
84
|
+
# * `Aws.config[:region]`
|
85
|
+
# * `ENV['AWS_REGION']`
|
86
|
+
# * `ENV['AMAZON_REGION']`
|
87
|
+
# * `ENV['AWS_DEFAULT_REGION']`
|
88
|
+
# * `~/.aws/credentials`
|
89
|
+
# * `~/.aws/config`
|
90
|
+
#
|
91
|
+
# @option options [String] :access_key_id
|
92
|
+
#
|
93
|
+
# @option options [Boolean] :convert_params (true)
|
94
|
+
# When `true`, an attempt is made to coerce request parameters into
|
95
|
+
# the required types.
|
96
|
+
#
|
97
|
+
# @option options [String] :endpoint
|
98
|
+
# The client endpoint is normally constructed from the `:region`
|
99
|
+
# option. You should only configure an `:endpoint` when connecting
|
100
|
+
# to test endpoints. This should be avalid HTTP(S) URI.
|
101
|
+
#
|
102
|
+
# @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
|
103
|
+
# The log formatter.
|
104
|
+
#
|
105
|
+
# @option options [Symbol] :log_level (:info)
|
106
|
+
# The log level to send messages to the `:logger` at.
|
107
|
+
#
|
108
|
+
# @option options [Logger] :logger
|
109
|
+
# The Logger instance to send log messages to. If this option
|
110
|
+
# is not set, logging will be disabled.
|
111
|
+
#
|
112
|
+
# @option options [String] :profile ("default")
|
113
|
+
# Used when loading credentials from the shared credentials file
|
114
|
+
# at HOME/.aws/credentials. When not specified, 'default' is used.
|
115
|
+
#
|
116
|
+
# @option options [Integer] :retry_limit (3)
|
117
|
+
# The maximum number of times to retry failed requests. Only
|
118
|
+
# ~ 500 level server errors and certain ~ 400 level client errors
|
119
|
+
# are retried. Generally, these are throttling errors, data
|
120
|
+
# checksum errors, networking errors, timeout errors and auth
|
121
|
+
# errors from expired credentials.
|
122
|
+
#
|
123
|
+
# @option options [String] :secret_access_key
|
124
|
+
#
|
125
|
+
# @option options [String] :session_token
|
126
|
+
#
|
127
|
+
# @option options [Boolean] :stub_responses (false)
|
128
|
+
# Causes the client to return stubbed responses. By default
|
129
|
+
# fake responses are generated and returned. You can specify
|
130
|
+
# the response data to return or errors to raise by calling
|
131
|
+
# {ClientStubs#stub_responses}. See {ClientStubs} for more information.
|
132
|
+
#
|
133
|
+
# ** Please note ** When response stubbing is enabled, no HTTP
|
134
|
+
# requests are made, and retries are disabled.
|
135
|
+
#
|
136
|
+
# @option options [Boolean] :validate_params (true)
|
137
|
+
# When `true`, request parameters are validated before
|
138
|
+
# sending the request.
|
139
|
+
#
|
140
|
+
def initialize(*args)
|
141
|
+
super
|
142
|
+
end
|
143
|
+
|
144
|
+
# @!group API Operations
|
145
|
+
|
146
|
+
# Cancels jobs in an AWS Batch job queue. Jobs that are in the
|
147
|
+
# `SUBMITTED`, `PENDING`, or `RUNNABLE` state are cancelled. Jobs that
|
148
|
+
# have progressed to `STARTING` or `RUNNING` are not cancelled (but the
|
149
|
+
# API operation still succeeds, even if no jobs are cancelled); these
|
150
|
+
# jobs must be terminated with the TerminateJob operation.
|
151
|
+
#
|
152
|
+
# @option params [required, String] :job_id
|
153
|
+
# A list of up to 100 job IDs to cancel.
|
154
|
+
#
|
155
|
+
# @option params [required, String] :reason
|
156
|
+
# A message to attach to the job that explains the reason for cancelling
|
157
|
+
# it. This message is returned by future DescribeJobs operations on the
|
158
|
+
# job. This message is also recorded in the AWS Batch activity logs.
|
159
|
+
#
|
160
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
161
|
+
#
|
162
|
+
# @example Request syntax with placeholder values
|
163
|
+
#
|
164
|
+
# resp = client.cancel_job({
|
165
|
+
# job_id: "String", # required
|
166
|
+
# reason: "String", # required
|
167
|
+
# })
|
168
|
+
#
|
169
|
+
# @overload cancel_job(params = {})
|
170
|
+
# @param [Hash] params ({})
|
171
|
+
def cancel_job(params = {}, options = {})
|
172
|
+
req = build_request(:cancel_job, params)
|
173
|
+
req.send_request(options)
|
174
|
+
end
|
175
|
+
|
176
|
+
# Creates an AWS Batch compute environment. You can create `MANAGED` or
|
177
|
+
# `UNMANAGED`compute environments.
|
178
|
+
#
|
179
|
+
# In a managed compute environment, AWS Batch manages the compute
|
180
|
+
# resources within the environment, based on the compute resources that
|
181
|
+
# you specify. Instances launched into a managed compute environment use
|
182
|
+
# the latest Amazon ECS-optimized AMI. You can choose to use Amazon EC2
|
183
|
+
# On-Demand instances in your managed compute environment, or you can
|
184
|
+
# use Amazon EC2 Spot instances that only launch when the Spot bid price
|
185
|
+
# is below a specified percentage of the On-Demand price.
|
186
|
+
#
|
187
|
+
# In an unmanaged compute environment, you can manage your own compute
|
188
|
+
# resources. This provides more compute resource configuration options,
|
189
|
+
# such as using a custom AMI, but you must ensure that your AMI meets
|
190
|
+
# the Amazon ECS container instance AMI specification. For more
|
191
|
+
# information, see [Container Instance AMIs][1] in the *Amazon EC2
|
192
|
+
# Container Service Developer Guide*. After you have created your
|
193
|
+
# unmanaged compute environment, you can use the
|
194
|
+
# DescribeComputeEnvironments operation to find the Amazon ECS cluster
|
195
|
+
# that is associated with it and then manually launch your container
|
196
|
+
# instances into that Amazon ECS cluster. For more information, see
|
197
|
+
# [Launching an Amazon ECS Container Instance][2] in the *Amazon EC2
|
198
|
+
# Container Service Developer Guide*.
|
199
|
+
#
|
200
|
+
#
|
201
|
+
#
|
202
|
+
# [1]: http://docs.aws.amazon.com/AmazonECS/latest/developerguide/container_instance_AMIs.html
|
203
|
+
# [2]: http://docs.aws.amazon.com/AmazonECS/latest/developerguide/launch_container_instance.html
|
204
|
+
#
|
205
|
+
# @option params [required, String] :compute_environment_name
|
206
|
+
# The name for your compute environment. Up to 128 letters (uppercase
|
207
|
+
# and lowercase), numbers, and underscores are allowed.
|
208
|
+
#
|
209
|
+
# @option params [required, String] :type
|
210
|
+
# The type of the compute environment.
|
211
|
+
#
|
212
|
+
# @option params [String] :state
|
213
|
+
# The state of the compute environment. If the state is `ENABLED`, then
|
214
|
+
# the compute environment accepts jobs from a queue and can scale out
|
215
|
+
# automatically based on queues.
|
216
|
+
#
|
217
|
+
# @option params [Types::ComputeResource] :compute_resources
|
218
|
+
# Details of the compute resources managed by the compute environment.
|
219
|
+
# This parameter is required for managed compute environments.
|
220
|
+
#
|
221
|
+
# @option params [required, String] :service_role
|
222
|
+
# The full Amazon Resource Name (ARN) of the IAM role that allows AWS
|
223
|
+
# Batch to make calls to other AWS services on your behalf.
|
224
|
+
#
|
225
|
+
# @return [Types::CreateComputeEnvironmentResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
226
|
+
#
|
227
|
+
# * {Types::CreateComputeEnvironmentResponse#compute_environment_name #compute_environment_name} => String
|
228
|
+
# * {Types::CreateComputeEnvironmentResponse#compute_environment_arn #compute_environment_arn} => String
|
229
|
+
#
|
230
|
+
# @example Request syntax with placeholder values
|
231
|
+
#
|
232
|
+
# resp = client.create_compute_environment({
|
233
|
+
# compute_environment_name: "String", # required
|
234
|
+
# type: "MANAGED", # required, accepts MANAGED, UNMANAGED
|
235
|
+
# state: "ENABLED", # accepts ENABLED, DISABLED
|
236
|
+
# compute_resources: {
|
237
|
+
# type: "EC2", # required, accepts EC2, SPOT
|
238
|
+
# minv_cpus: 1, # required
|
239
|
+
# maxv_cpus: 1, # required
|
240
|
+
# desiredv_cpus: 1,
|
241
|
+
# instance_types: ["String"], # required
|
242
|
+
# subnets: ["String"], # required
|
243
|
+
# security_group_ids: ["String"], # required
|
244
|
+
# ec2_key_pair: "String",
|
245
|
+
# instance_role: "String", # required
|
246
|
+
# tags: {
|
247
|
+
# "String" => "String",
|
248
|
+
# },
|
249
|
+
# bid_percentage: 1,
|
250
|
+
# spot_iam_fleet_role: "String",
|
251
|
+
# },
|
252
|
+
# service_role: "String", # required
|
253
|
+
# })
|
254
|
+
#
|
255
|
+
# @example Response structure
|
256
|
+
#
|
257
|
+
# resp.compute_environment_name #=> String
|
258
|
+
# resp.compute_environment_arn #=> String
|
259
|
+
#
|
260
|
+
# @overload create_compute_environment(params = {})
|
261
|
+
# @param [Hash] params ({})
|
262
|
+
def create_compute_environment(params = {}, options = {})
|
263
|
+
req = build_request(:create_compute_environment, params)
|
264
|
+
req.send_request(options)
|
265
|
+
end
|
266
|
+
|
267
|
+
# Creates an AWS Batch job queue. When you create a job queue, you
|
268
|
+
# associate one or more compute environments to the queue and assign an
|
269
|
+
# order of preference for the compute environments.
|
270
|
+
#
|
271
|
+
# You also set a priority to the job queue that determines the order in
|
272
|
+
# which the AWS Batch scheduler places jobs onto its associated compute
|
273
|
+
# environments. For example, if a compute environment is associated with
|
274
|
+
# more than one job queue, the job queue with a higher priority is given
|
275
|
+
# preference for scheduling jobs to that compute environment.
|
276
|
+
#
|
277
|
+
# @option params [required, String] :job_queue_name
|
278
|
+
# The name of the job queue.
|
279
|
+
#
|
280
|
+
# @option params [String] :state
|
281
|
+
# The state of the job queue. If the job queue state is `ENABLED`, it is
|
282
|
+
# able to accept jobs.
|
283
|
+
#
|
284
|
+
# @option params [required, Integer] :priority
|
285
|
+
# The priority of the job queue. Job queues with a higher priority (or a
|
286
|
+
# lower integer value for the `priority` parameter) are evaluated first
|
287
|
+
# when associated with same compute environment. Priority is determined
|
288
|
+
# in ascending order, for example, a job queue with a priority value of
|
289
|
+
# `1` is given scheduling preference over a job queue with a priority
|
290
|
+
# value of `10`.
|
291
|
+
#
|
292
|
+
# @option params [required, Array<Types::ComputeEnvironmentOrder>] :compute_environment_order
|
293
|
+
# The set of compute environments mapped to a job queue and their order
|
294
|
+
# relative to each other. The job scheduler uses this parameter to
|
295
|
+
# determine which compute environment should execute a given job.
|
296
|
+
# Compute environments must be in the `VALID` state before you can
|
297
|
+
# associate them with a job queue. You can associate up to 3 compute
|
298
|
+
# environments with a job queue.
|
299
|
+
#
|
300
|
+
# @return [Types::CreateJobQueueResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
301
|
+
#
|
302
|
+
# * {Types::CreateJobQueueResponse#job_queue_name #job_queue_name} => String
|
303
|
+
# * {Types::CreateJobQueueResponse#job_queue_arn #job_queue_arn} => String
|
304
|
+
#
|
305
|
+
# @example Request syntax with placeholder values
|
306
|
+
#
|
307
|
+
# resp = client.create_job_queue({
|
308
|
+
# job_queue_name: "String", # required
|
309
|
+
# state: "ENABLED", # accepts ENABLED, DISABLED
|
310
|
+
# priority: 1, # required
|
311
|
+
# compute_environment_order: [ # required
|
312
|
+
# {
|
313
|
+
# order: 1, # required
|
314
|
+
# compute_environment: "String", # required
|
315
|
+
# },
|
316
|
+
# ],
|
317
|
+
# })
|
318
|
+
#
|
319
|
+
# @example Response structure
|
320
|
+
#
|
321
|
+
# resp.job_queue_name #=> String
|
322
|
+
# resp.job_queue_arn #=> String
|
323
|
+
#
|
324
|
+
# @overload create_job_queue(params = {})
|
325
|
+
# @param [Hash] params ({})
|
326
|
+
def create_job_queue(params = {}, options = {})
|
327
|
+
req = build_request(:create_job_queue, params)
|
328
|
+
req.send_request(options)
|
329
|
+
end
|
330
|
+
|
331
|
+
# Deletes an AWS Batch compute environment.
|
332
|
+
#
|
333
|
+
# Before you can delete a compute environment, you must set its state to
|
334
|
+
# `DISABLED` with the UpdateComputeEnvironment API operation and
|
335
|
+
# disassociate it from any job queues with the UpdateJobQueue API
|
336
|
+
# operation.
|
337
|
+
#
|
338
|
+
# @option params [required, String] :compute_environment
|
339
|
+
# The name or Amazon Resource Name (ARN) of the compute environment to
|
340
|
+
# delete.
|
341
|
+
#
|
342
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
343
|
+
#
|
344
|
+
# @example Request syntax with placeholder values
|
345
|
+
#
|
346
|
+
# resp = client.delete_compute_environment({
|
347
|
+
# compute_environment: "String", # required
|
348
|
+
# })
|
349
|
+
#
|
350
|
+
# @overload delete_compute_environment(params = {})
|
351
|
+
# @param [Hash] params ({})
|
352
|
+
def delete_compute_environment(params = {}, options = {})
|
353
|
+
req = build_request(:delete_compute_environment, params)
|
354
|
+
req.send_request(options)
|
355
|
+
end
|
356
|
+
|
357
|
+
# Deletes the specified job queue. You must first disable submissions
|
358
|
+
# for a queue with the UpdateJobQueue operation and terminate any jobs
|
359
|
+
# that have not completed with the TerminateJob.
|
360
|
+
#
|
361
|
+
# It is not necessary to disassociate compute environments from a queue
|
362
|
+
# before submitting a `DeleteJobQueue` request.
|
363
|
+
#
|
364
|
+
# @option params [required, String] :job_queue
|
365
|
+
# The short name or full Amazon Resource Name (ARN) of the queue to
|
366
|
+
# delete.
|
367
|
+
#
|
368
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
369
|
+
#
|
370
|
+
# @example Request syntax with placeholder values
|
371
|
+
#
|
372
|
+
# resp = client.delete_job_queue({
|
373
|
+
# job_queue: "String", # required
|
374
|
+
# })
|
375
|
+
#
|
376
|
+
# @overload delete_job_queue(params = {})
|
377
|
+
# @param [Hash] params ({})
|
378
|
+
def delete_job_queue(params = {}, options = {})
|
379
|
+
req = build_request(:delete_job_queue, params)
|
380
|
+
req.send_request(options)
|
381
|
+
end
|
382
|
+
|
383
|
+
# Deregisters an AWS Batch job definition.
|
384
|
+
#
|
385
|
+
# @option params [required, String] :job_definition
|
386
|
+
# The name and revision (`name:revision`) or full Amazon Resource Name
|
387
|
+
# (ARN) of the job definition to deregister.
|
388
|
+
#
|
389
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
390
|
+
#
|
391
|
+
# @example Request syntax with placeholder values
|
392
|
+
#
|
393
|
+
# resp = client.deregister_job_definition({
|
394
|
+
# job_definition: "String", # required
|
395
|
+
# })
|
396
|
+
#
|
397
|
+
# @overload deregister_job_definition(params = {})
|
398
|
+
# @param [Hash] params ({})
|
399
|
+
def deregister_job_definition(params = {}, options = {})
|
400
|
+
req = build_request(:deregister_job_definition, params)
|
401
|
+
req.send_request(options)
|
402
|
+
end
|
403
|
+
|
404
|
+
# Describes one or more of your compute environments.
|
405
|
+
#
|
406
|
+
# If you are using an unmanaged compute environment, you can use the
|
407
|
+
# `DescribeComputeEnvironment` operation to determine the
|
408
|
+
# `ecsClusterArn` that you should launch your Amazon ECS container
|
409
|
+
# instances into.
|
410
|
+
#
|
411
|
+
# @option params [Array<String>] :compute_environments
|
412
|
+
# A list of up to 100 compute environment names or full Amazon Resource
|
413
|
+
# Name (ARN) entries.
|
414
|
+
#
|
415
|
+
# @option params [Integer] :max_results
|
416
|
+
# The maximum number of cluster results returned by
|
417
|
+
# `DescribeComputeEnvironments` in paginated output. When this parameter
|
418
|
+
# is used, `DescribeComputeEnvironments` only returns `maxResults`
|
419
|
+
# results in a single page along with a `nextToken` response element.
|
420
|
+
# The remaining results of the initial request can be seen by sending
|
421
|
+
# another `DescribeComputeEnvironments` request with the returned
|
422
|
+
# `nextToken` value. This value can be between 1 and 100. If this
|
423
|
+
# parameter is not used, then `DescribeComputeEnvironments` returns up
|
424
|
+
# to 100 results and a `nextToken` value if applicable.
|
425
|
+
#
|
426
|
+
# @option params [String] :next_token
|
427
|
+
# The `nextToken` value returned from a previous paginated
|
428
|
+
# `DescribeComputeEnvironments` request where `maxResults` was used and
|
429
|
+
# the results exceeded the value of that parameter. Pagination continues
|
430
|
+
# from the end of the previous results that returned the `nextToken`
|
431
|
+
# value. This value is `null` when there are no more results to return.
|
432
|
+
#
|
433
|
+
# <note markdown="1"> This token should be treated as an opaque identifier that is only used
|
434
|
+
# to retrieve the next items in a list and not for other programmatic
|
435
|
+
# purposes.
|
436
|
+
#
|
437
|
+
# </note>
|
438
|
+
#
|
439
|
+
# @return [Types::DescribeComputeEnvironmentsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
440
|
+
#
|
441
|
+
# * {Types::DescribeComputeEnvironmentsResponse#compute_environments #compute_environments} => Array<Types::ComputeEnvironmentDetail>
|
442
|
+
# * {Types::DescribeComputeEnvironmentsResponse#next_token #next_token} => String
|
443
|
+
#
|
444
|
+
# @example Request syntax with placeholder values
|
445
|
+
#
|
446
|
+
# resp = client.describe_compute_environments({
|
447
|
+
# compute_environments: ["String"],
|
448
|
+
# max_results: 1,
|
449
|
+
# next_token: "String",
|
450
|
+
# })
|
451
|
+
#
|
452
|
+
# @example Response structure
|
453
|
+
#
|
454
|
+
# resp.compute_environments #=> Array
|
455
|
+
# resp.compute_environments[0].compute_environment_name #=> String
|
456
|
+
# resp.compute_environments[0].compute_environment_arn #=> String
|
457
|
+
# resp.compute_environments[0].ecs_cluster_arn #=> String
|
458
|
+
# resp.compute_environments[0].type #=> String, one of "MANAGED", "UNMANAGED"
|
459
|
+
# resp.compute_environments[0].state #=> String, one of "ENABLED", "DISABLED"
|
460
|
+
# resp.compute_environments[0].status #=> String, one of "CREATING", "UPDATING", "DELETING", "DELETED", "VALID", "INVALID"
|
461
|
+
# resp.compute_environments[0].status_reason #=> String
|
462
|
+
# resp.compute_environments[0].compute_resources.type #=> String, one of "EC2", "SPOT"
|
463
|
+
# resp.compute_environments[0].compute_resources.minv_cpus #=> Integer
|
464
|
+
# resp.compute_environments[0].compute_resources.maxv_cpus #=> Integer
|
465
|
+
# resp.compute_environments[0].compute_resources.desiredv_cpus #=> Integer
|
466
|
+
# resp.compute_environments[0].compute_resources.instance_types #=> Array
|
467
|
+
# resp.compute_environments[0].compute_resources.instance_types[0] #=> String
|
468
|
+
# resp.compute_environments[0].compute_resources.subnets #=> Array
|
469
|
+
# resp.compute_environments[0].compute_resources.subnets[0] #=> String
|
470
|
+
# resp.compute_environments[0].compute_resources.security_group_ids #=> Array
|
471
|
+
# resp.compute_environments[0].compute_resources.security_group_ids[0] #=> String
|
472
|
+
# resp.compute_environments[0].compute_resources.ec2_key_pair #=> String
|
473
|
+
# resp.compute_environments[0].compute_resources.instance_role #=> String
|
474
|
+
# resp.compute_environments[0].compute_resources.tags #=> Hash
|
475
|
+
# resp.compute_environments[0].compute_resources.tags["String"] #=> String
|
476
|
+
# resp.compute_environments[0].compute_resources.bid_percentage #=> Integer
|
477
|
+
# resp.compute_environments[0].compute_resources.spot_iam_fleet_role #=> String
|
478
|
+
# resp.compute_environments[0].service_role #=> String
|
479
|
+
# resp.next_token #=> String
|
480
|
+
#
|
481
|
+
# @overload describe_compute_environments(params = {})
|
482
|
+
# @param [Hash] params ({})
|
483
|
+
def describe_compute_environments(params = {}, options = {})
|
484
|
+
req = build_request(:describe_compute_environments, params)
|
485
|
+
req.send_request(options)
|
486
|
+
end
|
487
|
+
|
488
|
+
# Describes a list of job definitions. You can specify a `status` (such
|
489
|
+
# as `ACTIVE`) to only return job definitions that match that status.
|
490
|
+
#
|
491
|
+
# @option params [Array<String>] :job_definitions
|
492
|
+
# A space-separated list of up to 100 job definition names or full
|
493
|
+
# Amazon Resource Name (ARN) entries.
|
494
|
+
#
|
495
|
+
# @option params [Integer] :max_results
|
496
|
+
# The maximum number of results returned by `DescribeJobDefinitions` in
|
497
|
+
# paginated output. When this parameter is used,
|
498
|
+
# `DescribeJobDefinitions` only returns `maxResults` results in a single
|
499
|
+
# page along with a `nextToken` response element. The remaining results
|
500
|
+
# of the initial request can be seen by sending another
|
501
|
+
# `DescribeJobDefinitions` request with the returned `nextToken` value.
|
502
|
+
# This value can be between 1 and 100. If this parameter is not used,
|
503
|
+
# then `DescribeJobDefinitions` returns up to 100 results and a
|
504
|
+
# `nextToken` value if applicable.
|
505
|
+
#
|
506
|
+
# @option params [String] :job_definition_name
|
507
|
+
# The name of the job definition to describe.
|
508
|
+
#
|
509
|
+
# @option params [String] :status
|
510
|
+
# The status with which to filter job definitions.
|
511
|
+
#
|
512
|
+
# @option params [String] :next_token
|
513
|
+
# The `nextToken` value returned from a previous paginated
|
514
|
+
# `DescribeJobDefinitions` request where `maxResults` was used and the
|
515
|
+
# results exceeded the value of that parameter. Pagination continues
|
516
|
+
# from the end of the previous results that returned the `nextToken`
|
517
|
+
# value. This value is `null` when there are no more results to return.
|
518
|
+
#
|
519
|
+
# <note markdown="1"> This token should be treated as an opaque identifier that is only used
|
520
|
+
# to retrieve the next items in a list and not for other programmatic
|
521
|
+
# purposes.
|
522
|
+
#
|
523
|
+
# </note>
|
524
|
+
#
|
525
|
+
# @return [Types::DescribeJobDefinitionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
526
|
+
#
|
527
|
+
# * {Types::DescribeJobDefinitionsResponse#job_definitions #job_definitions} => Array<Types::JobDefinition>
|
528
|
+
# * {Types::DescribeJobDefinitionsResponse#next_token #next_token} => String
|
529
|
+
#
|
530
|
+
# @example Request syntax with placeholder values
|
531
|
+
#
|
532
|
+
# resp = client.describe_job_definitions({
|
533
|
+
# job_definitions: ["String"],
|
534
|
+
# max_results: 1,
|
535
|
+
# job_definition_name: "String",
|
536
|
+
# status: "String",
|
537
|
+
# next_token: "String",
|
538
|
+
# })
|
539
|
+
#
|
540
|
+
# @example Response structure
|
541
|
+
#
|
542
|
+
# resp.job_definitions #=> Array
|
543
|
+
# resp.job_definitions[0].job_definition_name #=> String
|
544
|
+
# resp.job_definitions[0].job_definition_arn #=> String
|
545
|
+
# resp.job_definitions[0].revision #=> Integer
|
546
|
+
# resp.job_definitions[0].status #=> String
|
547
|
+
# resp.job_definitions[0].type #=> String
|
548
|
+
# resp.job_definitions[0].parameters #=> Hash
|
549
|
+
# resp.job_definitions[0].parameters["String"] #=> String
|
550
|
+
# resp.job_definitions[0].container_properties.image #=> String
|
551
|
+
# resp.job_definitions[0].container_properties.vcpus #=> Integer
|
552
|
+
# resp.job_definitions[0].container_properties.memory #=> Integer
|
553
|
+
# resp.job_definitions[0].container_properties.command #=> Array
|
554
|
+
# resp.job_definitions[0].container_properties.command[0] #=> String
|
555
|
+
# resp.job_definitions[0].container_properties.job_role_arn #=> String
|
556
|
+
# resp.job_definitions[0].container_properties.volumes #=> Array
|
557
|
+
# resp.job_definitions[0].container_properties.volumes[0].host.source_path #=> String
|
558
|
+
# resp.job_definitions[0].container_properties.volumes[0].name #=> String
|
559
|
+
# resp.job_definitions[0].container_properties.environment #=> Array
|
560
|
+
# resp.job_definitions[0].container_properties.environment[0].name #=> String
|
561
|
+
# resp.job_definitions[0].container_properties.environment[0].value #=> String
|
562
|
+
# resp.job_definitions[0].container_properties.mount_points #=> Array
|
563
|
+
# resp.job_definitions[0].container_properties.mount_points[0].container_path #=> String
|
564
|
+
# resp.job_definitions[0].container_properties.mount_points[0].read_only #=> Boolean
|
565
|
+
# resp.job_definitions[0].container_properties.mount_points[0].source_volume #=> String
|
566
|
+
# resp.job_definitions[0].container_properties.readonly_root_filesystem #=> Boolean
|
567
|
+
# resp.job_definitions[0].container_properties.privileged #=> Boolean
|
568
|
+
# resp.job_definitions[0].container_properties.ulimits #=> Array
|
569
|
+
# resp.job_definitions[0].container_properties.ulimits[0].hard_limit #=> Integer
|
570
|
+
# resp.job_definitions[0].container_properties.ulimits[0].name #=> String
|
571
|
+
# resp.job_definitions[0].container_properties.ulimits[0].soft_limit #=> Integer
|
572
|
+
# resp.job_definitions[0].container_properties.user #=> String
|
573
|
+
# resp.next_token #=> String
|
574
|
+
#
|
575
|
+
# @overload describe_job_definitions(params = {})
|
576
|
+
# @param [Hash] params ({})
|
577
|
+
def describe_job_definitions(params = {}, options = {})
|
578
|
+
req = build_request(:describe_job_definitions, params)
|
579
|
+
req.send_request(options)
|
580
|
+
end
|
581
|
+
|
582
|
+
# Describes one or more of your job queues.
|
583
|
+
#
|
584
|
+
# @option params [Array<String>] :job_queues
|
585
|
+
# A list of up to 100 queue names or full queue Amazon Resource Name
|
586
|
+
# (ARN) entries.
|
587
|
+
#
|
588
|
+
# @option params [Integer] :max_results
|
589
|
+
# The maximum number of results returned by `DescribeJobQueues` in
|
590
|
+
# paginated output. When this parameter is used, `DescribeJobQueues`
|
591
|
+
# only returns `maxResults` results in a single page along with a
|
592
|
+
# `nextToken` response element. The remaining results of the initial
|
593
|
+
# request can be seen by sending another `DescribeJobQueues` request
|
594
|
+
# with the returned `nextToken` value. This value can be between 1 and
|
595
|
+
# 100. If this parameter is not used, then `DescribeJobQueues` returns
|
596
|
+
# up to 100 results and a `nextToken` value if applicable.
|
597
|
+
#
|
598
|
+
# @option params [String] :next_token
|
599
|
+
# The `nextToken` value returned from a previous paginated
|
600
|
+
# `DescribeJobQueues` request where `maxResults` was used and the
|
601
|
+
# results exceeded the value of that parameter. Pagination continues
|
602
|
+
# from the end of the previous results that returned the `nextToken`
|
603
|
+
# value. This value is `null` when there are no more results to return.
|
604
|
+
#
|
605
|
+
# <note markdown="1"> This token should be treated as an opaque identifier that is only used
|
606
|
+
# to retrieve the next items in a list and not for other programmatic
|
607
|
+
# purposes.
|
608
|
+
#
|
609
|
+
# </note>
|
610
|
+
#
|
611
|
+
# @return [Types::DescribeJobQueuesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
612
|
+
#
|
613
|
+
# * {Types::DescribeJobQueuesResponse#job_queues #job_queues} => Array<Types::JobQueueDetail>
|
614
|
+
# * {Types::DescribeJobQueuesResponse#next_token #next_token} => String
|
615
|
+
#
|
616
|
+
# @example Request syntax with placeholder values
|
617
|
+
#
|
618
|
+
# resp = client.describe_job_queues({
|
619
|
+
# job_queues: ["String"],
|
620
|
+
# max_results: 1,
|
621
|
+
# next_token: "String",
|
622
|
+
# })
|
623
|
+
#
|
624
|
+
# @example Response structure
|
625
|
+
#
|
626
|
+
# resp.job_queues #=> Array
|
627
|
+
# resp.job_queues[0].job_queue_name #=> String
|
628
|
+
# resp.job_queues[0].job_queue_arn #=> String
|
629
|
+
# resp.job_queues[0].state #=> String, one of "ENABLED", "DISABLED"
|
630
|
+
# resp.job_queues[0].status #=> String, one of "CREATING", "UPDATING", "DELETING", "DELETED", "VALID", "INVALID"
|
631
|
+
# resp.job_queues[0].status_reason #=> String
|
632
|
+
# resp.job_queues[0].priority #=> Integer
|
633
|
+
# resp.job_queues[0].compute_environment_order #=> Array
|
634
|
+
# resp.job_queues[0].compute_environment_order[0].order #=> Integer
|
635
|
+
# resp.job_queues[0].compute_environment_order[0].compute_environment #=> String
|
636
|
+
# resp.next_token #=> String
|
637
|
+
#
|
638
|
+
# @overload describe_job_queues(params = {})
|
639
|
+
# @param [Hash] params ({})
|
640
|
+
def describe_job_queues(params = {}, options = {})
|
641
|
+
req = build_request(:describe_job_queues, params)
|
642
|
+
req.send_request(options)
|
643
|
+
end
|
644
|
+
|
645
|
+
# Describes a list of AWS Batch jobs.
|
646
|
+
#
|
647
|
+
# @option params [required, Array<String>] :jobs
|
648
|
+
# A space-separated list of up to 100 job IDs.
|
649
|
+
#
|
650
|
+
# @return [Types::DescribeJobsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
651
|
+
#
|
652
|
+
# * {Types::DescribeJobsResponse#jobs #jobs} => Array<Types::JobDetail>
|
653
|
+
#
|
654
|
+
# @example Request syntax with placeholder values
|
655
|
+
#
|
656
|
+
# resp = client.describe_jobs({
|
657
|
+
# jobs: ["String"], # required
|
658
|
+
# })
|
659
|
+
#
|
660
|
+
# @example Response structure
|
661
|
+
#
|
662
|
+
# resp.jobs #=> Array
|
663
|
+
# resp.jobs[0].job_name #=> String
|
664
|
+
# resp.jobs[0].job_id #=> String
|
665
|
+
# resp.jobs[0].job_queue #=> String
|
666
|
+
# resp.jobs[0].status #=> String, one of "SUBMITTED", "PENDING", "RUNNABLE", "STARTING", "RUNNING", "SUCCEEDED", "FAILED"
|
667
|
+
# resp.jobs[0].status_reason #=> String
|
668
|
+
# resp.jobs[0].created_at #=> Integer
|
669
|
+
# resp.jobs[0].started_at #=> Integer
|
670
|
+
# resp.jobs[0].stopped_at #=> Integer
|
671
|
+
# resp.jobs[0].depends_on #=> Array
|
672
|
+
# resp.jobs[0].depends_on[0].job_id #=> String
|
673
|
+
# resp.jobs[0].job_definition #=> String
|
674
|
+
# resp.jobs[0].parameters #=> Hash
|
675
|
+
# resp.jobs[0].parameters["String"] #=> String
|
676
|
+
# resp.jobs[0].container.image #=> String
|
677
|
+
# resp.jobs[0].container.vcpus #=> Integer
|
678
|
+
# resp.jobs[0].container.memory #=> Integer
|
679
|
+
# resp.jobs[0].container.command #=> Array
|
680
|
+
# resp.jobs[0].container.command[0] #=> String
|
681
|
+
# resp.jobs[0].container.job_role_arn #=> String
|
682
|
+
# resp.jobs[0].container.volumes #=> Array
|
683
|
+
# resp.jobs[0].container.volumes[0].host.source_path #=> String
|
684
|
+
# resp.jobs[0].container.volumes[0].name #=> String
|
685
|
+
# resp.jobs[0].container.environment #=> Array
|
686
|
+
# resp.jobs[0].container.environment[0].name #=> String
|
687
|
+
# resp.jobs[0].container.environment[0].value #=> String
|
688
|
+
# resp.jobs[0].container.mount_points #=> Array
|
689
|
+
# resp.jobs[0].container.mount_points[0].container_path #=> String
|
690
|
+
# resp.jobs[0].container.mount_points[0].read_only #=> Boolean
|
691
|
+
# resp.jobs[0].container.mount_points[0].source_volume #=> String
|
692
|
+
# resp.jobs[0].container.readonly_root_filesystem #=> Boolean
|
693
|
+
# resp.jobs[0].container.ulimits #=> Array
|
694
|
+
# resp.jobs[0].container.ulimits[0].hard_limit #=> Integer
|
695
|
+
# resp.jobs[0].container.ulimits[0].name #=> String
|
696
|
+
# resp.jobs[0].container.ulimits[0].soft_limit #=> Integer
|
697
|
+
# resp.jobs[0].container.privileged #=> Boolean
|
698
|
+
# resp.jobs[0].container.user #=> String
|
699
|
+
# resp.jobs[0].container.exit_code #=> Integer
|
700
|
+
# resp.jobs[0].container.reason #=> String
|
701
|
+
# resp.jobs[0].container.container_instance_arn #=> String
|
702
|
+
#
|
703
|
+
# @overload describe_jobs(params = {})
|
704
|
+
# @param [Hash] params ({})
|
705
|
+
def describe_jobs(params = {}, options = {})
|
706
|
+
req = build_request(:describe_jobs, params)
|
707
|
+
req.send_request(options)
|
708
|
+
end
|
709
|
+
|
710
|
+
# Returns a list of task jobs for a specified job queue. You can filter
|
711
|
+
# the results by job status with the `jobStatus` parameter.
|
712
|
+
#
|
713
|
+
# @option params [required, String] :job_queue
|
714
|
+
# The name or full Amazon Resource Name (ARN) of the job queue with
|
715
|
+
# which to list jobs.
|
716
|
+
#
|
717
|
+
# @option params [String] :job_status
|
718
|
+
# The job status with which to filter jobs in the specified queue.
|
719
|
+
#
|
720
|
+
# @option params [Integer] :max_results
|
721
|
+
# The maximum number of results returned by `ListJobs` in paginated
|
722
|
+
# output. When this parameter is used, `ListJobs` only returns
|
723
|
+
# `maxResults` results in a single page along with a `nextToken`
|
724
|
+
# response element. The remaining results of the initial request can be
|
725
|
+
# seen by sending another `ListJobs` request with the returned
|
726
|
+
# `nextToken` value. This value can be between 1 and 100. If this
|
727
|
+
# parameter is not used, then `ListJobs` returns up to 100 results and a
|
728
|
+
# `nextToken` value if applicable.
|
729
|
+
#
|
730
|
+
# @option params [String] :next_token
|
731
|
+
# The `nextToken` value returned from a previous paginated `ListJobs`
|
732
|
+
# request where `maxResults` was used and the results exceeded the value
|
733
|
+
# of that parameter. Pagination continues from the end of the previous
|
734
|
+
# results that returned the `nextToken` value. This value is `null` when
|
735
|
+
# there are no more results to return.
|
736
|
+
#
|
737
|
+
# <note markdown="1"> This token should be treated as an opaque identifier that is only used
|
738
|
+
# to retrieve the next items in a list and not for other programmatic
|
739
|
+
# purposes.
|
740
|
+
#
|
741
|
+
# </note>
|
742
|
+
#
|
743
|
+
# @return [Types::ListJobsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
744
|
+
#
|
745
|
+
# * {Types::ListJobsResponse#job_summary_list #job_summary_list} => Array<Types::JobSummary>
|
746
|
+
# * {Types::ListJobsResponse#next_token #next_token} => String
|
747
|
+
#
|
748
|
+
# @example Request syntax with placeholder values
|
749
|
+
#
|
750
|
+
# resp = client.list_jobs({
|
751
|
+
# job_queue: "String", # required
|
752
|
+
# job_status: "SUBMITTED", # accepts SUBMITTED, PENDING, RUNNABLE, STARTING, RUNNING, SUCCEEDED, FAILED
|
753
|
+
# max_results: 1,
|
754
|
+
# next_token: "String",
|
755
|
+
# })
|
756
|
+
#
|
757
|
+
# @example Response structure
|
758
|
+
#
|
759
|
+
# resp.job_summary_list #=> Array
|
760
|
+
# resp.job_summary_list[0].job_id #=> String
|
761
|
+
# resp.job_summary_list[0].job_name #=> String
|
762
|
+
# resp.next_token #=> String
|
763
|
+
#
|
764
|
+
# @overload list_jobs(params = {})
|
765
|
+
# @param [Hash] params ({})
|
766
|
+
def list_jobs(params = {}, options = {})
|
767
|
+
req = build_request(:list_jobs, params)
|
768
|
+
req.send_request(options)
|
769
|
+
end
|
770
|
+
|
771
|
+
# Registers an AWS Batch job definition.
|
772
|
+
#
|
773
|
+
# @option params [required, String] :job_definition_name
|
774
|
+
# The name of the job definition to register.
|
775
|
+
#
|
776
|
+
# @option params [required, String] :type
|
777
|
+
# The type of job definition.
|
778
|
+
#
|
779
|
+
# @option params [Hash<String,String>] :parameters
|
780
|
+
# Default parameter substitution placeholders to set in the job
|
781
|
+
# definition. Parameters are specified as a key-value pair mapping.
|
782
|
+
# Parameters in a `SubmitJob` request override any corresponding
|
783
|
+
# parameter defaults from the job definition.
|
784
|
+
#
|
785
|
+
# @option params [Types::ContainerProperties] :container_properties
|
786
|
+
# An object with various properties specific for container-based jobs.
|
787
|
+
# This parameter is required if the `type` parameter is `container`.
|
788
|
+
#
|
789
|
+
# @return [Types::RegisterJobDefinitionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
790
|
+
#
|
791
|
+
# * {Types::RegisterJobDefinitionResponse#job_definition_name #job_definition_name} => String
|
792
|
+
# * {Types::RegisterJobDefinitionResponse#job_definition_arn #job_definition_arn} => String
|
793
|
+
# * {Types::RegisterJobDefinitionResponse#revision #revision} => Integer
|
794
|
+
#
|
795
|
+
# @example Request syntax with placeholder values
|
796
|
+
#
|
797
|
+
# resp = client.register_job_definition({
|
798
|
+
# job_definition_name: "String", # required
|
799
|
+
# type: "container", # required, accepts container
|
800
|
+
# parameters: {
|
801
|
+
# "String" => "String",
|
802
|
+
# },
|
803
|
+
# container_properties: {
|
804
|
+
# image: "String", # required
|
805
|
+
# vcpus: 1, # required
|
806
|
+
# memory: 1, # required
|
807
|
+
# command: ["String"],
|
808
|
+
# job_role_arn: "String",
|
809
|
+
# volumes: [
|
810
|
+
# {
|
811
|
+
# host: {
|
812
|
+
# source_path: "String",
|
813
|
+
# },
|
814
|
+
# name: "String",
|
815
|
+
# },
|
816
|
+
# ],
|
817
|
+
# environment: [
|
818
|
+
# {
|
819
|
+
# name: "String",
|
820
|
+
# value: "String",
|
821
|
+
# },
|
822
|
+
# ],
|
823
|
+
# mount_points: [
|
824
|
+
# {
|
825
|
+
# container_path: "String",
|
826
|
+
# read_only: false,
|
827
|
+
# source_volume: "String",
|
828
|
+
# },
|
829
|
+
# ],
|
830
|
+
# readonly_root_filesystem: false,
|
831
|
+
# privileged: false,
|
832
|
+
# ulimits: [
|
833
|
+
# {
|
834
|
+
# hard_limit: 1, # required
|
835
|
+
# name: "String", # required
|
836
|
+
# soft_limit: 1, # required
|
837
|
+
# },
|
838
|
+
# ],
|
839
|
+
# user: "String",
|
840
|
+
# },
|
841
|
+
# })
|
842
|
+
#
|
843
|
+
# @example Response structure
|
844
|
+
#
|
845
|
+
# resp.job_definition_name #=> String
|
846
|
+
# resp.job_definition_arn #=> String
|
847
|
+
# resp.revision #=> Integer
|
848
|
+
#
|
849
|
+
# @overload register_job_definition(params = {})
|
850
|
+
# @param [Hash] params ({})
|
851
|
+
def register_job_definition(params = {}, options = {})
|
852
|
+
req = build_request(:register_job_definition, params)
|
853
|
+
req.send_request(options)
|
854
|
+
end
|
855
|
+
|
856
|
+
# Submits an AWS Batch job from a job definition. Parameters specified
|
857
|
+
# during SubmitJob override parameters defined in the job definition.
|
858
|
+
#
|
859
|
+
# @option params [required, String] :job_name
|
860
|
+
# The name of the job.
|
861
|
+
#
|
862
|
+
# @option params [required, String] :job_queue
|
863
|
+
# The job queue into which the job will be submitted. You can specify
|
864
|
+
# either the name or the Amazon Resource Name (ARN) of the queue.
|
865
|
+
#
|
866
|
+
# @option params [Array<Types::JobDependency>] :depends_on
|
867
|
+
# A list of job names or IDs on which this job depends. A job can depend
|
868
|
+
# upon a maximum of 100 jobs.
|
869
|
+
#
|
870
|
+
# @option params [required, String] :job_definition
|
871
|
+
# The job definition used by this job. This value can be either a
|
872
|
+
# `name:revision` or the Amazon Resource Name (ARN) for the job
|
873
|
+
# definition.
|
874
|
+
#
|
875
|
+
# @option params [Hash<String,String>] :parameters
|
876
|
+
# Additional parameters passed to the job that replace parameter
|
877
|
+
# substitution placeholders that are set in the job definition.
|
878
|
+
# Parameters are specified as a key and value pair mapping. Parameters
|
879
|
+
# in a `SubmitJob` request override any corresponding parameter defaults
|
880
|
+
# from the job definition.
|
881
|
+
#
|
882
|
+
# @option params [Types::ContainerOverrides] :container_overrides
|
883
|
+
# A list of container overrides in JSON format that specify the name of
|
884
|
+
# a container in the specified job definition and the overrides it
|
885
|
+
# should receive. You can override the default command for a container
|
886
|
+
# (that is specified in the job definition or the Docker image) with a
|
887
|
+
# `command` override. You can also override existing environment
|
888
|
+
# variables (that are specified in the job definition or Docker image)
|
889
|
+
# on a container or add new environment variables to it with an
|
890
|
+
# `environment` override.
|
891
|
+
#
|
892
|
+
# @return [Types::SubmitJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
893
|
+
#
|
894
|
+
# * {Types::SubmitJobResponse#job_name #job_name} => String
|
895
|
+
# * {Types::SubmitJobResponse#job_id #job_id} => String
|
896
|
+
#
|
897
|
+
# @example Request syntax with placeholder values
|
898
|
+
#
|
899
|
+
# resp = client.submit_job({
|
900
|
+
# job_name: "String", # required
|
901
|
+
# job_queue: "String", # required
|
902
|
+
# depends_on: [
|
903
|
+
# {
|
904
|
+
# job_id: "String",
|
905
|
+
# },
|
906
|
+
# ],
|
907
|
+
# job_definition: "String", # required
|
908
|
+
# parameters: {
|
909
|
+
# "String" => "String",
|
910
|
+
# },
|
911
|
+
# container_overrides: {
|
912
|
+
# vcpus: 1,
|
913
|
+
# memory: 1,
|
914
|
+
# command: ["String"],
|
915
|
+
# environment: [
|
916
|
+
# {
|
917
|
+
# name: "String",
|
918
|
+
# value: "String",
|
919
|
+
# },
|
920
|
+
# ],
|
921
|
+
# },
|
922
|
+
# })
|
923
|
+
#
|
924
|
+
# @example Response structure
|
925
|
+
#
|
926
|
+
# resp.job_name #=> String
|
927
|
+
# resp.job_id #=> String
|
928
|
+
#
|
929
|
+
# @overload submit_job(params = {})
|
930
|
+
# @param [Hash] params ({})
|
931
|
+
def submit_job(params = {}, options = {})
|
932
|
+
req = build_request(:submit_job, params)
|
933
|
+
req.send_request(options)
|
934
|
+
end
|
935
|
+
|
936
|
+
# Terminates jobs in a job queue. Jobs that are in the `STARTING` or
|
937
|
+
# `RUNNING` state are terminated, which causes them to transition to
|
938
|
+
# `FAILED`. Jobs that have not progressed to the `STARTING` state are
|
939
|
+
# cancelled.
|
940
|
+
#
|
941
|
+
# @option params [required, String] :job_id
|
942
|
+
# Job IDs to be terminated. Up to 100 jobs can be specified.
|
943
|
+
#
|
944
|
+
# @option params [required, String] :reason
|
945
|
+
# A message to attach to the job that explains the reason for cancelling
|
946
|
+
# it. This message is returned by future DescribeJobs operations on the
|
947
|
+
# job. This message is also recorded in the AWS Batch activity logs.
|
948
|
+
#
|
949
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
950
|
+
#
|
951
|
+
# @example Request syntax with placeholder values
|
952
|
+
#
|
953
|
+
# resp = client.terminate_job({
|
954
|
+
# job_id: "String", # required
|
955
|
+
# reason: "String", # required
|
956
|
+
# })
|
957
|
+
#
|
958
|
+
# @overload terminate_job(params = {})
|
959
|
+
# @param [Hash] params ({})
|
960
|
+
def terminate_job(params = {}, options = {})
|
961
|
+
req = build_request(:terminate_job, params)
|
962
|
+
req.send_request(options)
|
963
|
+
end
|
964
|
+
|
965
|
+
# Updates an AWS Batch compute environment.
|
966
|
+
#
|
967
|
+
# @option params [required, String] :compute_environment
|
968
|
+
# The name or full Amazon Resource Name (ARN) of the compute environment
|
969
|
+
# to update.
|
970
|
+
#
|
971
|
+
# @option params [String] :state
|
972
|
+
# The state of the compute environment. Compute environments in the
|
973
|
+
# `ENABLED` state can accept jobs from a queue and scale in or out
|
974
|
+
# automatically based on the workload demand of its associated queues.
|
975
|
+
#
|
976
|
+
# @option params [Types::ComputeResourceUpdate] :compute_resources
|
977
|
+
# Details of the compute resources managed by the compute environment.
|
978
|
+
# Required for a managed compute environment.
|
979
|
+
#
|
980
|
+
# @option params [String] :service_role
|
981
|
+
# The name or full Amazon Resource Name (ARN) of the IAM role that
|
982
|
+
# allows AWS Batch to make calls to ECS, Auto Scaling, and EC2 on your
|
983
|
+
# behalf.
|
984
|
+
#
|
985
|
+
# @return [Types::UpdateComputeEnvironmentResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
986
|
+
#
|
987
|
+
# * {Types::UpdateComputeEnvironmentResponse#compute_environment_name #compute_environment_name} => String
|
988
|
+
# * {Types::UpdateComputeEnvironmentResponse#compute_environment_arn #compute_environment_arn} => String
|
989
|
+
#
|
990
|
+
# @example Request syntax with placeholder values
|
991
|
+
#
|
992
|
+
# resp = client.update_compute_environment({
|
993
|
+
# compute_environment: "String", # required
|
994
|
+
# state: "ENABLED", # accepts ENABLED, DISABLED
|
995
|
+
# compute_resources: {
|
996
|
+
# minv_cpus: 1,
|
997
|
+
# maxv_cpus: 1,
|
998
|
+
# desiredv_cpus: 1,
|
999
|
+
# },
|
1000
|
+
# service_role: "String",
|
1001
|
+
# })
|
1002
|
+
#
|
1003
|
+
# @example Response structure
|
1004
|
+
#
|
1005
|
+
# resp.compute_environment_name #=> String
|
1006
|
+
# resp.compute_environment_arn #=> String
|
1007
|
+
#
|
1008
|
+
# @overload update_compute_environment(params = {})
|
1009
|
+
# @param [Hash] params ({})
|
1010
|
+
def update_compute_environment(params = {}, options = {})
|
1011
|
+
req = build_request(:update_compute_environment, params)
|
1012
|
+
req.send_request(options)
|
1013
|
+
end
|
1014
|
+
|
1015
|
+
# Updates a job queue.
|
1016
|
+
#
|
1017
|
+
# @option params [required, String] :job_queue
|
1018
|
+
# The name or the Amazon Resource Name (ARN) of the job queue.
|
1019
|
+
#
|
1020
|
+
# @option params [String] :state
|
1021
|
+
# Describes the queue's ability to accept new jobs.
|
1022
|
+
#
|
1023
|
+
# @option params [Integer] :priority
|
1024
|
+
# The priority of the job queue. Job queues with a higher priority (or a
|
1025
|
+
# lower integer value for the `priority` parameter) are evaluated first
|
1026
|
+
# when associated with same compute environment. Priority is determined
|
1027
|
+
# in ascending order, for example, a job queue with a priority value of
|
1028
|
+
# `1` is given scheduling preference over a job queue with a priority
|
1029
|
+
# value of `10`.
|
1030
|
+
#
|
1031
|
+
# @option params [Array<Types::ComputeEnvironmentOrder>] :compute_environment_order
|
1032
|
+
# Details the set of compute environments mapped to a job queue and
|
1033
|
+
# their order relative to each other. This is one of the parameters used
|
1034
|
+
# by the job scheduler to determine which compute environment should
|
1035
|
+
# execute a given job.
|
1036
|
+
#
|
1037
|
+
# @return [Types::UpdateJobQueueResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1038
|
+
#
|
1039
|
+
# * {Types::UpdateJobQueueResponse#job_queue_name #job_queue_name} => String
|
1040
|
+
# * {Types::UpdateJobQueueResponse#job_queue_arn #job_queue_arn} => String
|
1041
|
+
#
|
1042
|
+
# @example Request syntax with placeholder values
|
1043
|
+
#
|
1044
|
+
# resp = client.update_job_queue({
|
1045
|
+
# job_queue: "String", # required
|
1046
|
+
# state: "ENABLED", # accepts ENABLED, DISABLED
|
1047
|
+
# priority: 1,
|
1048
|
+
# compute_environment_order: [
|
1049
|
+
# {
|
1050
|
+
# order: 1, # required
|
1051
|
+
# compute_environment: "String", # required
|
1052
|
+
# },
|
1053
|
+
# ],
|
1054
|
+
# })
|
1055
|
+
#
|
1056
|
+
# @example Response structure
|
1057
|
+
#
|
1058
|
+
# resp.job_queue_name #=> String
|
1059
|
+
# resp.job_queue_arn #=> String
|
1060
|
+
#
|
1061
|
+
# @overload update_job_queue(params = {})
|
1062
|
+
# @param [Hash] params ({})
|
1063
|
+
def update_job_queue(params = {}, options = {})
|
1064
|
+
req = build_request(:update_job_queue, params)
|
1065
|
+
req.send_request(options)
|
1066
|
+
end
|
1067
|
+
|
1068
|
+
# @!endgroup
|
1069
|
+
|
1070
|
+
# @param params ({})
|
1071
|
+
# @api private
|
1072
|
+
def build_request(operation_name, params = {})
|
1073
|
+
handlers = @handlers.for(operation_name)
|
1074
|
+
context = Seahorse::Client::RequestContext.new(
|
1075
|
+
operation_name: operation_name,
|
1076
|
+
operation: config.api.operation(operation_name),
|
1077
|
+
client: self,
|
1078
|
+
params: params,
|
1079
|
+
config: config)
|
1080
|
+
context[:gem_name] = 'aws-sdk-batch'
|
1081
|
+
context[:gem_version] = '1.0.0.rc1'
|
1082
|
+
Seahorse::Client::Request.new(handlers, context)
|
1083
|
+
end
|
1084
|
+
|
1085
|
+
# @api private
|
1086
|
+
# @deprecated
|
1087
|
+
def waiter_names
|
1088
|
+
[]
|
1089
|
+
end
|
1090
|
+
|
1091
|
+
class << self
|
1092
|
+
|
1093
|
+
# @api private
|
1094
|
+
attr_reader :identifier
|
1095
|
+
|
1096
|
+
# @api private
|
1097
|
+
def errors_module
|
1098
|
+
Errors
|
1099
|
+
end
|
1100
|
+
|
1101
|
+
end
|
1102
|
+
end
|
1103
|
+
end
|