aws-sdk-deadline 1.17.0 → 1.19.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -257,11 +257,34 @@ module Aws::Deadline
257
257
  # Used when loading credentials from the shared credentials file
258
258
  # at HOME/.aws/credentials. When not specified, 'default' is used.
259
259
  #
260
+ # @option options [String] :request_checksum_calculation ("when_supported")
261
+ # Determines when a checksum will be calculated for request payloads. Values are:
262
+ #
263
+ # * `when_supported` - (default) When set, a checksum will be
264
+ # calculated for all request payloads of operations modeled with the
265
+ # `httpChecksum` trait where `requestChecksumRequired` is `true` and/or a
266
+ # `requestAlgorithmMember` is modeled.
267
+ # * `when_required` - When set, a checksum will only be calculated for
268
+ # request payloads of operations modeled with the `httpChecksum` trait where
269
+ # `requestChecksumRequired` is `true` or where a `requestAlgorithmMember`
270
+ # is modeled and supplied.
271
+ #
260
272
  # @option options [Integer] :request_min_compression_size_bytes (10240)
261
273
  # The minimum size in bytes that triggers compression for request
262
274
  # bodies. The value must be non-negative integer value between 0
263
275
  # and 10485780 bytes inclusive.
264
276
  #
277
+ # @option options [String] :response_checksum_validation ("when_supported")
278
+ # Determines when checksum validation will be performed on response payloads. Values are:
279
+ #
280
+ # * `when_supported` - (default) When set, checksum validation is performed on all
281
+ # response payloads of operations modeled with the `httpChecksum` trait where
282
+ # `responseAlgorithms` is modeled, except when no modeled checksum algorithms
283
+ # are supported.
284
+ # * `when_required` - When set, checksum validation is not performed on
285
+ # response payloads of operations unless the checksum algorithm is supported and
286
+ # the `requestValidationModeMember` member is set to `ENABLED`.
287
+ #
265
288
  # @option options [Proc] :retry_backoff
266
289
  # A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay.
267
290
  # This option is only used in the `legacy` retry mode.
@@ -1276,9 +1299,9 @@ module Aws::Deadline
1276
1299
  req.send_request(options)
1277
1300
  end
1278
1301
 
1279
- # Creates a job. A job is a set of instructions that AWS Deadline Cloud
1280
- # uses to schedule and run work on available workers. For more
1281
- # information, see [Deadline Cloud jobs][1].
1302
+ # Creates a job. A job is a set of instructions that Deadline Cloud uses
1303
+ # to schedule and run work on available workers. For more information,
1304
+ # see [Deadline Cloud jobs][1].
1282
1305
  #
1283
1306
  #
1284
1307
  #
@@ -1329,6 +1352,18 @@ module Aws::Deadline
1329
1352
  # @option params [Integer] :max_retries_per_task
1330
1353
  # The maximum number of retries for each task.
1331
1354
  #
1355
+ # @option params [Integer] :max_worker_count
1356
+ # The maximum number of worker hosts that can concurrently process a
1357
+ # job. When the `maxWorkerCount` is reached, no more workers will be
1358
+ # assigned to process the job, even if the fleets assigned to the job's
1359
+ # queue has available workers.
1360
+ #
1361
+ # You can't set the `maxWorkerCount` to 0. If you set it to -1, there
1362
+ # is no maximum number of workers.
1363
+ #
1364
+ # If you don't specify the `maxWorkerCount`, Deadline Cloud won't
1365
+ # throttle the number of workers used to process the job.
1366
+ #
1332
1367
  # @option params [String] :source_job_id
1333
1368
  # The job ID for the source job.
1334
1369
  #
@@ -1370,6 +1405,7 @@ module Aws::Deadline
1370
1405
  # target_task_run_status: "READY", # accepts READY, SUSPENDED
1371
1406
  # max_failed_tasks_count: 1,
1372
1407
  # max_retries_per_task: 1,
1408
+ # max_worker_count: 1,
1373
1409
  # source_job_id: "JobId",
1374
1410
  # })
1375
1411
  #
@@ -1438,6 +1474,81 @@ module Aws::Deadline
1438
1474
  req.send_request(options)
1439
1475
  end
1440
1476
 
