aws-sdk-batch 1.45.0 → 1.46.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.
- checksums.yaml +4 -4
- data/CHANGELOG.md +5 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-batch.rb +1 -1
- data/lib/aws-sdk-batch/client.rb +82 -67
- data/lib/aws-sdk-batch/client_api.rb +1 -1
- data/lib/aws-sdk-batch/types.rb +182 -158
- metadata +2 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 5c6a9011b5e322a31d9711ed061aa4b32c840ede851a7a844ea80c32e219890a
|
4
|
+
data.tar.gz: 380e04bbccff0d590de3ca7b5bd6f46a782a5f7132c2da889b923d8f662da158
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 80e85ccfb2cd93d0d41904f2c0fac2a80ec4e118cf795779848ab1cff23e74aee79a1d963286e934d24a4c9ce8495e4e75de73f79c48759add57e079d37ccdff
|
7
|
+
data.tar.gz: d5815bbf0664ba1b92fcecf34cfa1ea91086ed16816fc6d247e1edb0f14a73cf13b38003f9af7c99303736dcddbef5b122496e2145afa81f4137168139f74367
|
data/CHANGELOG.md
CHANGED
@@ -1,6 +1,11 @@
|
|
1
1
|
Unreleased Changes
|
2
2
|
------------------
|
3
3
|
|
4
|
+
1.46.0 (2021-03-17)
|
5
|
+
------------------
|
6
|
+
|
7
|
+
* Feature - Making serviceRole an optional parameter when creating a compute environment. If serviceRole is not provided then Service Linked Role will be created (or reused if it already exists).
|
8
|
+
|
4
9
|
1.45.0 (2021-03-10)
|
5
10
|
------------------
|
6
11
|
|
data/VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
1.
|
1
|
+
1.46.0
|
data/lib/aws-sdk-batch.rb
CHANGED
data/lib/aws-sdk-batch/client.rb
CHANGED
@@ -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`
|
333
|
-
# API operation still succeeds, even if no job is canceled
|
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.
|
386
|
-
# EC2 Spot Instances,
|
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
389
|
# is less than a specified percentage of the On-Demand price.
|
390
390
|
#
|
391
|
-
# <note markdown="1"> Multi-node parallel jobs
|
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
|
398
|
-
# you
|
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
|
402
|
-
#
|
403
|
-
#
|
404
|
-
#
|
405
|
-
#
|
406
|
-
#
|
407
|
-
#
|
408
|
-
# <note markdown="1"> AWS Batch doesn't upgrade the AMIs in a compute environment after
|
409
|
-
#
|
410
|
-
# version of the Amazon ECS
|
411
|
-
# you're responsible for
|
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:
|
@@ -470,15 +470,24 @@ module Aws::Batch
|
|
470
470
|
#
|
471
471
|
# [1]: https://docs.aws.amazon.com/batch/latest/userguide/compute_environments.html
|
472
472
|
#
|
473
|
-
# @option params [
|
473
|
+
# @option params [String] :service_role
|
474
474
|
# The full Amazon Resource Name (ARN) of the IAM role that allows AWS
|
475
475
|
# Batch to make calls to other AWS services on your behalf. For more
|
476
476
|
# information, see [AWS Batch service IAM role][1] in the *AWS Batch
|
477
477
|
# User Guide*.
|
478
478
|
#
|
479
|
-
# If your
|
480
|
-
#
|
481
|
-
#
|
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*.
|
482
491
|
#
|
483
492
|
# <note markdown="1"> Depending on how you created your AWS Batch service role, its ARN
|
484
493
|
# might contain the `service-role` path prefix. When you only specify
|
@@ -492,6 +501,7 @@ module Aws::Batch
|
|
492
501
|
#
|
493
502
|
#
|
494
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
|
495
505
|
#
|
496
506
|
# @option params [Hash<String,String>] :tags
|
497
507
|
# The tags that you apply to the compute environment to help you
|
@@ -637,7 +647,7 @@ module Aws::Batch
|
|
637
647
|
# },
|
638
648
|
# ],
|
639
649
|
# },
|
640
|
-
# service_role: "String",
|
650
|
+
# service_role: "String",
|
641
651
|
# tags: {
|
642
652
|
# "TagKey" => "TagValue",
|
643
653
|
# },
|
@@ -661,8 +671,8 @@ module Aws::Batch
|
|
661
671
|
# associate one or more compute environments to the queue and assign an
|
662
672
|
# order of preference for the compute environments.
|
663
673
|
#
|
664
|
-
# You also set a priority to the job queue that determines the order
|
665
|
-
#
|
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
|
666
676
|
# environments. For example, if a compute environment is associated with
|
667
677
|
# more than one job queue, the job queue with a higher priority is given
|
668
678
|
# preference for scheduling jobs to that compute environment.
|
@@ -807,7 +817,7 @@ module Aws::Batch
|
|
807
817
|
# operation. Compute environments that use AWS Fargate resources must
|
808
818
|
# terminate all active jobs on that compute environment before deleting
|
809
819
|
# the compute environment. If this isn't done, the compute environment
|
810
|
-
#
|
820
|
+
# enters an invalid state.
|
811
821
|
#
|
812
822
|
# @option params [required, String] :compute_environment
|
813
823
|
# The name or Amazon Resource Name (ARN) of the compute environment to
|
@@ -1081,8 +1091,8 @@ module Aws::Batch
|
|
1081
1091
|
# The maximum number of results returned by `DescribeJobDefinitions` in
|
1082
1092
|
# paginated output. When this parameter is used,
|
1083
1093
|
# `DescribeJobDefinitions` only returns `maxResults` results in a single
|
1084
|
-
# page
|
1085
|
-
#
|
1094
|
+
# page and a `nextToken` response element. The remaining results of the
|
1095
|
+
# initial request can be seen by sending another
|
1086
1096
|
# `DescribeJobDefinitions` request with the returned `nextToken` value.
|
1087
1097
|
# This value can be between 1 and 100. If this parameter isn't used,
|
1088
1098
|
# then `DescribeJobDefinitions` returns up to 100 results and a
|
@@ -1315,12 +1325,12 @@ module Aws::Batch
|
|
1315
1325
|
# @option params [Integer] :max_results
|
1316
1326
|
# The maximum number of results returned by `DescribeJobQueues` in
|
1317
1327
|
# paginated output. When this parameter is used, `DescribeJobQueues`
|
1318
|
-
# only returns `maxResults` results in a single page
|
1319
|
-
#
|
1320
|
-
#
|
1321
|
-
#
|
1322
|
-
#
|
1323
|
-
#
|
1328
|
+
# only returns `maxResults` results in a single page and a `nextToken`
|
1329
|
+
# response element. The remaining results of the initial request can be
|
1330
|
+
# seen by sending another `DescribeJobQueues` request with the returned
|
1331
|
+
# `nextToken` value. This value can be between 1 and 100. If this
|
1332
|
+
# parameter isn't used, then `DescribeJobQueues` returns up to 100
|
1333
|
+
# results and a `nextToken` value if applicable.
|
1324
1334
|
#
|
1325
1335
|
# @option params [String] :next_token
|
1326
1336
|
# The `nextToken` value returned from a previous paginated
|
@@ -1655,9 +1665,9 @@ module Aws::Batch
|
|
1655
1665
|
#
|
1656
1666
|
# * A job queue ID to return a list of jobs in that job queue
|
1657
1667
|
#
|
1658
|
-
# * A multi-node parallel job ID to return a list of that job
|
1668
|
+
# * A multi-node parallel job ID to return a list of nodes for that job
|
1659
1669
|
#
|
1660
|
-
# * An array job ID to return a list of that job
|
1670
|
+
# * An array job ID to return a list of the children for that job
|
1661
1671
|
#
|
1662
1672
|
# You can filter the results by job status with the `jobStatus`
|
1663
1673
|
# parameter. If you don't specify a status, only `RUNNING` jobs are
|
@@ -1683,12 +1693,12 @@ module Aws::Batch
|
|
1683
1693
|
# @option params [Integer] :max_results
|
1684
1694
|
# The maximum number of results returned by `ListJobs` in paginated
|
1685
1695
|
# output. When this parameter is used, `ListJobs` only returns
|
1686
|
-
# `maxResults` results in a single page
|
1687
|
-
#
|
1688
|
-
#
|
1689
|
-
#
|
1690
|
-
#
|
1691
|
-
#
|
1696
|
+
# `maxResults` results in a single page and a `nextToken` response
|
1697
|
+
# element. The remaining results of the initial request can be seen by
|
1698
|
+
# sending another `ListJobs` request with the returned `nextToken`
|
1699
|
+
# value. This value can be between 1 and 100. If this parameter isn't
|
1700
|
+
# used, then `ListJobs` returns up to 100 results and a `nextToken`
|
1701
|
+
# value if applicable.
|
1692
1702
|
#
|
1693
1703
|
# @option params [String] :next_token
|
1694
1704
|
# The `nextToken` value returned from a previous paginated `ListJobs`
|
@@ -2233,12 +2243,18 @@ module Aws::Batch
|
|
2233
2243
|
req.send_request(options)
|
2234
2244
|
end
|
2235
2245
|
|
2236
|
-
# Submits an AWS Batch job from a job definition. Parameters
|
2237
|
-
# during SubmitJob override parameters defined in the job
|
2238
|
-
#
|
2239
|
-
#
|
2240
|
-
#
|
2241
|
-
# job
|
2246
|
+
# Submits an AWS Batch job from a job definition. Parameters that are
|
2247
|
+
# specified during SubmitJob override parameters defined in the job
|
2248
|
+
# definition. vCPU and memory requirements that are specified in the
|
2249
|
+
# `ResourceRequirements` objects in the job definition are the
|
2250
|
+
# exception. They can't be overridden this way using the `memory` and
|
2251
|
+
# `vcpus` parameters. Rather, you must specify updates to job definition
|
2252
|
+
# parameters in a `ResourceRequirements` object that's included in the
|
2253
|
+
# `containerOverrides` parameter.
|
2254
|
+
#
|
2255
|
+
# Jobs that run on Fargate resources can't be guaranteed to run for
|
2256
|
+
# more than 14 days. This is because, after 14 days, Fargate resources
|
2257
|
+
# might become unavailable and job might be terminated.
|
2242
2258
|
#
|
2243
2259
|
# @option params [required, String] :job_name
|
2244
2260
|
# The name of the job. The first character must be alphanumeric, and up
|
@@ -2246,8 +2262,8 @@ module Aws::Batch
|
|
2246
2262
|
# underscores are allowed.
|
2247
2263
|
#
|
2248
2264
|
# @option params [required, String] :job_queue
|
2249
|
-
# The job queue
|
2250
|
-
#
|
2265
|
+
# The job queue where the job is submitted. You can specify either the
|
2266
|
+
# name or the Amazon Resource Name (ARN) of the queue.
|
2251
2267
|
#
|
2252
2268
|
# @option params [Types::ArrayProperties] :array_properties
|
2253
2269
|
# The array properties for the submitted job, such as the size of the
|
@@ -2282,14 +2298,13 @@ module Aws::Batch
|
|
2282
2298
|
# from the job definition.
|
2283
2299
|
#
|
2284
2300
|
# @option params [Types::ContainerOverrides] :container_overrides
|
2285
|
-
# A list of container overrides in JSON format that specify the name
|
2286
|
-
# a container in the specified job definition and the overrides it
|
2287
|
-
# should receive. You can override the default command for a container
|
2288
|
-
#
|
2301
|
+
# A list of container overrides in the JSON format that specify the name
|
2302
|
+
# of a container in the specified job definition and the overrides it
|
2303
|
+
# should receive. You can override the default command for a container,
|
2304
|
+
# which is specified in the job definition or the Docker image, with a
|
2289
2305
|
# `command` override. You can also override existing environment
|
2290
|
-
# variables
|
2291
|
-
#
|
2292
|
-
# `environment` override.
|
2306
|
+
# variables on a container or add new environment variables to it with
|
2307
|
+
# an `environment` override.
|
2293
2308
|
#
|
2294
2309
|
# @option params [Types::NodeOverrides] :node_overrides
|
2295
2310
|
# A list of node overrides in JSON format that specify the node range to
|
@@ -2654,7 +2669,7 @@ module Aws::Batch
|
|
2654
2669
|
#
|
2655
2670
|
# <note markdown="1"> Depending on how you created your AWS Batch service role, its ARN
|
2656
2671
|
# might contain the `service-role` path prefix. When you only specify
|
2657
|
-
# the name of the service role, AWS Batch assumes that your ARN
|
2672
|
+
# the name of the service role, AWS Batch assumes that your ARN doesn't
|
2658
2673
|
# use the `service-role` path prefix. Because of this, we recommend that
|
2659
2674
|
# you specify the full ARN of your service role when you create compute
|
2660
2675
|
# environments.
|
@@ -2722,9 +2737,9 @@ module Aws::Batch
|
|
2722
2737
|
#
|
2723
2738
|
# @option params [String] :state
|
2724
2739
|
# Describes the queue's ability to accept new jobs. If the job queue
|
2725
|
-
# state is `ENABLED`, it
|
2726
|
-
#
|
2727
|
-
#
|
2740
|
+
# state is `ENABLED`, it can accept jobs. If the job queue state is
|
2741
|
+
# `DISABLED`, new jobs can't be added to the queue, but jobs already in
|
2742
|
+
# the queue can finish.
|
2728
2743
|
#
|
2729
2744
|
# @option params [Integer] :priority
|
2730
2745
|
# The priority of the job queue. Job queues with a higher priority (or a
|
@@ -2733,8 +2748,8 @@ module Aws::Batch
|
|
2733
2748
|
# determined in descending order, for example, a job queue with a
|
2734
2749
|
# priority value of `10` is given scheduling preference over a job queue
|
2735
2750
|
# with a priority value of `1`. All of the compute environments must be
|
2736
|
-
# either EC2 (`EC2` or `SPOT`) or Fargate (`FARGATE` or `FARGATE_SPOT`)
|
2737
|
-
# EC2 and Fargate compute environments
|
2751
|
+
# either EC2 (`EC2` or `SPOT`) or Fargate (`FARGATE` or `FARGATE_SPOT`).
|
2752
|
+
# EC2 and Fargate compute environments can't be mixed.
|
2738
2753
|
#
|
2739
2754
|
# @option params [Array<Types::ComputeEnvironmentOrder>] :compute_environment_order
|
2740
2755
|
# Details the set of compute environments mapped to a job queue and
|
@@ -2743,7 +2758,7 @@ module Aws::Batch
|
|
2743
2758
|
# a given job. Compute environments must be in the `VALID` state before
|
2744
2759
|
# you can associate them with a job queue. All of the compute
|
2745
2760
|
# environments must be either EC2 (`EC2` or `SPOT`) or Fargate
|
2746
|
-
# (`FARGATE` or `FARGATE_SPOT`)
|
2761
|
+
# (`FARGATE` or `FARGATE_SPOT`). EC2 and Fargate compute environments
|
2747
2762
|
# can't be mixed.
|
2748
2763
|
#
|
2749
2764
|
# <note markdown="1"> All compute environments that are associated with a job queue must
|
@@ -2814,7 +2829,7 @@ module Aws::Batch
|
|
2814
2829
|
params: params,
|
2815
2830
|
config: config)
|
2816
2831
|
context[:gem_name] = 'aws-sdk-batch'
|
2817
|
-
context[:gem_version] = '1.
|
2832
|
+
context[:gem_version] = '1.46.0'
|
2818
2833
|
Seahorse::Client::Request.new(handlers, context)
|
2819
2834
|
end
|
2820
2835
|
|
@@ -303,7 +303,7 @@ module Aws::Batch
|
|
303
303
|
CreateComputeEnvironmentRequest.add_member(:type, Shapes::ShapeRef.new(shape: CEType, required: true, location_name: "type"))
|
304
304
|
CreateComputeEnvironmentRequest.add_member(:state, Shapes::ShapeRef.new(shape: CEState, location_name: "state"))
|
305
305
|
CreateComputeEnvironmentRequest.add_member(:compute_resources, Shapes::ShapeRef.new(shape: ComputeResource, location_name: "computeResources"))
|
306
|
-
CreateComputeEnvironmentRequest.add_member(:service_role, Shapes::ShapeRef.new(shape: String,
|
306
|
+
CreateComputeEnvironmentRequest.add_member(:service_role, Shapes::ShapeRef.new(shape: String, location_name: "serviceRole"))
|
307
307
|
CreateComputeEnvironmentRequest.add_member(:tags, Shapes::ShapeRef.new(shape: TagrisTagsMap, location_name: "tags"))
|
308
308
|
CreateComputeEnvironmentRequest.struct_class = Types::CreateComputeEnvironmentRequest
|
309
309
|
|
data/lib/aws-sdk-batch/types.rb
CHANGED
@@ -424,13 +424,13 @@ module Aws::Batch
|
|
424
424
|
# : AWS Batch selects an instance type that best fits the needs of the
|
425
425
|
# jobs with a preference for the lowest-cost instance type. If
|
426
426
|
# additional instances of the selected instance type aren't
|
427
|
-
# available, AWS Batch
|
428
|
-
# available. If there
|
427
|
+
# available, AWS Batch waits for the additional instances to be
|
428
|
+
# available. If there aren't enough instances available, or if the
|
429
429
|
# user is hitting [Amazon EC2 service limits][1] then additional
|
430
|
-
# jobs aren't run until currently running jobs have completed.
|
431
|
-
# allocation strategy keeps costs lower but can limit scaling.
|
432
|
-
# you are using Spot Fleets with `BEST_FIT` then the Spot Fleet
|
433
|
-
# Role must be specified.
|
430
|
+
# jobs aren't run until the currently running jobs have completed.
|
431
|
+
# This allocation strategy keeps costs lower but can limit scaling.
|
432
|
+
# If you are using Spot Fleets with `BEST_FIT` then the Spot Fleet
|
433
|
+
# IAM Role must be specified.
|
434
434
|
#
|
435
435
|
# BEST\_FIT\_PROGRESSIVE
|
436
436
|
#
|
@@ -474,11 +474,11 @@ module Aws::Batch
|
|
474
474
|
# can reach.
|
475
475
|
#
|
476
476
|
# <note markdown="1"> With both `BEST_FIT_PROGRESSIVE` and `SPOT_CAPACITY_OPTIMIZED`
|
477
|
-
# allocation strategies, AWS Batch might need to
|
478
|
-
#
|
479
|
-
#
|
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
480
|
# more than a single instance from among those specified in your
|
481
|
-
# compute environment
|
481
|
+
# compute environment is allocated.
|
482
482
|
#
|
483
483
|
# </note>
|
484
484
|
# @return [Integer]
|
@@ -499,8 +499,8 @@ module Aws::Batch
|
|
499
499
|
# families to launch any instance type within those families (for
|
500
500
|
# example, `c5` or `p3`), or you can specify specific sizes within a
|
501
501
|
# family (such as `c5.8xlarge`). You can also choose `optimal` to
|
502
|
-
# select instance types (from the C4, M4, and R4 instance families)
|
503
|
-
#
|
502
|
+
# select instance types (from the C4, M4, and R4 instance families)
|
503
|
+
# that match the demand of your job queues.
|
504
504
|
#
|
505
505
|
# <note markdown="1"> This parameter isn't applicable to jobs running on Fargate
|
506
506
|
# resources, and shouldn't be specified.
|
@@ -550,10 +550,9 @@ module Aws::Batch
|
|
550
550
|
#
|
551
551
|
# @!attribute [rw] subnets
|
552
552
|
# The VPC subnets into which the compute resources are launched. These
|
553
|
-
# subnets must be within the same VPC.
|
554
|
-
#
|
555
|
-
#
|
556
|
-
# *Amazon VPC User Guide*.
|
553
|
+
# subnets must be within the same VPC. Fargate compute resources can
|
554
|
+
# contain up to 16 subnets. For more information, see [VPCs and
|
555
|
+
# Subnets][1] in the *Amazon VPC User Guide*.
|
557
556
|
#
|
558
557
|
#
|
559
558
|
#
|
@@ -566,9 +565,9 @@ module Aws::Batch
|
|
566
565
|
# specified, either in `securityGroupIds` or using a launch template
|
567
566
|
# referenced in `launchTemplate`. This parameter is required for jobs
|
568
567
|
# running on Fargate resources and must contain at least one security
|
569
|
-
# group.
|
570
|
-
#
|
571
|
-
#
|
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.
|
572
571
|
# @return [Array<String>]
|
573
572
|
#
|
574
573
|
# @!attribute [rw] ec2_key_pair
|
@@ -610,7 +609,7 @@ module Aws::Batch
|
|
610
609
|
# instances in the Amazon EC2 console. These tags can't be updated or
|
611
610
|
# removed after the compute environment has been created; any changes
|
612
611
|
# require creating a new compute environment and removing the old
|
613
|
-
# compute environment. These tags
|
612
|
+
# compute environment. These tags aren't seen when using the AWS
|
614
613
|
# Batch `ListTagsForResource` API operation.
|
615
614
|
#
|
616
615
|
# <note markdown="1"> This parameter isn't applicable to jobs running on Fargate
|
@@ -768,11 +767,11 @@ module Aws::Batch
|
|
768
767
|
# reach.
|
769
768
|
#
|
770
769
|
# <note markdown="1"> With both `BEST_FIT_PROGRESSIVE` and `SPOT_CAPACITY_OPTIMIZED`
|
771
|
-
# allocation strategies, AWS Batch might need to
|
772
|
-
#
|
773
|
-
#
|
774
|
-
#
|
775
|
-
#
|
770
|
+
# allocation strategies, AWS Batch might need to exceed `maxvCpus` to
|
771
|
+
# meet your capacity requirements. In this event, AWS Batch never
|
772
|
+
# exceeds `maxvCpus` by more than a single instance. That is, no more
|
773
|
+
# than a single instance from among those specified in your compute
|
774
|
+
# environment.
|
776
775
|
#
|
777
776
|
# </note>
|
778
777
|
# @return [Integer]
|
@@ -787,13 +786,12 @@ module Aws::Batch
|
|
787
786
|
# @return [Integer]
|
788
787
|
#
|
789
788
|
# @!attribute [rw] subnets
|
790
|
-
# The VPC subnets that the compute resources are launched into.
|
791
|
-
#
|
792
|
-
#
|
793
|
-
#
|
794
|
-
#
|
795
|
-
#
|
796
|
-
# made.
|
789
|
+
# The VPC subnets that the compute resources are launched into.
|
790
|
+
# Fargate compute resources can contain up to 16 subnets. Providing an
|
791
|
+
# empty list will be handled as if this parameter wasn't specified
|
792
|
+
# and no change is made. This can't be specified for EC2 compute
|
793
|
+
# resources. For more information, see [VPCs and Subnets][1] in the
|
794
|
+
# *Amazon VPC User Guide*.
|
797
795
|
#
|
798
796
|
#
|
799
797
|
#
|
@@ -829,19 +827,20 @@ module Aws::Batch
|
|
829
827
|
# @return [String]
|
830
828
|
#
|
831
829
|
# @!attribute [rw] vcpus
|
832
|
-
# The number of vCPUs reserved for the container.
|
833
|
-
# resources can specify the vCPU requirement for the job
|
834
|
-
# `resourceRequirements
|
835
|
-
#
|
836
|
-
# maps to `CpuShares` in the [Create a container][1]
|
837
|
-
# [Docker Remote API][2] and the `--cpu-shares` option
|
838
|
-
# run][3]. Each vCPU is equivalent to 1,024 CPU shares. You
|
839
|
-
# specify at least one vCPU. This is required but can be
|
840
|
-
# several places. It must be specified for each node at
|
841
|
-
#
|
842
|
-
#
|
843
|
-
#
|
844
|
-
#
|
830
|
+
# The number of vCPUs reserved for the container. For jobs that run on
|
831
|
+
# EC2 resources, you can specify the vCPU requirement for the job
|
832
|
+
# using `resourceRequirements`, but you can't specify the vCPU
|
833
|
+
# requirements in both the `vcpus` and `resourceRequirement` object.
|
834
|
+
# This parameter maps to `CpuShares` in the [Create a container][1]
|
835
|
+
# section of the [Docker Remote API][2] and the `--cpu-shares` option
|
836
|
+
# to [docker run][3]. Each vCPU is equivalent to 1,024 CPU shares. You
|
837
|
+
# must specify at least one vCPU. This is required but can be
|
838
|
+
# specified in several places. It must be specified for each node at
|
839
|
+
# least once.
|
840
|
+
#
|
841
|
+
# <note markdown="1"> This parameter isn't applicable to jobs that run on Fargate
|
842
|
+
# resources. For jobs that run on Fargate resources, you must specify
|
843
|
+
# the vCPU requirement for the job using `resourceRequirements`.
|
845
844
|
#
|
846
845
|
# </note>
|
847
846
|
#
|
@@ -1006,7 +1005,7 @@ module Aws::Batch
|
|
1006
1005
|
# This parameter maps to `LogConfig` in the [Create a container][1]
|
1007
1006
|
# section of the [Docker Remote API][2] and the `--log-driver` option
|
1008
1007
|
# to [docker run][3]. By default, containers use the same logging
|
1009
|
-
# driver that the Docker daemon uses. However the container might use
|
1008
|
+
# driver that the Docker daemon uses. However, the container might use
|
1010
1009
|
# a different logging driver than the Docker daemon by specifying a
|
1011
1010
|
# log driver with this parameter in the container definition. To use a
|
1012
1011
|
# different logging driver for a container, the log system must be
|
@@ -1125,21 +1124,25 @@ module Aws::Batch
|
|
1125
1124
|
# }
|
1126
1125
|
#
|
1127
1126
|
# @!attribute [rw] vcpus
|
1128
|
-
# This parameter
|
1129
|
-
#
|
1130
|
-
#
|
1131
|
-
#
|
1132
|
-
#
|
1133
|
-
#
|
1134
|
-
#
|
1135
|
-
#
|
1136
|
-
#
|
1137
|
-
#
|
1138
|
-
#
|
1139
|
-
#
|
1140
|
-
#
|
1141
|
-
#
|
1142
|
-
#
|
1127
|
+
# This parameter indicates the number of vCPUs reserved for the
|
1128
|
+
# container.It overrides the `vcpus` parameter that's set in the job
|
1129
|
+
# definition, but doesn't override any vCPU requirement specified in
|
1130
|
+
# the `resourceRequirement` structure in the job definition.
|
1131
|
+
#
|
1132
|
+
# This parameter is supported for jobs that run on EC2 resources, but
|
1133
|
+
# isn't supported for jobs that run on Fargate resources. For Fargate
|
1134
|
+
# resources, you can only use `resourceRequirement`. For EC2
|
1135
|
+
# resources, you can use either this parameter or
|
1136
|
+
# `resourceRequirement` but not both.
|
1137
|
+
#
|
1138
|
+
# This parameter maps to `CpuShares` in the [Create a container][1]
|
1139
|
+
# section of the [Docker Remote API][2] and the `--cpu-shares` option
|
1140
|
+
# to [docker run][3]. Each vCPU is equivalent to 1,024 CPU shares. You
|
1141
|
+
# must specify at least one vCPU.
|
1142
|
+
#
|
1143
|
+
# <note markdown="1"> This parameter isn't applicable to jobs that run on Fargate
|
1144
|
+
# resources and shouldn't be provided. For jobs that run on Fargate
|
1145
|
+
# resources, you must specify the vCPU requirement for the job using
|
1143
1146
|
# `resourceRequirements`.
|
1144
1147
|
#
|
1145
1148
|
# </note>
|
@@ -1152,10 +1155,15 @@ module Aws::Batch
|
|
1152
1155
|
# @return [Integer]
|
1153
1156
|
#
|
1154
1157
|
# @!attribute [rw] memory
|
1155
|
-
# This parameter
|
1156
|
-
#
|
1157
|
-
#
|
1158
|
-
#
|
1158
|
+
# This parameter indicates the amount of memory (in MiB) that's
|
1159
|
+
# reserved for the job. It overrides the `memory` parameter set in the
|
1160
|
+
# job definition, but doesn't override any memory requirement
|
1161
|
+
# specified in the `ResourceRequirement` structure in the job
|
1162
|
+
# definition.
|
1163
|
+
#
|
1164
|
+
# This parameter is supported for jobs that run on EC2 resources, but
|
1165
|
+
# isn't supported for jobs that run on Fargate resources. For these
|
1166
|
+
# resources, use `resourceRequirement` instead.
|
1159
1167
|
# @return [Integer]
|
1160
1168
|
#
|
1161
1169
|
# @!attribute [rw] command
|
@@ -1338,21 +1346,21 @@ module Aws::Batch
|
|
1338
1346
|
# @return [String]
|
1339
1347
|
#
|
1340
1348
|
# @!attribute [rw] vcpus
|
1341
|
-
#
|
1342
|
-
#
|
1343
|
-
#
|
1344
|
-
#
|
1345
|
-
#
|
1346
|
-
#
|
1347
|
-
#
|
1348
|
-
#
|
1349
|
-
#
|
1350
|
-
#
|
1351
|
-
#
|
1349
|
+
# The number of vCPUs reserved for the job. Each vCPU is equivalent to
|
1350
|
+
# 1,024 CPU shares. This parameter maps to `CpuShares` in the [Create
|
1351
|
+
# a container][1] section of the [Docker Remote API][2] and the
|
1352
|
+
# `--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
|
1354
|
+
# specify it at least once for each node.
|
1355
|
+
#
|
1356
|
+
# This parameter is supported on EC2 resources but isn't supported
|
1357
|
+
# for jobs that run on Fargate resources. For these resources, use
|
1358
|
+
# `resourceRequirement` instead. You can use this parameter or
|
1359
|
+
# `resourceRequirements` structure but not both.
|
1352
1360
|
#
|
1353
1361
|
# <note markdown="1"> This parameter isn't applicable to jobs running on Fargate
|
1354
|
-
# resources and shouldn't be provided.
|
1355
|
-
# resources must specify the vCPU requirement for the job using
|
1362
|
+
# resources and shouldn't be provided. For jobs that run on Fargate
|
1363
|
+
# resources, you must specify the vCPU requirement for the job using
|
1356
1364
|
# `resourceRequirements`.
|
1357
1365
|
#
|
1358
1366
|
# </note>
|
@@ -1365,17 +1373,21 @@ module Aws::Batch
|
|
1365
1373
|
# @return [Integer]
|
1366
1374
|
#
|
1367
1375
|
# @!attribute [rw] memory
|
1368
|
-
# This parameter
|
1369
|
-
#
|
1370
|
-
#
|
1371
|
-
#
|
1372
|
-
#
|
1373
|
-
#
|
1374
|
-
#
|
1375
|
-
#
|
1376
|
-
#
|
1377
|
-
#
|
1378
|
-
#
|
1376
|
+
# This parameter indicates the memory hard limit (in MiB) for a
|
1377
|
+
# container. If your container attempts to exceed the specified
|
1378
|
+
# number, it is terminated. You must specify at least 4 MiB of memory
|
1379
|
+
# for a job using this parameter. The memory hard limit can be
|
1380
|
+
# specified in several places. It must be specified for each node at
|
1381
|
+
# least once.
|
1382
|
+
#
|
1383
|
+
# This parameter maps to `Memory` in the [Create a container][1]
|
1384
|
+
# section of the [Docker Remote API][2] and the `--memory` option to
|
1385
|
+
# [docker run][3].
|
1386
|
+
#
|
1387
|
+
# This parameter is supported on EC2 resources but isn't supported on
|
1388
|
+
# Fargate resources. For Fargate resources, you should specify the
|
1389
|
+
# memory requirement using `resourceRequirement`. You can do this for
|
1390
|
+
# EC2 resources.
|
1379
1391
|
#
|
1380
1392
|
# <note markdown="1"> If you're trying to maximize your resource utilization by providing
|
1381
1393
|
# your jobs as much memory as possible for a particular instance type,
|
@@ -1419,9 +1431,9 @@ module Aws::Batch
|
|
1419
1431
|
#
|
1420
1432
|
# @!attribute [rw] execution_role_arn
|
1421
1433
|
# The Amazon Resource Name (ARN) of the execution role that AWS Batch
|
1422
|
-
# can assume.
|
1423
|
-
# execution role. For more information, see [AWS Batch execution
|
1424
|
-
# role][1] in the *AWS Batch User Guide*.
|
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*.
|
1425
1437
|
#
|
1426
1438
|
#
|
1427
1439
|
#
|
@@ -1531,7 +1543,7 @@ module Aws::Batch
|
|
1531
1543
|
# groups in a multi-node parallel job must use the same instance type.
|
1532
1544
|
#
|
1533
1545
|
# <note markdown="1"> This parameter isn't applicable to single-node container jobs or
|
1534
|
-
# for jobs
|
1546
|
+
# for jobs that run on Fargate resources and shouldn't be provided.
|
1535
1547
|
#
|
1536
1548
|
# </note>
|
1537
1549
|
# @return [String]
|
@@ -1697,7 +1709,7 @@ module Aws::Batch
|
|
1697
1709
|
# },
|
1698
1710
|
# ],
|
1699
1711
|
# },
|
1700
|
-
# service_role: "String",
|
1712
|
+
# service_role: "String",
|
1701
1713
|
# tags: {
|
1702
1714
|
# "TagKey" => "TagValue",
|
1703
1715
|
# },
|
@@ -1753,9 +1765,19 @@ module Aws::Batch
|
|
1753
1765
|
# information, see [AWS Batch service IAM role][1] in the *AWS Batch
|
1754
1766
|
# User Guide*.
|
1755
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
|
1773
|
+
# account.
|
1774
|
+
#
|
1756
1775
|
# If your specified role has a path other than `/`, then you must
|
1757
|
-
# either
|
1758
|
-
#
|
1776
|
+
# specify either the full role ARN (recommended) or prefix the role
|
1777
|
+
# name with the path. For example, if a role with the name `bar` has a
|
1778
|
+
# path of `/foo/` then you would specify `/foo/bar` as the role name.
|
1779
|
+
# For more information, see [Friendly names and paths][2] in the *IAM
|
1780
|
+
# User Guide*.
|
1759
1781
|
#
|
1760
1782
|
# <note markdown="1"> Depending on how you created your AWS Batch service role, its ARN
|
1761
1783
|
# might contain the `service-role` path prefix. When you only specify
|
@@ -1769,6 +1791,7 @@ module Aws::Batch
|
|
1769
1791
|
#
|
1770
1792
|
#
|
1771
1793
|
# [1]: https://docs.aws.amazon.com/batch/latest/userguide/service_IAM_role.html
|
1794
|
+
# [2]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html#identifiers-friendly-names
|
1772
1795
|
# @return [String]
|
1773
1796
|
#
|
1774
1797
|
# @!attribute [rw] tags
|
@@ -2094,7 +2117,7 @@ module Aws::Batch
|
|
2094
2117
|
# The maximum number of results returned by `DescribeJobDefinitions`
|
2095
2118
|
# in paginated output. When this parameter is used,
|
2096
2119
|
# `DescribeJobDefinitions` only returns `maxResults` results in a
|
2097
|
-
# single page
|
2120
|
+
# single page and a `nextToken` response element. The remaining
|
2098
2121
|
# results of the initial request can be seen by sending another
|
2099
2122
|
# `DescribeJobDefinitions` request with the returned `nextToken`
|
2100
2123
|
# value. This value can be between 1 and 100. If this parameter isn't
|
@@ -2177,12 +2200,12 @@ module Aws::Batch
|
|
2177
2200
|
# @!attribute [rw] max_results
|
2178
2201
|
# The maximum number of results returned by `DescribeJobQueues` in
|
2179
2202
|
# paginated output. When this parameter is used, `DescribeJobQueues`
|
2180
|
-
# only returns `maxResults` results in a single page
|
2181
|
-
#
|
2182
|
-
#
|
2183
|
-
#
|
2184
|
-
#
|
2185
|
-
#
|
2203
|
+
# only returns `maxResults` results in a single page and a `nextToken`
|
2204
|
+
# response element. The remaining results of the initial request can
|
2205
|
+
# be seen by sending another `DescribeJobQueues` request with the
|
2206
|
+
# returned `nextToken` value. This value can be between 1 and 100. If
|
2207
|
+
# this parameter isn't used, then `DescribeJobQueues` returns up to
|
2208
|
+
# 100 results and a `nextToken` value if applicable.
|
2186
2209
|
# @return [Integer]
|
2187
2210
|
#
|
2188
2211
|
# @!attribute [rw] next_token
|
@@ -2286,7 +2309,7 @@ module Aws::Batch
|
|
2286
2309
|
#
|
2287
2310
|
# @!attribute [rw] container_path
|
2288
2311
|
# The path inside the container used to expose the host device. By
|
2289
|
-
# default the `hostPath` value is used.
|
2312
|
+
# default, the `hostPath` value is used.
|
2290
2313
|
# @return [String]
|
2291
2314
|
#
|
2292
2315
|
# @!attribute [rw] permissions
|
@@ -2383,23 +2406,25 @@ module Aws::Batch
|
|
2383
2406
|
#
|
2384
2407
|
# @!attribute [rw] on_status_reason
|
2385
2408
|
# Contains a glob pattern to match against the `StatusReason` returned
|
2386
|
-
# for a job. The
|
2387
|
-
# letters, numbers, periods (.), colons (:), and white space
|
2388
|
-
# tabs).
|
2389
|
-
# start of the string needs to be an exact
|
2409
|
+
# for a job. The pattern can be up to 512 characters long, and can
|
2410
|
+
# contain letters, numbers, periods (.), colons (:), and white space
|
2411
|
+
# (including spaces or tabs). It can optionally end with an asterisk
|
2412
|
+
# (*) so that only the start of the string needs to be an exact
|
2413
|
+
# match.
|
2390
2414
|
# @return [String]
|
2391
2415
|
#
|
2392
2416
|
# @!attribute [rw] on_reason
|
2393
2417
|
# Contains a glob pattern to match against the `Reason` returned for a
|
2394
|
-
# job. The
|
2395
|
-
# letters, numbers, periods (.), colons (:), and white space
|
2396
|
-
# tabs)
|
2397
|
-
# start of the string needs to be an exact
|
2418
|
+
# job. The pattern can be up to 512 characters long, and can contain
|
2419
|
+
# letters, numbers, periods (.), colons (:), and white space
|
2420
|
+
# (including spaces and tabs). It can optionally end with an asterisk
|
2421
|
+
# (*) so that only the start of the string needs to be an exact
|
2422
|
+
# match.
|
2398
2423
|
# @return [String]
|
2399
2424
|
#
|
2400
2425
|
# @!attribute [rw] on_exit_code
|
2401
2426
|
# Contains a glob pattern to match against the decimal representation
|
2402
|
-
# of the `ExitCode` returned for a job. The
|
2427
|
+
# of the `ExitCode` returned for a job. The pattern can be up to 512
|
2403
2428
|
# characters long, can contain only numbers, and can optionally end
|
2404
2429
|
# with an asterisk (*) so that only the start of the string needs to
|
2405
2430
|
# be an exact match.
|
@@ -2408,7 +2433,7 @@ module Aws::Batch
|
|
2408
2433
|
# @!attribute [rw] action
|
2409
2434
|
# Specifies the action to take if all of the specified conditions
|
2410
2435
|
# (`onStatusReason`, `onReason`, and `onExitCode`) are met. The values
|
2411
|
-
#
|
2436
|
+
# aren't case sensitive.
|
2412
2437
|
# @return [String]
|
2413
2438
|
#
|
2414
2439
|
# @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/EvaluateOnExit AWS API Documentation
|
@@ -2422,8 +2447,8 @@ module Aws::Batch
|
|
2422
2447
|
include Aws::Structure
|
2423
2448
|
end
|
2424
2449
|
|
2425
|
-
# The platform configuration for jobs running on Fargate resources.
|
2426
|
-
#
|
2450
|
+
# The platform configuration for jobs running on Fargate resources. For
|
2451
|
+
# jobs that run on EC2 resources, you shouldn't specify this parameter.
|
2427
2452
|
#
|
2428
2453
|
# @note When making an API call, you may pass FargatePlatformConfiguration
|
2429
2454
|
# data as a hash:
|
@@ -2433,10 +2458,10 @@ module Aws::Batch
|
|
2433
2458
|
# }
|
2434
2459
|
#
|
2435
2460
|
# @!attribute [rw] platform_version
|
2436
|
-
# The AWS Fargate platform version
|
2461
|
+
# The AWS Fargate platform version where the jobs are running. A
|
2437
2462
|
# platform version is specified only for jobs running on Fargate
|
2438
2463
|
# resources. If one isn't specified, the `LATEST` platform version is
|
2439
|
-
# used by default. This
|
2464
|
+
# used by default. This uses a recent, approved version of the AWS
|
2440
2465
|
# Fargate platform for compute resources. For more information, see
|
2441
2466
|
# [AWS Fargate platform versions][1] in the *Amazon Elastic Container
|
2442
2467
|
# Service Developer Guide*.
|
@@ -2473,11 +2498,11 @@ module Aws::Batch
|
|
2473
2498
|
# assigned a host path for you. If this parameter contains a file
|
2474
2499
|
# location, then the data volume persists at the specified location on
|
2475
2500
|
# the host container instance until you delete it manually. If the
|
2476
|
-
# source path location
|
2501
|
+
# source path location doesn't exist on the host container instance,
|
2477
2502
|
# the Docker daemon creates it. If the location does exist, the
|
2478
2503
|
# contents of the source path folder are exported.
|
2479
2504
|
#
|
2480
|
-
# <note markdown="1"> This parameter isn't applicable to jobs
|
2505
|
+
# <note markdown="1"> This parameter isn't applicable to jobs that run on Fargate
|
2481
2506
|
# resources and shouldn't be provided.
|
2482
2507
|
#
|
2483
2508
|
# </note>
|
@@ -2740,7 +2765,7 @@ module Aws::Batch
|
|
2740
2765
|
# @!attribute [rw] propagate_tags
|
2741
2766
|
# Specifies whether to propagate the tags from the job or job
|
2742
2767
|
# definition to the corresponding Amazon ECS task. If no value is
|
2743
|
-
# specified, the tags
|
2768
|
+
# specified, the tags aren't propagated. Tags can only be propagated
|
2744
2769
|
# to the tasks during task creation. For tags with the same name, job
|
2745
2770
|
# tags are given priority over job definitions tags. If the total
|
2746
2771
|
# number of combined tags from the job and job definition is over 50,
|
@@ -2816,7 +2841,7 @@ module Aws::Batch
|
|
2816
2841
|
# priority value of `10` is given scheduling preference over a job
|
2817
2842
|
# queue with a priority value of `1`. All of the compute environments
|
2818
2843
|
# must be either EC2 (`EC2` or `SPOT`) or Fargate (`FARGATE` or
|
2819
|
-
# `FARGATE_SPOT`); EC2 and Fargate compute environments
|
2844
|
+
# `FARGATE_SPOT`); EC2 and Fargate compute environments can't be
|
2820
2845
|
# mixed.
|
2821
2846
|
# @return [Integer]
|
2822
2847
|
#
|
@@ -3173,7 +3198,7 @@ module Aws::Batch
|
|
3173
3198
|
#
|
3174
3199
|
# * If the `maxSwap` and `swappiness` parameters are omitted from a
|
3175
3200
|
# job definition, each container will have a default `swappiness`
|
3176
|
-
# value of 60 and the total swap usage will be limited to two times
|
3201
|
+
# value of 60, and the total swap usage will be limited to two times
|
3177
3202
|
# the memory reservation of the container.
|
3178
3203
|
#
|
3179
3204
|
# <note markdown="1"> This parameter isn't applicable to jobs running on Fargate
|
@@ -3239,12 +3264,12 @@ module Aws::Batch
|
|
3239
3264
|
# @!attribute [rw] max_results
|
3240
3265
|
# The maximum number of results returned by `ListJobs` in paginated
|
3241
3266
|
# output. When this parameter is used, `ListJobs` only returns
|
3242
|
-
# `maxResults` results in a single page
|
3243
|
-
#
|
3244
|
-
#
|
3245
|
-
#
|
3246
|
-
#
|
3247
|
-
#
|
3267
|
+
# `maxResults` results in a single page and a `nextToken` response
|
3268
|
+
# element. The remaining results of the initial request can be seen by
|
3269
|
+
# sending another `ListJobs` request with the returned `nextToken`
|
3270
|
+
# value. This value can be between 1 and 100. If this parameter isn't
|
3271
|
+
# used, then `ListJobs` returns up to 100 results and a `nextToken`
|
3272
|
+
# value if applicable.
|
3248
3273
|
# @return [Integer]
|
3249
3274
|
#
|
3250
3275
|
# @!attribute [rw] next_token
|
@@ -3404,7 +3429,7 @@ module Aws::Batch
|
|
3404
3429
|
# including usage and options, see [Syslog logging driver][8] in the
|
3405
3430
|
# Docker documentation.
|
3406
3431
|
#
|
3407
|
-
# <note markdown="1"> If you have a custom driver that'
|
3432
|
+
# <note markdown="1"> If you have a custom driver that's not listed earlier that you want
|
3408
3433
|
# to work with the Amazon ECS container agent, you can fork the Amazon
|
3409
3434
|
# ECS container agent project that's [available on GitHub][9] and
|
3410
3435
|
# customize it to work with that driver. We encourage you to submit
|
@@ -4373,17 +4398,17 @@ module Aws::Batch
|
|
4373
4398
|
#
|
4374
4399
|
# type="MEMORY"
|
4375
4400
|
#
|
4376
|
-
# :
|
4377
|
-
#
|
4378
|
-
# exceed the memory specified
|
4379
|
-
# parameter maps to `Memory` in the [Create a
|
4380
|
-
# of the [Docker Remote API][2] and the `--memory` option to [docker
|
4381
|
-
# run][3]. You must specify at least 4 MiB of memory for a job. This
|
4382
|
-
# is required but can be specified in several places for multi-node
|
4383
|
-
# parallel (MNP) jobs. It must be specified for each node at least
|
4384
|
-
# once. This parameter maps to `Memory` in the [Create a
|
4401
|
+
# : 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
|
4385
4405
|
# container][1] section of the [Docker Remote API][2] and the
|
4386
|
-
# `--memory` option to [docker run][3].
|
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
|
4411
|
+
# Remote API][2] and the `--memory` option to [docker run][3].
|
4387
4412
|
#
|
4388
4413
|
# <note markdown="1"> If you're trying to maximize your resource utilization by
|
4389
4414
|
# providing your jobs as much memory as possible for a particular
|
@@ -4571,7 +4596,7 @@ module Aws::Batch
|
|
4571
4596
|
# ARN of the parameter in the AWS Systems Manager Parameter Store.
|
4572
4597
|
#
|
4573
4598
|
# <note markdown="1"> If the AWS Systems Manager Parameter Store parameter exists in the
|
4574
|
-
# same Region as the job you
|
4599
|
+
# same Region as the job you're launching, then you can use either
|
4575
4600
|
# the full ARN or name of the parameter. If the parameter exists in a
|
4576
4601
|
# different Region, then the full ARN must be specified.
|
4577
4602
|
#
|
@@ -4692,8 +4717,8 @@ module Aws::Batch
|
|
4692
4717
|
# @return [String]
|
4693
4718
|
#
|
4694
4719
|
# @!attribute [rw] job_queue
|
4695
|
-
# The job queue
|
4696
|
-
#
|
4720
|
+
# The job queue where the job is submitted. You can specify either the
|
4721
|
+
# name or the Amazon Resource Name (ARN) of the queue.
|
4697
4722
|
# @return [String]
|
4698
4723
|
#
|
4699
4724
|
# @!attribute [rw] array_properties
|
@@ -4733,14 +4758,13 @@ module Aws::Batch
|
|
4733
4758
|
# @return [Hash<String,String>]
|
4734
4759
|
#
|
4735
4760
|
# @!attribute [rw] container_overrides
|
4736
|
-
# A list of container overrides in JSON format that specify the
|
4737
|
-
# of a container in the specified job definition and the
|
4738
|
-
# should receive. You can override the default command
|
4739
|
-
#
|
4740
|
-
# `command` override. You can also override
|
4741
|
-
#
|
4742
|
-
#
|
4743
|
-
# `environment` override.
|
4761
|
+
# A list of container overrides in the JSON format that specify the
|
4762
|
+
# name of a container in the specified job definition and the
|
4763
|
+
# overrides it should receive. You can override the default command
|
4764
|
+
# for a container, which is specified in the job definition or the
|
4765
|
+
# Docker image, with a `command` override. You can also override
|
4766
|
+
# existing environment variables on a container or add new environment
|
4767
|
+
# variables to it with an `environment` override.
|
4744
4768
|
# @return [Types::ContainerOverrides]
|
4745
4769
|
#
|
4746
4770
|
# @!attribute [rw] node_overrides
|
@@ -5094,8 +5118,8 @@ module Aws::Batch
|
|
5094
5118
|
#
|
5095
5119
|
# <note markdown="1"> Depending on how you created your AWS Batch service role, its ARN
|
5096
5120
|
# might contain the `service-role` path prefix. When you only specify
|
5097
|
-
# the name of the service role, AWS Batch assumes that your ARN
|
5098
|
-
#
|
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
|
5099
5123
|
# recommend that you specify the full ARN of your service role when
|
5100
5124
|
# you create compute environments.
|
5101
5125
|
#
|
@@ -5158,9 +5182,9 @@ module Aws::Batch
|
|
5158
5182
|
#
|
5159
5183
|
# @!attribute [rw] state
|
5160
5184
|
# Describes the queue's ability to accept new jobs. If the job queue
|
5161
|
-
# state is `ENABLED`, it
|
5162
|
-
#
|
5163
|
-
#
|
5185
|
+
# state is `ENABLED`, it can accept jobs. If the job queue state is
|
5186
|
+
# `DISABLED`, new jobs can't be added to the queue, but jobs already
|
5187
|
+
# in the queue can finish.
|
5164
5188
|
# @return [String]
|
5165
5189
|
#
|
5166
5190
|
# @!attribute [rw] priority
|
@@ -5171,7 +5195,7 @@ module Aws::Batch
|
|
5171
5195
|
# priority value of `10` is given scheduling preference over a job
|
5172
5196
|
# queue with a priority value of `1`. All of the compute environments
|
5173
5197
|
# must be either EC2 (`EC2` or `SPOT`) or Fargate (`FARGATE` or
|
5174
|
-
# `FARGATE_SPOT`)
|
5198
|
+
# `FARGATE_SPOT`). EC2 and Fargate compute environments can't be
|
5175
5199
|
# mixed.
|
5176
5200
|
# @return [Integer]
|
5177
5201
|
#
|
@@ -5182,7 +5206,7 @@ module Aws::Batch
|
|
5182
5206
|
# should run a given job. Compute environments must be in the `VALID`
|
5183
5207
|
# state before you can associate them with a job queue. All of the
|
5184
5208
|
# compute environments must be either EC2 (`EC2` or `SPOT`) or Fargate
|
5185
|
-
# (`FARGATE` or `FARGATE_SPOT`)
|
5209
|
+
# (`FARGATE` or `FARGATE_SPOT`). EC2 and Fargate compute environments
|
5186
5210
|
# can't be mixed.
|
5187
5211
|
#
|
5188
5212
|
# <note markdown="1"> All compute environments that are associated with a job queue must
|
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: aws-sdk-batch
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 1.
|
4
|
+
version: 1.46.0
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Amazon Web Services
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date: 2021-03-
|
11
|
+
date: 2021-03-17 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: aws-sdk-core
|