aws-sdk-batch 1.47.0 → 1.48.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +5 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-batch.rb +1 -1
- data/lib/aws-sdk-batch/client.rb +165 -104
- data/lib/aws-sdk-batch/client_api.rb +10 -0
- data/lib/aws-sdk-batch/types.rb +461 -347
- metadata +3 -4
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: df92323fa97141cd442a82928218d9b9de310eec44e8d876e657e479a8e74d91
|
4
|
+
data.tar.gz: 8d30049c5f976e4cf1af76a5299cc8f33973da8b5666ea416643616eede71716
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 1dc774d2534e5f00b0a7c65f78757ac0c4f10cf6baee58fbb93d3a6b4e0987ccb71a55df55ce1e477306086cab705b08f0f15d9817d271fea984192278bf5002
|
7
|
+
data.tar.gz: 6e8510fa9e8d1608fca619f3346f5d34f45429c1b5e62d82448081a50e7890015e3867abc7b12774e7a29f2bd2603192c31c21dcfcee586271957c5c455e6cbc
|
data/CHANGELOG.md
CHANGED
data/VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
1.
|
1
|
+
1.48.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
|
@@ -1428,7 +1431,7 @@ module Aws::Batch
|
|
1428
1431
|
req.send_request(options)
|
1429
1432
|
end
|
1430
1433
|
|
1431
|
-
# Describes a list of
|
1434
|
+
# Describes a list of Batch jobs.
|
1432
1435
|
#
|
1433
1436
|
# @option params [required, Array<String>] :jobs
|
1434
1437
|
# A list of up to 100 job IDs.
|
@@ -1683,7 +1686,7 @@ module Aws::Batch
|
|
1683
1686
|
req.send_request(options)
|
1684
1687
|
end
|
1685
1688
|
|
1686
|
-
# Returns a list of
|
1689
|
+
# Returns a list of Batch jobs.
|
1687
1690
|
#
|
1688
1691
|
# You must specify only one of the following items:
|
1689
1692
|
#
|
@@ -1711,8 +1714,10 @@ module Aws::Batch
|
|
1711
1714
|
# associated with the specified job.
|
1712
1715
|
#
|
1713
1716
|
# @option params [String] :job_status
|
1714
|
-
# The job status used to filter jobs in the specified queue. If
|
1715
|
-
#
|
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.
|
1716
1721
|
#
|
1717
1722
|
# @option params [Integer] :max_results
|
1718
1723
|
# The maximum number of results returned by `ListJobs` in paginated
|
@@ -1737,6 +1742,54 @@ module Aws::Batch
|
|
1737
1742
|
#
|
1738
1743
|
# </note>
|
1739
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
|
+
#
|
1740
1793
|
# @return [Types::ListJobsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1741
1794
|
#
|
1742
1795
|
# * {Types::ListJobsResponse#job_summary_list #job_summary_list} => Array<Types::JobSummary>
|
@@ -1791,6 +1844,12 @@ module Aws::Batch
|
|
1791
1844
|
# job_status: "SUBMITTED", # accepts SUBMITTED, PENDING, RUNNABLE, STARTING, RUNNING, SUCCEEDED, FAILED
|
1792
1845
|
# max_results: 1,
|
1793
1846
|
# next_token: "String",
|
1847
|
+
# filters: [
|
1848
|
+
# {
|
1849
|
+
# name: "String",
|
1850
|
+
# values: ["String"],
|
1851
|
+
# },
|
1852
|
+
# ],
|
1794
1853
|
# })
|
1795
1854
|
#
|
1796
1855
|
# @example Response structure
|
@@ -1811,6 +1870,7 @@ module Aws::Batch
|
|
1811
1870
|
# resp.job_summary_list[0].node_properties.is_main_node #=> Boolean
|
1812
1871
|
# resp.job_summary_list[0].node_properties.num_nodes #=> Integer
|
1813
1872
|
# resp.job_summary_list[0].node_properties.node_index #=> Integer
|
1873
|
+
# resp.job_summary_list[0].job_definition #=> String
|
1814
1874
|
# resp.next_token #=> String
|
1815
1875
|
#
|
1816
1876
|
# @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/ListJobs AWS API Documentation
|
@@ -1822,14 +1882,14 @@ module Aws::Batch
|
|
1822
1882
|
req.send_request(options)
|
1823
1883
|
end
|
1824
1884
|
|
1825
|
-
# Lists the tags for an
|
1826
|
-
#
|
1827
|
-
#
|
1828
|
-
#
|
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.
|
1829
1889
|
#
|
1830
1890
|
# @option params [required, String] :resource_arn
|
1831
1891
|
# The Amazon Resource Name (ARN) that identifies the resource that tags
|
1832
|
-
# are listed for.
|
1892
|
+
# are listed for. Batch resources that support tags are compute
|
1833
1893
|
# environments, jobs, job definitions, and job queues. ARNs for child
|
1834
1894
|
# jobs of array and multi-node parallel (MNP) jobs are not supported.
|
1835
1895
|
#
|
@@ -1875,7 +1935,7 @@ module Aws::Batch
|
|
1875
1935
|
req.send_request(options)
|
1876
1936
|
end
|
1877
1937
|
|
1878
|
-
# Registers an
|
1938
|
+
# Registers an Batch job definition.
|
1879
1939
|
#
|
1880
1940
|
# @option params [required, String] :job_definition_name
|
1881
1941
|
# The name of the job definition to register. Up to 128 letters
|
@@ -1885,7 +1945,7 @@ module Aws::Batch
|
|
1885
1945
|
# @option params [required, String] :type
|
1886
1946
|
# The type of job definition. For more information about multi-node
|
1887
1947
|
# parallel jobs, see [Creating a multi-node parallel job definition][1]
|
1888
|
-
# in the *
|
1948
|
+
# in the *Batch User Guide*.
|
1889
1949
|
#
|
1890
1950
|
# <note markdown="1"> If the job is run on Fargate resources, then `multinode` isn't
|
1891
1951
|
# supported.
|
@@ -1917,9 +1977,9 @@ module Aws::Batch
|
|
1917
1977
|
# An object with various properties specific to multi-node parallel
|
1918
1978
|
# jobs. If you specify node properties for a job, it becomes a
|
1919
1979
|
# multi-node parallel job. For more information, see [Multi-node
|
1920
|
-
# Parallel Jobs][1] in the *
|
1921
|
-
#
|
1922
|
-
#
|
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`.
|
1923
1983
|
#
|
1924
1984
|
# <note markdown="1"> If the job runs on Fargate resources, then you must not specify
|
1925
1985
|
# `nodeProperties`; use `containerProperties` instead.
|
@@ -1947,12 +2007,12 @@ module Aws::Batch
|
|
1947
2007
|
#
|
1948
2008
|
# @option params [Types::JobTimeout] :timeout
|
1949
2009
|
# The timeout configuration for jobs that are submitted with this job
|
1950
|
-
# definition, after which
|
1951
|
-
#
|
1952
|
-
#
|
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
|
1953
2013
|
# configuration that's specified during a SubmitJob operation overrides
|
1954
2014
|
# the timeout configuration defined here. For more information, see [Job
|
1955
|
-
# Timeouts][1] in the *
|
2015
|
+
# Timeouts][1] in the *Batch User Guide*.
|
1956
2016
|
#
|
1957
2017
|
#
|
1958
2018
|
#
|
@@ -1961,8 +2021,8 @@ module Aws::Batch
|
|
1961
2021
|
# @option params [Hash<String,String>] :tags
|
1962
2022
|
# The tags that you apply to the job definition to help you categorize
|
1963
2023
|
# and organize your resources. Each tag consists of a key and an
|
1964
|
-
# optional value. For more information, see [Tagging
|
1965
|
-
# in *
|
2024
|
+
# optional value. For more information, see [Tagging Amazon Web Services
|
2025
|
+
# Resources][1] in *Batch User Guide*.
|
1966
2026
|
#
|
1967
2027
|
#
|
1968
2028
|
#
|
@@ -2287,7 +2347,7 @@ module Aws::Batch
|
|
2287
2347
|
req.send_request(options)
|
2288
2348
|
end
|
2289
2349
|
|
2290
|
-
# Submits an
|
2350
|
+
# Submits an Batch job from a job definition. Parameters that are
|
2291
2351
|
# specified during SubmitJob override parameters defined in the job
|
2292
2352
|
# definition. vCPU and memory requirements that are specified in the
|
2293
2353
|
# `ResourceRequirements` objects in the job definition are the
|
@@ -2313,7 +2373,7 @@ module Aws::Batch
|
|
2313
2373
|
# The array properties for the submitted job, such as the size of the
|
2314
2374
|
# array. The array size can be between 2 and 10,000. If you specify
|
2315
2375
|
# array properties for a job, it becomes an array job. For more
|
2316
|
-
# information, see [Array Jobs][1] in the *
|
2376
|
+
# information, see [Array Jobs][1] in the *Batch User Guide*.
|
2317
2377
|
#
|
2318
2378
|
#
|
2319
2379
|
#
|
@@ -2354,8 +2414,8 @@ module Aws::Batch
|
|
2354
2414
|
# A list of node overrides in JSON format that specify the node range to
|
2355
2415
|
# target and the container overrides for that node range.
|
2356
2416
|
#
|
2357
|
-
# <note markdown="1"> This parameter isn't applicable to jobs running on Fargate
|
2358
|
-
# use `containerOverrides` instead.
|
2417
|
+
# <note markdown="1"> This parameter isn't applicable to jobs that are running on Fargate
|
2418
|
+
# resources; use `containerOverrides` instead.
|
2359
2419
|
#
|
2360
2420
|
# </note>
|
2361
2421
|
#
|
@@ -2376,8 +2436,8 @@ module Aws::Batch
|
|
2376
2436
|
#
|
2377
2437
|
# @option params [Types::JobTimeout] :timeout
|
2378
2438
|
# The timeout configuration for this SubmitJob operation. You can
|
2379
|
-
# specify a timeout duration after which
|
2380
|
-
#
|
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
|
2381
2441
|
# isn't retried. The minimum value for the timeout is 60 seconds. This
|
2382
2442
|
# configuration overrides any timeout configuration specified in the job
|
2383
2443
|
# definition. For array jobs, child jobs have the same timeout
|
@@ -2392,8 +2452,8 @@ module Aws::Batch
|
|
2392
2452
|
# @option params [Hash<String,String>] :tags
|
2393
2453
|
# The tags that you apply to the job request to help you categorize and
|
2394
2454
|
# organize your resources. Each tag consists of a key and an optional
|
2395
|
-
# value. For more information, see [Tagging
|
2396
|
-
# General Reference*.
|
2455
|
+
# value. For more information, see [Tagging Amazon Web Services
|
2456
|
+
# Resources][1] in *Amazon Web Services General Reference*.
|
2397
2457
|
#
|
2398
2458
|
#
|
2399
2459
|
#
|
@@ -2522,22 +2582,22 @@ module Aws::Batch
|
|
2522
2582
|
# Associates the specified tags to a resource with the specified
|
2523
2583
|
# `resourceArn`. If existing tags on a resource aren't specified in the
|
2524
2584
|
# request parameters, they aren't changed. When a resource is deleted,
|
2525
|
-
# the tags associated with that resource are deleted as well.
|
2526
|
-
# 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
|
2527
2587
|
# definitions, and job queues. ARNs for child jobs of array and
|
2528
2588
|
# multi-node parallel (MNP) jobs are not supported.
|
2529
2589
|
#
|
2530
2590
|
# @option params [required, String] :resource_arn
|
2531
2591
|
# The Amazon Resource Name (ARN) of the resource that tags are added to.
|
2532
|
-
#
|
2533
|
-
#
|
2592
|
+
# Batch resources that support tags are compute environments, jobs, job
|
2593
|
+
# definitions, and job queues. ARNs for child jobs of array and
|
2534
2594
|
# multi-node parallel (MNP) jobs are not supported.
|
2535
2595
|
#
|
2536
2596
|
# @option params [required, Hash<String,String>] :tags
|
2537
2597
|
# The tags that you apply to the resource to help you categorize and
|
2538
2598
|
# organize your resources. Each tag consists of a key and an optional
|
2539
|
-
# value. For more information, see [Tagging
|
2540
|
-
# General Reference*.
|
2599
|
+
# value. For more information, see [Tagging Amazon Web Services
|
2600
|
+
# Resources][1] in *Amazon Web Services General Reference*.
|
2541
2601
|
#
|
2542
2602
|
#
|
2543
2603
|
#
|
@@ -2585,12 +2645,12 @@ module Aws::Batch
|
|
2585
2645
|
# cancelled.
|
2586
2646
|
#
|
2587
2647
|
# @option params [required, String] :job_id
|
2588
|
-
# The
|
2648
|
+
# The Batch job ID of the job to terminate.
|
2589
2649
|
#
|
2590
2650
|
# @option params [required, String] :reason
|
2591
2651
|
# A message to attach to the job that explains the reason for canceling
|
2592
2652
|
# it. This message is returned by future DescribeJobs operations on the
|
2593
|
-
# job. This message is also recorded in the
|
2653
|
+
# job. This message is also recorded in the Batch activity logs.
|
2594
2654
|
#
|
2595
2655
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
2596
2656
|
#
|
@@ -2624,11 +2684,11 @@ module Aws::Batch
|
|
2624
2684
|
req.send_request(options)
|
2625
2685
|
end
|
2626
2686
|
|
2627
|
-
# Deletes specified tags from an
|
2687
|
+
# Deletes specified tags from an Batch resource.
|
2628
2688
|
#
|
2629
2689
|
# @option params [required, String] :resource_arn
|
2630
2690
|
# The Amazon Resource Name (ARN) of the resource from which to delete
|
2631
|
-
# tags.
|
2691
|
+
# tags. Batch resources that support tags are compute environments,
|
2632
2692
|
# jobs, job definitions, and job queues. ARNs for child jobs of array
|
2633
2693
|
# and multi-node parallel (MNP) jobs are not supported.
|
2634
2694
|
#
|
@@ -2669,7 +2729,7 @@ module Aws::Batch
|
|
2669
2729
|
req.send_request(options)
|
2670
2730
|
end
|
2671
2731
|
|
2672
|
-
# Updates an
|
2732
|
+
# Updates an Batch compute environment.
|
2673
2733
|
#
|
2674
2734
|
# @option params [required, String] :compute_environment
|
2675
2735
|
# The name or full Amazon Resource Name (ARN) of the compute environment
|
@@ -2680,14 +2740,14 @@ module Aws::Batch
|
|
2680
2740
|
# `ENABLED` state can accept jobs from a queue and scale in or out
|
2681
2741
|
# automatically based on the workload demand of its associated queues.
|
2682
2742
|
#
|
2683
|
-
# If the state is `ENABLED`, then the
|
2743
|
+
# If the state is `ENABLED`, then the Batch scheduler can attempt to
|
2684
2744
|
# place jobs from an associated job queue on the compute resources
|
2685
2745
|
# within the environment. If the compute environment is managed, then it
|
2686
2746
|
# can scale its instances out or in automatically, based on the job
|
2687
2747
|
# queue demand.
|
2688
2748
|
#
|
2689
|
-
# If the state is `DISABLED`, then the
|
2690
|
-
#
|
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
|
2691
2751
|
# `RUNNING` state continue to progress normally. Managed compute
|
2692
2752
|
# environments in the `DISABLED` state don't scale out. However, they
|
2693
2753
|
# scale in to `minvCpus` value after instances become idle.
|
@@ -2695,31 +2755,32 @@ module Aws::Batch
|
|
2695
2755
|
# @option params [Types::ComputeResourceUpdate] :compute_resources
|
2696
2756
|
# Details of the compute resources managed by the compute environment.
|
2697
2757
|
# Required for a managed compute environment. For more information, see
|
2698
|
-
# [Compute Environments][1] in the *
|
2758
|
+
# [Compute Environments][1] in the *Batch User Guide*.
|
2699
2759
|
#
|
2700
2760
|
#
|
2701
2761
|
#
|
2702
2762
|
# [1]: https://docs.aws.amazon.com/batch/latest/userguide/compute_environments.html
|
2703
2763
|
#
|
2704
2764
|
# @option params [String] :service_role
|
2705
|
-
# The full Amazon Resource Name (ARN) of the IAM role that allows
|
2706
|
-
#
|
2707
|
-
# 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
|
2708
2768
|
# User Guide*.
|
2709
2769
|
#
|
2710
|
-
# If the compute environment has a service-linked role, it
|
2711
|
-
# changed to use a regular IAM role.
|
2712
|
-
# regular IAM role, it
|
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.
|
2713
2774
|
#
|
2714
2775
|
# If your specified role has a path other than `/`, then you must either
|
2715
2776
|
# specify the full role ARN (this is recommended) or prefix the role
|
2716
2777
|
# name with the path.
|
2717
2778
|
#
|
2718
|
-
# <note markdown="1"> Depending on how you created your
|
2719
|
-
#
|
2720
|
-
#
|
2721
|
-
#
|
2722
|
-
#
|
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
|
2723
2784
|
# environments.
|
2724
2785
|
#
|
2725
2786
|
# </note>
|
@@ -2810,7 +2871,7 @@ module Aws::Batch
|
|
2810
2871
|
# can't be mixed.
|
2811
2872
|
#
|
2812
2873
|
# <note markdown="1"> All compute environments that are associated with a job queue must
|
2813
|
-
# share the same architecture.
|
2874
|
+
# share the same architecture. Batch doesn't support mixing compute
|
2814
2875
|
# environment architecture types in a single job queue.
|
2815
2876
|
#
|
2816
2877
|
# </note>
|
@@ -2877,7 +2938,7 @@ module Aws::Batch
|
|
2877
2938
|
params: params,
|
2878
2939
|
config: config)
|
2879
2940
|
context[:gem_name] = 'aws-sdk-batch'
|
2880
|
-
context[:gem_version] = '1.
|
2941
|
+
context[:gem_version] = '1.48.0'
|
2881
2942
|
Seahorse::Client::Request.new(handlers, context)
|
2882
2943
|
end
|
2883
2944
|
|