aws-sdk-batch 1.46.0 → 1.50.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -63,6 +63,10 @@ module Aws::Batch
63
63
  DeviceCgroupPermission = Shapes::StringShape.new(name: 'DeviceCgroupPermission')
64
64
  DeviceCgroupPermissions = Shapes::ListShape.new(name: 'DeviceCgroupPermissions')
65
65
  DevicesList = Shapes::ListShape.new(name: 'DevicesList')
66
+ EFSAuthorizationConfig = Shapes::StructureShape.new(name: 'EFSAuthorizationConfig')
67
+ EFSAuthorizationConfigIAM = Shapes::StringShape.new(name: 'EFSAuthorizationConfigIAM')
68
+ EFSTransitEncryption = Shapes::StringShape.new(name: 'EFSTransitEncryption')
69
+ EFSVolumeConfiguration = Shapes::StructureShape.new(name: 'EFSVolumeConfiguration')
66
70
  Ec2Configuration = Shapes::StructureShape.new(name: 'Ec2Configuration')
67
71
  Ec2ConfigurationList = Shapes::ListShape.new(name: 'Ec2ConfigurationList')
68
72
  EnvironmentVariables = Shapes::ListShape.new(name: 'EnvironmentVariables')
@@ -89,8 +93,10 @@ module Aws::Batch
89
93
  JobSummaryList = Shapes::ListShape.new(name: 'JobSummaryList')
90
94
  JobTimeout = Shapes::StructureShape.new(name: 'JobTimeout')
91
95
  KeyValuePair = Shapes::StructureShape.new(name: 'KeyValuePair')
96
+ KeyValuesPair = Shapes::StructureShape.new(name: 'KeyValuesPair')
92
97
  LaunchTemplateSpecification = Shapes::StructureShape.new(name: 'LaunchTemplateSpecification')
93
98
  LinuxParameters = Shapes::StructureShape.new(name: 'LinuxParameters')
99
+ ListJobsFilterList = Shapes::ListShape.new(name: 'ListJobsFilterList')
94
100
  ListJobsRequest = Shapes::StructureShape.new(name: 'ListJobsRequest')
95
101
  ListJobsResponse = Shapes::StructureShape.new(name: 'ListJobsResponse')
96
102
  ListTagsForResourceRequest = Shapes::StructureShape.new(name: 'ListTagsForResourceRequest')
@@ -381,6 +387,17 @@ module Aws::Batch
381
387
 
382
388
  DevicesList.member = Shapes::ShapeRef.new(shape: Device)
383
389
 
390
+ EFSAuthorizationConfig.add_member(:access_point_id, Shapes::ShapeRef.new(shape: String, location_name: "accessPointId"))
391
+ EFSAuthorizationConfig.add_member(:iam, Shapes::ShapeRef.new(shape: EFSAuthorizationConfigIAM, location_name: "iam"))
392
+ EFSAuthorizationConfig.struct_class = Types::EFSAuthorizationConfig
393
+
394
+ EFSVolumeConfiguration.add_member(:file_system_id, Shapes::ShapeRef.new(shape: String, required: true, location_name: "fileSystemId"))
395
+ EFSVolumeConfiguration.add_member(:root_directory, Shapes::ShapeRef.new(shape: String, location_name: "rootDirectory"))
396
+ EFSVolumeConfiguration.add_member(:transit_encryption, Shapes::ShapeRef.new(shape: EFSTransitEncryption, location_name: "transitEncryption"))
397
+ EFSVolumeConfiguration.add_member(:transit_encryption_port, Shapes::ShapeRef.new(shape: Integer, location_name: "transitEncryptionPort"))
398
+ EFSVolumeConfiguration.add_member(:authorization_config, Shapes::ShapeRef.new(shape: EFSAuthorizationConfig, location_name: "authorizationConfig"))
399
+ EFSVolumeConfiguration.struct_class = Types::EFSVolumeConfiguration
400
+
384
401
  Ec2Configuration.add_member(:image_type, Shapes::ShapeRef.new(shape: ImageType, required: true, location_name: "imageType"))
385
402
  Ec2Configuration.add_member(:image_id_override, Shapes::ShapeRef.new(shape: ImageIdOverride, location_name: "imageIdOverride"))
386
403
  Ec2Configuration.struct_class = Types::Ec2Configuration
@@ -475,6 +492,7 @@ module Aws::Batch
475
492
  JobSummary.add_member(:container, Shapes::ShapeRef.new(shape: ContainerSummary, location_name: "container"))
476
493
  JobSummary.add_member(:array_properties, Shapes::ShapeRef.new(shape: ArrayPropertiesSummary, location_name: "arrayProperties"))
477
494
  JobSummary.add_member(:node_properties, Shapes::ShapeRef.new(shape: NodePropertiesSummary, location_name: "nodeProperties"))
495
+ JobSummary.add_member(:job_definition, Shapes::ShapeRef.new(shape: String, location_name: "jobDefinition"))
478
496
  JobSummary.struct_class = Types::JobSummary
479
497
 
480
498
  JobSummaryList.member = Shapes::ShapeRef.new(shape: JobSummary)
@@ -486,6 +504,10 @@ module Aws::Batch
486
504
  KeyValuePair.add_member(:value, Shapes::ShapeRef.new(shape: String, location_name: "value"))
487
505
  KeyValuePair.struct_class = Types::KeyValuePair
488
506
 
507
+ KeyValuesPair.add_member(:name, Shapes::ShapeRef.new(shape: String, location_name: "name"))
508
+ KeyValuesPair.add_member(:values, Shapes::ShapeRef.new(shape: StringList, location_name: "values"))
509
+ KeyValuesPair.struct_class = Types::KeyValuesPair
510
+
489
511
  LaunchTemplateSpecification.add_member(:launch_template_id, Shapes::ShapeRef.new(shape: String, location_name: "launchTemplateId"))
490
512
  LaunchTemplateSpecification.add_member(:launch_template_name, Shapes::ShapeRef.new(shape: String, location_name: "launchTemplateName"))
491
513
  LaunchTemplateSpecification.add_member(:version, Shapes::ShapeRef.new(shape: String, location_name: "version"))
@@ -499,12 +521,15 @@ module Aws::Batch
499
521
  LinuxParameters.add_member(:swappiness, Shapes::ShapeRef.new(shape: Integer, location_name: "swappiness"))
500
522
  LinuxParameters.struct_class = Types::LinuxParameters
501
523
 
524
+ ListJobsFilterList.member = Shapes::ShapeRef.new(shape: KeyValuesPair)
525
+
502
526
  ListJobsRequest.add_member(:job_queue, Shapes::ShapeRef.new(shape: String, location_name: "jobQueue"))
503
527
  ListJobsRequest.add_member(:array_job_id, Shapes::ShapeRef.new(shape: String, location_name: "arrayJobId"))
504
528
  ListJobsRequest.add_member(:multi_node_job_id, Shapes::ShapeRef.new(shape: String, location_name: "multiNodeJobId"))
505
529
  ListJobsRequest.add_member(:job_status, Shapes::ShapeRef.new(shape: JobStatus, location_name: "jobStatus"))
506
530
  ListJobsRequest.add_member(:max_results, Shapes::ShapeRef.new(shape: Integer, location_name: "maxResults"))
507
531
  ListJobsRequest.add_member(:next_token, Shapes::ShapeRef.new(shape: String, location_name: "nextToken"))
532
+ ListJobsRequest.add_member(:filters, Shapes::ShapeRef.new(shape: ListJobsFilterList, location_name: "filters"))
508
533
  ListJobsRequest.struct_class = Types::ListJobsRequest
509
534
 
510
535
  ListJobsResponse.add_member(:job_summary_list, Shapes::ShapeRef.new(shape: JobSummaryList, required: true, location_name: "jobSummaryList"))
@@ -696,6 +721,7 @@ module Aws::Batch
696
721
 
697
722
  Volume.add_member(:host, Shapes::ShapeRef.new(shape: Host, location_name: "host"))
698
723
  Volume.add_member(:name, Shapes::ShapeRef.new(shape: String, location_name: "name"))
724
+ Volume.add_member(:efs_volume_configuration, Shapes::ShapeRef.new(shape: EFSVolumeConfiguration, location_name: "efsVolumeConfiguration"))
699
725
  Volume.struct_class = Types::Volume
700
726
 
701
727
  Volumes.member = Shapes::ShapeRef.new(shape: Volume)
@@ -10,7 +10,7 @@
10
10
  module Aws::Batch
11
11
  module Types
12
12
 
13
- # An object representing an AWS Batch array job.
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 AWS Batch jobs is `/aws/batch/job`.
109
- # Each container attempt receives a log stream name when they reach
110
- # the `RUNNING` status.
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 AWS Batch job ID of the job to cancel.
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 AWS
182
- # Batch activity logs.
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 AWS Batch compute environment.
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 *AWS Batch
237
- # User Guide*.
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 AWS Batch scheduler can attempt
249
- # to place jobs from an associated job queue on the compute resources
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 AWS Batch scheduler doesn't
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 *AWS Batch User
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
- # AWS Batch to make calls to AWS API operations on your behalf. For
284
- # more information, see [AWS Batch service IAM role][1] in the *AWS
285
- # Batch User Guide*.
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. AWS Batch doesn't support mixing compute
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 AWS Batch compute resource. For more
354
- # information, see [Compute Environments][1] in the *AWS Batch User
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 *AWS Batch User Guide*.
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 *AWS Batch User Guide*.
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 *AWS Batch User Guide*.
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
- # : AWS Batch selects an instance type that best fits the needs of the
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, AWS Batch waits for the additional instances to be
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 hitting [Amazon EC2 service limits][1] then additional
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
- # : AWS Batch will select additional instance types that are large
438
- # enough to meet the requirements of the jobs in the queue, with a
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, AWS Batch will select new instance types.
440
+ # aren't available, Batch will select new instance types.
442
441
  #
