aws-sdk-batch 1.37.0 → 1.42.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: baa1f885ee4f0ae4a8aacfe78be394486d333e39ac25eae7cd34918c129644bf
4
- data.tar.gz: e89ceda04b2334a48523634d5eefd3d297f95544c5986a5d5eeab692a49fa2cf
3
+ metadata.gz: b240304ecae1aeae3ea13bb1f66495b9f1cb47ee43c4d103bf3622b00f7c8cc2
4
+ data.tar.gz: 2451f30ab3efaf8c2526b900d19abb100e5d7ea1fd40ba2986457724f1cdc812
5
5
  SHA512:
6
- metadata.gz: 1385d1497837a9fe33906a958d7e33a6b415d53712fcdeda7c58db3d02820db8436b1026b4534bf9772c78f4b499836837887fb1b3a319e11bba52ce714a2cb7
7
- data.tar.gz: 0ae933de56e73cd3cc562cfc654d1bfe1a563ad0e4dec276f3fb9f1a1ee1ab686c5017fb3a3eea6681f9d5c9b6b8c0d2f2e346c492fae050ee9f4b05900d0075
6
+ metadata.gz: f187b949aa833f58675fd84795e60a89b77806675d1232646043c3bbd5888a77c4301297afd7b7b08f59604fd9878e5daca4f538b49887c1484c82de660711ca
7
+ data.tar.gz: 76af358d5e06da9d61ccd55032aa418ae19a143928a1217776a67b5b2e0a34eedb8535afb935489b71b2be40d31015b0fc0a433a0240ab3cc4c7797fcbbd449e
@@ -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.37.0'
51
+ GEM_VERSION = '1.42.0'
52
52
 
53
53
  end
@@ -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 cancelled. Jobs that
332
- # have progressed to `STARTING` or `RUNNING` are not cancelled (but the
333
- # API operation still succeeds, even if no job is cancelled); these jobs
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 Amazon EC2 On-Demand Instances or
384
- # Spot Instances in your managed compute environment. You can optionally
385
- # set a maximum price so that Spot Instances only launch when the Spot
386
- # Instance price is below a specified percentage of the On-Demand price.
385
+ # environment. You can choose either to use EC2 On-Demand Instances and
386
+ # EC2 Spot Instances, or to use Fargate and Fargate Spot capacity in
387
+ # your managed compute environment. You can optionally set a maximum
388
+ # price so that Spot Instances only launch when the Spot Instance price
389
+ # is below a specified percentage of the On-Demand price.
387
390
  #
388
391
  # <note markdown="1"> Multi-node parallel jobs are not supported on Spot Instances.
389
392
  #
390
393
  # </note>
391
394
  #
392
- # In an unmanaged compute environment, you can manage your own compute
393
- # resources. This provides more compute resource configuration options,
394
- # such as using a custom AMI, but you must ensure that your AMI meets
395
- # the Amazon ECS container instance AMI specification. For more
396
- # information, see [Container Instance AMIs][2] in the *Amazon Elastic
397
- # Container Service Developer Guide*. After you have created your
398
- # unmanaged compute environment, you can use the
399
- # DescribeComputeEnvironments operation to find the Amazon ECS cluster
400
- # that is associated with it. Then, manually launch your container
401
- # instances into that Amazon ECS cluster. For more information, see
402
- # [Launching an Amazon ECS Container Instance][3] in the *Amazon Elastic
403
- # Container Service Developer Guide*.
404
- #
405
- # <note markdown="1"> AWS Batch does not upgrade the AMIs in a compute environment after it
406
- # is created (for example, when a newer version of the Amazon
407
- # ECS-optimized AMI is available). You are responsible for the
408
- # management of the guest operating system (including updates and
409
- # security patches) and any additional application software or utilities
410
- # that you install on the compute resources. To use a new AMI for your
411
- # AWS Batch jobs:
395
+ # In an unmanaged compute environment, you can manage your own EC2
396
+ # compute resources and have a lot of flexibility with how you configure
397
+ # your compute resources. For example, you can use custom AMI. However,
398
+ # you need to verify that your AMI meets the Amazon ECS container
399
+ # instance AMI specification. For more information, see [container
400
+ # instance AMIs][2] in the *Amazon Elastic Container Service Developer
401
+ # Guide*. After you have created your unmanaged compute environment, you
402
+ # can use the DescribeComputeEnvironments operation to find the Amazon
403
+ # ECS cluster that is associated with it. Then, manually launch your
404
+ # container instances into that Amazon ECS cluster. For more
405
+ # information, see [Launching an Amazon ECS container instance][3] in
406
+ # the *Amazon Elastic Container Service Developer Guide*.
407
+ #
408
+ # <note markdown="1"> AWS Batch doesn't upgrade the AMIs in a compute environment after
409
+ # it's created. For example, it doesn't update the AMIs when a newer
410
+ # version of the Amazon ECS-optimized AMI is available. Therefore,
411
+ # you're responsible for the management of the guest operating system
412
+ # (including updates and security patches) and any additional
413
+ # application software or utilities that you install on the compute
414
+ # resources. To use a new AMI for your AWS Batch jobs, complete these
415
+ # steps:
412
416
  #
413
417
  # 1. Create a new compute environment with the new AMI.
414
418
  #
415
419
  # 2. Add the compute environment to an existing job queue.
416
420
  #
417
- # 3. Remove the old compute environment from your job queue.
421
+ # 3. Remove the earlier compute environment from your job queue.
418
422
  #
419
- # 4. Delete the old compute environment.
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. For more information, see
435
- # [Compute Environments][1] in the *AWS Batch User Guide*.
438
+ # The type of the compute environment: `MANAGED` or `UNMANAGED`. For
439
+ # more information, see [Compute Environments][1] in the *AWS Batch User
440
+ # Guide*.
436
441
  #
437
442
  #
438
443
  #
@@ -444,10 +449,10 @@ module Aws::Batch
444
449
  # automatically based on queues.
445
450
  #
446
451
  # @option params [Types::ComputeResource] :compute_resources
447
- # Details of the compute resources managed by the compute environment.
448
- # This parameter is required for managed compute environments. For more
449
- # information, see [Compute Environments][1] in the *AWS Batch User
450
- # Guide*.
452
+ # Details about the compute resources managed by the compute
453
+ # environment. This parameter is required for managed compute
454
+ # environments. For more information, see [Compute Environments][1] in
455
+ # the *AWS Batch User Guide*.
451
456
  #
452
457
  #
453
458
  #
@@ -463,13 +468,29 @@ module Aws::Batch
463
468
  #
464
469
  # <note markdown="1"> Depending on how you created your AWS Batch service role, its ARN may
465
470
  # contain the `service-role` path prefix. When you only specify the name
466
- # of the service role, AWS Batch assumes that your ARN does not use the
471
+ # of the service role, AWS Batch assumes that your ARN doesn't use the
467
472
  # `service-role` path prefix. Because of this, we recommend that you
468
473
  # specify the full ARN of your service role when you create compute
469
474
  # environments.
470
475
  #
471
476
  # </note>
472
477
  #