1477
+ # Creates a limit that manages the distribution of shared resources,
1478
+ # such as floating licenses. A limit can throttle work assignments, help
1479
+ # manage workloads, and track current usage. Before you use a limit, you
1480
+ # must associate the limit with one or more queues.
1481
+ #
1482
+ # You must add the `amountRequirementName` to a step in a job template
1483
+ # to declare the limit requirement.
1484
+ #
1485
+ # @option params [String] :client_token
1486
+ # The unique token which the server uses to recognize retries of the
1487
+ # same request.
1488
+ #
1489
+ # **A suitable default value is auto-generated.** You should normally
1490
+ # not need to pass this option.**
1491
+ #
1492
+ # @option params [required, String] :display_name
1493
+ # The display name of the limit.
1494
+ #
1495
+ # This field can store any content. Escape or encode this content before
1496
+ # displaying it on a webpage or any other system that might interpret
1497
+ # the content of this field.
1498
+ #
1499
+ # @option params [required, String] :amount_requirement_name
1500
+ # The value that you specify as the `name` in the `amounts` field of the
1501
+ # `hostRequirements` in a step of a job template to declare the limit
1502
+ # requirement.
1503
+ #
1504
+ # @option params [required, Integer] :max_count
1505
+ # The maximum number of resources constrained by this limit. When all of
1506
+ # the resources are in use, steps that require the limit won't be
1507
+ # scheduled until the resource is available.
1508
+ #
1509
+ # The `maxCount` must not be 0. If the value is -1, there is no
1510
+ # restriction on the number of resources that can be acquired for this
1511
+ # limit.
1512
+ #
1513
+ # @option params [required, String] :farm_id
1514
+ # The farm ID of the farm that contains the limit.
1515
+ #
1516
+ # @option params [String] :description
1517
+ # A description of the limit. A description helps you identify the
1518
+ # purpose of the limit.
1519
+ #
1520
+ # This field can store any content. Escape or encode this content before
1521
+ # displaying it on a webpage or any other system that might interpret
1522
+ # the content of this field.
1523
+ #
1524
+ # @return [Types::CreateLimitResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1525
+ #
1526
+ # * {Types::CreateLimitResponse#limit_id #limit_id} => String
1527
+ #
1528
+ # @example Request syntax with placeholder values
1529
+ #
1530
+ # resp = client.create_limit({
1531
+ # client_token: "ClientToken",
1532
+ # display_name: "ResourceName", # required
1533
+ # amount_requirement_name: "AmountRequirementName", # required
1534
+ # max_count: 1, # required
1535
+ # farm_id: "FarmId", # required
1536
+ # description: "Description",
1537
+ # })
1538
+ #
1539
+ # @example Response structure
1540
+ #
1541
+ # resp.limit_id #=> String
1542
+ #
1543
+ # @see http://docs.aws.amazon.com/goto/WebAPI/deadline-2023-10-12/CreateLimit AWS API Documentation
1544
+ #
1545
+ # @overload create_limit(params = {})
1546
+ # @param [Hash] params ({})
1547
+ def create_limit(params = {}, options = {})
1548
+ req = build_request(:create_limit, params)
1549
+ req.send_request(options)
1550
+ end
1551
+
1441
1552
  # Creates an Amazon Web Services Deadline Cloud monitor that you can use
1442
1553
  # to view your farms, queues, and fleets. After you submit a job, you
1443
1554
  # can track the progress of the tasks and steps that make up the job,
@@ -1686,6 +1797,40 @@ module Aws::Deadline
1686
1797
  req.send_request(options)
1687
1798
  end
1688
1799
 
1800
+ # Associates a limit with a particular queue. After the limit is
1801
+ # associated, all workers for jobs that specify the limit associated
1802
+ # with the queue are subject to the limit. You can't associate two
1803
+ # limits with the same `amountRequirementName` to the same queue.
1804
+ #
1805
+ # @option params [required, String] :farm_id
1806
+ # The unique identifier of the farm that contains the queue and limit to
1807
+ # associate.
1808
+ #
1809
+ # @option params [required, String] :queue_id
1810
+ # The unique identifier of the queue to associate with the limit.
1811
+ #
1812
+ # @option params [required, String] :limit_id
1813
+ # The unique identifier of the limit to associate with the queue.
1814
+ #
1815
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1816
+ #
1817
+ # @example Request syntax with placeholder values
1818
+ #
1819
+ # resp = client.create_queue_limit_association({
1820
+ # farm_id: "FarmId", # required
1821
+ # queue_id: "QueueId", # required
1822
+ # limit_id: "LimitId", # required
1823
+ # })
1824
+ #
1825
+ # @see http://docs.aws.amazon.com/goto/WebAPI/deadline-2023-10-12/CreateQueueLimitAssociation AWS API Documentation
1826
+ #
1827
+ # @overload create_queue_limit_association(params = {})
1828
+ # @param [Hash] params ({})
1829
+ def create_queue_limit_association(params = {}, options = {})
1830
+ req = build_request(:create_queue_limit_association, params)
1831
+ req.send_request(options)
1832
+ end
1833
+
1689
1834
  # Creates a storage profile that specifies the operating system, file
1690
1835
  # type, and file location of resources used on a farm.
1691
1836
  #
@@ -1903,6 +2048,34 @@ module Aws::Deadline
1903
2048
  req.send_request(options)
1904
2049
  end
1905
2050
 
2051
+ # Removes a limit from the specified farm. Before you delete a limit you
2052
+ # must use the `DeleteQueueLimitAssociation` operation to remove the
2053
+ # association with any queues.
2054
+ #
2055
+ # @option params [required, String] :farm_id
2056
+ # The unique identifier of the farm that contains the limit to delete.
2057
+ #
2058
+ # @option params [required, String] :limit_id
2059
+ # The unique identifier of the limit to delete.
2060
+ #
2061
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
2062
+ #
2063
+ # @example Request syntax with placeholder values
2064
+ #
2065
+ # resp = client.delete_limit({
2066
+ # farm_id: "FarmId", # required
2067
+ # limit_id: "LimitId", # required
2068
+ # })
2069
+ #
2070
+ # @see http://docs.aws.amazon.com/goto/WebAPI/deadline-2023-10-12/DeleteLimit AWS API Documentation
2071
+ #
2072
+ # @overload delete_limit(params = {})
2073
+ # @param [Hash] params ({})
2074
+ def delete_limit(params = {}, options = {})
2075
+ req = build_request(:delete_limit, params)
2076
+ req.send_request(options)
2077
+ end
2078
+
1906
2079
  # Deletes a metered product.
1907
2080
  #
1908
2081
  # @option params [required, String] :license_endpoint_id
@@ -2044,6 +2217,42 @@ module Aws::Deadline
2044
2217
  req.send_request(options)
2045
2218
  end
2046
2219
 
