aws-sdk-batch 1.152.0 → 1.153.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 +264 -14
- data/lib/aws-sdk-batch/client_api.rb +90 -0
- data/lib/aws-sdk-batch/types.rb +286 -8
- data/lib/aws-sdk-batch.rb +1 -1
- data/sig/client.rbs +36 -0
- data/sig/types.rbs +60 -0
- metadata +3 -3
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 77ea021f03a85bf1503611a9552758400bb9c83b7764916a7d2ff59f250180c2
|
|
4
|
+
data.tar.gz: 14c07340d7c5f61953e801f36f47d7bd9f7ef82baab5f71ab4967ea922cf9799
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 972a96bb65f6a95cb56b2e70dc0928839da591d45b8ab51be96081932549e54c3dff0422c4451b0c8df8414ee527b2245eb625ec54c37bdc54171d872567df41
|
|
7
|
+
data.tar.gz: 5ee2276258af282bcd6c730a62e0057c58e5720ecd1faf6fc6d649511d7a5ac33fd29b12cd202e22652da27a77c2c3ebfb9e91f3a437bedf18b741ff3310f2f8
|
data/CHANGELOG.md
CHANGED
|
@@ -1,6 +1,11 @@
|
|
|
1
1
|
Unreleased Changes
|
|
2
2
|
------------------
|
|
3
3
|
|
|
4
|
+
1.153.0 (2026-09-11)
|
|
5
|
+
------------------
|
|
6
|
+
|
|
7
|
+
* Feature - Added new bulk job APIs (CancelJobs, TerminateJobs, TerminateServiceJobs) and new fields on ListJobs and ListServiceJobs responses. This allows customers to cancel or terminate multiple jobs in a single request. ListJobs and ListServiceJobs responses now include isCancelled and isTerminated fields.
|
|
8
|
+
|
|
4
9
|
1.152.0 (2026-09-09)
|
|
5
10
|
------------------
|
|
6
11
|
|
data/VERSION
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
1.
|
|
1
|
+
1.153.0
|
data/lib/aws-sdk-batch/client.rb
CHANGED
|
@@ -478,30 +478,30 @@ module Aws::Batch
|
|
|
478
478
|
# `PENDING`, or `RUNNABLE` state are cancelled and the job status is
|
|
479
479
|
# updated to `FAILED`.
|
|
480
480
|
#
|
|
481
|
-
# <note markdown="1"> A `PENDING` job is
|
|
482
|
-
# Therefore, it
|
|
481
|
+
# <note markdown="1"> A `PENDING` job is cancelled after all dependency jobs are completed.
|
|
482
|
+
# Therefore, it might take longer than expected to cancel a job in
|
|
483
483
|
# `PENDING` status.
|
|
484
484
|
#
|
|
485
485
|
# When you try to cancel an array parent job in `PENDING`, Batch
|
|
486
|
-
# attempts to cancel all child jobs. The array parent job is
|
|
486
|
+
# attempts to cancel all child jobs. The array parent job is cancelled
|
|
487
487
|
# when all child jobs are completed.
|
|
488
488
|
#
|
|
489
489
|
# </note>
|
|
490
490
|
#
|
|
491
491
|
# Jobs that progressed to the `STARTING` or `RUNNING` state aren't
|
|
492
|
-
#
|
|
493
|
-
#
|
|
494
|
-
# operation.
|
|
492
|
+
# cancelled. However, the API operation still succeeds, even if no job
|
|
493
|
+
# is cancelled. These jobs must be terminated with the TerminateJob or
|
|
494
|
+
# TerminateJobs operation.
|
|
495
495
|
#
|
|
496
496
|
# @option params [required, String] :job_id
|
|
497
497
|
# The Batch job ID of the job to cancel.
|
|
498
498
|
#
|
|
499
499
|
# @option params [required, String] :reason
|
|
500
|
-
# A message to attach to the job that explains the reason for
|
|
500
|
+
# A message to attach to the job that explains the reason for cancelling
|
|
501
501
|
# it. This message is returned by future DescribeJobs operations on the
|
|
502
502
|
# job. It is also recorded in the Batch activity logs.
|
|
503
503
|
#
|
|
504
|
-
# This parameter has
|
|
504
|
+
# This parameter has a limit of 1024 characters.
|
|
505
505
|
#
|
|
506
506
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
|
507
507
|
#
|
|
@@ -535,6 +535,98 @@ module Aws::Batch
|
|
|
535
535
|
req.send_request(options)
|
|
536
536
|
end
|
|
537
537
|
|
|
538
|
+
# Cancels up to 50 jobs in an Batch job queue. This is a bulk version of
|
|
539
|
+
# CancelJob. Jobs that are in a `SUBMITTED`, `PENDING`, or `RUNNABLE`
|
|
540
|
+
# state are cancelled and the job status is updated to `FAILED`.
|
|
541
|
+
#
|
|
542
|
+
# <note markdown="1"> A `PENDING` job is cancelled after all dependency jobs are completed.
|
|
543
|
+
# Therefore, it might take longer than expected to cancel a job in
|
|
544
|
+
# `PENDING` status.
|
|
545
|
+
#
|
|
546
|
+
# When you try to cancel an array parent job in `PENDING`, Batch
|
|
547
|
+
# attempts to cancel all child jobs. The array parent job is cancelled
|
|
548
|
+
# when all child jobs are completed.
|
|
549
|
+
#
|
|
550
|
+
# </note>
|
|
551
|
+
#
|
|
552
|
+
# Jobs that progressed to the `STARTING` or `RUNNING` state aren't
|
|
553
|
+
# cancelled. These jobs must be terminated with the TerminateJob or
|
|
554
|
+
# TerminateJobs operation.
|
|
555
|
+
#
|
|
556
|
+
# Batch reports the result for each job individually in the response.
|
|
557
|
+
# Jobs that were processed successfully are reported in the `successful`
|
|
558
|
+
# list. Jobs that encountered errors are reported in the `errors` list.
|
|
559
|
+
# The response returns an HTTP status code of `200` even when some jobs
|
|
560
|
+
# encountered errors, so check the `errors` list. Jobs that can't be
|
|
561
|
+
# found are treated as successfully processed.
|
|
562
|
+
#
|
|
563
|
+
# @option params [required, Array<String>] :jobs
|
|
564
|
+
# An array of up to 50 Batch job IDs of the jobs to cancel.
|
|
565
|
+
#
|
|
566
|
+
# @option params [required, String] :reason
|
|
567
|
+
# A message to attach to the job that explains the reason for cancelling
|
|
568
|
+
# it. This message is returned by future DescribeJobs operations on the
|
|
569
|
+
# job. It is also recorded in the Batch activity logs.
|
|
570
|
+
#
|
|
571
|
+
# This parameter has a limit of 1024 characters.
|
|
572
|
+
#
|
|
573
|
+
# @return [Types::CancelJobsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
574
|
+
#
|
|
575
|
+
# * {Types::CancelJobsResponse#successful #successful} => Array<String>
|
|
576
|
+
# * {Types::CancelJobsResponse#errors #errors} => Array<Types::CancelJobsErrorDetail>
|
|
577
|
+
#
|
|
578
|
+
#
|
|
579
|
+
# @example Example: To cancel multiple jobs
|
|
580
|
+
#
|
|
581
|
+
# # This example cancels the jobs with the specified job IDs.
|
|
582
|
+
#
|
|
583
|
+
# resp = client.cancel_jobs({
|
|
584
|
+
# jobs: [
|
|
585
|
+
# "1d828f65-7a4d-42e8-996d-3b900ed59dc4",
|
|
586
|
+
# "b3d0f26e-6d3a-4a5b-9c2e-7f4a1b2c3d4e",
|
|
587
|
+
# ],
|
|
588
|
+
# reason: "Cancelling jobs.",
|
|
589
|
+
# })
|
|
590
|
+
#
|
|
591
|
+
# resp.to_h outputs the following:
|
|
592
|
+
# {
|
|
593
|
+
# errors: [
|
|
594
|
+
# {
|
|
595
|
+
# code: "ServerException",
|
|
596
|
+
# job: "b3d0f26e-6d3a-4a5b-9c2e-7f4a1b2c3d4e",
|
|
597
|
+
# message: "Failed to read job state. Please retry this job.",
|
|
598
|
+
# },
|
|
599
|
+
# ],
|
|
600
|
+
# successful: [
|
|
601
|
+
# "1d828f65-7a4d-42e8-996d-3b900ed59dc4",
|
|
602
|
+
# ],
|
|
603
|
+
# }
|
|
604
|
+
#
|
|
605
|
+
# @example Request syntax with placeholder values
|
|
606
|
+
#
|
|
607
|
+
# resp = client.cancel_jobs({
|
|
608
|
+
# jobs: ["String"], # required
|
|
609
|
+
# reason: "String", # required
|
|
610
|
+
# })
|
|
611
|
+
#
|
|
612
|
+
# @example Response structure
|
|
613
|
+
#
|
|
614
|
+
# resp.successful #=> Array
|
|
615
|
+
# resp.successful[0] #=> String
|
|
616
|
+
# resp.errors #=> Array
|
|
617
|
+
# resp.errors[0].job #=> String
|
|
618
|
+
# resp.errors[0].code #=> String
|
|
619
|
+
# resp.errors[0].message #=> String
|
|
620
|
+
#
|
|
621
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/CancelJobs AWS API Documentation
|
|
622
|
+
#
|
|
623
|
+
# @overload cancel_jobs(params = {})
|
|
624
|
+
# @param [Hash] params ({})
|
|
625
|
+
def cancel_jobs(params = {}, options = {})
|
|
626
|
+
req = build_request(:cancel_jobs, params)
|
|
627
|
+
req.send_request(options)
|
|
628
|
+
end
|
|
629
|
+
|
|
538
630
|
# Creates an Batch compute environment. You can create `MANAGED` or
|
|
539
631
|
# `UNMANAGED` compute environments. `MANAGED` compute environments can
|
|
540
632
|
# use Amazon EC2 or Fargate resources. `UNMANAGED` compute environments
|
|
@@ -4043,6 +4135,8 @@ module Aws::Batch
|
|
|
4043
4135
|
# resp.job_summary_list[0].node_properties.num_nodes #=> Integer
|
|
4044
4136
|
# resp.job_summary_list[0].node_properties.node_index #=> Integer
|
|
4045
4137
|
# resp.job_summary_list[0].job_definition #=> String
|
|
4138
|
+
# resp.job_summary_list[0].is_cancelled #=> Boolean
|
|
4139
|
+
# resp.job_summary_list[0].is_terminated #=> Boolean
|
|
4046
4140
|
# resp.next_token #=> String
|
|
4047
4141
|
#
|
|
4048
4142
|
# @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/ListJobs AWS API Documentation
|
|
@@ -4438,6 +4532,7 @@ module Aws::Batch
|
|
|
4438
4532
|
# resp.job_summary_list[0].status_reason #=> String
|
|
4439
4533
|
# resp.job_summary_list[0].started_at #=> Integer
|
|
4440
4534
|
# resp.job_summary_list[0].stopped_at #=> Integer
|
|
4535
|
+
# resp.job_summary_list[0].is_terminated #=> Boolean
|
|
4441
4536
|
# resp.next_token #=> String
|
|
4442
4537
|
#
|
|
4443
4538
|
# @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/ListServiceJobs AWS API Documentation
|
|
@@ -6352,11 +6447,11 @@ module Aws::Batch
|
|
|
6352
6447
|
# The Batch job ID of the job to terminate.
|
|
6353
6448
|
#
|
|
6354
6449
|
# @option params [required, String] :reason
|
|
6355
|
-
# A message to attach to the job that explains the reason for
|
|
6356
|
-
# it. This message is returned by future DescribeJobs
|
|
6357
|
-
# job. It is also recorded in the Batch activity logs.
|
|
6450
|
+
# A message to attach to the job that explains the reason for
|
|
6451
|
+
# terminating it. This message is returned by future DescribeJobs
|
|
6452
|
+
# operations on the job. It is also recorded in the Batch activity logs.
|
|
6358
6453
|
#
|
|
6359
|
-
# This parameter has
|
|
6454
|
+
# This parameter has a limit of 1024 characters.
|
|
6360
6455
|
#
|
|
6361
6456
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
|
6362
6457
|
#
|
|
@@ -6390,6 +6485,85 @@ module Aws::Batch
|
|
|
6390
6485
|
req.send_request(options)
|
|
6391
6486
|
end
|
|
6392
6487
|
|
|
6488
|
+
# Terminates up to 50 jobs in a job queue. This is a bulk version of
|
|
6489
|
+
# TerminateJob. Jobs that are in the `STARTING` or `RUNNING` state are
|
|
6490
|
+
# terminated, which causes them to transition to `FAILED`. Jobs that
|
|
6491
|
+
# have not progressed to the `STARTING` state are cancelled.
|
|
6492
|
+
#
|
|
6493
|
+
# Batch reports the result for each job individually in the response.
|
|
6494
|
+
# Jobs that were processed successfully are reported in the `successful`
|
|
6495
|
+
# list. Jobs that encountered errors are reported in the `errors` list.
|
|
6496
|
+
# The response returns an HTTP status code of `200` even when some jobs
|
|
6497
|
+
# encountered errors, so check the `errors` list. Jobs that can't be
|
|
6498
|
+
# found are treated as successfully processed.
|
|
6499
|
+
#
|
|
6500
|
+
# @option params [required, Array<String>] :jobs
|
|
6501
|
+
# An array of up to 50 Batch job IDs of the jobs to terminate.
|
|
6502
|
+
#
|
|
6503
|
+
# @option params [required, String] :reason
|
|
6504
|
+
# A message to attach to the job that explains the reason for
|
|
6505
|
+
# terminating it. This message is returned by future DescribeJobs
|
|
6506
|
+
# operations on the job. It is also recorded in the Batch activity logs.
|
|
6507
|
+
#
|
|
6508
|
+
# This parameter has a limit of 1024 characters.
|
|
6509
|
+
#
|
|
6510
|
+
# @return [Types::TerminateJobsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
6511
|
+
#
|
|
6512
|
+
# * {Types::TerminateJobsResponse#successful #successful} => Array<String>
|
|
6513
|
+
# * {Types::TerminateJobsResponse#errors #errors} => Array<Types::TerminateJobsErrorDetail>
|
|
6514
|
+
#
|
|
6515
|
+
#
|
|
6516
|
+
# @example Example: To terminate multiple jobs
|
|
6517
|
+
#
|
|
6518
|
+
# # This example terminates the jobs with the specified job IDs.
|
|
6519
|
+
#
|
|
6520
|
+
# resp = client.terminate_jobs({
|
|
6521
|
+
# jobs: [
|
|
6522
|
+
# "61e743ed-35e4-48da-b2de-5c8333821c84",
|
|
6523
|
+
# "b3d0f26e-6d3a-4a5b-9c2e-7f4a1b2c3d4e",
|
|
6524
|
+
# ],
|
|
6525
|
+
# reason: "Terminating jobs.",
|
|
6526
|
+
# })
|
|
6527
|
+
#
|
|
6528
|
+
# resp.to_h outputs the following:
|
|
6529
|
+
# {
|
|
6530
|
+
# errors: [
|
|
6531
|
+
# {
|
|
6532
|
+
# code: "ServerException",
|
|
6533
|
+
# job: "b3d0f26e-6d3a-4a5b-9c2e-7f4a1b2c3d4e",
|
|
6534
|
+
# message: "Failed to read job state. Please retry this job.",
|
|
6535
|
+
# },
|
|
6536
|
+
# ],
|
|
6537
|
+
# successful: [
|
|
6538
|
+
# "61e743ed-35e4-48da-b2de-5c8333821c84",
|
|
6539
|
+
# ],
|
|
6540
|
+
# }
|
|
6541
|
+
#
|
|
6542
|
+
# @example Request syntax with placeholder values
|
|
6543
|
+
#
|
|
6544
|
+
# resp = client.terminate_jobs({
|
|
6545
|
+
# jobs: ["String"], # required
|
|
6546
|
+
# reason: "String", # required
|
|
6547
|
+
# })
|
|
6548
|
+
#
|
|
6549
|
+
# @example Response structure
|
|
6550
|
+
#
|
|
6551
|
+
# resp.successful #=> Array
|
|
6552
|
+
# resp.successful[0] #=> String
|
|
6553
|
+
# resp.errors #=> Array
|
|
6554
|
+
# resp.errors[0].job #=> String
|
|
6555
|
+
# resp.errors[0].code #=> String
|
|
6556
|
+
# resp.errors[0].message #=> String
|
|
6557
|
+
#
|
|
6558
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/TerminateJobs AWS API Documentation
|
|
6559
|
+
#
|
|
6560
|
+
# @overload terminate_jobs(params = {})
|
|
6561
|
+
# @param [Hash] params ({})
|
|
6562
|
+
def terminate_jobs(params = {}, options = {})
|
|
6563
|
+
req = build_request(:terminate_jobs, params)
|
|
6564
|
+
req.send_request(options)
|
|
6565
|
+
end
|
|
6566
|
+
|
|
6393
6567
|
# Terminates a service job in a job queue.
|
|
6394
6568
|
#
|
|
6395
6569
|
# @option params [required, String] :job_id
|
|
@@ -6397,7 +6571,7 @@ module Aws::Batch
|
|
|
6397
6571
|
#
|
|
6398
6572
|
# @option params [required, String] :reason
|
|
6399
6573
|
# A message to attach to the service job that explains the reason for
|
|
6400
|
-
#
|
|
6574
|
+
# terminating it. This message is returned by `DescribeServiceJob`
|
|
6401
6575
|
# operations on the service job.
|
|
6402
6576
|
#
|
|
6403
6577
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
|
@@ -6418,6 +6592,82 @@ module Aws::Batch
|
|
|
6418
6592
|
req.send_request(options)
|
|
6419
6593
|
end
|
|
6420
6594
|
|
|
6595
|
+
# Terminates up to 50 service jobs in a job queue. This is a bulk
|
|
6596
|
+
# version of TerminateServiceJob.
|
|
6597
|
+
#
|
|
6598
|
+
# Batch reports the result for each service job individually in the
|
|
6599
|
+
# response. Service jobs that were processed successfully are reported
|
|
6600
|
+
# in the `successful` list. Service jobs that encountered errors are
|
|
6601
|
+
# reported in the `errors` list. The response returns an HTTP status
|
|
6602
|
+
# code of `200` even when some service jobs encountered errors, so check
|
|
6603
|
+
# the `errors` list. Service jobs that can't be found are treated as
|
|
6604
|
+
# successfully processed.
|
|
6605
|
+
#
|
|
6606
|
+
# @option params [required, Array<String>] :jobs
|
|
6607
|
+
# An array of up to 50 service job IDs of the service jobs to terminate.
|
|
6608
|
+
#
|
|
6609
|
+
# @option params [required, String] :reason
|
|
6610
|
+
# A message to attach to the service job that explains the reason for
|
|
6611
|
+
# terminating it. This message is returned by `DescribeServiceJob`
|
|
6612
|
+
# operations on the service job.
|
|
6613
|
+
#
|
|
6614
|
+
# @return [Types::TerminateServiceJobsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
6615
|
+
#
|
|
6616
|
+
# * {Types::TerminateServiceJobsResponse#successful #successful} => Array<String>
|
|
6617
|
+
# * {Types::TerminateServiceJobsResponse#errors #errors} => Array<Types::TerminateServiceJobsErrorDetail>
|
|
6618
|
+
#
|
|
6619
|
+
#
|
|
6620
|
+
# @example Example: To terminate multiple service jobs
|
|
6621
|
+
#
|
|
6622
|
+
# # This example terminates the specified service jobs with a reason.
|
|
6623
|
+
#
|
|
6624
|
+
# resp = client.terminate_service_jobs({
|
|
6625
|
+
# jobs: [
|
|
6626
|
+
# "a4d6c728-8ee8-4c65-8e2a-9a5e8f4b7c3d",
|
|
6627
|
+
# "b3d0f26e-6d3a-4a5b-9c2e-7f4a1b2c3d4e",
|
|
6628
|
+
# ],
|
|
6629
|
+
# reason: "Job terminated by user request",
|
|
6630
|
+
# })
|
|
6631
|
+
#
|
|
6632
|
+
# resp.to_h outputs the following:
|
|
6633
|
+
# {
|
|
6634
|
+
# errors: [
|
|
6635
|
+
# {
|
|
6636
|
+
# code: "ServerException",
|
|
6637
|
+
# job: "b3d0f26e-6d3a-4a5b-9c2e-7f4a1b2c3d4e",
|
|
6638
|
+
# message: "Failed to read job state. Please retry this job.",
|
|
6639
|
+
# },
|
|
6640
|
+
# ],
|
|
6641
|
+
# successful: [
|
|
6642
|
+
# "a4d6c728-8ee8-4c65-8e2a-9a5e8f4b7c3d",
|
|
6643
|
+
# ],
|
|
6644
|
+
# }
|
|
6645
|
+
#
|
|
6646
|
+
# @example Request syntax with placeholder values
|
|
6647
|
+
#
|
|
6648
|
+
# resp = client.terminate_service_jobs({
|
|
6649
|
+
# jobs: ["String"], # required
|
|
6650
|
+
# reason: "String", # required
|
|
6651
|
+
# })
|
|
6652
|
+
#
|
|
6653
|
+
# @example Response structure
|
|
6654
|
+
#
|
|
6655
|
+
# resp.successful #=> Array
|
|
6656
|
+
# resp.successful[0] #=> String
|
|
6657
|
+
# resp.errors #=> Array
|
|
6658
|
+
# resp.errors[0].job #=> String
|
|
6659
|
+
# resp.errors[0].code #=> String
|
|
6660
|
+
# resp.errors[0].message #=> String
|
|
6661
|
+
#
|
|
6662
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/TerminateServiceJobs AWS API Documentation
|
|
6663
|
+
#
|
|
6664
|
+
# @overload terminate_service_jobs(params = {})
|
|
6665
|
+
# @param [Hash] params ({})
|
|
6666
|
+
def terminate_service_jobs(params = {}, options = {})
|
|
6667
|
+
req = build_request(:terminate_service_jobs, params)
|
|
6668
|
+
req.send_request(options)
|
|
6669
|
+
end
|
|
6670
|
+
|
|
6421
6671
|
# Deletes specified tags from an Batch resource.
|
|
6422
6672
|
#
|
|
6423
6673
|
# @option params [required, String] :resource_arn
|
|
@@ -7114,7 +7364,7 @@ module Aws::Batch
|
|
|
7114
7364
|
tracer: tracer
|
|
7115
7365
|
)
|
|
7116
7366
|
context[:gem_name] = 'aws-sdk-batch'
|
|
7117
|
-
context[:gem_version] = '1.
|
|
7367
|
+
context[:gem_version] = '1.153.0'
|
|
7118
7368
|
Seahorse::Client::Request.new(handlers, context)
|
|
7119
7369
|
end
|
|
7120
7370
|
|
|
@@ -34,6 +34,10 @@ module Aws::Batch
|
|
|
34
34
|
CRUpdateAllocationStrategy = Shapes::StringShape.new(name: 'CRUpdateAllocationStrategy')
|
|
35
35
|
CancelJobRequest = Shapes::StructureShape.new(name: 'CancelJobRequest')
|
|
36
36
|
CancelJobResponse = Shapes::StructureShape.new(name: 'CancelJobResponse')
|
|
37
|
+
CancelJobsErrorDetail = Shapes::StructureShape.new(name: 'CancelJobsErrorDetail')
|
|
38
|
+
CancelJobsErrorDetailList = Shapes::ListShape.new(name: 'CancelJobsErrorDetailList')
|
|
39
|
+
CancelJobsRequest = Shapes::StructureShape.new(name: 'CancelJobsRequest')
|
|
40
|
+
CancelJobsResponse = Shapes::StructureShape.new(name: 'CancelJobsResponse')
|
|
37
41
|
CapacityLimit = Shapes::StructureShape.new(name: 'CapacityLimit')
|
|
38
42
|
CapacityLimits = Shapes::ListShape.new(name: 'CapacityLimits')
|
|
39
43
|
CapacityReservationRequest = Shapes::StructureShape.new(name: 'CapacityReservationRequest')
|
|
@@ -357,8 +361,16 @@ module Aws::Batch
|
|
|
357
361
|
TaskPropertiesOverride = Shapes::StructureShape.new(name: 'TaskPropertiesOverride')
|
|
358
362
|
TerminateJobRequest = Shapes::StructureShape.new(name: 'TerminateJobRequest')
|
|
359
363
|
TerminateJobResponse = Shapes::StructureShape.new(name: 'TerminateJobResponse')
|
|
364
|
+
TerminateJobsErrorDetail = Shapes::StructureShape.new(name: 'TerminateJobsErrorDetail')
|
|
365
|
+
TerminateJobsErrorDetailList = Shapes::ListShape.new(name: 'TerminateJobsErrorDetailList')
|
|
366
|
+
TerminateJobsRequest = Shapes::StructureShape.new(name: 'TerminateJobsRequest')
|
|
367
|
+
TerminateJobsResponse = Shapes::StructureShape.new(name: 'TerminateJobsResponse')
|
|
360
368
|
TerminateServiceJobRequest = Shapes::StructureShape.new(name: 'TerminateServiceJobRequest')
|
|
361
369
|
TerminateServiceJobResponse = Shapes::StructureShape.new(name: 'TerminateServiceJobResponse')
|
|
370
|
+
TerminateServiceJobsErrorDetail = Shapes::StructureShape.new(name: 'TerminateServiceJobsErrorDetail')
|
|
371
|
+
TerminateServiceJobsErrorDetailList = Shapes::ListShape.new(name: 'TerminateServiceJobsErrorDetailList')
|
|
372
|
+
TerminateServiceJobsRequest = Shapes::StructureShape.new(name: 'TerminateServiceJobsRequest')
|
|
373
|
+
TerminateServiceJobsResponse = Shapes::StructureShape.new(name: 'TerminateServiceJobsResponse')
|
|
362
374
|
Tmpfs = Shapes::StructureShape.new(name: 'Tmpfs')
|
|
363
375
|
TmpfsList = Shapes::ListShape.new(name: 'TmpfsList')
|
|
364
376
|
Ulimit = Shapes::StructureShape.new(name: 'Ulimit')
|
|
@@ -438,6 +450,21 @@ module Aws::Batch
|
|
|
438
450
|
|
|
439
451
|
CancelJobResponse.struct_class = Types::CancelJobResponse
|
|
440
452
|
|
|
453
|
+
CancelJobsErrorDetail.add_member(:job, Shapes::ShapeRef.new(shape: String, required: true, location_name: "job"))
|
|
454
|
+
CancelJobsErrorDetail.add_member(:code, Shapes::ShapeRef.new(shape: String, required: true, location_name: "code"))
|
|
455
|
+
CancelJobsErrorDetail.add_member(:message, Shapes::ShapeRef.new(shape: String, required: true, location_name: "message"))
|
|
456
|
+
CancelJobsErrorDetail.struct_class = Types::CancelJobsErrorDetail
|
|
457
|
+
|
|
458
|
+
CancelJobsErrorDetailList.member = Shapes::ShapeRef.new(shape: CancelJobsErrorDetail)
|
|
459
|
+
|
|
460
|
+
CancelJobsRequest.add_member(:jobs, Shapes::ShapeRef.new(shape: StringList, required: true, location_name: "jobs"))
|
|
461
|
+
CancelJobsRequest.add_member(:reason, Shapes::ShapeRef.new(shape: String, required: true, location_name: "reason"))
|
|
462
|
+
CancelJobsRequest.struct_class = Types::CancelJobsRequest
|
|
463
|
+
|
|
464
|
+
CancelJobsResponse.add_member(:successful, Shapes::ShapeRef.new(shape: StringList, required: true, location_name: "successful"))
|
|
465
|
+
CancelJobsResponse.add_member(:errors, Shapes::ShapeRef.new(shape: CancelJobsErrorDetailList, required: true, location_name: "errors"))
|
|
466
|
+
CancelJobsResponse.struct_class = Types::CancelJobsResponse
|
|
467
|
+
|
|
441
468
|
CapacityLimit.add_member(:max_capacity, Shapes::ShapeRef.new(shape: Integer, location_name: "maxCapacity"))
|
|
442
469
|
CapacityLimit.add_member(:capacity_unit, Shapes::ShapeRef.new(shape: String, location_name: "capacityUnit"))
|
|
443
470
|
CapacityLimit.struct_class = Types::CapacityLimit
|
|
@@ -1285,6 +1312,8 @@ module Aws::Batch
|
|
|
1285
1312
|
JobSummary.add_member(:array_properties, Shapes::ShapeRef.new(shape: ArrayPropertiesSummary, location_name: "arrayProperties"))
|
|
1286
1313
|
JobSummary.add_member(:node_properties, Shapes::ShapeRef.new(shape: NodePropertiesSummary, location_name: "nodeProperties"))
|
|
1287
1314
|
JobSummary.add_member(:job_definition, Shapes::ShapeRef.new(shape: String, location_name: "jobDefinition"))
|
|
1315
|
+
JobSummary.add_member(:is_cancelled, Shapes::ShapeRef.new(shape: Boolean, location_name: "isCancelled"))
|
|
1316
|
+
JobSummary.add_member(:is_terminated, Shapes::ShapeRef.new(shape: Boolean, location_name: "isTerminated"))
|
|
1288
1317
|
JobSummary.struct_class = Types::JobSummary
|
|
1289
1318
|
|
|
1290
1319
|
JobSummaryList.member = Shapes::ShapeRef.new(shape: JobSummary)
|
|
@@ -1712,6 +1741,7 @@ module Aws::Batch
|
|
|
1712
1741
|
ServiceJobSummary.add_member(:status_reason, Shapes::ShapeRef.new(shape: String, location_name: "statusReason"))
|
|
1713
1742
|
ServiceJobSummary.add_member(:started_at, Shapes::ShapeRef.new(shape: Long, location_name: "startedAt"))
|
|
1714
1743
|
ServiceJobSummary.add_member(:stopped_at, Shapes::ShapeRef.new(shape: Long, location_name: "stoppedAt"))
|
|
1744
|
+
ServiceJobSummary.add_member(:is_terminated, Shapes::ShapeRef.new(shape: Boolean, location_name: "isTerminated"))
|
|
1715
1745
|
ServiceJobSummary.struct_class = Types::ServiceJobSummary
|
|
1716
1746
|
|
|
1717
1747
|
ServiceJobSummaryList.member = Shapes::ShapeRef.new(shape: ServiceJobSummary)
|
|
@@ -1855,12 +1885,42 @@ module Aws::Batch
|
|
|
1855
1885
|
|
|
1856
1886
|
TerminateJobResponse.struct_class = Types::TerminateJobResponse
|
|
1857
1887
|
|
|
1888
|
+
TerminateJobsErrorDetail.add_member(:job, Shapes::ShapeRef.new(shape: String, required: true, location_name: "job"))
|
|
1889
|
+
TerminateJobsErrorDetail.add_member(:code, Shapes::ShapeRef.new(shape: String, required: true, location_name: "code"))
|
|
1890
|
+
TerminateJobsErrorDetail.add_member(:message, Shapes::ShapeRef.new(shape: String, required: true, location_name: "message"))
|
|
1891
|
+
TerminateJobsErrorDetail.struct_class = Types::TerminateJobsErrorDetail
|
|
1892
|
+
|
|
1893
|
+
TerminateJobsErrorDetailList.member = Shapes::ShapeRef.new(shape: TerminateJobsErrorDetail)
|
|
1894
|
+
|
|
1895
|
+
TerminateJobsRequest.add_member(:jobs, Shapes::ShapeRef.new(shape: StringList, required: true, location_name: "jobs"))
|
|
1896
|
+
TerminateJobsRequest.add_member(:reason, Shapes::ShapeRef.new(shape: String, required: true, location_name: "reason"))
|
|
1897
|
+
TerminateJobsRequest.struct_class = Types::TerminateJobsRequest
|
|
1898
|
+
|
|
1899
|
+
TerminateJobsResponse.add_member(:successful, Shapes::ShapeRef.new(shape: StringList, required: true, location_name: "successful"))
|
|
1900
|
+
TerminateJobsResponse.add_member(:errors, Shapes::ShapeRef.new(shape: TerminateJobsErrorDetailList, required: true, location_name: "errors"))
|
|
1901
|
+
TerminateJobsResponse.struct_class = Types::TerminateJobsResponse
|
|
1902
|
+
|
|
1858
1903
|
TerminateServiceJobRequest.add_member(:job_id, Shapes::ShapeRef.new(shape: String, required: true, location_name: "jobId"))
|
|
1859
1904
|
TerminateServiceJobRequest.add_member(:reason, Shapes::ShapeRef.new(shape: String, required: true, location_name: "reason"))
|
|
1860
1905
|
TerminateServiceJobRequest.struct_class = Types::TerminateServiceJobRequest
|
|
1861
1906
|
|
|
1862
1907
|
TerminateServiceJobResponse.struct_class = Types::TerminateServiceJobResponse
|
|
1863
1908
|
|
|
1909
|
+
TerminateServiceJobsErrorDetail.add_member(:job, Shapes::ShapeRef.new(shape: String, required: true, location_name: "job"))
|
|
1910
|
+
TerminateServiceJobsErrorDetail.add_member(:code, Shapes::ShapeRef.new(shape: String, required: true, location_name: "code"))
|
|
1911
|
+
TerminateServiceJobsErrorDetail.add_member(:message, Shapes::ShapeRef.new(shape: String, required: true, location_name: "message"))
|
|
1912
|
+
TerminateServiceJobsErrorDetail.struct_class = Types::TerminateServiceJobsErrorDetail
|
|
1913
|
+
|
|
1914
|
+
TerminateServiceJobsErrorDetailList.member = Shapes::ShapeRef.new(shape: TerminateServiceJobsErrorDetail)
|
|
1915
|
+
|
|
1916
|
+
TerminateServiceJobsRequest.add_member(:jobs, Shapes::ShapeRef.new(shape: StringList, required: true, location_name: "jobs"))
|
|
1917
|
+
TerminateServiceJobsRequest.add_member(:reason, Shapes::ShapeRef.new(shape: String, required: true, location_name: "reason"))
|
|
1918
|
+
TerminateServiceJobsRequest.struct_class = Types::TerminateServiceJobsRequest
|
|
1919
|
+
|
|
1920
|
+
TerminateServiceJobsResponse.add_member(:successful, Shapes::ShapeRef.new(shape: StringList, required: true, location_name: "successful"))
|
|
1921
|
+
TerminateServiceJobsResponse.add_member(:errors, Shapes::ShapeRef.new(shape: TerminateServiceJobsErrorDetailList, required: true, location_name: "errors"))
|
|
1922
|
+
TerminateServiceJobsResponse.struct_class = Types::TerminateServiceJobsResponse
|
|
1923
|
+
|
|
1864
1924
|
Tmpfs.add_member(:container_path, Shapes::ShapeRef.new(shape: String, required: true, location_name: "containerPath"))
|
|
1865
1925
|
Tmpfs.add_member(:size, Shapes::ShapeRef.new(shape: Integer, required: true, location_name: "size"))
|
|
1866
1926
|
Tmpfs.add_member(:mount_options, Shapes::ShapeRef.new(shape: StringList, location_name: "mountOptions"))
|
|
@@ -2003,6 +2063,16 @@ module Aws::Batch
|
|
|
2003
2063
|
o.errors << Shapes::ShapeRef.new(shape: ServerException)
|
|
2004
2064
|
end)
|
|
2005
2065
|
|
|
2066
|
+
api.add_operation(:cancel_jobs, Seahorse::Model::Operation.new.tap do |o|
|
|
2067
|
+
o.name = "CancelJobs"
|
|
2068
|
+
o.http_method = "POST"
|
|
2069
|
+
o.http_request_uri = "/v1/canceljobs"
|
|
2070
|
+
o.input = Shapes::ShapeRef.new(shape: CancelJobsRequest)
|
|
2071
|
+
o.output = Shapes::ShapeRef.new(shape: CancelJobsResponse)
|
|
2072
|
+
o.errors << Shapes::ShapeRef.new(shape: ClientException)
|
|
2073
|
+
o.errors << Shapes::ShapeRef.new(shape: ServerException)
|
|
2074
|
+
end)
|
|
2075
|
+
|
|
2006
2076
|
api.add_operation(:create_compute_environment, Seahorse::Model::Operation.new.tap do |o|
|
|
2007
2077
|
o.name = "CreateComputeEnvironment"
|
|
2008
2078
|
o.http_method = "POST"
|
|
@@ -2413,6 +2483,16 @@ module Aws::Batch
|
|
|
2413
2483
|
o.errors << Shapes::ShapeRef.new(shape: ServerException)
|
|
2414
2484
|
end)
|
|
2415
2485
|
|
|
2486
|
+
api.add_operation(:terminate_jobs, Seahorse::Model::Operation.new.tap do |o|
|
|
2487
|
+
o.name = "TerminateJobs"
|
|
2488
|
+
o.http_method = "POST"
|
|
2489
|
+
o.http_request_uri = "/v1/terminatejobs"
|
|
2490
|
+
o.input = Shapes::ShapeRef.new(shape: TerminateJobsRequest)
|
|
2491
|
+
o.output = Shapes::ShapeRef.new(shape: TerminateJobsResponse)
|
|
2492
|
+
o.errors << Shapes::ShapeRef.new(shape: ClientException)
|
|
2493
|
+
o.errors << Shapes::ShapeRef.new(shape: ServerException)
|
|
2494
|
+
end)
|
|
2495
|
+
|
|
2416
2496
|
api.add_operation(:terminate_service_job, Seahorse::Model::Operation.new.tap do |o|
|
|
2417
2497
|
o.name = "TerminateServiceJob"
|
|
2418
2498
|
o.http_method = "POST"
|
|
@@ -2423,6 +2503,16 @@ module Aws::Batch
|
|
|
2423
2503
|
o.errors << Shapes::ShapeRef.new(shape: ServerException)
|
|
2424
2504
|
end)
|
|
2425
2505
|
|
|
2506
|
+
api.add_operation(:terminate_service_jobs, Seahorse::Model::Operation.new.tap do |o|
|
|
2507
|
+
o.name = "TerminateServiceJobs"
|
|
2508
|
+
o.http_method = "POST"
|
|
2509
|
+
o.http_request_uri = "/v1/terminateservicejobs"
|
|
2510
|
+
o.input = Shapes::ShapeRef.new(shape: TerminateServiceJobsRequest)
|
|
2511
|
+
o.output = Shapes::ShapeRef.new(shape: TerminateServiceJobsResponse)
|
|
2512
|
+
o.errors << Shapes::ShapeRef.new(shape: ClientException)
|
|
2513
|
+
o.errors << Shapes::ShapeRef.new(shape: ServerException)
|
|
2514
|
+
end)
|
|
2515
|
+
|
|
2426
2516
|
api.add_operation(:untag_resource, Seahorse::Model::Operation.new.tap do |o|
|
|
2427
2517
|
o.name = "UntagResource"
|
|
2428
2518
|
o.http_method = "DELETE"
|
data/lib/aws-sdk-batch/types.rb
CHANGED
|
@@ -251,11 +251,11 @@ module Aws::Batch
|
|
|
251
251
|
#
|
|
252
252
|
# @!attribute [rw] reason
|
|
253
253
|
# A message to attach to the job that explains the reason for
|
|
254
|
-
#
|
|
254
|
+
# cancelling it. This message is returned by future DescribeJobs
|
|
255
255
|
# operations on the job. It is also recorded in the Batch activity
|
|
256
256
|
# logs.
|
|
257
257
|
#
|
|
258
|
-
# This parameter has
|
|
258
|
+
# This parameter has a limit of 1024 characters.
|
|
259
259
|
# @return [String]
|
|
260
260
|
#
|
|
261
261
|
# @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/CancelJobRequest AWS API Documentation
|
|
@@ -271,6 +271,92 @@ module Aws::Batch
|
|
|
271
271
|
#
|
|
272
272
|
class CancelJobResponse < Aws::EmptyStructure; end
|
|
273
273
|
|
|
274
|
+
# An object that contains the details of a job that couldn't be
|
|
275
|
+
# cancelled by a `CancelJobs` operation.
|
|
276
|
+
#
|
|
277
|
+
# @!attribute [rw] job
|
|
278
|
+
# The Batch job ID of the job that couldn't be cancelled.
|
|
279
|
+
# @return [String]
|
|
280
|
+
#
|
|
281
|
+
# @!attribute [rw] code
|
|
282
|
+
# An error code that identifies the reason the job couldn't be
|
|
283
|
+
# cancelled. Valid values are:
|
|
284
|
+
#
|
|
285
|
+
# * `ValidationException` – A job identifier in the request is
|
|
286
|
+
# malformed or isn't valid.
|
|
287
|
+
#
|
|
288
|
+
# * `ClientException` – The request failed because of a client error.
|
|
289
|
+
#
|
|
290
|
+
# * `ThrottlingException` – The request was throttled. Retry the
|
|
291
|
+
# request.
|
|
292
|
+
#
|
|
293
|
+
# * `ServerException` – An internal error occurred. Retry the request.
|
|
294
|
+
#
|
|
295
|
+
# * `AccessDenied` – The caller isn't authorized to perform the
|
|
296
|
+
# action on the specified job.
|
|
297
|
+
# @return [String]
|
|
298
|
+
#
|
|
299
|
+
# @!attribute [rw] message
|
|
300
|
+
# A message that describes the reason the job couldn't be cancelled.
|
|
301
|
+
# @return [String]
|
|
302
|
+
#
|
|
303
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/CancelJobsErrorDetail AWS API Documentation
|
|
304
|
+
#
|
|
305
|
+
class CancelJobsErrorDetail < Struct.new(
|
|
306
|
+
:job,
|
|
307
|
+
:code,
|
|
308
|
+
:message)
|
|
309
|
+
SENSITIVE = []
|
|
310
|
+
include Aws::Structure
|
|
311
|
+
end
|
|
312
|
+
|
|
313
|
+
# Specifies the jobs to cancel and the reason for the cancellation.
|
|
314
|
+
#
|
|
315
|
+
# @!attribute [rw] jobs
|
|
316
|
+
# An array of up to 50 Batch job IDs of the jobs to cancel.
|
|
317
|
+
# @return [Array<String>]
|
|
318
|
+
#
|
|
319
|
+
# @!attribute [rw] reason
|
|
320
|
+
# A message to attach to the job that explains the reason for
|
|
321
|
+
# cancelling it. This message is returned by future DescribeJobs
|
|
322
|
+
# operations on the job. It is also recorded in the Batch activity
|
|
323
|
+
# logs.
|
|
324
|
+
#
|
|
325
|
+
# This parameter has a limit of 1024 characters.
|
|
326
|
+
# @return [String]
|
|
327
|
+
#
|
|
328
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/CancelJobsRequest AWS API Documentation
|
|
329
|
+
#
|
|
330
|
+
class CancelJobsRequest < Struct.new(
|
|
331
|
+
:jobs,
|
|
332
|
+
:reason)
|
|
333
|
+
SENSITIVE = []
|
|
334
|
+
include Aws::Structure
|
|
335
|
+
end
|
|
336
|
+
|
|
337
|
+
# The result of a `CancelJobs` request, including the jobs whose
|
|
338
|
+
# cancellation request was accepted and the errors for jobs that
|
|
339
|
+
# couldn't be cancelled.
|
|
340
|
+
#
|
|
341
|
+
# @!attribute [rw] successful
|
|
342
|
+
# A list of the job IDs whose cancellation request was accepted.
|
|
343
|
+
# @return [Array<String>]
|
|
344
|
+
#
|
|
345
|
+
# @!attribute [rw] errors
|
|
346
|
+
# A list of `CancelJobsErrorDetail` items, one for each job that
|
|
347
|
+
# couldn't be cancelled. Each item includes the job ID along with a
|
|
348
|
+
# code and message that describe why the job wasn't cancelled.
|
|
349
|
+
# @return [Array<Types::CancelJobsErrorDetail>]
|
|
350
|
+
#
|
|
351
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/CancelJobsResponse AWS API Documentation
|
|
352
|
+
#
|
|
353
|
+
class CancelJobsResponse < Struct.new(
|
|
354
|
+
:successful,
|
|
355
|
+
:errors)
|
|
356
|
+
SENSITIVE = []
|
|
357
|
+
include Aws::Structure
|
|
358
|
+
end
|
|
359
|
+
|
|
274
360
|
# Defines the type and maximum quantity of resources that can be
|
|
275
361
|
# allocated to service jobs in a service environment.
|
|
276
362
|
#
|
|
@@ -6873,7 +6959,7 @@ module Aws::Batch
|
|
|
6873
6959
|
# @return [Types::EcsPropertiesDetail]
|
|
6874
6960
|
#
|
|
6875
6961
|
# @!attribute [rw] is_cancelled
|
|
6876
|
-
# Indicates whether the job is
|
|
6962
|
+
# Indicates whether the job is cancelled.
|
|
6877
6963
|
# @return [Boolean]
|
|
6878
6964
|
#
|
|
6879
6965
|
# @!attribute [rw] is_terminated
|
|
@@ -7169,6 +7255,16 @@ module Aws::Batch
|
|
|
7169
7255
|
# The Amazon Resource Name (ARN) of the job definition.
|
|
7170
7256
|
# @return [String]
|
|
7171
7257
|
#
|
|
7258
|
+
# @!attribute [rw] is_cancelled
|
|
7259
|
+
# Indicates whether a cancellation request has been accepted for the
|
|
7260
|
+
# job. This field is only present when the value is `true`.
|
|
7261
|
+
# @return [Boolean]
|
|
7262
|
+
#
|
|
7263
|
+
# @!attribute [rw] is_terminated
|
|
7264
|
+
# Indicates whether a termination request has been accepted for the
|
|
7265
|
+
# job. This field is only present when the value is `true`.
|
|
7266
|
+
# @return [Boolean]
|
|
7267
|
+
#
|
|
7172
7268
|
# @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/JobSummary AWS API Documentation
|
|
7173
7269
|
#
|
|
7174
7270
|
class JobSummary < Struct.new(
|
|
@@ -7186,7 +7282,9 @@ module Aws::Batch
|
|
|
7186
7282
|
:container,
|
|
7187
7283
|
:array_properties,
|
|
7188
7284
|
:node_properties,
|
|
7189
|
-
:job_definition
|
|
7285
|
+
:job_definition,
|
|
7286
|
+
:is_cancelled,
|
|
7287
|
+
:is_terminated)
|
|
7190
7288
|
SENSITIVE = []
|
|
7191
7289
|
include Aws::Structure
|
|
7192
7290
|
end
|
|
@@ -10101,6 +10199,11 @@ module Aws::Batch
|
|
|
10101
10199
|
# stopped running.
|
|
10102
10200
|
# @return [Integer]
|
|
10103
10201
|
#
|
|
10202
|
+
# @!attribute [rw] is_terminated
|
|
10203
|
+
# Indicates whether a termination request has been accepted for the
|
|
10204
|
+
# service job. This field is only present when the value is `true`.
|
|
10205
|
+
# @return [Boolean]
|
|
10206
|
+
#
|
|
10104
10207
|
# @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/ServiceJobSummary AWS API Documentation
|
|
10105
10208
|
#
|
|
10106
10209
|
class ServiceJobSummary < Struct.new(
|
|
@@ -10117,7 +10220,8 @@ module Aws::Batch
|
|
|
10117
10220
|
:status,
|
|
10118
10221
|
:status_reason,
|
|
10119
10222
|
:started_at,
|
|
10120
|
-
:stopped_at
|
|
10223
|
+
:stopped_at,
|
|
10224
|
+
:is_terminated)
|
|
10121
10225
|
SENSITIVE = []
|
|
10122
10226
|
include Aws::Structure
|
|
10123
10227
|
end
|
|
@@ -11353,11 +11457,11 @@ module Aws::Batch
|
|
|
11353
11457
|
#
|
|
11354
11458
|
# @!attribute [rw] reason
|
|
11355
11459
|
# A message to attach to the job that explains the reason for
|
|
11356
|
-
#
|
|
11460
|
+
# terminating it. This message is returned by future DescribeJobs
|
|
11357
11461
|
# operations on the job. It is also recorded in the Batch activity
|
|
11358
11462
|
# logs.
|
|
11359
11463
|
#
|
|
11360
|
-
# This parameter has
|
|
11464
|
+
# This parameter has a limit of 1024 characters.
|
|
11361
11465
|
# @return [String]
|
|
11362
11466
|
#
|
|
11363
11467
|
# @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/TerminateJobRequest AWS API Documentation
|
|
@@ -11373,13 +11477,99 @@ module Aws::Batch
|
|
|
11373
11477
|
#
|
|
11374
11478
|
class TerminateJobResponse < Aws::EmptyStructure; end
|
|
11375
11479
|
|
|
11480
|
+
# An object that contains the details of a job that couldn't be
|
|
11481
|
+
# terminated by a `TerminateJobs` operation.
|
|
11482
|
+
#
|
|
11483
|
+
# @!attribute [rw] job
|
|
11484
|
+
# The Batch job ID of the job that couldn't be terminated.
|
|
11485
|
+
# @return [String]
|
|
11486
|
+
#
|
|
11487
|
+
# @!attribute [rw] code
|
|
11488
|
+
# An error code that identifies the reason the job couldn't be
|
|
11489
|
+
# terminated. Valid values are:
|
|
11490
|
+
#
|
|
11491
|
+
# * `ValidationException` – A job identifier in the request is
|
|
11492
|
+
# malformed or isn't valid.
|
|
11493
|
+
#
|
|
11494
|
+
# * `ClientException` – The request failed because of a client error.
|
|
11495
|
+
#
|
|
11496
|
+
# * `ThrottlingException` – The request was throttled. Retry the
|
|
11497
|
+
# request.
|
|
11498
|
+
#
|
|
11499
|
+
# * `ServerException` – An internal error occurred. Retry the request.
|
|
11500
|
+
#
|
|
11501
|
+
# * `AccessDenied` – The caller isn't authorized to perform the
|
|
11502
|
+
# action on the specified job.
|
|
11503
|
+
# @return [String]
|
|
11504
|
+
#
|
|
11505
|
+
# @!attribute [rw] message
|
|
11506
|
+
# A message that describes the reason the job couldn't be terminated.
|
|
11507
|
+
# @return [String]
|
|
11508
|
+
#
|
|
11509
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/TerminateJobsErrorDetail AWS API Documentation
|
|
11510
|
+
#
|
|
11511
|
+
class TerminateJobsErrorDetail < Struct.new(
|
|
11512
|
+
:job,
|
|
11513
|
+
:code,
|
|
11514
|
+
:message)
|
|
11515
|
+
SENSITIVE = []
|
|
11516
|
+
include Aws::Structure
|
|
11517
|
+
end
|
|
11518
|
+
|
|
11519
|
+
# Specifies the jobs to terminate and the reason for the termination.
|
|
11520
|
+
#
|
|
11521
|
+
# @!attribute [rw] jobs
|
|
11522
|
+
# An array of up to 50 Batch job IDs of the jobs to terminate.
|
|
11523
|
+
# @return [Array<String>]
|
|
11524
|
+
#
|
|
11525
|
+
# @!attribute [rw] reason
|
|
11526
|
+
# A message to attach to the job that explains the reason for
|
|
11527
|
+
# terminating it. This message is returned by future DescribeJobs
|
|
11528
|
+
# operations on the job. It is also recorded in the Batch activity
|
|
11529
|
+
# logs.
|
|
11530
|
+
#
|
|
11531
|
+
# This parameter has a limit of 1024 characters.
|
|
11532
|
+
# @return [String]
|
|
11533
|
+
#
|
|
11534
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/TerminateJobsRequest AWS API Documentation
|
|
11535
|
+
#
|
|
11536
|
+
class TerminateJobsRequest < Struct.new(
|
|
11537
|
+
:jobs,
|
|
11538
|
+
:reason)
|
|
11539
|
+
SENSITIVE = []
|
|
11540
|
+
include Aws::Structure
|
|
11541
|
+
end
|
|
11542
|
+
|
|
11543
|
+
# The result of a `TerminateJobs` request, including the jobs whose
|
|
11544
|
+
# termination request was accepted and the errors for jobs that
|
|
11545
|
+
# couldn't be terminated.
|
|
11546
|
+
#
|
|
11547
|
+
# @!attribute [rw] successful
|
|
11548
|
+
# A list of the job IDs whose termination request was accepted.
|
|
11549
|
+
# @return [Array<String>]
|
|
11550
|
+
#
|
|
11551
|
+
# @!attribute [rw] errors
|
|
11552
|
+
# A list of `TerminateJobsErrorDetail` items, one for each job that
|
|
11553
|
+
# couldn't be terminated. Each item includes the job ID along with a
|
|
11554
|
+
# code and message that describe why the job wasn't terminated.
|
|
11555
|
+
# @return [Array<Types::TerminateJobsErrorDetail>]
|
|
11556
|
+
#
|
|
11557
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/TerminateJobsResponse AWS API Documentation
|
|
11558
|
+
#
|
|
11559
|
+
class TerminateJobsResponse < Struct.new(
|
|
11560
|
+
:successful,
|
|
11561
|
+
:errors)
|
|
11562
|
+
SENSITIVE = []
|
|
11563
|
+
include Aws::Structure
|
|
11564
|
+
end
|
|
11565
|
+
|
|
11376
11566
|
# @!attribute [rw] job_id
|
|
11377
11567
|
# The service job ID of the service job to terminate.
|
|
11378
11568
|
# @return [String]
|
|
11379
11569
|
#
|
|
11380
11570
|
# @!attribute [rw] reason
|
|
11381
11571
|
# A message to attach to the service job that explains the reason for
|
|
11382
|
-
#
|
|
11572
|
+
# terminating it. This message is returned by `DescribeServiceJob`
|
|
11383
11573
|
# operations on the service job.
|
|
11384
11574
|
# @return [String]
|
|
11385
11575
|
#
|
|
@@ -11396,6 +11586,94 @@ module Aws::Batch
|
|
|
11396
11586
|
#
|
|
11397
11587
|
class TerminateServiceJobResponse < Aws::EmptyStructure; end
|
|
11398
11588
|
|
|
11589
|
+
# An object that contains the details of a service job that couldn't be
|
|
11590
|
+
# terminated by a `TerminateServiceJobs` operation.
|
|
11591
|
+
#
|
|
11592
|
+
# @!attribute [rw] job
|
|
11593
|
+
# The service job ID of the service job that couldn't be terminated.
|
|
11594
|
+
# @return [String]
|
|
11595
|
+
#
|
|
11596
|
+
# @!attribute [rw] code
|
|
11597
|
+
# An error code that identifies the reason the service job couldn't
|
|
11598
|
+
# be terminated. Valid values are:
|
|
11599
|
+
#
|
|
11600
|
+
# * `ValidationException` – A service job identifier in the request is
|
|
11601
|
+
# malformed or isn't valid.
|
|
11602
|
+
#
|
|
11603
|
+
# * `ClientException` – The request failed because of a client error.
|
|
11604
|
+
#
|
|
11605
|
+
# * `ThrottlingException` – The request was throttled. Retry the
|
|
11606
|
+
# request.
|
|
11607
|
+
#
|
|
11608
|
+
# * `ServerException` – An internal error occurred. Retry the request.
|
|
11609
|
+
#
|
|
11610
|
+
# * `AccessDenied` – The caller isn't authorized to perform the
|
|
11611
|
+
# action on the specified service job.
|
|
11612
|
+
# @return [String]
|
|
11613
|
+
#
|
|
11614
|
+
# @!attribute [rw] message
|
|
11615
|
+
# A message that describes the reason the service job couldn't be
|
|
11616
|
+
# terminated.
|
|
11617
|
+
# @return [String]
|
|
11618
|
+
#
|
|
11619
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/TerminateServiceJobsErrorDetail AWS API Documentation
|
|
11620
|
+
#
|
|
11621
|
+
class TerminateServiceJobsErrorDetail < Struct.new(
|
|
11622
|
+
:job,
|
|
11623
|
+
:code,
|
|
11624
|
+
:message)
|
|
11625
|
+
SENSITIVE = []
|
|
11626
|
+
include Aws::Structure
|
|
11627
|
+
end
|
|
11628
|
+
|
|
11629
|
+
# Specifies the service jobs to terminate and the reason for the
|
|
11630
|
+
# termination.
|
|
11631
|
+
#
|
|
11632
|
+
# @!attribute [rw] jobs
|
|
11633
|
+
# An array of up to 50 service job IDs of the service jobs to
|
|
11634
|
+
# terminate.
|
|
11635
|
+
# @return [Array<String>]
|
|
11636
|
+
#
|
|
11637
|
+
# @!attribute [rw] reason
|
|
11638
|
+
# A message to attach to the service job that explains the reason for
|
|
11639
|
+
# terminating it. This message is returned by `DescribeServiceJob`
|
|
11640
|
+
# operations on the service job.
|
|
11641
|
+
# @return [String]
|
|
11642
|
+
#
|
|
11643
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/TerminateServiceJobsRequest AWS API Documentation
|
|
11644
|
+
#
|
|
11645
|
+
class TerminateServiceJobsRequest < Struct.new(
|
|
11646
|
+
:jobs,
|
|
11647
|
+
:reason)
|
|
11648
|
+
SENSITIVE = []
|
|
11649
|
+
include Aws::Structure
|
|
11650
|
+
end
|
|
11651
|
+
|
|
11652
|
+
# The result of a `TerminateServiceJobs` request, including the service
|
|
11653
|
+
# jobs whose termination request was accepted and the errors for service
|
|
11654
|
+
# jobs that couldn't be terminated.
|
|
11655
|
+
#
|
|
11656
|
+
# @!attribute [rw] successful
|
|
11657
|
+
# A list of the service job IDs whose termination request was
|
|
11658
|
+
# accepted.
|
|
11659
|
+
# @return [Array<String>]
|
|
11660
|
+
#
|
|
11661
|
+
# @!attribute [rw] errors
|
|
11662
|
+
# A list of `TerminateServiceJobsErrorDetail` items, one for each
|
|
11663
|
+
# service job that couldn't be terminated. Each item includes the
|
|
11664
|
+
# service job ID along with a code and message that describe why the
|
|
11665
|
+
# service job wasn't terminated.
|
|
11666
|
+
# @return [Array<Types::TerminateServiceJobsErrorDetail>]
|
|
11667
|
+
#
|
|
11668
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/TerminateServiceJobsResponse AWS API Documentation
|
|
11669
|
+
#
|
|
11670
|
+
class TerminateServiceJobsResponse < Struct.new(
|
|
11671
|
+
:successful,
|
|
11672
|
+
:errors)
|
|
11673
|
+
SENSITIVE = []
|
|
11674
|
+
include Aws::Structure
|
|
11675
|
+
end
|
|
11676
|
+
|
|
11399
11677
|
# The container path, mount options, and size of the `tmpfs` mount.
|
|
11400
11678
|
#
|
|
11401
11679
|
# <note markdown="1"> This object isn't applicable to jobs that are running on Fargate
|
data/lib/aws-sdk-batch.rb
CHANGED
data/sig/client.rbs
CHANGED
|
@@ -88,6 +88,18 @@ module Aws
|
|
|
88
88
|
) -> _CancelJobResponseSuccess
|
|
89
89
|
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _CancelJobResponseSuccess
|
|
90
90
|
|
|
91
|
+
interface _CancelJobsResponseSuccess
|
|
92
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::CancelJobsResponse]
|
|
93
|
+
def successful: () -> ::Array[::String]
|
|
94
|
+
def errors: () -> ::Array[Types::CancelJobsErrorDetail]
|
|
95
|
+
end
|
|
96
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Batch/Client.html#cancel_jobs-instance_method
|
|
97
|
+
def cancel_jobs: (
|
|
98
|
+
jobs: Array[::String],
|
|
99
|
+
reason: ::String
|
|
100
|
+
) -> _CancelJobsResponseSuccess
|
|
101
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _CancelJobsResponseSuccess
|
|
102
|
+
|
|
91
103
|
interface _CreateComputeEnvironmentResponseSuccess
|
|
92
104
|
include ::Seahorse::Client::_ResponseSuccess[Types::CreateComputeEnvironmentResponse]
|
|
93
105
|
def compute_environment_name: () -> ::String
|
|
@@ -789,6 +801,18 @@ module Aws
|
|
|
789
801
|
) -> _TerminateJobResponseSuccess
|
|
790
802
|
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _TerminateJobResponseSuccess
|
|
791
803
|
|
|
804
|
+
interface _TerminateJobsResponseSuccess
|
|
805
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::TerminateJobsResponse]
|
|
806
|
+
def successful: () -> ::Array[::String]
|
|
807
|
+
def errors: () -> ::Array[Types::TerminateJobsErrorDetail]
|
|
808
|
+
end
|
|
809
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Batch/Client.html#terminate_jobs-instance_method
|
|
810
|
+
def terminate_jobs: (
|
|
811
|
+
jobs: Array[::String],
|
|
812
|
+
reason: ::String
|
|
813
|
+
) -> _TerminateJobsResponseSuccess
|
|
814
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _TerminateJobsResponseSuccess
|
|
815
|
+
|
|
792
816
|
interface _TerminateServiceJobResponseSuccess
|
|
793
817
|
include ::Seahorse::Client::_ResponseSuccess[Types::TerminateServiceJobResponse]
|
|
794
818
|
end
|
|
@@ -799,6 +823,18 @@ module Aws
|
|
|
799
823
|
) -> _TerminateServiceJobResponseSuccess
|
|
800
824
|
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _TerminateServiceJobResponseSuccess
|
|
801
825
|
|
|
826
|
+
interface _TerminateServiceJobsResponseSuccess
|
|
827
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::TerminateServiceJobsResponse]
|
|
828
|
+
def successful: () -> ::Array[::String]
|
|
829
|
+
def errors: () -> ::Array[Types::TerminateServiceJobsErrorDetail]
|
|
830
|
+
end
|
|
831
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Batch/Client.html#terminate_service_jobs-instance_method
|
|
832
|
+
def terminate_service_jobs: (
|
|
833
|
+
jobs: Array[::String],
|
|
834
|
+
reason: ::String
|
|
835
|
+
) -> _TerminateServiceJobsResponseSuccess
|
|
836
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _TerminateServiceJobsResponseSuccess
|
|
837
|
+
|
|
802
838
|
interface _UntagResourceResponseSuccess
|
|
803
839
|
include ::Seahorse::Client::_ResponseSuccess[Types::UntagResourceResponse]
|
|
804
840
|
end
|
data/sig/types.rbs
CHANGED
|
@@ -73,6 +73,25 @@ module Aws::Batch
|
|
|
73
73
|
class CancelJobResponse < Aws::EmptyStructure
|
|
74
74
|
end
|
|
75
75
|
|
|
76
|
+
class CancelJobsErrorDetail
|
|
77
|
+
attr_accessor job: ::String
|
|
78
|
+
attr_accessor code: ::String
|
|
79
|
+
attr_accessor message: ::String
|
|
80
|
+
SENSITIVE: []
|
|
81
|
+
end
|
|
82
|
+
|
|
83
|
+
class CancelJobsRequest
|
|
84
|
+
attr_accessor jobs: ::Array[::String]
|
|
85
|
+
attr_accessor reason: ::String
|
|
86
|
+
SENSITIVE: []
|
|
87
|
+
end
|
|
88
|
+
|
|
89
|
+
class CancelJobsResponse
|
|
90
|
+
attr_accessor successful: ::Array[::String]
|
|
91
|
+
attr_accessor errors: ::Array[Types::CancelJobsErrorDetail]
|
|
92
|
+
SENSITIVE: []
|
|
93
|
+
end
|
|
94
|
+
|
|
76
95
|
class CapacityLimit
|
|
77
96
|
attr_accessor max_capacity: ::Integer
|
|
78
97
|
attr_accessor capacity_unit: ::String
|
|
@@ -1072,6 +1091,8 @@ module Aws::Batch
|
|
|
1072
1091
|
attr_accessor array_properties: Types::ArrayPropertiesSummary
|
|
1073
1092
|
attr_accessor node_properties: Types::NodePropertiesSummary
|
|
1074
1093
|
attr_accessor job_definition: ::String
|
|
1094
|
+
attr_accessor is_cancelled: bool
|
|
1095
|
+
attr_accessor is_terminated: bool
|
|
1075
1096
|
SENSITIVE: []
|
|
1076
1097
|
end
|
|
1077
1098
|
|
|
@@ -1559,6 +1580,7 @@ module Aws::Batch
|
|
|
1559
1580
|
attr_accessor status_reason: ::String
|
|
1560
1581
|
attr_accessor started_at: ::Integer
|
|
1561
1582
|
attr_accessor stopped_at: ::Integer
|
|
1583
|
+
attr_accessor is_terminated: bool
|
|
1562
1584
|
SENSITIVE: []
|
|
1563
1585
|
end
|
|
1564
1586
|
|
|
@@ -1717,6 +1739,25 @@ module Aws::Batch
|
|
|
1717
1739
|
class TerminateJobResponse < Aws::EmptyStructure
|
|
1718
1740
|
end
|
|
1719
1741
|
|
|
1742
|
+
class TerminateJobsErrorDetail
|
|
1743
|
+
attr_accessor job: ::String
|
|
1744
|
+
attr_accessor code: ::String
|
|
1745
|
+
attr_accessor message: ::String
|
|
1746
|
+
SENSITIVE: []
|
|
1747
|
+
end
|
|
1748
|
+
|
|
1749
|
+
class TerminateJobsRequest
|
|
1750
|
+
attr_accessor jobs: ::Array[::String]
|
|
1751
|
+
attr_accessor reason: ::String
|
|
1752
|
+
SENSITIVE: []
|
|
1753
|
+
end
|
|
1754
|
+
|
|
1755
|
+
class TerminateJobsResponse
|
|
1756
|
+
attr_accessor successful: ::Array[::String]
|
|
1757
|
+
attr_accessor errors: ::Array[Types::TerminateJobsErrorDetail]
|
|
1758
|
+
SENSITIVE: []
|
|
1759
|
+
end
|
|
1760
|
+
|
|
1720
1761
|
class TerminateServiceJobRequest
|
|
1721
1762
|
attr_accessor job_id: ::String
|
|
1722
1763
|
attr_accessor reason: ::String
|
|
@@ -1726,6 +1767,25 @@ module Aws::Batch
|
|
|
1726
1767
|
class TerminateServiceJobResponse < Aws::EmptyStructure
|
|
1727
1768
|
end
|
|
1728
1769
|
|
|
1770
|
+
class TerminateServiceJobsErrorDetail
|
|
1771
|
+
attr_accessor job: ::String
|
|
1772
|
+
attr_accessor code: ::String
|
|
1773
|
+
attr_accessor message: ::String
|
|
1774
|
+
SENSITIVE: []
|
|
1775
|
+
end
|
|
1776
|
+
|
|
1777
|
+
class TerminateServiceJobsRequest
|
|
1778
|
+
attr_accessor jobs: ::Array[::String]
|
|
1779
|
+
attr_accessor reason: ::String
|
|
1780
|
+
SENSITIVE: []
|
|
1781
|
+
end
|
|
1782
|
+
|
|
1783
|
+
class TerminateServiceJobsResponse
|
|
1784
|
+
attr_accessor successful: ::Array[::String]
|
|
1785
|
+
attr_accessor errors: ::Array[Types::TerminateServiceJobsErrorDetail]
|
|
1786
|
+
SENSITIVE: []
|
|
1787
|
+
end
|
|
1788
|
+
|
|
1729
1789
|
class Tmpfs
|
|
1730
1790
|
attr_accessor container_path: ::String
|
|
1731
1791
|
attr_accessor size: ::Integer
|
metadata
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: aws-sdk-batch
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 1.
|
|
4
|
+
version: 1.153.0
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- Amazon Web Services
|
|
@@ -18,7 +18,7 @@ dependencies:
|
|
|
18
18
|
version: '3'
|
|
19
19
|
- - ">="
|
|
20
20
|
- !ruby/object:Gem::Version
|
|
21
|
-
version: 3.
|
|
21
|
+
version: 3.256.0
|
|
22
22
|
type: :runtime
|
|
23
23
|
prerelease: false
|
|
24
24
|
version_requirements: !ruby/object:Gem::Requirement
|
|
@@ -28,7 +28,7 @@ dependencies:
|
|
|
28
28
|
version: '3'
|
|
29
29
|
- - ">="
|
|
30
30
|
- !ruby/object:Gem::Version
|
|
31
|
-
version: 3.
|
|
31
|
+
version: 3.256.0
|
|
32
32
|
- !ruby/object:Gem::Dependency
|
|
33
33
|
name: aws-sigv4
|
|
34
34
|
requirement: !ruby/object:Gem::Requirement
|