478
+ # @option params [Hash<String,String>] :tags
479
+ # The tags that you apply to the compute environment to help you
480
+ # categorize and organize your resources. Each tag consists of a key and
481
+ # an optional value. For more information, see [Tagging AWS
482
+ # Resources][1] in *AWS General Reference*.
483
+ #
484
+ # These tags can be updated or removed using the [TagResource][2] and
485
+ # [UntagResource][3] API operations. These tags don't propagate to the
486
+ # underlying compute resources.
487
+ #
488
+ #
489
+ #
490
+ # [1]: https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html
491
+ # [2]: https://docs.aws.amazon.com/batch/latest/APIReference/API_TagResource.html
492
+ # [3]: https://docs.aws.amazon.com/batch/latest/APIReference/API_UntagResource.html
493
+ #
473
494
  # @return [Types::CreateComputeEnvironmentResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
474
495
  #
475
496
  # * {Types::CreateComputeEnvironmentResponse#compute_environment_name #compute_environment_name} => String
@@ -569,17 +590,17 @@ module Aws::Batch
569
590
  # type: "MANAGED", # required, accepts MANAGED, UNMANAGED
570
591
  # state: "ENABLED", # accepts ENABLED, DISABLED
571
592
  # compute_resources: {
572
- # type: "EC2", # required, accepts EC2, SPOT
593
+ # type: "EC2", # required, accepts EC2, SPOT, FARGATE, FARGATE_SPOT
573
594
  # allocation_strategy: "BEST_FIT", # accepts BEST_FIT, BEST_FIT_PROGRESSIVE, SPOT_CAPACITY_OPTIMIZED
574
- # minv_cpus: 1, # required
595
+ # minv_cpus: 1,
575
596
  # maxv_cpus: 1, # required
576
597
  # desiredv_cpus: 1,
577
- # instance_types: ["String"], # required
598
+ # instance_types: ["String"],
578
599
  # image_id: "String",
579
600
  # subnets: ["String"], # required
580
601
  # security_group_ids: ["String"],
581
602
  # ec2_key_pair: "String",
582
- # instance_role: "String", # required
603
+ # instance_role: "String",
583
604
  # tags: {
584
605
  # "String" => "String",
585
606
  # },
@@ -591,8 +612,17 @@ module Aws::Batch
591
612
  # launch_template_name: "String",
592
613
  # version: "String",
593
614
  # },
615
+ # ec2_configuration: [
616
+ # {
617
+ # image_type: "ImageType", # required
618
+ # image_id_override: "ImageIdOverride",
619
+ # },
620
+ # ],
594
621
  # },
595
622
  # service_role: "String", # required
623
+ # tags: {
624
+ # "TagKey" => "TagValue",
625
+ # },
596
626
  # })
597
627
  #
598
628
  # @example Response structure
@@ -625,24 +655,36 @@ module Aws::Batch
625
655
  # @option params [String] :state
626
656
  # The state of the job queue. If the job queue state is `ENABLED`, it is
627
657
  # able to accept jobs. If the job queue state is `DISABLED`, new jobs
628
- # cannot be added to the queue, but jobs already in the queue can
658
+ # can't be added to the queue, but jobs already in the queue can
629
659
  # finish.
630
660
  #
631
661
  # @option params [required, Integer] :priority
632
662
  # The priority of the job queue. Job queues with a higher priority (or a
633
663
  # higher integer value for the `priority` parameter) are evaluated first
634
664
  # when associated with the same compute environment. Priority is
635
- # determined in descending order, for example, a job queue with a
665
+ # determined in descending order. For example, a job queue with a
636
666
  # priority value of `10` is given scheduling preference over a job queue
637
667
  # with a priority value of `1`.
638
668
  #
639
669
  # @option params [required, Array<Types::ComputeEnvironmentOrder>] :compute_environment_order
640
670
  # The set of compute environments mapped to a job queue and their order
641
671
  # relative to each other. The job scheduler uses this parameter to
642
- # determine which compute environment should execute a given job.
643
- # Compute environments must be in the `VALID` state before you can
644
- # associate them with a job queue. You can associate up to three compute
645
- # environments with a job queue.
672
+ # determine which compute environment should run a specific job. Compute
673
+ # environments must be in the `VALID` state before you can associate
674
+ # them with a job queue. You can associate up to three compute
675
+ # environments with a job queue. All of the compute environments must be
676
+ # either EC2 (`EC2` or `SPOT`) or Fargate (`FARGATE` or `FARGATE_SPOT`);
677
+ # EC2 and Fargate compute environments can't be mixed.
678
+ #
679
+ # @option params [Hash<String,String>] :tags
680
+ # The tags that you apply to the job queue to help you categorize and
681
+ # organize your resources. Each tag consists of a key and an optional
682
+ # value. For more information, see [Tagging AWS Resources][1] in *AWS
683
+ # General Reference*.
684
+ #
685
+ #
686
+ #
687
+ # [1]: https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html
646
688
  #
647
689
  # @return [Types::CreateJobQueueResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
648
690
  #
@@ -711,6 +753,9 @@ module Aws::Batch
711
753
  # compute_environment: "String", # required
712
754
  # },
713
755
  # ],
756
+ # tags: {
757
+ # "TagKey" => "TagValue",
758
+ # },
714
759
  # })
715
760
  #
716
761
  # @example Response structure
@@ -732,7 +777,10 @@ module Aws::Batch
732
777
  # Before you can delete a compute environment, you must set its state to
733
778
  # `DISABLED` with the UpdateComputeEnvironment API operation and
734
779
  # disassociate it from any job queues with the UpdateJobQueue API
735
- # operation.
780
+ # operation. Compute environments that use AWS Fargate resources must
781
+ # terminate all active jobs on that compute environment before deleting
782
+ # the compute environment. If this isn't done, the compute environment
783
+ # will end up in an invalid state.
736
784
  #
737
785
  # @option params [required, String] :compute_environment
738
786
  # The name or Amazon Resource Name (ARN) of the compute environment to
@@ -772,7 +820,7 @@ module Aws::Batch
772
820
  # for a queue with the UpdateJobQueue operation. All jobs in the queue
773
821
  # are terminated when you delete a job queue.
774
822
  #
775
- # It is not necessary to disassociate compute environments from a queue
823
+ # It's not necessary to disassociate compute environments from a queue
776
824
  # before submitting a `DeleteJobQueue` request.
777
825
  #
778
826
  # @option params [required, String] :job_queue
@@ -809,7 +857,7 @@ module Aws::Batch
809
857
  req.send_request(options)
810
858
  end
811
859
 
812
- # Deregisters an AWS Batch job definition. Job definitions will be
860
+ # Deregisters an AWS Batch job definition. Job definitions are
813
861
  # permanently deleted after 180 days.
814
862
  #
815
863
  # @option params [required, String] :job_definition
@@ -848,7 +896,7 @@ module Aws::Batch
848
896
 
849
897
  # Describes one or more of your compute environments.
850
898
  #
851
- # If you are using an unmanaged compute environment, you can use the
899
+ # If you're using an unmanaged compute environment, you can use the
852
900
  # `DescribeComputeEnvironment` operation to determine the
853
901
  # `ecsClusterArn` that you should launch your Amazon ECS container
854
902
  # instances into.
@@ -865,7 +913,7 @@ module Aws::Batch
865
913
  # The remaining results of the initial request can be seen by sending
