aws-sdk-batch 1.42.0 → 1.47.0

Sign up to get free protection for your applications and to get access to all the features.
data/VERSION ADDED
@@ -0,0 +1 @@
1
+ 1.47.0
data/lib/aws-sdk-batch.rb CHANGED
@@ -3,7 +3,7 @@
3
3
  # WARNING ABOUT GENERATED CODE
4
4
  #
5
5
  # This file is generated. See the contributing guide for more information:
6
- # https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
6
+ # https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
7
7
  #
8
8
  # WARNING ABOUT GENERATED CODE
9
9
 
@@ -48,6 +48,6 @@ require_relative 'aws-sdk-batch/customizations'
48
48
  # @!group service
49
49
  module Aws::Batch
50
50
 
51
- GEM_VERSION = '1.42.0'
51
+ GEM_VERSION = '1.47.0'
52
52
 
53
53
  end
@@ -3,7 +3,7 @@
3
3
  # WARNING ABOUT GENERATED CODE
4
4
  #
5
5
  # This file is generated. See the contributing guide for more information:
6
- # https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
6
+ # https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
7
7
  #
8
8
  # WARNING ABOUT GENERATED CODE
9
9
 
@@ -329,8 +329,8 @@ module Aws::Batch
329
329
 
330
330
  # Cancels a job in an AWS Batch job queue. Jobs that are in the
331
331
  # `SUBMITTED`, `PENDING`, or `RUNNABLE` state are canceled. Jobs that
332
- # have progressed to `STARTING` or `RUNNING` are not canceled (but the
333
- # API operation still succeeds, even if no job is canceled); these jobs
332
+ # have progressed to `STARTING` or `RUNNING` aren't canceled, but the
333
+ # API operation still succeeds, even if no job is canceled. These jobs
334
334
  # must be terminated with the TerminateJob operation.
335
335
  #
336
336
  # @option params [required, String] :job_id
@@ -382,34 +382,34 @@ module Aws::Batch
382
382
  # instance types of the compute resources within the environment. This
383
383
  # is based on the compute resource specification that you define or the
384
384
  # [launch template][1] that you specify when you create the compute
385
- # environment. You can choose either to use EC2 On-Demand Instances and
386
- # EC2 Spot Instances, or to use Fargate and Fargate Spot capacity in
387
- # your managed compute environment. You can optionally set a maximum
385
+ # environment. Either, you can choose to use EC2 On-Demand Instances and
386
+ # EC2 Spot Instances. Or, you can use Fargate and Fargate Spot capacity
387
+ # in your managed compute environment. You can optionally set a maximum
388
388
  # price so that Spot Instances only launch when the Spot Instance price
389
- # is below a specified percentage of the On-Demand price.
389
+ # is less than a specified percentage of the On-Demand price.
390
390
  #
391
- # <note markdown="1"> Multi-node parallel jobs are not supported on Spot Instances.
391
+ # <note markdown="1"> Multi-node parallel jobs aren't supported on Spot Instances.
392
392
  #
393
393
  # </note>
394
394
  #
395
395
  # In an unmanaged compute environment, you can manage your own EC2
396
396
  # compute resources and have a lot of flexibility with how you configure
397
- # your compute resources. For example, you can use custom AMI. However,
398
- # you need to verify that your AMI meets the Amazon ECS container
397
+ # your compute resources. For example, you can use custom AMIs. However,
398
+ # you must verify that each of your AMIs meet the Amazon ECS container
399
399
  # instance AMI specification. For more information, see [container
400
400
  # instance AMIs][2] in the *Amazon Elastic Container Service Developer
401
- # Guide*. After you have created your unmanaged compute environment, you
402
- # can use the DescribeComputeEnvironments operation to find the Amazon
403
- # ECS cluster that is associated with it. Then, manually launch your
404
- # container instances into that Amazon ECS cluster. For more
405
- # information, see [Launching an Amazon ECS container instance][3] in
406
- # the *Amazon Elastic Container Service Developer Guide*.
407
- #
408
- # <note markdown="1"> AWS Batch doesn't upgrade the AMIs in a compute environment after
409
- # it's created. For example, it doesn't update the AMIs when a newer
410
- # version of the Amazon ECS-optimized AMI is available. Therefore,
411
- # you're responsible for the management of the guest operating system
412
- # (including updates and security patches) and any additional
401
+ # Guide*. After you created your unmanaged compute environment, you can
402
+ # use the DescribeComputeEnvironments operation to find the Amazon ECS
403
+ # cluster that's associated with it. Then, launch your container
404
+ # instances into that Amazon ECS cluster. For more information, see
405
+ # [Launching an Amazon ECS container instance][3] in the *Amazon Elastic
406
+ # Container Service Developer Guide*.
407
+ #
408
+ # <note markdown="1"> AWS Batch doesn't upgrade the AMIs in a compute environment after the
409
+ # environment is created. For example, it doesn't update the AMIs when
410
+ # a newer version of the Amazon ECS optimized AMI is available.
411
+ # Therefore, you're responsible for managing the guest operating system
412
+ # (including its updates and security patches) and any additional
413
413
  # application software or utilities that you install on the compute