2220
+ # Removes the association between a queue and a limit. You must use the
2221
+ # `UpdateQueueLimitAssociation` operation to set the status to
2222
+ # `STOP_LIMIT_USAGE_AND_COMPLETE_TASKS` or
2223
+ # `STOP_LIMIT_USAGE_AND_CANCEL_TASKS`. The status does not change
2224
+ # immediately. Use the `GetQueueLimitAssociation` operation to see if
2225
+ # the status changed to `STOPPED` before deleting the association.
2226
+ #
2227
+ # @option params [required, String] :farm_id
2228
+ # The unique identifier of the farm that contains the queue and limit to
2229
+ # disassociate.
2230
+ #
2231
+ # @option params [required, String] :queue_id
2232
+ # The unique identifier of the queue to disassociate.
2233
+ #
2234
+ # @option params [required, String] :limit_id
2235
+ # The unique identifier of the limit to disassociate.
2236
+ #
2237
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
2238
+ #
2239
+ # @example Request syntax with placeholder values
2240
+ #
2241
+ # resp = client.delete_queue_limit_association({
2242
+ # farm_id: "FarmId", # required
2243
+ # queue_id: "QueueId", # required
2244
+ # limit_id: "LimitId", # required
2245
+ # })
2246
+ #
2247
+ # @see http://docs.aws.amazon.com/goto/WebAPI/deadline-2023-10-12/DeleteQueueLimitAssociation AWS API Documentation
2248
+ #
2249
+ # @overload delete_queue_limit_association(params = {})
2250
+ # @param [Hash] params ({})
2251
+ def delete_queue_limit_association(params = {}, options = {})
2252
+ req = build_request(:delete_queue_limit_association, params)
2253
+ req.send_request(options)
2254
+ end
2255
+
2047
2256
  # Deletes a storage profile.
2048
2257
  #
2049
2258
  # @option params [required, String] :farm_id
@@ -2455,12 +2664,12 @@ module Aws::Deadline
2455
2664
  # @option params [required, String] :farm_id
2456
2665
  # The farm ID of the farm in the job.
2457
2666
  #
2458
- # @option params [required, String] :job_id
2459
- # The job ID.
2460
- #
2461
2667
  # @option params [required, String] :queue_id
2462
2668
  # The queue ID associated with the job.
2463
2669
  #
2670
+ # @option params [required, String] :job_id
2671
+ # The job ID.
2672
+ #
2464
2673
  # @return [Types::GetJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2465
2674
  #
2466
2675
  # * {Types::GetJobResponse#job_id #job_id} => String
@@ -2483,14 +2692,15 @@ module Aws::Deadline
2483
2692
  # * {Types::GetJobResponse#parameters #parameters} => Hash<String,Types::JobParameter>
2484
2693
  # * {Types::GetJobResponse#attachments #attachments} => Types::Attachments
2485
2694
  # * {Types::GetJobResponse#description #description} => String
2695
+ # * {Types::GetJobResponse#max_worker_count #max_worker_count} => Integer
2486
2696
  # * {Types::GetJobResponse#source_job_id #source_job_id} => String
2487
2697
  #
2488
2698
  # @example Request syntax with placeholder values
2489
2699
  #
2490
2700
  # resp = client.get_job({
2491
2701
  # farm_id: "FarmId", # required
2492
- # job_id: "JobId", # required
2493
2702
  # queue_id: "QueueId", # required
2703
+ # job_id: "JobId", # required
2494
2704
  # })
2495
2705
  #
2496
2706
  # @example Response structure
@@ -2528,6 +2738,7 @@ module Aws::Deadline
2528
2738
  # resp.attachments.manifests[0].input_manifest_hash #=> String
2529
2739
  # resp.attachments.file_system #=> String, one of "COPIED", "VIRTUAL"
2530
2740
  # resp.description #=> String
2741
+ # resp.max_worker_count #=> Integer
2531
2742
  # resp.source_job_id #=> String
2532
2743
  #
2533
2744
  #
@@ -2592,6 +2803,58 @@ module Aws::Deadline
2592
2803
  req.send_request(options)
2593
2804
  end
2594
2805
 
2806
+ # Gets information about a specific limit.
2807
+ #
2808
+ # @option params [required, String] :farm_id
2809
+ # The unique identifier of the farm that contains the limit.
2810
+ #
2811
+ # @option params [required, String] :limit_id
2812
+ # The unique identifier of the limit to return.
2813
+ #
2814
+ # @return [Types::GetLimitResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2815
+ #
2816
+ # * {Types::GetLimitResponse#display_name #display_name} => String
2817
+ # * {Types::GetLimitResponse#amount_requirement_name #amount_requirement_name} => String
2818
+ # * {Types::GetLimitResponse#max_count #max_count} => Integer
2819
+ # * {Types::GetLimitResponse#created_at #created_at} => Time
2820
+ # * {Types::GetLimitResponse#created_by #created_by} => String
2821
+ # * {Types::GetLimitResponse#updated_at #updated_at} => Time
2822
+ # * {Types::GetLimitResponse#updated_by #updated_by} => String
2823
+ # * {Types::GetLimitResponse#farm_id #farm_id} => String
2824
+ # * {Types::GetLimitResponse#limit_id #limit_id} => String
2825
+ # * {Types::GetLimitResponse#current_count #current_count} => Integer
2826
+ # * {Types::GetLimitResponse#description #description} => String
2827
+ #
2828
+ # @example Request syntax with placeholder values
2829
+ #
2830
+ # resp = client.get_limit({
2831
+ # farm_id: "FarmId", # required
2832
+ # limit_id: "LimitId", # required
2833
+ # })
2834
+ #
2835
+ # @example Response structure
2836
+ #
2837
+ # resp.display_name #=> String
2838
+ # resp.amount_requirement_name #=> String
2839
+ # resp.max_count #=> Integer
2840
+ # resp.created_at #=> Time
2841
+ # resp.created_by #=> String
2842
+ # resp.updated_at #=> Time
2843
+ # resp.updated_by #=> String
2844
+ # resp.farm_id #=> String
2845
+ # resp.limit_id #=> String
2846
+ # resp.current_count #=> Integer
2847
+ # resp.description #=> String
2848
+ #
2849
+ # @see http://docs.aws.amazon.com/goto/WebAPI/deadline-2023-10-12/GetLimit AWS API Documentation
2850
+ #
2851
+ # @overload get_limit(params = {})
2852
+ # @param [Hash] params ({})
2853
+ def get_limit(params = {}, options = {})
2854
+ req = build_request(:get_limit, params)
2855
+ req.send_request(options)
2856
+ end
2857
+
2595
2858
  # Gets information about the specified monitor.