866
914
  # another `DescribeComputeEnvironments` request with the returned
867
915
  # `nextToken` value. This value can be between 1 and 100. If this
868
- # parameter is not used, then `DescribeComputeEnvironments` returns up
916
+ # parameter isn't used, then `DescribeComputeEnvironments` returns up
869
917
  # to 100 results and a `nextToken` value if applicable.
870
918
  #
871
919
  # @option params [String] :next_token
@@ -951,11 +999,13 @@ module Aws::Batch
951
999
  # resp.compute_environments[0].compute_environment_name #=> String
952
1000
  # resp.compute_environments[0].compute_environment_arn #=> String
953
1001
  # resp.compute_environments[0].ecs_cluster_arn #=> String
1002
+ # resp.compute_environments[0].tags #=> Hash
1003
+ # resp.compute_environments[0].tags["TagKey"] #=> String
954
1004
  # resp.compute_environments[0].type #=> String, one of "MANAGED", "UNMANAGED"
955
1005
  # resp.compute_environments[0].state #=> String, one of "ENABLED", "DISABLED"
956
1006
  # resp.compute_environments[0].status #=> String, one of "CREATING", "UPDATING", "DELETING", "DELETED", "VALID", "INVALID"
957
1007
  # resp.compute_environments[0].status_reason #=> String
958
- # resp.compute_environments[0].compute_resources.type #=> String, one of "EC2", "SPOT"
1008
+ # resp.compute_environments[0].compute_resources.type #=> String, one of "EC2", "SPOT", "FARGATE", "FARGATE_SPOT"
959
1009
  # resp.compute_environments[0].compute_resources.allocation_strategy #=> String, one of "BEST_FIT", "BEST_FIT_PROGRESSIVE", "SPOT_CAPACITY_OPTIMIZED"
960
1010
  # resp.compute_environments[0].compute_resources.minv_cpus #=> Integer
961
1011
  # resp.compute_environments[0].compute_resources.maxv_cpus #=> Integer
@@ -977,6 +1027,9 @@ module Aws::Batch
977
1027
  # resp.compute_environments[0].compute_resources.launch_template.launch_template_id #=> String
978
1028
  # resp.compute_environments[0].compute_resources.launch_template.launch_template_name #=> String
979
1029
  # resp.compute_environments[0].compute_resources.launch_template.version #=> String
1030
+ # resp.compute_environments[0].compute_resources.ec2_configuration #=> Array
1031
+ # resp.compute_environments[0].compute_resources.ec2_configuration[0].image_type #=> String
1032
+ # resp.compute_environments[0].compute_resources.ec2_configuration[0].image_id_override #=> String
980
1033
  # resp.compute_environments[0].service_role #=> String
981
1034
  # resp.next_token #=> String
982
1035
  #
@@ -1003,7 +1056,7 @@ module Aws::Batch
1003
1056
  # page along with a `nextToken` response element. The remaining results
1004
1057
  # of the initial request can be seen by sending another
1005
1058
  # `DescribeJobDefinitions` request with the returned `nextToken` value.
1006
- # This value can be between 1 and 100. If this parameter is not used,
1059
+ # This value can be between 1 and 100. If this parameter isn't used,
1007
1060
  # then `DescribeJobDefinitions` returns up to 100 results and a
1008
1061
  # `nextToken` value if applicable.
1009
1062
  #
@@ -1011,7 +1064,7 @@ module Aws::Batch
1011
1064
  # The name of the job definition to describe.
1012
1065
  #
1013
1066
  # @option params [String] :status
1014
- # The status with which to filter job definitions.
1067
+ # The status used to filter job definitions.
1015
1068
  #
1016
1069
  # @option params [String] :next_token
1017
1070
  # The `nextToken` value returned from a previous paginated
@@ -1093,6 +1146,11 @@ module Aws::Batch
1093
1146
  # resp.job_definitions[0].parameters #=> Hash
1094
1147
  # resp.job_definitions[0].parameters["String"] #=> String
1095
1148
  # resp.job_definitions[0].retry_strategy.attempts #=> Integer
1149
+ # resp.job_definitions[0].retry_strategy.evaluate_on_exit #=> Array
1150
+ # resp.job_definitions[0].retry_strategy.evaluate_on_exit[0].on_status_reason #=> String
1151
+ # resp.job_definitions[0].retry_strategy.evaluate_on_exit[0].on_reason #=> String
1152
+ # resp.job_definitions[0].retry_strategy.evaluate_on_exit[0].on_exit_code #=> String
1153
+ # resp.job_definitions[0].retry_strategy.evaluate_on_exit[0].action #=> String, one of "RETRY", "EXIT"
1096
1154
  # resp.job_definitions[0].container_properties.image #=> String
1097
1155
  # resp.job_definitions[0].container_properties.vcpus #=> Integer
1098
1156
  # resp.job_definitions[0].container_properties.memory #=> Integer
@@ -1120,7 +1178,7 @@ module Aws::Batch
1120
1178
  # resp.job_definitions[0].container_properties.instance_type #=> String
1121
1179
  # resp.job_definitions[0].container_properties.resource_requirements #=> Array
1122
1180
  # resp.job_definitions[0].container_properties.resource_requirements[0].value #=> String
1123
- # resp.job_definitions[0].container_properties.resource_requirements[0].type #=> String, one of "GPU"
1181
+ # resp.job_definitions[0].container_properties.resource_requirements[0].type #=> String, one of "GPU", "VCPU", "MEMORY"
1124
1182
  # resp.job_definitions[0].container_properties.linux_parameters.devices #=> Array
1125
1183
  # resp.job_definitions[0].container_properties.linux_parameters.devices[0].host_path #=> String
1126
1184
  # resp.job_definitions[0].container_properties.linux_parameters.devices[0].container_path #=> String
@@ -1144,6 +1202,8 @@ module Aws::Batch
1144
1202
  # resp.job_definitions[0].container_properties.secrets #=> Array
1145
1203
  # resp.job_definitions[0].container_properties.secrets[0].name #=> String
1146
1204
  # resp.job_definitions[0].container_properties.secrets[0].value_from #=> String
1205
+ # resp.job_definitions[0].container_properties.network_configuration.assign_public_ip #=> String, one of "ENABLED", "DISABLED"
1206
+ # resp.job_definitions[0].container_properties.fargate_platform_configuration.platform_version #=> String
1147
1207
  # resp.job_definitions[0].timeout.attempt_duration_seconds #=> Integer
1148
1208
  # resp.job_definitions[0].node_properties.num_nodes #=> Integer
1149
1209
  # resp.job_definitions[0].node_properties.main_node #=> Integer
@@ -1176,7 +1236,7 @@ module Aws::Batch
1176
1236
  # resp.job_definitions[0].node_properties.node_range_properties[0].container.instance_type #=> String
1177
1237
  # resp.job_definitions[0].node_properties.node_range_properties[0].container.resource_requirements #=> Array
1178
1238
  # resp.job_definitions[0].node_properties.node_range_properties[0].container.resource_requirements[0].value #=> String
1179
- # resp.job_definitions[0].node_properties.node_range_properties[0].container.resource_requirements[0].type #=> String, one of "GPU"
1239
+ # resp.job_definitions[0].node_properties.node_range_properties[0].container.resource_requirements[0].type #=> String, one of "GPU", "VCPU", "MEMORY"
1180
1240
  # resp.job_definitions[0].node_properties.node_range_properties[0].container.linux_parameters.devices #=> Array