443
442
  # SPOT\_CAPACITY\_OPTIMIZED
444
443
  #
445
- # : AWS Batch will select one or more instance types that are large
446
- # enough to meet the requirements of the jobs in the queue, with a
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, AWS Batch might need to go above `maxvCpus` to meet your
453
- # capacity requirements. In this event, AWS Batch never exceeds
454
- # `maxvCpus` by more than a single instance.
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, AWS Batch might need to exceed `maxvCpus` to
478
- # meet your capacity requirements. In this event, AWS Batch never
479
- # exceeds `maxvCpus` by more than a single instance. For example, no
480
- # more than a single instance from among those specified in your
481
- # compute environment is allocated.
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
- # AWS Batch modifies this value between the minimum and maximum
489
- # values, based on job queue demand.
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 into which the compute resources are launched. These
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 security
568
- # group. Fargate doesn't support launch templates. If security groups
569
- # are specified using both `securityGroupIds` and `launchTemplate`,
570
- # the values in `securityGroupIds` is used.
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 *AWS
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 AWS Batch, these take the form of
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, \\\{ "Name": "AWS Batch Instance -
608
- # C4OnDemand" \\}. This is helpful for recognizing your AWS Batch
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 has been created; any changes
611
- # require creating a new compute environment and removing the old
612
- # compute environment. These tags aren't seen when using the AWS
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 *AWS Batch User Guide*.
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 *AWS Batch User Guide*.
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 *AWS Batch User
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 *AWS Batch User Guide*.
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, AWS Batch might need to exceed `maxvCpus` to
771
- # meet your capacity requirements. In this event, AWS Batch never
772
- # exceeds `maxvCpus` by more than a single instance. That is, no more
773
- # than a single instance from among those specified in your compute
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 that the compute resources are launched into.
790
- # Fargate compute resources can contain up to 16 subnets. Providing an
791
- # empty list will be handled as if this parameter wasn't specified
792
- # and no change is made. This can't be specified for EC2 compute
793
- # resources. For more information, see [VPCs and Subnets][1] in the
794
- # *Amazon VPC User Guide*.
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 AWS Batch
872
- # can assume. For more information, see [AWS Batch execution IAM
873
- # role][1] in the *AWS Batch User Guide*.
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 AWS Batch
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 AWS Batch jobs is `/aws/batch/job`.
974
- # Each container attempt receives a log stream name when they reach
975
- # the `RUNNING` status.
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"> AWS Batch currently supports a subset of the logging drivers
1019
- # available to the Docker daemon (shown in the LogConfiguration data
1020
- # type). Additional log drivers might be available in future releases
1021
- # of the Amazon ECS container agent.
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 *AWS Batch User Guide*.
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 resources.
1061
- # Jobs running on EC2 resources must not specify this parameter.
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 resources.
1066
- # Jobs running on EC2 resources must not specify this parameter.
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
- # This parameter is supported for jobs that run on EC2 resources, but
1133
- # isn't supported for jobs that run on Fargate resources. For Fargate
1134
- # resources, you can only use `resourceRequirement`. For EC2
1135
- # resources, you can use either this parameter or
1136
- # `resourceRequirement` but not both.
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 isn't applicable to jobs that run on Fargate
1144
- # resources and shouldn't be provided. For jobs that run on Fargate
1145
- # resources, you must specify the vCPU requirement for the job using
1146
- # `resourceRequirements`.
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
- # for jobs running on Fargate resources and shouldn't be provided.
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 AWS Batch
1193
+ # convention is reserved for variables that are set by the Batch
1191
1194
  # service.
1192
1195
  #
1193
1196
  # </note>
@@ -1231,6 +1234,16 @@ module Aws::Batch
1231
1234
  # source_path: "String",
1232
1235
  # },
1233
1236
  # name: "String",
1237
+ # efs_volume_configuration: {
1238
+ # file_system_id: "String", # required
1239
+ # root_directory: "String",
1240
+ # transit_encryption: "ENABLED", # accepts ENABLED, DISABLED
1241
+ # transit_encryption_port: 1,
1242
+ # authorization_config: {
1243
+ # access_point_id: "String",
1244
+ # iam: "ENABLED", # accepts ENABLED, DISABLED
1245
+ # },
1246
+ # },
1234
1247
  # },
1235
1248
  # ],
1236
1249
  # environment: [
@@ -1350,7 +1363,7 @@ module Aws::Batch
1350
1363
  # 1,024 CPU shares. This parameter maps to `CpuShares` in the [Create
1351
1364
  # a container][1] section of the [Docker Remote API][2] and the
1352
1365
  # `--cpu-shares` option to [docker run][3]. The number of vCPUs must
1353
- # be specified but can be be specified in several places. You must
1366
+ # be specified but can be specified in several places. You must
1354
1367
  # specify it at least once for each node.
1355
1368
  #
1356
1369
  # This parameter is supported on EC2 resources but isn't supported
@@ -1358,7 +1371,7 @@ module Aws::Batch
1358
1371
  # `resourceRequirement` instead. You can use this parameter or
1359
1372
  # `resourceRequirements` structure but not both.
1360
1373
  #
1361
- # <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
1362
1375
  # resources and shouldn't be provided. For jobs that run on Fargate
1363
1376
  # resources, you must specify the vCPU requirement for the job using
1364
1377
  # `resourceRequirements`.
@@ -1375,7 +1388,7 @@ module Aws::Batch
1375
1388
  # @!attribute [rw] memory
1376
1389
  # This parameter indicates the memory hard limit (in MiB) for a
1377
1390
  # container. If your container attempts to exceed the specified
1378
- # number, it is terminated. You must specify at least 4 MiB of memory
1391
+ # number, it's terminated. You must specify at least 4 MiB of memory
1379
1392
  # for a job using this parameter. The memory hard limit can be
1380
1393
  # specified in several places. It must be specified for each node at
1381
1394
  # least once.
@@ -1386,12 +1399,12 @@ module Aws::Batch
1386
1399
  #
1387
1400
  # This parameter is supported on EC2 resources but isn't supported on
1388
1401
  # Fargate resources. For Fargate resources, you should specify the
1389
- # memory requirement using `resourceRequirement`. You can do this for
1390
- # EC2 resources.
1402
+ # memory requirement using `resourceRequirement`. You can also do this
1403
+ # for EC2 resources.
1391
1404
  #
1392
1405
  # <note markdown="1"> If you're trying to maximize your resource utilization by providing
1393
1406
  # your jobs as much memory as possible for a particular instance type,
1394
- # see [Memory Management][4] in the *AWS Batch User Guide*.
1407
+ # see [Memory Management][4] in the *Batch User Guide*.
1395
1408
  #
1396
1409
  # </note>
1397
1410
  #
@@ -1420,9 +1433,9 @@ module Aws::Batch
1420
1433
  #
1421
1434
  # @!attribute [rw] job_role_arn
1422
1435
  # The Amazon Resource Name (ARN) of the IAM role that the container
1423
- # can assume for AWS permissions. For more information, see [IAM Roles
1424
- # for Tasks][1] in the *Amazon Elastic Container Service Developer
1425
- # 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*.
1426
1439
  #
1427
1440
  #
1428
1441
  #
@@ -1430,10 +1443,10 @@ module Aws::Batch
1430
1443
  # @return [String]
1431
1444
  #
1432
1445
  # @!attribute [rw] execution_role_arn
1433
- # The Amazon Resource Name (ARN) of the execution role that AWS Batch
1434
- # can assume. For jobs that run on Fargate resources, you must provide
1435
- # an execution role. For more information, see [AWS Batch execution
1436
- # IAM role][1] in the *AWS Batch User Guide*.
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*.
1437
1450
  #
1438
1451
  #
1439
1452
  #
@@ -1453,7 +1466,7 @@ module Aws::Batch
1453
1466
  # sensitive information, such as credential data.
1454
1467
  #
1455
1468
  # <note markdown="1"> Environment variables must not start with `AWS_BATCH`; this naming
1456
- # convention is reserved for variables that are set by the AWS Batch
1469
+ # convention is reserved for variables that are set by the Batch
1457
1470
  # service.
1458
1471
  #
1459
1472
  # </note>
@@ -1497,7 +1510,7 @@ module Aws::Batch
1497
1510
  # `--privileged` option to [docker run][3]. The default value is
1498
1511
  # false.
1499
1512
  #
1500
- # <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
1501
1514
  # resources and shouldn't be provided, or specified as false.
1502
1515
  #
1503
1516
  # </note>
@@ -1514,7 +1527,7 @@ module Aws::Batch
1514
1527
  # `Ulimits` in the [Create a container][1] section of the [Docker
1515
1528
  # Remote API][2] and the `--ulimit` option to [docker run][3].
1516
1529
  #
1517
- # <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
1518
1531
  # resources and shouldn't be provided.
1519
1532
  #
1520
1533
  # </note>
@@ -1543,7 +1556,7 @@ module Aws::Batch
1543
1556
  # groups in a multi-node parallel job must use the same instance type.
1544
1557
  #
1545
1558
  # <note markdown="1"> This parameter isn't applicable to single-node container jobs or
1546
- # for jobs that run on Fargate resources and shouldn't be provided.
1559
+ # jobs that run on Fargate resources, and shouldn't be provided.
1547
1560
  #
1548
1561
  # </note>
1549
1562
  # @return [String]
@@ -1573,9 +1586,8 @@ module Aws::Batch
1573
1586
  # options for different supported log drivers, see [Configure logging
1574
1587
  # drivers][4] in the Docker documentation.
1575
1588
  #
1576
- # <note markdown="1"> AWS Batch currently supports a subset of the logging drivers
1577
- # available to the Docker daemon (shown in the LogConfiguration data
1578
- # 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).
1579
1591
  #
1580
1592
  # </note>
1581
1593
  #
@@ -1606,7 +1618,7 @@ module Aws::Batch
1606
1618
  #
1607
1619
  # @!attribute [rw] secrets
1608
1620
  # The secrets for the container. For more information, see [Specifying
1609
- # sensitive data][1] in the *AWS Batch User Guide*.
1621
+ # sensitive data][1] in the *Batch User Guide*.
1610
1622
  #
1611
1623
  #
1612
1624
  #
@@ -1614,13 +1626,15 @@ module Aws::Batch
1614
1626
  # @return [Array<Types::Secret>]
1615
1627
  #
1616
1628
  # @!attribute [rw] network_configuration
1617
- # The network configuration for jobs running on Fargate resources.
1618
- # Jobs running on EC2 resources must not specify this parameter.
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.
1619
1632
  # @return [Types::NetworkConfiguration]
1620
1633
  #
1621
1634
  # @!attribute [rw] fargate_platform_configuration
1622
- # The platform configuration for jobs running on Fargate resources.
1623
- # Jobs running on EC2 resources must not specify this parameter.
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.
1624
1638
  # @return [Types::FargatePlatformConfiguration]
1625
1639
  #
1626
1640
  # @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/ContainerProperties AWS API Documentation
@@ -1722,8 +1736,8 @@ module Aws::Batch
1722
1736
  #
1723
1737
  # @!attribute [rw] type
1724
1738
  # The type of the compute environment: `MANAGED` or `UNMANAGED`. For
1725
- # more information, see [Compute Environments][1] in the *AWS Batch
1726
- # User Guide*.
1739
+ # more information, see [Compute Environments][1] in the *Batch User
1740
+ # Guide*.
1727
1741
  #
1728
1742
  #
1729
1743
  #
@@ -1735,13 +1749,13 @@ module Aws::Batch
1735
1749
  # then the compute environment accepts jobs from a queue and can scale
1736
1750
  # out automatically based on queues.
1737
1751
  #
1738
- # If the state is `ENABLED`, then the AWS Batch scheduler can attempt
1739
- # to place jobs from an associated job queue on the compute resources
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
1740
1754
  # within the environment. If the compute environment is managed, then
1741
1755
  # it can scale its instances out or in automatically, based on the job
1742
1756
  # queue demand.
1743
1757
  #
1744
- # If the state is `DISABLED`, then the AWS Batch scheduler doesn't
1758
+ # If the state is `DISABLED`, then the Batch scheduler doesn't
1745
1759
  # attempt to place jobs within the environment. Jobs in a `STARTING`
1746
1760
  # or `RUNNING` state continue to progress normally. Managed compute
1747
1761
  # environments in the `DISABLED` state don't scale out. However, they
@@ -1752,7 +1766,7 @@ module Aws::Batch
1752
1766
  # Details about the compute resources managed by the compute
1753
1767
  # environment. This parameter is required for managed compute
1754
1768
  # environments. For more information, see [Compute Environments][1] in
1755
- # the *AWS Batch User Guide*.
1769
+ # the *Batch User Guide*.
1756
1770
  #
1757
1771
  #
1758
1772
  #
@@ -1760,16 +1774,16 @@ module Aws::Batch
1760
1774
  # @return [Types::ComputeResource]
1761
1775
  #
1762
1776
  # @!attribute [rw] service_role
1763
- # The full Amazon Resource Name (ARN) of the IAM role that allows AWS
1764
- # Batch to make calls to other AWS services on your behalf. For more
1765
- # information, see [AWS Batch service IAM role][1] in the *AWS Batch
1766
- # User Guide*.
1767
- #
1768
- # If your account has already created the AWS Batch service-linked
1769
- # role, that role is used by default for your compute environment
1770
- # unless you specify a role here. If the AWS Batch service-linked role
1771
- # does not exist in your account, and no role is specified here, the
1772
- # service will try to create the AWS Batch service-linked role in your
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
1773
1787
  # account.
1774
1788
  #
1775
1789
  # If your specified role has a path other than `/`, then you must
@@ -1779,12 +1793,12 @@ module Aws::Batch
1779
1793
  # For more information, see [Friendly names and paths][2] in the *IAM
1780
1794
  # User Guide*.
1781
1795
  #
1782
- # <note markdown="1"> Depending on how you created your AWS Batch service role, its ARN
1783
- # might contain the `service-role` path prefix. When you only specify
1784
- # the name of the service role, AWS Batch assumes that your ARN
1785
- # doesn't use the `service-role` path prefix. Because of this, we
1786
- # recommend that you specify the full ARN of your service role when
1787
- # you create compute environments.
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.
1788
1802
  #
1789
1803
  # </note>
1790
1804
  #
@@ -1797,8 +1811,8 @@ module Aws::Batch
1797
1811
  # @!attribute [rw] tags
1798
1812
  # The tags that you apply to the compute environment to help you
1799
1813
  # categorize and organize your resources. Each tag consists of a key
1800
- # and an optional value. For more information, see [Tagging AWS
1801
- # Resources][1] in *AWS General Reference*.
1814
+ # and an optional value. For more information, see [Tagging Amazon Web
1815
+ # Services Resources][1] in *Amazon Web Services General Reference*.
1802
1816
  #
1803
1817
  # These tags can be updated or removed using the [TagResource][2] and
1804
1818
  # [UntagResource][3] API operations. These tags don't propagate to
@@ -1882,7 +1896,7 @@ module Aws::Batch
1882
1896
  # priority value of `10` is given scheduling preference over a job
1883
1897
  # queue with a priority value of `1`. All of the compute environments
1884
1898
  # must be either EC2 (`EC2` or `SPOT`) or Fargate (`FARGATE` or
1885
- # `FARGATE_SPOT`); EC2 and Fargate compute environments cannot be
1899
+ # `FARGATE_SPOT`); EC2 and Fargate compute environments can't be
1886
1900
  # mixed.
1887
1901
  # @return [Integer]
1888
1902
  #
@@ -1898,8 +1912,8 @@ module Aws::Batch
1898
1912
  # can't be mixed.
1899
1913
  #
1900
1914
  # <note markdown="1"> All compute environments that are associated with a job queue must
1901
- # share the same architecture. AWS Batch doesn't support mixing
1902
- # compute environment architecture types in a single job queue.
1915
+ # share the same architecture. Batch doesn't support mixing compute
1916
+ # environment architecture types in a single job queue.
1903
1917
  #
1904
1918
  # </note>
1905
1919
  # @return [Array<Types::ComputeEnvironmentOrder>]
@@ -1907,8 +1921,8 @@ module Aws::Batch
1907
1921
  # @!attribute [rw] tags
1908
1922
  # The tags that you apply to the job queue to help you categorize and
1909
1923
  # organize your resources. Each tag consists of a key and an optional
1910
- # value. For more information, see [Tagging your AWS Batch
1911
- # resources][1] in *AWS Batch User Guide*.
1924
+ # value. For more information, see [Tagging your Batch resources][1]
1925
+ # in *Batch User Guide*.
1912
1926
  #
1913
1927
  #
1914
1928
  #
@@ -2109,8 +2123,11 @@ module Aws::Batch
2109
2123
  # }
2110
2124
  #
2111
2125
  # @!attribute [rw] job_definitions
2112
- # A list of up to 100 job definition names or full Amazon Resource
2113
- # Name (ARN) entries.
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\}`.
2114
2131
  # @return [Array<String>]
2115
2132
  #
2116
2133
  # @!attribute [rw] max_results
@@ -2289,8 +2306,8 @@ module Aws::Batch
2289
2306
 
2290
2307
  # An object representing a container instance host device.
2291
2308
  #
2292
- # <note markdown="1"> This object isn't applicable to jobs running on Fargate resources and
2293
- # 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.
2294
2311
  #
2295
2312
  # </note>
2296
2313
  #
@@ -2308,8 +2325,8 @@ module Aws::Batch
2308
2325
  # @return [String]
2309
2326
  #
2310
2327
  # @!attribute [rw] container_path
2311
- # The path inside the container used to expose the host device. By
2312
- # 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.
2313
2330
  # @return [String]
2314
2331
  #
2315
2332
  # @!attribute [rw] permissions
@@ -2328,14 +2345,153 @@ module Aws::Batch
2328
2345
  include Aws::Structure
2329
2346
  end
2330
2347
 
2348
+ # The authorization configuration details for the Amazon EFS file
2349
+ # system.
2350
+ #
2351
+ # @note When making an API call, you may pass EFSAuthorizationConfig
2352
+ # data as a hash:
2353
+ #
2354
+ # {
2355
+ # access_point_id: "String",
2356
+ # iam: "ENABLED", # accepts ENABLED, DISABLED
2357
+ # }
2358
+ #
2359
+ # @!attribute [rw] access_point_id
2360
+ # The Amazon EFS access point ID to use. If an access point is
2361
+ # specified, the root directory value specified in the
2362
+ # `EFSVolumeConfiguration` must either be omitted or set to `/` which
2363
+ # will enforce the path set on the EFS access point. If an access
2364
+ # point is used, transit encryption must be enabled in the
2365
+ # `EFSVolumeConfiguration`. For more information, see [Working with
2366
+ # Amazon EFS Access Points][1] in the *Amazon Elastic File System User
2367
+ # Guide*.
2368
+ #
2369
+ #
2370
+ #
2371
+ # [1]: https://docs.aws.amazon.com/efs/latest/ug/efs-access-points.html
2372
+ # @return [String]
2373
+ #
2374
+ # @!attribute [rw] iam
2375
+ # Whether or not to use the Batch job IAM role defined in a job
2376
+ # definition when mounting the Amazon EFS file system. If enabled,
2377
+ # transit encryption must be enabled in the `EFSVolumeConfiguration`.
2378
+ # If this parameter is omitted, the default value of `DISABLED` is
2379
+ # used. For more information, see [Using Amazon EFS Access Points][1]
2380
+ # in the *Batch User Guide*. EFS IAM authorization requires that
2381
+ # `TransitEncryption` be `ENABLED` and that a `JobRoleArn` is
2382
+ # specified.
2383
+ #
2384
+ #
2385
+ #
2386
+ # [1]: https://docs.aws.amazon.com/batch/latest/userguide/efs-volumes.html#efs-volume-accesspoints
2387
+ # @return [String]
2388
+ #
2389
+ # @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/EFSAuthorizationConfig AWS API Documentation
2390
+ #
2391
+ class EFSAuthorizationConfig < Struct.new(
2392
+ :access_point_id,
2393
+ :iam)
2394
+ SENSITIVE = []
2395
+ include Aws::Structure
2396
+ end
2397
+
2398
+ # This is used when you're using an Amazon Elastic File System file
2399
+ # system for job storage. For more information, see [Amazon EFS
2400
+ # Volumes][1] in the *Batch User Guide*.
2401
+ #
2402
+ #
2403
+ #
2404
+ # [1]: https://docs.aws.amazon.com/batch/latest/userguide/efs-volumes.html
2405
+ #
2406
+ # @note When making an API call, you may pass EFSVolumeConfiguration
2407
+ # data as a hash:
2408
+ #
2409
+ # {
2410
+ # file_system_id: "String", # required
2411
+ # root_directory: "String",
2412
+ # transit_encryption: "ENABLED", # accepts ENABLED, DISABLED
2413
+ # transit_encryption_port: 1,
2414
+ # authorization_config: {
2415
+ # access_point_id: "String",
2416
+ # iam: "ENABLED", # accepts ENABLED, DISABLED
2417
+ # },
2418
+ # }
2419
+ #
2420
+ # @!attribute [rw] file_system_id
2421
+ # The Amazon EFS file system ID to use.
2422
+ # @return [String]
2423
+ #
2424
+ # @!attribute [rw] root_directory
2425
+ # The directory within the Amazon EFS file system to mount as the root
2426
+ # directory inside the host. If this parameter is omitted, the root of
2427
+ # the Amazon EFS volume is used instead. Specifying `/` has the same
2428
+ # effect as omitting this parameter. The maximum length is 4,096
2429
+ # characters.
2430
+ #
2431
+ # If an EFS access point is specified in the `authorizationConfig`,
2432
+ # the root directory parameter must either be omitted or set to `/`,
2433
+ # which enforces the path set on the Amazon EFS access point.
2434
+ # @return [String]
2435
+ #
2436
+ # @!attribute [rw] transit_encryption
2437
+ # Determines whether to enable encryption for Amazon EFS data in
2438
+ # transit between the Amazon ECS host and the Amazon EFS server.
2439
+ # Transit encryption must be enabled if Amazon EFS IAM authorization
2440
+ # is used. If this parameter is omitted, the default value of
2441
+ # `DISABLED` is used. For more information, see [Encrypting data in
2442
+ # transit][1] in the *Amazon Elastic File System User Guide*.
2443
+ #
2444
+ #
2445
+ #
2446
+ # [1]: https://docs.aws.amazon.com/efs/latest/ug/encryption-in-transit.html
2447
+ # @return [String]
2448
+ #
2449
+ # @!attribute [rw] transit_encryption_port
2450
+ # The port to use when sending encrypted data between the Amazon ECS
2451
+ # host and the Amazon EFS server. If you don't specify a transit
2452
+ # encryption port, it uses the port selection strategy that the Amazon
2453
+ # EFS mount helper uses. The value must be between 0 and 65,535. For
2454
+ # more information, see [EFS Mount Helper][1] in the *Amazon Elastic
2455
+ # File System User Guide*.
2456
+ #
2457
+ #
2458
+ #
2459
+ # [1]: https://docs.aws.amazon.com/efs/latest/ug/efs-mount-helper.html
2460
+ # @return [Integer]
2461
+ #
2462
+ # @!attribute [rw] authorization_config
2463
+ # The authorization configuration details for the Amazon EFS file
2464
+ # system.
2465
+ # @return [Types::EFSAuthorizationConfig]
2466
+ #
2467
+ # @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/EFSVolumeConfiguration AWS API Documentation
2468
+ #
2469
+ class EFSVolumeConfiguration < Struct.new(
2470
+ :file_system_id,
2471
+ :root_directory,
2472
+ :transit_encryption,
2473
+ :transit_encryption_port,
2474
+ :authorization_config)
2475
+ SENSITIVE = []
2476
+ include Aws::Structure
2477
+ end
2478
+
2331
2479
  # Provides information used to select Amazon Machine Images (AMIs) for
2332
- # instances in the compute environment. If the `Ec2Configuration` isn't
2333
- # specified, the default is `ECS_AL1`.
2480
+ # instances in the compute environment. If `Ec2Configuration` isn't
2481
+ # specified, the default is currently `ECS_AL1` ([Amazon Linux][1]) for
2482
+ # non-GPU, non AWSGraviton instances. Starting on March 31, 2021, this
2483
+ # default will be changing to `ECS_AL2` ([Amazon Linux 2][2]).
2334
2484
  #
2335
- # <note markdown="1"> This object isn't applicable to jobs running on Fargate resources.
2485
+ # <note markdown="1"> This object isn't applicable to jobs that are running on Fargate
2486
+ # resources.
2336
2487
  #
2337
2488
  # </note>
2338
2489
  #
2490
+ #
2491
+ #
2492
+ # [1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html#alami
2493
+ # [2]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html#al2ami
2494
+ #
2339
2495
  # @note When making an API call, you may pass Ec2Configuration
2340
2496
  # data as a hash:
2341
2497
  #
@@ -2347,25 +2503,28 @@ module Aws::Batch
2347
2503
  # @!attribute [rw] image_type
2348
2504
  # The image type to match with the instance type to select an AMI. If
2349
2505
  # the `imageIdOverride` parameter isn't specified, then a recent
2350
- # [Amazon ECS-optimized AMI][1] is used.
2506
+ # [Amazon ECS-optimized AMI][1] (`ECS_AL1`) is used. Starting on March
2507
+ # 31, 2021, this default will be changing to `ECS_AL2` ([Amazon Linux
2508
+ # 2][2]).
2351
2509
  #
2352
2510
  # ECS\_AL2
2353
2511
  #
2354
- # : [Amazon Linux 2][2]− Default for all AWS Graviton-based instance
2355
- # families (for example, `C6g`, `M6g`, `R6g`, and `T4g`) and can be
2356
- # 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.
2357
2515
  #
2358
2516
  # ECS\_AL2\_NVIDIA
2359
2517
  #
2360
2518
  # : [Amazon Linux 2 (GPU)][3]−Default for all GPU instance families
2361
- # (for example `P4` and `G4`) and can be used for all non-AWS
2362
- # 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.
2363
2521
  #
2364
2522
  # ECS\_AL1
2365
2523
  #
2366
- # : [Amazon Linux][4]−Default for all non-GPU, non-AWS Graviton
2367
- # instance families. Amazon Linux is reaching the end-of-life of
2368
- # standard support. For more information, see [Amazon Linux AMI][5].
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].
2369
2528
  #
2370
2529
  #
2371
2530
  #
@@ -2406,7 +2565,7 @@ module Aws::Batch
2406
2565
  #
2407
2566
  # @!attribute [rw] on_status_reason
2408
2567
  # Contains a glob pattern to match against the `StatusReason` returned
2409
- # for a job. The pattern can be up to 512 characters long, and can
2568
+ # for a job. The pattern can be up to 512 characters in length. It can
2410
2569
  # contain letters, numbers, periods (.), colons (:), and white space
2411
2570
  # (including spaces or tabs). It can optionally end with an asterisk
2412
2571
  # (*) so that only the start of the string needs to be an exact
@@ -2415,8 +2574,8 @@ module Aws::Batch
2415
2574
  #
2416
2575
  # @!attribute [rw] on_reason
2417
2576
  # Contains a glob pattern to match against the `Reason` returned for a
2418
- # job. The pattern can be up to 512 characters long, and can contain
2419
- # 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
2420
2579
  # (including spaces and tabs). It can optionally end with an asterisk
2421
2580
  # (*) so that only the start of the string needs to be an exact
2422
2581
  # match.
@@ -2425,9 +2584,9 @@ module Aws::Batch
2425
2584
  # @!attribute [rw] on_exit_code
2426
2585
  # Contains a glob pattern to match against the decimal representation
2427
2586
  # of the `ExitCode` returned for a job. The pattern can be up to 512
2428
- # characters long, can contain only numbers, and can optionally end
2429
- # with an asterisk (*) so that only the start of the string needs to
2430
- # 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.
2431
2590
  # @return [String]
2432
2591
  #
2433
2592
  # @!attribute [rw] action
@@ -2447,8 +2606,9 @@ module Aws::Batch
2447
2606
  include Aws::Structure
2448
2607
  end
2449
2608
 
2450
- # The platform configuration for jobs running on Fargate resources. For
2451
- # jobs that run on EC2 resources, you shouldn't specify this parameter.
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.
2452
2612
  #
2453
2613
  # @note When making an API call, you may pass FargatePlatformConfiguration
2454
2614
  # data as a hash:
@@ -2458,13 +2618,13 @@ module Aws::Batch
2458
2618
  # }
2459
2619
  #
2460
2620
  # @!attribute [rw] platform_version
2461
- # The AWS Fargate platform version where the jobs are running. A
2462
- # platform version is specified only for jobs running on Fargate
2621
+ # The Fargate platform version where the jobs are running. A platform
2622
+ # version is specified only for jobs that are running on Fargate
2463
2623
  # resources. If one isn't specified, the `LATEST` platform version is
2464
- # used by default. This uses a recent, approved version of the AWS
2465
- # Fargate platform for compute resources. For more information, see
2466
- # [AWS Fargate platform versions][1] in the *Amazon Elastic Container
2467
- # Service Developer Guide*.
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*.
2468
2628
  #
2469
2629
  #
2470
2630
  #
@@ -2516,7 +2676,7 @@ module Aws::Batch
2516
2676
  include Aws::Structure
2517
2677
  end
2518
2678
 
2519
- # An object representing an AWS Batch job definition.
2679
+ # An object representing an Batch job definition.
2520
2680
  #
2521
2681
  # @!attribute [rw] job_definition_name
2522
2682
  # The name of the job definition.
@@ -2538,7 +2698,7 @@ module Aws::Batch
2538
2698
  # The type of job definition. If the job is run on Fargate resources,
2539
2699
  # then `multinode` isn't supported. For more information about
2540
2700
  # multi-node parallel jobs, see [Creating a multi-node parallel job
2541
- # definition][1] in the *AWS Batch User Guide*.
2701
+ # definition][1] in the *Batch User Guide*.
2542
2702
  #
2543
2703
  #
2544
2704
  #
@@ -2551,7 +2711,7 @@ module Aws::Batch
2551
2711
  # pair mapping. Parameters in a `SubmitJob` request override any
2552
2712
  # corresponding parameter defaults from the job definition. For more
2553
2713
  # information about specifying parameters, see [Job Definition
2554
- # Parameters][1] in the *AWS Batch User Guide*.
2714
+ # Parameters][1] in the *Batch User Guide*.
2555
2715
  #
2556
2716
  #
2557
2717
  #
@@ -2569,7 +2729,7 @@ module Aws::Batch
2569
2729
  #
2570
2730
  # @!attribute [rw] timeout
2571
2731
  # The timeout configuration for jobs that are submitted with this job
2572
- # definition. You can specify a timeout duration after which AWS Batch
2732
+ # definition. You can specify a timeout duration after which Batch
2573
2733
  # terminates your jobs if they haven't finished.
2574
2734
  # @return [Types::JobTimeout]
2575
2735
  #
@@ -2623,7 +2783,7 @@ module Aws::Batch
2623
2783
  include Aws::Structure
2624
2784
  end
2625
2785
 
2626
- # An object representing an AWS Batch job dependency.
2786
+ # An object representing an Batch job dependency.
2627
2787
  #
2628
2788
  # @note When making an API call, you may pass JobDependency
2629
2789
  # data as a hash:
@@ -2634,7 +2794,7 @@ module Aws::Batch
2634
2794
  # }
2635
2795
  #
2636
2796
  # @!attribute [rw] job_id
2637
- # The job ID of the AWS Batch job associated with this dependency.
2797
+ # The job ID of the Batch job associated with this dependency.
2638
2798
  # @return [String]
2639
2799
  #
2640
2800
  # @!attribute [rw] type
@@ -2650,7 +2810,7 @@ module Aws::Batch
2650
2810
  include Aws::Structure
2651
2811
  end
2652
2812
 
2653
- # An object representing an AWS Batch job.
2813
+ # An object representing an Batch job.
2654
2814
  #
2655
2815
  # @!attribute [rw] job_arn
2656
2816
  # The Amazon Resource Name (ARN) of the job.
@@ -2673,7 +2833,7 @@ module Aws::Batch
2673
2833
  # The current status for the job.
2674
2834
  #
2675
2835
  # <note markdown="1"> If your jobs don't progress to `STARTING`, see [Jobs Stuck in
2676
- # RUNNABLE Status][1] in the troubleshooting section of the *AWS Batch
2836
+ # RUNNABLE Status][1] in the troubleshooting section of the *Batch
2677
2837
  # User Guide*.
2678
2838
  #
2679
2839
  # </note>
@@ -2745,7 +2905,8 @@ module Aws::Batch
2745
2905
  # An object representing the node properties of a multi-node parallel
2746
2906
  # job.
2747
2907
  #
2748
- # <note markdown="1"> This isn't applicable to jobs running on Fargate resources.
2908
+ # <note markdown="1"> This isn't applicable to jobs that are running on Fargate
2909
+ # resources.
2749
2910
  #
2750
2911
  # </note>
2751
2912
  # @return [Types::NodeProperties]
@@ -2807,7 +2968,7 @@ module Aws::Batch
2807
2968
  include Aws::Structure
2808
2969
  end
2809
2970
 
2810
- # An object representing the details of an AWS Batch job queue.
2971
+ # An object representing the details of an Batch job queue.
2811
2972
  #
2812
2973
  # @!attribute [rw] job_queue_name
2813
2974
  # The name of the job queue.
@@ -2853,7 +3014,7 @@ module Aws::Batch
2853
3014
  #
2854
3015
  # @!attribute [rw] tags
2855
3016
  # The tags applied to the job queue. For more information, see
2856
- # [Tagging your AWS Batch resources][1] in *AWS Batch User Guide*.
3017
+ # [Tagging your Batch resources][1] in *Batch User Guide*.
2857
3018
  #
2858
3019
  #
2859
3020
  #
@@ -2929,11 +3090,16 @@ module Aws::Batch
2929
3090
  # @!attribute [rw] node_properties
2930
3091
  # The node properties for a single node in a job summary list.
2931
3092
  #
2932
- # <note markdown="1"> This isn't applicable to jobs running on Fargate resources.
3093
+ # <note markdown="1"> This isn't applicable to jobs that are running on Fargate
3094
+ # resources.
2933
3095
  #
2934
3096
  # </note>
2935
3097
  # @return [Types::NodePropertiesSummary]
2936
3098
  #
3099
+ # @!attribute [rw] job_definition
3100
+ # The Amazon Resource Name (ARN) of the job definition.
3101
+ # @return [String]
3102
+ #
2937
3103
  # @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/JobSummary AWS API Documentation
2938
3104
  #
2939
3105
  class JobSummary < Struct.new(
@@ -2947,7 +3113,8 @@ module Aws::Batch
2947
3113
  :stopped_at,
2948
3114
  :container,
2949
3115
  :array_properties,
2950
- :node_properties)
3116
+ :node_properties,
3117
+ :job_definition)
2951
3118
  SENSITIVE = []
2952
3119
  include Aws::Structure
2953
3120
  end
@@ -2963,7 +3130,7 @@ module Aws::Batch
2963
3130
  #
2964
3131
  # @!attribute [rw] attempt_duration_seconds
2965
3132
  # The time duration in seconds (measured from the job attempt's
2966
- # `startedAt` timestamp) after which AWS Batch terminates your jobs if
3133
+ # `startedAt` timestamp) after which Batch terminates your jobs if
2967
3134
  # they have not finished. The minimum value for the timeout is 60
2968
3135
  # seconds.
2969
3136
  # @return [Integer]
@@ -3005,6 +3172,34 @@ module Aws::Batch
3005
3172
  include Aws::Structure
3006
3173
  end
3007
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
+
3008
3203
  # An object representing a launch template associated with a compute
3009
3204
  # resource. You must specify either the launch template ID or launch
3010
3205
  # template name in the request, but not both.
@@ -3014,7 +3209,8 @@ module Aws::Batch
3014
3209
  # values in the `securityGroupIds` parameter of
3015
3210
  # `CreateComputeEnvironment` will be used.
3016
3211
  #
3017
- # <note markdown="1"> This object isn't applicable to jobs running on Fargate resources.
3212
+ # <note markdown="1"> This object isn't applicable to jobs that are running on Fargate
3213
+ # resources.
3018
3214
  #
3019
3215
  # </note>
3020
3216
  #
@@ -3042,6 +3238,14 @@ module Aws::Batch
3042
3238
  # is used. If the value is `$Default`, the default version of the
3043
3239
  # launch template is used.
3044
3240
  #
3241
+ # After the compute environment is created, the launch template
3242
+ # version that's used isn't changed, even if the `$Default` or
3243
+ # `$Latest` version for the launch template is updated. To use a new
3244
+ # launch template version, create a new compute environment, add the
3245
+ # new compute environment to the existing job queue, remove the old
3246
+ # compute environment from the job queue, and delete the old compute
3247
+ # environment.
3248
+ #
3045
3249
  # Default: `$Default`.
3046
3250
  # @return [String]
3047
3251
  #
@@ -3087,7 +3291,7 @@ module Aws::Batch
3087
3291
  # `Devices` in the [Create a container][1] section of the [Docker
3088
3292
  # Remote API][2] and the `--device` option to [docker run][3].
3089
3293
  #
3090
- # <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
3091
3295
  # resources and shouldn't be provided.
3092
3296
  #
3093
3297
  # </note>
@@ -3117,7 +3321,7 @@ module Aws::Batch
3117
3321
  # The value for the size (in MiB) of the `/dev/shm` volume. This
3118
3322
  # parameter maps to the `--shm-size` option to [docker run][1].
3119
3323
  #
3120
- # <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
3121
3325
  # resources and shouldn't be provided.
3122
3326
  #
3123
3327
  # </note>
@@ -3132,7 +3336,7 @@ module Aws::Batch
3132
3336
  # mount. This parameter maps to the `--tmpfs` option to [docker
3133
3337
  # run][1].
3134
3338
  #
3135
- # <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
3136
3340
  # resources and shouldn't be provided.
3137
3341
  #
3138
3342
  # </note>
@@ -3156,7 +3360,7 @@ module Aws::Batch
3156
3360
  # `maxSwap` value must be set for the `swappiness` parameter to be
3157
3361
  # used.
3158
3362
  #
3159
- # <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
3160
3364
  # resources and shouldn't be provided.
3161
3365
  #
3162
3366
  # </note>
@@ -3174,9 +3378,10 @@ module Aws::Batch
3174
3378
  # be swapped very aggressively. Accepted values are whole numbers
3175
3379
  # between `0` and `100`. If the `swappiness` parameter isn't
3176
3380
  # specified, a default value of `60` is used. If a value isn't
3177
- # specified for `maxSwap` then this parameter is ignored. If `maxSwap`
3178
- # is set to 0, the container doesn't use swap. This parameter maps to
3179
- # the `--memory-swappiness` option to [docker run][1].
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].
3180
3385
  #
3181
3386
  # Consider the following when you use a per-container swap
3182
3387
  # configuration.
@@ -3201,7 +3406,7 @@ module Aws::Batch
3201
3406
  # value of 60, and the total swap usage will be limited to two times
3202
3407
  # the memory reservation of the container.
3203
3408
  #
3204
- # <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
3205
3410
  # resources and shouldn't be provided.
3206
3411
  #
3207
3412
  # </note>
@@ -3238,6 +3443,12 @@ module Aws::Batch
3238
3443
  # job_status: "SUBMITTED", # accepts SUBMITTED, PENDING, RUNNABLE, STARTING, RUNNING, SUCCEEDED, FAILED
3239
3444
  # max_results: 1,
3240
3445
  # next_token: "String",
3446
+ # filters: [
3447
+ # {
3448
+ # name: "String",
3449
+ # values: ["String"],
3450
+ # },
3451
+ # ],
3241
3452
  # }
3242
3453
  #
3243
3454
  # @!attribute [rw] job_queue
@@ -3257,8 +3468,10 @@ module Aws::Batch
3257
3468
  # @return [String]
3258
3469
  #
3259
3470
  # @!attribute [rw] job_status
3260
- # The job status used to filter jobs in the specified queue. If you
3261
- # don't specify a status, only `RUNNING` jobs are returned.
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.
3262
3475
  # @return [String]
3263
3476
  #
3264
3477
  # @!attribute [rw] max_results
@@ -3286,6 +3499,56 @@ module Aws::Batch
3286
3499
  # </note>
3287
3500
  # @return [String]
3288
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
+ #
3289
3552
  # @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/ListJobsRequest AWS API Documentation
3290
3553
  #
3291
3554
  class ListJobsRequest < Struct.new(
@@ -3294,7 +3557,8 @@ module Aws::Batch
3294
3557
  :multi_node_job_id,
3295
3558
  :job_status,
3296
3559
  :max_results,
3297
- :next_token)
3560
+ :next_token,
3561
+ :filters)
3298
3562
  SENSITIVE = []
3299
3563
  include Aws::Structure
3300
3564
  end
@@ -3328,10 +3592,9 @@ module Aws::Batch
3328
3592
  #
3329
3593
  # @!attribute [rw] resource_arn
3330
3594
  # The Amazon Resource Name (ARN) that identifies the resource that
3331
- # tags are listed for. AWS Batch resources that support tags are
3332
- # compute environments, jobs, job definitions, and job queues. ARNs
3333
- # for child jobs of array and multi-node parallel (MNP) jobs are not
3334
- # 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.
3335
3598
  # @return [String]
3336
3599
  #
3337
3600
  # @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/ListTagsForResourceRequest AWS API Documentation
@@ -3381,17 +3644,17 @@ module Aws::Batch
3381
3644
  # The supported log drivers are `awslogs`, `fluentd`, `gelf`,
3382
3645
  # `json-file`, `journald`, `logentries`, `syslog`, and `splunk`.
3383
3646
  #
3384
- # <note markdown="1"> Jobs running on Fargate resources are restricted to the `awslogs`
3385
- # 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.
3386
3649
  #
3387
3650
  # </note>
3388
3651
  #
3389
3652
  # awslogs
3390
3653
  #
3391
3654
  # : Specifies the Amazon CloudWatch Logs logging driver. For more
3392
- # information, see [Using the awslogs Log Driver][1] in the *AWS
3393
- # Batch User Guide* and [Amazon CloudWatch Logs logging driver][2]
3394
- # in the Docker documentation.
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.
3395
3658
  #
3396
3659
  # fluentd
3397
3660
  #
@@ -3468,7 +3731,7 @@ module Aws::Batch
3468
3731
  #
3469
3732
  # @!attribute [rw] secret_options
3470
3733
  # The secrets to pass to the log configuration. For more information,
3471
- # see [Specifying Sensitive Data][1] in the *AWS Batch User Guide*.
3734
+ # see [Specifying Sensitive Data][1] in the *Batch User Guide*.
3472
3735
  #
3473
3736
  #
3474
3737
  #
@@ -3527,8 +3790,9 @@ module Aws::Batch
3527
3790
  include Aws::Structure
3528
3791
  end
3529
3792
 
3530
- # The network configuration for jobs running on Fargate resources. Jobs
3531
- # running on EC2 resources must not specify this parameter.
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.
3532
3796
  #
3533
3797
  # @note When making an API call, you may pass NetworkConfiguration
3534
3798
  # data as a hash:
@@ -3539,8 +3803,8 @@ module Aws::Batch
3539
3803
  #
3540
3804
  # @!attribute [rw] assign_public_ip
3541
3805
  # Indicates whether the job should have a public IP address. For a job
3542
- # running on Fargate resources in a private subnet to send outbound
3543
- # traffic to the internet (for example, in order to pull container
3806
+ # that is running on Fargate resources in a private subnet to send
3807
+ # outbound traffic to the internet (for example, to pull container
3544
3808
  # images), the private subnet requires a NAT gateway be attached to
3545
3809
  # route requests to the internet. For more information, see [Amazon
3546
3810
  # ECS task networking][1]. The default value is "DISABLED".
@@ -3608,8 +3872,8 @@ module Aws::Batch
3608
3872
  # Object representing any node overrides to a job definition that's
3609
3873
  # used in a SubmitJob API operation.
3610
3874
  #
3611
- # <note markdown="1"> This isn't applicable to jobs running on Fargate resources and
3612
- # 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.
3613
3877
  #
3614
3878
  # </note>
3615
3879
  #
@@ -3697,6 +3961,16 @@ module Aws::Batch
3697
3961
  # source_path: "String",
3698
3962
  # },
3699
3963
  # name: "String",
3964
+ # efs_volume_configuration: {
3965
+ # file_system_id: "String", # required
3966
+ # root_directory: "String",
3967
+ # transit_encryption: "ENABLED", # accepts ENABLED, DISABLED
3968
+ # transit_encryption_port: 1,
3969
+ # authorization_config: {
3970
+ # access_point_id: "String",
3971
+ # iam: "ENABLED", # accepts ENABLED, DISABLED
3972
+ # },
3973
+ # },
3700
3974
  # },
3701
3975
  # ],
3702
3976
  # environment: [
@@ -3901,6 +4175,16 @@ module Aws::Batch
3901
4175
  # source_path: "String",
3902
4176
  # },
3903
4177
  # name: "String",
4178
+ # efs_volume_configuration: {
4179
+ # file_system_id: "String", # required
4180
+ # root_directory: "String",
4181
+ # transit_encryption: "ENABLED", # accepts ENABLED, DISABLED
4182
+ # transit_encryption_port: 1,
4183
+ # authorization_config: {
4184
+ # access_point_id: "String",
4185
+ # iam: "ENABLED", # accepts ENABLED, DISABLED
4186
+ # },
4187
+ # },
3904
4188
  # },
3905
4189
  # ],
3906
4190
  # environment: [
@@ -4028,6 +4312,16 @@ module Aws::Batch
4028
4312
  # source_path: "String",
4029
4313
  # },
4030
4314
  # name: "String",
4315
+ # efs_volume_configuration: {
4316
+ # file_system_id: "String", # required
4317
+ # root_directory: "String",
4318
+ # transit_encryption: "ENABLED", # accepts ENABLED, DISABLED
4319
+ # transit_encryption_port: 1,
4320
+ # authorization_config: {
4321
+ # access_point_id: "String",
4322
+ # iam: "ENABLED", # accepts ENABLED, DISABLED
4323
+ # },
4324
+ # },
4031
4325
  # },
4032
4326
  # ],
4033
4327
  # environment: [
@@ -4124,6 +4418,16 @@ module Aws::Batch
4124
4418
  # source_path: "String",
4125
4419
  # },
4126
4420
  # name: "String",
4421
+ # efs_volume_configuration: {
4422
+ # file_system_id: "String", # required
4423
+ # root_directory: "String",
4424
+ # transit_encryption: "ENABLED", # accepts ENABLED, DISABLED
4425
+ # transit_encryption_port: 1,
4426
+ # authorization_config: {
4427
+ # access_point_id: "String",
4428
+ # iam: "ENABLED", # accepts ENABLED, DISABLED
4429
+ # },
4430
+ # },
4127
4431
  # },
4128
4432
  # ],
4129
4433
  # environment: [
@@ -4234,7 +4538,7 @@ module Aws::Batch
4234
4538
  # @!attribute [rw] type
4235
4539
  # The type of job definition. For more information about multi-node
4236
4540
  # parallel jobs, see [Creating a multi-node parallel job
4237
- # definition][1] in the *AWS Batch User Guide*.
4541
+ # definition][1] in the *Batch User Guide*.
4238
4542
  #
4239
4543
  # <note markdown="1"> If the job is run on Fargate resources, then `multinode` isn't
4240
4544
  # supported.
@@ -4269,7 +4573,7 @@ module Aws::Batch
4269
4573
  # An object with various properties specific to multi-node parallel
4270
4574
  # jobs. If you specify node properties for a job, it becomes a
4271
4575
  # multi-node parallel job. For more information, see [Multi-node
4272
- # Parallel Jobs][1] in the *AWS Batch User Guide*. If the job
4576
+ # Parallel Jobs][1] in the *Batch User Guide*. If the job
4273
4577
  # definition's `type` parameter is `container`, then you must specify
4274
4578
  # either `containerProperties` or `nodeProperties`.
4275
4579
  #
@@ -4302,12 +4606,12 @@ module Aws::Batch
4302
4606
  #
4303
4607
  # @!attribute [rw] timeout
4304
4608
  # The timeout configuration for jobs that are submitted with this job
4305
- # definition, after which AWS Batch terminates your jobs if they have
4306
- # not finished. If a job is terminated due to a timeout, it isn't
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
4307
4611
  # retried. The minimum value for the timeout is 60 seconds. Any
4308
4612
  # timeout configuration that's specified during a SubmitJob operation
4309
4613
  # overrides the timeout configuration defined here. For more
4310
- # information, see [Job Timeouts][1] in the *AWS Batch User Guide*.
4614
+ # information, see [Job Timeouts][1] in the *Batch User Guide*.
4311
4615
  #
4312
4616
  #
4313
4617
  #
@@ -4317,8 +4621,8 @@ module Aws::Batch
4317
4621
  # @!attribute [rw] tags
4318
4622
  # The tags that you apply to the job definition to help you categorize
4319
4623
  # and organize your resources. Each tag consists of a key and an
4320
- # optional value. For more information, see [Tagging AWS Resources][1]
4321
- # in *AWS Batch User Guide*.
4624
+ # optional value. For more information, see [Tagging Amazon Web
4625
+ # Services Resources][1] in *Batch User Guide*.
4322
4626
  #
4323
4627
  #
4324
4628
  #
@@ -4392,35 +4696,36 @@ module Aws::Batch
4392
4696
  # exceed the number of available GPUs on the compute resource that
4393
4697
  # the job is launched on.
4394
4698
  #
4395
- # <note markdown="1"> GPUs are not available for jobs running on Fargate resources.
4699
+ # <note markdown="1"> GPUs are not available for jobs that are running on Fargate
4700
+ # resources.
4396
4701
  #
4397
4702
  # </note>
4398
4703
  #
4399
4704
  # type="MEMORY"
4400
4705
  #
4401
4706
  # : The memory hard limit (in MiB) present to the container. This
4402
- # parameter is supported for jobs running on EC2 resources. If your
4403
- # container attempts to exceed the memory specified, the container
4404
- # is terminated. This parameter maps to `Memory` in the [Create a
4405
- # container][1] section of the [Docker Remote API][2] and the
4406
- # `--memory` option to [docker run][3]. You must specify at least 4
4407
- # MiB of memory for a job. This is required but can be specified in
4408
- # several places for multi-node parallel (MNP) jobs. It must be
4409
- # specified for each node at least once. This parameter maps to
4410
- # `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
4411
4716
  # Remote API][2] and the `--memory` option to [docker run][3].
