aws-sdk-batch 1.61.0 → 1.63.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 +10 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-batch/client.rb +311 -66
- data/lib/aws-sdk-batch/client_api.rb +178 -0
- data/lib/aws-sdk-batch/types.rb +2206 -623
- data/lib/aws-sdk-batch.rb +1 -1
- metadata +2 -2
data/lib/aws-sdk-batch/client.rb
CHANGED
@@ -352,10 +352,10 @@ module Aws::Batch
|
|
352
352
|
# @!group API Operations
|
353
353
|
|
354
354
|
# Cancels a job in an Batch job queue. Jobs that are in the `SUBMITTED`,
|
355
|
-
# `PENDING`, or `RUNNABLE` state are canceled. Jobs that
|
356
|
-
#
|
357
|
-
# still succeeds, even if no job is canceled. These jobs must
|
358
|
-
# terminated with the TerminateJob operation.
|
355
|
+
# `PENDING`, or `RUNNABLE` state are canceled. Jobs that progressed to
|
356
|
+
# the `STARTING` or `RUNNING` state aren't canceled. However, the API
|
357
|
+
# operation still succeeds, even if no job is canceled. These jobs must
|
358
|
+
# be terminated with the TerminateJob operation.
|
359
359
|
#
|
360
360
|
# @option params [required, String] :job_id
|
361
361
|
# The Batch job ID of the job to cancel.
|
@@ -417,9 +417,9 @@ module Aws::Batch
|
|
417
417
|
# </note>
|
418
418
|
#
|
419
419
|
# In an unmanaged compute environment, you can manage your own EC2
|
420
|
-
# compute resources and have
|
421
|
-
#
|
422
|
-
#
|
420
|
+
# compute resources and have flexibility with how you configure your
|
421
|
+
# compute resources. For example, you can use custom AMIs. However, you
|
422
|
+
# must verify that each of your AMIs meet the Amazon ECS container
|
423
423
|
# instance AMI specification. For more information, see [container
|
424
424
|
# instance AMIs][2] in the *Amazon Elastic Container Service Developer
|
425
425
|
# Guide*. After you created your unmanaged compute environment, you can
|
@@ -429,13 +429,15 @@ module Aws::Batch
|
|
429
429
|
# [Launching an Amazon ECS container instance][3] in the *Amazon Elastic
|
430
430
|
# Container Service Developer Guide*.
|
431
431
|
#
|
432
|
-
# <note markdown="1"> Batch doesn't upgrade the AMIs in a compute environment
|
433
|
-
#
|
434
|
-
# a newer version of the Amazon ECS
|
435
|
-
#
|
436
|
-
#
|
437
|
-
#
|
438
|
-
#
|
432
|
+
# <note markdown="1"> Batch doesn't automatically upgrade the AMIs in a compute environment
|
433
|
+
# after it's created. For example, it also doesn't update the AMIs in
|
434
|
+
# your compute environment when a newer version of the Amazon ECS
|
435
|
+
# optimized AMI is available. You're responsible for the management of
|
436
|
+
# the guest operating system. This includes any updates and security
|
437
|
+
# patches. You're also responsible for any additional application
|
438
|
+
# software or utilities that you install on the compute resources. There
|
439
|
+
# are two ways to use a new AMI for your Batch jobs. The original method
|
440
|
+
# is to complete these steps:
|
439
441
|
#
|
440
442
|
# 1. Create a new compute environment with the new AMI.
|
441
443
|
#
|
@@ -445,6 +447,43 @@ module Aws::Batch
|
|
445
447
|
#
|
446
448
|
# 4. Delete the earlier compute environment.
|
447
449
|
#
|
450
|
+
# In April 2022, Batch added enhanced support for updating compute
|
451
|
+
# environments. For more information, see [Updating compute
|
452
|
+
# environments][4]. To use the enhanced updating of compute environments
|
453
|
+
# to update AMIs, follow these rules:
|
454
|
+
#
|
455
|
+
# * Either don't set the service role (`serviceRole`) parameter or set
|
456
|
+
# it to the **AWSBatchServiceRole** service-linked role.
|
457
|
+
#
|
458
|
+
# * Set the allocation strategy (`allocationStrategy`) parameter to
|
459
|
+
# `BEST_FIT_PROGRESSIVE` or `SPOT_CAPACITY_OPTIMIZED`.
|
460
|
+
#
|
461
|
+
# * Set the update to latest image version
|
462
|
+
# (`updateToLatestImageVersion`) parameter to `true`.
|
463
|
+
#
|
464
|
+
# * Don't specify an AMI ID in `imageId`, `imageIdOverride` (in [
|
465
|
+
# `ec2Configuration` ][5]), or in the launch template
|
466
|
+
# (`launchTemplate`). In that case, Batch selects the latest Amazon
|
467
|
+
# ECS optimized AMI that's supported by Batch at the time the
|
468
|
+
# infrastructure update is initiated. Alternatively, you can specify
|
469
|
+
# the AMI ID in the `imageId` or `imageIdOverride` parameters, or the
|
470
|
+
# launch template identified by the `LaunchTemplate` properties.
|
471
|
+
# Changing any of these properties starts an infrastructure update. If
|
472
|
+
# the AMI ID is specified in the launch template, it can't be
|
473
|
+
# replaced by specifying an AMI ID in either the `imageId` or
|
474
|
+
# `imageIdOverride` parameters. It can only be replaced by specifying
|
475
|
+
# a different launch template, or if the launch template version is
|
476
|
+
# set to `$Default` or `$Latest`, by setting either a new default
|
477
|
+
# version for the launch template (if `$Default`) or by adding a new
|
478
|
+
# version to the launch template (if `$Latest`).
|
479
|
+
#
|
480
|
+
# If these rules are followed, any update that starts an infrastructure
|
481
|
+
# update causes the AMI ID to be re-selected. If the `version` setting
|
482
|
+
# in the launch template (`launchTemplate`) is set to `$Latest` or
|
483
|
+
# `$Default`, the latest or default version of the launch template is
|
484
|
+
# evaluated up at the time of the infrastructure update, even if the
|
485
|
+
# `launchTemplate` wasn't updated.
|
486
|
+
#
|
448
487
|
# </note>
|
449
488
|
#
|
450
489
|
#
|
@@ -452,9 +491,11 @@ module Aws::Batch
|
|
452
491
|
# [1]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-launch-templates.html
|
453
492
|
# [2]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/container_instance_AMIs.html
|
454
493
|
# [3]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/launch_container_instance.html
|
494
|
+
# [4]: https://docs.aws.amazon.com/batch/latest/userguide/updating-compute-environments.html
|
495
|
+
# [5]: https://docs.aws.amazon.com/batch/latest/APIReference/API_Ec2Configuration.html
|
455
496
|
#
|
456
497
|
# @option params [required, String] :compute_environment_name
|
457
|
-
# The name for your compute environment. It can be up to 128
|
498
|
+
# The name for your compute environment. It can be up to 128 characters
|
458
499
|
# long. It can contain uppercase and lowercase letters, numbers, hyphens
|
459
500
|
# (-), and underscores (\_).
|
460
501
|
#
|
@@ -521,9 +562,8 @@ module Aws::Batch
|
|
521
562
|
# If your specified role has a path other than `/`, then you must
|
522
563
|
# specify either the full role ARN (recommended) or prefix the role name
|
523
564
|
# with the path. For example, if a role with the name `bar` has a path
|
524
|
-
# of `/foo
|
525
|
-
#
|
526
|
-
# Guide*.
|
565
|
+
# of `/foo/`, specify `/foo/bar` as the role name. For more information,
|
566
|
+
# see [Friendly names and paths][2] in the *IAM User Guide*.
|
527
567
|
#
|
528
568
|
# <note markdown="1"> Depending on how you created your Batch service role, its ARN might
|
529
569
|
# contain the `service-role` path prefix. When you only specify the name
|
@@ -555,6 +595,10 @@ module Aws::Batch
|
|
555
595
|
# [2]: https://docs.aws.amazon.com/batch/latest/APIReference/API_TagResource.html
|
556
596
|
# [3]: https://docs.aws.amazon.com/batch/latest/APIReference/API_UntagResource.html
|
557
597
|
#
|
598
|
+
# @option params [Types::EksConfiguration] :eks_configuration
|
599
|
+
# The details for the Amazon EKS cluster that supports the compute
|
600
|
+
# environment.
|
601
|
+
#
|
558
602
|
# @return [Types::CreateComputeEnvironmentResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
559
603
|
#
|
560
604
|
# * {Types::CreateComputeEnvironmentResponse#compute_environment_name #compute_environment_name} => String
|
@@ -681,6 +725,7 @@ module Aws::Batch
|
|
681
725
|
# {
|
682
726
|
# image_type: "ImageType", # required
|
683
727
|
# image_id_override: "ImageIdOverride",
|
728
|
+
# image_kubernetes_version: "KubernetesVersion",
|
684
729
|
# },
|
685
730
|
# ],
|
686
731
|
# },
|
@@ -688,6 +733,10 @@ module Aws::Batch
|
|
688
733
|
# tags: {
|
689
734
|
# "TagKey" => "TagValue",
|
690
735
|
# },
|
736
|
+
# eks_configuration: {
|
737
|
+
# eks_cluster_arn: "String", # required
|
738
|
+
# kubernetes_namespace: "String", # required
|
739
|
+
# },
|
691
740
|
# })
|
692
741
|
#
|
693
742
|
# @example Response structure
|
@@ -734,7 +783,7 @@ module Aws::Batch
|
|
734
783
|
# scheduling policy. The format is
|
735
784
|
# `aws:Partition:batch:Region:Account:scheduling-policy/Name `. An
|
736
785
|
# example is
|
737
|
-
# `aws:aws:batch:us-west-2:
|
786
|
+
# `aws:aws:batch:us-west-2:123456789012:scheduling-policy/MySchedulingPolicy`.
|
738
787
|
#
|
739
788
|
# @option params [required, Integer] :priority
|
740
789
|
# The priority of the job queue. Job queues with a higher priority (or a
|
@@ -1098,9 +1147,8 @@ module Aws::Batch
|
|
1098
1147
|
# from the end of the previous results that returned the `nextToken`
|
1099
1148
|
# value. This value is `null` when there are no more results to return.
|
1100
1149
|
#
|
1101
|
-
# <note markdown="1">
|
1102
|
-
#
|
1103
|
-
# purposes.
|
1150
|
+
# <note markdown="1"> Treat this token as an opaque identifier that's only used to retrieve
|
1151
|
+
# the next items in a list and not for other programmatic purposes.
|
1104
1152
|
#
|
1105
1153
|
# </note>
|
1106
1154
|
#
|
@@ -1206,9 +1254,14 @@ module Aws::Batch
|
|
1206
1254
|
# resp.compute_environments[0].compute_resources.ec2_configuration #=> Array
|
1207
1255
|
# resp.compute_environments[0].compute_resources.ec2_configuration[0].image_type #=> String
|
1208
1256
|
# resp.compute_environments[0].compute_resources.ec2_configuration[0].image_id_override #=> String
|
1257
|
+
# resp.compute_environments[0].compute_resources.ec2_configuration[0].image_kubernetes_version #=> String
|
1209
1258
|
# resp.compute_environments[0].service_role #=> String
|
1210
1259
|
# resp.compute_environments[0].update_policy.terminate_jobs_on_update #=> Boolean
|
1211
1260
|
# resp.compute_environments[0].update_policy.job_execution_timeout_minutes #=> Integer
|
1261
|
+
# resp.compute_environments[0].eks_configuration.eks_cluster_arn #=> String
|
1262
|
+
# resp.compute_environments[0].eks_configuration.kubernetes_namespace #=> String
|
1263
|
+
# resp.compute_environments[0].container_orchestration_type #=> String, one of "ECS", "EKS"
|
1264
|
+
# resp.compute_environments[0].uuid #=> String
|
1212
1265
|
# resp.next_token #=> String
|
1213
1266
|
#
|
1214
1267
|
# @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/DescribeComputeEnvironments AWS API Documentation
|
@@ -1254,9 +1307,8 @@ module Aws::Batch
|
|
1254
1307
|
# from the end of the previous results that returned the `nextToken`
|
1255
1308
|
# value. This value is `null` when there are no more results to return.
|
1256
1309
|
#
|
1257
|
-
# <note markdown="1">
|
1258
|
-
#
|
1259
|
-
# purposes.
|
1310
|
+
# <note markdown="1"> Treat this token as an opaque identifier that's only used to retrieve
|
1311
|
+
# the next items in a list and not for other programmatic purposes.
|
1260
1312
|
#
|
1261
1313
|
# </note>
|
1262
1314
|
#
|
@@ -1469,6 +1521,41 @@ module Aws::Batch
|
|
1469
1521
|
# resp.job_definitions[0].propagate_tags #=> Boolean
|
1470
1522
|
# resp.job_definitions[0].platform_capabilities #=> Array
|
1471
1523
|
# resp.job_definitions[0].platform_capabilities[0] #=> String, one of "EC2", "FARGATE"
|
1524
|
+
# resp.job_definitions[0].eks_properties.pod_properties.service_account_name #=> String
|
1525
|
+
# resp.job_definitions[0].eks_properties.pod_properties.host_network #=> Boolean
|
1526
|
+
# resp.job_definitions[0].eks_properties.pod_properties.dns_policy #=> String
|
1527
|
+
# resp.job_definitions[0].eks_properties.pod_properties.containers #=> Array
|
1528
|
+
# resp.job_definitions[0].eks_properties.pod_properties.containers[0].name #=> String
|
1529
|
+
# resp.job_definitions[0].eks_properties.pod_properties.containers[0].image #=> String
|
1530
|
+
# resp.job_definitions[0].eks_properties.pod_properties.containers[0].image_pull_policy #=> String
|
1531
|
+
# resp.job_definitions[0].eks_properties.pod_properties.containers[0].command #=> Array
|
1532
|
+
# resp.job_definitions[0].eks_properties.pod_properties.containers[0].command[0] #=> String
|
1533
|
+
# resp.job_definitions[0].eks_properties.pod_properties.containers[0].args #=> Array
|
1534
|
+
# resp.job_definitions[0].eks_properties.pod_properties.containers[0].args[0] #=> String
|
1535
|
+
# resp.job_definitions[0].eks_properties.pod_properties.containers[0].env #=> Array
|
1536
|
+
# resp.job_definitions[0].eks_properties.pod_properties.containers[0].env[0].name #=> String
|
1537
|
+
# resp.job_definitions[0].eks_properties.pod_properties.containers[0].env[0].value #=> String
|
1538
|
+
# resp.job_definitions[0].eks_properties.pod_properties.containers[0].resources.limits #=> Hash
|
1539
|
+
# resp.job_definitions[0].eks_properties.pod_properties.containers[0].resources.limits["String"] #=> String
|
1540
|
+
# resp.job_definitions[0].eks_properties.pod_properties.containers[0].resources.requests #=> Hash
|
1541
|
+
# resp.job_definitions[0].eks_properties.pod_properties.containers[0].resources.requests["String"] #=> String
|
1542
|
+
# resp.job_definitions[0].eks_properties.pod_properties.containers[0].volume_mounts #=> Array
|
1543
|
+
# resp.job_definitions[0].eks_properties.pod_properties.containers[0].volume_mounts[0].name #=> String
|
1544
|
+
# resp.job_definitions[0].eks_properties.pod_properties.containers[0].volume_mounts[0].mount_path #=> String
|
1545
|
+
# resp.job_definitions[0].eks_properties.pod_properties.containers[0].volume_mounts[0].read_only #=> Boolean
|
1546
|
+
# resp.job_definitions[0].eks_properties.pod_properties.containers[0].security_context.run_as_user #=> Integer
|
1547
|
+
# resp.job_definitions[0].eks_properties.pod_properties.containers[0].security_context.run_as_group #=> Integer
|
1548
|
+
# resp.job_definitions[0].eks_properties.pod_properties.containers[0].security_context.privileged #=> Boolean
|
1549
|
+
# resp.job_definitions[0].eks_properties.pod_properties.containers[0].security_context.read_only_root_filesystem #=> Boolean
|
1550
|
+
# resp.job_definitions[0].eks_properties.pod_properties.containers[0].security_context.run_as_non_root #=> Boolean
|
1551
|
+
# resp.job_definitions[0].eks_properties.pod_properties.volumes #=> Array
|
1552
|
+
# resp.job_definitions[0].eks_properties.pod_properties.volumes[0].name #=> String
|
1553
|
+
# resp.job_definitions[0].eks_properties.pod_properties.volumes[0].host_path.path #=> String
|
1554
|
+
# resp.job_definitions[0].eks_properties.pod_properties.volumes[0].empty_dir.medium #=> String
|
1555
|
+
# resp.job_definitions[0].eks_properties.pod_properties.volumes[0].empty_dir.size_limit #=> String
|
1556
|
+
# resp.job_definitions[0].eks_properties.pod_properties.volumes[0].secret.secret_name #=> String
|
1557
|
+
# resp.job_definitions[0].eks_properties.pod_properties.volumes[0].secret.optional #=> Boolean
|
1558
|
+
# resp.job_definitions[0].container_orchestration_type #=> String, one of "ECS", "EKS"
|
1472
1559
|
# resp.next_token #=> String
|
1473
1560
|
#
|
1474
1561
|
# @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/DescribeJobDefinitions AWS API Documentation
|
@@ -1503,9 +1590,8 @@ module Aws::Batch
|
|
1503
1590
|
# from the end of the previous results that returned the `nextToken`
|
1504
1591
|
# value. This value is `null` when there are no more results to return.
|
1505
1592
|
#
|
1506
|
-
# <note markdown="1">
|
1507
|
-
#
|
1508
|
-
# purposes.
|
1593
|
+
# <note markdown="1"> Treat this token as an opaque identifier that's only used to retrieve
|
1594
|
+
# the next items in a list and not for other programmatic purposes.
|
1509
1595
|
#
|
1510
1596
|
# </note>
|
1511
1597
|
#
|
@@ -1828,6 +1914,53 @@ module Aws::Batch
|
|
1828
1914
|
# resp.jobs[0].propagate_tags #=> Boolean
|
1829
1915
|
# resp.jobs[0].platform_capabilities #=> Array
|
1830
1916
|
# resp.jobs[0].platform_capabilities[0] #=> String, one of "EC2", "FARGATE"
|
1917
|
+
# resp.jobs[0].eks_properties.pod_properties.service_account_name #=> String
|
1918
|
+
# resp.jobs[0].eks_properties.pod_properties.host_network #=> Boolean
|
1919
|
+
# resp.jobs[0].eks_properties.pod_properties.dns_policy #=> String
|
1920
|
+
# resp.jobs[0].eks_properties.pod_properties.containers #=> Array
|
1921
|
+
# resp.jobs[0].eks_properties.pod_properties.containers[0].name #=> String
|
1922
|
+
# resp.jobs[0].eks_properties.pod_properties.containers[0].image #=> String
|
1923
|
+
# resp.jobs[0].eks_properties.pod_properties.containers[0].image_pull_policy #=> String
|
1924
|
+
# resp.jobs[0].eks_properties.pod_properties.containers[0].command #=> Array
|
1925
|
+
# resp.jobs[0].eks_properties.pod_properties.containers[0].command[0] #=> String
|
1926
|
+
# resp.jobs[0].eks_properties.pod_properties.containers[0].args #=> Array
|
1927
|
+
# resp.jobs[0].eks_properties.pod_properties.containers[0].args[0] #=> String
|
1928
|
+
# resp.jobs[0].eks_properties.pod_properties.containers[0].env #=> Array
|
1929
|
+
# resp.jobs[0].eks_properties.pod_properties.containers[0].env[0].name #=> String
|
1930
|
+
# resp.jobs[0].eks_properties.pod_properties.containers[0].env[0].value #=> String
|
1931
|
+
# resp.jobs[0].eks_properties.pod_properties.containers[0].resources.limits #=> Hash
|
1932
|
+
# resp.jobs[0].eks_properties.pod_properties.containers[0].resources.limits["String"] #=> String
|
1933
|
+
# resp.jobs[0].eks_properties.pod_properties.containers[0].resources.requests #=> Hash
|
1934
|
+
# resp.jobs[0].eks_properties.pod_properties.containers[0].resources.requests["String"] #=> String
|
1935
|
+
# resp.jobs[0].eks_properties.pod_properties.containers[0].exit_code #=> Integer
|
1936
|
+
# resp.jobs[0].eks_properties.pod_properties.containers[0].reason #=> String
|
1937
|
+
# resp.jobs[0].eks_properties.pod_properties.containers[0].volume_mounts #=> Array
|
1938
|
+
# resp.jobs[0].eks_properties.pod_properties.containers[0].volume_mounts[0].name #=> String
|
1939
|
+
# resp.jobs[0].eks_properties.pod_properties.containers[0].volume_mounts[0].mount_path #=> String
|
1940
|
+
# resp.jobs[0].eks_properties.pod_properties.containers[0].volume_mounts[0].read_only #=> Boolean
|
1941
|
+
# resp.jobs[0].eks_properties.pod_properties.containers[0].security_context.run_as_user #=> Integer
|
1942
|
+
# resp.jobs[0].eks_properties.pod_properties.containers[0].security_context.run_as_group #=> Integer
|
1943
|
+
# resp.jobs[0].eks_properties.pod_properties.containers[0].security_context.privileged #=> Boolean
|
1944
|
+
# resp.jobs[0].eks_properties.pod_properties.containers[0].security_context.read_only_root_filesystem #=> Boolean
|
1945
|
+
# resp.jobs[0].eks_properties.pod_properties.containers[0].security_context.run_as_non_root #=> Boolean
|
1946
|
+
# resp.jobs[0].eks_properties.pod_properties.volumes #=> Array
|
1947
|
+
# resp.jobs[0].eks_properties.pod_properties.volumes[0].name #=> String
|
1948
|
+
# resp.jobs[0].eks_properties.pod_properties.volumes[0].host_path.path #=> String
|
1949
|
+
# resp.jobs[0].eks_properties.pod_properties.volumes[0].empty_dir.medium #=> String
|
1950
|
+
# resp.jobs[0].eks_properties.pod_properties.volumes[0].empty_dir.size_limit #=> String
|
1951
|
+
# resp.jobs[0].eks_properties.pod_properties.volumes[0].secret.secret_name #=> String
|
1952
|
+
# resp.jobs[0].eks_properties.pod_properties.volumes[0].secret.optional #=> Boolean
|
1953
|
+
# resp.jobs[0].eks_properties.pod_properties.pod_name #=> String
|
1954
|
+
# resp.jobs[0].eks_properties.pod_properties.node_name #=> String
|
1955
|
+
# resp.jobs[0].eks_attempts #=> Array
|
1956
|
+
# resp.jobs[0].eks_attempts[0].containers #=> Array
|
1957
|
+
# resp.jobs[0].eks_attempts[0].containers[0].exit_code #=> Integer
|
1958
|
+
# resp.jobs[0].eks_attempts[0].containers[0].reason #=> String
|
1959
|
+
# resp.jobs[0].eks_attempts[0].pod_name #=> String
|
1960
|
+
# resp.jobs[0].eks_attempts[0].node_name #=> String
|
1961
|
+
# resp.jobs[0].eks_attempts[0].started_at #=> Integer
|
1962
|
+
# resp.jobs[0].eks_attempts[0].stopped_at #=> Integer
|
1963
|
+
# resp.jobs[0].eks_attempts[0].status_reason #=> String
|
1831
1964
|
#
|
1832
1965
|
# @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/DescribeJobs AWS API Documentation
|
1833
1966
|
#
|
@@ -1926,9 +2059,8 @@ module Aws::Batch
|
|
1926
2059
|
# results that returned the `nextToken` value. This value is `null` when
|
1927
2060
|
# there are no more results to return.
|
1928
2061
|
#
|
1929
|
-
# <note markdown="1">
|
1930
|
-
#
|
1931
|
-
# purposes.
|
2062
|
+
# <note markdown="1"> Treat this token as an opaque identifier that's only used to retrieve
|
2063
|
+
# the next items in a list and not for other programmatic purposes.
|
1932
2064
|
#
|
1933
2065
|
# </note>
|
1934
2066
|
#
|
@@ -1942,7 +2074,7 @@ module Aws::Batch
|
|
1942
2074
|
# JOB\_NAME
|
1943
2075
|
#
|
1944
2076
|
# : The value of the filter is a case-insensitive match for the job
|
1945
|
-
# name. If the value ends with an asterisk (*), the filter
|
2077
|
+
# name. If the value ends with an asterisk (*), the filter matches
|
1946
2078
|
# any job name that begins with the string before the '*'. This
|
1947
2079
|
# corresponds to the `jobName` value. For example, `test1` matches
|
1948
2080
|
# both `Test1` and `test1`, and `test1*` matches both `test1` and
|
@@ -1956,7 +2088,7 @@ module Aws::Batch
|
|
1956
2088
|
# value. The value is case sensitive. When the value for the filter is
|
1957
2089
|
# the job definition name, the results include all the jobs that used
|
1958
2090
|
# any revision of that job definition name. If the value ends with an
|
1959
|
-
# asterisk (*), the filter
|
2091
|
+
# asterisk (*), the filter matches any job definition name that
|
1960
2092
|
# begins with the string before the '*'. For example, `jd1` matches
|
1961
2093
|
# only `jd1`, and `jd1*` matches both `jd1` and `jd1A`. The version of
|
1962
2094
|
# the job definition that's used doesn't affect the sort order. When
|
@@ -1964,7 +2096,7 @@ module Aws::Batch
|
|
1964
2096
|
# the form
|
1965
2097
|
# `arn:$\{Partition\}:batch:$\{Region\}:$\{Account\}:job-definition/$\{JobDefinitionName\}:$\{Revision\}`),
|
1966
2098
|
# the results include jobs that used the specified revision of the job
|
1967
|
-
# definition. Asterisk (*)
|
2099
|
+
# definition. Asterisk (*) isn't supported when the ARN is used.
|
1968
2100
|
#
|
1969
2101
|
# BEFORE\_CREATED\_AT
|
1970
2102
|
#
|
@@ -2092,9 +2224,8 @@ module Aws::Batch
|
|
2092
2224
|
# from the end of the previous results that returned the `nextToken`
|
2093
2225
|
# value. This value is `null` when there are no more results to return.
|
2094
2226
|
#
|
2095
|
-
# <note markdown="1">
|
2096
|
-
#
|
2097
|
-
# purposes.
|
2227
|
+
# <note markdown="1"> Treat this token as an opaque identifier that's only used to retrieve
|
2228
|
+
# the next items in a list and not for other programmatic purposes.
|
2098
2229
|
#
|
2099
2230
|
# </note>
|
2100
2231
|
#
|
@@ -2130,14 +2261,14 @@ module Aws::Batch
|
|
2130
2261
|
# Lists the tags for an Batch resource. Batch resources that support
|
2131
2262
|
# tags are compute environments, jobs, job definitions, job queues, and
|
2132
2263
|
# scheduling policies. ARNs for child jobs of array and multi-node
|
2133
|
-
# parallel (MNP) jobs
|
2264
|
+
# parallel (MNP) jobs aren't supported.
|
2134
2265
|
#
|
2135
2266
|
# @option params [required, String] :resource_arn
|
2136
2267
|
# The Amazon Resource Name (ARN) that identifies the resource that tags
|
2137
2268
|
# are listed for. Batch resources that support tags are compute
|
2138
2269
|
# environments, jobs, job definitions, job queues, and scheduling
|
2139
2270
|
# policies. ARNs for child jobs of array and multi-node parallel (MNP)
|
2140
|
-
# jobs
|
2271
|
+
# jobs aren't supported.
|
2141
2272
|
#
|
2142
2273
|
# @return [Types::ListTagsForResourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2143
2274
|
#
|
@@ -2210,18 +2341,19 @@ module Aws::Batch
|
|
2210
2341
|
#
|
2211
2342
|
# @option params [Integer] :scheduling_priority
|
2212
2343
|
# The scheduling priority for jobs that are submitted with this job
|
2213
|
-
# definition. This
|
2214
|
-
# policy. Jobs with a higher scheduling priority
|
2215
|
-
#
|
2344
|
+
# definition. This only affects jobs in job queues with a fair share
|
2345
|
+
# policy. Jobs with a higher scheduling priority are scheduled before
|
2346
|
+
# jobs with a lower scheduling priority.
|
2216
2347
|
#
|
2217
2348
|
# The minimum supported value is 0 and the maximum supported value is
|
2218
2349
|
# 9999.
|
2219
2350
|
#
|
2220
2351
|
# @option params [Types::ContainerProperties] :container_properties
|
2221
|
-
# An object with various properties specific to
|
2222
|
-
# container-based jobs. If the job definition's `type`
|
2223
|
-
# `container`, then you must specify either
|
2224
|
-
# `nodeProperties`.
|
2352
|
+
# An object with various properties specific to Amazon ECS based
|
2353
|
+
# single-node container-based jobs. If the job definition's `type`
|
2354
|
+
# parameter is `container`, then you must specify either
|
2355
|
+
# `containerProperties` or `nodeProperties`. This must not be specified
|
2356
|
+
# for Amazon EKS based job definitions.
|
2225
2357
|
#
|
2226
2358
|
# <note markdown="1"> If the job runs on Fargate resources, then you must not specify
|
2227
2359
|
# `nodeProperties`; use only `containerProperties`.
|
@@ -2241,6 +2373,11 @@ module Aws::Batch
|
|
2241
2373
|
#
|
2242
2374
|
# </note>
|
2243
2375
|
#
|
2376
|
+
# <note markdown="1"> If the job runs on Amazon EKS resources, then you must not specify
|
2377
|
+
# `nodeProperties`.
|
2378
|
+
#
|
2379
|
+
# </note>
|
2380
|
+
#
|
2244
2381
|
#
|
2245
2382
|
#
|
2246
2383
|
# [1]: https://docs.aws.amazon.com/batch/latest/userguide/multi-node-parallel-jobs.html
|
@@ -2260,6 +2397,11 @@ module Aws::Batch
|
|
2260
2397
|
# tags from the job and job definition is over 50, the job is moved to
|
2261
2398
|
# the `FAILED` state.
|
2262
2399
|
#
|
2400
|
+
# <note markdown="1"> If the job runs on Amazon EKS resources, then you must not specify
|
2401
|
+
# `propagateTags`.
|
2402
|
+
#
|
2403
|
+
# </note>
|
2404
|
+
#
|
2263
2405
|
# @option params [Types::JobTimeout] :timeout
|
2264
2406
|
# The timeout configuration for jobs that are submitted with this job
|
2265
2407
|
# definition, after which Batch terminates your jobs if they have not
|
@@ -2288,6 +2430,16 @@ module Aws::Batch
|
|
2288
2430
|
# is specified, it defaults to `EC2`. To run the job on Fargate
|
2289
2431
|
# resources, specify `FARGATE`.
|
2290
2432
|
#
|
2433
|
+
# <note markdown="1"> If the job runs on Amazon EKS resources, then you must not specify
|
2434
|
+
# `platformCapabilities`.
|
2435
|
+
#
|
2436
|
+
# </note>
|
2437
|
+
#
|
2438
|
+
# @option params [Types::EksProperties] :eks_properties
|
2439
|
+
# An object with various properties that are specific to Amazon EKS
|
2440
|
+
# based jobs. This must not be specified for Amazon ECS based job
|
2441
|
+
# definitions.
|
2442
|
+
#
|
2291
2443
|
# @return [Types::RegisterJobDefinitionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2292
2444
|
#
|
2293
2445
|
# * {Types::RegisterJobDefinitionResponse#job_definition_name #job_definition_name} => String
|
@@ -2602,6 +2754,66 @@ module Aws::Batch
|
|
2602
2754
|
# "TagKey" => "TagValue",
|
2603
2755
|
# },
|
2604
2756
|
# platform_capabilities: ["EC2"], # accepts EC2, FARGATE
|
2757
|
+
# eks_properties: {
|
2758
|
+
# pod_properties: {
|
2759
|
+
# service_account_name: "String",
|
2760
|
+
# host_network: false,
|
2761
|
+
# dns_policy: "String",
|
2762
|
+
# containers: [
|
2763
|
+
# {
|
2764
|
+
# name: "String",
|
2765
|
+
# image: "String", # required
|
2766
|
+
# image_pull_policy: "String",
|
2767
|
+
# command: ["String"],
|
2768
|
+
# args: ["String"],
|
2769
|
+
# env: [
|
2770
|
+
# {
|
2771
|
+
# name: "String", # required
|
2772
|
+
# value: "String",
|
2773
|
+
# },
|
2774
|
+
# ],
|
2775
|
+
# resources: {
|
2776
|
+
# limits: {
|
2777
|
+
# "String" => "Quantity",
|
2778
|
+
# },
|
2779
|
+
# requests: {
|
2780
|
+
# "String" => "Quantity",
|
2781
|
+
# },
|
2782
|
+
# },
|
2783
|
+
# volume_mounts: [
|
2784
|
+
# {
|
2785
|
+
# name: "String",
|
2786
|
+
# mount_path: "String",
|
2787
|
+
# read_only: false,
|
2788
|
+
# },
|
2789
|
+
# ],
|
2790
|
+
# security_context: {
|
2791
|
+
# run_as_user: 1,
|
2792
|
+
# run_as_group: 1,
|
2793
|
+
# privileged: false,
|
2794
|
+
# read_only_root_filesystem: false,
|
2795
|
+
# run_as_non_root: false,
|
2796
|
+
# },
|
2797
|
+
# },
|
2798
|
+
# ],
|
2799
|
+
# volumes: [
|
2800
|
+
# {
|
2801
|
+
# name: "String", # required
|
2802
|
+
# host_path: {
|
2803
|
+
# path: "String",
|
2804
|
+
# },
|
2805
|
+
# empty_dir: {
|
2806
|
+
# medium: "String",
|
2807
|
+
# size_limit: "Quantity",
|
2808
|
+
# },
|
2809
|
+
# secret: {
|
2810
|
+
# secret_name: "String", # required
|
2811
|
+
# optional: false,
|
2812
|
+
# },
|
2813
|
+
# },
|
2814
|
+
# ],
|
2815
|
+
# },
|
2816
|
+
# },
|
2605
2817
|
# })
|
2606
2818
|
#
|
2607
2819
|
# @example Response structure
|
@@ -2647,14 +2859,16 @@ module Aws::Batch
|
|
2647
2859
|
# name or the Amazon Resource Name (ARN) of the queue.
|
2648
2860
|
#
|
2649
2861
|
# @option params [String] :share_identifier
|
2650
|
-
# The share identifier for the job.
|
2862
|
+
# The share identifier for the job. If the job queue doesn't have a
|
2863
|
+
# scheduling policy, then this parameter must not be specified. If the
|
2864
|
+
# job queue has a scheduling policy, then this parameter must be
|
2865
|
+
# specified.
|
2651
2866
|
#
|
2652
2867
|
# @option params [Integer] :scheduling_priority_override
|
2653
|
-
# The scheduling priority for the job. This
|
2868
|
+
# The scheduling priority for the job. This only affects jobs in job
|
2654
2869
|
# queues with a fair share policy. Jobs with a higher scheduling
|
2655
|
-
# priority
|
2656
|
-
#
|
2657
|
-
# definition.
|
2870
|
+
# priority are scheduled before jobs with a lower scheduling priority.
|
2871
|
+
# This overrides any scheduling priority in the job definition.
|
2658
2872
|
#
|
2659
2873
|
# The minimum supported value is 0 and the maximum supported value is
|
2660
2874
|
# 9999.
|
@@ -2692,13 +2906,13 @@ module Aws::Batch
|
|
2692
2906
|
# from the job definition.
|
2693
2907
|
#
|
2694
2908
|
# @option params [Types::ContainerOverrides] :container_overrides
|
2695
|
-
#
|
2696
|
-
#
|
2697
|
-
#
|
2698
|
-
#
|
2699
|
-
# `command` override. You can
|
2700
|
-
# variables on a container or add new
|
2701
|
-
# an `environment` override.
|
2909
|
+
# An object with various properties that override the defaults for the
|
2910
|
+
# job definition that specify the name of a container in the specified
|
2911
|
+
# job definition and the overrides it should receive. You can override
|
2912
|
+
# the default command for a container, which is specified in the job
|
2913
|
+
# definition or the Docker image, with a `command` override. You can
|
2914
|
+
# also override existing environment variables on a container or add new
|
2915
|
+
# environment variables to it with an `environment` override.
|
2702
2916
|
#
|
2703
2917
|
# @option params [Types::NodeOverrides] :node_overrides
|
2704
2918
|
# A list of node overrides in JSON format that specify the node range to
|
@@ -2749,6 +2963,11 @@ module Aws::Batch
|
|
2749
2963
|
#
|
2750
2964
|
# [1]: https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html
|
2751
2965
|
#
|
2966
|
+
# @option params [Types::EksPropertiesOverride] :eks_properties_override
|
2967
|
+
# An object that can only be specified for jobs that are run on Amazon
|
2968
|
+
# EKS resources with various properties that override defaults for the
|
2969
|
+
# job definition.
|
2970
|
+
#
|
2752
2971
|
# @return [Types::SubmitJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2753
2972
|
#
|
2754
2973
|
# * {Types::SubmitJobResponse#job_arn #job_arn} => String
|
@@ -2854,6 +3073,31 @@ module Aws::Batch
|
|
2854
3073
|
# tags: {
|
2855
3074
|
# "TagKey" => "TagValue",
|
2856
3075
|
# },
|
3076
|
+
# eks_properties_override: {
|
3077
|
+
# pod_properties: {
|
3078
|
+
# containers: [
|
3079
|
+
# {
|
3080
|
+
# image: "String",
|
3081
|
+
# command: ["String"],
|
3082
|
+
# args: ["String"],
|
3083
|
+
# env: [
|
3084
|
+
# {
|
3085
|
+
# name: "String", # required
|
3086
|
+
# value: "String",
|
3087
|
+
# },
|
3088
|
+
# ],
|
3089
|
+
# resources: {
|
3090
|
+
# limits: {
|
3091
|
+
# "String" => "Quantity",
|
3092
|
+
# },
|
3093
|
+
# requests: {
|
3094
|
+
# "String" => "Quantity",
|
3095
|
+
# },
|
3096
|
+
# },
|
3097
|
+
# },
|
3098
|
+
# ],
|
3099
|
+
# },
|
3100
|
+
# },
|
2857
3101
|
# })
|
2858
3102
|
#
|
2859
3103
|
# @example Response structure
|
@@ -2877,13 +3121,13 @@ module Aws::Batch
|
|
2877
3121
|
# the tags that are associated with that resource are deleted as well.
|
2878
3122
|
# Batch resources that support tags are compute environments, jobs, job
|
2879
3123
|
# definitions, job queues, and scheduling policies. ARNs for child jobs
|
2880
|
-
# of array and multi-node parallel (MNP) jobs
|
3124
|
+
# of array and multi-node parallel (MNP) jobs aren't supported.
|
2881
3125
|
#
|
2882
3126
|
# @option params [required, String] :resource_arn
|
2883
3127
|
# The Amazon Resource Name (ARN) of the resource that tags are added to.
|
2884
3128
|
# Batch resources that support tags are compute environments, jobs, job
|
2885
3129
|
# definitions, job queues, and scheduling policies. ARNs for child jobs
|
2886
|
-
# of array and multi-node parallel (MNP) jobs
|
3130
|
+
# of array and multi-node parallel (MNP) jobs aren't supported.
|
2887
3131
|
#
|
2888
3132
|
# @option params [required, Hash<String,String>] :tags
|
2889
3133
|
# The tags that you apply to the resource to help you categorize and
|
@@ -2982,7 +3226,7 @@ module Aws::Batch
|
|
2982
3226
|
# The Amazon Resource Name (ARN) of the resource from which to delete
|
2983
3227
|
# tags. Batch resources that support tags are compute environments,
|
2984
3228
|
# jobs, job definitions, job queues, and scheduling policies. ARNs for
|
2985
|
-
# child jobs of array and multi-node parallel (MNP) jobs
|
3229
|
+
# child jobs of array and multi-node parallel (MNP) jobs aren't
|
2986
3230
|
# supported.
|
2987
3231
|
#
|
2988
3232
|
# @option params [required, Array<String>] :tag_keys
|
@@ -3047,11 +3291,11 @@ module Aws::Batch
|
|
3047
3291
|
#
|
3048
3292
|
# @option params [Integer] :unmanagedv_cpus
|
3049
3293
|
# The maximum number of vCPUs expected to be used for an unmanaged
|
3050
|
-
# compute environment.
|
3294
|
+
# compute environment. Don't specify this parameter for a managed
|
3051
3295
|
# compute environment. This parameter is only used for fair share
|
3052
3296
|
# scheduling to reserve vCPU capacity for new share identifiers. If this
|
3053
|
-
# parameter
|
3054
|
-
#
|
3297
|
+
# parameter isn't provided for a fair share job queue, no vCPU capacity
|
3298
|
+
# is reserved.
|
3055
3299
|
#
|
3056
3300
|
# @option params [Types::ComputeResourceUpdate] :compute_resources
|
3057
3301
|
# Details of the compute resources managed by the compute environment.
|
@@ -3155,6 +3399,7 @@ module Aws::Batch
|
|
3155
3399
|
# {
|
3156
3400
|
# image_type: "ImageType", # required
|
3157
3401
|
# image_id_override: "ImageIdOverride",
|
3402
|
+
# image_kubernetes_version: "KubernetesVersion",
|
3158
3403
|
# },
|
3159
3404
|
# ],
|
3160
3405
|
# update_to_latest_image_version: false,
|
@@ -3199,7 +3444,7 @@ module Aws::Batch
|
|
3199
3444
|
# but not removed. The format is
|
3200
3445
|
# `aws:Partition:batch:Region:Account:scheduling-policy/Name `. For
|
3201
3446
|
# example,
|
3202
|
-
# `aws:aws:batch:us-west-2:
|
3447
|
+
# `aws:aws:batch:us-west-2:123456789012:scheduling-policy/MySchedulingPolicy`.
|
3203
3448
|
#
|
3204
3449
|
# @option params [Integer] :priority
|
3205
3450
|
# The priority of the job queue. Job queues with a higher priority (or a
|
@@ -3325,7 +3570,7 @@ module Aws::Batch
|
|
3325
3570
|
params: params,
|
3326
3571
|
config: config)
|
3327
3572
|
context[:gem_name] = 'aws-sdk-batch'
|
3328
|
-
context[:gem_version] = '1.
|
3573
|
+
context[:gem_version] = '1.63.0'
|
3329
3574
|
Seahorse::Client::Request.new(handlers, context)
|
3330
3575
|
end
|
3331
3576
|
|