1181
1241
  # resp.job_definitions[0].node_properties.node_range_properties[0].container.linux_parameters.devices[0].host_path #=> String
1182
1242
  # resp.job_definitions[0].node_properties.node_range_properties[0].container.linux_parameters.devices[0].container_path #=> String
@@ -1200,6 +1260,13 @@ module Aws::Batch
1200
1260
  # resp.job_definitions[0].node_properties.node_range_properties[0].container.secrets #=> Array
1201
1261
  # resp.job_definitions[0].node_properties.node_range_properties[0].container.secrets[0].name #=> String
1202
1262
  # resp.job_definitions[0].node_properties.node_range_properties[0].container.secrets[0].value_from #=> String
1263
+ # resp.job_definitions[0].node_properties.node_range_properties[0].container.network_configuration.assign_public_ip #=> String, one of "ENABLED", "DISABLED"
1264
+ # resp.job_definitions[0].node_properties.node_range_properties[0].container.fargate_platform_configuration.platform_version #=> String
1265
+ # resp.job_definitions[0].tags #=> Hash
1266
+ # resp.job_definitions[0].tags["TagKey"] #=> String
1267
+ # resp.job_definitions[0].propagate_tags #=> Boolean
1268
+ # resp.job_definitions[0].platform_capabilities #=> Array
1269
+ # resp.job_definitions[0].platform_capabilities[0] #=> String, one of "EC2", "FARGATE"
1203
1270
  # resp.next_token #=> String
1204
1271
  #
1205
1272
  # @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/DescribeJobDefinitions AWS API Documentation
@@ -1224,7 +1291,7 @@ module Aws::Batch
1224
1291
  # `nextToken` response element. The remaining results of the initial
1225
1292
  # request can be seen by sending another `DescribeJobQueues` request
1226
1293
  # with the returned `nextToken` value. This value can be between 1 and
1227
- # 100. If this parameter is not used, then `DescribeJobQueues` returns
1294
+ # 100. If this parameter isn't used, then `DescribeJobQueues` returns
1228
1295
  # up to 100 results and a `nextToken` value if applicable.
1229
1296
  #
1230
1297
  # @option params [String] :next_token
@@ -1298,6 +1365,8 @@ module Aws::Batch
1298
1365
  # resp.job_queues[0].compute_environment_order #=> Array
1299
1366
  # resp.job_queues[0].compute_environment_order[0].order #=> Integer
1300
1367
  # resp.job_queues[0].compute_environment_order[0].compute_environment #=> String
1368
+ # resp.job_queues[0].tags #=> Hash
1369
+ # resp.job_queues[0].tags["TagKey"] #=> String
1301
1370
  # resp.next_token #=> String
1302
1371
  #
1303
1372
  # @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/DescribeJobQueues AWS API Documentation
@@ -1377,6 +1446,7 @@ module Aws::Batch
1377
1446
  # @example Response structure
1378
1447
  #
1379
1448
  # resp.jobs #=> Array
1449
+ # resp.jobs[0].job_arn #=> String
1380
1450
  # resp.jobs[0].job_name #=> String
1381
1451
  # resp.jobs[0].job_id #=> String
1382
1452
  # resp.jobs[0].job_queue #=> String
@@ -1397,6 +1467,11 @@ module Aws::Batch
1397
1467
  # resp.jobs[0].status_reason #=> String
1398
1468
  # resp.jobs[0].created_at #=> Integer
1399
1469
  # resp.jobs[0].retry_strategy.attempts #=> Integer
1470
+ # resp.jobs[0].retry_strategy.evaluate_on_exit #=> Array
1471
+ # resp.jobs[0].retry_strategy.evaluate_on_exit[0].on_status_reason #=> String
1472
+ # resp.jobs[0].retry_strategy.evaluate_on_exit[0].on_reason #=> String
1473
+ # resp.jobs[0].retry_strategy.evaluate_on_exit[0].on_exit_code #=> String
1474
+ # resp.jobs[0].retry_strategy.evaluate_on_exit[0].action #=> String, one of "RETRY", "EXIT"
1400
1475
  # resp.jobs[0].started_at #=> Integer
1401
1476
  # resp.jobs[0].stopped_at #=> Integer
1402
1477
  # resp.jobs[0].depends_on #=> Array
@@ -1441,7 +1516,7 @@ module Aws::Batch
1441
1516
  # resp.jobs[0].container.network_interfaces[0].private_ipv_4_address #=> String
1442
1517
  # resp.jobs[0].container.resource_requirements #=> Array
1443
1518
  # resp.jobs[0].container.resource_requirements[0].value #=> String
1444
- # resp.jobs[0].container.resource_requirements[0].type #=> String, one of "GPU"
1519
+ # resp.jobs[0].container.resource_requirements[0].type #=> String, one of "GPU", "VCPU", "MEMORY"
1445
1520
  # resp.jobs[0].container.linux_parameters.devices #=> Array
1446
1521
  # resp.jobs[0].container.linux_parameters.devices[0].host_path #=> String
1447
1522
  # resp.jobs[0].container.linux_parameters.devices[0].container_path #=> String
@@ -1465,6 +1540,8 @@ module Aws::Batch
1465
1540
  # resp.jobs[0].container.secrets #=> Array
1466
1541
  # resp.jobs[0].container.secrets[0].name #=> String
1467
1542
  # resp.jobs[0].container.secrets[0].value_from #=> String
1543
+ # resp.jobs[0].container.network_configuration.assign_public_ip #=> String, one of "ENABLED", "DISABLED"
1544
+ # resp.jobs[0].container.fargate_platform_configuration.platform_version #=> String
1468
1545
  # resp.jobs[0].node_details.node_index #=> Integer
1469
1546
  # resp.jobs[0].node_details.is_main_node #=> Boolean
1470
1547
  # resp.jobs[0].node_properties.num_nodes #=> Integer
@@ -1498,7 +1575,7 @@ module Aws::Batch
1498
1575
  # resp.jobs[0].node_properties.node_range_properties[0].container.instance_type #=> String
1499
1576
  # resp.jobs[0].node_properties.node_range_properties[0].container.resource_requirements #=> Array
1500
1577
  # resp.jobs[0].node_properties.node_range_properties[0].container.resource_requirements[0].value #=> String
1501
- # resp.jobs[0].node_properties.node_range_properties[0].container.resource_requirements[0].type #=> String, one of "GPU"
1578
+ # resp.jobs[0].node_properties.node_range_properties[0].container.resource_requirements[0].type #=> String, one of "GPU", "VCPU", "MEMORY"
1502
1579
  # resp.jobs[0].node_properties.node_range_properties[0].container.linux_parameters.devices #=> Array
1503
1580
  # resp.jobs[0].node_properties.node_range_properties[0].container.linux_parameters.devices[0].host_path #=> String
1504
1581
  # resp.jobs[0].node_properties.node_range_properties[0].container.linux_parameters.devices[0].container_path #=> String
@@ -1522,11 +1599,18 @@ module Aws::Batch
1522
1599
  # resp.jobs[0].node_properties.node_range_properties[0].container.secrets #=> Array