4412
4717
  #
4413
4718
  # <note markdown="1"> If you're trying to maximize your resource utilization by
4414
4719
  # providing your jobs as much memory as possible for a particular
4415
- # instance type, see [Memory Management][4] in the *AWS Batch User
4720
+ # instance type, see [Memory Management][4] in the *Batch User
4416
4721
  # Guide*.
4417
4722
  #
4418
4723
  # </note>
4419
4724
  #
4420
- # For jobs running on Fargate resources, then `value` is the hard
4421
- # limit (in MiB), and must match one of the supported values and the
4422
- # `VCPU` values must be one of the values supported for that memory
4423
- # 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.
4424
4729
  #
4425
4730
  # value = 512
4426
4731
  #
@@ -4468,10 +4773,10 @@ module Aws::Batch
4468
4773
  # but can be specified in several places; it must be specified for
4469
4774
  # each node at least once.
4470
4775
  #
4471
- # For jobs running on Fargate resources, then `value` must match one
4472
- # of the supported values and the `MEMORY` values must be one of the
4473
- # values supported for that VCPU value. The supported values are
4474
- # 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
4475
4780
  #
4476
4781
  # value = 0.25
4477
4782
  #
@@ -4519,7 +4824,7 @@ module Aws::Batch
4519
4824
  end
