aws-sdk-batch 1.53.0 → 1.54.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 +5 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-batch/client.rb +336 -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 +2 -2
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
data/VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
1.
|
1
|
+
1.54.0
|
data/lib/aws-sdk-batch/client.rb
CHANGED
@@ -468,6 +468,17 @@ module Aws::Batch
|
|
468
468
|
# environments in the `DISABLED` state don't scale out. However, they
|
469
469
|
# scale in to `minvCpus` value after instances become idle.
|
470
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
|
+
#
|
471
482
|
# @option params [Types::ComputeResource] :compute_resources
|
472
483
|
# Details about the compute resources managed by the compute
|
473
484
|
# environment. This parameter is required for managed compute
|
@@ -626,6 +637,7 @@ module Aws::Batch
|
|
626
637
|
# compute_environment_name: "String", # required
|
627
638
|
# type: "MANAGED", # required, accepts MANAGED, UNMANAGED
|
628
639
|
# state: "ENABLED", # accepts ENABLED, DISABLED
|
640
|
+
# unmanagedv_cpus: 1,
|
629
641
|
# compute_resources: {
|
630
642
|
# type: "EC2", # required, accepts EC2, SPOT, FARGATE, FARGATE_SPOT
|
631
643
|
# allocation_strategy: "BEST_FIT", # accepts BEST_FIT, BEST_FIT_PROGRESSIVE, SPOT_CAPACITY_OPTIMIZED
|
@@ -696,6 +708,17 @@ module Aws::Batch
|
|
696
708
|
# can't be added to the queue, but jobs already in the queue can
|
697
709
|
# finish.
|
698
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
|
+
#
|
699
722
|
# @option params [required, Integer] :priority
|
700
723
|
# The priority of the job queue. Job queues with a higher priority (or a
|
701
724
|
# higher integer value for the `priority` parameter) are evaluated first
|
@@ -792,6 +815,7 @@ module Aws::Batch
|
|
792
815
|
# resp = client.create_job_queue({
|
793
816
|
# job_queue_name: "String", # required
|
794
817
|
# state: "ENABLED", # accepts ENABLED, DISABLED
|
818
|
+
# scheduling_policy_arn: "String",
|
795
819
|
# priority: 1, # required
|
796
820
|
# compute_environment_order: [ # required
|
797
821
|
# {
|
@@ -818,6 +842,68 @@ module Aws::Batch
|
|
818
842
|
req.send_request(options)
|
819
843
|
end
|
820
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
|
+
|
821
907
|
# Deletes an Batch compute environment.
|
822
908
|
#
|
823
909
|
# Before you can delete a compute environment, you must set its state to
|
@@ -904,6 +990,30 @@ module Aws::Batch
|
|
904
990
|
req.send_request(options)
|
905
991
|
end
|
906
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
|
+
|
907
1017
|
# Deregisters an Batch job definition. Job definitions are permanently
|
908
1018
|
# deleted after 180 days.
|
909
1019
|
#
|
@@ -1045,6 +1155,7 @@ module Aws::Batch
|
|
1045
1155
|
# resp.compute_environments #=> Array
|
1046
1156
|
# resp.compute_environments[0].compute_environment_name #=> String
|
1047
1157
|
# resp.compute_environments[0].compute_environment_arn #=> String
|
1158
|
+
# resp.compute_environments[0].unmanagedv_cpus #=> Integer
|
1048
1159
|
# resp.compute_environments[0].ecs_cluster_arn #=> String
|
1049
1160
|
# resp.compute_environments[0].tags #=> Hash
|
1050
1161
|
# resp.compute_environments[0].tags["TagKey"] #=> String
|
@@ -1158,12 +1269,20 @@ module Aws::Batch
|
|
1158
1269
|
# environment: [
|
1159
1270
|
# ],
|
1160
1271
|
# image: "busybox",
|
1161
|
-
# memory: 128,
|
1162
1272
|
# mount_points: [
|
1163
1273
|
# ],
|
1274
|
+
# resource_requirements: [
|
1275
|
+
# {
|
1276
|
+
# type: "MEMORY",
|
1277
|
+
# value: "128",
|
1278
|
+
# },
|
1279
|
+
# {
|
1280
|
+
# type: "VCPU",
|
1281
|
+
# value: "1",
|
1282
|
+
# },
|
1283
|
+
# ],
|
1164
1284
|
# ulimits: [
|
1165
1285
|
# ],
|
1166
|
-
# vcpus: 1,
|
1167
1286
|
# volumes: [
|
1168
1287
|
# ],
|
1169
1288
|
# },
|
@@ -1193,6 +1312,7 @@ module Aws::Batch
|
|
1193
1312
|
# resp.job_definitions[0].revision #=> Integer
|
1194
1313
|
# resp.job_definitions[0].status #=> String
|
1195
1314
|
# resp.job_definitions[0].type #=> String
|
1315
|
+
# resp.job_definitions[0].scheduling_priority #=> Integer
|
1196
1316
|
# resp.job_definitions[0].parameters #=> Hash
|
1197
1317
|
# resp.job_definitions[0].parameters["String"] #=> String
|
1198
1318
|
# resp.job_definitions[0].retry_strategy.attempts #=> Integer
|
@@ -1421,6 +1541,7 @@ module Aws::Batch
|
|
1421
1541
|
# resp.job_queues[0].job_queue_name #=> String
|
1422
1542
|
# resp.job_queues[0].job_queue_arn #=> String
|
1423
1543
|
# resp.job_queues[0].state #=> String, one of "ENABLED", "DISABLED"
|
1544
|
+
# resp.job_queues[0].scheduling_policy_arn #=> String
|
1424
1545
|
# resp.job_queues[0].status #=> String, one of "CREATING", "UPDATING", "DELETING", "DELETED", "VALID", "INVALID"
|
1425
1546
|
# resp.job_queues[0].status_reason #=> String
|
1426
1547
|
# resp.job_queues[0].priority #=> Integer
|
@@ -1513,6 +1634,8 @@ module Aws::Batch
|
|
1513
1634
|
# resp.jobs[0].job_id #=> String
|
1514
1635
|
# resp.jobs[0].job_queue #=> String
|
1515
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
|
1516
1639
|
# resp.jobs[0].attempts #=> Array
|
1517
1640
|
# resp.jobs[0].attempts[0].container.container_instance_arn #=> String
|
1518
1641
|
# resp.jobs[0].attempts[0].container.task_arn #=> String
|
@@ -1695,6 +1818,44 @@ module Aws::Batch
|
|
1695
1818
|
req.send_request(options)
|
1696
1819
|
end
|
1697
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
|
+
|
1698
1859
|
# Returns a list of Batch jobs.
|
1699
1860
|
#
|
1700
1861
|
# You must specify only one of the following items:
|
@@ -1891,16 +2052,72 @@ module Aws::Batch
|
|
1891
2052
|
req.send_request(options)
|
1892
2053
|
end
|
1893
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
|
+
|
1894
2110
|
# Lists the tags for an Batch resource. Batch resources that support
|
1895
|
-
# tags are compute environments, jobs, job definitions,
|
1896
|
-
# ARNs for child jobs of array and multi-node
|
1897
|
-
# 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.
|
1898
2114
|
#
|
1899
2115
|
# @option params [required, String] :resource_arn
|
1900
2116
|
# The Amazon Resource Name (ARN) that identifies the resource that tags
|
1901
2117
|
# are listed for. Batch resources that support tags are compute
|
1902
|
-
# environments, jobs, job definitions,
|
1903
|
-
# 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.
|
1904
2121
|
#
|
1905
2122
|
# @return [Types::ListTagsForResourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1906
2123
|
#
|
@@ -1971,6 +2188,15 @@ module Aws::Batch
|
|
1971
2188
|
# Parameters in a `SubmitJob` request override any corresponding
|
1972
2189
|
# parameter defaults from the job definition.
|
1973
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
|
+
#
|
1974
2200
|
# @option params [Types::ContainerProperties] :container_properties
|
1975
2201
|
# An object with various properties specific to single-node
|
1976
2202
|
# container-based jobs. If the job definition's `type` parameter is
|
@@ -2061,8 +2287,16 @@ module Aws::Batch
|
|
2061
2287
|
# "10",
|
2062
2288
|
# ],
|
2063
2289
|
# image: "busybox",
|
2064
|
-
#
|
2065
|
-
#
|
2290
|
+
# resource_requirements: [
|
2291
|
+
# {
|
2292
|
+
# type: "MEMORY",
|
2293
|
+
# value: "128",
|
2294
|
+
# },
|
2295
|
+
# {
|
2296
|
+
# type: "VCPU",
|
2297
|
+
# value: "1",
|
2298
|
+
# },
|
2299
|
+
# ],
|
2066
2300
|
# },
|
2067
2301
|
# job_definition_name: "sleep10",
|
2068
2302
|
# })
|
@@ -2086,8 +2320,16 @@ module Aws::Batch
|
|
2086
2320
|
# "30",
|
2087
2321
|
# ],
|
2088
2322
|
# image: "busybox",
|
2089
|
-
#
|
2090
|
-
#
|
2323
|
+
# resource_requirements: [
|
2324
|
+
# {
|
2325
|
+
# type: "MEMORY",
|
2326
|
+
# value: "128",
|
2327
|
+
# },
|
2328
|
+
# {
|
2329
|
+
# type: "VCPU",
|
2330
|
+
# value: "1",
|
2331
|
+
# },
|
2332
|
+
# ],
|
2091
2333
|
# },
|
2092
2334
|
# job_definition_name: "sleep30",
|
2093
2335
|
# tags: {
|
@@ -2111,6 +2353,7 @@ module Aws::Batch
|
|
2111
2353
|
# parameters: {
|
2112
2354
|
# "String" => "String",
|
2113
2355
|
# },
|
2356
|
+
# scheduling_priority: 1,
|
2114
2357
|
# container_properties: {
|
2115
2358
|
# image: "String",
|
2116
2359
|
# vcpus: 1,
|
@@ -2359,12 +2602,17 @@ module Aws::Batch
|
|
2359
2602
|
# Submits an Batch job from a job definition. Parameters that are
|
2360
2603
|
# specified during SubmitJob override parameters defined in the job
|
2361
2604
|
# definition. vCPU and memory requirements that are specified in the
|
2362
|
-
# `
|
2605
|
+
# `resourceRequirements` objects in the job definition are the
|
2363
2606
|
# exception. They can't be overridden this way using the `memory` and
|
2364
2607
|
# `vcpus` parameters. Rather, you must specify updates to job definition
|
2365
2608
|
# parameters in a `ResourceRequirements` object that's included in the
|
2366
2609
|
# `containerOverrides` parameter.
|
2367
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
|
+
#
|
2368
2616
|
# Jobs that run on Fargate resources can't be guaranteed to run for
|
2369
2617
|
# more than 14 days. This is because, after 14 days, Fargate resources
|
2370
2618
|
# might become unavailable and job might be terminated.
|
@@ -2378,6 +2626,19 @@ module Aws::Batch
|
|
2378
2626
|
# The job queue where the job is submitted. You can specify either the
|
2379
2627
|
# name or the Amazon Resource Name (ARN) of the queue.
|
2380
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
|
+
#
|
2381
2642
|
# @option params [Types::ArrayProperties] :array_properties
|
2382
2643
|
# The array properties for the submitted job, such as the size of the
|
2383
2644
|
# array. The array size can be between 2 and 10,000. If you specify
|
@@ -2496,6 +2757,8 @@ module Aws::Batch
|
|
2496
2757
|
# resp = client.submit_job({
|
2497
2758
|
# job_name: "String", # required
|
2498
2759
|
# job_queue: "String", # required
|
2760
|
+
# share_identifier: "String",
|
2761
|
+
# scheduling_priority_override: 1,
|
2499
2762
|
# array_properties: {
|
2500
2763
|
# size: 1,
|
2501
2764
|
# },
|
@@ -2593,14 +2856,14 @@ module Aws::Batch
|
|
2593
2856
|
# request parameters, they aren't changed. When a resource is deleted,
|
2594
2857
|
# the tags that are associated with that resource are deleted as well.
|
2595
2858
|
# Batch resources that support tags are compute environments, jobs, job
|
2596
|
-
# definitions, and
|
2597
|
-
# 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.
|
2598
2861
|
#
|
2599
2862
|
# @option params [required, String] :resource_arn
|
2600
2863
|
# The Amazon Resource Name (ARN) of the resource that tags are added to.
|
2601
2864
|
# Batch resources that support tags are compute environments, jobs, job
|
2602
|
-
# definitions, and
|
2603
|
-
# 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.
|
2604
2867
|
#
|
2605
2868
|
# @option params [required, Hash<String,String>] :tags
|
2606
2869
|
# The tags that you apply to the resource to help you categorize and
|
@@ -2698,8 +2961,9 @@ module Aws::Batch
|
|
2698
2961
|
# @option params [required, String] :resource_arn
|
2699
2962
|
# The Amazon Resource Name (ARN) of the resource from which to delete
|
2700
2963
|
# tags. Batch resources that support tags are compute environments,
|
2701
|
-
# jobs, job definitions, and
|
2702
|
-
# 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.
|
2703
2967
|
#
|
2704
2968
|
# @option params [required, Array<String>] :tag_keys
|
2705
2969
|
# The keys of the tags to be removed.
|
@@ -2761,6 +3025,14 @@ module Aws::Batch
|
|
2761
3025
|
# environments in the `DISABLED` state don't scale out. However, they
|
2762
3026
|
# scale in to `minvCpus` value after instances become idle.
|
2763
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
|
+
#
|
2764
3036
|
# @option params [Types::ComputeResourceUpdate] :compute_resources
|
2765
3037
|
# Details of the compute resources managed by the compute environment.
|
2766
3038
|
# Required for a managed compute environment. For more information, see
|
@@ -2824,6 +3096,7 @@ module Aws::Batch
|
|
2824
3096
|
# resp = client.update_compute_environment({
|
2825
3097
|
# compute_environment: "String", # required
|
2826
3098
|
# state: "ENABLED", # accepts ENABLED, DISABLED
|
3099
|
+
# unmanagedv_cpus: 1,
|
2827
3100
|
# compute_resources: {
|
2828
3101
|
# minv_cpus: 1,
|
2829
3102
|
# maxv_cpus: 1,
|
@@ -2859,6 +3132,14 @@ module Aws::Batch
|
|
2859
3132
|
# `DISABLED`, new jobs can't be added to the queue, but jobs already in
|
2860
3133
|
# the queue can finish.
|
2861
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
|
+
#
|
2862
3143
|
# @option params [Integer] :priority
|
2863
3144
|
# The priority of the job queue. Job queues with a higher priority (or a
|
2864
3145
|
# higher integer value for the `priority` parameter) are evaluated first
|
@@ -2911,6 +3192,7 @@ module Aws::Batch
|
|
2911
3192
|
# resp = client.update_job_queue({
|
2912
3193
|
# job_queue: "String", # required
|
2913
3194
|
# state: "ENABLED", # accepts ENABLED, DISABLED
|
3195
|
+
# scheduling_policy_arn: "String",
|
2914
3196
|
# priority: 1,
|
2915
3197
|
# compute_environment_order: [
|
2916
3198
|
# {
|
@@ -2934,6 +3216,41 @@ module Aws::Batch
|
|
2934
3216
|
req.send_request(options)
|
2935
3217
|
end
|
2936
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
|
+
|
2937
3254
|
# @!endgroup
|
2938
3255
|
|
2939
3256
|
# @param params ({})
|
@@ -2947,7 +3264,7 @@ module Aws::Batch
|
|
2947
3264
|
params: params,
|
2948
3265
|
config: config)
|
2949
3266
|
context[:gem_name] = 'aws-sdk-batch'
|
2950
|
-
context[:gem_version] = '1.
|
3267
|
+
context[:gem_version] = '1.54.0'
|
2951
3268
|
Seahorse::Client::Request.new(handlers, context)
|
2952
3269
|
end
|
2953
3270
|
|