2596
2859
  #
2597
2860
  # @option params [required, String] :monitor_id
@@ -2821,6 +3084,61 @@ module Aws::Deadline
2821
3084
  req.send_request(options)
2822
3085
  end
2823
3086
 
3087
+ # Gets information about a specific association between a queue and a
3088
+ # limit.
3089
+ #
3090
+ # @option params [required, String] :farm_id
3091
+ # The unique identifier of the farm that contains the associated queue
3092
+ # and limit.
3093
+ #
3094
+ # @option params [required, String] :queue_id
3095
+ # The unique identifier of the queue associated with the limit.
3096
+ #
3097
+ # @option params [required, String] :limit_id
3098
+ # The unique identifier of the limit associated with the queue.
3099
+ #
3100
+ # @return [Types::GetQueueLimitAssociationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
3101
+ #
3102
+ # * {Types::GetQueueLimitAssociationResponse#created_at #created_at} => Time
3103
+ # * {Types::GetQueueLimitAssociationResponse#created_by #created_by} => String
3104
+ # * {Types::GetQueueLimitAssociationResponse#updated_at #updated_at} => Time
3105
+ # * {Types::GetQueueLimitAssociationResponse#updated_by #updated_by} => String
3106
+ # * {Types::GetQueueLimitAssociationResponse#queue_id #queue_id} => String
3107
+ # * {Types::GetQueueLimitAssociationResponse#limit_id #limit_id} => String
3108
+ # * {Types::GetQueueLimitAssociationResponse#status #status} => String
3109
+ #
3110
+ # @example Request syntax with placeholder values
3111
+ #
3112
+ # resp = client.get_queue_limit_association({
3113
+ # farm_id: "FarmId", # required
3114
+ # queue_id: "QueueId", # required
3115
+ # limit_id: "LimitId", # required
3116
+ # })
3117
+ #
3118
+ # @example Response structure
3119
+ #
3120
+ # resp.created_at #=> Time
3121
+ # resp.created_by #=> String
3122
+ # resp.updated_at #=> Time
3123
+ # resp.updated_by #=> String
3124
+ # resp.queue_id #=> String
3125
+ # resp.limit_id #=> String
3126
+ # resp.status #=> String, one of "ACTIVE", "STOP_LIMIT_USAGE_AND_COMPLETE_TASKS", "STOP_LIMIT_USAGE_AND_CANCEL_TASKS", "STOPPED"
3127
+ #
3128
+ #
3129
+ # The following waiters are defined for this operation (see {Client#wait_until} for detailed usage):
3130
+ #
3131
+ # * queue_limit_association_stopped
3132
+ #
3133
+ # @see http://docs.aws.amazon.com/goto/WebAPI/deadline-2023-10-12/GetQueueLimitAssociation AWS API Documentation
3134
+ #
3135
+ # @overload get_queue_limit_association(params = {})
3136
+ # @param [Hash] params ({})
3137
+ def get_queue_limit_association(params = {}, options = {})
3138
+ req = build_request(:get_queue_limit_association, params)
3139
+ req.send_request(options)
3140
+ end
3141
+
2824
3142
  # Gets a session.
2825
3143
  #
2826
3144
  # @option params [required, String] :farm_id
@@ -2925,6 +3243,7 @@ module Aws::Deadline
2925
3243
  # * {Types::GetSessionActionResponse#process_exit_code #process_exit_code} => Integer
2926
3244
  # * {Types::GetSessionActionResponse#progress_message #progress_message} => String
2927
3245
  # * {Types::GetSessionActionResponse#definition #definition} => Types::SessionActionDefinition
3246
+ # * {Types::GetSessionActionResponse#acquired_limits #acquired_limits} => Array<Types::AcquiredLimit>
2928
3247
  #
2929
3248
  # @example Request syntax with placeholder values
2930
3249
  #
@@ -2956,6 +3275,9 @@ module Aws::Deadline
2956
3275
  # resp.definition.task_run.parameters["String"].string #=> String
2957
3276
  # resp.definition.task_run.parameters["String"].path #=> String
2958
3277
  # resp.definition.sync_input_job_attachments.step_id #=> String
3278
+ # resp.acquired_limits #=> Array
3279
+ # resp.acquired_limits[0].limit_id #=> String
3280
+ # resp.acquired_limits[0].count #=> Integer
2959
3281
  #
2960
3282
  # @see http://docs.aws.amazon.com/goto/WebAPI/deadline-2023-10-12/GetSessionAction AWS API Documentation
2961
3283
  #
@@ -3308,9 +3630,9 @@ module Aws::Deadline
3308
3630
  #
3309
3631
  # @return [Types::GetWorkerResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
3310
3632
  #
3311
- # * {Types::GetWorkerResponse#worker_id #worker_id} => String
3312
3633
  # * {Types::GetWorkerResponse#farm_id #farm_id} => String