1523
1600
  # resp.jobs[0].node_properties.node_range_properties[0].container.secrets[0].name #=> String
1524
1601
  # resp.jobs[0].node_properties.node_range_properties[0].container.secrets[0].value_from #=> String
1602
+ # resp.jobs[0].node_properties.node_range_properties[0].container.network_configuration.assign_public_ip #=> String, one of "ENABLED", "DISABLED"
1603
+ # resp.jobs[0].node_properties.node_range_properties[0].container.fargate_platform_configuration.platform_version #=> String
1525
1604
  # resp.jobs[0].array_properties.status_summary #=> Hash
1526
1605
  # resp.jobs[0].array_properties.status_summary["String"] #=> Integer
1527
1606
  # resp.jobs[0].array_properties.size #=> Integer
1528
1607
  # resp.jobs[0].array_properties.index #=> Integer
1529
1608
  # resp.jobs[0].timeout.attempt_duration_seconds #=> Integer
1609
+ # resp.jobs[0].tags #=> Hash
1610
+ # resp.jobs[0].tags["TagKey"] #=> String
1611
+ # resp.jobs[0].propagate_tags #=> Boolean
1612
+ # resp.jobs[0].platform_capabilities #=> Array
1613
+ # resp.jobs[0].platform_capabilities[0] #=> String, one of "EC2", "FARGATE"
1530
1614
  #
1531
1615
  # @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/DescribeJobs AWS API Documentation
1532
1616
  #
@@ -1539,21 +1623,21 @@ module Aws::Batch
1539
1623
 
1540
1624
  # Returns a list of AWS Batch jobs.
1541
1625
  #
1542
- # You must specify only one of the following:
1626
+ # You must specify only one of the following items:
1543
1627
  #
1544
- # * a job queue ID to return a list of jobs in that job queue
1628
+ # * A job queue ID to return a list of jobs in that job queue
1545
1629
  #
1546
- # * a multi-node parallel job ID to return a list of that job's nodes
1630
+ # * A multi-node parallel job ID to return a list of that job's nodes
1547
1631
  #
1548
- # * an array job ID to return a list of that job's children
1632
+ # * An array job ID to return a list of that job's children
1549
1633
  #
1550
1634
  # You can filter the results by job status with the `jobStatus`
1551
- # parameter. If you do not specify a status, only `RUNNING` jobs are
1635
+ # parameter. If you don't specify a status, only `RUNNING` jobs are
1552
1636
  # returned.
1553
1637
  #
1554
1638
  # @option params [String] :job_queue
1555
- # The name or full Amazon Resource Name (ARN) of the job queue with
1556
- # which to list jobs.
1639
+ # The name or full Amazon Resource Name (ARN) of the job queue used to
1640
+ # list jobs.
1557
1641
  #
1558
1642
  # @option params [String] :array_job_id
1559
1643
  # The job ID for an array job. Specifying an array job ID with this
@@ -1565,8 +1649,8 @@ module Aws::Batch
1565
1649
  # associated with the specified job.
1566
1650
  #
1567
1651
  # @option params [String] :job_status
1568
- # The job status with which to filter jobs in the specified queue. If
1569
- # you do not specify a status, only `RUNNING` jobs are returned.
1652
+ # The job status used to filter jobs in the specified queue. If you
1653
+ # don't specify a status, only `RUNNING` jobs are returned.
1570
1654
  #
1571
1655
  # @option params [Integer] :max_results
1572
1656
  # The maximum number of results returned by `ListJobs` in paginated
@@ -1575,7 +1659,7 @@ module Aws::Batch
1575
1659
  # response element. The remaining results of the initial request can be
1576
1660
  # seen by sending another `ListJobs` request with the returned
1577
1661
  # `nextToken` value. This value can be between 1 and 100. If this
1578
- # parameter is not used, then `ListJobs` returns up to 100 results and a
1662
+ # parameter isn't used, then `ListJobs` returns up to 100 results and a
1579
1663
  # `nextToken` value if applicable.
1580
1664
  #
1581
1665
  # @option params [String] :next_token
@@ -1650,6 +1734,7 @@ module Aws::Batch
1650
1734
  # @example Response structure
1651
1735
  #
1652
1736
  # resp.job_summary_list #=> Array
1737
+ # resp.job_summary_list[0].job_arn #=> String
1653
1738
  # resp.job_summary_list[0].job_id #=> String
1654
1739
  # resp.job_summary_list[0].job_name #=> String
1655
1740
  # resp.job_summary_list[0].created_at #=> Integer
@@ -1675,6 +1760,59 @@ module Aws::Batch
1675
1760
  req.send_request(options)
1676
1761
  end
1677
1762
 
1763
+ # Lists the tags for an AWS Batch resource. AWS Batch resources that
1764
+ # support tags are compute environments, jobs, job definitions, and job
1765
+ # queues. ARNs for child jobs of array and multi-node parallel (MNP)
1766
+ # jobs are not supported.
1767
+ #
1768
+ # @option params [required, String] :resource_arn
1769
+ # The Amazon Resource Name (ARN) that identifies the resource that tags
1770
+ # are listed for. AWS Batch resources that support tags are compute
1771
+ # environments, jobs, job definitions, and job queues. ARNs for child
1772
+ # jobs of array and multi-node parallel (MNP) jobs are not supported.
1773
+ #
1774
+ # @return [Types::ListTagsForResourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1775
+ #
1776
+ # * {Types::ListTagsForResourceResponse#tags #tags} => Hash&lt;String,String&gt;
1777
+ #
1778
+ #
1779
+ # @example Example: ListTagsForResource Example
1780
+ #
1781
+ # # This demonstrates calling the ListTagsForResource action.
1782
+ #
1783
+ # resp = client.list_tags_for_resource({
1784
+ # resource_arn: "arn:aws:batch:us-east-1:123456789012:job-definition/sleep30:1",
1785
+ # })
1786
+ #
1787
+ # resp.to_h outputs the following:
1788
+ # {
1789
+ # tags: {
1790
+ # "Department" => "Engineering",
1791
+ # "Stage" => "Alpha",
1792
+ # "User" => "JaneDoe",
1793
+ # },
1794
+ # }
1795
+ #
1796
+ # @example Request syntax with placeholder values
1797
+ #
1798
+ # resp = client.list_tags_for_resource({
1799
+ # resource_arn: "String", # required
1800
+ # })
1801
+ #
1802
+ # @example Response structure
1803
+ #
1804
+ # resp.tags #=> Hash
1805
+ # resp.tags["TagKey"] #=> String
1806
+ #
1807
+ # @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/ListTagsForResource AWS API Documentation
1808
+ #
1809
+ # @overload list_tags_for_resource(params = {})
1810
+ # @param [Hash] params ({})
1811
+ def list_tags_for_resource(params = {}, options = {})
1812
+ req = build_request(:list_tags_for_resource, params)
1813
+ req.send_request(options)
1814
+ end
1815
+
1678
1816
  # Registers an AWS Batch job definition.
1679
1817
  #
1680
1818
  # @option params [required, String] :job_definition_name
@@ -1683,7 +1821,18 @@ module Aws::Batch
1683
1821
  # allowed.
1684
1822
  #
