aws-sdk-batch 1.41.0 → 1.46.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +303 -0
- data/LICENSE.txt +202 -0
- data/VERSION +1 -0
- data/lib/aws-sdk-batch.rb +2 -2
- data/lib/aws-sdk-batch/client.rb +324 -152
- data/lib/aws-sdk-batch/client_api.rb +35 -9
- data/lib/aws-sdk-batch/errors.rb +1 -1
- data/lib/aws-sdk-batch/resource.rb +1 -1
- data/lib/aws-sdk-batch/types.rb +1297 -337
- metadata +8 -5
data/VERSION
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
1.46.0
|
data/lib/aws-sdk-batch.rb
CHANGED
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
# WARNING ABOUT GENERATED CODE
|
|
4
4
|
#
|
|
5
5
|
# This file is generated. See the contributing guide for more information:
|
|
6
|
-
# https://github.com/aws/aws-sdk-ruby/blob/
|
|
6
|
+
# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
|
|
7
7
|
#
|
|
8
8
|
# WARNING ABOUT GENERATED CODE
|
|
9
9
|
|
|
@@ -48,6 +48,6 @@ require_relative 'aws-sdk-batch/customizations'
|
|
|
48
48
|
# @!group service
|
|
49
49
|
module Aws::Batch
|
|
50
50
|
|
|
51
|
-
GEM_VERSION = '1.
|
|
51
|
+
GEM_VERSION = '1.46.0'
|
|
52
52
|
|
|
53
53
|
end
|
data/lib/aws-sdk-batch/client.rb
CHANGED
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
# WARNING ABOUT GENERATED CODE
|
|
4
4
|
#
|
|
5
5
|
# This file is generated. See the contributing guide for more information:
|
|
6
|
-
# https://github.com/aws/aws-sdk-ruby/blob/
|
|
6
|
+
# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
|
|
7
7
|
#
|
|
8
8
|
# WARNING ABOUT GENERATED CODE
|
|
9
9
|
|
|
@@ -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`
|
|
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` aren't 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.
|
|
384
|
-
# Spot Instances
|
|
385
|
-
#
|
|
386
|
-
#
|
|
385
|
+
# environment. Either, you can choose to use EC2 On-Demand Instances and
|
|
386
|
+
# EC2 Spot Instances. Or, you can use Fargate and Fargate Spot capacity
|
|
387
|
+
# in 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
|
-
# <note markdown="1"> Multi-node parallel jobs
|
|
391
|
+
# <note markdown="1"> Multi-node parallel jobs aren't 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 can
|
|
399
|
-
# DescribeComputeEnvironments operation to find the Amazon ECS
|
|
400
|
-
# that
|
|
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 AMIs. However,
|
|
398
|
+
# you must verify that each of your AMIs meet 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 created your unmanaged compute environment, you can
|
|
402
|
+
# use the DescribeComputeEnvironments operation to find the Amazon ECS
|
|
403
|
+
# cluster that's associated with it. Then, launch your container
|
|
401
404
|
# instances into that Amazon ECS cluster. For more information, see
|
|
402
|
-
# [Launching an Amazon ECS
|
|
405
|
+
# [Launching an Amazon ECS container instance][3] in the *Amazon Elastic
|
|
403
406
|
# Container Service Developer Guide*.
|
|
404
407
|
#
|
|
405
|
-
# <note markdown="1"> AWS Batch
|
|
406
|
-
# is created
|
|
407
|
-
# ECS
|
|
408
|
-
#
|
|
409
|
-
# security patches) and any additional
|
|
410
|
-
# that you install on the compute
|
|
411
|
-
# AWS Batch jobs
|
|
408
|
+
# <note markdown="1"> AWS Batch doesn't upgrade the AMIs in a compute environment after the
|
|
409
|
+
# environment is created. For example, it doesn't update the AMIs when
|
|
410
|
+
# a newer version of the Amazon ECS optimized AMI is available.
|
|
411
|
+
# Therefore, you're responsible for managing the guest operating system
|
|
412
|
+
# (including its 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,33 +448,61 @@ 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
|
#
|
|
454
471
|
# [1]: https://docs.aws.amazon.com/batch/latest/userguide/compute_environments.html
|
|
455
472
|
#
|
|
456
|
-
# @option params [
|
|
473
|
+
# @option params [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.
|
|
459
|
-
#
|
|
460
|
-
#
|
|
461
|
-
#
|
|
462
|
-
#
|
|
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*.
|
|
478
|
+
#
|
|
479
|
+
# If your account has already created the AWS Batch service-linked role,
|
|
480
|
+
# that role is used by default for your compute environment unless you
|
|
481
|
+
# specify a role here. If the AWS Batch service-linked role does not
|
|
482
|
+
# exist in your account, and no role is specified here, the service will
|
|
483
|
+
# try to create the AWS Batch service-linked role in your account.
|
|
484
|
+
#
|
|
485
|
+
# If your specified role has a path other than `/`, then you must
|
|
486
|
+
# specify either the full role ARN (recommended) or prefix the role name
|
|
487
|
+
# with the path. For example, if a role with the name `bar` has a path
|
|
488
|
+
# of `/foo/` then you would specify `/foo/bar` as the role name. For
|
|
489
|
+
# more information, see [Friendly names and paths][2] in the *IAM User
|
|
490
|
+
# Guide*.
|
|
463
491
|
#
|
|
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
|
|
492
|
+
# <note markdown="1"> Depending on how you created your AWS Batch service role, its ARN
|
|
493
|
+
# might contain the `service-role` path prefix. When you only specify
|
|
494
|
+
# the name of the service role, AWS Batch assumes that your ARN doesn't
|
|
495
|
+
# use the `service-role` path prefix. Because of this, we recommend that
|
|
496
|
+
# you specify the full ARN of your service role when you create compute
|
|
469
497
|
# environments.
|
|
470
498
|
#
|
|
471
499
|
# </note>
|
|
472
500
|
#
|
|
501
|
+
#
|
|
502
|
+
#
|
|
503
|
+
# [1]: https://docs.aws.amazon.com/batch/latest/userguide/service_IAM_role.html
|
|
504
|
+
# [2]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html#identifiers-friendly-names
|
|
505
|
+
#
|
|
473
506
|
# @option params [Hash<String,String>] :tags
|
|
474
507
|
# The tags that you apply to the compute environment to help you
|
|
475
508
|
# categorize and organize your resources. Each tag consists of a key and
|
|
@@ -477,7 +510,7 @@ module Aws::Batch
|
|
|
477
510
|
# Resources][1] in *AWS General Reference*.
|
|
478
511
|
#
|
|
479
512
|
# These tags can be updated or removed using the [TagResource][2] and
|
|
480
|
-
# [UntagResource][3] API operations. These tags
|
|
513
|
+
# [UntagResource][3] API operations. These tags don't propagate to the
|
|
481
514
|
# underlying compute resources.
|
|
482
515
|
#
|
|
483
516
|
#
|
|
@@ -585,17 +618,17 @@ module Aws::Batch
|
|
|
585
618
|
# type: "MANAGED", # required, accepts MANAGED, UNMANAGED
|
|
586
619
|
# state: "ENABLED", # accepts ENABLED, DISABLED
|
|
587
620
|
# compute_resources: {
|
|
588
|
-
# type: "EC2", # required, accepts EC2, SPOT
|
|
621
|
+
# type: "EC2", # required, accepts EC2, SPOT, FARGATE, FARGATE_SPOT
|
|
589
622
|
# allocation_strategy: "BEST_FIT", # accepts BEST_FIT, BEST_FIT_PROGRESSIVE, SPOT_CAPACITY_OPTIMIZED
|
|
590
|
-
# minv_cpus: 1,
|
|
623
|
+
# minv_cpus: 1,
|
|
591
624
|
# maxv_cpus: 1, # required
|
|
592
625
|
# desiredv_cpus: 1,
|
|
593
|
-
# instance_types: ["String"],
|
|
626
|
+
# instance_types: ["String"],
|
|
594
627
|
# image_id: "String",
|
|
595
628
|
# subnets: ["String"], # required
|
|
596
629
|
# security_group_ids: ["String"],
|
|
597
630
|
# ec2_key_pair: "String",
|
|
598
|
-
# instance_role: "String",
|
|
631
|
+
# instance_role: "String",
|
|
599
632
|
# tags: {
|
|
600
633
|
# "String" => "String",
|
|
601
634
|
# },
|
|
@@ -614,7 +647,7 @@ module Aws::Batch
|
|
|
614
647
|
# },
|
|
615
648
|
# ],
|
|
616
649
|
# },
|
|
617
|
-
# service_role: "String",
|
|
650
|
+
# service_role: "String",
|
|
618
651
|
# tags: {
|
|
619
652
|
# "TagKey" => "TagValue",
|
|
620
653
|
# },
|
|
@@ -638,46 +671,57 @@ module Aws::Batch
|
|
|
638
671
|
# associate one or more compute environments to the queue and assign an
|
|
639
672
|
# order of preference for the compute environments.
|
|
640
673
|
#
|
|
641
|
-
# You also set a priority to the job queue that determines the order
|
|
642
|
-
#
|
|
674
|
+
# You also set a priority to the job queue that determines the order
|
|
675
|
+
# that the AWS Batch scheduler places jobs onto its associated compute
|
|
643
676
|
# environments. For example, if a compute environment is associated with
|
|
644
677
|
# more than one job queue, the job queue with a higher priority is given
|
|
645
678
|
# preference for scheduling jobs to that compute environment.
|
|
646
679
|
#
|
|
647
680
|
# @option params [required, String] :job_queue_name
|
|
648
|
-
# The name of the job queue.
|
|
681
|
+
# The name of the job queue. Up to 128 letters (uppercase and
|
|
682
|
+
# lowercase), numbers, and underscores are allowed.
|
|
649
683
|
#
|
|
650
684
|
# @option params [String] :state
|
|
651
685
|
# The state of the job queue. If the job queue state is `ENABLED`, it is
|
|
652
686
|
# able to accept jobs. If the job queue state is `DISABLED`, new jobs
|
|
653
|
-
#
|
|
687
|
+
# can't be added to the queue, but jobs already in the queue can
|
|
654
688
|
# finish.
|
|
655
689
|
#
|
|
656
690
|
# @option params [required, Integer] :priority
|
|
657
691
|
# The priority of the job queue. Job queues with a higher priority (or a
|
|
658
692
|
# higher integer value for the `priority` parameter) are evaluated first
|
|
659
693
|
# when associated with the same compute environment. Priority is
|
|
660
|
-
# determined in descending order
|
|
694
|
+
# determined in descending order. For example, a job queue with a
|
|
661
695
|
# priority value of `10` is given scheduling preference over a job queue
|
|
662
|
-
# with a priority value of `1`.
|
|
696
|
+
# with a priority value of `1`. 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 cannot be mixed.
|
|
663
699
|
#
|
|
664
700
|
# @option params [required, Array<Types::ComputeEnvironmentOrder>] :compute_environment_order
|
|
665
701
|
# The set of compute environments mapped to a job queue and their order
|
|
666
702
|
# 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.
|
|
703
|
+
# determine which compute environment should run a specific job. Compute
|
|
704
|
+
# environments must be in the `VALID` state before you can associate
|
|
705
|
+
# them with a job queue. You can associate up to three compute
|
|
706
|
+
# environments with a job queue. All of the compute environments must be
|
|
707
|
+
# either EC2 (`EC2` or `SPOT`) or Fargate (`FARGATE` or `FARGATE_SPOT`);
|
|
708
|
+
# EC2 and Fargate compute environments can't be mixed.
|
|
709
|
+
#
|
|
710
|
+
# <note markdown="1"> All compute environments that are associated with a job queue must
|
|
711
|
+
# share the same architecture. AWS Batch doesn't support mixing compute
|
|
712
|
+
# environment architecture types in a single job queue.
|
|
713
|
+
#
|
|
714
|
+
# </note>
|
|
671
715
|
#
|
|
672
716
|
# @option params [Hash<String,String>] :tags
|
|
673
717
|
# The tags that you apply to the job queue to help you categorize and
|
|
674
718
|
# organize your resources. Each tag consists of a key and an optional
|
|
675
|
-
# value. For more information, see [Tagging AWS
|
|
676
|
-
#
|
|
719
|
+
# value. For more information, see [Tagging your AWS Batch resources][1]
|
|
720
|
+
# in *AWS Batch User Guide*.
|
|
677
721
|
#
|
|
678
722
|
#
|
|
679
723
|
#
|
|
680
|
-
# [1]: https://docs.aws.amazon.com/
|
|
724
|
+
# [1]: https://docs.aws.amazon.com/batch/latest/userguide/using-tags.html
|
|
681
725
|
#
|
|
682
726
|
# @return [Types::CreateJobQueueResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
683
727
|
#
|
|
@@ -770,7 +814,10 @@ module Aws::Batch
|
|
|
770
814
|
# Before you can delete a compute environment, you must set its state to
|
|
771
815
|
# `DISABLED` with the UpdateComputeEnvironment API operation and
|
|
772
816
|
# disassociate it from any job queues with the UpdateJobQueue API
|
|
773
|
-
# operation.
|
|
817
|
+
# operation. Compute environments that use AWS Fargate resources must
|
|
818
|
+
# terminate all active jobs on that compute environment before deleting
|
|
819
|
+
# the compute environment. If this isn't done, the compute environment
|
|
820
|
+
# enters an invalid state.
|
|
774
821
|
#
|
|
775
822
|
# @option params [required, String] :compute_environment
|
|
776
823
|
# The name or Amazon Resource Name (ARN) of the compute environment to
|
|
@@ -808,9 +855,10 @@ module Aws::Batch
|
|
|
808
855
|
|
|
809
856
|
# Deletes the specified job queue. You must first disable submissions
|
|
810
857
|
# for a queue with the UpdateJobQueue operation. All jobs in the queue
|
|
811
|
-
# are terminated when you delete a job queue.
|
|
858
|
+
# are eventually terminated when you delete a job queue. The jobs are
|
|
859
|
+
# terminated at a rate of about 16 jobs each second.
|
|
812
860
|
#
|
|
813
|
-
# It
|
|
861
|
+
# It's not necessary to disassociate compute environments from a queue
|
|
814
862
|
# before submitting a `DeleteJobQueue` request.
|
|
815
863
|
#
|
|
816
864
|
# @option params [required, String] :job_queue
|
|
@@ -847,7 +895,7 @@ module Aws::Batch
|
|
|
847
895
|
req.send_request(options)
|
|
848
896
|
end
|
|
849
897
|
|
|
850
|
-
# Deregisters an AWS Batch job definition. Job definitions
|
|
898
|
+
# Deregisters an AWS Batch job definition. Job definitions are
|
|
851
899
|
# permanently deleted after 180 days.
|
|
852
900
|
#
|
|
853
901
|
# @option params [required, String] :job_definition
|
|
@@ -886,7 +934,7 @@ module Aws::Batch
|
|
|
886
934
|
|
|
887
935
|
# Describes one or more of your compute environments.
|
|
888
936
|
#
|
|
889
|
-
# If you
|
|
937
|
+
# If you're using an unmanaged compute environment, you can use the
|
|
890
938
|
# `DescribeComputeEnvironment` operation to determine the
|
|
891
939
|
# `ecsClusterArn` that you should launch your Amazon ECS container
|
|
892
940
|
# instances into.
|
|
@@ -903,7 +951,7 @@ module Aws::Batch
|
|
|
903
951
|
# The remaining results of the initial request can be seen by sending
|
|
904
952
|
# another `DescribeComputeEnvironments` request with the returned
|
|
905
953
|
# `nextToken` value. This value can be between 1 and 100. If this
|
|
906
|
-
# parameter
|
|
954
|
+
# parameter isn't used, then `DescribeComputeEnvironments` returns up
|
|
907
955
|
# to 100 results and a `nextToken` value if applicable.
|
|
908
956
|
#
|
|
909
957
|
# @option params [String] :next_token
|
|
@@ -913,7 +961,7 @@ module Aws::Batch
|
|
|
913
961
|
# from the end of the previous results that returned the `nextToken`
|
|
914
962
|
# value. This value is `null` when there are no more results to return.
|
|
915
963
|
#
|
|
916
|
-
# <note markdown="1"> This token should be treated as an opaque identifier that
|
|
964
|
+
# <note markdown="1"> This token should be treated as an opaque identifier that's only used
|
|
917
965
|
# to retrieve the next items in a list and not for other programmatic
|
|
918
966
|
# purposes.
|
|
919
967
|
#
|
|
@@ -995,7 +1043,7 @@ module Aws::Batch
|
|
|
995
1043
|
# resp.compute_environments[0].state #=> String, one of "ENABLED", "DISABLED"
|
|
996
1044
|
# resp.compute_environments[0].status #=> String, one of "CREATING", "UPDATING", "DELETING", "DELETED", "VALID", "INVALID"
|
|
997
1045
|
# resp.compute_environments[0].status_reason #=> String
|
|
998
|
-
# resp.compute_environments[0].compute_resources.type #=> String, one of "EC2", "SPOT"
|
|
1046
|
+
# resp.compute_environments[0].compute_resources.type #=> String, one of "EC2", "SPOT", "FARGATE", "FARGATE_SPOT"
|
|
999
1047
|
# resp.compute_environments[0].compute_resources.allocation_strategy #=> String, one of "BEST_FIT", "BEST_FIT_PROGRESSIVE", "SPOT_CAPACITY_OPTIMIZED"
|
|
1000
1048
|
# resp.compute_environments[0].compute_resources.minv_cpus #=> Integer
|
|
1001
1049
|
# resp.compute_environments[0].compute_resources.maxv_cpus #=> Integer
|
|
@@ -1043,10 +1091,10 @@ module Aws::Batch
|
|
|
1043
1091
|
# The maximum number of results returned by `DescribeJobDefinitions` in
|
|
1044
1092
|
# paginated output. When this parameter is used,
|
|
1045
1093
|
# `DescribeJobDefinitions` only returns `maxResults` results in a single
|
|
1046
|
-
# page
|
|
1047
|
-
#
|
|
1094
|
+
# page and a `nextToken` response element. The remaining results of the
|
|
1095
|
+
# initial request can be seen by sending another
|
|
1048
1096
|
# `DescribeJobDefinitions` request with the returned `nextToken` value.
|
|
1049
|
-
# This value can be between 1 and 100. If this parameter
|
|
1097
|
+
# This value can be between 1 and 100. If this parameter isn't used,
|
|
1050
1098
|
# then `DescribeJobDefinitions` returns up to 100 results and a
|
|
1051
1099
|
# `nextToken` value if applicable.
|
|
1052
1100
|
#
|
|
@@ -1054,7 +1102,7 @@ module Aws::Batch
|
|
|
1054
1102
|
# The name of the job definition to describe.
|
|
1055
1103
|
#
|
|
1056
1104
|
# @option params [String] :status
|
|
1057
|
-
# The status
|
|
1105
|
+
# The status used to filter job definitions.
|
|
1058
1106
|
#
|
|
1059
1107
|
# @option params [String] :next_token
|
|
1060
1108
|
# The `nextToken` value returned from a previous paginated
|
|
@@ -1063,7 +1111,7 @@ module Aws::Batch
|
|
|
1063
1111
|
# from the end of the previous results that returned the `nextToken`
|
|
1064
1112
|
# value. This value is `null` when there are no more results to return.
|
|
1065
1113
|
#
|
|
1066
|
-
# <note markdown="1"> This token should be treated as an opaque identifier that
|
|
1114
|
+
# <note markdown="1"> This token should be treated as an opaque identifier that's only used
|
|
1067
1115
|
# to retrieve the next items in a list and not for other programmatic
|
|
1068
1116
|
# purposes.
|
|
1069
1117
|
#
|
|
@@ -1168,7 +1216,7 @@ module Aws::Batch
|
|
|
1168
1216
|
# resp.job_definitions[0].container_properties.instance_type #=> String
|
|
1169
1217
|
# resp.job_definitions[0].container_properties.resource_requirements #=> Array
|
|
1170
1218
|
# 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"
|
|
1219
|
+
# resp.job_definitions[0].container_properties.resource_requirements[0].type #=> String, one of "GPU", "VCPU", "MEMORY"
|
|
1172
1220
|
# resp.job_definitions[0].container_properties.linux_parameters.devices #=> Array
|
|
1173
1221
|
# resp.job_definitions[0].container_properties.linux_parameters.devices[0].host_path #=> String
|
|
1174
1222
|
# resp.job_definitions[0].container_properties.linux_parameters.devices[0].container_path #=> String
|
|
@@ -1192,6 +1240,8 @@ module Aws::Batch
|
|
|
1192
1240
|
# resp.job_definitions[0].container_properties.secrets #=> Array
|
|
1193
1241
|
# resp.job_definitions[0].container_properties.secrets[0].name #=> String
|
|
1194
1242
|
# resp.job_definitions[0].container_properties.secrets[0].value_from #=> String
|
|
1243
|
+
# resp.job_definitions[0].container_properties.network_configuration.assign_public_ip #=> String, one of "ENABLED", "DISABLED"
|
|
1244
|
+
# resp.job_definitions[0].container_properties.fargate_platform_configuration.platform_version #=> String
|
|
1195
1245
|
# resp.job_definitions[0].timeout.attempt_duration_seconds #=> Integer
|
|
1196
1246
|
# resp.job_definitions[0].node_properties.num_nodes #=> Integer
|
|
1197
1247
|
# resp.job_definitions[0].node_properties.main_node #=> Integer
|
|
@@ -1224,7 +1274,7 @@ module Aws::Batch
|
|
|
1224
1274
|
# resp.job_definitions[0].node_properties.node_range_properties[0].container.instance_type #=> String
|
|
1225
1275
|
# resp.job_definitions[0].node_properties.node_range_properties[0].container.resource_requirements #=> Array
|
|
1226
1276
|
# 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"
|
|
1277
|
+
# resp.job_definitions[0].node_properties.node_range_properties[0].container.resource_requirements[0].type #=> String, one of "GPU", "VCPU", "MEMORY"
|
|
1228
1278
|
# resp.job_definitions[0].node_properties.node_range_properties[0].container.linux_parameters.devices #=> Array
|
|
1229
1279
|
# resp.job_definitions[0].node_properties.node_range_properties[0].container.linux_parameters.devices[0].host_path #=> String
|
|
1230
1280
|
# resp.job_definitions[0].node_properties.node_range_properties[0].container.linux_parameters.devices[0].container_path #=> String
|
|
@@ -1248,8 +1298,13 @@ module Aws::Batch
|
|
|
1248
1298
|
# resp.job_definitions[0].node_properties.node_range_properties[0].container.secrets #=> Array
|
|
1249
1299
|
# resp.job_definitions[0].node_properties.node_range_properties[0].container.secrets[0].name #=> String
|
|
1250
1300
|
# resp.job_definitions[0].node_properties.node_range_properties[0].container.secrets[0].value_from #=> String
|
|
1301
|
+
# resp.job_definitions[0].node_properties.node_range_properties[0].container.network_configuration.assign_public_ip #=> String, one of "ENABLED", "DISABLED"
|
|
1302
|
+
# resp.job_definitions[0].node_properties.node_range_properties[0].container.fargate_platform_configuration.platform_version #=> String
|
|
1251
1303
|
# resp.job_definitions[0].tags #=> Hash
|
|
1252
1304
|
# resp.job_definitions[0].tags["TagKey"] #=> String
|
|
1305
|
+
# resp.job_definitions[0].propagate_tags #=> Boolean
|
|
1306
|
+
# resp.job_definitions[0].platform_capabilities #=> Array
|
|
1307
|
+
# resp.job_definitions[0].platform_capabilities[0] #=> String, one of "EC2", "FARGATE"
|
|
1253
1308
|
# resp.next_token #=> String
|
|
1254
1309
|
#
|
|
1255
1310
|
# @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/DescribeJobDefinitions AWS API Documentation
|
|
@@ -1270,12 +1325,12 @@ module Aws::Batch
|
|
|
1270
1325
|
# @option params [Integer] :max_results
|
|
1271
1326
|
# The maximum number of results returned by `DescribeJobQueues` in
|
|
1272
1327
|
# paginated output. When this parameter is used, `DescribeJobQueues`
|
|
1273
|
-
# only returns `maxResults` results in a single page
|
|
1274
|
-
#
|
|
1275
|
-
#
|
|
1276
|
-
#
|
|
1277
|
-
#
|
|
1278
|
-
#
|
|
1328
|
+
# only returns `maxResults` results in a single page and a `nextToken`
|
|
1329
|
+
# response element. The remaining results of the initial request can be
|
|
1330
|
+
# seen by sending another `DescribeJobQueues` request with the returned
|
|
1331
|
+
# `nextToken` value. This value can be between 1 and 100. If this
|
|
1332
|
+
# parameter isn't used, then `DescribeJobQueues` returns up to 100
|
|
1333
|
+
# results and a `nextToken` value if applicable.
|
|
1279
1334
|
#
|
|
1280
1335
|
# @option params [String] :next_token
|
|
1281
1336
|
# The `nextToken` value returned from a previous paginated
|
|
@@ -1284,7 +1339,7 @@ module Aws::Batch
|
|
|
1284
1339
|
# from the end of the previous results that returned the `nextToken`
|
|
1285
1340
|
# value. This value is `null` when there are no more results to return.
|
|
1286
1341
|
#
|
|
1287
|
-
# <note markdown="1"> This token should be treated as an opaque identifier that
|
|
1342
|
+
# <note markdown="1"> This token should be treated as an opaque identifier that's only used
|
|
1288
1343
|
# to retrieve the next items in a list and not for other programmatic
|
|
1289
1344
|
# purposes.
|
|
1290
1345
|
#
|
|
@@ -1499,7 +1554,7 @@ module Aws::Batch
|
|
|
1499
1554
|
# resp.jobs[0].container.network_interfaces[0].private_ipv_4_address #=> String
|
|
1500
1555
|
# resp.jobs[0].container.resource_requirements #=> Array
|
|
1501
1556
|
# resp.jobs[0].container.resource_requirements[0].value #=> String
|
|
1502
|
-
# resp.jobs[0].container.resource_requirements[0].type #=> String, one of "GPU"
|
|
1557
|
+
# resp.jobs[0].container.resource_requirements[0].type #=> String, one of "GPU", "VCPU", "MEMORY"
|
|
1503
1558
|
# resp.jobs[0].container.linux_parameters.devices #=> Array
|
|
1504
1559
|
# resp.jobs[0].container.linux_parameters.devices[0].host_path #=> String
|
|
1505
1560
|
# resp.jobs[0].container.linux_parameters.devices[0].container_path #=> String
|
|
@@ -1523,6 +1578,8 @@ module Aws::Batch
|
|
|
1523
1578
|
# resp.jobs[0].container.secrets #=> Array
|
|
1524
1579
|
# resp.jobs[0].container.secrets[0].name #=> String
|
|
1525
1580
|
# resp.jobs[0].container.secrets[0].value_from #=> String
|
|
1581
|
+
# resp.jobs[0].container.network_configuration.assign_public_ip #=> String, one of "ENABLED", "DISABLED"
|
|
1582
|
+
# resp.jobs[0].container.fargate_platform_configuration.platform_version #=> String
|
|
1526
1583
|
# resp.jobs[0].node_details.node_index #=> Integer
|
|
1527
1584
|
# resp.jobs[0].node_details.is_main_node #=> Boolean
|
|
1528
1585
|
# resp.jobs[0].node_properties.num_nodes #=> Integer
|
|
@@ -1556,7 +1613,7 @@ module Aws::Batch
|
|
|
1556
1613
|
# resp.jobs[0].node_properties.node_range_properties[0].container.instance_type #=> String
|
|
1557
1614
|
# resp.jobs[0].node_properties.node_range_properties[0].container.resource_requirements #=> Array
|
|
1558
1615
|
# 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"
|
|
1616
|
+
# resp.jobs[0].node_properties.node_range_properties[0].container.resource_requirements[0].type #=> String, one of "GPU", "VCPU", "MEMORY"
|
|
1560
1617
|
# resp.jobs[0].node_properties.node_range_properties[0].container.linux_parameters.devices #=> Array
|
|
1561
1618
|
# resp.jobs[0].node_properties.node_range_properties[0].container.linux_parameters.devices[0].host_path #=> String
|
|
1562
1619
|
# resp.jobs[0].node_properties.node_range_properties[0].container.linux_parameters.devices[0].container_path #=> String
|
|
@@ -1580,6 +1637,8 @@ module Aws::Batch
|
|
|
1580
1637
|
# resp.jobs[0].node_properties.node_range_properties[0].container.secrets #=> Array
|
|
1581
1638
|
# resp.jobs[0].node_properties.node_range_properties[0].container.secrets[0].name #=> String
|
|
1582
1639
|
# resp.jobs[0].node_properties.node_range_properties[0].container.secrets[0].value_from #=> String
|
|
1640
|
+
# resp.jobs[0].node_properties.node_range_properties[0].container.network_configuration.assign_public_ip #=> String, one of "ENABLED", "DISABLED"
|
|
1641
|
+
# resp.jobs[0].node_properties.node_range_properties[0].container.fargate_platform_configuration.platform_version #=> String
|
|
1583
1642
|
# resp.jobs[0].array_properties.status_summary #=> Hash
|
|
1584
1643
|
# resp.jobs[0].array_properties.status_summary["String"] #=> Integer
|
|
1585
1644
|
# resp.jobs[0].array_properties.size #=> Integer
|
|
@@ -1587,6 +1646,9 @@ module Aws::Batch
|
|
|
1587
1646
|
# resp.jobs[0].timeout.attempt_duration_seconds #=> Integer
|
|
1588
1647
|
# resp.jobs[0].tags #=> Hash
|
|
1589
1648
|
# resp.jobs[0].tags["TagKey"] #=> String
|
|
1649
|
+
# resp.jobs[0].propagate_tags #=> Boolean
|
|
1650
|
+
# resp.jobs[0].platform_capabilities #=> Array
|
|
1651
|
+
# resp.jobs[0].platform_capabilities[0] #=> String, one of "EC2", "FARGATE"
|
|
1590
1652
|
#
|
|
1591
1653
|
# @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/DescribeJobs AWS API Documentation
|
|
1592
1654
|
#
|
|
@@ -1599,21 +1661,21 @@ module Aws::Batch
|
|
|
1599
1661
|
|
|
1600
1662
|
# Returns a list of AWS Batch jobs.
|
|
1601
1663
|
#
|
|
1602
|
-
# You must specify only one of the following:
|
|
1664
|
+
# You must specify only one of the following items:
|
|
1603
1665
|
#
|
|
1604
|
-
# *
|
|
1666
|
+
# * A job queue ID to return a list of jobs in that job queue
|
|
1605
1667
|
#
|
|
1606
|
-
# *
|
|
1668
|
+
# * A multi-node parallel job ID to return a list of nodes for that job
|
|
1607
1669
|
#
|
|
1608
|
-
# *
|
|
1670
|
+
# * An array job ID to return a list of the children for that job
|
|
1609
1671
|
#
|
|
1610
1672
|
# You can filter the results by job status with the `jobStatus`
|
|
1611
|
-
# parameter. If you
|
|
1673
|
+
# parameter. If you don't specify a status, only `RUNNING` jobs are
|
|
1612
1674
|
# returned.
|
|
1613
1675
|
#
|
|
1614
1676
|
# @option params [String] :job_queue
|
|
1615
|
-
# The name or full Amazon Resource Name (ARN) of the job queue
|
|
1616
|
-
#
|
|
1677
|
+
# The name or full Amazon Resource Name (ARN) of the job queue used to
|
|
1678
|
+
# list jobs.
|
|
1617
1679
|
#
|
|
1618
1680
|
# @option params [String] :array_job_id
|
|
1619
1681
|
# The job ID for an array job. Specifying an array job ID with this
|
|
@@ -1625,18 +1687,18 @@ module Aws::Batch
|
|
|
1625
1687
|
# associated with the specified job.
|
|
1626
1688
|
#
|
|
1627
1689
|
# @option params [String] :job_status
|
|
1628
|
-
# The job status
|
|
1629
|
-
#
|
|
1690
|
+
# The job status used to filter jobs in the specified queue. If you
|
|
1691
|
+
# don't specify a status, only `RUNNING` jobs are returned.
|
|
1630
1692
|
#
|
|
1631
1693
|
# @option params [Integer] :max_results
|
|
1632
1694
|
# The maximum number of results returned by `ListJobs` in paginated
|
|
1633
1695
|
# output. When this parameter is used, `ListJobs` only returns
|
|
1634
|
-
# `maxResults` results in a single page
|
|
1635
|
-
#
|
|
1636
|
-
#
|
|
1637
|
-
#
|
|
1638
|
-
#
|
|
1639
|
-
#
|
|
1696
|
+
# `maxResults` results in a single page and a `nextToken` response
|
|
1697
|
+
# element. The remaining results of the initial request can be seen by
|
|
1698
|
+
# sending another `ListJobs` request with the returned `nextToken`
|
|
1699
|
+
# value. This value can be between 1 and 100. If this parameter isn't
|
|
1700
|
+
# used, then `ListJobs` returns up to 100 results and a `nextToken`
|
|
1701
|
+
# value if applicable.
|
|
1640
1702
|
#
|
|
1641
1703
|
# @option params [String] :next_token
|
|
1642
1704
|
# The `nextToken` value returned from a previous paginated `ListJobs`
|
|
@@ -1645,7 +1707,7 @@ module Aws::Batch
|
|
|
1645
1707
|
# results that returned the `nextToken` value. This value is `null` when
|
|
1646
1708
|
# there are no more results to return.
|
|
1647
1709
|
#
|
|
1648
|
-
# <note markdown="1"> This token should be treated as an opaque identifier that
|
|
1710
|
+
# <note markdown="1"> This token should be treated as an opaque identifier that's only used
|
|
1649
1711
|
# to retrieve the next items in a list and not for other programmatic
|
|
1650
1712
|
# purposes.
|
|
1651
1713
|
#
|
|
@@ -1736,14 +1798,14 @@ module Aws::Batch
|
|
|
1736
1798
|
req.send_request(options)
|
|
1737
1799
|
end
|
|
1738
1800
|
|
|
1739
|
-
#
|
|
1801
|
+
# Lists the tags for an AWS Batch resource. AWS Batch resources that
|
|
1740
1802
|
# support tags are compute environments, jobs, job definitions, and job
|
|
1741
1803
|
# queues. ARNs for child jobs of array and multi-node parallel (MNP)
|
|
1742
1804
|
# jobs are not supported.
|
|
1743
1805
|
#
|
|
1744
1806
|
# @option params [required, String] :resource_arn
|
|
1745
|
-
# The Amazon Resource Name (ARN) that identifies the resource
|
|
1746
|
-
#
|
|
1807
|
+
# The Amazon Resource Name (ARN) that identifies the resource that tags
|
|
1808
|
+
# are listed for. AWS Batch resources that support tags are compute
|
|
1747
1809
|
# environments, jobs, job definitions, and job queues. ARNs for child
|
|
1748
1810
|
# jobs of array and multi-node parallel (MNP) jobs are not supported.
|
|
1749
1811
|
#
|
|
@@ -1797,7 +1859,18 @@ module Aws::Batch
|
|
|
1797
1859
|
# allowed.
|
|
1798
1860
|
#
|
|
1799
1861
|
# @option params [required, String] :type
|
|
1800
|
-
# The type of job definition.
|
|
1862
|
+
# The type of job definition. For more information about multi-node
|
|
1863
|
+
# parallel jobs, see [Creating a multi-node parallel job definition][1]
|
|
1864
|
+
# in the *AWS Batch User Guide*.
|
|
1865
|
+
#
|
|
1866
|
+
# <note markdown="1"> If the job is run on Fargate resources, then `multinode` isn't
|
|
1867
|
+
# supported.
|
|
1868
|
+
#
|
|
1869
|
+
# </note>
|
|
1870
|
+
#
|
|
1871
|
+
#
|
|
1872
|
+
#
|
|
1873
|
+
# [1]: https://docs.aws.amazon.com/batch/latest/userguide/multi-node-job-def.html
|
|
1801
1874
|
#
|
|
1802
1875
|
# @option params [Hash<String,String>] :parameters
|
|
1803
1876
|
# Default parameter substitution placeholders to set in the job
|
|
@@ -1811,6 +1884,11 @@ module Aws::Batch
|
|
|
1811
1884
|
# `container`, then you must specify either `containerProperties` or
|
|
1812
1885
|
# `nodeProperties`.
|
|
1813
1886
|
#
|
|
1887
|
+
# <note markdown="1"> If the job runs on Fargate resources, then you must not specify
|
|
1888
|
+
# `nodeProperties`; use only `containerProperties`.
|
|
1889
|
+
#
|
|
1890
|
+
# </note>
|
|
1891
|
+
#
|
|
1814
1892
|
# @option params [Types::NodeProperties] :node_properties
|
|
1815
1893
|
# An object with various properties specific to multi-node parallel
|
|
1816
1894
|
# jobs. If you specify node properties for a job, it becomes a
|
|
@@ -1819,39 +1897,57 @@ module Aws::Batch
|
|
|
1819
1897
|
# definition's `type` parameter is `container`, then you must specify
|
|
1820
1898
|
# either `containerProperties` or `nodeProperties`.
|
|
1821
1899
|
#
|
|
1900
|
+
# <note markdown="1"> If the job runs on Fargate resources, then you must not specify
|
|
1901
|
+
# `nodeProperties`; use `containerProperties` instead.
|
|
1902
|
+
#
|
|
1903
|
+
# </note>
|
|
1904
|
+
#
|
|
1822
1905
|
#
|
|
1823
1906
|
#
|
|
1824
1907
|
# [1]: https://docs.aws.amazon.com/batch/latest/userguide/multi-node-parallel-jobs.html
|
|
1825
1908
|
#
|
|
1826
1909
|
# @option params [Types::RetryStrategy] :retry_strategy
|
|
1827
1910
|
# The retry strategy to use for failed jobs that are submitted with this
|
|
1828
|
-
# job definition. Any retry strategy that
|
|
1911
|
+
# job definition. Any retry strategy that's specified during a
|
|
1829
1912
|
# SubmitJob operation overrides the retry strategy defined here. If a
|
|
1830
|
-
# job is terminated due to a timeout, it
|
|
1913
|
+
# job is terminated due to a timeout, it isn't retried.
|
|
1914
|
+
#
|
|
1915
|
+
# @option params [Boolean] :propagate_tags
|
|
1916
|
+
# Specifies whether to propagate the tags from the job or job definition
|
|
1917
|
+
# to the corresponding Amazon ECS task. If no value is specified, the
|
|
1918
|
+
# tags are not propagated. Tags can only be propagated to the tasks
|
|
1919
|
+
# during task creation. For tags with the same name, job tags are given
|
|
1920
|
+
# priority over job definitions tags. If the total number of combined
|
|
1921
|
+
# tags from the job and job definition is over 50, the job is moved to
|
|
1922
|
+
# the `FAILED` state.
|
|
1831
1923
|
#
|
|
1832
1924
|
# @option params [Types::JobTimeout] :timeout
|
|
1833
1925
|
# The timeout configuration for jobs that are submitted with this job
|
|
1834
1926
|
# definition, after which AWS Batch terminates your jobs if they have
|
|
1835
|
-
# not finished. If a job is terminated due to a timeout, it
|
|
1927
|
+
# not finished. If a job is terminated due to a timeout, it isn't
|
|
1836
1928
|
# retried. The minimum value for the timeout is 60 seconds. Any timeout
|
|
1837
|
-
# configuration that
|
|
1929
|
+
# configuration that's specified during a SubmitJob operation overrides
|
|
1838
1930
|
# the timeout configuration defined here. For more information, see [Job
|
|
1839
|
-
# Timeouts][1] in the *
|
|
1840
|
-
# Guide*.
|
|
1931
|
+
# Timeouts][1] in the *AWS Batch User Guide*.
|
|
1841
1932
|
#
|
|
1842
1933
|
#
|
|
1843
1934
|
#
|
|
1844
|
-
# [1]: https://docs.aws.amazon.com/
|
|
1935
|
+
# [1]: https://docs.aws.amazon.com/batch/latest/userguide/job_timeouts.html
|
|
1845
1936
|
#
|
|
1846
1937
|
# @option params [Hash<String,String>] :tags
|
|
1847
1938
|
# The tags that you apply to the job definition to help you categorize
|
|
1848
1939
|
# and organize your resources. Each tag consists of a key and an
|
|
1849
1940
|
# optional value. For more information, see [Tagging AWS Resources][1]
|
|
1850
|
-
# in *AWS
|
|
1941
|
+
# in *AWS Batch User Guide*.
|
|
1851
1942
|
#
|
|
1852
1943
|
#
|
|
1853
1944
|
#
|
|
1854
|
-
# [1]: https://docs.aws.amazon.com/
|
|
1945
|
+
# [1]: https://docs.aws.amazon.com/batch/latest/userguide/using-tags.html
|
|
1946
|
+
#
|
|
1947
|
+
# @option params [Array<String>] :platform_capabilities
|
|
1948
|
+
# The platform capabilities required by the job definition. If no value
|
|
1949
|
+
# is specified, it defaults to `EC2`. To run the job on Fargate
|
|
1950
|
+
# resources, specify `FARGATE`.
|
|
1855
1951
|
#
|
|
1856
1952
|
# @return [Types::RegisterJobDefinitionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
1857
1953
|
#
|
|
@@ -1964,7 +2060,7 @@ module Aws::Batch
|
|
|
1964
2060
|
# resource_requirements: [
|
|
1965
2061
|
# {
|
|
1966
2062
|
# value: "String", # required
|
|
1967
|
-
# type: "GPU", # required, accepts GPU
|
|
2063
|
+
# type: "GPU", # required, accepts GPU, VCPU, MEMORY
|
|
1968
2064
|
# },
|
|
1969
2065
|
# ],
|
|
1970
2066
|
# linux_parameters: {
|
|
@@ -2005,6 +2101,12 @@ module Aws::Batch
|
|
|
2005
2101
|
# value_from: "String", # required
|
|
2006
2102
|
# },
|
|
2007
2103
|
# ],
|
|
2104
|
+
# network_configuration: {
|
|
2105
|
+
# assign_public_ip: "ENABLED", # accepts ENABLED, DISABLED
|
|
2106
|
+
# },
|
|
2107
|
+
# fargate_platform_configuration: {
|
|
2108
|
+
# platform_version: "String",
|
|
2109
|
+
# },
|
|
2008
2110
|
# },
|
|
2009
2111
|
# node_properties: {
|
|
2010
2112
|
# num_nodes: 1, # required
|
|
@@ -2054,7 +2156,7 @@ module Aws::Batch
|
|
|
2054
2156
|
# resource_requirements: [
|
|
2055
2157
|
# {
|
|
2056
2158
|
# value: "String", # required
|
|
2057
|
-
# type: "GPU", # required, accepts GPU
|
|
2159
|
+
# type: "GPU", # required, accepts GPU, VCPU, MEMORY
|
|
2058
2160
|
# },
|
|
2059
2161
|
# ],
|
|
2060
2162
|
# linux_parameters: {
|
|
@@ -2095,6 +2197,12 @@ module Aws::Batch
|
|
|
2095
2197
|
# value_from: "String", # required
|
|
2096
2198
|
# },
|
|
2097
2199
|
# ],
|
|
2200
|
+
# network_configuration: {
|
|
2201
|
+
# assign_public_ip: "ENABLED", # accepts ENABLED, DISABLED
|
|
2202
|
+
# },
|
|
2203
|
+
# fargate_platform_configuration: {
|
|
2204
|
+
# platform_version: "String",
|
|
2205
|
+
# },
|
|
2098
2206
|
# },
|
|
2099
2207
|
# },
|
|
2100
2208
|
# ],
|
|
@@ -2110,12 +2218,14 @@ module Aws::Batch
|
|
|
2110
2218
|
# },
|
|
2111
2219
|
# ],
|
|
2112
2220
|
# },
|
|
2221
|
+
# propagate_tags: false,
|
|
2113
2222
|
# timeout: {
|
|
2114
2223
|
# attempt_duration_seconds: 1,
|
|
2115
2224
|
# },
|
|
2116
2225
|
# tags: {
|
|
2117
2226
|
# "TagKey" => "TagValue",
|
|
2118
2227
|
# },
|
|
2228
|
+
# platform_capabilities: ["EC2"], # accepts EC2, FARGATE
|
|
2119
2229
|
# })
|
|
2120
2230
|
#
|
|
2121
2231
|
# @example Response structure
|
|
@@ -2133,8 +2243,18 @@ module Aws::Batch
|
|
|
2133
2243
|
req.send_request(options)
|
|
2134
2244
|
end
|
|
2135
2245
|
|
|
2136
|
-
# Submits an AWS Batch job from a job definition. Parameters
|
|
2137
|
-
# during SubmitJob override parameters defined in the job
|
|
2246
|
+
# Submits an AWS Batch job from a job definition. Parameters that are
|
|
2247
|
+
# specified during SubmitJob override parameters defined in the job
|
|
2248
|
+
# definition. vCPU and memory requirements that are specified in the
|
|
2249
|
+
# `ResourceRequirements` objects in the job definition are the
|
|
2250
|
+
# exception. They can't be overridden this way using the `memory` and
|
|
2251
|
+
# `vcpus` parameters. Rather, you must specify updates to job definition
|
|
2252
|
+
# parameters in a `ResourceRequirements` object that's included in the
|
|
2253
|
+
# `containerOverrides` parameter.
|
|
2254
|
+
#
|
|
2255
|
+
# Jobs that run on Fargate resources can't be guaranteed to run for
|
|
2256
|
+
# more than 14 days. This is because, after 14 days, Fargate resources
|
|
2257
|
+
# might become unavailable and job might be terminated.
|
|
2138
2258
|
#
|
|
2139
2259
|
# @option params [required, String] :job_name
|
|
2140
2260
|
# The name of the job. The first character must be alphanumeric, and up
|
|
@@ -2142,8 +2262,8 @@ module Aws::Batch
|
|
|
2142
2262
|
# underscores are allowed.
|
|
2143
2263
|
#
|
|
2144
2264
|
# @option params [required, String] :job_queue
|
|
2145
|
-
# The job queue
|
|
2146
|
-
#
|
|
2265
|
+
# The job queue where the job is submitted. You can specify either the
|
|
2266
|
+
# name or the Amazon Resource Name (ARN) of the queue.
|
|
2147
2267
|
#
|
|
2148
2268
|
# @option params [Types::ArrayProperties] :array_properties
|
|
2149
2269
|
# The array properties for the submitted job, such as the size of the
|
|
@@ -2178,29 +2298,43 @@ module Aws::Batch
|
|
|
2178
2298
|
# from the job definition.
|
|
2179
2299
|
#
|
|
2180
2300
|
# @option params [Types::ContainerOverrides] :container_overrides
|
|
2181
|
-
# A list of container overrides in JSON format that specify the name
|
|
2182
|
-
# a container in the specified job definition and the overrides it
|
|
2183
|
-
# should receive. You can override the default command for a container
|
|
2184
|
-
#
|
|
2301
|
+
# A list of container overrides in the JSON format that specify the name
|
|
2302
|
+
# of a container in the specified job definition and the overrides it
|
|
2303
|
+
# should receive. You can override the default command for a container,
|
|
2304
|
+
# which is specified in the job definition or the Docker image, with a
|
|
2185
2305
|
# `command` override. You can also override existing environment
|
|
2186
|
-
# variables
|
|
2187
|
-
#
|
|
2188
|
-
# `environment` override.
|
|
2306
|
+
# variables on a container or add new environment variables to it with
|
|
2307
|
+
# an `environment` override.
|
|
2189
2308
|
#
|
|
2190
2309
|
# @option params [Types::NodeOverrides] :node_overrides
|
|
2191
2310
|
# A list of node overrides in JSON format that specify the node range to
|
|
2192
2311
|
# target and the container overrides for that node range.
|
|
2193
2312
|
#
|
|
2313
|
+
# <note markdown="1"> This parameter isn't applicable to jobs running on Fargate resources;
|
|
2314
|
+
# use `containerOverrides` instead.
|
|
2315
|
+
#
|
|
2316
|
+
# </note>
|
|
2317
|
+
#
|
|
2194
2318
|
# @option params [Types::RetryStrategy] :retry_strategy
|
|
2195
2319
|
# The retry strategy to use for failed jobs from this SubmitJob
|
|
2196
2320
|
# operation. When a retry strategy is specified here, it overrides the
|
|
2197
2321
|
# retry strategy defined in the job definition.
|
|
2198
2322
|
#
|
|
2323
|
+
# @option params [Boolean] :propagate_tags
|
|
2324
|
+
# Specifies whether to propagate the tags from the job or job definition
|
|
2325
|
+
# to the corresponding Amazon ECS task. If no value is specified, the
|
|
2326
|
+
# tags aren't propagated. Tags can only be propagated to the tasks
|
|
2327
|
+
# during task creation. For tags with the same name, job tags are given
|
|
2328
|
+
# priority over job definitions tags. If the total number of combined
|
|
2329
|
+
# tags from the job and job definition is over 50, the job is moved to
|
|
2330
|
+
# the `FAILED` state. When specified, this overrides the tag propagation
|
|
2331
|
+
# setting in the job definition.
|
|
2332
|
+
#
|
|
2199
2333
|
# @option params [Types::JobTimeout] :timeout
|
|
2200
2334
|
# The timeout configuration for this SubmitJob operation. You can
|
|
2201
2335
|
# specify a timeout duration after which AWS Batch terminates your jobs
|
|
2202
|
-
# if they
|
|
2203
|
-
#
|
|
2336
|
+
# if they haven't finished. If a job is terminated due to a timeout, it
|
|
2337
|
+
# isn't retried. The minimum value for the timeout is 60 seconds. This
|
|
2204
2338
|
# configuration overrides any timeout configuration specified in the job
|
|
2205
2339
|
# definition. For array jobs, child jobs have the same timeout
|
|
2206
2340
|
# configuration as the parent job. For more information, see [Job
|
|
@@ -2276,7 +2410,7 @@ module Aws::Batch
|
|
|
2276
2410
|
# resource_requirements: [
|
|
2277
2411
|
# {
|
|
2278
2412
|
# value: "String", # required
|
|
2279
|
-
# type: "GPU", # required, accepts GPU
|
|
2413
|
+
# type: "GPU", # required, accepts GPU, VCPU, MEMORY
|
|
2280
2414
|
# },
|
|
2281
2415
|
# ],
|
|
2282
2416
|
# },
|
|
@@ -2299,7 +2433,7 @@ module Aws::Batch
|
|
|
2299
2433
|
# resource_requirements: [
|
|
2300
2434
|
# {
|
|
2301
2435
|
# value: "String", # required
|
|
2302
|
-
# type: "GPU", # required, accepts GPU
|
|
2436
|
+
# type: "GPU", # required, accepts GPU, VCPU, MEMORY
|
|
2303
2437
|
# },
|
|
2304
2438
|
# ],
|
|
2305
2439
|
# },
|
|
@@ -2317,6 +2451,7 @@ module Aws::Batch
|
|
|
2317
2451
|
# },
|
|
2318
2452
|
# ],
|
|
2319
2453
|
# },
|
|
2454
|
+
# propagate_tags: false,
|
|
2320
2455
|
# timeout: {
|
|
2321
2456
|
# attempt_duration_seconds: 1,
|
|
2322
2457
|
# },
|
|
@@ -2341,15 +2476,15 @@ module Aws::Batch
|
|
|
2341
2476
|
end
|
|
2342
2477
|
|
|
2343
2478
|
# Associates the specified tags to a resource with the specified
|
|
2344
|
-
# `resourceArn`. If existing tags on a resource
|
|
2345
|
-
# request parameters, they
|
|
2479
|
+
# `resourceArn`. If existing tags on a resource aren't specified in the
|
|
2480
|
+
# request parameters, they aren't changed. When a resource is deleted,
|
|
2346
2481
|
# the tags associated with that resource are deleted as well. AWS Batch
|
|
2347
2482
|
# resources that support tags are compute environments, jobs, job
|
|
2348
2483
|
# definitions, and job queues. ARNs for child jobs of array and
|
|
2349
2484
|
# multi-node parallel (MNP) jobs are not supported.
|
|
2350
2485
|
#
|
|
2351
2486
|
# @option params [required, String] :resource_arn
|
|
2352
|
-
# The Amazon Resource Name (ARN) of the resource
|
|
2487
|
+
# The Amazon Resource Name (ARN) of the resource that tags are added to.
|
|
2353
2488
|
# AWS Batch resources that support tags are compute environments, jobs,
|
|
2354
2489
|
# job definitions, and job queues. ARNs for child jobs of array and
|
|
2355
2490
|
# multi-node parallel (MNP) jobs are not supported.
|
|
@@ -2501,27 +2636,50 @@ module Aws::Batch
|
|
|
2501
2636
|
# `ENABLED` state can accept jobs from a queue and scale in or out
|
|
2502
2637
|
# automatically based on the workload demand of its associated queues.
|
|
2503
2638
|
#
|
|
2639
|
+
# If the state is `ENABLED`, then the AWS Batch scheduler can attempt to
|
|
2640
|
+
# place jobs from an associated job queue on the compute resources
|
|
2641
|
+
# within the environment. If the compute environment is managed, then it
|
|
2642
|
+
# can scale its instances out or in automatically, based on the job
|
|
2643
|
+
# queue demand.
|
|
2644
|
+
#
|
|
2645
|
+
# If the state is `DISABLED`, then the AWS Batch scheduler doesn't
|
|
2646
|
+
# attempt to place jobs within the environment. Jobs in a `STARTING` or
|
|
2647
|
+
# `RUNNING` state continue to progress normally. Managed compute
|
|
2648
|
+
# environments in the `DISABLED` state don't scale out. However, they
|
|
2649
|
+
# scale in to `minvCpus` value after instances become idle.
|
|
2650
|
+
#
|
|
2504
2651
|
# @option params [Types::ComputeResourceUpdate] :compute_resources
|
|
2505
2652
|
# Details of the compute resources managed by the compute environment.
|
|
2506
|
-
# Required for a managed compute environment.
|
|
2653
|
+
# Required for a managed compute environment. For more information, see
|
|
2654
|
+
# [Compute Environments][1] in the *AWS Batch User Guide*.
|
|
2655
|
+
#
|
|
2656
|
+
#
|
|
2657
|
+
#
|
|
2658
|
+
# [1]: https://docs.aws.amazon.com/batch/latest/userguide/compute_environments.html
|
|
2507
2659
|
#
|
|
2508
2660
|
# @option params [String] :service_role
|
|
2509
2661
|
# The full Amazon Resource Name (ARN) of the IAM role that allows AWS
|
|
2510
|
-
# Batch to make calls to other AWS services on your behalf.
|
|
2662
|
+
# Batch to make calls to other AWS services on your behalf. For more
|
|
2663
|
+
# information, see [AWS Batch service IAM role][1] in the *AWS Batch
|
|
2664
|
+
# User Guide*.
|
|
2511
2665
|
#
|
|
2512
2666
|
# If your specified role has a path other than `/`, then you must either
|
|
2513
2667
|
# specify the full role ARN (this is recommended) or prefix the role
|
|
2514
2668
|
# name with the path.
|
|
2515
2669
|
#
|
|
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
|
|
2519
|
-
# `service-role` path prefix. Because of this, we recommend that
|
|
2520
|
-
# specify the full ARN of your service role when you create compute
|
|
2670
|
+
# <note markdown="1"> Depending on how you created your AWS Batch service role, its ARN
|
|
2671
|
+
# might contain the `service-role` path prefix. When you only specify
|
|
2672
|
+
# the name of the service role, AWS Batch assumes that your ARN doesn't
|
|
2673
|
+
# use the `service-role` path prefix. Because of this, we recommend that
|
|
2674
|
+
# you specify the full ARN of your service role when you create compute
|
|
2521
2675
|
# environments.
|
|
2522
2676
|
#
|
|
2523
2677
|
# </note>
|
|
2524
2678
|
#
|
|
2679
|
+
#
|
|
2680
|
+
#
|
|
2681
|
+
# [1]: https://docs.aws.amazon.com/batch/latest/userguide/service_IAM_role.html
|
|
2682
|
+
#
|
|
2525
2683
|
# @return [Types::UpdateComputeEnvironmentResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
2526
2684
|
#
|
|
2527
2685
|
# * {Types::UpdateComputeEnvironmentResponse#compute_environment_name #compute_environment_name} => String
|
|
@@ -2552,6 +2710,8 @@ module Aws::Batch
|
|
|
2552
2710
|
# minv_cpus: 1,
|
|
2553
2711
|
# maxv_cpus: 1,
|
|
2554
2712
|
# desiredv_cpus: 1,
|
|
2713
|
+
# subnets: ["String"],
|
|
2714
|
+
# security_group_ids: ["String"],
|
|
2555
2715
|
# },
|
|
2556
2716
|
# service_role: "String",
|
|
2557
2717
|
# })
|
|
@@ -2577,9 +2737,9 @@ module Aws::Batch
|
|
|
2577
2737
|
#
|
|
2578
2738
|
# @option params [String] :state
|
|
2579
2739
|
# Describes the queue's ability to accept new jobs. If the job queue
|
|
2580
|
-
# state is `ENABLED`, it
|
|
2581
|
-
#
|
|
2582
|
-
#
|
|
2740
|
+
# state is `ENABLED`, it can accept jobs. If the job queue state is
|
|
2741
|
+
# `DISABLED`, new jobs can't be added to the queue, but jobs already in
|
|
2742
|
+
# the queue can finish.
|
|
2583
2743
|
#
|
|
2584
2744
|
# @option params [Integer] :priority
|
|
2585
2745
|
# The priority of the job queue. Job queues with a higher priority (or a
|
|
@@ -2587,13 +2747,25 @@ module Aws::Batch
|
|
|
2587
2747
|
# when associated with the same compute environment. Priority is
|
|
2588
2748
|
# determined in descending order, for example, a job queue with a
|
|
2589
2749
|
# priority value of `10` is given scheduling preference over a job queue
|
|
2590
|
-
# with a priority value of `1`.
|
|
2750
|
+
# with a priority value of `1`. All of the compute environments must be
|
|
2751
|
+
# either EC2 (`EC2` or `SPOT`) or Fargate (`FARGATE` or `FARGATE_SPOT`).
|
|
2752
|
+
# EC2 and Fargate compute environments can't be mixed.
|
|
2591
2753
|
#
|
|
2592
2754
|
# @option params [Array<Types::ComputeEnvironmentOrder>] :compute_environment_order
|
|
2593
2755
|
# Details the set of compute environments mapped to a job queue and
|
|
2594
2756
|
# 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
|
-
#
|
|
2757
|
+
# by the job scheduler to determine which compute environment should run
|
|
2758
|
+
# a given job. Compute environments must be in the `VALID` state before
|
|
2759
|
+
# you can associate them with a job queue. All of the compute
|
|
2760
|
+
# environments must be either EC2 (`EC2` or `SPOT`) or Fargate
|
|
2761
|
+
# (`FARGATE` or `FARGATE_SPOT`). EC2 and Fargate compute environments
|
|
2762
|
+
# can't be mixed.
|
|
2763
|
+
#
|
|
2764
|
+
# <note markdown="1"> All compute environments that are associated with a job queue must
|
|
2765
|
+
# share the same architecture. AWS Batch doesn't support mixing compute
|
|
2766
|
+
# environment architecture types in a single job queue.
|
|
2767
|
+
#
|
|
2768
|
+
# </note>
|
|
2597
2769
|
#
|
|
2598
2770
|
# @return [Types::UpdateJobQueueResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
2599
2771
|
#
|
|
@@ -2657,7 +2829,7 @@ module Aws::Batch
|
|
|
2657
2829
|
params: params,
|
|
2658
2830
|
config: config)
|
|
2659
2831
|
context[:gem_name] = 'aws-sdk-batch'
|
|
2660
|
-
context[:gem_version] = '1.
|
|
2832
|
+
context[:gem_version] = '1.46.0'
|
|
2661
2833
|
Seahorse::Client::Request.new(handlers, context)
|
|
2662
2834
|
end
|
|
2663
2835
|
|