414
414
  # resources. To use a new AMI for your AWS Batch jobs, complete these
415
415
  # steps:
@@ -448,6 +448,18 @@ module Aws::Batch
448
448
  # the compute environment accepts jobs from a queue and can scale out
449
449
  # automatically based on queues.
450
450
  #
451
+ # If the state is `ENABLED`, then the AWS Batch scheduler can attempt to
452
+ # place jobs from an associated job queue on the compute resources
453
+ # within the environment. If the compute environment is managed, then it
454
+ # can scale its instances out or in automatically, based on the job
455
+ # queue demand.
456
+ #
457
+ # If the state is `DISABLED`, then the AWS Batch scheduler doesn't
458
+ # attempt to place jobs within the environment. Jobs in a `STARTING` or
459
+ # `RUNNING` state continue to progress normally. Managed compute
460
+ # environments in the `DISABLED` state don't scale out. However, they
461
+ # scale in to `minvCpus` value after instances become idle.
462
+ #
451
463
  # @option params [Types::ComputeResource] :compute_resources
452
464
  # Details about the compute resources managed by the compute
453
465
  # environment. This parameter is required for managed compute
@@ -458,23 +470,39 @@ module Aws::Batch
458
470
  #
459
471
  # [1]: https://docs.aws.amazon.com/batch/latest/userguide/compute_environments.html
460
472
  #
461
- # @option params [required, String] :service_role
473
+ # @option params [String] :service_role
462
474
  # The full Amazon Resource Name (ARN) of the IAM role that allows AWS
463
- # Batch to make calls to other AWS services on your behalf.
464
- #
465
- # If your specified role has a path other than `/`, then you must either
466
- # specify the full role ARN (this is recommended) or prefix the role
467
- # name with the path.
475
+ # Batch to make calls to other AWS services on your behalf. For more
476
+ # information, see [AWS Batch service IAM role][1] in the *AWS Batch
477
+ # User Guide*.
478
+ #
479
+ # If your account has already created the AWS Batch service-linked role,
480
+ # that role is used by default for your compute environment unless you
481
+ # specify a role here. If the AWS Batch service-linked role does not
482
+ # exist in your account, and no role is specified here, the service will
483
+ # try to create the AWS Batch service-linked role in your account.
484
+ #
485
+ # If your specified role has a path other than `/`, then you must
486
+ # specify either the full role ARN (recommended) or prefix the role name
487
+ # with the path. For example, if a role with the name `bar` has a path
488
+ # of `/foo/` then you would specify `/foo/bar` as the role name. For
489
+ # more information, see [Friendly names and paths][2] in the *IAM User
490
+ # Guide*.
468
491
  #
469
- # <note markdown="1"> Depending on how you created your AWS Batch service role, its ARN may
470
- # contain the `service-role` path prefix. When you only specify the name
471
- # of the service role, AWS Batch assumes that your ARN doesn't use the
472
- # `service-role` path prefix. Because of this, we recommend that you
473
- # specify the full ARN of your service role when you create compute
492
+ # <note markdown="1"> Depending on how you created your AWS Batch service role, its ARN
493
+ # might contain the `service-role` path prefix. When you only specify
494
+ # the name of the service role, AWS Batch assumes that your ARN doesn't
495
+ # use the `service-role` path prefix. Because of this, we recommend that
496
+ # you specify the full ARN of your service role when you create compute
474
497
  # environments.
475
498
  #
476
499
  # </note>
477
500
  #
501
+ #
502
+ #
503
+ # [1]: https://docs.aws.amazon.com/batch/latest/userguide/service_IAM_role.html
504
+ # [2]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html#identifiers-friendly-names
505
+ #
478
506
  # @option params [Hash<String,String>] :tags
479
507
  # The tags that you apply to the compute environment to help you
480
508
  # categorize and organize your resources. Each tag consists of a key and
@@ -619,7 +647,7 @@ module Aws::Batch
619
647
  # },
620
648
  # ],
621
649
  # },
622
- # service_role: "String", # required
650
+ # service_role: "String",
623
651
  # tags: {
624
652
  # "TagKey" => "TagValue",
625
653
  # },