3313
3634
  # * {Types::GetWorkerResponse#fleet_id #fleet_id} => String
3635
+ # * {Types::GetWorkerResponse#worker_id #worker_id} => String
3314
3636
  # * {Types::GetWorkerResponse#host_properties #host_properties} => Types::HostPropertiesResponse
3315
3637
  # * {Types::GetWorkerResponse#status #status} => String
3316
3638
  # * {Types::GetWorkerResponse#log #log} => Types::LogConfiguration
@@ -3329,9 +3651,9 @@ module Aws::Deadline
3329
3651
  #
3330
3652
  # @example Response structure
3331
3653
  #
3332
- # resp.worker_id #=> String
3333
3654
  # resp.farm_id #=> String
3334
3655
  # resp.fleet_id #=> String
3656
+ # resp.worker_id #=> String
3335
3657
  # resp.host_properties.ip_addresses.ip_v4_addresses #=> Array
3336
3658
  # resp.host_properties.ip_addresses.ip_v4_addresses[0] #=> String
3337
3659
  # resp.host_properties.ip_addresses.ip_v6_addresses #=> Array
@@ -3890,6 +4212,7 @@ module Aws::Deadline
3890
4212
  # resp.jobs[0].task_run_status_counts["TaskRunStatus"] #=> Integer
3891
4213
  # resp.jobs[0].max_failed_tasks_count #=> Integer
3892
4214
  # resp.jobs[0].max_retries_per_task #=> Integer
4215
+ # resp.jobs[0].max_worker_count #=> Integer
3893
4216
  # resp.jobs[0].source_job_id #=> String
3894
4217
  # resp.next_token #=> String
3895
4218
  #
@@ -3944,6 +4267,57 @@ module Aws::Deadline
3944
4267
  req.send_request(options)
3945
4268
  end
3946
4269
 
4270
+ # Gets a list of limits defined in the specified farm.
4271
+ #
4272
+ # @option params [required, String] :farm_id
4273
+ # The unique identifier of the farm that contains the limits.
4274
+ #
4275
+ # @option params [String] :next_token
4276
+ # The token for the next set of results, or `null` to start from the
4277
+ # beginning.
4278
+ #
4279
+ # @option params [Integer] :max_results
4280
+ # The maximum number of limits to return in each page of results.
4281
+ #
4282
+ # @return [Types::ListLimitsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
4283
+ #
4284
+ # * {Types::ListLimitsResponse#limits #limits} => Array<Types::LimitSummary>
4285
+ # * {Types::ListLimitsResponse#next_token #next_token} => String
4286
+ #
4287
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
4288
+ #
4289
+ # @example Request syntax with placeholder values
4290
+ #
4291
+ # resp = client.list_limits({
4292
+ # farm_id: "FarmId", # required
4293
+ # next_token: "String",
4294
+ # max_results: 1,
4295
+ # })
4296
+ #
4297
+ # @example Response structure
4298
+ #
4299
+ # resp.limits #=> Array
4300
+ # resp.limits[0].display_name #=> String
4301
+ # resp.limits[0].amount_requirement_name #=> String
4302
+ # resp.limits[0].max_count #=> Integer
4303
+ # resp.limits[0].created_at #=> Time
4304
+ # resp.limits[0].created_by #=> String
4305
+ # resp.limits[0].updated_at #=> Time
4306
+ # resp.limits[0].updated_by #=> String
4307
+ # resp.limits[0].farm_id #=> String
4308
+ # resp.limits[0].limit_id #=> String
4309
+ # resp.limits[0].current_count #=> Integer
4310
+ # resp.next_token #=> String
4311
+ #
4312
+ # @see http://docs.aws.amazon.com/goto/WebAPI/deadline-2023-10-12/ListLimits AWS API Documentation
4313
+ #
4314
+ # @overload list_limits(params = {})
4315
+ # @param [Hash] params ({})
4316
+ def list_limits(params = {}, options = {})
4317
+ req = build_request(:list_limits, params)
4318
+ req.send_request(options)
4319
+ end
4320
+
3947
4321
  # Lists metered products.
3948
4322
  #
3949
4323
  # @option params [required, String] :license_endpoint_id
@@ -4145,6 +4519,70 @@ module Aws::Deadline
4145
4519
  req.send_request(options)
4146
4520
  end
4147
4521
 
