aws-sdk-batch 1.45.0 → 1.49.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 +20 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-batch.rb +1 -1
- data/lib/aws-sdk-batch/client.rb +280 -156
- data/lib/aws-sdk-batch/client_api.rb +27 -1
- data/lib/aws-sdk-batch/types.rb +773 -418
- metadata +7 -8
@@ -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')
|
@@ -89,8 +93,10 @@ module Aws::Batch
|
|
89
93
|
JobSummaryList = Shapes::ListShape.new(name: 'JobSummaryList')
|
90
94
|
JobTimeout = Shapes::StructureShape.new(name: 'JobTimeout')
|
91
95
|
KeyValuePair = Shapes::StructureShape.new(name: 'KeyValuePair')
|
96
|
+
KeyValuesPair = Shapes::StructureShape.new(name: 'KeyValuesPair')
|
92
97
|
LaunchTemplateSpecification = Shapes::StructureShape.new(name: 'LaunchTemplateSpecification')
|
93
98
|
LinuxParameters = Shapes::StructureShape.new(name: 'LinuxParameters')
|
99
|
+
ListJobsFilterList = Shapes::ListShape.new(name: 'ListJobsFilterList')
|
94
100
|
ListJobsRequest = Shapes::StructureShape.new(name: 'ListJobsRequest')
|
95
101
|
ListJobsResponse = Shapes::StructureShape.new(name: 'ListJobsResponse')
|
96
102
|
ListTagsForResourceRequest = Shapes::StructureShape.new(name: 'ListTagsForResourceRequest')
|
@@ -303,7 +309,7 @@ module Aws::Batch
|
|
303
309
|
CreateComputeEnvironmentRequest.add_member(:type, Shapes::ShapeRef.new(shape: CEType, required: true, location_name: "type"))
|
304
310
|
CreateComputeEnvironmentRequest.add_member(:state, Shapes::ShapeRef.new(shape: CEState, location_name: "state"))
|
305
311
|
CreateComputeEnvironmentRequest.add_member(:compute_resources, Shapes::ShapeRef.new(shape: ComputeResource, location_name: "computeResources"))
|
306
|
-
CreateComputeEnvironmentRequest.add_member(:service_role, Shapes::ShapeRef.new(shape: String,
|
312
|
+
CreateComputeEnvironmentRequest.add_member(:service_role, Shapes::ShapeRef.new(shape: String, location_name: "serviceRole"))
|
307
313
|
CreateComputeEnvironmentRequest.add_member(:tags, Shapes::ShapeRef.new(shape: TagrisTagsMap, location_name: "tags"))
|
308
314
|
CreateComputeEnvironmentRequest.struct_class = Types::CreateComputeEnvironmentRequest
|
309
315
|
|
@@ -381,6 +387,17 @@ module Aws::Batch
|
|
381
387
|
|
382
388
|
DevicesList.member = Shapes::ShapeRef.new(shape: Device)
|
383
389
|
|
390
|
+
EFSAuthorizationConfig.add_member(:access_point_id, Shapes::ShapeRef.new(shape: String, location_name: "accessPointId"))
|
391
|
+
EFSAuthorizationConfig.add_member(:iam, Shapes::ShapeRef.new(shape: EFSAuthorizationConfigIAM, location_name: "iam"))
|
392
|
+
EFSAuthorizationConfig.struct_class = Types::EFSAuthorizationConfig
|
393
|
+
|
394
|
+
EFSVolumeConfiguration.add_member(:file_system_id, Shapes::ShapeRef.new(shape: String, required: true, location_name: "fileSystemId"))
|
395
|
+
EFSVolumeConfiguration.add_member(:root_directory, Shapes::ShapeRef.new(shape: String, location_name: "rootDirectory"))
|
396
|
+
EFSVolumeConfiguration.add_member(:transit_encryption, Shapes::ShapeRef.new(shape: EFSTransitEncryption, location_name: "transitEncryption"))
|
397
|
+
EFSVolumeConfiguration.add_member(:transit_encryption_port, Shapes::ShapeRef.new(shape: Integer, location_name: "transitEncryptionPort"))
|
398
|
+
EFSVolumeConfiguration.add_member(:authorization_config, Shapes::ShapeRef.new(shape: EFSAuthorizationConfig, location_name: "authorizationConfig"))
|
399
|
+
EFSVolumeConfiguration.struct_class = Types::EFSVolumeConfiguration
|
400
|
+
|
384
401
|
Ec2Configuration.add_member(:image_type, Shapes::ShapeRef.new(shape: ImageType, required: true, location_name: "imageType"))
|
385
402
|
Ec2Configuration.add_member(:image_id_override, Shapes::ShapeRef.new(shape: ImageIdOverride, location_name: "imageIdOverride"))
|
386
403
|
Ec2Configuration.struct_class = Types::Ec2Configuration
|
@@ -475,6 +492,7 @@ module Aws::Batch
|
|
475
492
|
JobSummary.add_member(:container, Shapes::ShapeRef.new(shape: ContainerSummary, location_name: "container"))
|
476
493
|
JobSummary.add_member(:array_properties, Shapes::ShapeRef.new(shape: ArrayPropertiesSummary, location_name: "arrayProperties"))
|
477
494
|
JobSummary.add_member(:node_properties, Shapes::ShapeRef.new(shape: NodePropertiesSummary, location_name: "nodeProperties"))
|
495
|
+
JobSummary.add_member(:job_definition, Shapes::ShapeRef.new(shape: String, location_name: "jobDefinition"))
|
478
496
|
JobSummary.struct_class = Types::JobSummary
|
479
497
|
|
480
498
|
JobSummaryList.member = Shapes::ShapeRef.new(shape: JobSummary)
|
@@ -486,6 +504,10 @@ module Aws::Batch
|
|
486
504
|
KeyValuePair.add_member(:value, Shapes::ShapeRef.new(shape: String, location_name: "value"))
|
487
505
|
KeyValuePair.struct_class = Types::KeyValuePair
|
488
506
|
|
507
|
+
KeyValuesPair.add_member(:name, Shapes::ShapeRef.new(shape: String, location_name: "name"))
|
508
|
+
KeyValuesPair.add_member(:values, Shapes::ShapeRef.new(shape: StringList, location_name: "values"))
|
509
|
+
KeyValuesPair.struct_class = Types::KeyValuesPair
|
510
|
+
|
489
511
|
LaunchTemplateSpecification.add_member(:launch_template_id, Shapes::ShapeRef.new(shape: String, location_name: "launchTemplateId"))
|
490
512
|
LaunchTemplateSpecification.add_member(:launch_template_name, Shapes::ShapeRef.new(shape: String, location_name: "launchTemplateName"))
|
491
513
|
LaunchTemplateSpecification.add_member(:version, Shapes::ShapeRef.new(shape: String, location_name: "version"))
|
@@ -499,12 +521,15 @@ module Aws::Batch
|
|
499
521
|
LinuxParameters.add_member(:swappiness, Shapes::ShapeRef.new(shape: Integer, location_name: "swappiness"))
|
500
522
|
LinuxParameters.struct_class = Types::LinuxParameters
|
501
523
|
|
524
|
+
ListJobsFilterList.member = Shapes::ShapeRef.new(shape: KeyValuesPair)
|
525
|
+
|
502
526
|
ListJobsRequest.add_member(:job_queue, Shapes::ShapeRef.new(shape: String, location_name: "jobQueue"))
|
503
527
|
ListJobsRequest.add_member(:array_job_id, Shapes::ShapeRef.new(shape: String, location_name: "arrayJobId"))
|
504
528
|
ListJobsRequest.add_member(:multi_node_job_id, Shapes::ShapeRef.new(shape: String, location_name: "multiNodeJobId"))
|
505
529
|
ListJobsRequest.add_member(:job_status, Shapes::ShapeRef.new(shape: JobStatus, location_name: "jobStatus"))
|
506
530
|
ListJobsRequest.add_member(:max_results, Shapes::ShapeRef.new(shape: Integer, location_name: "maxResults"))
|
507
531
|
ListJobsRequest.add_member(:next_token, Shapes::ShapeRef.new(shape: String, location_name: "nextToken"))
|
532
|
+
ListJobsRequest.add_member(:filters, Shapes::ShapeRef.new(shape: ListJobsFilterList, location_name: "filters"))
|
508
533
|
ListJobsRequest.struct_class = Types::ListJobsRequest
|
509
534
|
|
510
535
|
ListJobsResponse.add_member(:job_summary_list, Shapes::ShapeRef.new(shape: JobSummaryList, required: true, location_name: "jobSummaryList"))
|
@@ -696,6 +721,7 @@ module Aws::Batch
|
|
696
721
|
|
697
722
|
Volume.add_member(:host, Shapes::ShapeRef.new(shape: Host, location_name: "host"))
|
698
723
|
Volume.add_member(:name, Shapes::ShapeRef.new(shape: String, location_name: "name"))
|
724
|
+
Volume.add_member(:efs_volume_configuration, Shapes::ShapeRef.new(shape: EFSVolumeConfiguration, location_name: "efsVolumeConfiguration"))
|
699
725
|
Volume.struct_class = Types::Volume
|
700
726
|
|
701
727
|
Volumes.member = Shapes::ShapeRef.new(shape: Volume)
|
data/lib/aws-sdk-batch/types.rb
CHANGED
@@ -10,7 +10,7 @@
|
|
10
10
|
module Aws::Batch
|
11
11
|
module Types
|
12
12
|
|
13
|
-
# An object representing an
|
13
|
+
# An object representing an Batch array job.
|
14
14
|
#
|
15
15
|
# @note When making an API call, you may pass ArrayProperties
|
16
16
|
# data as a hash:
|
@@ -105,9 +105,9 @@ module Aws::Batch
|
|
105
105
|
#
|
106
106
|
# @!attribute [rw] log_stream_name
|
107
107
|
# The name of the CloudWatch Logs log stream associated with the
|
108
|
-
# container. The log group for
|
109
|
-
#
|
110
|
-
#
|
108
|
+
# container. The log group for Batch jobs is `/aws/batch/job`. Each
|
109
|
+
# container attempt receives a log stream name when they reach the
|
110
|
+
# `RUNNING` status.
|
111
111
|
# @return [String]
|
112
112
|
#
|
113
113
|
# @!attribute [rw] network_interfaces
|
@@ -172,14 +172,14 @@ module Aws::Batch
|
|
172
172
|
# }
|
173
173
|
#
|
174
174
|
# @!attribute [rw] job_id
|
175
|
-
# The
|
175
|
+
# The Batch job ID of the job to cancel.
|
176
176
|
# @return [String]
|
177
177
|
#
|
178
178
|
# @!attribute [rw] reason
|
179
179
|
# A message to attach to the job that explains the reason for
|
180
180
|
# canceling it. This message is returned by future DescribeJobs
|
181
|
-
# operations on the job. This message is also recorded in the
|
182
|
-
#
|
181
|
+
# operations on the job. This message is also recorded in the Batch
|
182
|
+
# activity logs.
|
183
183
|
# @return [String]
|
184
184
|
#
|
185
185
|
# @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/CancelJobRequest AWS API Documentation
|
@@ -211,7 +211,7 @@ module Aws::Batch
|
|
211
211
|
include Aws::Structure
|
212
212
|
end
|
213
213
|
|
214
|
-
# An object representing an
|
214
|
+
# An object representing an Batch compute environment.
|
215
215
|
#
|
216
216
|
# @!attribute [rw] compute_environment_name
|
217
217
|
# The name of the compute environment. Up to 128 letters (uppercase
|
@@ -233,8 +233,8 @@ module Aws::Batch
|
|
233
233
|
#
|
234
234
|
# @!attribute [rw] type
|
235
235
|
# The type of the compute environment: `MANAGED` or `UNMANAGED`. For
|
236
|
-
# more information, see [Compute Environments][1] in the *
|
237
|
-
#
|
236
|
+
# more information, see [Compute Environments][1] in the *Batch User
|
237
|
+
# Guide*.
|
238
238
|
#
|
239
239
|
#
|
240
240
|
#
|
@@ -245,13 +245,13 @@ module Aws::Batch
|
|
245
245
|
# The state of the compute environment. The valid values are `ENABLED`
|
246
246
|
# or `DISABLED`.
|
247
247
|
#
|
248
|
-
# If the state is `ENABLED`, then the
|
249
|
-
#
|
248
|
+
# If the state is `ENABLED`, then the Batch scheduler can attempt to
|
249
|
+
# place jobs from an associated job queue on the compute resources
|
250
250
|
# within the environment. If the compute environment is managed, then
|
251
251
|
# it can scale its instances out or in automatically, based on the job
|
252
252
|
# queue demand.
|
253
253
|
#
|
254
|
-
# If the state is `DISABLED`, then the
|
254
|
+
# If the state is `DISABLED`, then the Batch scheduler doesn't
|
255
255
|
# attempt to place jobs within the environment. Jobs in a `STARTING`
|
256
256
|
# or `RUNNING` state continue to progress normally. Managed compute
|
257
257
|
# environments in the `DISABLED` state don't scale out. However, they
|
@@ -270,7 +270,7 @@ module Aws::Batch
|
|
270
270
|
#
|
271
271
|
# @!attribute [rw] compute_resources
|
272
272
|
# The compute resources defined for the compute environment. For more
|
273
|
-
# information, see [Compute Environments][1] in the *
|
273
|
+
# information, see [Compute Environments][1] in the *Batch User
|
274
274
|
# Guide*.
|
275
275
|
#
|
276
276
|
#
|
@@ -280,9 +280,9 @@ module Aws::Batch
|
|
280
280
|
#
|
281
281
|
# @!attribute [rw] service_role
|
282
282
|
# The service role associated with the compute environment that allows
|
283
|
-
#
|
284
|
-
# more information, see [
|
285
|
-
# Batch User Guide*.
|
283
|
+
# Batch to make calls to Amazon Web Services API operations on your
|
284
|
+
# behalf. For more information, see [Batch service IAM role][1] in the
|
285
|
+
# *Batch User Guide*.
|
286
286
|
#
|
287
287
|
#
|
288
288
|
#
|
@@ -317,7 +317,7 @@ module Aws::Batch
|
|
317
317
|
# can't be mixed.
|
318
318
|
#
|
319
319
|
# <note markdown="1"> All compute environments that are associated with a job queue must
|
320
|
-
# share the same architecture.
|
320
|
+
# share the same architecture. Batch doesn't support mixing compute
|
321
321
|
# environment architecture types in a single job queue.
|
322
322
|
#
|
323
323
|
# </note>
|
@@ -350,9 +350,8 @@ module Aws::Batch
|
|
350
350
|
include Aws::Structure
|
351
351
|
end
|
352
352
|
|
353
|
-
# An object representing an
|
354
|
-
# information, see [Compute Environments][1] in the *
|
355
|
-
# Guide*.
|
353
|
+
# An object representing an Batch compute resource. For more
|
354
|
+
# information, see [Compute Environments][1] in the *Batch User Guide*.
|
356
355
|
#
|
357
356
|
#
|
358
357
|
#
|
@@ -395,11 +394,11 @@ module Aws::Batch
|
|
395
394
|
# @!attribute [rw] type
|
396
395
|
# The type of compute environment: `EC2`, `SPOT`, `FARGATE`, or
|
397
396
|
# `FARGATE_SPOT`. For more information, see [Compute Environments][1]
|
398
|
-
# in the *
|
397
|
+
# in the *Batch User Guide*.
|
399
398
|
#
|
400
399
|
# If you choose `SPOT`, you must also specify an Amazon EC2 Spot Fleet
|
401
400
|
# role with the `spotIamFleetRole` parameter. For more information,
|
402
|
-
# see [Amazon EC2 Spot Fleet role][2] in the *
|
401
|
+
# see [Amazon EC2 Spot Fleet role][2] in the *Batch User Guide*.
|
403
402
|
#
|
404
403
|
#
|
405
404
|
#
|
@@ -412,46 +411,46 @@ module Aws::Batch
|
|
412
411
|
# enough instances of the best fitting instance type can be allocated.
|
413
412
|
# This might be because of availability of the instance type in the
|
414
413
|
# Region or [Amazon EC2 service limits][1]. For more information, see
|
415
|
-
# [Allocation Strategies][2] in the *
|
414
|
+
# [Allocation Strategies][2] in the *Batch User Guide*.
|
416
415
|
#
|
417
|
-
# <note markdown="1"> This parameter isn't applicable to jobs running on Fargate
|
416
|
+
# <note markdown="1"> This parameter isn't applicable to jobs that are running on Fargate
|
418
417
|
# resources, and shouldn't be specified.
|
419
418
|
#
|
420
419
|
# </note>
|
421
420
|
#
|
422
421
|
# BEST\_FIT (default)
|
423
422
|
#
|
424
|
-
# :
|
423
|
+
# : Batch selects an instance type that best fits the needs of the
|
425
424
|
# jobs with a preference for the lowest-cost instance type. If
|
426
425
|
# additional instances of the selected instance type aren't
|
427
|
-
# available,
|
428
|
-
# available. If there
|
429
|
-
# user is
|
430
|
-
# jobs aren't run until currently running jobs have completed.
|
431
|
-
# allocation strategy keeps costs lower but can limit scaling.
|
432
|
-
# you are using Spot Fleets with `BEST_FIT` then the Spot Fleet
|
433
|
-
# Role must be specified.
|
426
|
+
# available, Batch waits for the additional instances to be
|
427
|
+
# available. If there aren't enough instances available, or if the
|
428
|
+
# user is reaching [Amazon EC2 service limits][1] then additional
|
429
|
+
# jobs aren't run until the currently running jobs have completed.
|
430
|
+
# This allocation strategy keeps costs lower but can limit scaling.
|
431
|
+
# If you are using Spot Fleets with `BEST_FIT` then the Spot Fleet
|
432
|
+
# IAM Role must be specified.
|
434
433
|
#
|
435
434
|
# BEST\_FIT\_PROGRESSIVE
|
436
435
|
#
|
437
|
-
# :
|
438
|
-
#
|
436
|
+
# : Batch will select additional instance types that are large enough
|
437
|
+
# to meet the requirements of the jobs in the queue, with a
|
439
438
|
# preference for instance types with a lower cost per unit vCPU. If
|
440
439
|
# additional instances of the previously selected instance types
|
441
|
-
# aren't available,
|
440
|
+
# aren't available, Batch will select new instance types.
|
442
441
|
#
|
443
442
|
# SPOT\_CAPACITY\_OPTIMIZED
|
444
443
|
#
|
445
|
-
# :
|
446
|
-
#
|
444
|
+
# : Batch will select one or more instance types that are large enough
|
445
|
+
# to meet the requirements of the jobs in the queue, with a
|
447
446
|
# preference for instance types that are less likely to be
|
448
447
|
# interrupted. This allocation strategy is only available for Spot
|
449
448
|
# Instance compute resources.
|
450
449
|
#
|
451
450
|
# With both `BEST_FIT_PROGRESSIVE` and `SPOT_CAPACITY_OPTIMIZED`
|
452
|
-
# strategies,
|
453
|
-
# capacity requirements. In this event,
|
454
|
-
#
|
451
|
+
# strategies, Batch might need to go above `maxvCpus` to meet your
|
452
|
+
# capacity requirements. In this event, Batch never exceeds `maxvCpus`
|
453
|
+
# by more than a single instance.
|
455
454
|
#
|
456
455
|
#
|
457
456
|
#
|
@@ -463,7 +462,7 @@ module Aws::Batch
|
|
463
462
|
# The minimum number of Amazon EC2 vCPUs that an environment should
|
464
463
|
# maintain (even if the compute environment is `DISABLED`).
|
465
464
|
#
|
466
|
-
# <note markdown="1"> This parameter isn't applicable to jobs running on Fargate
|
465
|
+
# <note markdown="1"> This parameter isn't applicable to jobs that are running on Fargate
|
467
466
|
# resources, and shouldn't be specified.
|
468
467
|
#
|
469
468
|
# </note>
|
@@ -474,21 +473,21 @@ module Aws::Batch
|
|
474
473
|
# can reach.
|
475
474
|
#
|
476
475
|
# <note markdown="1"> With both `BEST_FIT_PROGRESSIVE` and `SPOT_CAPACITY_OPTIMIZED`
|
477
|
-
# allocation strategies,
|
478
|
-
#
|
479
|
-
#
|
480
|
-
#
|
481
|
-
#
|
476
|
+
# allocation strategies, Batch might need to exceed `maxvCpus` to meet
|
477
|
+
# your capacity requirements. In this event, Batch never exceeds
|
478
|
+
# `maxvCpus` by more than a single instance. For example, no more than
|
479
|
+
# a single instance from among those specified in your compute
|
480
|
+
# environment is allocated.
|
482
481
|
#
|
483
482
|
# </note>
|
484
483
|
# @return [Integer]
|
485
484
|
#
|
486
485
|
# @!attribute [rw] desiredv_cpus
|
487
486
|
# The desired number of Amazon EC2 vCPUS in the compute environment.
|
488
|
-
#
|
489
|
-
#
|
487
|
+
# Batch modifies this value between the minimum and maximum values,
|
488
|
+
# based on job queue demand.
|
490
489
|
#
|
491
|
-
# <note markdown="1"> This parameter isn't applicable to jobs running on Fargate
|
490
|
+
# <note markdown="1"> This parameter isn't applicable to jobs that are running on Fargate
|
492
491
|
# resources, and shouldn't be specified.
|
493
492
|
#
|
494
493
|
# </note>
|
@@ -499,10 +498,10 @@ module Aws::Batch
|
|
499
498
|
# families to launch any instance type within those families (for
|
500
499
|
# example, `c5` or `p3`), or you can specify specific sizes within a
|
501
500
|
# family (such as `c5.8xlarge`). You can also choose `optimal` to
|
502
|
-
# select instance types (from the C4, M4, and R4 instance families)
|
503
|
-
#
|
501
|
+
# select instance types (from the C4, M4, and R4 instance families)
|
502
|
+
# that match the demand of your job queues.
|
504
503
|
#
|
505
|
-
# <note markdown="1"> This parameter isn't applicable to jobs running on Fargate
|
504
|
+
# <note markdown="1"> This parameter isn't applicable to jobs that are running on Fargate
|
506
505
|
# resources, and shouldn't be specified.
|
507
506
|
#
|
508
507
|
# </note>
|
@@ -527,7 +526,7 @@ module Aws::Batch
|
|
527
526
|
# compute environment. This parameter is overridden by the
|
528
527
|
# `imageIdOverride` member of the `Ec2Configuration` structure.
|
529
528
|
#
|
530
|
-
# <note markdown="1"> This parameter isn't applicable to jobs running on Fargate
|
529
|
+
# <note markdown="1"> This parameter isn't applicable to jobs that are running on Fargate
|
531
530
|
# resources, and shouldn't be specified.
|
532
531
|
#
|
533
532
|
# </note>
|
@@ -549,11 +548,10 @@ module Aws::Batch
|
|
549
548
|
# @return [String]
|
550
549
|
#
|
551
550
|
# @!attribute [rw] subnets
|
552
|
-
# The VPC subnets
|
553
|
-
# subnets must be within the same VPC.
|
554
|
-
#
|
555
|
-
#
|
556
|
-
# *Amazon VPC User Guide*.
|
551
|
+
# The VPC subnets where the compute resources are launched. These
|
552
|
+
# subnets must be within the same VPC. Fargate compute resources can
|
553
|
+
# contain up to 16 subnets. For more information, see [VPCs and
|
554
|
+
# Subnets][1] in the *Amazon VPC User Guide*.
|
557
555
|
#
|
558
556
|
#
|
559
557
|
#
|
@@ -565,10 +563,10 @@ module Aws::Batch
|
|
565
563
|
# the compute environment. One or more security groups must be
|
566
564
|
# specified, either in `securityGroupIds` or using a launch template
|
567
565
|
# referenced in `launchTemplate`. This parameter is required for jobs
|
568
|
-
# running on Fargate resources and must contain at least one
|
569
|
-
# group.
|
570
|
-
# groups are specified using both `securityGroupIds` and
|
571
|
-
# `launchTemplate`, the values in `securityGroupIds`
|
566
|
+
# that are running on Fargate resources and must contain at least one
|
567
|
+
# security group. Fargate doesn't support launch templates. If
|
568
|
+
# security groups are specified using both `securityGroupIds` and
|
569
|
+
# `launchTemplate`, the values in `securityGroupIds` are used.
|
572
570
|
# @return [Array<String>]
|
573
571
|
#
|
574
572
|
# @!attribute [rw] ec2_key_pair
|
@@ -576,7 +574,7 @@ module Aws::Batch
|
|
576
574
|
# compute environment. You can use this key pair to log in to your
|
577
575
|
# instances with SSH.
|
578
576
|
#
|
579
|
-
# <note markdown="1"> This parameter isn't applicable to jobs running on Fargate
|
577
|
+
# <note markdown="1"> This parameter isn't applicable to jobs that are running on Fargate
|
580
578
|
# resources, and shouldn't be specified.
|
581
579
|
#
|
582
580
|
# </note>
|
@@ -588,10 +586,10 @@ module Aws::Batch
|
|
588
586
|
# Resource Name (ARN) of an instance profile. For example, `
|
589
587
|
# ecsInstanceRole ` or
|
590
588
|
# `arn:aws:iam::<aws_account_id>:instance-profile/ecsInstanceRole `.
|
591
|
-
# For more information, see [Amazon ECS Instance Role][1] in the
|
592
|
-
# Batch User Guide*.
|
589
|
+
# For more information, see [Amazon ECS Instance Role][1] in the
|
590
|
+
# *Batch User Guide*.
|
593
591
|
#
|
594
|
-
# <note markdown="1"> This parameter isn't applicable to jobs running on Fargate
|
592
|
+
# <note markdown="1"> This parameter isn't applicable to jobs that are running on Fargate
|
595
593
|
# resources, and shouldn't be specified.
|
596
594
|
#
|
597
595
|
# </note>
|
@@ -603,17 +601,17 @@ module Aws::Batch
|
|
603
601
|
#
|
604
602
|
# @!attribute [rw] tags
|
605
603
|
# Key-value pair tags to be applied to EC2 resources that are launched
|
606
|
-
# in the compute environment. For
|
604
|
+
# in the compute environment. For Batch, these take the form of
|
607
605
|
# "String1": "String2", where String1 is the tag key and String2
|
608
|
-
# is the tag value−for example,
|
609
|
-
# C4OnDemand"
|
606
|
+
# is the tag value−for example, `\{ "Name": "Batch Instance -
|
607
|
+
# C4OnDemand" \}`. This is helpful for recognizing your Batch
|
610
608
|
# instances in the Amazon EC2 console. These tags can't be updated or
|
611
|
-
# removed after the compute environment
|
612
|
-
# require
|
613
|
-
# compute environment. These tags
|
614
|
-
# Batch `ListTagsForResource` API operation.
|
609
|
+
# removed after the compute environment is created.Aany changes to
|
610
|
+
# these tags require that you create a new compute environment and
|
611
|
+
# remove the old compute environment. These tags aren't seen when
|
612
|
+
# using the Batch `ListTagsForResource` API operation.
|
615
613
|
#
|
616
|
-
# <note markdown="1"> This parameter isn't applicable to jobs running on Fargate
|
614
|
+
# <note markdown="1"> This parameter isn't applicable to jobs that are running on Fargate
|
617
615
|
# resources, and shouldn't be specified.
|
618
616
|
#
|
619
617
|
# </note>
|
@@ -629,7 +627,7 @@ module Aws::Batch
|
|
629
627
|
# potential. For more information, see [Placement Groups][1] in the
|
630
628
|
# *Amazon EC2 User Guide for Linux Instances*.
|
631
629
|
#
|
632
|
-
# <note markdown="1"> This parameter isn't applicable to jobs running on Fargate
|
630
|
+
# <note markdown="1"> This parameter isn't applicable to jobs that are running on Fargate
|
633
631
|
# resources, and shouldn't be specified.
|
634
632
|
#
|
635
633
|
# </note>
|
@@ -649,7 +647,7 @@ module Aws::Batch
|
|
649
647
|
# If you leave this field empty, the default value is 100% of the
|
650
648
|
# On-Demand price.
|
651
649
|
#
|
652
|
-
# <note markdown="1"> This parameter isn't applicable to jobs running on Fargate
|
650
|
+
# <note markdown="1"> This parameter isn't applicable to jobs that are running on Fargate
|
653
651
|
# resources, and shouldn't be specified.
|
654
652
|
#
|
655
653
|
# </note>
|
@@ -660,9 +658,9 @@ module Aws::Batch
|
|
660
658
|
# applied to a `SPOT` compute environment. This role is required if
|
661
659
|
# the allocation strategy set to `BEST_FIT` or if the allocation
|
662
660
|
# strategy isn't specified. For more information, see [Amazon EC2
|
663
|
-
# Spot Fleet Role][1] in the *
|
661
|
+
# Spot Fleet Role][1] in the *Batch User Guide*.
|
664
662
|
#
|
665
|
-
# <note markdown="1"> This parameter isn't applicable to jobs running on Fargate
|
663
|
+
# <note markdown="1"> This parameter isn't applicable to jobs that are running on Fargate
|
666
664
|
# resources, and shouldn't be specified.
|
667
665
|
#
|
668
666
|
# </note>
|
@@ -672,7 +670,7 @@ module Aws::Batch
|
|
672
670
|
# managed policy. The previously recommended
|
673
671
|
# **AmazonEC2SpotFleetRole** managed policy doesn't have the required
|
674
672
|
# permissions to tag Spot Instances. For more information, see [Spot
|
675
|
-
# Instances not tagged on creation][2] in the *
|
673
|
+
# Instances not tagged on creation][2] in the *Batch User Guide*.
|
676
674
|
#
|
677
675
|
#
|
678
676
|
#
|
@@ -686,10 +684,10 @@ module Aws::Batch
|
|
686
684
|
# CreateComputeEnvironment API operation override the same parameters
|
687
685
|
# in the launch template. You must specify either the launch template
|
688
686
|
# ID or launch template name in the request, but not both. For more
|
689
|
-
# information, see [Launch Template Support][1] in the *
|
687
|
+
# information, see [Launch Template Support][1] in the *Batch User
|
690
688
|
# Guide*.
|
691
689
|
#
|
692
|
-
# <note markdown="1"> This parameter isn't applicable to jobs running on Fargate
|
690
|
+
# <note markdown="1"> This parameter isn't applicable to jobs that are running on Fargate
|
693
691
|
# resources, and shouldn't be specified.
|
694
692
|
#
|
695
693
|
# </note>
|
@@ -704,7 +702,7 @@ module Aws::Batch
|
|
704
702
|
# EC2 instances in the compute environment. If `Ec2Configuration`
|
705
703
|
# isn't specified, the default is `ECS_AL1`.
|
706
704
|
#
|
707
|
-
# <note markdown="1"> This parameter isn't applicable to jobs running on Fargate
|
705
|
+
# <note markdown="1"> This parameter isn't applicable to jobs that are running on Fargate
|
708
706
|
# resources, and shouldn't be specified.
|
709
707
|
#
|
710
708
|
# </note>
|
@@ -736,7 +734,7 @@ module Aws::Batch
|
|
736
734
|
|
737
735
|
# An object representing the attributes of a compute environment that
|
738
736
|
# can be updated. For more information, see [Compute Environments][1] in
|
739
|
-
# the *
|
737
|
+
# the *Batch User Guide*.
|
740
738
|
#
|
741
739
|
#
|
742
740
|
#
|
@@ -757,7 +755,7 @@ module Aws::Batch
|
|
757
755
|
# The minimum number of Amazon EC2 vCPUs that an environment should
|
758
756
|
# maintain.
|
759
757
|
#
|
760
|
-
# <note markdown="1"> This parameter isn't applicable to jobs running on Fargate
|
758
|
+
# <note markdown="1"> This parameter isn't applicable to jobs that are running on Fargate
|
761
759
|
# resources, and shouldn't be specified.
|
762
760
|
#
|
763
761
|
# </note>
|
@@ -768,11 +766,11 @@ module Aws::Batch
|
|
768
766
|
# reach.
|
769
767
|
#
|
770
768
|
# <note markdown="1"> With both `BEST_FIT_PROGRESSIVE` and `SPOT_CAPACITY_OPTIMIZED`
|
771
|
-
# allocation strategies,
|
772
|
-
#
|
773
|
-
#
|
774
|
-
#
|
775
|
-
#
|
769
|
+
# allocation strategies, Batch might need to exceed `maxvCpus` to meet
|
770
|
+
# your capacity requirements. In this event, Batch never exceeds
|
771
|
+
# `maxvCpus` by more than a single instance. That is, no more than a
|
772
|
+
# single instance from among those specified in your compute
|
773
|
+
# environment.
|
776
774
|
#
|
777
775
|
# </note>
|
778
776
|
# @return [Integer]
|
@@ -780,20 +778,19 @@ module Aws::Batch
|
|
780
778
|
# @!attribute [rw] desiredv_cpus
|
781
779
|
# The desired number of Amazon EC2 vCPUS in the compute environment.
|
782
780
|
#
|
783
|
-
# <note markdown="1"> This parameter isn't applicable to jobs running on Fargate
|
781
|
+
# <note markdown="1"> This parameter isn't applicable to jobs that are running on Fargate
|
784
782
|
# resources, and shouldn't be specified.
|
785
783
|
#
|
786
784
|
# </note>
|
787
785
|
# @return [Integer]
|
788
786
|
#
|
789
787
|
# @!attribute [rw] subnets
|
790
|
-
# The VPC subnets
|
791
|
-
#
|
792
|
-
#
|
793
|
-
#
|
794
|
-
#
|
795
|
-
#
|
796
|
-
# made.
|
788
|
+
# The VPC subnets where the compute resources are launched. Fargate
|
789
|
+
# compute resources can contain up to 16 subnets. Providing an empty
|
790
|
+
# list will be handled as if this parameter wasn't specified and no
|
791
|
+
# change is made. This can't be specified for EC2 compute resources.
|
792
|
+
# For more information, see [VPCs and Subnets][1] in the *Amazon VPC
|
793
|
+
# User Guide*.
|
797
794
|
#
|
798
795
|
#
|
799
796
|
#
|
@@ -829,19 +826,20 @@ module Aws::Batch
|
|
829
826
|
# @return [String]
|
830
827
|
#
|
831
828
|
# @!attribute [rw] vcpus
|
832
|
-
# The number of vCPUs reserved for the container.
|
833
|
-
# resources can specify the vCPU requirement for the job
|
834
|
-
# `resourceRequirements
|
835
|
-
#
|
836
|
-
# maps to `CpuShares` in the [Create a container][1]
|
837
|
-
# [Docker Remote API][2] and the `--cpu-shares` option
|
838
|
-
# run][3]. Each vCPU is equivalent to 1,024 CPU shares. You
|
839
|
-
# specify at least one vCPU. This is required but can be
|
840
|
-
# several places. It must be specified for each node at
|
841
|
-
#
|
842
|
-
#
|
843
|
-
#
|
844
|
-
#
|
829
|
+
# The number of vCPUs reserved for the container. For jobs that run on
|
830
|
+
# EC2 resources, you can specify the vCPU requirement for the job
|
831
|
+
# using `resourceRequirements`, but you can't specify the vCPU
|
832
|
+
# requirements in both the `vcpus` and `resourceRequirement` object.
|
833
|
+
# This parameter maps to `CpuShares` in the [Create a container][1]
|
834
|
+
# section of the [Docker Remote API][2] and the `--cpu-shares` option
|
835
|
+
# to [docker run][3]. Each vCPU is equivalent to 1,024 CPU shares. You
|
836
|
+
# must specify at least one vCPU. This is required but can be
|
837
|
+
# specified in several places. It must be specified for each node at
|
838
|
+
# least once.
|
839
|
+
#
|
840
|
+
# <note markdown="1"> This parameter isn't applicable to jobs that run on Fargate
|
841
|
+
# resources. For jobs that run on Fargate resources, you must specify
|
842
|
+
# the vCPU requirement for the job using `resourceRequirements`.
|
845
843
|
#
|
846
844
|
# </note>
|
847
845
|
#
|
@@ -869,9 +867,9 @@ module Aws::Batch
|
|
869
867
|
# @return [String]
|
870
868
|
#
|
871
869
|
# @!attribute [rw] execution_role_arn
|
872
|
-
# The Amazon Resource Name (ARN) of the execution role that
|
873
|
-
#
|
874
|
-
#
|
870
|
+
# The Amazon Resource Name (ARN) of the execution role that Batch can
|
871
|
+
# assume. For more information, see [Batch execution IAM role][1] in
|
872
|
+
# the *Batch User Guide*.
|
875
873
|
#
|
876
874
|
#
|
877
875
|
#
|
@@ -886,7 +884,7 @@ module Aws::Batch
|
|
886
884
|
# The environment variables to pass to a container.
|
887
885
|
#
|
888
886
|
# <note markdown="1"> Environment variables must not start with `AWS_BATCH`; this naming
|
889
|
-
# convention is reserved for variables that are set by the
|
887
|
+
# convention is reserved for variables that are set by the Batch
|
890
888
|
# service.
|
891
889
|
#
|
892
890
|
# </note>
|
@@ -914,7 +912,7 @@ module Aws::Batch
|
|
914
912
|
# maps to `Ulimits` in the [Create a container][1] section of the
|
915
913
|
# [Docker Remote API][2] and the `--ulimit` option to [docker run][3].
|
916
914
|
#
|
917
|
-
# <note markdown="1"> This parameter isn't applicable to jobs running on Fargate
|
915
|
+
# <note markdown="1"> This parameter isn't applicable to jobs that are running on Fargate
|
918
916
|
# resources.
|
919
917
|
#
|
920
918
|
# </note>
|
@@ -931,7 +929,7 @@ module Aws::Batch
|
|
931
929
|
# permissions on the host container instance (similar to the `root`
|
932
930
|
# user). The default value is false.
|
933
931
|
#
|
934
|
-
# <note markdown="1"> This parameter isn't applicable to jobs running on Fargate
|
932
|
+
# <note markdown="1"> This parameter isn't applicable to jobs that are running on Fargate
|
935
933
|
# resources and shouldn't be provided, or specified as false.
|
936
934
|
#
|
937
935
|
# </note>
|
@@ -971,16 +969,16 @@ module Aws::Batch
|
|
971
969
|
#
|
972
970
|
# @!attribute [rw] log_stream_name
|
973
971
|
# The name of the CloudWatch Logs log stream associated with the
|
974
|
-
# container. The log group for
|
975
|
-
#
|
976
|
-
#
|
972
|
+
# container. The log group for Batch jobs is `/aws/batch/job`. Each
|
973
|
+
# container attempt receives a log stream name when they reach the
|
974
|
+
# `RUNNING` status.
|
977
975
|
# @return [String]
|
978
976
|
#
|
979
977
|
# @!attribute [rw] instance_type
|
980
978
|
# The instance type of the underlying host infrastructure of a
|
981
979
|
# multi-node parallel job.
|
982
980
|
#
|
983
|
-
# <note markdown="1"> This parameter isn't applicable to jobs running on Fargate
|
981
|
+
# <note markdown="1"> This parameter isn't applicable to jobs that are running on Fargate
|
984
982
|
# resources.
|
985
983
|
#
|
986
984
|
# </note>
|
@@ -1006,7 +1004,7 @@ module Aws::Batch
|
|
1006
1004
|
# This parameter maps to `LogConfig` in the [Create a container][1]
|
1007
1005
|
# section of the [Docker Remote API][2] and the `--log-driver` option
|
1008
1006
|
# to [docker run][3]. By default, containers use the same logging
|
1009
|
-
# driver that the Docker daemon uses. However the container might use
|
1007
|
+
# driver that the Docker daemon uses. However, the container might use
|
1010
1008
|
# a different logging driver than the Docker daemon by specifying a
|
1011
1009
|
# log driver with this parameter in the container definition. To use a
|
1012
1010
|
# different logging driver for a container, the log system must be
|
@@ -1016,10 +1014,10 @@ module Aws::Batch
|
|
1016
1014
|
# log drivers, see [Configure logging drivers][4] in the Docker
|
1017
1015
|
# documentation.
|
1018
1016
|
#
|
1019
|
-
# <note markdown="1">
|
1020
|
-
#
|
1021
|
-
#
|
1022
|
-
#
|
1017
|
+
# <note markdown="1"> Batch currently supports a subset of the logging drivers available
|
1018
|
+
# to the Docker daemon (shown in the LogConfiguration data type).
|
1019
|
+
# Additional log drivers might be available in future releases of the
|
1020
|
+
# Amazon ECS container agent.
|
1023
1021
|
#
|
1024
1022
|
# </note>
|
1025
1023
|
#
|
@@ -1050,7 +1048,7 @@ module Aws::Batch
|
|
1050
1048
|
#
|
1051
1049
|
# @!attribute [rw] secrets
|
1052
1050
|
# The secrets to pass to the container. For more information, see
|
1053
|
-
# [Specifying sensitive data][1] in the *
|
1051
|
+
# [Specifying sensitive data][1] in the *Batch User Guide*.
|
1054
1052
|
#
|
1055
1053
|
#
|
1056
1054
|
#
|
@@ -1058,13 +1056,15 @@ module Aws::Batch
|
|
1058
1056
|
# @return [Array<Types::Secret>]
|
1059
1057
|
#
|
1060
1058
|
# @!attribute [rw] network_configuration
|
1061
|
-
# The network configuration for jobs running on Fargate
|
1062
|
-
# Jobs running on EC2 resources must not specify
|
1059
|
+
# The network configuration for jobs that are running on Fargate
|
1060
|
+
# resources. Jobs that are running on EC2 resources must not specify
|
1061
|
+
# this parameter.
|
1063
1062
|
# @return [Types::NetworkConfiguration]
|
1064
1063
|
#
|
1065
1064
|
# @!attribute [rw] fargate_platform_configuration
|
1066
|
-
# The platform configuration for jobs running on Fargate
|
1067
|
-
# Jobs running on EC2 resources must not specify
|
1065
|
+
# The platform configuration for jobs that are running on Fargate
|
1066
|
+
# resources. Jobs that are running on EC2 resources must not specify
|
1067
|
+
# this parameter.
|
1068
1068
|
# @return [Types::FargatePlatformConfiguration]
|
1069
1069
|
#
|
1070
1070
|
# @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/ContainerDetail AWS API Documentation
|
@@ -1125,22 +1125,25 @@ module Aws::Batch
|
|
1125
1125
|
# }
|
1126
1126
|
#
|
1127
1127
|
# @!attribute [rw] vcpus
|
1128
|
-
# This parameter
|
1129
|
-
#
|
1130
|
-
#
|
1131
|
-
#
|
1132
|
-
#
|
1133
|
-
# `
|
1134
|
-
#
|
1135
|
-
# `
|
1136
|
-
#
|
1137
|
-
#
|
1138
|
-
#
|
1139
|
-
#
|
1140
|
-
#
|
1141
|
-
#
|
1142
|
-
#
|
1143
|
-
#
|
1128
|
+
# This parameter indicates the number of vCPUs reserved for the
|
1129
|
+
# container.It overrides the `vcpus` parameter that's set in the job
|
1130
|
+
# definition, but doesn't override any vCPU requirement specified in
|
1131
|
+
# the `resourceRequirement` structure in the job definition. To
|
1132
|
+
# override vCPU requirements that are specified in the
|
1133
|
+
# `ResourceRequirement` structure in the job definition,
|
1134
|
+
# `ResourceRequirement` must be specified in the `SubmitJob` request,
|
1135
|
+
# with `type` set to `VCPU` and `value` set to the new value.
|
1136
|
+
#
|
1137
|
+
# This parameter maps to `CpuShares` in the [Create a container][1]
|
1138
|
+
# section of the [Docker Remote API][2] and the `--cpu-shares` option
|
1139
|
+
# to [docker run][3]. Each vCPU is equivalent to 1,024 CPU shares. You
|
1140
|
+
# must specify at least one vCPU.
|
1141
|
+
#
|
1142
|
+
# <note markdown="1"> This parameter is supported for jobs that run on EC2 resources, but
|
1143
|
+
# isn't supported for jobs that run on Fargate resources. For Fargate
|
1144
|
+
# resources, you can only use `resourceRequirement`. For EC2
|
1145
|
+
# resources, you can use either this parameter or
|
1146
|
+
# `resourceRequirement` but not both.
|
1144
1147
|
#
|
1145
1148
|
# </note>
|
1146
1149
|
#
|
@@ -1152,10 +1155,18 @@ module Aws::Batch
|
|
1152
1155
|
# @return [Integer]
|
1153
1156
|
#
|
1154
1157
|
# @!attribute [rw] memory
|
1155
|
-
# This parameter
|
1156
|
-
#
|
1157
|
-
#
|
1158
|
-
#
|
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. To override memory requirements that are specified in
|
1163
|
+
# the `ResourceRequirement` structure in the job definition,
|
1164
|
+
# `ResourceRequirement` must be specified in the `SubmitJob` request,
|
1165
|
+
# with `type` set to `MEMORY` and `value` set to the new value.
|
1166
|
+
#
|
1167
|
+
# This parameter is supported for jobs that run on EC2 resources, but
|
1168
|
+
# isn't supported for jobs that run on Fargate resources. For these
|
1169
|
+
# resources, use `resourceRequirement` instead.
|
1159
1170
|
# @return [Integer]
|
1160
1171
|
#
|
1161
1172
|
# @!attribute [rw] command
|
@@ -1167,7 +1178,7 @@ module Aws::Batch
|
|
1167
1178
|
# The instance type to use for a multi-node parallel job.
|
1168
1179
|
#
|
1169
1180
|
# <note markdown="1"> This parameter isn't applicable to single-node container jobs or
|
1170
|
-
#
|
1181
|
+
# jobs that run on Fargate resources, and shouldn't be provided.
|
1171
1182
|
#
|
1172
1183
|
# </note>
|
1173
1184
|
# @return [String]
|
@@ -1179,7 +1190,7 @@ module Aws::Batch
|
|
1179
1190
|
# Docker image or the job definition.
|
1180
1191
|
#
|
1181
1192
|
# <note markdown="1"> Environment variables must not start with `AWS_BATCH`; this naming
|
1182
|
-
# convention is reserved for variables that are set by the
|
1193
|
+
# convention is reserved for variables that are set by the Batch
|
1183
1194
|
# service.
|
1184
1195
|
#
|
1185
1196
|
# </note>
|
@@ -1223,6 +1234,16 @@ module Aws::Batch
|
|
1223
1234
|
# source_path: "String",
|
1224
1235
|
# },
|
1225
1236
|
# name: "String",
|
1237
|
+
# efs_volume_configuration: {
|
1238
|
+
# file_system_id: "String", # required
|
1239
|
+
# root_directory: "String",
|
1240
|
+
# transit_encryption: "ENABLED", # accepts ENABLED, DISABLED
|
1241
|
+
# transit_encryption_port: 1,
|
1242
|
+
# authorization_config: {
|
1243
|
+
# access_point_id: "String",
|
1244
|
+
# iam: "ENABLED", # accepts ENABLED, DISABLED
|
1245
|
+
# },
|
1246
|
+
# },
|
1226
1247
|
# },
|
1227
1248
|
# ],
|
1228
1249
|
# environment: [
|
@@ -1338,21 +1359,21 @@ module Aws::Batch
|
|
1338
1359
|
# @return [String]
|
1339
1360
|
#
|
1340
1361
|
# @!attribute [rw] vcpus
|
1341
|
-
#
|
1342
|
-
#
|
1343
|
-
#
|
1344
|
-
#
|
1345
|
-
#
|
1346
|
-
#
|
1347
|
-
#
|
1348
|
-
#
|
1349
|
-
#
|
1350
|
-
#
|
1351
|
-
#
|
1352
|
-
#
|
1353
|
-
# <note markdown="1"> This parameter isn't applicable to jobs running on Fargate
|
1354
|
-
# resources and shouldn't be provided.
|
1355
|
-
# resources must specify the vCPU requirement for the job using
|
1362
|
+
# The number of vCPUs reserved for the job. Each vCPU is equivalent to
|
1363
|
+
# 1,024 CPU shares. This parameter maps to `CpuShares` in the [Create
|
1364
|
+
# a container][1] section of the [Docker Remote API][2] and the
|
1365
|
+
# `--cpu-shares` option to [docker run][3]. The number of vCPUs must
|
1366
|
+
# be specified but can be specified in several places. You must
|
1367
|
+
# specify it at least once for each node.
|
1368
|
+
#
|
1369
|
+
# This parameter is supported on EC2 resources but isn't supported
|
1370
|
+
# for jobs that run on Fargate resources. For these resources, use
|
1371
|
+
# `resourceRequirement` instead. You can use this parameter or
|
1372
|
+
# `resourceRequirements` structure but not both.
|
1373
|
+
#
|
1374
|
+
# <note markdown="1"> This parameter isn't applicable to jobs that are running on Fargate
|
1375
|
+
# resources and shouldn't be provided. For jobs that run on Fargate
|
1376
|
+
# resources, you must specify the vCPU requirement for the job using
|
1356
1377
|
# `resourceRequirements`.
|
1357
1378
|
#
|
1358
1379
|
# </note>
|
@@ -1365,21 +1386,25 @@ module Aws::Batch
|
|
1365
1386
|
# @return [Integer]
|
1366
1387
|
#
|
1367
1388
|
# @!attribute [rw] memory
|
1368
|
-
# This parameter
|
1369
|
-
#
|
1370
|
-
#
|
1371
|
-
#
|
1372
|
-
#
|
1373
|
-
#
|
1374
|
-
#
|
1375
|
-
#
|
1376
|
-
#
|
1377
|
-
#
|
1378
|
-
#
|
1389
|
+
# This parameter indicates the memory hard limit (in MiB) for a
|
1390
|
+
# container. If your container attempts to exceed the specified
|
1391
|
+
# number, it's terminated. You must specify at least 4 MiB of memory
|
1392
|
+
# for a job using this parameter. The memory hard limit can be
|
1393
|
+
# specified in several places. It must be specified for each node at
|
1394
|
+
# least once.
|
1395
|
+
#
|
1396
|
+
# This parameter maps to `Memory` in the [Create a container][1]
|
1397
|
+
# section of the [Docker Remote API][2] and the `--memory` option to
|
1398
|
+
# [docker run][3].
|
1399
|
+
#
|
1400
|
+
# This parameter is supported on EC2 resources but isn't supported on
|
1401
|
+
# Fargate resources. For Fargate resources, you should specify the
|
1402
|
+
# memory requirement using `resourceRequirement`. You can also do this
|
1403
|
+
# for EC2 resources.
|
1379
1404
|
#
|
1380
1405
|
# <note markdown="1"> If you're trying to maximize your resource utilization by providing
|
1381
1406
|
# your jobs as much memory as possible for a particular instance type,
|
1382
|
-
# see [Memory Management][4] in the *
|
1407
|
+
# see [Memory Management][4] in the *Batch User Guide*.
|
1383
1408
|
#
|
1384
1409
|
# </note>
|
1385
1410
|
#
|
@@ -1408,9 +1433,9 @@ module Aws::Batch
|
|
1408
1433
|
#
|
1409
1434
|
# @!attribute [rw] job_role_arn
|
1410
1435
|
# The Amazon Resource Name (ARN) of the IAM role that the container
|
1411
|
-
# can assume for
|
1412
|
-
# for Tasks][1] in the *Amazon Elastic
|
1413
|
-
# Guide*.
|
1436
|
+
# can assume for Amazon Web Services permissions. For more
|
1437
|
+
# information, see [IAM Roles for Tasks][1] in the *Amazon Elastic
|
1438
|
+
# Container Service Developer Guide*.
|
1414
1439
|
#
|
1415
1440
|
#
|
1416
1441
|
#
|
@@ -1418,10 +1443,10 @@ module Aws::Batch
|
|
1418
1443
|
# @return [String]
|
1419
1444
|
#
|
1420
1445
|
# @!attribute [rw] execution_role_arn
|
1421
|
-
# The Amazon Resource Name (ARN) of the execution role that
|
1422
|
-
#
|
1423
|
-
# execution role. For more information, see [
|
1424
|
-
# role][1] in the *
|
1446
|
+
# The Amazon Resource Name (ARN) of the execution role that Batch can
|
1447
|
+
# assume. For jobs that run on Fargate resources, you must provide an
|
1448
|
+
# execution role. For more information, see [Batch execution IAM
|
1449
|
+
# role][1] in the *Batch User Guide*.
|
1425
1450
|
#
|
1426
1451
|
#
|
1427
1452
|
#
|
@@ -1441,7 +1466,7 @@ module Aws::Batch
|
|
1441
1466
|
# sensitive information, such as credential data.
|
1442
1467
|
#
|
1443
1468
|
# <note markdown="1"> Environment variables must not start with `AWS_BATCH`; this naming
|
1444
|
-
# convention is reserved for variables that are set by the
|
1469
|
+
# convention is reserved for variables that are set by the Batch
|
1445
1470
|
# service.
|
1446
1471
|
#
|
1447
1472
|
# </note>
|
@@ -1485,7 +1510,7 @@ module Aws::Batch
|
|
1485
1510
|
# `--privileged` option to [docker run][3]. The default value is
|
1486
1511
|
# false.
|
1487
1512
|
#
|
1488
|
-
# <note markdown="1"> This parameter isn't applicable to jobs running on Fargate
|
1513
|
+
# <note markdown="1"> This parameter isn't applicable to jobs that are running on Fargate
|
1489
1514
|
# resources and shouldn't be provided, or specified as false.
|
1490
1515
|
#
|
1491
1516
|
# </note>
|
@@ -1502,7 +1527,7 @@ module Aws::Batch
|
|
1502
1527
|
# `Ulimits` in the [Create a container][1] section of the [Docker
|
1503
1528
|
# Remote API][2] and the `--ulimit` option to [docker run][3].
|
1504
1529
|
#
|
1505
|
-
# <note markdown="1"> This parameter isn't applicable to jobs running on Fargate
|
1530
|
+
# <note markdown="1"> This parameter isn't applicable to jobs that are running on Fargate
|
1506
1531
|
# resources and shouldn't be provided.
|
1507
1532
|
#
|
1508
1533
|
# </note>
|
@@ -1531,7 +1556,7 @@ module Aws::Batch
|
|
1531
1556
|
# groups in a multi-node parallel job must use the same instance type.
|
1532
1557
|
#
|
1533
1558
|
# <note markdown="1"> This parameter isn't applicable to single-node container jobs or
|
1534
|
-
#
|
1559
|
+
# jobs that run on Fargate resources, and shouldn't be provided.
|
1535
1560
|
#
|
1536
1561
|
# </note>
|
1537
1562
|
# @return [String]
|
@@ -1561,9 +1586,8 @@ module Aws::Batch
|
|
1561
1586
|
# options for different supported log drivers, see [Configure logging
|
1562
1587
|
# drivers][4] in the Docker documentation.
|
1563
1588
|
#
|
1564
|
-
# <note markdown="1">
|
1565
|
-
#
|
1566
|
-
# type).
|
1589
|
+
# <note markdown="1"> Batch currently supports a subset of the logging drivers available
|
1590
|
+
# to the Docker daemon (shown in the LogConfiguration data type).
|
1567
1591
|
#
|
1568
1592
|
# </note>
|
1569
1593
|
#
|
@@ -1594,7 +1618,7 @@ module Aws::Batch
|
|
1594
1618
|
#
|
1595
1619
|
# @!attribute [rw] secrets
|
1596
1620
|
# The secrets for the container. For more information, see [Specifying
|
1597
|
-
# sensitive data][1] in the *
|
1621
|
+
# sensitive data][1] in the *Batch User Guide*.
|
1598
1622
|
#
|
1599
1623
|
#
|
1600
1624
|
#
|
@@ -1602,13 +1626,15 @@ module Aws::Batch
|
|
1602
1626
|
# @return [Array<Types::Secret>]
|
1603
1627
|
#
|
1604
1628
|
# @!attribute [rw] network_configuration
|
1605
|
-
# The network configuration for jobs running on Fargate
|
1606
|
-
# Jobs running on EC2 resources must not specify
|
1629
|
+
# The network configuration for jobs that are running on Fargate
|
1630
|
+
# resources. Jobs that are running on EC2 resources must not specify
|
1631
|
+
# this parameter.
|
1607
1632
|
# @return [Types::NetworkConfiguration]
|
1608
1633
|
#
|
1609
1634
|
# @!attribute [rw] fargate_platform_configuration
|
1610
|
-
# The platform configuration for jobs running on Fargate
|
1611
|
-
# Jobs running on EC2 resources must not specify
|
1635
|
+
# The platform configuration for jobs that are running on Fargate
|
1636
|
+
# resources. Jobs that are running on EC2 resources must not specify
|
1637
|
+
# this parameter.
|
1612
1638
|
# @return [Types::FargatePlatformConfiguration]
|
1613
1639
|
#
|
1614
1640
|
# @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/ContainerProperties AWS API Documentation
|
@@ -1697,7 +1723,7 @@ module Aws::Batch
|
|
1697
1723
|
# },
|
1698
1724
|
# ],
|
1699
1725
|
# },
|
1700
|
-
# service_role: "String",
|
1726
|
+
# service_role: "String",
|
1701
1727
|
# tags: {
|
1702
1728
|
# "TagKey" => "TagValue",
|
1703
1729
|
# },
|
@@ -1710,8 +1736,8 @@ module Aws::Batch
|
|
1710
1736
|
#
|
1711
1737
|
# @!attribute [rw] type
|
1712
1738
|
# The type of the compute environment: `MANAGED` or `UNMANAGED`. For
|
1713
|
-
# more information, see [Compute Environments][1] in the *
|
1714
|
-
#
|
1739
|
+
# more information, see [Compute Environments][1] in the *Batch User
|
1740
|
+
# Guide*.
|
1715
1741
|
#
|
1716
1742
|
#
|
1717
1743
|
#
|
@@ -1723,13 +1749,13 @@ module Aws::Batch
|
|
1723
1749
|
# then the compute environment accepts jobs from a queue and can scale
|
1724
1750
|
# out automatically based on queues.
|
1725
1751
|
#
|
1726
|
-
# If the state is `ENABLED`, then the
|
1727
|
-
#
|
1752
|
+
# If the state is `ENABLED`, then the Batch scheduler can attempt to
|
1753
|
+
# place jobs from an associated job queue on the compute resources
|
1728
1754
|
# within the environment. If the compute environment is managed, then
|
1729
1755
|
# it can scale its instances out or in automatically, based on the job
|
1730
1756
|
# queue demand.
|
1731
1757
|
#
|
1732
|
-
# If the state is `DISABLED`, then the
|
1758
|
+
# If the state is `DISABLED`, then the Batch scheduler doesn't
|
1733
1759
|
# attempt to place jobs within the environment. Jobs in a `STARTING`
|
1734
1760
|
# or `RUNNING` state continue to progress normally. Managed compute
|
1735
1761
|
# environments in the `DISABLED` state don't scale out. However, they
|
@@ -1740,7 +1766,7 @@ module Aws::Batch
|
|
1740
1766
|
# Details about the compute resources managed by the compute
|
1741
1767
|
# environment. This parameter is required for managed compute
|
1742
1768
|
# environments. For more information, see [Compute Environments][1] in
|
1743
|
-
# the *
|
1769
|
+
# the *Batch User Guide*.
|
1744
1770
|
#
|
1745
1771
|
#
|
1746
1772
|
#
|
@@ -1748,34 +1774,45 @@ module Aws::Batch
|
|
1748
1774
|
# @return [Types::ComputeResource]
|
1749
1775
|
#
|
1750
1776
|
# @!attribute [rw] service_role
|
1751
|
-
# The full Amazon Resource Name (ARN) of the IAM role that allows
|
1752
|
-
# Batch to make calls to other
|
1753
|
-
# information, see [
|
1754
|
-
# User Guide*.
|
1777
|
+
# The full Amazon Resource Name (ARN) of the IAM role that allows
|
1778
|
+
# Batch to make calls to other Amazon Web Services services on your
|
1779
|
+
# behalf. For more information, see [Batch service IAM role][1] in the
|
1780
|
+
# *Batch User Guide*.
|
1781
|
+
#
|
1782
|
+
# If your account already created the Batch service-linked role, that
|
1783
|
+
# role is used by default for your compute environment unless you
|
1784
|
+
# specify a different role here. If the Batch service-linked role
|
1785
|
+
# doesn't exist in your account, and no role is specified here, the
|
1786
|
+
# service attempts to create the Batch service-linked role in your
|
1787
|
+
# account.
|
1755
1788
|
#
|
1756
1789
|
# If your specified role has a path other than `/`, then you must
|
1757
|
-
# either
|
1758
|
-
#
|
1790
|
+
# specify either the full role ARN (recommended) or prefix the role
|
1791
|
+
# name with the path. For example, if a role with the name `bar` has a
|
1792
|
+
# path of `/foo/` then you would specify `/foo/bar` as the role name.
|
1793
|
+
# For more information, see [Friendly names and paths][2] in the *IAM
|
1794
|
+
# User Guide*.
|
1759
1795
|
#
|
1760
|
-
# <note markdown="1"> Depending on how you created your
|
1761
|
-
#
|
1762
|
-
#
|
1763
|
-
#
|
1764
|
-
#
|
1765
|
-
#
|
1796
|
+
# <note markdown="1"> Depending on how you created your Batch service role, its ARN might
|
1797
|
+
# contain the `service-role` path prefix. When you only specify the
|
1798
|
+
# name of the service role, Batch assumes that your ARN doesn't use
|
1799
|
+
# the `service-role` path prefix. Because of this, we recommend that
|
1800
|
+
# you specify the full ARN of your service role when you create
|
1801
|
+
# compute environments.
|
1766
1802
|
#
|
1767
1803
|
# </note>
|
1768
1804
|
#
|
1769
1805
|
#
|
1770
1806
|
#
|
1771
1807
|
# [1]: https://docs.aws.amazon.com/batch/latest/userguide/service_IAM_role.html
|
1808
|
+
# [2]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html#identifiers-friendly-names
|
1772
1809
|
# @return [String]
|
1773
1810
|
#
|
1774
1811
|
# @!attribute [rw] tags
|
1775
1812
|
# The tags that you apply to the compute environment to help you
|
1776
1813
|
# categorize and organize your resources. Each tag consists of a key
|
1777
|
-
# and an optional value. For more information, see [Tagging
|
1778
|
-
# Resources][1] in *
|
1814
|
+
# and an optional value. For more information, see [Tagging Amazon Web
|
1815
|
+
# Services Resources][1] in *Amazon Web Services General Reference*.
|
1779
1816
|
#
|
1780
1817
|
# These tags can be updated or removed using the [TagResource][2] and
|
1781
1818
|
# [UntagResource][3] API operations. These tags don't propagate to
|
@@ -1859,7 +1896,7 @@ module Aws::Batch
|
|
1859
1896
|
# priority value of `10` is given scheduling preference over a job
|
1860
1897
|
# queue with a priority value of `1`. All of the compute environments
|
1861
1898
|
# must be either EC2 (`EC2` or `SPOT`) or Fargate (`FARGATE` or
|
1862
|
-
# `FARGATE_SPOT`); EC2 and Fargate compute environments
|
1899
|
+
# `FARGATE_SPOT`); EC2 and Fargate compute environments can't be
|
1863
1900
|
# mixed.
|
1864
1901
|
# @return [Integer]
|
1865
1902
|
#
|
@@ -1875,8 +1912,8 @@ module Aws::Batch
|
|
1875
1912
|
# can't be mixed.
|
1876
1913
|
#
|
1877
1914
|
# <note markdown="1"> All compute environments that are associated with a job queue must
|
1878
|
-
# share the same architecture.
|
1879
|
-
#
|
1915
|
+
# share the same architecture. Batch doesn't support mixing compute
|
1916
|
+
# environment architecture types in a single job queue.
|
1880
1917
|
#
|
1881
1918
|
# </note>
|
1882
1919
|
# @return [Array<Types::ComputeEnvironmentOrder>]
|
@@ -1884,8 +1921,8 @@ module Aws::Batch
|
|
1884
1921
|
# @!attribute [rw] tags
|
1885
1922
|
# The tags that you apply to the job queue to help you categorize and
|
1886
1923
|
# organize your resources. Each tag consists of a key and an optional
|
1887
|
-
# value. For more information, see [Tagging your
|
1888
|
-
#
|
1924
|
+
# value. For more information, see [Tagging your Batch resources][1]
|
1925
|
+
# in *Batch User Guide*.
|
1889
1926
|
#
|
1890
1927
|
#
|
1891
1928
|
#
|
@@ -2086,15 +2123,18 @@ module Aws::Batch
|
|
2086
2123
|
# }
|
2087
2124
|
#
|
2088
2125
|
# @!attribute [rw] job_definitions
|
2089
|
-
# A list of up to 100 job
|
2090
|
-
#
|
2126
|
+
# A list of up to 100 job definitions. Each entry in the list can
|
2127
|
+
# either be an ARN of the form
|
2128
|
+
# `arn:aws:batch:$\{Region\}:$\{Account\}:job-definition/$\{JobDefinitionName\}:$\{Revision\}`
|
2129
|
+
# or a short version using the form
|
2130
|
+
# `$\{JobDefinitionName\}:$\{Revision\}`.
|
2091
2131
|
# @return [Array<String>]
|
2092
2132
|
#
|
2093
2133
|
# @!attribute [rw] max_results
|
2094
2134
|
# The maximum number of results returned by `DescribeJobDefinitions`
|
2095
2135
|
# in paginated output. When this parameter is used,
|
2096
2136
|
# `DescribeJobDefinitions` only returns `maxResults` results in a
|
2097
|
-
# single page
|
2137
|
+
# single page and a `nextToken` response element. The remaining
|
2098
2138
|
# results of the initial request can be seen by sending another
|
2099
2139
|
# `DescribeJobDefinitions` request with the returned `nextToken`
|
2100
2140
|
# value. This value can be between 1 and 100. If this parameter isn't
|
@@ -2177,12 +2217,12 @@ module Aws::Batch
|
|
2177
2217
|
# @!attribute [rw] max_results
|
2178
2218
|
# The maximum number of results returned by `DescribeJobQueues` in
|
2179
2219
|
# paginated output. When this parameter is used, `DescribeJobQueues`
|
2180
|
-
# only returns `maxResults` results in a single page
|
2181
|
-
#
|
2182
|
-
#
|
2183
|
-
#
|
2184
|
-
#
|
2185
|
-
#
|
2220
|
+
# only returns `maxResults` results in a single page and a `nextToken`
|
2221
|
+
# response element. The remaining results of the initial request can
|
2222
|
+
# be seen by sending another `DescribeJobQueues` request with the
|
2223
|
+
# returned `nextToken` value. This value can be between 1 and 100. If
|
2224
|
+
# this parameter isn't used, then `DescribeJobQueues` returns up to
|
2225
|
+
# 100 results and a `nextToken` value if applicable.
|
2186
2226
|
# @return [Integer]
|
2187
2227
|
#
|
2188
2228
|
# @!attribute [rw] next_token
|
@@ -2266,8 +2306,8 @@ module Aws::Batch
|
|
2266
2306
|
|
2267
2307
|
# An object representing a container instance host device.
|
2268
2308
|
#
|
2269
|
-
# <note markdown="1"> This object isn't applicable to jobs running on Fargate
|
2270
|
-
# shouldn't be provided.
|
2309
|
+
# <note markdown="1"> This object isn't applicable to jobs that are running on Fargate
|
2310
|
+
# resources and shouldn't be provided.
|
2271
2311
|
#
|
2272
2312
|
# </note>
|
2273
2313
|
#
|
@@ -2285,8 +2325,8 @@ module Aws::Batch
|
|
2285
2325
|
# @return [String]
|
2286
2326
|
#
|
2287
2327
|
# @!attribute [rw] container_path
|
2288
|
-
# The path inside the container used to expose the host
|
2289
|
-
# default the `hostPath` value is used.
|
2328
|
+
# The path inside the container that's used to expose the host
|
2329
|
+
# device. By default, the `hostPath` value is used.
|
2290
2330
|
# @return [String]
|
2291
2331
|
#
|
2292
2332
|
# @!attribute [rw] permissions
|
@@ -2305,14 +2345,153 @@ module Aws::Batch
|
|
2305
2345
|
include Aws::Structure
|
2306
2346
|
end
|
2307
2347
|
|
2348
|
+
# The authorization configuration details for the Amazon EFS file
|
2349
|
+
# system.
|
2350
|
+
#
|
2351
|
+
# @note When making an API call, you may pass EFSAuthorizationConfig
|
2352
|
+
# data as a hash:
|
2353
|
+
#
|
2354
|
+
# {
|
2355
|
+
# access_point_id: "String",
|
2356
|
+
# iam: "ENABLED", # accepts ENABLED, DISABLED
|
2357
|
+
# }
|
2358
|
+
#
|
2359
|
+
# @!attribute [rw] access_point_id
|
2360
|
+
# The Amazon EFS access point ID to use. If an access point is
|
2361
|
+
# specified, the root directory value specified in the
|
2362
|
+
# `EFSVolumeConfiguration` must either be omitted or set to `/` which
|
2363
|
+
# will enforce the path set on the EFS access point. If an access
|
2364
|
+
# point is used, transit encryption must be enabled in the
|
2365
|
+
# `EFSVolumeConfiguration`. For more information, see [Working with
|
2366
|
+
# Amazon EFS Access Points][1] in the *Amazon Elastic File System User
|
2367
|
+
# Guide*.
|
2368
|
+
#
|
2369
|
+
#
|
2370
|
+
#
|
2371
|
+
# [1]: https://docs.aws.amazon.com/efs/latest/ug/efs-access-points.html
|
2372
|
+
# @return [String]
|
2373
|
+
#
|
2374
|
+
# @!attribute [rw] iam
|
2375
|
+
# Whether or not to use the Batch job IAM role defined in a job
|
2376
|
+
# definition when mounting the Amazon EFS file system. If enabled,
|
2377
|
+
# transit encryption must be enabled in the `EFSVolumeConfiguration`.
|
2378
|
+
# If this parameter is omitted, the default value of `DISABLED` is
|
2379
|
+
# used. For more information, see [Using Amazon EFS Access Points][1]
|
2380
|
+
# in the *Batch User Guide*. EFS IAM authorization requires that
|
2381
|
+
# `TransitEncryption` be `ENABLED` and that a `JobRoleArn` is
|
2382
|
+
# specified.
|
2383
|
+
#
|
2384
|
+
#
|
2385
|
+
#
|
2386
|
+
# [1]: https://docs.aws.amazon.com/batch/latest/userguide/efs-volumes.html#efs-volume-accesspoints
|
2387
|
+
# @return [String]
|
2388
|
+
#
|
2389
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/EFSAuthorizationConfig AWS API Documentation
|
2390
|
+
#
|
2391
|
+
class EFSAuthorizationConfig < Struct.new(
|
2392
|
+
:access_point_id,
|
2393
|
+
:iam)
|
2394
|
+
SENSITIVE = []
|
2395
|
+
include Aws::Structure
|
2396
|
+
end
|
2397
|
+
|
2398
|
+
# This is used when you're using an Amazon Elastic File System file
|
2399
|
+
# system for job storage. For more information, see [Amazon EFS
|
2400
|
+
# Volumes][1] in the *Batch User Guide*.
|
2401
|
+
#
|
2402
|
+
#
|
2403
|
+
#
|
2404
|
+
# [1]: https://docs.aws.amazon.com/batch/latest/userguide/efs-volumes.html
|
2405
|
+
#
|
2406
|
+
# @note When making an API call, you may pass EFSVolumeConfiguration
|
2407
|
+
# data as a hash:
|
2408
|
+
#
|
2409
|
+
# {
|
2410
|
+
# file_system_id: "String", # required
|
2411
|
+
# root_directory: "String",
|
2412
|
+
# transit_encryption: "ENABLED", # accepts ENABLED, DISABLED
|
2413
|
+
# transit_encryption_port: 1,
|
2414
|
+
# authorization_config: {
|
2415
|
+
# access_point_id: "String",
|
2416
|
+
# iam: "ENABLED", # accepts ENABLED, DISABLED
|
2417
|
+
# },
|
2418
|
+
# }
|
2419
|
+
#
|
2420
|
+
# @!attribute [rw] file_system_id
|
2421
|
+
# The Amazon EFS file system ID to use.
|
2422
|
+
# @return [String]
|
2423
|
+
#
|
2424
|
+
# @!attribute [rw] root_directory
|
2425
|
+
# The directory within the Amazon EFS file system to mount as the root
|
2426
|
+
# directory inside the host. If this parameter is omitted, the root of
|
2427
|
+
# the Amazon EFS volume is used instead. Specifying `/` has the same
|
2428
|
+
# effect as omitting this parameter. The maximum length is 4,096
|
2429
|
+
# characters.
|
2430
|
+
#
|
2431
|
+
# If an EFS access point is specified in the `authorizationConfig`,
|
2432
|
+
# the root directory parameter must either be omitted or set to `/`,
|
2433
|
+
# which enforces the path set on the Amazon EFS access point.
|
2434
|
+
# @return [String]
|
2435
|
+
#
|
2436
|
+
# @!attribute [rw] transit_encryption
|
2437
|
+
# Determines whether to enable encryption for Amazon EFS data in
|
2438
|
+
# transit between the Amazon ECS host and the Amazon EFS server.
|
2439
|
+
# Transit encryption must be enabled if Amazon EFS IAM authorization
|
2440
|
+
# is used. If this parameter is omitted, the default value of
|
2441
|
+
# `DISABLED` is used. For more information, see [Encrypting data in
|
2442
|
+
# transit][1] in the *Amazon Elastic File System User Guide*.
|
2443
|
+
#
|
2444
|
+
#
|
2445
|
+
#
|
2446
|
+
# [1]: https://docs.aws.amazon.com/efs/latest/ug/encryption-in-transit.html
|
2447
|
+
# @return [String]
|
2448
|
+
#
|
2449
|
+
# @!attribute [rw] transit_encryption_port
|
2450
|
+
# The port to use when sending encrypted data between the Amazon ECS
|
2451
|
+
# host and the Amazon EFS server. If you don't specify a transit
|
2452
|
+
# encryption port, it uses the port selection strategy that the Amazon
|
2453
|
+
# EFS mount helper uses. The value must be between 0 and 65,535. For
|
2454
|
+
# more information, see [EFS Mount Helper][1] in the *Amazon Elastic
|
2455
|
+
# File System User Guide*.
|
2456
|
+
#
|
2457
|
+
#
|
2458
|
+
#
|
2459
|
+
# [1]: https://docs.aws.amazon.com/efs/latest/ug/efs-mount-helper.html
|
2460
|
+
# @return [Integer]
|
2461
|
+
#
|
2462
|
+
# @!attribute [rw] authorization_config
|
2463
|
+
# The authorization configuration details for the Amazon EFS file
|
2464
|
+
# system.
|
2465
|
+
# @return [Types::EFSAuthorizationConfig]
|
2466
|
+
#
|
2467
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/EFSVolumeConfiguration AWS API Documentation
|
2468
|
+
#
|
2469
|
+
class EFSVolumeConfiguration < Struct.new(
|
2470
|
+
:file_system_id,
|
2471
|
+
:root_directory,
|
2472
|
+
:transit_encryption,
|
2473
|
+
:transit_encryption_port,
|
2474
|
+
:authorization_config)
|
2475
|
+
SENSITIVE = []
|
2476
|
+
include Aws::Structure
|
2477
|
+
end
|
2478
|
+
|
2308
2479
|
# Provides information used to select Amazon Machine Images (AMIs) for
|
2309
|
-
# instances in the compute environment. If
|
2310
|
-
# specified, the default is `ECS_AL1
|
2480
|
+
# instances in the compute environment. If `Ec2Configuration` isn't
|
2481
|
+
# specified, the default is currently `ECS_AL1` ([Amazon Linux][1]) for
|
2482
|
+
# non-GPU, non AWSGraviton instances. Starting on March 31, 2021, this
|
2483
|
+
# default will be changing to `ECS_AL2` ([Amazon Linux 2][2]).
|
2311
2484
|
#
|
2312
|
-
# <note markdown="1"> This object isn't applicable to jobs running on Fargate
|
2485
|
+
# <note markdown="1"> This object isn't applicable to jobs that are running on Fargate
|
2486
|
+
# resources.
|
2313
2487
|
#
|
2314
2488
|
# </note>
|
2315
2489
|
#
|
2490
|
+
#
|
2491
|
+
#
|
2492
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html#alami
|
2493
|
+
# [2]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html#al2ami
|
2494
|
+
#
|
2316
2495
|
# @note When making an API call, you may pass Ec2Configuration
|
2317
2496
|
# data as a hash:
|
2318
2497
|
#
|
@@ -2324,25 +2503,28 @@ module Aws::Batch
|
|
2324
2503
|
# @!attribute [rw] image_type
|
2325
2504
|
# The image type to match with the instance type to select an AMI. If
|
2326
2505
|
# the `imageIdOverride` parameter isn't specified, then a recent
|
2327
|
-
# [Amazon ECS-optimized AMI][1] is used.
|
2506
|
+
# [Amazon ECS-optimized AMI][1] (`ECS_AL1`) is used. Starting on March
|
2507
|
+
# 31, 2021, this default will be changing to `ECS_AL2` ([Amazon Linux
|
2508
|
+
# 2][2]).
|
2328
2509
|
#
|
2329
2510
|
# ECS\_AL2
|
2330
2511
|
#
|
2331
|
-
# : [Amazon Linux 2][2]− Default for all
|
2332
|
-
# families (for example, `C6g`, `M6g`,
|
2333
|
-
# used for all non-GPU instance types.
|
2512
|
+
# : [Amazon Linux 2][2]− Default for all Amazon Web Services
|
2513
|
+
# Graviton-based instance families (for example, `C6g`, `M6g`,
|
2514
|
+
# `R6g`, and `T4g`) and can be used for all non-GPU instance types.
|
2334
2515
|
#
|
2335
2516
|
# ECS\_AL2\_NVIDIA
|
2336
2517
|
#
|
2337
2518
|
# : [Amazon Linux 2 (GPU)][3]−Default for all GPU instance families
|
2338
|
-
# (for example `P4` and `G4`) and can be used for all non
|
2339
|
-
# Graviton-based instance types.
|
2519
|
+
# (for example `P4` and `G4`) and can be used for all non Amazon Web
|
2520
|
+
# Services Graviton-based instance types.
|
2340
2521
|
#
|
2341
2522
|
# ECS\_AL1
|
2342
2523
|
#
|
2343
|
-
# : [Amazon Linux][4]−Default for all non-GPU, non
|
2344
|
-
# instance families. Amazon Linux is reaching the
|
2345
|
-
# standard support. For more information, see [Amazon
|
2524
|
+
# : [Amazon Linux][4]−Default for all non-GPU, non Amazon Web Services
|
2525
|
+
# Graviton instance families. Amazon Linux is reaching the
|
2526
|
+
# end-of-life of standard support. For more information, see [Amazon
|
2527
|
+
# Linux AMI][5].
|
2346
2528
|
#
|
2347
2529
|
#
|
2348
2530
|
#
|
@@ -2383,32 +2565,34 @@ module Aws::Batch
|
|
2383
2565
|
#
|
2384
2566
|
# @!attribute [rw] on_status_reason
|
2385
2567
|
# Contains a glob pattern to match against the `StatusReason` returned
|
2386
|
-
# for a job. The
|
2387
|
-
# letters, numbers, periods (.), colons (:), and white space
|
2388
|
-
# tabs).
|
2389
|
-
# start of the string needs to be an exact
|
2568
|
+
# for a job. The pattern can be up to 512 characters in length. It can
|
2569
|
+
# contain letters, numbers, periods (.), colons (:), and white space
|
2570
|
+
# (including spaces or tabs). It can optionally end with an asterisk
|
2571
|
+
# (*) so that only the start of the string needs to be an exact
|
2572
|
+
# match.
|
2390
2573
|
# @return [String]
|
2391
2574
|
#
|
2392
2575
|
# @!attribute [rw] on_reason
|
2393
2576
|
# Contains a glob pattern to match against the `Reason` returned for a
|
2394
|
-
# job. The
|
2395
|
-
# letters, numbers, periods (.), colons (:), and white space
|
2396
|
-
# tabs)
|
2397
|
-
# start of the string needs to be an exact
|
2577
|
+
# job. The pattern can be up to 512 characters in length. It can
|
2578
|
+
# contain letters, numbers, periods (.), colons (:), and white space
|
2579
|
+
# (including spaces and tabs). It can optionally end with an asterisk
|
2580
|
+
# (*) so that only the start of the string needs to be an exact
|
2581
|
+
# match.
|
2398
2582
|
# @return [String]
|
2399
2583
|
#
|
2400
2584
|
# @!attribute [rw] on_exit_code
|
2401
2585
|
# Contains a glob pattern to match against the decimal representation
|
2402
|
-
# of the `ExitCode` returned for a job. The
|
2403
|
-
# characters
|
2404
|
-
# with an asterisk (*) so that only the start of the
|
2405
|
-
# be an exact match.
|
2586
|
+
# of the `ExitCode` returned for a job. The pattern can be up to 512
|
2587
|
+
# characters in length. It can contain only numbers, and can
|
2588
|
+
# optionally end with an asterisk (*) so that only the start of the
|
2589
|
+
# string needs to be an exact match.
|
2406
2590
|
# @return [String]
|
2407
2591
|
#
|
2408
2592
|
# @!attribute [rw] action
|
2409
2593
|
# Specifies the action to take if all of the specified conditions
|
2410
2594
|
# (`onStatusReason`, `onReason`, and `onExitCode`) are met. The values
|
2411
|
-
#
|
2595
|
+
# aren't case sensitive.
|
2412
2596
|
# @return [String]
|
2413
2597
|
#
|
2414
2598
|
# @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/EvaluateOnExit AWS API Documentation
|
@@ -2422,8 +2606,9 @@ module Aws::Batch
|
|
2422
2606
|
include Aws::Structure
|
2423
2607
|
end
|
2424
2608
|
|
2425
|
-
# The platform configuration for jobs running on Fargate
|
2426
|
-
#
|
2609
|
+
# The platform configuration for jobs that are running on Fargate
|
2610
|
+
# resources. Jobs that run on EC2 resources must not specify this
|
2611
|
+
# parameter.
|
2427
2612
|
#
|
2428
2613
|
# @note When making an API call, you may pass FargatePlatformConfiguration
|
2429
2614
|
# data as a hash:
|
@@ -2433,13 +2618,13 @@ module Aws::Batch
|
|
2433
2618
|
# }
|
2434
2619
|
#
|
2435
2620
|
# @!attribute [rw] platform_version
|
2436
|
-
# The
|
2437
|
-
#
|
2621
|
+
# The Fargate platform version where the jobs are running. A platform
|
2622
|
+
# version is specified only for jobs that are running on Fargate
|
2438
2623
|
# resources. If one isn't specified, the `LATEST` platform version is
|
2439
|
-
# used by default. This
|
2440
|
-
#
|
2441
|
-
#
|
2442
|
-
#
|
2624
|
+
# used by default. This uses a recent, approved version of the Fargate
|
2625
|
+
# platform for compute resources. For more information, see [Fargate
|
2626
|
+
# platform versions][1] in the *Amazon Elastic Container Service
|
2627
|
+
# Developer Guide*.
|
2443
2628
|
#
|
2444
2629
|
#
|
2445
2630
|
#
|
@@ -2473,11 +2658,11 @@ module Aws::Batch
|
|
2473
2658
|
# assigned a host path for you. If this parameter contains a file
|
2474
2659
|
# location, then the data volume persists at the specified location on
|
2475
2660
|
# the host container instance until you delete it manually. If the
|
2476
|
-
# source path location
|
2661
|
+
# source path location doesn't exist on the host container instance,
|
2477
2662
|
# the Docker daemon creates it. If the location does exist, the
|
2478
2663
|
# contents of the source path folder are exported.
|
2479
2664
|
#
|
2480
|
-
# <note markdown="1"> This parameter isn't applicable to jobs
|
2665
|
+
# <note markdown="1"> This parameter isn't applicable to jobs that run on Fargate
|
2481
2666
|
# resources and shouldn't be provided.
|
2482
2667
|
#
|
2483
2668
|
# </note>
|
@@ -2491,7 +2676,7 @@ module Aws::Batch
|
|
2491
2676
|
include Aws::Structure
|
2492
2677
|
end
|
2493
2678
|
|
2494
|
-
# An object representing an
|
2679
|
+
# An object representing an Batch job definition.
|
2495
2680
|
#
|
2496
2681
|
# @!attribute [rw] job_definition_name
|
2497
2682
|
# The name of the job definition.
|
@@ -2513,7 +2698,7 @@ module Aws::Batch
|
|
2513
2698
|
# The type of job definition. If the job is run on Fargate resources,
|
2514
2699
|
# then `multinode` isn't supported. For more information about
|
2515
2700
|
# multi-node parallel jobs, see [Creating a multi-node parallel job
|
2516
|
-
# definition][1] in the *
|
2701
|
+
# definition][1] in the *Batch User Guide*.
|
2517
2702
|
#
|
2518
2703
|
#
|
2519
2704
|
#
|
@@ -2526,7 +2711,7 @@ module Aws::Batch
|
|
2526
2711
|
# pair mapping. Parameters in a `SubmitJob` request override any
|
2527
2712
|
# corresponding parameter defaults from the job definition. For more
|
2528
2713
|
# information about specifying parameters, see [Job Definition
|
2529
|
-
# Parameters][1] in the *
|
2714
|
+
# Parameters][1] in the *Batch User Guide*.
|
2530
2715
|
#
|
2531
2716
|
#
|
2532
2717
|
#
|
@@ -2544,7 +2729,7 @@ module Aws::Batch
|
|
2544
2729
|
#
|
2545
2730
|
# @!attribute [rw] timeout
|
2546
2731
|
# The timeout configuration for jobs that are submitted with this job
|
2547
|
-
# definition. You can specify a timeout duration after which
|
2732
|
+
# definition. You can specify a timeout duration after which Batch
|
2548
2733
|
# terminates your jobs if they haven't finished.
|
2549
2734
|
# @return [Types::JobTimeout]
|
2550
2735
|
#
|
@@ -2598,7 +2783,7 @@ module Aws::Batch
|
|
2598
2783
|
include Aws::Structure
|
2599
2784
|
end
|
2600
2785
|
|
2601
|
-
# An object representing an
|
2786
|
+
# An object representing an Batch job dependency.
|
2602
2787
|
#
|
2603
2788
|
# @note When making an API call, you may pass JobDependency
|
2604
2789
|
# data as a hash:
|
@@ -2609,7 +2794,7 @@ module Aws::Batch
|
|
2609
2794
|
# }
|
2610
2795
|
#
|
2611
2796
|
# @!attribute [rw] job_id
|
2612
|
-
# The job ID of the
|
2797
|
+
# The job ID of the Batch job associated with this dependency.
|
2613
2798
|
# @return [String]
|
2614
2799
|
#
|
2615
2800
|
# @!attribute [rw] type
|
@@ -2625,7 +2810,7 @@ module Aws::Batch
|
|
2625
2810
|
include Aws::Structure
|
2626
2811
|
end
|
2627
2812
|
|
2628
|
-
# An object representing an
|
2813
|
+
# An object representing an Batch job.
|
2629
2814
|
#
|
2630
2815
|
# @!attribute [rw] job_arn
|
2631
2816
|
# The Amazon Resource Name (ARN) of the job.
|
@@ -2648,7 +2833,7 @@ module Aws::Batch
|
|
2648
2833
|
# The current status for the job.
|
2649
2834
|
#
|
2650
2835
|
# <note markdown="1"> If your jobs don't progress to `STARTING`, see [Jobs Stuck in
|
2651
|
-
# RUNNABLE Status][1] in the troubleshooting section of the *
|
2836
|
+
# RUNNABLE Status][1] in the troubleshooting section of the *Batch
|
2652
2837
|
# User Guide*.
|
2653
2838
|
#
|
2654
2839
|
# </note>
|
@@ -2720,7 +2905,8 @@ module Aws::Batch
|
|
2720
2905
|
# An object representing the node properties of a multi-node parallel
|
2721
2906
|
# job.
|
2722
2907
|
#
|
2723
|
-
# <note markdown="1"> This isn't applicable to jobs running on Fargate
|
2908
|
+
# <note markdown="1"> This isn't applicable to jobs that are running on Fargate
|
2909
|
+
# resources.
|
2724
2910
|
#
|
2725
2911
|
# </note>
|
2726
2912
|
# @return [Types::NodeProperties]
|
@@ -2740,7 +2926,7 @@ module Aws::Batch
|
|
2740
2926
|
# @!attribute [rw] propagate_tags
|
2741
2927
|
# Specifies whether to propagate the tags from the job or job
|
2742
2928
|
# definition to the corresponding Amazon ECS task. If no value is
|
2743
|
-
# specified, the tags
|
2929
|
+
# specified, the tags aren't propagated. Tags can only be propagated
|
2744
2930
|
# to the tasks during task creation. For tags with the same name, job
|
2745
2931
|
# tags are given priority over job definitions tags. If the total
|
2746
2932
|
# number of combined tags from the job and job definition is over 50,
|
@@ -2782,7 +2968,7 @@ module Aws::Batch
|
|
2782
2968
|
include Aws::Structure
|
2783
2969
|
end
|
2784
2970
|
|
2785
|
-
# An object representing the details of an
|
2971
|
+
# An object representing the details of an Batch job queue.
|
2786
2972
|
#
|
2787
2973
|
# @!attribute [rw] job_queue_name
|
2788
2974
|
# The name of the job queue.
|
@@ -2816,7 +3002,7 @@ module Aws::Batch
|
|
2816
3002
|
# priority value of `10` is given scheduling preference over a job
|
2817
3003
|
# queue with a priority value of `1`. All of the compute environments
|
2818
3004
|
# must be either EC2 (`EC2` or `SPOT`) or Fargate (`FARGATE` or
|
2819
|
-
# `FARGATE_SPOT`); EC2 and Fargate compute environments
|
3005
|
+
# `FARGATE_SPOT`); EC2 and Fargate compute environments can't be
|
2820
3006
|
# mixed.
|
2821
3007
|
# @return [Integer]
|
2822
3008
|
#
|
@@ -2828,7 +3014,7 @@ module Aws::Batch
|
|
2828
3014
|
#
|
2829
3015
|
# @!attribute [rw] tags
|
2830
3016
|
# The tags applied to the job queue. For more information, see
|
2831
|
-
# [Tagging your
|
3017
|
+
# [Tagging your Batch resources][1] in *Batch User Guide*.
|
2832
3018
|
#
|
2833
3019
|
#
|
2834
3020
|
#
|
@@ -2904,11 +3090,16 @@ module Aws::Batch
|
|
2904
3090
|
# @!attribute [rw] node_properties
|
2905
3091
|
# The node properties for a single node in a job summary list.
|
2906
3092
|
#
|
2907
|
-
# <note markdown="1"> This isn't applicable to jobs running on Fargate
|
3093
|
+
# <note markdown="1"> This isn't applicable to jobs that are running on Fargate
|
3094
|
+
# resources.
|
2908
3095
|
#
|
2909
3096
|
# </note>
|
2910
3097
|
# @return [Types::NodePropertiesSummary]
|
2911
3098
|
#
|
3099
|
+
# @!attribute [rw] job_definition
|
3100
|
+
# The Amazon Resource Name (ARN) of the job definition.
|
3101
|
+
# @return [String]
|
3102
|
+
#
|
2912
3103
|
# @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/JobSummary AWS API Documentation
|
2913
3104
|
#
|
2914
3105
|
class JobSummary < Struct.new(
|
@@ -2922,7 +3113,8 @@ module Aws::Batch
|
|
2922
3113
|
:stopped_at,
|
2923
3114
|
:container,
|
2924
3115
|
:array_properties,
|
2925
|
-
:node_properties
|
3116
|
+
:node_properties,
|
3117
|
+
:job_definition)
|
2926
3118
|
SENSITIVE = []
|
2927
3119
|
include Aws::Structure
|
2928
3120
|
end
|
@@ -2938,7 +3130,7 @@ module Aws::Batch
|
|
2938
3130
|
#
|
2939
3131
|
# @!attribute [rw] attempt_duration_seconds
|
2940
3132
|
# The time duration in seconds (measured from the job attempt's
|
2941
|
-
# `startedAt` timestamp) after which
|
3133
|
+
# `startedAt` timestamp) after which Batch terminates your jobs if
|
2942
3134
|
# they have not finished. The minimum value for the timeout is 60
|
2943
3135
|
# seconds.
|
2944
3136
|
# @return [Integer]
|
@@ -2980,6 +3172,34 @@ module Aws::Batch
|
|
2980
3172
|
include Aws::Structure
|
2981
3173
|
end
|
2982
3174
|
|
3175
|
+
# A filter name and value pair that's used to return a more specific
|
3176
|
+
# list of results from a `ListJobs` API operation.
|
3177
|
+
#
|
3178
|
+
# @note When making an API call, you may pass KeyValuesPair
|
3179
|
+
# data as a hash:
|
3180
|
+
#
|
3181
|
+
# {
|
3182
|
+
# name: "String",
|
3183
|
+
# values: ["String"],
|
3184
|
+
# }
|
3185
|
+
#
|
3186
|
+
# @!attribute [rw] name
|
3187
|
+
# The name of the filter. Filter names are case sensitive.
|
3188
|
+
# @return [String]
|
3189
|
+
#
|
3190
|
+
# @!attribute [rw] values
|
3191
|
+
# The filter values.
|
3192
|
+
# @return [Array<String>]
|
3193
|
+
#
|
3194
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/KeyValuesPair AWS API Documentation
|
3195
|
+
#
|
3196
|
+
class KeyValuesPair < Struct.new(
|
3197
|
+
:name,
|
3198
|
+
:values)
|
3199
|
+
SENSITIVE = []
|
3200
|
+
include Aws::Structure
|
3201
|
+
end
|
3202
|
+
|
2983
3203
|
# An object representing a launch template associated with a compute
|
2984
3204
|
# resource. You must specify either the launch template ID or launch
|
2985
3205
|
# template name in the request, but not both.
|
@@ -2989,7 +3209,8 @@ module Aws::Batch
|
|
2989
3209
|
# values in the `securityGroupIds` parameter of
|
2990
3210
|
# `CreateComputeEnvironment` will be used.
|
2991
3211
|
#
|
2992
|
-
# <note markdown="1"> This object isn't applicable to jobs running on Fargate
|
3212
|
+
# <note markdown="1"> This object isn't applicable to jobs that are running on Fargate
|
3213
|
+
# resources.
|
2993
3214
|
#
|
2994
3215
|
# </note>
|
2995
3216
|
#
|
@@ -3017,6 +3238,14 @@ module Aws::Batch
|
|
3017
3238
|
# is used. If the value is `$Default`, the default version of the
|
3018
3239
|
# launch template is used.
|
3019
3240
|
#
|
3241
|
+
# After the compute environment is created, the launch template
|
3242
|
+
# version that's used isn't changed, even if the `$Default` or
|
3243
|
+
# `$Latest` version for the launch template is updated. To use a new
|
3244
|
+
# launch template version, create a new compute environment, add the
|
3245
|
+
# new compute environment to the existing job queue, remove the old
|
3246
|
+
# compute environment from the job queue, and delete the old compute
|
3247
|
+
# environment.
|
3248
|
+
#
|
3020
3249
|
# Default: `$Default`.
|
3021
3250
|
# @return [String]
|
3022
3251
|
#
|
@@ -3062,7 +3291,7 @@ module Aws::Batch
|
|
3062
3291
|
# `Devices` in the [Create a container][1] section of the [Docker
|
3063
3292
|
# Remote API][2] and the `--device` option to [docker run][3].
|
3064
3293
|
#
|
3065
|
-
# <note markdown="1"> This parameter isn't applicable to jobs running on Fargate
|
3294
|
+
# <note markdown="1"> This parameter isn't applicable to jobs that are running on Fargate
|
3066
3295
|
# resources and shouldn't be provided.
|
3067
3296
|
#
|
3068
3297
|
# </note>
|
@@ -3092,7 +3321,7 @@ module Aws::Batch
|
|
3092
3321
|
# The value for the size (in MiB) of the `/dev/shm` volume. This
|
3093
3322
|
# parameter maps to the `--shm-size` option to [docker run][1].
|
3094
3323
|
#
|
3095
|
-
# <note markdown="1"> This parameter isn't applicable to jobs running on Fargate
|
3324
|
+
# <note markdown="1"> This parameter isn't applicable to jobs that are running on Fargate
|
3096
3325
|
# resources and shouldn't be provided.
|
3097
3326
|
#
|
3098
3327
|
# </note>
|
@@ -3107,7 +3336,7 @@ module Aws::Batch
|
|
3107
3336
|
# mount. This parameter maps to the `--tmpfs` option to [docker
|
3108
3337
|
# run][1].
|
3109
3338
|
#
|
3110
|
-
# <note markdown="1"> This parameter isn't applicable to jobs running on Fargate
|
3339
|
+
# <note markdown="1"> This parameter isn't applicable to jobs that are running on Fargate
|
3111
3340
|
# resources and shouldn't be provided.
|
3112
3341
|
#
|
3113
3342
|
# </note>
|
@@ -3131,7 +3360,7 @@ module Aws::Batch
|
|
3131
3360
|
# `maxSwap` value must be set for the `swappiness` parameter to be
|
3132
3361
|
# used.
|
3133
3362
|
#
|
3134
|
-
# <note markdown="1"> This parameter isn't applicable to jobs running on Fargate
|
3363
|
+
# <note markdown="1"> This parameter isn't applicable to jobs that are running on Fargate
|
3135
3364
|
# resources and shouldn't be provided.
|
3136
3365
|
#
|
3137
3366
|
# </note>
|
@@ -3149,9 +3378,10 @@ module Aws::Batch
|
|
3149
3378
|
# be swapped very aggressively. Accepted values are whole numbers
|
3150
3379
|
# between `0` and `100`. If the `swappiness` parameter isn't
|
3151
3380
|
# specified, a default value of `60` is used. If a value isn't
|
3152
|
-
# specified for `maxSwap
|
3153
|
-
# is set to 0, the container doesn't use swap. This
|
3154
|
-
# the `--memory-swappiness` option to [docker
|
3381
|
+
# specified for `maxSwap`, then this parameter is ignored. If
|
3382
|
+
# `maxSwap` is set to 0, the container doesn't use swap. This
|
3383
|
+
# parameter maps to the `--memory-swappiness` option to [docker
|
3384
|
+
# run][1].
|
3155
3385
|
#
|
3156
3386
|
# Consider the following when you use a per-container swap
|
3157
3387
|
# configuration.
|
@@ -3173,10 +3403,10 @@ module Aws::Batch
|
|
3173
3403
|
#
|
3174
3404
|
# * If the `maxSwap` and `swappiness` parameters are omitted from a
|
3175
3405
|
# job definition, each container will have a default `swappiness`
|
3176
|
-
# value of 60 and the total swap usage will be limited to two times
|
3406
|
+
# value of 60, and the total swap usage will be limited to two times
|
3177
3407
|
# the memory reservation of the container.
|
3178
3408
|
#
|
3179
|
-
# <note markdown="1"> This parameter isn't applicable to jobs running on Fargate
|
3409
|
+
# <note markdown="1"> This parameter isn't applicable to jobs that are running on Fargate
|
3180
3410
|
# resources and shouldn't be provided.
|
3181
3411
|
#
|
3182
3412
|
# </note>
|
@@ -3213,6 +3443,12 @@ module Aws::Batch
|
|
3213
3443
|
# job_status: "SUBMITTED", # accepts SUBMITTED, PENDING, RUNNABLE, STARTING, RUNNING, SUCCEEDED, FAILED
|
3214
3444
|
# max_results: 1,
|
3215
3445
|
# next_token: "String",
|
3446
|
+
# filters: [
|
3447
|
+
# {
|
3448
|
+
# name: "String",
|
3449
|
+
# values: ["String"],
|
3450
|
+
# },
|
3451
|
+
# ],
|
3216
3452
|
# }
|
3217
3453
|
#
|
3218
3454
|
# @!attribute [rw] job_queue
|
@@ -3232,19 +3468,21 @@ module Aws::Batch
|
|
3232
3468
|
# @return [String]
|
3233
3469
|
#
|
3234
3470
|
# @!attribute [rw] job_status
|
3235
|
-
# The job status used to filter jobs in the specified queue. If
|
3236
|
-
#
|
3471
|
+
# The job status used to filter jobs in the specified queue. If the
|
3472
|
+
# `filters` parameter is specified, the `jobStatus` parameter is
|
3473
|
+
# ignored and jobs with any status are returned. If you don't specify
|
3474
|
+
# a status, only `RUNNING` jobs are returned.
|
3237
3475
|
# @return [String]
|
3238
3476
|
#
|
3239
3477
|
# @!attribute [rw] max_results
|
3240
3478
|
# The maximum number of results returned by `ListJobs` in paginated
|
3241
3479
|
# output. When this parameter is used, `ListJobs` only returns
|
3242
|
-
# `maxResults` results in a single page
|
3243
|
-
#
|
3244
|
-
#
|
3245
|
-
#
|
3246
|
-
#
|
3247
|
-
#
|
3480
|
+
# `maxResults` results in a single page and a `nextToken` response
|
3481
|
+
# element. The remaining results of the initial request can be seen by
|
3482
|
+
# sending another `ListJobs` request with the returned `nextToken`
|
3483
|
+
# value. This value can be between 1 and 100. If this parameter isn't
|
3484
|
+
# used, then `ListJobs` returns up to 100 results and a `nextToken`
|
3485
|
+
# value if applicable.
|
3248
3486
|
# @return [Integer]
|
3249
3487
|
#
|
3250
3488
|
# @!attribute [rw] next_token
|
@@ -3261,6 +3499,56 @@ module Aws::Batch
|
|
3261
3499
|
# </note>
|
3262
3500
|
# @return [String]
|
3263
3501
|
#
|
3502
|
+
# @!attribute [rw] filters
|
3503
|
+
# The filter to apply to the query. Only one filter can be used at a
|
3504
|
+
# time. When the filter is used, `jobStatus` is ignored. The filter
|
3505
|
+
# doesn't apply to child jobs in an array or multi-node parallel
|
3506
|
+
# (MNP) jobs. The results are sorted by the `createdAt` field, with
|
3507
|
+
# the most recent jobs being first.
|
3508
|
+
#
|
3509
|
+
# JOB\_NAME
|
3510
|
+
#
|
3511
|
+
# : The value of the filter is a case-insensitive match for the job
|
3512
|
+
# name. If the value ends with an asterisk (*), the filter will
|
3513
|
+
# match any job name that begins with the string before the '*'.
|
3514
|
+
# This corresponds to the `jobName` value. For example, `test1`
|
3515
|
+
# matches both `Test1` and `test1`, and `test1*` matches both
|
3516
|
+
# `test1` and `Test10`. When the `JOB_NAME` filter is used, the
|
3517
|
+
# results are grouped by the job name and version.
|
3518
|
+
#
|
3519
|
+
# JOB\_DEFINITION
|
3520
|
+
#
|
3521
|
+
# : The value for the filter is the name or Amazon Resource Name (ARN)
|
3522
|
+
# of the job definition. This corresponds to the `jobDefinition`
|
3523
|
+
# value. The value is case sensitive. When the value for the filter
|
3524
|
+
# is the job definition name, the results include all the jobs that
|
3525
|
+
# used any revision of that job definition name. If the value ends
|
3526
|
+
# with an asterisk (*), the filter will match any job definition
|
3527
|
+
# name that begins with the string before the '*'. For example,
|
3528
|
+
# `jd1` matches only `jd1`, and `jd1*` matches both `jd1` and
|
3529
|
+
# `jd1A`. The version of the job definition that's used doesn't
|
3530
|
+
# affect the sort order. When the `JOB_DEFINITION` filter is used
|
3531
|
+
# and the ARN is used (which is in the form
|
3532
|
+
# `arn:$\{Partition\}:batch:$\{Region\}:$\{Account\}:job-definition/$\{JobDefinitionName\}:$\{Revision\}`),
|
3533
|
+
# the results include jobs that used the specified revision of the
|
3534
|
+
# job definition. Asterisk (*) is not supported when the ARN is
|
3535
|
+
# used.
|
3536
|
+
#
|
3537
|
+
# BEFORE\_CREATED\_AT
|
3538
|
+
#
|
3539
|
+
# : The value for the filter is the time that's before the job was
|
3540
|
+
# created. This corresponds to the `createdAt` value. The value is a
|
3541
|
+
# string representation of the number of seconds since 00:00:00 UTC
|
3542
|
+
# (midnight) on January 1, 1970.
|
3543
|
+
#
|
3544
|
+
# AFTER\_CREATED\_AT
|
3545
|
+
#
|
3546
|
+
# : The value for the filter is the time that's after the job was
|
3547
|
+
# created. This corresponds to the `createdAt` value. The value is a
|
3548
|
+
# string representation of the number of seconds since 00:00:00 UTC
|
3549
|
+
# (midnight) on January 1, 1970.
|
3550
|
+
# @return [Array<Types::KeyValuesPair>]
|
3551
|
+
#
|
3264
3552
|
# @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/ListJobsRequest AWS API Documentation
|
3265
3553
|
#
|
3266
3554
|
class ListJobsRequest < Struct.new(
|
@@ -3269,7 +3557,8 @@ module Aws::Batch
|
|
3269
3557
|
:multi_node_job_id,
|
3270
3558
|
:job_status,
|
3271
3559
|
:max_results,
|
3272
|
-
:next_token
|
3560
|
+
:next_token,
|
3561
|
+
:filters)
|
3273
3562
|
SENSITIVE = []
|
3274
3563
|
include Aws::Structure
|
3275
3564
|
end
|
@@ -3303,10 +3592,9 @@ module Aws::Batch
|
|
3303
3592
|
#
|
3304
3593
|
# @!attribute [rw] resource_arn
|
3305
3594
|
# The Amazon Resource Name (ARN) that identifies the resource that
|
3306
|
-
# tags are listed for.
|
3307
|
-
#
|
3308
|
-
#
|
3309
|
-
# supported.
|
3595
|
+
# tags are listed for. Batch resources that support tags are compute
|
3596
|
+
# environments, jobs, job definitions, and job queues. ARNs for child
|
3597
|
+
# jobs of array and multi-node parallel (MNP) jobs are not supported.
|
3310
3598
|
# @return [String]
|
3311
3599
|
#
|
3312
3600
|
# @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/ListTagsForResourceRequest AWS API Documentation
|
@@ -3356,17 +3644,17 @@ module Aws::Batch
|
|
3356
3644
|
# The supported log drivers are `awslogs`, `fluentd`, `gelf`,
|
3357
3645
|
# `json-file`, `journald`, `logentries`, `syslog`, and `splunk`.
|
3358
3646
|
#
|
3359
|
-
# <note markdown="1"> Jobs running on Fargate resources are restricted to the
|
3360
|
-
# and `splunk` log drivers.
|
3647
|
+
# <note markdown="1"> Jobs that are running on Fargate resources are restricted to the
|
3648
|
+
# `awslogs` and `splunk` log drivers.
|
3361
3649
|
#
|
3362
3650
|
# </note>
|
3363
3651
|
#
|
3364
3652
|
# awslogs
|
3365
3653
|
#
|
3366
3654
|
# : Specifies the Amazon CloudWatch Logs logging driver. For more
|
3367
|
-
# information, see [Using the awslogs Log Driver][1] in the *
|
3368
|
-
#
|
3369
|
-
#
|
3655
|
+
# information, see [Using the awslogs Log Driver][1] in the *Batch
|
3656
|
+
# User Guide* and [Amazon CloudWatch Logs logging driver][2] in the
|
3657
|
+
# Docker documentation.
|
3370
3658
|
#
|
3371
3659
|
# fluentd
|
3372
3660
|
#
|
@@ -3404,7 +3692,7 @@ module Aws::Batch
|
|
3404
3692
|
# including usage and options, see [Syslog logging driver][8] in the
|
3405
3693
|
# Docker documentation.
|
3406
3694
|
#
|
3407
|
-
# <note markdown="1"> If you have a custom driver that'
|
3695
|
+
# <note markdown="1"> If you have a custom driver that's not listed earlier that you want
|
3408
3696
|
# to work with the Amazon ECS container agent, you can fork the Amazon
|
3409
3697
|
# ECS container agent project that's [available on GitHub][9] and
|
3410
3698
|
# customize it to work with that driver. We encourage you to submit
|
@@ -3443,7 +3731,7 @@ module Aws::Batch
|
|
3443
3731
|
#
|
3444
3732
|
# @!attribute [rw] secret_options
|
3445
3733
|
# The secrets to pass to the log configuration. For more information,
|
3446
|
-
# see [Specifying Sensitive Data][1] in the *
|
3734
|
+
# see [Specifying Sensitive Data][1] in the *Batch User Guide*.
|
3447
3735
|
#
|
3448
3736
|
#
|
3449
3737
|
#
|
@@ -3502,8 +3790,9 @@ module Aws::Batch
|
|
3502
3790
|
include Aws::Structure
|
3503
3791
|
end
|
3504
3792
|
|
3505
|
-
# The network configuration for jobs running on Fargate
|
3506
|
-
# running on EC2 resources must not specify
|
3793
|
+
# The network configuration for jobs that are running on Fargate
|
3794
|
+
# resources. Jobs that are running on EC2 resources must not specify
|
3795
|
+
# this parameter.
|
3507
3796
|
#
|
3508
3797
|
# @note When making an API call, you may pass NetworkConfiguration
|
3509
3798
|
# data as a hash:
|
@@ -3514,8 +3803,8 @@ module Aws::Batch
|
|
3514
3803
|
#
|
3515
3804
|
# @!attribute [rw] assign_public_ip
|
3516
3805
|
# Indicates whether the job should have a public IP address. For a job
|
3517
|
-
# running on Fargate resources in a private subnet to send
|
3518
|
-
# traffic to the internet (for example,
|
3806
|
+
# that is running on Fargate resources in a private subnet to send
|
3807
|
+
# outbound traffic to the internet (for example, to pull container
|
3519
3808
|
# images), the private subnet requires a NAT gateway be attached to
|
3520
3809
|
# route requests to the internet. For more information, see [Amazon
|
3521
3810
|
# ECS task networking][1]. The default value is "DISABLED".
|
@@ -3583,8 +3872,8 @@ module Aws::Batch
|
|
3583
3872
|
# Object representing any node overrides to a job definition that's
|
3584
3873
|
# used in a SubmitJob API operation.
|
3585
3874
|
#
|
3586
|
-
# <note markdown="1"> This isn't applicable to jobs running on Fargate resources
|
3587
|
-
# shouldn't be provided; use `containerOverrides` instead.
|
3875
|
+
# <note markdown="1"> This isn't applicable to jobs that are running on Fargate resources
|
3876
|
+
# and shouldn't be provided; use `containerOverrides` instead.
|
3588
3877
|
#
|
3589
3878
|
# </note>
|
3590
3879
|
#
|
@@ -3672,6 +3961,16 @@ module Aws::Batch
|
|
3672
3961
|
# source_path: "String",
|
3673
3962
|
# },
|
3674
3963
|
# name: "String",
|
3964
|
+
# efs_volume_configuration: {
|
3965
|
+
# file_system_id: "String", # required
|
3966
|
+
# root_directory: "String",
|
3967
|
+
# transit_encryption: "ENABLED", # accepts ENABLED, DISABLED
|
3968
|
+
# transit_encryption_port: 1,
|
3969
|
+
# authorization_config: {
|
3970
|
+
# access_point_id: "String",
|
3971
|
+
# iam: "ENABLED", # accepts ENABLED, DISABLED
|
3972
|
+
# },
|
3973
|
+
# },
|
3675
3974
|
# },
|
3676
3975
|
# ],
|
3677
3976
|
# environment: [
|
@@ -3876,6 +4175,16 @@ module Aws::Batch
|
|
3876
4175
|
# source_path: "String",
|
3877
4176
|
# },
|
3878
4177
|
# name: "String",
|
4178
|
+
# efs_volume_configuration: {
|
4179
|
+
# file_system_id: "String", # required
|
4180
|
+
# root_directory: "String",
|
4181
|
+
# transit_encryption: "ENABLED", # accepts ENABLED, DISABLED
|
4182
|
+
# transit_encryption_port: 1,
|
4183
|
+
# authorization_config: {
|
4184
|
+
# access_point_id: "String",
|
4185
|
+
# iam: "ENABLED", # accepts ENABLED, DISABLED
|
4186
|
+
# },
|
4187
|
+
# },
|
3879
4188
|
# },
|
3880
4189
|
# ],
|
3881
4190
|
# environment: [
|
@@ -4003,6 +4312,16 @@ module Aws::Batch
|
|
4003
4312
|
# source_path: "String",
|
4004
4313
|
# },
|
4005
4314
|
# name: "String",
|
4315
|
+
# efs_volume_configuration: {
|
4316
|
+
# file_system_id: "String", # required
|
4317
|
+
# root_directory: "String",
|
4318
|
+
# transit_encryption: "ENABLED", # accepts ENABLED, DISABLED
|
4319
|
+
# transit_encryption_port: 1,
|
4320
|
+
# authorization_config: {
|
4321
|
+
# access_point_id: "String",
|
4322
|
+
# iam: "ENABLED", # accepts ENABLED, DISABLED
|
4323
|
+
# },
|
4324
|
+
# },
|
4006
4325
|
# },
|
4007
4326
|
# ],
|
4008
4327
|
# environment: [
|
@@ -4099,6 +4418,16 @@ module Aws::Batch
|
|
4099
4418
|
# source_path: "String",
|
4100
4419
|
# },
|
4101
4420
|
# name: "String",
|
4421
|
+
# efs_volume_configuration: {
|
4422
|
+
# file_system_id: "String", # required
|
4423
|
+
# root_directory: "String",
|
4424
|
+
# transit_encryption: "ENABLED", # accepts ENABLED, DISABLED
|
4425
|
+
# transit_encryption_port: 1,
|
4426
|
+
# authorization_config: {
|
4427
|
+
# access_point_id: "String",
|
4428
|
+
# iam: "ENABLED", # accepts ENABLED, DISABLED
|
4429
|
+
# },
|
4430
|
+
# },
|
4102
4431
|
# },
|
4103
4432
|
# ],
|
4104
4433
|
# environment: [
|
@@ -4209,7 +4538,7 @@ module Aws::Batch
|
|
4209
4538
|
# @!attribute [rw] type
|
4210
4539
|
# The type of job definition. For more information about multi-node
|
4211
4540
|
# parallel jobs, see [Creating a multi-node parallel job
|
4212
|
-
# definition][1] in the *
|
4541
|
+
# definition][1] in the *Batch User Guide*.
|
4213
4542
|
#
|
4214
4543
|
# <note markdown="1"> If the job is run on Fargate resources, then `multinode` isn't
|
4215
4544
|
# supported.
|
@@ -4244,7 +4573,7 @@ module Aws::Batch
|
|
4244
4573
|
# An object with various properties specific to multi-node parallel
|
4245
4574
|
# jobs. If you specify node properties for a job, it becomes a
|
4246
4575
|
# multi-node parallel job. For more information, see [Multi-node
|
4247
|
-
# Parallel Jobs][1] in the *
|
4576
|
+
# Parallel Jobs][1] in the *Batch User Guide*. If the job
|
4248
4577
|
# definition's `type` parameter is `container`, then you must specify
|
4249
4578
|
# either `containerProperties` or `nodeProperties`.
|
4250
4579
|
#
|
@@ -4277,12 +4606,12 @@ module Aws::Batch
|
|
4277
4606
|
#
|
4278
4607
|
# @!attribute [rw] timeout
|
4279
4608
|
# The timeout configuration for jobs that are submitted with this job
|
4280
|
-
# definition, after which
|
4281
|
-
#
|
4609
|
+
# definition, after which Batch terminates your jobs if they have not
|
4610
|
+
# finished. If a job is terminated due to a timeout, it isn't
|
4282
4611
|
# retried. The minimum value for the timeout is 60 seconds. Any
|
4283
4612
|
# timeout configuration that's specified during a SubmitJob operation
|
4284
4613
|
# overrides the timeout configuration defined here. For more
|
4285
|
-
# information, see [Job Timeouts][1] in the *
|
4614
|
+
# information, see [Job Timeouts][1] in the *Batch User Guide*.
|
4286
4615
|
#
|
4287
4616
|
#
|
4288
4617
|
#
|
@@ -4292,8 +4621,8 @@ module Aws::Batch
|
|
4292
4621
|
# @!attribute [rw] tags
|
4293
4622
|
# The tags that you apply to the job definition to help you categorize
|
4294
4623
|
# and organize your resources. Each tag consists of a key and an
|
4295
|
-
# optional value. For more information, see [Tagging
|
4296
|
-
# in *
|
4624
|
+
# optional value. For more information, see [Tagging Amazon Web
|
4625
|
+
# Services Resources][1] in *Batch User Guide*.
|
4297
4626
|
#
|
4298
4627
|
#
|
4299
4628
|
#
|
@@ -4367,35 +4696,36 @@ module Aws::Batch
|
|
4367
4696
|
# exceed the number of available GPUs on the compute resource that
|
4368
4697
|
# the job is launched on.
|
4369
4698
|
#
|
4370
|
-
# <note markdown="1"> GPUs are not available for jobs running on Fargate
|
4699
|
+
# <note markdown="1"> GPUs are not available for jobs that are running on Fargate
|
4700
|
+
# resources.
|
4371
4701
|
#
|
4372
4702
|
# </note>
|
4373
4703
|
#
|
4374
4704
|
# type="MEMORY"
|
4375
4705
|
#
|
4376
|
-
# :
|
4377
|
-
#
|
4378
|
-
# exceed the memory specified
|
4379
|
-
# parameter maps to `Memory` in the
|
4380
|
-
# of the [Docker Remote API][2] and
|
4381
|
-
# run][3]. You must specify at
|
4382
|
-
#
|
4383
|
-
# parallel (MNP) jobs. It
|
4384
|
-
#
|
4385
|
-
# container][1] section of the [Docker
|
4386
|
-
# `--memory` option to [docker run][3].
|
4706
|
+
# : The memory hard limit (in MiB) present to the container. This
|
4707
|
+
# parameter is supported for jobs that are running on EC2 resources.
|
4708
|
+
# If your container attempts to exceed the memory specified, the
|
4709
|
+
# container is terminated. This parameter maps to `Memory` in the
|
4710
|
+
# [Create a container][1] section of the [Docker Remote API][2] and
|
4711
|
+
# the `--memory` option to [docker run][3]. You must specify at
|
4712
|
+
# least 4 MiB of memory for a job. This is required but can be
|
4713
|
+
# specified in several places for multi-node parallel (MNP) jobs. It
|
4714
|
+
# must be specified for each node at least once. This parameter maps
|
4715
|
+
# to `Memory` in the [Create a container][1] section of the [Docker
|
4716
|
+
# Remote API][2] and the `--memory` option to [docker run][3].
|
4387
4717
|
#
|
4388
4718
|
# <note markdown="1"> If you're trying to maximize your resource utilization by
|
4389
4719
|
# providing your jobs as much memory as possible for a particular
|
4390
|
-
# instance type, see [Memory Management][4] in the *
|
4720
|
+
# instance type, see [Memory Management][4] in the *Batch User
|
4391
4721
|
# Guide*.
|
4392
4722
|
#
|
4393
4723
|
# </note>
|
4394
4724
|
#
|
4395
|
-
# For jobs running on Fargate resources, then `value` is
|
4396
|
-
# limit (in MiB), and must match one of the supported
|
4397
|
-
# `VCPU` values must be one of the values supported
|
4398
|
-
# value.
|
4725
|
+
# For jobs that are running on Fargate resources, then `value` is
|
4726
|
+
# the hard limit (in MiB), and must match one of the supported
|
4727
|
+
# values and the `VCPU` values must be one of the values supported
|
4728
|
+
# for that memory value.
|
4399
4729
|
#
|
4400
4730
|
# value = 512
|
4401
4731
|
#
|
@@ -4443,10 +4773,10 @@ module Aws::Batch
|
|
4443
4773
|
# but can be specified in several places; it must be specified for
|
4444
4774
|
# each node at least once.
|
4445
4775
|
#
|
4446
|
-
# For jobs running on Fargate resources, then `value` must
|
4447
|
-
# of the supported values and the `MEMORY` values must be
|
4448
|
-
# values supported for that VCPU value. The supported
|
4449
|
-
# 0.25, 0.5, 1, 2, and 4
|
4776
|
+
# For jobs that are running on Fargate resources, then `value` must
|
4777
|
+
# match one of the supported values and the `MEMORY` values must be
|
4778
|
+
# one of the values supported for that VCPU value. The supported
|
4779
|
+
# values are 0.25, 0.5, 1, 2, and 4
|
4450
4780
|
#
|
4451
4781
|
# value = 0.25
|
4452
4782
|
#
|
@@ -4494,7 +4824,7 @@ module Aws::Batch
|
|
4494
4824
|
end
|
4495
4825
|
|
4496
4826
|
# The retry strategy associated with a job. For more information, see
|
4497
|
-
# [Automated job retries][1] in the *
|
4827
|
+
# [Automated job retries][1] in the *Batch User Guide*.
|
4498
4828
|
#
|
4499
4829
|
#
|
4500
4830
|
#
|
@@ -4546,8 +4876,8 @@ module Aws::Batch
|
|
4546
4876
|
# * To reference sensitive information in the log configuration of a
|
4547
4877
|
# container, use the `secretOptions` container definition parameter.
|
4548
4878
|
#
|
4549
|
-
# For more information, see [Specifying sensitive data][1] in the *
|
4550
|
-
#
|
4879
|
+
# For more information, see [Specifying sensitive data][1] in the *Batch
|
4880
|
+
# User Guide*.
|
4551
4881
|
#
|
4552
4882
|
#
|
4553
4883
|
#
|
@@ -4567,13 +4897,14 @@ module Aws::Batch
|
|
4567
4897
|
#
|
4568
4898
|
# @!attribute [rw] value_from
|
4569
4899
|
# The secret to expose to the container. The supported values are
|
4570
|
-
# either the full ARN of the
|
4571
|
-
#
|
4900
|
+
# either the full ARN of the Secrets Manager secret or the full ARN of
|
4901
|
+
# the parameter in the Amazon Web Services Systems Manager Parameter
|
4902
|
+
# Store.
|
4572
4903
|
#
|
4573
|
-
# <note markdown="1"> If the
|
4574
|
-
# same Region as the job you
|
4575
|
-
# the full ARN or name of the parameter. If the parameter
|
4576
|
-
# different Region, then the full ARN must be specified.
|
4904
|
+
# <note markdown="1"> If the Amazon Web Services Systems Manager Parameter Store parameter
|
4905
|
+
# exists in the same Region as the job you're launching, then you can
|
4906
|
+
# use either the full ARN or name of the parameter. If the parameter
|
4907
|
+
# exists in a different Region, then the full ARN must be specified.
|
4577
4908
|
#
|
4578
4909
|
# </note>
|
4579
4910
|
# @return [String]
|
@@ -4692,15 +5023,15 @@ module Aws::Batch
|
|
4692
5023
|
# @return [String]
|
4693
5024
|
#
|
4694
5025
|
# @!attribute [rw] job_queue
|
4695
|
-
# The job queue
|
4696
|
-
#
|
5026
|
+
# The job queue where the job is submitted. You can specify either the
|
5027
|
+
# name or the Amazon Resource Name (ARN) of the queue.
|
4697
5028
|
# @return [String]
|
4698
5029
|
#
|
4699
5030
|
# @!attribute [rw] array_properties
|
4700
5031
|
# The array properties for the submitted job, such as the size of the
|
4701
5032
|
# array. The array size can be between 2 and 10,000. If you specify
|
4702
5033
|
# array properties for a job, it becomes an array job. For more
|
4703
|
-
# information, see [Array Jobs][1] in the *
|
5034
|
+
# information, see [Array Jobs][1] in the *Batch User Guide*.
|
4704
5035
|
#
|
4705
5036
|
#
|
4706
5037
|
#
|
@@ -4733,21 +5064,20 @@ module Aws::Batch
|
|
4733
5064
|
# @return [Hash<String,String>]
|
4734
5065
|
#
|
4735
5066
|
# @!attribute [rw] container_overrides
|
4736
|
-
# A list of container overrides in JSON format that specify the
|
4737
|
-
# of a container in the specified job definition and the
|
4738
|
-
# should receive. You can override the default command
|
4739
|
-
#
|
4740
|
-
# `command` override. You can also override
|
4741
|
-
#
|
4742
|
-
#
|
4743
|
-
# `environment` override.
|
5067
|
+
# A list of container overrides in the JSON format that specify the
|
5068
|
+
# name of a container in the specified job definition and the
|
5069
|
+
# overrides it should receive. You can override the default command
|
5070
|
+
# for a container, which is specified in the job definition or the
|
5071
|
+
# Docker image, with a `command` override. You can also override
|
5072
|
+
# existing environment variables on a container or add new environment
|
5073
|
+
# variables to it with an `environment` override.
|
4744
5074
|
# @return [Types::ContainerOverrides]
|
4745
5075
|
#
|
4746
5076
|
# @!attribute [rw] node_overrides
|
4747
5077
|
# A list of node overrides in JSON format that specify the node range
|
4748
5078
|
# to target and the container overrides for that node range.
|
4749
5079
|
#
|
4750
|
-
# <note markdown="1"> This parameter isn't applicable to jobs running on Fargate
|
5080
|
+
# <note markdown="1"> This parameter isn't applicable to jobs that are running on Fargate
|
4751
5081
|
# resources; use `containerOverrides` instead.
|
4752
5082
|
#
|
4753
5083
|
# </note>
|
@@ -4772,14 +5102,14 @@ module Aws::Batch
|
|
4772
5102
|
#
|
4773
5103
|
# @!attribute [rw] timeout
|
4774
5104
|
# The timeout configuration for this SubmitJob operation. You can
|
4775
|
-
# specify a timeout duration after which
|
4776
|
-
#
|
4777
|
-
#
|
4778
|
-
#
|
4779
|
-
#
|
4780
|
-
#
|
4781
|
-
#
|
4782
|
-
#
|
5105
|
+
# specify a timeout duration after which Batch terminates your jobs if
|
5106
|
+
# they haven't finished. If a job is terminated due to a timeout, it
|
5107
|
+
# isn't retried. The minimum value for the timeout is 60 seconds.
|
5108
|
+
# This configuration overrides any timeout configuration specified in
|
5109
|
+
# the job definition. For array jobs, child jobs have the same timeout
|
5110
|
+
# configuration as the parent job. For more information, see [Job
|
5111
|
+
# Timeouts][1] in the *Amazon Elastic Container Service Developer
|
5112
|
+
# Guide*.
|
4783
5113
|
#
|
4784
5114
|
#
|
4785
5115
|
#
|
@@ -4789,8 +5119,8 @@ module Aws::Batch
|
|
4789
5119
|
# @!attribute [rw] tags
|
4790
5120
|
# The tags that you apply to the job request to help you categorize
|
4791
5121
|
# and organize your resources. Each tag consists of a key and an
|
4792
|
-
# optional value. For more information, see [Tagging
|
4793
|
-
# in *
|
5122
|
+
# optional value. For more information, see [Tagging Amazon Web
|
5123
|
+
# Services Resources][1] in *Amazon Web Services General Reference*.
|
4794
5124
|
#
|
4795
5125
|
#
|
4796
5126
|
#
|
@@ -4850,7 +5180,7 @@ module Aws::Batch
|
|
4850
5180
|
#
|
4851
5181
|
# @!attribute [rw] resource_arn
|
4852
5182
|
# The Amazon Resource Name (ARN) of the resource that tags are added
|
4853
|
-
# to.
|
5183
|
+
# to. Batch resources that support tags are compute environments,
|
4854
5184
|
# jobs, job definitions, and job queues. ARNs for child jobs of array
|
4855
5185
|
# and multi-node parallel (MNP) jobs are not supported.
|
4856
5186
|
# @return [String]
|
@@ -4858,8 +5188,8 @@ module Aws::Batch
|
|
4858
5188
|
# @!attribute [rw] tags
|
4859
5189
|
# The tags that you apply to the resource to help you categorize and
|
4860
5190
|
# organize your resources. Each tag consists of a key and an optional
|
4861
|
-
# value. For more information, see [Tagging
|
4862
|
-
# General Reference*.
|
5191
|
+
# value. For more information, see [Tagging Amazon Web Services
|
5192
|
+
# Resources][1] in *Amazon Web Services General Reference*.
|
4863
5193
|
#
|
4864
5194
|
#
|
4865
5195
|
#
|
@@ -4890,14 +5220,14 @@ module Aws::Batch
|
|
4890
5220
|
# }
|
4891
5221
|
#
|
4892
5222
|
# @!attribute [rw] job_id
|
4893
|
-
# The
|
5223
|
+
# The Batch job ID of the job to terminate.
|
4894
5224
|
# @return [String]
|
4895
5225
|
#
|
4896
5226
|
# @!attribute [rw] reason
|
4897
5227
|
# A message to attach to the job that explains the reason for
|
4898
5228
|
# canceling it. This message is returned by future DescribeJobs
|
4899
|
-
# operations on the job. This message is also recorded in the
|
4900
|
-
#
|
5229
|
+
# operations on the job. This message is also recorded in the Batch
|
5230
|
+
# activity logs.
|
4901
5231
|
# @return [String]
|
4902
5232
|
#
|
4903
5233
|
# @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/TerminateJobRequest AWS API Documentation
|
@@ -4915,7 +5245,8 @@ module Aws::Batch
|
|
4915
5245
|
|
4916
5246
|
# The container path, mount options, and size of the tmpfs mount.
|
4917
5247
|
#
|
4918
|
-
# <note markdown="1"> This object isn't applicable to jobs running on Fargate
|
5248
|
+
# <note markdown="1"> This object isn't applicable to jobs that are running on Fargate
|
5249
|
+
# resources.
|
4919
5250
|
#
|
4920
5251
|
# </note>
|
4921
5252
|
#
|
@@ -4964,7 +5295,8 @@ module Aws::Batch
|
|
4964
5295
|
|
4965
5296
|
# The `ulimit` settings to pass to the container.
|
4966
5297
|
#
|
4967
|
-
# <note markdown="1"> This object isn't applicable to jobs running on Fargate
|
5298
|
+
# <note markdown="1"> This object isn't applicable to jobs that are running on Fargate
|
5299
|
+
# resources.
|
4968
5300
|
#
|
4969
5301
|
# </note>
|
4970
5302
|
#
|
@@ -5009,9 +5341,9 @@ module Aws::Batch
|
|
5009
5341
|
#
|
5010
5342
|
# @!attribute [rw] resource_arn
|
5011
5343
|
# The Amazon Resource Name (ARN) of the resource from which to delete
|
5012
|
-
# tags.
|
5013
|
-
#
|
5014
|
-
#
|
5344
|
+
# tags. Batch resources that support tags are compute environments,
|
5345
|
+
# jobs, job definitions, and job queues. ARNs for child jobs of array
|
5346
|
+
# and multi-node parallel (MNP) jobs are not supported.
|
5015
5347
|
# @return [String]
|
5016
5348
|
#
|
5017
5349
|
# @!attribute [rw] tag_keys
|
@@ -5059,13 +5391,13 @@ module Aws::Batch
|
|
5059
5391
|
# `ENABLED` state can accept jobs from a queue and scale in or out
|
5060
5392
|
# automatically based on the workload demand of its associated queues.
|
5061
5393
|
#
|
5062
|
-
# If the state is `ENABLED`, then the
|
5063
|
-
#
|
5394
|
+
# If the state is `ENABLED`, then the Batch scheduler can attempt to
|
5395
|
+
# place jobs from an associated job queue on the compute resources
|
5064
5396
|
# within the environment. If the compute environment is managed, then
|
5065
5397
|
# it can scale its instances out or in automatically, based on the job
|
5066
5398
|
# queue demand.
|
5067
5399
|
#
|
5068
|
-
# If the state is `DISABLED`, then the
|
5400
|
+
# If the state is `DISABLED`, then the Batch scheduler doesn't
|
5069
5401
|
# attempt to place jobs within the environment. Jobs in a `STARTING`
|
5070
5402
|
# or `RUNNING` state continue to progress normally. Managed compute
|
5071
5403
|
# environments in the `DISABLED` state don't scale out. However, they
|
@@ -5075,7 +5407,7 @@ module Aws::Batch
|
|
5075
5407
|
# @!attribute [rw] compute_resources
|
5076
5408
|
# Details of the compute resources managed by the compute environment.
|
5077
5409
|
# Required for a managed compute environment. For more information,
|
5078
|
-
# see [Compute Environments][1] in the *
|
5410
|
+
# see [Compute Environments][1] in the *Batch User Guide*.
|
5079
5411
|
#
|
5080
5412
|
#
|
5081
5413
|
#
|
@@ -5083,21 +5415,26 @@ module Aws::Batch
|
|
5083
5415
|
# @return [Types::ComputeResourceUpdate]
|
5084
5416
|
#
|
5085
5417
|
# @!attribute [rw] service_role
|
5086
|
-
# The full Amazon Resource Name (ARN) of the IAM role that allows
|
5087
|
-
# Batch to make calls to other
|
5088
|
-
# information, see [
|
5089
|
-
# User Guide*.
|
5418
|
+
# The full Amazon Resource Name (ARN) of the IAM role that allows
|
5419
|
+
# Batch to make calls to other Amazon Web Services services on your
|
5420
|
+
# behalf. For more information, see [Batch service IAM role][1] in the
|
5421
|
+
# *Batch User Guide*.
|
5422
|
+
#
|
5423
|
+
# If the compute environment has a service-linked role, it can't be
|
5424
|
+
# changed to use a regular IAM role. Likewise, if the compute
|
5425
|
+
# environment has a regular IAM role, it can't be changed to use a
|
5426
|
+
# service-linked role.
|
5090
5427
|
#
|
5091
5428
|
# If your specified role has a path other than `/`, then you must
|
5092
5429
|
# either specify the full role ARN (this is recommended) or prefix the
|
5093
5430
|
# role name with the path.
|
5094
5431
|
#
|
5095
|
-
# <note markdown="1"> Depending on how you created your
|
5096
|
-
#
|
5097
|
-
#
|
5098
|
-
#
|
5099
|
-
#
|
5100
|
-
#
|
5432
|
+
# <note markdown="1"> Depending on how you created your Batch service role, its ARN might
|
5433
|
+
# contain the `service-role` path prefix. When you only specify the
|
5434
|
+
# name of the service role, Batch assumes that your ARN doesn't use
|
5435
|
+
# the `service-role` path prefix. Because of this, we recommend that
|
5436
|
+
# you specify the full ARN of your service role when you create
|
5437
|
+
# compute environments.
|
5101
5438
|
#
|
5102
5439
|
# </note>
|
5103
5440
|
#
|
@@ -5158,9 +5495,9 @@ module Aws::Batch
|
|
5158
5495
|
#
|
5159
5496
|
# @!attribute [rw] state
|
5160
5497
|
# Describes the queue's ability to accept new jobs. If the job queue
|
5161
|
-
# state is `ENABLED`, it
|
5162
|
-
#
|
5163
|
-
#
|
5498
|
+
# state is `ENABLED`, it can accept jobs. If the job queue state is
|
5499
|
+
# `DISABLED`, new jobs can't be added to the queue, but jobs already
|
5500
|
+
# in the queue can finish.
|
5164
5501
|
# @return [String]
|
5165
5502
|
#
|
5166
5503
|
# @!attribute [rw] priority
|
@@ -5171,7 +5508,7 @@ module Aws::Batch
|
|
5171
5508
|
# priority value of `10` is given scheduling preference over a job
|
5172
5509
|
# queue with a priority value of `1`. All of the compute environments
|
5173
5510
|
# must be either EC2 (`EC2` or `SPOT`) or Fargate (`FARGATE` or
|
5174
|
-
# `FARGATE_SPOT`)
|
5511
|
+
# `FARGATE_SPOT`). EC2 and Fargate compute environments can't be
|
5175
5512
|
# mixed.
|
5176
5513
|
# @return [Integer]
|
5177
5514
|
#
|
@@ -5182,12 +5519,12 @@ module Aws::Batch
|
|
5182
5519
|
# should run a given job. Compute environments must be in the `VALID`
|
5183
5520
|
# state before you can associate them with a job queue. All of the
|
5184
5521
|
# compute environments must be either EC2 (`EC2` or `SPOT`) or Fargate
|
5185
|
-
# (`FARGATE` or `FARGATE_SPOT`)
|
5522
|
+
# (`FARGATE` or `FARGATE_SPOT`). EC2 and Fargate compute environments
|
5186
5523
|
# can't be mixed.
|
5187
5524
|
#
|
5188
5525
|
# <note markdown="1"> All compute environments that are associated with a job queue must
|
5189
|
-
# share the same architecture.
|
5190
|
-
#
|
5526
|
+
# share the same architecture. Batch doesn't support mixing compute
|
5527
|
+
# environment architecture types in a single job queue.
|
5191
5528
|
#
|
5192
5529
|
# </note>
|
5193
5530
|
# @return [Array<Types::ComputeEnvironmentOrder>]
|
@@ -5230,6 +5567,16 @@ module Aws::Batch
|
|
5230
5567
|
# source_path: "String",
|
5231
5568
|
# },
|
5232
5569
|
# name: "String",
|
5570
|
+
# efs_volume_configuration: {
|
5571
|
+
# file_system_id: "String", # required
|
5572
|
+
# root_directory: "String",
|
5573
|
+
# transit_encryption: "ENABLED", # accepts ENABLED, DISABLED
|
5574
|
+
# transit_encryption_port: 1,
|
5575
|
+
# authorization_config: {
|
5576
|
+
# access_point_id: "String",
|
5577
|
+
# iam: "ENABLED", # accepts ENABLED, DISABLED
|
5578
|
+
# },
|
5579
|
+
# },
|
5233
5580
|
# }
|
5234
5581
|
#
|
5235
5582
|
# @!attribute [rw] host
|
@@ -5240,7 +5587,7 @@ module Aws::Batch
|
|
5240
5587
|
# guaranteed to persist after the containers associated with it stop
|
5241
5588
|
# running.
|
5242
5589
|
#
|
5243
|
-
# <note markdown="1"> This parameter isn't applicable to jobs running on Fargate
|
5590
|
+
# <note markdown="1"> This parameter isn't applicable to jobs that are running on Fargate
|
5244
5591
|
# resources and shouldn't be provided.
|
5245
5592
|
#
|
5246
5593
|
# </note>
|
@@ -5253,11 +5600,19 @@ module Aws::Batch
|
|
5253
5600
|
# `mountPoints`.
|
5254
5601
|
# @return [String]
|
5255
5602
|
#
|
5603
|
+
# @!attribute [rw] efs_volume_configuration
|
5604
|
+
# This parameter is specified when you are using an Amazon Elastic
|
5605
|
+
# File System file system for job storage. Jobs that are running on
|
5606
|
+
# Fargate resources must specify a `platformVersion` of at least
|
5607
|
+
# `1.4.0`.
|
5608
|
+
# @return [Types::EFSVolumeConfiguration]
|
5609
|
+
#
|
5256
5610
|
# @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/Volume AWS API Documentation
|
5257
5611
|
#
|
5258
5612
|
class Volume < Struct.new(
|
5259
5613
|
:host,
|
5260
|
-
:name
|
5614
|
+
:name,
|
5615
|
+
:efs_volume_configuration)
|
5261
5616
|
SENSITIVE = []
|
5262
5617
|
include Aws::Structure
|
5263
5618
|
end
|