4520
4825
 
4521
4826
  # The retry strategy associated with a job. For more information, see
4522
- # [Automated job retries][1] in the *AWS Batch User Guide*.
4827
+ # [Automated job retries][1] in the *Batch User Guide*.
4523
4828
  #
4524
4829
  #
4525
4830
  #
@@ -4571,8 +4876,8 @@ module Aws::Batch
4571
4876
  # * To reference sensitive information in the log configuration of a
4572
4877
  # container, use the `secretOptions` container definition parameter.
4573
4878
  #
4574
- # For more information, see [Specifying sensitive data][1] in the *AWS
4575
- # Batch User Guide*.
4879
+ # For more information, see [Specifying sensitive data][1] in the *Batch
4880
+ # User Guide*.
4576
4881
  #
4577
4882
  #
4578
4883
  #
@@ -4592,13 +4897,14 @@ module Aws::Batch
4592
4897
  #
4593
4898
  # @!attribute [rw] value_from
4594
4899
  # The secret to expose to the container. The supported values are
4595
- # either the full ARN of the AWS Secrets Manager secret or the full
4596
- # ARN of the parameter in the AWS Systems Manager Parameter Store.
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.
4597
4903
  #
4598
- # <note markdown="1"> If the AWS Systems Manager Parameter Store parameter exists in the
4599
- # same Region as the job you're launching, then you can use either
4600
- # the full ARN or name of the parameter. If the parameter exists in a
4601
- # 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.
4602
4908
  #