4522
+ # Gets a list of the associations between queues and limits defined in a
4523
+ # farm.
4524
+ #
4525
+ # @option params [required, String] :farm_id
4526
+ # The unique identifier of the farm that contains the limits and
4527
+ # associations.
4528
+ #
4529
+ # @option params [String] :queue_id
4530
+ # Specifies that the operation should return only the queue limit
4531
+ # associations for the specified queue. If you specify both the
4532
+ # `queueId` and the `limitId`, only the specified limit is returned if
4533
+ # it exists.
4534
+ #
4535
+ # @option params [String] :limit_id
4536
+ # Specifies that the operation should return only the queue limit
4537
+ # associations for the specified limit. If you specify both the
4538
+ # `queueId` and the `limitId`, only the specified limit is returned if
4539
+ # it exists.
4540
+ #
4541
+ # @option params [String] :next_token
4542
+ # The token for the next set of results, or `null` to start from the
4543
+ # beginning.
4544
+ #
4545
+ # @option params [Integer] :max_results
4546
+ # The maximum number of associations to return in each page of results.
4547
+ #
4548
+ # @return [Types::ListQueueLimitAssociationsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
4549
+ #
4550
+ # * {Types::ListQueueLimitAssociationsResponse#queue_limit_associations #queue_limit_associations} => Array<Types::QueueLimitAssociationSummary>
4551
+ # * {Types::ListQueueLimitAssociationsResponse#next_token #next_token} => String
4552
+ #
4553
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
4554
+ #
4555
+ # @example Request syntax with placeholder values
4556
+ #
4557
+ # resp = client.list_queue_limit_associations({
4558
+ # farm_id: "FarmId", # required
4559
+ # queue_id: "QueueId",
4560
+ # limit_id: "LimitId",
4561
+ # next_token: "String",
4562
+ # max_results: 1,
4563
+ # })
4564
+ #
4565
+ # @example Response structure
4566
+ #
4567
+ # resp.queue_limit_associations #=> Array
4568
+ # resp.queue_limit_associations[0].created_at #=> Time
4569
+ # resp.queue_limit_associations[0].created_by #=> String
4570
+ # resp.queue_limit_associations[0].updated_at #=> Time
4571
+ # resp.queue_limit_associations[0].updated_by #=> String
4572
+ # resp.queue_limit_associations[0].queue_id #=> String
4573
+ # resp.queue_limit_associations[0].limit_id #=> String
4574
+ # resp.queue_limit_associations[0].status #=> String, one of "ACTIVE", "STOP_LIMIT_USAGE_AND_COMPLETE_TASKS", "STOP_LIMIT_USAGE_AND_CANCEL_TASKS", "STOPPED"
4575
+ # resp.next_token #=> String
4576
+ #
4577
+ # @see http://docs.aws.amazon.com/goto/WebAPI/deadline-2023-10-12/ListQueueLimitAssociations AWS API Documentation
4578
+ #
4579
+ # @overload list_queue_limit_associations(params = {})
4580
+ # @param [Hash] params ({})
4581
+ def list_queue_limit_associations(params = {}, options = {})
4582
+ req = build_request(:list_queue_limit_associations, params)
4583
+ req.send_request(options)
4584
+ end
4585
+
4148
4586
  # Lists the members in a queue.
4149
4587
  #
4150
4588
  # @option params [required, String] :farm_id
@@ -5020,6 +5458,7 @@ module Aws::Deadline
5020
5458
  # resp.jobs[0].job_parameters["String"].float #=> String
5021
5459
  # resp.jobs[0].job_parameters["String"].string #=> String
5022
5460
  # resp.jobs[0].job_parameters["String"].path #=> String
5461
+ # resp.jobs[0].max_worker_count #=> Integer
5023
5462
  # resp.jobs[0].source_job_id #=> String
5024
5463
  # resp.next_item_offset #=> Integer
5025
5464
  # resp.total_results #=> Integer
@@ -5797,15 +6236,6 @@ module Aws::Deadline
5797
6236
  # **A suitable default value is auto-generated.** You should normally
5798
6237
  # not need to pass this option.**
5799
6238
  #
5800
- # @option params [required, String] :farm_id
5801
- # The farm ID of the job to update.
5802
- #
5803
- # @option params [required, String] :queue_id
5804
- # The queue ID of the job to update.
5805
- #
5806
- # @option params [required, String] :job_id
5807
- # The job ID to update.
5808
- #
5809
6239
  # @option params [String] :target_task_run_status
5810
6240
  # The task status to update the job's tasks to.
5811
6241
  #
@@ -5826,20 +6256,43 @@ module Aws::Deadline
5826
6256
  # An archived jobs and its steps and tasks are deleted after 120 days.
5827
6257
  # The job can't be recovered.
5828
6258
  #
6259
+ # @option params [Integer] :max_worker_count
6260
+ # The maximum number of worker hosts that can concurrently process a
6261
+ # job. When the `maxWorkerCount` is reached, no more workers will be
6262
+ # assigned to process the job, even if the fleets assigned to the job's
6263
+ # queue has available workers.
6264
+ #
6265
+ # You can't set the `maxWorkerCount` to 0. If you set it to -1, there
6266
+ # is no maximum number of workers.
6267
+ #
6268
+ # If you don't specify the `maxWorkerCount`, the default is -1.
6269
+ #
6270
+ # The maximum number of workers that can process tasks in the job.
6271
+ #
6272
+ # @option params [required, String] :farm_id
6273
+ # The farm ID of the job to update.
6274
+ #
6275
+ # @option params [required, String] :queue_id
6276
+ # The queue ID of the job to update.
6277
+ #
6278
+ # @option params [required, String] :job_id
6279
+ # The job ID to update.
6280
+ #
5829
6281
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
5830
6282
  #
5831
6283
  # @example Request syntax with placeholder values
5832
6284
  #
5833
6285
  # resp = client.update_job({
5834
6286
  # client_token: "ClientToken",
5835
- # farm_id: "FarmId", # required
5836
- # queue_id: "QueueId", # required
5837
- # job_id: "JobId", # required
5838
6287
  # target_task_run_status: "READY", # accepts READY, FAILED, SUCCEEDED, CANCELED, SUSPENDED, PENDING
5839
6288
  # priority: 1,
5840
6289
  # max_failed_tasks_count: 1,
5841
6290
  # max_retries_per_task: 1,
5842
6291
  # lifecycle_status: "ARCHIVED", # accepts ARCHIVED
6292
+ # max_worker_count: 1,
6293
+ # farm_id: "FarmId", # required
6294
+ # queue_id: "QueueId", # required
6295
+ # job_id: "JobId", # required
5843
6296
  # })
5844
6297
  #
5845
6298
  # @see http://docs.aws.amazon.com/goto/WebAPI/deadline-2023-10-12/UpdateJob AWS API Documentation
@@ -5851,6 +6304,62 @@ module Aws::Deadline
5851
6304
  req.send_request(options)
5852
6305
  end
5853
6306
 
