aws-sdk-batch 1.2.0 → 1.3.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/lib/aws-sdk-batch.rb +1 -1
- data/lib/aws-sdk-batch/client.rb +52 -14
- data/lib/aws-sdk-batch/client_api.rb +37 -1
- data/lib/aws-sdk-batch/types.rb +203 -29
- metadata +2 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA1:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 660540f10f4b01f51f15f8ba707a1b8831790c2b
|
4
|
+
data.tar.gz: 98289444c3b798267f4f512a86f54bbe9a89adbd
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: f2fe01fe2f20a2eb89d53265827e7680ef954a173aa277a5520de285b6757ff612bc178143245056b8a79574f085108bb3a389e8e7b56cf25fe1f389eebac770
|
7
|
+
data.tar.gz: 074804531a19749e5bb5bc32224029d509600fca759046b980455233e214ac1b419b0305efa9f3e35ef772a7c17f553d8155fc13eaaa275e38f08888d84f2ad0
|
data/lib/aws-sdk-batch.rb
CHANGED
data/lib/aws-sdk-batch/client.rb
CHANGED
@@ -155,7 +155,7 @@ module Aws::Batch
|
|
155
155
|
# The AWS Batch job ID of the job to cancel.
|
156
156
|
#
|
157
157
|
# @option params [required, String] :reason
|
158
|
-
# A message to attach to the job that explains the reason for
|
158
|
+
# A message to attach to the job that explains the reason for canceling
|
159
159
|
# it. This message is returned by future DescribeJobs operations on the
|
160
160
|
# job. This message is also recorded in the AWS Batch activity logs.
|
161
161
|
#
|
@@ -198,8 +198,8 @@ module Aws::Batch
|
|
198
198
|
# resources within the environment, based on the compute resources that
|
199
199
|
# you specify. Instances launched into a managed compute environment use
|
200
200
|
# a recent, approved version of the Amazon ECS-optimized AMI. You can
|
201
|
-
# choose to use Amazon EC2 On-Demand
|
202
|
-
# environment, or you can use Amazon EC2 Spot
|
201
|
+
# choose to use Amazon EC2 On-Demand Instances in your managed compute
|
202
|
+
# environment, or you can use Amazon EC2 Spot Instances that only launch
|
203
203
|
# when the Spot bid price is below a specified percentage of the
|
204
204
|
# On-Demand price.
|
205
205
|
#
|
@@ -207,13 +207,13 @@ module Aws::Batch
|
|
207
207
|
# resources. This provides more compute resource configuration options,
|
208
208
|
# such as using a custom AMI, but you must ensure that your AMI meets
|
209
209
|
# the Amazon ECS container instance AMI specification. For more
|
210
|
-
# information, see [Container Instance AMIs][1] in the *Amazon
|
210
|
+
# information, see [Container Instance AMIs][1] in the *Amazon Elastic
|
211
211
|
# Container Service Developer Guide*. After you have created your
|
212
212
|
# unmanaged compute environment, you can use the
|
213
213
|
# DescribeComputeEnvironments operation to find the Amazon ECS cluster
|
214
214
|
# that is associated with it and then manually launch your container
|
215
215
|
# instances into that Amazon ECS cluster. For more information, see
|
216
|
-
# [Launching an Amazon ECS Container Instance][2] in the *Amazon
|
216
|
+
# [Launching an Amazon ECS Container Instance][2] in the *Amazon Elastic
|
217
217
|
# Container Service Developer Guide*.
|
218
218
|
#
|
219
219
|
#
|
@@ -416,7 +416,7 @@ module Aws::Batch
|
|
416
416
|
# relative to each other. The job scheduler uses this parameter to
|
417
417
|
# determine which compute environment should execute a given job.
|
418
418
|
# Compute environments must be in the `VALID` state before you can
|
419
|
-
# associate them with a job queue. You can associate up to
|
419
|
+
# associate them with a job queue. You can associate up to three compute
|
420
420
|
# environments with a job queue.
|
421
421
|
#
|
422
422
|
# @return [Types::CreateJobQueueResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
@@ -1076,6 +1076,7 @@ module Aws::Batch
|
|
1076
1076
|
# resp.jobs[0].stopped_at #=> Integer
|
1077
1077
|
# resp.jobs[0].depends_on #=> Array
|
1078
1078
|
# resp.jobs[0].depends_on[0].job_id #=> String
|
1079
|
+
# resp.jobs[0].depends_on[0].type #=> String, one of "N_TO_N", "SEQUENTIAL"
|
1079
1080
|
# resp.jobs[0].job_definition #=> String
|
1080
1081
|
# resp.jobs[0].parameters #=> Hash
|
1081
1082
|
# resp.jobs[0].parameters["String"] #=> String
|
@@ -1107,6 +1108,10 @@ module Aws::Batch
|
|
1107
1108
|
# resp.jobs[0].container.container_instance_arn #=> String
|
1108
1109
|
# resp.jobs[0].container.task_arn #=> String
|
1109
1110
|
# resp.jobs[0].container.log_stream_name #=> String
|
1111
|
+
# resp.jobs[0].array_properties.status_summary #=> Hash
|
1112
|
+
# resp.jobs[0].array_properties.status_summary["String"] #=> Integer
|
1113
|
+
# resp.jobs[0].array_properties.size #=> Integer
|
1114
|
+
# resp.jobs[0].array_properties.index #=> Integer
|
1110
1115
|
#
|
1111
1116
|
# @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/DescribeJobs AWS API Documentation
|
1112
1117
|
#
|
@@ -1121,10 +1126,14 @@ module Aws::Batch
|
|
1121
1126
|
# the results by job status with the `jobStatus` parameter. If you do
|
1122
1127
|
# not specify a status, only `RUNNING` jobs are returned.
|
1123
1128
|
#
|
1124
|
-
# @option params [
|
1129
|
+
# @option params [String] :job_queue
|
1125
1130
|
# The name or full Amazon Resource Name (ARN) of the job queue with
|
1126
1131
|
# which to list jobs.
|
1127
1132
|
#
|
1133
|
+
# @option params [String] :array_job_id
|
1134
|
+
# The job ID for an array job. Specifying an array job ID with this
|
1135
|
+
# parameter lists all child jobs from within the specified array.
|
1136
|
+
#
|
1128
1137
|
# @option params [String] :job_status
|
1129
1138
|
# The job status with which to filter jobs in the specified queue. If
|
1130
1139
|
# you do not specify a status, only `RUNNING` jobs are returned.
|
@@ -1198,7 +1207,8 @@ module Aws::Batch
|
|
1198
1207
|
# @example Request syntax with placeholder values
|
1199
1208
|
#
|
1200
1209
|
# resp = client.list_jobs({
|
1201
|
-
# job_queue: "String",
|
1210
|
+
# job_queue: "String",
|
1211
|
+
# array_job_id: "String",
|
1202
1212
|
# job_status: "SUBMITTED", # accepts SUBMITTED, PENDING, RUNNABLE, STARTING, RUNNING, SUCCEEDED, FAILED
|
1203
1213
|
# max_results: 1,
|
1204
1214
|
# next_token: "String",
|
@@ -1209,6 +1219,15 @@ module Aws::Batch
|
|
1209
1219
|
# resp.job_summary_list #=> Array
|
1210
1220
|
# resp.job_summary_list[0].job_id #=> String
|
1211
1221
|
# resp.job_summary_list[0].job_name #=> String
|
1222
|
+
# resp.job_summary_list[0].created_at #=> Integer
|
1223
|
+
# resp.job_summary_list[0].status #=> String, one of "SUBMITTED", "PENDING", "RUNNABLE", "STARTING", "RUNNING", "SUCCEEDED", "FAILED"
|
1224
|
+
# resp.job_summary_list[0].status_reason #=> String
|
1225
|
+
# resp.job_summary_list[0].started_at #=> Integer
|
1226
|
+
# resp.job_summary_list[0].stopped_at #=> Integer
|
1227
|
+
# resp.job_summary_list[0].container.exit_code #=> Integer
|
1228
|
+
# resp.job_summary_list[0].container.reason #=> String
|
1229
|
+
# resp.job_summary_list[0].array_properties.size #=> Integer
|
1230
|
+
# resp.job_summary_list[0].array_properties.index #=> Integer
|
1212
1231
|
# resp.next_token #=> String
|
1213
1232
|
#
|
1214
1233
|
# @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/ListJobs AWS API Documentation
|
@@ -1352,12 +1371,27 @@ module Aws::Batch
|
|
1352
1371
|
# underscores are allowed.
|
1353
1372
|
#
|
1354
1373
|
# @option params [required, String] :job_queue
|
1355
|
-
# The job queue into which the job
|
1356
|
-
#
|
1374
|
+
# The job queue into which the job is submitted. You can specify either
|
1375
|
+
# the name or the Amazon Resource Name (ARN) of the queue.
|
1376
|
+
#
|
1377
|
+
# @option params [Types::ArrayProperties] :array_properties
|
1378
|
+
# The array properties for the submitted job, such as the size of the
|
1379
|
+
# array. The array size can be between 2 and 10,000. If you specify
|
1380
|
+
# array properties for a job, it becomes an array job. For more
|
1381
|
+
# information, see [Array Jobs][1] in the *AWS Batch User Guide*.
|
1382
|
+
#
|
1383
|
+
#
|
1384
|
+
#
|
1385
|
+
# [1]: http://docs.aws.amazon.com/batch/latest/userguide/array_jobs.html
|
1357
1386
|
#
|
1358
1387
|
# @option params [Array<Types::JobDependency>] :depends_on
|
1359
|
-
# A list of
|
1360
|
-
#
|
1388
|
+
# A list of dependencies for the job. A job can depend upon a maximum of
|
1389
|
+
# 20 jobs. You can specify a `SEQUENTIAL` type dependency without
|
1390
|
+
# specifying a job ID for array jobs so that each child array job
|
1391
|
+
# completes sequentially, starting at index 0. You can also specify an
|
1392
|
+
# `N_TO_N` type dependency with a job ID for array jobs so that each
|
1393
|
+
# index child of this job must wait for the corresponding index child of
|
1394
|
+
# each dependency to complete before it can begin.
|
1361
1395
|
#
|
1362
1396
|
# @option params [required, String] :job_definition
|
1363
1397
|
# The job definition used by this job. This value can be either a
|
@@ -1413,9 +1447,13 @@ module Aws::Batch
|
|
1413
1447
|
# resp = client.submit_job({
|
1414
1448
|
# job_name: "String", # required
|
1415
1449
|
# job_queue: "String", # required
|
1450
|
+
# array_properties: {
|
1451
|
+
# size: 1,
|
1452
|
+
# },
|
1416
1453
|
# depends_on: [
|
1417
1454
|
# {
|
1418
1455
|
# job_id: "String",
|
1456
|
+
# type: "N_TO_N", # accepts N_TO_N, SEQUENTIAL
|
1419
1457
|
# },
|
1420
1458
|
# ],
|
1421
1459
|
# job_definition: "String", # required
|
@@ -1461,7 +1499,7 @@ module Aws::Batch
|
|
1461
1499
|
# The AWS Batch job ID of the job to terminate.
|
1462
1500
|
#
|
1463
1501
|
# @option params [required, String] :reason
|
1464
|
-
# A message to attach to the job that explains the reason for
|
1502
|
+
# A message to attach to the job that explains the reason for canceling
|
1465
1503
|
# it. This message is returned by future DescribeJobs operations on the
|
1466
1504
|
# job. This message is also recorded in the AWS Batch activity logs.
|
1467
1505
|
#
|
@@ -1661,7 +1699,7 @@ module Aws::Batch
|
|
1661
1699
|
params: params,
|
1662
1700
|
config: config)
|
1663
1701
|
context[:gem_name] = 'aws-sdk-batch'
|
1664
|
-
context[:gem_version] = '1.
|
1702
|
+
context[:gem_version] = '1.3.0'
|
1665
1703
|
Seahorse::Client::Request.new(handlers, context)
|
1666
1704
|
end
|
1667
1705
|
|
@@ -11,6 +11,11 @@ module Aws::Batch
|
|
11
11
|
|
12
12
|
include Seahorse::Model
|
13
13
|
|
14
|
+
ArrayJobDependency = Shapes::StringShape.new(name: 'ArrayJobDependency')
|
15
|
+
ArrayJobStatusSummary = Shapes::MapShape.new(name: 'ArrayJobStatusSummary')
|
16
|
+
ArrayProperties = Shapes::StructureShape.new(name: 'ArrayProperties')
|
17
|
+
ArrayPropertiesDetail = Shapes::StructureShape.new(name: 'ArrayPropertiesDetail')
|
18
|
+
ArrayPropertiesSummary = Shapes::StructureShape.new(name: 'ArrayPropertiesSummary')
|
14
19
|
AttemptContainerDetail = Shapes::StructureShape.new(name: 'AttemptContainerDetail')
|
15
20
|
AttemptDetail = Shapes::StructureShape.new(name: 'AttemptDetail')
|
16
21
|
AttemptDetails = Shapes::ListShape.new(name: 'AttemptDetails')
|
@@ -31,6 +36,7 @@ module Aws::Batch
|
|
31
36
|
ContainerDetail = Shapes::StructureShape.new(name: 'ContainerDetail')
|
32
37
|
ContainerOverrides = Shapes::StructureShape.new(name: 'ContainerOverrides')
|
33
38
|
ContainerProperties = Shapes::StructureShape.new(name: 'ContainerProperties')
|
39
|
+
ContainerSummary = Shapes::StructureShape.new(name: 'ContainerSummary')
|
34
40
|
CreateComputeEnvironmentRequest = Shapes::StructureShape.new(name: 'CreateComputeEnvironmentRequest')
|
35
41
|
CreateComputeEnvironmentResponse = Shapes::StructureShape.new(name: 'CreateComputeEnvironmentResponse')
|
36
42
|
CreateJobQueueRequest = Shapes::StructureShape.new(name: 'CreateJobQueueRequest')
|
@@ -93,6 +99,21 @@ module Aws::Batch
|
|
93
99
|
Volume = Shapes::StructureShape.new(name: 'Volume')
|
94
100
|
Volumes = Shapes::ListShape.new(name: 'Volumes')
|
95
101
|
|
102
|
+
ArrayJobStatusSummary.key = Shapes::ShapeRef.new(shape: String)
|
103
|
+
ArrayJobStatusSummary.value = Shapes::ShapeRef.new(shape: Integer)
|
104
|
+
|
105
|
+
ArrayProperties.add_member(:size, Shapes::ShapeRef.new(shape: Integer, location_name: "size"))
|
106
|
+
ArrayProperties.struct_class = Types::ArrayProperties
|
107
|
+
|
108
|
+
ArrayPropertiesDetail.add_member(:status_summary, Shapes::ShapeRef.new(shape: ArrayJobStatusSummary, location_name: "statusSummary"))
|
109
|
+
ArrayPropertiesDetail.add_member(:size, Shapes::ShapeRef.new(shape: Integer, location_name: "size"))
|
110
|
+
ArrayPropertiesDetail.add_member(:index, Shapes::ShapeRef.new(shape: Integer, location_name: "index"))
|
111
|
+
ArrayPropertiesDetail.struct_class = Types::ArrayPropertiesDetail
|
112
|
+
|
113
|
+
ArrayPropertiesSummary.add_member(:size, Shapes::ShapeRef.new(shape: Integer, location_name: "size"))
|
114
|
+
ArrayPropertiesSummary.add_member(:index, Shapes::ShapeRef.new(shape: Integer, location_name: "index"))
|
115
|
+
ArrayPropertiesSummary.struct_class = Types::ArrayPropertiesSummary
|
116
|
+
|
96
117
|
AttemptContainerDetail.add_member(:container_instance_arn, Shapes::ShapeRef.new(shape: String, location_name: "containerInstanceArn"))
|
97
118
|
AttemptContainerDetail.add_member(:task_arn, Shapes::ShapeRef.new(shape: String, location_name: "taskArn"))
|
98
119
|
AttemptContainerDetail.add_member(:exit_code, Shapes::ShapeRef.new(shape: Integer, location_name: "exitCode"))
|
@@ -192,6 +213,10 @@ module Aws::Batch
|
|
192
213
|
ContainerProperties.add_member(:user, Shapes::ShapeRef.new(shape: String, location_name: "user"))
|
193
214
|
ContainerProperties.struct_class = Types::ContainerProperties
|
194
215
|
|
216
|
+
ContainerSummary.add_member(:exit_code, Shapes::ShapeRef.new(shape: Integer, location_name: "exitCode"))
|
217
|
+
ContainerSummary.add_member(:reason, Shapes::ShapeRef.new(shape: String, location_name: "reason"))
|
218
|
+
ContainerSummary.struct_class = Types::ContainerSummary
|
219
|
+
|
195
220
|
CreateComputeEnvironmentRequest.add_member(:compute_environment_name, Shapes::ShapeRef.new(shape: String, required: true, location_name: "computeEnvironmentName"))
|
196
221
|
CreateComputeEnvironmentRequest.add_member(:type, Shapes::ShapeRef.new(shape: CEType, required: true, location_name: "type"))
|
197
222
|
CreateComputeEnvironmentRequest.add_member(:state, Shapes::ShapeRef.new(shape: CEState, location_name: "state"))
|
@@ -281,6 +306,7 @@ module Aws::Batch
|
|
281
306
|
JobDefinitionList.member = Shapes::ShapeRef.new(shape: JobDefinition)
|
282
307
|
|
283
308
|
JobDependency.add_member(:job_id, Shapes::ShapeRef.new(shape: String, location_name: "jobId"))
|
309
|
+
JobDependency.add_member(:type, Shapes::ShapeRef.new(shape: ArrayJobDependency, location_name: "type"))
|
284
310
|
JobDependency.struct_class = Types::JobDependency
|
285
311
|
|
286
312
|
JobDependencyList.member = Shapes::ShapeRef.new(shape: JobDependency)
|
@@ -299,6 +325,7 @@ module Aws::Batch
|
|
299
325
|
JobDetail.add_member(:job_definition, Shapes::ShapeRef.new(shape: String, required: true, location_name: "jobDefinition"))
|
300
326
|
JobDetail.add_member(:parameters, Shapes::ShapeRef.new(shape: ParametersMap, location_name: "parameters"))
|
301
327
|
JobDetail.add_member(:container, Shapes::ShapeRef.new(shape: ContainerDetail, location_name: "container"))
|
328
|
+
JobDetail.add_member(:array_properties, Shapes::ShapeRef.new(shape: ArrayPropertiesDetail, location_name: "arrayProperties"))
|
302
329
|
JobDetail.struct_class = Types::JobDetail
|
303
330
|
|
304
331
|
JobDetailList.member = Shapes::ShapeRef.new(shape: JobDetail)
|
@@ -316,6 +343,13 @@ module Aws::Batch
|
|
316
343
|
|
317
344
|
JobSummary.add_member(:job_id, Shapes::ShapeRef.new(shape: String, required: true, location_name: "jobId"))
|
318
345
|
JobSummary.add_member(:job_name, Shapes::ShapeRef.new(shape: String, required: true, location_name: "jobName"))
|
346
|
+
JobSummary.add_member(:created_at, Shapes::ShapeRef.new(shape: Long, location_name: "createdAt"))
|
347
|
+
JobSummary.add_member(:status, Shapes::ShapeRef.new(shape: JobStatus, location_name: "status"))
|
348
|
+
JobSummary.add_member(:status_reason, Shapes::ShapeRef.new(shape: String, location_name: "statusReason"))
|
349
|
+
JobSummary.add_member(:started_at, Shapes::ShapeRef.new(shape: Long, location_name: "startedAt"))
|
350
|
+
JobSummary.add_member(:stopped_at, Shapes::ShapeRef.new(shape: Long, location_name: "stoppedAt"))
|
351
|
+
JobSummary.add_member(:container, Shapes::ShapeRef.new(shape: ContainerSummary, location_name: "container"))
|
352
|
+
JobSummary.add_member(:array_properties, Shapes::ShapeRef.new(shape: ArrayPropertiesSummary, location_name: "arrayProperties"))
|
319
353
|
JobSummary.struct_class = Types::JobSummary
|
320
354
|
|
321
355
|
JobSummaryList.member = Shapes::ShapeRef.new(shape: JobSummary)
|
@@ -324,7 +358,8 @@ module Aws::Batch
|
|
324
358
|
KeyValuePair.add_member(:value, Shapes::ShapeRef.new(shape: String, location_name: "value"))
|
325
359
|
KeyValuePair.struct_class = Types::KeyValuePair
|
326
360
|
|
327
|
-
ListJobsRequest.add_member(:job_queue, Shapes::ShapeRef.new(shape: String,
|
361
|
+
ListJobsRequest.add_member(:job_queue, Shapes::ShapeRef.new(shape: String, location_name: "jobQueue"))
|
362
|
+
ListJobsRequest.add_member(:array_job_id, Shapes::ShapeRef.new(shape: String, location_name: "arrayJobId"))
|
328
363
|
ListJobsRequest.add_member(:job_status, Shapes::ShapeRef.new(shape: JobStatus, location_name: "jobStatus"))
|
329
364
|
ListJobsRequest.add_member(:max_results, Shapes::ShapeRef.new(shape: Integer, location_name: "maxResults"))
|
330
365
|
ListJobsRequest.add_member(:next_token, Shapes::ShapeRef.new(shape: String, location_name: "nextToken"))
|
@@ -363,6 +398,7 @@ module Aws::Batch
|
|
363
398
|
|
364
399
|
SubmitJobRequest.add_member(:job_name, Shapes::ShapeRef.new(shape: String, required: true, location_name: "jobName"))
|
365
400
|
SubmitJobRequest.add_member(:job_queue, Shapes::ShapeRef.new(shape: String, required: true, location_name: "jobQueue"))
|
401
|
+
SubmitJobRequest.add_member(:array_properties, Shapes::ShapeRef.new(shape: ArrayProperties, location_name: "arrayProperties"))
|
366
402
|
SubmitJobRequest.add_member(:depends_on, Shapes::ShapeRef.new(shape: JobDependencyList, location_name: "dependsOn"))
|
367
403
|
SubmitJobRequest.add_member(:job_definition, Shapes::ShapeRef.new(shape: String, required: true, location_name: "jobDefinition"))
|
368
404
|
SubmitJobRequest.add_member(:parameters, Shapes::ShapeRef.new(shape: ParametersMap, location_name: "parameters"))
|
data/lib/aws-sdk-batch/types.rb
CHANGED
@@ -8,6 +8,72 @@
|
|
8
8
|
module Aws::Batch
|
9
9
|
module Types
|
10
10
|
|
11
|
+
# An object representing an AWS Batch array job.
|
12
|
+
#
|
13
|
+
# @note When making an API call, you may pass ArrayProperties
|
14
|
+
# data as a hash:
|
15
|
+
#
|
16
|
+
# {
|
17
|
+
# size: 1,
|
18
|
+
# }
|
19
|
+
#
|
20
|
+
# @!attribute [rw] size
|
21
|
+
# The size of the array job.
|
22
|
+
# @return [Integer]
|
23
|
+
#
|
24
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/ArrayProperties AWS API Documentation
|
25
|
+
#
|
26
|
+
class ArrayProperties < Struct.new(
|
27
|
+
:size)
|
28
|
+
include Aws::Structure
|
29
|
+
end
|
30
|
+
|
31
|
+
# An object representing the array properties of a job.
|
32
|
+
#
|
33
|
+
# @!attribute [rw] status_summary
|
34
|
+
# A summary of the number of array job children in each available job
|
35
|
+
# status. This parameter is returned for parent array jobs.
|
36
|
+
# @return [Hash<String,Integer>]
|
37
|
+
#
|
38
|
+
# @!attribute [rw] size
|
39
|
+
# The size of the array job. This parameter is returned for parent
|
40
|
+
# array jobs.
|
41
|
+
# @return [Integer]
|
42
|
+
#
|
43
|
+
# @!attribute [rw] index
|
44
|
+
# The job index within the array that is associated with this job.
|
45
|
+
# This parameter is returned for array job children.
|
46
|
+
# @return [Integer]
|
47
|
+
#
|
48
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/ArrayPropertiesDetail AWS API Documentation
|
49
|
+
#
|
50
|
+
class ArrayPropertiesDetail < Struct.new(
|
51
|
+
:status_summary,
|
52
|
+
:size,
|
53
|
+
:index)
|
54
|
+
include Aws::Structure
|
55
|
+
end
|
56
|
+
|
57
|
+
# An object representing the array properties of a job.
|
58
|
+
#
|
59
|
+
# @!attribute [rw] size
|
60
|
+
# The size of the array job. This parameter is returned for parent
|
61
|
+
# array jobs.
|
62
|
+
# @return [Integer]
|
63
|
+
#
|
64
|
+
# @!attribute [rw] index
|
65
|
+
# The job index within the array that is associated with this job.
|
66
|
+
# This parameter is returned for children of array jobs.
|
67
|
+
# @return [Integer]
|
68
|
+
#
|
69
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/ArrayPropertiesSummary AWS API Documentation
|
70
|
+
#
|
71
|
+
class ArrayPropertiesSummary < Struct.new(
|
72
|
+
:size,
|
73
|
+
:index)
|
74
|
+
include Aws::Structure
|
75
|
+
end
|
76
|
+
|
11
77
|
# An object representing the details of a container that is part of a
|
12
78
|
# job attempt.
|
13
79
|
#
|
@@ -57,13 +123,15 @@ module Aws::Batch
|
|
57
123
|
# @return [Types::AttemptContainerDetail]
|
58
124
|
#
|
59
125
|
# @!attribute [rw] started_at
|
60
|
-
# The Unix
|
61
|
-
# transitioned from the `
|
126
|
+
# The Unix time stamp for when the attempt was started (when the
|
127
|
+
# attempt transitioned from the `STARTING` state to the `RUNNING`
|
128
|
+
# state).
|
62
129
|
# @return [Integer]
|
63
130
|
#
|
64
131
|
# @!attribute [rw] stopped_at
|
65
|
-
# The Unix
|
66
|
-
# transitioned from the `RUNNING` state to
|
132
|
+
# The Unix time stamp for when the attempt was stopped (when the
|
133
|
+
# attempt transitioned from the `RUNNING` state to a terminal state,
|
134
|
+
# such as `SUCCEEDED` or `FAILED`).
|
67
135
|
# @return [Integer]
|
68
136
|
#
|
69
137
|
# @!attribute [rw] status_reason
|
@@ -95,7 +163,7 @@ module Aws::Batch
|
|
95
163
|
#
|
96
164
|
# @!attribute [rw] reason
|
97
165
|
# A message to attach to the job that explains the reason for
|
98
|
-
#
|
166
|
+
# canceling it. This message is returned by future DescribeJobs
|
99
167
|
# operations on the job. This message is also recorded in the AWS
|
100
168
|
# Batch activity logs.
|
101
169
|
# @return [String]
|
@@ -599,7 +667,7 @@ module Aws::Batch
|
|
599
667
|
# to `CpuShares` in the [Create a container][1] section of the [Docker
|
600
668
|
# Remote API][2] and the `--cpu-shares` option to [docker run][3].
|
601
669
|
# Each vCPU is equivalent to 1,024 CPU shares. You must specify at
|
602
|
-
# least
|
670
|
+
# least one vCPU.
|
603
671
|
#
|
604
672
|
#
|
605
673
|
#
|
@@ -652,7 +720,7 @@ module Aws::Batch
|
|
652
720
|
# maps to `Env` in the [Create a container][1] section of the [Docker
|
653
721
|
# Remote API][2] and the `--env` option to [docker run][3].
|
654
722
|
#
|
655
|
-
# We do not recommend using
|
723
|
+
# We do not recommend using plaintext environment variables for
|
656
724
|
# sensitive information, such as credential data.
|
657
725
|
#
|
658
726
|
# <note markdown="1"> Environment variables must not start with `AWS_BATCH`; this naming
|
@@ -748,6 +816,25 @@ module Aws::Batch
|
|
748
816
|
include Aws::Structure
|
749
817
|
end
|
750
818
|
|
819
|
+
# An object representing summary details of a container within a job.
|
820
|
+
#
|
821
|
+
# @!attribute [rw] exit_code
|
822
|
+
# The exit code to return upon completion.
|
823
|
+
# @return [Integer]
|
824
|
+
#
|
825
|
+
# @!attribute [rw] reason
|
826
|
+
# A short (255 max characters) human-readable string to provide
|
827
|
+
# additional details about a running or stopped container.
|
828
|
+
# @return [String]
|
829
|
+
#
|
830
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/ContainerSummary AWS API Documentation
|
831
|
+
#
|
832
|
+
class ContainerSummary < Struct.new(
|
833
|
+
:exit_code,
|
834
|
+
:reason)
|
835
|
+
include Aws::Structure
|
836
|
+
end
|
837
|
+
|
751
838
|
# @note When making an API call, you may pass CreateComputeEnvironmentRequest
|
752
839
|
# data as a hash:
|
753
840
|
#
|
@@ -878,8 +965,8 @@ module Aws::Batch
|
|
878
965
|
# order relative to each other. The job scheduler uses this parameter
|
879
966
|
# to determine which compute environment should execute a given job.
|
880
967
|
# Compute environments must be in the `VALID` state before you can
|
881
|
-
# associate them with a job queue. You can associate up to
|
882
|
-
# environments with a job queue.
|
968
|
+
# associate them with a job queue. You can associate up to three
|
969
|
+
# compute environments with a job queue.
|
883
970
|
# @return [Array<Types::ComputeEnvironmentOrder>]
|
884
971
|
#
|
885
972
|
# @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/CreateJobQueueRequest AWS API Documentation
|
@@ -1318,16 +1405,22 @@ module Aws::Batch
|
|
1318
1405
|
#
|
1319
1406
|
# {
|
1320
1407
|
# job_id: "String",
|
1408
|
+
# type: "N_TO_N", # accepts N_TO_N, SEQUENTIAL
|
1321
1409
|
# }
|
1322
1410
|
#
|
1323
1411
|
# @!attribute [rw] job_id
|
1324
1412
|
# The job ID of the AWS Batch job associated with this dependency.
|
1325
1413
|
# @return [String]
|
1326
1414
|
#
|
1415
|
+
# @!attribute [rw] type
|
1416
|
+
# The type of the job dependency.
|
1417
|
+
# @return [String]
|
1418
|
+
#
|
1327
1419
|
# @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/JobDependency AWS API Documentation
|
1328
1420
|
#
|
1329
1421
|
class JobDependency < Struct.new(
|
1330
|
-
:job_id
|
1422
|
+
:job_id,
|
1423
|
+
:type)
|
1331
1424
|
include Aws::Structure
|
1332
1425
|
end
|
1333
1426
|
|
@@ -1360,8 +1453,11 @@ module Aws::Batch
|
|
1360
1453
|
# @return [String]
|
1361
1454
|
#
|
1362
1455
|
# @!attribute [rw] created_at
|
1363
|
-
# The Unix
|
1364
|
-
# entered the `
|
1456
|
+
# The Unix time stamp for when the job was created. For non-array jobs
|
1457
|
+
# and parent array jobs, this is when the job entered the `SUBMITTED`
|
1458
|
+
# state (at the time SubmitJob was called). For array child jobs, this
|
1459
|
+
# is when the child job was spawned by its parent and entered the
|
1460
|
+
# `PENDING` state.
|
1365
1461
|
# @return [Integer]
|
1366
1462
|
#
|
1367
1463
|
# @!attribute [rw] retry_strategy
|
@@ -1369,13 +1465,14 @@ module Aws::Batch
|
|
1369
1465
|
# @return [Types::RetryStrategy]
|
1370
1466
|
#
|
1371
1467
|
# @!attribute [rw] started_at
|
1372
|
-
# The Unix
|
1373
|
-
# transitioned from the `
|
1468
|
+
# The Unix time stamp for when the job was started (when the job
|
1469
|
+
# transitioned from the `STARTING` state to the `RUNNING` state).
|
1374
1470
|
# @return [Integer]
|
1375
1471
|
#
|
1376
1472
|
# @!attribute [rw] stopped_at
|
1377
|
-
# The Unix
|
1378
|
-
# transitioned from the `RUNNING` state to
|
1473
|
+
# The Unix time stamp for when the job was stopped (when the job
|
1474
|
+
# transitioned from the `RUNNING` state to a terminal state, such as
|
1475
|
+
# `SUCCEEDED` or `FAILED`).
|
1379
1476
|
# @return [Integer]
|
1380
1477
|
#
|
1381
1478
|
# @!attribute [rw] depends_on
|
@@ -1397,6 +1494,10 @@ module Aws::Batch
|
|
1397
1494
|
# associated with the job.
|
1398
1495
|
# @return [Types::ContainerDetail]
|
1399
1496
|
#
|
1497
|
+
# @!attribute [rw] array_properties
|
1498
|
+
# The array properties of the job, if it is an array job.
|
1499
|
+
# @return [Types::ArrayPropertiesDetail]
|
1500
|
+
#
|
1400
1501
|
# @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/JobDetail AWS API Documentation
|
1401
1502
|
#
|
1402
1503
|
class JobDetail < Struct.new(
|
@@ -1413,7 +1514,8 @@ module Aws::Batch
|
|
1413
1514
|
:depends_on,
|
1414
1515
|
:job_definition,
|
1415
1516
|
:parameters,
|
1416
|
-
:container
|
1517
|
+
:container,
|
1518
|
+
:array_properties)
|
1417
1519
|
include Aws::Structure
|
1418
1520
|
end
|
1419
1521
|
|
@@ -1473,11 +1575,55 @@ module Aws::Batch
|
|
1473
1575
|
# The name of the job.
|
1474
1576
|
# @return [String]
|
1475
1577
|
#
|
1578
|
+
# @!attribute [rw] created_at
|
1579
|
+
# The Unix time stamp for when the job was created. For non-array jobs
|
1580
|
+
# and parent array jobs, this is when the job entered the `SUBMITTED`
|
1581
|
+
# state (at the time SubmitJob was called). For array child jobs, this
|
1582
|
+
# is when the child job was spawned by its parent and entered the
|
1583
|
+
# `PENDING` state.
|
1584
|
+
# @return [Integer]
|
1585
|
+
#
|
1586
|
+
# @!attribute [rw] status
|
1587
|
+
# The current status for the job.
|
1588
|
+
# @return [String]
|
1589
|
+
#
|
1590
|
+
# @!attribute [rw] status_reason
|
1591
|
+
# A short, human-readable string to provide additional details about
|
1592
|
+
# the current status of the job.
|
1593
|
+
# @return [String]
|
1594
|
+
#
|
1595
|
+
# @!attribute [rw] started_at
|
1596
|
+
# The Unix time stamp for when the job was started (when the job
|
1597
|
+
# transitioned from the `STARTING` state to the `RUNNING` state).
|
1598
|
+
# @return [Integer]
|
1599
|
+
#
|
1600
|
+
# @!attribute [rw] stopped_at
|
1601
|
+
# The Unix time stamp for when the job was stopped (when the job
|
1602
|
+
# transitioned from the `RUNNING` state to a terminal state, such as
|
1603
|
+
# `SUCCEEDED` or `FAILED`).
|
1604
|
+
# @return [Integer]
|
1605
|
+
#
|
1606
|
+
# @!attribute [rw] container
|
1607
|
+
# An object representing the details of the container that is
|
1608
|
+
# associated with the job.
|
1609
|
+
# @return [Types::ContainerSummary]
|
1610
|
+
#
|
1611
|
+
# @!attribute [rw] array_properties
|
1612
|
+
# The array properties of the job, if it is an array job.
|
1613
|
+
# @return [Types::ArrayPropertiesSummary]
|
1614
|
+
#
|
1476
1615
|
# @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/JobSummary AWS API Documentation
|
1477
1616
|
#
|
1478
1617
|
class JobSummary < Struct.new(
|
1479
1618
|
:job_id,
|
1480
|
-
:job_name
|
1619
|
+
:job_name,
|
1620
|
+
:created_at,
|
1621
|
+
:status,
|
1622
|
+
:status_reason,
|
1623
|
+
:started_at,
|
1624
|
+
:stopped_at,
|
1625
|
+
:container,
|
1626
|
+
:array_properties)
|
1481
1627
|
include Aws::Structure
|
1482
1628
|
end
|
1483
1629
|
|
@@ -1492,12 +1638,12 @@ module Aws::Batch
|
|
1492
1638
|
# }
|
1493
1639
|
#
|
1494
1640
|
# @!attribute [rw] name
|
1495
|
-
# The name of the key
|
1641
|
+
# The name of the key-value pair. For environment variables, this is
|
1496
1642
|
# the name of the environment variable.
|
1497
1643
|
# @return [String]
|
1498
1644
|
#
|
1499
1645
|
# @!attribute [rw] value
|
1500
|
-
# The value of the key
|
1646
|
+
# The value of the key-value pair. For environment variables, this is
|
1501
1647
|
# the value of the environment variable.
|
1502
1648
|
# @return [String]
|
1503
1649
|
#
|
@@ -1513,7 +1659,8 @@ module Aws::Batch
|
|
1513
1659
|
# data as a hash:
|
1514
1660
|
#
|
1515
1661
|
# {
|
1516
|
-
# job_queue: "String",
|
1662
|
+
# job_queue: "String",
|
1663
|
+
# array_job_id: "String",
|
1517
1664
|
# job_status: "SUBMITTED", # accepts SUBMITTED, PENDING, RUNNABLE, STARTING, RUNNING, SUCCEEDED, FAILED
|
1518
1665
|
# max_results: 1,
|
1519
1666
|
# next_token: "String",
|
@@ -1524,6 +1671,11 @@ module Aws::Batch
|
|
1524
1671
|
# which to list jobs.
|
1525
1672
|
# @return [String]
|
1526
1673
|
#
|
1674
|
+
# @!attribute [rw] array_job_id
|
1675
|
+
# The job ID for an array job. Specifying an array job ID with this
|
1676
|
+
# parameter lists all child jobs from within the specified array.
|
1677
|
+
# @return [String]
|
1678
|
+
#
|
1527
1679
|
# @!attribute [rw] job_status
|
1528
1680
|
# The job status with which to filter jobs in the specified queue. If
|
1529
1681
|
# you do not specify a status, only `RUNNING` jobs are returned.
|
@@ -1558,6 +1710,7 @@ module Aws::Batch
|
|
1558
1710
|
#
|
1559
1711
|
class ListJobsRequest < Struct.new(
|
1560
1712
|
:job_queue,
|
1713
|
+
:array_job_id,
|
1561
1714
|
:job_status,
|
1562
1715
|
:max_results,
|
1563
1716
|
:next_token)
|
@@ -1741,9 +1894,9 @@ module Aws::Batch
|
|
1741
1894
|
#
|
1742
1895
|
# @!attribute [rw] attempts
|
1743
1896
|
# The number of times to move a job to the `RUNNABLE` status. You may
|
1744
|
-
# specify between 1 and 10 attempts. If `attempts` is
|
1745
|
-
# one, the job is retried if it fails until it has moved
|
1746
|
-
# that many times.
|
1897
|
+
# specify between 1 and 10 attempts. If the value of `attempts` is
|
1898
|
+
# greater than one, the job is retried if it fails until it has moved
|
1899
|
+
# to `RUNNABLE` that many times.
|
1747
1900
|
# @return [Integer]
|
1748
1901
|
#
|
1749
1902
|
# @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/RetryStrategy AWS API Documentation
|
@@ -1759,9 +1912,13 @@ module Aws::Batch
|
|
1759
1912
|
# {
|
1760
1913
|
# job_name: "String", # required
|
1761
1914
|
# job_queue: "String", # required
|
1915
|
+
# array_properties: {
|
1916
|
+
# size: 1,
|
1917
|
+
# },
|
1762
1918
|
# depends_on: [
|
1763
1919
|
# {
|
1764
1920
|
# job_id: "String",
|
1921
|
+
# type: "N_TO_N", # accepts N_TO_N, SEQUENTIAL
|
1765
1922
|
# },
|
1766
1923
|
# ],
|
1767
1924
|
# job_definition: "String", # required
|
@@ -1791,13 +1948,29 @@ module Aws::Batch
|
|
1791
1948
|
# @return [String]
|
1792
1949
|
#
|
1793
1950
|
# @!attribute [rw] job_queue
|
1794
|
-
# The job queue into which the job
|
1951
|
+
# The job queue into which the job is submitted. You can specify
|
1795
1952
|
# either the name or the Amazon Resource Name (ARN) of the queue.
|
1796
1953
|
# @return [String]
|
1797
1954
|
#
|
1955
|
+
# @!attribute [rw] array_properties
|
1956
|
+
# The array properties for the submitted job, such as the size of the
|
1957
|
+
# array. The array size can be between 2 and 10,000. If you specify
|
1958
|
+
# array properties for a job, it becomes an array job. For more
|
1959
|
+
# information, see [Array Jobs][1] in the *AWS Batch User Guide*.
|
1960
|
+
#
|
1961
|
+
#
|
1962
|
+
#
|
1963
|
+
# [1]: http://docs.aws.amazon.com/batch/latest/userguide/array_jobs.html
|
1964
|
+
# @return [Types::ArrayProperties]
|
1965
|
+
#
|
1798
1966
|
# @!attribute [rw] depends_on
|
1799
|
-
# A list of
|
1800
|
-
#
|
1967
|
+
# A list of dependencies for the job. A job can depend upon a maximum
|
1968
|
+
# of 20 jobs. You can specify a `SEQUENTIAL` type dependency without
|
1969
|
+
# specifying a job ID for array jobs so that each child array job
|
1970
|
+
# completes sequentially, starting at index 0. You can also specify an
|
1971
|
+
# `N_TO_N` type dependency with a job ID for array jobs so that each
|
1972
|
+
# index child of this job must wait for the corresponding index child
|
1973
|
+
# of each dependency to complete before it can begin.
|
1801
1974
|
# @return [Array<Types::JobDependency>]
|
1802
1975
|
#
|
1803
1976
|
# @!attribute [rw] job_definition
|
@@ -1836,6 +2009,7 @@ module Aws::Batch
|
|
1836
2009
|
class SubmitJobRequest < Struct.new(
|
1837
2010
|
:job_name,
|
1838
2011
|
:job_queue,
|
2012
|
+
:array_properties,
|
1839
2013
|
:depends_on,
|
1840
2014
|
:job_definition,
|
1841
2015
|
:parameters,
|
@@ -1874,7 +2048,7 @@ module Aws::Batch
|
|
1874
2048
|
#
|
1875
2049
|
# @!attribute [rw] reason
|
1876
2050
|
# A message to attach to the job that explains the reason for
|
1877
|
-
#
|
2051
|
+
# canceling it. This message is returned by future DescribeJobs
|
1878
2052
|
# operations on the job. This message is also recorded in the AWS
|
1879
2053
|
# Batch activity logs.
|
1880
2054
|
# @return [String]
|
@@ -2078,7 +2252,7 @@ module Aws::Batch
|
|
2078
2252
|
# The contents of the `host` parameter determine whether your data
|
2079
2253
|
# volume persists on the host container instance and where it is
|
2080
2254
|
# stored. If the host parameter is empty, then the Docker daemon
|
2081
|
-
# assigns a host path for your data volume,
|
2255
|
+
# assigns a host path for your data volume. However, the data is not
|
2082
2256
|
# guaranteed to persist after the containers associated with it stop
|
2083
2257
|
# running.
|
2084
2258
|
# @return [Types::Host]
|
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: aws-sdk-batch
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 1.
|
4
|
+
version: 1.3.0
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Amazon Web Services
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date: 2017-11-
|
11
|
+
date: 2017-11-29 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: aws-sdk-core
|