4603
4909
  # </note>
4604
4910
  # @return [String]
@@ -4725,7 +5031,7 @@ module Aws::Batch
4725
5031
  # The array properties for the submitted job, such as the size of the
4726
5032
  # array. The array size can be between 2 and 10,000. If you specify
4727
5033
  # array properties for a job, it becomes an array job. For more
4728
- # information, see [Array Jobs][1] in the *AWS Batch User Guide*.
5034
+ # information, see [Array Jobs][1] in the *Batch User Guide*.
4729
5035
  #
4730
5036
  #
4731
5037
  #
@@ -4771,7 +5077,7 @@ module Aws::Batch
4771
5077
  # A list of node overrides in JSON format that specify the node range
4772
5078
  # to target and the container overrides for that node range.
4773
5079
  #
4774
- # <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
4775
5081
  # resources; use `containerOverrides` instead.
4776
5082
  #
4777
5083
  # </note>
@@ -4796,14 +5102,14 @@ module Aws::Batch
4796
5102
  #
4797
5103
  # @!attribute [rw] timeout
4798
5104
  # The timeout configuration for this SubmitJob operation. You can
4799
- # specify a timeout duration after which AWS Batch terminates your
4800
- # jobs if they haven't finished. If a job is terminated due to a
4801
- # timeout, it isn't retried. The minimum value for the timeout is 60
4802
- # seconds. This configuration overrides any timeout configuration
4803
- # specified in the job definition. For array jobs, child jobs have the
4804
- # same timeout configuration as the parent job. For more information,
4805
- # see [Job Timeouts][1] in the *Amazon Elastic Container Service
4806
- # Developer Guide*.
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*.
4807
5113
  #