6307
+ # Updates the properties of the specified limit.
6308
+ #
6309
+ # @option params [required, String] :farm_id
6310
+ # The unique identifier of the farm that contains the limit.
6311
+ #
6312
+ # @option params [required, String] :limit_id
6313
+ # The unique identifier of the limit to update.
6314
+ #
6315
+ # @option params [String] :display_name
6316
+ # The new display name of the limit.
6317
+ #
6318
+ # This field can store any content. Escape or encode this content before
6319
+ # displaying it on a webpage or any other system that might interpret
6320
+ # the content of this field.
6321
+ #
6322
+ # @option params [String] :description
6323
+ # The new description of the limit.
6324
+ #
6325
+ # This field can store any content. Escape or encode this content before
6326
+ # displaying it on a webpage or any other system that might interpret
6327
+ # the content of this field.
6328
+ #
6329
+ # @option params [Integer] :max_count
6330
+ # The maximum number of resources constrained by this limit. When all of
6331
+ # the resources are in use, steps that require the limit won't be
6332
+ # scheduled until the resource is available.
6333
+ #
6334
+ # If more than the new maximum number is currently in use, running jobs
6335
+ # finish but no new jobs are started until the number of resources in
6336
+ # use is below the new maximum number.
6337
+ #
6338
+ # The `maxCount` must not be 0. If the value is -1, there is no
6339
+ # restriction on the number of resources that can be acquired for this
6340
+ # limit.
6341
+ #
6342
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
6343
+ #
6344
+ # @example Request syntax with placeholder values
6345
+ #
6346
+ # resp = client.update_limit({
6347
+ # farm_id: "FarmId", # required
6348
+ # limit_id: "LimitId", # required
6349
+ # display_name: "ResourceName",
6350
+ # description: "Description",
6351
+ # max_count: 1,
6352
+ # })
6353
+ #
6354
+ # @see http://docs.aws.amazon.com/goto/WebAPI/deadline-2023-10-12/UpdateLimit AWS API Documentation
6355
+ #
6356
+ # @overload update_limit(params = {})
6357
+ # @param [Hash] params ({})
6358
+ def update_limit(params = {}, options = {})
6359
+ req = build_request(:update_limit, params)
6360
+ req.send_request(options)
6361
+ end
6362
+
5854
6363
  # Modifies the settings for a Deadline Cloud monitor. You can modify one
5855
6364
  # or all of the settings when you call `UpdateMonitor`.
5856
6365
  #
@@ -6070,6 +6579,45 @@ module Aws::Deadline
6070
6579
  req.send_request(options)
6071
6580
  end
6072
6581
 
6582
+ # Updates the status of the queue. If you set the status to one of the
6583
+ # `STOP_LIMIT_USAGE*` values, there will be a delay before the status
6584
+ # transitions to the `STOPPED` state.
6585
+ #
6586
+ # @option params [required, String] :farm_id
6587
+ # The unique identifier of the farm that contains the associated queues
6588
+ # and limits.
6589
+ #
6590
+ # @option params [required, String] :queue_id
6591
+ # The unique identifier of the queue associated to the limit.
6592
+ #
6593
+ # @option params [required, String] :limit_id
6594
+ # The unique identifier of the limit associated to the queue.
6595
+ #
6596
+ # @option params [required, String] :status
6597
+ # Sets the status of the limit. You can mark the limit active, or you
6598
+ # can stop usage of the limit and either complete existing tasks or
6599
+ # cancel any existing tasks immediately.
6600
+ #
6601
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
6602
+ #
6603
+ # @example Request syntax with placeholder values
6604
+ #
6605
+ # resp = client.update_queue_limit_association({
6606
+ # farm_id: "FarmId", # required
6607
+ # queue_id: "QueueId", # required
6608
+ # limit_id: "LimitId", # required
6609
+ # status: "ACTIVE", # required, accepts ACTIVE, STOP_LIMIT_USAGE_AND_COMPLETE_TASKS, STOP_LIMIT_USAGE_AND_CANCEL_TASKS
6610
+ # })
6611
+ #
6612
+ # @see http://docs.aws.amazon.com/goto/WebAPI/deadline-2023-10-12/UpdateQueueLimitAssociation AWS API Documentation
6613
+ #
6614
+ # @overload update_queue_limit_association(params = {})
6615
+ # @param [Hash] params ({})
6616
+ def update_queue_limit_association(params = {}, options = {})
6617
+ req = build_request(:update_queue_limit_association, params)
6618
+ req.send_request(options)
6619
+ end
6620
+
6073
6621
  # Updates a session.
6074
6622
  #
6075
6623
  # @option params [String] :client_token
@@ -6079,6 +6627,9 @@ module Aws::Deadline
6079
6627
  # **A suitable default value is auto-generated.** You should normally
6080
6628
  # not need to pass this option.**
6081
6629
  #
6630
+ # @option params [required, String] :target_lifecycle_status
6631
+ # The life cycle status to update in the session.
6632
+ #
6082
6633
  # @option params [required, String] :farm_id
6083
6634
  # The farm ID to update in the session.
6084
6635
  #
@@ -6091,20 +6642,17 @@ module Aws::Deadline
6091
6642
  # @option params [required, String] :session_id
6092
6643
  # The session ID to update.
6093
6644
  #
6094
- # @option params [required, String] :target_lifecycle_status
6095
- # The life cycle status to update in the session.
6096
- #
6097
6645
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
6098
6646
  #
6099
6647
  # @example Request syntax with placeholder values
6100
6648
  #
6101
6649
  # resp = client.update_session({
6102
6650
  # client_token: "ClientToken",
