aws-sdk-batch 1.42.0 → 1.43.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/lib/aws-sdk-batch.rb +1 -1
- data/lib/aws-sdk-batch/client.rb +89 -28
- data/lib/aws-sdk-batch/types.rb +305 -114
- 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: 670e8989f810cdcedfe78e8dda205d78d250d8fa040bc488a9cb49af4ec63d85
|
4
|
+
data.tar.gz: 7a45d7ae7ed3f93a41074e799d211c6cb28f1493e4f07ea0831f19c2054dfad6
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: fd80a33d7ac7ca4bc3833dc06372340f572b4b6773a95b372a80b93699e134fb26200bcb4acc6237f317da2b19bf229fddebf69864a1c2aa68aed2d1d56ee172
|
7
|
+
data.tar.gz: 8791dbaeb9175cc1093c36750f5a1b2589c36fe710c4e30189560b4743e59b07ce6c7da35d1f42de7942a8dee649215b3d61fcb0eacccfc29cab85cf44dc0b2a
|
data/lib/aws-sdk-batch.rb
CHANGED
data/lib/aws-sdk-batch/client.rb
CHANGED
@@ -386,7 +386,7 @@ module Aws::Batch
|
|
386
386
|
# EC2 Spot Instances, or to use Fargate and Fargate Spot capacity in
|
387
387
|
# 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
|
389
|
+
# is less than a specified percentage of the On-Demand price.
|
390
390
|
#
|
391
391
|
# <note markdown="1"> Multi-node parallel jobs are not supported on Spot Instances.
|
392
392
|
#
|
@@ -400,7 +400,7 @@ module Aws::Batch
|
|
400
400
|
# instance AMIs][2] in the *Amazon Elastic Container Service Developer
|
401
401
|
# Guide*. After you have created your unmanaged compute environment, you
|
402
402
|
# can use the DescribeComputeEnvironments operation to find the Amazon
|
403
|
-
# ECS cluster that
|
403
|
+
# ECS cluster that's associated with it. Then, manually launch your
|
404
404
|
# container instances into that Amazon ECS cluster. For more
|
405
405
|
# information, see [Launching an Amazon ECS container instance][3] in
|
406
406
|
# the *Amazon Elastic Container Service Developer Guide*.
|
@@ -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
|
@@ -460,21 +472,27 @@ module Aws::Batch
|
|
460
472
|
#
|
461
473
|
# @option params [required, 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.
|
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*.
|
464
478
|
#
|
465
479
|
# If your specified role has a path other than `/`, then you must either
|
466
480
|
# specify the full role ARN (this is recommended) or prefix the role
|
467
481
|
# name with the path.
|
468
482
|
#
|
469
|
-
# <note markdown="1"> Depending on how you created your AWS Batch service role, its ARN
|
470
|
-
# contain the `service-role` path prefix. When you only specify
|
471
|
-
# of the service role, AWS Batch assumes that your ARN doesn't
|
472
|
-
# `service-role` path prefix. Because of this, we recommend that
|
473
|
-
# specify the full ARN of your service role when you create compute
|
483
|
+
# <note markdown="1"> Depending on how you created your AWS Batch service role, its ARN
|
484
|
+
# might contain the `service-role` path prefix. When you only specify
|
485
|
+
# the name of the service role, AWS Batch assumes that your ARN doesn't
|
486
|
+
# use the `service-role` path prefix. Because of this, we recommend that
|
487
|
+
# you specify the full ARN of your service role when you create compute
|
474
488
|
# environments.
|
475
489
|
#
|
476
490
|
# </note>
|
477
491
|
#
|
492
|
+
#
|
493
|
+
#
|
494
|
+
# [1]: https://docs.aws.amazon.com/batch/latest/userguide/service_IAM_role.html
|
495
|
+
#
|
478
496
|
# @option params [Hash<String,String>] :tags
|
479
497
|
# The tags that you apply to the compute environment to help you
|
480
498
|
# categorize and organize your resources. Each tag consists of a key and
|
@@ -650,7 +668,8 @@ module Aws::Batch
|
|
650
668
|
# preference for scheduling jobs to that compute environment.
|
651
669
|
#
|
652
670
|
# @option params [required, String] :job_queue_name
|
653
|
-
# The name of the job queue.
|
671
|
+
# The name of the job queue. Up to 128 letters (uppercase and
|
672
|
+
# lowercase), numbers, and underscores are allowed.
|
654
673
|
#
|
655
674
|
# @option params [String] :state
|
656
675
|
# The state of the job queue. If the job queue state is `ENABLED`, it is
|
@@ -664,7 +683,9 @@ module Aws::Batch
|
|
664
683
|
# when associated with the same compute environment. Priority is
|
665
684
|
# determined in descending order. For example, a job queue with a
|
666
685
|
# priority value of `10` is given scheduling preference over a job queue
|
667
|
-
# with a priority value of `1`.
|
686
|
+
# with a priority value of `1`. All of the compute environments must be
|
687
|
+
# either EC2 (`EC2` or `SPOT`) or Fargate (`FARGATE` or `FARGATE_SPOT`);
|
688
|
+
# EC2 and Fargate compute environments cannot be mixed.
|
668
689
|
#
|
669
690
|
# @option params [required, Array<Types::ComputeEnvironmentOrder>] :compute_environment_order
|
670
691
|
# The set of compute environments mapped to a job queue and their order
|
@@ -676,15 +697,21 @@ module Aws::Batch
|
|
676
697
|
# either EC2 (`EC2` or `SPOT`) or Fargate (`FARGATE` or `FARGATE_SPOT`);
|
677
698
|
# EC2 and Fargate compute environments can't be mixed.
|
678
699
|
#
|
700
|
+
# <note markdown="1"> All compute environments that are associated with a job queue must
|
701
|
+
# share the same architecture. AWS Batch doesn't support mixing compute
|
702
|
+
# environment architecture types in a single job queue.
|
703
|
+
#
|
704
|
+
# </note>
|
705
|
+
#
|
679
706
|
# @option params [Hash<String,String>] :tags
|
680
707
|
# The tags that you apply to the job queue to help you categorize and
|
681
708
|
# organize your resources. Each tag consists of a key and an optional
|
682
|
-
# value. For more information, see [Tagging AWS
|
683
|
-
#
|
709
|
+
# value. For more information, see [Tagging your AWS Batch resources][1]
|
710
|
+
# in *AWS Batch User Guide*.
|
684
711
|
#
|
685
712
|
#
|
686
713
|
#
|
687
|
-
# [1]: https://docs.aws.amazon.com/
|
714
|
+
# [1]: https://docs.aws.amazon.com/batch/latest/userguide/using-tags.html
|
688
715
|
#
|
689
716
|
# @return [Types::CreateJobQueueResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
690
717
|
#
|
@@ -818,7 +845,8 @@ module Aws::Batch
|
|
818
845
|
|
819
846
|
# Deletes the specified job queue. You must first disable submissions
|
820
847
|
# for a queue with the UpdateJobQueue operation. All jobs in the queue
|
821
|
-
# are terminated when you delete a job queue.
|
848
|
+
# are eventually terminated when you delete a job queue. The jobs are
|
849
|
+
# terminated at a rate of about 16 jobs each second.
|
822
850
|
#
|
823
851
|
# It's not necessary to disassociate compute environments from a queue
|
824
852
|
# before submitting a `DeleteJobQueue` request.
|
@@ -923,7 +951,7 @@ module Aws::Batch
|
|
923
951
|
# from the end of the previous results that returned the `nextToken`
|
924
952
|
# value. This value is `null` when there are no more results to return.
|
925
953
|
#
|
926
|
-
# <note markdown="1"> This token should be treated as an opaque identifier that
|
954
|
+
# <note markdown="1"> This token should be treated as an opaque identifier that's only used
|
927
955
|
# to retrieve the next items in a list and not for other programmatic
|
928
956
|
# purposes.
|
929
957
|
#
|
@@ -1073,7 +1101,7 @@ module Aws::Batch
|
|
1073
1101
|
# from the end of the previous results that returned the `nextToken`
|
1074
1102
|
# value. This value is `null` when there are no more results to return.
|
1075
1103
|
#
|
1076
|
-
# <note markdown="1"> This token should be treated as an opaque identifier that
|
1104
|
+
# <note markdown="1"> This token should be treated as an opaque identifier that's only used
|
1077
1105
|
# to retrieve the next items in a list and not for other programmatic
|
1078
1106
|
# purposes.
|
1079
1107
|
#
|
@@ -1301,7 +1329,7 @@ module Aws::Batch
|
|
1301
1329
|
# from the end of the previous results that returned the `nextToken`
|
1302
1330
|
# value. This value is `null` when there are no more results to return.
|
1303
1331
|
#
|
1304
|
-
# <note markdown="1"> This token should be treated as an opaque identifier that
|
1332
|
+
# <note markdown="1"> This token should be treated as an opaque identifier that's only used
|
1305
1333
|
# to retrieve the next items in a list and not for other programmatic
|
1306
1334
|
# purposes.
|
1307
1335
|
#
|
@@ -1669,7 +1697,7 @@ module Aws::Batch
|
|
1669
1697
|
# results that returned the `nextToken` value. This value is `null` when
|
1670
1698
|
# there are no more results to return.
|
1671
1699
|
#
|
1672
|
-
# <note markdown="1"> This token should be treated as an opaque identifier that
|
1700
|
+
# <note markdown="1"> This token should be treated as an opaque identifier that's only used
|
1673
1701
|
# to retrieve the next items in a list and not for other programmatic
|
1674
1702
|
# purposes.
|
1675
1703
|
#
|
@@ -1870,7 +1898,7 @@ module Aws::Batch
|
|
1870
1898
|
#
|
1871
1899
|
# @option params [Types::RetryStrategy] :retry_strategy
|
1872
1900
|
# The retry strategy to use for failed jobs that are submitted with this
|
1873
|
-
# job definition. Any retry strategy that
|
1901
|
+
# job definition. Any retry strategy that's specified during a
|
1874
1902
|
# SubmitJob operation overrides the retry strategy defined here. If a
|
1875
1903
|
# job is terminated due to a timeout, it isn't retried.
|
1876
1904
|
#
|
@@ -1888,7 +1916,7 @@ module Aws::Batch
|
|
1888
1916
|
# definition, after which AWS Batch terminates your jobs if they have
|
1889
1917
|
# not finished. If a job is terminated due to a timeout, it isn't
|
1890
1918
|
# retried. The minimum value for the timeout is 60 seconds. Any timeout
|
1891
|
-
# configuration that
|
1919
|
+
# configuration that's specified during a SubmitJob operation overrides
|
1892
1920
|
# the timeout configuration defined here. For more information, see [Job
|
1893
1921
|
# Timeouts][1] in the *AWS Batch User Guide*.
|
1894
1922
|
#
|
@@ -2257,7 +2285,7 @@ module Aws::Batch
|
|
2257
2285
|
# A list of container overrides in JSON format that specify the name of
|
2258
2286
|
# a container in the specified job definition and the overrides it
|
2259
2287
|
# should receive. You can override the default command for a container
|
2260
|
-
# (that
|
2288
|
+
# (that's specified in the job definition or the Docker image) with a
|
2261
2289
|
# `command` override. You can also override existing environment
|
2262
2290
|
# variables (that are specified in the job definition or Docker image)
|
2263
2291
|
# on a container or add new environment variables to it with an
|
@@ -2593,13 +2621,32 @@ module Aws::Batch
|
|
2593
2621
|
# `ENABLED` state can accept jobs from a queue and scale in or out
|
2594
2622
|
# automatically based on the workload demand of its associated queues.
|
2595
2623
|
#
|
2624
|
+
# If the state is `ENABLED`, then the AWS Batch scheduler can attempt to
|
2625
|
+
# place jobs from an associated job queue on the compute resources
|
2626
|
+
# within the environment. If the compute environment is managed, then it
|
2627
|
+
# can scale its instances out or in automatically, based on the job
|
2628
|
+
# queue demand.
|
2629
|
+
#
|
2630
|
+
# If the state is `DISABLED`, then the AWS Batch scheduler doesn't
|
2631
|
+
# attempt to place jobs within the environment. Jobs in a `STARTING` or
|
2632
|
+
# `RUNNING` state continue to progress normally. Managed compute
|
2633
|
+
# environments in the `DISABLED` state don't scale out. However, they
|
2634
|
+
# scale in to `minvCpus` value after instances become idle.
|
2635
|
+
#
|
2596
2636
|
# @option params [Types::ComputeResourceUpdate] :compute_resources
|
2597
2637
|
# Details of the compute resources managed by the compute environment.
|
2598
|
-
# Required for a managed compute environment.
|
2638
|
+
# Required for a managed compute environment. For more information, see
|
2639
|
+
# [Compute Environments][1] in the *AWS Batch User Guide*.
|
2640
|
+
#
|
2641
|
+
#
|
2642
|
+
#
|
2643
|
+
# [1]: https://docs.aws.amazon.com/batch/latest/userguide/compute_environments.html
|
2599
2644
|
#
|
2600
2645
|
# @option params [String] :service_role
|
2601
2646
|
# 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.
|
2647
|
+
# Batch to make calls to other AWS services on your behalf. For more
|
2648
|
+
# information, see [AWS Batch service IAM role][1] in the *AWS Batch
|
2649
|
+
# User Guide*.
|
2603
2650
|
#
|
2604
2651
|
# If your specified role has a path other than `/`, then you must either
|
2605
2652
|
# specify the full role ARN (this is recommended) or prefix the role
|
@@ -2614,6 +2661,10 @@ module Aws::Batch
|
|
2614
2661
|
#
|
2615
2662
|
# </note>
|
2616
2663
|
#
|
2664
|
+
#
|
2665
|
+
#
|
2666
|
+
# [1]: https://docs.aws.amazon.com/batch/latest/userguide/service_IAM_role.html
|
2667
|
+
#
|
2617
2668
|
# @return [Types::UpdateComputeEnvironmentResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2618
2669
|
#
|
2619
2670
|
# * {Types::UpdateComputeEnvironmentResponse#compute_environment_name #compute_environment_name} => String
|
@@ -2681,15 +2732,25 @@ module Aws::Batch
|
|
2681
2732
|
# when associated with the same compute environment. Priority is
|
2682
2733
|
# determined in descending order, for example, a job queue with a
|
2683
2734
|
# priority value of `10` is given scheduling preference over a job queue
|
2684
|
-
# with a priority value of `1`.
|
2735
|
+
# 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 cannot be mixed.
|
2685
2738
|
#
|
2686
2739
|
# @option params [Array<Types::ComputeEnvironmentOrder>] :compute_environment_order
|
2687
2740
|
# Details the set of compute environments mapped to a job queue and
|
2688
2741
|
# their order relative to each other. This is one of the parameters used
|
2689
2742
|
# by the job scheduler to determine which compute environment should run
|
2690
|
-
# a given job.
|
2691
|
-
#
|
2692
|
-
#
|
2743
|
+
# a given job. Compute environments must be in the `VALID` state before
|
2744
|
+
# you can associate them with a job queue. All of the compute
|
2745
|
+
# environments must be either EC2 (`EC2` or `SPOT`) or Fargate
|
2746
|
+
# (`FARGATE` or `FARGATE_SPOT`); EC2 and Fargate compute environments
|
2747
|
+
# can't be mixed.
|
2748
|
+
#
|
2749
|
+
# <note markdown="1"> All compute environments that are associated with a job queue must
|
2750
|
+
# share the same architecture. AWS Batch doesn't support mixing compute
|
2751
|
+
# environment architecture types in a single job queue.
|
2752
|
+
#
|
2753
|
+
# </note>
|
2693
2754
|
#
|
2694
2755
|
# @return [Types::UpdateJobQueueResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2695
2756
|
#
|
@@ -2753,7 +2814,7 @@ module Aws::Batch
|
|
2753
2814
|
params: params,
|
2754
2815
|
config: config)
|
2755
2816
|
context[:gem_name] = 'aws-sdk-batch'
|
2756
|
-
context[:gem_version] = '1.
|
2817
|
+
context[:gem_version] = '1.43.0'
|
2757
2818
|
Seahorse::Client::Request.new(handlers, context)
|
2758
2819
|
end
|
2759
2820
|
|
data/lib/aws-sdk-batch/types.rb
CHANGED
@@ -44,7 +44,7 @@ module Aws::Batch
|
|
44
44
|
# @return [Integer]
|
45
45
|
#
|
46
46
|
# @!attribute [rw] index
|
47
|
-
# The job index within the array that
|
47
|
+
# The job index within the array that's associated with this job.
|
48
48
|
# This parameter is returned for array job children.
|
49
49
|
# @return [Integer]
|
50
50
|
#
|
@@ -66,7 +66,7 @@ module Aws::Batch
|
|
66
66
|
# @return [Integer]
|
67
67
|
#
|
68
68
|
# @!attribute [rw] index
|
69
|
-
# The job index within the array that
|
69
|
+
# The job index within the array that's associated with this job.
|
70
70
|
# This parameter is returned for children of array jobs.
|
71
71
|
# @return [Integer]
|
72
72
|
#
|
@@ -79,7 +79,7 @@ module Aws::Batch
|
|
79
79
|
include Aws::Structure
|
80
80
|
end
|
81
81
|
|
82
|
-
# An object representing the details of a container that
|
82
|
+
# An object representing the details of a container that's part of a
|
83
83
|
# job attempt.
|
84
84
|
#
|
85
85
|
# @!attribute [rw] container_instance_arn
|
@@ -88,7 +88,7 @@ module Aws::Batch
|
|
88
88
|
# @return [String]
|
89
89
|
#
|
90
90
|
# @!attribute [rw] task_arn
|
91
|
-
# The Amazon Resource Name (ARN) of the Amazon ECS task that
|
91
|
+
# The Amazon Resource Name (ARN) of the Amazon ECS task that's
|
92
92
|
# associated with the job attempt. Each container attempt receives a
|
93
93
|
# task ARN when they reach the `STARTING` status.
|
94
94
|
# @return [String]
|
@@ -161,6 +161,8 @@ module Aws::Batch
|
|
161
161
|
include Aws::Structure
|
162
162
|
end
|
163
163
|
|
164
|
+
# Contains the parameters for `CancelJob`.
|
165
|
+
#
|
164
166
|
# @note When making an API call, you may pass CancelJobRequest
|
165
167
|
# data as a hash:
|
166
168
|
#
|
@@ -195,7 +197,7 @@ module Aws::Batch
|
|
195
197
|
|
196
198
|
# These errors are usually caused by a client action, such as using an
|
197
199
|
# action or resource on behalf of a user that doesn't have permissions
|
198
|
-
# to use the action or resource, or specifying an identifier that
|
200
|
+
# to use the action or resource, or specifying an identifier that's not
|
199
201
|
# valid.
|
200
202
|
#
|
201
203
|
# @!attribute [rw] message
|
@@ -212,7 +214,8 @@ module Aws::Batch
|
|
212
214
|
# An object representing an AWS Batch compute environment.
|
213
215
|
#
|
214
216
|
# @!attribute [rw] compute_environment_name
|
215
|
-
# The name of the compute environment.
|
217
|
+
# The name of the compute environment. Up to 128 letters (uppercase
|
218
|
+
# and lowercase), numbers, hyphens, and underscores are allowed.
|
216
219
|
# @return [String]
|
217
220
|
#
|
218
221
|
# @!attribute [rw] compute_environment_arn
|
@@ -229,9 +232,9 @@ module Aws::Batch
|
|
229
232
|
# @return [Hash<String,String>]
|
230
233
|
#
|
231
234
|
# @!attribute [rw] type
|
232
|
-
# The type of compute environment: `
|
233
|
-
#
|
234
|
-
#
|
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*.
|
235
238
|
#
|
236
239
|
#
|
237
240
|
#
|
@@ -251,7 +254,7 @@ module Aws::Batch
|
|
251
254
|
# If the state is `DISABLED`, then the AWS Batch scheduler doesn't
|
252
255
|
# attempt to place jobs within the environment. Jobs in a `STARTING`
|
253
256
|
# or `RUNNING` state continue to progress normally. Managed compute
|
254
|
-
# environments in the `DISABLED` state
|
257
|
+
# environments in the `DISABLED` state don't scale out. However, they
|
255
258
|
# scale in to `minvCpus` value after instances become idle.
|
256
259
|
# @return [String]
|
257
260
|
#
|
@@ -266,12 +269,24 @@ module Aws::Batch
|
|
266
269
|
# @return [String]
|
267
270
|
#
|
268
271
|
# @!attribute [rw] compute_resources
|
269
|
-
# The compute resources defined for the compute environment.
|
272
|
+
# The compute resources defined for the compute environment. For more
|
273
|
+
# information, see [Compute Environments][1] in the *AWS Batch User
|
274
|
+
# Guide*.
|
275
|
+
#
|
276
|
+
#
|
277
|
+
#
|
278
|
+
# [1]: https://docs.aws.amazon.com/batch/latest/userguide/compute_environments.html
|
270
279
|
# @return [Types::ComputeResource]
|
271
280
|
#
|
272
281
|
# @!attribute [rw] service_role
|
273
282
|
# The service role associated with the compute environment that allows
|
274
|
-
# AWS Batch to make calls to AWS API operations on your behalf.
|
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*.
|
286
|
+
#
|
287
|
+
#
|
288
|
+
#
|
289
|
+
# [1]: https://docs.aws.amazon.com/batch/latest/userguide/service_IAM_role.html
|
275
290
|
# @return [String]
|
276
291
|
#
|
277
292
|
# @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/ComputeEnvironmentDetail AWS API Documentation
|
@@ -295,7 +310,17 @@ module Aws::Batch
|
|
295
310
|
# within a queue. Compute environments are tried in ascending order. For
|
296
311
|
# example, if two compute environments are associated with a job queue,
|
297
312
|
# the compute environment with a lower order integer value is tried for
|
298
|
-
# job placement first.
|
313
|
+
# job placement first. Compute environments must be in the `VALID` state
|
314
|
+
# before you can associate them with a job queue. All of the compute
|
315
|
+
# environments must be either EC2 (`EC2` or `SPOT`) or Fargate
|
316
|
+
# (`FARGATE` or `FARGATE_SPOT`); EC2 and Fargate compute environments
|
317
|
+
# can't be mixed.
|
318
|
+
#
|
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
|
321
|
+
# environment architecture types in a single job queue.
|
322
|
+
#
|
323
|
+
# </note>
|
299
324
|
#
|
300
325
|
# @note When making an API call, you may pass ComputeEnvironmentOrder
|
301
326
|
# data as a hash:
|
@@ -325,7 +350,13 @@ module Aws::Batch
|
|
325
350
|
include Aws::Structure
|
326
351
|
end
|
327
352
|
|
328
|
-
# An object representing an AWS Batch compute resource.
|
353
|
+
# An object representing an AWS Batch compute resource. For more
|
354
|
+
# information, see [Compute Environments][1] in the *AWS Batch User
|
355
|
+
# Guide*.
|
356
|
+
#
|
357
|
+
#
|
358
|
+
#
|
359
|
+
# [1]: https://docs.aws.amazon.com/batch/latest/userguide/compute_environments.html
|
329
360
|
#
|
330
361
|
# @note When making an API call, you may pass ComputeResource
|
331
362
|
# data as a hash:
|
@@ -366,9 +397,14 @@ module Aws::Batch
|
|
366
397
|
# `FARGATE_SPOT`. For more information, see [Compute Environments][1]
|
367
398
|
# in the *AWS Batch User Guide*.
|
368
399
|
#
|
400
|
+
# If you choose `SPOT`, you must also specify an Amazon EC2 Spot Fleet
|
401
|
+
# role with the `spotIamFleetRole` parameter. For more information,
|
402
|
+
# see [Amazon EC2 Spot Fleet role][2] in the *AWS Batch User Guide*.
|
403
|
+
#
|
369
404
|
#
|
370
405
|
#
|
371
406
|
# [1]: https://docs.aws.amazon.com/batch/latest/userguide/compute_environments.html
|
407
|
+
# [2]: https://docs.aws.amazon.com/batch/latest/userguide/spot_fleet_IAM_role.html
|
372
408
|
# @return [String]
|
373
409
|
#
|
374
410
|
# @!attribute [rw] allocation_strategy
|
@@ -434,15 +470,15 @@ module Aws::Batch
|
|
434
470
|
# @return [Integer]
|
435
471
|
#
|
436
472
|
# @!attribute [rw] maxv_cpus
|
437
|
-
# The maximum number of Amazon EC2 vCPUs that
|
438
|
-
# reach.
|
473
|
+
# The maximum number of Amazon EC2 vCPUs that a compute environment
|
474
|
+
# can reach.
|
439
475
|
#
|
440
476
|
# <note markdown="1"> With both `BEST_FIT_PROGRESSIVE` and `SPOT_CAPACITY_OPTIMIZED`
|
441
|
-
# allocation strategies, AWS Batch
|
442
|
-
# meet your capacity requirements. In this event, AWS Batch will
|
443
|
-
# go above `maxvCpus` by more than a single instance (e.g., no
|
444
|
-
# than a single instance from among those specified in your
|
445
|
-
# environment).
|
477
|
+
# allocation strategies, AWS Batch might need to go above `maxvCpus`
|
478
|
+
# to meet your capacity requirements. In this event, AWS Batch will
|
479
|
+
# never go above `maxvCpus` by more than a single instance (e.g., no
|
480
|
+
# more than a single instance from among those specified in your
|
481
|
+
# compute environment).
|
446
482
|
#
|
447
483
|
# </note>
|
448
484
|
# @return [Integer]
|
@@ -459,11 +495,11 @@ module Aws::Batch
|
|
459
495
|
# @return [Integer]
|
460
496
|
#
|
461
497
|
# @!attribute [rw] instance_types
|
462
|
-
# The instances types that
|
498
|
+
# The instances types that can be launched. You can specify instance
|
463
499
|
# families to launch any instance type within those families (for
|
464
500
|
# example, `c5` or `p3`), or you can specify specific sizes within a
|
465
501
|
# family (such as `c5.8xlarge`). You can also choose `optimal` to
|
466
|
-
# select instance types (from the
|
502
|
+
# select instance types (from the C4, M4, and R4 instance families) on
|
467
503
|
# the fly that match the demand of your job queues.
|
468
504
|
#
|
469
505
|
# <note markdown="1"> This parameter isn't applicable to jobs running on Fargate
|
@@ -477,6 +513,13 @@ module Aws::Batch
|
|
477
513
|
# compute environment.
|
478
514
|
#
|
479
515
|
# </note>
|
516
|
+
#
|
517
|
+
# <note markdown="1"> Currently, `optimal` uses instance types from the C4, M4, and R4
|
518
|
+
# instance families. In Regions that don't have instance types from
|
519
|
+
# those instance families, instance types from the C5, M5. and R5
|
520
|
+
# instance families are used.
|
521
|
+
#
|
522
|
+
# </note>
|
480
523
|
# @return [Array<String>]
|
481
524
|
#
|
482
525
|
# @!attribute [rw] image_id
|
@@ -529,7 +572,7 @@ module Aws::Batch
|
|
529
572
|
# @return [Array<String>]
|
530
573
|
#
|
531
574
|
# @!attribute [rw] ec2_key_pair
|
532
|
-
# The Amazon EC2 key pair that
|
575
|
+
# The Amazon EC2 key pair that's used for instances launched in the
|
533
576
|
# compute environment. You can use this key pair to log in to your
|
534
577
|
# instances with SSH.
|
535
578
|
#
|
@@ -562,13 +605,18 @@ module Aws::Batch
|
|
562
605
|
# Key-value pair tags to be applied to EC2 resources that are launched
|
563
606
|
# in the compute environment. For AWS Batch, these take the form of
|
564
607
|
# "String1": "String2", where String1 is the tag key and String2
|
565
|
-
# is the tag value
|
608
|
+
# is the tag value−for example, \\\{ "Name": "AWS Batch Instance -
|
566
609
|
# C4OnDemand" \\}. This is helpful for recognizing your AWS Batch
|
567
|
-
# instances in the Amazon EC2 console. These tags can
|
568
|
-
#
|
569
|
-
#
|
570
|
-
#
|
610
|
+
# instances in the Amazon EC2 console. These tags can't be updated or
|
611
|
+
# removed after the compute environment has been created; any changes
|
612
|
+
# require creating a new compute environment and removing the old
|
613
|
+
# compute environment. These tags are not seen when using the AWS
|
571
614
|
# Batch `ListTagsForResource` API operation.
|
615
|
+
#
|
616
|
+
# <note markdown="1"> This parameter isn't applicable to jobs running on Fargate
|
617
|
+
# resources, and shouldn't be specified.
|
618
|
+
#
|
619
|
+
# </note>
|
572
620
|
# @return [Hash<String,String>]
|
573
621
|
#
|
574
622
|
# @!attribute [rw] placement_group
|
@@ -595,11 +643,11 @@ module Aws::Batch
|
|
595
643
|
# The maximum percentage that a Spot Instance price can be when
|
596
644
|
# compared with the On-Demand price for that instance type before
|
597
645
|
# instances are launched. For example, if your maximum percentage is
|
598
|
-
# 20%, then the Spot price must be
|
599
|
-
# price for that Amazon EC2 instance. You always pay the
|
600
|
-
# (market) price and never more than your maximum percentage.
|
601
|
-
# leave this field empty, the default value is 100% of the
|
602
|
-
# price.
|
646
|
+
# 20%, then the Spot price must be less than 20% of the current
|
647
|
+
# On-Demand price for that Amazon EC2 instance. You always pay the
|
648
|
+
# lowest (market) price and never more than your maximum percentage.
|
649
|
+
# If you leave this field empty, the default value is 100% of the
|
650
|
+
# On-Demand price.
|
603
651
|
#
|
604
652
|
# <note markdown="1"> This parameter isn't applicable to jobs running on Fargate
|
605
653
|
# resources, and shouldn't be specified.
|
@@ -653,8 +701,8 @@ module Aws::Batch
|
|
653
701
|
#
|
654
702
|
# @!attribute [rw] ec2_configuration
|
655
703
|
# Provides information used to select Amazon Machine Images (AMIs) for
|
656
|
-
# instances in the compute environment. If `Ec2Configuration`
|
657
|
-
# specified, the default is `ECS_AL1`.
|
704
|
+
# EC2 instances in the compute environment. If `Ec2Configuration`
|
705
|
+
# isn't specified, the default is `ECS_AL1`.
|
658
706
|
#
|
659
707
|
# <note markdown="1"> This parameter isn't applicable to jobs running on Fargate
|
660
708
|
# resources, and shouldn't be specified.
|
@@ -687,7 +735,12 @@ module Aws::Batch
|
|
687
735
|
end
|
688
736
|
|
689
737
|
# An object representing the attributes of a compute environment that
|
690
|
-
# can be updated.
|
738
|
+
# can be updated. For more information, see [Compute Environments][1] in
|
739
|
+
# the *AWS Batch User Guide*.
|
740
|
+
#
|
741
|
+
#
|
742
|
+
#
|
743
|
+
# [1]: https://docs.aws.amazon.com/batch/latest/userguide/compute_environments.html
|
691
744
|
#
|
692
745
|
# @note When making an API call, you may pass ComputeResourceUpdate
|
693
746
|
# data as a hash:
|
@@ -704,8 +757,8 @@ module Aws::Batch
|
|
704
757
|
# The minimum number of Amazon EC2 vCPUs that an environment should
|
705
758
|
# maintain.
|
706
759
|
#
|
707
|
-
# <note markdown="1"> This parameter
|
708
|
-
# and shouldn't be specified.
|
760
|
+
# <note markdown="1"> This parameter isn't applicable to jobs running on Fargate
|
761
|
+
# resources, and shouldn't be specified.
|
709
762
|
#
|
710
763
|
# </note>
|
711
764
|
# @return [Integer]
|
@@ -713,6 +766,15 @@ module Aws::Batch
|
|
713
766
|
# @!attribute [rw] maxv_cpus
|
714
767
|
# The maximum number of Amazon EC2 vCPUs that an environment can
|
715
768
|
# reach.
|
769
|
+
#
|
770
|
+
# <note markdown="1"> With both `BEST_FIT_PROGRESSIVE` and `SPOT_CAPACITY_OPTIMIZED`
|
771
|
+
# allocation strategies, AWS Batch might need to go above `maxvCpus`
|
772
|
+
# to meet your capacity requirements. In this event, AWS Batch will
|
773
|
+
# never go above `maxvCpus` by more than a single instance (e.g., no
|
774
|
+
# more than a single instance from among those specified in your
|
775
|
+
# compute environment).
|
776
|
+
#
|
777
|
+
# </note>
|
716
778
|
# @return [Integer]
|
717
779
|
#
|
718
780
|
# @!attribute [rw] desiredv_cpus
|
@@ -744,7 +806,7 @@ module Aws::Batch
|
|
744
806
|
# compute resources, where it can contain up to 5 security groups.
|
745
807
|
# This can't be specified for EC2 compute resources. Providing an
|
746
808
|
# empty list is handled as if this parameter wasn't specified and no
|
747
|
-
#
|
809
|
+
# change is made.
|
748
810
|
# @return [Array<String>]
|
749
811
|
#
|
750
812
|
# @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/ComputeResourceUpdate AWS API Documentation
|
@@ -759,7 +821,7 @@ module Aws::Batch
|
|
759
821
|
include Aws::Structure
|
760
822
|
end
|
761
823
|
|
762
|
-
# An object representing the details of a container that
|
824
|
+
# An object representing the details of a container that's part of a
|
763
825
|
# job.
|
764
826
|
#
|
765
827
|
# @!attribute [rw] image
|
@@ -798,7 +860,7 @@ module Aws::Batch
|
|
798
860
|
# @return [Integer]
|
799
861
|
#
|
800
862
|
# @!attribute [rw] command
|
801
|
-
# The command that
|
863
|
+
# The command that's passed to the container.
|
802
864
|
# @return [Array<String>]
|
803
865
|
#
|
804
866
|
# @!attribute [rw] job_role_arn
|
@@ -902,7 +964,7 @@ module Aws::Batch
|
|
902
964
|
# @return [String]
|
903
965
|
#
|
904
966
|
# @!attribute [rw] task_arn
|
905
|
-
# The Amazon Resource Name (ARN) of the Amazon ECS task that
|
967
|
+
# The Amazon Resource Name (ARN) of the Amazon ECS task that's
|
906
968
|
# associated with the container job. Each container attempt receives a
|
907
969
|
# task ARN when they reach the `STARTING` status.
|
908
970
|
# @return [String]
|
@@ -956,8 +1018,8 @@ module Aws::Batch
|
|
956
1018
|
#
|
957
1019
|
# <note markdown="1"> AWS Batch currently supports a subset of the logging drivers
|
958
1020
|
# available to the Docker daemon (shown in the LogConfiguration data
|
959
|
-
# type). Additional log drivers
|
960
|
-
# the Amazon ECS container agent.
|
1021
|
+
# type). Additional log drivers might be available in future releases
|
1022
|
+
# of the Amazon ECS container agent.
|
961
1023
|
#
|
962
1024
|
# </note>
|
963
1025
|
#
|
@@ -1143,7 +1205,7 @@ module Aws::Batch
|
|
1143
1205
|
end
|
1144
1206
|
|
1145
1207
|
# Container properties are used in job definitions to describe the
|
1146
|
-
# container that
|
1208
|
+
# container that's launched as part of a job.
|
1147
1209
|
#
|
1148
1210
|
# @note When making an API call, you may pass ContainerProperties
|
1149
1211
|
# data as a hash:
|
@@ -1330,7 +1392,7 @@ module Aws::Batch
|
|
1330
1392
|
# @return [Integer]
|
1331
1393
|
#
|
1332
1394
|
# @!attribute [rw] command
|
1333
|
-
# The command that
|
1395
|
+
# The command that's passed to the container. This parameter maps to
|
1334
1396
|
# `Cmd` in the [Create a container][1] section of the [Docker Remote
|
1335
1397
|
# API][2] and the `COMMAND` parameter to [docker run][3]. For more
|
1336
1398
|
# information, see
|
@@ -1596,6 +1658,8 @@ module Aws::Batch
|
|
1596
1658
|
include Aws::Structure
|
1597
1659
|
end
|
1598
1660
|
|
1661
|
+
# Contains the parameters for `CreateComputeEnvironment`.
|
1662
|
+
#
|
1599
1663
|
# @note When making an API call, you may pass CreateComputeEnvironmentRequest
|
1600
1664
|
# data as a hash:
|
1601
1665
|
#
|
@@ -1658,6 +1722,18 @@ module Aws::Batch
|
|
1658
1722
|
# The state of the compute environment. If the state is `ENABLED`,
|
1659
1723
|
# then the compute environment accepts jobs from a queue and can scale
|
1660
1724
|
# out automatically based on queues.
|
1725
|
+
#
|
1726
|
+
# If the state is `ENABLED`, then the AWS Batch scheduler can attempt
|
1727
|
+
# to place jobs from an associated job queue on the compute resources
|
1728
|
+
# within the environment. If the compute environment is managed, then
|
1729
|
+
# it can scale its instances out or in automatically, based on the job
|
1730
|
+
# queue demand.
|
1731
|
+
#
|
1732
|
+
# If the state is `DISABLED`, then the AWS Batch scheduler doesn't
|
1733
|
+
# attempt to place jobs within the environment. Jobs in a `STARTING`
|
1734
|
+
# or `RUNNING` state continue to progress normally. Managed compute
|
1735
|
+
# environments in the `DISABLED` state don't scale out. However, they
|
1736
|
+
# scale in to `minvCpus` value after instances become idle.
|
1661
1737
|
# @return [String]
|
1662
1738
|
#
|
1663
1739
|
# @!attribute [rw] compute_resources
|
@@ -1673,20 +1749,26 @@ module Aws::Batch
|
|
1673
1749
|
#
|
1674
1750
|
# @!attribute [rw] service_role
|
1675
1751
|
# The full Amazon Resource Name (ARN) of the IAM role that allows AWS
|
1676
|
-
# Batch to make calls to other AWS services on your behalf.
|
1752
|
+
# Batch to make calls to other AWS services on your behalf. For more
|
1753
|
+
# information, see [AWS Batch service IAM role][1] in the *AWS Batch
|
1754
|
+
# User Guide*.
|
1677
1755
|
#
|
1678
1756
|
# If your specified role has a path other than `/`, then you must
|
1679
1757
|
# either specify the full role ARN (this is recommended) or prefix the
|
1680
1758
|
# role name with the path.
|
1681
1759
|
#
|
1682
1760
|
# <note markdown="1"> Depending on how you created your AWS Batch service role, its ARN
|
1683
|
-
#
|
1761
|
+
# might contain the `service-role` path prefix. When you only specify
|
1684
1762
|
# the name of the service role, AWS Batch assumes that your ARN
|
1685
1763
|
# doesn't use the `service-role` path prefix. Because of this, we
|
1686
1764
|
# recommend that you specify the full ARN of your service role when
|
1687
1765
|
# you create compute environments.
|
1688
1766
|
#
|
1689
1767
|
# </note>
|
1768
|
+
#
|
1769
|
+
#
|
1770
|
+
#
|
1771
|
+
# [1]: https://docs.aws.amazon.com/batch/latest/userguide/service_IAM_role.html
|
1690
1772
|
# @return [String]
|
1691
1773
|
#
|
1692
1774
|
# @!attribute [rw] tags
|
@@ -1720,7 +1802,8 @@ module Aws::Batch
|
|
1720
1802
|
end
|
1721
1803
|
|
1722
1804
|
# @!attribute [rw] compute_environment_name
|
1723
|
-
# The name of the compute environment.
|
1805
|
+
# The name of the compute environment. Up to 128 letters (uppercase
|
1806
|
+
# and lowercase), numbers, hyphens, and underscores are allowed.
|
1724
1807
|
# @return [String]
|
1725
1808
|
#
|
1726
1809
|
# @!attribute [rw] compute_environment_arn
|
@@ -1736,6 +1819,8 @@ module Aws::Batch
|
|
1736
1819
|
include Aws::Structure
|
1737
1820
|
end
|
1738
1821
|
|
1822
|
+
# Contains the parameters for `CreateJobQueue`.
|
1823
|
+
#
|
1739
1824
|
# @note When making an API call, you may pass CreateJobQueueRequest
|
1740
1825
|
# data as a hash:
|
1741
1826
|
#
|
@@ -1755,7 +1840,8 @@ module Aws::Batch
|
|
1755
1840
|
# }
|
1756
1841
|
#
|
1757
1842
|
# @!attribute [rw] job_queue_name
|
1758
|
-
# The name of the job queue.
|
1843
|
+
# The name of the job queue. Up to 128 letters (uppercase and
|
1844
|
+
# lowercase), numbers, and underscores are allowed.
|
1759
1845
|
# @return [String]
|
1760
1846
|
#
|
1761
1847
|
# @!attribute [rw] state
|
@@ -1771,7 +1857,10 @@ module Aws::Batch
|
|
1771
1857
|
# first when associated with the same compute environment. Priority is
|
1772
1858
|
# determined in descending order. For example, a job queue with a
|
1773
1859
|
# priority value of `10` is given scheduling preference over a job
|
1774
|
-
# queue with a priority value of `1`.
|
1860
|
+
# queue with a priority value of `1`. All of the compute environments
|
1861
|
+
# must be either EC2 (`EC2` or `SPOT`) or Fargate (`FARGATE` or
|
1862
|
+
# `FARGATE_SPOT`); EC2 and Fargate compute environments cannot be
|
1863
|
+
# mixed.
|
1775
1864
|
# @return [Integer]
|
1776
1865
|
#
|
1777
1866
|
# @!attribute [rw] compute_environment_order
|
@@ -1784,17 +1873,23 @@ module Aws::Batch
|
|
1784
1873
|
# environments must be either EC2 (`EC2` or `SPOT`) or Fargate
|
1785
1874
|
# (`FARGATE` or `FARGATE_SPOT`); EC2 and Fargate compute environments
|
1786
1875
|
# can't be mixed.
|
1876
|
+
#
|
1877
|
+
# <note markdown="1"> All compute environments that are associated with a job queue must
|
1878
|
+
# share the same architecture. AWS Batch doesn't support mixing
|
1879
|
+
# compute environment architecture types in a single job queue.
|
1880
|
+
#
|
1881
|
+
# </note>
|
1787
1882
|
# @return [Array<Types::ComputeEnvironmentOrder>]
|
1788
1883
|
#
|
1789
1884
|
# @!attribute [rw] tags
|
1790
1885
|
# The tags that you apply to the job queue to help you categorize and
|
1791
1886
|
# organize your resources. Each tag consists of a key and an optional
|
1792
|
-
# value. For more information, see [Tagging AWS
|
1793
|
-
#
|
1887
|
+
# value. For more information, see [Tagging your AWS Batch
|
1888
|
+
# resources][1] in *AWS Batch User Guide*.
|
1794
1889
|
#
|
1795
1890
|
#
|
1796
1891
|
#
|
1797
|
-
# [1]: https://docs.aws.amazon.com/
|
1892
|
+
# [1]: https://docs.aws.amazon.com/batch/latest/userguide/using-tags.html
|
1798
1893
|
# @return [Hash<String,String>]
|
1799
1894
|
#
|
1800
1895
|
# @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/CreateJobQueueRequest AWS API Documentation
|
@@ -1826,6 +1921,8 @@ module Aws::Batch
|
|
1826
1921
|
include Aws::Structure
|
1827
1922
|
end
|
1828
1923
|
|
1924
|
+
# Contains the parameters for `DeleteComputeEnvironment`.
|
1925
|
+
#
|
1829
1926
|
# @note When making an API call, you may pass DeleteComputeEnvironmentRequest
|
1830
1927
|
# data as a hash:
|
1831
1928
|
#
|
@@ -1850,6 +1947,8 @@ module Aws::Batch
|
|
1850
1947
|
#
|
1851
1948
|
class DeleteComputeEnvironmentResponse < Aws::EmptyStructure; end
|
1852
1949
|
|
1950
|
+
# Contains the parameters for `DeleteJobQueue`.
|
1951
|
+
#
|
1853
1952
|
# @note When making an API call, you may pass DeleteJobQueueRequest
|
1854
1953
|
# data as a hash:
|
1855
1954
|
#
|
@@ -1898,6 +1997,8 @@ module Aws::Batch
|
|
1898
1997
|
#
|
1899
1998
|
class DeregisterJobDefinitionResponse < Aws::EmptyStructure; end
|
1900
1999
|
|
2000
|
+
# Contains the parameters for `DescribeComputeEnvironments`.
|
2001
|
+
#
|
1901
2002
|
# @note When making an API call, you may pass DescribeComputeEnvironmentsRequest
|
1902
2003
|
# data as a hash:
|
1903
2004
|
#
|
@@ -1933,7 +2034,7 @@ module Aws::Batch
|
|
1933
2034
|
# `nextToken` value. This value is `null` when there are no more
|
1934
2035
|
# results to return.
|
1935
2036
|
#
|
1936
|
-
# <note markdown="1"> This token should be treated as an opaque identifier that
|
2037
|
+
# <note markdown="1"> This token should be treated as an opaque identifier that's only
|
1937
2038
|
# used to retrieve the next items in a list and not for other
|
1938
2039
|
# programmatic purposes.
|
1939
2040
|
#
|
@@ -1971,6 +2072,8 @@ module Aws::Batch
|
|
1971
2072
|
include Aws::Structure
|
1972
2073
|
end
|
1973
2074
|
|
2075
|
+
# Contains the parameters for `DescribeJobDefinitions`.
|
2076
|
+
#
|
1974
2077
|
# @note When making an API call, you may pass DescribeJobDefinitionsRequest
|
1975
2078
|
# data as a hash:
|
1976
2079
|
#
|
@@ -2015,7 +2118,7 @@ module Aws::Batch
|
|
2015
2118
|
# value. This value is `null` when there are no more results to
|
2016
2119
|
# return.
|
2017
2120
|
#
|
2018
|
-
# <note markdown="1"> This token should be treated as an opaque identifier that
|
2121
|
+
# <note markdown="1"> This token should be treated as an opaque identifier that's only
|
2019
2122
|
# used to retrieve the next items in a list and not for other
|
2020
2123
|
# programmatic purposes.
|
2021
2124
|
#
|
@@ -2055,6 +2158,8 @@ module Aws::Batch
|
|
2055
2158
|
include Aws::Structure
|
2056
2159
|
end
|
2057
2160
|
|
2161
|
+
# Contains the parameters for `DescribeJobQueues`.
|
2162
|
+
#
|
2058
2163
|
# @note When making an API call, you may pass DescribeJobQueuesRequest
|
2059
2164
|
# data as a hash:
|
2060
2165
|
#
|
@@ -2088,7 +2193,7 @@ module Aws::Batch
|
|
2088
2193
|
# value. This value is `null` when there are no more results to
|
2089
2194
|
# return.
|
2090
2195
|
#
|
2091
|
-
# <note markdown="1"> This token should be treated as an opaque identifier that
|
2196
|
+
# <note markdown="1"> This token should be treated as an opaque identifier that's only
|
2092
2197
|
# used to retrieve the next items in a list and not for other
|
2093
2198
|
# programmatic purposes.
|
2094
2199
|
#
|
@@ -2126,6 +2231,8 @@ module Aws::Batch
|
|
2126
2231
|
include Aws::Structure
|
2127
2232
|
end
|
2128
2233
|
|
2234
|
+
# Contains the parameters for `DescribeJobs`.
|
2235
|
+
#
|
2129
2236
|
# @note When making an API call, you may pass DescribeJobsRequest
|
2130
2237
|
# data as a hash:
|
2131
2238
|
#
|
@@ -2233,7 +2340,7 @@ module Aws::Batch
|
|
2233
2340
|
#
|
2234
2341
|
# ECS\_AL1
|
2235
2342
|
#
|
2236
|
-
# : [Amazon Linux][4]−Default for all non-GPU, non-AWS
|
2343
|
+
# : [Amazon Linux][4]−Default for all non-GPU, non-AWS Graviton
|
2237
2344
|
# instance families. Amazon Linux is reaching the end-of-life of
|
2238
2345
|
# standard support. For more information, see [Amazon Linux AMI][5].
|
2239
2346
|
#
|
@@ -2361,7 +2468,7 @@ module Aws::Batch
|
|
2361
2468
|
# }
|
2362
2469
|
#
|
2363
2470
|
# @!attribute [rw] source_path
|
2364
|
-
# The path on the host container instance that
|
2471
|
+
# The path on the host container instance that's presented to the
|
2365
2472
|
# container. If this parameter is empty, then the Docker daemon has
|
2366
2473
|
# assigned a host path for you. If this parameter contains a file
|
2367
2474
|
# location, then the data volume persists at the specified location on
|
@@ -2540,7 +2647,7 @@ module Aws::Batch
|
|
2540
2647
|
# @!attribute [rw] status
|
2541
2648
|
# The current status for the job.
|
2542
2649
|
#
|
2543
|
-
# <note markdown="1"> If your jobs
|
2650
|
+
# <note markdown="1"> If your jobs don't progress to `STARTING`, see [Jobs Stuck in
|
2544
2651
|
# RUNNABLE Status][1] in the troubleshooting section of the *AWS Batch
|
2545
2652
|
# User Guide*.
|
2546
2653
|
#
|
@@ -2590,7 +2697,7 @@ module Aws::Batch
|
|
2590
2697
|
# @return [Array<Types::JobDependency>]
|
2591
2698
|
#
|
2592
2699
|
# @!attribute [rw] job_definition
|
2593
|
-
# The job definition that
|
2700
|
+
# The job definition that's used by this job.
|
2594
2701
|
# @return [String]
|
2595
2702
|
#
|
2596
2703
|
# @!attribute [rw] parameters
|
@@ -2605,7 +2712,7 @@ module Aws::Batch
|
|
2605
2712
|
# @return [Types::ContainerDetail]
|
2606
2713
|
#
|
2607
2714
|
# @!attribute [rw] node_details
|
2608
|
-
# An object representing the details of a node that
|
2715
|
+
# An object representing the details of a node that's associated with
|
2609
2716
|
# a multi-node parallel job.
|
2610
2717
|
# @return [Types::NodeDetails]
|
2611
2718
|
#
|
@@ -2702,7 +2809,15 @@ module Aws::Batch
|
|
2702
2809
|
# @return [String]
|
2703
2810
|
#
|
2704
2811
|
# @!attribute [rw] priority
|
2705
|
-
# The priority of the job queue.
|
2812
|
+
# The priority of the job queue. Job queues with a higher priority (or
|
2813
|
+
# a higher integer value for the `priority` parameter) are evaluated
|
2814
|
+
# first when associated with the same compute environment. Priority is
|
2815
|
+
# determined in descending order, for example, a job queue with a
|
2816
|
+
# priority value of `10` is given scheduling preference over a job
|
2817
|
+
# queue with a priority value of `1`. All of the compute environments
|
2818
|
+
# must be either EC2 (`EC2` or `SPOT`) or Fargate (`FARGATE` or
|
2819
|
+
# `FARGATE_SPOT`); EC2 and Fargate compute environments cannot be
|
2820
|
+
# mixed.
|
2706
2821
|
# @return [Integer]
|
2707
2822
|
#
|
2708
2823
|
# @!attribute [rw] compute_environment_order
|
@@ -2712,7 +2827,12 @@ module Aws::Batch
|
|
2712
2827
|
# @return [Array<Types::ComputeEnvironmentOrder>]
|
2713
2828
|
#
|
2714
2829
|
# @!attribute [rw] tags
|
2715
|
-
# The tags applied to the job queue.
|
2830
|
+
# The tags applied to the job queue. For more information, see
|
2831
|
+
# [Tagging your AWS Batch resources][1] in *AWS Batch User Guide*.
|
2832
|
+
#
|
2833
|
+
#
|
2834
|
+
#
|
2835
|
+
# [1]: https://docs.aws.amazon.com/batch/latest/userguide/using-tags.html
|
2716
2836
|
# @return [Hash<String,String>]
|
2717
2837
|
#
|
2718
2838
|
# @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/JobQueueDetail AWS API Documentation
|
@@ -2773,7 +2893,7 @@ module Aws::Batch
|
|
2773
2893
|
# @return [Integer]
|
2774
2894
|
#
|
2775
2895
|
# @!attribute [rw] container
|
2776
|
-
# An object representing the details of the container that
|
2896
|
+
# An object representing the details of the container that's
|
2777
2897
|
# associated with the job.
|
2778
2898
|
# @return [Types::ContainerSummary]
|
2779
2899
|
#
|
@@ -3029,9 +3149,32 @@ module Aws::Batch
|
|
3029
3149
|
# be swapped very aggressively. Accepted values are whole numbers
|
3030
3150
|
# between `0` and `100`. If the `swappiness` parameter isn't
|
3031
3151
|
# specified, a default value of `60` is used. If a value isn't
|
3032
|
-
# specified for `maxSwap` then this parameter is ignored.
|
3033
|
-
#
|
3034
|
-
# run][1].
|
3152
|
+
# specified for `maxSwap` then this parameter is ignored. If `maxSwap`
|
3153
|
+
# is set to 0, the container doesn't use swap. This parameter maps to
|
3154
|
+
# the `--memory-swappiness` option to [docker run][1].
|
3155
|
+
#
|
3156
|
+
# Consider the following when you use a per-container swap
|
3157
|
+
# configuration.
|
3158
|
+
#
|
3159
|
+
# * Swap space must be enabled and allocated on the container instance
|
3160
|
+
# for the containers to use.
|
3161
|
+
#
|
3162
|
+
# <note markdown="1"> The Amazon ECS optimized AMIs don't have swap enabled by default.
|
3163
|
+
# You must enable swap on the instance to use this feature. For more
|
3164
|
+
# information, see [Instance Store Swap Volumes][2] in the *Amazon
|
3165
|
+
# EC2 User Guide for Linux Instances* or [How do I allocate memory
|
3166
|
+
# to work as swap space in an Amazon EC2 instance by using a swap
|
3167
|
+
# file?][3]
|
3168
|
+
#
|
3169
|
+
# </note>
|
3170
|
+
#
|
3171
|
+
# * The swap space parameters are only supported for job definitions
|
3172
|
+
# using EC2 resources.
|
3173
|
+
#
|
3174
|
+
# * If the `maxSwap` and `swappiness` parameters are omitted from a
|
3175
|
+
# job definition, each container will have a default `swappiness`
|
3176
|
+
# value of 60 and the total swap usage will be limited to two times
|
3177
|
+
# the memory reservation of the container.
|
3035
3178
|
#
|
3036
3179
|
# <note markdown="1"> This parameter isn't applicable to jobs running on Fargate
|
3037
3180
|
# resources and shouldn't be provided.
|
@@ -3041,6 +3184,8 @@ module Aws::Batch
|
|
3041
3184
|
#
|
3042
3185
|
#
|
3043
3186
|
# [1]: https://docs.docker.com/engine/reference/run/
|
3187
|
+
# [2]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-store-swap-volumes.html
|
3188
|
+
# [3]: http://aws.amazon.com/premiumsupport/knowledge-center/ec2-memory-swap-file/
|
3044
3189
|
# @return [Integer]
|
3045
3190
|
#
|
3046
3191
|
# @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/LinuxParameters AWS API Documentation
|
@@ -3056,6 +3201,8 @@ module Aws::Batch
|
|
3056
3201
|
include Aws::Structure
|
3057
3202
|
end
|
3058
3203
|
|
3204
|
+
# Contains the parameters for `ListJobs`.
|
3205
|
+
#
|
3059
3206
|
# @note When making an API call, you may pass ListJobsRequest
|
3060
3207
|
# data as a hash:
|
3061
3208
|
#
|
@@ -3107,7 +3254,7 @@ module Aws::Batch
|
|
3107
3254
|
# previous results that returned the `nextToken` value. This value is
|
3108
3255
|
# `null` when there are no more results to return.
|
3109
3256
|
#
|
3110
|
-
# <note markdown="1"> This token should be treated as an opaque identifier that
|
3257
|
+
# <note markdown="1"> This token should be treated as an opaque identifier that's only
|
3111
3258
|
# used to retrieve the next items in a list and not for other
|
3112
3259
|
# programmatic purposes.
|
3113
3260
|
#
|
@@ -3257,9 +3404,9 @@ module Aws::Batch
|
|
3257
3404
|
# including usage and options, see [Syslog logging driver][8] in the
|
3258
3405
|
# Docker documentation.
|
3259
3406
|
#
|
3260
|
-
# <note markdown="1"> If you have a custom driver that
|
3407
|
+
# <note markdown="1"> If you have a custom driver that'sn't listed earlier that you want
|
3261
3408
|
# to work with the Amazon ECS container agent, you can fork the Amazon
|
3262
|
-
# ECS container agent project that
|
3409
|
+
# ECS container agent project that's [available on GitHub][9] and
|
3263
3410
|
# customize it to work with that driver. We encourage you to submit
|
3264
3411
|
# pull requests for changes that you want to have included. However,
|
3265
3412
|
# Amazon Web Services doesn't currently support running modified
|
@@ -3313,7 +3460,7 @@ module Aws::Batch
|
|
3313
3460
|
include Aws::Structure
|
3314
3461
|
end
|
3315
3462
|
|
3316
|
-
# Details on a Docker volume mount point that
|
3463
|
+
# Details on a Docker volume mount point that's used in a job's
|
3317
3464
|
# container properties. This parameter maps to `Volumes` in the [Create
|
3318
3465
|
# a container][1] section of the Docker Remote API and the `--volume`
|
3319
3466
|
# option to docker run.
|
@@ -3433,7 +3580,7 @@ module Aws::Batch
|
|
3433
3580
|
include Aws::Structure
|
3434
3581
|
end
|
3435
3582
|
|
3436
|
-
# Object representing any node overrides to a job definition that
|
3583
|
+
# Object representing any node overrides to a job definition that's
|
3437
3584
|
# used in a SubmitJob API operation.
|
3438
3585
|
#
|
3439
3586
|
# <note markdown="1"> This isn't applicable to jobs running on Fargate resources and
|
@@ -3630,7 +3777,7 @@ module Aws::Batch
|
|
3630
3777
|
include Aws::Structure
|
3631
3778
|
end
|
3632
3779
|
|
3633
|
-
# An object representing the properties of a node that
|
3780
|
+
# An object representing the properties of a node that's associated
|
3634
3781
|
# with a multi-node parallel job.
|
3635
3782
|
#
|
3636
3783
|
# @!attribute [rw] is_main_node
|
@@ -3658,7 +3805,7 @@ module Aws::Batch
|
|
3658
3805
|
include Aws::Structure
|
3659
3806
|
end
|
3660
3807
|
|
3661
|
-
# Object representing any node overrides to a job definition that
|
3808
|
+
# Object representing any node overrides to a job definition that's
|
3662
3809
|
# used in a SubmitJob API operation.
|
3663
3810
|
#
|
3664
3811
|
# @note When making an API call, you may pass NodePropertyOverride
|
@@ -3814,7 +3961,7 @@ module Aws::Batch
|
|
3814
3961
|
# starting range value is omitted (`:n`), then `0` is used to start
|
3815
3962
|
# the range. If the ending range value is omitted (`n:`), then the
|
3816
3963
|
# highest possible node index is used to end the range. Your
|
3817
|
-
# accumulative node ranges must account for all nodes (`0:n`). You
|
3964
|
+
# accumulative node ranges must account for all nodes (`0:n`). You can
|
3818
3965
|
# nest node ranges, for example `0:10` and `4:5`, in which case the
|
3819
3966
|
# `4:5` range properties override the `0:10` properties.
|
3820
3967
|
# @return [String]
|
@@ -3832,6 +3979,8 @@ module Aws::Batch
|
|
3832
3979
|
include Aws::Structure
|
3833
3980
|
end
|
3834
3981
|
|
3982
|
+
# Contains the parameters for `RegisterJobDefinition`.
|
3983
|
+
#
|
3835
3984
|
# @note When making an API call, you may pass RegisterJobDefinitionRequest
|
3836
3985
|
# data as a hash:
|
3837
3986
|
#
|
@@ -4111,7 +4260,7 @@ module Aws::Batch
|
|
4111
4260
|
#
|
4112
4261
|
# @!attribute [rw] retry_strategy
|
4113
4262
|
# The retry strategy to use for failed jobs that are submitted with
|
4114
|
-
# this job definition. Any retry strategy that
|
4263
|
+
# this job definition. Any retry strategy that's specified during a
|
4115
4264
|
# SubmitJob operation overrides the retry strategy defined here. If a
|
4116
4265
|
# job is terminated due to a timeout, it isn't retried.
|
4117
4266
|
# @return [Types::RetryStrategy]
|
@@ -4131,7 +4280,7 @@ module Aws::Batch
|
|
4131
4280
|
# definition, after which AWS Batch terminates your jobs if they have
|
4132
4281
|
# not finished. If a job is terminated due to a timeout, it isn't
|
4133
4282
|
# retried. The minimum value for the timeout is 60 seconds. Any
|
4134
|
-
# timeout configuration that
|
4283
|
+
# timeout configuration that's specified during a SubmitJob operation
|
4135
4284
|
# overrides the timeout configuration defined here. For more
|
4136
4285
|
# information, see [Job Timeouts][1] in the *AWS Batch User Guide*.
|
4137
4286
|
#
|
@@ -4234,8 +4383,7 @@ module Aws::Batch
|
|
4234
4383
|
# parallel (MNP) jobs. It must be specified for each node at least
|
4235
4384
|
# once. This parameter maps to `Memory` in the [Create a
|
4236
4385
|
# container][1] section of the [Docker Remote API][2] and the
|
4237
|
-
# `--memory` option to [docker run][3].
|
4238
|
-
# MiB of memory for a job.
|
4386
|
+
# `--memory` option to [docker run][3].
|
4239
4387
|
#
|
4240
4388
|
# <note markdown="1"> If you're trying to maximize your resource utilization by
|
4241
4389
|
# providing your jobs as much memory as possible for a particular
|
@@ -4245,44 +4393,43 @@ module Aws::Batch
|
|
4245
4393
|
# </note>
|
4246
4394
|
#
|
4247
4395
|
# For jobs running on Fargate resources, then `value` is the hard
|
4248
|
-
# limit (in
|
4249
|
-
#
|
4250
|
-
#
|
4251
|
-
# supported for that memory value.
|
4396
|
+
# limit (in MiB), and must match one of the supported values and the
|
4397
|
+
# `VCPU` values must be one of the values supported for that memory
|
4398
|
+
# value.
|
4252
4399
|
#
|
4253
|
-
# value =
|
4400
|
+
# value = 512
|
4254
4401
|
#
|
4255
4402
|
# : `VCPU` = 0.25
|
4256
4403
|
#
|
4257
|
-
# value =
|
4404
|
+
# value = 1024
|
4258
4405
|
#
|
4259
4406
|
# : `VCPU` = 0.25 or 0.5
|
4260
4407
|
#
|
4261
|
-
# value =
|
4408
|
+
# value = 2048
|
4262
4409
|
#
|
4263
4410
|
# : `VCPU` = 0.25, 0.5, or 1
|
4264
4411
|
#
|
4265
|
-
# value =
|
4412
|
+
# value = 3072
|
4266
4413
|
#
|
4267
4414
|
# : `VCPU` = 0.5, or 1
|
4268
4415
|
#
|
4269
|
-
# value =
|
4416
|
+
# value = 4096
|
4270
4417
|
#
|
4271
4418
|
# : `VCPU` = 0.5, 1, or 2
|
4272
4419
|
#
|
4273
|
-
# value =
|
4420
|
+
# value = 5120, 6144, or 7168
|
4274
4421
|
#
|
4275
4422
|
# : `VCPU` = 1 or 2
|
4276
4423
|
#
|
4277
|
-
# value =
|
4424
|
+
# value = 8192
|
4278
4425
|
#
|
4279
4426
|
# : `VCPU` = 1, 2, or 4
|
4280
4427
|
#
|
4281
|
-
# value =
|
4428
|
+
# value = 9216, 10240, 11264, 12288, 13312, 14336, 15360, or 16384
|
4282
4429
|
#
|
4283
4430
|
# : `VCPU` = 2 or 4
|
4284
4431
|
#
|
4285
|
-
# value =
|
4432
|
+
# value = 17408, 18432, 19456, 20480, 21504, 22528, 23552, 24576, 25600, 26624, 27648, 28672, 29696, or 30720
|
4286
4433
|
#
|
4287
4434
|
# : `VCPU` = 4
|
4288
4435
|
#
|
@@ -4291,10 +4438,10 @@ module Aws::Batch
|
|
4291
4438
|
# : The number of vCPUs reserved for the container. This parameter
|
4292
4439
|
# maps to `CpuShares` in the [Create a container][1] section of the
|
4293
4440
|
# [Docker Remote API][2] and the `--cpu-shares` option to [docker
|
4294
|
-
# run][3]. Each vCPU is equivalent to 1,024 CPU shares.
|
4295
|
-
# specify at least one vCPU. This is required
|
4296
|
-
# in several places; it must be specified for
|
4297
|
-
# once.
|
4441
|
+
# run][3]. Each vCPU is equivalent to 1,024 CPU shares. For EC2
|
4442
|
+
# resources, you must specify at least one vCPU. This is required
|
4443
|
+
# but can be specified in several places; it must be specified for
|
4444
|
+
# each node at least once.
|
4298
4445
|
#
|
4299
4446
|
# For jobs running on Fargate resources, then `value` must match one
|
4300
4447
|
# of the supported values and the `MEMORY` values must be one of the
|
@@ -4303,24 +4450,26 @@ module Aws::Batch
|
|
4303
4450
|
#
|
4304
4451
|
# value = 0.25
|
4305
4452
|
#
|
4306
|
-
# : `MEMORY` =
|
4453
|
+
# : `MEMORY` = 512, 1024, or 2048
|
4307
4454
|
#
|
4308
4455
|
# value = 0.5
|
4309
4456
|
#
|
4310
|
-
# : `MEMORY` =
|
4457
|
+
# : `MEMORY` = 1024, 2048, 3072, or 4096
|
4311
4458
|
#
|
4312
4459
|
# value = 1
|
4313
4460
|
#
|
4314
|
-
# : `MEMORY` =
|
4461
|
+
# : `MEMORY` = 2048, 3072, 4096, 5120, 6144, 7168, or 8192
|
4315
4462
|
#
|
4316
4463
|
# value = 2
|
4317
4464
|
#
|
4318
|
-
# : `MEMORY` =
|
4465
|
+
# : `MEMORY` = 4096, 5120, 6144, 7168, 8192, 9216, 10240, 11264,
|
4466
|
+
# 12288, 13312, 14336, 15360, or 16384
|
4319
4467
|
#
|
4320
4468
|
# value = 4
|
4321
4469
|
#
|
4322
|
-
# : `MEMORY` =
|
4323
|
-
#
|
4470
|
+
# : `MEMORY` = 8192, 9216, 10240, 11264, 12288, 13312, 14336, 15360,
|
4471
|
+
# 16384, 17408, 18432, 19456, 20480, 21504, 22528, 23552, 24576,
|
4472
|
+
# 25600, 26624, 27648, 28672, 29696, or 30720
|
4324
4473
|
#
|
4325
4474
|
#
|
4326
4475
|
#
|
@@ -4367,7 +4516,7 @@ module Aws::Batch
|
|
4367
4516
|
# }
|
4368
4517
|
#
|
4369
4518
|
# @!attribute [rw] attempts
|
4370
|
-
# The number of times to move a job to the `RUNNABLE` status. You
|
4519
|
+
# The number of times to move a job to the `RUNNABLE` status. You can
|
4371
4520
|
# specify between 1 and 10 attempts. If the value of `attempts` is
|
4372
4521
|
# greater than one, the job is retried on failure the same number of
|
4373
4522
|
# attempts as the value.
|
@@ -4451,6 +4600,8 @@ module Aws::Batch
|
|
4451
4600
|
include Aws::Structure
|
4452
4601
|
end
|
4453
4602
|
|
4603
|
+
# Contains the parameters for `SubmitJob`.
|
4604
|
+
#
|
4454
4605
|
# @note When making an API call, you may pass SubmitJobRequest
|
4455
4606
|
# data as a hash:
|
4456
4607
|
#
|
@@ -4585,7 +4736,7 @@ module Aws::Batch
|
|
4585
4736
|
# A list of container overrides in JSON format that specify the name
|
4586
4737
|
# of a container in the specified job definition and the overrides it
|
4587
4738
|
# should receive. You can override the default command for a container
|
4588
|
-
# (that
|
4739
|
+
# (that's specified in the job definition or the Docker image) with a
|
4589
4740
|
# `command` override. You can also override existing environment
|
4590
4741
|
# variables (that are specified in the job definition or Docker image)
|
4591
4742
|
# on a container or add new environment variables to it with an
|
@@ -4728,6 +4879,8 @@ module Aws::Batch
|
|
4728
4879
|
#
|
4729
4880
|
class TagResourceResponse < Aws::EmptyStructure; end
|
4730
4881
|
|
4882
|
+
# Contains the parameters for `TerminateJob`.
|
4883
|
+
#
|
4731
4884
|
# @note When making an API call, you may pass TerminateJobRequest
|
4732
4885
|
# data as a hash:
|
4733
4886
|
#
|
@@ -4878,6 +5031,8 @@ module Aws::Batch
|
|
4878
5031
|
#
|
4879
5032
|
class UntagResourceResponse < Aws::EmptyStructure; end
|
4880
5033
|
|
5034
|
+
# Contains the parameters for `UpdateComputeEnvironment`.
|
5035
|
+
#
|
4881
5036
|
# @note When making an API call, you may pass UpdateComputeEnvironmentRequest
|
4882
5037
|
# data as a hash:
|
4883
5038
|
#
|
@@ -4903,16 +5058,35 @@ module Aws::Batch
|
|
4903
5058
|
# The state of the compute environment. Compute environments in the
|
4904
5059
|
# `ENABLED` state can accept jobs from a queue and scale in or out
|
4905
5060
|
# automatically based on the workload demand of its associated queues.
|
5061
|
+
#
|
5062
|
+
# If the state is `ENABLED`, then the AWS Batch scheduler can attempt
|
5063
|
+
# to place jobs from an associated job queue on the compute resources
|
5064
|
+
# within the environment. If the compute environment is managed, then
|
5065
|
+
# it can scale its instances out or in automatically, based on the job
|
5066
|
+
# queue demand.
|
5067
|
+
#
|
5068
|
+
# If the state is `DISABLED`, then the AWS Batch scheduler doesn't
|
5069
|
+
# attempt to place jobs within the environment. Jobs in a `STARTING`
|
5070
|
+
# or `RUNNING` state continue to progress normally. Managed compute
|
5071
|
+
# environments in the `DISABLED` state don't scale out. However, they
|
5072
|
+
# scale in to `minvCpus` value after instances become idle.
|
4906
5073
|
# @return [String]
|
4907
5074
|
#
|
4908
5075
|
# @!attribute [rw] compute_resources
|
4909
5076
|
# Details of the compute resources managed by the compute environment.
|
4910
|
-
# Required for a managed compute environment.
|
5077
|
+
# Required for a managed compute environment. For more information,
|
5078
|
+
# see [Compute Environments][1] in the *AWS Batch User Guide*.
|
5079
|
+
#
|
5080
|
+
#
|
5081
|
+
#
|
5082
|
+
# [1]: https://docs.aws.amazon.com/batch/latest/userguide/compute_environments.html
|
4911
5083
|
# @return [Types::ComputeResourceUpdate]
|
4912
5084
|
#
|
4913
5085
|
# @!attribute [rw] service_role
|
4914
5086
|
# The full Amazon Resource Name (ARN) of the IAM role that allows AWS
|
4915
|
-
# Batch to make calls to other AWS services on your behalf.
|
5087
|
+
# Batch to make calls to other AWS services on your behalf. For more
|
5088
|
+
# information, see [AWS Batch service IAM role][1] in the *AWS Batch
|
5089
|
+
# User Guide*.
|
4916
5090
|
#
|
4917
5091
|
# If your specified role has a path other than `/`, then you must
|
4918
5092
|
# either specify the full role ARN (this is recommended) or prefix the
|
@@ -4926,6 +5100,10 @@ module Aws::Batch
|
|
4926
5100
|
# you create compute environments.
|
4927
5101
|
#
|
4928
5102
|
# </note>
|
5103
|
+
#
|
5104
|
+
#
|
5105
|
+
#
|
5106
|
+
# [1]: https://docs.aws.amazon.com/batch/latest/userguide/service_IAM_role.html
|
4929
5107
|
# @return [String]
|
4930
5108
|
#
|
4931
5109
|
# @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/UpdateComputeEnvironmentRequest AWS API Documentation
|
@@ -4940,7 +5118,8 @@ module Aws::Batch
|
|
4940
5118
|
end
|
4941
5119
|
|
4942
5120
|
# @!attribute [rw] compute_environment_name
|
4943
|
-
# The name of the compute environment.
|
5121
|
+
# The name of the compute environment. Up to 128 letters (uppercase
|
5122
|
+
# and lowercase), numbers, hyphens, and underscores are allowed.
|
4944
5123
|
# @return [String]
|
4945
5124
|
#
|
4946
5125
|
# @!attribute [rw] compute_environment_arn
|
@@ -4956,6 +5135,8 @@ module Aws::Batch
|
|
4956
5135
|
include Aws::Structure
|
4957
5136
|
end
|
4958
5137
|
|
5138
|
+
# Contains the parameters for `UpdateJobQueue`.
|
5139
|
+
#
|
4959
5140
|
# @note When making an API call, you may pass UpdateJobQueueRequest
|
4960
5141
|
# data as a hash:
|
4961
5142
|
#
|
@@ -4988,17 +5169,27 @@ module Aws::Batch
|
|
4988
5169
|
# first when associated with the same compute environment. Priority is
|
4989
5170
|
# determined in descending order, for example, a job queue with a
|
4990
5171
|
# priority value of `10` is given scheduling preference over a job
|
4991
|
-
# queue with a priority value of `1`.
|
5172
|
+
# queue with a priority value of `1`. All of the compute environments
|
5173
|
+
# must be either EC2 (`EC2` or `SPOT`) or Fargate (`FARGATE` or
|
5174
|
+
# `FARGATE_SPOT`); EC2 and Fargate compute environments cannot be
|
5175
|
+
# mixed.
|
4992
5176
|
# @return [Integer]
|
4993
5177
|
#
|
4994
5178
|
# @!attribute [rw] compute_environment_order
|
4995
5179
|
# Details the set of compute environments mapped to a job queue and
|
4996
5180
|
# their order relative to each other. This is one of the parameters
|
4997
5181
|
# used by the job scheduler to determine which compute environment
|
4998
|
-
# should run a given job.
|
4999
|
-
#
|
5000
|
-
#
|
5001
|
-
#
|
5182
|
+
# should run a given job. Compute environments must be in the `VALID`
|
5183
|
+
# state before you can associate them with a job queue. All of the
|
5184
|
+
# compute environments must be either EC2 (`EC2` or `SPOT`) or Fargate
|
5185
|
+
# (`FARGATE` or `FARGATE_SPOT`); EC2 and Fargate compute environments
|
5186
|
+
# can't be mixed.
|
5187
|
+
#
|
5188
|
+
# <note markdown="1"> All compute environments that are associated with a job queue must
|
5189
|
+
# share the same architecture. AWS Batch doesn't support mixing
|
5190
|
+
# compute environment architecture types in a single job queue.
|
5191
|
+
#
|
5192
|
+
# </note>
|
5002
5193
|
# @return [Array<Types::ComputeEnvironmentOrder>]
|
5003
5194
|
#
|
5004
5195
|
# @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/UpdateJobQueueRequest AWS API Documentation
|