4808
5114
  #
4809
5115
  #
@@ -4813,8 +5119,8 @@ module Aws::Batch
4813
5119
  # @!attribute [rw] tags
4814
5120
  # The tags that you apply to the job request to help you categorize
4815
5121
  # and organize your resources. Each tag consists of a key and an
4816
- # optional value. For more information, see [Tagging AWS Resources][1]
4817
- # in *AWS General Reference*.
5122
+ # optional value. For more information, see [Tagging Amazon Web
5123
+ # Services Resources][1] in *Amazon Web Services General Reference*.
4818
5124
  #
4819
5125
  #
4820
5126
  #
@@ -4874,7 +5180,7 @@ module Aws::Batch
4874
5180
  #
4875
5181
  # @!attribute [rw] resource_arn
4876
5182
  # The Amazon Resource Name (ARN) of the resource that tags are added
4877
- # to. AWS Batch resources that support tags are compute environments,
5183
+ # to. Batch resources that support tags are compute environments,
4878
5184
  # jobs, job definitions, and job queues. ARNs for child jobs of array
4879
5185
  # and multi-node parallel (MNP) jobs are not supported.
4880
5186
  # @return [String]
@@ -4882,8 +5188,8 @@ module Aws::Batch
4882
5188
  # @!attribute [rw] tags
