aws-sdk-batch 1.47.0 → 1.48.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 +5 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-batch.rb +1 -1
- data/lib/aws-sdk-batch/client.rb +165 -104
- data/lib/aws-sdk-batch/client_api.rb +10 -0
- data/lib/aws-sdk-batch/types.rb +461 -347
- metadata +3 -4
@@ -93,8 +93,10 @@ module Aws::Batch
|
|
93
93
|
JobSummaryList = Shapes::ListShape.new(name: 'JobSummaryList')
|
94
94
|
JobTimeout = Shapes::StructureShape.new(name: 'JobTimeout')
|
95
95
|
KeyValuePair = Shapes::StructureShape.new(name: 'KeyValuePair')
|
96
|
+
KeyValuesPair = Shapes::StructureShape.new(name: 'KeyValuesPair')
|
96
97
|
LaunchTemplateSpecification = Shapes::StructureShape.new(name: 'LaunchTemplateSpecification')
|
97
98
|
LinuxParameters = Shapes::StructureShape.new(name: 'LinuxParameters')
|
99
|
+
ListJobsFilterList = Shapes::ListShape.new(name: 'ListJobsFilterList')
|
98
100
|
ListJobsRequest = Shapes::StructureShape.new(name: 'ListJobsRequest')
|
99
101
|
ListJobsResponse = Shapes::StructureShape.new(name: 'ListJobsResponse')
|
100
102
|
ListTagsForResourceRequest = Shapes::StructureShape.new(name: 'ListTagsForResourceRequest')
|
@@ -490,6 +492,7 @@ module Aws::Batch
|
|
490
492
|
JobSummary.add_member(:container, Shapes::ShapeRef.new(shape: ContainerSummary, location_name: "container"))
|
491
493
|
JobSummary.add_member(:array_properties, Shapes::ShapeRef.new(shape: ArrayPropertiesSummary, location_name: "arrayProperties"))
|
492
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"))
|
493
496
|
JobSummary.struct_class = Types::JobSummary
|
494
497
|
|
495
498
|
JobSummaryList.member = Shapes::ShapeRef.new(shape: JobSummary)
|
@@ -501,6 +504,10 @@ module Aws::Batch
|
|
501
504
|
KeyValuePair.add_member(:value, Shapes::ShapeRef.new(shape: String, location_name: "value"))
|
502
505
|
KeyValuePair.struct_class = Types::KeyValuePair
|
503
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
|
+
|
504
511
|
LaunchTemplateSpecification.add_member(:launch_template_id, Shapes::ShapeRef.new(shape: String, location_name: "launchTemplateId"))
|
505
512
|
LaunchTemplateSpecification.add_member(:launch_template_name, Shapes::ShapeRef.new(shape: String, location_name: "launchTemplateName"))
|
506
513
|
LaunchTemplateSpecification.add_member(:version, Shapes::ShapeRef.new(shape: String, location_name: "version"))
|
@@ -514,12 +521,15 @@ module Aws::Batch
|
|
514
521
|
LinuxParameters.add_member(:swappiness, Shapes::ShapeRef.new(shape: Integer, location_name: "swappiness"))
|
515
522
|
LinuxParameters.struct_class = Types::LinuxParameters
|
516
523
|
|
524
|
+
ListJobsFilterList.member = Shapes::ShapeRef.new(shape: KeyValuesPair)
|
525
|
+
|
517
526
|
ListJobsRequest.add_member(:job_queue, Shapes::ShapeRef.new(shape: String, location_name: "jobQueue"))
|
518
527
|
ListJobsRequest.add_member(:array_job_id, Shapes::ShapeRef.new(shape: String, location_name: "arrayJobId"))
|
519
528
|
ListJobsRequest.add_member(:multi_node_job_id, Shapes::ShapeRef.new(shape: String, location_name: "multiNodeJobId"))
|
520
529
|
ListJobsRequest.add_member(:job_status, Shapes::ShapeRef.new(shape: JobStatus, location_name: "jobStatus"))
|
521
530
|
ListJobsRequest.add_member(:max_results, Shapes::ShapeRef.new(shape: Integer, location_name: "maxResults"))
|
522
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"))
|
523
533
|
ListJobsRequest.struct_class = Types::ListJobsRequest
|
524
534
|
|
525
535
|
ListJobsResponse.add_member(:job_summary_list, Shapes::ShapeRef.new(shape: JobSummaryList, required: true, location_name: "jobSummaryList"))
|
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,21 +411,21 @@ 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,
|
426
|
+
# available, Batch waits for the additional instances to be
|
428
427
|
# available. If there aren't enough instances available, or if the
|
429
|
-
# user is
|
428
|
+
# user is reaching [Amazon EC2 service limits][1] then additional
|
430
429
|
# jobs aren't run until the currently running jobs have completed.
|
431
430
|
# This allocation strategy keeps costs lower but can limit scaling.
|
432
431
|
# If you are using Spot Fleets with `BEST_FIT` then the Spot Fleet
|
@@ -434,24 +433,24 @@ module Aws::Batch
|
|
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>
|
@@ -502,7 +501,7 @@ module Aws::Batch
|
|
502
501
|
# select instance types (from the C4, M4, and R4 instance families)
|
503
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,7 +548,7 @@ module Aws::Batch
|
|
549
548
|
# @return [String]
|
550
549
|
#
|
551
550
|
# @!attribute [rw] subnets
|
552
|
-
# The VPC subnets
|
551
|
+
# The VPC subnets where the compute resources are launched. These
|
553
552
|
# subnets must be within the same VPC. Fargate compute resources can
|
554
553
|
# contain up to 16 subnets. For more information, see [VPCs and
|
555
554
|
# Subnets][1] in the *Amazon VPC User Guide*.
|
@@ -564,10 +563,10 @@ module Aws::Batch
|
|
564
563
|
# the compute environment. One or more security groups must be
|
565
564
|
# specified, either in `securityGroupIds` or using a launch template
|
566
565
|
# referenced in `launchTemplate`. This parameter is required for jobs
|
567
|
-
# running on Fargate resources and must contain at least one
|
568
|
-
# group. Fargate doesn't support launch templates. If
|
569
|
-
# are specified using both `securityGroupIds` and
|
570
|
-
# 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.
|
571
570
|
# @return [Array<String>]
|
572
571
|
#
|
573
572
|
# @!attribute [rw] ec2_key_pair
|
@@ -575,7 +574,7 @@ module Aws::Batch
|
|
575
574
|
# compute environment. You can use this key pair to log in to your
|
576
575
|
# instances with SSH.
|
577
576
|
#
|
578
|
-
# <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
|
579
578
|
# resources, and shouldn't be specified.
|
580
579
|
#
|
581
580
|
# </note>
|
@@ -587,10 +586,10 @@ module Aws::Batch
|
|
587
586
|
# Resource Name (ARN) of an instance profile. For example, `
|
588
587
|
# ecsInstanceRole ` or
|
589
588
|
# `arn:aws:iam::<aws_account_id>:instance-profile/ecsInstanceRole `.
|
590
|
-
# For more information, see [Amazon ECS Instance Role][1] in the
|
591
|
-
# Batch User Guide*.
|
589
|
+
# For more information, see [Amazon ECS Instance Role][1] in the
|
590
|
+
# *Batch User Guide*.
|
592
591
|
#
|
593
|
-
# <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
|
594
593
|
# resources, and shouldn't be specified.
|
595
594
|
#
|
596
595
|
# </note>
|
@@ -602,17 +601,17 @@ module Aws::Batch
|
|
602
601
|
#
|
603
602
|
# @!attribute [rw] tags
|
604
603
|
# Key-value pair tags to be applied to EC2 resources that are launched
|
605
|
-
# in the compute environment. For
|
604
|
+
# in the compute environment. For Batch, these take the form of
|
606
605
|
# "String1": "String2", where String1 is the tag key and String2
|
607
|
-
# is the tag value−for example,
|
608
|
-
# C4OnDemand"
|
606
|
+
# is the tag value−for example, `\{ "Name": "Batch Instance -
|
607
|
+
# C4OnDemand" \}`. This is helpful for recognizing your Batch
|
609
608
|
# instances in the Amazon EC2 console. These tags can't be updated or
|
610
|
-
# removed after the compute environment
|
611
|
-
# require
|
612
|
-
# compute environment. These tags aren't seen when
|
613
|
-
# 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.
|
614
613
|
#
|
615
|
-
# <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
|
616
615
|
# resources, and shouldn't be specified.
|
617
616
|
#
|
618
617
|
# </note>
|
@@ -628,7 +627,7 @@ module Aws::Batch
|
|
628
627
|
# potential. For more information, see [Placement Groups][1] in the
|
629
628
|
# *Amazon EC2 User Guide for Linux Instances*.
|
630
629
|
#
|
631
|
-
# <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
|
632
631
|
# resources, and shouldn't be specified.
|
633
632
|
#
|
634
633
|
# </note>
|
@@ -648,7 +647,7 @@ module Aws::Batch
|
|
648
647
|
# If you leave this field empty, the default value is 100% of the
|
649
648
|
# On-Demand price.
|
650
649
|
#
|
651
|
-
# <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
|
652
651
|
# resources, and shouldn't be specified.
|
653
652
|
#
|
654
653
|
# </note>
|
@@ -659,9 +658,9 @@ module Aws::Batch
|
|
659
658
|
# applied to a `SPOT` compute environment. This role is required if
|
660
659
|
# the allocation strategy set to `BEST_FIT` or if the allocation
|
661
660
|
# strategy isn't specified. For more information, see [Amazon EC2
|
662
|
-
# Spot Fleet Role][1] in the *
|
661
|
+
# Spot Fleet Role][1] in the *Batch User Guide*.
|
663
662
|
#
|
664
|
-
# <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
|
665
664
|
# resources, and shouldn't be specified.
|
666
665
|
#
|
667
666
|
# </note>
|
@@ -671,7 +670,7 @@ module Aws::Batch
|
|
671
670
|
# managed policy. The previously recommended
|
672
671
|
# **AmazonEC2SpotFleetRole** managed policy doesn't have the required
|
673
672
|
# permissions to tag Spot Instances. For more information, see [Spot
|
674
|
-
# Instances not tagged on creation][2] in the *
|
673
|
+
# Instances not tagged on creation][2] in the *Batch User Guide*.
|
675
674
|
#
|
676
675
|
#
|
677
676
|
#
|
@@ -685,10 +684,10 @@ module Aws::Batch
|
|
685
684
|
# CreateComputeEnvironment API operation override the same parameters
|
686
685
|
# in the launch template. You must specify either the launch template
|
687
686
|
# ID or launch template name in the request, but not both. For more
|
688
|
-
# information, see [Launch Template Support][1] in the *
|
687
|
+
# information, see [Launch Template Support][1] in the *Batch User
|
689
688
|
# Guide*.
|
690
689
|
#
|
691
|
-
# <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
|
692
691
|
# resources, and shouldn't be specified.
|
693
692
|
#
|
694
693
|
# </note>
|
@@ -703,7 +702,7 @@ module Aws::Batch
|
|
703
702
|
# EC2 instances in the compute environment. If `Ec2Configuration`
|
704
703
|
# isn't specified, the default is `ECS_AL1`.
|
705
704
|
#
|
706
|
-
# <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
|
707
706
|
# resources, and shouldn't be specified.
|
708
707
|
#
|
709
708
|
# </note>
|
@@ -735,7 +734,7 @@ module Aws::Batch
|
|
735
734
|
|
736
735
|
# An object representing the attributes of a compute environment that
|
737
736
|
# can be updated. For more information, see [Compute Environments][1] in
|
738
|
-
# the *
|
737
|
+
# the *Batch User Guide*.
|
739
738
|
#
|
740
739
|
#
|
741
740
|
#
|
@@ -756,7 +755,7 @@ module Aws::Batch
|
|
756
755
|
# The minimum number of Amazon EC2 vCPUs that an environment should
|
757
756
|
# maintain.
|
758
757
|
#
|
759
|
-
# <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
|
760
759
|
# resources, and shouldn't be specified.
|
761
760
|
#
|
762
761
|
# </note>
|
@@ -767,10 +766,10 @@ module Aws::Batch
|
|
767
766
|
# reach.
|
768
767
|
#
|
769
768
|
# <note markdown="1"> With both `BEST_FIT_PROGRESSIVE` and `SPOT_CAPACITY_OPTIMIZED`
|
770
|
-
# allocation strategies,
|
771
|
-
#
|
772
|
-
#
|
773
|
-
#
|
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
|
774
773
|
# environment.
|
775
774
|
#
|
776
775
|
# </note>
|
@@ -779,19 +778,19 @@ module Aws::Batch
|
|
779
778
|
# @!attribute [rw] desiredv_cpus
|
780
779
|
# The desired number of Amazon EC2 vCPUS in the compute environment.
|
781
780
|
#
|
782
|
-
# <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
|
783
782
|
# resources, and shouldn't be specified.
|
784
783
|
#
|
785
784
|
# </note>
|
786
785
|
# @return [Integer]
|
787
786
|
#
|
788
787
|
# @!attribute [rw] subnets
|
789
|
-
# The VPC subnets
|
790
|
-
#
|
791
|
-
#
|
792
|
-
#
|
793
|
-
#
|
794
|
-
#
|
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*.
|
795
794
|
#
|
796
795
|
#
|
797
796
|
#
|
@@ -868,9 +867,9 @@ module Aws::Batch
|
|
868
867
|
# @return [String]
|
869
868
|
#
|
870
869
|
# @!attribute [rw] execution_role_arn
|
871
|
-
# The Amazon Resource Name (ARN) of the execution role that
|
872
|
-
#
|
873
|
-
#
|
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*.
|
874
873
|
#
|
875
874
|
#
|
876
875
|
#
|
@@ -885,7 +884,7 @@ module Aws::Batch
|
|
885
884
|
# The environment variables to pass to a container.
|
886
885
|
#
|
887
886
|
# <note markdown="1"> Environment variables must not start with `AWS_BATCH`; this naming
|
888
|
-
# convention is reserved for variables that are set by the
|
887
|
+
# convention is reserved for variables that are set by the Batch
|
889
888
|
# service.
|
890
889
|
#
|
891
890
|
# </note>
|
@@ -913,7 +912,7 @@ module Aws::Batch
|
|
913
912
|
# maps to `Ulimits` in the [Create a container][1] section of the
|
914
913
|
# [Docker Remote API][2] and the `--ulimit` option to [docker run][3].
|
915
914
|
#
|
916
|
-
# <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
|
917
916
|
# resources.
|
918
917
|
#
|
919
918
|
# </note>
|
@@ -930,7 +929,7 @@ module Aws::Batch
|
|
930
929
|
# permissions on the host container instance (similar to the `root`
|
931
930
|
# user). The default value is false.
|
932
931
|
#
|
933
|
-
# <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
|
934
933
|
# resources and shouldn't be provided, or specified as false.
|
935
934
|
#
|
936
935
|
# </note>
|
@@ -970,16 +969,16 @@ module Aws::Batch
|
|
970
969
|
#
|
971
970
|
# @!attribute [rw] log_stream_name
|
972
971
|
# The name of the CloudWatch Logs log stream associated with the
|
973
|
-
# container. The log group for
|
974
|
-
#
|
975
|
-
#
|
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.
|
976
975
|
# @return [String]
|
977
976
|
#
|
978
977
|
# @!attribute [rw] instance_type
|
979
978
|
# The instance type of the underlying host infrastructure of a
|
980
979
|
# multi-node parallel job.
|
981
980
|
#
|
982
|
-
# <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
|
983
982
|
# resources.
|
984
983
|
#
|
985
984
|
# </note>
|
@@ -1015,10 +1014,10 @@ module Aws::Batch
|
|
1015
1014
|
# log drivers, see [Configure logging drivers][4] in the Docker
|
1016
1015
|
# documentation.
|
1017
1016
|
#
|
1018
|
-
# <note markdown="1">
|
1019
|
-
#
|
1020
|
-
#
|
1021
|
-
#
|
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.
|
1022
1021
|
#
|
1023
1022
|
# </note>
|
1024
1023
|
#
|
@@ -1049,7 +1048,7 @@ module Aws::Batch
|
|
1049
1048
|
#
|
1050
1049
|
# @!attribute [rw] secrets
|
1051
1050
|
# The secrets to pass to the container. For more information, see
|
1052
|
-
# [Specifying sensitive data][1] in the *
|
1051
|
+
# [Specifying sensitive data][1] in the *Batch User Guide*.
|
1053
1052
|
#
|
1054
1053
|
#
|
1055
1054
|
#
|
@@ -1057,13 +1056,15 @@ module Aws::Batch
|
|
1057
1056
|
# @return [Array<Types::Secret>]
|
1058
1057
|
#
|
1059
1058
|
# @!attribute [rw] network_configuration
|
1060
|
-
# The network configuration for jobs running on Fargate
|
1061
|
-
# 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.
|
1062
1062
|
# @return [Types::NetworkConfiguration]
|
1063
1063
|
#
|
1064
1064
|
# @!attribute [rw] fargate_platform_configuration
|
1065
|
-
# The platform configuration for jobs running on Fargate
|
1066
|
-
# 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.
|
1067
1068
|
# @return [Types::FargatePlatformConfiguration]
|
1068
1069
|
#
|
1069
1070
|
# @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/ContainerDetail AWS API Documentation
|
@@ -1127,23 +1128,22 @@ module Aws::Batch
|
|
1127
1128
|
# This parameter indicates the number of vCPUs reserved for the
|
1128
1129
|
# container.It overrides the `vcpus` parameter that's set in the job
|
1129
1130
|
# definition, but doesn't override any vCPU requirement specified in
|
1130
|
-
# the `resourceRequirement` structure in the job definition.
|
1131
|
-
#
|
1132
|
-
#
|
1133
|
-
#
|
1134
|
-
#
|
1135
|
-
# resources, you can use either this parameter or
|
1136
|
-
# `resourceRequirement` but not both.
|
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.
|
1137
1136
|
#
|
1138
1137
|
# This parameter maps to `CpuShares` in the [Create a container][1]
|
1139
1138
|
# section of the [Docker Remote API][2] and the `--cpu-shares` option
|
1140
1139
|
# to [docker run][3]. Each vCPU is equivalent to 1,024 CPU shares. You
|
1141
1140
|
# must specify at least one vCPU.
|
1142
1141
|
#
|
1143
|
-
# <note markdown="1"> This parameter
|
1144
|
-
#
|
1145
|
-
# resources, you
|
1146
|
-
#
|
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.
|
1147
1147
|
#
|
1148
1148
|
# </note>
|
1149
1149
|
#
|
@@ -1159,7 +1159,10 @@ module Aws::Batch
|
|
1159
1159
|
# reserved for the job. It overrides the `memory` parameter set in the
|
1160
1160
|
# job definition, but doesn't override any memory requirement
|
1161
1161
|
# specified in the `ResourceRequirement` structure in the job
|
1162
|
-
# definition.
|
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.
|
1163
1166
|
#
|
1164
1167
|
# This parameter is supported for jobs that run on EC2 resources, but
|
1165
1168
|
# isn't supported for jobs that run on Fargate resources. For these
|
@@ -1175,7 +1178,7 @@ module Aws::Batch
|
|
1175
1178
|
# The instance type to use for a multi-node parallel job.
|
1176
1179
|
#
|
1177
1180
|
# <note markdown="1"> This parameter isn't applicable to single-node container jobs or
|
1178
|
-
#
|
1181
|
+
# jobs that run on Fargate resources, and shouldn't be provided.
|
1179
1182
|
#
|
1180
1183
|
# </note>
|
1181
1184
|
# @return [String]
|
@@ -1187,7 +1190,7 @@ module Aws::Batch
|
|
1187
1190
|
# Docker image or the job definition.
|
1188
1191
|
#
|
1189
1192
|
# <note markdown="1"> Environment variables must not start with `AWS_BATCH`; this naming
|
1190
|
-
# convention is reserved for variables that are set by the
|
1193
|
+
# convention is reserved for variables that are set by the Batch
|
1191
1194
|
# service.
|
1192
1195
|
#
|
1193
1196
|
# </note>
|
@@ -1360,7 +1363,7 @@ module Aws::Batch
|
|
1360
1363
|
# 1,024 CPU shares. This parameter maps to `CpuShares` in the [Create
|
1361
1364
|
# a container][1] section of the [Docker Remote API][2] and the
|
1362
1365
|
# `--cpu-shares` option to [docker run][3]. The number of vCPUs must
|
1363
|
-
# be specified but can be
|
1366
|
+
# be specified but can be specified in several places. You must
|
1364
1367
|
# specify it at least once for each node.
|
1365
1368
|
#
|
1366
1369
|
# This parameter is supported on EC2 resources but isn't supported
|
@@ -1368,7 +1371,7 @@ module Aws::Batch
|
|
1368
1371
|
# `resourceRequirement` instead. You can use this parameter or
|
1369
1372
|
# `resourceRequirements` structure but not both.
|
1370
1373
|
#
|
1371
|
-
# <note markdown="1"> This parameter isn't applicable to jobs running on Fargate
|
1374
|
+
# <note markdown="1"> This parameter isn't applicable to jobs that are running on Fargate
|
1372
1375
|
# resources and shouldn't be provided. For jobs that run on Fargate
|
1373
1376
|
# resources, you must specify the vCPU requirement for the job using
|
1374
1377
|
# `resourceRequirements`.
|
@@ -1385,7 +1388,7 @@ module Aws::Batch
|
|
1385
1388
|
# @!attribute [rw] memory
|
1386
1389
|
# This parameter indicates the memory hard limit (in MiB) for a
|
1387
1390
|
# container. If your container attempts to exceed the specified
|
1388
|
-
# number, it
|
1391
|
+
# number, it's terminated. You must specify at least 4 MiB of memory
|
1389
1392
|
# for a job using this parameter. The memory hard limit can be
|
1390
1393
|
# specified in several places. It must be specified for each node at
|
1391
1394
|
# least once.
|
@@ -1396,12 +1399,12 @@ module Aws::Batch
|
|
1396
1399
|
#
|
1397
1400
|
# This parameter is supported on EC2 resources but isn't supported on
|
1398
1401
|
# Fargate resources. For Fargate resources, you should specify the
|
1399
|
-
# memory requirement using `resourceRequirement`. You can do this
|
1400
|
-
# EC2 resources.
|
1402
|
+
# memory requirement using `resourceRequirement`. You can also do this
|
1403
|
+
# for EC2 resources.
|
1401
1404
|
#
|
1402
1405
|
# <note markdown="1"> If you're trying to maximize your resource utilization by providing
|
1403
1406
|
# your jobs as much memory as possible for a particular instance type,
|
1404
|
-
# see [Memory Management][4] in the *
|
1407
|
+
# see [Memory Management][4] in the *Batch User Guide*.
|
1405
1408
|
#
|
1406
1409
|
# </note>
|
1407
1410
|
#
|
@@ -1430,9 +1433,9 @@ module Aws::Batch
|
|
1430
1433
|
#
|
1431
1434
|
# @!attribute [rw] job_role_arn
|
1432
1435
|
# The Amazon Resource Name (ARN) of the IAM role that the container
|
1433
|
-
# can assume for
|
1434
|
-
# for Tasks][1] in the *Amazon Elastic
|
1435
|
-
# 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*.
|
1436
1439
|
#
|
1437
1440
|
#
|
1438
1441
|
#
|
@@ -1440,10 +1443,10 @@ module Aws::Batch
|
|
1440
1443
|
# @return [String]
|
1441
1444
|
#
|
1442
1445
|
# @!attribute [rw] execution_role_arn
|
1443
|
-
# The Amazon Resource Name (ARN) of the execution role that
|
1444
|
-
#
|
1445
|
-
#
|
1446
|
-
#
|
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*.
|
1447
1450
|
#
|
1448
1451
|
#
|
1449
1452
|
#
|
@@ -1463,7 +1466,7 @@ module Aws::Batch
|
|
1463
1466
|
# sensitive information, such as credential data.
|
1464
1467
|
#
|
1465
1468
|
# <note markdown="1"> Environment variables must not start with `AWS_BATCH`; this naming
|
1466
|
-
# convention is reserved for variables that are set by the
|
1469
|
+
# convention is reserved for variables that are set by the Batch
|
1467
1470
|
# service.
|
1468
1471
|
#
|
1469
1472
|
# </note>
|
@@ -1507,7 +1510,7 @@ module Aws::Batch
|
|
1507
1510
|
# `--privileged` option to [docker run][3]. The default value is
|
1508
1511
|
# false.
|
1509
1512
|
#
|
1510
|
-
# <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
|
1511
1514
|
# resources and shouldn't be provided, or specified as false.
|
1512
1515
|
#
|
1513
1516
|
# </note>
|
@@ -1524,7 +1527,7 @@ module Aws::Batch
|
|
1524
1527
|
# `Ulimits` in the [Create a container][1] section of the [Docker
|
1525
1528
|
# Remote API][2] and the `--ulimit` option to [docker run][3].
|
1526
1529
|
#
|
1527
|
-
# <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
|
1528
1531
|
# resources and shouldn't be provided.
|
1529
1532
|
#
|
1530
1533
|
# </note>
|
@@ -1553,7 +1556,7 @@ module Aws::Batch
|
|
1553
1556
|
# groups in a multi-node parallel job must use the same instance type.
|
1554
1557
|
#
|
1555
1558
|
# <note markdown="1"> This parameter isn't applicable to single-node container jobs or
|
1556
|
-
#
|
1559
|
+
# jobs that run on Fargate resources, and shouldn't be provided.
|
1557
1560
|
#
|
1558
1561
|
# </note>
|
1559
1562
|
# @return [String]
|
@@ -1583,9 +1586,8 @@ module Aws::Batch
|
|
1583
1586
|
# options for different supported log drivers, see [Configure logging
|
1584
1587
|
# drivers][4] in the Docker documentation.
|
1585
1588
|
#
|
1586
|
-
# <note markdown="1">
|
1587
|
-
#
|
1588
|
-
# 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).
|
1589
1591
|
#
|
1590
1592
|
# </note>
|
1591
1593
|
#
|
@@ -1616,7 +1618,7 @@ module Aws::Batch
|
|
1616
1618
|
#
|
1617
1619
|
# @!attribute [rw] secrets
|
1618
1620
|
# The secrets for the container. For more information, see [Specifying
|
1619
|
-
# sensitive data][1] in the *
|
1621
|
+
# sensitive data][1] in the *Batch User Guide*.
|
1620
1622
|
#
|
1621
1623
|
#
|
1622
1624
|
#
|
@@ -1624,13 +1626,15 @@ module Aws::Batch
|
|
1624
1626
|
# @return [Array<Types::Secret>]
|
1625
1627
|
#
|
1626
1628
|
# @!attribute [rw] network_configuration
|
1627
|
-
# The network configuration for jobs running on Fargate
|
1628
|
-
# 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.
|
1629
1632
|
# @return [Types::NetworkConfiguration]
|
1630
1633
|
#
|
1631
1634
|
# @!attribute [rw] fargate_platform_configuration
|
1632
|
-
# The platform configuration for jobs running on Fargate
|
1633
|
-
# 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.
|
1634
1638
|
# @return [Types::FargatePlatformConfiguration]
|
1635
1639
|
#
|
1636
1640
|
# @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/ContainerProperties AWS API Documentation
|
@@ -1732,8 +1736,8 @@ module Aws::Batch
|
|
1732
1736
|
#
|
1733
1737
|
# @!attribute [rw] type
|
1734
1738
|
# The type of the compute environment: `MANAGED` or `UNMANAGED`. For
|
1735
|
-
# more information, see [Compute Environments][1] in the *
|
1736
|
-
#
|
1739
|
+
# more information, see [Compute Environments][1] in the *Batch User
|
1740
|
+
# Guide*.
|
1737
1741
|
#
|
1738
1742
|
#
|
1739
1743
|
#
|
@@ -1745,13 +1749,13 @@ module Aws::Batch
|
|
1745
1749
|
# then the compute environment accepts jobs from a queue and can scale
|
1746
1750
|
# out automatically based on queues.
|
1747
1751
|
#
|
1748
|
-
# If the state is `ENABLED`, then the
|
1749
|
-
#
|
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
|
1750
1754
|
# within the environment. If the compute environment is managed, then
|
1751
1755
|
# it can scale its instances out or in automatically, based on the job
|
1752
1756
|
# queue demand.
|
1753
1757
|
#
|
1754
|
-
# If the state is `DISABLED`, then the
|
1758
|
+
# If the state is `DISABLED`, then the Batch scheduler doesn't
|
1755
1759
|
# attempt to place jobs within the environment. Jobs in a `STARTING`
|
1756
1760
|
# or `RUNNING` state continue to progress normally. Managed compute
|
1757
1761
|
# environments in the `DISABLED` state don't scale out. However, they
|
@@ -1762,7 +1766,7 @@ module Aws::Batch
|
|
1762
1766
|
# Details about the compute resources managed by the compute
|
1763
1767
|
# environment. This parameter is required for managed compute
|
1764
1768
|
# environments. For more information, see [Compute Environments][1] in
|
1765
|
-
# the *
|
1769
|
+
# the *Batch User Guide*.
|
1766
1770
|
#
|
1767
1771
|
#
|
1768
1772
|
#
|
@@ -1770,16 +1774,16 @@ module Aws::Batch
|
|
1770
1774
|
# @return [Types::ComputeResource]
|
1771
1775
|
#
|
1772
1776
|
# @!attribute [rw] service_role
|
1773
|
-
# The full Amazon Resource Name (ARN) of the IAM role that allows
|
1774
|
-
# Batch to make calls to other
|
1775
|
-
# information, see [
|
1776
|
-
# User Guide*.
|
1777
|
-
#
|
1778
|
-
# If your account
|
1779
|
-
# role
|
1780
|
-
#
|
1781
|
-
#
|
1782
|
-
# service
|
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
|
1783
1787
|
# account.
|
1784
1788
|
#
|
1785
1789
|
# If your specified role has a path other than `/`, then you must
|
@@ -1789,12 +1793,12 @@ module Aws::Batch
|
|
1789
1793
|
# For more information, see [Friendly names and paths][2] in the *IAM
|
1790
1794
|
# User Guide*.
|
1791
1795
|
#
|
1792
|
-
# <note markdown="1"> Depending on how you created your
|
1793
|
-
#
|
1794
|
-
#
|
1795
|
-
#
|
1796
|
-
#
|
1797
|
-
#
|
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.
|
1798
1802
|
#
|
1799
1803
|
# </note>
|
1800
1804
|
#
|
@@ -1807,8 +1811,8 @@ module Aws::Batch
|
|
1807
1811
|
# @!attribute [rw] tags
|
1808
1812
|
# The tags that you apply to the compute environment to help you
|
1809
1813
|
# categorize and organize your resources. Each tag consists of a key
|
1810
|
-
# and an optional value. For more information, see [Tagging
|
1811
|
-
# 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*.
|
1812
1816
|
#
|
1813
1817
|
# These tags can be updated or removed using the [TagResource][2] and
|
1814
1818
|
# [UntagResource][3] API operations. These tags don't propagate to
|
@@ -1892,7 +1896,7 @@ module Aws::Batch
|
|
1892
1896
|
# priority value of `10` is given scheduling preference over a job
|
1893
1897
|
# queue with a priority value of `1`. All of the compute environments
|
1894
1898
|
# must be either EC2 (`EC2` or `SPOT`) or Fargate (`FARGATE` or
|
1895
|
-
# `FARGATE_SPOT`); EC2 and Fargate compute environments
|
1899
|
+
# `FARGATE_SPOT`); EC2 and Fargate compute environments can't be
|
1896
1900
|
# mixed.
|
1897
1901
|
# @return [Integer]
|
1898
1902
|
#
|
@@ -1908,8 +1912,8 @@ module Aws::Batch
|
|
1908
1912
|
# can't be mixed.
|
1909
1913
|
#
|
1910
1914
|
# <note markdown="1"> All compute environments that are associated with a job queue must
|
1911
|
-
# share the same architecture.
|
1912
|
-
#
|
1915
|
+
# share the same architecture. Batch doesn't support mixing compute
|
1916
|
+
# environment architecture types in a single job queue.
|
1913
1917
|
#
|
1914
1918
|
# </note>
|
1915
1919
|
# @return [Array<Types::ComputeEnvironmentOrder>]
|
@@ -1917,8 +1921,8 @@ module Aws::Batch
|
|
1917
1921
|
# @!attribute [rw] tags
|
1918
1922
|
# The tags that you apply to the job queue to help you categorize and
|
1919
1923
|
# organize your resources. Each tag consists of a key and an optional
|
1920
|
-
# value. For more information, see [Tagging your
|
1921
|
-
#
|
1924
|
+
# value. For more information, see [Tagging your Batch resources][1]
|
1925
|
+
# in *Batch User Guide*.
|
1922
1926
|
#
|
1923
1927
|
#
|
1924
1928
|
#
|
@@ -2119,8 +2123,11 @@ module Aws::Batch
|
|
2119
2123
|
# }
|
2120
2124
|
#
|
2121
2125
|
# @!attribute [rw] job_definitions
|
2122
|
-
# A list of up to 100 job
|
2123
|
-
#
|
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\}`.
|
2124
2131
|
# @return [Array<String>]
|
2125
2132
|
#
|
2126
2133
|
# @!attribute [rw] max_results
|
@@ -2299,8 +2306,8 @@ module Aws::Batch
|
|
2299
2306
|
|
2300
2307
|
# An object representing a container instance host device.
|
2301
2308
|
#
|
2302
|
-
# <note markdown="1"> This object isn't applicable to jobs running on Fargate
|
2303
|
-
# 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.
|
2304
2311
|
#
|
2305
2312
|
# </note>
|
2306
2313
|
#
|
@@ -2318,8 +2325,8 @@ module Aws::Batch
|
|
2318
2325
|
# @return [String]
|
2319
2326
|
#
|
2320
2327
|
# @!attribute [rw] container_path
|
2321
|
-
# The path inside the container used to expose the host
|
2322
|
-
# 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.
|
2323
2330
|
# @return [String]
|
2324
2331
|
#
|
2325
2332
|
# @!attribute [rw] permissions
|
@@ -2365,18 +2372,18 @@ module Aws::Batch
|
|
2365
2372
|
# @return [String]
|
2366
2373
|
#
|
2367
2374
|
# @!attribute [rw] iam
|
2368
|
-
# Whether or not to use the
|
2369
|
-
#
|
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,
|
2370
2377
|
# transit encryption must be enabled in the `EFSVolumeConfiguration`.
|
2371
2378
|
# If this parameter is omitted, the default value of `DISABLED` is
|
2372
2379
|
# used. For more information, see [Using Amazon EFS Access Points][1]
|
2373
|
-
# in the *
|
2380
|
+
# in the *Batch User Guide*. EFS IAM authorization requires that
|
2374
2381
|
# `TransitEncryption` be `ENABLED` and that a `JobRoleArn` is
|
2375
2382
|
# specified.
|
2376
2383
|
#
|
2377
2384
|
#
|
2378
2385
|
#
|
2379
|
-
# [1]: https://docs.aws.amazon.com/batch/latest/
|
2386
|
+
# [1]: https://docs.aws.amazon.com/batch/latest/userguide/efs-volumes.html#efs-volume-accesspoints
|
2380
2387
|
# @return [String]
|
2381
2388
|
#
|
2382
2389
|
# @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/EFSAuthorizationConfig AWS API Documentation
|
@@ -2388,13 +2395,13 @@ module Aws::Batch
|
|
2388
2395
|
include Aws::Structure
|
2389
2396
|
end
|
2390
2397
|
|
2391
|
-
# This
|
2392
|
-
#
|
2393
|
-
#
|
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*.
|
2394
2401
|
#
|
2395
2402
|
#
|
2396
2403
|
#
|
2397
|
-
# [1]: https://docs.aws.amazon.com/batch/latest/
|
2404
|
+
# [1]: https://docs.aws.amazon.com/batch/latest/userguide/efs-volumes.html
|
2398
2405
|
#
|
2399
2406
|
# @note When making an API call, you may pass EFSVolumeConfiguration
|
2400
2407
|
# data as a hash:
|
@@ -2417,21 +2424,22 @@ module Aws::Batch
|
|
2417
2424
|
# @!attribute [rw] root_directory
|
2418
2425
|
# The directory within the Amazon EFS file system to mount as the root
|
2419
2426
|
# directory inside the host. If this parameter is omitted, the root of
|
2420
|
-
# the Amazon EFS volume
|
2421
|
-
#
|
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.
|
2422
2430
|
#
|
2423
2431
|
# If an EFS access point is specified in the `authorizationConfig`,
|
2424
|
-
# the root directory parameter must either be omitted or set to
|
2425
|
-
# which
|
2432
|
+
# the root directory parameter must either be omitted or set to `/`,
|
2433
|
+
# which enforces the path set on the Amazon EFS access point.
|
2426
2434
|
# @return [String]
|
2427
2435
|
#
|
2428
2436
|
# @!attribute [rw] transit_encryption
|
2429
|
-
#
|
2430
|
-
# between the Amazon ECS host and the Amazon EFS server.
|
2431
|
-
# encryption must be enabled if Amazon EFS IAM authorization
|
2432
|
-
# If this parameter is omitted, the default value of
|
2433
|
-
# used. For more information, see [Encrypting data in
|
2434
|
-
# the *Amazon Elastic File System User Guide*.
|
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*.
|
2435
2443
|
#
|
2436
2444
|
#
|
2437
2445
|
#
|
@@ -2440,10 +2448,11 @@ module Aws::Batch
|
|
2440
2448
|
#
|
2441
2449
|
# @!attribute [rw] transit_encryption_port
|
2442
2450
|
# The port to use when sending encrypted data between the Amazon ECS
|
2443
|
-
# host and the Amazon EFS server. If you
|
2444
|
-
# encryption port, it
|
2445
|
-
#
|
2446
|
-
# Helper][1] in the *Amazon Elastic
|
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*.
|
2447
2456
|
#
|
2448
2457
|
#
|
2449
2458
|
#
|
@@ -2470,10 +2479,11 @@ module Aws::Batch
|
|
2470
2479
|
# Provides information used to select Amazon Machine Images (AMIs) for
|
2471
2480
|
# instances in the compute environment. If `Ec2Configuration` isn't
|
2472
2481
|
# specified, the default is currently `ECS_AL1` ([Amazon Linux][1]) for
|
2473
|
-
# non-GPU, non
|
2482
|
+
# non-GPU, non AWSGraviton instances. Starting on March 31, 2021, this
|
2474
2483
|
# default will be changing to `ECS_AL2` ([Amazon Linux 2][2]).
|
2475
2484
|
#
|
2476
|
-
# <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.
|
2477
2487
|
#
|
2478
2488
|
# </note>
|
2479
2489
|
#
|
@@ -2499,21 +2509,22 @@ module Aws::Batch
|
|
2499
2509
|
#
|
2500
2510
|
# ECS\_AL2
|
2501
2511
|
#
|
2502
|
-
# : [Amazon Linux 2][2]− Default for all
|
2503
|
-
# families (for example, `C6g`, `M6g`,
|
2504
|
-
# 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.
|
2505
2515
|
#
|
2506
2516
|
# ECS\_AL2\_NVIDIA
|
2507
2517
|
#
|
2508
2518
|
# : [Amazon Linux 2 (GPU)][3]−Default for all GPU instance families
|
2509
|
-
# (for example `P4` and `G4`) and can be used for all non
|
2510
|
-
# 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.
|
2511
2521
|
#
|
2512
2522
|
# ECS\_AL1
|
2513
2523
|
#
|
2514
|
-
# : [Amazon Linux][4]−Default for all non-GPU, non
|
2515
|
-
# instance families. Amazon Linux is reaching the
|
2516
|
-
# 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].
|
2517
2528
|
#
|
2518
2529
|
#
|
2519
2530
|
#
|
@@ -2554,7 +2565,7 @@ module Aws::Batch
|
|
2554
2565
|
#
|
2555
2566
|
# @!attribute [rw] on_status_reason
|
2556
2567
|
# Contains a glob pattern to match against the `StatusReason` returned
|
2557
|
-
# for a job. The pattern can be up to 512 characters
|
2568
|
+
# for a job. The pattern can be up to 512 characters in length. It can
|
2558
2569
|
# contain letters, numbers, periods (.), colons (:), and white space
|
2559
2570
|
# (including spaces or tabs). It can optionally end with an asterisk
|
2560
2571
|
# (*) so that only the start of the string needs to be an exact
|
@@ -2563,8 +2574,8 @@ module Aws::Batch
|
|
2563
2574
|
#
|
2564
2575
|
# @!attribute [rw] on_reason
|
2565
2576
|
# Contains a glob pattern to match against the `Reason` returned for a
|
2566
|
-
# job. The pattern can be up to 512 characters
|
2567
|
-
# letters, numbers, periods (.), colons (:), and white space
|
2577
|
+
# job. The pattern can be up to 512 characters in length. It can
|
2578
|
+
# contain letters, numbers, periods (.), colons (:), and white space
|
2568
2579
|
# (including spaces and tabs). It can optionally end with an asterisk
|
2569
2580
|
# (*) so that only the start of the string needs to be an exact
|
2570
2581
|
# match.
|
@@ -2573,9 +2584,9 @@ module Aws::Batch
|
|
2573
2584
|
# @!attribute [rw] on_exit_code
|
2574
2585
|
# Contains a glob pattern to match against the decimal representation
|
2575
2586
|
# of the `ExitCode` returned for a job. The pattern can be up to 512
|
2576
|
-
# characters
|
2577
|
-
# with an asterisk (*) so that only the start of the
|
2578
|
-
# be an exact match.
|
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.
|
2579
2590
|
# @return [String]
|
2580
2591
|
#
|
2581
2592
|
# @!attribute [rw] action
|
@@ -2595,8 +2606,9 @@ module Aws::Batch
|
|
2595
2606
|
include Aws::Structure
|
2596
2607
|
end
|
2597
2608
|
|
2598
|
-
# The platform configuration for jobs running on Fargate
|
2599
|
-
#
|
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.
|
2600
2612
|
#
|
2601
2613
|
# @note When making an API call, you may pass FargatePlatformConfiguration
|
2602
2614
|
# data as a hash:
|
@@ -2606,13 +2618,13 @@ module Aws::Batch
|
|
2606
2618
|
# }
|
2607
2619
|
#
|
2608
2620
|
# @!attribute [rw] platform_version
|
2609
|
-
# The
|
2610
|
-
#
|
2621
|
+
# The Fargate platform version where the jobs are running. A platform
|
2622
|
+
# version is specified only for jobs that are running on Fargate
|
2611
2623
|
# resources. If one isn't specified, the `LATEST` platform version is
|
2612
|
-
# used by default. This uses a recent, approved version of the
|
2613
|
-
#
|
2614
|
-
#
|
2615
|
-
#
|
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*.
|
2616
2628
|
#
|
2617
2629
|
#
|
2618
2630
|
#
|
@@ -2664,7 +2676,7 @@ module Aws::Batch
|
|
2664
2676
|
include Aws::Structure
|
2665
2677
|
end
|
2666
2678
|
|
2667
|
-
# An object representing an
|
2679
|
+
# An object representing an Batch job definition.
|
2668
2680
|
#
|
2669
2681
|
# @!attribute [rw] job_definition_name
|
2670
2682
|
# The name of the job definition.
|
@@ -2686,7 +2698,7 @@ module Aws::Batch
|
|
2686
2698
|
# The type of job definition. If the job is run on Fargate resources,
|
2687
2699
|
# then `multinode` isn't supported. For more information about
|
2688
2700
|
# multi-node parallel jobs, see [Creating a multi-node parallel job
|
2689
|
-
# definition][1] in the *
|
2701
|
+
# definition][1] in the *Batch User Guide*.
|
2690
2702
|
#
|
2691
2703
|
#
|
2692
2704
|
#
|
@@ -2699,7 +2711,7 @@ module Aws::Batch
|
|
2699
2711
|
# pair mapping. Parameters in a `SubmitJob` request override any
|
2700
2712
|
# corresponding parameter defaults from the job definition. For more
|
2701
2713
|
# information about specifying parameters, see [Job Definition
|
2702
|
-
# Parameters][1] in the *
|
2714
|
+
# Parameters][1] in the *Batch User Guide*.
|
2703
2715
|
#
|
2704
2716
|
#
|
2705
2717
|
#
|
@@ -2717,7 +2729,7 @@ module Aws::Batch
|
|
2717
2729
|
#
|
2718
2730
|
# @!attribute [rw] timeout
|
2719
2731
|
# The timeout configuration for jobs that are submitted with this job
|
2720
|
-
# definition. You can specify a timeout duration after which
|
2732
|
+
# definition. You can specify a timeout duration after which Batch
|
2721
2733
|
# terminates your jobs if they haven't finished.
|
2722
2734
|
# @return [Types::JobTimeout]
|
2723
2735
|
#
|
@@ -2771,7 +2783,7 @@ module Aws::Batch
|
|
2771
2783
|
include Aws::Structure
|
2772
2784
|
end
|
2773
2785
|
|
2774
|
-
# An object representing an
|
2786
|
+
# An object representing an Batch job dependency.
|
2775
2787
|
#
|
2776
2788
|
# @note When making an API call, you may pass JobDependency
|
2777
2789
|
# data as a hash:
|
@@ -2782,7 +2794,7 @@ module Aws::Batch
|
|
2782
2794
|
# }
|
2783
2795
|
#
|
2784
2796
|
# @!attribute [rw] job_id
|
2785
|
-
# The job ID of the
|
2797
|
+
# The job ID of the Batch job associated with this dependency.
|
2786
2798
|
# @return [String]
|
2787
2799
|
#
|
2788
2800
|
# @!attribute [rw] type
|
@@ -2798,7 +2810,7 @@ module Aws::Batch
|
|
2798
2810
|
include Aws::Structure
|
2799
2811
|
end
|
2800
2812
|
|
2801
|
-
# An object representing an
|
2813
|
+
# An object representing an Batch job.
|
2802
2814
|
#
|
2803
2815
|
# @!attribute [rw] job_arn
|
2804
2816
|
# The Amazon Resource Name (ARN) of the job.
|
@@ -2821,7 +2833,7 @@ module Aws::Batch
|
|
2821
2833
|
# The current status for the job.
|
2822
2834
|
#
|
2823
2835
|
# <note markdown="1"> If your jobs don't progress to `STARTING`, see [Jobs Stuck in
|
2824
|
-
# RUNNABLE Status][1] in the troubleshooting section of the *
|
2836
|
+
# RUNNABLE Status][1] in the troubleshooting section of the *Batch
|
2825
2837
|
# User Guide*.
|
2826
2838
|
#
|
2827
2839
|
# </note>
|
@@ -2893,7 +2905,8 @@ module Aws::Batch
|
|
2893
2905
|
# An object representing the node properties of a multi-node parallel
|
2894
2906
|
# job.
|
2895
2907
|
#
|
2896
|
-
# <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.
|
2897
2910
|
#
|
2898
2911
|
# </note>
|
2899
2912
|
# @return [Types::NodeProperties]
|
@@ -2955,7 +2968,7 @@ module Aws::Batch
|
|
2955
2968
|
include Aws::Structure
|
2956
2969
|
end
|
2957
2970
|
|
2958
|
-
# An object representing the details of an
|
2971
|
+
# An object representing the details of an Batch job queue.
|
2959
2972
|
#
|
2960
2973
|
# @!attribute [rw] job_queue_name
|
2961
2974
|
# The name of the job queue.
|
@@ -3001,7 +3014,7 @@ module Aws::Batch
|
|
3001
3014
|
#
|
3002
3015
|
# @!attribute [rw] tags
|
3003
3016
|
# The tags applied to the job queue. For more information, see
|
3004
|
-
# [Tagging your
|
3017
|
+
# [Tagging your Batch resources][1] in *Batch User Guide*.
|
3005
3018
|
#
|
3006
3019
|
#
|
3007
3020
|
#
|
@@ -3077,11 +3090,16 @@ module Aws::Batch
|
|
3077
3090
|
# @!attribute [rw] node_properties
|
3078
3091
|
# The node properties for a single node in a job summary list.
|
3079
3092
|
#
|
3080
|
-
# <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.
|
3081
3095
|
#
|
3082
3096
|
# </note>
|
3083
3097
|
# @return [Types::NodePropertiesSummary]
|
3084
3098
|
#
|
3099
|
+
# @!attribute [rw] job_definition
|
3100
|
+
# The Amazon Resource Name (ARN) of the job definition.
|
3101
|
+
# @return [String]
|
3102
|
+
#
|
3085
3103
|
# @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/JobSummary AWS API Documentation
|
3086
3104
|
#
|
3087
3105
|
class JobSummary < Struct.new(
|
@@ -3095,7 +3113,8 @@ module Aws::Batch
|
|
3095
3113
|
:stopped_at,
|
3096
3114
|
:container,
|
3097
3115
|
:array_properties,
|
3098
|
-
:node_properties
|
3116
|
+
:node_properties,
|
3117
|
+
:job_definition)
|
3099
3118
|
SENSITIVE = []
|
3100
3119
|
include Aws::Structure
|
3101
3120
|
end
|
@@ -3111,7 +3130,7 @@ module Aws::Batch
|
|
3111
3130
|
#
|
3112
3131
|
# @!attribute [rw] attempt_duration_seconds
|
3113
3132
|
# The time duration in seconds (measured from the job attempt's
|
3114
|
-
# `startedAt` timestamp) after which
|
3133
|
+
# `startedAt` timestamp) after which Batch terminates your jobs if
|
3115
3134
|
# they have not finished. The minimum value for the timeout is 60
|
3116
3135
|
# seconds.
|
3117
3136
|
# @return [Integer]
|
@@ -3153,6 +3172,34 @@ module Aws::Batch
|
|
3153
3172
|
include Aws::Structure
|
3154
3173
|
end
|
3155
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
|
+
|
3156
3203
|
# An object representing a launch template associated with a compute
|
3157
3204
|
# resource. You must specify either the launch template ID or launch
|
3158
3205
|
# template name in the request, but not both.
|
@@ -3162,7 +3209,8 @@ module Aws::Batch
|
|
3162
3209
|
# values in the `securityGroupIds` parameter of
|
3163
3210
|
# `CreateComputeEnvironment` will be used.
|
3164
3211
|
#
|
3165
|
-
# <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.
|
3166
3214
|
#
|
3167
3215
|
# </note>
|
3168
3216
|
#
|
@@ -3191,7 +3239,7 @@ module Aws::Batch
|
|
3191
3239
|
# launch template is used.
|
3192
3240
|
#
|
3193
3241
|
# After the compute environment is created, the launch template
|
3194
|
-
# version used
|
3242
|
+
# version that's used isn't changed, even if the `$Default` or
|
3195
3243
|
# `$Latest` version for the launch template is updated. To use a new
|
3196
3244
|
# launch template version, create a new compute environment, add the
|
3197
3245
|
# new compute environment to the existing job queue, remove the old
|
@@ -3243,7 +3291,7 @@ module Aws::Batch
|
|
3243
3291
|
# `Devices` in the [Create a container][1] section of the [Docker
|
3244
3292
|
# Remote API][2] and the `--device` option to [docker run][3].
|
3245
3293
|
#
|
3246
|
-
# <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
|
3247
3295
|
# resources and shouldn't be provided.
|
3248
3296
|
#
|
3249
3297
|
# </note>
|
@@ -3273,7 +3321,7 @@ module Aws::Batch
|
|
3273
3321
|
# The value for the size (in MiB) of the `/dev/shm` volume. This
|
3274
3322
|
# parameter maps to the `--shm-size` option to [docker run][1].
|
3275
3323
|
#
|
3276
|
-
# <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
|
3277
3325
|
# resources and shouldn't be provided.
|
3278
3326
|
#
|
3279
3327
|
# </note>
|
@@ -3288,7 +3336,7 @@ module Aws::Batch
|
|
3288
3336
|
# mount. This parameter maps to the `--tmpfs` option to [docker
|
3289
3337
|
# run][1].
|
3290
3338
|
#
|
3291
|
-
# <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
|
3292
3340
|
# resources and shouldn't be provided.
|
3293
3341
|
#
|
3294
3342
|
# </note>
|
@@ -3312,7 +3360,7 @@ module Aws::Batch
|
|
3312
3360
|
# `maxSwap` value must be set for the `swappiness` parameter to be
|
3313
3361
|
# used.
|
3314
3362
|
#
|
3315
|
-
# <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
|
3316
3364
|
# resources and shouldn't be provided.
|
3317
3365
|
#
|
3318
3366
|
# </note>
|
@@ -3330,9 +3378,10 @@ module Aws::Batch
|
|
3330
3378
|
# be swapped very aggressively. Accepted values are whole numbers
|
3331
3379
|
# between `0` and `100`. If the `swappiness` parameter isn't
|
3332
3380
|
# specified, a default value of `60` is used. If a value isn't
|
3333
|
-
# specified for `maxSwap
|
3334
|
-
# is set to 0, the container doesn't use swap. This
|
3335
|
-
# 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].
|
3336
3385
|
#
|
3337
3386
|
# Consider the following when you use a per-container swap
|
3338
3387
|
# configuration.
|
@@ -3357,7 +3406,7 @@ module Aws::Batch
|
|
3357
3406
|
# value of 60, and the total swap usage will be limited to two times
|
3358
3407
|
# the memory reservation of the container.
|
3359
3408
|
#
|
3360
|
-
# <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
|
3361
3410
|
# resources and shouldn't be provided.
|
3362
3411
|
#
|
3363
3412
|
# </note>
|
@@ -3394,6 +3443,12 @@ module Aws::Batch
|
|
3394
3443
|
# job_status: "SUBMITTED", # accepts SUBMITTED, PENDING, RUNNABLE, STARTING, RUNNING, SUCCEEDED, FAILED
|
3395
3444
|
# max_results: 1,
|
3396
3445
|
# next_token: "String",
|
3446
|
+
# filters: [
|
3447
|
+
# {
|
3448
|
+
# name: "String",
|
3449
|
+
# values: ["String"],
|
3450
|
+
# },
|
3451
|
+
# ],
|
3397
3452
|
# }
|
3398
3453
|
#
|
3399
3454
|
# @!attribute [rw] job_queue
|
@@ -3413,8 +3468,10 @@ module Aws::Batch
|
|
3413
3468
|
# @return [String]
|
3414
3469
|
#
|
3415
3470
|
# @!attribute [rw] job_status
|
3416
|
-
# The job status used to filter jobs in the specified queue. If
|
3417
|
-
#
|
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.
|
3418
3475
|
# @return [String]
|
3419
3476
|
#
|
3420
3477
|
# @!attribute [rw] max_results
|
@@ -3442,6 +3499,56 @@ module Aws::Batch
|
|
3442
3499
|
# </note>
|
3443
3500
|
# @return [String]
|
3444
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
|
+
#
|
3445
3552
|
# @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/ListJobsRequest AWS API Documentation
|
3446
3553
|
#
|
3447
3554
|
class ListJobsRequest < Struct.new(
|
@@ -3450,7 +3557,8 @@ module Aws::Batch
|
|
3450
3557
|
:multi_node_job_id,
|
3451
3558
|
:job_status,
|
3452
3559
|
:max_results,
|
3453
|
-
:next_token
|
3560
|
+
:next_token,
|
3561
|
+
:filters)
|
3454
3562
|
SENSITIVE = []
|
3455
3563
|
include Aws::Structure
|
3456
3564
|
end
|
@@ -3484,10 +3592,9 @@ module Aws::Batch
|
|
3484
3592
|
#
|
3485
3593
|
# @!attribute [rw] resource_arn
|
3486
3594
|
# The Amazon Resource Name (ARN) that identifies the resource that
|
3487
|
-
# tags are listed for.
|
3488
|
-
#
|
3489
|
-
#
|
3490
|
-
# 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.
|
3491
3598
|
# @return [String]
|
3492
3599
|
#
|
3493
3600
|
# @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/ListTagsForResourceRequest AWS API Documentation
|
@@ -3537,17 +3644,17 @@ module Aws::Batch
|
|
3537
3644
|
# The supported log drivers are `awslogs`, `fluentd`, `gelf`,
|
3538
3645
|
# `json-file`, `journald`, `logentries`, `syslog`, and `splunk`.
|
3539
3646
|
#
|
3540
|
-
# <note markdown="1"> Jobs running on Fargate resources are restricted to the
|
3541
|
-
# 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.
|
3542
3649
|
#
|
3543
3650
|
# </note>
|
3544
3651
|
#
|
3545
3652
|
# awslogs
|
3546
3653
|
#
|
3547
3654
|
# : Specifies the Amazon CloudWatch Logs logging driver. For more
|
3548
|
-
# information, see [Using the awslogs Log Driver][1] in the *
|
3549
|
-
#
|
3550
|
-
#
|
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.
|
3551
3658
|
#
|
3552
3659
|
# fluentd
|
3553
3660
|
#
|
@@ -3624,7 +3731,7 @@ module Aws::Batch
|
|
3624
3731
|
#
|
3625
3732
|
# @!attribute [rw] secret_options
|
3626
3733
|
# The secrets to pass to the log configuration. For more information,
|
3627
|
-
# see [Specifying Sensitive Data][1] in the *
|
3734
|
+
# see [Specifying Sensitive Data][1] in the *Batch User Guide*.
|
3628
3735
|
#
|
3629
3736
|
#
|
3630
3737
|
#
|
@@ -3683,8 +3790,9 @@ module Aws::Batch
|
|
3683
3790
|
include Aws::Structure
|
3684
3791
|
end
|
3685
3792
|
|
3686
|
-
# The network configuration for jobs running on Fargate
|
3687
|
-
# 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.
|
3688
3796
|
#
|
3689
3797
|
# @note When making an API call, you may pass NetworkConfiguration
|
3690
3798
|
# data as a hash:
|
@@ -3695,8 +3803,8 @@ module Aws::Batch
|
|
3695
3803
|
#
|
3696
3804
|
# @!attribute [rw] assign_public_ip
|
3697
3805
|
# Indicates whether the job should have a public IP address. For a job
|
3698
|
-
# running on Fargate resources in a private subnet to send
|
3699
|
-
# 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
|
3700
3808
|
# images), the private subnet requires a NAT gateway be attached to
|
3701
3809
|
# route requests to the internet. For more information, see [Amazon
|
3702
3810
|
# ECS task networking][1]. The default value is "DISABLED".
|
@@ -3764,8 +3872,8 @@ module Aws::Batch
|
|
3764
3872
|
# Object representing any node overrides to a job definition that's
|
3765
3873
|
# used in a SubmitJob API operation.
|
3766
3874
|
#
|
3767
|
-
# <note markdown="1"> This isn't applicable to jobs running on Fargate resources
|
3768
|
-
# 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.
|
3769
3877
|
#
|
3770
3878
|
# </note>
|
3771
3879
|
#
|
@@ -4430,7 +4538,7 @@ module Aws::Batch
|
|
4430
4538
|
# @!attribute [rw] type
|
4431
4539
|
# The type of job definition. For more information about multi-node
|
4432
4540
|
# parallel jobs, see [Creating a multi-node parallel job
|
4433
|
-
# definition][1] in the *
|
4541
|
+
# definition][1] in the *Batch User Guide*.
|
4434
4542
|
#
|
4435
4543
|
# <note markdown="1"> If the job is run on Fargate resources, then `multinode` isn't
|
4436
4544
|
# supported.
|
@@ -4465,7 +4573,7 @@ module Aws::Batch
|
|
4465
4573
|
# An object with various properties specific to multi-node parallel
|
4466
4574
|
# jobs. If you specify node properties for a job, it becomes a
|
4467
4575
|
# multi-node parallel job. For more information, see [Multi-node
|
4468
|
-
# Parallel Jobs][1] in the *
|
4576
|
+
# Parallel Jobs][1] in the *Batch User Guide*. If the job
|
4469
4577
|
# definition's `type` parameter is `container`, then you must specify
|
4470
4578
|
# either `containerProperties` or `nodeProperties`.
|
4471
4579
|
#
|
@@ -4498,12 +4606,12 @@ module Aws::Batch
|
|
4498
4606
|
#
|
4499
4607
|
# @!attribute [rw] timeout
|
4500
4608
|
# The timeout configuration for jobs that are submitted with this job
|
4501
|
-
# definition, after which
|
4502
|
-
#
|
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
|
4503
4611
|
# retried. The minimum value for the timeout is 60 seconds. Any
|
4504
4612
|
# timeout configuration that's specified during a SubmitJob operation
|
4505
4613
|
# overrides the timeout configuration defined here. For more
|
4506
|
-
# information, see [Job Timeouts][1] in the *
|
4614
|
+
# information, see [Job Timeouts][1] in the *Batch User Guide*.
|
4507
4615
|
#
|
4508
4616
|
#
|
4509
4617
|
#
|
@@ -4513,8 +4621,8 @@ module Aws::Batch
|
|
4513
4621
|
# @!attribute [rw] tags
|
4514
4622
|
# The tags that you apply to the job definition to help you categorize
|
4515
4623
|
# and organize your resources. Each tag consists of a key and an
|
4516
|
-
# optional value. For more information, see [Tagging
|
4517
|
-
# in *
|
4624
|
+
# optional value. For more information, see [Tagging Amazon Web
|
4625
|
+
# Services Resources][1] in *Batch User Guide*.
|
4518
4626
|
#
|
4519
4627
|
#
|
4520
4628
|
#
|
@@ -4588,35 +4696,36 @@ module Aws::Batch
|
|
4588
4696
|
# exceed the number of available GPUs on the compute resource that
|
4589
4697
|
# the job is launched on.
|
4590
4698
|
#
|
4591
|
-
# <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.
|
4592
4701
|
#
|
4593
4702
|
# </note>
|
4594
4703
|
#
|
4595
4704
|
# type="MEMORY"
|
4596
4705
|
#
|
4597
4706
|
# : The memory hard limit (in MiB) present to the container. This
|
4598
|
-
# parameter is supported for jobs running on EC2 resources.
|
4599
|
-
# container attempts to exceed the memory specified, the
|
4600
|
-
# is terminated. This parameter maps to `Memory` in the
|
4601
|
-
# container][1] section of the [Docker Remote API][2] and
|
4602
|
-
# `--memory` option to [docker run][3]. You must specify at
|
4603
|
-
# MiB of memory for a job. This is required but can be
|
4604
|
-
# several places for multi-node parallel (MNP) jobs. It
|
4605
|
-
# specified for each node at least once. This parameter maps
|
4606
|
-
# `Memory` in the [Create a container][1] section of the [Docker
|
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
|
4607
4716
|
# Remote API][2] and the `--memory` option to [docker run][3].
|
4608
4717
|
#
|
4609
4718
|
# <note markdown="1"> If you're trying to maximize your resource utilization by
|
4610
4719
|
# providing your jobs as much memory as possible for a particular
|
4611
|
-
# instance type, see [Memory Management][4] in the *
|
4720
|
+
# instance type, see [Memory Management][4] in the *Batch User
|
4612
4721
|
# Guide*.
|
4613
4722
|
#
|
4614
4723
|
# </note>
|
4615
4724
|
#
|
4616
|
-
# For jobs running on Fargate resources, then `value` is
|
4617
|
-
# limit (in MiB), and must match one of the supported
|
4618
|
-
# `VCPU` values must be one of the values supported
|
4619
|
-
# 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.
|
4620
4729
|
#
|
4621
4730
|
# value = 512
|
4622
4731
|
#
|
@@ -4664,10 +4773,10 @@ module Aws::Batch
|
|
4664
4773
|
# but can be specified in several places; it must be specified for
|
4665
4774
|
# each node at least once.
|
4666
4775
|
#
|
4667
|
-
# For jobs running on Fargate resources, then `value` must
|
4668
|
-
# of the supported values and the `MEMORY` values must be
|
4669
|
-
# values supported for that VCPU value. The supported
|
4670
|
-
# 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
|
4671
4780
|
#
|
4672
4781
|
# value = 0.25
|
4673
4782
|
#
|
@@ -4715,7 +4824,7 @@ module Aws::Batch
|
|
4715
4824
|
end
|
4716
4825
|
|
4717
4826
|
# The retry strategy associated with a job. For more information, see
|
4718
|
-
# [Automated job retries][1] in the *
|
4827
|
+
# [Automated job retries][1] in the *Batch User Guide*.
|
4719
4828
|
#
|
4720
4829
|
#
|
4721
4830
|
#
|
@@ -4767,8 +4876,8 @@ module Aws::Batch
|
|
4767
4876
|
# * To reference sensitive information in the log configuration of a
|
4768
4877
|
# container, use the `secretOptions` container definition parameter.
|
4769
4878
|
#
|
4770
|
-
# For more information, see [Specifying sensitive data][1] in the *
|
4771
|
-
#
|
4879
|
+
# For more information, see [Specifying sensitive data][1] in the *Batch
|
4880
|
+
# User Guide*.
|
4772
4881
|
#
|
4773
4882
|
#
|
4774
4883
|
#
|
@@ -4788,13 +4897,14 @@ module Aws::Batch
|
|
4788
4897
|
#
|
4789
4898
|
# @!attribute [rw] value_from
|
4790
4899
|
# The secret to expose to the container. The supported values are
|
4791
|
-
# either the full ARN of the
|
4792
|
-
#
|
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.
|
4793
4903
|
#
|
4794
|
-
# <note markdown="1"> If the
|
4795
|
-
# same Region as the job you're launching, then you can
|
4796
|
-
# the full ARN or name of the parameter. If the parameter
|
4797
|
-
# 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.
|
4798
4908
|
#
|
4799
4909
|
# </note>
|
4800
4910
|
# @return [String]
|
@@ -4921,7 +5031,7 @@ module Aws::Batch
|
|
4921
5031
|
# The array properties for the submitted job, such as the size of the
|
4922
5032
|
# array. The array size can be between 2 and 10,000. If you specify
|
4923
5033
|
# array properties for a job, it becomes an array job. For more
|
4924
|
-
# information, see [Array Jobs][1] in the *
|
5034
|
+
# information, see [Array Jobs][1] in the *Batch User Guide*.
|
4925
5035
|
#
|
4926
5036
|
#
|
4927
5037
|
#
|
@@ -4967,7 +5077,7 @@ module Aws::Batch
|
|
4967
5077
|
# A list of node overrides in JSON format that specify the node range
|
4968
5078
|
# to target and the container overrides for that node range.
|
4969
5079
|
#
|
4970
|
-
# <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
|
4971
5081
|
# resources; use `containerOverrides` instead.
|
4972
5082
|
#
|
4973
5083
|
# </note>
|
@@ -4992,14 +5102,14 @@ module Aws::Batch
|
|
4992
5102
|
#
|
4993
5103
|
# @!attribute [rw] timeout
|
4994
5104
|
# The timeout configuration for this SubmitJob operation. You can
|
4995
|
-
# specify a timeout duration after which
|
4996
|
-
#
|
4997
|
-
#
|
4998
|
-
#
|
4999
|
-
#
|
5000
|
-
#
|
5001
|
-
#
|
5002
|
-
#
|
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*.
|
5003
5113
|
#
|
5004
5114
|
#
|
5005
5115
|
#
|
@@ -5009,8 +5119,8 @@ module Aws::Batch
|
|
5009
5119
|
# @!attribute [rw] tags
|
5010
5120
|
# The tags that you apply to the job request to help you categorize
|
5011
5121
|
# and organize your resources. Each tag consists of a key and an
|
5012
|
-
# optional value. For more information, see [Tagging
|
5013
|
-
# in *
|
5122
|
+
# optional value. For more information, see [Tagging Amazon Web
|
5123
|
+
# Services Resources][1] in *Amazon Web Services General Reference*.
|
5014
5124
|
#
|
5015
5125
|
#
|
5016
5126
|
#
|
@@ -5070,7 +5180,7 @@ module Aws::Batch
|
|
5070
5180
|
#
|
5071
5181
|
# @!attribute [rw] resource_arn
|
5072
5182
|
# The Amazon Resource Name (ARN) of the resource that tags are added
|
5073
|
-
# to.
|
5183
|
+
# to. Batch resources that support tags are compute environments,
|
5074
5184
|
# jobs, job definitions, and job queues. ARNs for child jobs of array
|
5075
5185
|
# and multi-node parallel (MNP) jobs are not supported.
|
5076
5186
|
# @return [String]
|
@@ -5078,8 +5188,8 @@ module Aws::Batch
|
|
5078
5188
|
# @!attribute [rw] tags
|
5079
5189
|
# The tags that you apply to the resource to help you categorize and
|
5080
5190
|
# organize your resources. Each tag consists of a key and an optional
|
5081
|
-
# value. For more information, see [Tagging
|
5082
|
-
# General Reference*.
|
5191
|
+
# value. For more information, see [Tagging Amazon Web Services
|
5192
|
+
# Resources][1] in *Amazon Web Services General Reference*.
|
5083
5193
|
#
|
5084
5194
|
#
|
5085
5195
|
#
|
@@ -5110,14 +5220,14 @@ module Aws::Batch
|
|
5110
5220
|
# }
|
5111
5221
|
#
|
5112
5222
|
# @!attribute [rw] job_id
|
5113
|
-
# The
|
5223
|
+
# The Batch job ID of the job to terminate.
|
5114
5224
|
# @return [String]
|
5115
5225
|
#
|
5116
5226
|
# @!attribute [rw] reason
|
5117
5227
|
# A message to attach to the job that explains the reason for
|
5118
5228
|
# canceling it. This message is returned by future DescribeJobs
|
5119
|
-
# operations on the job. This message is also recorded in the
|
5120
|
-
#
|
5229
|
+
# operations on the job. This message is also recorded in the Batch
|
5230
|
+
# activity logs.
|
5121
5231
|
# @return [String]
|
5122
5232
|
#
|
5123
5233
|
# @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/TerminateJobRequest AWS API Documentation
|
@@ -5135,7 +5245,8 @@ module Aws::Batch
|
|
5135
5245
|
|
5136
5246
|
# The container path, mount options, and size of the tmpfs mount.
|
5137
5247
|
#
|
5138
|
-
# <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.
|
5139
5250
|
#
|
5140
5251
|
# </note>
|
5141
5252
|
#
|
@@ -5184,7 +5295,8 @@ module Aws::Batch
|
|
5184
5295
|
|
5185
5296
|
# The `ulimit` settings to pass to the container.
|
5186
5297
|
#
|
5187
|
-
# <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.
|
5188
5300
|
#
|
5189
5301
|
# </note>
|
5190
5302
|
#
|
@@ -5229,9 +5341,9 @@ module Aws::Batch
|
|
5229
5341
|
#
|
5230
5342
|
# @!attribute [rw] resource_arn
|
5231
5343
|
# The Amazon Resource Name (ARN) of the resource from which to delete
|
5232
|
-
# tags.
|
5233
|
-
#
|
5234
|
-
#
|
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.
|
5235
5347
|
# @return [String]
|
5236
5348
|
#
|
5237
5349
|
# @!attribute [rw] tag_keys
|
@@ -5279,13 +5391,13 @@ module Aws::Batch
|
|
5279
5391
|
# `ENABLED` state can accept jobs from a queue and scale in or out
|
5280
5392
|
# automatically based on the workload demand of its associated queues.
|
5281
5393
|
#
|
5282
|
-
# If the state is `ENABLED`, then the
|
5283
|
-
#
|
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
|
5284
5396
|
# within the environment. If the compute environment is managed, then
|
5285
5397
|
# it can scale its instances out or in automatically, based on the job
|
5286
5398
|
# queue demand.
|
5287
5399
|
#
|
5288
|
-
# If the state is `DISABLED`, then the
|
5400
|
+
# If the state is `DISABLED`, then the Batch scheduler doesn't
|
5289
5401
|
# attempt to place jobs within the environment. Jobs in a `STARTING`
|
5290
5402
|
# or `RUNNING` state continue to progress normally. Managed compute
|
5291
5403
|
# environments in the `DISABLED` state don't scale out. However, they
|
@@ -5295,7 +5407,7 @@ module Aws::Batch
|
|
5295
5407
|
# @!attribute [rw] compute_resources
|
5296
5408
|
# Details of the compute resources managed by the compute environment.
|
5297
5409
|
# Required for a managed compute environment. For more information,
|
5298
|
-
# see [Compute Environments][1] in the *
|
5410
|
+
# see [Compute Environments][1] in the *Batch User Guide*.
|
5299
5411
|
#
|
5300
5412
|
#
|
5301
5413
|
#
|
@@ -5303,25 +5415,26 @@ module Aws::Batch
|
|
5303
5415
|
# @return [Types::ComputeResourceUpdate]
|
5304
5416
|
#
|
5305
5417
|
# @!attribute [rw] service_role
|
5306
|
-
# The full Amazon Resource Name (ARN) of the IAM role that allows
|
5307
|
-
# Batch to make calls to other
|
5308
|
-
# information, see [
|
5309
|
-
# 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*.
|
5310
5422
|
#
|
5311
|
-
# If the compute environment has a service-linked role, it
|
5312
|
-
# changed to use a regular IAM role.
|
5313
|
-
# regular IAM role, it
|
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.
|
5314
5427
|
#
|
5315
5428
|
# If your specified role has a path other than `/`, then you must
|
5316
5429
|
# either specify the full role ARN (this is recommended) or prefix the
|
5317
5430
|
# role name with the path.
|
5318
5431
|
#
|
5319
|
-
# <note markdown="1"> Depending on how you created your
|
5320
|
-
#
|
5321
|
-
#
|
5322
|
-
#
|
5323
|
-
#
|
5324
|
-
#
|
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.
|
5325
5438
|
#
|
5326
5439
|
# </note>
|
5327
5440
|
#
|
@@ -5410,8 +5523,8 @@ module Aws::Batch
|
|
5410
5523
|
# can't be mixed.
|
5411
5524
|
#
|
5412
5525
|
# <note markdown="1"> All compute environments that are associated with a job queue must
|
5413
|
-
# share the same architecture.
|
5414
|
-
#
|
5526
|
+
# share the same architecture. Batch doesn't support mixing compute
|
5527
|
+
# environment architecture types in a single job queue.
|
5415
5528
|
#
|
5416
5529
|
# </note>
|
5417
5530
|
# @return [Array<Types::ComputeEnvironmentOrder>]
|
@@ -5474,7 +5587,7 @@ module Aws::Batch
|
|
5474
5587
|
# guaranteed to persist after the containers associated with it stop
|
5475
5588
|
# running.
|
5476
5589
|
#
|
5477
|
-
# <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
|
5478
5591
|
# resources and shouldn't be provided.
|
5479
5592
|
#
|
5480
5593
|
# </note>
|
@@ -5489,8 +5602,9 @@ module Aws::Batch
|
|
5489
5602
|
#
|
5490
5603
|
# @!attribute [rw] efs_volume_configuration
|
5491
5604
|
# This parameter is specified when you are using an Amazon Elastic
|
5492
|
-
# File System file system for job storage. Jobs running on
|
5493
|
-
# resources must specify a `platformVersion` of at least
|
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`.
|
5494
5608
|
# @return [Types::EFSVolumeConfiguration]
|
5495
5609
|
#
|
5496
5610
|
# @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/Volume AWS API Documentation
|