aws-sdk-batch 1.39.0 → 1.44.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/lib/aws-sdk-batch.rb +1 -1
- data/lib/aws-sdk-batch/client.rb +312 -120
- data/lib/aws-sdk-batch/client_api.rb +57 -8
- data/lib/aws-sdk-batch/types.rb +1411 -311
- metadata +4 -4
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: a91e31fa58b2d823591fd5320adc816083aa917634006033766e62c08f169b5d
|
4
|
+
data.tar.gz: bba053c36bf1c02222bd54574e6565d7985c39af37d990fc70dba12bba41d539
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: d1ac5f148150b40bc50705410ab3fd0247e5a790050904a3801cdb3775e49ead40419541f8138b1548594234e1a58361a2723ba6dacb5d5aa759e38607d7baab
|
7
|
+
data.tar.gz: 07dbce57db5f45a1b9883e40705683a7181d86d3d0675abfcc34181e971423a7d08f55537edb009a0e9b9ca530b5e5bc3cc1d9c88ef0d24864f25bebd1076ae3
|
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 less than 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
|
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's 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
|
#
|
@@ -443,11 +448,23 @@ module Aws::Batch
|
|
443
448
|
# the compute environment accepts jobs from a queue and can scale out
|
444
449
|
# automatically based on queues.
|
445
450
|
#
|
451
|
+
# If the state is `ENABLED`, then the AWS Batch scheduler can attempt to
|
452
|
+
# place jobs from an associated job queue on the compute resources
|
453
|
+
# within the environment. If the compute environment is managed, then it
|
454
|
+
# can scale its instances out or in automatically, based on the job
|
455
|
+
# queue demand.
|
456
|
+
#
|
457
|
+
# If the state is `DISABLED`, then the AWS Batch scheduler doesn't
|
458
|
+
# attempt to place jobs within the environment. Jobs in a `STARTING` or
|
459
|
+
# `RUNNING` state continue to progress normally. Managed compute
|
460
|
+
# environments in the `DISABLED` state don't scale out. However, they
|
461
|
+
# scale in to `minvCpus` value after instances become idle.
|
462
|
+
#
|
446
463
|
# @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*.
|
464
|
+
# Details about the compute resources managed by the compute
|
465
|
+
# environment. This parameter is required for managed compute
|
466
|
+
# environments. For more information, see [Compute Environments][1] in
|
467
|
+
# the *AWS Batch User Guide*.
|
451
468
|
#
|
452
469
|
#
|
453
470
|
#
|
@@ -455,21 +472,27 @@ module Aws::Batch
|
|
455
472
|
#
|
456
473
|
# @option params [required, String] :service_role
|
457
474
|
# The full Amazon Resource Name (ARN) of the IAM role that allows AWS
|
458
|
-
# Batch to make calls to other AWS services on your behalf.
|
475
|
+
# Batch to make calls to other AWS services on your behalf. For more
|
476
|
+
# information, see [AWS Batch service IAM role][1] in the *AWS Batch
|
477
|
+
# User Guide*.
|
459
478
|
#
|
460
479
|
# If your specified role has a path other than `/`, then you must either
|
461
480
|
# specify the full role ARN (this is recommended) or prefix the role
|
462
481
|
# name with the path.
|
463
482
|
#
|
464
|
-
# <note markdown="1"> Depending on how you created your AWS Batch service role, its ARN
|
465
|
-
# contain the `service-role` path prefix. When you only specify
|
466
|
-
# of the service role, AWS Batch assumes that your ARN
|
467
|
-
# `service-role` path prefix. Because of this, we recommend that
|
468
|
-
# specify the full ARN of your service role when you create compute
|
483
|
+
# <note markdown="1"> Depending on how you created your AWS Batch service role, its ARN
|
484
|
+
# might contain the `service-role` path prefix. When you only specify
|
485
|
+
# the name of the service role, AWS Batch assumes that your ARN doesn't
|
486
|
+
# use the `service-role` path prefix. Because of this, we recommend that
|
487
|
+
# you specify the full ARN of your service role when you create compute
|
469
488
|
# environments.
|
470
489
|
#
|
471
490
|
# </note>
|
472
491
|
#
|
492
|
+
#
|
493
|
+
#
|
494
|
+
# [1]: https://docs.aws.amazon.com/batch/latest/userguide/service_IAM_role.html
|
495
|
+
#
|
473
496
|
# @option params [Hash<String,String>] :tags
|
474
497
|
# The tags that you apply to the compute environment to help you
|
475
498
|
# categorize and organize your resources. Each tag consists of a key and
|
@@ -477,7 +500,7 @@ module Aws::Batch
|
|
477
500
|
# Resources][1] in *AWS General Reference*.
|
478
501
|
#
|
479
502
|
# These tags can be updated or removed using the [TagResource][2] and
|
480
|
-
# [UntagResource][3] API operations. These tags
|
503
|
+
# [UntagResource][3] API operations. These tags don't propagate to the
|
481
504
|
# underlying compute resources.
|
482
505
|
#
|
483
506
|
#
|
@@ -585,17 +608,17 @@ module Aws::Batch
|
|
585
608
|
# type: "MANAGED", # required, accepts MANAGED, UNMANAGED
|
586
609
|
# state: "ENABLED", # accepts ENABLED, DISABLED
|
587
610
|
# compute_resources: {
|
588
|
-
# type: "EC2", # required, accepts EC2, SPOT
|
611
|
+
# type: "EC2", # required, accepts EC2, SPOT, FARGATE, FARGATE_SPOT
|
589
612
|
# allocation_strategy: "BEST_FIT", # accepts BEST_FIT, BEST_FIT_PROGRESSIVE, SPOT_CAPACITY_OPTIMIZED
|
590
|
-
# minv_cpus: 1,
|
613
|
+
# minv_cpus: 1,
|
591
614
|
# maxv_cpus: 1, # required
|
592
615
|
# desiredv_cpus: 1,
|
593
|
-
# instance_types: ["String"],
|
616
|
+
# instance_types: ["String"],
|
594
617
|
# image_id: "String",
|
595
618
|
# subnets: ["String"], # required
|
596
619
|
# security_group_ids: ["String"],
|
597
620
|
# ec2_key_pair: "String",
|
598
|
-
# instance_role: "String",
|
621
|
+
# instance_role: "String",
|
599
622
|
# tags: {
|
600
623
|
# "String" => "String",
|
601
624
|
# },
|
@@ -607,6 +630,12 @@ module Aws::Batch
|
|
607
630
|
# launch_template_name: "String",
|
608
631
|
# version: "String",
|
609
632
|
# },
|
633
|
+
# ec2_configuration: [
|
634
|
+
# {
|
635
|
+
# image_type: "ImageType", # required
|
636
|
+
# image_id_override: "ImageIdOverride",
|
637
|
+
# },
|
638
|
+
# ],
|
610
639
|
# },
|
611
640
|
# service_role: "String", # required
|
612
641
|
# tags: {
|
@@ -639,39 +668,50 @@ module Aws::Batch
|
|
639
668
|
# preference for scheduling jobs to that compute environment.
|
640
669
|
#
|
641
670
|
# @option params [required, String] :job_queue_name
|
642
|
-
# The name of the job queue.
|
671
|
+
# The name of the job queue. Up to 128 letters (uppercase and
|
672
|
+
# lowercase), numbers, and underscores are allowed.
|
643
673
|
#
|
644
674
|
# @option params [String] :state
|
645
675
|
# The state of the job queue. If the job queue state is `ENABLED`, it is
|
646
676
|
# able to accept jobs. If the job queue state is `DISABLED`, new jobs
|
647
|
-
#
|
677
|
+
# can't be added to the queue, but jobs already in the queue can
|
648
678
|
# finish.
|
649
679
|
#
|
650
680
|
# @option params [required, Integer] :priority
|
651
681
|
# The priority of the job queue. Job queues with a higher priority (or a
|
652
682
|
# higher integer value for the `priority` parameter) are evaluated first
|
653
683
|
# when associated with the same compute environment. Priority is
|
654
|
-
# determined in descending order
|
684
|
+
# determined in descending order. For example, a job queue with a
|
655
685
|
# priority value of `10` is given scheduling preference over a job queue
|
656
|
-
# with a priority value of `1`.
|
686
|
+
# with a priority value of `1`. All of the compute environments must be
|
687
|
+
# either EC2 (`EC2` or `SPOT`) or Fargate (`FARGATE` or `FARGATE_SPOT`);
|
688
|
+
# EC2 and Fargate compute environments cannot be mixed.
|
657
689
|
#
|
658
690
|
# @option params [required, Array<Types::ComputeEnvironmentOrder>] :compute_environment_order
|
659
691
|
# The set of compute environments mapped to a job queue and their order
|
660
692
|
# relative to each other. The job scheduler uses this parameter to
|
661
|
-
# determine which compute environment should
|
662
|
-
#
|
663
|
-
#
|
664
|
-
# environments with a job queue.
|
693
|
+
# determine which compute environment should run a specific job. Compute
|
694
|
+
# environments must be in the `VALID` state before you can associate
|
695
|
+
# them with a job queue. You can associate up to three compute
|
696
|
+
# environments with a job queue. All of the compute environments must be
|
697
|
+
# either EC2 (`EC2` or `SPOT`) or Fargate (`FARGATE` or `FARGATE_SPOT`);
|
698
|
+
# EC2 and Fargate compute environments can't be mixed.
|
699
|
+
#
|
700
|
+
# <note markdown="1"> All compute environments that are associated with a job queue must
|
701
|
+
# share the same architecture. AWS Batch doesn't support mixing compute
|
702
|
+
# environment architecture types in a single job queue.
|
703
|
+
#
|
704
|
+
# </note>
|
665
705
|
#
|
666
706
|
# @option params [Hash<String,String>] :tags
|
667
707
|
# The tags that you apply to the job queue to help you categorize and
|
668
708
|
# organize your resources. Each tag consists of a key and an optional
|
669
|
-
# value. For more information, see [Tagging AWS
|
670
|
-
#
|
709
|
+
# value. For more information, see [Tagging your AWS Batch resources][1]
|
710
|
+
# in *AWS Batch User Guide*.
|
671
711
|
#
|
672
712
|
#
|
673
713
|
#
|
674
|
-
# [1]: https://docs.aws.amazon.com/
|
714
|
+
# [1]: https://docs.aws.amazon.com/batch/latest/userguide/using-tags.html
|
675
715
|
#
|
676
716
|
# @return [Types::CreateJobQueueResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
677
717
|
#
|
@@ -764,7 +804,10 @@ module Aws::Batch
|
|
764
804
|
# Before you can delete a compute environment, you must set its state to
|
765
805
|
# `DISABLED` with the UpdateComputeEnvironment API operation and
|
766
806
|
# disassociate it from any job queues with the UpdateJobQueue API
|
767
|
-
# operation.
|
807
|
+
# operation. Compute environments that use AWS Fargate resources must
|
808
|
+
# terminate all active jobs on that compute environment before deleting
|
809
|
+
# the compute environment. If this isn't done, the compute environment
|
810
|
+
# will end up in an invalid state.
|
768
811
|
#
|
769
812
|
# @option params [required, String] :compute_environment
|
770
813
|
# The name or Amazon Resource Name (ARN) of the compute environment to
|
@@ -802,9 +845,10 @@ module Aws::Batch
|
|
802
845
|
|
803
846
|
# Deletes the specified job queue. You must first disable submissions
|
804
847
|
# for a queue with the UpdateJobQueue operation. All jobs in the queue
|
805
|
-
# are terminated when you delete a job queue.
|
848
|
+
# are eventually terminated when you delete a job queue. The jobs are
|
849
|
+
# terminated at a rate of about 16 jobs each second.
|
806
850
|
#
|
807
|
-
# It
|
851
|
+
# It's not necessary to disassociate compute environments from a queue
|
808
852
|
# before submitting a `DeleteJobQueue` request.
|
809
853
|
#
|
810
854
|
# @option params [required, String] :job_queue
|
@@ -841,7 +885,7 @@ module Aws::Batch
|
|
841
885
|
req.send_request(options)
|
842
886
|
end
|
843
887
|
|
844
|
-
# Deregisters an AWS Batch job definition. Job definitions
|
888
|
+
# Deregisters an AWS Batch job definition. Job definitions are
|
845
889
|
# permanently deleted after 180 days.
|
846
890
|
#
|
847
891
|
# @option params [required, String] :job_definition
|
@@ -880,7 +924,7 @@ module Aws::Batch
|
|
880
924
|
|
881
925
|
# Describes one or more of your compute environments.
|
882
926
|
#
|
883
|
-
# If you
|
927
|
+
# If you're using an unmanaged compute environment, you can use the
|
884
928
|
# `DescribeComputeEnvironment` operation to determine the
|
885
929
|
# `ecsClusterArn` that you should launch your Amazon ECS container
|
886
930
|
# instances into.
|
@@ -897,7 +941,7 @@ module Aws::Batch
|
|
897
941
|
# The remaining results of the initial request can be seen by sending
|
898
942
|
# another `DescribeComputeEnvironments` request with the returned
|
899
943
|
# `nextToken` value. This value can be between 1 and 100. If this
|
900
|
-
# parameter
|
944
|
+
# parameter isn't used, then `DescribeComputeEnvironments` returns up
|
901
945
|
# to 100 results and a `nextToken` value if applicable.
|
902
946
|
#
|
903
947
|
# @option params [String] :next_token
|
@@ -907,7 +951,7 @@ module Aws::Batch
|
|
907
951
|
# from the end of the previous results that returned the `nextToken`
|
908
952
|
# value. This value is `null` when there are no more results to return.
|
909
953
|
#
|
910
|
-
# <note markdown="1"> This token should be treated as an opaque identifier that
|
954
|
+
# <note markdown="1"> This token should be treated as an opaque identifier that's only used
|
911
955
|
# to retrieve the next items in a list and not for other programmatic
|
912
956
|
# purposes.
|
913
957
|
#
|
@@ -989,7 +1033,7 @@ module Aws::Batch
|
|
989
1033
|
# resp.compute_environments[0].state #=> String, one of "ENABLED", "DISABLED"
|
990
1034
|
# resp.compute_environments[0].status #=> String, one of "CREATING", "UPDATING", "DELETING", "DELETED", "VALID", "INVALID"
|
991
1035
|
# resp.compute_environments[0].status_reason #=> String
|
992
|
-
# resp.compute_environments[0].compute_resources.type #=> String, one of "EC2", "SPOT"
|
1036
|
+
# resp.compute_environments[0].compute_resources.type #=> String, one of "EC2", "SPOT", "FARGATE", "FARGATE_SPOT"
|
993
1037
|
# resp.compute_environments[0].compute_resources.allocation_strategy #=> String, one of "BEST_FIT", "BEST_FIT_PROGRESSIVE", "SPOT_CAPACITY_OPTIMIZED"
|
994
1038
|
# resp.compute_environments[0].compute_resources.minv_cpus #=> Integer
|
995
1039
|
# resp.compute_environments[0].compute_resources.maxv_cpus #=> Integer
|
@@ -1011,6 +1055,9 @@ module Aws::Batch
|
|
1011
1055
|
# resp.compute_environments[0].compute_resources.launch_template.launch_template_id #=> String
|
1012
1056
|
# resp.compute_environments[0].compute_resources.launch_template.launch_template_name #=> String
|
1013
1057
|
# resp.compute_environments[0].compute_resources.launch_template.version #=> String
|
1058
|
+
# resp.compute_environments[0].compute_resources.ec2_configuration #=> Array
|
1059
|
+
# resp.compute_environments[0].compute_resources.ec2_configuration[0].image_type #=> String
|
1060
|
+
# resp.compute_environments[0].compute_resources.ec2_configuration[0].image_id_override #=> String
|
1014
1061
|
# resp.compute_environments[0].service_role #=> String
|
1015
1062
|
# resp.next_token #=> String
|
1016
1063
|
#
|
@@ -1037,7 +1084,7 @@ module Aws::Batch
|
|
1037
1084
|
# page along with a `nextToken` response element. The remaining results
|
1038
1085
|
# of the initial request can be seen by sending another
|
1039
1086
|
# `DescribeJobDefinitions` request with the returned `nextToken` value.
|
1040
|
-
# This value can be between 1 and 100. If this parameter
|
1087
|
+
# This value can be between 1 and 100. If this parameter isn't used,
|
1041
1088
|
# then `DescribeJobDefinitions` returns up to 100 results and a
|
1042
1089
|
# `nextToken` value if applicable.
|
1043
1090
|
#
|
@@ -1045,7 +1092,7 @@ module Aws::Batch
|
|
1045
1092
|
# The name of the job definition to describe.
|
1046
1093
|
#
|
1047
1094
|
# @option params [String] :status
|
1048
|
-
# The status
|
1095
|
+
# The status used to filter job definitions.
|
1049
1096
|
#
|
1050
1097
|
# @option params [String] :next_token
|
1051
1098
|
# The `nextToken` value returned from a previous paginated
|
@@ -1054,7 +1101,7 @@ module Aws::Batch
|
|
1054
1101
|
# from the end of the previous results that returned the `nextToken`
|
1055
1102
|
# value. This value is `null` when there are no more results to return.
|
1056
1103
|
#
|
1057
|
-
# <note markdown="1"> This token should be treated as an opaque identifier that
|
1104
|
+
# <note markdown="1"> This token should be treated as an opaque identifier that's only used
|
1058
1105
|
# to retrieve the next items in a list and not for other programmatic
|
1059
1106
|
# purposes.
|
1060
1107
|
#
|
@@ -1127,6 +1174,11 @@ module Aws::Batch
|
|
1127
1174
|
# resp.job_definitions[0].parameters #=> Hash
|
1128
1175
|
# resp.job_definitions[0].parameters["String"] #=> String
|
1129
1176
|
# resp.job_definitions[0].retry_strategy.attempts #=> Integer
|
1177
|
+
# resp.job_definitions[0].retry_strategy.evaluate_on_exit #=> Array
|
1178
|
+
# resp.job_definitions[0].retry_strategy.evaluate_on_exit[0].on_status_reason #=> String
|
1179
|
+
# resp.job_definitions[0].retry_strategy.evaluate_on_exit[0].on_reason #=> String
|
1180
|
+
# resp.job_definitions[0].retry_strategy.evaluate_on_exit[0].on_exit_code #=> String
|
1181
|
+
# resp.job_definitions[0].retry_strategy.evaluate_on_exit[0].action #=> String, one of "RETRY", "EXIT"
|
1130
1182
|
# resp.job_definitions[0].container_properties.image #=> String
|
1131
1183
|
# resp.job_definitions[0].container_properties.vcpus #=> Integer
|
1132
1184
|
# resp.job_definitions[0].container_properties.memory #=> Integer
|
@@ -1154,7 +1206,7 @@ module Aws::Batch
|
|
1154
1206
|
# resp.job_definitions[0].container_properties.instance_type #=> String
|
1155
1207
|
# resp.job_definitions[0].container_properties.resource_requirements #=> Array
|
1156
1208
|
# resp.job_definitions[0].container_properties.resource_requirements[0].value #=> String
|
1157
|
-
# resp.job_definitions[0].container_properties.resource_requirements[0].type #=> String, one of "GPU"
|
1209
|
+
# resp.job_definitions[0].container_properties.resource_requirements[0].type #=> String, one of "GPU", "VCPU", "MEMORY"
|
1158
1210
|
# resp.job_definitions[0].container_properties.linux_parameters.devices #=> Array
|
1159
1211
|
# resp.job_definitions[0].container_properties.linux_parameters.devices[0].host_path #=> String
|
1160
1212
|
# resp.job_definitions[0].container_properties.linux_parameters.devices[0].container_path #=> String
|
@@ -1178,6 +1230,8 @@ module Aws::Batch
|
|
1178
1230
|
# resp.job_definitions[0].container_properties.secrets #=> Array
|
1179
1231
|
# resp.job_definitions[0].container_properties.secrets[0].name #=> String
|
1180
1232
|
# resp.job_definitions[0].container_properties.secrets[0].value_from #=> String
|
1233
|
+
# resp.job_definitions[0].container_properties.network_configuration.assign_public_ip #=> String, one of "ENABLED", "DISABLED"
|
1234
|
+
# resp.job_definitions[0].container_properties.fargate_platform_configuration.platform_version #=> String
|
1181
1235
|
# resp.job_definitions[0].timeout.attempt_duration_seconds #=> Integer
|
1182
1236
|
# resp.job_definitions[0].node_properties.num_nodes #=> Integer
|
1183
1237
|
# resp.job_definitions[0].node_properties.main_node #=> Integer
|
@@ -1210,7 +1264,7 @@ module Aws::Batch
|
|
1210
1264
|
# resp.job_definitions[0].node_properties.node_range_properties[0].container.instance_type #=> String
|
1211
1265
|
# resp.job_definitions[0].node_properties.node_range_properties[0].container.resource_requirements #=> Array
|
1212
1266
|
# resp.job_definitions[0].node_properties.node_range_properties[0].container.resource_requirements[0].value #=> String
|
1213
|
-
# resp.job_definitions[0].node_properties.node_range_properties[0].container.resource_requirements[0].type #=> String, one of "GPU"
|
1267
|
+
# resp.job_definitions[0].node_properties.node_range_properties[0].container.resource_requirements[0].type #=> String, one of "GPU", "VCPU", "MEMORY"
|
1214
1268
|
# resp.job_definitions[0].node_properties.node_range_properties[0].container.linux_parameters.devices #=> Array
|
1215
1269
|
# resp.job_definitions[0].node_properties.node_range_properties[0].container.linux_parameters.devices[0].host_path #=> String
|
1216
1270
|
# resp.job_definitions[0].node_properties.node_range_properties[0].container.linux_parameters.devices[0].container_path #=> String
|
@@ -1234,8 +1288,13 @@ module Aws::Batch
|
|
1234
1288
|
# resp.job_definitions[0].node_properties.node_range_properties[0].container.secrets #=> Array
|
1235
1289
|
# resp.job_definitions[0].node_properties.node_range_properties[0].container.secrets[0].name #=> String
|
1236
1290
|
# resp.job_definitions[0].node_properties.node_range_properties[0].container.secrets[0].value_from #=> String
|
1291
|
+
# resp.job_definitions[0].node_properties.node_range_properties[0].container.network_configuration.assign_public_ip #=> String, one of "ENABLED", "DISABLED"
|
1292
|
+
# resp.job_definitions[0].node_properties.node_range_properties[0].container.fargate_platform_configuration.platform_version #=> String
|
1237
1293
|
# resp.job_definitions[0].tags #=> Hash
|
1238
1294
|
# resp.job_definitions[0].tags["TagKey"] #=> String
|
1295
|
+
# resp.job_definitions[0].propagate_tags #=> Boolean
|
1296
|
+
# resp.job_definitions[0].platform_capabilities #=> Array
|
1297
|
+
# resp.job_definitions[0].platform_capabilities[0] #=> String, one of "EC2", "FARGATE"
|
1239
1298
|
# resp.next_token #=> String
|
1240
1299
|
#
|
1241
1300
|
# @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/DescribeJobDefinitions AWS API Documentation
|
@@ -1260,7 +1319,7 @@ module Aws::Batch
|
|
1260
1319
|
# `nextToken` response element. The remaining results of the initial
|
1261
1320
|
# request can be seen by sending another `DescribeJobQueues` request
|
1262
1321
|
# with the returned `nextToken` value. This value can be between 1 and
|
1263
|
-
# 100. If this parameter
|
1322
|
+
# 100. If this parameter isn't used, then `DescribeJobQueues` returns
|
1264
1323
|
# up to 100 results and a `nextToken` value if applicable.
|
1265
1324
|
#
|
1266
1325
|
# @option params [String] :next_token
|
@@ -1270,7 +1329,7 @@ module Aws::Batch
|
|
1270
1329
|
# from the end of the previous results that returned the `nextToken`
|
1271
1330
|
# value. This value is `null` when there are no more results to return.
|
1272
1331
|
#
|
1273
|
-
# <note markdown="1"> This token should be treated as an opaque identifier that
|
1332
|
+
# <note markdown="1"> This token should be treated as an opaque identifier that's only used
|
1274
1333
|
# to retrieve the next items in a list and not for other programmatic
|
1275
1334
|
# purposes.
|
1276
1335
|
#
|
@@ -1436,6 +1495,11 @@ module Aws::Batch
|
|
1436
1495
|
# resp.jobs[0].status_reason #=> String
|
1437
1496
|
# resp.jobs[0].created_at #=> Integer
|
1438
1497
|
# resp.jobs[0].retry_strategy.attempts #=> Integer
|
1498
|
+
# resp.jobs[0].retry_strategy.evaluate_on_exit #=> Array
|
1499
|
+
# resp.jobs[0].retry_strategy.evaluate_on_exit[0].on_status_reason #=> String
|
1500
|
+
# resp.jobs[0].retry_strategy.evaluate_on_exit[0].on_reason #=> String
|
1501
|
+
# resp.jobs[0].retry_strategy.evaluate_on_exit[0].on_exit_code #=> String
|
1502
|
+
# resp.jobs[0].retry_strategy.evaluate_on_exit[0].action #=> String, one of "RETRY", "EXIT"
|
1439
1503
|
# resp.jobs[0].started_at #=> Integer
|
1440
1504
|
# resp.jobs[0].stopped_at #=> Integer
|
1441
1505
|
# resp.jobs[0].depends_on #=> Array
|
@@ -1480,7 +1544,7 @@ module Aws::Batch
|
|
1480
1544
|
# resp.jobs[0].container.network_interfaces[0].private_ipv_4_address #=> String
|
1481
1545
|
# resp.jobs[0].container.resource_requirements #=> Array
|
1482
1546
|
# resp.jobs[0].container.resource_requirements[0].value #=> String
|
1483
|
-
# resp.jobs[0].container.resource_requirements[0].type #=> String, one of "GPU"
|
1547
|
+
# resp.jobs[0].container.resource_requirements[0].type #=> String, one of "GPU", "VCPU", "MEMORY"
|
1484
1548
|
# resp.jobs[0].container.linux_parameters.devices #=> Array
|
1485
1549
|
# resp.jobs[0].container.linux_parameters.devices[0].host_path #=> String
|
1486
1550
|
# resp.jobs[0].container.linux_parameters.devices[0].container_path #=> String
|
@@ -1504,6 +1568,8 @@ module Aws::Batch
|
|
1504
1568
|
# resp.jobs[0].container.secrets #=> Array
|
1505
1569
|
# resp.jobs[0].container.secrets[0].name #=> String
|
1506
1570
|
# resp.jobs[0].container.secrets[0].value_from #=> String
|
1571
|
+
# resp.jobs[0].container.network_configuration.assign_public_ip #=> String, one of "ENABLED", "DISABLED"
|
1572
|
+
# resp.jobs[0].container.fargate_platform_configuration.platform_version #=> String
|
1507
1573
|
# resp.jobs[0].node_details.node_index #=> Integer
|
1508
1574
|
# resp.jobs[0].node_details.is_main_node #=> Boolean
|
1509
1575
|
# resp.jobs[0].node_properties.num_nodes #=> Integer
|
@@ -1537,7 +1603,7 @@ module Aws::Batch
|
|
1537
1603
|
# resp.jobs[0].node_properties.node_range_properties[0].container.instance_type #=> String
|
1538
1604
|
# resp.jobs[0].node_properties.node_range_properties[0].container.resource_requirements #=> Array
|
1539
1605
|
# resp.jobs[0].node_properties.node_range_properties[0].container.resource_requirements[0].value #=> String
|
1540
|
-
# resp.jobs[0].node_properties.node_range_properties[0].container.resource_requirements[0].type #=> String, one of "GPU"
|
1606
|
+
# resp.jobs[0].node_properties.node_range_properties[0].container.resource_requirements[0].type #=> String, one of "GPU", "VCPU", "MEMORY"
|
1541
1607
|
# resp.jobs[0].node_properties.node_range_properties[0].container.linux_parameters.devices #=> Array
|
1542
1608
|
# resp.jobs[0].node_properties.node_range_properties[0].container.linux_parameters.devices[0].host_path #=> String
|
1543
1609
|
# resp.jobs[0].node_properties.node_range_properties[0].container.linux_parameters.devices[0].container_path #=> String
|
@@ -1561,6 +1627,8 @@ module Aws::Batch
|
|
1561
1627
|
# resp.jobs[0].node_properties.node_range_properties[0].container.secrets #=> Array
|
1562
1628
|
# resp.jobs[0].node_properties.node_range_properties[0].container.secrets[0].name #=> String
|
1563
1629
|
# resp.jobs[0].node_properties.node_range_properties[0].container.secrets[0].value_from #=> String
|
1630
|
+
# resp.jobs[0].node_properties.node_range_properties[0].container.network_configuration.assign_public_ip #=> String, one of "ENABLED", "DISABLED"
|
1631
|
+
# resp.jobs[0].node_properties.node_range_properties[0].container.fargate_platform_configuration.platform_version #=> String
|
1564
1632
|
# resp.jobs[0].array_properties.status_summary #=> Hash
|
1565
1633
|
# resp.jobs[0].array_properties.status_summary["String"] #=> Integer
|
1566
1634
|
# resp.jobs[0].array_properties.size #=> Integer
|
@@ -1568,6 +1636,9 @@ module Aws::Batch
|
|
1568
1636
|
# resp.jobs[0].timeout.attempt_duration_seconds #=> Integer
|
1569
1637
|
# resp.jobs[0].tags #=> Hash
|
1570
1638
|
# resp.jobs[0].tags["TagKey"] #=> String
|
1639
|
+
# resp.jobs[0].propagate_tags #=> Boolean
|
1640
|
+
# resp.jobs[0].platform_capabilities #=> Array
|
1641
|
+
# resp.jobs[0].platform_capabilities[0] #=> String, one of "EC2", "FARGATE"
|
1571
1642
|
#
|
1572
1643
|
# @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/DescribeJobs AWS API Documentation
|
1573
1644
|
#
|
@@ -1580,21 +1651,21 @@ module Aws::Batch
|
|
1580
1651
|
|
1581
1652
|
# Returns a list of AWS Batch jobs.
|
1582
1653
|
#
|
1583
|
-
# You must specify only one of the following:
|
1654
|
+
# You must specify only one of the following items:
|
1584
1655
|
#
|
1585
|
-
# *
|
1656
|
+
# * A job queue ID to return a list of jobs in that job queue
|
1586
1657
|
#
|
1587
|
-
# *
|
1658
|
+
# * A multi-node parallel job ID to return a list of that job's nodes
|
1588
1659
|
#
|
1589
|
-
# *
|
1660
|
+
# * An array job ID to return a list of that job's children
|
1590
1661
|
#
|
1591
1662
|
# You can filter the results by job status with the `jobStatus`
|
1592
|
-
# parameter. If you
|
1663
|
+
# parameter. If you don't specify a status, only `RUNNING` jobs are
|
1593
1664
|
# returned.
|
1594
1665
|
#
|
1595
1666
|
# @option params [String] :job_queue
|
1596
|
-
# The name or full Amazon Resource Name (ARN) of the job queue
|
1597
|
-
#
|
1667
|
+
# The name or full Amazon Resource Name (ARN) of the job queue used to
|
1668
|
+
# list jobs.
|
1598
1669
|
#
|
1599
1670
|
# @option params [String] :array_job_id
|
1600
1671
|
# The job ID for an array job. Specifying an array job ID with this
|
@@ -1606,8 +1677,8 @@ module Aws::Batch
|
|
1606
1677
|
# associated with the specified job.
|
1607
1678
|
#
|
1608
1679
|
# @option params [String] :job_status
|
1609
|
-
# The job status
|
1610
|
-
#
|
1680
|
+
# The job status used to filter jobs in the specified queue. If you
|
1681
|
+
# don't specify a status, only `RUNNING` jobs are returned.
|
1611
1682
|
#
|
1612
1683
|
# @option params [Integer] :max_results
|
1613
1684
|
# The maximum number of results returned by `ListJobs` in paginated
|
@@ -1616,7 +1687,7 @@ module Aws::Batch
|
|
1616
1687
|
# response element. The remaining results of the initial request can be
|
1617
1688
|
# seen by sending another `ListJobs` request with the returned
|
1618
1689
|
# `nextToken` value. This value can be between 1 and 100. If this
|
1619
|
-
# parameter
|
1690
|
+
# parameter isn't used, then `ListJobs` returns up to 100 results and a
|
1620
1691
|
# `nextToken` value if applicable.
|
1621
1692
|
#
|
1622
1693
|
# @option params [String] :next_token
|
@@ -1626,7 +1697,7 @@ module Aws::Batch
|
|
1626
1697
|
# results that returned the `nextToken` value. This value is `null` when
|
1627
1698
|
# there are no more results to return.
|
1628
1699
|
#
|
1629
|
-
# <note markdown="1"> This token should be treated as an opaque identifier that
|
1700
|
+
# <note markdown="1"> This token should be treated as an opaque identifier that's only used
|
1630
1701
|
# to retrieve the next items in a list and not for other programmatic
|
1631
1702
|
# purposes.
|
1632
1703
|
#
|
@@ -1717,14 +1788,14 @@ module Aws::Batch
|
|
1717
1788
|
req.send_request(options)
|
1718
1789
|
end
|
1719
1790
|
|
1720
|
-
#
|
1791
|
+
# Lists the tags for an AWS Batch resource. AWS Batch resources that
|
1721
1792
|
# support tags are compute environments, jobs, job definitions, and job
|
1722
1793
|
# queues. ARNs for child jobs of array and multi-node parallel (MNP)
|
1723
1794
|
# jobs are not supported.
|
1724
1795
|
#
|
1725
1796
|
# @option params [required, String] :resource_arn
|
1726
|
-
# The Amazon Resource Name (ARN) that identifies the resource
|
1727
|
-
#
|
1797
|
+
# The Amazon Resource Name (ARN) that identifies the resource that tags
|
1798
|
+
# are listed for. AWS Batch resources that support tags are compute
|
1728
1799
|
# environments, jobs, job definitions, and job queues. ARNs for child
|
1729
1800
|
# jobs of array and multi-node parallel (MNP) jobs are not supported.
|
1730
1801
|
#
|
@@ -1778,7 +1849,18 @@ module Aws::Batch
|
|
1778
1849
|
# allowed.
|
1779
1850
|
#
|
1780
1851
|
# @option params [required, String] :type
|
1781
|
-
# The type of job definition.
|
1852
|
+
# The type of job definition. For more information about multi-node
|
1853
|
+
# parallel jobs, see [Creating a multi-node parallel job definition][1]
|
1854
|
+
# in the *AWS Batch User Guide*.
|
1855
|
+
#
|
1856
|
+
# <note markdown="1"> If the job is run on Fargate resources, then `multinode` isn't
|
1857
|
+
# supported.
|
1858
|
+
#
|
1859
|
+
# </note>
|
1860
|
+
#
|
1861
|
+
#
|
1862
|
+
#
|
1863
|
+
# [1]: https://docs.aws.amazon.com/batch/latest/userguide/multi-node-job-def.html
|
1782
1864
|
#
|
1783
1865
|
# @option params [Hash<String,String>] :parameters
|
1784
1866
|
# Default parameter substitution placeholders to set in the job
|
@@ -1792,6 +1874,11 @@ module Aws::Batch
|
|
1792
1874
|
# `container`, then you must specify either `containerProperties` or
|
1793
1875
|
# `nodeProperties`.
|
1794
1876
|
#
|
1877
|
+
# <note markdown="1"> If the job runs on Fargate resources, then you must not specify
|
1878
|
+
# `nodeProperties`; use only `containerProperties`.
|
1879
|
+
#
|
1880
|
+
# </note>
|
1881
|
+
#
|
1795
1882
|
# @option params [Types::NodeProperties] :node_properties
|
1796
1883
|
# An object with various properties specific to multi-node parallel
|
1797
1884
|
# jobs. If you specify node properties for a job, it becomes a
|
@@ -1800,39 +1887,57 @@ module Aws::Batch
|
|
1800
1887
|
# definition's `type` parameter is `container`, then you must specify
|
1801
1888
|
# either `containerProperties` or `nodeProperties`.
|
1802
1889
|
#
|
1890
|
+
# <note markdown="1"> If the job runs on Fargate resources, then you must not specify
|
1891
|
+
# `nodeProperties`; use `containerProperties` instead.
|
1892
|
+
#
|
1893
|
+
# </note>
|
1894
|
+
#
|
1803
1895
|
#
|
1804
1896
|
#
|
1805
1897
|
# [1]: https://docs.aws.amazon.com/batch/latest/userguide/multi-node-parallel-jobs.html
|
1806
1898
|
#
|
1807
1899
|
# @option params [Types::RetryStrategy] :retry_strategy
|
1808
1900
|
# The retry strategy to use for failed jobs that are submitted with this
|
1809
|
-
# job definition. Any retry strategy that
|
1901
|
+
# job definition. Any retry strategy that's specified during a
|
1810
1902
|
# SubmitJob operation overrides the retry strategy defined here. If a
|
1811
|
-
# job is terminated due to a timeout, it
|
1903
|
+
# job is terminated due to a timeout, it isn't retried.
|
1904
|
+
#
|
1905
|
+
# @option params [Boolean] :propagate_tags
|
1906
|
+
# Specifies whether to propagate the tags from the job or job definition
|
1907
|
+
# to the corresponding Amazon ECS task. If no value is specified, the
|
1908
|
+
# tags are not propagated. Tags can only be propagated to the tasks
|
1909
|
+
# during task creation. For tags with the same name, job tags are given
|
1910
|
+
# priority over job definitions tags. If the total number of combined
|
1911
|
+
# tags from the job and job definition is over 50, the job is moved to
|
1912
|
+
# the `FAILED` state.
|
1812
1913
|
#
|
1813
1914
|
# @option params [Types::JobTimeout] :timeout
|
1814
1915
|
# The timeout configuration for jobs that are submitted with this job
|
1815
1916
|
# definition, after which AWS Batch terminates your jobs if they have
|
1816
|
-
# not finished. If a job is terminated due to a timeout, it
|
1917
|
+
# not finished. If a job is terminated due to a timeout, it isn't
|
1817
1918
|
# retried. The minimum value for the timeout is 60 seconds. Any timeout
|
1818
|
-
# configuration that
|
1919
|
+
# configuration that's specified during a SubmitJob operation overrides
|
1819
1920
|
# the timeout configuration defined here. For more information, see [Job
|
1820
|
-
# Timeouts][1] in the *
|
1821
|
-
# Guide*.
|
1921
|
+
# Timeouts][1] in the *AWS Batch User Guide*.
|
1822
1922
|
#
|
1823
1923
|
#
|
1824
1924
|
#
|
1825
|
-
# [1]: https://docs.aws.amazon.com/
|
1925
|
+
# [1]: https://docs.aws.amazon.com/batch/latest/userguide/job_timeouts.html
|
1826
1926
|
#
|
1827
1927
|
# @option params [Hash<String,String>] :tags
|
1828
1928
|
# The tags that you apply to the job definition to help you categorize
|
1829
1929
|
# and organize your resources. Each tag consists of a key and an
|
1830
1930
|
# optional value. For more information, see [Tagging AWS Resources][1]
|
1831
|
-
# in *AWS
|
1931
|
+
# in *AWS Batch User Guide*.
|
1832
1932
|
#
|
1833
1933
|
#
|
1834
1934
|
#
|
1835
|
-
# [1]: https://docs.aws.amazon.com/
|
1935
|
+
# [1]: https://docs.aws.amazon.com/batch/latest/userguide/using-tags.html
|
1936
|
+
#
|
1937
|
+
# @option params [Array<String>] :platform_capabilities
|
1938
|
+
# The platform capabilities required by the job definition. If no value
|
1939
|
+
# is specified, it defaults to `EC2`. To run the job on Fargate
|
1940
|
+
# resources, specify `FARGATE`.
|
1836
1941
|
#
|
1837
1942
|
# @return [Types::RegisterJobDefinitionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1838
1943
|
#
|
@@ -1945,7 +2050,7 @@ module Aws::Batch
|
|
1945
2050
|
# resource_requirements: [
|
1946
2051
|
# {
|
1947
2052
|
# value: "String", # required
|
1948
|
-
# type: "GPU", # required, accepts GPU
|
2053
|
+
# type: "GPU", # required, accepts GPU, VCPU, MEMORY
|
1949
2054
|
# },
|
1950
2055
|
# ],
|
1951
2056
|
# linux_parameters: {
|
@@ -1986,6 +2091,12 @@ module Aws::Batch
|
|
1986
2091
|
# value_from: "String", # required
|
1987
2092
|
# },
|
1988
2093
|
# ],
|
2094
|
+
# network_configuration: {
|
2095
|
+
# assign_public_ip: "ENABLED", # accepts ENABLED, DISABLED
|
2096
|
+
# },
|
2097
|
+
# fargate_platform_configuration: {
|
2098
|
+
# platform_version: "String",
|
2099
|
+
# },
|
1989
2100
|
# },
|
1990
2101
|
# node_properties: {
|
1991
2102
|
# num_nodes: 1, # required
|
@@ -2035,7 +2146,7 @@ module Aws::Batch
|
|
2035
2146
|
# resource_requirements: [
|
2036
2147
|
# {
|
2037
2148
|
# value: "String", # required
|
2038
|
-
# type: "GPU", # required, accepts GPU
|
2149
|
+
# type: "GPU", # required, accepts GPU, VCPU, MEMORY
|
2039
2150
|
# },
|
2040
2151
|
# ],
|
2041
2152
|
# linux_parameters: {
|
@@ -2076,19 +2187,35 @@ module Aws::Batch
|
|
2076
2187
|
# value_from: "String", # required
|
2077
2188
|
# },
|
2078
2189
|
# ],
|
2190
|
+
# network_configuration: {
|
2191
|
+
# assign_public_ip: "ENABLED", # accepts ENABLED, DISABLED
|
2192
|
+
# },
|
2193
|
+
# fargate_platform_configuration: {
|
2194
|
+
# platform_version: "String",
|
2195
|
+
# },
|
2079
2196
|
# },
|
2080
2197
|
# },
|
2081
2198
|
# ],
|
2082
2199
|
# },
|
2083
2200
|
# retry_strategy: {
|
2084
2201
|
# attempts: 1,
|
2202
|
+
# evaluate_on_exit: [
|
2203
|
+
# {
|
2204
|
+
# on_status_reason: "String",
|
2205
|
+
# on_reason: "String",
|
2206
|
+
# on_exit_code: "String",
|
2207
|
+
# action: "RETRY", # required, accepts RETRY, EXIT
|
2208
|
+
# },
|
2209
|
+
# ],
|
2085
2210
|
# },
|
2211
|
+
# propagate_tags: false,
|
2086
2212
|
# timeout: {
|
2087
2213
|
# attempt_duration_seconds: 1,
|
2088
2214
|
# },
|
2089
2215
|
# tags: {
|
2090
2216
|
# "TagKey" => "TagValue",
|
2091
2217
|
# },
|
2218
|
+
# platform_capabilities: ["EC2"], # accepts EC2, FARGATE
|
2092
2219
|
# })
|
2093
2220
|
#
|
2094
2221
|
# @example Response structure
|
@@ -2109,6 +2236,10 @@ module Aws::Batch
|
|
2109
2236
|
# Submits an AWS Batch job from a job definition. Parameters specified
|
2110
2237
|
# during SubmitJob override parameters defined in the job definition.
|
2111
2238
|
#
|
2239
|
+
# Jobs run on Fargate resources don't run for more than 14 days. After
|
2240
|
+
# 14 days, the Fargate resources might no longer be available and the
|
2241
|
+
# job is terminated.
|
2242
|
+
#
|
2112
2243
|
# @option params [required, String] :job_name
|
2113
2244
|
# The name of the job. The first character must be alphanumeric, and up
|
2114
2245
|
# to 128 letters (uppercase and lowercase), numbers, hyphens, and
|
@@ -2154,7 +2285,7 @@ module Aws::Batch
|
|
2154
2285
|
# A list of container overrides in JSON format that specify the name of
|
2155
2286
|
# a container in the specified job definition and the overrides it
|
2156
2287
|
# should receive. You can override the default command for a container
|
2157
|
-
# (that
|
2288
|
+
# (that's specified in the job definition or the Docker image) with a
|
2158
2289
|
# `command` override. You can also override existing environment
|
2159
2290
|
# variables (that are specified in the job definition or Docker image)
|
2160
2291
|
# on a container or add new environment variables to it with an
|
@@ -2164,16 +2295,31 @@ module Aws::Batch
|
|
2164
2295
|
# A list of node overrides in JSON format that specify the node range to
|
2165
2296
|
# target and the container overrides for that node range.
|
2166
2297
|
#
|
2298
|
+
# <note markdown="1"> This parameter isn't applicable to jobs running on Fargate resources;
|
2299
|
+
# use `containerOverrides` instead.
|
2300
|
+
#
|
2301
|
+
# </note>
|
2302
|
+
#
|
2167
2303
|
# @option params [Types::RetryStrategy] :retry_strategy
|
2168
2304
|
# The retry strategy to use for failed jobs from this SubmitJob
|
2169
2305
|
# operation. When a retry strategy is specified here, it overrides the
|
2170
2306
|
# retry strategy defined in the job definition.
|
2171
2307
|
#
|
2308
|
+
# @option params [Boolean] :propagate_tags
|
2309
|
+
# Specifies whether to propagate the tags from the job or job definition
|
2310
|
+
# to the corresponding Amazon ECS task. If no value is specified, the
|
2311
|
+
# tags aren't propagated. Tags can only be propagated to the tasks
|
2312
|
+
# during task creation. For tags with the same name, job tags are given
|
2313
|
+
# priority over job definitions tags. If the total number of combined
|
2314
|
+
# tags from the job and job definition is over 50, the job is moved to
|
2315
|
+
# the `FAILED` state. When specified, this overrides the tag propagation
|
2316
|
+
# setting in the job definition.
|
2317
|
+
#
|
2172
2318
|
# @option params [Types::JobTimeout] :timeout
|
2173
2319
|
# The timeout configuration for this SubmitJob operation. You can
|
2174
2320
|
# specify a timeout duration after which AWS Batch terminates your jobs
|
2175
|
-
# if they
|
2176
|
-
#
|
2321
|
+
# if they haven't finished. If a job is terminated due to a timeout, it
|
2322
|
+
# isn't retried. The minimum value for the timeout is 60 seconds. This
|
2177
2323
|
# configuration overrides any timeout configuration specified in the job
|
2178
2324
|
# definition. For array jobs, child jobs have the same timeout
|
2179
2325
|
# configuration as the parent job. For more information, see [Job
|
@@ -2249,7 +2395,7 @@ module Aws::Batch
|
|
2249
2395
|
# resource_requirements: [
|
2250
2396
|
# {
|
2251
2397
|
# value: "String", # required
|
2252
|
-
# type: "GPU", # required, accepts GPU
|
2398
|
+
# type: "GPU", # required, accepts GPU, VCPU, MEMORY
|
2253
2399
|
# },
|
2254
2400
|
# ],
|
2255
2401
|
# },
|
@@ -2272,7 +2418,7 @@ module Aws::Batch
|
|
2272
2418
|
# resource_requirements: [
|
2273
2419
|
# {
|
2274
2420
|
# value: "String", # required
|
2275
|
-
# type: "GPU", # required, accepts GPU
|
2421
|
+
# type: "GPU", # required, accepts GPU, VCPU, MEMORY
|
2276
2422
|
# },
|
2277
2423
|
# ],
|
2278
2424
|
# },
|
@@ -2281,7 +2427,16 @@ module Aws::Batch
|
|
2281
2427
|
# },
|
2282
2428
|
# retry_strategy: {
|
2283
2429
|
# attempts: 1,
|
2430
|
+
# evaluate_on_exit: [
|
2431
|
+
# {
|
2432
|
+
# on_status_reason: "String",
|
2433
|
+
# on_reason: "String",
|
2434
|
+
# on_exit_code: "String",
|
2435
|
+
# action: "RETRY", # required, accepts RETRY, EXIT
|
2436
|
+
# },
|
2437
|
+
# ],
|
2284
2438
|
# },
|
2439
|
+
# propagate_tags: false,
|
2285
2440
|
# timeout: {
|
2286
2441
|
# attempt_duration_seconds: 1,
|
2287
2442
|
# },
|
@@ -2306,15 +2461,15 @@ module Aws::Batch
|
|
2306
2461
|
end
|
2307
2462
|
|
2308
2463
|
# Associates the specified tags to a resource with the specified
|
2309
|
-
# `resourceArn`. If existing tags on a resource
|
2310
|
-
# request parameters, they
|
2464
|
+
# `resourceArn`. If existing tags on a resource aren't specified in the
|
2465
|
+
# request parameters, they aren't changed. When a resource is deleted,
|
2311
2466
|
# the tags associated with that resource are deleted as well. AWS Batch
|
2312
2467
|
# resources that support tags are compute environments, jobs, job
|
2313
2468
|
# definitions, and job queues. ARNs for child jobs of array and
|
2314
2469
|
# multi-node parallel (MNP) jobs are not supported.
|
2315
2470
|
#
|
2316
2471
|
# @option params [required, String] :resource_arn
|
2317
|
-
# The Amazon Resource Name (ARN) of the resource
|
2472
|
+
# The Amazon Resource Name (ARN) of the resource that tags are added to.
|
2318
2473
|
# AWS Batch resources that support tags are compute environments, jobs,
|
2319
2474
|
# job definitions, and job queues. ARNs for child jobs of array and
|
2320
2475
|
# multi-node parallel (MNP) jobs are not supported.
|
@@ -2466,27 +2621,50 @@ module Aws::Batch
|
|
2466
2621
|
# `ENABLED` state can accept jobs from a queue and scale in or out
|
2467
2622
|
# automatically based on the workload demand of its associated queues.
|
2468
2623
|
#
|
2624
|
+
# If the state is `ENABLED`, then the AWS Batch scheduler can attempt to
|
2625
|
+
# place jobs from an associated job queue on the compute resources
|
2626
|
+
# within the environment. If the compute environment is managed, then it
|
2627
|
+
# can scale its instances out or in automatically, based on the job
|
2628
|
+
# queue demand.
|
2629
|
+
#
|
2630
|
+
# If the state is `DISABLED`, then the AWS Batch scheduler doesn't
|
2631
|
+
# attempt to place jobs within the environment. Jobs in a `STARTING` or
|
2632
|
+
# `RUNNING` state continue to progress normally. Managed compute
|
2633
|
+
# environments in the `DISABLED` state don't scale out. However, they
|
2634
|
+
# scale in to `minvCpus` value after instances become idle.
|
2635
|
+
#
|
2469
2636
|
# @option params [Types::ComputeResourceUpdate] :compute_resources
|
2470
2637
|
# Details of the compute resources managed by the compute environment.
|
2471
|
-
# Required for a managed compute environment.
|
2638
|
+
# Required for a managed compute environment. For more information, see
|
2639
|
+
# [Compute Environments][1] in the *AWS Batch User Guide*.
|
2640
|
+
#
|
2641
|
+
#
|
2642
|
+
#
|
2643
|
+
# [1]: https://docs.aws.amazon.com/batch/latest/userguide/compute_environments.html
|
2472
2644
|
#
|
2473
2645
|
# @option params [String] :service_role
|
2474
2646
|
# The full Amazon Resource Name (ARN) of the IAM role that allows AWS
|
2475
|
-
# Batch to make calls to other AWS services on your behalf.
|
2647
|
+
# Batch to make calls to other AWS services on your behalf. For more
|
2648
|
+
# information, see [AWS Batch service IAM role][1] in the *AWS Batch
|
2649
|
+
# User Guide*.
|
2476
2650
|
#
|
2477
2651
|
# If your specified role has a path other than `/`, then you must either
|
2478
2652
|
# specify the full role ARN (this is recommended) or prefix the role
|
2479
2653
|
# name with the path.
|
2480
2654
|
#
|
2481
|
-
# <note markdown="1"> Depending on how you created your AWS Batch service role, its ARN
|
2482
|
-
# contain the `service-role` path prefix. When you only specify
|
2483
|
-
# of the service role, AWS Batch assumes that your ARN does not
|
2484
|
-
# `service-role` path prefix. Because of this, we recommend that
|
2485
|
-
# specify the full ARN of your service role when you create compute
|
2655
|
+
# <note markdown="1"> Depending on how you created your AWS Batch service role, its ARN
|
2656
|
+
# might contain the `service-role` path prefix. When you only specify
|
2657
|
+
# the name of the service role, AWS Batch assumes that your ARN does not
|
2658
|
+
# use the `service-role` path prefix. Because of this, we recommend that
|
2659
|
+
# you specify the full ARN of your service role when you create compute
|
2486
2660
|
# environments.
|
2487
2661
|
#
|
2488
2662
|
# </note>
|
2489
2663
|
#
|
2664
|
+
#
|
2665
|
+
#
|
2666
|
+
# [1]: https://docs.aws.amazon.com/batch/latest/userguide/service_IAM_role.html
|
2667
|
+
#
|
2490
2668
|
# @return [Types::UpdateComputeEnvironmentResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2491
2669
|
#
|
2492
2670
|
# * {Types::UpdateComputeEnvironmentResponse#compute_environment_name #compute_environment_name} => String
|
@@ -2517,6 +2695,8 @@ module Aws::Batch
|
|
2517
2695
|
# minv_cpus: 1,
|
2518
2696
|
# maxv_cpus: 1,
|
2519
2697
|
# desiredv_cpus: 1,
|
2698
|
+
# subnets: ["String"],
|
2699
|
+
# security_group_ids: ["String"],
|
2520
2700
|
# },
|
2521
2701
|
# service_role: "String",
|
2522
2702
|
# })
|
@@ -2552,13 +2732,25 @@ module Aws::Batch
|
|
2552
2732
|
# when associated with the same compute environment. Priority is
|
2553
2733
|
# determined in descending order, for example, a job queue with a
|
2554
2734
|
# priority value of `10` is given scheduling preference over a job queue
|
2555
|
-
# with a priority value of `1`.
|
2735
|
+
# with a priority value of `1`. All of the compute environments must be
|
2736
|
+
# either EC2 (`EC2` or `SPOT`) or Fargate (`FARGATE` or `FARGATE_SPOT`);
|
2737
|
+
# EC2 and Fargate compute environments cannot be mixed.
|
2556
2738
|
#
|
2557
2739
|
# @option params [Array<Types::ComputeEnvironmentOrder>] :compute_environment_order
|
2558
2740
|
# Details the set of compute environments mapped to a job queue and
|
2559
2741
|
# their order relative to each other. This is one of the parameters used
|
2560
|
-
# by the job scheduler to determine which compute environment should
|
2561
|
-
#
|
2742
|
+
# by the job scheduler to determine which compute environment should run
|
2743
|
+
# a given job. Compute environments must be in the `VALID` state before
|
2744
|
+
# you can associate them with a job queue. All of the compute
|
2745
|
+
# environments must be either EC2 (`EC2` or `SPOT`) or Fargate
|
2746
|
+
# (`FARGATE` or `FARGATE_SPOT`); EC2 and Fargate compute environments
|
2747
|
+
# can't be mixed.
|
2748
|
+
#
|
2749
|
+
# <note markdown="1"> All compute environments that are associated with a job queue must
|
2750
|
+
# share the same architecture. AWS Batch doesn't support mixing compute
|
2751
|
+
# environment architecture types in a single job queue.
|
2752
|
+
#
|
2753
|
+
# </note>
|
2562
2754
|
#
|
2563
2755
|
# @return [Types::UpdateJobQueueResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2564
2756
|
#
|
@@ -2622,7 +2814,7 @@ module Aws::Batch
|
|
2622
2814
|
params: params,
|
2623
2815
|
config: config)
|
2624
2816
|
context[:gem_name] = 'aws-sdk-batch'
|
2625
|
-
context[:gem_version] = '1.
|
2817
|
+
context[:gem_version] = '1.44.0'
|
2626
2818
|
Seahorse::Client::Request.new(handlers, context)
|
2627
2819
|
end
|
2628
2820
|
|