@@ -643,14 +671,15 @@ module Aws::Batch
643
671
  # associate one or more compute environments to the queue and assign an
644
672
  # order of preference for the compute environments.
645
673
  #
646
- # You also set a priority to the job queue that determines the order in
647
- # which the AWS Batch scheduler places jobs onto its associated compute
674
+ # You also set a priority to the job queue that determines the order
675
+ # that the AWS Batch scheduler places jobs onto its associated compute
648
676
  # environments. For example, if a compute environment is associated with
649
677
  # more than one job queue, the job queue with a higher priority is given
650
678
  # preference for scheduling jobs to that compute environment.
651
679
  #
652
680
  # @option params [required, String] :job_queue_name
653
- # The name of the job queue.
681
+ # The name of the job queue. Up to 128 letters (uppercase and
682
+ # lowercase), numbers, and underscores are allowed.
654
683
  #
655
684
  # @option params [String] :state
656
685
  # The state of the job queue. If the job queue state is `ENABLED`, it is
@@ -664,7 +693,9 @@ module Aws::Batch
664
693
  # when associated with the same compute environment. Priority is
665
694
  # determined in descending order. For example, a job queue with a
666
695
  # priority value of `10` is given scheduling preference over a job queue
667
- # with a priority value of `1`.
696
+ # with a priority value of `1`. All of the compute environments must be
697
+ # either EC2 (`EC2` or `SPOT`) or Fargate (`FARGATE` or `FARGATE_SPOT`);
698
+ # EC2 and Fargate compute environments cannot be mixed.
668
699
  #
669
700
  # @option params [required, Array<Types::ComputeEnvironmentOrder>] :compute_environment_order
670
701
  # The set of compute environments mapped to a job queue and their order
@@ -676,15 +707,21 @@ module Aws::Batch
676
707
  # either EC2 (`EC2` or `SPOT`) or Fargate (`FARGATE` or `FARGATE_SPOT`);
677
708
  # EC2 and Fargate compute environments can't be mixed.
678
709
  #
710
+ # <note markdown="1"> All compute environments that are associated with a job queue must
711
+ # share the same architecture. AWS Batch doesn't support mixing compute
712
+ # environment architecture types in a single job queue.
713
+ #
714
+ # </note>
715
+ #
679
716
  # @option params [Hash<String,String>] :tags
680
717
  # The tags that you apply to the job queue to help you categorize and
681
718
  # organize your resources. Each tag consists of a key and an optional
682
- # value. For more information, see [Tagging AWS Resources][1] in *AWS
683
- # General Reference*.
719
+ # value. For more information, see [Tagging your AWS Batch resources][1]
720
+ # in *AWS Batch User Guide*.
684
721
  #
685
722
  #
686
723
  #
687
- # [1]: https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html
724
+ # [1]: https://docs.aws.amazon.com/batch/latest/userguide/using-tags.html
688
725
  #
689
726
  # @return [Types::CreateJobQueueResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
690
727
  #
@@ -780,7 +817,7 @@ module Aws::Batch
780
817
  # operation. Compute environments that use AWS Fargate resources must
781
818
  # terminate all active jobs on that compute environment before deleting
782
819
  # the compute environment. If this isn't done, the compute environment
783
- # will end up in an invalid state.
820
+ # enters an invalid state.
784
821
  #
785
822
  # @option params [required, String] :compute_environment
786
823
  # The name or Amazon Resource Name (ARN) of the compute environment to
@@ -818,7 +855,8 @@ module Aws::Batch
818
855
 
819
856
  # Deletes the specified job queue. You must first disable submissions
820
857
  # for a queue with the UpdateJobQueue operation. All jobs in the queue
821
- # are terminated when you delete a job queue.
858
+ # are eventually terminated when you delete a job queue. The jobs are
859
+ # terminated at a rate of about 16 jobs each second.
822
860
  #
823
861
  # It's not necessary to disassociate compute environments from a queue
824
862
  # before submitting a `DeleteJobQueue` request.
@@ -923,7 +961,7 @@ module Aws::Batch
923
961
  # from the end of the previous results that returned the `nextToken`
924
962
  # value. This value is `null` when there are no more results to return.
925
963
  #
926
- # <note markdown="1"> This token should be treated as an opaque identifier that is only used
964
+ # <note markdown="1"> This token should be treated as an opaque identifier that's only used
927
965
  # to retrieve the next items in a list and not for other programmatic
928
966
  # purposes.
929
967
  #
@@ -1053,8 +1091,8 @@ module Aws::Batch
1053
1091
  # The maximum number of results returned by `DescribeJobDefinitions` in
1054
1092
  # paginated output. When this parameter is used,
1055
1093
  # `DescribeJobDefinitions` only returns `maxResults` results in a single