6651
+ # target_lifecycle_status: "ENDED", # required, accepts ENDED
6103
6652
  # farm_id: "FarmId", # required
6104
6653
  # queue_id: "QueueId", # required
6105
6654
  # job_id: "JobId", # required
6106
6655
  # session_id: "SessionId", # required
6107
- # target_lifecycle_status: "ENDED", # required, accepts ENDED
6108
6656
  # })
6109
6657
  #
6110
6658
  # @see http://docs.aws.amazon.com/goto/WebAPI/deadline-2023-10-12/UpdateSession AWS API Documentation
@@ -6118,6 +6666,9 @@ module Aws::Deadline
6118
6666
 
6119
6667
  # Updates a step.
6120
6668
  #
6669
+ # @option params [required, String] :target_task_run_status
6670
+ # The task status to update the step's tasks to.
6671
+ #
6121
6672
  # @option params [String] :client_token
6122
6673
  # The unique token which the server uses to recognize retries of the
6123
6674
  # same request.
@@ -6137,20 +6688,17 @@ module Aws::Deadline
6137
6688
  # @option params [required, String] :step_id
6138
6689
  # The step ID to update.
6139
6690
  #
6140
- # @option params [required, String] :target_task_run_status
6141
- # The task status to update the step's tasks to.
6142
- #
6143
6691
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
6144
6692
  #
6145
6693
  # @example Request syntax with placeholder values
6146
6694
  #
6147
6695
  # resp = client.update_step({
6696
+ # target_task_run_status: "READY", # required, accepts READY, FAILED, SUCCEEDED, CANCELED, SUSPENDED, PENDING
6148
6697
  # client_token: "ClientToken",
6149
6698
  # farm_id: "FarmId", # required
6150
6699
  # queue_id: "QueueId", # required
6151
6700
  # job_id: "JobId", # required
6152
6701
  # step_id: "StepId", # required
6153
- # target_task_run_status: "READY", # required, accepts READY, FAILED, SUCCEEDED, CANCELED, SUSPENDED, PENDING
6154
6702
  # })
6155
6703
  #
6156
6704
  # @see http://docs.aws.amazon.com/goto/WebAPI/deadline-2023-10-12/UpdateStep AWS API Documentation
@@ -6237,6 +6785,9 @@ module Aws::Deadline
6237
6785
  # **A suitable default value is auto-generated.** You should normally
6238
6786
  # not need to pass this option.**
6239
6787
  #
6788
+ # @option params [required, String] :target_run_status
6789
+ # The run status with which to start the task.
6790
+ #
6240
6791
  # @option params [required, String] :farm_id
6241
6792
  # The farm ID to update.
6242
6793
  #
@@ -6252,21 +6803,18 @@ module Aws::Deadline
6252
6803
  # @option params [required, String] :task_id
6253
6804
  # The task ID to update.
6254
6805
  #
6255
- # @option params [required, String] :target_run_status
6256
- # The run status with which to start the task.
6257
- #
6258
6806
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
6259
6807
  #
6260
6808
  # @example Request syntax with placeholder values
6261
6809
  #
6262
6810
  # resp = client.update_task({
6263
6811
  # client_token: "ClientToken",
6812
+ # target_run_status: "READY", # required, accepts READY, FAILED, SUCCEEDED, CANCELED, SUSPENDED, PENDING
6264
6813
  # farm_id: "FarmId", # required
6265
6814
  # queue_id: "QueueId", # required
6266
6815
  # job_id: "JobId", # required
6267
6816
  # step_id: "StepId", # required
6268
6817
  # task_id: "TaskId", # required
6269
- # target_run_status: "READY", # required, accepts READY, FAILED, SUCCEEDED, CANCELED, SUSPENDED, PENDING
6270
6818
  # })
6271
6819
  #
6272
6820
  # @see http://docs.aws.amazon.com/goto/WebAPI/deadline-2023-10-12/UpdateTask AWS API Documentation
@@ -6446,7 +6994,7 @@ module Aws::Deadline
6446
6994
  tracer: tracer
6447
6995
  )
6448
6996
  context[:gem_name] = 'aws-sdk-deadline'
6449
- context[:gem_version] = '1.17.0'
6997
+ context[:gem_version] = '1.19.0'
6450
6998
  Seahorse::Client::Request.new(handlers, context)
6451
6999
  end
6452
7000
 
@@ -6519,6 +7067,7 @@ module Aws::Deadline
6519
7067
  # | license_endpoint_deleted | {Client#get_license_endpoint} | 10 | 234 |
6520
7068
  # | license_endpoint_valid | {Client#get_license_endpoint} | 10 | 114 |
6521
7069
  # | queue_fleet_association_stopped | {Client#get_queue_fleet_association} | 10 | 60 |
7070
+ # | queue_limit_association_stopped | {Client#get_queue_limit_association} | 10 | 60 |
6522
7071
  # | queue_scheduling | {Client#get_queue} | 10 | 70 |
6523
7072
  # | queue_scheduling_blocked | {Client#get_queue} | 10 | 30 |
6524
7073
  #
@@ -6576,6 +7125,7 @@ module Aws::Deadline
6576
7125
  license_endpoint_deleted: Waiters::LicenseEndpointDeleted,
6577
7126
  license_endpoint_valid: Waiters::LicenseEndpointValid,
6578
7127
  queue_fleet_association_stopped: Waiters::QueueFleetAssociationStopped,
7128
+ queue_limit_association_stopped: Waiters::QueueLimitAssociationStopped,
6579
7129
  queue_scheduling: Waiters::QueueScheduling,
6580
7130
  queue_scheduling_blocked: Waiters::QueueSchedulingBlocked
6581
7131
  }