aws-sdk-batch 1.50.0 → 1.54.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 +20 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-batch/client.rb +345 -19
- data/lib/aws-sdk-batch/client_api.rb +144 -0
- data/lib/aws-sdk-batch/types.rb +596 -113
- data/lib/aws-sdk-batch.rb +1 -1
- metadata +5 -5
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 0b4eab6af8f349c878194a9426c30babc99ed023f58732101a8d1a152e518f57
|
4
|
+
data.tar.gz: 995b607c52be5b52e3726b237b8ac69286fe5fa4f55bb3f1c0799c7bda72209c
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 48c5e494d9becbfb9a92ef383177f8f4e39141f58d4ad88a1e3a1e7699e609f1650e24312acad7ec7b5a0f15f0c4507a3e218f4c9665b9a82e6658235e278b0e
|
7
|
+
data.tar.gz: 58f55dd4ed28e2cc24aec28696d9aab74cabb6f3e584bc3a7b7a0c2b6b4d50f9ff70828fef644a493646da7811eadf6b44a264c999cfd535331b6be367cbaa23
|
data/CHANGELOG.md
CHANGED
@@ -1,6 +1,26 @@
|
|
1
1
|
Unreleased Changes
|
2
2
|
------------------
|
3
3
|
|
4
|
+
1.54.0 (2021-11-09)
|
5
|
+
------------------
|
6
|
+
|
7
|
+
* Feature - Adds support for scheduling policy APIs.
|
8
|
+
|
9
|
+
1.53.0 (2021-11-04)
|
10
|
+
------------------
|
11
|
+
|
12
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
13
|
+
|
14
|
+
1.52.0 (2021-10-18)
|
15
|
+
------------------
|
16
|
+
|
17
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
18
|
+
|
19
|
+
1.51.0 (2021-09-01)
|
20
|
+
------------------
|
21
|
+
|
22
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
23
|
+
|
4
24
|
1.50.0 (2021-07-30)
|
5
25
|
------------------
|
6
26
|
|
data/VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
1.
|
1
|
+
1.54.0
|
data/lib/aws-sdk-batch/client.rb
CHANGED
@@ -275,6 +275,15 @@ module Aws::Batch
|
|
275
275
|
# ** Please note ** When response stubbing is enabled, no HTTP
|
276
276
|
# requests are made, and retries are disabled.
|
277
277
|
#
|
278
|
+
# @option options [Boolean] :use_dualstack_endpoint
|
279
|
+
# When set to `true`, dualstack enabled endpoints (with `.aws` TLD)
|
280
|
+
# will be used if available.
|
281
|
+
#
|
282
|
+
# @option options [Boolean] :use_fips_endpoint
|
283
|
+
# When set to `true`, fips compatible endpoints will be used if available.
|
284
|
+
# When a `fips` region is used, the region is normalized and this config
|
285
|
+
# is set to `true`.
|
286
|
+
#
|
278
287
|
# @option options [Boolean] :validate_params (true)
|
279
288
|
# When `true`, request parameters are validated before
|
280
289
|
# sending the request.
|
@@ -459,6 +468,17 @@ module Aws::Batch
|
|
459
468
|
# environments in the `DISABLED` state don't scale out. However, they
|
460
469
|
# scale in to `minvCpus` value after instances become idle.
|
461
470
|
#
|
471
|
+
# @option params [Integer] :unmanagedv_cpus
|
472
|
+
# The maximum number of vCPUs for an unmanaged compute environment. This
|
473
|
+
# parameter is only used for fair share scheduling to reserve vCPU
|
474
|
+
# capacity for new share identifiers. If this parameter is not provided
|
475
|
+
# for a fair share job queue, no vCPU capacity will be reserved.
|
476
|
+
#
|
477
|
+
# <note markdown="1"> This parameter is only supported when the `type` parameter is set to
|
478
|
+
# `UNMANAGED`/
|
479
|
+
#
|
480
|
+
# </note>
|
481
|
+
#
|
462
482
|
# @option params [Types::ComputeResource] :compute_resources
|
463
483
|
# Details about the compute resources managed by the compute
|
464
484
|
# environment. This parameter is required for managed compute
|
@@ -617,6 +637,7 @@ module Aws::Batch
|
|
617
637
|
# compute_environment_name: "String", # required
|
618
638
|
# type: "MANAGED", # required, accepts MANAGED, UNMANAGED
|
619
639
|
# state: "ENABLED", # accepts ENABLED, DISABLED
|
640
|
+
# unmanagedv_cpus: 1,
|
620
641
|
# compute_resources: {
|
621
642
|
# type: "EC2", # required, accepts EC2, SPOT, FARGATE, FARGATE_SPOT
|
622
643
|
# allocation_strategy: "BEST_FIT", # accepts BEST_FIT, BEST_FIT_PROGRESSIVE, SPOT_CAPACITY_OPTIMIZED
|
@@ -687,6 +708,17 @@ module Aws::Batch
|
|
687
708
|
# can't be added to the queue, but jobs already in the queue can
|
688
709
|
# finish.
|
689
710
|
#
|
711
|
+
# @option params [String] :scheduling_policy_arn
|
712
|
+
# Amazon Resource Name (ARN) of the fair share scheduling policy. If
|
713
|
+
# this parameter is specified, the job queue will use a fair share
|
714
|
+
# scheduling policy. If this parameter is not specified, the job queue
|
715
|
+
# will use a first in, first out (FIFO) scheduling policy. Once a job
|
716
|
+
# queue is created, the fair share scheduling policy can be replaced but
|
717
|
+
# not removed. The format is
|
718
|
+
# `aws:Partition:batch:Region:Account:scheduling-policy/Name `. For
|
719
|
+
# example,
|
720
|
+
# `aws:aws:batch:us-west-2:012345678910:scheduling-policy/MySchedulingPolicy`.
|
721
|
+
#
|
690
722
|
# @option params [required, Integer] :priority
|
691
723
|
# The priority of the job queue. Job queues with a higher priority (or a
|
692
724
|
# higher integer value for the `priority` parameter) are evaluated first
|
@@ -783,6 +815,7 @@ module Aws::Batch
|
|
783
815
|
# resp = client.create_job_queue({
|
784
816
|
# job_queue_name: "String", # required
|
785
817
|
# state: "ENABLED", # accepts ENABLED, DISABLED
|
818
|
+
# scheduling_policy_arn: "String",
|
786
819
|
# priority: 1, # required
|
787
820
|
# compute_environment_order: [ # required
|
788
821
|
# {
|
@@ -809,6 +842,68 @@ module Aws::Batch
|
|
809
842
|
req.send_request(options)
|
810
843
|
end
|
811
844
|
|
845
|
+
# Creates an Batch scheduling policy.
|
846
|
+
#
|
847
|
+
# @option params [required, String] :name
|
848
|
+
# The name of the scheduling policy. Up to 128 letters (uppercase and
|
849
|
+
# lowercase), numbers, hyphens, and underscores are allowed.
|
850
|
+
#
|
851
|
+
# @option params [Types::FairsharePolicy] :fairshare_policy
|
852
|
+
# The fair share policy of the scheduling policy.
|
853
|
+
#
|
854
|
+
# @option params [Hash<String,String>] :tags
|
855
|
+
# The tags that you apply to the scheduling policy to help you
|
856
|
+
# categorize and organize your resources. Each tag consists of a key and
|
857
|
+
# an optional value. For more information, see [Tagging Amazon Web
|
858
|
+
# Services Resources][1] in *Amazon Web Services General Reference*.
|
859
|
+
#
|
860
|
+
# These tags can be updated or removed using the [TagResource][2] and
|
861
|
+
# [UntagResource][3] API operations.
|
862
|
+
#
|
863
|
+
#
|
864
|
+
#
|
865
|
+
# [1]: https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html
|
866
|
+
# [2]: https://docs.aws.amazon.com/batch/latest/APIReference/API_TagResource.html
|
867
|
+
# [3]: https://docs.aws.amazon.com/batch/latest/APIReference/API_UntagResource.html
|
868
|
+
#
|
869
|
+
# @return [Types::CreateSchedulingPolicyResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
870
|
+
#
|
871
|
+
# * {Types::CreateSchedulingPolicyResponse#name #name} => String
|
872
|
+
# * {Types::CreateSchedulingPolicyResponse#arn #arn} => String
|
873
|
+
#
|
874
|
+
# @example Request syntax with placeholder values
|
875
|
+
#
|
876
|
+
# resp = client.create_scheduling_policy({
|
877
|
+
# name: "String", # required
|
878
|
+
# fairshare_policy: {
|
879
|
+
# share_decay_seconds: 1,
|
880
|
+
# compute_reservation: 1,
|
881
|
+
# share_distribution: [
|
882
|
+
# {
|
883
|
+
# share_identifier: "String", # required
|
884
|
+
# weight_factor: 1.0,
|
885
|
+
# },
|
886
|
+
# ],
|
887
|
+
# },
|
888
|
+
# tags: {
|
889
|
+
# "TagKey" => "TagValue",
|
890
|
+
# },
|
891
|
+
# })
|
892
|
+
#
|
893
|
+
# @example Response structure
|
894
|
+
#
|
895
|
+
# resp.name #=> String
|
896
|
+
# resp.arn #=> String
|
897
|
+
#
|
898
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/CreateSchedulingPolicy AWS API Documentation
|
899
|
+
#
|
900
|
+
# @overload create_scheduling_policy(params = {})
|
901
|
+
# @param [Hash] params ({})
|
902
|
+
def create_scheduling_policy(params = {}, options = {})
|
903
|
+
req = build_request(:create_scheduling_policy, params)
|
904
|
+
req.send_request(options)
|
905
|
+
end
|
906
|
+
|
812
907
|
# Deletes an Batch compute environment.
|
813
908
|
#
|
814
909
|
# Before you can delete a compute environment, you must set its state to
|
@@ -895,6 +990,30 @@ module Aws::Batch
|
|
895
990
|
req.send_request(options)
|
896
991
|
end
|
897
992
|
|
993
|
+
# Deletes the specified scheduling policy.
|
994
|
+
#
|
995
|
+
# You can't delete a scheduling policy that is used in any job queues.
|
996
|
+
#
|
997
|
+
# @option params [required, String] :arn
|
998
|
+
# The Amazon Resource Name (ARN) of the scheduling policy to delete.
|
999
|
+
#
|
1000
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1001
|
+
#
|
1002
|
+
# @example Request syntax with placeholder values
|
1003
|
+
#
|
1004
|
+
# resp = client.delete_scheduling_policy({
|
1005
|
+
# arn: "String", # required
|
1006
|
+
# })
|
1007
|
+
#
|
1008
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/DeleteSchedulingPolicy AWS API Documentation
|
1009
|
+
#
|
1010
|
+
# @overload delete_scheduling_policy(params = {})
|
1011
|
+
# @param [Hash] params ({})
|
1012
|
+
def delete_scheduling_policy(params = {}, options = {})
|
1013
|
+
req = build_request(:delete_scheduling_policy, params)
|
1014
|
+
req.send_request(options)
|
1015
|
+
end
|
1016
|
+
|
898
1017
|
# Deregisters an Batch job definition. Job definitions are permanently
|
899
1018
|
# deleted after 180 days.
|
900
1019
|
#
|
@@ -1036,6 +1155,7 @@ module Aws::Batch
|
|
1036
1155
|
# resp.compute_environments #=> Array
|
1037
1156
|
# resp.compute_environments[0].compute_environment_name #=> String
|
1038
1157
|
# resp.compute_environments[0].compute_environment_arn #=> String
|
1158
|
+
# resp.compute_environments[0].unmanagedv_cpus #=> Integer
|
1039
1159
|
# resp.compute_environments[0].ecs_cluster_arn #=> String
|
1040
1160
|
# resp.compute_environments[0].tags #=> Hash
|
1041
1161
|
# resp.compute_environments[0].tags["TagKey"] #=> String
|
@@ -1149,12 +1269,20 @@ module Aws::Batch
|
|
1149
1269
|
# environment: [
|
1150
1270
|
# ],
|
1151
1271
|
# image: "busybox",
|
1152
|
-
# memory: 128,
|
1153
1272
|
# mount_points: [
|
1154
1273
|
# ],
|
1274
|
+
# resource_requirements: [
|
1275
|
+
# {
|
1276
|
+
# type: "MEMORY",
|
1277
|
+
# value: "128",
|
1278
|
+
# },
|
1279
|
+
# {
|
1280
|
+
# type: "VCPU",
|
1281
|
+
# value: "1",
|
1282
|
+
# },
|
1283
|
+
# ],
|
1155
1284
|
# ulimits: [
|
1156
1285
|
# ],
|
1157
|
-
# vcpus: 1,
|
1158
1286
|
# volumes: [
|
1159
1287
|
# ],
|
1160
1288
|
# },
|
@@ -1184,6 +1312,7 @@ module Aws::Batch
|
|
1184
1312
|
# resp.job_definitions[0].revision #=> Integer
|
1185
1313
|
# resp.job_definitions[0].status #=> String
|
1186
1314
|
# resp.job_definitions[0].type #=> String
|
1315
|
+
# resp.job_definitions[0].scheduling_priority #=> Integer
|
1187
1316
|
# resp.job_definitions[0].parameters #=> Hash
|
1188
1317
|
# resp.job_definitions[0].parameters["String"] #=> String
|
1189
1318
|
# resp.job_definitions[0].retry_strategy.attempts #=> Integer
|
@@ -1412,6 +1541,7 @@ module Aws::Batch
|
|
1412
1541
|
# resp.job_queues[0].job_queue_name #=> String
|
1413
1542
|
# resp.job_queues[0].job_queue_arn #=> String
|
1414
1543
|
# resp.job_queues[0].state #=> String, one of "ENABLED", "DISABLED"
|
1544
|
+
# resp.job_queues[0].scheduling_policy_arn #=> String
|
1415
1545
|
# resp.job_queues[0].status #=> String, one of "CREATING", "UPDATING", "DELETING", "DELETED", "VALID", "INVALID"
|
1416
1546
|
# resp.job_queues[0].status_reason #=> String
|
1417
1547
|
# resp.job_queues[0].priority #=> Integer
|
@@ -1504,6 +1634,8 @@ module Aws::Batch
|
|
1504
1634
|
# resp.jobs[0].job_id #=> String
|
1505
1635
|
# resp.jobs[0].job_queue #=> String
|
1506
1636
|
# resp.jobs[0].status #=> String, one of "SUBMITTED", "PENDING", "RUNNABLE", "STARTING", "RUNNING", "SUCCEEDED", "FAILED"
|
1637
|
+
# resp.jobs[0].share_identifier #=> String
|
1638
|
+
# resp.jobs[0].scheduling_priority #=> Integer
|
1507
1639
|
# resp.jobs[0].attempts #=> Array
|
1508
1640
|
# resp.jobs[0].attempts[0].container.container_instance_arn #=> String
|
1509
1641
|
# resp.jobs[0].attempts[0].container.task_arn #=> String
|
@@ -1686,6 +1818,44 @@ module Aws::Batch
|
|
1686
1818
|
req.send_request(options)
|
1687
1819
|
end
|
1688
1820
|
|
1821
|
+
# Describes one or more of your scheduling policies.
|
1822
|
+
#
|
1823
|
+
# @option params [required, Array<String>] :arns
|
1824
|
+
# A list of up to 100 scheduling policy Amazon Resource Name (ARN)
|
1825
|
+
# entries.
|
1826
|
+
#
|
1827
|
+
# @return [Types::DescribeSchedulingPoliciesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1828
|
+
#
|
1829
|
+
# * {Types::DescribeSchedulingPoliciesResponse#scheduling_policies #scheduling_policies} => Array<Types::SchedulingPolicyDetail>
|
1830
|
+
#
|
1831
|
+
# @example Request syntax with placeholder values
|
1832
|
+
#
|
1833
|
+
# resp = client.describe_scheduling_policies({
|
1834
|
+
# arns: ["String"], # required
|
1835
|
+
# })
|
1836
|
+
#
|
1837
|
+
# @example Response structure
|
1838
|
+
#
|
1839
|
+
# resp.scheduling_policies #=> Array
|
1840
|
+
# resp.scheduling_policies[0].name #=> String
|
1841
|
+
# resp.scheduling_policies[0].arn #=> String
|
1842
|
+
# resp.scheduling_policies[0].fairshare_policy.share_decay_seconds #=> Integer
|
1843
|
+
# resp.scheduling_policies[0].fairshare_policy.compute_reservation #=> Integer
|
1844
|
+
# resp.scheduling_policies[0].fairshare_policy.share_distribution #=> Array
|
1845
|
+
# resp.scheduling_policies[0].fairshare_policy.share_distribution[0].share_identifier #=> String
|
1846
|
+
# resp.scheduling_policies[0].fairshare_policy.share_distribution[0].weight_factor #=> Float
|
1847
|
+
# resp.scheduling_policies[0].tags #=> Hash
|
1848
|
+
# resp.scheduling_policies[0].tags["TagKey"] #=> String
|
1849
|
+
#
|
1850
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/DescribeSchedulingPolicies AWS API Documentation
|
1851
|
+
#
|
1852
|
+
# @overload describe_scheduling_policies(params = {})
|
1853
|
+
# @param [Hash] params ({})
|
1854
|
+
def describe_scheduling_policies(params = {}, options = {})
|
1855
|
+
req = build_request(:describe_scheduling_policies, params)
|
1856
|
+
req.send_request(options)
|
1857
|
+
end
|
1858
|
+
|
1689
1859
|
# Returns a list of Batch jobs.
|
1690
1860
|
#
|
1691
1861
|
# You must specify only one of the following items:
|
@@ -1882,16 +2052,72 @@ module Aws::Batch
|
|
1882
2052
|
req.send_request(options)
|
1883
2053
|
end
|
1884
2054
|
|
2055
|
+
# Returns a list of Batch scheduling policies.
|
2056
|
+
#
|
2057
|
+
# @option params [Integer] :max_results
|
2058
|
+
# The maximum number of results returned by `ListSchedulingPolicies` in
|
2059
|
+
# paginated output. When this parameter is used,
|
2060
|
+
# `ListSchedulingPolicies` only returns `maxResults` results in a single
|
2061
|
+
# page and a `nextToken` response element. The remaining results of the
|
2062
|
+
# initial request can be seen by sending another
|
2063
|
+
# `ListSchedulingPolicies` request with the returned `nextToken` value.
|
2064
|
+
# This value can be between 1 and 100. If this parameter isn't used,
|
2065
|
+
# then `ListSchedulingPolicies` returns up to 100 results and a
|
2066
|
+
# `nextToken` value if applicable.
|
2067
|
+
#
|
2068
|
+
# @option params [String] :next_token
|
2069
|
+
# The `nextToken` value returned from a previous paginated
|
2070
|
+
# `ListSchedulingPolicies` request where `maxResults` was used and the
|
2071
|
+
# results exceeded the value of that parameter. Pagination continues
|
2072
|
+
# from the end of the previous results that returned the `nextToken`
|
2073
|
+
# value. This value is `null` when there are no more results to return.
|
2074
|
+
#
|
2075
|
+
# <note markdown="1"> This token should be treated as an opaque identifier that's only used
|
2076
|
+
# to retrieve the next items in a list and not for other programmatic
|
2077
|
+
# purposes.
|
2078
|
+
#
|
2079
|
+
# </note>
|
2080
|
+
#
|
2081
|
+
# @return [Types::ListSchedulingPoliciesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2082
|
+
#
|
2083
|
+
# * {Types::ListSchedulingPoliciesResponse#scheduling_policies #scheduling_policies} => Array<Types::SchedulingPolicyListingDetail>
|
2084
|
+
# * {Types::ListSchedulingPoliciesResponse#next_token #next_token} => String
|
2085
|
+
#
|
2086
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
2087
|
+
#
|
2088
|
+
# @example Request syntax with placeholder values
|
2089
|
+
#
|
2090
|
+
# resp = client.list_scheduling_policies({
|
2091
|
+
# max_results: 1,
|
2092
|
+
# next_token: "String",
|
2093
|
+
# })
|
2094
|
+
#
|
2095
|
+
# @example Response structure
|
2096
|
+
#
|
2097
|
+
# resp.scheduling_policies #=> Array
|
2098
|
+
# resp.scheduling_policies[0].arn #=> String
|
2099
|
+
# resp.next_token #=> String
|
2100
|
+
#
|
2101
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/ListSchedulingPolicies AWS API Documentation
|
2102
|
+
#
|
2103
|
+
# @overload list_scheduling_policies(params = {})
|
2104
|
+
# @param [Hash] params ({})
|
2105
|
+
def list_scheduling_policies(params = {}, options = {})
|
2106
|
+
req = build_request(:list_scheduling_policies, params)
|
2107
|
+
req.send_request(options)
|
2108
|
+
end
|
2109
|
+
|
1885
2110
|
# Lists the tags for an Batch resource. Batch resources that support
|
1886
|
-
# tags are compute environments, jobs, job definitions,
|
1887
|
-
# ARNs for child jobs of array and multi-node
|
1888
|
-
# not supported.
|
2111
|
+
# tags are compute environments, jobs, job definitions, job queues, and
|
2112
|
+
# scheduling policies. ARNs for child jobs of array and multi-node
|
2113
|
+
# parallel (MNP) jobs are not supported.
|
1889
2114
|
#
|
1890
2115
|
# @option params [required, String] :resource_arn
|
1891
2116
|
# The Amazon Resource Name (ARN) that identifies the resource that tags
|
1892
2117
|
# are listed for. Batch resources that support tags are compute
|
1893
|
-
# environments, jobs, job definitions,
|
1894
|
-
# jobs of array and multi-node parallel (MNP)
|
2118
|
+
# environments, jobs, job definitions, job queues, and scheduling
|
2119
|
+
# policies. ARNs for child jobs of array and multi-node parallel (MNP)
|
2120
|
+
# jobs are not supported.
|
1895
2121
|
#
|
1896
2122
|
# @return [Types::ListTagsForResourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1897
2123
|
#
|
@@ -1962,6 +2188,15 @@ module Aws::Batch
|
|
1962
2188
|
# Parameters in a `SubmitJob` request override any corresponding
|
1963
2189
|
# parameter defaults from the job definition.
|
1964
2190
|
#
|
2191
|
+
# @option params [Integer] :scheduling_priority
|
2192
|
+
# The scheduling priority for jobs that are submitted with this job
|
2193
|
+
# definition. This will only affect jobs in job queues with a fair share
|
2194
|
+
# policy. Jobs with a higher scheduling priority will be scheduled
|
2195
|
+
# before jobs with a lower scheduling priority.
|
2196
|
+
#
|
2197
|
+
# The minimum supported value is 0 and the maximum supported value is
|
2198
|
+
# 9999.
|
2199
|
+
#
|
1965
2200
|
# @option params [Types::ContainerProperties] :container_properties
|
1966
2201
|
# An object with various properties specific to single-node
|
1967
2202
|
# container-based jobs. If the job definition's `type` parameter is
|
@@ -2052,8 +2287,16 @@ module Aws::Batch
|
|
2052
2287
|
# "10",
|
2053
2288
|
# ],
|
2054
2289
|
# image: "busybox",
|
2055
|
-
#
|
2056
|
-
#
|
2290
|
+
# resource_requirements: [
|
2291
|
+
# {
|
2292
|
+
# type: "MEMORY",
|
2293
|
+
# value: "128",
|
2294
|
+
# },
|
2295
|
+
# {
|
2296
|
+
# type: "VCPU",
|
2297
|
+
# value: "1",
|
2298
|
+
# },
|
2299
|
+
# ],
|
2057
2300
|
# },
|
2058
2301
|
# job_definition_name: "sleep10",
|
2059
2302
|
# })
|
@@ -2077,8 +2320,16 @@ module Aws::Batch
|
|
2077
2320
|
# "30",
|
2078
2321
|
# ],
|
2079
2322
|
# image: "busybox",
|
2080
|
-
#
|
2081
|
-
#
|
2323
|
+
# resource_requirements: [
|
2324
|
+
# {
|
2325
|
+
# type: "MEMORY",
|
2326
|
+
# value: "128",
|
2327
|
+
# },
|
2328
|
+
# {
|
2329
|
+
# type: "VCPU",
|
2330
|
+
# value: "1",
|
2331
|
+
# },
|
2332
|
+
# ],
|
2082
2333
|
# },
|
2083
2334
|
# job_definition_name: "sleep30",
|
2084
2335
|
# tags: {
|
@@ -2102,6 +2353,7 @@ module Aws::Batch
|
|
2102
2353
|
# parameters: {
|
2103
2354
|
# "String" => "String",
|
2104
2355
|
# },
|
2356
|
+
# scheduling_priority: 1,
|
2105
2357
|
# container_properties: {
|
2106
2358
|
# image: "String",
|
2107
2359
|
# vcpus: 1,
|
@@ -2350,12 +2602,17 @@ module Aws::Batch
|
|
2350
2602
|
# Submits an Batch job from a job definition. Parameters that are
|
2351
2603
|
# specified during SubmitJob override parameters defined in the job
|
2352
2604
|
# definition. vCPU and memory requirements that are specified in the
|
2353
|
-
# `
|
2605
|
+
# `resourceRequirements` objects in the job definition are the
|
2354
2606
|
# exception. They can't be overridden this way using the `memory` and
|
2355
2607
|
# `vcpus` parameters. Rather, you must specify updates to job definition
|
2356
2608
|
# parameters in a `ResourceRequirements` object that's included in the
|
2357
2609
|
# `containerOverrides` parameter.
|
2358
2610
|
#
|
2611
|
+
# <note markdown="1"> Job queues with a scheduling policy are limited to 500 active fair
|
2612
|
+
# share identifiers at a time.
|
2613
|
+
#
|
2614
|
+
# </note>
|
2615
|
+
#
|
2359
2616
|
# Jobs that run on Fargate resources can't be guaranteed to run for
|
2360
2617
|
# more than 14 days. This is because, after 14 days, Fargate resources
|
2361
2618
|
# might become unavailable and job might be terminated.
|
@@ -2369,6 +2626,19 @@ module Aws::Batch
|
|
2369
2626
|
# The job queue where the job is submitted. You can specify either the
|
2370
2627
|
# name or the Amazon Resource Name (ARN) of the queue.
|
2371
2628
|
#
|
2629
|
+
# @option params [String] :share_identifier
|
2630
|
+
# The share identifier for the job.
|
2631
|
+
#
|
2632
|
+
# @option params [Integer] :scheduling_priority_override
|
2633
|
+
# The scheduling priority for the job. This will only affect jobs in job
|
2634
|
+
# queues with a fair share policy. Jobs with a higher scheduling
|
2635
|
+
# priority will be scheduled before jobs with a lower scheduling
|
2636
|
+
# priority. This will override any scheduling priority in the job
|
2637
|
+
# definition.
|
2638
|
+
#
|
2639
|
+
# The minimum supported value is 0 and the maximum supported value is
|
2640
|
+
# 9999.
|
2641
|
+
#
|
2372
2642
|
# @option params [Types::ArrayProperties] :array_properties
|
2373
2643
|
# The array properties for the submitted job, such as the size of the
|
2374
2644
|
# array. The array size can be between 2 and 10,000. If you specify
|
@@ -2487,6 +2757,8 @@ module Aws::Batch
|
|
2487
2757
|
# resp = client.submit_job({
|
2488
2758
|
# job_name: "String", # required
|
2489
2759
|
# job_queue: "String", # required
|
2760
|
+
# share_identifier: "String",
|
2761
|
+
# scheduling_priority_override: 1,
|
2490
2762
|
# array_properties: {
|
2491
2763
|
# size: 1,
|
2492
2764
|
# },
|
@@ -2584,14 +2856,14 @@ module Aws::Batch
|
|
2584
2856
|
# request parameters, they aren't changed. When a resource is deleted,
|
2585
2857
|
# the tags that are associated with that resource are deleted as well.
|
2586
2858
|
# Batch resources that support tags are compute environments, jobs, job
|
2587
|
-
# definitions, and
|
2588
|
-
# multi-node parallel (MNP) jobs are not supported.
|
2859
|
+
# definitions, job queues, and scheduling policies. ARNs for child jobs
|
2860
|
+
# of array and multi-node parallel (MNP) jobs are not supported.
|
2589
2861
|
#
|
2590
2862
|
# @option params [required, String] :resource_arn
|
2591
2863
|
# The Amazon Resource Name (ARN) of the resource that tags are added to.
|
2592
2864
|
# Batch resources that support tags are compute environments, jobs, job
|
2593
|
-
# definitions, and
|
2594
|
-
# multi-node parallel (MNP) jobs are not supported.
|
2865
|
+
# definitions, job queues, and scheduling policies. ARNs for child jobs
|
2866
|
+
# of array and multi-node parallel (MNP) jobs are not supported.
|
2595
2867
|
#
|
2596
2868
|
# @option params [required, Hash<String,String>] :tags
|
2597
2869
|
# The tags that you apply to the resource to help you categorize and
|
@@ -2689,8 +2961,9 @@ module Aws::Batch
|
|
2689
2961
|
# @option params [required, String] :resource_arn
|
2690
2962
|
# The Amazon Resource Name (ARN) of the resource from which to delete
|
2691
2963
|
# tags. Batch resources that support tags are compute environments,
|
2692
|
-
# jobs, job definitions, and
|
2693
|
-
# and multi-node parallel (MNP) jobs are not
|
2964
|
+
# jobs, job definitions, job queues, and scheduling policies. ARNs for
|
2965
|
+
# child jobs of array and multi-node parallel (MNP) jobs are not
|
2966
|
+
# supported.
|
2694
2967
|
#
|
2695
2968
|
# @option params [required, Array<String>] :tag_keys
|
2696
2969
|
# The keys of the tags to be removed.
|
@@ -2752,6 +3025,14 @@ module Aws::Batch
|
|
2752
3025
|
# environments in the `DISABLED` state don't scale out. However, they
|
2753
3026
|
# scale in to `minvCpus` value after instances become idle.
|
2754
3027
|
#
|
3028
|
+
# @option params [Integer] :unmanagedv_cpus
|
3029
|
+
# The maximum number of vCPUs expected to be used for an unmanaged
|
3030
|
+
# compute environment. This parameter should not be specified for a
|
3031
|
+
# managed compute environment. This parameter is only used for fair
|
3032
|
+
# share scheduling to reserve vCPU capacity for new share identifiers.
|
3033
|
+
# If this parameter is not provided for a fair share job queue, no vCPU
|
3034
|
+
# capacity will be reserved.
|
3035
|
+
#
|
2755
3036
|
# @option params [Types::ComputeResourceUpdate] :compute_resources
|
2756
3037
|
# Details of the compute resources managed by the compute environment.
|
2757
3038
|
# Required for a managed compute environment. For more information, see
|
@@ -2815,6 +3096,7 @@ module Aws::Batch
|
|
2815
3096
|
# resp = client.update_compute_environment({
|
2816
3097
|
# compute_environment: "String", # required
|
2817
3098
|
# state: "ENABLED", # accepts ENABLED, DISABLED
|
3099
|
+
# unmanagedv_cpus: 1,
|
2818
3100
|
# compute_resources: {
|
2819
3101
|
# minv_cpus: 1,
|
2820
3102
|
# maxv_cpus: 1,
|
@@ -2850,6 +3132,14 @@ module Aws::Batch
|
|
2850
3132
|
# `DISABLED`, new jobs can't be added to the queue, but jobs already in
|
2851
3133
|
# the queue can finish.
|
2852
3134
|
#
|
3135
|
+
# @option params [String] :scheduling_policy_arn
|
3136
|
+
# Amazon Resource Name (ARN) of the fair share scheduling policy. Once a
|
3137
|
+
# job queue is created, the fair share scheduling policy can be replaced
|
3138
|
+
# but not removed. The format is
|
3139
|
+
# `aws:Partition:batch:Region:Account:scheduling-policy/Name `. For
|
3140
|
+
# example,
|
3141
|
+
# `aws:aws:batch:us-west-2:012345678910:scheduling-policy/MySchedulingPolicy`.
|
3142
|
+
#
|
2853
3143
|
# @option params [Integer] :priority
|
2854
3144
|
# The priority of the job queue. Job queues with a higher priority (or a
|
2855
3145
|
# higher integer value for the `priority` parameter) are evaluated first
|
@@ -2902,6 +3192,7 @@ module Aws::Batch
|
|
2902
3192
|
# resp = client.update_job_queue({
|
2903
3193
|
# job_queue: "String", # required
|
2904
3194
|
# state: "ENABLED", # accepts ENABLED, DISABLED
|
3195
|
+
# scheduling_policy_arn: "String",
|
2905
3196
|
# priority: 1,
|
2906
3197
|
# compute_environment_order: [
|
2907
3198
|
# {
|
@@ -2925,6 +3216,41 @@ module Aws::Batch
|
|
2925
3216
|
req.send_request(options)
|
2926
3217
|
end
|
2927
3218
|
|
3219
|
+
# Updates a scheduling policy.
|
3220
|
+
#
|
3221
|
+
# @option params [required, String] :arn
|
3222
|
+
# The Amazon Resource Name (ARN) of the scheduling policy to update.
|
3223
|
+
#
|
3224
|
+
# @option params [Types::FairsharePolicy] :fairshare_policy
|
3225
|
+
# The fair share policy.
|
3226
|
+
#
|
3227
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
3228
|
+
#
|
3229
|
+
# @example Request syntax with placeholder values
|
3230
|
+
#
|
3231
|
+
# resp = client.update_scheduling_policy({
|
3232
|
+
# arn: "String", # required
|
3233
|
+
# fairshare_policy: {
|
3234
|
+
# share_decay_seconds: 1,
|
3235
|
+
# compute_reservation: 1,
|
3236
|
+
# share_distribution: [
|
3237
|
+
# {
|
3238
|
+
# share_identifier: "String", # required
|
3239
|
+
# weight_factor: 1.0,
|
3240
|
+
# },
|
3241
|
+
# ],
|
3242
|
+
# },
|
3243
|
+
# })
|
3244
|
+
#
|
3245
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/UpdateSchedulingPolicy AWS API Documentation
|
3246
|
+
#
|
3247
|
+
# @overload update_scheduling_policy(params = {})
|
3248
|
+
# @param [Hash] params ({})
|
3249
|
+
def update_scheduling_policy(params = {}, options = {})
|
3250
|
+
req = build_request(:update_scheduling_policy, params)
|
3251
|
+
req.send_request(options)
|
3252
|
+
end
|
3253
|
+
|
2928
3254
|
# @!endgroup
|
2929
3255
|
|
2930
3256
|
# @param params ({})
|
@@ -2938,7 +3264,7 @@ module Aws::Batch
|
|
2938
3264
|
params: params,
|
2939
3265
|
config: config)
|
2940
3266
|
context[:gem_name] = 'aws-sdk-batch'
|
2941
|
-
context[:gem_version] = '1.
|
3267
|
+
context[:gem_version] = '1.54.0'
|
2942
3268
|
Seahorse::Client::Request.new(handlers, context)
|
2943
3269
|
end
|
2944
3270
|
|