1056
- # page along with a `nextToken` response element. The remaining results
1057
- # of the initial request can be seen by sending another
1094
+ # page and a `nextToken` response element. The remaining results of the
1095
+ # initial request can be seen by sending another
1058
1096
  # `DescribeJobDefinitions` request with the returned `nextToken` value.
1059
1097
  # This value can be between 1 and 100. If this parameter isn't used,
1060
1098
  # then `DescribeJobDefinitions` returns up to 100 results and a
@@ -1073,7 +1111,7 @@ module Aws::Batch
1073
1111
  # from the end of the previous results that returned the `nextToken`
1074
1112
  # value. This value is `null` when there are no more results to return.
1075
1113
  #
1076
- # <note markdown="1"> This token should be treated as an opaque identifier that is only used
1114
+ # <note markdown="1"> This token should be treated as an opaque identifier that's only used
1077
1115
  # to retrieve the next items in a list and not for other programmatic
1078
1116
  # purposes.
1079
1117
  #
@@ -1161,6 +1199,12 @@ module Aws::Batch
1161
1199
  # resp.job_definitions[0].container_properties.volumes #=> Array
1162
1200
  # resp.job_definitions[0].container_properties.volumes[0].host.source_path #=> String
1163
1201
  # resp.job_definitions[0].container_properties.volumes[0].name #=> String
1202
+ # resp.job_definitions[0].container_properties.volumes[0].efs_volume_configuration.file_system_id #=> String
1203
+ # resp.job_definitions[0].container_properties.volumes[0].efs_volume_configuration.root_directory #=> String
1204
+ # resp.job_definitions[0].container_properties.volumes[0].efs_volume_configuration.transit_encryption #=> String, one of "ENABLED", "DISABLED"
1205
+ # resp.job_definitions[0].container_properties.volumes[0].efs_volume_configuration.transit_encryption_port #=> Integer
1206
+ # resp.job_definitions[0].container_properties.volumes[0].efs_volume_configuration.authorization_config.access_point_id #=> String
1207
+ # resp.job_definitions[0].container_properties.volumes[0].efs_volume_configuration.authorization_config.iam #=> String, one of "ENABLED", "DISABLED"
1164
1208
  # resp.job_definitions[0].container_properties.environment #=> Array
1165
1209
  # resp.job_definitions[0].container_properties.environment[0].name #=> String
1166
1210
  # resp.job_definitions[0].container_properties.environment[0].value #=> String
@@ -1219,6 +1263,12 @@ module Aws::Batch
1219
1263
  # resp.job_definitions[0].node_properties.node_range_properties[0].container.volumes #=> Array
1220
1264
  # resp.job_definitions[0].node_properties.node_range_properties[0].container.volumes[0].host.source_path #=> String
1221
1265
  # resp.job_definitions[0].node_properties.node_range_properties[0].container.volumes[0].name #=> String
1266
+ # resp.job_definitions[0].node_properties.node_range_properties[0].container.volumes[0].efs_volume_configuration.file_system_id #=> String
1267
+ # resp.job_definitions[0].node_properties.node_range_properties[0].container.volumes[0].efs_volume_configuration.root_directory #=> String
1268
+ # resp.job_definitions[0].node_properties.node_range_properties[0].container.volumes[0].efs_volume_configuration.transit_encryption #=> String, one of "ENABLED", "DISABLED"
1269
+ # resp.job_definitions[0].node_properties.node_range_properties[0].container.volumes[0].efs_volume_configuration.transit_encryption_port #=> Integer
1270
+ # resp.job_definitions[0].node_properties.node_range_properties[0].container.volumes[0].efs_volume_configuration.authorization_config.access_point_id #=> String
1271
+ # resp.job_definitions[0].node_properties.node_range_properties[0].container.volumes[0].efs_volume_configuration.authorization_config.iam #=> String, one of "ENABLED", "DISABLED"
1222
1272
  # resp.job_definitions[0].node_properties.node_range_properties[0].container.environment #=> Array
1223
1273
  # resp.job_definitions[0].node_properties.node_range_properties[0].container.environment[0].name #=> String
1224
1274
  # resp.job_definitions[0].node_properties.node_range_properties[0].container.environment[0].value #=> String
@@ -1287,12 +1337,12 @@ module Aws::Batch
1287
1337
  # @option params [Integer] :max_results
1288
1338
  # The maximum number of results returned by `DescribeJobQueues` in
1289
1339
  # paginated output. When this parameter is used, `DescribeJobQueues`