1685
1823
  # @option params [required, String] :type
1686
- # The type of job definition.
1824
+ # The type of job definition. For more information about multi-node
1825
+ # parallel jobs, see [Creating a multi-node parallel job definition][1]
1826
+ # in the *AWS Batch User Guide*.
1827
+ #
1828
+ # <note markdown="1"> If the job is run on Fargate resources, then `multinode` isn't
1829
+ # supported.
1830
+ #
1831
+ # </note>
1832
+ #
1833
+ #
1834
+ #
1835
+ # [1]: https://docs.aws.amazon.com/batch/latest/userguide/multi-node-job-def.html
1687
1836
  #
1688
1837
  # @option params [Hash<String,String>] :parameters
1689
1838
  # Default parameter substitution placeholders to set in the job
@@ -1697,6 +1846,11 @@ module Aws::Batch
1697
1846
  # `container`, then you must specify either `containerProperties` or
1698
1847
  # `nodeProperties`.
1699
1848
  #
1849
+ # <note markdown="1"> If the job runs on Fargate resources, then you must not specify
1850
+ # `nodeProperties`; use only `containerProperties`.
1851
+ #
1852
+ # </note>
1853
+ #
1700
1854
  # @option params [Types::NodeProperties] :node_properties
1701
1855
  # An object with various properties specific to multi-node parallel
1702
1856
  # jobs. If you specify node properties for a job, it becomes a
@@ -1705,6 +1859,11 @@ module Aws::Batch
1705
1859
  # definition's `type` parameter is `container`, then you must specify
1706
1860
  # either `containerProperties` or `nodeProperties`.
1707
1861
  #
1862
+ # <note markdown="1"> If the job runs on Fargate resources, then you must not specify
1863
+ # `nodeProperties`; use `containerProperties` instead.
1864
+ #
1865
+ # </note>
1866
+ #
1708
1867
  #
1709
1868
  #
1710
1869
  # [1]: https://docs.aws.amazon.com/batch/latest/userguide/multi-node-parallel-jobs.html
@@ -1713,21 +1872,44 @@ module Aws::Batch
1713
1872
  # The retry strategy to use for failed jobs that are submitted with this
1714
1873
  # job definition. Any retry strategy that is specified during a
1715
1874
  # SubmitJob operation overrides the retry strategy defined here. If a
1716
- # job is terminated due to a timeout, it is not retried.
1875
+ # job is terminated due to a timeout, it isn't retried.
1876
+ #
1877
+ # @option params [Boolean] :propagate_tags
1878
+ # Specifies whether to propagate the tags from the job or job definition
1879
+ # to the corresponding Amazon ECS task. If no value is specified, the
1880
+ # tags are not propagated. Tags can only be propagated to the tasks
1881
+ # during task creation. For tags with the same name, job tags are given
1882
+ # priority over job definitions tags. If the total number of combined
1883
+ # tags from the job and job definition is over 50, the job is moved to
1884
+ # the `FAILED` state.
1717
1885
  #
1718
1886
  # @option params [Types::JobTimeout] :timeout
1719
1887
  # The timeout configuration for jobs that are submitted with this job
1720
1888
  # definition, after which AWS Batch terminates your jobs if they have
1721
- # not finished. If a job is terminated due to a timeout, it is not
1889
+ # not finished. If a job is terminated due to a timeout, it isn't
1722
1890
  # retried. The minimum value for the timeout is 60 seconds. Any timeout
1723
1891
  # configuration that is specified during a SubmitJob operation overrides
1724
1892
  # the timeout configuration defined here. For more information, see [Job
1725
- # Timeouts][1] in the *Amazon Elastic Container Service Developer
1726
- # Guide*.
1893
+ # Timeouts][1] in the *AWS Batch User Guide*.
1727
1894
  #
1728
1895
  #
1729
1896
  #
1730
- # [1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/job_timeouts.html
1897
+ # [1]: https://docs.aws.amazon.com/batch/latest/userguide/job_timeouts.html
1898
+ #
1899
+ # @option params [Hash<String,String>] :tags
1900
+ # The tags that you apply to the job definition to help you categorize
1901
+ # and organize your resources. Each tag consists of a key and an
1902
+ # optional value. For more information, see [Tagging AWS Resources][1]
1903
+ # in *AWS Batch User Guide*.
1904
+ #
1905
+ #
1906
+ #
1907
+ # [1]: https://docs.aws.amazon.com/batch/latest/userguide/using-tags.html
1908
+ #
1909
+ # @option params [Array<String>] :platform_capabilities
1910
+ # The platform capabilities required by the job definition. If no value
1911
+ # is specified, it defaults to `EC2`. To run the job on Fargate
1912
+ # resources, specify `FARGATE`.
1731
1913
  #
1732
1914
  # @return [Types::RegisterJobDefinitionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1733
1915
  #
@@ -1761,6 +1943,35 @@ module Aws::Batch
1761
1943
  # revision: 1,
1762
1944
  # }
1763
1945
  #
1946
+ # @example Example: RegisterJobDefinition with tags
1947
+ #
1948
+ # # This demonstrates calling the RegisterJobDefinition action, including tags.
1949
+ #
1950
+ # resp = client.register_job_definition({
1951
+ # type: "container",
1952
+ # container_properties: {
1953
+ # command: [
1954
+ # "sleep",
1955
+ # "30",
1956
+ # ],
1957
+ # image: "busybox",
1958
+ # memory: 128,
1959
+ # vcpus: 1,
1960
+ # },
1961
+ # job_definition_name: "sleep30",
1962
+ # tags: {
1963
+ # "Department" => "Engineering",
1964
+ # "User" => "JaneDoe",
1965
+ # },
1966
+ # })
1967
+ #
1968
+ # resp.to_h outputs the following:
1969
+ # {
1970
+ # job_definition_arn: "arn:aws:batch:us-east-1:012345678910:job-definition/sleep30:1",
1971
+ # job_definition_name: "sleep30",
1972
+ # revision: 1,
1973
+ # }
1974
+ #
1764
1975
  # @example Request syntax with placeholder values
1765
1976
  #
1766
1977
  # resp = client.register_job_definition({
@@ -1811,7 +2022,7 @@ module Aws::Batch
1811
2022
  # resource_requirements: [
1812
2023
  # {
1813
2024
  # value: "String", # required
1814
- # type: "GPU", # required, accepts GPU
2025
+ # type: "GPU", # required, accepts GPU, VCPU, MEMORY
1815
2026
  # },
1816
2027
  # ],
1817
2028
  # linux_parameters: {
@@ -1852,6 +2063,12 @@ module Aws::Batch
1852
2063
  # value_from: "String", # required
1853
2064
  # },
1854
2065
  # ],
2066
+ # network_configuration: {
2067
+ # assign_public_ip: "ENABLED", # accepts ENABLED, DISABLED
2068
+ # },
2069
+ # fargate_platform_configuration: {
2070
+ # platform_version: "String",
2071
+ # },
1855
2072
  # },
1856
2073
  # node_properties: {
1857
2074
  # num_nodes: 1, # required
@@ -1901,7 +2118,7 @@ module Aws::Batch
1901
2118
  # resource_requirements: [
1902
2119
  # {
1903
2120
  # value: "String", # required
