aws-sdk-batch 1.137.0 → 1.138.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 +395 -8
- data/lib/aws-sdk-batch/client_api.rb +246 -0
- data/lib/aws-sdk-batch/types.rb +743 -25
- data/lib/aws-sdk-batch.rb +1 -1
- data/sig/client.rbs +119 -0
- data/sig/types.rbs +177 -0
- metadata +1 -1
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: f331089503bb1e1cbf925ba5964a7ced82204fb54ba3034f251b64eebe06c690
|
|
4
|
+
data.tar.gz: 24680629d1436f1e13fa3df18efd836a65bc772bf0bae84c5b5b549babd92384
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 54e7cd7814b4db981d66bd8b1dfaf9e370e62cd10d7a870e4d25d6512e6d60b0f7f71d8be5227161be4bf4fa87c24f8f1b3bea53619cf360a130abbc10aaf26e
|
|
7
|
+
data.tar.gz: 4a6f79eec7f5cdbb4cb9ca5f2f1a487893815bb363bc1dd62eb423a0701120352f84dc781705f572e5d4727122bcf1667ff4a1afd2d6d3f8149b04d4f5336974
|
data/CHANGELOG.md
CHANGED
|
@@ -1,6 +1,11 @@
|
|
|
1
1
|
Unreleased Changes
|
|
2
2
|
------------------
|
|
3
3
|
|
|
4
|
+
1.138.0 (2026-03-19)
|
|
5
|
+
------------------
|
|
6
|
+
|
|
7
|
+
* Feature - AWS Batch now supports quota management, enabling administrators to allocate shared compute resources across teams and projects through quota shares with capacity limits, resource-sharing strategies, and priority-based preemption - currently available for SageMaker Training job queues.
|
|
8
|
+
|
|
4
9
|
1.137.0 (2026-03-18)
|
|
5
10
|
------------------
|
|
6
11
|
|
data/VERSION
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
1.
|
|
1
|
+
1.138.0
|
data/lib/aws-sdk-batch/client.rb
CHANGED
|
@@ -1151,6 +1151,90 @@ module Aws::Batch
|
|
|
1151
1151
|
req.send_request(options)
|
|
1152
1152
|
end
|
|
1153
1153
|
|
|
1154
|
+
# Creates an Batch quota share. Each quota share operates as a virtual
|
|
1155
|
+
# queue with a configured compute capacity, resource sharing strategy,
|
|
1156
|
+
# and borrow limits.
|
|
1157
|
+
#
|
|
1158
|
+
# @option params [required, String] :quota_share_name
|
|
1159
|
+
# The name of the quota share. It can be up to 128 characters long. It
|
|
1160
|
+
# can contain uppercase and lowercase letters, numbers, hyphens (-), and
|
|
1161
|
+
# underscores (\_).
|
|
1162
|
+
#
|
|
1163
|
+
# @option params [required, String] :job_queue
|
|
1164
|
+
# The Batch job queue associated with the quota share. This can be the
|
|
1165
|
+
# job queue name or ARN. A job queue must be in the `VALID` state before
|
|
1166
|
+
# you can associate it with a quota share.
|
|
1167
|
+
#
|
|
1168
|
+
# @option params [required, Array<Types::QuotaShareCapacityLimit>] :capacity_limits
|
|
1169
|
+
# A list that specifies the quantity and type of compute capacity
|
|
1170
|
+
# allocated to the quota share.
|
|
1171
|
+
#
|
|
1172
|
+
# @option params [required, Types::QuotaShareResourceSharingConfiguration] :resource_sharing_configuration
|
|
1173
|
+
# Specifies whether a quota share reserves, lends, or both lends and
|
|
1174
|
+
# borrows idle compute capacity.
|
|
1175
|
+
#
|
|
1176
|
+
# @option params [required, Types::QuotaSharePreemptionConfiguration] :preemption_configuration
|
|
1177
|
+
# Specifies the preemption behavior for jobs in a quota share.
|
|
1178
|
+
#
|
|
1179
|
+
# @option params [String] :state
|
|
1180
|
+
# The state of the quota share. If the quota share is `ENABLED`, it is
|
|
1181
|
+
# able to accept jobs. If the quota share is `DISABLED`, new jobs won't
|
|
1182
|
+
# be accepted but jobs already submitted can finish. The default state
|
|
1183
|
+
# is `ENABLED`.
|
|
1184
|
+
#
|
|
1185
|
+
# @option params [Hash<String,String>] :tags
|
|
1186
|
+
# The tags that you apply to the quota share to help you categorize and
|
|
1187
|
+
# organize your resources. Each tag consists of a key and an optional
|
|
1188
|
+
# value. For more information, see [Tagging your Batch resources][1] in
|
|
1189
|
+
# *Batch User Guide*.
|
|
1190
|
+
#
|
|
1191
|
+
#
|
|
1192
|
+
#
|
|
1193
|
+
# [1]: https://docs.aws.amazon.com/batch/latest/userguide/using-tags.html
|
|
1194
|
+
#
|
|
1195
|
+
# @return [Types::CreateQuotaShareResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
1196
|
+
#
|
|
1197
|
+
# * {Types::CreateQuotaShareResponse#quota_share_name #quota_share_name} => String
|
|
1198
|
+
# * {Types::CreateQuotaShareResponse#quota_share_arn #quota_share_arn} => String
|
|
1199
|
+
#
|
|
1200
|
+
# @example Request syntax with placeholder values
|
|
1201
|
+
#
|
|
1202
|
+
# resp = client.create_quota_share({
|
|
1203
|
+
# quota_share_name: "String", # required
|
|
1204
|
+
# job_queue: "String", # required
|
|
1205
|
+
# capacity_limits: [ # required
|
|
1206
|
+
# {
|
|
1207
|
+
# max_capacity: 1, # required
|
|
1208
|
+
# capacity_unit: "String", # required
|
|
1209
|
+
# },
|
|
1210
|
+
# ],
|
|
1211
|
+
# resource_sharing_configuration: { # required
|
|
1212
|
+
# strategy: "RESERVE", # required, accepts RESERVE, LEND, LEND_AND_BORROW
|
|
1213
|
+
# borrow_limit: 1,
|
|
1214
|
+
# },
|
|
1215
|
+
# preemption_configuration: { # required
|
|
1216
|
+
# in_share_preemption: "ENABLED", # required, accepts ENABLED, DISABLED
|
|
1217
|
+
# },
|
|
1218
|
+
# state: "ENABLED", # accepts ENABLED, DISABLED
|
|
1219
|
+
# tags: {
|
|
1220
|
+
# "TagKey" => "TagValue",
|
|
1221
|
+
# },
|
|
1222
|
+
# })
|
|
1223
|
+
#
|
|
1224
|
+
# @example Response structure
|
|
1225
|
+
#
|
|
1226
|
+
# resp.quota_share_name #=> String
|
|
1227
|
+
# resp.quota_share_arn #=> String
|
|
1228
|
+
#
|
|
1229
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/CreateQuotaShare AWS API Documentation
|
|
1230
|
+
#
|
|
1231
|
+
# @overload create_quota_share(params = {})
|
|
1232
|
+
# @param [Hash] params ({})
|
|
1233
|
+
def create_quota_share(params = {}, options = {})
|
|
1234
|
+
req = build_request(:create_quota_share, params)
|
|
1235
|
+
req.send_request(options)
|
|
1236
|
+
end
|
|
1237
|
+
|
|
1154
1238
|
# Creates an Batch scheduling policy.
|
|
1155
1239
|
#
|
|
1156
1240
|
# @option params [required, String] :name
|
|
@@ -1158,8 +1242,15 @@ module Aws::Batch
|
|
|
1158
1242
|
# letters long. It can contain uppercase and lowercase letters, numbers,
|
|
1159
1243
|
# hyphens (-), and underscores (\_).
|
|
1160
1244
|
#
|
|
1245
|
+
# @option params [Types::QuotaSharePolicy] :quota_share_policy
|
|
1246
|
+
# The quota share scheduling policy details. Only one of fairsharePolicy
|
|
1247
|
+
# or quotaSharePolicy can be set. Once set, this policy type cannot be
|
|
1248
|
+
# removed or changed to a fairSharePolicy.
|
|
1249
|
+
#
|
|
1161
1250
|
# @option params [Types::FairsharePolicy] :fairshare_policy
|
|
1162
|
-
# The fair-share scheduling policy details.
|
|
1251
|
+
# The fair-share scheduling policy details. Only one of fairsharePolicy
|
|
1252
|
+
# or quotaSharePolicy can be set. Once set, this policy type cannot be
|
|
1253
|
+
# removed or changed to a quotaSharePolicy.
|
|
1163
1254
|
#
|
|
1164
1255
|
# @option params [Hash<String,String>] :tags
|
|
1165
1256
|
# The tags that you apply to the scheduling policy to help you
|
|
@@ -1185,6 +1276,9 @@ module Aws::Batch
|
|
|
1185
1276
|
#
|
|
1186
1277
|
# resp = client.create_scheduling_policy({
|
|
1187
1278
|
# name: "String", # required
|
|
1279
|
+
# quota_share_policy: {
|
|
1280
|
+
# idle_resource_assignment_strategy: "FIFO", # required, accepts FIFO
|
|
1281
|
+
# },
|
|
1188
1282
|
# fairshare_policy: {
|
|
1189
1283
|
# share_decay_seconds: 1,
|
|
1190
1284
|
# compute_reservation: 1,
|
|
@@ -1363,8 +1457,7 @@ module Aws::Batch
|
|
|
1363
1457
|
|
|
1364
1458
|
# Deletes the specified job queue. You must first disable submissions
|
|
1365
1459
|
# for a queue with the UpdateJobQueue operation. All jobs in the queue
|
|
1366
|
-
# are eventually terminated when you delete a job queue.
|
|
1367
|
-
# terminated at a rate of about 16 jobs each second.
|
|
1460
|
+
# are eventually terminated when you delete a job queue.
|
|
1368
1461
|
#
|
|
1369
1462
|
# It's not necessary to disassociate compute environments from a queue
|
|
1370
1463
|
# before submitting a `DeleteJobQueue` request.
|
|
@@ -1403,6 +1496,31 @@ module Aws::Batch
|
|
|
1403
1496
|
req.send_request(options)
|
|
1404
1497
|
end
|
|
1405
1498
|
|
|
1499
|
+
# Deletes the specified quota share. You must first disable submissions
|
|
1500
|
+
# for the share by updating the state to `DISABLED` using the
|
|
1501
|
+
# UpdateQuotaShare operation. All jobs in the share are eventually
|
|
1502
|
+
# terminated when you delete a quota share.
|
|
1503
|
+
#
|
|
1504
|
+
# @option params [required, String] :quota_share_arn
|
|
1505
|
+
# The Amazon Resource Name (ARN) of the quota share.
|
|
1506
|
+
#
|
|
1507
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
|
1508
|
+
#
|
|
1509
|
+
# @example Request syntax with placeholder values
|
|
1510
|
+
#
|
|
1511
|
+
# resp = client.delete_quota_share({
|
|
1512
|
+
# quota_share_arn: "String", # required
|
|
1513
|
+
# })
|
|
1514
|
+
#
|
|
1515
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/DeleteQuotaShare AWS API Documentation
|
|
1516
|
+
#
|
|
1517
|
+
# @overload delete_quota_share(params = {})
|
|
1518
|
+
# @param [Hash] params ({})
|
|
1519
|
+
def delete_quota_share(params = {}, options = {})
|
|
1520
|
+
req = build_request(:delete_quota_share, params)
|
|
1521
|
+
req.send_request(options)
|
|
1522
|
+
end
|
|
1523
|
+
|
|
1406
1524
|
# Deletes the specified scheduling policy.
|
|
1407
1525
|
#
|
|
1408
1526
|
# You can't delete a scheduling policy that's used in any job queues.
|
|
@@ -3012,6 +3130,54 @@ module Aws::Batch
|
|
|
3012
3130
|
req.send_request(options)
|
|
3013
3131
|
end
|
|
3014
3132
|
|
|
3133
|
+
# Returns a description of the specified quota share.
|
|
3134
|
+
#
|
|
3135
|
+
# @option params [required, String] :quota_share_arn
|
|
3136
|
+
# The Amazon Resource Name (ARN) of the quota share.
|
|
3137
|
+
#
|
|
3138
|
+
# @return [Types::DescribeQuotaShareResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
3139
|
+
#
|
|
3140
|
+
# * {Types::DescribeQuotaShareResponse#quota_share_name #quota_share_name} => String
|
|
3141
|
+
# * {Types::DescribeQuotaShareResponse#quota_share_arn #quota_share_arn} => String
|
|
3142
|
+
# * {Types::DescribeQuotaShareResponse#job_queue_arn #job_queue_arn} => String
|
|
3143
|
+
# * {Types::DescribeQuotaShareResponse#capacity_limits #capacity_limits} => Array<Types::QuotaShareCapacityLimit>
|
|
3144
|
+
# * {Types::DescribeQuotaShareResponse#resource_sharing_configuration #resource_sharing_configuration} => Types::QuotaShareResourceSharingConfiguration
|
|
3145
|
+
# * {Types::DescribeQuotaShareResponse#preemption_configuration #preemption_configuration} => Types::QuotaSharePreemptionConfiguration
|
|
3146
|
+
# * {Types::DescribeQuotaShareResponse#state #state} => String
|
|
3147
|
+
# * {Types::DescribeQuotaShareResponse#status #status} => String
|
|
3148
|
+
# * {Types::DescribeQuotaShareResponse#tags #tags} => Hash<String,String>
|
|
3149
|
+
#
|
|
3150
|
+
# @example Request syntax with placeholder values
|
|
3151
|
+
#
|
|
3152
|
+
# resp = client.describe_quota_share({
|
|
3153
|
+
# quota_share_arn: "String", # required
|
|
3154
|
+
# })
|
|
3155
|
+
#
|
|
3156
|
+
# @example Response structure
|
|
3157
|
+
#
|
|
3158
|
+
# resp.quota_share_name #=> String
|
|
3159
|
+
# resp.quota_share_arn #=> String
|
|
3160
|
+
# resp.job_queue_arn #=> String
|
|
3161
|
+
# resp.capacity_limits #=> Array
|
|
3162
|
+
# resp.capacity_limits[0].max_capacity #=> Integer
|
|
3163
|
+
# resp.capacity_limits[0].capacity_unit #=> String
|
|
3164
|
+
# resp.resource_sharing_configuration.strategy #=> String, one of "RESERVE", "LEND", "LEND_AND_BORROW"
|
|
3165
|
+
# resp.resource_sharing_configuration.borrow_limit #=> Integer
|
|
3166
|
+
# resp.preemption_configuration.in_share_preemption #=> String, one of "ENABLED", "DISABLED"
|
|
3167
|
+
# resp.state #=> String, one of "ENABLED", "DISABLED"
|
|
3168
|
+
# resp.status #=> String, one of "CREATING", "VALID", "INVALID", "UPDATING", "DELETING"
|
|
3169
|
+
# resp.tags #=> Hash
|
|
3170
|
+
# resp.tags["TagKey"] #=> String
|
|
3171
|
+
#
|
|
3172
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/DescribeQuotaShare AWS API Documentation
|
|
3173
|
+
#
|
|
3174
|
+
# @overload describe_quota_share(params = {})
|
|
3175
|
+
# @param [Hash] params ({})
|
|
3176
|
+
def describe_quota_share(params = {}, options = {})
|
|
3177
|
+
req = build_request(:describe_quota_share, params)
|
|
3178
|
+
req.send_request(options)
|
|
3179
|
+
end
|
|
3180
|
+
|
|
3015
3181
|
# Describes one or more of your scheduling policies.
|
|
3016
3182
|
#
|
|
3017
3183
|
# @option params [required, Array<String>] :arns
|
|
@@ -3033,6 +3199,7 @@ module Aws::Batch
|
|
|
3033
3199
|
# resp.scheduling_policies #=> Array
|
|
3034
3200
|
# resp.scheduling_policies[0].name #=> String
|
|
3035
3201
|
# resp.scheduling_policies[0].arn #=> String
|
|
3202
|
+
# resp.scheduling_policies[0].quota_share_policy.idle_resource_assignment_strategy #=> String, one of "FIFO"
|
|
3036
3203
|
# resp.scheduling_policies[0].fairshare_policy.share_decay_seconds #=> Integer
|
|
3037
3204
|
# resp.scheduling_policies[0].fairshare_policy.compute_reservation #=> Integer
|
|
3038
3205
|
# resp.scheduling_policies[0].fairshare_policy.share_distribution #=> Array
|
|
@@ -3139,6 +3306,9 @@ module Aws::Batch
|
|
|
3139
3306
|
# * {Types::DescribeServiceJobResponse#service_request_payload #service_request_payload} => String
|
|
3140
3307
|
# * {Types::DescribeServiceJobResponse#service_job_type #service_job_type} => String
|
|
3141
3308
|
# * {Types::DescribeServiceJobResponse#share_identifier #share_identifier} => String
|
|
3309
|
+
# * {Types::DescribeServiceJobResponse#quota_share_name #quota_share_name} => String
|
|
3310
|
+
# * {Types::DescribeServiceJobResponse#preemption_configuration #preemption_configuration} => Types::ServiceJobPreemptionConfiguration
|
|
3311
|
+
# * {Types::DescribeServiceJobResponse#preemption_summary #preemption_summary} => Types::ServiceJobPreemptionSummary
|
|
3142
3312
|
# * {Types::DescribeServiceJobResponse#started_at #started_at} => Integer
|
|
3143
3313
|
# * {Types::DescribeServiceJobResponse#status #status} => String
|
|
3144
3314
|
# * {Types::DescribeServiceJobResponse#status_reason #status_reason} => String
|
|
@@ -3180,6 +3350,15 @@ module Aws::Batch
|
|
|
3180
3350
|
# resp.service_request_payload #=> String
|
|
3181
3351
|
# resp.service_job_type #=> String, one of "SAGEMAKER_TRAINING"
|
|
3182
3352
|
# resp.share_identifier #=> String
|
|
3353
|
+
# resp.quota_share_name #=> String
|
|
3354
|
+
# resp.preemption_configuration.preemption_retries_before_termination #=> Integer
|
|
3355
|
+
# resp.preemption_summary.preempted_attempt_count #=> Integer
|
|
3356
|
+
# resp.preemption_summary.recent_preempted_attempts #=> Array
|
|
3357
|
+
# resp.preemption_summary.recent_preempted_attempts[0].service_resource_id.name #=> String, one of "TrainingJobArn"
|
|
3358
|
+
# resp.preemption_summary.recent_preempted_attempts[0].service_resource_id.value #=> String
|
|
3359
|
+
# resp.preemption_summary.recent_preempted_attempts[0].started_at #=> Integer
|
|
3360
|
+
# resp.preemption_summary.recent_preempted_attempts[0].stopped_at #=> Integer
|
|
3361
|
+
# resp.preemption_summary.recent_preempted_attempts[0].status_reason #=> String
|
|
3183
3362
|
# resp.started_at #=> Integer
|
|
3184
3363
|
# resp.status #=> String, one of "SUBMITTED", "PENDING", "RUNNABLE", "SCHEDULED", "STARTING", "RUNNING", "SUCCEEDED", "FAILED"
|
|
3185
3364
|
# resp.status_reason #=> String
|
|
@@ -3197,9 +3376,14 @@ module Aws::Batch
|
|
|
3197
3376
|
req.send_request(options)
|
|
3198
3377
|
end
|
|
3199
3378
|
|
|
3200
|
-
# Provides a
|
|
3201
|
-
#
|
|
3202
|
-
#
|
|
3379
|
+
# Provides a snapshot of job queue state, including ordering of
|
|
3380
|
+
# `RUNNABLE` jobs, as well as capacity utilization for already
|
|
3381
|
+
# dispatched jobs. The first 100 `RUNNABLE` jobs in the job queue are
|
|
3382
|
+
# listed in order of dispatch. For job queues with an attached
|
|
3383
|
+
# quota-share policy, the first `RUNNABLE` job in each quota share is
|
|
3384
|
+
# also listed. Capacity utilization for the job queue is provided, as
|
|
3385
|
+
# well as break downs by share for job queues with attached fair-share
|
|
3386
|
+
# or quota-share scheduling policies.
|
|
3203
3387
|
#
|
|
3204
3388
|
# @option params [required, String] :job_queue
|
|
3205
3389
|
# The job queue’s name or full queue Amazon Resource Name (ARN).
|
|
@@ -3207,6 +3391,7 @@ module Aws::Batch
|
|
|
3207
3391
|
# @return [Types::GetJobQueueSnapshotResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
3208
3392
|
#
|
|
3209
3393
|
# * {Types::GetJobQueueSnapshotResponse#front_of_queue #front_of_queue} => Types::FrontOfQueueDetail
|
|
3394
|
+
# * {Types::GetJobQueueSnapshotResponse#front_of_quota_shares #front_of_quota_shares} => Types::FrontOfQuotaSharesDetail
|
|
3210
3395
|
# * {Types::GetJobQueueSnapshotResponse#queue_utilization #queue_utilization} => Types::QueueSnapshotUtilizationDetail
|
|
3211
3396
|
#
|
|
3212
3397
|
# @example Request syntax with placeholder values
|
|
@@ -3221,6 +3406,11 @@ module Aws::Batch
|
|
|
3221
3406
|
# resp.front_of_queue.jobs[0].job_arn #=> String
|
|
3222
3407
|
# resp.front_of_queue.jobs[0].earliest_time_at_position #=> Integer
|
|
3223
3408
|
# resp.front_of_queue.last_updated_at #=> Integer
|
|
3409
|
+
# resp.front_of_quota_shares.quota_shares #=> Hash
|
|
3410
|
+
# resp.front_of_quota_shares.quota_shares["String"] #=> Array
|
|
3411
|
+
# resp.front_of_quota_shares.quota_shares["String"][0].job_arn #=> String
|
|
3412
|
+
# resp.front_of_quota_shares.quota_shares["String"][0].earliest_time_at_position #=> Integer
|
|
3413
|
+
# resp.front_of_quota_shares.last_updated_at #=> Integer
|
|
3224
3414
|
# resp.queue_utilization.total_capacity_usage #=> Array
|
|
3225
3415
|
# resp.queue_utilization.total_capacity_usage[0].capacity_unit #=> String
|
|
3226
3416
|
# resp.queue_utilization.total_capacity_usage[0].quantity #=> Float
|
|
@@ -3230,6 +3420,11 @@ module Aws::Batch
|
|
|
3230
3420
|
# resp.queue_utilization.fairshare_utilization.top_capacity_utilization[0].capacity_usage #=> Array
|
|
3231
3421
|
# resp.queue_utilization.fairshare_utilization.top_capacity_utilization[0].capacity_usage[0].capacity_unit #=> String
|
|
3232
3422
|
# resp.queue_utilization.fairshare_utilization.top_capacity_utilization[0].capacity_usage[0].quantity #=> Float
|
|
3423
|
+
# resp.queue_utilization.quota_share_utilization.top_capacity_utilization #=> Array
|
|
3424
|
+
# resp.queue_utilization.quota_share_utilization.top_capacity_utilization[0].quota_share_name #=> String
|
|
3425
|
+
# resp.queue_utilization.quota_share_utilization.top_capacity_utilization[0].capacity_usage #=> Array
|
|
3426
|
+
# resp.queue_utilization.quota_share_utilization.top_capacity_utilization[0].capacity_usage[0].capacity_unit #=> String
|
|
3427
|
+
# resp.queue_utilization.quota_share_utilization.top_capacity_utilization[0].capacity_usage[0].quantity #=> Float
|
|
3233
3428
|
# resp.queue_utilization.last_updated_at #=> Integer
|
|
3234
3429
|
#
|
|
3235
3430
|
# @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/GetJobQueueSnapshot AWS API Documentation
|
|
@@ -3710,6 +3905,74 @@ module Aws::Batch
|
|
|
3710
3905
|
req.send_request(options)
|
|
3711
3906
|
end
|
|
3712
3907
|
|
|
3908
|
+
# Returns a list of Batch quota shares associated with a job queue.
|
|
3909
|
+
#
|
|
3910
|
+
# @option params [required, String] :job_queue
|
|
3911
|
+
# The name or full Amazon Resource Name (ARN) of the job queue used to
|
|
3912
|
+
# list quota shares.
|
|
3913
|
+
#
|
|
3914
|
+
# @option params [Integer] :max_results
|
|
3915
|
+
# The maximum number of results returned by `ListQuotaShares` in
|
|
3916
|
+
# paginated output. When this parameter is used, `ListQuotaShares` only
|
|
3917
|
+
# returns `maxResults` results in a single page and a `nextToken`
|
|
3918
|
+
# response element. You can see the remaining results of the initial
|
|
3919
|
+
# request by sending another `ListQuotaShares` request with the returned
|
|
3920
|
+
# `nextToken` value. This value can be between 1 and 100. If this
|
|
3921
|
+
# parameter isn't used, `ListQuotaShares` returns up to 100 results and
|
|
3922
|
+
# a `nextToken` value if applicable.
|
|
3923
|
+
#
|
|
3924
|
+
# @option params [String] :next_token
|
|
3925
|
+
# The `nextToken` value that's returned from a previous paginated
|
|
3926
|
+
# `ListQuotaShares` request where `maxResults` was used and the results
|
|
3927
|
+
# exceeded the value of that parameter. Pagination continues from the
|
|
3928
|
+
# end of the previous results that returned the `nextToken` value. This
|
|
3929
|
+
# value is `null` when there are no more results to return.
|
|
3930
|
+
#
|
|
3931
|
+
# <note markdown="1"> Treat this token as an opaque identifier that's only used to retrieve
|
|
3932
|
+
# the next items in a list and not for other programmatic purposes.
|
|
3933
|
+
#
|
|
3934
|
+
# </note>
|
|
3935
|
+
#
|
|
3936
|
+
# @return [Types::ListQuotaSharesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
3937
|
+
#
|
|
3938
|
+
# * {Types::ListQuotaSharesResponse#quota_shares #quota_shares} => Array<Types::QuotaShareDetail>
|
|
3939
|
+
# * {Types::ListQuotaSharesResponse#next_token #next_token} => String
|
|
3940
|
+
#
|
|
3941
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
|
3942
|
+
#
|
|
3943
|
+
# @example Request syntax with placeholder values
|
|
3944
|
+
#
|
|
3945
|
+
# resp = client.list_quota_shares({
|
|
3946
|
+
# job_queue: "String", # required
|
|
3947
|
+
# max_results: 1,
|
|
3948
|
+
# next_token: "String",
|
|
3949
|
+
# })
|
|
3950
|
+
#
|
|
3951
|
+
# @example Response structure
|
|
3952
|
+
#
|
|
3953
|
+
# resp.quota_shares #=> Array
|
|
3954
|
+
# resp.quota_shares[0].quota_share_name #=> String
|
|
3955
|
+
# resp.quota_shares[0].quota_share_arn #=> String
|
|
3956
|
+
# resp.quota_shares[0].job_queue_arn #=> String
|
|
3957
|
+
# resp.quota_shares[0].capacity_limits #=> Array
|
|
3958
|
+
# resp.quota_shares[0].capacity_limits[0].max_capacity #=> Integer
|
|
3959
|
+
# resp.quota_shares[0].capacity_limits[0].capacity_unit #=> String
|
|
3960
|
+
# resp.quota_shares[0].resource_sharing_configuration.strategy #=> String, one of "RESERVE", "LEND", "LEND_AND_BORROW"
|
|
3961
|
+
# resp.quota_shares[0].resource_sharing_configuration.borrow_limit #=> Integer
|
|
3962
|
+
# resp.quota_shares[0].preemption_configuration.in_share_preemption #=> String, one of "ENABLED", "DISABLED"
|
|
3963
|
+
# resp.quota_shares[0].state #=> String, one of "ENABLED", "DISABLED"
|
|
3964
|
+
# resp.quota_shares[0].status #=> String, one of "CREATING", "VALID", "INVALID", "UPDATING", "DELETING"
|
|
3965
|
+
# resp.next_token #=> String
|
|
3966
|
+
#
|
|
3967
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/ListQuotaShares AWS API Documentation
|
|
3968
|
+
#
|
|
3969
|
+
# @overload list_quota_shares(params = {})
|
|
3970
|
+
# @param [Hash] params ({})
|
|
3971
|
+
def list_quota_shares(params = {}, options = {})
|
|
3972
|
+
req = build_request(:list_quota_shares, params)
|
|
3973
|
+
req.send_request(options)
|
|
3974
|
+
end
|
|
3975
|
+
|
|
3713
3976
|
# Returns a list of Batch scheduling policies.
|
|
3714
3977
|
#
|
|
3715
3978
|
# @option params [Integer] :max_results
|
|
@@ -3881,6 +4144,7 @@ module Aws::Batch
|
|
|
3881
4144
|
# resp.job_summary_list[0].scheduled_at #=> Integer
|
|
3882
4145
|
# resp.job_summary_list[0].service_job_type #=> String, one of "SAGEMAKER_TRAINING"
|
|
3883
4146
|
# resp.job_summary_list[0].share_identifier #=> String
|
|
4147
|
+
# resp.job_summary_list[0].quota_share_name #=> String
|
|
3884
4148
|
# resp.job_summary_list[0].status #=> String, one of "SUBMITTED", "PENDING", "RUNNABLE", "SCHEDULED", "STARTING", "RUNNING", "SUCCEEDED", "FAILED"
|
|
3885
4149
|
# resp.job_summary_list[0].status_reason #=> String
|
|
3886
4150
|
# resp.job_summary_list[0].started_at #=> Integer
|
|
@@ -5448,6 +5712,15 @@ module Aws::Batch
|
|
|
5448
5712
|
# policy. If the job queue has a fair-share scheduling policy, then this
|
|
5449
5713
|
# parameter must be specified.
|
|
5450
5714
|
#
|
|
5715
|
+
# @option params [String] :quota_share_name
|
|
5716
|
+
# The quota share for the service job. Don't specify this parameter if
|
|
5717
|
+
# the job queue doesn't have a quota share scheduling policy. If the
|
|
5718
|
+
# job queue has a quota share scheduling policy, then this parameter
|
|
5719
|
+
# must be specified.
|
|
5720
|
+
#
|
|
5721
|
+
# @option params [Types::ServiceJobPreemptionConfiguration] :preemption_configuration
|
|
5722
|
+
# Specifies the service job behavior when preempted.
|
|
5723
|
+
#
|
|
5451
5724
|
# @option params [Types::ServiceJobTimeout] :timeout_config
|
|
5452
5725
|
# The timeout configuration for the service job. If none is specified,
|
|
5453
5726
|
# Batch defers to the default timeout of the underlying service handling
|
|
@@ -5496,6 +5769,10 @@ module Aws::Batch
|
|
|
5496
5769
|
# service_request_payload: "String", # required
|
|
5497
5770
|
# service_job_type: "SAGEMAKER_TRAINING", # required, accepts SAGEMAKER_TRAINING
|
|
5498
5771
|
# share_identifier: "String",
|
|
5772
|
+
# quota_share_name: "String",
|
|
5773
|
+
# preemption_configuration: {
|
|
5774
|
+
# preemption_retries_before_termination: 1,
|
|
5775
|
+
# },
|
|
5499
5776
|
# timeout_config: {
|
|
5500
5777
|
# attempt_duration_seconds: 1,
|
|
5501
5778
|
# },
|
|
@@ -6103,13 +6380,78 @@ module Aws::Batch
|
|
|
6103
6380
|
req.send_request(options)
|
|
6104
6381
|
end
|
|
6105
6382
|
|
|
6383
|
+
# Updates a quota share.
|
|
6384
|
+
#
|
|
6385
|
+
# @option params [required, String] :quota_share_arn
|
|
6386
|
+
# The Amazon Resource Name (ARN) of the quota share to update.
|
|
6387
|
+
#
|
|
6388
|
+
# @option params [Array<Types::QuotaShareCapacityLimit>] :capacity_limits
|
|
6389
|
+
# A list that specifies the quantity and type of compute capacity
|
|
6390
|
+
# allocated to the quota share.
|
|
6391
|
+
#
|
|
6392
|
+
# @option params [Types::QuotaShareResourceSharingConfiguration] :resource_sharing_configuration
|
|
6393
|
+
# Specifies whether a quota share reserves, lends, or both lends and
|
|
6394
|
+
# borrows idle compute capacity.
|
|
6395
|
+
#
|
|
6396
|
+
# @option params [Types::QuotaSharePreemptionConfiguration] :preemption_configuration
|
|
6397
|
+
# Specifies the preemption behavior for jobs in a quota share.
|
|
6398
|
+
#
|
|
6399
|
+
# @option params [String] :state
|
|
6400
|
+
# The state of the quota share. If the quota share is `ENABLED`, it is
|
|
6401
|
+
# able to accept jobs. If the quota share is `DISABLED`, new jobs won't
|
|
6402
|
+
# be accepted but jobs already submitted can finish.
|
|
6403
|
+
#
|
|
6404
|
+
# @return [Types::UpdateQuotaShareResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
6405
|
+
#
|
|
6406
|
+
# * {Types::UpdateQuotaShareResponse#quota_share_name #quota_share_name} => String
|
|
6407
|
+
# * {Types::UpdateQuotaShareResponse#quota_share_arn #quota_share_arn} => String
|
|
6408
|
+
#
|
|
6409
|
+
# @example Request syntax with placeholder values
|
|
6410
|
+
#
|
|
6411
|
+
# resp = client.update_quota_share({
|
|
6412
|
+
# quota_share_arn: "String", # required
|
|
6413
|
+
# capacity_limits: [
|
|
6414
|
+
# {
|
|
6415
|
+
# max_capacity: 1, # required
|
|
6416
|
+
# capacity_unit: "String", # required
|
|
6417
|
+
# },
|
|
6418
|
+
# ],
|
|
6419
|
+
# resource_sharing_configuration: {
|
|
6420
|
+
# strategy: "RESERVE", # required, accepts RESERVE, LEND, LEND_AND_BORROW
|
|
6421
|
+
# borrow_limit: 1,
|
|
6422
|
+
# },
|
|
6423
|
+
# preemption_configuration: {
|
|
6424
|
+
# in_share_preemption: "ENABLED", # required, accepts ENABLED, DISABLED
|
|
6425
|
+
# },
|
|
6426
|
+
# state: "ENABLED", # accepts ENABLED, DISABLED
|
|
6427
|
+
# })
|
|
6428
|
+
#
|
|
6429
|
+
# @example Response structure
|
|
6430
|
+
#
|
|
6431
|
+
# resp.quota_share_name #=> String
|
|
6432
|
+
# resp.quota_share_arn #=> String
|
|
6433
|
+
#
|
|
6434
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/UpdateQuotaShare AWS API Documentation
|
|
6435
|
+
#
|
|
6436
|
+
# @overload update_quota_share(params = {})
|
|
6437
|
+
# @param [Hash] params ({})
|
|
6438
|
+
def update_quota_share(params = {}, options = {})
|
|
6439
|
+
req = build_request(:update_quota_share, params)
|
|
6440
|
+
req.send_request(options)
|
|
6441
|
+
end
|
|
6442
|
+
|
|
6106
6443
|
# Updates a scheduling policy.
|
|
6107
6444
|
#
|
|
6108
6445
|
# @option params [required, String] :arn
|
|
6109
6446
|
# The Amazon Resource Name (ARN) of the scheduling policy to update.
|
|
6110
6447
|
#
|
|
6448
|
+
# @option params [Types::QuotaSharePolicy] :quota_share_policy
|
|
6449
|
+
# The quota share scheduling policy details. Once set during creation, a
|
|
6450
|
+
# quotaSharePolicy cannot be removed or changed to a fairsharePolicy.
|
|
6451
|
+
#
|
|
6111
6452
|
# @option params [Types::FairsharePolicy] :fairshare_policy
|
|
6112
|
-
# The fair-share policy scheduling details.
|
|
6453
|
+
# The fair-share policy scheduling details. Once set during creation, a
|
|
6454
|
+
# fairsharePolicy cannot be removed or changed to a quotaSharePolicy.
|
|
6113
6455
|
#
|
|
6114
6456
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
|
6115
6457
|
#
|
|
@@ -6117,6 +6459,9 @@ module Aws::Batch
|
|
|
6117
6459
|
#
|
|
6118
6460
|
# resp = client.update_scheduling_policy({
|
|
6119
6461
|
# arn: "String", # required
|
|
6462
|
+
# quota_share_policy: {
|
|
6463
|
+
# idle_resource_assignment_strategy: "FIFO", # required, accepts FIFO
|
|
6464
|
+
# },
|
|
6120
6465
|
# fairshare_policy: {
|
|
6121
6466
|
# share_decay_seconds: 1,
|
|
6122
6467
|
# compute_reservation: 1,
|
|
@@ -6185,6 +6530,48 @@ module Aws::Batch
|
|
|
6185
6530
|
req.send_request(options)
|
|
6186
6531
|
end
|
|
6187
6532
|
|
|
6533
|
+
# Updates the priority of a specified service job in an Batch job queue.
|
|
6534
|
+
#
|
|
6535
|
+
# @option params [required, String] :job_id
|
|
6536
|
+
# The Batch job ID of the job to update.
|
|
6537
|
+
#
|
|
6538
|
+
# @option params [required, Integer] :scheduling_priority
|
|
6539
|
+
# The scheduling priority for the job. This only affects jobs in job
|
|
6540
|
+
# queues with a quota-share or fair-share scheduling policy. Jobs with a
|
|
6541
|
+
# higher scheduling priority are scheduled before jobs with a lower
|
|
6542
|
+
# scheduling priority within a share.
|
|
6543
|
+
#
|
|
6544
|
+
# The minimum supported value is 0 and the maximum supported value is
|
|
6545
|
+
# 9999.
|
|
6546
|
+
#
|
|
6547
|
+
# @return [Types::UpdateServiceJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
6548
|
+
#
|
|
6549
|
+
# * {Types::UpdateServiceJobResponse#job_arn #job_arn} => String
|
|
6550
|
+
# * {Types::UpdateServiceJobResponse#job_name #job_name} => String
|
|
6551
|
+
# * {Types::UpdateServiceJobResponse#job_id #job_id} => String
|
|
6552
|
+
#
|
|
6553
|
+
# @example Request syntax with placeholder values
|
|
6554
|
+
#
|
|
6555
|
+
# resp = client.update_service_job({
|
|
6556
|
+
# job_id: "String", # required
|
|
6557
|
+
# scheduling_priority: 1, # required
|
|
6558
|
+
# })
|
|
6559
|
+
#
|
|
6560
|
+
# @example Response structure
|
|
6561
|
+
#
|
|
6562
|
+
# resp.job_arn #=> String
|
|
6563
|
+
# resp.job_name #=> String
|
|
6564
|
+
# resp.job_id #=> String
|
|
6565
|
+
#
|
|
6566
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/UpdateServiceJob AWS API Documentation
|
|
6567
|
+
#
|
|
6568
|
+
# @overload update_service_job(params = {})
|
|
6569
|
+
# @param [Hash] params ({})
|
|
6570
|
+
def update_service_job(params = {}, options = {})
|
|
6571
|
+
req = build_request(:update_service_job, params)
|
|
6572
|
+
req.send_request(options)
|
|
6573
|
+
end
|
|
6574
|
+
|
|
6188
6575
|
# @!endgroup
|
|
6189
6576
|
|
|
6190
6577
|
# @param params ({})
|
|
@@ -6203,7 +6590,7 @@ module Aws::Batch
|
|
|
6203
6590
|
tracer: tracer
|
|
6204
6591
|
)
|
|
6205
6592
|
context[:gem_name] = 'aws-sdk-batch'
|
|
6206
|
-
context[:gem_version] = '1.
|
|
6593
|
+
context[:gem_version] = '1.138.0'
|
|
6207
6594
|
Seahorse::Client::Request.new(handlers, context)
|
|
6208
6595
|
end
|
|
6209
6596
|
|