1290
- # only returns `maxResults` results in a single page along with a
1291
- # `nextToken` response element. The remaining results of the initial
1292
- # request can be seen by sending another `DescribeJobQueues` request
1293
- # with the returned `nextToken` value. This value can be between 1 and
1294
- # 100. If this parameter isn't used, then `DescribeJobQueues` returns
1295
- # up to 100 results and a `nextToken` value if applicable.
1340
+ # only returns `maxResults` results in a single page and a `nextToken`
1341
+ # response element. The remaining results of the initial request can be
1342
+ # seen by sending another `DescribeJobQueues` request with the returned
1343
+ # `nextToken` value. This value can be between 1 and 100. If this
1344
+ # parameter isn't used, then `DescribeJobQueues` returns up to 100
1345
+ # results and a `nextToken` value if applicable.
1296
1346
  #
1297
1347
  # @option params [String] :next_token
1298
1348
  # The `nextToken` value returned from a previous paginated
@@ -1301,7 +1351,7 @@ module Aws::Batch
1301
1351
  # from the end of the previous results that returned the `nextToken`
1302
1352
  # value. This value is `null` when there are no more results to return.
1303
1353
  #
1304
- # <note markdown="1"> This token should be treated as an opaque identifier that is only used
1354
+ # <note markdown="1"> This token should be treated as an opaque identifier that's only used
1305
1355
  # to retrieve the next items in a list and not for other programmatic
1306
1356
  # purposes.
1307
1357
  #
@@ -1490,6 +1540,12 @@ module Aws::Batch
1490
1540
  # resp.jobs[0].container.volumes #=> Array
1491
1541
  # resp.jobs[0].container.volumes[0].host.source_path #=> String
1492
1542
  # resp.jobs[0].container.volumes[0].name #=> String
1543
+ # resp.jobs[0].container.volumes[0].efs_volume_configuration.file_system_id #=> String
1544
+ # resp.jobs[0].container.volumes[0].efs_volume_configuration.root_directory #=> String
1545
+ # resp.jobs[0].container.volumes[0].efs_volume_configuration.transit_encryption #=> String, one of "ENABLED", "DISABLED"
1546
+ # resp.jobs[0].container.volumes[0].efs_volume_configuration.transit_encryption_port #=> Integer
1547
+ # resp.jobs[0].container.volumes[0].efs_volume_configuration.authorization_config.access_point_id #=> String
1548
+ # resp.jobs[0].container.volumes[0].efs_volume_configuration.authorization_config.iam #=> String, one of "ENABLED", "DISABLED"
1493
1549
  # resp.jobs[0].container.environment #=> Array
1494
1550
  # resp.jobs[0].container.environment[0].name #=> String
1495
1551
  # resp.jobs[0].container.environment[0].value #=> String
@@ -1558,6 +1614,12 @@ module Aws::Batch
1558
1614
  # resp.jobs[0].node_properties.node_range_properties[0].container.volumes #=> Array
1559
1615
  # resp.jobs[0].node_properties.node_range_properties[0].container.volumes[0].host.source_path #=> String
1560
1616
  # resp.jobs[0].node_properties.node_range_properties[0].container.volumes[0].name #=> String
1617
+ # resp.jobs[0].node_properties.node_range_properties[0].container.volumes[0].efs_volume_configuration.file_system_id #=> String
1618
+ # resp.jobs[0].node_properties.node_range_properties[0].container.volumes[0].efs_volume_configuration.root_directory #=> String
1619
+ # resp.jobs[0].node_properties.node_range_properties[0].container.volumes[0].efs_volume_configuration.transit_encryption #=> String, one of "ENABLED", "DISABLED"
1620
+ # resp.jobs[0].node_properties.node_range_properties[0].container.volumes[0].efs_volume_configuration.transit_encryption_port #=> Integer
1621
+ # resp.jobs[0].node_properties.node_range_properties[0].container.volumes[0].efs_volume_configuration.authorization_config.access_point_id #=> String
1622
+ # resp.jobs[0].node_properties.node_range_properties[0].container.volumes[0].efs_volume_configuration.authorization_config.iam #=> String, one of "ENABLED", "DISABLED"
1561
1623
  # resp.jobs[0].node_properties.node_range_properties[0].container.environment #=> Array
1562
1624
  # resp.jobs[0].node_properties.node_range_properties[0].container.environment[0].name #=> String
1563
1625
  # resp.jobs[0].node_properties.node_range_properties[0].container.environment[0].value #=> String
@@ -1627,9 +1689,9 @@ module Aws::Batch
1627
1689
  #
1628
1690
  # * A job queue ID to return a list of jobs in that job queue
1629
1691
  #
1630
- # * A multi-node parallel job ID to return a list of that job's nodes
1692
+ # * A multi-node parallel job ID to return a list of nodes for that job
1631
1693
  #
