aws-sdk-batch 1.41.0 → 1.42.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/lib/aws-sdk-batch.rb +1 -1
- data/lib/aws-sdk-batch/client.rb +195 -99
- data/lib/aws-sdk-batch/client_api.rb +33 -7
- data/lib/aws-sdk-batch/types.rb +980 -235
- metadata +2 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: b240304ecae1aeae3ea13bb1f66495b9f1cb47ee43c4d103bf3622b00f7c8cc2
|
4
|
+
data.tar.gz: 2451f30ab3efaf8c2526b900d19abb100e5d7ea1fd40ba2986457724f1cdc812
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: f187b949aa833f58675fd84795e60a89b77806675d1232646043c3bbd5888a77c4301297afd7b7b08f59604fd9878e5daca4f538b49887c1484c82de660711ca
|
7
|
+
data.tar.gz: 76af358d5e06da9d61ccd55032aa418ae19a143928a1217776a67b5b2e0a34eedb8535afb935489b71b2be40d31015b0fc0a433a0240ab3cc4c7797fcbbd449e
|
data/lib/aws-sdk-batch.rb
CHANGED
data/lib/aws-sdk-batch/client.rb
CHANGED
@@ -328,9 +328,9 @@ module Aws::Batch
|
|
328
328
|
# @!group API Operations
|
329
329
|
|
330
330
|
# Cancels a job in an AWS Batch job queue. Jobs that are in the
|
331
|
-
# `SUBMITTED`, `PENDING`, or `RUNNABLE` state are
|
332
|
-
# have progressed to `STARTING` or `RUNNING` are not
|
333
|
-
# API operation still succeeds, even if no job is
|
331
|
+
# `SUBMITTED`, `PENDING`, or `RUNNABLE` state are canceled. Jobs that
|
332
|
+
# have progressed to `STARTING` or `RUNNING` are not canceled (but the
|
333
|
+
# API operation still succeeds, even if no job is canceled); these jobs
|
334
334
|
# must be terminated with the TerminateJob operation.
|
335
335
|
#
|
336
336
|
# @option params [required, String] :job_id
|
@@ -374,49 +374,53 @@ module Aws::Batch
|
|
374
374
|
end
|
375
375
|
|
376
376
|
# Creates an AWS Batch compute environment. You can create `MANAGED` or
|
377
|
-
# `UNMANAGED` compute environments.
|
377
|
+
# `UNMANAGED` compute environments. `MANAGED` compute environments can
|
378
|
+
# use Amazon EC2 or AWS Fargate resources. `UNMANAGED` compute
|
379
|
+
# environments can only use EC2 resources.
|
378
380
|
#
|
379
381
|
# In a managed compute environment, AWS Batch manages the capacity and
|
380
382
|
# instance types of the compute resources within the environment. This
|
381
383
|
# is based on the compute resource specification that you define or the
|
382
384
|
# [launch template][1] that you specify when you create the compute
|
383
|
-
# environment. You can choose to use
|
384
|
-
# Spot Instances
|
385
|
-
#
|
386
|
-
#
|
385
|
+
# environment. You can choose either to use EC2 On-Demand Instances and
|
386
|
+
# EC2 Spot Instances, or to use Fargate and Fargate Spot capacity in
|
387
|
+
# your managed compute environment. You can optionally set a maximum
|
388
|
+
# price so that Spot Instances only launch when the Spot Instance price
|
389
|
+
# is below a specified percentage of the On-Demand price.
|
387
390
|
#
|
388
391
|
# <note markdown="1"> Multi-node parallel jobs are not supported on Spot Instances.
|
389
392
|
#
|
390
393
|
# </note>
|
391
394
|
#
|
392
|
-
# In an unmanaged compute environment, you can manage your own
|
393
|
-
# resources
|
394
|
-
#
|
395
|
-
#
|
396
|
-
#
|
397
|
-
#
|
398
|
-
# unmanaged compute environment, you
|
399
|
-
# DescribeComputeEnvironments operation to find the Amazon
|
400
|
-
# that is associated with it. Then, manually launch your
|
401
|
-
# instances into that Amazon ECS cluster. For more
|
402
|
-
# [Launching an Amazon ECS
|
403
|
-
# Container Service Developer Guide*.
|
404
|
-
#
|
405
|
-
# <note markdown="1"> AWS Batch
|
406
|
-
#
|
407
|
-
# ECS-optimized AMI is available
|
408
|
-
# management of the guest operating system
|
409
|
-
# security patches) and any additional
|
410
|
-
# that you install on the compute
|
411
|
-
# AWS Batch jobs
|
395
|
+
# In an unmanaged compute environment, you can manage your own EC2
|
396
|
+
# compute resources and have a lot of flexibility with how you configure
|
397
|
+
# your compute resources. For example, you can use custom AMI. However,
|
398
|
+
# you need to verify that your AMI meets the Amazon ECS container
|
399
|
+
# instance AMI specification. For more information, see [container
|
400
|
+
# instance AMIs][2] in the *Amazon Elastic Container Service Developer
|
401
|
+
# Guide*. After you have created your unmanaged compute environment, you
|
402
|
+
# can use the DescribeComputeEnvironments operation to find the Amazon
|
403
|
+
# ECS cluster that is associated with it. Then, manually launch your
|
404
|
+
# container instances into that Amazon ECS cluster. For more
|
405
|
+
# information, see [Launching an Amazon ECS container instance][3] in
|
406
|
+
# the *Amazon Elastic Container Service Developer Guide*.
|
407
|
+
#
|
408
|
+
# <note markdown="1"> AWS Batch doesn't upgrade the AMIs in a compute environment after
|
409
|
+
# it's created. For example, it doesn't update the AMIs when a newer
|
410
|
+
# version of the Amazon ECS-optimized AMI is available. Therefore,
|
411
|
+
# you're responsible for the management of the guest operating system
|
412
|
+
# (including updates and security patches) and any additional
|
413
|
+
# application software or utilities that you install on the compute
|
414
|
+
# resources. To use a new AMI for your AWS Batch jobs, complete these
|
415
|
+
# steps:
|
412
416
|
#
|
413
417
|
# 1. Create a new compute environment with the new AMI.
|
414
418
|
#
|
415
419
|
# 2. Add the compute environment to an existing job queue.
|
416
420
|
#
|
417
|
-
# 3. Remove the
|
421
|
+
# 3. Remove the earlier compute environment from your job queue.
|
418
422
|
#
|
419
|
-
# 4. Delete the
|
423
|
+
# 4. Delete the earlier compute environment.
|
420
424
|
#
|
421
425
|
# </note>
|
422
426
|
#
|
@@ -431,8 +435,9 @@ module Aws::Batch
|
|
431
435
|
# and lowercase), numbers, hyphens, and underscores are allowed.
|
432
436
|
#
|
433
437
|
# @option params [required, String] :type
|
434
|
-
# The type of the compute environment
|
435
|
-
# [Compute Environments][1] in the *AWS Batch User
|
438
|
+
# The type of the compute environment: `MANAGED` or `UNMANAGED`. For
|
439
|
+
# more information, see [Compute Environments][1] in the *AWS Batch User
|
440
|
+
# Guide*.
|
436
441
|
#
|
437
442
|
#
|
438
443
|
#
|
@@ -444,10 +449,10 @@ module Aws::Batch
|
|
444
449
|
# automatically based on queues.
|
445
450
|
#
|
446
451
|
# @option params [Types::ComputeResource] :compute_resources
|
447
|
-
# Details
|
448
|
-
# This parameter is required for managed compute
|
449
|
-
# information, see [Compute Environments][1] in
|
450
|
-
# Guide*.
|
452
|
+
# Details about the compute resources managed by the compute
|
453
|
+
# environment. This parameter is required for managed compute
|
454
|
+
# environments. For more information, see [Compute Environments][1] in
|
455
|
+
# the *AWS Batch User Guide*.
|
451
456
|
#
|
452
457
|
#
|
453
458
|
#
|
@@ -463,7 +468,7 @@ module Aws::Batch
|
|
463
468
|
#
|
464
469
|
# <note markdown="1"> Depending on how you created your AWS Batch service role, its ARN may
|
465
470
|
# contain the `service-role` path prefix. When you only specify the name
|
466
|
-
# of the service role, AWS Batch assumes that your ARN
|
471
|
+
# of the service role, AWS Batch assumes that your ARN doesn't use the
|
467
472
|
# `service-role` path prefix. Because of this, we recommend that you
|
468
473
|
# specify the full ARN of your service role when you create compute
|
469
474
|
# environments.
|
@@ -477,7 +482,7 @@ module Aws::Batch
|
|
477
482
|
# Resources][1] in *AWS General Reference*.
|
478
483
|
#
|
479
484
|
# These tags can be updated or removed using the [TagResource][2] and
|
480
|
-
# [UntagResource][3] API operations. These tags
|
485
|
+
# [UntagResource][3] API operations. These tags don't propagate to the
|
481
486
|
# underlying compute resources.
|
482
487
|
#
|
483
488
|
#
|
@@ -585,17 +590,17 @@ module Aws::Batch
|
|
585
590
|
# type: "MANAGED", # required, accepts MANAGED, UNMANAGED
|
586
591
|
# state: "ENABLED", # accepts ENABLED, DISABLED
|
587
592
|
# compute_resources: {
|
588
|
-
# type: "EC2", # required, accepts EC2, SPOT
|
593
|
+
# type: "EC2", # required, accepts EC2, SPOT, FARGATE, FARGATE_SPOT
|
589
594
|
# allocation_strategy: "BEST_FIT", # accepts BEST_FIT, BEST_FIT_PROGRESSIVE, SPOT_CAPACITY_OPTIMIZED
|
590
|
-
# minv_cpus: 1,
|
595
|
+
# minv_cpus: 1,
|
591
596
|
# maxv_cpus: 1, # required
|
592
597
|
# desiredv_cpus: 1,
|
593
|
-
# instance_types: ["String"],
|
598
|
+
# instance_types: ["String"],
|
594
599
|
# image_id: "String",
|
595
600
|
# subnets: ["String"], # required
|
596
601
|
# security_group_ids: ["String"],
|
597
602
|
# ec2_key_pair: "String",
|
598
|
-
# instance_role: "String",
|
603
|
+
# instance_role: "String",
|
599
604
|
# tags: {
|
600
605
|
# "String" => "String",
|
601
606
|
# },
|
@@ -650,24 +655,26 @@ module Aws::Batch
|
|
650
655
|
# @option params [String] :state
|
651
656
|
# The state of the job queue. If the job queue state is `ENABLED`, it is
|
652
657
|
# able to accept jobs. If the job queue state is `DISABLED`, new jobs
|
653
|
-
#
|
658
|
+
# can't be added to the queue, but jobs already in the queue can
|
654
659
|
# finish.
|
655
660
|
#
|
656
661
|
# @option params [required, Integer] :priority
|
657
662
|
# The priority of the job queue. Job queues with a higher priority (or a
|
658
663
|
# higher integer value for the `priority` parameter) are evaluated first
|
659
664
|
# when associated with the same compute environment. Priority is
|
660
|
-
# determined in descending order
|
665
|
+
# determined in descending order. For example, a job queue with a
|
661
666
|
# priority value of `10` is given scheduling preference over a job queue
|
662
667
|
# with a priority value of `1`.
|
663
668
|
#
|
664
669
|
# @option params [required, Array<Types::ComputeEnvironmentOrder>] :compute_environment_order
|
665
670
|
# The set of compute environments mapped to a job queue and their order
|
666
671
|
# relative to each other. The job scheduler uses this parameter to
|
667
|
-
# determine which compute environment should
|
668
|
-
#
|
669
|
-
#
|
670
|
-
# environments with a job queue.
|
672
|
+
# determine which compute environment should run a specific job. Compute
|
673
|
+
# environments must be in the `VALID` state before you can associate
|
674
|
+
# them with a job queue. You can associate up to three compute
|
675
|
+
# environments with a job queue. All of the compute environments must be
|
676
|
+
# either EC2 (`EC2` or `SPOT`) or Fargate (`FARGATE` or `FARGATE_SPOT`);
|
677
|
+
# EC2 and Fargate compute environments can't be mixed.
|
671
678
|
#
|
672
679
|
# @option params [Hash<String,String>] :tags
|
673
680
|
# The tags that you apply to the job queue to help you categorize and
|
@@ -770,7 +777,10 @@ module Aws::Batch
|
|
770
777
|
# Before you can delete a compute environment, you must set its state to
|
771
778
|
# `DISABLED` with the UpdateComputeEnvironment API operation and
|
772
779
|
# disassociate it from any job queues with the UpdateJobQueue API
|
773
|
-
# operation.
|
780
|
+
# operation. Compute environments that use AWS Fargate resources must
|
781
|
+
# terminate all active jobs on that compute environment before deleting
|
782
|
+
# the compute environment. If this isn't done, the compute environment
|
783
|
+
# will end up in an invalid state.
|
774
784
|
#
|
775
785
|
# @option params [required, String] :compute_environment
|
776
786
|
# The name or Amazon Resource Name (ARN) of the compute environment to
|
@@ -810,7 +820,7 @@ module Aws::Batch
|
|
810
820
|
# for a queue with the UpdateJobQueue operation. All jobs in the queue
|
811
821
|
# are terminated when you delete a job queue.
|
812
822
|
#
|
813
|
-
# It
|
823
|
+
# It's not necessary to disassociate compute environments from a queue
|
814
824
|
# before submitting a `DeleteJobQueue` request.
|
815
825
|
#
|
816
826
|
# @option params [required, String] :job_queue
|
@@ -847,7 +857,7 @@ module Aws::Batch
|
|
847
857
|
req.send_request(options)
|
848
858
|
end
|
849
859
|
|
850
|
-
# Deregisters an AWS Batch job definition. Job definitions
|
860
|
+
# Deregisters an AWS Batch job definition. Job definitions are
|
851
861
|
# permanently deleted after 180 days.
|
852
862
|
#
|
853
863
|
# @option params [required, String] :job_definition
|
@@ -886,7 +896,7 @@ module Aws::Batch
|
|
886
896
|
|
887
897
|
# Describes one or more of your compute environments.
|
888
898
|
#
|
889
|
-
# If you
|
899
|
+
# If you're using an unmanaged compute environment, you can use the
|
890
900
|
# `DescribeComputeEnvironment` operation to determine the
|
891
901
|
# `ecsClusterArn` that you should launch your Amazon ECS container
|
892
902
|
# instances into.
|
@@ -903,7 +913,7 @@ module Aws::Batch
|
|
903
913
|
# The remaining results of the initial request can be seen by sending
|
904
914
|
# another `DescribeComputeEnvironments` request with the returned
|
905
915
|
# `nextToken` value. This value can be between 1 and 100. If this
|
906
|
-
# parameter
|
916
|
+
# parameter isn't used, then `DescribeComputeEnvironments` returns up
|
907
917
|
# to 100 results and a `nextToken` value if applicable.
|
908
918
|
#
|
909
919
|
# @option params [String] :next_token
|
@@ -995,7 +1005,7 @@ module Aws::Batch
|
|
995
1005
|
# resp.compute_environments[0].state #=> String, one of "ENABLED", "DISABLED"
|
996
1006
|
# resp.compute_environments[0].status #=> String, one of "CREATING", "UPDATING", "DELETING", "DELETED", "VALID", "INVALID"
|
997
1007
|
# resp.compute_environments[0].status_reason #=> String
|
998
|
-
# resp.compute_environments[0].compute_resources.type #=> String, one of "EC2", "SPOT"
|
1008
|
+
# resp.compute_environments[0].compute_resources.type #=> String, one of "EC2", "SPOT", "FARGATE", "FARGATE_SPOT"
|
999
1009
|
# resp.compute_environments[0].compute_resources.allocation_strategy #=> String, one of "BEST_FIT", "BEST_FIT_PROGRESSIVE", "SPOT_CAPACITY_OPTIMIZED"
|
1000
1010
|
# resp.compute_environments[0].compute_resources.minv_cpus #=> Integer
|
1001
1011
|
# resp.compute_environments[0].compute_resources.maxv_cpus #=> Integer
|
@@ -1046,7 +1056,7 @@ module Aws::Batch
|
|
1046
1056
|
# page along with a `nextToken` response element. The remaining results
|
1047
1057
|
# of the initial request can be seen by sending another
|
1048
1058
|
# `DescribeJobDefinitions` request with the returned `nextToken` value.
|
1049
|
-
# This value can be between 1 and 100. If this parameter
|
1059
|
+
# This value can be between 1 and 100. If this parameter isn't used,
|
1050
1060
|
# then `DescribeJobDefinitions` returns up to 100 results and a
|
1051
1061
|
# `nextToken` value if applicable.
|
1052
1062
|
#
|
@@ -1054,7 +1064,7 @@ module Aws::Batch
|
|
1054
1064
|
# The name of the job definition to describe.
|
1055
1065
|
#
|
1056
1066
|
# @option params [String] :status
|
1057
|
-
# The status
|
1067
|
+
# The status used to filter job definitions.
|
1058
1068
|
#
|
1059
1069
|
# @option params [String] :next_token
|
1060
1070
|
# The `nextToken` value returned from a previous paginated
|
@@ -1168,7 +1178,7 @@ module Aws::Batch
|
|
1168
1178
|
# resp.job_definitions[0].container_properties.instance_type #=> String
|
1169
1179
|
# resp.job_definitions[0].container_properties.resource_requirements #=> Array
|
1170
1180
|
# resp.job_definitions[0].container_properties.resource_requirements[0].value #=> String
|
1171
|
-
# resp.job_definitions[0].container_properties.resource_requirements[0].type #=> String, one of "GPU"
|
1181
|
+
# resp.job_definitions[0].container_properties.resource_requirements[0].type #=> String, one of "GPU", "VCPU", "MEMORY"
|
1172
1182
|
# resp.job_definitions[0].container_properties.linux_parameters.devices #=> Array
|
1173
1183
|
# resp.job_definitions[0].container_properties.linux_parameters.devices[0].host_path #=> String
|
1174
1184
|
# resp.job_definitions[0].container_properties.linux_parameters.devices[0].container_path #=> String
|
@@ -1192,6 +1202,8 @@ module Aws::Batch
|
|
1192
1202
|
# resp.job_definitions[0].container_properties.secrets #=> Array
|
1193
1203
|
# resp.job_definitions[0].container_properties.secrets[0].name #=> String
|
1194
1204
|
# resp.job_definitions[0].container_properties.secrets[0].value_from #=> String
|
1205
|
+
# resp.job_definitions[0].container_properties.network_configuration.assign_public_ip #=> String, one of "ENABLED", "DISABLED"
|
1206
|
+
# resp.job_definitions[0].container_properties.fargate_platform_configuration.platform_version #=> String
|
1195
1207
|
# resp.job_definitions[0].timeout.attempt_duration_seconds #=> Integer
|
1196
1208
|
# resp.job_definitions[0].node_properties.num_nodes #=> Integer
|
1197
1209
|
# resp.job_definitions[0].node_properties.main_node #=> Integer
|
@@ -1224,7 +1236,7 @@ module Aws::Batch
|
|
1224
1236
|
# resp.job_definitions[0].node_properties.node_range_properties[0].container.instance_type #=> String
|
1225
1237
|
# resp.job_definitions[0].node_properties.node_range_properties[0].container.resource_requirements #=> Array
|
1226
1238
|
# resp.job_definitions[0].node_properties.node_range_properties[0].container.resource_requirements[0].value #=> String
|
1227
|
-
# resp.job_definitions[0].node_properties.node_range_properties[0].container.resource_requirements[0].type #=> String, one of "GPU"
|
1239
|
+
# resp.job_definitions[0].node_properties.node_range_properties[0].container.resource_requirements[0].type #=> String, one of "GPU", "VCPU", "MEMORY"
|
1228
1240
|
# resp.job_definitions[0].node_properties.node_range_properties[0].container.linux_parameters.devices #=> Array
|
1229
1241
|
# resp.job_definitions[0].node_properties.node_range_properties[0].container.linux_parameters.devices[0].host_path #=> String
|
1230
1242
|
# resp.job_definitions[0].node_properties.node_range_properties[0].container.linux_parameters.devices[0].container_path #=> String
|
@@ -1248,8 +1260,13 @@ module Aws::Batch
|
|
1248
1260
|
# resp.job_definitions[0].node_properties.node_range_properties[0].container.secrets #=> Array
|
1249
1261
|
# resp.job_definitions[0].node_properties.node_range_properties[0].container.secrets[0].name #=> String
|
1250
1262
|
# resp.job_definitions[0].node_properties.node_range_properties[0].container.secrets[0].value_from #=> String
|
1263
|
+
# resp.job_definitions[0].node_properties.node_range_properties[0].container.network_configuration.assign_public_ip #=> String, one of "ENABLED", "DISABLED"
|
1264
|
+
# resp.job_definitions[0].node_properties.node_range_properties[0].container.fargate_platform_configuration.platform_version #=> String
|
1251
1265
|
# resp.job_definitions[0].tags #=> Hash
|
1252
1266
|
# resp.job_definitions[0].tags["TagKey"] #=> String
|
1267
|
+
# resp.job_definitions[0].propagate_tags #=> Boolean
|
1268
|
+
# resp.job_definitions[0].platform_capabilities #=> Array
|
1269
|
+
# resp.job_definitions[0].platform_capabilities[0] #=> String, one of "EC2", "FARGATE"
|
1253
1270
|
# resp.next_token #=> String
|
1254
1271
|
#
|
1255
1272
|
# @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/DescribeJobDefinitions AWS API Documentation
|
@@ -1274,7 +1291,7 @@ module Aws::Batch
|
|
1274
1291
|
# `nextToken` response element. The remaining results of the initial
|
1275
1292
|
# request can be seen by sending another `DescribeJobQueues` request
|
1276
1293
|
# with the returned `nextToken` value. This value can be between 1 and
|
1277
|
-
# 100. If this parameter
|
1294
|
+
# 100. If this parameter isn't used, then `DescribeJobQueues` returns
|
1278
1295
|
# up to 100 results and a `nextToken` value if applicable.
|
1279
1296
|
#
|
1280
1297
|
# @option params [String] :next_token
|
@@ -1499,7 +1516,7 @@ module Aws::Batch
|
|
1499
1516
|
# resp.jobs[0].container.network_interfaces[0].private_ipv_4_address #=> String
|
1500
1517
|
# resp.jobs[0].container.resource_requirements #=> Array
|
1501
1518
|
# resp.jobs[0].container.resource_requirements[0].value #=> String
|
1502
|
-
# resp.jobs[0].container.resource_requirements[0].type #=> String, one of "GPU"
|
1519
|
+
# resp.jobs[0].container.resource_requirements[0].type #=> String, one of "GPU", "VCPU", "MEMORY"
|
1503
1520
|
# resp.jobs[0].container.linux_parameters.devices #=> Array
|
1504
1521
|
# resp.jobs[0].container.linux_parameters.devices[0].host_path #=> String
|
1505
1522
|
# resp.jobs[0].container.linux_parameters.devices[0].container_path #=> String
|
@@ -1523,6 +1540,8 @@ module Aws::Batch
|
|
1523
1540
|
# resp.jobs[0].container.secrets #=> Array
|
1524
1541
|
# resp.jobs[0].container.secrets[0].name #=> String
|
1525
1542
|
# resp.jobs[0].container.secrets[0].value_from #=> String
|
1543
|
+
# resp.jobs[0].container.network_configuration.assign_public_ip #=> String, one of "ENABLED", "DISABLED"
|
1544
|
+
# resp.jobs[0].container.fargate_platform_configuration.platform_version #=> String
|
1526
1545
|
# resp.jobs[0].node_details.node_index #=> Integer
|
1527
1546
|
# resp.jobs[0].node_details.is_main_node #=> Boolean
|
1528
1547
|
# resp.jobs[0].node_properties.num_nodes #=> Integer
|
@@ -1556,7 +1575,7 @@ module Aws::Batch
|
|
1556
1575
|
# resp.jobs[0].node_properties.node_range_properties[0].container.instance_type #=> String
|
1557
1576
|
# resp.jobs[0].node_properties.node_range_properties[0].container.resource_requirements #=> Array
|
1558
1577
|
# resp.jobs[0].node_properties.node_range_properties[0].container.resource_requirements[0].value #=> String
|
1559
|
-
# resp.jobs[0].node_properties.node_range_properties[0].container.resource_requirements[0].type #=> String, one of "GPU"
|
1578
|
+
# resp.jobs[0].node_properties.node_range_properties[0].container.resource_requirements[0].type #=> String, one of "GPU", "VCPU", "MEMORY"
|
1560
1579
|
# resp.jobs[0].node_properties.node_range_properties[0].container.linux_parameters.devices #=> Array
|
1561
1580
|
# resp.jobs[0].node_properties.node_range_properties[0].container.linux_parameters.devices[0].host_path #=> String
|
1562
1581
|
# resp.jobs[0].node_properties.node_range_properties[0].container.linux_parameters.devices[0].container_path #=> String
|
@@ -1580,6 +1599,8 @@ module Aws::Batch
|
|
1580
1599
|
# resp.jobs[0].node_properties.node_range_properties[0].container.secrets #=> Array
|
1581
1600
|
# resp.jobs[0].node_properties.node_range_properties[0].container.secrets[0].name #=> String
|
1582
1601
|
# resp.jobs[0].node_properties.node_range_properties[0].container.secrets[0].value_from #=> String
|
1602
|
+
# resp.jobs[0].node_properties.node_range_properties[0].container.network_configuration.assign_public_ip #=> String, one of "ENABLED", "DISABLED"
|
1603
|
+
# resp.jobs[0].node_properties.node_range_properties[0].container.fargate_platform_configuration.platform_version #=> String
|
1583
1604
|
# resp.jobs[0].array_properties.status_summary #=> Hash
|
1584
1605
|
# resp.jobs[0].array_properties.status_summary["String"] #=> Integer
|
1585
1606
|
# resp.jobs[0].array_properties.size #=> Integer
|
@@ -1587,6 +1608,9 @@ module Aws::Batch
|
|
1587
1608
|
# resp.jobs[0].timeout.attempt_duration_seconds #=> Integer
|
1588
1609
|
# resp.jobs[0].tags #=> Hash
|
1589
1610
|
# resp.jobs[0].tags["TagKey"] #=> String
|
1611
|
+
# resp.jobs[0].propagate_tags #=> Boolean
|
1612
|
+
# resp.jobs[0].platform_capabilities #=> Array
|
1613
|
+
# resp.jobs[0].platform_capabilities[0] #=> String, one of "EC2", "FARGATE"
|
1590
1614
|
#
|
1591
1615
|
# @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/DescribeJobs AWS API Documentation
|
1592
1616
|
#
|
@@ -1599,21 +1623,21 @@ module Aws::Batch
|
|
1599
1623
|
|
1600
1624
|
# Returns a list of AWS Batch jobs.
|
1601
1625
|
#
|
1602
|
-
# You must specify only one of the following:
|
1626
|
+
# You must specify only one of the following items:
|
1603
1627
|
#
|
1604
|
-
# *
|
1628
|
+
# * A job queue ID to return a list of jobs in that job queue
|
1605
1629
|
#
|
1606
|
-
# *
|
1630
|
+
# * A multi-node parallel job ID to return a list of that job's nodes
|
1607
1631
|
#
|
1608
|
-
# *
|
1632
|
+
# * An array job ID to return a list of that job's children
|
1609
1633
|
#
|
1610
1634
|
# You can filter the results by job status with the `jobStatus`
|
1611
|
-
# parameter. If you
|
1635
|
+
# parameter. If you don't specify a status, only `RUNNING` jobs are
|
1612
1636
|
# returned.
|
1613
1637
|
#
|
1614
1638
|
# @option params [String] :job_queue
|
1615
|
-
# The name or full Amazon Resource Name (ARN) of the job queue
|
1616
|
-
#
|
1639
|
+
# The name or full Amazon Resource Name (ARN) of the job queue used to
|
1640
|
+
# list jobs.
|
1617
1641
|
#
|
1618
1642
|
# @option params [String] :array_job_id
|
1619
1643
|
# The job ID for an array job. Specifying an array job ID with this
|
@@ -1625,8 +1649,8 @@ module Aws::Batch
|
|
1625
1649
|
# associated with the specified job.
|
1626
1650
|
#
|
1627
1651
|
# @option params [String] :job_status
|
1628
|
-
# The job status
|
1629
|
-
#
|
1652
|
+
# The job status used to filter jobs in the specified queue. If you
|
1653
|
+
# don't specify a status, only `RUNNING` jobs are returned.
|
1630
1654
|
#
|
1631
1655
|
# @option params [Integer] :max_results
|
1632
1656
|
# The maximum number of results returned by `ListJobs` in paginated
|
@@ -1635,7 +1659,7 @@ module Aws::Batch
|
|
1635
1659
|
# response element. The remaining results of the initial request can be
|
1636
1660
|
# seen by sending another `ListJobs` request with the returned
|
1637
1661
|
# `nextToken` value. This value can be between 1 and 100. If this
|
1638
|
-
# parameter
|
1662
|
+
# parameter isn't used, then `ListJobs` returns up to 100 results and a
|
1639
1663
|
# `nextToken` value if applicable.
|
1640
1664
|
#
|
1641
1665
|
# @option params [String] :next_token
|
@@ -1736,14 +1760,14 @@ module Aws::Batch
|
|
1736
1760
|
req.send_request(options)
|
1737
1761
|
end
|
1738
1762
|
|
1739
|
-
#
|
1763
|
+
# Lists the tags for an AWS Batch resource. AWS Batch resources that
|
1740
1764
|
# support tags are compute environments, jobs, job definitions, and job
|
1741
1765
|
# queues. ARNs for child jobs of array and multi-node parallel (MNP)
|
1742
1766
|
# jobs are not supported.
|
1743
1767
|
#
|
1744
1768
|
# @option params [required, String] :resource_arn
|
1745
|
-
# The Amazon Resource Name (ARN) that identifies the resource
|
1746
|
-
#
|
1769
|
+
# The Amazon Resource Name (ARN) that identifies the resource that tags
|
1770
|
+
# are listed for. AWS Batch resources that support tags are compute
|
1747
1771
|
# environments, jobs, job definitions, and job queues. ARNs for child
|
1748
1772
|
# jobs of array and multi-node parallel (MNP) jobs are not supported.
|
1749
1773
|
#
|
@@ -1797,7 +1821,18 @@ module Aws::Batch
|
|
1797
1821
|
# allowed.
|
1798
1822
|
#
|
1799
1823
|
# @option params [required, String] :type
|
1800
|
-
# The type of job definition.
|
1824
|
+
# The type of job definition. For more information about multi-node
|
1825
|
+
# parallel jobs, see [Creating a multi-node parallel job definition][1]
|
1826
|
+
# in the *AWS Batch User Guide*.
|
1827
|
+
#
|
1828
|
+
# <note markdown="1"> If the job is run on Fargate resources, then `multinode` isn't
|
1829
|
+
# supported.
|
1830
|
+
#
|
1831
|
+
# </note>
|
1832
|
+
#
|
1833
|
+
#
|
1834
|
+
#
|
1835
|
+
# [1]: https://docs.aws.amazon.com/batch/latest/userguide/multi-node-job-def.html
|
1801
1836
|
#
|
1802
1837
|
# @option params [Hash<String,String>] :parameters
|
1803
1838
|
# Default parameter substitution placeholders to set in the job
|
@@ -1811,6 +1846,11 @@ module Aws::Batch
|
|
1811
1846
|
# `container`, then you must specify either `containerProperties` or
|
1812
1847
|
# `nodeProperties`.
|
1813
1848
|
#
|
1849
|
+
# <note markdown="1"> If the job runs on Fargate resources, then you must not specify
|
1850
|
+
# `nodeProperties`; use only `containerProperties`.
|
1851
|
+
#
|
1852
|
+
# </note>
|
1853
|
+
#
|
1814
1854
|
# @option params [Types::NodeProperties] :node_properties
|
1815
1855
|
# An object with various properties specific to multi-node parallel
|
1816
1856
|
# jobs. If you specify node properties for a job, it becomes a
|
@@ -1819,6 +1859,11 @@ module Aws::Batch
|
|
1819
1859
|
# definition's `type` parameter is `container`, then you must specify
|
1820
1860
|
# either `containerProperties` or `nodeProperties`.
|
1821
1861
|
#
|
1862
|
+
# <note markdown="1"> If the job runs on Fargate resources, then you must not specify
|
1863
|
+
# `nodeProperties`; use `containerProperties` instead.
|
1864
|
+
#
|
1865
|
+
# </note>
|
1866
|
+
#
|
1822
1867
|
#
|
1823
1868
|
#
|
1824
1869
|
# [1]: https://docs.aws.amazon.com/batch/latest/userguide/multi-node-parallel-jobs.html
|
@@ -1827,31 +1872,44 @@ module Aws::Batch
|
|
1827
1872
|
# The retry strategy to use for failed jobs that are submitted with this
|
1828
1873
|
# job definition. Any retry strategy that is specified during a
|
1829
1874
|
# SubmitJob operation overrides the retry strategy defined here. If a
|
1830
|
-
# job is terminated due to a timeout, it
|
1875
|
+
# job is terminated due to a timeout, it isn't retried.
|
1876
|
+
#
|
1877
|
+
# @option params [Boolean] :propagate_tags
|
1878
|
+
# Specifies whether to propagate the tags from the job or job definition
|
1879
|
+
# to the corresponding Amazon ECS task. If no value is specified, the
|
1880
|
+
# tags are not propagated. Tags can only be propagated to the tasks
|
1881
|
+
# during task creation. For tags with the same name, job tags are given
|
1882
|
+
# priority over job definitions tags. If the total number of combined
|
1883
|
+
# tags from the job and job definition is over 50, the job is moved to
|
1884
|
+
# the `FAILED` state.
|
1831
1885
|
#
|
1832
1886
|
# @option params [Types::JobTimeout] :timeout
|
1833
1887
|
# The timeout configuration for jobs that are submitted with this job
|
1834
1888
|
# definition, after which AWS Batch terminates your jobs if they have
|
1835
|
-
# not finished. If a job is terminated due to a timeout, it
|
1889
|
+
# not finished. If a job is terminated due to a timeout, it isn't
|
1836
1890
|
# retried. The minimum value for the timeout is 60 seconds. Any timeout
|
1837
1891
|
# configuration that is specified during a SubmitJob operation overrides
|
1838
1892
|
# the timeout configuration defined here. For more information, see [Job
|
1839
|
-
# Timeouts][1] in the *
|
1840
|
-
# Guide*.
|
1893
|
+
# Timeouts][1] in the *AWS Batch User Guide*.
|
1841
1894
|
#
|
1842
1895
|
#
|
1843
1896
|
#
|
1844
|
-
# [1]: https://docs.aws.amazon.com/
|
1897
|
+
# [1]: https://docs.aws.amazon.com/batch/latest/userguide/job_timeouts.html
|
1845
1898
|
#
|
1846
1899
|
# @option params [Hash<String,String>] :tags
|
1847
1900
|
# The tags that you apply to the job definition to help you categorize
|
1848
1901
|
# and organize your resources. Each tag consists of a key and an
|
1849
1902
|
# optional value. For more information, see [Tagging AWS Resources][1]
|
1850
|
-
# in *AWS
|
1903
|
+
# in *AWS Batch User Guide*.
|
1851
1904
|
#
|
1852
1905
|
#
|
1853
1906
|
#
|
1854
|
-
# [1]: https://docs.aws.amazon.com/
|
1907
|
+
# [1]: https://docs.aws.amazon.com/batch/latest/userguide/using-tags.html
|
1908
|
+
#
|
1909
|
+
# @option params [Array<String>] :platform_capabilities
|
1910
|
+
# The platform capabilities required by the job definition. If no value
|
1911
|
+
# is specified, it defaults to `EC2`. To run the job on Fargate
|
1912
|
+
# resources, specify `FARGATE`.
|
1855
1913
|
#
|
1856
1914
|
# @return [Types::RegisterJobDefinitionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1857
1915
|
#
|
@@ -1964,7 +2022,7 @@ module Aws::Batch
|
|
1964
2022
|
# resource_requirements: [
|
1965
2023
|
# {
|
1966
2024
|
# value: "String", # required
|
1967
|
-
# type: "GPU", # required, accepts GPU
|
2025
|
+
# type: "GPU", # required, accepts GPU, VCPU, MEMORY
|
1968
2026
|
# },
|
1969
2027
|
# ],
|
1970
2028
|
# linux_parameters: {
|
@@ -2005,6 +2063,12 @@ module Aws::Batch
|
|
2005
2063
|
# value_from: "String", # required
|
2006
2064
|
# },
|
2007
2065
|
# ],
|
2066
|
+
# network_configuration: {
|
2067
|
+
# assign_public_ip: "ENABLED", # accepts ENABLED, DISABLED
|
2068
|
+
# },
|
2069
|
+
# fargate_platform_configuration: {
|
2070
|
+
# platform_version: "String",
|
2071
|
+
# },
|
2008
2072
|
# },
|
2009
2073
|
# node_properties: {
|
2010
2074
|
# num_nodes: 1, # required
|
@@ -2054,7 +2118,7 @@ module Aws::Batch
|
|
2054
2118
|
# resource_requirements: [
|
2055
2119
|
# {
|
2056
2120
|
# value: "String", # required
|
2057
|
-
# type: "GPU", # required, accepts GPU
|
2121
|
+
# type: "GPU", # required, accepts GPU, VCPU, MEMORY
|
2058
2122
|
# },
|
2059
2123
|
# ],
|
2060
2124
|
# linux_parameters: {
|
@@ -2095,6 +2159,12 @@ module Aws::Batch
|
|
2095
2159
|
# value_from: "String", # required
|
2096
2160
|
# },
|
2097
2161
|
# ],
|
2162
|
+
# network_configuration: {
|
2163
|
+
# assign_public_ip: "ENABLED", # accepts ENABLED, DISABLED
|
2164
|
+
# },
|
2165
|
+
# fargate_platform_configuration: {
|
2166
|
+
# platform_version: "String",
|
2167
|
+
# },
|
2098
2168
|
# },
|
2099
2169
|
# },
|
2100
2170
|
# ],
|
@@ -2110,12 +2180,14 @@ module Aws::Batch
|
|
2110
2180
|
# },
|
2111
2181
|
# ],
|
2112
2182
|
# },
|
2183
|
+
# propagate_tags: false,
|
2113
2184
|
# timeout: {
|
2114
2185
|
# attempt_duration_seconds: 1,
|
2115
2186
|
# },
|
2116
2187
|
# tags: {
|
2117
2188
|
# "TagKey" => "TagValue",
|
2118
2189
|
# },
|
2190
|
+
# platform_capabilities: ["EC2"], # accepts EC2, FARGATE
|
2119
2191
|
# })
|
2120
2192
|
#
|
2121
2193
|
# @example Response structure
|
@@ -2136,6 +2208,10 @@ module Aws::Batch
|
|
2136
2208
|
# Submits an AWS Batch job from a job definition. Parameters specified
|
2137
2209
|
# during SubmitJob override parameters defined in the job definition.
|
2138
2210
|
#
|
2211
|
+
# Jobs run on Fargate resources don't run for more than 14 days. After
|
2212
|
+
# 14 days, the Fargate resources might no longer be available and the
|
2213
|
+
# job is terminated.
|
2214
|
+
#
|
2139
2215
|
# @option params [required, String] :job_name
|
2140
2216
|
# The name of the job. The first character must be alphanumeric, and up
|
2141
2217
|
# to 128 letters (uppercase and lowercase), numbers, hyphens, and
|
@@ -2191,16 +2267,31 @@ module Aws::Batch
|
|
2191
2267
|
# A list of node overrides in JSON format that specify the node range to
|
2192
2268
|
# target and the container overrides for that node range.
|
2193
2269
|
#
|
2270
|
+
# <note markdown="1"> This parameter isn't applicable to jobs running on Fargate resources;
|
2271
|
+
# use `containerOverrides` instead.
|
2272
|
+
#
|
2273
|
+
# </note>
|
2274
|
+
#
|
2194
2275
|
# @option params [Types::RetryStrategy] :retry_strategy
|
2195
2276
|
# The retry strategy to use for failed jobs from this SubmitJob
|
2196
2277
|
# operation. When a retry strategy is specified here, it overrides the
|
2197
2278
|
# retry strategy defined in the job definition.
|
2198
2279
|
#
|
2280
|
+
# @option params [Boolean] :propagate_tags
|
2281
|
+
# Specifies whether to propagate the tags from the job or job definition
|
2282
|
+
# to the corresponding Amazon ECS task. If no value is specified, the
|
2283
|
+
# tags aren't propagated. Tags can only be propagated to the tasks
|
2284
|
+
# during task creation. For tags with the same name, job tags are given
|
2285
|
+
# priority over job definitions tags. If the total number of combined
|
2286
|
+
# tags from the job and job definition is over 50, the job is moved to
|
2287
|
+
# the `FAILED` state. When specified, this overrides the tag propagation
|
2288
|
+
# setting in the job definition.
|
2289
|
+
#
|
2199
2290
|
# @option params [Types::JobTimeout] :timeout
|
2200
2291
|
# The timeout configuration for this SubmitJob operation. You can
|
2201
2292
|
# specify a timeout duration after which AWS Batch terminates your jobs
|
2202
|
-
# if they
|
2203
|
-
#
|
2293
|
+
# if they haven't finished. If a job is terminated due to a timeout, it
|
2294
|
+
# isn't retried. The minimum value for the timeout is 60 seconds. This
|
2204
2295
|
# configuration overrides any timeout configuration specified in the job
|
2205
2296
|
# definition. For array jobs, child jobs have the same timeout
|
2206
2297
|
# configuration as the parent job. For more information, see [Job
|
@@ -2276,7 +2367,7 @@ module Aws::Batch
|
|
2276
2367
|
# resource_requirements: [
|
2277
2368
|
# {
|
2278
2369
|
# value: "String", # required
|
2279
|
-
# type: "GPU", # required, accepts GPU
|
2370
|
+
# type: "GPU", # required, accepts GPU, VCPU, MEMORY
|
2280
2371
|
# },
|
2281
2372
|
# ],
|
2282
2373
|
# },
|
@@ -2299,7 +2390,7 @@ module Aws::Batch
|
|
2299
2390
|
# resource_requirements: [
|
2300
2391
|
# {
|
2301
2392
|
# value: "String", # required
|
2302
|
-
# type: "GPU", # required, accepts GPU
|
2393
|
+
# type: "GPU", # required, accepts GPU, VCPU, MEMORY
|
2303
2394
|
# },
|
2304
2395
|
# ],
|
2305
2396
|
# },
|
@@ -2317,6 +2408,7 @@ module Aws::Batch
|
|
2317
2408
|
# },
|
2318
2409
|
# ],
|
2319
2410
|
# },
|
2411
|
+
# propagate_tags: false,
|
2320
2412
|
# timeout: {
|
2321
2413
|
# attempt_duration_seconds: 1,
|
2322
2414
|
# },
|
@@ -2341,15 +2433,15 @@ module Aws::Batch
|
|
2341
2433
|
end
|
2342
2434
|
|
2343
2435
|
# Associates the specified tags to a resource with the specified
|
2344
|
-
# `resourceArn`. If existing tags on a resource
|
2345
|
-
# request parameters, they
|
2436
|
+
# `resourceArn`. If existing tags on a resource aren't specified in the
|
2437
|
+
# request parameters, they aren't changed. When a resource is deleted,
|
2346
2438
|
# the tags associated with that resource are deleted as well. AWS Batch
|
2347
2439
|
# resources that support tags are compute environments, jobs, job
|
2348
2440
|
# definitions, and job queues. ARNs for child jobs of array and
|
2349
2441
|
# multi-node parallel (MNP) jobs are not supported.
|
2350
2442
|
#
|
2351
2443
|
# @option params [required, String] :resource_arn
|
2352
|
-
# The Amazon Resource Name (ARN) of the resource
|
2444
|
+
# The Amazon Resource Name (ARN) of the resource that tags are added to.
|
2353
2445
|
# AWS Batch resources that support tags are compute environments, jobs,
|
2354
2446
|
# job definitions, and job queues. ARNs for child jobs of array and
|
2355
2447
|
# multi-node parallel (MNP) jobs are not supported.
|
@@ -2513,11 +2605,11 @@ module Aws::Batch
|
|
2513
2605
|
# specify the full role ARN (this is recommended) or prefix the role
|
2514
2606
|
# name with the path.
|
2515
2607
|
#
|
2516
|
-
# <note markdown="1"> Depending on how you created your AWS Batch service role, its ARN
|
2517
|
-
# contain the `service-role` path prefix. When you only specify
|
2518
|
-
# of the service role, AWS Batch assumes that your ARN does not
|
2519
|
-
# `service-role` path prefix. Because of this, we recommend that
|
2520
|
-
# specify the full ARN of your service role when you create compute
|
2608
|
+
# <note markdown="1"> Depending on how you created your AWS Batch service role, its ARN
|
2609
|
+
# might contain the `service-role` path prefix. When you only specify
|
2610
|
+
# the name of the service role, AWS Batch assumes that your ARN does not
|
2611
|
+
# use the `service-role` path prefix. Because of this, we recommend that
|
2612
|
+
# you specify the full ARN of your service role when you create compute
|
2521
2613
|
# environments.
|
2522
2614
|
#
|
2523
2615
|
# </note>
|
@@ -2552,6 +2644,8 @@ module Aws::Batch
|
|
2552
2644
|
# minv_cpus: 1,
|
2553
2645
|
# maxv_cpus: 1,
|
2554
2646
|
# desiredv_cpus: 1,
|
2647
|
+
# subnets: ["String"],
|
2648
|
+
# security_group_ids: ["String"],
|
2555
2649
|
# },
|
2556
2650
|
# service_role: "String",
|
2557
2651
|
# })
|
@@ -2592,8 +2686,10 @@ module Aws::Batch
|
|
2592
2686
|
# @option params [Array<Types::ComputeEnvironmentOrder>] :compute_environment_order
|
2593
2687
|
# Details the set of compute environments mapped to a job queue and
|
2594
2688
|
# their order relative to each other. This is one of the parameters used
|
2595
|
-
# by the job scheduler to determine which compute environment should
|
2596
|
-
#
|
2689
|
+
# by the job scheduler to determine which compute environment should run
|
2690
|
+
# a given job. All of the compute environments must be either EC2 (`EC2`
|
2691
|
+
# or `SPOT`) or Fargate (`FARGATE` or `FARGATE_SPOT`); EC2 and Fargate
|
2692
|
+
# compute environments can't be mixed.
|
2597
2693
|
#
|
2598
2694
|
# @return [Types::UpdateJobQueueResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2599
2695
|
#
|
@@ -2657,7 +2753,7 @@ module Aws::Batch
|
|
2657
2753
|
params: params,
|
2658
2754
|
config: config)
|
2659
2755
|
context[:gem_name] = 'aws-sdk-batch'
|
2660
|
-
context[:gem_version] = '1.
|
2756
|
+
context[:gem_version] = '1.42.0'
|
2661
2757
|
Seahorse::Client::Request.new(handlers, context)
|
2662
2758
|
end
|
2663
2759
|
|