4883
5189
  # The tags that you apply to the resource to help you categorize and
4884
5190
  # organize your resources. Each tag consists of a key and an optional
4885
- # value. For more information, see [Tagging AWS Resources][1] in *AWS
4886
- # General Reference*.
5191
+ # value. For more information, see [Tagging Amazon Web Services
5192
+ # Resources][1] in *Amazon Web Services General Reference*.
4887
5193
  #
4888
5194
  #
4889
5195
  #
@@ -4914,14 +5220,14 @@ module Aws::Batch
4914
5220
  # }
4915
5221
  #
4916
5222
  # @!attribute [rw] job_id
4917
- # The AWS Batch job ID of the job to terminate.
5223
+ # The Batch job ID of the job to terminate.
4918
5224
  # @return [String]
4919
5225
  #
4920
5226
  # @!attribute [rw] reason
4921
5227
  # A message to attach to the job that explains the reason for
4922
5228
  # canceling it. This message is returned by future DescribeJobs
4923
- # operations on the job. This message is also recorded in the AWS
4924
- # Batch activity logs.
5229
+ # operations on the job. This message is also recorded in the Batch
5230
+ # activity logs.
4925
5231
  # @return [String]
4926
5232
  #
4927
5233
  # @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/TerminateJobRequest AWS API Documentation
