aws-sdk-batch 1.62.0 → 1.64.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 +301 -83
- data/lib/aws-sdk-batch/client_api.rb +178 -0
- data/lib/aws-sdk-batch/endpoint_parameters.rb +66 -0
- data/lib/aws-sdk-batch/endpoint_provider.rb +122 -0
- data/lib/aws-sdk-batch/endpoints.rb +351 -0
- data/lib/aws-sdk-batch/plugins/endpoints.rb +116 -0
- data/lib/aws-sdk-batch/types.rb +2199 -623
- data/lib/aws-sdk-batch.rb +5 -1
- metadata +8 -4
data/lib/aws-sdk-batch/client.rb
CHANGED
@@ -30,7 +30,7 @@ require 'aws-sdk-core/plugins/http_checksum.rb'
|
|
30
30
|
require 'aws-sdk-core/plugins/checksum_algorithm.rb'
|
31
31
|
require 'aws-sdk-core/plugins/defaults_mode.rb'
|
32
32
|
require 'aws-sdk-core/plugins/recursion_detection.rb'
|
33
|
-
require 'aws-sdk-core/plugins/
|
33
|
+
require 'aws-sdk-core/plugins/sign.rb'
|
34
34
|
require 'aws-sdk-core/plugins/protocols/rest_json.rb'
|
35
35
|
|
36
36
|
Aws::Plugins::GlobalConfiguration.add_identifier(:batch)
|
@@ -79,8 +79,9 @@ module Aws::Batch
|
|
79
79
|
add_plugin(Aws::Plugins::ChecksumAlgorithm)
|
80
80
|
add_plugin(Aws::Plugins::DefaultsMode)
|
81
81
|
add_plugin(Aws::Plugins::RecursionDetection)
|
82
|
-
add_plugin(Aws::Plugins::
|
82
|
+
add_plugin(Aws::Plugins::Sign)
|
83
83
|
add_plugin(Aws::Plugins::Protocols::RestJson)
|
84
|
+
add_plugin(Aws::Batch::Plugins::Endpoints)
|
84
85
|
|
85
86
|
# @overload initialize(options)
|
86
87
|
# @param [Hash] options
|
@@ -287,6 +288,19 @@ module Aws::Batch
|
|
287
288
|
# ** Please note ** When response stubbing is enabled, no HTTP
|
288
289
|
# requests are made, and retries are disabled.
|
289
290
|
#
|
291
|
+
# @option options [Aws::TokenProvider] :token_provider
|
292
|
+
# A Bearer Token Provider. This can be an instance of any one of the
|
293
|
+
# following classes:
|
294
|
+
#
|
295
|
+
# * `Aws::StaticTokenProvider` - Used for configuring static, non-refreshing
|
296
|
+
# tokens.
|
297
|
+
#
|
298
|
+
# * `Aws::SSOTokenProvider` - Used for loading tokens from AWS SSO using an
|
299
|
+
# access token generated from `aws login`.
|
300
|
+
#
|
301
|
+
# When `:token_provider` is not configured directly, the `Aws::TokenProviderChain`
|
302
|
+
# will be used to search for tokens configured for your profile in shared configuration files.
|
303
|
+
#
|
290
304
|
# @option options [Boolean] :use_dualstack_endpoint
|
291
305
|
# When set to `true`, dualstack enabled endpoints (with `.aws` TLD)
|
292
306
|
# will be used if available.
|
@@ -300,6 +314,9 @@ module Aws::Batch
|
|
300
314
|
# When `true`, request parameters are validated before
|
301
315
|
# sending the request.
|
302
316
|
#
|
317
|
+
# @option options [Aws::Batch::EndpointProvider] :endpoint_provider
|
318
|
+
# The endpoint provider used to resolve endpoints. Any object that responds to `#resolve_endpoint(parameters)` where `parameters` is a Struct similar to `Aws::Batch::EndpointParameters`
|
319
|
+
#
|
303
320
|
# @option options [URI::HTTP,String] :http_proxy A proxy to send
|
304
321
|
# requests through. Formatted like 'http://proxy.com:123'.
|
305
322
|
#
|
@@ -352,10 +369,10 @@ module Aws::Batch
|
|
352
369
|
# @!group API Operations
|
353
370
|
|
354
371
|
# 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.
|
372
|
+
# `PENDING`, or `RUNNABLE` state are canceled. Jobs that progressed to
|
373
|
+
# the `STARTING` or `RUNNING` state aren't canceled. However, the API
|
374
|
+
# operation still succeeds, even if no job is canceled. These jobs must
|
375
|
+
# be terminated with the TerminateJob operation.
|
359
376
|
#
|
360
377
|
# @option params [required, String] :job_id
|
361
378
|
# The Batch job ID of the job to cancel.
|
@@ -417,9 +434,9 @@ module Aws::Batch
|
|
417
434
|
# </note>
|
418
435
|
#
|
419
436
|
# In an unmanaged compute environment, you can manage your own EC2
|
420
|
-
# compute resources and have
|
421
|
-
#
|
422
|
-
#
|
437
|
+
# compute resources and have flexibility with how you configure your
|
438
|
+
# compute resources. For example, you can use custom AMIs. However, you
|
439
|
+
# must verify that each of your AMIs meet the Amazon ECS container
|
423
440
|
# instance AMI specification. For more information, see [container
|
424
441
|
# instance AMIs][2] in the *Amazon Elastic Container Service Developer
|
425
442
|
# Guide*. After you created your unmanaged compute environment, you can
|
@@ -452,7 +469,7 @@ module Aws::Batch
|
|
452
469
|
# environments][4]. To use the enhanced updating of compute environments
|
453
470
|
# to update AMIs, follow these rules:
|
454
471
|
#
|
455
|
-
# * Either
|
472
|
+
# * Either don't set the service role (`serviceRole`) parameter or set
|
456
473
|
# it to the **AWSBatchServiceRole** service-linked role.
|
457
474
|
#
|
458
475
|
# * Set the allocation strategy (`allocationStrategy`) parameter to
|
@@ -461,28 +478,28 @@ module Aws::Batch
|
|
461
478
|
# * Set the update to latest image version
|
462
479
|
# (`updateToLatestImageVersion`) parameter to `true`.
|
463
480
|
#
|
464
|
-
# *
|
481
|
+
# * Don't specify an AMI ID in `imageId`, `imageIdOverride` (in [
|
465
482
|
# `ec2Configuration` ][5]), or in the launch template
|
466
|
-
# (`launchTemplate`). In that case Batch
|
467
|
-
# ECS optimized AMI supported by Batch at the time the
|
468
|
-
# update is initiated. Alternatively you can specify
|
469
|
-
# `imageId` or `imageIdOverride` parameters, or the
|
470
|
-
# identified by the `LaunchTemplate` properties.
|
471
|
-
# properties
|
472
|
-
# specified in the launch template, it can
|
473
|
-
# specifying an AMI ID in either the `imageId` or
|
474
|
-
# parameters. It can only be replaced by specifying
|
475
|
-
# template, or if the launch template version is
|
476
|
-
# `$Latest`, by setting either a new default
|
477
|
-
# template (if `$Default`)or by adding a new
|
478
|
-
# template (if `$Latest`).
|
479
|
-
#
|
480
|
-
# If these rules are followed, any update that
|
481
|
-
#
|
482
|
-
#
|
483
|
-
# `$
|
484
|
-
#
|
485
|
-
#
|
483
|
+
# (`launchTemplate`). In that case, Batch selects the latest Amazon
|
484
|
+
# ECS optimized AMI that's supported by Batch at the time the
|
485
|
+
# infrastructure update is initiated. Alternatively, you can specify
|
486
|
+
# the AMI ID in the `imageId` or `imageIdOverride` parameters, or the
|
487
|
+
# launch template identified by the `LaunchTemplate` properties.
|
488
|
+
# Changing any of these properties starts an infrastructure update. If
|
489
|
+
# the AMI ID is specified in the launch template, it can't be
|
490
|
+
# replaced by specifying an AMI ID in either the `imageId` or
|
491
|
+
# `imageIdOverride` parameters. It can only be replaced by specifying
|
492
|
+
# a different launch template, or if the launch template version is
|
493
|
+
# set to `$Default` or `$Latest`, by setting either a new default
|
494
|
+
# version for the launch template (if `$Default`) or by adding a new
|
495
|
+
# version to the launch template (if `$Latest`).
|
496
|
+
#
|
497
|
+
# If these rules are followed, any update that starts an infrastructure
|
498
|
+
# update causes the AMI ID to be re-selected. If the `version` setting
|
499
|
+
# in the launch template (`launchTemplate`) is set to `$Latest` or
|
500
|
+
# `$Default`, the latest or default version of the launch template is
|
501
|
+
# evaluated up at the time of the infrastructure update, even if the
|
502
|
+
# `launchTemplate` wasn't updated.
|
486
503
|
#
|
487
504
|
# </note>
|
488
505
|
#
|
@@ -495,7 +512,7 @@ module Aws::Batch
|
|
495
512
|
# [5]: https://docs.aws.amazon.com/batch/latest/APIReference/API_Ec2Configuration.html
|
496
513
|
#
|
497
514
|
# @option params [required, String] :compute_environment_name
|
498
|
-
# The name for your compute environment. It can be up to 128
|
515
|
+
# The name for your compute environment. It can be up to 128 characters
|
499
516
|
# long. It can contain uppercase and lowercase letters, numbers, hyphens
|
500
517
|
# (-), and underscores (\_).
|
501
518
|
#
|
@@ -562,9 +579,8 @@ module Aws::Batch
|
|
562
579
|
# If your specified role has a path other than `/`, then you must
|
563
580
|
# specify either the full role ARN (recommended) or prefix the role name
|
564
581
|
# with the path. For example, if a role with the name `bar` has a path
|
565
|
-
# of `/foo
|
566
|
-
#
|
567
|
-
# Guide*.
|
582
|
+
# of `/foo/`, specify `/foo/bar` as the role name. For more information,
|
583
|
+
# see [Friendly names and paths][2] in the *IAM User Guide*.
|
568
584
|
#
|
569
585
|
# <note markdown="1"> Depending on how you created your Batch service role, its ARN might
|
570
586
|
# contain the `service-role` path prefix. When you only specify the name
|
@@ -596,6 +612,10 @@ module Aws::Batch
|
|
596
612
|
# [2]: https://docs.aws.amazon.com/batch/latest/APIReference/API_TagResource.html
|
597
613
|
# [3]: https://docs.aws.amazon.com/batch/latest/APIReference/API_UntagResource.html
|
598
614
|
#
|
615
|
+
# @option params [Types::EksConfiguration] :eks_configuration
|
616
|
+
# The details for the Amazon EKS cluster that supports the compute
|
617
|
+
# environment.
|
618
|
+
#
|
599
619
|
# @return [Types::CreateComputeEnvironmentResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
600
620
|
#
|
601
621
|
# * {Types::CreateComputeEnvironmentResponse#compute_environment_name #compute_environment_name} => String
|
@@ -722,6 +742,7 @@ module Aws::Batch
|
|
722
742
|
# {
|
723
743
|
# image_type: "ImageType", # required
|
724
744
|
# image_id_override: "ImageIdOverride",
|
745
|
+
# image_kubernetes_version: "KubernetesVersion",
|
725
746
|
# },
|
726
747
|
# ],
|
727
748
|
# },
|
@@ -729,6 +750,10 @@ module Aws::Batch
|
|
729
750
|
# tags: {
|
730
751
|
# "TagKey" => "TagValue",
|
731
752
|
# },
|
753
|
+
# eks_configuration: {
|
754
|
+
# eks_cluster_arn: "String", # required
|
755
|
+
# kubernetes_namespace: "String", # required
|
756
|
+
# },
|
732
757
|
# })
|
733
758
|
#
|
734
759
|
# @example Response structure
|
@@ -775,7 +800,7 @@ module Aws::Batch
|
|
775
800
|
# scheduling policy. The format is
|
776
801
|
# `aws:Partition:batch:Region:Account:scheduling-policy/Name `. An
|
777
802
|
# example is
|
778
|
-
# `aws:aws:batch:us-west-2:
|
803
|
+
# `aws:aws:batch:us-west-2:123456789012:scheduling-policy/MySchedulingPolicy`.
|
779
804
|
#
|
780
805
|
# @option params [required, Integer] :priority
|
781
806
|
# The priority of the job queue. Job queues with a higher priority (or a
|
@@ -1139,9 +1164,8 @@ module Aws::Batch
|
|
1139
1164
|
# from the end of the previous results that returned the `nextToken`
|
1140
1165
|
# value. This value is `null` when there are no more results to return.
|
1141
1166
|
#
|
1142
|
-
# <note markdown="1">
|
1143
|
-
#
|
1144
|
-
# purposes.
|
1167
|
+
# <note markdown="1"> Treat this token as an opaque identifier that's only used to retrieve
|
1168
|
+
# the next items in a list and not for other programmatic purposes.
|
1145
1169
|
#
|
1146
1170
|
# </note>
|
1147
1171
|
#
|
@@ -1247,9 +1271,14 @@ module Aws::Batch
|
|
1247
1271
|
# resp.compute_environments[0].compute_resources.ec2_configuration #=> Array
|
1248
1272
|
# resp.compute_environments[0].compute_resources.ec2_configuration[0].image_type #=> String
|
1249
1273
|
# resp.compute_environments[0].compute_resources.ec2_configuration[0].image_id_override #=> String
|
1274
|
+
# resp.compute_environments[0].compute_resources.ec2_configuration[0].image_kubernetes_version #=> String
|
1250
1275
|
# resp.compute_environments[0].service_role #=> String
|
1251
1276
|
# resp.compute_environments[0].update_policy.terminate_jobs_on_update #=> Boolean
|
1252
1277
|
# resp.compute_environments[0].update_policy.job_execution_timeout_minutes #=> Integer
|
1278
|
+
# resp.compute_environments[0].eks_configuration.eks_cluster_arn #=> String
|
1279
|
+
# resp.compute_environments[0].eks_configuration.kubernetes_namespace #=> String
|
1280
|
+
# resp.compute_environments[0].container_orchestration_type #=> String, one of "ECS", "EKS"
|
1281
|
+
# resp.compute_environments[0].uuid #=> String
|
1253
1282
|
# resp.next_token #=> String
|
1254
1283
|
#
|
1255
1284
|
# @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/DescribeComputeEnvironments AWS API Documentation
|
@@ -1295,9 +1324,8 @@ module Aws::Batch
|
|
1295
1324
|
# from the end of the previous results that returned the `nextToken`
|
1296
1325
|
# value. This value is `null` when there are no more results to return.
|
1297
1326
|
#
|
1298
|
-
# <note markdown="1">
|
1299
|
-
#
|
1300
|
-
# purposes.
|
1327
|
+
# <note markdown="1"> Treat this token as an opaque identifier that's only used to retrieve
|
1328
|
+
# the next items in a list and not for other programmatic purposes.
|
1301
1329
|
#
|
1302
1330
|
# </note>
|
1303
1331
|
#
|
@@ -1510,6 +1538,41 @@ module Aws::Batch
|
|
1510
1538
|
# resp.job_definitions[0].propagate_tags #=> Boolean
|
1511
1539
|
# resp.job_definitions[0].platform_capabilities #=> Array
|
1512
1540
|
# resp.job_definitions[0].platform_capabilities[0] #=> String, one of "EC2", "FARGATE"
|
1541
|
+
# resp.job_definitions[0].eks_properties.pod_properties.service_account_name #=> String
|
1542
|
+
# resp.job_definitions[0].eks_properties.pod_properties.host_network #=> Boolean
|
1543
|
+
# resp.job_definitions[0].eks_properties.pod_properties.dns_policy #=> String
|
1544
|
+
# resp.job_definitions[0].eks_properties.pod_properties.containers #=> Array
|
1545
|
+
# resp.job_definitions[0].eks_properties.pod_properties.containers[0].name #=> String
|
1546
|
+
# resp.job_definitions[0].eks_properties.pod_properties.containers[0].image #=> String
|
1547
|
+
# resp.job_definitions[0].eks_properties.pod_properties.containers[0].image_pull_policy #=> String
|
1548
|
+
# resp.job_definitions[0].eks_properties.pod_properties.containers[0].command #=> Array
|
1549
|
+
# resp.job_definitions[0].eks_properties.pod_properties.containers[0].command[0] #=> String
|
1550
|
+
# resp.job_definitions[0].eks_properties.pod_properties.containers[0].args #=> Array
|
1551
|
+
# resp.job_definitions[0].eks_properties.pod_properties.containers[0].args[0] #=> String
|
1552
|
+
# resp.job_definitions[0].eks_properties.pod_properties.containers[0].env #=> Array
|
1553
|
+
# resp.job_definitions[0].eks_properties.pod_properties.containers[0].env[0].name #=> String
|
1554
|
+
# resp.job_definitions[0].eks_properties.pod_properties.containers[0].env[0].value #=> String
|
1555
|
+
# resp.job_definitions[0].eks_properties.pod_properties.containers[0].resources.limits #=> Hash
|
1556
|
+
# resp.job_definitions[0].eks_properties.pod_properties.containers[0].resources.limits["String"] #=> String
|
1557
|
+
# resp.job_definitions[0].eks_properties.pod_properties.containers[0].resources.requests #=> Hash
|
1558
|
+
# resp.job_definitions[0].eks_properties.pod_properties.containers[0].resources.requests["String"] #=> String
|
1559
|
+
# resp.job_definitions[0].eks_properties.pod_properties.containers[0].volume_mounts #=> Array
|
1560
|
+
# resp.job_definitions[0].eks_properties.pod_properties.containers[0].volume_mounts[0].name #=> String
|
1561
|
+
# resp.job_definitions[0].eks_properties.pod_properties.containers[0].volume_mounts[0].mount_path #=> String
|
1562
|
+
# resp.job_definitions[0].eks_properties.pod_properties.containers[0].volume_mounts[0].read_only #=> Boolean
|
1563
|
+
# resp.job_definitions[0].eks_properties.pod_properties.containers[0].security_context.run_as_user #=> Integer
|
1564
|
+
# resp.job_definitions[0].eks_properties.pod_properties.containers[0].security_context.run_as_group #=> Integer
|
1565
|
+
# resp.job_definitions[0].eks_properties.pod_properties.containers[0].security_context.privileged #=> Boolean
|
1566
|
+
# resp.job_definitions[0].eks_properties.pod_properties.containers[0].security_context.read_only_root_filesystem #=> Boolean
|
1567
|
+
# resp.job_definitions[0].eks_properties.pod_properties.containers[0].security_context.run_as_non_root #=> Boolean
|
1568
|
+
# resp.job_definitions[0].eks_properties.pod_properties.volumes #=> Array
|
1569
|
+
# resp.job_definitions[0].eks_properties.pod_properties.volumes[0].name #=> String
|
1570
|
+
# resp.job_definitions[0].eks_properties.pod_properties.volumes[0].host_path.path #=> String
|
1571
|
+
# resp.job_definitions[0].eks_properties.pod_properties.volumes[0].empty_dir.medium #=> String
|
1572
|
+
# resp.job_definitions[0].eks_properties.pod_properties.volumes[0].empty_dir.size_limit #=> String
|
1573
|
+
# resp.job_definitions[0].eks_properties.pod_properties.volumes[0].secret.secret_name #=> String
|
1574
|
+
# resp.job_definitions[0].eks_properties.pod_properties.volumes[0].secret.optional #=> Boolean
|
1575
|
+
# resp.job_definitions[0].container_orchestration_type #=> String, one of "ECS", "EKS"
|
1513
1576
|
# resp.next_token #=> String
|
1514
1577
|
#
|
1515
1578
|
# @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/DescribeJobDefinitions AWS API Documentation
|
@@ -1544,9 +1607,8 @@ module Aws::Batch
|
|
1544
1607
|
# from the end of the previous results that returned the `nextToken`
|
1545
1608
|
# value. This value is `null` when there are no more results to return.
|
1546
1609
|
#
|
1547
|
-
# <note markdown="1">
|
1548
|
-
#
|
1549
|
-
# purposes.
|
1610
|
+
# <note markdown="1"> Treat this token as an opaque identifier that's only used to retrieve
|
1611
|
+
# the next items in a list and not for other programmatic purposes.
|
1550
1612
|
#
|
1551
1613
|
# </note>
|
1552
1614
|
#
|
@@ -1869,6 +1931,53 @@ module Aws::Batch
|
|
1869
1931
|
# resp.jobs[0].propagate_tags #=> Boolean
|
1870
1932
|
# resp.jobs[0].platform_capabilities #=> Array
|
1871
1933
|
# resp.jobs[0].platform_capabilities[0] #=> String, one of "EC2", "FARGATE"
|
1934
|
+
# resp.jobs[0].eks_properties.pod_properties.service_account_name #=> String
|
1935
|
+
# resp.jobs[0].eks_properties.pod_properties.host_network #=> Boolean
|
1936
|
+
# resp.jobs[0].eks_properties.pod_properties.dns_policy #=> String
|
1937
|
+
# resp.jobs[0].eks_properties.pod_properties.containers #=> Array
|
1938
|
+
# resp.jobs[0].eks_properties.pod_properties.containers[0].name #=> String
|
1939
|
+
# resp.jobs[0].eks_properties.pod_properties.containers[0].image #=> String
|
1940
|
+
# resp.jobs[0].eks_properties.pod_properties.containers[0].image_pull_policy #=> String
|
1941
|
+
# resp.jobs[0].eks_properties.pod_properties.containers[0].command #=> Array
|
1942
|
+
# resp.jobs[0].eks_properties.pod_properties.containers[0].command[0] #=> String
|
1943
|
+
# resp.jobs[0].eks_properties.pod_properties.containers[0].args #=> Array
|
1944
|
+
# resp.jobs[0].eks_properties.pod_properties.containers[0].args[0] #=> String
|
1945
|
+
# resp.jobs[0].eks_properties.pod_properties.containers[0].env #=> Array
|
1946
|
+
# resp.jobs[0].eks_properties.pod_properties.containers[0].env[0].name #=> String
|
1947
|
+
# resp.jobs[0].eks_properties.pod_properties.containers[0].env[0].value #=> String
|
1948
|
+
# resp.jobs[0].eks_properties.pod_properties.containers[0].resources.limits #=> Hash
|
1949
|
+
# resp.jobs[0].eks_properties.pod_properties.containers[0].resources.limits["String"] #=> String
|
1950
|
+
# resp.jobs[0].eks_properties.pod_properties.containers[0].resources.requests #=> Hash
|
1951
|
+
# resp.jobs[0].eks_properties.pod_properties.containers[0].resources.requests["String"] #=> String
|
1952
|
+
# resp.jobs[0].eks_properties.pod_properties.containers[0].exit_code #=> Integer
|
1953
|
+
# resp.jobs[0].eks_properties.pod_properties.containers[0].reason #=> String
|
1954
|
+
# resp.jobs[0].eks_properties.pod_properties.containers[0].volume_mounts #=> Array
|
1955
|
+
# resp.jobs[0].eks_properties.pod_properties.containers[0].volume_mounts[0].name #=> String
|
1956
|
+
# resp.jobs[0].eks_properties.pod_properties.containers[0].volume_mounts[0].mount_path #=> String
|
1957
|
+
# resp.jobs[0].eks_properties.pod_properties.containers[0].volume_mounts[0].read_only #=> Boolean
|
1958
|
+
# resp.jobs[0].eks_properties.pod_properties.containers[0].security_context.run_as_user #=> Integer
|
1959
|
+
# resp.jobs[0].eks_properties.pod_properties.containers[0].security_context.run_as_group #=> Integer
|
1960
|
+
# resp.jobs[0].eks_properties.pod_properties.containers[0].security_context.privileged #=> Boolean
|
1961
|
+
# resp.jobs[0].eks_properties.pod_properties.containers[0].security_context.read_only_root_filesystem #=> Boolean
|
1962
|
+
# resp.jobs[0].eks_properties.pod_properties.containers[0].security_context.run_as_non_root #=> Boolean
|
1963
|
+
# resp.jobs[0].eks_properties.pod_properties.volumes #=> Array
|
1964
|
+
# resp.jobs[0].eks_properties.pod_properties.volumes[0].name #=> String
|
1965
|
+
# resp.jobs[0].eks_properties.pod_properties.volumes[0].host_path.path #=> String
|
1966
|
+
# resp.jobs[0].eks_properties.pod_properties.volumes[0].empty_dir.medium #=> String
|
1967
|
+
# resp.jobs[0].eks_properties.pod_properties.volumes[0].empty_dir.size_limit #=> String
|
1968
|
+
# resp.jobs[0].eks_properties.pod_properties.volumes[0].secret.secret_name #=> String
|
1969
|
+
# resp.jobs[0].eks_properties.pod_properties.volumes[0].secret.optional #=> Boolean
|
1970
|
+
# resp.jobs[0].eks_properties.pod_properties.pod_name #=> String
|
1971
|
+
# resp.jobs[0].eks_properties.pod_properties.node_name #=> String
|
1972
|
+
# resp.jobs[0].eks_attempts #=> Array
|
1973
|
+
# resp.jobs[0].eks_attempts[0].containers #=> Array
|
1974
|
+
# resp.jobs[0].eks_attempts[0].containers[0].exit_code #=> Integer
|
1975
|
+
# resp.jobs[0].eks_attempts[0].containers[0].reason #=> String
|
1976
|
+
# resp.jobs[0].eks_attempts[0].pod_name #=> String
|
1977
|
+
# resp.jobs[0].eks_attempts[0].node_name #=> String
|
1978
|
+
# resp.jobs[0].eks_attempts[0].started_at #=> Integer
|
1979
|
+
# resp.jobs[0].eks_attempts[0].stopped_at #=> Integer
|
1980
|
+
# resp.jobs[0].eks_attempts[0].status_reason #=> String
|
1872
1981
|
#
|
1873
1982
|
# @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/DescribeJobs AWS API Documentation
|
1874
1983
|
#
|
@@ -1967,9 +2076,8 @@ module Aws::Batch
|
|
1967
2076
|
# results that returned the `nextToken` value. This value is `null` when
|
1968
2077
|
# there are no more results to return.
|
1969
2078
|
#
|
1970
|
-
# <note markdown="1">
|
1971
|
-
#
|
1972
|
-
# purposes.
|
2079
|
+
# <note markdown="1"> Treat this token as an opaque identifier that's only used to retrieve
|
2080
|
+
# the next items in a list and not for other programmatic purposes.
|
1973
2081
|
#
|
1974
2082
|
# </note>
|
1975
2083
|
#
|
@@ -1983,7 +2091,7 @@ module Aws::Batch
|
|
1983
2091
|
# JOB\_NAME
|
1984
2092
|
#
|
1985
2093
|
# : The value of the filter is a case-insensitive match for the job
|
1986
|
-
# name. If the value ends with an asterisk (*), the filter
|
2094
|
+
# name. If the value ends with an asterisk (*), the filter matches
|
1987
2095
|
# any job name that begins with the string before the '*'. This
|
1988
2096
|
# corresponds to the `jobName` value. For example, `test1` matches
|
1989
2097
|
# both `Test1` and `test1`, and `test1*` matches both `test1` and
|
@@ -1997,7 +2105,7 @@ module Aws::Batch
|
|
1997
2105
|
# value. The value is case sensitive. When the value for the filter is
|
1998
2106
|
# the job definition name, the results include all the jobs that used
|
1999
2107
|
# any revision of that job definition name. If the value ends with an
|
2000
|
-
# asterisk (*), the filter
|
2108
|
+
# asterisk (*), the filter matches any job definition name that
|
2001
2109
|
# begins with the string before the '*'. For example, `jd1` matches
|
2002
2110
|
# only `jd1`, and `jd1*` matches both `jd1` and `jd1A`. The version of
|
2003
2111
|
# the job definition that's used doesn't affect the sort order. When
|
@@ -2005,7 +2113,7 @@ module Aws::Batch
|
|
2005
2113
|
# the form
|
2006
2114
|
# `arn:$\{Partition\}:batch:$\{Region\}:$\{Account\}:job-definition/$\{JobDefinitionName\}:$\{Revision\}`),
|
2007
2115
|
# the results include jobs that used the specified revision of the job
|
2008
|
-
# definition. Asterisk (*)
|
2116
|
+
# definition. Asterisk (*) isn't supported when the ARN is used.
|
2009
2117
|
#
|
2010
2118
|
# BEFORE\_CREATED\_AT
|
2011
2119
|
#
|
@@ -2133,9 +2241,8 @@ module Aws::Batch
|
|
2133
2241
|
# from the end of the previous results that returned the `nextToken`
|
2134
2242
|
# value. This value is `null` when there are no more results to return.
|
2135
2243
|
#
|
2136
|
-
# <note markdown="1">
|
2137
|
-
#
|
2138
|
-
# purposes.
|
2244
|
+
# <note markdown="1"> Treat this token as an opaque identifier that's only used to retrieve
|
2245
|
+
# the next items in a list and not for other programmatic purposes.
|
2139
2246
|
#
|
2140
2247
|
# </note>
|
2141
2248
|
#
|
@@ -2171,14 +2278,14 @@ module Aws::Batch
|
|
2171
2278
|
# Lists the tags for an Batch resource. Batch resources that support
|
2172
2279
|
# tags are compute environments, jobs, job definitions, job queues, and
|
2173
2280
|
# scheduling policies. ARNs for child jobs of array and multi-node
|
2174
|
-
# parallel (MNP) jobs
|
2281
|
+
# parallel (MNP) jobs aren't supported.
|
2175
2282
|
#
|
2176
2283
|
# @option params [required, String] :resource_arn
|
2177
2284
|
# The Amazon Resource Name (ARN) that identifies the resource that tags
|
2178
2285
|
# are listed for. Batch resources that support tags are compute
|
2179
2286
|
# environments, jobs, job definitions, job queues, and scheduling
|
2180
2287
|
# policies. ARNs for child jobs of array and multi-node parallel (MNP)
|
2181
|
-
# jobs
|
2288
|
+
# jobs aren't supported.
|
2182
2289
|
#
|
2183
2290
|
# @return [Types::ListTagsForResourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2184
2291
|
#
|
@@ -2251,18 +2358,19 @@ module Aws::Batch
|
|
2251
2358
|
#
|
2252
2359
|
# @option params [Integer] :scheduling_priority
|
2253
2360
|
# The scheduling priority for jobs that are submitted with this job
|
2254
|
-
# definition. This
|
2255
|
-
# policy. Jobs with a higher scheduling priority
|
2256
|
-
#
|
2361
|
+
# definition. This only affects jobs in job queues with a fair share
|
2362
|
+
# policy. Jobs with a higher scheduling priority are scheduled before
|
2363
|
+
# jobs with a lower scheduling priority.
|
2257
2364
|
#
|
2258
2365
|
# The minimum supported value is 0 and the maximum supported value is
|
2259
2366
|
# 9999.
|
2260
2367
|
#
|
2261
2368
|
# @option params [Types::ContainerProperties] :container_properties
|
2262
|
-
# An object with various properties specific to
|
2263
|
-
# container-based jobs. If the job definition's `type`
|
2264
|
-
# `container`, then you must specify either
|
2265
|
-
# `nodeProperties`.
|
2369
|
+
# An object with various properties specific to Amazon ECS based
|
2370
|
+
# single-node container-based jobs. If the job definition's `type`
|
2371
|
+
# parameter is `container`, then you must specify either
|
2372
|
+
# `containerProperties` or `nodeProperties`. This must not be specified
|
2373
|
+
# for Amazon EKS based job definitions.
|
2266
2374
|
#
|
2267
2375
|
# <note markdown="1"> If the job runs on Fargate resources, then you must not specify
|
2268
2376
|
# `nodeProperties`; use only `containerProperties`.
|
@@ -2282,6 +2390,11 @@ module Aws::Batch
|
|
2282
2390
|
#
|
2283
2391
|
# </note>
|
2284
2392
|
#
|
2393
|
+
# <note markdown="1"> If the job runs on Amazon EKS resources, then you must not specify
|
2394
|
+
# `nodeProperties`.
|
2395
|
+
#
|
2396
|
+
# </note>
|
2397
|
+
#
|
2285
2398
|
#
|
2286
2399
|
#
|
2287
2400
|
# [1]: https://docs.aws.amazon.com/batch/latest/userguide/multi-node-parallel-jobs.html
|
@@ -2301,6 +2414,11 @@ module Aws::Batch
|
|
2301
2414
|
# tags from the job and job definition is over 50, the job is moved to
|
2302
2415
|
# the `FAILED` state.
|
2303
2416
|
#
|
2417
|
+
# <note markdown="1"> If the job runs on Amazon EKS resources, then you must not specify
|
2418
|
+
# `propagateTags`.
|
2419
|
+
#
|
2420
|
+
# </note>
|
2421
|
+
#
|
2304
2422
|
# @option params [Types::JobTimeout] :timeout
|
2305
2423
|
# The timeout configuration for jobs that are submitted with this job
|
2306
2424
|
# definition, after which Batch terminates your jobs if they have not
|
@@ -2329,6 +2447,16 @@ module Aws::Batch
|
|
2329
2447
|
# is specified, it defaults to `EC2`. To run the job on Fargate
|
2330
2448
|
# resources, specify `FARGATE`.
|
2331
2449
|
#
|
2450
|
+
# <note markdown="1"> If the job runs on Amazon EKS resources, then you must not specify
|
2451
|
+
# `platformCapabilities`.
|
2452
|
+
#
|
2453
|
+
# </note>
|
2454
|
+
#
|
2455
|
+
# @option params [Types::EksProperties] :eks_properties
|
2456
|
+
# An object with various properties that are specific to Amazon EKS
|
2457
|
+
# based jobs. This must not be specified for Amazon ECS based job
|
2458
|
+
# definitions.
|
2459
|
+
#
|
2332
2460
|
# @return [Types::RegisterJobDefinitionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2333
2461
|
#
|
2334
2462
|
# * {Types::RegisterJobDefinitionResponse#job_definition_name #job_definition_name} => String
|
@@ -2643,6 +2771,66 @@ module Aws::Batch
|
|
2643
2771
|
# "TagKey" => "TagValue",
|
2644
2772
|
# },
|
2645
2773
|
# platform_capabilities: ["EC2"], # accepts EC2, FARGATE
|
2774
|
+
# eks_properties: {
|
2775
|
+
# pod_properties: {
|
2776
|
+
# service_account_name: "String",
|
2777
|
+
# host_network: false,
|
2778
|
+
# dns_policy: "String",
|
2779
|
+
# containers: [
|
2780
|
+
# {
|
2781
|
+
# name: "String",
|
2782
|
+
# image: "String", # required
|
2783
|
+
# image_pull_policy: "String",
|
2784
|
+
# command: ["String"],
|
2785
|
+
# args: ["String"],
|
2786
|
+
# env: [
|
2787
|
+
# {
|
2788
|
+
# name: "String", # required
|
2789
|
+
# value: "String",
|
2790
|
+
# },
|
2791
|
+
# ],
|
2792
|
+
# resources: {
|
2793
|
+
# limits: {
|
2794
|
+
# "String" => "Quantity",
|
2795
|
+
# },
|
2796
|
+
# requests: {
|
2797
|
+
# "String" => "Quantity",
|
2798
|
+
# },
|
2799
|
+
# },
|
2800
|
+
# volume_mounts: [
|
2801
|
+
# {
|
2802
|
+
# name: "String",
|
2803
|
+
# mount_path: "String",
|
2804
|
+
# read_only: false,
|
2805
|
+
# },
|
2806
|
+
# ],
|
2807
|
+
# security_context: {
|
2808
|
+
# run_as_user: 1,
|
2809
|
+
# run_as_group: 1,
|
2810
|
+
# privileged: false,
|
2811
|
+
# read_only_root_filesystem: false,
|
2812
|
+
# run_as_non_root: false,
|
2813
|
+
# },
|
2814
|
+
# },
|
2815
|
+
# ],
|
2816
|
+
# volumes: [
|
2817
|
+
# {
|
2818
|
+
# name: "String", # required
|
2819
|
+
# host_path: {
|
2820
|
+
# path: "String",
|
2821
|
+
# },
|
2822
|
+
# empty_dir: {
|
2823
|
+
# medium: "String",
|
2824
|
+
# size_limit: "Quantity",
|
2825
|
+
# },
|
2826
|
+
# secret: {
|
2827
|
+
# secret_name: "String", # required
|
2828
|
+
# optional: false,
|
2829
|
+
# },
|
2830
|
+
# },
|
2831
|
+
# ],
|
2832
|
+
# },
|
2833
|
+
# },
|
2646
2834
|
# })
|
2647
2835
|
#
|
2648
2836
|
# @example Response structure
|
@@ -2688,17 +2876,16 @@ module Aws::Batch
|
|
2688
2876
|
# name or the Amazon Resource Name (ARN) of the queue.
|
2689
2877
|
#
|
2690
2878
|
# @option params [String] :share_identifier
|
2691
|
-
# The share identifier for the job. If the job queue
|
2879
|
+
# The share identifier for the job. If the job queue doesn't have a
|
2692
2880
|
# scheduling policy, then this parameter must not be specified. If the
|
2693
2881
|
# job queue has a scheduling policy, then this parameter must be
|
2694
2882
|
# specified.
|
2695
2883
|
#
|
2696
2884
|
# @option params [Integer] :scheduling_priority_override
|
2697
|
-
# The scheduling priority for the job. This
|
2885
|
+
# The scheduling priority for the job. This only affects jobs in job
|
2698
2886
|
# queues with a fair share policy. Jobs with a higher scheduling
|
2699
|
-
# priority
|
2700
|
-
#
|
2701
|
-
# definition.
|
2887
|
+
# priority are scheduled before jobs with a lower scheduling priority.
|
2888
|
+
# This overrides any scheduling priority in the job definition.
|
2702
2889
|
#
|
2703
2890
|
# The minimum supported value is 0 and the maximum supported value is
|
2704
2891
|
# 9999.
|
@@ -2736,13 +2923,13 @@ module Aws::Batch
|
|
2736
2923
|
# from the job definition.
|
2737
2924
|
#
|
2738
2925
|
# @option params [Types::ContainerOverrides] :container_overrides
|
2739
|
-
#
|
2740
|
-
#
|
2741
|
-
#
|
2742
|
-
#
|
2743
|
-
# `command` override. You can
|
2744
|
-
# variables on a container or add new
|
2745
|
-
# an `environment` override.
|
2926
|
+
# An object with various properties that override the defaults for the
|
2927
|
+
# job definition that specify the name of a container in the specified
|
2928
|
+
# job definition and the overrides it should receive. You can override
|
2929
|
+
# the default command for a container, which is specified in the job
|
2930
|
+
# definition or the Docker image, with a `command` override. You can
|
2931
|
+
# also override existing environment variables on a container or add new
|
2932
|
+
# environment variables to it with an `environment` override.
|
2746
2933
|
#
|
2747
2934
|
# @option params [Types::NodeOverrides] :node_overrides
|
2748
2935
|
# A list of node overrides in JSON format that specify the node range to
|
@@ -2793,6 +2980,11 @@ module Aws::Batch
|
|
2793
2980
|
#
|
2794
2981
|
# [1]: https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html
|
2795
2982
|
#
|
2983
|
+
# @option params [Types::EksPropertiesOverride] :eks_properties_override
|
2984
|
+
# An object that can only be specified for jobs that are run on Amazon
|
2985
|
+
# EKS resources with various properties that override defaults for the
|
2986
|
+
# job definition.
|
2987
|
+
#
|
2796
2988
|
# @return [Types::SubmitJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2797
2989
|
#
|
2798
2990
|
# * {Types::SubmitJobResponse#job_arn #job_arn} => String
|
@@ -2898,6 +3090,31 @@ module Aws::Batch
|
|
2898
3090
|
# tags: {
|
2899
3091
|
# "TagKey" => "TagValue",
|
2900
3092
|
# },
|
3093
|
+
# eks_properties_override: {
|
3094
|
+
# pod_properties: {
|
3095
|
+
# containers: [
|
3096
|
+
# {
|
3097
|
+
# image: "String",
|
3098
|
+
# command: ["String"],
|
3099
|
+
# args: ["String"],
|
3100
|
+
# env: [
|
3101
|
+
# {
|
3102
|
+
# name: "String", # required
|
3103
|
+
# value: "String",
|
3104
|
+
# },
|
3105
|
+
# ],
|
3106
|
+
# resources: {
|
3107
|
+
# limits: {
|
3108
|
+
# "String" => "Quantity",
|
3109
|
+
# },
|
3110
|
+
# requests: {
|
3111
|
+
# "String" => "Quantity",
|
3112
|
+
# },
|
3113
|
+
# },
|
3114
|
+
# },
|
3115
|
+
# ],
|
3116
|
+
# },
|
3117
|
+
# },
|
2901
3118
|
# })
|
2902
3119
|
#
|
2903
3120
|
# @example Response structure
|
@@ -2921,13 +3138,13 @@ module Aws::Batch
|
|
2921
3138
|
# the tags that are associated with that resource are deleted as well.
|
2922
3139
|
# Batch resources that support tags are compute environments, jobs, job
|
2923
3140
|
# definitions, job queues, and scheduling policies. ARNs for child jobs
|
2924
|
-
# of array and multi-node parallel (MNP) jobs
|
3141
|
+
# of array and multi-node parallel (MNP) jobs aren't supported.
|
2925
3142
|
#
|
2926
3143
|
# @option params [required, String] :resource_arn
|
2927
3144
|
# The Amazon Resource Name (ARN) of the resource that tags are added to.
|
2928
3145
|
# Batch resources that support tags are compute environments, jobs, job
|
2929
3146
|
# definitions, job queues, and scheduling policies. ARNs for child jobs
|
2930
|
-
# of array and multi-node parallel (MNP) jobs
|
3147
|
+
# of array and multi-node parallel (MNP) jobs aren't supported.
|
2931
3148
|
#
|
2932
3149
|
# @option params [required, Hash<String,String>] :tags
|
2933
3150
|
# The tags that you apply to the resource to help you categorize and
|
@@ -3026,7 +3243,7 @@ module Aws::Batch
|
|
3026
3243
|
# The Amazon Resource Name (ARN) of the resource from which to delete
|
3027
3244
|
# tags. Batch resources that support tags are compute environments,
|
3028
3245
|
# jobs, job definitions, job queues, and scheduling policies. ARNs for
|
3029
|
-
# child jobs of array and multi-node parallel (MNP) jobs
|
3246
|
+
# child jobs of array and multi-node parallel (MNP) jobs aren't
|
3030
3247
|
# supported.
|
3031
3248
|
#
|
3032
3249
|
# @option params [required, Array<String>] :tag_keys
|
@@ -3091,11 +3308,11 @@ module Aws::Batch
|
|
3091
3308
|
#
|
3092
3309
|
# @option params [Integer] :unmanagedv_cpus
|
3093
3310
|
# The maximum number of vCPUs expected to be used for an unmanaged
|
3094
|
-
# compute environment.
|
3311
|
+
# compute environment. Don't specify this parameter for a managed
|
3095
3312
|
# compute environment. This parameter is only used for fair share
|
3096
3313
|
# scheduling to reserve vCPU capacity for new share identifiers. If this
|
3097
|
-
# parameter
|
3098
|
-
#
|
3314
|
+
# parameter isn't provided for a fair share job queue, no vCPU capacity
|
3315
|
+
# is reserved.
|
3099
3316
|
#
|
3100
3317
|
# @option params [Types::ComputeResourceUpdate] :compute_resources
|
3101
3318
|
# Details of the compute resources managed by the compute environment.
|
@@ -3199,6 +3416,7 @@ module Aws::Batch
|
|
3199
3416
|
# {
|
3200
3417
|
# image_type: "ImageType", # required
|
3201
3418
|
# image_id_override: "ImageIdOverride",
|
3419
|
+
# image_kubernetes_version: "KubernetesVersion",
|
3202
3420
|
# },
|
3203
3421
|
# ],
|
3204
3422
|
# update_to_latest_image_version: false,
|
@@ -3243,7 +3461,7 @@ module Aws::Batch
|
|
3243
3461
|
# but not removed. The format is
|
3244
3462
|
# `aws:Partition:batch:Region:Account:scheduling-policy/Name `. For
|
3245
3463
|
# example,
|
3246
|
-
# `aws:aws:batch:us-west-2:
|
3464
|
+
# `aws:aws:batch:us-west-2:123456789012:scheduling-policy/MySchedulingPolicy`.
|
3247
3465
|
#
|
3248
3466
|
# @option params [Integer] :priority
|
3249
3467
|
# The priority of the job queue. Job queues with a higher priority (or a
|
@@ -3369,7 +3587,7 @@ module Aws::Batch
|
|
3369
3587
|
params: params,
|
3370
3588
|
config: config)
|
3371
3589
|
context[:gem_name] = 'aws-sdk-batch'
|
3372
|
-
context[:gem_version] = '1.
|
3590
|
+
context[:gem_version] = '1.64.0'
|
3373
3591
|
Seahorse::Client::Request.new(handlers, context)
|
3374
3592
|
end
|
3375
3593
|
|