1632
- # * An array job ID to return a list of that job's children
1694
+ # * An array job ID to return a list of the children for that job
1633
1695
  #
1634
1696
  # You can filter the results by job status with the `jobStatus`
1635
1697
  # parameter. If you don't specify a status, only `RUNNING` jobs are
@@ -1655,12 +1717,12 @@ module Aws::Batch
1655
1717
  # @option params [Integer] :max_results
1656
1718
  # The maximum number of results returned by `ListJobs` in paginated
1657
1719
  # output. When this parameter is used, `ListJobs` only returns
1658
- # `maxResults` results in a single page along with a `nextToken`
1659
- # response element. The remaining results of the initial request can be
1660
- # seen by sending another `ListJobs` request with the returned
1661
- # `nextToken` value. This value can be between 1 and 100. If this
1662
- # parameter isn't used, then `ListJobs` returns up to 100 results and a
1663
- # `nextToken` value if applicable.
1720
+ # `maxResults` results in a single page and a `nextToken` response
1721
+ # element. The remaining results of the initial request can be seen by
1722
+ # sending another `ListJobs` request with the returned `nextToken`
1723
+ # value. This value can be between 1 and 100. If this parameter isn't
1724
+ # used, then `ListJobs` returns up to 100 results and a `nextToken`
1725
+ # value if applicable.
1664
1726
  #
1665
1727
  # @option params [String] :next_token
1666
1728
  # The `nextToken` value returned from a previous paginated `ListJobs`
@@ -1669,7 +1731,7 @@ module Aws::Batch
1669
1731
  # results that returned the `nextToken` value. This value is `null` when
1670
1732
  # there are no more results to return.
1671
1733
  #
1672
- # <note markdown="1"> This token should be treated as an opaque identifier that is only used
1734
+ # <note markdown="1"> This token should be treated as an opaque identifier that's only used
1673
1735
  # to retrieve the next items in a list and not for other programmatic
1674
1736
  # purposes.
1675
1737
  #
@@ -1870,7 +1932,7 @@ module Aws::Batch
1870
1932
  #
1871
1933
  # @option params [Types::RetryStrategy] :retry_strategy
1872
1934
  # The retry strategy to use for failed jobs that are submitted with this
1873
- # job definition. Any retry strategy that is specified during a
1935
+ # job definition. Any retry strategy that's specified during a
1874
1936
  # SubmitJob operation overrides the retry strategy defined here. If a
1875
1937
  # job is terminated due to a timeout, it isn't retried.
1876
1938
  #
@@ -1888,7 +1950,7 @@ module Aws::Batch
1888
1950
  # definition, after which AWS Batch terminates your jobs if they have
1889
1951
  # not finished. If a job is terminated due to a timeout, it isn't
1890
1952
  # retried. The minimum value for the timeout is 60 seconds. Any timeout
1891
- # configuration that is specified during a SubmitJob operation overrides
1953
+ # configuration that's specified during a SubmitJob operation overrides
1892
1954
  # the timeout configuration defined here. For more information, see [Job
1893
1955
  # Timeouts][1] in the *AWS Batch User Guide*.
1894
1956
  #
@@ -1993,6 +2055,16 @@ module Aws::Batch
1993
2055
  # source_path: "String",
1994
2056
  # },
1995
2057
  # name: "String",
2058
+ # efs_volume_configuration: {
2059
+ # file_system_id: "String", # required
2060
+ # root_directory: "String",
2061
+ # transit_encryption: "ENABLED", # accepts ENABLED, DISABLED
2062
+ # transit_encryption_port: 1,
2063
+ # authorization_config: {
2064
+ # access_point_id: "String",
2065
+ # iam: "ENABLED", # accepts ENABLED, DISABLED
2066
+ # },
2067
+ # },
1996
2068
  # },
1997
2069
  # ],
1998
2070
  # environment: [
@@ -2089,6 +2161,16 @@ module Aws::Batch
2089
2161
  # source_path: "String",
2090
2162
  # },
2091
2163
  # name: "String",
2164
+ # efs_volume_configuration: {
2165
+ # file_system_id: "String", # required
2166
+ # root_directory: "String",
2167
+ # transit_encryption: "ENABLED", # accepts ENABLED, DISABLED
2168
+ # transit_encryption_port: 1,
2169
+ # authorization_config: {
2170
+ # access_point_id: "String",
2171
+ # iam: "ENABLED", # accepts ENABLED, DISABLED
2172
+ # },
2173
+ # },
2092
2174
  # },
2093
2175
  # ],
2094
2176
  # environment: [
@@ -2205,12 +2287,18 @@ module Aws::Batch
2205
2287
  req.send_request(options)
2206
2288
  end
