aws-sdk-batch 1.42.0 → 1.47.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +308 -0
- data/LICENSE.txt +202 -0
- data/VERSION +1 -0
- data/lib/aws-sdk-batch.rb +2 -2
- data/lib/aws-sdk-batch/client.rb +215 -91
- data/lib/aws-sdk-batch/client_api.rb +18 -2
- data/lib/aws-sdk-batch/errors.rb +1 -1
- data/lib/aws-sdk-batch/resource.rb +1 -1
- data/lib/aws-sdk-batch/types.rb +690 -258
- metadata +10 -7
@@ -3,7 +3,7 @@
|
|
3
3
|
# WARNING ABOUT GENERATED CODE
|
4
4
|
#
|
5
5
|
# This file is generated. See the contributing guide for more information:
|
6
|
-
# https://github.com/aws/aws-sdk-ruby/blob/
|
6
|
+
# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
|
7
7
|
#
|
8
8
|
# WARNING ABOUT GENERATED CODE
|
9
9
|
|
@@ -63,6 +63,10 @@ module Aws::Batch
|
|
63
63
|
DeviceCgroupPermission = Shapes::StringShape.new(name: 'DeviceCgroupPermission')
|
64
64
|
DeviceCgroupPermissions = Shapes::ListShape.new(name: 'DeviceCgroupPermissions')
|
65
65
|
DevicesList = Shapes::ListShape.new(name: 'DevicesList')
|
66
|
+
EFSAuthorizationConfig = Shapes::StructureShape.new(name: 'EFSAuthorizationConfig')
|
67
|
+
EFSAuthorizationConfigIAM = Shapes::StringShape.new(name: 'EFSAuthorizationConfigIAM')
|
68
|
+
EFSTransitEncryption = Shapes::StringShape.new(name: 'EFSTransitEncryption')
|
69
|
+
EFSVolumeConfiguration = Shapes::StructureShape.new(name: 'EFSVolumeConfiguration')
|
66
70
|
Ec2Configuration = Shapes::StructureShape.new(name: 'Ec2Configuration')
|
67
71
|
Ec2ConfigurationList = Shapes::ListShape.new(name: 'Ec2ConfigurationList')
|
68
72
|
EnvironmentVariables = Shapes::ListShape.new(name: 'EnvironmentVariables')
|
@@ -303,7 +307,7 @@ module Aws::Batch
|
|
303
307
|
CreateComputeEnvironmentRequest.add_member(:type, Shapes::ShapeRef.new(shape: CEType, required: true, location_name: "type"))
|
304
308
|
CreateComputeEnvironmentRequest.add_member(:state, Shapes::ShapeRef.new(shape: CEState, location_name: "state"))
|
305
309
|
CreateComputeEnvironmentRequest.add_member(:compute_resources, Shapes::ShapeRef.new(shape: ComputeResource, location_name: "computeResources"))
|
306
|
-
CreateComputeEnvironmentRequest.add_member(:service_role, Shapes::ShapeRef.new(shape: String,
|
310
|
+
CreateComputeEnvironmentRequest.add_member(:service_role, Shapes::ShapeRef.new(shape: String, location_name: "serviceRole"))
|
307
311
|
CreateComputeEnvironmentRequest.add_member(:tags, Shapes::ShapeRef.new(shape: TagrisTagsMap, location_name: "tags"))
|
308
312
|
CreateComputeEnvironmentRequest.struct_class = Types::CreateComputeEnvironmentRequest
|
309
313
|
|
@@ -381,6 +385,17 @@ module Aws::Batch
|
|
381
385
|
|
382
386
|
DevicesList.member = Shapes::ShapeRef.new(shape: Device)
|
383
387
|
|
388
|
+
EFSAuthorizationConfig.add_member(:access_point_id, Shapes::ShapeRef.new(shape: String, location_name: "accessPointId"))
|
389
|
+
EFSAuthorizationConfig.add_member(:iam, Shapes::ShapeRef.new(shape: EFSAuthorizationConfigIAM, location_name: "iam"))
|
390
|
+
EFSAuthorizationConfig.struct_class = Types::EFSAuthorizationConfig
|
391
|
+
|
392
|
+
EFSVolumeConfiguration.add_member(:file_system_id, Shapes::ShapeRef.new(shape: String, required: true, location_name: "fileSystemId"))
|
393
|
+
EFSVolumeConfiguration.add_member(:root_directory, Shapes::ShapeRef.new(shape: String, location_name: "rootDirectory"))
|
394
|
+
EFSVolumeConfiguration.add_member(:transit_encryption, Shapes::ShapeRef.new(shape: EFSTransitEncryption, location_name: "transitEncryption"))
|
395
|
+
EFSVolumeConfiguration.add_member(:transit_encryption_port, Shapes::ShapeRef.new(shape: Integer, location_name: "transitEncryptionPort"))
|
396
|
+
EFSVolumeConfiguration.add_member(:authorization_config, Shapes::ShapeRef.new(shape: EFSAuthorizationConfig, location_name: "authorizationConfig"))
|
397
|
+
EFSVolumeConfiguration.struct_class = Types::EFSVolumeConfiguration
|
398
|
+
|
384
399
|
Ec2Configuration.add_member(:image_type, Shapes::ShapeRef.new(shape: ImageType, required: true, location_name: "imageType"))
|
385
400
|
Ec2Configuration.add_member(:image_id_override, Shapes::ShapeRef.new(shape: ImageIdOverride, location_name: "imageIdOverride"))
|
386
401
|
Ec2Configuration.struct_class = Types::Ec2Configuration
|
@@ -696,6 +711,7 @@ module Aws::Batch
|
|
696
711
|
|
697
712
|
Volume.add_member(:host, Shapes::ShapeRef.new(shape: Host, location_name: "host"))
|
698
713
|
Volume.add_member(:name, Shapes::ShapeRef.new(shape: String, location_name: "name"))
|
714
|
+
Volume.add_member(:efs_volume_configuration, Shapes::ShapeRef.new(shape: EFSVolumeConfiguration, location_name: "efsVolumeConfiguration"))
|
699
715
|
Volume.struct_class = Types::Volume
|
700
716
|
|
701
717
|
Volumes.member = Shapes::ShapeRef.new(shape: Volume)
|
data/lib/aws-sdk-batch/errors.rb
CHANGED
@@ -3,7 +3,7 @@
|
|
3
3
|
# WARNING ABOUT GENERATED CODE
|
4
4
|
#
|
5
5
|
# This file is generated. See the contributing guide for more information:
|
6
|
-
# https://github.com/aws/aws-sdk-ruby/blob/
|
6
|
+
# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
|
7
7
|
#
|
8
8
|
# WARNING ABOUT GENERATED CODE
|
9
9
|
|
@@ -3,7 +3,7 @@
|
|
3
3
|
# WARNING ABOUT GENERATED CODE
|
4
4
|
#
|
5
5
|
# This file is generated. See the contributing guide for more information:
|
6
|
-
# https://github.com/aws/aws-sdk-ruby/blob/
|
6
|
+
# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
|
7
7
|
#
|
8
8
|
# WARNING ABOUT GENERATED CODE
|
9
9
|
|
data/lib/aws-sdk-batch/types.rb
CHANGED
@@ -3,7 +3,7 @@
|
|
3
3
|
# WARNING ABOUT GENERATED CODE
|
4
4
|
#
|
5
5
|
# This file is generated. See the contributing guide for more information:
|
6
|
-
# https://github.com/aws/aws-sdk-ruby/blob/
|
6
|
+
# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
|
7
7
|
#
|
8
8
|
# WARNING ABOUT GENERATED CODE
|
9
9
|
|
@@ -44,7 +44,7 @@ module Aws::Batch
|
|
44
44
|
# @return [Integer]
|
45
45
|
#
|
46
46
|
# @!attribute [rw] index
|
47
|
-
# The job index within the array that
|
47
|
+
# The job index within the array that's associated with this job.
|
48
48
|
# This parameter is returned for array job children.
|
49
49
|
# @return [Integer]
|
50
50
|
#
|
@@ -66,7 +66,7 @@ module Aws::Batch
|
|
66
66
|
# @return [Integer]
|
67
67
|
#
|
68
68
|
# @!attribute [rw] index
|
69
|
-
# The job index within the array that
|
69
|
+
# The job index within the array that's associated with this job.
|
70
70
|
# This parameter is returned for children of array jobs.
|
71
71
|
# @return [Integer]
|
72
72
|
#
|
@@ -79,7 +79,7 @@ module Aws::Batch
|
|
79
79
|
include Aws::Structure
|
80
80
|
end
|
81
81
|
|
82
|
-
# An object representing the details of a container that
|
82
|
+
# An object representing the details of a container that's part of a
|
83
83
|
# job attempt.
|
84
84
|
#
|
85
85
|
# @!attribute [rw] container_instance_arn
|
@@ -88,7 +88,7 @@ module Aws::Batch
|
|
88
88
|
# @return [String]
|
89
89
|
#
|
90
90
|
# @!attribute [rw] task_arn
|
91
|
-
# The Amazon Resource Name (ARN) of the Amazon ECS task that
|
91
|
+
# The Amazon Resource Name (ARN) of the Amazon ECS task that's
|
92
92
|
# associated with the job attempt. Each container attempt receives a
|
93
93
|
# task ARN when they reach the `STARTING` status.
|
94
94
|
# @return [String]
|
@@ -161,6 +161,8 @@ module Aws::Batch
|
|
161
161
|
include Aws::Structure
|
162
162
|
end
|
163
163
|
|
164
|
+
# Contains the parameters for `CancelJob`.
|
165
|
+
#
|
164
166
|
# @note When making an API call, you may pass CancelJobRequest
|
165
167
|
# data as a hash:
|
166
168
|
#
|
@@ -195,7 +197,7 @@ module Aws::Batch
|
|
195
197
|
|
196
198
|
# These errors are usually caused by a client action, such as using an
|
197
199
|
# action or resource on behalf of a user that doesn't have permissions
|
198
|
-
# to use the action or resource, or specifying an identifier that
|
200
|
+
# to use the action or resource, or specifying an identifier that's not
|
199
201
|
# valid.
|
200
202
|
#
|
201
203
|
# @!attribute [rw] message
|
@@ -212,7 +214,8 @@ module Aws::Batch
|
|
212
214
|
# An object representing an AWS Batch compute environment.
|
213
215
|
#
|
214
216
|
# @!attribute [rw] compute_environment_name
|
215
|
-
# The name of the compute environment.
|
217
|
+
# The name of the compute environment. Up to 128 letters (uppercase
|
218
|
+
# and lowercase), numbers, hyphens, and underscores are allowed.
|
216
219
|
# @return [String]
|
217
220
|
#
|
218
221
|
# @!attribute [rw] compute_environment_arn
|
@@ -229,9 +232,9 @@ module Aws::Batch
|
|
229
232
|
# @return [Hash<String,String>]
|
230
233
|
#
|
231
234
|
# @!attribute [rw] type
|
232
|
-
# The type of compute environment: `
|
233
|
-
#
|
234
|
-
#
|
235
|
+
# The type of the compute environment: `MANAGED` or `UNMANAGED`. For
|
236
|
+
# more information, see [Compute Environments][1] in the *AWS Batch
|
237
|
+
# User Guide*.
|
235
238
|
#
|
236
239
|
#
|
237
240
|
#
|
@@ -251,7 +254,7 @@ module Aws::Batch
|
|
251
254
|
# If the state is `DISABLED`, then the AWS Batch scheduler doesn't
|
252
255
|
# attempt to place jobs within the environment. Jobs in a `STARTING`
|
253
256
|
# or `RUNNING` state continue to progress normally. Managed compute
|
254
|
-
# environments in the `DISABLED` state
|
257
|
+
# environments in the `DISABLED` state don't scale out. However, they
|
255
258
|
# scale in to `minvCpus` value after instances become idle.
|
256
259
|
# @return [String]
|
257
260
|
#
|
@@ -266,12 +269,24 @@ module Aws::Batch
|
|
266
269
|
# @return [String]
|
267
270
|
#
|
268
271
|
# @!attribute [rw] compute_resources
|
269
|
-
# The compute resources defined for the compute environment.
|
272
|
+
# The compute resources defined for the compute environment. For more
|
273
|
+
# information, see [Compute Environments][1] in the *AWS Batch User
|
274
|
+
# Guide*.
|
275
|
+
#
|
276
|
+
#
|
277
|
+
#
|
278
|
+
# [1]: https://docs.aws.amazon.com/batch/latest/userguide/compute_environments.html
|
270
279
|
# @return [Types::ComputeResource]
|
271
280
|
#
|
272
281
|
# @!attribute [rw] service_role
|
273
282
|
# The service role associated with the compute environment that allows
|
274
|
-
# AWS Batch to make calls to AWS API operations on your behalf.
|
283
|
+
# AWS Batch to make calls to AWS API operations on your behalf. For
|
284
|
+
# more information, see [AWS Batch service IAM role][1] in the *AWS
|
285
|
+
# Batch User Guide*.
|
286
|
+
#
|
287
|
+
#
|
288
|
+
#
|
289
|
+
# [1]: https://docs.aws.amazon.com/batch/latest/userguide/service_IAM_role.html
|
275
290
|
# @return [String]
|
276
291
|
#
|
277
292
|
# @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/ComputeEnvironmentDetail AWS API Documentation
|
@@ -295,7 +310,17 @@ module Aws::Batch
|
|
295
310
|
# within a queue. Compute environments are tried in ascending order. For
|
296
311
|
# example, if two compute environments are associated with a job queue,
|
297
312
|
# the compute environment with a lower order integer value is tried for
|
298
|
-
# job placement first.
|
313
|
+
# job placement first. Compute environments must be in the `VALID` state
|
314
|
+
# before you can associate them with a job queue. All of the compute
|
315
|
+
# environments must be either EC2 (`EC2` or `SPOT`) or Fargate
|
316
|
+
# (`FARGATE` or `FARGATE_SPOT`); EC2 and Fargate compute environments
|
317
|
+
# can't be mixed.
|
318
|
+
#
|
319
|
+
# <note markdown="1"> All compute environments that are associated with a job queue must
|
320
|
+
# share the same architecture. AWS Batch doesn't support mixing compute
|
321
|
+
# environment architecture types in a single job queue.
|
322
|
+
#
|
323
|
+
# </note>
|
299
324
|
#
|
300
325
|
# @note When making an API call, you may pass ComputeEnvironmentOrder
|
301
326
|
# data as a hash:
|
@@ -325,7 +350,13 @@ module Aws::Batch
|
|
325
350
|
include Aws::Structure
|
326
351
|
end
|
327
352
|
|
328
|
-
# An object representing an AWS Batch compute resource.
|
353
|
+
# An object representing an AWS Batch compute resource. For more
|
354
|
+
# information, see [Compute Environments][1] in the *AWS Batch User
|
355
|
+
# Guide*.
|
356
|
+
#
|
357
|
+
#
|
358
|
+
#
|
359
|
+
# [1]: https://docs.aws.amazon.com/batch/latest/userguide/compute_environments.html
|
329
360
|
#
|
330
361
|
# @note When making an API call, you may pass ComputeResource
|
331
362
|
# data as a hash:
|
@@ -366,9 +397,14 @@ module Aws::Batch
|
|
366
397
|
# `FARGATE_SPOT`. For more information, see [Compute Environments][1]
|
367
398
|
# in the *AWS Batch User Guide*.
|
368
399
|
#
|
400
|
+
# If you choose `SPOT`, you must also specify an Amazon EC2 Spot Fleet
|
401
|
+
# role with the `spotIamFleetRole` parameter. For more information,
|
402
|
+
# see [Amazon EC2 Spot Fleet role][2] in the *AWS Batch User Guide*.
|
403
|
+
#
|
369
404
|
#
|
370
405
|
#
|
371
406
|
# [1]: https://docs.aws.amazon.com/batch/latest/userguide/compute_environments.html
|
407
|
+
# [2]: https://docs.aws.amazon.com/batch/latest/userguide/spot_fleet_IAM_role.html
|
372
408
|
# @return [String]
|
373
409
|
#
|
374
410
|
# @!attribute [rw] allocation_strategy
|
@@ -388,13 +424,13 @@ module Aws::Batch
|
|
388
424
|
# : AWS Batch selects an instance type that best fits the needs of the
|
389
425
|
# jobs with a preference for the lowest-cost instance type. If
|
390
426
|
# additional instances of the selected instance type aren't
|
391
|
-
# available, AWS Batch
|
392
|
-
# available. If there
|
427
|
+
# available, AWS Batch waits for the additional instances to be
|
428
|
+
# available. If there aren't enough instances available, or if the
|
393
429
|
# user is hitting [Amazon EC2 service limits][1] then additional
|
394
|
-
# jobs aren't run until currently running jobs have completed.
|
395
|
-
# allocation strategy keeps costs lower but can limit scaling.
|
396
|
-
# you are using Spot Fleets with `BEST_FIT` then the Spot Fleet
|
397
|
-
# Role must be specified.
|
430
|
+
# jobs aren't run until the currently running jobs have completed.
|
431
|
+
# This allocation strategy keeps costs lower but can limit scaling.
|
432
|
+
# If you are using Spot Fleets with `BEST_FIT` then the Spot Fleet
|
433
|
+
# IAM Role must be specified.
|
398
434
|
#
|
399
435
|
# BEST\_FIT\_PROGRESSIVE
|
400
436
|
#
|
@@ -434,15 +470,15 @@ module Aws::Batch
|
|
434
470
|
# @return [Integer]
|
435
471
|
#
|
436
472
|
# @!attribute [rw] maxv_cpus
|
437
|
-
# The maximum number of Amazon EC2 vCPUs that
|
438
|
-
# reach.
|
473
|
+
# The maximum number of Amazon EC2 vCPUs that a compute environment
|
474
|
+
# can reach.
|
439
475
|
#
|
440
476
|
# <note markdown="1"> With both `BEST_FIT_PROGRESSIVE` and `SPOT_CAPACITY_OPTIMIZED`
|
441
|
-
# allocation strategies, AWS Batch
|
442
|
-
# meet your capacity requirements. In this event, AWS Batch
|
443
|
-
#
|
444
|
-
# than a single instance from among those specified in your
|
445
|
-
# environment
|
477
|
+
# allocation strategies, AWS Batch might need to exceed `maxvCpus` to
|
478
|
+
# meet your capacity requirements. In this event, AWS Batch never
|
479
|
+
# exceeds `maxvCpus` by more than a single instance. For example, no
|
480
|
+
# more than a single instance from among those specified in your
|
481
|
+
# compute environment is allocated.
|
446
482
|
#
|
447
483
|
# </note>
|
448
484
|
# @return [Integer]
|
@@ -459,12 +495,12 @@ module Aws::Batch
|
|
459
495
|
# @return [Integer]
|
460
496
|
#
|
461
497
|
# @!attribute [rw] instance_types
|
462
|
-
# The instances types that
|
498
|
+
# The instances types that can be launched. You can specify instance
|
463
499
|
# families to launch any instance type within those families (for
|
464
500
|
# example, `c5` or `p3`), or you can specify specific sizes within a
|
465
501
|
# family (such as `c5.8xlarge`). You can also choose `optimal` to
|
466
|
-
# select instance types (from the
|
467
|
-
#
|
502
|
+
# select instance types (from the C4, M4, and R4 instance families)
|
503
|
+
# that match the demand of your job queues.
|
468
504
|
#
|
469
505
|
# <note markdown="1"> This parameter isn't applicable to jobs running on Fargate
|
470
506
|
# resources, and shouldn't be specified.
|
@@ -477,6 +513,13 @@ module Aws::Batch
|
|
477
513
|
# compute environment.
|
478
514
|
#
|
479
515
|
# </note>
|
516
|
+
#
|
517
|
+
# <note markdown="1"> Currently, `optimal` uses instance types from the C4, M4, and R4
|
518
|
+
# instance families. In Regions that don't have instance types from
|
519
|
+
# those instance families, instance types from the C5, M5. and R5
|
520
|
+
# instance families are used.
|
521
|
+
#
|
522
|
+
# </note>
|
480
523
|
# @return [Array<String>]
|
481
524
|
#
|
482
525
|
# @!attribute [rw] image_id
|
@@ -507,10 +550,9 @@ module Aws::Batch
|
|
507
550
|
#
|
508
551
|
# @!attribute [rw] subnets
|
509
552
|
# The VPC subnets into which the compute resources are launched. These
|
510
|
-
# subnets must be within the same VPC.
|
511
|
-
#
|
512
|
-
#
|
513
|
-
# *Amazon VPC User Guide*.
|
553
|
+
# subnets must be within the same VPC. Fargate compute resources can
|
554
|
+
# contain up to 16 subnets. For more information, see [VPCs and
|
555
|
+
# Subnets][1] in the *Amazon VPC User Guide*.
|
514
556
|
#
|
515
557
|
#
|
516
558
|
#
|
@@ -523,13 +565,13 @@ module Aws::Batch
|
|
523
565
|
# specified, either in `securityGroupIds` or using a launch template
|
524
566
|
# referenced in `launchTemplate`. This parameter is required for jobs
|
525
567
|
# running on Fargate resources and must contain at least one security
|
526
|
-
# group.
|
527
|
-
#
|
528
|
-
#
|
568
|
+
# group. Fargate doesn't support launch templates. If security groups
|
569
|
+
# are specified using both `securityGroupIds` and `launchTemplate`,
|
570
|
+
# the values in `securityGroupIds` is used.
|
529
571
|
# @return [Array<String>]
|
530
572
|
#
|
531
573
|
# @!attribute [rw] ec2_key_pair
|
532
|
-
# The Amazon EC2 key pair that
|
574
|
+
# The Amazon EC2 key pair that's used for instances launched in the
|
533
575
|
# compute environment. You can use this key pair to log in to your
|
534
576
|
# instances with SSH.
|
535
577
|
#
|
@@ -562,13 +604,18 @@ module Aws::Batch
|
|
562
604
|
# Key-value pair tags to be applied to EC2 resources that are launched
|
563
605
|
# in the compute environment. For AWS Batch, these take the form of
|
564
606
|
# "String1": "String2", where String1 is the tag key and String2
|
565
|
-
# is the tag value
|
607
|
+
# is the tag value−for example, \\\{ "Name": "AWS Batch Instance -
|
566
608
|
# C4OnDemand" \\}. This is helpful for recognizing your AWS Batch
|
567
|
-
# instances in the Amazon EC2 console. These tags can
|
568
|
-
#
|
569
|
-
#
|
570
|
-
#
|
609
|
+
# instances in the Amazon EC2 console. These tags can't be updated or
|
610
|
+
# removed after the compute environment has been created; any changes
|
611
|
+
# require creating a new compute environment and removing the old
|
612
|
+
# compute environment. These tags aren't seen when using the AWS
|
571
613
|
# Batch `ListTagsForResource` API operation.
|
614
|
+
#
|
615
|
+
# <note markdown="1"> This parameter isn't applicable to jobs running on Fargate
|
616
|
+
# resources, and shouldn't be specified.
|
617
|
+
#
|
618
|
+
# </note>
|
572
619
|
# @return [Hash<String,String>]
|
573
620
|
#
|
574
621
|
# @!attribute [rw] placement_group
|
@@ -595,11 +642,11 @@ module Aws::Batch
|
|
595
642
|
# The maximum percentage that a Spot Instance price can be when
|
596
643
|
# compared with the On-Demand price for that instance type before
|
597
644
|
# instances are launched. For example, if your maximum percentage is
|
598
|
-
# 20%, then the Spot price must be
|
599
|
-
# price for that Amazon EC2 instance. You always pay the
|
600
|
-
# (market) price and never more than your maximum percentage.
|
601
|
-
# leave this field empty, the default value is 100% of the
|
602
|
-
# price.
|
645
|
+
# 20%, then the Spot price must be less than 20% of the current
|
646
|
+
# On-Demand price for that Amazon EC2 instance. You always pay the
|
647
|
+
# lowest (market) price and never more than your maximum percentage.
|
648
|
+
# If you leave this field empty, the default value is 100% of the
|
649
|
+
# On-Demand price.
|
603
650
|
#
|
604
651
|
# <note markdown="1"> This parameter isn't applicable to jobs running on Fargate
|
605
652
|
# resources, and shouldn't be specified.
|
@@ -653,8 +700,8 @@ module Aws::Batch
|
|
653
700
|
#
|
654
701
|
# @!attribute [rw] ec2_configuration
|
655
702
|
# Provides information used to select Amazon Machine Images (AMIs) for
|
656
|
-
# instances in the compute environment. If `Ec2Configuration`
|
657
|
-
# specified, the default is `ECS_AL1`.
|
703
|
+
# EC2 instances in the compute environment. If `Ec2Configuration`
|
704
|
+
# isn't specified, the default is `ECS_AL1`.
|
658
705
|
#
|
659
706
|
# <note markdown="1"> This parameter isn't applicable to jobs running on Fargate
|
660
707
|
# resources, and shouldn't be specified.
|
@@ -687,7 +734,12 @@ module Aws::Batch
|
|
687
734
|
end
|
688
735
|
|
689
736
|
# An object representing the attributes of a compute environment that
|
690
|
-
# can be updated.
|
737
|
+
# can be updated. For more information, see [Compute Environments][1] in
|
738
|
+
# the *AWS Batch User Guide*.
|
739
|
+
#
|
740
|
+
#
|
741
|
+
#
|
742
|
+
# [1]: https://docs.aws.amazon.com/batch/latest/userguide/compute_environments.html
|
691
743
|
#
|
692
744
|
# @note When making an API call, you may pass ComputeResourceUpdate
|
693
745
|
# data as a hash:
|
@@ -704,8 +756,8 @@ module Aws::Batch
|
|
704
756
|
# The minimum number of Amazon EC2 vCPUs that an environment should
|
705
757
|
# maintain.
|
706
758
|
#
|
707
|
-
# <note markdown="1"> This parameter
|
708
|
-
# and shouldn't be specified.
|
759
|
+
# <note markdown="1"> This parameter isn't applicable to jobs running on Fargate
|
760
|
+
# resources, and shouldn't be specified.
|
709
761
|
#
|
710
762
|
# </note>
|
711
763
|
# @return [Integer]
|
@@ -713,6 +765,15 @@ module Aws::Batch
|
|
713
765
|
# @!attribute [rw] maxv_cpus
|
714
766
|
# The maximum number of Amazon EC2 vCPUs that an environment can
|
715
767
|
# reach.
|
768
|
+
#
|
769
|
+
# <note markdown="1"> With both `BEST_FIT_PROGRESSIVE` and `SPOT_CAPACITY_OPTIMIZED`
|
770
|
+
# allocation strategies, AWS Batch might need to exceed `maxvCpus` to
|
771
|
+
# meet your capacity requirements. In this event, AWS Batch never
|
772
|
+
# exceeds `maxvCpus` by more than a single instance. That is, no more
|
773
|
+
# than a single instance from among those specified in your compute
|
774
|
+
# environment.
|
775
|
+
#
|
776
|
+
# </note>
|
716
777
|
# @return [Integer]
|
717
778
|
#
|
718
779
|
# @!attribute [rw] desiredv_cpus
|
@@ -725,13 +786,12 @@ module Aws::Batch
|
|
725
786
|
# @return [Integer]
|
726
787
|
#
|
727
788
|
# @!attribute [rw] subnets
|
728
|
-
# The VPC subnets that the compute resources are launched into.
|
729
|
-
#
|
730
|
-
#
|
731
|
-
#
|
732
|
-
#
|
733
|
-
#
|
734
|
-
# made.
|
789
|
+
# The VPC subnets that the compute resources are launched into.
|
790
|
+
# Fargate compute resources can contain up to 16 subnets. Providing an
|
791
|
+
# empty list will be handled as if this parameter wasn't specified
|
792
|
+
# and no change is made. This can't be specified for EC2 compute
|
793
|
+
# resources. For more information, see [VPCs and Subnets][1] in the
|
794
|
+
# *Amazon VPC User Guide*.
|
735
795
|
#
|
736
796
|
#
|
737
797
|
#
|
@@ -744,7 +804,7 @@ module Aws::Batch
|
|
744
804
|
# compute resources, where it can contain up to 5 security groups.
|
745
805
|
# This can't be specified for EC2 compute resources. Providing an
|
746
806
|
# empty list is handled as if this parameter wasn't specified and no
|
747
|
-
#
|
807
|
+
# change is made.
|
748
808
|
# @return [Array<String>]
|
749
809
|
#
|
750
810
|
# @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/ComputeResourceUpdate AWS API Documentation
|
@@ -759,7 +819,7 @@ module Aws::Batch
|
|
759
819
|
include Aws::Structure
|
760
820
|
end
|
761
821
|
|
762
|
-
# An object representing the details of a container that
|
822
|
+
# An object representing the details of a container that's part of a
|
763
823
|
# job.
|
764
824
|
#
|
765
825
|
# @!attribute [rw] image
|
@@ -767,19 +827,20 @@ module Aws::Batch
|
|
767
827
|
# @return [String]
|
768
828
|
#
|
769
829
|
# @!attribute [rw] vcpus
|
770
|
-
# The number of vCPUs reserved for the container.
|
771
|
-
# resources can specify the vCPU requirement for the job
|
772
|
-
# `resourceRequirements
|
773
|
-
#
|
774
|
-
# maps to `CpuShares` in the [Create a container][1]
|
775
|
-
# [Docker Remote API][2] and the `--cpu-shares` option
|
776
|
-
# run][3]. Each vCPU is equivalent to 1,024 CPU shares. You
|
777
|
-
# specify at least one vCPU. This is required but can be
|
778
|
-
# several places. It must be specified for each node at
|
779
|
-
#
|
780
|
-
#
|
781
|
-
#
|
782
|
-
#
|
830
|
+
# The number of vCPUs reserved for the container. For jobs that run on
|
831
|
+
# EC2 resources, you can specify the vCPU requirement for the job
|
832
|
+
# using `resourceRequirements`, but you can't specify the vCPU
|
833
|
+
# requirements in both the `vcpus` and `resourceRequirement` object.
|
834
|
+
# This parameter maps to `CpuShares` in the [Create a container][1]
|
835
|
+
# section of the [Docker Remote API][2] and the `--cpu-shares` option
|
836
|
+
# to [docker run][3]. Each vCPU is equivalent to 1,024 CPU shares. You
|
837
|
+
# must specify at least one vCPU. This is required but can be
|
838
|
+
# specified in several places. It must be specified for each node at
|
839
|
+
# least once.
|
840
|
+
#
|
841
|
+
# <note markdown="1"> This parameter isn't applicable to jobs that run on Fargate
|
842
|
+
# resources. For jobs that run on Fargate resources, you must specify
|
843
|
+
# the vCPU requirement for the job using `resourceRequirements`.
|
783
844
|
#
|
784
845
|
# </note>
|
785
846
|
#
|
@@ -798,7 +859,7 @@ module Aws::Batch
|
|
798
859
|
# @return [Integer]
|
799
860
|
#
|
800
861
|
# @!attribute [rw] command
|
801
|
-
# The command that
|
862
|
+
# The command that's passed to the container.
|
802
863
|
# @return [Array<String>]
|
803
864
|
#
|
804
865
|
# @!attribute [rw] job_role_arn
|
@@ -902,7 +963,7 @@ module Aws::Batch
|
|
902
963
|
# @return [String]
|
903
964
|
#
|
904
965
|
# @!attribute [rw] task_arn
|
905
|
-
# The Amazon Resource Name (ARN) of the Amazon ECS task that
|
966
|
+
# The Amazon Resource Name (ARN) of the Amazon ECS task that's
|
906
967
|
# associated with the container job. Each container attempt receives a
|
907
968
|
# task ARN when they reach the `STARTING` status.
|
908
969
|
# @return [String]
|
@@ -944,7 +1005,7 @@ module Aws::Batch
|
|
944
1005
|
# This parameter maps to `LogConfig` in the [Create a container][1]
|
945
1006
|
# section of the [Docker Remote API][2] and the `--log-driver` option
|
946
1007
|
# to [docker run][3]. By default, containers use the same logging
|
947
|
-
# driver that the Docker daemon uses. However the container might use
|
1008
|
+
# driver that the Docker daemon uses. However, the container might use
|
948
1009
|
# a different logging driver than the Docker daemon by specifying a
|
949
1010
|
# log driver with this parameter in the container definition. To use a
|
950
1011
|
# different logging driver for a container, the log system must be
|
@@ -956,8 +1017,8 @@ module Aws::Batch
|
|
956
1017
|
#
|
957
1018
|
# <note markdown="1"> AWS Batch currently supports a subset of the logging drivers
|
958
1019
|
# available to the Docker daemon (shown in the LogConfiguration data
|
959
|
-
# type). Additional log drivers
|
960
|
-
# the Amazon ECS container agent.
|
1020
|
+
# type). Additional log drivers might be available in future releases
|
1021
|
+
# of the Amazon ECS container agent.
|
961
1022
|
#
|
962
1023
|
# </note>
|
963
1024
|
#
|
@@ -1063,21 +1124,25 @@ module Aws::Batch
|
|
1063
1124
|
# }
|
1064
1125
|
#
|
1065
1126
|
# @!attribute [rw] vcpus
|
1066
|
-
# This parameter
|
1067
|
-
#
|
1068
|
-
#
|
1069
|
-
#
|
1070
|
-
#
|
1071
|
-
#
|
1072
|
-
#
|
1073
|
-
#
|
1074
|
-
#
|
1075
|
-
#
|
1076
|
-
#
|
1077
|
-
#
|
1078
|
-
#
|
1079
|
-
#
|
1080
|
-
#
|
1127
|
+
# This parameter indicates the number of vCPUs reserved for the
|
1128
|
+
# container.It overrides the `vcpus` parameter that's set in the job
|
1129
|
+
# definition, but doesn't override any vCPU requirement specified in
|
1130
|
+
# the `resourceRequirement` structure in the job definition.
|
1131
|
+
#
|
1132
|
+
# This parameter is supported for jobs that run on EC2 resources, but
|
1133
|
+
# isn't supported for jobs that run on Fargate resources. For Fargate
|
1134
|
+
# resources, you can only use `resourceRequirement`. For EC2
|
1135
|
+
# resources, you can use either this parameter or
|
1136
|
+
# `resourceRequirement` but not both.
|
1137
|
+
#
|
1138
|
+
# This parameter maps to `CpuShares` in the [Create a container][1]
|
1139
|
+
# section of the [Docker Remote API][2] and the `--cpu-shares` option
|
1140
|
+
# to [docker run][3]. Each vCPU is equivalent to 1,024 CPU shares. You
|
1141
|
+
# must specify at least one vCPU.
|
1142
|
+
#
|
1143
|
+
# <note markdown="1"> This parameter isn't applicable to jobs that run on Fargate
|
1144
|
+
# resources and shouldn't be provided. For jobs that run on Fargate
|
1145
|
+
# resources, you must specify the vCPU requirement for the job using
|
1081
1146
|
# `resourceRequirements`.
|
1082
1147
|
#
|
1083
1148
|
# </note>
|
@@ -1090,10 +1155,15 @@ module Aws::Batch
|
|
1090
1155
|
# @return [Integer]
|
1091
1156
|
#
|
1092
1157
|
# @!attribute [rw] memory
|
1093
|
-
# This parameter
|
1094
|
-
#
|
1095
|
-
#
|
1096
|
-
#
|
1158
|
+
# This parameter indicates the amount of memory (in MiB) that's
|
1159
|
+
# reserved for the job. It overrides the `memory` parameter set in the
|
1160
|
+
# job definition, but doesn't override any memory requirement
|
1161
|
+
# specified in the `ResourceRequirement` structure in the job
|
1162
|
+
# definition.
|
1163
|
+
#
|
1164
|
+
# This parameter is supported for jobs that run on EC2 resources, but
|
1165
|
+
# isn't supported for jobs that run on Fargate resources. For these
|
1166
|
+
# resources, use `resourceRequirement` instead.
|
1097
1167
|
# @return [Integer]
|
1098
1168
|
#
|
1099
1169
|
# @!attribute [rw] command
|
@@ -1143,7 +1213,7 @@ module Aws::Batch
|
|
1143
1213
|
end
|
1144
1214
|
|
1145
1215
|
# Container properties are used in job definitions to describe the
|
1146
|
-
# container that
|
1216
|
+
# container that's launched as part of a job.
|
1147
1217
|
#
|
1148
1218
|
# @note When making an API call, you may pass ContainerProperties
|
1149
1219
|
# data as a hash:
|
@@ -1161,6 +1231,16 @@ module Aws::Batch
|
|
1161
1231
|
# source_path: "String",
|
1162
1232
|
# },
|
1163
1233
|
# name: "String",
|
1234
|
+
# efs_volume_configuration: {
|
1235
|
+
# file_system_id: "String", # required
|
1236
|
+
# root_directory: "String",
|
1237
|
+
# transit_encryption: "ENABLED", # accepts ENABLED, DISABLED
|
1238
|
+
# transit_encryption_port: 1,
|
1239
|
+
# authorization_config: {
|
1240
|
+
# access_point_id: "String",
|
1241
|
+
# iam: "ENABLED", # accepts ENABLED, DISABLED
|
1242
|
+
# },
|
1243
|
+
# },
|
1164
1244
|
# },
|
1165
1245
|
# ],
|
1166
1246
|
# environment: [
|
@@ -1276,21 +1356,21 @@ module Aws::Batch
|
|
1276
1356
|
# @return [String]
|
1277
1357
|
#
|
1278
1358
|
# @!attribute [rw] vcpus
|
1279
|
-
#
|
1280
|
-
#
|
1281
|
-
#
|
1282
|
-
#
|
1283
|
-
#
|
1284
|
-
#
|
1285
|
-
#
|
1286
|
-
#
|
1287
|
-
#
|
1288
|
-
#
|
1289
|
-
#
|
1359
|
+
# The number of vCPUs reserved for the job. Each vCPU is equivalent to
|
1360
|
+
# 1,024 CPU shares. This parameter maps to `CpuShares` in the [Create
|
1361
|
+
# a container][1] section of the [Docker Remote API][2] and the
|
1362
|
+
# `--cpu-shares` option to [docker run][3]. The number of vCPUs must
|
1363
|
+
# be specified but can be be specified in several places. You must
|
1364
|
+
# specify it at least once for each node.
|
1365
|
+
#
|
1366
|
+
# This parameter is supported on EC2 resources but isn't supported
|
1367
|
+
# for jobs that run on Fargate resources. For these resources, use
|
1368
|
+
# `resourceRequirement` instead. You can use this parameter or
|
1369
|
+
# `resourceRequirements` structure but not both.
|
1290
1370
|
#
|
1291
1371
|
# <note markdown="1"> This parameter isn't applicable to jobs running on Fargate
|
1292
|
-
# resources and shouldn't be provided.
|
1293
|
-
# resources must specify the vCPU requirement for the job using
|
1372
|
+
# resources and shouldn't be provided. For jobs that run on Fargate
|
1373
|
+
# resources, you must specify the vCPU requirement for the job using
|
1294
1374
|
# `resourceRequirements`.
|
1295
1375
|
#
|
1296
1376
|
# </note>
|
@@ -1303,17 +1383,21 @@ module Aws::Batch
|
|
1303
1383
|
# @return [Integer]
|
1304
1384
|
#
|
1305
1385
|
# @!attribute [rw] memory
|
1306
|
-
# This parameter
|
1307
|
-
#
|
1308
|
-
#
|
1309
|
-
#
|
1310
|
-
#
|
1311
|
-
#
|
1312
|
-
#
|
1313
|
-
#
|
1314
|
-
#
|
1315
|
-
#
|
1316
|
-
#
|
1386
|
+
# This parameter indicates the memory hard limit (in MiB) for a
|
1387
|
+
# container. If your container attempts to exceed the specified
|
1388
|
+
# number, it is terminated. You must specify at least 4 MiB of memory
|
1389
|
+
# for a job using this parameter. The memory hard limit can be
|
1390
|
+
# specified in several places. It must be specified for each node at
|
1391
|
+
# least once.
|
1392
|
+
#
|
1393
|
+
# This parameter maps to `Memory` in the [Create a container][1]
|
1394
|
+
# section of the [Docker Remote API][2] and the `--memory` option to
|
1395
|
+
# [docker run][3].
|
1396
|
+
#
|
1397
|
+
# This parameter is supported on EC2 resources but isn't supported on
|
1398
|
+
# Fargate resources. For Fargate resources, you should specify the
|
1399
|
+
# memory requirement using `resourceRequirement`. You can do this for
|
1400
|
+
# EC2 resources.
|
1317
1401
|
#
|
1318
1402
|
# <note markdown="1"> If you're trying to maximize your resource utilization by providing
|
1319
1403
|
# your jobs as much memory as possible for a particular instance type,
|
@@ -1330,7 +1414,7 @@ module Aws::Batch
|
|
1330
1414
|
# @return [Integer]
|
1331
1415
|
#
|
1332
1416
|
# @!attribute [rw] command
|
1333
|
-
# The command that
|
1417
|
+
# The command that's passed to the container. This parameter maps to
|
1334
1418
|
# `Cmd` in the [Create a container][1] section of the [Docker Remote
|
1335
1419
|
# API][2] and the `COMMAND` parameter to [docker run][3]. For more
|
1336
1420
|
# information, see
|
@@ -1357,9 +1441,9 @@ module Aws::Batch
|
|
1357
1441
|
#
|
1358
1442
|
# @!attribute [rw] execution_role_arn
|
1359
1443
|
# The Amazon Resource Name (ARN) of the execution role that AWS Batch
|
1360
|
-
# can assume.
|
1361
|
-
# execution role. For more information, see [AWS Batch execution
|
1362
|
-
# role][1] in the *AWS Batch User Guide*.
|
1444
|
+
# can assume. For jobs that run on Fargate resources, you must provide
|
1445
|
+
# an execution role. For more information, see [AWS Batch execution
|
1446
|
+
# IAM role][1] in the *AWS Batch User Guide*.
|
1363
1447
|
#
|
1364
1448
|
#
|
1365
1449
|
#
|
@@ -1469,7 +1553,7 @@ module Aws::Batch
|
|
1469
1553
|
# groups in a multi-node parallel job must use the same instance type.
|
1470
1554
|
#
|
1471
1555
|
# <note markdown="1"> This parameter isn't applicable to single-node container jobs or
|
1472
|
-
# for jobs
|
1556
|
+
# for jobs that run on Fargate resources and shouldn't be provided.
|
1473
1557
|
#
|
1474
1558
|
# </note>
|
1475
1559
|
# @return [String]
|
@@ -1596,6 +1680,8 @@ module Aws::Batch
|
|
1596
1680
|
include Aws::Structure
|
1597
1681
|
end
|
1598
1682
|
|
1683
|
+
# Contains the parameters for `CreateComputeEnvironment`.
|
1684
|
+
#
|
1599
1685
|
# @note When making an API call, you may pass CreateComputeEnvironmentRequest
|
1600
1686
|
# data as a hash:
|
1601
1687
|
#
|
@@ -1633,7 +1719,7 @@ module Aws::Batch
|
|
1633
1719
|
# },
|
1634
1720
|
# ],
|
1635
1721
|
# },
|
1636
|
-
# service_role: "String",
|
1722
|
+
# service_role: "String",
|
1637
1723
|
# tags: {
|
1638
1724
|
# "TagKey" => "TagValue",
|
1639
1725
|
# },
|
@@ -1658,6 +1744,18 @@ module Aws::Batch
|
|
1658
1744
|
# The state of the compute environment. If the state is `ENABLED`,
|
1659
1745
|
# then the compute environment accepts jobs from a queue and can scale
|
1660
1746
|
# out automatically based on queues.
|
1747
|
+
#
|
1748
|
+
# If the state is `ENABLED`, then the AWS Batch scheduler can attempt
|
1749
|
+
# to place jobs from an associated job queue on the compute resources
|
1750
|
+
# within the environment. If the compute environment is managed, then
|
1751
|
+
# it can scale its instances out or in automatically, based on the job
|
1752
|
+
# queue demand.
|
1753
|
+
#
|
1754
|
+
# If the state is `DISABLED`, then the AWS Batch scheduler doesn't
|
1755
|
+
# attempt to place jobs within the environment. Jobs in a `STARTING`
|
1756
|
+
# or `RUNNING` state continue to progress normally. Managed compute
|
1757
|
+
# environments in the `DISABLED` state don't scale out. However, they
|
1758
|
+
# scale in to `minvCpus` value after instances become idle.
|
1661
1759
|
# @return [String]
|
1662
1760
|
#
|
1663
1761
|
# @!attribute [rw] compute_resources
|
@@ -1673,20 +1771,37 @@ module Aws::Batch
|
|
1673
1771
|
#
|
1674
1772
|
# @!attribute [rw] service_role
|
1675
1773
|
# The full Amazon Resource Name (ARN) of the IAM role that allows AWS
|
1676
|
-
# Batch to make calls to other AWS services on your behalf.
|
1774
|
+
# Batch to make calls to other AWS services on your behalf. For more
|
1775
|
+
# information, see [AWS Batch service IAM role][1] in the *AWS Batch
|
1776
|
+
# User Guide*.
|
1777
|
+
#
|
1778
|
+
# If your account has already created the AWS Batch service-linked
|
1779
|
+
# role, that role is used by default for your compute environment
|
1780
|
+
# unless you specify a role here. If the AWS Batch service-linked role
|
1781
|
+
# does not exist in your account, and no role is specified here, the
|
1782
|
+
# service will try to create the AWS Batch service-linked role in your
|
1783
|
+
# account.
|
1677
1784
|
#
|
1678
1785
|
# If your specified role has a path other than `/`, then you must
|
1679
|
-
# either
|
1680
|
-
#
|
1786
|
+
# specify either the full role ARN (recommended) or prefix the role
|
1787
|
+
# name with the path. For example, if a role with the name `bar` has a
|
1788
|
+
# path of `/foo/` then you would specify `/foo/bar` as the role name.
|
1789
|
+
# For more information, see [Friendly names and paths][2] in the *IAM
|
1790
|
+
# User Guide*.
|
1681
1791
|
#
|
1682
1792
|
# <note markdown="1"> Depending on how you created your AWS Batch service role, its ARN
|
1683
|
-
#
|
1793
|
+
# might contain the `service-role` path prefix. When you only specify
|
1684
1794
|
# the name of the service role, AWS Batch assumes that your ARN
|
1685
1795
|
# doesn't use the `service-role` path prefix. Because of this, we
|
1686
1796
|
# recommend that you specify the full ARN of your service role when
|
1687
1797
|
# you create compute environments.
|
1688
1798
|
#
|
1689
1799
|
# </note>
|
1800
|
+
#
|
1801
|
+
#
|
1802
|
+
#
|
1803
|
+
# [1]: https://docs.aws.amazon.com/batch/latest/userguide/service_IAM_role.html
|
1804
|
+
# [2]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html#identifiers-friendly-names
|
1690
1805
|
# @return [String]
|
1691
1806
|
#
|
1692
1807
|
# @!attribute [rw] tags
|
@@ -1720,7 +1835,8 @@ module Aws::Batch
|
|
1720
1835
|
end
|
1721
1836
|
|
1722
1837
|
# @!attribute [rw] compute_environment_name
|
1723
|
-
# The name of the compute environment.
|
1838
|
+
# The name of the compute environment. Up to 128 letters (uppercase
|
1839
|
+
# and lowercase), numbers, hyphens, and underscores are allowed.
|
1724
1840
|
# @return [String]
|
1725
1841
|
#
|
1726
1842
|
# @!attribute [rw] compute_environment_arn
|
@@ -1736,6 +1852,8 @@ module Aws::Batch
|
|
1736
1852
|
include Aws::Structure
|
1737
1853
|
end
|
1738
1854
|
|
1855
|
+
# Contains the parameters for `CreateJobQueue`.
|
1856
|
+
#
|
1739
1857
|
# @note When making an API call, you may pass CreateJobQueueRequest
|
1740
1858
|
# data as a hash:
|
1741
1859
|
#
|
@@ -1755,7 +1873,8 @@ module Aws::Batch
|
|
1755
1873
|
# }
|
1756
1874
|
#
|
1757
1875
|
# @!attribute [rw] job_queue_name
|
1758
|
-
# The name of the job queue.
|
1876
|
+
# The name of the job queue. Up to 128 letters (uppercase and
|
1877
|
+
# lowercase), numbers, and underscores are allowed.
|
1759
1878
|
# @return [String]
|
1760
1879
|
#
|
1761
1880
|
# @!attribute [rw] state
|
@@ -1771,7 +1890,10 @@ module Aws::Batch
|
|
1771
1890
|
# first when associated with the same compute environment. Priority is
|
1772
1891
|
# determined in descending order. For example, a job queue with a
|
1773
1892
|
# priority value of `10` is given scheduling preference over a job
|
1774
|
-
# queue with a priority value of `1`.
|
1893
|
+
# queue with a priority value of `1`. All of the compute environments
|
1894
|
+
# must be either EC2 (`EC2` or `SPOT`) or Fargate (`FARGATE` or
|
1895
|
+
# `FARGATE_SPOT`); EC2 and Fargate compute environments cannot be
|
1896
|
+
# mixed.
|
1775
1897
|
# @return [Integer]
|
1776
1898
|
#
|
1777
1899
|
# @!attribute [rw] compute_environment_order
|
@@ -1784,17 +1906,23 @@ module Aws::Batch
|
|
1784
1906
|
# environments must be either EC2 (`EC2` or `SPOT`) or Fargate
|
1785
1907
|
# (`FARGATE` or `FARGATE_SPOT`); EC2 and Fargate compute environments
|
1786
1908
|
# can't be mixed.
|
1909
|
+
#
|
1910
|
+
# <note markdown="1"> All compute environments that are associated with a job queue must
|
1911
|
+
# share the same architecture. AWS Batch doesn't support mixing
|
1912
|
+
# compute environment architecture types in a single job queue.
|
1913
|
+
#
|
1914
|
+
# </note>
|
1787
1915
|
# @return [Array<Types::ComputeEnvironmentOrder>]
|
1788
1916
|
#
|
1789
1917
|
# @!attribute [rw] tags
|
1790
1918
|
# The tags that you apply to the job queue to help you categorize and
|
1791
1919
|
# organize your resources. Each tag consists of a key and an optional
|
1792
|
-
# value. For more information, see [Tagging AWS
|
1793
|
-
#
|
1920
|
+
# value. For more information, see [Tagging your AWS Batch
|
1921
|
+
# resources][1] in *AWS Batch User Guide*.
|
1794
1922
|
#
|
1795
1923
|
#
|
1796
1924
|
#
|
1797
|
-
# [1]: https://docs.aws.amazon.com/
|
1925
|
+
# [1]: https://docs.aws.amazon.com/batch/latest/userguide/using-tags.html
|
1798
1926
|
# @return [Hash<String,String>]
|
1799
1927
|
#
|
1800
1928
|
# @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/CreateJobQueueRequest AWS API Documentation
|
@@ -1826,6 +1954,8 @@ module Aws::Batch
|
|
1826
1954
|
include Aws::Structure
|
1827
1955
|
end
|
1828
1956
|
|
1957
|
+
# Contains the parameters for `DeleteComputeEnvironment`.
|
1958
|
+
#
|
1829
1959
|
# @note When making an API call, you may pass DeleteComputeEnvironmentRequest
|
1830
1960
|
# data as a hash:
|
1831
1961
|
#
|
@@ -1850,6 +1980,8 @@ module Aws::Batch
|
|
1850
1980
|
#
|
1851
1981
|
class DeleteComputeEnvironmentResponse < Aws::EmptyStructure; end
|
1852
1982
|
|
1983
|
+
# Contains the parameters for `DeleteJobQueue`.
|
1984
|
+
#
|
1853
1985
|
# @note When making an API call, you may pass DeleteJobQueueRequest
|
1854
1986
|
# data as a hash:
|
1855
1987
|
#
|
@@ -1898,6 +2030,8 @@ module Aws::Batch
|
|
1898
2030
|
#
|
1899
2031
|
class DeregisterJobDefinitionResponse < Aws::EmptyStructure; end
|
1900
2032
|
|
2033
|
+
# Contains the parameters for `DescribeComputeEnvironments`.
|
2034
|
+
#
|
1901
2035
|
# @note When making an API call, you may pass DescribeComputeEnvironmentsRequest
|
1902
2036
|
# data as a hash:
|
1903
2037
|
#
|
@@ -1933,7 +2067,7 @@ module Aws::Batch
|
|
1933
2067
|
# `nextToken` value. This value is `null` when there are no more
|
1934
2068
|
# results to return.
|
1935
2069
|
#
|
1936
|
-
# <note markdown="1"> This token should be treated as an opaque identifier that
|
2070
|
+
# <note markdown="1"> This token should be treated as an opaque identifier that's only
|
1937
2071
|
# used to retrieve the next items in a list and not for other
|
1938
2072
|
# programmatic purposes.
|
1939
2073
|
#
|
@@ -1971,6 +2105,8 @@ module Aws::Batch
|
|
1971
2105
|
include Aws::Structure
|
1972
2106
|
end
|
1973
2107
|
|
2108
|
+
# Contains the parameters for `DescribeJobDefinitions`.
|
2109
|
+
#
|
1974
2110
|
# @note When making an API call, you may pass DescribeJobDefinitionsRequest
|
1975
2111
|
# data as a hash:
|
1976
2112
|
#
|
@@ -1991,7 +2127,7 @@ module Aws::Batch
|
|
1991
2127
|
# The maximum number of results returned by `DescribeJobDefinitions`
|
1992
2128
|
# in paginated output. When this parameter is used,
|
1993
2129
|
# `DescribeJobDefinitions` only returns `maxResults` results in a
|
1994
|
-
# single page
|
2130
|
+
# single page and a `nextToken` response element. The remaining
|
1995
2131
|
# results of the initial request can be seen by sending another
|
1996
2132
|
# `DescribeJobDefinitions` request with the returned `nextToken`
|
1997
2133
|
# value. This value can be between 1 and 100. If this parameter isn't
|
@@ -2015,7 +2151,7 @@ module Aws::Batch
|
|
2015
2151
|
# value. This value is `null` when there are no more results to
|
2016
2152
|
# return.
|
2017
2153
|
#
|
2018
|
-
# <note markdown="1"> This token should be treated as an opaque identifier that
|
2154
|
+
# <note markdown="1"> This token should be treated as an opaque identifier that's only
|
2019
2155
|
# used to retrieve the next items in a list and not for other
|
2020
2156
|
# programmatic purposes.
|
2021
2157
|
#
|
@@ -2055,6 +2191,8 @@ module Aws::Batch
|
|
2055
2191
|
include Aws::Structure
|
2056
2192
|
end
|
2057
2193
|
|
2194
|
+
# Contains the parameters for `DescribeJobQueues`.
|
2195
|
+
#
|
2058
2196
|
# @note When making an API call, you may pass DescribeJobQueuesRequest
|
2059
2197
|
# data as a hash:
|
2060
2198
|
#
|
@@ -2072,12 +2210,12 @@ module Aws::Batch
|
|
2072
2210
|
# @!attribute [rw] max_results
|
2073
2211
|
# The maximum number of results returned by `DescribeJobQueues` in
|
2074
2212
|
# paginated output. When this parameter is used, `DescribeJobQueues`
|
2075
|
-
# only returns `maxResults` results in a single page
|
2076
|
-
#
|
2077
|
-
#
|
2078
|
-
#
|
2079
|
-
#
|
2080
|
-
#
|
2213
|
+
# only returns `maxResults` results in a single page and a `nextToken`
|
2214
|
+
# response element. The remaining results of the initial request can
|
2215
|
+
# be seen by sending another `DescribeJobQueues` request with the
|
2216
|
+
# returned `nextToken` value. This value can be between 1 and 100. If
|
2217
|
+
# this parameter isn't used, then `DescribeJobQueues` returns up to
|
2218
|
+
# 100 results and a `nextToken` value if applicable.
|
2081
2219
|
# @return [Integer]
|
2082
2220
|
#
|
2083
2221
|
# @!attribute [rw] next_token
|
@@ -2088,7 +2226,7 @@ module Aws::Batch
|
|
2088
2226
|
# value. This value is `null` when there are no more results to
|
2089
2227
|
# return.
|
2090
2228
|
#
|
2091
|
-
# <note markdown="1"> This token should be treated as an opaque identifier that
|
2229
|
+
# <note markdown="1"> This token should be treated as an opaque identifier that's only
|
2092
2230
|
# used to retrieve the next items in a list and not for other
|
2093
2231
|
# programmatic purposes.
|
2094
2232
|
#
|
@@ -2126,6 +2264,8 @@ module Aws::Batch
|
|
2126
2264
|
include Aws::Structure
|
2127
2265
|
end
|
2128
2266
|
|
2267
|
+
# Contains the parameters for `DescribeJobs`.
|
2268
|
+
#
|
2129
2269
|
# @note When making an API call, you may pass DescribeJobsRequest
|
2130
2270
|
# data as a hash:
|
2131
2271
|
#
|
@@ -2179,7 +2319,7 @@ module Aws::Batch
|
|
2179
2319
|
#
|
2180
2320
|
# @!attribute [rw] container_path
|
2181
2321
|
# The path inside the container used to expose the host device. By
|
2182
|
-
# default the `hostPath` value is used.
|
2322
|
+
# default, the `hostPath` value is used.
|
2183
2323
|
# @return [String]
|
2184
2324
|
#
|
2185
2325
|
# @!attribute [rw] permissions
|
@@ -2198,14 +2338,150 @@ module Aws::Batch
|
|
2198
2338
|
include Aws::Structure
|
2199
2339
|
end
|
2200
2340
|
|
2341
|
+
# The authorization configuration details for the Amazon EFS file
|
2342
|
+
# system.
|
2343
|
+
#
|
2344
|
+
# @note When making an API call, you may pass EFSAuthorizationConfig
|
2345
|
+
# data as a hash:
|
2346
|
+
#
|
2347
|
+
# {
|
2348
|
+
# access_point_id: "String",
|
2349
|
+
# iam: "ENABLED", # accepts ENABLED, DISABLED
|
2350
|
+
# }
|
2351
|
+
#
|
2352
|
+
# @!attribute [rw] access_point_id
|
2353
|
+
# The Amazon EFS access point ID to use. If an access point is
|
2354
|
+
# specified, the root directory value specified in the
|
2355
|
+
# `EFSVolumeConfiguration` must either be omitted or set to `/` which
|
2356
|
+
# will enforce the path set on the EFS access point. If an access
|
2357
|
+
# point is used, transit encryption must be enabled in the
|
2358
|
+
# `EFSVolumeConfiguration`. For more information, see [Working with
|
2359
|
+
# Amazon EFS Access Points][1] in the *Amazon Elastic File System User
|
2360
|
+
# Guide*.
|
2361
|
+
#
|
2362
|
+
#
|
2363
|
+
#
|
2364
|
+
# [1]: https://docs.aws.amazon.com/efs/latest/ug/efs-access-points.html
|
2365
|
+
# @return [String]
|
2366
|
+
#
|
2367
|
+
# @!attribute [rw] iam
|
2368
|
+
# Whether or not to use the AWS Batch execution IAM role defined in a
|
2369
|
+
# job definition when mounting the Amazon EFS file system. If enabled,
|
2370
|
+
# transit encryption must be enabled in the `EFSVolumeConfiguration`.
|
2371
|
+
# If this parameter is omitted, the default value of `DISABLED` is
|
2372
|
+
# used. For more information, see [Using Amazon EFS Access Points][1]
|
2373
|
+
# in the *AWS Batch User Guide*. EFS IAM authorization requires that
|
2374
|
+
# `TransitEncryption` be `ENABLED` and that a `JobRoleArn` is
|
2375
|
+
# specified.
|
2376
|
+
#
|
2377
|
+
#
|
2378
|
+
#
|
2379
|
+
# [1]: https://docs.aws.amazon.com/batch/latest/ug/efs-volumes.html#efs-volume-accesspoints
|
2380
|
+
# @return [String]
|
2381
|
+
#
|
2382
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/EFSAuthorizationConfig AWS API Documentation
|
2383
|
+
#
|
2384
|
+
class EFSAuthorizationConfig < Struct.new(
|
2385
|
+
:access_point_id,
|
2386
|
+
:iam)
|
2387
|
+
SENSITIVE = []
|
2388
|
+
include Aws::Structure
|
2389
|
+
end
|
2390
|
+
|
2391
|
+
# This parameter is specified when you are using an Amazon Elastic File
|
2392
|
+
# System file system for task storage. For more information, see [Amazon
|
2393
|
+
# EFS Volumes][1] in the *AWS Batch User Guide*.
|
2394
|
+
#
|
2395
|
+
#
|
2396
|
+
#
|
2397
|
+
# [1]: https://docs.aws.amazon.com/batch/latest/ug/efs-volumes.html
|
2398
|
+
#
|
2399
|
+
# @note When making an API call, you may pass EFSVolumeConfiguration
|
2400
|
+
# data as a hash:
|
2401
|
+
#
|
2402
|
+
# {
|
2403
|
+
# file_system_id: "String", # required
|
2404
|
+
# root_directory: "String",
|
2405
|
+
# transit_encryption: "ENABLED", # accepts ENABLED, DISABLED
|
2406
|
+
# transit_encryption_port: 1,
|
2407
|
+
# authorization_config: {
|
2408
|
+
# access_point_id: "String",
|
2409
|
+
# iam: "ENABLED", # accepts ENABLED, DISABLED
|
2410
|
+
# },
|
2411
|
+
# }
|
2412
|
+
#
|
2413
|
+
# @!attribute [rw] file_system_id
|
2414
|
+
# The Amazon EFS file system ID to use.
|
2415
|
+
# @return [String]
|
2416
|
+
#
|
2417
|
+
# @!attribute [rw] root_directory
|
2418
|
+
# The directory within the Amazon EFS file system to mount as the root
|
2419
|
+
# directory inside the host. If this parameter is omitted, the root of
|
2420
|
+
# the Amazon EFS volume will be used. Specifying `/` will have the
|
2421
|
+
# same effect as omitting this parameter.
|
2422
|
+
#
|
2423
|
+
# If an EFS access point is specified in the `authorizationConfig`,
|
2424
|
+
# the root directory parameter must either be omitted or set to `/`
|
2425
|
+
# which will enforce the path set on the Amazon EFS access point.
|
2426
|
+
# @return [String]
|
2427
|
+
#
|
2428
|
+
# @!attribute [rw] transit_encryption
|
2429
|
+
# Whether or not to enable encryption for Amazon EFS data in transit
|
2430
|
+
# between the Amazon ECS host and the Amazon EFS server. Transit
|
2431
|
+
# encryption must be enabled if Amazon EFS IAM authorization is used.
|
2432
|
+
# If this parameter is omitted, the default value of `DISABLED` is
|
2433
|
+
# used. For more information, see [Encrypting data in transit][1] in
|
2434
|
+
# the *Amazon Elastic File System User Guide*.
|
2435
|
+
#
|
2436
|
+
#
|
2437
|
+
#
|
2438
|
+
# [1]: https://docs.aws.amazon.com/efs/latest/ug/encryption-in-transit.html
|
2439
|
+
# @return [String]
|
2440
|
+
#
|
2441
|
+
# @!attribute [rw] transit_encryption_port
|
2442
|
+
# The port to use when sending encrypted data between the Amazon ECS
|
2443
|
+
# host and the Amazon EFS server. If you do not specify a transit
|
2444
|
+
# encryption port, it will use the port selection strategy that the
|
2445
|
+
# Amazon EFS mount helper uses. For more information, see [EFS Mount
|
2446
|
+
# Helper][1] in the *Amazon Elastic File System User Guide*.
|
2447
|
+
#
|
2448
|
+
#
|
2449
|
+
#
|
2450
|
+
# [1]: https://docs.aws.amazon.com/efs/latest/ug/efs-mount-helper.html
|
2451
|
+
# @return [Integer]
|
2452
|
+
#
|
2453
|
+
# @!attribute [rw] authorization_config
|
2454
|
+
# The authorization configuration details for the Amazon EFS file
|
2455
|
+
# system.
|
2456
|
+
# @return [Types::EFSAuthorizationConfig]
|
2457
|
+
#
|
2458
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/EFSVolumeConfiguration AWS API Documentation
|
2459
|
+
#
|
2460
|
+
class EFSVolumeConfiguration < Struct.new(
|
2461
|
+
:file_system_id,
|
2462
|
+
:root_directory,
|
2463
|
+
:transit_encryption,
|
2464
|
+
:transit_encryption_port,
|
2465
|
+
:authorization_config)
|
2466
|
+
SENSITIVE = []
|
2467
|
+
include Aws::Structure
|
2468
|
+
end
|
2469
|
+
|
2201
2470
|
# Provides information used to select Amazon Machine Images (AMIs) for
|
2202
|
-
# instances in the compute environment. If
|
2203
|
-
# specified, the default is `ECS_AL1
|
2471
|
+
# instances in the compute environment. If `Ec2Configuration` isn't
|
2472
|
+
# specified, the default is currently `ECS_AL1` ([Amazon Linux][1]) for
|
2473
|
+
# non-GPU, non-Graviton instances. Starting on March 31, 2021, this
|
2474
|
+
# default will be changing to `ECS_AL2` ([Amazon Linux 2][2]).
|
2204
2475
|
#
|
2205
2476
|
# <note markdown="1"> This object isn't applicable to jobs running on Fargate resources.
|
2206
2477
|
#
|
2207
2478
|
# </note>
|
2208
2479
|
#
|
2480
|
+
#
|
2481
|
+
#
|
2482
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html#alami
|
2483
|
+
# [2]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html#al2ami
|
2484
|
+
#
|
2209
2485
|
# @note When making an API call, you may pass Ec2Configuration
|
2210
2486
|
# data as a hash:
|
2211
2487
|
#
|
@@ -2217,7 +2493,9 @@ module Aws::Batch
|
|
2217
2493
|
# @!attribute [rw] image_type
|
2218
2494
|
# The image type to match with the instance type to select an AMI. If
|
2219
2495
|
# the `imageIdOverride` parameter isn't specified, then a recent
|
2220
|
-
# [Amazon ECS-optimized AMI][1] is used.
|
2496
|
+
# [Amazon ECS-optimized AMI][1] (`ECS_AL1`) is used. Starting on March
|
2497
|
+
# 31, 2021, this default will be changing to `ECS_AL2` ([Amazon Linux
|
2498
|
+
# 2][2]).
|
2221
2499
|
#
|
2222
2500
|
# ECS\_AL2
|
2223
2501
|
#
|
@@ -2233,7 +2511,7 @@ module Aws::Batch
|
|
2233
2511
|
#
|
2234
2512
|
# ECS\_AL1
|
2235
2513
|
#
|
2236
|
-
# : [Amazon Linux][4]−Default for all non-GPU, non-AWS
|
2514
|
+
# : [Amazon Linux][4]−Default for all non-GPU, non-AWS Graviton
|
2237
2515
|
# instance families. Amazon Linux is reaching the end-of-life of
|
2238
2516
|
# standard support. For more information, see [Amazon Linux AMI][5].
|
2239
2517
|
#
|
@@ -2276,23 +2554,25 @@ module Aws::Batch
|
|
2276
2554
|
#
|
2277
2555
|
# @!attribute [rw] on_status_reason
|
2278
2556
|
# Contains a glob pattern to match against the `StatusReason` returned
|
2279
|
-
# for a job. The
|
2280
|
-
# letters, numbers, periods (.), colons (:), and white space
|
2281
|
-
# tabs).
|
2282
|
-
# start of the string needs to be an exact
|
2557
|
+
# for a job. The pattern can be up to 512 characters long, and can
|
2558
|
+
# contain letters, numbers, periods (.), colons (:), and white space
|
2559
|
+
# (including spaces or tabs). It can optionally end with an asterisk
|
2560
|
+
# (*) so that only the start of the string needs to be an exact
|
2561
|
+
# match.
|
2283
2562
|
# @return [String]
|
2284
2563
|
#
|
2285
2564
|
# @!attribute [rw] on_reason
|
2286
2565
|
# Contains a glob pattern to match against the `Reason` returned for a
|
2287
|
-
# job. The
|
2288
|
-
# letters, numbers, periods (.), colons (:), and white space
|
2289
|
-
# tabs)
|
2290
|
-
# start of the string needs to be an exact
|
2566
|
+
# job. The pattern can be up to 512 characters long, and can contain
|
2567
|
+
# letters, numbers, periods (.), colons (:), and white space
|
2568
|
+
# (including spaces and tabs). It can optionally end with an asterisk
|
2569
|
+
# (*) so that only the start of the string needs to be an exact
|
2570
|
+
# match.
|
2291
2571
|
# @return [String]
|
2292
2572
|
#
|
2293
2573
|
# @!attribute [rw] on_exit_code
|
2294
2574
|
# Contains a glob pattern to match against the decimal representation
|
2295
|
-
# of the `ExitCode` returned for a job. The
|
2575
|
+
# of the `ExitCode` returned for a job. The pattern can be up to 512
|
2296
2576
|
# characters long, can contain only numbers, and can optionally end
|
2297
2577
|
# with an asterisk (*) so that only the start of the string needs to
|
2298
2578
|
# be an exact match.
|
@@ -2301,7 +2581,7 @@ module Aws::Batch
|
|
2301
2581
|
# @!attribute [rw] action
|
2302
2582
|
# Specifies the action to take if all of the specified conditions
|
2303
2583
|
# (`onStatusReason`, `onReason`, and `onExitCode`) are met. The values
|
2304
|
-
#
|
2584
|
+
# aren't case sensitive.
|
2305
2585
|
# @return [String]
|
2306
2586
|
#
|
2307
2587
|
# @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/EvaluateOnExit AWS API Documentation
|
@@ -2315,8 +2595,8 @@ module Aws::Batch
|
|
2315
2595
|
include Aws::Structure
|
2316
2596
|
end
|
2317
2597
|
|
2318
|
-
# The platform configuration for jobs running on Fargate resources.
|
2319
|
-
#
|
2598
|
+
# The platform configuration for jobs running on Fargate resources. For
|
2599
|
+
# jobs that run on EC2 resources, you shouldn't specify this parameter.
|
2320
2600
|
#
|
2321
2601
|
# @note When making an API call, you may pass FargatePlatformConfiguration
|
2322
2602
|
# data as a hash:
|
@@ -2326,10 +2606,10 @@ module Aws::Batch
|
|
2326
2606
|
# }
|
2327
2607
|
#
|
2328
2608
|
# @!attribute [rw] platform_version
|
2329
|
-
# The AWS Fargate platform version
|
2609
|
+
# The AWS Fargate platform version where the jobs are running. A
|
2330
2610
|
# platform version is specified only for jobs running on Fargate
|
2331
2611
|
# resources. If one isn't specified, the `LATEST` platform version is
|
2332
|
-
# used by default. This
|
2612
|
+
# used by default. This uses a recent, approved version of the AWS
|
2333
2613
|
# Fargate platform for compute resources. For more information, see
|
2334
2614
|
# [AWS Fargate platform versions][1] in the *Amazon Elastic Container
|
2335
2615
|
# Service Developer Guide*.
|
@@ -2361,16 +2641,16 @@ module Aws::Batch
|
|
2361
2641
|
# }
|
2362
2642
|
#
|
2363
2643
|
# @!attribute [rw] source_path
|
2364
|
-
# The path on the host container instance that
|
2644
|
+
# The path on the host container instance that's presented to the
|
2365
2645
|
# container. If this parameter is empty, then the Docker daemon has
|
2366
2646
|
# assigned a host path for you. If this parameter contains a file
|
2367
2647
|
# location, then the data volume persists at the specified location on
|
2368
2648
|
# the host container instance until you delete it manually. If the
|
2369
|
-
# source path location
|
2649
|
+
# source path location doesn't exist on the host container instance,
|
2370
2650
|
# the Docker daemon creates it. If the location does exist, the
|
2371
2651
|
# contents of the source path folder are exported.
|
2372
2652
|
#
|
2373
|
-
# <note markdown="1"> This parameter isn't applicable to jobs
|
2653
|
+
# <note markdown="1"> This parameter isn't applicable to jobs that run on Fargate
|
2374
2654
|
# resources and shouldn't be provided.
|
2375
2655
|
#
|
2376
2656
|
# </note>
|
@@ -2540,7 +2820,7 @@ module Aws::Batch
|
|
2540
2820
|
# @!attribute [rw] status
|
2541
2821
|
# The current status for the job.
|
2542
2822
|
#
|
2543
|
-
# <note markdown="1"> If your jobs
|
2823
|
+
# <note markdown="1"> If your jobs don't progress to `STARTING`, see [Jobs Stuck in
|
2544
2824
|
# RUNNABLE Status][1] in the troubleshooting section of the *AWS Batch
|
2545
2825
|
# User Guide*.
|
2546
2826
|
#
|
@@ -2590,7 +2870,7 @@ module Aws::Batch
|
|
2590
2870
|
# @return [Array<Types::JobDependency>]
|
2591
2871
|
#
|
2592
2872
|
# @!attribute [rw] job_definition
|
2593
|
-
# The job definition that
|
2873
|
+
# The job definition that's used by this job.
|
2594
2874
|
# @return [String]
|
2595
2875
|
#
|
2596
2876
|
# @!attribute [rw] parameters
|
@@ -2605,7 +2885,7 @@ module Aws::Batch
|
|
2605
2885
|
# @return [Types::ContainerDetail]
|
2606
2886
|
#
|
2607
2887
|
# @!attribute [rw] node_details
|
2608
|
-
# An object representing the details of a node that
|
2888
|
+
# An object representing the details of a node that's associated with
|
2609
2889
|
# a multi-node parallel job.
|
2610
2890
|
# @return [Types::NodeDetails]
|
2611
2891
|
#
|
@@ -2633,7 +2913,7 @@ module Aws::Batch
|
|
2633
2913
|
# @!attribute [rw] propagate_tags
|
2634
2914
|
# Specifies whether to propagate the tags from the job or job
|
2635
2915
|
# definition to the corresponding Amazon ECS task. If no value is
|
2636
|
-
# specified, the tags
|
2916
|
+
# specified, the tags aren't propagated. Tags can only be propagated
|
2637
2917
|
# to the tasks during task creation. For tags with the same name, job
|
2638
2918
|
# tags are given priority over job definitions tags. If the total
|
2639
2919
|
# number of combined tags from the job and job definition is over 50,
|
@@ -2702,7 +2982,15 @@ module Aws::Batch
|
|
2702
2982
|
# @return [String]
|
2703
2983
|
#
|
2704
2984
|
# @!attribute [rw] priority
|
2705
|
-
# The priority of the job queue.
|
2985
|
+
# The priority of the job queue. Job queues with a higher priority (or
|
2986
|
+
# a higher integer value for the `priority` parameter) are evaluated
|
2987
|
+
# first when associated with the same compute environment. Priority is
|
2988
|
+
# determined in descending order, for example, a job queue with a
|
2989
|
+
# priority value of `10` is given scheduling preference over a job
|
2990
|
+
# queue with a priority value of `1`. All of the compute environments
|
2991
|
+
# must be either EC2 (`EC2` or `SPOT`) or Fargate (`FARGATE` or
|
2992
|
+
# `FARGATE_SPOT`); EC2 and Fargate compute environments can't be
|
2993
|
+
# mixed.
|
2706
2994
|
# @return [Integer]
|
2707
2995
|
#
|
2708
2996
|
# @!attribute [rw] compute_environment_order
|
@@ -2712,7 +3000,12 @@ module Aws::Batch
|
|
2712
3000
|
# @return [Array<Types::ComputeEnvironmentOrder>]
|
2713
3001
|
#
|
2714
3002
|
# @!attribute [rw] tags
|
2715
|
-
# The tags applied to the job queue.
|
3003
|
+
# The tags applied to the job queue. For more information, see
|
3004
|
+
# [Tagging your AWS Batch resources][1] in *AWS Batch User Guide*.
|
3005
|
+
#
|
3006
|
+
#
|
3007
|
+
#
|
3008
|
+
# [1]: https://docs.aws.amazon.com/batch/latest/userguide/using-tags.html
|
2716
3009
|
# @return [Hash<String,String>]
|
2717
3010
|
#
|
2718
3011
|
# @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/JobQueueDetail AWS API Documentation
|
@@ -2773,7 +3066,7 @@ module Aws::Batch
|
|
2773
3066
|
# @return [Integer]
|
2774
3067
|
#
|
2775
3068
|
# @!attribute [rw] container
|
2776
|
-
# An object representing the details of the container that
|
3069
|
+
# An object representing the details of the container that's
|
2777
3070
|
# associated with the job.
|
2778
3071
|
# @return [Types::ContainerSummary]
|
2779
3072
|
#
|
@@ -2897,6 +3190,14 @@ module Aws::Batch
|
|
2897
3190
|
# is used. If the value is `$Default`, the default version of the
|
2898
3191
|
# launch template is used.
|
2899
3192
|
#
|
3193
|
+
# After the compute environment is created, the launch template
|
3194
|
+
# version used will not be changed, even if the `$Default` or
|
3195
|
+
# `$Latest` version for the launch template is updated. To use a new
|
3196
|
+
# launch template version, create a new compute environment, add the
|
3197
|
+
# new compute environment to the existing job queue, remove the old
|
3198
|
+
# compute environment from the job queue, and delete the old compute
|
3199
|
+
# environment.
|
3200
|
+
#
|
2900
3201
|
# Default: `$Default`.
|
2901
3202
|
# @return [String]
|
2902
3203
|
#
|
@@ -3029,9 +3330,32 @@ module Aws::Batch
|
|
3029
3330
|
# be swapped very aggressively. Accepted values are whole numbers
|
3030
3331
|
# between `0` and `100`. If the `swappiness` parameter isn't
|
3031
3332
|
# specified, a default value of `60` is used. If a value isn't
|
3032
|
-
# specified for `maxSwap` then this parameter is ignored.
|
3033
|
-
#
|
3034
|
-
# run][1].
|
3333
|
+
# specified for `maxSwap` then this parameter is ignored. If `maxSwap`
|
3334
|
+
# is set to 0, the container doesn't use swap. This parameter maps to
|
3335
|
+
# the `--memory-swappiness` option to [docker run][1].
|
3336
|
+
#
|
3337
|
+
# Consider the following when you use a per-container swap
|
3338
|
+
# configuration.
|
3339
|
+
#
|
3340
|
+
# * Swap space must be enabled and allocated on the container instance
|
3341
|
+
# for the containers to use.
|
3342
|
+
#
|
3343
|
+
# <note markdown="1"> The Amazon ECS optimized AMIs don't have swap enabled by default.
|
3344
|
+
# You must enable swap on the instance to use this feature. For more
|
3345
|
+
# information, see [Instance Store Swap Volumes][2] in the *Amazon
|
3346
|
+
# EC2 User Guide for Linux Instances* or [How do I allocate memory
|
3347
|
+
# to work as swap space in an Amazon EC2 instance by using a swap
|
3348
|
+
# file?][3]
|
3349
|
+
#
|
3350
|
+
# </note>
|
3351
|
+
#
|
3352
|
+
# * The swap space parameters are only supported for job definitions
|
3353
|
+
# using EC2 resources.
|
3354
|
+
#
|
3355
|
+
# * If the `maxSwap` and `swappiness` parameters are omitted from a
|
3356
|
+
# job definition, each container will have a default `swappiness`
|
3357
|
+
# value of 60, and the total swap usage will be limited to two times
|
3358
|
+
# the memory reservation of the container.
|
3035
3359
|
#
|
3036
3360
|
# <note markdown="1"> This parameter isn't applicable to jobs running on Fargate
|
3037
3361
|
# resources and shouldn't be provided.
|
@@ -3041,6 +3365,8 @@ module Aws::Batch
|
|
3041
3365
|
#
|
3042
3366
|
#
|
3043
3367
|
# [1]: https://docs.docker.com/engine/reference/run/
|
3368
|
+
# [2]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-store-swap-volumes.html
|
3369
|
+
# [3]: http://aws.amazon.com/premiumsupport/knowledge-center/ec2-memory-swap-file/
|
3044
3370
|
# @return [Integer]
|
3045
3371
|
#
|
3046
3372
|
# @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/LinuxParameters AWS API Documentation
|
@@ -3056,6 +3382,8 @@ module Aws::Batch
|
|
3056
3382
|
include Aws::Structure
|
3057
3383
|
end
|
3058
3384
|
|
3385
|
+
# Contains the parameters for `ListJobs`.
|
3386
|
+
#
|
3059
3387
|
# @note When making an API call, you may pass ListJobsRequest
|
3060
3388
|
# data as a hash:
|
3061
3389
|
#
|
@@ -3092,12 +3420,12 @@ module Aws::Batch
|
|
3092
3420
|
# @!attribute [rw] max_results
|
3093
3421
|
# The maximum number of results returned by `ListJobs` in paginated
|
3094
3422
|
# output. When this parameter is used, `ListJobs` only returns
|
3095
|
-
# `maxResults` results in a single page
|
3096
|
-
#
|
3097
|
-
#
|
3098
|
-
#
|
3099
|
-
#
|
3100
|
-
#
|
3423
|
+
# `maxResults` results in a single page and a `nextToken` response
|
3424
|
+
# element. The remaining results of the initial request can be seen by
|
3425
|
+
# sending another `ListJobs` request with the returned `nextToken`
|
3426
|
+
# value. This value can be between 1 and 100. If this parameter isn't
|
3427
|
+
# used, then `ListJobs` returns up to 100 results and a `nextToken`
|
3428
|
+
# value if applicable.
|
3101
3429
|
# @return [Integer]
|
3102
3430
|
#
|
3103
3431
|
# @!attribute [rw] next_token
|
@@ -3107,7 +3435,7 @@ module Aws::Batch
|
|
3107
3435
|
# previous results that returned the `nextToken` value. This value is
|
3108
3436
|
# `null` when there are no more results to return.
|
3109
3437
|
#
|
3110
|
-
# <note markdown="1"> This token should be treated as an opaque identifier that
|
3438
|
+
# <note markdown="1"> This token should be treated as an opaque identifier that's only
|
3111
3439
|
# used to retrieve the next items in a list and not for other
|
3112
3440
|
# programmatic purposes.
|
3113
3441
|
#
|
@@ -3257,9 +3585,9 @@ module Aws::Batch
|
|
3257
3585
|
# including usage and options, see [Syslog logging driver][8] in the
|
3258
3586
|
# Docker documentation.
|
3259
3587
|
#
|
3260
|
-
# <note markdown="1"> If you have a custom driver that
|
3588
|
+
# <note markdown="1"> If you have a custom driver that's not listed earlier that you want
|
3261
3589
|
# to work with the Amazon ECS container agent, you can fork the Amazon
|
3262
|
-
# ECS container agent project that
|
3590
|
+
# ECS container agent project that's [available on GitHub][9] and
|
3263
3591
|
# customize it to work with that driver. We encourage you to submit
|
3264
3592
|
# pull requests for changes that you want to have included. However,
|
3265
3593
|
# Amazon Web Services doesn't currently support running modified
|
@@ -3313,7 +3641,7 @@ module Aws::Batch
|
|
3313
3641
|
include Aws::Structure
|
3314
3642
|
end
|
3315
3643
|
|
3316
|
-
# Details on a Docker volume mount point that
|
3644
|
+
# Details on a Docker volume mount point that's used in a job's
|
3317
3645
|
# container properties. This parameter maps to `Volumes` in the [Create
|
3318
3646
|
# a container][1] section of the Docker Remote API and the `--volume`
|
3319
3647
|
# option to docker run.
|
@@ -3433,7 +3761,7 @@ module Aws::Batch
|
|
3433
3761
|
include Aws::Structure
|
3434
3762
|
end
|
3435
3763
|
|
3436
|
-
# Object representing any node overrides to a job definition that
|
3764
|
+
# Object representing any node overrides to a job definition that's
|
3437
3765
|
# used in a SubmitJob API operation.
|
3438
3766
|
#
|
3439
3767
|
# <note markdown="1"> This isn't applicable to jobs running on Fargate resources and
|
@@ -3525,6 +3853,16 @@ module Aws::Batch
|
|
3525
3853
|
# source_path: "String",
|
3526
3854
|
# },
|
3527
3855
|
# name: "String",
|
3856
|
+
# efs_volume_configuration: {
|
3857
|
+
# file_system_id: "String", # required
|
3858
|
+
# root_directory: "String",
|
3859
|
+
# transit_encryption: "ENABLED", # accepts ENABLED, DISABLED
|
3860
|
+
# transit_encryption_port: 1,
|
3861
|
+
# authorization_config: {
|
3862
|
+
# access_point_id: "String",
|
3863
|
+
# iam: "ENABLED", # accepts ENABLED, DISABLED
|
3864
|
+
# },
|
3865
|
+
# },
|
3528
3866
|
# },
|
3529
3867
|
# ],
|
3530
3868
|
# environment: [
|
@@ -3630,7 +3968,7 @@ module Aws::Batch
|
|
3630
3968
|
include Aws::Structure
|
3631
3969
|
end
|
3632
3970
|
|
3633
|
-
# An object representing the properties of a node that
|
3971
|
+
# An object representing the properties of a node that's associated
|
3634
3972
|
# with a multi-node parallel job.
|
3635
3973
|
#
|
3636
3974
|
# @!attribute [rw] is_main_node
|
@@ -3658,7 +3996,7 @@ module Aws::Batch
|
|
3658
3996
|
include Aws::Structure
|
3659
3997
|
end
|
3660
3998
|
|
3661
|
-
# Object representing any node overrides to a job definition that
|
3999
|
+
# Object representing any node overrides to a job definition that's
|
3662
4000
|
# used in a SubmitJob API operation.
|
3663
4001
|
#
|
3664
4002
|
# @note When making an API call, you may pass NodePropertyOverride
|
@@ -3729,6 +4067,16 @@ module Aws::Batch
|
|
3729
4067
|
# source_path: "String",
|
3730
4068
|
# },
|
3731
4069
|
# name: "String",
|
4070
|
+
# efs_volume_configuration: {
|
4071
|
+
# file_system_id: "String", # required
|
4072
|
+
# root_directory: "String",
|
4073
|
+
# transit_encryption: "ENABLED", # accepts ENABLED, DISABLED
|
4074
|
+
# transit_encryption_port: 1,
|
4075
|
+
# authorization_config: {
|
4076
|
+
# access_point_id: "String",
|
4077
|
+
# iam: "ENABLED", # accepts ENABLED, DISABLED
|
4078
|
+
# },
|
4079
|
+
# },
|
3732
4080
|
# },
|
3733
4081
|
# ],
|
3734
4082
|
# environment: [
|
@@ -3814,7 +4162,7 @@ module Aws::Batch
|
|
3814
4162
|
# starting range value is omitted (`:n`), then `0` is used to start
|
3815
4163
|
# the range. If the ending range value is omitted (`n:`), then the
|
3816
4164
|
# highest possible node index is used to end the range. Your
|
3817
|
-
# accumulative node ranges must account for all nodes (`0:n`). You
|
4165
|
+
# accumulative node ranges must account for all nodes (`0:n`). You can
|
3818
4166
|
# nest node ranges, for example `0:10` and `4:5`, in which case the
|
3819
4167
|
# `4:5` range properties override the `0:10` properties.
|
3820
4168
|
# @return [String]
|
@@ -3832,6 +4180,8 @@ module Aws::Batch
|
|
3832
4180
|
include Aws::Structure
|
3833
4181
|
end
|
3834
4182
|
|
4183
|
+
# Contains the parameters for `RegisterJobDefinition`.
|
4184
|
+
#
|
3835
4185
|
# @note When making an API call, you may pass RegisterJobDefinitionRequest
|
3836
4186
|
# data as a hash:
|
3837
4187
|
#
|
@@ -3854,6 +4204,16 @@ module Aws::Batch
|
|
3854
4204
|
# source_path: "String",
|
3855
4205
|
# },
|
3856
4206
|
# name: "String",
|
4207
|
+
# efs_volume_configuration: {
|
4208
|
+
# file_system_id: "String", # required
|
4209
|
+
# root_directory: "String",
|
4210
|
+
# transit_encryption: "ENABLED", # accepts ENABLED, DISABLED
|
4211
|
+
# transit_encryption_port: 1,
|
4212
|
+
# authorization_config: {
|
4213
|
+
# access_point_id: "String",
|
4214
|
+
# iam: "ENABLED", # accepts ENABLED, DISABLED
|
4215
|
+
# },
|
4216
|
+
# },
|
3857
4217
|
# },
|
3858
4218
|
# ],
|
3859
4219
|
# environment: [
|
@@ -3950,6 +4310,16 @@ module Aws::Batch
|
|
3950
4310
|
# source_path: "String",
|
3951
4311
|
# },
|
3952
4312
|
# name: "String",
|
4313
|
+
# efs_volume_configuration: {
|
4314
|
+
# file_system_id: "String", # required
|
4315
|
+
# root_directory: "String",
|
4316
|
+
# transit_encryption: "ENABLED", # accepts ENABLED, DISABLED
|
4317
|
+
# transit_encryption_port: 1,
|
4318
|
+
# authorization_config: {
|
4319
|
+
# access_point_id: "String",
|
4320
|
+
# iam: "ENABLED", # accepts ENABLED, DISABLED
|
4321
|
+
# },
|
4322
|
+
# },
|
3953
4323
|
# },
|
3954
4324
|
# ],
|
3955
4325
|
# environment: [
|
@@ -4111,7 +4481,7 @@ module Aws::Batch
|
|
4111
4481
|
#
|
4112
4482
|
# @!attribute [rw] retry_strategy
|
4113
4483
|
# The retry strategy to use for failed jobs that are submitted with
|
4114
|
-
# this job definition. Any retry strategy that
|
4484
|
+
# this job definition. Any retry strategy that's specified during a
|
4115
4485
|
# SubmitJob operation overrides the retry strategy defined here. If a
|
4116
4486
|
# job is terminated due to a timeout, it isn't retried.
|
4117
4487
|
# @return [Types::RetryStrategy]
|
@@ -4131,7 +4501,7 @@ module Aws::Batch
|
|
4131
4501
|
# definition, after which AWS Batch terminates your jobs if they have
|
4132
4502
|
# not finished. If a job is terminated due to a timeout, it isn't
|
4133
4503
|
# retried. The minimum value for the timeout is 60 seconds. Any
|
4134
|
-
# timeout configuration that
|
4504
|
+
# timeout configuration that's specified during a SubmitJob operation
|
4135
4505
|
# overrides the timeout configuration defined here. For more
|
4136
4506
|
# information, see [Job Timeouts][1] in the *AWS Batch User Guide*.
|
4137
4507
|
#
|
@@ -4224,18 +4594,17 @@ module Aws::Batch
|
|
4224
4594
|
#
|
4225
4595
|
# type="MEMORY"
|
4226
4596
|
#
|
4227
|
-
# :
|
4228
|
-
#
|
4229
|
-
# exceed the memory specified
|
4230
|
-
# parameter maps to `Memory` in the [Create a
|
4231
|
-
# of the [Docker Remote API][2] and the `--memory` option to [docker
|
4232
|
-
# run][3]. You must specify at least 4 MiB of memory for a job. This
|
4233
|
-
# is required but can be specified in several places for multi-node
|
4234
|
-
# parallel (MNP) jobs. It must be specified for each node at least
|
4235
|
-
# once. This parameter maps to `Memory` in the [Create a
|
4597
|
+
# : The memory hard limit (in MiB) present to the container. This
|
4598
|
+
# parameter is supported for jobs running on EC2 resources. If your
|
4599
|
+
# container attempts to exceed the memory specified, the container
|
4600
|
+
# is terminated. This parameter maps to `Memory` in the [Create a
|
4236
4601
|
# container][1] section of the [Docker Remote API][2] and the
|
4237
4602
|
# `--memory` option to [docker run][3]. You must specify at least 4
|
4238
|
-
# MiB of memory for a job.
|
4603
|
+
# MiB of memory for a job. This is required but can be specified in
|
4604
|
+
# several places for multi-node parallel (MNP) jobs. It must be
|
4605
|
+
# specified for each node at least once. This parameter maps to
|
4606
|
+
# `Memory` in the [Create a container][1] section of the [Docker
|
4607
|
+
# Remote API][2] and the `--memory` option to [docker run][3].
|
4239
4608
|
#
|
4240
4609
|
# <note markdown="1"> If you're trying to maximize your resource utilization by
|
4241
4610
|
# providing your jobs as much memory as possible for a particular
|
@@ -4245,44 +4614,43 @@ module Aws::Batch
|
|
4245
4614
|
# </note>
|
4246
4615
|
#
|
4247
4616
|
# For jobs running on Fargate resources, then `value` is the hard
|
4248
|
-
# limit (in
|
4249
|
-
#
|
4250
|
-
#
|
4251
|
-
# supported for that memory value.
|
4617
|
+
# limit (in MiB), and must match one of the supported values and the
|
4618
|
+
# `VCPU` values must be one of the values supported for that memory
|
4619
|
+
# value.
|
4252
4620
|
#
|
4253
|
-
# value =
|
4621
|
+
# value = 512
|
4254
4622
|
#
|
4255
4623
|
# : `VCPU` = 0.25
|
4256
4624
|
#
|
4257
|
-
# value =
|
4625
|
+
# value = 1024
|
4258
4626
|
#
|
4259
4627
|
# : `VCPU` = 0.25 or 0.5
|
4260
4628
|
#
|
4261
|
-
# value =
|
4629
|
+
# value = 2048
|
4262
4630
|
#
|
4263
4631
|
# : `VCPU` = 0.25, 0.5, or 1
|
4264
4632
|
#
|
4265
|
-
# value =
|
4633
|
+
# value = 3072
|
4266
4634
|
#
|
4267
4635
|
# : `VCPU` = 0.5, or 1
|
4268
4636
|
#
|
4269
|
-
# value =
|
4637
|
+
# value = 4096
|
4270
4638
|
#
|
4271
4639
|
# : `VCPU` = 0.5, 1, or 2
|
4272
4640
|
#
|
4273
|
-
# value =
|
4641
|
+
# value = 5120, 6144, or 7168
|
4274
4642
|
#
|
4275
4643
|
# : `VCPU` = 1 or 2
|
4276
4644
|
#
|
4277
|
-
# value =
|
4645
|
+
# value = 8192
|
4278
4646
|
#
|
4279
4647
|
# : `VCPU` = 1, 2, or 4
|
4280
4648
|
#
|
4281
|
-
# value =
|
4649
|
+
# value = 9216, 10240, 11264, 12288, 13312, 14336, 15360, or 16384
|
4282
4650
|
#
|
4283
4651
|
# : `VCPU` = 2 or 4
|
4284
4652
|
#
|
4285
|
-
# value =
|
4653
|
+
# value = 17408, 18432, 19456, 20480, 21504, 22528, 23552, 24576, 25600, 26624, 27648, 28672, 29696, or 30720
|
4286
4654
|
#
|
4287
4655
|
# : `VCPU` = 4
|
4288
4656
|
#
|
@@ -4291,10 +4659,10 @@ module Aws::Batch
|
|
4291
4659
|
# : The number of vCPUs reserved for the container. This parameter
|
4292
4660
|
# maps to `CpuShares` in the [Create a container][1] section of the
|
4293
4661
|
# [Docker Remote API][2] and the `--cpu-shares` option to [docker
|
4294
|
-
# run][3]. Each vCPU is equivalent to 1,024 CPU shares.
|
4295
|
-
# specify at least one vCPU. This is required
|
4296
|
-
# in several places; it must be specified for
|
4297
|
-
# once.
|
4662
|
+
# run][3]. Each vCPU is equivalent to 1,024 CPU shares. For EC2
|
4663
|
+
# resources, you must specify at least one vCPU. This is required
|
4664
|
+
# but can be specified in several places; it must be specified for
|
4665
|
+
# each node at least once.
|
4298
4666
|
#
|
4299
4667
|
# For jobs running on Fargate resources, then `value` must match one
|
4300
4668
|
# of the supported values and the `MEMORY` values must be one of the
|
@@ -4303,24 +4671,26 @@ module Aws::Batch
|
|
4303
4671
|
#
|
4304
4672
|
# value = 0.25
|
4305
4673
|
#
|
4306
|
-
# : `MEMORY` =
|
4674
|
+
# : `MEMORY` = 512, 1024, or 2048
|
4307
4675
|
#
|
4308
4676
|
# value = 0.5
|
4309
4677
|
#
|
4310
|
-
# : `MEMORY` =
|
4678
|
+
# : `MEMORY` = 1024, 2048, 3072, or 4096
|
4311
4679
|
#
|
4312
4680
|
# value = 1
|
4313
4681
|
#
|
4314
|
-
# : `MEMORY` =
|
4682
|
+
# : `MEMORY` = 2048, 3072, 4096, 5120, 6144, 7168, or 8192
|
4315
4683
|
#
|
4316
4684
|
# value = 2
|
4317
4685
|
#
|
4318
|
-
# : `MEMORY` =
|
4686
|
+
# : `MEMORY` = 4096, 5120, 6144, 7168, 8192, 9216, 10240, 11264,
|
4687
|
+
# 12288, 13312, 14336, 15360, or 16384
|
4319
4688
|
#
|
4320
4689
|
# value = 4
|
4321
4690
|
#
|
4322
|
-
# : `MEMORY` =
|
4323
|
-
#
|
4691
|
+
# : `MEMORY` = 8192, 9216, 10240, 11264, 12288, 13312, 14336, 15360,
|
4692
|
+
# 16384, 17408, 18432, 19456, 20480, 21504, 22528, 23552, 24576,
|
4693
|
+
# 25600, 26624, 27648, 28672, 29696, or 30720
|
4324
4694
|
#
|
4325
4695
|
#
|
4326
4696
|
#
|
@@ -4367,7 +4737,7 @@ module Aws::Batch
|
|
4367
4737
|
# }
|
4368
4738
|
#
|
4369
4739
|
# @!attribute [rw] attempts
|
4370
|
-
# The number of times to move a job to the `RUNNABLE` status. You
|
4740
|
+
# The number of times to move a job to the `RUNNABLE` status. You can
|
4371
4741
|
# specify between 1 and 10 attempts. If the value of `attempts` is
|
4372
4742
|
# greater than one, the job is retried on failure the same number of
|
4373
4743
|
# attempts as the value.
|
@@ -4422,7 +4792,7 @@ module Aws::Batch
|
|
4422
4792
|
# ARN of the parameter in the AWS Systems Manager Parameter Store.
|
4423
4793
|
#
|
4424
4794
|
# <note markdown="1"> If the AWS Systems Manager Parameter Store parameter exists in the
|
4425
|
-
# same Region as the job you
|
4795
|
+
# same Region as the job you're launching, then you can use either
|
4426
4796
|
# the full ARN or name of the parameter. If the parameter exists in a
|
4427
4797
|
# different Region, then the full ARN must be specified.
|
4428
4798
|
#
|
@@ -4451,6 +4821,8 @@ module Aws::Batch
|
|
4451
4821
|
include Aws::Structure
|
4452
4822
|
end
|
4453
4823
|
|
4824
|
+
# Contains the parameters for `SubmitJob`.
|
4825
|
+
#
|
4454
4826
|
# @note When making an API call, you may pass SubmitJobRequest
|
4455
4827
|
# data as a hash:
|
4456
4828
|
#
|
@@ -4541,8 +4913,8 @@ module Aws::Batch
|
|
4541
4913
|
# @return [String]
|
4542
4914
|
#
|
4543
4915
|
# @!attribute [rw] job_queue
|
4544
|
-
# The job queue
|
4545
|
-
#
|
4916
|
+
# The job queue where the job is submitted. You can specify either the
|
4917
|
+
# name or the Amazon Resource Name (ARN) of the queue.
|
4546
4918
|
# @return [String]
|
4547
4919
|
#
|
4548
4920
|
# @!attribute [rw] array_properties
|
@@ -4582,14 +4954,13 @@ module Aws::Batch
|
|
4582
4954
|
# @return [Hash<String,String>]
|
4583
4955
|
#
|
4584
4956
|
# @!attribute [rw] container_overrides
|
4585
|
-
# A list of container overrides in JSON format that specify the
|
4586
|
-
# of a container in the specified job definition and the
|
4587
|
-
# should receive. You can override the default command
|
4588
|
-
#
|
4589
|
-
# `command` override. You can also override
|
4590
|
-
#
|
4591
|
-
#
|
4592
|
-
# `environment` override.
|
4957
|
+
# A list of container overrides in the JSON format that specify the
|
4958
|
+
# name of a container in the specified job definition and the
|
4959
|
+
# overrides it should receive. You can override the default command
|
4960
|
+
# for a container, which is specified in the job definition or the
|
4961
|
+
# Docker image, with a `command` override. You can also override
|
4962
|
+
# existing environment variables on a container or add new environment
|
4963
|
+
# variables to it with an `environment` override.
|
4593
4964
|
# @return [Types::ContainerOverrides]
|
4594
4965
|
#
|
4595
4966
|
# @!attribute [rw] node_overrides
|
@@ -4728,6 +5099,8 @@ module Aws::Batch
|
|
4728
5099
|
#
|
4729
5100
|
class TagResourceResponse < Aws::EmptyStructure; end
|
4730
5101
|
|
5102
|
+
# Contains the parameters for `TerminateJob`.
|
5103
|
+
#
|
4731
5104
|
# @note When making an API call, you may pass TerminateJobRequest
|
4732
5105
|
# data as a hash:
|
4733
5106
|
#
|
@@ -4878,6 +5251,8 @@ module Aws::Batch
|
|
4878
5251
|
#
|
4879
5252
|
class UntagResourceResponse < Aws::EmptyStructure; end
|
4880
5253
|
|
5254
|
+
# Contains the parameters for `UpdateComputeEnvironment`.
|
5255
|
+
#
|
4881
5256
|
# @note When making an API call, you may pass UpdateComputeEnvironmentRequest
|
4882
5257
|
# data as a hash:
|
4883
5258
|
#
|
@@ -4903,16 +5278,39 @@ module Aws::Batch
|
|
4903
5278
|
# The state of the compute environment. Compute environments in the
|
4904
5279
|
# `ENABLED` state can accept jobs from a queue and scale in or out
|
4905
5280
|
# automatically based on the workload demand of its associated queues.
|
5281
|
+
#
|
5282
|
+
# If the state is `ENABLED`, then the AWS Batch scheduler can attempt
|
5283
|
+
# to place jobs from an associated job queue on the compute resources
|
5284
|
+
# within the environment. If the compute environment is managed, then
|
5285
|
+
# it can scale its instances out or in automatically, based on the job
|
5286
|
+
# queue demand.
|
5287
|
+
#
|
5288
|
+
# If the state is `DISABLED`, then the AWS Batch scheduler doesn't
|
5289
|
+
# attempt to place jobs within the environment. Jobs in a `STARTING`
|
5290
|
+
# or `RUNNING` state continue to progress normally. Managed compute
|
5291
|
+
# environments in the `DISABLED` state don't scale out. However, they
|
5292
|
+
# scale in to `minvCpus` value after instances become idle.
|
4906
5293
|
# @return [String]
|
4907
5294
|
#
|
4908
5295
|
# @!attribute [rw] compute_resources
|
4909
5296
|
# Details of the compute resources managed by the compute environment.
|
4910
|
-
# Required for a managed compute environment.
|
5297
|
+
# Required for a managed compute environment. For more information,
|
5298
|
+
# see [Compute Environments][1] in the *AWS Batch User Guide*.
|
5299
|
+
#
|
5300
|
+
#
|
5301
|
+
#
|
5302
|
+
# [1]: https://docs.aws.amazon.com/batch/latest/userguide/compute_environments.html
|
4911
5303
|
# @return [Types::ComputeResourceUpdate]
|
4912
5304
|
#
|
4913
5305
|
# @!attribute [rw] service_role
|
4914
5306
|
# The full Amazon Resource Name (ARN) of the IAM role that allows AWS
|
4915
|
-
# Batch to make calls to other AWS services on your behalf.
|
5307
|
+
# Batch to make calls to other AWS services on your behalf. For more
|
5308
|
+
# information, see [AWS Batch service IAM role][1] in the *AWS Batch
|
5309
|
+
# User Guide*.
|
5310
|
+
#
|
5311
|
+
# If the compute environment has a service-linked role, it cannot be
|
5312
|
+
# changed to use a regular IAM role. If the compute environment has a
|
5313
|
+
# regular IAM role, it cannot be changed to use a service-linked role.
|
4916
5314
|
#
|
4917
5315
|
# If your specified role has a path other than `/`, then you must
|
4918
5316
|
# either specify the full role ARN (this is recommended) or prefix the
|
@@ -4920,12 +5318,16 @@ module Aws::Batch
|
|
4920
5318
|
#
|
4921
5319
|
# <note markdown="1"> Depending on how you created your AWS Batch service role, its ARN
|
4922
5320
|
# might contain the `service-role` path prefix. When you only specify
|
4923
|
-
# the name of the service role, AWS Batch assumes that your ARN
|
4924
|
-
#
|
5321
|
+
# the name of the service role, AWS Batch assumes that your ARN
|
5322
|
+
# doesn't use the `service-role` path prefix. Because of this, we
|
4925
5323
|
# recommend that you specify the full ARN of your service role when
|
4926
5324
|
# you create compute environments.
|
4927
5325
|
#
|
4928
5326
|
# </note>
|
5327
|
+
#
|
5328
|
+
#
|
5329
|
+
#
|
5330
|
+
# [1]: https://docs.aws.amazon.com/batch/latest/userguide/service_IAM_role.html
|
4929
5331
|
# @return [String]
|
4930
5332
|
#
|
4931
5333
|
# @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/UpdateComputeEnvironmentRequest AWS API Documentation
|
@@ -4940,7 +5342,8 @@ module Aws::Batch
|
|
4940
5342
|
end
|
4941
5343
|
|
4942
5344
|
# @!attribute [rw] compute_environment_name
|
4943
|
-
# The name of the compute environment.
|
5345
|
+
# The name of the compute environment. Up to 128 letters (uppercase
|
5346
|
+
# and lowercase), numbers, hyphens, and underscores are allowed.
|
4944
5347
|
# @return [String]
|
4945
5348
|
#
|
4946
5349
|
# @!attribute [rw] compute_environment_arn
|
@@ -4956,6 +5359,8 @@ module Aws::Batch
|
|
4956
5359
|
include Aws::Structure
|
4957
5360
|
end
|
4958
5361
|
|
5362
|
+
# Contains the parameters for `UpdateJobQueue`.
|
5363
|
+
#
|
4959
5364
|
# @note When making an API call, you may pass UpdateJobQueueRequest
|
4960
5365
|
# data as a hash:
|
4961
5366
|
#
|
@@ -4977,9 +5382,9 @@ module Aws::Batch
|
|
4977
5382
|
#
|
4978
5383
|
# @!attribute [rw] state
|
4979
5384
|
# Describes the queue's ability to accept new jobs. If the job queue
|
4980
|
-
# state is `ENABLED`, it
|
4981
|
-
#
|
4982
|
-
#
|
5385
|
+
# state is `ENABLED`, it can accept jobs. If the job queue state is
|
5386
|
+
# `DISABLED`, new jobs can't be added to the queue, but jobs already
|
5387
|
+
# in the queue can finish.
|
4983
5388
|
# @return [String]
|
4984
5389
|
#
|
4985
5390
|
# @!attribute [rw] priority
|
@@ -4988,17 +5393,27 @@ module Aws::Batch
|
|
4988
5393
|
# first when associated with the same compute environment. Priority is
|
4989
5394
|
# determined in descending order, for example, a job queue with a
|
4990
5395
|
# priority value of `10` is given scheduling preference over a job
|
4991
|
-
# queue with a priority value of `1`.
|
5396
|
+
# queue with a priority value of `1`. All of the compute environments
|
5397
|
+
# must be either EC2 (`EC2` or `SPOT`) or Fargate (`FARGATE` or
|
5398
|
+
# `FARGATE_SPOT`). EC2 and Fargate compute environments can't be
|
5399
|
+
# mixed.
|
4992
5400
|
# @return [Integer]
|
4993
5401
|
#
|
4994
5402
|
# @!attribute [rw] compute_environment_order
|
4995
5403
|
# Details the set of compute environments mapped to a job queue and
|
4996
5404
|
# their order relative to each other. This is one of the parameters
|
4997
5405
|
# used by the job scheduler to determine which compute environment
|
4998
|
-
# should run a given job.
|
4999
|
-
#
|
5000
|
-
#
|
5001
|
-
#
|
5406
|
+
# should run a given job. Compute environments must be in the `VALID`
|
5407
|
+
# state before you can associate them with a job queue. All of the
|
5408
|
+
# compute environments must be either EC2 (`EC2` or `SPOT`) or Fargate
|
5409
|
+
# (`FARGATE` or `FARGATE_SPOT`). EC2 and Fargate compute environments
|
5410
|
+
# can't be mixed.
|
5411
|
+
#
|
5412
|
+
# <note markdown="1"> All compute environments that are associated with a job queue must
|
5413
|
+
# share the same architecture. AWS Batch doesn't support mixing
|
5414
|
+
# compute environment architecture types in a single job queue.
|
5415
|
+
#
|
5416
|
+
# </note>
|
5002
5417
|
# @return [Array<Types::ComputeEnvironmentOrder>]
|
5003
5418
|
#
|
5004
5419
|
# @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/UpdateJobQueueRequest AWS API Documentation
|
@@ -5039,6 +5454,16 @@ module Aws::Batch
|
|
5039
5454
|
# source_path: "String",
|
5040
5455
|
# },
|
5041
5456
|
# name: "String",
|
5457
|
+
# efs_volume_configuration: {
|
5458
|
+
# file_system_id: "String", # required
|
5459
|
+
# root_directory: "String",
|
5460
|
+
# transit_encryption: "ENABLED", # accepts ENABLED, DISABLED
|
5461
|
+
# transit_encryption_port: 1,
|
5462
|
+
# authorization_config: {
|
5463
|
+
# access_point_id: "String",
|
5464
|
+
# iam: "ENABLED", # accepts ENABLED, DISABLED
|
5465
|
+
# },
|
5466
|
+
# },
|
5042
5467
|
# }
|
5043
5468
|
#
|
5044
5469
|
# @!attribute [rw] host
|
@@ -5062,11 +5487,18 @@ module Aws::Batch
|
|
5062
5487
|
# `mountPoints`.
|
5063
5488
|
# @return [String]
|
5064
5489
|
#
|
5490
|
+
# @!attribute [rw] efs_volume_configuration
|
5491
|
+
# This parameter is specified when you are using an Amazon Elastic
|
5492
|
+
# File System file system for job storage. Jobs running on Fargate
|
5493
|
+
# resources must specify a `platformVersion` of at least `1.4.0`.
|
5494
|
+
# @return [Types::EFSVolumeConfiguration]
|
5495
|
+
#
|
5065
5496
|
# @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/Volume AWS API Documentation
|
5066
5497
|
#
|
5067
5498
|
class Volume < Struct.new(
|
5068
5499
|
:host,
|
5069
|
-
:name
|
5500
|
+
:name,
|
5501
|
+
:efs_volume_configuration)
|
5070
5502
|
SENSITIVE = []
|
5071
5503
|
include Aws::Structure
|
5072
5504
|
end
|