1904
- # type: "GPU", # required, accepts GPU
2121
+ # type: "GPU", # required, accepts GPU, VCPU, MEMORY
1905
2122
  # },
1906
2123
  # ],
1907
2124
  # linux_parameters: {
@@ -1942,16 +2159,35 @@ module Aws::Batch
1942
2159
  # value_from: "String", # required
1943
2160
  # },
1944
2161
  # ],
2162
+ # network_configuration: {
2163
+ # assign_public_ip: "ENABLED", # accepts ENABLED, DISABLED
2164
+ # },
2165
+ # fargate_platform_configuration: {
2166
+ # platform_version: "String",
2167
+ # },
1945
2168
  # },
1946
2169
  # },
1947
2170
  # ],
1948
2171
  # },
1949
2172
  # retry_strategy: {
1950
2173
  # attempts: 1,
2174
+ # evaluate_on_exit: [
2175
+ # {
2176
+ # on_status_reason: "String",
2177
+ # on_reason: "String",
2178
+ # on_exit_code: "String",
2179
+ # action: "RETRY", # required, accepts RETRY, EXIT
2180
+ # },
2181
+ # ],
1951
2182
  # },
2183
+ # propagate_tags: false,
1952
2184
  # timeout: {
1953
2185
  # attempt_duration_seconds: 1,
1954
2186
  # },
2187
+ # tags: {
2188
+ # "TagKey" => "TagValue",
2189
+ # },
2190
+ # platform_capabilities: ["EC2"], # accepts EC2, FARGATE
1955
2191
  # })
1956
2192
  #
1957
2193
  # @example Response structure
@@ -1972,6 +2208,10 @@ module Aws::Batch
1972
2208
  # Submits an AWS Batch job from a job definition. Parameters specified
1973
2209
  # during SubmitJob override parameters defined in the job definition.
1974
2210
  #
2211
+ # Jobs run on Fargate resources don't run for more than 14 days. After
2212
+ # 14 days, the Fargate resources might no longer be available and the
2213
+ # job is terminated.
2214
+ #
1975
2215
  # @option params [required, String] :job_name
1976
2216
  # The name of the job. The first character must be alphanumeric, and up
1977
2217
  # to 128 letters (uppercase and lowercase), numbers, hyphens, and
@@ -2027,16 +2267,31 @@ module Aws::Batch
2027
2267
  # A list of node overrides in JSON format that specify the node range to
2028
2268
  # target and the container overrides for that node range.
2029
2269
  #
2270
+ # <note markdown="1"> This parameter isn't applicable to jobs running on Fargate resources;
2271
+ # use `containerOverrides` instead.
2272
+ #
2273
+ # </note>
2274
+ #
2030
2275
  # @option params [Types::RetryStrategy] :retry_strategy
2031
2276
  # The retry strategy to use for failed jobs from this SubmitJob
2032
2277
  # operation. When a retry strategy is specified here, it overrides the
2033
2278
  # retry strategy defined in the job definition.
2034
2279
  #
2280
+ # @option params [Boolean] :propagate_tags
2281
+ # Specifies whether to propagate the tags from the job or job definition
2282
+ # to the corresponding Amazon ECS task. If no value is specified, the
2283
+ # tags aren't propagated. Tags can only be propagated to the tasks
2284
+ # during task creation. For tags with the same name, job tags are given
2285
+ # priority over job definitions tags. If the total number of combined
2286
+ # tags from the job and job definition is over 50, the job is moved to
2287
+ # the `FAILED` state. When specified, this overrides the tag propagation
2288
+ # setting in the job definition.
2289
+ #
2035
2290
  # @option params [Types::JobTimeout] :timeout
2036
2291
  # The timeout configuration for this SubmitJob operation. You can
2037
2292
  # specify a timeout duration after which AWS Batch terminates your jobs
2038
- # if they have not finished. If a job is terminated due to a timeout, it
2039
- # is not retried. The minimum value for the timeout is 60 seconds. This
2293
+ # if they haven't finished. If a job is terminated due to a timeout, it
2294
+ # isn't retried. The minimum value for the timeout is 60 seconds. This
2040
2295
  # configuration overrides any timeout configuration specified in the job
2041
2296
  # definition. For array jobs, child jobs have the same timeout
2042
2297
  # configuration as the parent job. For more information, see [Job
@@ -2047,8 +2302,19 @@ module Aws::Batch
2047
2302
  #
2048
2303
  # [1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/job_timeouts.html
2049
2304
  #
2305
+ # @option params [Hash<String,String>] :tags
2306
+ # The tags that you apply to the job request to help you categorize and
2307
+ # organize your resources. Each tag consists of a key and an optional
2308
+ # value. For more information, see [Tagging AWS Resources][1] in *AWS
2309
+ # General Reference*.
2310
+ #
2311
+ #
2312
+ #
2313
+ # [1]: https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html
2314
+ #
2050
2315
  # @return [Types::SubmitJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2051
2316
  #
2317
+ # * {Types::SubmitJobResponse#job_arn #job_arn} => String
2052
2318
  # * {Types::SubmitJobResponse#job_name #job_name} => String
2053
2319
  # * {Types::SubmitJobResponse#job_id #job_id} => String
2054
2320
  #
@@ -2101,7 +2367,7 @@ module Aws::Batch
2101
2367
  # resource_requirements: [
2102
2368
  # {
2103
2369
  # value: "String", # required
2104
- # type: "GPU", # required, accepts GPU
2370
+ # type: "GPU", # required, accepts GPU, VCPU, MEMORY
2105
2371
  # },
2106
2372
  # ],
2107
2373
  # },
@@ -2124,7 +2390,7 @@ module Aws::Batch
2124
2390
  # resource_requirements: [
2125
2391
  # {
2126
2392
  # value: "String", # required
2127
- # type: "GPU", # required, accepts GPU
2393
+ # type: "GPU", # required, accepts GPU, VCPU, MEMORY
2128
2394
  # },
2129
2395
  # ],
2130
2396
  # },
@@ -2133,14 +2399,27 @@ module Aws::Batch
2133
2399
  # },
2134
2400
  # retry_strategy: {
2135
2401
  # attempts: 1,
2402
+ # evaluate_on_exit: [
2403
+ # {
2404
+ # on_status_reason: "String",
2405
+ # on_reason: "String",
2406
+ # on_exit_code: "String",
2407
+ # action: "RETRY", # required, accepts RETRY, EXIT
2408
+ # },
2409
+ # ],
2136
2410
  # },
2411
+ # propagate_tags: false,
2137
2412
  # timeout: {
2138
2413
  # attempt_duration_seconds: 1,
2139
2414
  # },
2415
+ # tags: {
2416
+ # "TagKey" => "TagValue",
2417
+ # },
2140
2418
  # })
2141
2419
  #
2142
2420
  # @example Response structure
2143
2421
  #
2422
+ # resp.job_arn #=> String
2144
2423
  # resp.job_name #=> String
2145
2424
  # resp.job_id #=> String
2146
2425
  #
@@ -2153,6 +2432,66 @@ module Aws::Batch
2153
2432
  req.send_request(options)
2154
2433
  end
2155
2434
 