2207
2289
 
2208
- # Submits an AWS Batch job from a job definition. Parameters specified
2209
- # during SubmitJob override parameters defined in the job definition.
2210
- #
2211
- # Jobs run on Fargate resources don't run for more than 14 days. After
2212
- # 14 days, the Fargate resources might no longer be available and the
2213
- # job is terminated.
2290
+ # Submits an AWS Batch job from a job definition. Parameters that are
2291
+ # specified during SubmitJob override parameters defined in the job
2292
+ # definition. vCPU and memory requirements that are specified in the
2293
+ # `ResourceRequirements` objects in the job definition are the
2294
+ # exception. They can't be overridden this way using the `memory` and
2295
+ # `vcpus` parameters. Rather, you must specify updates to job definition
2296
+ # parameters in a `ResourceRequirements` object that's included in the
2297
+ # `containerOverrides` parameter.
2298
+ #
2299
+ # Jobs that run on Fargate resources can't be guaranteed to run for
2300
+ # more than 14 days. This is because, after 14 days, Fargate resources
2301
+ # might become unavailable and job might be terminated.
2214
2302
  #
2215
2303
  # @option params [required, String] :job_name
2216
2304
  # The name of the job. The first character must be alphanumeric, and up
@@ -2218,8 +2306,8 @@ module Aws::Batch
2218
2306
  # underscores are allowed.
2219
2307
  #
2220
2308
  # @option params [required, String] :job_queue
2221
- # The job queue into which the job is submitted. You can specify either
2222
- # the name or the Amazon Resource Name (ARN) of the queue.
2309
+ # The job queue where the job is submitted. You can specify either the
2310
+ # name or the Amazon Resource Name (ARN) of the queue.
2223
2311
  #
2224
2312
  # @option params [Types::ArrayProperties] :array_properties
2225
2313
  # The array properties for the submitted job, such as the size of the
@@ -2254,14 +2342,13 @@ module Aws::Batch
2254
2342
  # from the job definition.
2255
2343
  #
2256
2344
  # @option params [Types::ContainerOverrides] :container_overrides
2257
- # A list of container overrides in JSON format that specify the name of
2258
- # a container in the specified job definition and the overrides it
2259
- # should receive. You can override the default command for a container
2260
- # (that is specified in the job definition or the Docker image) with a
2345
+ # A list of container overrides in the JSON format that specify the name
2346
+ # of a container in the specified job definition and the overrides it
2347
+ # should receive. You can override the default command for a container,
2348
+ # which is specified in the job definition or the Docker image, with a
2261
2349
  # `command` override. You can also override existing environment
2262
- # variables (that are specified in the job definition or Docker image)
2263
- # on a container or add new environment variables to it with an
2264
- # `environment` override.
2350
+ # variables on a container or add new environment variables to it with
2351
+ # an `environment` override.
2265
2352
  #
2266
2353
  # @option params [Types::NodeOverrides] :node_overrides
2267
2354
  # A list of node overrides in JSON format that specify the node range to
@@ -2593,13 +2680,36 @@ module Aws::Batch
2593
2680
  # `ENABLED` state can accept jobs from a queue and scale in or out
2594
2681
  # automatically based on the workload demand of its associated queues.
2595
2682
  #
2683
+ # If the state is `ENABLED`, then the AWS Batch scheduler can attempt to
2684
+ # place jobs from an associated job queue on the compute resources
2685
+ # within the environment. If the compute environment is managed, then it
2686
+ # can scale its instances out or in automatically, based on the job
2687
+ # queue demand.
2688
+ #
2689
+ # If the state is `DISABLED`, then the AWS Batch scheduler doesn't
2690
+ # attempt to place jobs within the environment. Jobs in a `STARTING` or
2691
+ # `RUNNING` state continue to progress normally. Managed compute
2692
+ # environments in the `DISABLED` state don't scale out. However, they
2693
+ # scale in to `minvCpus` value after instances become idle.
2694
+ #
2596
2695
  # @option params [Types::ComputeResourceUpdate] :compute_resources
2597
2696
  # Details of the compute resources managed by the compute environment.
2598
- # Required for a managed compute environment.
2697
+ # Required for a managed compute environment. For more information, see
2698
+ # [Compute Environments][1] in the *AWS Batch User Guide*.
2699
+ #
2700
+ #
2701
+ #
2702
+ # [1]: https://docs.aws.amazon.com/batch/latest/userguide/compute_environments.html
2599
2703
  #
2600
2704
  # @option params [String] :service_role
2601
2705
  # The full Amazon Resource Name (ARN) of the IAM role that allows AWS
