aws-sdk-batch 1.45.0 → 1.49.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 +20 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-batch.rb +1 -1
- data/lib/aws-sdk-batch/client.rb +280 -156
- data/lib/aws-sdk-batch/client_api.rb +27 -1
- data/lib/aws-sdk-batch/types.rb +773 -418
- metadata +7 -8
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 4b135146d7592b125f6c4c8c98a4788b068e2a5a064e382510de6ba31ed3a462
|
4
|
+
data.tar.gz: e40ed56a35617c39e8e1707eb00e28141cd67c77e32c34162632aedbd6853a36
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 88bfb11633e82b48c528d56b4dd5cff0204d8bb98a021ea2c2d6dfffa2641d00e9021663f83cbffe3884159eb9d7917378e479d78ab8f6426f5bfdfbfcce2830
|
7
|
+
data.tar.gz: 1e98536d588bedd573e8bd3efff108022b44f8cf89e3137b81d271c0c540ae190b8e8fe9dc84463444b40d3781c974fd3638a08beb474afd0cd437c4cf8551e6
|
data/CHANGELOG.md
CHANGED
@@ -1,6 +1,26 @@
|
|
1
1
|
Unreleased Changes
|
2
2
|
------------------
|
3
3
|
|
4
|
+
1.49.0 (2021-07-28)
|
5
|
+
------------------
|
6
|
+
|
7
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
8
|
+
|
9
|
+
1.48.0 (2021-07-27)
|
10
|
+
------------------
|
11
|
+
|
12
|
+
* Feature - Add support for ListJob filters
|
13
|
+
|
14
|
+
1.47.0 (2021-03-31)
|
15
|
+
------------------
|
16
|
+
|
17
|
+
* Feature - AWS Batch adds support for Amazon EFS File System
|
18
|
+
|
19
|
+
1.46.0 (2021-03-17)
|
20
|
+
------------------
|
21
|
+
|
22
|
+
* 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).
|
23
|
+
|
4
24
|
1.45.0 (2021-03-10)
|
5
25
|
------------------
|
6
26
|
|
data/VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
1.
|
1
|
+
1.49.0
|
data/lib/aws-sdk-batch.rb
CHANGED
data/lib/aws-sdk-batch/client.rb
CHANGED
@@ -327,19 +327,19 @@ module Aws::Batch
|
|
327
327
|
|
328
328
|
# @!group API Operations
|
329
329
|
|
330
|
-
# Cancels a job in an
|
331
|
-
# `
|
332
|
-
#
|
333
|
-
#
|
334
|
-
#
|
330
|
+
# Cancels a job in an Batch job queue. Jobs that are in the `SUBMITTED`,
|
331
|
+
# `PENDING`, or `RUNNABLE` state are canceled. Jobs that have progressed
|
332
|
+
# to `STARTING` or `RUNNING` aren't canceled, but the API operation
|
333
|
+
# still succeeds, even if no job is canceled. These jobs must be
|
334
|
+
# terminated with the TerminateJob operation.
|
335
335
|
#
|
336
336
|
# @option params [required, String] :job_id
|
337
|
-
# The
|
337
|
+
# The Batch job ID of the job to cancel.
|
338
338
|
#
|
339
339
|
# @option params [required, String] :reason
|
340
340
|
# A message to attach to the job that explains the reason for canceling
|
341
341
|
# it. This message is returned by future DescribeJobs operations on the
|
342
|
-
# job. This message is also recorded in the
|
342
|
+
# job. This message is also recorded in the Batch activity logs.
|
343
343
|
#
|
344
344
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
345
345
|
#
|
@@ -373,46 +373,45 @@ module Aws::Batch
|
|
373
373
|
req.send_request(options)
|
374
374
|
end
|
375
375
|
|
376
|
-
# Creates an
|
376
|
+
# Creates an Batch compute environment. You can create `MANAGED` or
|
377
377
|
# `UNMANAGED` compute environments. `MANAGED` compute environments can
|
378
|
-
# use Amazon EC2 or
|
379
|
-
#
|
378
|
+
# use Amazon EC2 or Fargate resources. `UNMANAGED` compute environments
|
379
|
+
# can only use EC2 resources.
|
380
380
|
#
|
381
|
-
# In a managed compute environment,
|
381
|
+
# In a managed compute environment, Batch manages the capacity and
|
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">
|
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"> 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
|
-
# resources. To use a new AMI for your
|
415
|
-
# steps:
|
414
|
+
# resources. To use a new AMI for your Batch jobs, complete these steps:
|
416
415
|
#
|
417
416
|
# 1. Create a new compute environment with the new AMI.
|
418
417
|
#
|
@@ -436,7 +435,7 @@ module Aws::Batch
|
|
436
435
|
#
|
437
436
|
# @option params [required, String] :type
|
438
437
|
# The type of the compute environment: `MANAGED` or `UNMANAGED`. For
|
439
|
-
# more information, see [Compute Environments][1] in the *
|
438
|
+
# more information, see [Compute Environments][1] in the *Batch User
|
440
439
|
# Guide*.
|
441
440
|
#
|
442
441
|
#
|
@@ -448,14 +447,14 @@ module Aws::Batch
|
|
448
447
|
# the compute environment accepts jobs from a queue and can scale out
|
449
448
|
# automatically based on queues.
|
450
449
|
#
|
451
|
-
# If the state is `ENABLED`, then the
|
450
|
+
# If the state is `ENABLED`, then the Batch scheduler can attempt to
|
452
451
|
# place jobs from an associated job queue on the compute resources
|
453
452
|
# within the environment. If the compute environment is managed, then it
|
454
453
|
# can scale its instances out or in automatically, based on the job
|
455
454
|
# queue demand.
|
456
455
|
#
|
457
|
-
# If the state is `DISABLED`, then the
|
458
|
-
#
|
456
|
+
# If the state is `DISABLED`, then the Batch scheduler doesn't attempt
|
457
|
+
# to place jobs within the environment. Jobs in a `STARTING` or
|
459
458
|
# `RUNNING` state continue to progress normally. Managed compute
|
460
459
|
# environments in the `DISABLED` state don't scale out. However, they
|
461
460
|
# scale in to `minvCpus` value after instances become idle.
|
@@ -464,27 +463,37 @@ module Aws::Batch
|
|
464
463
|
# Details about the compute resources managed by the compute
|
465
464
|
# environment. This parameter is required for managed compute
|
466
465
|
# environments. For more information, see [Compute Environments][1] in
|
467
|
-
# the *
|
466
|
+
# the *Batch User Guide*.
|
468
467
|
#
|
469
468
|
#
|
470
469
|
#
|
471
470
|
# [1]: https://docs.aws.amazon.com/batch/latest/userguide/compute_environments.html
|
472
471
|
#
|
473
|
-
# @option params [
|
474
|
-
# The full Amazon Resource Name (ARN) of the IAM role that allows
|
475
|
-
#
|
476
|
-
# information, see [
|
472
|
+
# @option params [String] :service_role
|
473
|
+
# The full Amazon Resource Name (ARN) of the IAM role that allows Batch
|
474
|
+
# to make calls to other Amazon Web Services services on your behalf.
|
475
|
+
# For more information, see [Batch service IAM role][1] in the *Batch
|
477
476
|
# User Guide*.
|
478
477
|
#
|
479
|
-
# If your
|
480
|
-
#
|
481
|
-
#
|
478
|
+
# If your account already created the Batch service-linked role, that
|
479
|
+
# role is used by default for your compute environment unless you
|
480
|
+
# specify a different role here. If the Batch service-linked role
|
481
|
+
# doesn't exist in your account, and no role is specified here, the
|
482
|
+
# service attempts to create the Batch service-linked role in your
|
483
|
+
# 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
|
-
# <note markdown="1"> Depending on how you created your
|
484
|
-
#
|
485
|
-
#
|
486
|
-
#
|
487
|
-
#
|
492
|
+
# <note markdown="1"> Depending on how you created your Batch service role, its ARN might
|
493
|
+
# contain the `service-role` path prefix. When you only specify the name
|
494
|
+
# of the service role, Batch assumes that your ARN doesn't use the
|
495
|
+
# `service-role` path prefix. Because of this, we recommend that you
|
496
|
+
# specify the full ARN of your service role when you create compute
|
488
497
|
# environments.
|
489
498
|
#
|
490
499
|
# </note>
|
@@ -492,12 +501,13 @@ 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
|
498
508
|
# categorize and organize your resources. Each tag consists of a key and
|
499
|
-
# an optional value. For more information, see [Tagging
|
500
|
-
# Resources][1] in *
|
509
|
+
# an optional value. For more information, see [Tagging Amazon Web
|
510
|
+
# Services Resources][1] in *Amazon Web Services General Reference*.
|
501
511
|
#
|
502
512
|
# These tags can be updated or removed using the [TagResource][2] and
|
503
513
|
# [UntagResource][3] API operations. These tags don't propagate to the
|
@@ -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
|
# },
|
@@ -657,12 +667,12 @@ module Aws::Batch
|
|
657
667
|
req.send_request(options)
|
658
668
|
end
|
659
669
|
|
660
|
-
# Creates an
|
661
|
-
#
|
662
|
-
#
|
670
|
+
# Creates an Batch job queue. When you create a job queue, you associate
|
671
|
+
# one or more compute environments to the queue and assign an order of
|
672
|
+
# 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 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.
|
@@ -685,7 +695,7 @@ module Aws::Batch
|
|
685
695
|
# priority value of `10` is given scheduling preference over a job queue
|
686
696
|
# with a priority value of `1`. All of the compute environments must be
|
687
697
|
# either EC2 (`EC2` or `SPOT`) or Fargate (`FARGATE` or `FARGATE_SPOT`);
|
688
|
-
# EC2 and Fargate compute environments
|
698
|
+
# EC2 and Fargate compute environments can't be mixed.
|
689
699
|
#
|
690
700
|
# @option params [required, Array<Types::ComputeEnvironmentOrder>] :compute_environment_order
|
691
701
|
# The set of compute environments mapped to a job queue and their order
|
@@ -698,7 +708,7 @@ module Aws::Batch
|
|
698
708
|
# EC2 and Fargate compute environments can't be mixed.
|
699
709
|
#
|
700
710
|
# <note markdown="1"> All compute environments that are associated with a job queue must
|
701
|
-
# share the same architecture.
|
711
|
+
# share the same architecture. Batch doesn't support mixing compute
|
702
712
|
# environment architecture types in a single job queue.
|
703
713
|
#
|
704
714
|
# </note>
|
@@ -706,8 +716,8 @@ module Aws::Batch
|
|
706
716
|
# @option params [Hash<String,String>] :tags
|
707
717
|
# The tags that you apply to the job queue to help you categorize and
|
708
718
|
# organize your resources. Each tag consists of a key and an optional
|
709
|
-
# value. For more information, see [Tagging your
|
710
|
-
#
|
719
|
+
# value. For more information, see [Tagging your Batch resources][1] in
|
720
|
+
# *Batch User Guide*.
|
711
721
|
#
|
712
722
|
#
|
713
723
|
#
|
@@ -799,15 +809,15 @@ module Aws::Batch
|
|
799
809
|
req.send_request(options)
|
800
810
|
end
|
801
811
|
|
802
|
-
# Deletes an
|
812
|
+
# Deletes an Batch compute environment.
|
803
813
|
#
|
804
814
|
# Before you can delete a compute environment, you must set its state to
|
805
815
|
# `DISABLED` with the UpdateComputeEnvironment API operation and
|
806
816
|
# disassociate it from any job queues with the UpdateJobQueue API
|
807
|
-
# operation. Compute environments that use
|
817
|
+
# operation. Compute environments that use 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
|
@@ -885,8 +895,8 @@ module Aws::Batch
|
|
885
895
|
req.send_request(options)
|
886
896
|
end
|
887
897
|
|
888
|
-
# Deregisters an
|
889
|
-
#
|
898
|
+
# Deregisters an Batch job definition. Job definitions are permanently
|
899
|
+
# deleted after 180 days.
|
890
900
|
#
|
891
901
|
# @option params [required, String] :job_definition
|
892
902
|
# The name and revision (`name:revision`) or full Amazon Resource Name
|
@@ -1074,15 +1084,18 @@ module Aws::Batch
|
|
1074
1084
|
# as `ACTIVE`) to only return job definitions that match that status.
|
1075
1085
|
#
|
1076
1086
|
# @option params [Array<String>] :job_definitions
|
1077
|
-
# A list of up to 100 job
|
1078
|
-
#
|
1087
|
+
# A list of up to 100 job definitions. Each entry in the list can either
|
1088
|
+
# be an ARN of the form
|
1089
|
+
# `arn:aws:batch:$\{Region\}:$\{Account\}:job-definition/$\{JobDefinitionName\}:$\{Revision\}`
|
1090
|
+
# or a short version using the form
|
1091
|
+
# `$\{JobDefinitionName\}:$\{Revision\}`.
|
1079
1092
|
#
|
1080
1093
|
# @option params [Integer] :max_results
|
1081
1094
|
# The maximum number of results returned by `DescribeJobDefinitions` in
|
1082
1095
|
# paginated output. When this parameter is used,
|
1083
1096
|
# `DescribeJobDefinitions` only returns `maxResults` results in a single
|
1084
|
-
# page
|
1085
|
-
#
|
1097
|
+
# page and a `nextToken` response element. The remaining results of the
|
1098
|
+
# initial request can be seen by sending another
|
1086
1099
|
# `DescribeJobDefinitions` request with the returned `nextToken` value.
|
1087
1100
|
# This value can be between 1 and 100. If this parameter isn't used,
|
1088
1101
|
# then `DescribeJobDefinitions` returns up to 100 results and a
|
@@ -1189,6 +1202,12 @@ module Aws::Batch
|
|
1189
1202
|
# resp.job_definitions[0].container_properties.volumes #=> Array
|
1190
1203
|
# resp.job_definitions[0].container_properties.volumes[0].host.source_path #=> String
|
1191
1204
|
# resp.job_definitions[0].container_properties.volumes[0].name #=> String
|
1205
|
+
# resp.job_definitions[0].container_properties.volumes[0].efs_volume_configuration.file_system_id #=> String
|
1206
|
+
# resp.job_definitions[0].container_properties.volumes[0].efs_volume_configuration.root_directory #=> String
|
1207
|
+
# resp.job_definitions[0].container_properties.volumes[0].efs_volume_configuration.transit_encryption #=> String, one of "ENABLED", "DISABLED"
|
1208
|
+
# resp.job_definitions[0].container_properties.volumes[0].efs_volume_configuration.transit_encryption_port #=> Integer
|
1209
|
+
# resp.job_definitions[0].container_properties.volumes[0].efs_volume_configuration.authorization_config.access_point_id #=> String
|
1210
|
+
# resp.job_definitions[0].container_properties.volumes[0].efs_volume_configuration.authorization_config.iam #=> String, one of "ENABLED", "DISABLED"
|
1192
1211
|
# resp.job_definitions[0].container_properties.environment #=> Array
|
1193
1212
|
# resp.job_definitions[0].container_properties.environment[0].name #=> String
|
1194
1213
|
# resp.job_definitions[0].container_properties.environment[0].value #=> String
|
@@ -1247,6 +1266,12 @@ module Aws::Batch
|
|
1247
1266
|
# resp.job_definitions[0].node_properties.node_range_properties[0].container.volumes #=> Array
|
1248
1267
|
# resp.job_definitions[0].node_properties.node_range_properties[0].container.volumes[0].host.source_path #=> String
|
1249
1268
|
# resp.job_definitions[0].node_properties.node_range_properties[0].container.volumes[0].name #=> String
|
1269
|
+
# resp.job_definitions[0].node_properties.node_range_properties[0].container.volumes[0].efs_volume_configuration.file_system_id #=> String
|
1270
|
+
# resp.job_definitions[0].node_properties.node_range_properties[0].container.volumes[0].efs_volume_configuration.root_directory #=> String
|
1271
|
+
# resp.job_definitions[0].node_properties.node_range_properties[0].container.volumes[0].efs_volume_configuration.transit_encryption #=> String, one of "ENABLED", "DISABLED"
|
1272
|
+
# resp.job_definitions[0].node_properties.node_range_properties[0].container.volumes[0].efs_volume_configuration.transit_encryption_port #=> Integer
|
1273
|
+
# resp.job_definitions[0].node_properties.node_range_properties[0].container.volumes[0].efs_volume_configuration.authorization_config.access_point_id #=> String
|
1274
|
+
# resp.job_definitions[0].node_properties.node_range_properties[0].container.volumes[0].efs_volume_configuration.authorization_config.iam #=> String, one of "ENABLED", "DISABLED"
|
1250
1275
|
# resp.job_definitions[0].node_properties.node_range_properties[0].container.environment #=> Array
|
1251
1276
|
# resp.job_definitions[0].node_properties.node_range_properties[0].container.environment[0].name #=> String
|
1252
1277
|
# resp.job_definitions[0].node_properties.node_range_properties[0].container.environment[0].value #=> String
|
@@ -1315,12 +1340,12 @@ module Aws::Batch
|
|
1315
1340
|
# @option params [Integer] :max_results
|
1316
1341
|
# The maximum number of results returned by `DescribeJobQueues` in
|
1317
1342
|
# paginated output. When this parameter is used, `DescribeJobQueues`
|
1318
|
-
# only returns `maxResults` results in a single page
|
1319
|
-
#
|
1320
|
-
#
|
1321
|
-
#
|
1322
|
-
#
|
1323
|
-
#
|
1343
|
+
# only returns `maxResults` results in a single page and a `nextToken`
|
1344
|
+
# response element. The remaining results of the initial request can be
|
1345
|
+
# seen by sending another `DescribeJobQueues` request with the returned
|
1346
|
+
# `nextToken` value. This value can be between 1 and 100. If this
|
1347
|
+
# parameter isn't used, then `DescribeJobQueues` returns up to 100
|
1348
|
+
# results and a `nextToken` value if applicable.
|
1324
1349
|
#
|
1325
1350
|
# @option params [String] :next_token
|
1326
1351
|
# The `nextToken` value returned from a previous paginated
|
@@ -1406,7 +1431,7 @@ module Aws::Batch
|
|
1406
1431
|
req.send_request(options)
|
1407
1432
|
end
|
1408
1433
|
|
1409
|
-
# Describes a list of
|
1434
|
+
# Describes a list of Batch jobs.
|
1410
1435
|
#
|
1411
1436
|
# @option params [required, Array<String>] :jobs
|
1412
1437
|
# A list of up to 100 job IDs.
|
@@ -1518,6 +1543,12 @@ module Aws::Batch
|
|
1518
1543
|
# resp.jobs[0].container.volumes #=> Array
|
1519
1544
|
# resp.jobs[0].container.volumes[0].host.source_path #=> String
|
1520
1545
|
# resp.jobs[0].container.volumes[0].name #=> String
|
1546
|
+
# resp.jobs[0].container.volumes[0].efs_volume_configuration.file_system_id #=> String
|
1547
|
+
# resp.jobs[0].container.volumes[0].efs_volume_configuration.root_directory #=> String
|
1548
|
+
# resp.jobs[0].container.volumes[0].efs_volume_configuration.transit_encryption #=> String, one of "ENABLED", "DISABLED"
|
1549
|
+
# resp.jobs[0].container.volumes[0].efs_volume_configuration.transit_encryption_port #=> Integer
|
1550
|
+
# resp.jobs[0].container.volumes[0].efs_volume_configuration.authorization_config.access_point_id #=> String
|
1551
|
+
# resp.jobs[0].container.volumes[0].efs_volume_configuration.authorization_config.iam #=> String, one of "ENABLED", "DISABLED"
|
1521
1552
|
# resp.jobs[0].container.environment #=> Array
|
1522
1553
|
# resp.jobs[0].container.environment[0].name #=> String
|
1523
1554
|
# resp.jobs[0].container.environment[0].value #=> String
|
@@ -1586,6 +1617,12 @@ module Aws::Batch
|
|
1586
1617
|
# resp.jobs[0].node_properties.node_range_properties[0].container.volumes #=> Array
|
1587
1618
|
# resp.jobs[0].node_properties.node_range_properties[0].container.volumes[0].host.source_path #=> String
|
1588
1619
|
# resp.jobs[0].node_properties.node_range_properties[0].container.volumes[0].name #=> String
|
1620
|
+
# resp.jobs[0].node_properties.node_range_properties[0].container.volumes[0].efs_volume_configuration.file_system_id #=> String
|
1621
|
+
# resp.jobs[0].node_properties.node_range_properties[0].container.volumes[0].efs_volume_configuration.root_directory #=> String
|
1622
|
+
# resp.jobs[0].node_properties.node_range_properties[0].container.volumes[0].efs_volume_configuration.transit_encryption #=> String, one of "ENABLED", "DISABLED"
|
1623
|
+
# resp.jobs[0].node_properties.node_range_properties[0].container.volumes[0].efs_volume_configuration.transit_encryption_port #=> Integer
|
1624
|
+
# resp.jobs[0].node_properties.node_range_properties[0].container.volumes[0].efs_volume_configuration.authorization_config.access_point_id #=> String
|
1625
|
+
# resp.jobs[0].node_properties.node_range_properties[0].container.volumes[0].efs_volume_configuration.authorization_config.iam #=> String, one of "ENABLED", "DISABLED"
|
1589
1626
|
# resp.jobs[0].node_properties.node_range_properties[0].container.environment #=> Array
|
1590
1627
|
# resp.jobs[0].node_properties.node_range_properties[0].container.environment[0].name #=> String
|
1591
1628
|
# resp.jobs[0].node_properties.node_range_properties[0].container.environment[0].value #=> String
|
@@ -1649,15 +1686,15 @@ module Aws::Batch
|
|
1649
1686
|
req.send_request(options)
|
1650
1687
|
end
|
1651
1688
|
|
1652
|
-
# Returns a list of
|
1689
|
+
# Returns a list of Batch jobs.
|
1653
1690
|
#
|
1654
1691
|
# You must specify only one of the following items:
|
1655
1692
|
#
|
1656
1693
|
# * A job queue ID to return a list of jobs in that job queue
|
1657
1694
|
#
|
1658
|
-
# * A multi-node parallel job ID to return a list of that job
|
1695
|
+
# * A multi-node parallel job ID to return a list of nodes for that job
|
1659
1696
|
#
|
1660
|
-
# * An array job ID to return a list of that job
|
1697
|
+
# * An array job ID to return a list of the children for that job
|
1661
1698
|
#
|
1662
1699
|
# You can filter the results by job status with the `jobStatus`
|
1663
1700
|
# parameter. If you don't specify a status, only `RUNNING` jobs are
|
@@ -1677,18 +1714,20 @@ module Aws::Batch
|
|
1677
1714
|
# associated with the specified job.
|
1678
1715
|
#
|
1679
1716
|
# @option params [String] :job_status
|
1680
|
-
# The job status used to filter jobs in the specified queue. If
|
1681
|
-
#
|
1717
|
+
# The job status used to filter jobs in the specified queue. If the
|
1718
|
+
# `filters` parameter is specified, the `jobStatus` parameter is ignored
|
1719
|
+
# and jobs with any status are returned. If you don't specify a status,
|
1720
|
+
# only `RUNNING` jobs are returned.
|
1682
1721
|
#
|
1683
1722
|
# @option params [Integer] :max_results
|
1684
1723
|
# The maximum number of results returned by `ListJobs` in paginated
|
1685
1724
|
# output. When this parameter is used, `ListJobs` only returns
|
1686
|
-
# `maxResults` results in a single page
|
1687
|
-
#
|
1688
|
-
#
|
1689
|
-
#
|
1690
|
-
#
|
1691
|
-
#
|
1725
|
+
# `maxResults` results in a single page and a `nextToken` response
|
1726
|
+
# element. The remaining results of the initial request can be seen by
|
1727
|
+
# sending another `ListJobs` request with the returned `nextToken`
|
1728
|
+
# value. This value can be between 1 and 100. If this parameter isn't
|
1729
|
+
# used, then `ListJobs` returns up to 100 results and a `nextToken`
|
1730
|
+
# value if applicable.
|
1692
1731
|
#
|
1693
1732
|
# @option params [String] :next_token
|
1694
1733
|
# The `nextToken` value returned from a previous paginated `ListJobs`
|
@@ -1703,6 +1742,54 @@ module Aws::Batch
|
|
1703
1742
|
#
|
1704
1743
|
# </note>
|
1705
1744
|
#
|
1745
|
+
# @option params [Array<Types::KeyValuesPair>] :filters
|
1746
|
+
# The filter to apply to the query. Only one filter can be used at a
|
1747
|
+
# time. When the filter is used, `jobStatus` is ignored. The filter
|
1748
|
+
# doesn't apply to child jobs in an array or multi-node parallel (MNP)
|
1749
|
+
# jobs. The results are sorted by the `createdAt` field, with the most
|
1750
|
+
# recent jobs being first.
|
1751
|
+
#
|
1752
|
+
# JOB\_NAME
|
1753
|
+
#
|
1754
|
+
# : The value of the filter is a case-insensitive match for the job
|
1755
|
+
# name. If the value ends with an asterisk (*), the filter will match
|
1756
|
+
# any job name that begins with the string before the '*'. This
|
1757
|
+
# corresponds to the `jobName` value. For example, `test1` matches
|
1758
|
+
# both `Test1` and `test1`, and `test1*` matches both `test1` and
|
1759
|
+
# `Test10`. When the `JOB_NAME` filter is used, the results are
|
1760
|
+
# grouped by the job name and version.
|
1761
|
+
#
|
1762
|
+
# JOB\_DEFINITION
|
1763
|
+
#
|
1764
|
+
# : The value for the filter is the name or Amazon Resource Name (ARN)
|
1765
|
+
# of the job definition. This corresponds to the `jobDefinition`
|
1766
|
+
# value. The value is case sensitive. When the value for the filter is
|
1767
|
+
# the job definition name, the results include all the jobs that used
|
1768
|
+
# any revision of that job definition name. If the value ends with an
|
1769
|
+
# asterisk (*), the filter will match any job definition name that
|
1770
|
+
# begins with the string before the '*'. For example, `jd1` matches
|
1771
|
+
# only `jd1`, and `jd1*` matches both `jd1` and `jd1A`. The version of
|
1772
|
+
# the job definition that's used doesn't affect the sort order. When
|
1773
|
+
# the `JOB_DEFINITION` filter is used and the ARN is used (which is in
|
1774
|
+
# the form
|
1775
|
+
# `arn:$\{Partition\}:batch:$\{Region\}:$\{Account\}:job-definition/$\{JobDefinitionName\}:$\{Revision\}`),
|
1776
|
+
# the results include jobs that used the specified revision of the job
|
1777
|
+
# definition. Asterisk (*) is not supported when the ARN is used.
|
1778
|
+
#
|
1779
|
+
# BEFORE\_CREATED\_AT
|
1780
|
+
#
|
1781
|
+
# : The value for the filter is the time that's before the job was
|
1782
|
+
# created. This corresponds to the `createdAt` value. The value is a
|
1783
|
+
# string representation of the number of seconds since 00:00:00 UTC
|
1784
|
+
# (midnight) on January 1, 1970.
|
1785
|
+
#
|
1786
|
+
# AFTER\_CREATED\_AT
|
1787
|
+
#
|
1788
|
+
# : The value for the filter is the time that's after the job was
|
1789
|
+
# created. This corresponds to the `createdAt` value. The value is a
|
1790
|
+
# string representation of the number of seconds since 00:00:00 UTC
|
1791
|
+
# (midnight) on January 1, 1970.
|
1792
|
+
#
|
1706
1793
|
# @return [Types::ListJobsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1707
1794
|
#
|
1708
1795
|
# * {Types::ListJobsResponse#job_summary_list #job_summary_list} => Array<Types::JobSummary>
|
@@ -1757,6 +1844,12 @@ module Aws::Batch
|
|
1757
1844
|
# job_status: "SUBMITTED", # accepts SUBMITTED, PENDING, RUNNABLE, STARTING, RUNNING, SUCCEEDED, FAILED
|
1758
1845
|
# max_results: 1,
|
1759
1846
|
# next_token: "String",
|
1847
|
+
# filters: [
|
1848
|
+
# {
|
1849
|
+
# name: "String",
|
1850
|
+
# values: ["String"],
|
1851
|
+
# },
|
1852
|
+
# ],
|
1760
1853
|
# })
|
1761
1854
|
#
|
1762
1855
|
# @example Response structure
|
@@ -1777,6 +1870,7 @@ module Aws::Batch
|
|
1777
1870
|
# resp.job_summary_list[0].node_properties.is_main_node #=> Boolean
|
1778
1871
|
# resp.job_summary_list[0].node_properties.num_nodes #=> Integer
|
1779
1872
|
# resp.job_summary_list[0].node_properties.node_index #=> Integer
|
1873
|
+
# resp.job_summary_list[0].job_definition #=> String
|
1780
1874
|
# resp.next_token #=> String
|
1781
1875
|
#
|
1782
1876
|
# @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/ListJobs AWS API Documentation
|
@@ -1788,14 +1882,14 @@ module Aws::Batch
|
|
1788
1882
|
req.send_request(options)
|
1789
1883
|
end
|
1790
1884
|
|
1791
|
-
# Lists the tags for an
|
1792
|
-
#
|
1793
|
-
#
|
1794
|
-
#
|
1885
|
+
# Lists the tags for an Batch resource. Batch resources that support
|
1886
|
+
# tags are compute environments, jobs, job definitions, and job queues.
|
1887
|
+
# ARNs for child jobs of array and multi-node parallel (MNP) jobs are
|
1888
|
+
# not supported.
|
1795
1889
|
#
|
1796
1890
|
# @option params [required, String] :resource_arn
|
1797
1891
|
# The Amazon Resource Name (ARN) that identifies the resource that tags
|
1798
|
-
# are listed for.
|
1892
|
+
# are listed for. Batch resources that support tags are compute
|
1799
1893
|
# environments, jobs, job definitions, and job queues. ARNs for child
|
1800
1894
|
# jobs of array and multi-node parallel (MNP) jobs are not supported.
|
1801
1895
|
#
|
@@ -1841,7 +1935,7 @@ module Aws::Batch
|
|
1841
1935
|
req.send_request(options)
|
1842
1936
|
end
|
1843
1937
|
|
1844
|
-
# Registers an
|
1938
|
+
# Registers an Batch job definition.
|
1845
1939
|
#
|
1846
1940
|
# @option params [required, String] :job_definition_name
|
1847
1941
|
# The name of the job definition to register. Up to 128 letters
|
@@ -1851,7 +1945,7 @@ module Aws::Batch
|
|
1851
1945
|
# @option params [required, String] :type
|
1852
1946
|
# The type of job definition. For more information about multi-node
|
1853
1947
|
# parallel jobs, see [Creating a multi-node parallel job definition][1]
|
1854
|
-
# in the *
|
1948
|
+
# in the *Batch User Guide*.
|
1855
1949
|
#
|
1856
1950
|
# <note markdown="1"> If the job is run on Fargate resources, then `multinode` isn't
|
1857
1951
|
# supported.
|
@@ -1883,9 +1977,9 @@ module Aws::Batch
|
|
1883
1977
|
# An object with various properties specific to multi-node parallel
|
1884
1978
|
# jobs. If you specify node properties for a job, it becomes a
|
1885
1979
|
# multi-node parallel job. For more information, see [Multi-node
|
1886
|
-
# Parallel Jobs][1] in the *
|
1887
|
-
#
|
1888
|
-
#
|
1980
|
+
# Parallel Jobs][1] in the *Batch User Guide*. If the job definition's
|
1981
|
+
# `type` parameter is `container`, then you must specify either
|
1982
|
+
# `containerProperties` or `nodeProperties`.
|
1889
1983
|
#
|
1890
1984
|
# <note markdown="1"> If the job runs on Fargate resources, then you must not specify
|
1891
1985
|
# `nodeProperties`; use `containerProperties` instead.
|
@@ -1913,12 +2007,12 @@ module Aws::Batch
|
|
1913
2007
|
#
|
1914
2008
|
# @option params [Types::JobTimeout] :timeout
|
1915
2009
|
# The timeout configuration for jobs that are submitted with this job
|
1916
|
-
# definition, after which
|
1917
|
-
#
|
1918
|
-
#
|
2010
|
+
# definition, after which Batch terminates your jobs if they have not
|
2011
|
+
# finished. If a job is terminated due to a timeout, it isn't retried.
|
2012
|
+
# The minimum value for the timeout is 60 seconds. Any timeout
|
1919
2013
|
# configuration that's specified during a SubmitJob operation overrides
|
1920
2014
|
# the timeout configuration defined here. For more information, see [Job
|
1921
|
-
# Timeouts][1] in the *
|
2015
|
+
# Timeouts][1] in the *Batch User Guide*.
|
1922
2016
|
#
|
1923
2017
|
#
|
1924
2018
|
#
|
@@ -1927,8 +2021,8 @@ module Aws::Batch
|
|
1927
2021
|
# @option params [Hash<String,String>] :tags
|
1928
2022
|
# The tags that you apply to the job definition to help you categorize
|
1929
2023
|
# and organize your resources. Each tag consists of a key and an
|
1930
|
-
# optional value. For more information, see [Tagging
|
1931
|
-
# in *
|
2024
|
+
# optional value. For more information, see [Tagging Amazon Web Services
|
2025
|
+
# Resources][1] in *Batch User Guide*.
|
1932
2026
|
#
|
1933
2027
|
#
|
1934
2028
|
#
|
@@ -2021,6 +2115,16 @@ module Aws::Batch
|
|
2021
2115
|
# source_path: "String",
|
2022
2116
|
# },
|
2023
2117
|
# name: "String",
|
2118
|
+
# efs_volume_configuration: {
|
2119
|
+
# file_system_id: "String", # required
|
2120
|
+
# root_directory: "String",
|
2121
|
+
# transit_encryption: "ENABLED", # accepts ENABLED, DISABLED
|
2122
|
+
# transit_encryption_port: 1,
|
2123
|
+
# authorization_config: {
|
2124
|
+
# access_point_id: "String",
|
2125
|
+
# iam: "ENABLED", # accepts ENABLED, DISABLED
|
2126
|
+
# },
|
2127
|
+
# },
|
2024
2128
|
# },
|
2025
2129
|
# ],
|
2026
2130
|
# environment: [
|
@@ -2117,6 +2221,16 @@ module Aws::Batch
|
|
2117
2221
|
# source_path: "String",
|
2118
2222
|
# },
|
2119
2223
|
# name: "String",
|
2224
|
+
# efs_volume_configuration: {
|
2225
|
+
# file_system_id: "String", # required
|
2226
|
+
# root_directory: "String",
|
2227
|
+
# transit_encryption: "ENABLED", # accepts ENABLED, DISABLED
|
2228
|
+
# transit_encryption_port: 1,
|
2229
|
+
# authorization_config: {
|
2230
|
+
# access_point_id: "String",
|
2231
|
+
# iam: "ENABLED", # accepts ENABLED, DISABLED
|
2232
|
+
# },
|
2233
|
+
# },
|
2120
2234
|
# },
|
2121
2235
|
# ],
|
2122
2236
|
# environment: [
|
@@ -2233,12 +2347,18 @@ module Aws::Batch
|
|
2233
2347
|
req.send_request(options)
|
2234
2348
|
end
|
2235
2349
|
|
2236
|
-
# Submits an
|
2237
|
-
# during SubmitJob override parameters defined in the job
|
2238
|
-
#
|
2239
|
-
#
|
2240
|
-
#
|
2241
|
-
# job
|
2350
|
+
# Submits an Batch job from a job definition. Parameters that are
|
2351
|
+
# specified during SubmitJob override parameters defined in the job
|
2352
|
+
# definition. vCPU and memory requirements that are specified in the
|
2353
|
+
# `ResourceRequirements` objects in the job definition are the
|
2354
|
+
# exception. They can't be overridden this way using the `memory` and
|
2355
|
+
# `vcpus` parameters. Rather, you must specify updates to job definition
|
2356
|
+
# parameters in a `ResourceRequirements` object that's included in the
|
2357
|
+
# `containerOverrides` parameter.
|
2358
|
+
#
|
2359
|
+
# Jobs that run on Fargate resources can't be guaranteed to run for
|
2360
|
+
# more than 14 days. This is because, after 14 days, Fargate resources
|
2361
|
+
# might become unavailable and job might be terminated.
|
2242
2362
|
#
|
2243
2363
|
# @option params [required, String] :job_name
|
2244
2364
|
# The name of the job. The first character must be alphanumeric, and up
|
@@ -2246,14 +2366,14 @@ module Aws::Batch
|
|
2246
2366
|
# underscores are allowed.
|
2247
2367
|
#
|
2248
2368
|
# @option params [required, String] :job_queue
|
2249
|
-
# The job queue
|
2250
|
-
#
|
2369
|
+
# The job queue where the job is submitted. You can specify either the
|
2370
|
+
# name or the Amazon Resource Name (ARN) of the queue.
|
2251
2371
|
#
|
2252
2372
|
# @option params [Types::ArrayProperties] :array_properties
|
2253
2373
|
# The array properties for the submitted job, such as the size of the
|
2254
2374
|
# array. The array size can be between 2 and 10,000. If you specify
|
2255
2375
|
# array properties for a job, it becomes an array job. For more
|
2256
|
-
# information, see [Array Jobs][1] in the *
|
2376
|
+
# information, see [Array Jobs][1] in the *Batch User Guide*.
|
2257
2377
|
#
|
2258
2378
|
#
|
2259
2379
|
#
|
@@ -2282,21 +2402,20 @@ module Aws::Batch
|
|
2282
2402
|
# from the job definition.
|
2283
2403
|
#
|
2284
2404
|
# @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
|
-
#
|
2405
|
+
# A list of container overrides in the JSON format that specify the name
|
2406
|
+
# of a container in the specified job definition and the overrides it
|
2407
|
+
# should receive. You can override the default command for a container,
|
2408
|
+
# which is specified in the job definition or the Docker image, with a
|
2289
2409
|
# `command` override. You can also override existing environment
|
2290
|
-
# variables
|
2291
|
-
#
|
2292
|
-
# `environment` override.
|
2410
|
+
# variables on a container or add new environment variables to it with
|
2411
|
+
# an `environment` override.
|
2293
2412
|
#
|
2294
2413
|
# @option params [Types::NodeOverrides] :node_overrides
|
2295
2414
|
# A list of node overrides in JSON format that specify the node range to
|
2296
2415
|
# target and the container overrides for that node range.
|
2297
2416
|
#
|
2298
|
-
# <note markdown="1"> This parameter isn't applicable to jobs running on Fargate
|
2299
|
-
# use `containerOverrides` instead.
|
2417
|
+
# <note markdown="1"> This parameter isn't applicable to jobs that are running on Fargate
|
2418
|
+
# resources; use `containerOverrides` instead.
|
2300
2419
|
#
|
2301
2420
|
# </note>
|
2302
2421
|
#
|
@@ -2317,8 +2436,8 @@ module Aws::Batch
|
|
2317
2436
|
#
|
2318
2437
|
# @option params [Types::JobTimeout] :timeout
|
2319
2438
|
# The timeout configuration for this SubmitJob operation. You can
|
2320
|
-
# specify a timeout duration after which
|
2321
|
-
#
|
2439
|
+
# specify a timeout duration after which Batch terminates your jobs if
|
2440
|
+
# they haven't finished. If a job is terminated due to a timeout, it
|
2322
2441
|
# isn't retried. The minimum value for the timeout is 60 seconds. This
|
2323
2442
|
# configuration overrides any timeout configuration specified in the job
|
2324
2443
|
# definition. For array jobs, child jobs have the same timeout
|
@@ -2333,8 +2452,8 @@ module Aws::Batch
|
|
2333
2452
|
# @option params [Hash<String,String>] :tags
|
2334
2453
|
# The tags that you apply to the job request to help you categorize and
|
2335
2454
|
# organize your resources. Each tag consists of a key and an optional
|
2336
|
-
# value. For more information, see [Tagging
|
2337
|
-
# General Reference*.
|
2455
|
+
# value. For more information, see [Tagging Amazon Web Services
|
2456
|
+
# Resources][1] in *Amazon Web Services General Reference*.
|
2338
2457
|
#
|
2339
2458
|
#
|
2340
2459
|
#
|
@@ -2463,22 +2582,22 @@ module Aws::Batch
|
|
2463
2582
|
# Associates the specified tags to a resource with the specified
|
2464
2583
|
# `resourceArn`. If existing tags on a resource aren't specified in the
|
2465
2584
|
# request parameters, they aren't changed. When a resource is deleted,
|
2466
|
-
# the tags associated with that resource are deleted as well.
|
2467
|
-
# resources that support tags are compute environments, jobs, job
|
2585
|
+
# the tags that are associated with that resource are deleted as well.
|
2586
|
+
# Batch resources that support tags are compute environments, jobs, job
|
2468
2587
|
# definitions, and job queues. ARNs for child jobs of array and
|
2469
2588
|
# multi-node parallel (MNP) jobs are not supported.
|
2470
2589
|
#
|
2471
2590
|
# @option params [required, String] :resource_arn
|
2472
2591
|
# The Amazon Resource Name (ARN) of the resource that tags are added to.
|
2473
|
-
#
|
2474
|
-
#
|
2592
|
+
# Batch resources that support tags are compute environments, jobs, job
|
2593
|
+
# definitions, and job queues. ARNs for child jobs of array and
|
2475
2594
|
# multi-node parallel (MNP) jobs are not supported.
|
2476
2595
|
#
|
2477
2596
|
# @option params [required, Hash<String,String>] :tags
|
2478
2597
|
# The tags that you apply to the resource to help you categorize and
|
2479
2598
|
# organize your resources. Each tag consists of a key and an optional
|
2480
|
-
# value. For more information, see [Tagging
|
2481
|
-
# General Reference*.
|
2599
|
+
# value. For more information, see [Tagging Amazon Web Services
|
2600
|
+
# Resources][1] in *Amazon Web Services General Reference*.
|
2482
2601
|
#
|
2483
2602
|
#
|
2484
2603
|
#
|
@@ -2526,12 +2645,12 @@ module Aws::Batch
|
|
2526
2645
|
# cancelled.
|
2527
2646
|
#
|
2528
2647
|
# @option params [required, String] :job_id
|
2529
|
-
# The
|
2648
|
+
# The Batch job ID of the job to terminate.
|
2530
2649
|
#
|
2531
2650
|
# @option params [required, String] :reason
|
2532
2651
|
# A message to attach to the job that explains the reason for canceling
|
2533
2652
|
# it. This message is returned by future DescribeJobs operations on the
|
2534
|
-
# job. This message is also recorded in the
|
2653
|
+
# job. This message is also recorded in the Batch activity logs.
|
2535
2654
|
#
|
2536
2655
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
2537
2656
|
#
|
@@ -2565,11 +2684,11 @@ module Aws::Batch
|
|
2565
2684
|
req.send_request(options)
|
2566
2685
|
end
|
2567
2686
|
|
2568
|
-
# Deletes specified tags from an
|
2687
|
+
# Deletes specified tags from an Batch resource.
|
2569
2688
|
#
|
2570
2689
|
# @option params [required, String] :resource_arn
|
2571
2690
|
# The Amazon Resource Name (ARN) of the resource from which to delete
|
2572
|
-
# tags.
|
2691
|
+
# tags. Batch resources that support tags are compute environments,
|
2573
2692
|
# jobs, job definitions, and job queues. ARNs for child jobs of array
|
2574
2693
|
# and multi-node parallel (MNP) jobs are not supported.
|
2575
2694
|
#
|
@@ -2610,7 +2729,7 @@ module Aws::Batch
|
|
2610
2729
|
req.send_request(options)
|
2611
2730
|
end
|
2612
2731
|
|
2613
|
-
# Updates an
|
2732
|
+
# Updates an Batch compute environment.
|
2614
2733
|
#
|
2615
2734
|
# @option params [required, String] :compute_environment
|
2616
2735
|
# The name or full Amazon Resource Name (ARN) of the compute environment
|
@@ -2621,14 +2740,14 @@ module Aws::Batch
|
|
2621
2740
|
# `ENABLED` state can accept jobs from a queue and scale in or out
|
2622
2741
|
# automatically based on the workload demand of its associated queues.
|
2623
2742
|
#
|
2624
|
-
# If the state is `ENABLED`, then the
|
2743
|
+
# If the state is `ENABLED`, then the Batch scheduler can attempt to
|
2625
2744
|
# place jobs from an associated job queue on the compute resources
|
2626
2745
|
# within the environment. If the compute environment is managed, then it
|
2627
2746
|
# can scale its instances out or in automatically, based on the job
|
2628
2747
|
# queue demand.
|
2629
2748
|
#
|
2630
|
-
# If the state is `DISABLED`, then the
|
2631
|
-
#
|
2749
|
+
# If the state is `DISABLED`, then the Batch scheduler doesn't attempt
|
2750
|
+
# to place jobs within the environment. Jobs in a `STARTING` or
|
2632
2751
|
# `RUNNING` state continue to progress normally. Managed compute
|
2633
2752
|
# environments in the `DISABLED` state don't scale out. However, they
|
2634
2753
|
# scale in to `minvCpus` value after instances become idle.
|
@@ -2636,27 +2755,32 @@ module Aws::Batch
|
|
2636
2755
|
# @option params [Types::ComputeResourceUpdate] :compute_resources
|
2637
2756
|
# Details of the compute resources managed by the compute environment.
|
2638
2757
|
# Required for a managed compute environment. For more information, see
|
2639
|
-
# [Compute Environments][1] in the *
|
2758
|
+
# [Compute Environments][1] in the *Batch User Guide*.
|
2640
2759
|
#
|
2641
2760
|
#
|
2642
2761
|
#
|
2643
2762
|
# [1]: https://docs.aws.amazon.com/batch/latest/userguide/compute_environments.html
|
2644
2763
|
#
|
2645
2764
|
# @option params [String] :service_role
|
2646
|
-
# The full Amazon Resource Name (ARN) of the IAM role that allows
|
2647
|
-
#
|
2648
|
-
# information, see [
|
2765
|
+
# The full Amazon Resource Name (ARN) of the IAM role that allows Batch
|
2766
|
+
# to make calls to other Amazon Web Services services on your behalf.
|
2767
|
+
# For more information, see [Batch service IAM role][1] in the *Batch
|
2649
2768
|
# User Guide*.
|
2650
2769
|
#
|
2770
|
+
# If the compute environment has a service-linked role, it can't be
|
2771
|
+
# changed to use a regular IAM role. Likewise, if the compute
|
2772
|
+
# environment has a regular IAM role, it can't be changed to use a
|
2773
|
+
# service-linked role.
|
2774
|
+
#
|
2651
2775
|
# If your specified role has a path other than `/`, then you must either
|
2652
2776
|
# specify the full role ARN (this is recommended) or prefix the role
|
2653
2777
|
# name with the path.
|
2654
2778
|
#
|
2655
|
-
# <note markdown="1"> Depending on how you created your
|
2656
|
-
#
|
2657
|
-
#
|
2658
|
-
#
|
2659
|
-
#
|
2779
|
+
# <note markdown="1"> Depending on how you created your Batch service role, its ARN might
|
2780
|
+
# contain the `service-role` path prefix. When you only specify the name
|
2781
|
+
# of the service role, Batch assumes that your ARN doesn't use the
|
2782
|
+
# `service-role` path prefix. Because of this, we recommend that you
|
2783
|
+
# specify the full ARN of your service role when you create compute
|
2660
2784
|
# environments.
|
2661
2785
|
#
|
2662
2786
|
# </note>
|
@@ -2722,9 +2846,9 @@ module Aws::Batch
|
|
2722
2846
|
#
|
2723
2847
|
# @option params [String] :state
|
2724
2848
|
# Describes the queue's ability to accept new jobs. If the job queue
|
2725
|
-
# state is `ENABLED`, it
|
2726
|
-
#
|
2727
|
-
#
|
2849
|
+
# state is `ENABLED`, it can accept jobs. If the job queue state is
|
2850
|
+
# `DISABLED`, new jobs can't be added to the queue, but jobs already in
|
2851
|
+
# the queue can finish.
|
2728
2852
|
#
|
2729
2853
|
# @option params [Integer] :priority
|
2730
2854
|
# The priority of the job queue. Job queues with a higher priority (or a
|
@@ -2733,8 +2857,8 @@ module Aws::Batch
|
|
2733
2857
|
# determined in descending order, for example, a job queue with a
|
2734
2858
|
# priority value of `10` is given scheduling preference over a job queue
|
2735
2859
|
# 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
|
2860
|
+
# either EC2 (`EC2` or `SPOT`) or Fargate (`FARGATE` or `FARGATE_SPOT`).
|
2861
|
+
# EC2 and Fargate compute environments can't be mixed.
|
2738
2862
|
#
|
2739
2863
|
# @option params [Array<Types::ComputeEnvironmentOrder>] :compute_environment_order
|
2740
2864
|
# Details the set of compute environments mapped to a job queue and
|
@@ -2743,11 +2867,11 @@ module Aws::Batch
|
|
2743
2867
|
# a given job. Compute environments must be in the `VALID` state before
|
2744
2868
|
# you can associate them with a job queue. All of the compute
|
2745
2869
|
# environments must be either EC2 (`EC2` or `SPOT`) or Fargate
|
2746
|
-
# (`FARGATE` or `FARGATE_SPOT`)
|
2870
|
+
# (`FARGATE` or `FARGATE_SPOT`). EC2 and Fargate compute environments
|
2747
2871
|
# can't be mixed.
|
2748
2872
|
#
|
2749
2873
|
# <note markdown="1"> All compute environments that are associated with a job queue must
|
2750
|
-
# share the same architecture.
|
2874
|
+
# share the same architecture. Batch doesn't support mixing compute
|
2751
2875
|
# environment architecture types in a single job queue.
|
2752
2876
|
#
|
2753
2877
|
# </note>
|
@@ -2814,7 +2938,7 @@ module Aws::Batch
|
|
2814
2938
|
params: params,
|
2815
2939
|
config: config)
|
2816
2940
|
context[:gem_name] = 'aws-sdk-batch'
|
2817
|
-
context[:gem_version] = '1.
|
2941
|
+
context[:gem_version] = '1.49.0'
|
2818
2942
|
Seahorse::Client::Request.new(handlers, context)
|
2819
2943
|
end
|
2820
2944
|
|