aws-sdk-batch 1.0.0.rc1 → 1.0.0.rc2
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/lib/aws-sdk-batch.rb +1 -1
- data/lib/aws-sdk-batch/client.rb +70 -5
- data/lib/aws-sdk-batch/client_api.rb +28 -0
- data/lib/aws-sdk-batch/types.rb +245 -8
- metadata +2 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA1:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 122fb3cc7aa68cd9ff1fa5f5f919ede2e85e59f7
|
4
|
+
data.tar.gz: 124886cc6a127cca3321f7325f4a3a8701cd7d0c
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 56f38cafbe4bd319f9d35ab358f5b42983b28c5afd203513f95d33ed38efcfe8f2560db73bf5eaeb6b1b895487154935d99c5ac2bf78016312540d2ce6d062a8
|
7
|
+
data.tar.gz: bbf997dd91a72ea7d4cb89b0a00d1238d60358fa681b29d94158298c60da9578c849171d674f9347492c7df90010c22d2e3d8a2cacd88f274a82520b023a06f6
|
data/lib/aws-sdk-batch.rb
CHANGED
data/lib/aws-sdk-batch/client.rb
CHANGED
@@ -18,6 +18,7 @@ require 'aws-sdk-core/plugins/regional_endpoint.rb'
|
|
18
18
|
require 'aws-sdk-core/plugins/response_paging.rb'
|
19
19
|
require 'aws-sdk-core/plugins/stub_responses.rb'
|
20
20
|
require 'aws-sdk-core/plugins/idempotency_token.rb'
|
21
|
+
require 'aws-sdk-core/plugins/jsonvalue_converter.rb'
|
21
22
|
require 'aws-sdk-core/plugins/signature_v4.rb'
|
22
23
|
require 'aws-sdk-core/plugins/protocols/rest_json.rb'
|
23
24
|
|
@@ -45,6 +46,7 @@ module Aws::Batch
|
|
45
46
|
add_plugin(Aws::Plugins::ResponsePaging)
|
46
47
|
add_plugin(Aws::Plugins::StubResponses)
|
47
48
|
add_plugin(Aws::Plugins::IdempotencyToken)
|
49
|
+
add_plugin(Aws::Plugins::JsonvalueConverter)
|
48
50
|
add_plugin(Aws::Plugins::SignatureV4)
|
49
51
|
add_plugin(Aws::Plugins::Protocols::RestJson)
|
50
52
|
|
@@ -166,6 +168,8 @@ module Aws::Batch
|
|
166
168
|
# reason: "String", # required
|
167
169
|
# })
|
168
170
|
#
|
171
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/CancelJob AWS API Documentation
|
172
|
+
#
|
169
173
|
# @overload cancel_job(params = {})
|
170
174
|
# @param [Hash] params ({})
|
171
175
|
def cancel_job(params = {}, options = {})
|
@@ -174,7 +178,7 @@ module Aws::Batch
|
|
174
178
|
end
|
175
179
|
|
176
180
|
# Creates an AWS Batch compute environment. You can create `MANAGED` or
|
177
|
-
# `UNMANAGED`compute environments.
|
181
|
+
# `UNMANAGED` compute environments.
|
178
182
|
#
|
179
183
|
# In a managed compute environment, AWS Batch manages the compute
|
180
184
|
# resources within the environment, based on the compute resources that
|
@@ -239,6 +243,7 @@ module Aws::Batch
|
|
239
243
|
# maxv_cpus: 1, # required
|
240
244
|
# desiredv_cpus: 1,
|
241
245
|
# instance_types: ["String"], # required
|
246
|
+
# image_id: "String",
|
242
247
|
# subnets: ["String"], # required
|
243
248
|
# security_group_ids: ["String"], # required
|
244
249
|
# ec2_key_pair: "String",
|
@@ -257,6 +262,8 @@ module Aws::Batch
|
|
257
262
|
# resp.compute_environment_name #=> String
|
258
263
|
# resp.compute_environment_arn #=> String
|
259
264
|
#
|
265
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/CreateComputeEnvironment AWS API Documentation
|
266
|
+
#
|
260
267
|
# @overload create_compute_environment(params = {})
|
261
268
|
# @param [Hash] params ({})
|
262
269
|
def create_compute_environment(params = {}, options = {})
|
@@ -321,6 +328,8 @@ module Aws::Batch
|
|
321
328
|
# resp.job_queue_name #=> String
|
322
329
|
# resp.job_queue_arn #=> String
|
323
330
|
#
|
331
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/CreateJobQueue AWS API Documentation
|
332
|
+
#
|
324
333
|
# @overload create_job_queue(params = {})
|
325
334
|
# @param [Hash] params ({})
|
326
335
|
def create_job_queue(params = {}, options = {})
|
@@ -347,6 +356,8 @@ module Aws::Batch
|
|
347
356
|
# compute_environment: "String", # required
|
348
357
|
# })
|
349
358
|
#
|
359
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/DeleteComputeEnvironment AWS API Documentation
|
360
|
+
#
|
350
361
|
# @overload delete_compute_environment(params = {})
|
351
362
|
# @param [Hash] params ({})
|
352
363
|
def delete_compute_environment(params = {}, options = {})
|
@@ -373,6 +384,8 @@ module Aws::Batch
|
|
373
384
|
# job_queue: "String", # required
|
374
385
|
# })
|
375
386
|
#
|
387
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/DeleteJobQueue AWS API Documentation
|
388
|
+
#
|
376
389
|
# @overload delete_job_queue(params = {})
|
377
390
|
# @param [Hash] params ({})
|
378
391
|
def delete_job_queue(params = {}, options = {})
|
@@ -394,6 +407,8 @@ module Aws::Batch
|
|
394
407
|
# job_definition: "String", # required
|
395
408
|
# })
|
396
409
|
#
|
410
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/DeregisterJobDefinition AWS API Documentation
|
411
|
+
#
|
397
412
|
# @overload deregister_job_definition(params = {})
|
398
413
|
# @param [Hash] params ({})
|
399
414
|
def deregister_job_definition(params = {}, options = {})
|
@@ -465,6 +480,7 @@ module Aws::Batch
|
|
465
480
|
# resp.compute_environments[0].compute_resources.desiredv_cpus #=> Integer
|
466
481
|
# resp.compute_environments[0].compute_resources.instance_types #=> Array
|
467
482
|
# resp.compute_environments[0].compute_resources.instance_types[0] #=> String
|
483
|
+
# resp.compute_environments[0].compute_resources.image_id #=> String
|
468
484
|
# resp.compute_environments[0].compute_resources.subnets #=> Array
|
469
485
|
# resp.compute_environments[0].compute_resources.subnets[0] #=> String
|
470
486
|
# resp.compute_environments[0].compute_resources.security_group_ids #=> Array
|
@@ -478,6 +494,8 @@ module Aws::Batch
|
|
478
494
|
# resp.compute_environments[0].service_role #=> String
|
479
495
|
# resp.next_token #=> String
|
480
496
|
#
|
497
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/DescribeComputeEnvironments AWS API Documentation
|
498
|
+
#
|
481
499
|
# @overload describe_compute_environments(params = {})
|
482
500
|
# @param [Hash] params ({})
|
483
501
|
def describe_compute_environments(params = {}, options = {})
|
@@ -547,6 +565,7 @@ module Aws::Batch
|
|
547
565
|
# resp.job_definitions[0].type #=> String
|
548
566
|
# resp.job_definitions[0].parameters #=> Hash
|
549
567
|
# resp.job_definitions[0].parameters["String"] #=> String
|
568
|
+
# resp.job_definitions[0].retry_strategy.attempts #=> Integer
|
550
569
|
# resp.job_definitions[0].container_properties.image #=> String
|
551
570
|
# resp.job_definitions[0].container_properties.vcpus #=> Integer
|
552
571
|
# resp.job_definitions[0].container_properties.memory #=> Integer
|
@@ -572,6 +591,8 @@ module Aws::Batch
|
|
572
591
|
# resp.job_definitions[0].container_properties.user #=> String
|
573
592
|
# resp.next_token #=> String
|
574
593
|
#
|
594
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/DescribeJobDefinitions AWS API Documentation
|
595
|
+
#
|
575
596
|
# @overload describe_job_definitions(params = {})
|
576
597
|
# @param [Hash] params ({})
|
577
598
|
def describe_job_definitions(params = {}, options = {})
|
@@ -635,6 +656,8 @@ module Aws::Batch
|
|
635
656
|
# resp.job_queues[0].compute_environment_order[0].compute_environment #=> String
|
636
657
|
# resp.next_token #=> String
|
637
658
|
#
|
659
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/DescribeJobQueues AWS API Documentation
|
660
|
+
#
|
638
661
|
# @overload describe_job_queues(params = {})
|
639
662
|
# @param [Hash] params ({})
|
640
663
|
def describe_job_queues(params = {}, options = {})
|
@@ -664,8 +687,17 @@ module Aws::Batch
|
|
664
687
|
# resp.jobs[0].job_id #=> String
|
665
688
|
# resp.jobs[0].job_queue #=> String
|
666
689
|
# resp.jobs[0].status #=> String, one of "SUBMITTED", "PENDING", "RUNNABLE", "STARTING", "RUNNING", "SUCCEEDED", "FAILED"
|
690
|
+
# resp.jobs[0].attempts #=> Array
|
691
|
+
# resp.jobs[0].attempts[0].container.container_instance_arn #=> String
|
692
|
+
# resp.jobs[0].attempts[0].container.task_arn #=> String
|
693
|
+
# resp.jobs[0].attempts[0].container.exit_code #=> Integer
|
694
|
+
# resp.jobs[0].attempts[0].container.reason #=> String
|
695
|
+
# resp.jobs[0].attempts[0].started_at #=> Integer
|
696
|
+
# resp.jobs[0].attempts[0].stopped_at #=> Integer
|
697
|
+
# resp.jobs[0].attempts[0].status_reason #=> String
|
667
698
|
# resp.jobs[0].status_reason #=> String
|
668
699
|
# resp.jobs[0].created_at #=> Integer
|
700
|
+
# resp.jobs[0].retry_strategy.attempts #=> Integer
|
669
701
|
# resp.jobs[0].started_at #=> Integer
|
670
702
|
# resp.jobs[0].stopped_at #=> Integer
|
671
703
|
# resp.jobs[0].depends_on #=> Array
|
@@ -699,6 +731,9 @@ module Aws::Batch
|
|
699
731
|
# resp.jobs[0].container.exit_code #=> Integer
|
700
732
|
# resp.jobs[0].container.reason #=> String
|
701
733
|
# resp.jobs[0].container.container_instance_arn #=> String
|
734
|
+
# resp.jobs[0].container.task_arn #=> String
|
735
|
+
#
|
736
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/DescribeJobs AWS API Documentation
|
702
737
|
#
|
703
738
|
# @overload describe_jobs(params = {})
|
704
739
|
# @param [Hash] params ({})
|
@@ -761,6 +796,8 @@ module Aws::Batch
|
|
761
796
|
# resp.job_summary_list[0].job_name #=> String
|
762
797
|
# resp.next_token #=> String
|
763
798
|
#
|
799
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/ListJobs AWS API Documentation
|
800
|
+
#
|
764
801
|
# @overload list_jobs(params = {})
|
765
802
|
# @param [Hash] params ({})
|
766
803
|
def list_jobs(params = {}, options = {})
|
@@ -786,6 +823,11 @@ module Aws::Batch
|
|
786
823
|
# An object with various properties specific for container-based jobs.
|
787
824
|
# This parameter is required if the `type` parameter is `container`.
|
788
825
|
#
|
826
|
+
# @option params [Types::RetryStrategy] :retry_strategy
|
827
|
+
# The retry strategy to use for failed jobs that are submitted with this
|
828
|
+
# job definition. Any retry strategy that is specified during a
|
829
|
+
# SubmitJob operation overrides the retry strategy defined here.
|
830
|
+
#
|
789
831
|
# @return [Types::RegisterJobDefinitionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
790
832
|
#
|
791
833
|
# * {Types::RegisterJobDefinitionResponse#job_definition_name #job_definition_name} => String
|
@@ -838,6 +880,9 @@ module Aws::Batch
|
|
838
880
|
# ],
|
839
881
|
# user: "String",
|
840
882
|
# },
|
883
|
+
# retry_strategy: {
|
884
|
+
# attempts: 1,
|
885
|
+
# },
|
841
886
|
# })
|
842
887
|
#
|
843
888
|
# @example Response structure
|
@@ -846,6 +891,8 @@ module Aws::Batch
|
|
846
891
|
# resp.job_definition_arn #=> String
|
847
892
|
# resp.revision #=> Integer
|
848
893
|
#
|
894
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/RegisterJobDefinition AWS API Documentation
|
895
|
+
#
|
849
896
|
# @overload register_job_definition(params = {})
|
850
897
|
# @param [Hash] params ({})
|
851
898
|
def register_job_definition(params = {}, options = {})
|
@@ -857,15 +904,17 @@ module Aws::Batch
|
|
857
904
|
# during SubmitJob override parameters defined in the job definition.
|
858
905
|
#
|
859
906
|
# @option params [required, String] :job_name
|
860
|
-
# The name of the job.
|
907
|
+
# The name of the job. A name must be 1 to 128 characters in length.
|
908
|
+
#
|
909
|
+
# Pattern: ^\[a-zA-Z0-9\_\]+$
|
861
910
|
#
|
862
911
|
# @option params [required, String] :job_queue
|
863
912
|
# The job queue into which the job will be submitted. You can specify
|
864
913
|
# either the name or the Amazon Resource Name (ARN) of the queue.
|
865
914
|
#
|
866
915
|
# @option params [Array<Types::JobDependency>] :depends_on
|
867
|
-
# A list of job
|
868
|
-
#
|
916
|
+
# A list of job IDs on which this job depends. A job can depend upon a
|
917
|
+
# maximum of 100 jobs.
|
869
918
|
#
|
870
919
|
# @option params [required, String] :job_definition
|
871
920
|
# The job definition used by this job. This value can be either a
|
@@ -889,6 +938,11 @@ module Aws::Batch
|
|
889
938
|
# on a container or add new environment variables to it with an
|
890
939
|
# `environment` override.
|
891
940
|
#
|
941
|
+
# @option params [Types::RetryStrategy] :retry_strategy
|
942
|
+
# The retry strategy to use for failed jobs from this SubmitJob
|
943
|
+
# operation. When a retry strategy is specified here, it overrides the
|
944
|
+
# retry strategy defined in the job definition.
|
945
|
+
#
|
892
946
|
# @return [Types::SubmitJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
893
947
|
#
|
894
948
|
# * {Types::SubmitJobResponse#job_name #job_name} => String
|
@@ -919,6 +973,9 @@ module Aws::Batch
|
|
919
973
|
# },
|
920
974
|
# ],
|
921
975
|
# },
|
976
|
+
# retry_strategy: {
|
977
|
+
# attempts: 1,
|
978
|
+
# },
|
922
979
|
# })
|
923
980
|
#
|
924
981
|
# @example Response structure
|
@@ -926,6 +983,8 @@ module Aws::Batch
|
|
926
983
|
# resp.job_name #=> String
|
927
984
|
# resp.job_id #=> String
|
928
985
|
#
|
986
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/SubmitJob AWS API Documentation
|
987
|
+
#
|
929
988
|
# @overload submit_job(params = {})
|
930
989
|
# @param [Hash] params ({})
|
931
990
|
def submit_job(params = {}, options = {})
|
@@ -955,6 +1014,8 @@ module Aws::Batch
|
|
955
1014
|
# reason: "String", # required
|
956
1015
|
# })
|
957
1016
|
#
|
1017
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/TerminateJob AWS API Documentation
|
1018
|
+
#
|
958
1019
|
# @overload terminate_job(params = {})
|
959
1020
|
# @param [Hash] params ({})
|
960
1021
|
def terminate_job(params = {}, options = {})
|
@@ -1005,6 +1066,8 @@ module Aws::Batch
|
|
1005
1066
|
# resp.compute_environment_name #=> String
|
1006
1067
|
# resp.compute_environment_arn #=> String
|
1007
1068
|
#
|
1069
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/UpdateComputeEnvironment AWS API Documentation
|
1070
|
+
#
|
1008
1071
|
# @overload update_compute_environment(params = {})
|
1009
1072
|
# @param [Hash] params ({})
|
1010
1073
|
def update_compute_environment(params = {}, options = {})
|
@@ -1058,6 +1121,8 @@ module Aws::Batch
|
|
1058
1121
|
# resp.job_queue_name #=> String
|
1059
1122
|
# resp.job_queue_arn #=> String
|
1060
1123
|
#
|
1124
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/UpdateJobQueue AWS API Documentation
|
1125
|
+
#
|
1061
1126
|
# @overload update_job_queue(params = {})
|
1062
1127
|
# @param [Hash] params ({})
|
1063
1128
|
def update_job_queue(params = {}, options = {})
|
@@ -1078,7 +1143,7 @@ module Aws::Batch
|
|
1078
1143
|
params: params,
|
1079
1144
|
config: config)
|
1080
1145
|
context[:gem_name] = 'aws-sdk-batch'
|
1081
|
-
context[:gem_version] = '1.0.0.
|
1146
|
+
context[:gem_version] = '1.0.0.rc2'
|
1082
1147
|
Seahorse::Client::Request.new(handlers, context)
|
1083
1148
|
end
|
1084
1149
|
|
@@ -11,6 +11,9 @@ module Aws::Batch
|
|
11
11
|
|
12
12
|
include Seahorse::Model
|
13
13
|
|
14
|
+
AttemptContainerDetail = Shapes::StructureShape.new(name: 'AttemptContainerDetail')
|
15
|
+
AttemptDetail = Shapes::StructureShape.new(name: 'AttemptDetail')
|
16
|
+
AttemptDetails = Shapes::ListShape.new(name: 'AttemptDetails')
|
14
17
|
Boolean = Shapes::BooleanShape.new(name: 'Boolean')
|
15
18
|
CEState = Shapes::StringShape.new(name: 'CEState')
|
16
19
|
CEStatus = Shapes::StringShape.new(name: 'CEStatus')
|
@@ -72,6 +75,7 @@ module Aws::Batch
|
|
72
75
|
ParametersMap = Shapes::MapShape.new(name: 'ParametersMap')
|
73
76
|
RegisterJobDefinitionRequest = Shapes::StructureShape.new(name: 'RegisterJobDefinitionRequest')
|
74
77
|
RegisterJobDefinitionResponse = Shapes::StructureShape.new(name: 'RegisterJobDefinitionResponse')
|
78
|
+
RetryStrategy = Shapes::StructureShape.new(name: 'RetryStrategy')
|
75
79
|
ServerException = Shapes::StructureShape.new(name: 'ServerException')
|
76
80
|
String = Shapes::StringShape.new(name: 'String')
|
77
81
|
StringList = Shapes::ListShape.new(name: 'StringList')
|
@@ -89,6 +93,20 @@ module Aws::Batch
|
|
89
93
|
Volume = Shapes::StructureShape.new(name: 'Volume')
|
90
94
|
Volumes = Shapes::ListShape.new(name: 'Volumes')
|
91
95
|
|
96
|
+
AttemptContainerDetail.add_member(:container_instance_arn, Shapes::ShapeRef.new(shape: String, location_name: "containerInstanceArn"))
|
97
|
+
AttemptContainerDetail.add_member(:task_arn, Shapes::ShapeRef.new(shape: String, location_name: "taskArn"))
|
98
|
+
AttemptContainerDetail.add_member(:exit_code, Shapes::ShapeRef.new(shape: Integer, location_name: "exitCode"))
|
99
|
+
AttemptContainerDetail.add_member(:reason, Shapes::ShapeRef.new(shape: String, location_name: "reason"))
|
100
|
+
AttemptContainerDetail.struct_class = Types::AttemptContainerDetail
|
101
|
+
|
102
|
+
AttemptDetail.add_member(:container, Shapes::ShapeRef.new(shape: AttemptContainerDetail, location_name: "container"))
|
103
|
+
AttemptDetail.add_member(:started_at, Shapes::ShapeRef.new(shape: Long, location_name: "startedAt"))
|
104
|
+
AttemptDetail.add_member(:stopped_at, Shapes::ShapeRef.new(shape: Long, location_name: "stoppedAt"))
|
105
|
+
AttemptDetail.add_member(:status_reason, Shapes::ShapeRef.new(shape: String, location_name: "statusReason"))
|
106
|
+
AttemptDetail.struct_class = Types::AttemptDetail
|
107
|
+
|
108
|
+
AttemptDetails.member = Shapes::ShapeRef.new(shape: AttemptDetail)
|
109
|
+
|
92
110
|
CancelJobRequest.add_member(:job_id, Shapes::ShapeRef.new(shape: String, required: true, location_name: "jobId"))
|
93
111
|
CancelJobRequest.add_member(:reason, Shapes::ShapeRef.new(shape: String, required: true, location_name: "reason"))
|
94
112
|
CancelJobRequest.struct_class = Types::CancelJobRequest
|
@@ -119,6 +137,7 @@ module Aws::Batch
|
|
119
137
|
ComputeResource.add_member(:maxv_cpus, Shapes::ShapeRef.new(shape: Integer, required: true, location_name: "maxvCpus"))
|
120
138
|
ComputeResource.add_member(:desiredv_cpus, Shapes::ShapeRef.new(shape: Integer, location_name: "desiredvCpus"))
|
121
139
|
ComputeResource.add_member(:instance_types, Shapes::ShapeRef.new(shape: StringList, required: true, location_name: "instanceTypes"))
|
140
|
+
ComputeResource.add_member(:image_id, Shapes::ShapeRef.new(shape: String, location_name: "imageId"))
|
122
141
|
ComputeResource.add_member(:subnets, Shapes::ShapeRef.new(shape: StringList, required: true, location_name: "subnets"))
|
123
142
|
ComputeResource.add_member(:security_group_ids, Shapes::ShapeRef.new(shape: StringList, required: true, location_name: "securityGroupIds"))
|
124
143
|
ComputeResource.add_member(:ec2_key_pair, Shapes::ShapeRef.new(shape: String, location_name: "ec2KeyPair"))
|
@@ -148,6 +167,7 @@ module Aws::Batch
|
|
148
167
|
ContainerDetail.add_member(:exit_code, Shapes::ShapeRef.new(shape: Integer, location_name: "exitCode"))
|
149
168
|
ContainerDetail.add_member(:reason, Shapes::ShapeRef.new(shape: String, location_name: "reason"))
|
150
169
|
ContainerDetail.add_member(:container_instance_arn, Shapes::ShapeRef.new(shape: String, location_name: "containerInstanceArn"))
|
170
|
+
ContainerDetail.add_member(:task_arn, Shapes::ShapeRef.new(shape: String, location_name: "taskArn"))
|
151
171
|
ContainerDetail.struct_class = Types::ContainerDetail
|
152
172
|
|
153
173
|
ContainerOverrides.add_member(:vcpus, Shapes::ShapeRef.new(shape: Integer, location_name: "vcpus"))
|
@@ -252,6 +272,7 @@ module Aws::Batch
|
|
252
272
|
JobDefinition.add_member(:status, Shapes::ShapeRef.new(shape: String, location_name: "status"))
|
253
273
|
JobDefinition.add_member(:type, Shapes::ShapeRef.new(shape: String, required: true, location_name: "type"))
|
254
274
|
JobDefinition.add_member(:parameters, Shapes::ShapeRef.new(shape: ParametersMap, location_name: "parameters"))
|
275
|
+
JobDefinition.add_member(:retry_strategy, Shapes::ShapeRef.new(shape: RetryStrategy, location_name: "retryStrategy"))
|
255
276
|
JobDefinition.add_member(:container_properties, Shapes::ShapeRef.new(shape: ContainerProperties, location_name: "containerProperties"))
|
256
277
|
JobDefinition.struct_class = Types::JobDefinition
|
257
278
|
|
@@ -266,8 +287,10 @@ module Aws::Batch
|
|
266
287
|
JobDetail.add_member(:job_id, Shapes::ShapeRef.new(shape: String, required: true, location_name: "jobId"))
|
267
288
|
JobDetail.add_member(:job_queue, Shapes::ShapeRef.new(shape: String, required: true, location_name: "jobQueue"))
|
268
289
|
JobDetail.add_member(:status, Shapes::ShapeRef.new(shape: JobStatus, required: true, location_name: "status"))
|
290
|
+
JobDetail.add_member(:attempts, Shapes::ShapeRef.new(shape: AttemptDetails, location_name: "attempts"))
|
269
291
|
JobDetail.add_member(:status_reason, Shapes::ShapeRef.new(shape: String, location_name: "statusReason"))
|
270
292
|
JobDetail.add_member(:created_at, Shapes::ShapeRef.new(shape: Long, location_name: "createdAt"))
|
293
|
+
JobDetail.add_member(:retry_strategy, Shapes::ShapeRef.new(shape: RetryStrategy, location_name: "retryStrategy"))
|
271
294
|
JobDetail.add_member(:started_at, Shapes::ShapeRef.new(shape: Long, required: true, location_name: "startedAt"))
|
272
295
|
JobDetail.add_member(:stopped_at, Shapes::ShapeRef.new(shape: Long, location_name: "stoppedAt"))
|
273
296
|
JobDetail.add_member(:depends_on, Shapes::ShapeRef.new(shape: JobDependencyList, location_name: "dependsOn"))
|
@@ -323,6 +346,7 @@ module Aws::Batch
|
|
323
346
|
RegisterJobDefinitionRequest.add_member(:type, Shapes::ShapeRef.new(shape: JobDefinitionType, required: true, location_name: "type"))
|
324
347
|
RegisterJobDefinitionRequest.add_member(:parameters, Shapes::ShapeRef.new(shape: ParametersMap, location_name: "parameters"))
|
325
348
|
RegisterJobDefinitionRequest.add_member(:container_properties, Shapes::ShapeRef.new(shape: ContainerProperties, location_name: "containerProperties"))
|
349
|
+
RegisterJobDefinitionRequest.add_member(:retry_strategy, Shapes::ShapeRef.new(shape: RetryStrategy, location_name: "retryStrategy"))
|
326
350
|
RegisterJobDefinitionRequest.struct_class = Types::RegisterJobDefinitionRequest
|
327
351
|
|
328
352
|
RegisterJobDefinitionResponse.add_member(:job_definition_name, Shapes::ShapeRef.new(shape: String, required: true, location_name: "jobDefinitionName"))
|
@@ -330,6 +354,9 @@ module Aws::Batch
|
|
330
354
|
RegisterJobDefinitionResponse.add_member(:revision, Shapes::ShapeRef.new(shape: Integer, required: true, location_name: "revision"))
|
331
355
|
RegisterJobDefinitionResponse.struct_class = Types::RegisterJobDefinitionResponse
|
332
356
|
|
357
|
+
RetryStrategy.add_member(:attempts, Shapes::ShapeRef.new(shape: Integer, location_name: "attempts"))
|
358
|
+
RetryStrategy.struct_class = Types::RetryStrategy
|
359
|
+
|
333
360
|
StringList.member = Shapes::ShapeRef.new(shape: String)
|
334
361
|
|
335
362
|
SubmitJobRequest.add_member(:job_name, Shapes::ShapeRef.new(shape: String, required: true, location_name: "jobName"))
|
@@ -338,6 +365,7 @@ module Aws::Batch
|
|
338
365
|
SubmitJobRequest.add_member(:job_definition, Shapes::ShapeRef.new(shape: String, required: true, location_name: "jobDefinition"))
|
339
366
|
SubmitJobRequest.add_member(:parameters, Shapes::ShapeRef.new(shape: ParametersMap, location_name: "parameters"))
|
340
367
|
SubmitJobRequest.add_member(:container_overrides, Shapes::ShapeRef.new(shape: ContainerOverrides, location_name: "containerOverrides"))
|
368
|
+
SubmitJobRequest.add_member(:retry_strategy, Shapes::ShapeRef.new(shape: RetryStrategy, location_name: "retryStrategy"))
|
341
369
|
SubmitJobRequest.struct_class = Types::SubmitJobRequest
|
342
370
|
|
343
371
|
SubmitJobResponse.add_member(:job_name, Shapes::ShapeRef.new(shape: String, required: true, location_name: "jobName"))
|
data/lib/aws-sdk-batch/types.rb
CHANGED
@@ -8,6 +8,70 @@
|
|
8
8
|
module Aws::Batch
|
9
9
|
module Types
|
10
10
|
|
11
|
+
# An object representing the details of a container that is part of a
|
12
|
+
# job attempt.
|
13
|
+
#
|
14
|
+
# @!attribute [rw] container_instance_arn
|
15
|
+
# The Amazon Resource Name (ARN) of the Amazon ECS container instance
|
16
|
+
# that hosts the job attempt.
|
17
|
+
# @return [String]
|
18
|
+
#
|
19
|
+
# @!attribute [rw] task_arn
|
20
|
+
# The Amazon Resource Name (ARN) of the Amazon ECS task that is
|
21
|
+
# associated with the job attempt.
|
22
|
+
# @return [String]
|
23
|
+
#
|
24
|
+
# @!attribute [rw] exit_code
|
25
|
+
# The exit code for the job attempt. A non-zero exit code is
|
26
|
+
# considered a failure.
|
27
|
+
# @return [Integer]
|
28
|
+
#
|
29
|
+
# @!attribute [rw] reason
|
30
|
+
# A short (255 max characters) human-readable string to provide
|
31
|
+
# additional details about a running or stopped container.
|
32
|
+
# @return [String]
|
33
|
+
#
|
34
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/AttemptContainerDetail AWS API Documentation
|
35
|
+
#
|
36
|
+
class AttemptContainerDetail < Struct.new(
|
37
|
+
:container_instance_arn,
|
38
|
+
:task_arn,
|
39
|
+
:exit_code,
|
40
|
+
:reason)
|
41
|
+
include Aws::Structure
|
42
|
+
end
|
43
|
+
|
44
|
+
# An object representing a job attempt.
|
45
|
+
#
|
46
|
+
# @!attribute [rw] container
|
47
|
+
# Details about the container in this job attempt.
|
48
|
+
# @return [Types::AttemptContainerDetail]
|
49
|
+
#
|
50
|
+
# @!attribute [rw] started_at
|
51
|
+
# The Unix timestamp for when the attempt was started (when the task
|
52
|
+
# transitioned from the `PENDING` state to the `RUNNING` state).
|
53
|
+
# @return [Integer]
|
54
|
+
#
|
55
|
+
# @!attribute [rw] stopped_at
|
56
|
+
# The Unix timestamp for when the attempt was stopped (when the task
|
57
|
+
# transitioned from the `RUNNING` state to the `STOPPED` state).
|
58
|
+
# @return [Integer]
|
59
|
+
#
|
60
|
+
# @!attribute [rw] status_reason
|
61
|
+
# A short, human-readable string to provide additional details about
|
62
|
+
# the current status of the job attempt.
|
63
|
+
# @return [String]
|
64
|
+
#
|
65
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/AttemptDetail AWS API Documentation
|
66
|
+
#
|
67
|
+
class AttemptDetail < Struct.new(
|
68
|
+
:container,
|
69
|
+
:started_at,
|
70
|
+
:stopped_at,
|
71
|
+
:status_reason)
|
72
|
+
include Aws::Structure
|
73
|
+
end
|
74
|
+
|
11
75
|
# @note When making an API call, you may pass CancelJobRequest
|
12
76
|
# data as a hash:
|
13
77
|
#
|
@@ -27,12 +91,16 @@ module Aws::Batch
|
|
27
91
|
# Batch activity logs.
|
28
92
|
# @return [String]
|
29
93
|
#
|
94
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/CancelJobRequest AWS API Documentation
|
95
|
+
#
|
30
96
|
class CancelJobRequest < Struct.new(
|
31
97
|
:job_id,
|
32
98
|
:reason)
|
33
99
|
include Aws::Structure
|
34
100
|
end
|
35
101
|
|
102
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/CancelJobResponse AWS API Documentation
|
103
|
+
#
|
36
104
|
class CancelJobResponse < Aws::EmptyStructure; end
|
37
105
|
|
38
106
|
# An object representing an AWS Batch compute environment.
|
@@ -80,6 +148,8 @@ module Aws::Batch
|
|
80
148
|
# AWS Batch to make calls to AWS API operations on your behalf.
|
81
149
|
# @return [String]
|
82
150
|
#
|
151
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/ComputeEnvironmentDetail AWS API Documentation
|
152
|
+
#
|
83
153
|
class ComputeEnvironmentDetail < Struct.new(
|
84
154
|
:compute_environment_name,
|
85
155
|
:compute_environment_arn,
|
@@ -115,6 +185,8 @@ module Aws::Batch
|
|
115
185
|
# The Amazon Resource Name (ARN) of the compute environment.
|
116
186
|
# @return [String]
|
117
187
|
#
|
188
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/ComputeEnvironmentOrder AWS API Documentation
|
189
|
+
#
|
118
190
|
class ComputeEnvironmentOrder < Struct.new(
|
119
191
|
:order,
|
120
192
|
:compute_environment)
|
@@ -132,6 +204,7 @@ module Aws::Batch
|
|
132
204
|
# maxv_cpus: 1, # required
|
133
205
|
# desiredv_cpus: 1,
|
134
206
|
# instance_types: ["String"], # required
|
207
|
+
# image_id: "String",
|
135
208
|
# subnets: ["String"], # required
|
136
209
|
# security_group_ids: ["String"], # required
|
137
210
|
# ec2_key_pair: "String",
|
@@ -163,6 +236,11 @@ module Aws::Batch
|
|
163
236
|
# The instances types that may launched.
|
164
237
|
# @return [Array<String>]
|
165
238
|
#
|
239
|
+
# @!attribute [rw] image_id
|
240
|
+
# The Amazon Machine Image (AMI) ID used for instances launched in the
|
241
|
+
# compute environment.
|
242
|
+
# @return [String]
|
243
|
+
#
|
166
244
|
# @!attribute [rw] subnets
|
167
245
|
# The VPC subnets into which the compute resources are launched.
|
168
246
|
# @return [Array<String>]
|
@@ -200,12 +278,15 @@ module Aws::Batch
|
|
200
278
|
# applied to a `SPOT` compute environment.
|
201
279
|
# @return [String]
|
202
280
|
#
|
281
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/ComputeResource AWS API Documentation
|
282
|
+
#
|
203
283
|
class ComputeResource < Struct.new(
|
204
284
|
:type,
|
205
285
|
:minv_cpus,
|
206
286
|
:maxv_cpus,
|
207
287
|
:desiredv_cpus,
|
208
288
|
:instance_types,
|
289
|
+
:image_id,
|
209
290
|
:subnets,
|
210
291
|
:security_group_ids,
|
211
292
|
:ec2_key_pair,
|
@@ -240,6 +321,8 @@ module Aws::Batch
|
|
240
321
|
# The desired number of EC2 vCPUS in the compute environment.
|
241
322
|
# @return [Integer]
|
242
323
|
#
|
324
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/ComputeResourceUpdate AWS API Documentation
|
325
|
+
#
|
243
326
|
class ComputeResourceUpdate < Struct.new(
|
244
327
|
:minv_cpus,
|
245
328
|
:maxv_cpus,
|
@@ -316,6 +399,13 @@ module Aws::Batch
|
|
316
399
|
# the container is running.
|
317
400
|
# @return [String]
|
318
401
|
#
|
402
|
+
# @!attribute [rw] task_arn
|
403
|
+
# The Amazon Resource Name (ARN) of the Amazon ECS task that is
|
404
|
+
# associated with the container job.
|
405
|
+
# @return [String]
|
406
|
+
#
|
407
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/ContainerDetail AWS API Documentation
|
408
|
+
#
|
319
409
|
class ContainerDetail < Struct.new(
|
320
410
|
:image,
|
321
411
|
:vcpus,
|
@@ -331,7 +421,8 @@ module Aws::Batch
|
|
331
421
|
:user,
|
332
422
|
:exit_code,
|
333
423
|
:reason,
|
334
|
-
:container_instance_arn
|
424
|
+
:container_instance_arn,
|
425
|
+
:task_arn)
|
335
426
|
include Aws::Structure
|
336
427
|
end
|
337
428
|
|
@@ -374,6 +465,8 @@ module Aws::Batch
|
|
374
465
|
# Docker image or the job definition.
|
375
466
|
# @return [Array<Types::KeyValuePair>]
|
376
467
|
#
|
468
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/ContainerOverrides AWS API Documentation
|
469
|
+
#
|
377
470
|
class ContainerOverrides < Struct.new(
|
378
471
|
:vcpus,
|
379
472
|
:memory,
|
@@ -585,6 +678,8 @@ module Aws::Batch
|
|
585
678
|
# [3]: https://docs.docker.com/engine/reference/run/
|
586
679
|
# @return [String]
|
587
680
|
#
|
681
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/ContainerProperties AWS API Documentation
|
682
|
+
#
|
588
683
|
class ContainerProperties < Struct.new(
|
589
684
|
:image,
|
590
685
|
:vcpus,
|
@@ -614,6 +709,7 @@ module Aws::Batch
|
|
614
709
|
# maxv_cpus: 1, # required
|
615
710
|
# desiredv_cpus: 1,
|
616
711
|
# instance_types: ["String"], # required
|
712
|
+
# image_id: "String",
|
617
713
|
# subnets: ["String"], # required
|
618
714
|
# security_group_ids: ["String"], # required
|
619
715
|
# ec2_key_pair: "String",
|
@@ -652,6 +748,8 @@ module Aws::Batch
|
|
652
748
|
# Batch to make calls to other AWS services on your behalf.
|
653
749
|
# @return [String]
|
654
750
|
#
|
751
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/CreateComputeEnvironmentRequest AWS API Documentation
|
752
|
+
#
|
655
753
|
class CreateComputeEnvironmentRequest < Struct.new(
|
656
754
|
:compute_environment_name,
|
657
755
|
:type,
|
@@ -669,6 +767,8 @@ module Aws::Batch
|
|
669
767
|
# The Amazon Resource Name (ARN) of the compute environment.
|
670
768
|
# @return [String]
|
671
769
|
#
|
770
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/CreateComputeEnvironmentResponse AWS API Documentation
|
771
|
+
#
|
672
772
|
class CreateComputeEnvironmentResponse < Struct.new(
|
673
773
|
:compute_environment_name,
|
674
774
|
:compute_environment_arn)
|
@@ -717,6 +817,8 @@ module Aws::Batch
|
|
717
817
|
# environments with a job queue.
|
718
818
|
# @return [Array<Types::ComputeEnvironmentOrder>]
|
719
819
|
#
|
820
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/CreateJobQueueRequest AWS API Documentation
|
821
|
+
#
|
720
822
|
class CreateJobQueueRequest < Struct.new(
|
721
823
|
:job_queue_name,
|
722
824
|
:state,
|
@@ -733,6 +835,8 @@ module Aws::Batch
|
|
733
835
|
# The Amazon Resource Name (ARN) of the job queue.
|
734
836
|
# @return [String]
|
735
837
|
#
|
838
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/CreateJobQueueResponse AWS API Documentation
|
839
|
+
#
|
736
840
|
class CreateJobQueueResponse < Struct.new(
|
737
841
|
:job_queue_name,
|
738
842
|
:job_queue_arn)
|
@@ -751,11 +855,15 @@ module Aws::Batch
|
|
751
855
|
# delete.
|
752
856
|
# @return [String]
|
753
857
|
#
|
858
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/DeleteComputeEnvironmentRequest AWS API Documentation
|
859
|
+
#
|
754
860
|
class DeleteComputeEnvironmentRequest < Struct.new(
|
755
861
|
:compute_environment)
|
756
862
|
include Aws::Structure
|
757
863
|
end
|
758
864
|
|
865
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/DeleteComputeEnvironmentResponse AWS API Documentation
|
866
|
+
#
|
759
867
|
class DeleteComputeEnvironmentResponse < Aws::EmptyStructure; end
|
760
868
|
|
761
869
|
# @note When making an API call, you may pass DeleteJobQueueRequest
|
@@ -770,11 +878,15 @@ module Aws::Batch
|
|
770
878
|
# delete.
|
771
879
|
# @return [String]
|
772
880
|
#
|
881
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/DeleteJobQueueRequest AWS API Documentation
|
882
|
+
#
|
773
883
|
class DeleteJobQueueRequest < Struct.new(
|
774
884
|
:job_queue)
|
775
885
|
include Aws::Structure
|
776
886
|
end
|
777
887
|
|
888
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/DeleteJobQueueResponse AWS API Documentation
|
889
|
+
#
|
778
890
|
class DeleteJobQueueResponse < Aws::EmptyStructure; end
|
779
891
|
|
780
892
|
# @note When making an API call, you may pass DeregisterJobDefinitionRequest
|
@@ -789,11 +901,15 @@ module Aws::Batch
|
|
789
901
|
# (ARN) of the job definition to deregister.
|
790
902
|
# @return [String]
|
791
903
|
#
|
904
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/DeregisterJobDefinitionRequest AWS API Documentation
|
905
|
+
#
|
792
906
|
class DeregisterJobDefinitionRequest < Struct.new(
|
793
907
|
:job_definition)
|
794
908
|
include Aws::Structure
|
795
909
|
end
|
796
910
|
|
911
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/DeregisterJobDefinitionResponse AWS API Documentation
|
912
|
+
#
|
797
913
|
class DeregisterJobDefinitionResponse < Aws::EmptyStructure; end
|
798
914
|
|
799
915
|
# @note When making an API call, you may pass DescribeComputeEnvironmentsRequest
|
@@ -838,6 +954,8 @@ module Aws::Batch
|
|
838
954
|
# </note>
|
839
955
|
# @return [String]
|
840
956
|
#
|
957
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/DescribeComputeEnvironmentsRequest AWS API Documentation
|
958
|
+
#
|
841
959
|
class DescribeComputeEnvironmentsRequest < Struct.new(
|
842
960
|
:compute_environments,
|
843
961
|
:max_results,
|
@@ -857,6 +975,8 @@ module Aws::Batch
|
|
857
975
|
# when there are no more results to return.
|
858
976
|
# @return [String]
|
859
977
|
#
|
978
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/DescribeComputeEnvironmentsResponse AWS API Documentation
|
979
|
+
#
|
860
980
|
class DescribeComputeEnvironmentsResponse < Struct.new(
|
861
981
|
:compute_environments,
|
862
982
|
:next_token)
|
@@ -914,6 +1034,8 @@ module Aws::Batch
|
|
914
1034
|
# </note>
|
915
1035
|
# @return [String]
|
916
1036
|
#
|
1037
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/DescribeJobDefinitionsRequest AWS API Documentation
|
1038
|
+
#
|
917
1039
|
class DescribeJobDefinitionsRequest < Struct.new(
|
918
1040
|
:job_definitions,
|
919
1041
|
:max_results,
|
@@ -935,6 +1057,8 @@ module Aws::Batch
|
|
935
1057
|
# when there are no more results to return.
|
936
1058
|
# @return [String]
|
937
1059
|
#
|
1060
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/DescribeJobDefinitionsResponse AWS API Documentation
|
1061
|
+
#
|
938
1062
|
class DescribeJobDefinitionsResponse < Struct.new(
|
939
1063
|
:job_definitions,
|
940
1064
|
:next_token)
|
@@ -981,6 +1105,8 @@ module Aws::Batch
|
|
981
1105
|
# </note>
|
982
1106
|
# @return [String]
|
983
1107
|
#
|
1108
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/DescribeJobQueuesRequest AWS API Documentation
|
1109
|
+
#
|
984
1110
|
class DescribeJobQueuesRequest < Struct.new(
|
985
1111
|
:job_queues,
|
986
1112
|
:max_results,
|
@@ -1000,6 +1126,8 @@ module Aws::Batch
|
|
1000
1126
|
# return.
|
1001
1127
|
# @return [String]
|
1002
1128
|
#
|
1129
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/DescribeJobQueuesResponse AWS API Documentation
|
1130
|
+
#
|
1003
1131
|
class DescribeJobQueuesResponse < Struct.new(
|
1004
1132
|
:job_queues,
|
1005
1133
|
:next_token)
|
@@ -1017,6 +1145,8 @@ module Aws::Batch
|
|
1017
1145
|
# A space-separated list of up to 100 job IDs.
|
1018
1146
|
# @return [Array<String>]
|
1019
1147
|
#
|
1148
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/DescribeJobsRequest AWS API Documentation
|
1149
|
+
#
|
1020
1150
|
class DescribeJobsRequest < Struct.new(
|
1021
1151
|
:jobs)
|
1022
1152
|
include Aws::Structure
|
@@ -1026,6 +1156,8 @@ module Aws::Batch
|
|
1026
1156
|
# The list of jobs.
|
1027
1157
|
# @return [Array<Types::JobDetail>]
|
1028
1158
|
#
|
1159
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/DescribeJobsResponse AWS API Documentation
|
1160
|
+
#
|
1029
1161
|
class DescribeJobsResponse < Struct.new(
|
1030
1162
|
:jobs)
|
1031
1163
|
include Aws::Structure
|
@@ -1055,6 +1187,8 @@ module Aws::Batch
|
|
1055
1187
|
# does exist, the contents of the source path folder are exported.
|
1056
1188
|
# @return [String]
|
1057
1189
|
#
|
1190
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/Host AWS API Documentation
|
1191
|
+
#
|
1058
1192
|
class Host < Struct.new(
|
1059
1193
|
:source_path)
|
1060
1194
|
include Aws::Structure
|
@@ -1089,10 +1223,17 @@ module Aws::Batch
|
|
1089
1223
|
# corresponding parameter defaults from the job definition.
|
1090
1224
|
# @return [Hash<String,String>]
|
1091
1225
|
#
|
1226
|
+
# @!attribute [rw] retry_strategy
|
1227
|
+
# The retry strategy to use for failed jobs that are submitted with
|
1228
|
+
# this job definition.
|
1229
|
+
# @return [Types::RetryStrategy]
|
1230
|
+
#
|
1092
1231
|
# @!attribute [rw] container_properties
|
1093
1232
|
# An object with various properties specific to container-based jobs.
|
1094
1233
|
# @return [Types::ContainerProperties]
|
1095
1234
|
#
|
1235
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/JobDefinition AWS API Documentation
|
1236
|
+
#
|
1096
1237
|
class JobDefinition < Struct.new(
|
1097
1238
|
:job_definition_name,
|
1098
1239
|
:job_definition_arn,
|
@@ -1100,6 +1241,7 @@ module Aws::Batch
|
|
1100
1241
|
:status,
|
1101
1242
|
:type,
|
1102
1243
|
:parameters,
|
1244
|
+
:retry_strategy,
|
1103
1245
|
:container_properties)
|
1104
1246
|
include Aws::Structure
|
1105
1247
|
end
|
@@ -1117,6 +1259,8 @@ module Aws::Batch
|
|
1117
1259
|
# The job ID of the AWS Batch job associated with this dependency.
|
1118
1260
|
# @return [String]
|
1119
1261
|
#
|
1262
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/JobDependency AWS API Documentation
|
1263
|
+
#
|
1120
1264
|
class JobDependency < Struct.new(
|
1121
1265
|
:job_id)
|
1122
1266
|
include Aws::Structure
|
@@ -1141,6 +1285,10 @@ module Aws::Batch
|
|
1141
1285
|
# The current status for the job.
|
1142
1286
|
# @return [String]
|
1143
1287
|
#
|
1288
|
+
# @!attribute [rw] attempts
|
1289
|
+
# A list of job attempts associated with this job.
|
1290
|
+
# @return [Array<Types::AttemptDetail>]
|
1291
|
+
#
|
1144
1292
|
# @!attribute [rw] status_reason
|
1145
1293
|
# A short, human-readable string to provide additional details about
|
1146
1294
|
# the current status of the job.
|
@@ -1151,6 +1299,10 @@ module Aws::Batch
|
|
1151
1299
|
# entered the `PENDING` state).
|
1152
1300
|
# @return [Integer]
|
1153
1301
|
#
|
1302
|
+
# @!attribute [rw] retry_strategy
|
1303
|
+
# The retry strategy to use for this job if an attempt fails.
|
1304
|
+
# @return [Types::RetryStrategy]
|
1305
|
+
#
|
1154
1306
|
# @!attribute [rw] started_at
|
1155
1307
|
# The Unix timestamp for when the job was started (when the task
|
1156
1308
|
# transitioned from the `PENDING` state to the `RUNNING` state).
|
@@ -1180,13 +1332,17 @@ module Aws::Batch
|
|
1180
1332
|
# associated with the job.
|
1181
1333
|
# @return [Types::ContainerDetail]
|
1182
1334
|
#
|
1335
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/JobDetail AWS API Documentation
|
1336
|
+
#
|
1183
1337
|
class JobDetail < Struct.new(
|
1184
1338
|
:job_name,
|
1185
1339
|
:job_id,
|
1186
1340
|
:job_queue,
|
1187
1341
|
:status,
|
1342
|
+
:attempts,
|
1188
1343
|
:status_reason,
|
1189
1344
|
:created_at,
|
1345
|
+
:retry_strategy,
|
1190
1346
|
:started_at,
|
1191
1347
|
:stopped_at,
|
1192
1348
|
:depends_on,
|
@@ -1229,6 +1385,8 @@ module Aws::Batch
|
|
1229
1385
|
# selected for job placement in ascending order.
|
1230
1386
|
# @return [Array<Types::ComputeEnvironmentOrder>]
|
1231
1387
|
#
|
1388
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/JobQueueDetail AWS API Documentation
|
1389
|
+
#
|
1232
1390
|
class JobQueueDetail < Struct.new(
|
1233
1391
|
:job_queue_name,
|
1234
1392
|
:job_queue_arn,
|
@@ -1250,6 +1408,8 @@ module Aws::Batch
|
|
1250
1408
|
# The name of the job.
|
1251
1409
|
# @return [String]
|
1252
1410
|
#
|
1411
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/JobSummary AWS API Documentation
|
1412
|
+
#
|
1253
1413
|
class JobSummary < Struct.new(
|
1254
1414
|
:job_id,
|
1255
1415
|
:job_name)
|
@@ -1276,6 +1436,8 @@ module Aws::Batch
|
|
1276
1436
|
# the value of the environment variable.
|
1277
1437
|
# @return [String]
|
1278
1438
|
#
|
1439
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/KeyValuePair AWS API Documentation
|
1440
|
+
#
|
1279
1441
|
class KeyValuePair < Struct.new(
|
1280
1442
|
:name,
|
1281
1443
|
:value)
|
@@ -1326,6 +1488,8 @@ module Aws::Batch
|
|
1326
1488
|
# </note>
|
1327
1489
|
# @return [String]
|
1328
1490
|
#
|
1491
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/ListJobsRequest AWS API Documentation
|
1492
|
+
#
|
1329
1493
|
class ListJobsRequest < Struct.new(
|
1330
1494
|
:job_queue,
|
1331
1495
|
:job_status,
|
@@ -1345,14 +1509,16 @@ module Aws::Batch
|
|
1345
1509
|
# is `null` when there are no more results to return.
|
1346
1510
|
# @return [String]
|
1347
1511
|
#
|
1512
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/ListJobsResponse AWS API Documentation
|
1513
|
+
#
|
1348
1514
|
class ListJobsResponse < Struct.new(
|
1349
1515
|
:job_summary_list,
|
1350
1516
|
:next_token)
|
1351
1517
|
include Aws::Structure
|
1352
1518
|
end
|
1353
1519
|
|
1354
|
-
# Details on a volume mount point that is used in a job's
|
1355
|
-
# properties.
|
1520
|
+
# Details on a Docker volume mount point that is used in a job's
|
1521
|
+
# container properties.
|
1356
1522
|
#
|
1357
1523
|
# @note When making an API call, you may pass MountPoint
|
1358
1524
|
# data as a hash:
|
@@ -1377,6 +1543,8 @@ module Aws::Batch
|
|
1377
1543
|
# The name of the volume to mount.
|
1378
1544
|
# @return [String]
|
1379
1545
|
#
|
1546
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/MountPoint AWS API Documentation
|
1547
|
+
#
|
1380
1548
|
class MountPoint < Struct.new(
|
1381
1549
|
:container_path,
|
1382
1550
|
:read_only,
|
@@ -1431,6 +1599,9 @@ module Aws::Batch
|
|
1431
1599
|
# ],
|
1432
1600
|
# user: "String",
|
1433
1601
|
# },
|
1602
|
+
# retry_strategy: {
|
1603
|
+
# attempts: 1,
|
1604
|
+
# },
|
1434
1605
|
# }
|
1435
1606
|
#
|
1436
1607
|
# @!attribute [rw] job_definition_name
|
@@ -1453,11 +1624,20 @@ module Aws::Batch
|
|
1453
1624
|
# This parameter is required if the `type` parameter is `container`.
|
1454
1625
|
# @return [Types::ContainerProperties]
|
1455
1626
|
#
|
1627
|
+
# @!attribute [rw] retry_strategy
|
1628
|
+
# The retry strategy to use for failed jobs that are submitted with
|
1629
|
+
# this job definition. Any retry strategy that is specified during a
|
1630
|
+
# SubmitJob operation overrides the retry strategy defined here.
|
1631
|
+
# @return [Types::RetryStrategy]
|
1632
|
+
#
|
1633
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/RegisterJobDefinitionRequest AWS API Documentation
|
1634
|
+
#
|
1456
1635
|
class RegisterJobDefinitionRequest < Struct.new(
|
1457
1636
|
:job_definition_name,
|
1458
1637
|
:type,
|
1459
1638
|
:parameters,
|
1460
|
-
:container_properties
|
1639
|
+
:container_properties,
|
1640
|
+
:retry_strategy)
|
1461
1641
|
include Aws::Structure
|
1462
1642
|
end
|
1463
1643
|
|
@@ -1473,6 +1653,8 @@ module Aws::Batch
|
|
1473
1653
|
# The revision of the job definition.
|
1474
1654
|
# @return [Integer]
|
1475
1655
|
#
|
1656
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/RegisterJobDefinitionResponse AWS API Documentation
|
1657
|
+
#
|
1476
1658
|
class RegisterJobDefinitionResponse < Struct.new(
|
1477
1659
|
:job_definition_name,
|
1478
1660
|
:job_definition_arn,
|
@@ -1480,6 +1662,29 @@ module Aws::Batch
|
|
1480
1662
|
include Aws::Structure
|
1481
1663
|
end
|
1482
1664
|
|
1665
|
+
# The retry strategy associated with a job.
|
1666
|
+
#
|
1667
|
+
# @note When making an API call, you may pass RetryStrategy
|
1668
|
+
# data as a hash:
|
1669
|
+
#
|
1670
|
+
# {
|
1671
|
+
# attempts: 1,
|
1672
|
+
# }
|
1673
|
+
#
|
1674
|
+
# @!attribute [rw] attempts
|
1675
|
+
# The number of times to move a job to the `RUNNABLE` status. You may
|
1676
|
+
# specify between 1 and 10 attempts. If `attempts` is greater than
|
1677
|
+
# one, the job is retried if it fails until it has moved to `RUNNABLE`
|
1678
|
+
# that many times.
|
1679
|
+
# @return [Integer]
|
1680
|
+
#
|
1681
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/RetryStrategy AWS API Documentation
|
1682
|
+
#
|
1683
|
+
class RetryStrategy < Struct.new(
|
1684
|
+
:attempts)
|
1685
|
+
include Aws::Structure
|
1686
|
+
end
|
1687
|
+
|
1483
1688
|
# @note When making an API call, you may pass SubmitJobRequest
|
1484
1689
|
# data as a hash:
|
1485
1690
|
#
|
@@ -1506,10 +1711,15 @@ module Aws::Batch
|
|
1506
1711
|
# },
|
1507
1712
|
# ],
|
1508
1713
|
# },
|
1714
|
+
# retry_strategy: {
|
1715
|
+
# attempts: 1,
|
1716
|
+
# },
|
1509
1717
|
# }
|
1510
1718
|
#
|
1511
1719
|
# @!attribute [rw] job_name
|
1512
|
-
# The name of the job.
|
1720
|
+
# The name of the job. A name must be 1 to 128 characters in length.
|
1721
|
+
#
|
1722
|
+
# Pattern: ^\[a-zA-Z0-9\_\]+$
|
1513
1723
|
# @return [String]
|
1514
1724
|
#
|
1515
1725
|
# @!attribute [rw] job_queue
|
@@ -1518,8 +1728,8 @@ module Aws::Batch
|
|
1518
1728
|
# @return [String]
|
1519
1729
|
#
|
1520
1730
|
# @!attribute [rw] depends_on
|
1521
|
-
# A list of job
|
1522
|
-
#
|
1731
|
+
# A list of job IDs on which this job depends. A job can depend upon a
|
1732
|
+
# maximum of 100 jobs.
|
1523
1733
|
# @return [Array<Types::JobDependency>]
|
1524
1734
|
#
|
1525
1735
|
# @!attribute [rw] job_definition
|
@@ -1547,13 +1757,22 @@ module Aws::Batch
|
|
1547
1757
|
# `environment` override.
|
1548
1758
|
# @return [Types::ContainerOverrides]
|
1549
1759
|
#
|
1760
|
+
# @!attribute [rw] retry_strategy
|
1761
|
+
# The retry strategy to use for failed jobs from this SubmitJob
|
1762
|
+
# operation. When a retry strategy is specified here, it overrides the
|
1763
|
+
# retry strategy defined in the job definition.
|
1764
|
+
# @return [Types::RetryStrategy]
|
1765
|
+
#
|
1766
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/SubmitJobRequest AWS API Documentation
|
1767
|
+
#
|
1550
1768
|
class SubmitJobRequest < Struct.new(
|
1551
1769
|
:job_name,
|
1552
1770
|
:job_queue,
|
1553
1771
|
:depends_on,
|
1554
1772
|
:job_definition,
|
1555
1773
|
:parameters,
|
1556
|
-
:container_overrides
|
1774
|
+
:container_overrides,
|
1775
|
+
:retry_strategy)
|
1557
1776
|
include Aws::Structure
|
1558
1777
|
end
|
1559
1778
|
|
@@ -1565,6 +1784,8 @@ module Aws::Batch
|
|
1565
1784
|
# The unique identifier for the job.
|
1566
1785
|
# @return [String]
|
1567
1786
|
#
|
1787
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/SubmitJobResponse AWS API Documentation
|
1788
|
+
#
|
1568
1789
|
class SubmitJobResponse < Struct.new(
|
1569
1790
|
:job_name,
|
1570
1791
|
:job_id)
|
@@ -1590,12 +1811,16 @@ module Aws::Batch
|
|
1590
1811
|
# Batch activity logs.
|
1591
1812
|
# @return [String]
|
1592
1813
|
#
|
1814
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/TerminateJobRequest AWS API Documentation
|
1815
|
+
#
|
1593
1816
|
class TerminateJobRequest < Struct.new(
|
1594
1817
|
:job_id,
|
1595
1818
|
:reason)
|
1596
1819
|
include Aws::Structure
|
1597
1820
|
end
|
1598
1821
|
|
1822
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/TerminateJobResponse AWS API Documentation
|
1823
|
+
#
|
1599
1824
|
class TerminateJobResponse < Aws::EmptyStructure; end
|
1600
1825
|
|
1601
1826
|
# The `ulimit` settings to pass to the container.
|
@@ -1621,6 +1846,8 @@ module Aws::Batch
|
|
1621
1846
|
# The soft limit for the `ulimit` type.
|
1622
1847
|
# @return [Integer]
|
1623
1848
|
#
|
1849
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/Ulimit AWS API Documentation
|
1850
|
+
#
|
1624
1851
|
class Ulimit < Struct.new(
|
1625
1852
|
:hard_limit,
|
1626
1853
|
:name,
|
@@ -1664,6 +1891,8 @@ module Aws::Batch
|
|
1664
1891
|
# behalf.
|
1665
1892
|
# @return [String]
|
1666
1893
|
#
|
1894
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/UpdateComputeEnvironmentRequest AWS API Documentation
|
1895
|
+
#
|
1667
1896
|
class UpdateComputeEnvironmentRequest < Struct.new(
|
1668
1897
|
:compute_environment,
|
1669
1898
|
:state,
|
@@ -1680,6 +1909,8 @@ module Aws::Batch
|
|
1680
1909
|
# The Amazon Resource Name (ARN) of the compute environment.
|
1681
1910
|
# @return [String]
|
1682
1911
|
#
|
1912
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/UpdateComputeEnvironmentResponse AWS API Documentation
|
1913
|
+
#
|
1683
1914
|
class UpdateComputeEnvironmentResponse < Struct.new(
|
1684
1915
|
:compute_environment_name,
|
1685
1916
|
:compute_environment_arn)
|
@@ -1725,6 +1956,8 @@ module Aws::Batch
|
|
1725
1956
|
# should execute a given job.
|
1726
1957
|
# @return [Array<Types::ComputeEnvironmentOrder>]
|
1727
1958
|
#
|
1959
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/UpdateJobQueueRequest AWS API Documentation
|
1960
|
+
#
|
1728
1961
|
class UpdateJobQueueRequest < Struct.new(
|
1729
1962
|
:job_queue,
|
1730
1963
|
:state,
|
@@ -1741,6 +1974,8 @@ module Aws::Batch
|
|
1741
1974
|
# The Amazon Resource Name (ARN) of the job queue.
|
1742
1975
|
# @return [String]
|
1743
1976
|
#
|
1977
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/UpdateJobQueueResponse AWS API Documentation
|
1978
|
+
#
|
1744
1979
|
class UpdateJobQueueResponse < Struct.new(
|
1745
1980
|
:job_queue_name,
|
1746
1981
|
:job_queue_arn)
|
@@ -1775,6 +2010,8 @@ module Aws::Batch
|
|
1775
2010
|
# `mountPoints`.
|
1776
2011
|
# @return [String]
|
1777
2012
|
#
|
2013
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/Volume AWS API Documentation
|
2014
|
+
#
|
1778
2015
|
class Volume < Struct.new(
|
1779
2016
|
:host,
|
1780
2017
|
:name)
|
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: aws-sdk-batch
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 1.0.0.
|
4
|
+
version: 1.0.0.rc2
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Amazon Web Services
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date: 2017-
|
11
|
+
date: 2017-04-26 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: aws-sdk-core
|