aws-sdk-batch 1.46.0 → 1.50.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- 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 +210 -101
- data/lib/aws-sdk-batch/client_api.rb +26 -0
- data/lib/aws-sdk-batch/types.rb +653 -322
- 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: 23d1e9eff2d94fc5b287dd12548e05cbea1bdd8334a687ccdcf0b10229b3cef5
|
4
|
+
data.tar.gz: b465e3921154300044e48b9870bf846263fd52c2a99e2a7fe93927b9b42436e8
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 51fedc4f0ef5d81eaabd1dd172bd55c49a195d1b10cd347bd090b65867fcfaba56d19b5cf4adbb76f5a8c85d160efb2d1b1a393c37237b13faaa297a3144be38
|
7
|
+
data.tar.gz: 658684f18c6e2adb7074aefa6dc49086b5abaa1c5d95965c27c254fdfe178213d344aedbc8df5d86367b43aa7fc3a710381da63722050bad039cc1c4691896d2
|
data/CHANGELOG.md
CHANGED
@@ -1,6 +1,26 @@
|
|
1
1
|
Unreleased Changes
|
2
2
|
------------------
|
3
3
|
|
4
|
+
1.50.0 (2021-07-30)
|
5
|
+
------------------
|
6
|
+
|
7
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
8
|
+
|
9
|
+
1.49.0 (2021-07-28)
|
10
|
+
------------------
|
11
|
+
|
12
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
13
|
+
|
14
|
+
1.48.0 (2021-07-27)
|
15
|
+
------------------
|
16
|
+
|
17
|
+
* Feature - Add support for ListJob filters
|
18
|
+
|
19
|
+
1.47.0 (2021-03-31)
|
20
|
+
------------------
|
21
|
+
|
22
|
+
* Feature - AWS Batch adds support for Amazon EFS File System
|
23
|
+
|
4
24
|
1.46.0 (2021-03-17)
|
5
25
|
------------------
|
6
26
|
|
data/VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
1.
|
1
|
+
1.50.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,12 +373,12 @@ 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
|
@@ -405,14 +405,13 @@ module Aws::Batch
|
|
405
405
|
# [Launching an Amazon ECS container instance][3] in the *Amazon Elastic
|
406
406
|
# Container Service Developer Guide*.
|
407
407
|
#
|
408
|
-
# <note markdown="1">
|
408
|
+
# <note markdown="1"> Batch doesn't upgrade the AMIs in a compute environment after the
|
409
409
|
# environment is created. For example, it doesn't update the AMIs when
|
410
410
|
# a newer version of the Amazon ECS optimized AMI is available.
|
411
411
|
# Therefore, you're responsible for managing the guest operating system
|
412
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,23 +463,24 @@ 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
472
|
# @option params [String] :service_role
|
474
|
-
# The full Amazon Resource Name (ARN) of the IAM role that allows
|
475
|
-
#
|
476
|
-
# information, see [
|
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 account
|
480
|
-
#
|
481
|
-
# specify a role here. If the
|
482
|
-
# exist in your account, and no role is specified here, the
|
483
|
-
#
|
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
484
|
#
|
485
485
|
# If your specified role has a path other than `/`, then you must
|
486
486
|
# specify either the full role ARN (recommended) or prefix the role name
|
@@ -489,11 +489,11 @@ module Aws::Batch
|
|
489
489
|
# more information, see [Friendly names and paths][2] in the *IAM User
|
490
490
|
# Guide*.
|
491
491
|
#
|
492
|
-
# <note markdown="1"> Depending on how you created your
|
493
|
-
#
|
494
|
-
#
|
495
|
-
#
|
496
|
-
#
|
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
|
497
497
|
# environments.
|
498
498
|
#
|
499
499
|
# </note>
|
@@ -506,8 +506,8 @@ module Aws::Batch
|
|
506
506
|
# @option params [Hash<String,String>] :tags
|
507
507
|
# The tags that you apply to the compute environment to help you
|
508
508
|
# categorize and organize your resources. Each tag consists of a key and
|
509
|
-
# an optional value. For more information, see [Tagging
|
510
|
-
# Resources][1] in *
|
509
|
+
# an optional value. For more information, see [Tagging Amazon Web
|
510
|
+
# Services Resources][1] in *Amazon Web Services General Reference*.
|
511
511
|
#
|
512
512
|
# These tags can be updated or removed using the [TagResource][2] and
|
513
513
|
# [UntagResource][3] API operations. These tags don't propagate to the
|
@@ -667,12 +667,12 @@ module Aws::Batch
|
|
667
667
|
req.send_request(options)
|
668
668
|
end
|
669
669
|
|
670
|
-
# Creates an
|
671
|
-
#
|
672
|
-
#
|
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.
|
673
673
|
#
|
674
674
|
# You also set a priority to the job queue that determines the order
|
675
|
-
# that the
|
675
|
+
# that the Batch scheduler places jobs onto its associated compute
|
676
676
|
# environments. For example, if a compute environment is associated with
|
677
677
|
# more than one job queue, the job queue with a higher priority is given
|
678
678
|
# preference for scheduling jobs to that compute environment.
|
@@ -695,7 +695,7 @@ module Aws::Batch
|
|
695
695
|
# priority value of `10` is given scheduling preference over a job queue
|
696
696
|
# with a priority value of `1`. All of the compute environments must be
|
697
697
|
# either EC2 (`EC2` or `SPOT`) or Fargate (`FARGATE` or `FARGATE_SPOT`);
|
698
|
-
# EC2 and Fargate compute environments
|
698
|
+
# EC2 and Fargate compute environments can't be mixed.
|
699
699
|
#
|
700
700
|
# @option params [required, Array<Types::ComputeEnvironmentOrder>] :compute_environment_order
|
701
701
|
# The set of compute environments mapped to a job queue and their order
|
@@ -708,7 +708,7 @@ module Aws::Batch
|
|
708
708
|
# EC2 and Fargate compute environments can't be mixed.
|
709
709
|
#
|
710
710
|
# <note markdown="1"> All compute environments that are associated with a job queue must
|
711
|
-
# share the same architecture.
|
711
|
+
# share the same architecture. Batch doesn't support mixing compute
|
712
712
|
# environment architecture types in a single job queue.
|
713
713
|
#
|
714
714
|
# </note>
|
@@ -716,8 +716,8 @@ module Aws::Batch
|
|
716
716
|
# @option params [Hash<String,String>] :tags
|
717
717
|
# The tags that you apply to the job queue to help you categorize and
|
718
718
|
# organize your resources. Each tag consists of a key and an optional
|
719
|
-
# value. For more information, see [Tagging your
|
720
|
-
#
|
719
|
+
# value. For more information, see [Tagging your Batch resources][1] in
|
720
|
+
# *Batch User Guide*.
|
721
721
|
#
|
722
722
|
#
|
723
723
|
#
|
@@ -809,12 +809,12 @@ module Aws::Batch
|
|
809
809
|
req.send_request(options)
|
810
810
|
end
|
811
811
|
|
812
|
-
# Deletes an
|
812
|
+
# Deletes an Batch compute environment.
|
813
813
|
#
|
814
814
|
# Before you can delete a compute environment, you must set its state to
|
815
815
|
# `DISABLED` with the UpdateComputeEnvironment API operation and
|
816
816
|
# disassociate it from any job queues with the UpdateJobQueue API
|
817
|
-
# operation. Compute environments that use
|
817
|
+
# operation. Compute environments that use Fargate resources must
|
818
818
|
# terminate all active jobs on that compute environment before deleting
|
819
819
|
# the compute environment. If this isn't done, the compute environment
|
820
820
|
# enters an invalid state.
|
@@ -895,8 +895,8 @@ module Aws::Batch
|
|
895
895
|
req.send_request(options)
|
896
896
|
end
|
897
897
|
|
898
|
-
# Deregisters an
|
899
|
-
#
|
898
|
+
# Deregisters an Batch job definition. Job definitions are permanently
|
899
|
+
# deleted after 180 days.
|
900
900
|
#
|
901
901
|
# @option params [required, String] :job_definition
|
902
902
|
# The name and revision (`name:revision`) or full Amazon Resource Name
|
@@ -1084,8 +1084,11 @@ module Aws::Batch
|
|
1084
1084
|
# as `ACTIVE`) to only return job definitions that match that status.
|
1085
1085
|
#
|
1086
1086
|
# @option params [Array<String>] :job_definitions
|
1087
|
-
# A list of up to 100 job
|
1088
|
-
#
|
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\}`.
|
1089
1092
|
#
|
1090
1093
|
# @option params [Integer] :max_results
|
1091
1094
|
# The maximum number of results returned by `DescribeJobDefinitions` in
|
@@ -1199,6 +1202,12 @@ module Aws::Batch
|
|
1199
1202
|
# resp.job_definitions[0].container_properties.volumes #=> Array
|
1200
1203
|
# resp.job_definitions[0].container_properties.volumes[0].host.source_path #=> String
|
1201
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"
|
1202
1211
|
# resp.job_definitions[0].container_properties.environment #=> Array
|
1203
1212
|
# resp.job_definitions[0].container_properties.environment[0].name #=> String
|
1204
1213
|
# resp.job_definitions[0].container_properties.environment[0].value #=> String
|
@@ -1257,6 +1266,12 @@ module Aws::Batch
|
|
1257
1266
|
# resp.job_definitions[0].node_properties.node_range_properties[0].container.volumes #=> Array
|
1258
1267
|
# resp.job_definitions[0].node_properties.node_range_properties[0].container.volumes[0].host.source_path #=> String
|
1259
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"
|
1260
1275
|
# resp.job_definitions[0].node_properties.node_range_properties[0].container.environment #=> Array
|
1261
1276
|
# resp.job_definitions[0].node_properties.node_range_properties[0].container.environment[0].name #=> String
|
1262
1277
|
# resp.job_definitions[0].node_properties.node_range_properties[0].container.environment[0].value #=> String
|
@@ -1416,7 +1431,7 @@ module Aws::Batch
|
|
1416
1431
|
req.send_request(options)
|
1417
1432
|
end
|
1418
1433
|
|
1419
|
-
# Describes a list of
|
1434
|
+
# Describes a list of Batch jobs.
|
1420
1435
|
#
|
1421
1436
|
# @option params [required, Array<String>] :jobs
|
1422
1437
|
# A list of up to 100 job IDs.
|
@@ -1528,6 +1543,12 @@ module Aws::Batch
|
|
1528
1543
|
# resp.jobs[0].container.volumes #=> Array
|
1529
1544
|
# resp.jobs[0].container.volumes[0].host.source_path #=> String
|
1530
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"
|
1531
1552
|
# resp.jobs[0].container.environment #=> Array
|
1532
1553
|
# resp.jobs[0].container.environment[0].name #=> String
|
1533
1554
|
# resp.jobs[0].container.environment[0].value #=> String
|
@@ -1596,6 +1617,12 @@ module Aws::Batch
|
|
1596
1617
|
# resp.jobs[0].node_properties.node_range_properties[0].container.volumes #=> Array
|
1597
1618
|
# resp.jobs[0].node_properties.node_range_properties[0].container.volumes[0].host.source_path #=> String
|
1598
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"
|
1599
1626
|
# resp.jobs[0].node_properties.node_range_properties[0].container.environment #=> Array
|
1600
1627
|
# resp.jobs[0].node_properties.node_range_properties[0].container.environment[0].name #=> String
|
1601
1628
|
# resp.jobs[0].node_properties.node_range_properties[0].container.environment[0].value #=> String
|
@@ -1659,7 +1686,7 @@ module Aws::Batch
|
|
1659
1686
|
req.send_request(options)
|
1660
1687
|
end
|
1661
1688
|
|
1662
|
-
# Returns a list of
|
1689
|
+
# Returns a list of Batch jobs.
|
1663
1690
|
#
|
1664
1691
|
# You must specify only one of the following items:
|
1665
1692
|
#
|
@@ -1687,8 +1714,10 @@ module Aws::Batch
|
|
1687
1714
|
# associated with the specified job.
|
1688
1715
|
#
|
1689
1716
|
# @option params [String] :job_status
|
1690
|
-
# The job status used to filter jobs in the specified queue. If
|
1691
|
-
#
|
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.
|
1692
1721
|
#
|
1693
1722
|
# @option params [Integer] :max_results
|
1694
1723
|
# The maximum number of results returned by `ListJobs` in paginated
|
@@ -1713,6 +1742,54 @@ module Aws::Batch
|
|
1713
1742
|
#
|
1714
1743
|
# </note>
|
1715
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
|
+
#
|
1716
1793
|
# @return [Types::ListJobsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1717
1794
|
#
|
1718
1795
|
# * {Types::ListJobsResponse#job_summary_list #job_summary_list} => Array<Types::JobSummary>
|
@@ -1767,6 +1844,12 @@ module Aws::Batch
|
|
1767
1844
|
# job_status: "SUBMITTED", # accepts SUBMITTED, PENDING, RUNNABLE, STARTING, RUNNING, SUCCEEDED, FAILED
|
1768
1845
|
# max_results: 1,
|
1769
1846
|
# next_token: "String",
|
1847
|
+
# filters: [
|
1848
|
+
# {
|
1849
|
+
# name: "String",
|
1850
|
+
# values: ["String"],
|
1851
|
+
# },
|
1852
|
+
# ],
|
1770
1853
|
# })
|
1771
1854
|
#
|
1772
1855
|
# @example Response structure
|
@@ -1787,6 +1870,7 @@ module Aws::Batch
|
|
1787
1870
|
# resp.job_summary_list[0].node_properties.is_main_node #=> Boolean
|
1788
1871
|
# resp.job_summary_list[0].node_properties.num_nodes #=> Integer
|
1789
1872
|
# resp.job_summary_list[0].node_properties.node_index #=> Integer
|
1873
|
+
# resp.job_summary_list[0].job_definition #=> String
|
1790
1874
|
# resp.next_token #=> String
|
1791
1875
|
#
|
1792
1876
|
# @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/ListJobs AWS API Documentation
|
@@ -1798,14 +1882,14 @@ module Aws::Batch
|
|
1798
1882
|
req.send_request(options)
|
1799
1883
|
end
|
1800
1884
|
|
1801
|
-
# Lists the tags for an
|
1802
|
-
#
|
1803
|
-
#
|
1804
|
-
#
|
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.
|
1805
1889
|
#
|
1806
1890
|
# @option params [required, String] :resource_arn
|
1807
1891
|
# The Amazon Resource Name (ARN) that identifies the resource that tags
|
1808
|
-
# are listed for.
|
1892
|
+
# are listed for. Batch resources that support tags are compute
|
1809
1893
|
# environments, jobs, job definitions, and job queues. ARNs for child
|
1810
1894
|
# jobs of array and multi-node parallel (MNP) jobs are not supported.
|
1811
1895
|
#
|
@@ -1851,7 +1935,7 @@ module Aws::Batch
|
|
1851
1935
|
req.send_request(options)
|
1852
1936
|
end
|
1853
1937
|
|
1854
|
-
# Registers an
|
1938
|
+
# Registers an Batch job definition.
|
1855
1939
|
#
|
1856
1940
|
# @option params [required, String] :job_definition_name
|
1857
1941
|
# The name of the job definition to register. Up to 128 letters
|
@@ -1861,7 +1945,7 @@ module Aws::Batch
|
|
1861
1945
|
# @option params [required, String] :type
|
1862
1946
|
# The type of job definition. For more information about multi-node
|
1863
1947
|
# parallel jobs, see [Creating a multi-node parallel job definition][1]
|
1864
|
-
# in the *
|
1948
|
+
# in the *Batch User Guide*.
|
1865
1949
|
#
|
1866
1950
|
# <note markdown="1"> If the job is run on Fargate resources, then `multinode` isn't
|
1867
1951
|
# supported.
|
@@ -1893,9 +1977,9 @@ module Aws::Batch
|
|
1893
1977
|
# An object with various properties specific to multi-node parallel
|
1894
1978
|
# jobs. If you specify node properties for a job, it becomes a
|
1895
1979
|
# multi-node parallel job. For more information, see [Multi-node
|
1896
|
-
# Parallel Jobs][1] in the *
|
1897
|
-
#
|
1898
|
-
#
|
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`.
|
1899
1983
|
#
|
1900
1984
|
# <note markdown="1"> If the job runs on Fargate resources, then you must not specify
|
1901
1985
|
# `nodeProperties`; use `containerProperties` instead.
|
@@ -1923,12 +2007,12 @@ module Aws::Batch
|
|
1923
2007
|
#
|
1924
2008
|
# @option params [Types::JobTimeout] :timeout
|
1925
2009
|
# The timeout configuration for jobs that are submitted with this job
|
1926
|
-
# definition, after which
|
1927
|
-
#
|
1928
|
-
#
|
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
|
1929
2013
|
# configuration that's specified during a SubmitJob operation overrides
|
1930
2014
|
# the timeout configuration defined here. For more information, see [Job
|
1931
|
-
# Timeouts][1] in the *
|
2015
|
+
# Timeouts][1] in the *Batch User Guide*.
|
1932
2016
|
#
|
1933
2017
|
#
|
1934
2018
|
#
|
@@ -1937,8 +2021,8 @@ module Aws::Batch
|
|
1937
2021
|
# @option params [Hash<String,String>] :tags
|
1938
2022
|
# The tags that you apply to the job definition to help you categorize
|
1939
2023
|
# and organize your resources. Each tag consists of a key and an
|
1940
|
-
# optional value. For more information, see [Tagging
|
1941
|
-
# in *
|
2024
|
+
# optional value. For more information, see [Tagging Amazon Web Services
|
2025
|
+
# Resources][1] in *Batch User Guide*.
|
1942
2026
|
#
|
1943
2027
|
#
|
1944
2028
|
#
|
@@ -2031,6 +2115,16 @@ module Aws::Batch
|
|
2031
2115
|
# source_path: "String",
|
2032
2116
|
# },
|
2033
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
|
+
# },
|
2034
2128
|
# },
|
2035
2129
|
# ],
|
2036
2130
|
# environment: [
|
@@ -2127,6 +2221,16 @@ module Aws::Batch
|
|
2127
2221
|
# source_path: "String",
|
2128
2222
|
# },
|
2129
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
|
+
# },
|
2130
2234
|
# },
|
2131
2235
|
# ],
|
2132
2236
|
# environment: [
|
@@ -2243,7 +2347,7 @@ module Aws::Batch
|
|
2243
2347
|
req.send_request(options)
|
2244
2348
|
end
|
2245
2349
|
|
2246
|
-
# Submits an
|
2350
|
+
# Submits an Batch job from a job definition. Parameters that are
|
2247
2351
|
# specified during SubmitJob override parameters defined in the job
|
2248
2352
|
# definition. vCPU and memory requirements that are specified in the
|
2249
2353
|
# `ResourceRequirements` objects in the job definition are the
|
@@ -2269,7 +2373,7 @@ module Aws::Batch
|
|
2269
2373
|
# The array properties for the submitted job, such as the size of the
|
2270
2374
|
# array. The array size can be between 2 and 10,000. If you specify
|
2271
2375
|
# array properties for a job, it becomes an array job. For more
|
2272
|
-
# information, see [Array Jobs][1] in the *
|
2376
|
+
# information, see [Array Jobs][1] in the *Batch User Guide*.
|
2273
2377
|
#
|
2274
2378
|
#
|
2275
2379
|
#
|
@@ -2310,8 +2414,8 @@ module Aws::Batch
|
|
2310
2414
|
# A list of node overrides in JSON format that specify the node range to
|
2311
2415
|
# target and the container overrides for that node range.
|
2312
2416
|
#
|
2313
|
-
# <note markdown="1"> This parameter isn't applicable to jobs running on Fargate
|
2314
|
-
# use `containerOverrides` instead.
|
2417
|
+
# <note markdown="1"> This parameter isn't applicable to jobs that are running on Fargate
|
2418
|
+
# resources; use `containerOverrides` instead.
|
2315
2419
|
#
|
2316
2420
|
# </note>
|
2317
2421
|
#
|
@@ -2332,8 +2436,8 @@ module Aws::Batch
|
|
2332
2436
|
#
|
2333
2437
|
# @option params [Types::JobTimeout] :timeout
|
2334
2438
|
# The timeout configuration for this SubmitJob operation. You can
|
2335
|
-
# specify a timeout duration after which
|
2336
|
-
#
|
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
|
2337
2441
|
# isn't retried. The minimum value for the timeout is 60 seconds. This
|
2338
2442
|
# configuration overrides any timeout configuration specified in the job
|
2339
2443
|
# definition. For array jobs, child jobs have the same timeout
|
@@ -2348,8 +2452,8 @@ module Aws::Batch
|
|
2348
2452
|
# @option params [Hash<String,String>] :tags
|
2349
2453
|
# The tags that you apply to the job request to help you categorize and
|
2350
2454
|
# organize your resources. Each tag consists of a key and an optional
|
2351
|
-
# value. For more information, see [Tagging
|
2352
|
-
# General Reference*.
|
2455
|
+
# value. For more information, see [Tagging Amazon Web Services
|
2456
|
+
# Resources][1] in *Amazon Web Services General Reference*.
|
2353
2457
|
#
|
2354
2458
|
#
|
2355
2459
|
#
|
@@ -2478,22 +2582,22 @@ module Aws::Batch
|
|
2478
2582
|
# Associates the specified tags to a resource with the specified
|
2479
2583
|
# `resourceArn`. If existing tags on a resource aren't specified in the
|
2480
2584
|
# request parameters, they aren't changed. When a resource is deleted,
|
2481
|
-
# the tags associated with that resource are deleted as well.
|
2482
|
-
# 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
|
2483
2587
|
# definitions, and job queues. ARNs for child jobs of array and
|
2484
2588
|
# multi-node parallel (MNP) jobs are not supported.
|
2485
2589
|
#
|
2486
2590
|
# @option params [required, String] :resource_arn
|
2487
2591
|
# The Amazon Resource Name (ARN) of the resource that tags are added to.
|
2488
|
-
#
|
2489
|
-
#
|
2592
|
+
# Batch resources that support tags are compute environments, jobs, job
|
2593
|
+
# definitions, and job queues. ARNs for child jobs of array and
|
2490
2594
|
# multi-node parallel (MNP) jobs are not supported.
|
2491
2595
|
#
|
2492
2596
|
# @option params [required, Hash<String,String>] :tags
|
2493
2597
|
# The tags that you apply to the resource to help you categorize and
|
2494
2598
|
# organize your resources. Each tag consists of a key and an optional
|
2495
|
-
# value. For more information, see [Tagging
|
2496
|
-
# General Reference*.
|
2599
|
+
# value. For more information, see [Tagging Amazon Web Services
|
2600
|
+
# Resources][1] in *Amazon Web Services General Reference*.
|
2497
2601
|
#
|
2498
2602
|
#
|
2499
2603
|
#
|
@@ -2541,12 +2645,12 @@ module Aws::Batch
|
|
2541
2645
|
# cancelled.
|
2542
2646
|
#
|
2543
2647
|
# @option params [required, String] :job_id
|
2544
|
-
# The
|
2648
|
+
# The Batch job ID of the job to terminate.
|
2545
2649
|
#
|
2546
2650
|
# @option params [required, String] :reason
|
2547
2651
|
# A message to attach to the job that explains the reason for canceling
|
2548
2652
|
# it. This message is returned by future DescribeJobs operations on the
|
2549
|
-
# job. This message is also recorded in the
|
2653
|
+
# job. This message is also recorded in the Batch activity logs.
|
2550
2654
|
#
|
2551
2655
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
2552
2656
|
#
|
@@ -2580,11 +2684,11 @@ module Aws::Batch
|
|
2580
2684
|
req.send_request(options)
|
2581
2685
|
end
|
2582
2686
|
|
2583
|
-
# Deletes specified tags from an
|
2687
|
+
# Deletes specified tags from an Batch resource.
|
2584
2688
|
#
|
2585
2689
|
# @option params [required, String] :resource_arn
|
2586
2690
|
# The Amazon Resource Name (ARN) of the resource from which to delete
|
2587
|
-
# tags.
|
2691
|
+
# tags. Batch resources that support tags are compute environments,
|
2588
2692
|
# jobs, job definitions, and job queues. ARNs for child jobs of array
|
2589
2693
|
# and multi-node parallel (MNP) jobs are not supported.
|
2590
2694
|
#
|
@@ -2625,7 +2729,7 @@ module Aws::Batch
|
|
2625
2729
|
req.send_request(options)
|
2626
2730
|
end
|
2627
2731
|
|
2628
|
-
# Updates an
|
2732
|
+
# Updates an Batch compute environment.
|
2629
2733
|
#
|
2630
2734
|
# @option params [required, String] :compute_environment
|
2631
2735
|
# The name or full Amazon Resource Name (ARN) of the compute environment
|
@@ -2636,14 +2740,14 @@ module Aws::Batch
|
|
2636
2740
|
# `ENABLED` state can accept jobs from a queue and scale in or out
|
2637
2741
|
# automatically based on the workload demand of its associated queues.
|
2638
2742
|
#
|
2639
|
-
# If the state is `ENABLED`, then the
|
2743
|
+
# If the state is `ENABLED`, then the Batch scheduler can attempt to
|
2640
2744
|
# place jobs from an associated job queue on the compute resources
|
2641
2745
|
# within the environment. If the compute environment is managed, then it
|
2642
2746
|
# can scale its instances out or in automatically, based on the job
|
2643
2747
|
# queue demand.
|
2644
2748
|
#
|
2645
|
-
# If the state is `DISABLED`, then the
|
2646
|
-
#
|
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
|
2647
2751
|
# `RUNNING` state continue to progress normally. Managed compute
|
2648
2752
|
# environments in the `DISABLED` state don't scale out. However, they
|
2649
2753
|
# scale in to `minvCpus` value after instances become idle.
|
@@ -2651,27 +2755,32 @@ module Aws::Batch
|
|
2651
2755
|
# @option params [Types::ComputeResourceUpdate] :compute_resources
|
2652
2756
|
# Details of the compute resources managed by the compute environment.
|
2653
2757
|
# Required for a managed compute environment. For more information, see
|
2654
|
-
# [Compute Environments][1] in the *
|
2758
|
+
# [Compute Environments][1] in the *Batch User Guide*.
|
2655
2759
|
#
|
2656
2760
|
#
|
2657
2761
|
#
|
2658
2762
|
# [1]: https://docs.aws.amazon.com/batch/latest/userguide/compute_environments.html
|
2659
2763
|
#
|
2660
2764
|
# @option params [String] :service_role
|
2661
|
-
# The full Amazon Resource Name (ARN) of the IAM role that allows
|
2662
|
-
#
|
2663
|
-
# 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
|
2664
2768
|
# User Guide*.
|
2665
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
|
+
#
|
2666
2775
|
# If your specified role has a path other than `/`, then you must either
|
2667
2776
|
# specify the full role ARN (this is recommended) or prefix the role
|
2668
2777
|
# name with the path.
|
2669
2778
|
#
|
2670
|
-
# <note markdown="1"> Depending on how you created your
|
2671
|
-
#
|
2672
|
-
#
|
2673
|
-
#
|
2674
|
-
#
|
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
|
2675
2784
|
# environments.
|
2676
2785
|
#
|
2677
2786
|
# </note>
|
@@ -2762,7 +2871,7 @@ module Aws::Batch
|
|
2762
2871
|
# can't be mixed.
|
2763
2872
|
#
|
2764
2873
|
# <note markdown="1"> All compute environments that are associated with a job queue must
|
2765
|
-
# share the same architecture.
|
2874
|
+
# share the same architecture. Batch doesn't support mixing compute
|
2766
2875
|
# environment architecture types in a single job queue.
|
2767
2876
|
#
|
2768
2877
|
# </note>
|
@@ -2829,7 +2938,7 @@ module Aws::Batch
|
|
2829
2938
|
params: params,
|
2830
2939
|
config: config)
|
2831
2940
|
context[:gem_name] = 'aws-sdk-batch'
|
2832
|
-
context[:gem_version] = '1.
|
2941
|
+
context[:gem_version] = '1.50.0'
|
2833
2942
|
Seahorse::Client::Request.new(handlers, context)
|
2834
2943
|
end
|
2835
2944
|
|