2602
- # Batch to make calls to other AWS services on your behalf.
2706
+ # Batch to make calls to other AWS services on your behalf. For more
2707
+ # information, see [AWS Batch service IAM role][1] in the *AWS Batch
2708
+ # User Guide*.
2709
+ #
2710
+ # If the compute environment has a service-linked role, it cannot be
2711
+ # changed to use a regular IAM role. If the compute environment has a
2712
+ # regular IAM role, it cannot be changed to use a service-linked role.
2603
2713
  #
2604
2714
  # If your specified role has a path other than `/`, then you must either
2605
2715
  # specify the full role ARN (this is recommended) or prefix the role
@@ -2607,13 +2717,17 @@ module Aws::Batch
2607
2717
  #
2608
2718
  # <note markdown="1"> Depending on how you created your AWS Batch service role, its ARN
2609
2719
  # might contain the `service-role` path prefix. When you only specify
2610
- # the name of the service role, AWS Batch assumes that your ARN does not
2720
+ # the name of the service role, AWS Batch assumes that your ARN doesn't
2611
2721
  # use the `service-role` path prefix. Because of this, we recommend that
2612
2722
  # you specify the full ARN of your service role when you create compute
2613
2723
  # environments.
2614
2724
  #
2615
2725
  # </note>
2616
2726
  #
2727
+ #
2728
+ #
2729
+ # [1]: https://docs.aws.amazon.com/batch/latest/userguide/service_IAM_role.html
2730
+ #
2617
2731
  # @return [Types::UpdateComputeEnvironmentResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2618
2732
  #
2619
2733
  # * {Types::UpdateComputeEnvironmentResponse#compute_environment_name #compute_environment_name} => String
@@ -2671,9 +2785,9 @@ module Aws::Batch
2671
2785
  #
2672
2786
  # @option params [String] :state
2673
2787
  # Describes the queue's ability to accept new jobs. If the job queue
2674
- # state is `ENABLED`, it is able to accept jobs. If the job queue state
2675
- # is `DISABLED`, new jobs cannot be added to the queue, but jobs already
2676
- # in the queue can finish.
2788
+ # state is `ENABLED`, it can accept jobs. If the job queue state is
2789
+ # `DISABLED`, new jobs can't be added to the queue, but jobs already in
2790
+ # the queue can finish.
2677
2791
  #
2678
2792
  # @option params [Integer] :priority
2679
2793
  # The priority of the job queue. Job queues with a higher priority (or a
@@ -2681,15 +2795,25 @@ module Aws::Batch
2681
2795
  # when associated with the same compute environment. Priority is
2682
2796
  # determined in descending order, for example, a job queue with a
2683
2797
  # priority value of `10` is given scheduling preference over a job queue
2684
- # with a priority value of `1`.
2798
+ # with a priority value of `1`. All of the compute environments must be
2799
+ # either EC2 (`EC2` or `SPOT`) or Fargate (`FARGATE` or `FARGATE_SPOT`).
2800
+ # EC2 and Fargate compute environments can't be mixed.
2685
2801
  #
2686
2802
  # @option params [Array<Types::ComputeEnvironmentOrder>] :compute_environment_order
2687
2803
  # Details the set of compute environments mapped to a job queue and
2688
2804
  # their order relative to each other. This is one of the parameters used
2689
2805
  # by the job scheduler to determine which compute environment should run
2690
- # a given job. All of the compute environments must be either EC2 (`EC2`
2691
- # or `SPOT`) or Fargate (`FARGATE` or `FARGATE_SPOT`); EC2 and Fargate
2692
- # compute environments can't be mixed.
2806
+ # a given job. Compute environments must be in the `VALID` state before
2807
+ # you can associate them with a job queue. All of the compute
2808
+ # environments must be either EC2 (`EC2` or `SPOT`) or Fargate
2809
+ # (`FARGATE` or `FARGATE_SPOT`). EC2 and Fargate compute environments
2810
+ # can't be mixed.
2811
+ #
2812
+ # <note markdown="1"> All compute environments that are associated with a job queue must
2813
+ # share the same architecture. AWS Batch doesn't support mixing compute
2814
+ # environment architecture types in a single job queue.
2815
+ #
2816
+ # </note>
2693
2817
  #
2694
2818
  # @return [Types::UpdateJobQueueResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2695
2819
  #
@@ -2753,7 +2877,7 @@ module Aws::Batch
2753
2877
  params: params,
2754
2878
  config: config)
2755
2879
  context[:gem_name] = 'aws-sdk-batch'
2756
- context[:gem_version] = '1.42.0'
2880
+ context[:gem_version] = '1.47.0'
2757
2881
  Seahorse::Client::Request.new(handlers, context)
2758
2882
  end
2759
2883