@@ -4939,7 +5245,8 @@ module Aws::Batch
4939
5245
 
4940
5246
  # The container path, mount options, and size of the tmpfs mount.
4941
5247
  #
4942
- # <note markdown="1"> This object isn't applicable to jobs running on Fargate resources.
5248
+ # <note markdown="1"> This object isn't applicable to jobs that are running on Fargate
5249
+ # resources.
4943
5250
  #
4944
5251
  # </note>
4945
5252
  #
@@ -4988,7 +5295,8 @@ module Aws::Batch
4988
5295
 
4989
5296
  # The `ulimit` settings to pass to the container.
4990
5297
  #
4991
- # <note markdown="1"> This object isn't applicable to jobs running on Fargate resources.
5298
+ # <note markdown="1"> This object isn't applicable to jobs that are running on Fargate
5299
+ # resources.
4992
5300
  #
4993
5301
  # </note>
4994
5302
  #
@@ -5033,9 +5341,9 @@ module Aws::Batch
5033
5341
  #
5034
5342
  # @!attribute [rw] resource_arn
5035
5343
  # The Amazon Resource Name (ARN) of the resource from which to delete
5036
- # tags. AWS Batch resources that support tags are compute
5037
- # environments, jobs, job definitions, and job queues. ARNs for child
5038
- # jobs of array and multi-node parallel (MNP) jobs are not supported.
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.
5039
5347
  # @return [String]
5040
5348
  #
5041
5349
  # @!attribute [rw] tag_keys
@@ -5083,13 +5391,13 @@ module Aws::Batch
5083
5391
  # `ENABLED` state can accept jobs from a queue and scale in or out
5084
5392
  # automatically based on the workload demand of its associated queues.
5085
5393
  #
5086
- # If the state is `ENABLED`, then the AWS Batch scheduler can attempt
5087
- # to place jobs from an associated job queue on the compute resources
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
5088
5396
  # within the environment. If the compute environment is managed, then
5089
5397
  # it can scale its instances out or in automatically, based on the job
5090
5398
  # queue demand.
5091
5399
  #
5092
- # If the state is `DISABLED`, then the AWS Batch scheduler doesn't
5400
+ # If the state is `DISABLED`, then the Batch scheduler doesn't
5093
5401
  # attempt to place jobs within the environment. Jobs in a `STARTING`
5094
5402
  # or `RUNNING` state continue to progress normally. Managed compute
5095
5403
  # environments in the `DISABLED` state don't scale out. However, they
@@ -5099,7 +5407,7 @@ module Aws::Batch
5099
5407
  # @!attribute [rw] compute_resources
5100
5408
  # Details of the compute resources managed by the compute environment.
5101
5409
  # Required for a managed compute environment. For more information,
5102
- # see [Compute Environments][1] in the *AWS Batch User Guide*.
5410
+ # see [Compute Environments][1] in the *Batch User Guide*.
5103
5411
  #
5104
5412
  #
5105
5413
  #
@@ -5107,21 +5415,26 @@ module Aws::Batch
5107
5415
  # @return [Types::ComputeResourceUpdate]
5108
5416
  #
5109
5417
  # @!attribute [rw] service_role
5110
- # The full Amazon Resource Name (ARN) of the IAM role that allows AWS
5111
- # Batch to make calls to other AWS services on your behalf. For more
5112
- # information, see [AWS Batch service IAM role][1] in the *AWS Batch
5113
- # User Guide*.
5418
+ # The full Amazon Resource Name (ARN) of the IAM role that allows
5419
+ # Batch to make calls to other Amazon Web Services services on your
5420
+ # behalf. For more information, see [Batch service IAM role][1] in the
5421
+ # *Batch User Guide*.
5422
+ #
5423
+ # If the compute environment has a service-linked role, it can't be
5424
+ # changed to use a regular IAM role. Likewise, if the compute
5425
+ # environment has a regular IAM role, it can't be changed to use a
5426
+ # service-linked role.
5114
5427
  #
5115
5428
  # If your specified role has a path other than `/`, then you must
5116
5429
  # either specify the full role ARN (this is recommended) or prefix the
5117
5430
  # role name with the path.
5118
5431
  #
5119
- # <note markdown="1"> Depending on how you created your AWS Batch service role, its ARN
5120
- # might contain the `service-role` path prefix. When you only specify
5121
- # the name of the service role, AWS Batch assumes that your ARN
5122
- # doesn't use the `service-role` path prefix. Because of this, we
5123
- # recommend that you specify the full ARN of your service role when
5124
- # you create compute environments.
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.
5125
5438
  #
5126
5439
  # </note>
5127
5440
  #
@@ -5210,8 +5523,8 @@ module Aws::Batch
5210
5523
  # can't be mixed.
5211
5524
  #
5212
5525
  # <note markdown="1"> All compute environments that are associated with a job queue must
5213
- # share the same architecture. AWS Batch doesn't support mixing
5214
- # compute environment architecture types in a single job queue.
5526
+ # share the same architecture. Batch doesn't support mixing compute
5527
+ # environment architecture types in a single job queue.
5215
5528
  #
5216
5529
  # </note>
5217
5530
  # @return [Array<Types::ComputeEnvironmentOrder>]
@@ -5254,6 +5567,16 @@ module Aws::Batch
5254
5567
  # source_path: "String",
5255
5568
  # },
5256
5569
  # name: "String",
5570
+ # efs_volume_configuration: {
5571
+ # file_system_id: "String", # required
5572
+ # root_directory: "String",
5573
+ # transit_encryption: "ENABLED", # accepts ENABLED, DISABLED
5574
+ # transit_encryption_port: 1,
5575
+ # authorization_config: {
5576
+ # access_point_id: "String",
5577
+ # iam: "ENABLED", # accepts ENABLED, DISABLED
5578
+ # },
5579
+ # },
5257
5580
  # }
5258
5581
  #
5259
5582
  # @!attribute [rw] host
@@ -5264,7 +5587,7 @@ module Aws::Batch
5264
5587
  # guaranteed to persist after the containers associated with it stop
5265
5588
  # running.
5266
5589
  #
5267
- # <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
5268
5591
  # resources and shouldn't be provided.
5269
5592
  #
5270
5593
  # </note>
@@ -5277,11 +5600,19 @@ module Aws::Batch
5277
5600
  # `mountPoints`.
5278
5601
  # @return [String]
5279
5602
  #
5603
+ # @!attribute [rw] efs_volume_configuration
5604
+ # This parameter is specified when you are using an Amazon Elastic
5605
+ # File System file system for job storage. Jobs that are running on
5606
+ # Fargate resources must specify a `platformVersion` of at least
5607
+ # `1.4.0`.
5608
+ # @return [Types::EFSVolumeConfiguration]
5609
+ #
5280
5610
  # @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/Volume AWS API Documentation
5281
5611
  #
5282
5612
  class Volume < Struct.new(
5283
5613
  :host,
5284
- :name)
5614
+ :name,
5615
+ :efs_volume_configuration)
5285
5616
  SENSITIVE = []
5286
5617
  include Aws::Structure
5287
5618
  end