aws-sdk-batch 1.110.0 → 1.111.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 +588 -29
- data/lib/aws-sdk-batch/client_api.rb +195 -0
- data/lib/aws-sdk-batch/types.rb +637 -77
- data/lib/aws-sdk-batch.rb +1 -1
- data/sig/client.rbs +124 -0
- data/sig/types.rbs +122 -0
- metadata +2 -2
data/lib/aws-sdk-batch/types.rb
CHANGED
@@ -1327,6 +1327,78 @@ module Aws::Batch
|
|
1327
1327
|
include Aws::Structure
|
1328
1328
|
end
|
1329
1329
|
|
1330
|
+
# Contains a list of consumable resources required by a job.
|
1331
|
+
#
|
1332
|
+
# @!attribute [rw] consumable_resource_list
|
1333
|
+
# The list of consumable resources required by a job.
|
1334
|
+
# @return [Array<Types::ConsumableResourceRequirement>]
|
1335
|
+
#
|
1336
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/ConsumableResourceProperties AWS API Documentation
|
1337
|
+
#
|
1338
|
+
class ConsumableResourceProperties < Struct.new(
|
1339
|
+
:consumable_resource_list)
|
1340
|
+
SENSITIVE = []
|
1341
|
+
include Aws::Structure
|
1342
|
+
end
|
1343
|
+
|
1344
|
+
# Information about a consumable resource required to run a job.
|
1345
|
+
#
|
1346
|
+
# @!attribute [rw] consumable_resource
|
1347
|
+
# The name or ARN of the consumable resource.
|
1348
|
+
# @return [String]
|
1349
|
+
#
|
1350
|
+
# @!attribute [rw] quantity
|
1351
|
+
# The quantity of the consumable resource that is needed.
|
1352
|
+
# @return [Integer]
|
1353
|
+
#
|
1354
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/ConsumableResourceRequirement AWS API Documentation
|
1355
|
+
#
|
1356
|
+
class ConsumableResourceRequirement < Struct.new(
|
1357
|
+
:consumable_resource,
|
1358
|
+
:quantity)
|
1359
|
+
SENSITIVE = []
|
1360
|
+
include Aws::Structure
|
1361
|
+
end
|
1362
|
+
|
1363
|
+
# Current information about a consumable resource.
|
1364
|
+
#
|
1365
|
+
# @!attribute [rw] consumable_resource_arn
|
1366
|
+
# The Amazon Resource Name (ARN) of the consumable resource.
|
1367
|
+
# @return [String]
|
1368
|
+
#
|
1369
|
+
# @!attribute [rw] consumable_resource_name
|
1370
|
+
# The name of the consumable resource.
|
1371
|
+
# @return [String]
|
1372
|
+
#
|
1373
|
+
# @!attribute [rw] total_quantity
|
1374
|
+
# The total amount of the consumable resource that is available.
|
1375
|
+
# @return [Integer]
|
1376
|
+
#
|
1377
|
+
# @!attribute [rw] in_use_quantity
|
1378
|
+
# The amount of the consumable resource that is currently in use.
|
1379
|
+
# @return [Integer]
|
1380
|
+
#
|
1381
|
+
# @!attribute [rw] resource_type
|
1382
|
+
# Indicates whether the resource is available to be re-used after a
|
1383
|
+
# job completes. Can be one of:
|
1384
|
+
#
|
1385
|
+
# * `REPLENISHABLE`
|
1386
|
+
#
|
1387
|
+
# * `NON_REPLENISHABLE`
|
1388
|
+
# @return [String]
|
1389
|
+
#
|
1390
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/ConsumableResourceSummary AWS API Documentation
|
1391
|
+
#
|
1392
|
+
class ConsumableResourceSummary < Struct.new(
|
1393
|
+
:consumable_resource_arn,
|
1394
|
+
:consumable_resource_name,
|
1395
|
+
:total_quantity,
|
1396
|
+
:in_use_quantity,
|
1397
|
+
:resource_type)
|
1398
|
+
SENSITIVE = []
|
1399
|
+
include Aws::Structure
|
1400
|
+
end
|
1401
|
+
|
1330
1402
|
# An object that represents the details of a container that's part of a
|
1331
1403
|
# job.
|
1332
1404
|
#
|
@@ -2141,9 +2213,9 @@ module Aws::Batch
|
|
2141
2213
|
#
|
2142
2214
|
# @!attribute [rw] unmanagedv_cpus
|
2143
2215
|
# The maximum number of vCPUs for an unmanaged compute environment.
|
2144
|
-
# This parameter is only used for fair
|
2216
|
+
# This parameter is only used for fair share scheduling to reserve
|
2145
2217
|
# vCPU capacity for new share identifiers. If this parameter isn't
|
2146
|
-
# provided for a fair
|
2218
|
+
# provided for a fair share job queue, no vCPU capacity is reserved.
|
2147
2219
|
#
|
2148
2220
|
# <note markdown="1"> This parameter is only supported when the `type` parameter is set to
|
2149
2221
|
# `UNMANAGED`.
|
@@ -2258,6 +2330,63 @@ module Aws::Batch
|
|
2258
2330
|
include Aws::Structure
|
2259
2331
|
end
|
2260
2332
|
|
2333
|
+
# @!attribute [rw] consumable_resource_name
|
2334
|
+
# The name of the consumable resource. Must be unique.
|
2335
|
+
# @return [String]
|
2336
|
+
#
|
2337
|
+
# @!attribute [rw] total_quantity
|
2338
|
+
# The total amount of the consumable resource that is available. Must
|
2339
|
+
# be non-negative.
|
2340
|
+
# @return [Integer]
|
2341
|
+
#
|
2342
|
+
# @!attribute [rw] resource_type
|
2343
|
+
# Indicates whether the resource is available to be re-used after a
|
2344
|
+
# job completes. Can be one of:
|
2345
|
+
#
|
2346
|
+
# * `REPLENISHABLE` (default)
|
2347
|
+
#
|
2348
|
+
# * `NON_REPLENISHABLE`
|
2349
|
+
# @return [String]
|
2350
|
+
#
|
2351
|
+
# @!attribute [rw] tags
|
2352
|
+
# The tags that you apply to the consumable resource to help you
|
2353
|
+
# categorize and organize your resources. Each tag consists of a key
|
2354
|
+
# and an optional value. For more information, see [Tagging your Batch
|
2355
|
+
# resources][1].
|
2356
|
+
#
|
2357
|
+
#
|
2358
|
+
#
|
2359
|
+
# [1]: https://docs.aws.amazon.com/batch/latest/userguide/using-tags.html
|
2360
|
+
# @return [Hash<String,String>]
|
2361
|
+
#
|
2362
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/CreateConsumableResourceRequest AWS API Documentation
|
2363
|
+
#
|
2364
|
+
class CreateConsumableResourceRequest < Struct.new(
|
2365
|
+
:consumable_resource_name,
|
2366
|
+
:total_quantity,
|
2367
|
+
:resource_type,
|
2368
|
+
:tags)
|
2369
|
+
SENSITIVE = []
|
2370
|
+
include Aws::Structure
|
2371
|
+
end
|
2372
|
+
|
2373
|
+
# @!attribute [rw] consumable_resource_name
|
2374
|
+
# The name of the consumable resource.
|
2375
|
+
# @return [String]
|
2376
|
+
#
|
2377
|
+
# @!attribute [rw] consumable_resource_arn
|
2378
|
+
# The Amazon Resource Name (ARN) of the consumable resource.
|
2379
|
+
# @return [String]
|
2380
|
+
#
|
2381
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/CreateConsumableResourceResponse AWS API Documentation
|
2382
|
+
#
|
2383
|
+
class CreateConsumableResourceResponse < Struct.new(
|
2384
|
+
:consumable_resource_name,
|
2385
|
+
:consumable_resource_arn)
|
2386
|
+
SENSITIVE = []
|
2387
|
+
include Aws::Structure
|
2388
|
+
end
|
2389
|
+
|
2261
2390
|
# Contains the parameters for `CreateJobQueue`.
|
2262
2391
|
#
|
2263
2392
|
# @!attribute [rw] job_queue_name
|
@@ -2274,11 +2403,10 @@ module Aws::Batch
|
|
2274
2403
|
# @return [String]
|
2275
2404
|
#
|
2276
2405
|
# @!attribute [rw] scheduling_policy_arn
|
2277
|
-
# The Amazon Resource Name (ARN) of the fair
|
2278
|
-
# Job queues that don't have a
|
2279
|
-
#
|
2280
|
-
#
|
2281
|
-
# removed.
|
2406
|
+
# The Amazon Resource Name (ARN) of the fair share scheduling policy.
|
2407
|
+
# Job queues that don't have a scheduling policy are scheduled in a
|
2408
|
+
# first-in, first-out (FIFO) model. After a job queue has a scheduling
|
2409
|
+
# policy, it can be replaced but can't be removed.
|
2282
2410
|
#
|
2283
2411
|
# The format is
|
2284
2412
|
# `aws:Partition:batch:Region:Account:scheduling-policy/Name `.
|
@@ -2286,11 +2414,11 @@ module Aws::Batch
|
|
2286
2414
|
# An example is
|
2287
2415
|
# `aws:aws:batch:us-west-2:123456789012:scheduling-policy/MySchedulingPolicy`.
|
2288
2416
|
#
|
2289
|
-
# A job queue without a
|
2290
|
-
#
|
2291
|
-
#
|
2292
|
-
#
|
2293
|
-
#
|
2417
|
+
# A job queue without a scheduling policy is scheduled as a FIFO job
|
2418
|
+
# queue and can't have a scheduling policy added. Jobs queues with a
|
2419
|
+
# scheduling policy can have a maximum of 500 active fair share
|
2420
|
+
# identifiers. When the limit has been reached, submissions of any
|
2421
|
+
# jobs that add a new fair share identifier fail.
|
2294
2422
|
# @return [String]
|
2295
2423
|
#
|
2296
2424
|
# @!attribute [rw] priority
|
@@ -2376,13 +2504,13 @@ module Aws::Batch
|
|
2376
2504
|
# Contains the parameters for `CreateSchedulingPolicy`.
|
2377
2505
|
#
|
2378
2506
|
# @!attribute [rw] name
|
2379
|
-
# The name of the
|
2380
|
-
#
|
2381
|
-
#
|
2507
|
+
# The name of the scheduling policy. It can be up to 128 letters long.
|
2508
|
+
# It can contain uppercase and lowercase letters, numbers, hyphens
|
2509
|
+
# (-), and underscores (\_).
|
2382
2510
|
# @return [String]
|
2383
2511
|
#
|
2384
2512
|
# @!attribute [rw] fairshare_policy
|
2385
|
-
# The fair
|
2513
|
+
# The fair share policy of the scheduling policy.
|
2386
2514
|
# @return [Types::FairsharePolicy]
|
2387
2515
|
#
|
2388
2516
|
# @!attribute [rw] tags
|
@@ -2450,6 +2578,22 @@ module Aws::Batch
|
|
2450
2578
|
#
|
2451
2579
|
class DeleteComputeEnvironmentResponse < Aws::EmptyStructure; end
|
2452
2580
|
|
2581
|
+
# @!attribute [rw] consumable_resource
|
2582
|
+
# The name or ARN of the consumable resource that will be deleted.
|
2583
|
+
# @return [String]
|
2584
|
+
#
|
2585
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/DeleteConsumableResourceRequest AWS API Documentation
|
2586
|
+
#
|
2587
|
+
class DeleteConsumableResourceRequest < Struct.new(
|
2588
|
+
:consumable_resource)
|
2589
|
+
SENSITIVE = []
|
2590
|
+
include Aws::Structure
|
2591
|
+
end
|
2592
|
+
|
2593
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/DeleteConsumableResourceResponse AWS API Documentation
|
2594
|
+
#
|
2595
|
+
class DeleteConsumableResourceResponse < Aws::EmptyStructure; end
|
2596
|
+
|
2453
2597
|
# Contains the parameters for `DeleteJobQueue`.
|
2454
2598
|
#
|
2455
2599
|
# @!attribute [rw] job_queue
|
@@ -2570,6 +2714,80 @@ module Aws::Batch
|
|
2570
2714
|
include Aws::Structure
|
2571
2715
|
end
|
2572
2716
|
|
2717
|
+
# @!attribute [rw] consumable_resource
|
2718
|
+
# The name or ARN of the consumable resource whose description will be
|
2719
|
+
# returned.
|
2720
|
+
# @return [String]
|
2721
|
+
#
|
2722
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/DescribeConsumableResourceRequest AWS API Documentation
|
2723
|
+
#
|
2724
|
+
class DescribeConsumableResourceRequest < Struct.new(
|
2725
|
+
:consumable_resource)
|
2726
|
+
SENSITIVE = []
|
2727
|
+
include Aws::Structure
|
2728
|
+
end
|
2729
|
+
|
2730
|
+
# @!attribute [rw] consumable_resource_name
|
2731
|
+
# The name of the consumable resource.
|
2732
|
+
# @return [String]
|
2733
|
+
#
|
2734
|
+
# @!attribute [rw] consumable_resource_arn
|
2735
|
+
# The Amazon Resource Name (ARN) of the consumable resource.
|
2736
|
+
# @return [String]
|
2737
|
+
#
|
2738
|
+
# @!attribute [rw] total_quantity
|
2739
|
+
# The total amount of the consumable resource that is available.
|
2740
|
+
# @return [Integer]
|
2741
|
+
#
|
2742
|
+
# @!attribute [rw] in_use_quantity
|
2743
|
+
# The amount of the consumable resource that is currently in use.
|
2744
|
+
# @return [Integer]
|
2745
|
+
#
|
2746
|
+
# @!attribute [rw] available_quantity
|
2747
|
+
# The amount of the consumable resource that is currently available to
|
2748
|
+
# use.
|
2749
|
+
# @return [Integer]
|
2750
|
+
#
|
2751
|
+
# @!attribute [rw] resource_type
|
2752
|
+
# Indicates whether the resource is available to be re-used after a
|
2753
|
+
# job completes. Can be one of:
|
2754
|
+
#
|
2755
|
+
# * `REPLENISHABLE`
|
2756
|
+
#
|
2757
|
+
# * `NON_REPLENISHABLE`
|
2758
|
+
# @return [String]
|
2759
|
+
#
|
2760
|
+
# @!attribute [rw] created_at
|
2761
|
+
# The Unix timestamp (in milliseconds) for when the consumable
|
2762
|
+
# resource was created.
|
2763
|
+
# @return [Integer]
|
2764
|
+
#
|
2765
|
+
# @!attribute [rw] tags
|
2766
|
+
# The tags that you apply to the consumable resource to help you
|
2767
|
+
# categorize and organize your resources. Each tag consists of a key
|
2768
|
+
# and an optional value. For more information, see [Tagging your Batch
|
2769
|
+
# resources][1].
|
2770
|
+
#
|
2771
|
+
#
|
2772
|
+
#
|
2773
|
+
# [1]: https://docs.aws.amazon.com/batch/latest/userguide/using-tags.html
|
2774
|
+
# @return [Hash<String,String>]
|
2775
|
+
#
|
2776
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/DescribeConsumableResourceResponse AWS API Documentation
|
2777
|
+
#
|
2778
|
+
class DescribeConsumableResourceResponse < Struct.new(
|
2779
|
+
:consumable_resource_name,
|
2780
|
+
:consumable_resource_arn,
|
2781
|
+
:total_quantity,
|
2782
|
+
:in_use_quantity,
|
2783
|
+
:available_quantity,
|
2784
|
+
:resource_type,
|
2785
|
+
:created_at,
|
2786
|
+
:tags)
|
2787
|
+
SENSITIVE = []
|
2788
|
+
include Aws::Structure
|
2789
|
+
end
|
2790
|
+
|
2573
2791
|
# Contains the parameters for `DescribeJobDefinitions`.
|
2574
2792
|
#
|
2575
2793
|
# @!attribute [rw] job_definitions
|
@@ -4450,7 +4668,7 @@ module Aws::Batch
|
|
4450
4668
|
#
|
4451
4669
|
# @!attribute [rw] init_containers
|
4452
4670
|
# The overrides for the `initContainers` defined in the Amazon EKS
|
4453
|
-
# pod. These containers run before application containers, always
|
4671
|
+
# pod. These containers run before application containers, always runs
|
4454
4672
|
# to completion, and must complete successfully before the next
|
4455
4673
|
# container starts. These containers are registered with the Amazon
|
4456
4674
|
# EKS Connector agent and persists the registration information in the
|
@@ -4683,13 +4901,13 @@ module Aws::Batch
|
|
4683
4901
|
include Aws::Structure
|
4684
4902
|
end
|
4685
4903
|
|
4686
|
-
# The fair
|
4904
|
+
# The fair share policy for a scheduling policy.
|
4687
4905
|
#
|
4688
4906
|
# @!attribute [rw] share_decay_seconds
|
4689
|
-
# The amount of time (in seconds) to use to calculate a fair
|
4690
|
-
# percentage for each share identifier in use. A value of zero
|
4691
|
-
# indicates the default minimum time window (600 seconds). The
|
4692
|
-
# supported value is 604800 (1 week).
|
4907
|
+
# The amount of time (in seconds) to use to calculate a fair share
|
4908
|
+
# percentage for each fair share identifier in use. A value of zero
|
4909
|
+
# (0) indicates the default minimum time window (600 seconds). The
|
4910
|
+
# maximum supported value is 604800 (1 week).
|
4693
4911
|
#
|
4694
4912
|
# The decay allows for more recently run jobs to have more weight than
|
4695
4913
|
# jobs that ran earlier. Consider adjusting this number if you have
|
@@ -4699,29 +4917,29 @@ module Aws::Batch
|
|
4699
4917
|
# @return [Integer]
|
4700
4918
|
#
|
4701
4919
|
# @!attribute [rw] compute_reservation
|
4702
|
-
# A value used to reserve some of the available maximum vCPU for
|
4703
|
-
# identifiers that aren't already used.
|
4920
|
+
# A value used to reserve some of the available maximum vCPU for fair
|
4921
|
+
# share identifiers that aren't already used.
|
4704
4922
|
#
|
4705
4923
|
# The reserved ratio is `(computeReservation/100)^ActiveFairShares `
|
4706
|
-
# where ` ActiveFairShares ` is the number of active share
|
4924
|
+
# where ` ActiveFairShares ` is the number of active fair share
|
4707
4925
|
# identifiers.
|
4708
4926
|
#
|
4709
4927
|
# For example, a `computeReservation` value of 50 indicates that Batch
|
4710
|
-
# reserves 50% of the maximum available vCPU if there's only one
|
4711
|
-
# share identifier. It reserves 25% if there are two share
|
4712
|
-
# identifiers. It reserves 12.5% if there are three share
|
4713
|
-
# A `computeReservation` value of 25 indicates that Batch
|
4714
|
-
# reserve 25% of the maximum available vCPU if there's only
|
4715
|
-
# identifier, 6.25% if there are two fair share
|
4716
|
-
# if there are three share identifiers.
|
4928
|
+
# reserves 50% of the maximum available vCPU if there's only one fair
|
4929
|
+
# share identifier. It reserves 25% if there are two fair share
|
4930
|
+
# identifiers. It reserves 12.5% if there are three fair share
|
4931
|
+
# identifiers. A `computeReservation` value of 25 indicates that Batch
|
4932
|
+
# should reserve 25% of the maximum available vCPU if there's only
|
4933
|
+
# one fair share identifier, 6.25% if there are two fair share
|
4934
|
+
# identifiers, and 1.56% if there are three fair share identifiers.
|
4717
4935
|
#
|
4718
4936
|
# The minimum value is 0 and the maximum value is 99.
|
4719
4937
|
# @return [Integer]
|
4720
4938
|
#
|
4721
4939
|
# @!attribute [rw] share_distribution
|
4722
4940
|
# An array of `SharedIdentifier` objects that contain the weights for
|
4723
|
-
# the share identifiers for the fair
|
4724
|
-
# that aren't included have a default weight of `1.0`.
|
4941
|
+
# the fair share identifiers for the fair share policy. Fair share
|
4942
|
+
# identifiers that aren't included have a default weight of `1.0`.
|
4725
4943
|
# @return [Array<Types::ShareAttributes>]
|
4726
4944
|
#
|
4727
4945
|
# @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/FairsharePolicy AWS API Documentation
|
@@ -4766,7 +4984,7 @@ module Aws::Batch
|
|
4766
4984
|
# @!attribute [rw] jobs
|
4767
4985
|
# The Amazon Resource Names (ARNs) of the first 100 `RUNNABLE` jobs in
|
4768
4986
|
# a named job queue. For first-in-first-out (FIFO) job queues, jobs
|
4769
|
-
# are ordered based on their submission time. For fair
|
4987
|
+
# are ordered based on their submission time. For fair share
|
4770
4988
|
# scheduling (FSS) job queues, jobs are ordered based on their job
|
4771
4989
|
# priority and share usage.
|
4772
4990
|
# @return [Array<Types::FrontOfQueueJobSummary>]
|
@@ -4821,7 +5039,7 @@ module Aws::Batch
|
|
4821
5039
|
# @!attribute [rw] front_of_queue
|
4822
5040
|
# The list of the first 100 `RUNNABLE` jobs in each job queue. For
|
4823
5041
|
# first-in-first-out (FIFO) job queues, jobs are ordered based on
|
4824
|
-
# their submission time. For fair
|
5042
|
+
# their submission time. For fair share scheduling (FSS) job queues,
|
4825
5043
|
# jobs are ordered based on their job priority and share usage.
|
4826
5044
|
# @return [Types::FrontOfQueueDetail]
|
4827
5045
|
#
|
@@ -4913,7 +5131,7 @@ module Aws::Batch
|
|
4913
5131
|
#
|
4914
5132
|
# @!attribute [rw] scheduling_priority
|
4915
5133
|
# The scheduling priority of the job definition. This only affects
|
4916
|
-
# jobs in job queues with a fair
|
5134
|
+
# jobs in job queues with a fair share policy. Jobs with a higher
|
4917
5135
|
# scheduling priority are scheduled before jobs with a lower
|
4918
5136
|
# scheduling priority.
|
4919
5137
|
# @return [Integer]
|
@@ -5000,6 +5218,10 @@ module Aws::Batch
|
|
5000
5218
|
# are `ECS` (default) or `EKS`.
|
5001
5219
|
# @return [String]
|
5002
5220
|
#
|
5221
|
+
# @!attribute [rw] consumable_resource_properties
|
5222
|
+
# Contains a list of consumable resources required by the job.
|
5223
|
+
# @return [Types::ConsumableResourceProperties]
|
5224
|
+
#
|
5003
5225
|
# @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/JobDefinition AWS API Documentation
|
5004
5226
|
#
|
5005
5227
|
class JobDefinition < Struct.new(
|
@@ -5019,7 +5241,8 @@ module Aws::Batch
|
|
5019
5241
|
:platform_capabilities,
|
5020
5242
|
:ecs_properties,
|
5021
5243
|
:eks_properties,
|
5022
|
-
:container_orchestration_type
|
5244
|
+
:container_orchestration_type,
|
5245
|
+
:consumable_resource_properties)
|
5023
5246
|
SENSITIVE = []
|
5024
5247
|
include Aws::Structure
|
5025
5248
|
end
|
@@ -5082,7 +5305,7 @@ module Aws::Batch
|
|
5082
5305
|
#
|
5083
5306
|
# @!attribute [rw] scheduling_priority
|
5084
5307
|
# The scheduling policy of the job definition. This only affects jobs
|
5085
|
-
# in job queues with a fair
|
5308
|
+
# in job queues with a fair share policy. Jobs with a higher
|
5086
5309
|
# scheduling priority are scheduled before jobs with a lower
|
5087
5310
|
# scheduling priority.
|
5088
5311
|
# @return [Integer]
|
@@ -5225,6 +5448,10 @@ module Aws::Batch
|
|
5225
5448
|
# Indicates whether the job is terminated.
|
5226
5449
|
# @return [Boolean]
|
5227
5450
|
#
|
5451
|
+
# @!attribute [rw] consumable_resource_properties
|
5452
|
+
# Contains a list of consumable resources required by the job.
|
5453
|
+
# @return [Types::ConsumableResourceProperties]
|
5454
|
+
#
|
5228
5455
|
# @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/JobDetail AWS API Documentation
|
5229
5456
|
#
|
5230
5457
|
class JobDetail < Struct.new(
|
@@ -5256,7 +5483,8 @@ module Aws::Batch
|
|
5256
5483
|
:eks_attempts,
|
5257
5484
|
:ecs_properties,
|
5258
5485
|
:is_cancelled,
|
5259
|
-
:is_terminated
|
5486
|
+
:is_terminated,
|
5487
|
+
:consumable_resource_properties)
|
5260
5488
|
SENSITIVE = []
|
5261
5489
|
include Aws::Structure
|
5262
5490
|
end
|
@@ -5535,7 +5763,8 @@ module Aws::Batch
|
|
5535
5763
|
end
|
5536
5764
|
|
5537
5765
|
# A filter name and value pair that's used to return a more specific
|
5538
|
-
# list of results from a `ListJobs`
|
5766
|
+
# list of results from a `ListJobs` or `ListJobsByConsumableResource`
|
5767
|
+
# API operation.
|
5539
5768
|
#
|
5540
5769
|
# @!attribute [rw] name
|
5541
5770
|
# The name of the filter. Filter names are case sensitive.
|
@@ -5823,7 +6052,7 @@ module Aws::Batch
|
|
5823
6052
|
# If a `maxSwap` value of `0` is specified, the container doesn't use
|
5824
6053
|
# swap. Accepted values are `0` or any positive integer. If the
|
5825
6054
|
# `maxSwap` parameter is omitted, the container doesn't use the swap
|
5826
|
-
# configuration for the container instance
|
6055
|
+
# configuration for the container instance that it's running on. A
|
5827
6056
|
# `maxSwap` value must be set for the `swappiness` parameter to be
|
5828
6057
|
# used.
|
5829
6058
|
#
|
@@ -5898,6 +6127,240 @@ module Aws::Batch
|
|
5898
6127
|
include Aws::Structure
|
5899
6128
|
end
|
5900
6129
|
|
6130
|
+
# @!attribute [rw] filters
|
6131
|
+
# The filters to apply to the consumable resource list query. If used,
|
6132
|
+
# only those consumable resources that match the filter are listed.
|
6133
|
+
# Filter names and values can be:
|
6134
|
+
#
|
6135
|
+
# * name: `CONSUMABLE_RESOURCE_NAME `
|
6136
|
+
#
|
6137
|
+
# values: case-insensitive matches for the consumable resource name.
|
6138
|
+
# If a filter value ends with an asterisk (*), it matches any
|
6139
|
+
# consumable resource name that begins with the string before the
|
6140
|
+
# '*'.
|
6141
|
+
# @return [Array<Types::KeyValuesPair>]
|
6142
|
+
#
|
6143
|
+
# @!attribute [rw] max_results
|
6144
|
+
# The maximum number of results returned by `ListConsumableResources`
|
6145
|
+
# in paginated output. When this parameter is used,
|
6146
|
+
# `ListConsumableResources` only returns `maxResults` results in a
|
6147
|
+
# single page and a `nextToken` response element. The remaining
|
6148
|
+
# results of the initial request can be seen by sending another
|
6149
|
+
# `ListConsumableResources` request with the returned `nextToken`
|
6150
|
+
# value. This value can be between 1 and 100. If this parameter isn't
|
6151
|
+
# used, then `ListConsumableResources` returns up to 100 results and a
|
6152
|
+
# `nextToken` value if applicable.
|
6153
|
+
# @return [Integer]
|
6154
|
+
#
|
6155
|
+
# @!attribute [rw] next_token
|
6156
|
+
# The `nextToken` value returned from a previous paginated
|
6157
|
+
# `ListConsumableResources` request where `maxResults` was used and
|
6158
|
+
# the results exceeded the value of that parameter. Pagination
|
6159
|
+
# continues from the end of the previous results that returned the
|
6160
|
+
# `nextToken` value. This value is `null` when there are no more
|
6161
|
+
# results to return.
|
6162
|
+
#
|
6163
|
+
# <note markdown="1"> Treat this token as an opaque identifier that's only used to
|
6164
|
+
# retrieve the next items in a list and not for other programmatic
|
6165
|
+
# purposes.
|
6166
|
+
#
|
6167
|
+
# </note>
|
6168
|
+
# @return [String]
|
6169
|
+
#
|
6170
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/ListConsumableResourcesRequest AWS API Documentation
|
6171
|
+
#
|
6172
|
+
class ListConsumableResourcesRequest < Struct.new(
|
6173
|
+
:filters,
|
6174
|
+
:max_results,
|
6175
|
+
:next_token)
|
6176
|
+
SENSITIVE = []
|
6177
|
+
include Aws::Structure
|
6178
|
+
end
|
6179
|
+
|
6180
|
+
# @!attribute [rw] consumable_resources
|
6181
|
+
# A list of consumable resources that match the request.
|
6182
|
+
# @return [Array<Types::ConsumableResourceSummary>]
|
6183
|
+
#
|
6184
|
+
# @!attribute [rw] next_token
|
6185
|
+
# The `nextToken` value to include in a future
|
6186
|
+
# `ListConsumableResources` request. When the results of a
|
6187
|
+
# `ListConsumableResources` request exceed `maxResults`, this value
|
6188
|
+
# can be used to retrieve the next page of results. This value is
|
6189
|
+
# `null` when there are no more results to return.
|
6190
|
+
# @return [String]
|
6191
|
+
#
|
6192
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/ListConsumableResourcesResponse AWS API Documentation
|
6193
|
+
#
|
6194
|
+
class ListConsumableResourcesResponse < Struct.new(
|
6195
|
+
:consumable_resources,
|
6196
|
+
:next_token)
|
6197
|
+
SENSITIVE = []
|
6198
|
+
include Aws::Structure
|
6199
|
+
end
|
6200
|
+
|
6201
|
+
# @!attribute [rw] consumable_resource
|
6202
|
+
# The name or ARN of the consumable resource.
|
6203
|
+
# @return [String]
|
6204
|
+
#
|
6205
|
+
# @!attribute [rw] filters
|
6206
|
+
# The filters to apply to the job list query. If used, only those jobs
|
6207
|
+
# requiring the specified consumable resource (`consumableResource`)
|
6208
|
+
# and that match the value of the filters are listed. The filter names
|
6209
|
+
# and values can be:
|
6210
|
+
#
|
6211
|
+
# * name: `JOB_STATUS`
|
6212
|
+
#
|
6213
|
+
# values: `SUBMITTED | PENDING | RUNNABLE | STARTING | RUNNING |
|
6214
|
+
# SUCCEEDED | FAILED`
|
6215
|
+
#
|
6216
|
+
# * name: `JOB_NAME `
|
6217
|
+
#
|
6218
|
+
# The values are case-insensitive matches for the job name. If a
|
6219
|
+
# filter value ends with an asterisk (*), it matches any job name
|
6220
|
+
# that begins with the string before the '*'.
|
6221
|
+
# @return [Array<Types::KeyValuesPair>]
|
6222
|
+
#
|
6223
|
+
# @!attribute [rw] max_results
|
6224
|
+
# The maximum number of results returned by
|
6225
|
+
# `ListJobsByConsumableResource` in paginated output. When this
|
6226
|
+
# parameter is used, `ListJobsByConsumableResource` only returns
|
6227
|
+
# `maxResults` results in a single page and a `nextToken` response
|
6228
|
+
# element. The remaining results of the initial request can be seen by
|
6229
|
+
# sending another `ListJobsByConsumableResource` request with the
|
6230
|
+
# returned `nextToken` value. This value can be between 1 and 100. If
|
6231
|
+
# this parameter isn't used, then `ListJobsByConsumableResource`
|
6232
|
+
# returns up to 100 results and a `nextToken` value if applicable.
|
6233
|
+
# @return [Integer]
|
6234
|
+
#
|
6235
|
+
# @!attribute [rw] next_token
|
6236
|
+
# The `nextToken` value returned from a previous paginated
|
6237
|
+
# `ListJobsByConsumableResource` request where `maxResults` was used
|
6238
|
+
# and the results exceeded the value of that parameter. Pagination
|
6239
|
+
# continues from the end of the previous results that returned the
|
6240
|
+
# `nextToken` value. This value is `null` when there are no more
|
6241
|
+
# results to return.
|
6242
|
+
#
|
6243
|
+
# <note markdown="1"> Treat this token as an opaque identifier that's only used to
|
6244
|
+
# retrieve the next items in a list and not for other programmatic
|
6245
|
+
# purposes.
|
6246
|
+
#
|
6247
|
+
# </note>
|
6248
|
+
# @return [String]
|
6249
|
+
#
|
6250
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/ListJobsByConsumableResourceRequest AWS API Documentation
|
6251
|
+
#
|
6252
|
+
class ListJobsByConsumableResourceRequest < Struct.new(
|
6253
|
+
:consumable_resource,
|
6254
|
+
:filters,
|
6255
|
+
:max_results,
|
6256
|
+
:next_token)
|
6257
|
+
SENSITIVE = []
|
6258
|
+
include Aws::Structure
|
6259
|
+
end
|
6260
|
+
|
6261
|
+
# @!attribute [rw] jobs
|
6262
|
+
# The list of jobs that require the specified consumable resources.
|
6263
|
+
# @return [Array<Types::ListJobsByConsumableResourceSummary>]
|
6264
|
+
#
|
6265
|
+
# @!attribute [rw] next_token
|
6266
|
+
# The `nextToken` value to include in a future
|
6267
|
+
# `ListJobsByConsumableResource` request. When the results of a
|
6268
|
+
# `ListJobsByConsumableResource` request exceed `maxResults`, this
|
6269
|
+
# value can be used to retrieve the next page of results. This value
|
6270
|
+
# is `null` when there are no more results to return.
|
6271
|
+
# @return [String]
|
6272
|
+
#
|
6273
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/ListJobsByConsumableResourceResponse AWS API Documentation
|
6274
|
+
#
|
6275
|
+
class ListJobsByConsumableResourceResponse < Struct.new(
|
6276
|
+
:jobs,
|
6277
|
+
:next_token)
|
6278
|
+
SENSITIVE = []
|
6279
|
+
include Aws::Structure
|
6280
|
+
end
|
6281
|
+
|
6282
|
+
# Current information about a consumable resource required by a job.
|
6283
|
+
#
|
6284
|
+
# @!attribute [rw] job_arn
|
6285
|
+
# The Amazon Resource Name (ARN) of the job.
|
6286
|
+
# @return [String]
|
6287
|
+
#
|
6288
|
+
# @!attribute [rw] job_queue_arn
|
6289
|
+
# The Amazon Resource Name (ARN) of the job queue.
|
6290
|
+
# @return [String]
|
6291
|
+
#
|
6292
|
+
# @!attribute [rw] job_name
|
6293
|
+
# The name of the job.
|
6294
|
+
# @return [String]
|
6295
|
+
#
|
6296
|
+
# @!attribute [rw] job_definition_arn
|
6297
|
+
# The Amazon Resource Name (ARN) of the job definition.
|
6298
|
+
# @return [String]
|
6299
|
+
#
|
6300
|
+
# @!attribute [rw] share_identifier
|
6301
|
+
# The fair-share scheduling policy identifier for the job.
|
6302
|
+
# @return [String]
|
6303
|
+
#
|
6304
|
+
# @!attribute [rw] job_status
|
6305
|
+
# The status of the job. Can be one of:
|
6306
|
+
#
|
6307
|
+
# * `SUBMITTED`
|
6308
|
+
#
|
6309
|
+
# * `PENDING`
|
6310
|
+
#
|
6311
|
+
# * `RUNNABLE`
|
6312
|
+
#
|
6313
|
+
# * `STARTING`
|
6314
|
+
#
|
6315
|
+
# * `RUNNING`
|
6316
|
+
#
|
6317
|
+
# * `SUCCEEDED`
|
6318
|
+
#
|
6319
|
+
# * `FAILED`
|
6320
|
+
# @return [String]
|
6321
|
+
#
|
6322
|
+
# @!attribute [rw] quantity
|
6323
|
+
# The total amount of the consumable resource that is available.
|
6324
|
+
# @return [Integer]
|
6325
|
+
#
|
6326
|
+
# @!attribute [rw] status_reason
|
6327
|
+
# A short, human-readable string to provide more details for the
|
6328
|
+
# current status of the job.
|
6329
|
+
# @return [String]
|
6330
|
+
#
|
6331
|
+
# @!attribute [rw] started_at
|
6332
|
+
# The Unix timestamp for when the job was started. More specifically,
|
6333
|
+
# it's when the job transitioned from the `STARTING` state to the
|
6334
|
+
# `RUNNING` state.
|
6335
|
+
# @return [Integer]
|
6336
|
+
#
|
6337
|
+
# @!attribute [rw] created_at
|
6338
|
+
# The Unix timestamp (in milliseconds) for when the consumable
|
6339
|
+
# resource was created.
|
6340
|
+
# @return [Integer]
|
6341
|
+
#
|
6342
|
+
# @!attribute [rw] consumable_resource_properties
|
6343
|
+
# Contains a list of consumable resources required by the job.
|
6344
|
+
# @return [Types::ConsumableResourceProperties]
|
6345
|
+
#
|
6346
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/ListJobsByConsumableResourceSummary AWS API Documentation
|
6347
|
+
#
|
6348
|
+
class ListJobsByConsumableResourceSummary < Struct.new(
|
6349
|
+
:job_arn,
|
6350
|
+
:job_queue_arn,
|
6351
|
+
:job_name,
|
6352
|
+
:job_definition_arn,
|
6353
|
+
:share_identifier,
|
6354
|
+
:job_status,
|
6355
|
+
:quantity,
|
6356
|
+
:status_reason,
|
6357
|
+
:started_at,
|
6358
|
+
:created_at,
|
6359
|
+
:consumable_resource_properties)
|
6360
|
+
SENSITIVE = []
|
6361
|
+
include Aws::Structure
|
6362
|
+
end
|
6363
|
+
|
5901
6364
|
# Contains the parameters for `ListJobs`.
|
5902
6365
|
#
|
5903
6366
|
# @!attribute [rw] job_queue
|
@@ -6493,6 +6956,11 @@ module Aws::Batch
|
|
6493
6956
|
# the existing Amazon EKS resources of a job.
|
6494
6957
|
# @return [Types::EksPropertiesOverride]
|
6495
6958
|
#
|
6959
|
+
# @!attribute [rw] consumable_resource_properties_override
|
6960
|
+
# An object that contains overrides for the consumable resources of a
|
6961
|
+
# job.
|
6962
|
+
# @return [Types::ConsumableResourceProperties]
|
6963
|
+
#
|
6496
6964
|
# @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/NodePropertyOverride AWS API Documentation
|
6497
6965
|
#
|
6498
6966
|
class NodePropertyOverride < Struct.new(
|
@@ -6500,7 +6968,8 @@ module Aws::Batch
|
|
6500
6968
|
:container_overrides,
|
6501
6969
|
:ecs_properties_override,
|
6502
6970
|
:instance_types,
|
6503
|
-
:eks_properties_override
|
6971
|
+
:eks_properties_override,
|
6972
|
+
:consumable_resource_properties_override)
|
6504
6973
|
SENSITIVE = []
|
6505
6974
|
include Aws::Structure
|
6506
6975
|
end
|
@@ -6545,6 +7014,10 @@ module Aws::Batch
|
|
6545
7014
|
# for a multi-node parallel job.
|
6546
7015
|
# @return [Types::EksProperties]
|
6547
7016
|
#
|
7017
|
+
# @!attribute [rw] consumable_resource_properties
|
7018
|
+
# Contains a list of consumable resources required by a job.
|
7019
|
+
# @return [Types::ConsumableResourceProperties]
|
7020
|
+
#
|
6548
7021
|
# @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/NodeRangeProperty AWS API Documentation
|
6549
7022
|
#
|
6550
7023
|
class NodeRangeProperty < Struct.new(
|
@@ -6552,7 +7025,8 @@ module Aws::Batch
|
|
6552
7025
|
:container,
|
6553
7026
|
:instance_types,
|
6554
7027
|
:ecs_properties,
|
6555
|
-
:eks_properties
|
7028
|
+
:eks_properties,
|
7029
|
+
:consumable_resource_properties)
|
6556
7030
|
SENSITIVE = []
|
6557
7031
|
include Aws::Structure
|
6558
7032
|
end
|
@@ -6595,7 +7069,7 @@ module Aws::Batch
|
|
6595
7069
|
#
|
6596
7070
|
# @!attribute [rw] scheduling_priority
|
6597
7071
|
# The scheduling priority for jobs that are submitted with this job
|
6598
|
-
# definition. This only affects jobs in job queues with a fair
|
7072
|
+
# definition. This only affects jobs in job queues with a fair share
|
6599
7073
|
# policy. Jobs with a higher scheduling priority are scheduled before
|
6600
7074
|
# jobs with a lower scheduling priority.
|
6601
7075
|
#
|
@@ -6707,6 +7181,10 @@ module Aws::Batch
|
|
6707
7181
|
# definitions.
|
6708
7182
|
# @return [Types::EcsProperties]
|
6709
7183
|
#
|
7184
|
+
# @!attribute [rw] consumable_resource_properties
|
7185
|
+
# Contains a list of consumable resources required by the job.
|
7186
|
+
# @return [Types::ConsumableResourceProperties]
|
7187
|
+
#
|
6710
7188
|
# @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/RegisterJobDefinitionRequest AWS API Documentation
|
6711
7189
|
#
|
6712
7190
|
class RegisterJobDefinitionRequest < Struct.new(
|
@@ -6722,7 +7200,8 @@ module Aws::Batch
|
|
6722
7200
|
:tags,
|
6723
7201
|
:platform_capabilities,
|
6724
7202
|
:eks_properties,
|
6725
|
-
:ecs_properties
|
7203
|
+
:ecs_properties,
|
7204
|
+
:consumable_resource_properties)
|
6726
7205
|
SENSITIVE = []
|
6727
7206
|
include Aws::Structure
|
6728
7207
|
end
|
@@ -7034,7 +7513,7 @@ module Aws::Batch
|
|
7034
7513
|
# An object that represents a scheduling policy.
|
7035
7514
|
#
|
7036
7515
|
# @!attribute [rw] name
|
7037
|
-
# The name of the
|
7516
|
+
# The name of the scheduling policy.
|
7038
7517
|
# @return [String]
|
7039
7518
|
#
|
7040
7519
|
# @!attribute [rw] arn
|
@@ -7045,14 +7524,14 @@ module Aws::Batch
|
|
7045
7524
|
# @return [String]
|
7046
7525
|
#
|
7047
7526
|
# @!attribute [rw] fairshare_policy
|
7048
|
-
# The fair
|
7527
|
+
# The fair share policy for the scheduling policy.
|
7049
7528
|
# @return [Types::FairsharePolicy]
|
7050
7529
|
#
|
7051
7530
|
# @!attribute [rw] tags
|
7052
|
-
# The tags that you apply to the
|
7053
|
-
#
|
7054
|
-
#
|
7055
|
-
#
|
7531
|
+
# The tags that you apply to the scheduling policy to categorize and
|
7532
|
+
# organize your resources. Each tag consists of a key and an optional
|
7533
|
+
# value. For more information, see [Tagging Amazon Web Services
|
7534
|
+
# resources][1] in *Amazon Web Services General Reference*.
|
7056
7535
|
#
|
7057
7536
|
#
|
7058
7537
|
#
|
@@ -7142,19 +7621,20 @@ module Aws::Batch
|
|
7142
7621
|
include Aws::Structure
|
7143
7622
|
end
|
7144
7623
|
|
7145
|
-
# Specifies the weights for the share identifiers for the fair
|
7146
|
-
# policy.
|
7147
|
-
# of `1.0`.
|
7624
|
+
# Specifies the weights for the fair share identifiers for the fair
|
7625
|
+
# share policy. Fair share identifiers that aren't included have a
|
7626
|
+
# default weight of `1.0`.
|
7148
7627
|
#
|
7149
7628
|
# @!attribute [rw] share_identifier
|
7150
|
-
# A share identifier or share identifier prefix. If the
|
7151
|
-
# with an asterisk (*), this entry specifies the weight
|
7152
|
-
# for share identifiers that start with that
|
7153
|
-
#
|
7154
|
-
# can't have one that specifies a
|
7155
|
-
#
|
7156
|
-
#
|
7157
|
-
#
|
7629
|
+
# A fair share identifier or fair share identifier prefix. If the
|
7630
|
+
# string ends with an asterisk (*), this entry specifies the weight
|
7631
|
+
# factor to use for fair share identifiers that start with that
|
7632
|
+
# prefix. The list of fair share identifiers in a fair share policy
|
7633
|
+
# can't overlap. For example, you can't have one that specifies a
|
7634
|
+
# `shareIdentifier` of `UserA*` and another that specifies a
|
7635
|
+
# `shareIdentifier` of `UserA-1`.
|
7636
|
+
#
|
7637
|
+
# There can be no more than 500 fair share identifiers active in a job
|
7158
7638
|
# queue.
|
7159
7639
|
#
|
7160
7640
|
# The string is limited to 255 alphanumeric characters, and can be
|
@@ -7162,10 +7642,10 @@ module Aws::Batch
|
|
7162
7642
|
# @return [String]
|
7163
7643
|
#
|
7164
7644
|
# @!attribute [rw] weight_factor
|
7165
|
-
# The weight factor for the share identifier. The default value
|
7166
|
-
# 1.0. A lower value has a higher priority for compute resources.
|
7167
|
-
# example, jobs that use a share identifier with a weight factor
|
7168
|
-
# 0.125 (1/8) get 8 times the compute resources of jobs that use a
|
7645
|
+
# The weight factor for the fair share identifier. The default value
|
7646
|
+
# is 1.0. A lower value has a higher priority for compute resources.
|
7647
|
+
# For example, jobs that use a share identifier with a weight factor
|
7648
|
+
# of 0.125 (1/8) get 8 times the compute resources of jobs that use a
|
7169
7649
|
# share identifier with a weight factor of 1.
|
7170
7650
|
#
|
7171
7651
|
# The smallest supported value is 0.0001, and the largest supported
|
@@ -7196,9 +7676,8 @@ module Aws::Batch
|
|
7196
7676
|
#
|
7197
7677
|
# @!attribute [rw] share_identifier
|
7198
7678
|
# The share identifier for the job. Don't specify this parameter if
|
7199
|
-
# the job queue doesn't have a
|
7200
|
-
#
|
7201
|
-
# must be specified.
|
7679
|
+
# the job queue doesn't have a scheduling policy. If the job queue
|
7680
|
+
# has a scheduling policy, then this parameter must be specified.
|
7202
7681
|
#
|
7203
7682
|
# This string is limited to 255 alphanumeric characters, and can be
|
7204
7683
|
# followed by an asterisk (*).
|
@@ -7206,7 +7685,7 @@ module Aws::Batch
|
|
7206
7685
|
#
|
7207
7686
|
# @!attribute [rw] scheduling_priority_override
|
7208
7687
|
# The scheduling priority for the job. This only affects jobs in job
|
7209
|
-
# queues with a fair
|
7688
|
+
# queues with a fair share policy. Jobs with a higher scheduling
|
7210
7689
|
# priority are scheduled before jobs with a lower scheduling priority.
|
7211
7690
|
# This overrides any scheduling priority in the job definition and
|
7212
7691
|
# works only within a single share identifier.
|
@@ -7333,6 +7812,11 @@ module Aws::Batch
|
|
7333
7812
|
# ECS resources.
|
7334
7813
|
# @return [Types::EcsPropertiesOverride]
|
7335
7814
|
#
|
7815
|
+
# @!attribute [rw] consumable_resource_properties_override
|
7816
|
+
# An object that contains overrides for the consumable resources of a
|
7817
|
+
# job.
|
7818
|
+
# @return [Types::ConsumableResourceProperties]
|
7819
|
+
#
|
7336
7820
|
# @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/SubmitJobRequest AWS API Documentation
|
7337
7821
|
#
|
7338
7822
|
class SubmitJobRequest < Struct.new(
|
@@ -7351,7 +7835,8 @@ module Aws::Batch
|
|
7351
7835
|
:timeout,
|
7352
7836
|
:tags,
|
7353
7837
|
:eks_properties_override,
|
7354
|
-
:ecs_properties_override
|
7838
|
+
:ecs_properties_override,
|
7839
|
+
:consumable_resource_properties_override)
|
7355
7840
|
SENSITIVE = []
|
7356
7841
|
include Aws::Structure
|
7357
7842
|
end
|
@@ -8317,9 +8802,9 @@ module Aws::Batch
|
|
8317
8802
|
# @!attribute [rw] unmanagedv_cpus
|
8318
8803
|
# The maximum number of vCPUs expected to be used for an unmanaged
|
8319
8804
|
# compute environment. Don't specify this parameter for a managed
|
8320
|
-
# compute environment. This parameter is only used for fair
|
8805
|
+
# compute environment. This parameter is only used for fair share
|
8321
8806
|
# scheduling to reserve vCPU capacity for new share identifiers. If
|
8322
|
-
# this parameter isn't provided for a fair
|
8807
|
+
# this parameter isn't provided for a fair share job queue, no vCPU
|
8323
8808
|
# capacity is reserved.
|
8324
8809
|
# @return [Integer]
|
8325
8810
|
#
|
@@ -8414,6 +8899,81 @@ module Aws::Batch
|
|
8414
8899
|
include Aws::Structure
|
8415
8900
|
end
|
8416
8901
|
|
8902
|
+
# @!attribute [rw] consumable_resource
|
8903
|
+
# The name or ARN of the consumable resource to be updated.
|
8904
|
+
# @return [String]
|
8905
|
+
#
|
8906
|
+
# @!attribute [rw] operation
|
8907
|
+
# Indicates how the quantity of the consumable resource will be
|
8908
|
+
# updated. Must be one of:
|
8909
|
+
#
|
8910
|
+
# * `SET`
|
8911
|
+
#
|
8912
|
+
# Sets the quantity of the resource to the value specified by the
|
8913
|
+
# `quantity` parameter.
|
8914
|
+
#
|
8915
|
+
# * `ADD`
|
8916
|
+
#
|
8917
|
+
# Increases the quantity of the resource by the value specified by
|
8918
|
+
# the `quantity` parameter.
|
8919
|
+
#
|
8920
|
+
# * `REMOVE`
|
8921
|
+
#
|
8922
|
+
# Reduces the quantity of the resource by the value specified by the
|
8923
|
+
# `quantity` parameter.
|
8924
|
+
# @return [String]
|
8925
|
+
#
|
8926
|
+
# @!attribute [rw] quantity
|
8927
|
+
# The change in the total quantity of the consumable resource. The
|
8928
|
+
# `operation` parameter determines whether the value specified here
|
8929
|
+
# will be the new total quantity, or the amount by which the total
|
8930
|
+
# quantity will be increased or reduced. Must be a non-negative value.
|
8931
|
+
# @return [Integer]
|
8932
|
+
#
|
8933
|
+
# @!attribute [rw] client_token
|
8934
|
+
# If this parameter is specified and two update requests with
|
8935
|
+
# identical payloads and `clientToken`s are received, these requests
|
8936
|
+
# are considered the same request and the second request is rejected.
|
8937
|
+
# A `clientToken` is valid for 8 hours or until one hour after the
|
8938
|
+
# consumable resource is deleted, whichever is less.
|
8939
|
+
#
|
8940
|
+
# **A suitable default value is auto-generated.** You should normally
|
8941
|
+
# not need to pass this option.
|
8942
|
+
# @return [String]
|
8943
|
+
#
|
8944
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/UpdateConsumableResourceRequest AWS API Documentation
|
8945
|
+
#
|
8946
|
+
class UpdateConsumableResourceRequest < Struct.new(
|
8947
|
+
:consumable_resource,
|
8948
|
+
:operation,
|
8949
|
+
:quantity,
|
8950
|
+
:client_token)
|
8951
|
+
SENSITIVE = []
|
8952
|
+
include Aws::Structure
|
8953
|
+
end
|
8954
|
+
|
8955
|
+
# @!attribute [rw] consumable_resource_name
|
8956
|
+
# The name of the consumable resource to be updated.
|
8957
|
+
# @return [String]
|
8958
|
+
#
|
8959
|
+
# @!attribute [rw] consumable_resource_arn
|
8960
|
+
# The Amazon Resource Name (ARN) of the consumable resource.
|
8961
|
+
# @return [String]
|
8962
|
+
#
|
8963
|
+
# @!attribute [rw] total_quantity
|
8964
|
+
# The total amount of the consumable resource that is available.
|
8965
|
+
# @return [Integer]
|
8966
|
+
#
|
8967
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/UpdateConsumableResourceResponse AWS API Documentation
|
8968
|
+
#
|
8969
|
+
class UpdateConsumableResourceResponse < Struct.new(
|
8970
|
+
:consumable_resource_name,
|
8971
|
+
:consumable_resource_arn,
|
8972
|
+
:total_quantity)
|
8973
|
+
SENSITIVE = []
|
8974
|
+
include Aws::Structure
|
8975
|
+
end
|
8976
|
+
|
8417
8977
|
# Contains the parameters for `UpdateJobQueue`.
|
8418
8978
|
#
|
8419
8979
|
# @!attribute [rw] job_queue
|
@@ -8428,8 +8988,8 @@ module Aws::Batch
|
|
8428
8988
|
# @return [String]
|
8429
8989
|
#
|
8430
8990
|
# @!attribute [rw] scheduling_policy_arn
|
8431
|
-
# Amazon Resource Name (ARN) of the fair
|
8432
|
-
# a job queue is created, the fair
|
8991
|
+
# Amazon Resource Name (ARN) of the fair share scheduling policy. Once
|
8992
|
+
# a job queue is created, the fair share scheduling policy can be
|
8433
8993
|
# replaced but not removed. The format is
|
8434
8994
|
# `aws:Partition:batch:Region:Account:scheduling-policy/Name `. For
|
8435
8995
|
# example,
|
@@ -8538,7 +9098,7 @@ module Aws::Batch
|
|
8538
9098
|
# @return [String]
|
8539
9099
|
#
|
8540
9100
|
# @!attribute [rw] fairshare_policy
|
8541
|
-
# The fair
|
9101
|
+
# The fair share policy.
|
8542
9102
|
# @return [Types::FairsharePolicy]
|
8543
9103
|
#
|
8544
9104
|
# @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/UpdateSchedulingPolicyRequest AWS API Documentation
|