2435
+ # Associates the specified tags to a resource with the specified
2436
+ # `resourceArn`. If existing tags on a resource aren't specified in the
2437
+ # request parameters, they aren't changed. When a resource is deleted,
2438
+ # the tags associated with that resource are deleted as well. AWS Batch
2439
+ # resources that support tags are compute environments, jobs, job
2440
+ # definitions, and job queues. ARNs for child jobs of array and
2441
+ # multi-node parallel (MNP) jobs are not supported.
2442
+ #
2443
+ # @option params [required, String] :resource_arn
2444
+ # The Amazon Resource Name (ARN) of the resource that tags are added to.
2445
+ # AWS Batch resources that support tags are compute environments, jobs,
2446
+ # job definitions, and job queues. ARNs for child jobs of array and
2447
+ # multi-node parallel (MNP) jobs are not supported.
2448
+ #
2449
+ # @option params [required, Hash<String,String>] :tags
2450
+ # The tags that you apply to the resource to help you categorize and
2451
+ # organize your resources. Each tag consists of a key and an optional
2452
+ # value. For more information, see [Tagging AWS Resources][1] in *AWS
2453
+ # General Reference*.
2454
+ #
2455
+ #
2456
+ #
2457
+ # [1]: https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html
2458
+ #
2459
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
2460
+ #
2461
+ #
2462
+ # @example Example: TagResource Example
2463
+ #
2464
+ # # This demonstrates calling the TagResource action.
2465
+ #
2466
+ # resp = client.tag_resource({
2467
+ # resource_arn: "arn:aws:batch:us-east-1:123456789012:job-definition/sleep30:1",
2468
+ # tags: {
2469
+ # "Stage" => "Alpha",
2470
+ # },
2471
+ # })
2472
+ #
2473
+ # resp.to_h outputs the following:
2474
+ # {
2475
+ # }
2476
+ #
2477
+ # @example Request syntax with placeholder values
2478
+ #
2479
+ # resp = client.tag_resource({
2480
+ # resource_arn: "String", # required
2481
+ # tags: { # required
2482
+ # "TagKey" => "TagValue",
2483
+ # },
2484
+ # })
2485
+ #
2486
+ # @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/TagResource AWS API Documentation
2487
+ #
2488
+ # @overload tag_resource(params = {})
2489
+ # @param [Hash] params ({})
2490
+ def tag_resource(params = {}, options = {})
2491
+ req = build_request(:tag_resource, params)
2492
+ req.send_request(options)
2493
+ end
2494
+
2156
2495
  # Terminates a job in a job queue. Jobs that are in the `STARTING` or
2157
2496
  # `RUNNING` state are terminated, which causes them to transition to
2158
2497
  # `FAILED`. Jobs that have not progressed to the `STARTING` state are
@@ -2198,6 +2537,51 @@ module Aws::Batch
2198
2537
  req.send_request(options)
2199
2538
  end
2200
2539
 
2540
+ # Deletes specified tags from an AWS Batch resource.
2541
+ #
2542
+ # @option params [required, String] :resource_arn
2543
+ # The Amazon Resource Name (ARN) of the resource from which to delete
2544
+ # tags. AWS Batch resources that support tags are compute environments,
2545
+ # jobs, job definitions, and job queues. ARNs for child jobs of array
2546
+ # and multi-node parallel (MNP) jobs are not supported.
2547
+ #
2548
+ # @option params [required, Array<String>] :tag_keys
2549
+ # The keys of the tags to be removed.
2550
+ #
2551
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
2552
+ #
2553
+ #
2554
+ # @example Example: UntagResource Example
2555
+ #
2556
+ # # This demonstrates calling the UntagResource action.
2557
+ #
2558
+ # resp = client.untag_resource({
2559
+ # resource_arn: "arn:aws:batch:us-east-1:123456789012:job-definition/sleep30:1",
2560
+ # tag_keys: [
2561
+ # "Stage",
2562
+ # ],
2563
+ # })
2564
+ #
2565
+ # resp.to_h outputs the following:
2566
+ # {
2567
+ # }
2568
+ #
2569
+ # @example Request syntax with placeholder values
2570
+ #
2571
+ # resp = client.untag_resource({
2572
+ # resource_arn: "String", # required
2573
+ # tag_keys: ["TagKey"], # required
2574
+ # })
2575
+ #
2576
+ # @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/UntagResource AWS API Documentation
2577
+ #
2578
+ # @overload untag_resource(params = {})
2579
+ # @param [Hash] params ({})
2580
+ def untag_resource(params = {}, options = {})
2581
+ req = build_request(:untag_resource, params)
2582
+ req.send_request(options)
2583
+ end
2584
+
2201
2585
  # Updates an AWS Batch compute environment.
2202
2586
  #
2203
2587
  # @option params [required, String] :compute_environment
@@ -2221,11 +2605,11 @@ module Aws::Batch
2221
2605
  # specify the full role ARN (this is recommended) or prefix the role
2222
2606
  # name with the path.
2223
2607
  #
2224
- # <note markdown="1"> Depending on how you created your AWS Batch service role, its ARN may
2225
- # contain the `service-role` path prefix. When you only specify the name
2226
- # of the service role, AWS Batch assumes that your ARN does not use the
2227
- # `service-role` path prefix. Because of this, we recommend that you
2228
- # specify the full ARN of your service role when you create compute
2608
+ # <note markdown="1"> Depending on how you created your AWS Batch service role, its ARN
2609
+ # might contain the `service-role` path prefix. When you only specify
2610
+ # the name of the service role, AWS Batch assumes that your ARN does not
2611
+ # use the `service-role` path prefix. Because of this, we recommend that
2612
+ # you specify the full ARN of your service role when you create compute
2229
2613
  # environments.
2230
2614
  #
2231
2615
  # </note>
@@ -2260,6 +2644,8 @@ module Aws::Batch
2260
2644
  # minv_cpus: 1,
2261
2645
  # maxv_cpus: 1,
2262
2646
  # desiredv_cpus: 1,
2647
+ # subnets: ["String"],
2648
+ # security_group_ids: ["String"],
2263
2649
  # },
2264
2650
  # service_role: "String",
2265
2651
  # })
@@ -2300,8 +2686,10 @@ module Aws::Batch
2300
2686
  # @option params [Array<Types::ComputeEnvironmentOrder>] :compute_environment_order
2301
2687
  # Details the set of compute environments mapped to a job queue and
2302
2688
  # their order relative to each other. This is one of the parameters used
2303
- # by the job scheduler to determine which compute environment should
2304
- # execute a given job.
2689
+ # by the job scheduler to determine which compute environment should run
2690
+ # a given job. All of the compute environments must be either EC2 (`EC2`
2691
+ # or `SPOT`) or Fargate (`FARGATE` or `FARGATE_SPOT`); EC2 and Fargate
2692
+ # compute environments can't be mixed.
2305
2693
  #
2306
2694
  # @return [Types::UpdateJobQueueResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2307
2695
  #
@@ -2365,7 +2753,7 @@ module Aws::Batch
2365
2753
  params: params,
2366
2754
  config: config)
2367
2755
  context[:gem_name] = 'aws-sdk-batch'
2368
- context[:gem_version] = '1.37.0'
2756
+ context[:gem_version] = '1.42.0'
2369
2757
  Seahorse::Client::Request.new(handlers, context)
2370
2758
  end
2371
2759