aws-sdk-batch 1.62.0 → 1.64.0
Sign up to get free protection for your applications and to get access to all the features.
- 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/types.rb
CHANGED
@@ -10,7 +10,7 @@
|
|
10
10
|
module Aws::Batch
|
11
11
|
module Types
|
12
12
|
|
13
|
-
# An object
|
13
|
+
# An object that represents an Batch array job.
|
14
14
|
#
|
15
15
|
# @note When making an API call, you may pass ArrayProperties
|
16
16
|
# data as a hash:
|
@@ -31,7 +31,7 @@ module Aws::Batch
|
|
31
31
|
include Aws::Structure
|
32
32
|
end
|
33
33
|
|
34
|
-
# An object
|
34
|
+
# An object that represents the array properties of a job.
|
35
35
|
#
|
36
36
|
# @!attribute [rw] status_summary
|
37
37
|
# A summary of the number of array job children in each available job
|
@@ -58,7 +58,7 @@ module Aws::Batch
|
|
58
58
|
include Aws::Structure
|
59
59
|
end
|
60
60
|
|
61
|
-
# An object
|
61
|
+
# An object that represents the array properties of a job.
|
62
62
|
#
|
63
63
|
# @!attribute [rw] size
|
64
64
|
# The size of the array job. This parameter is returned for parent
|
@@ -79,7 +79,7 @@ module Aws::Batch
|
|
79
79
|
include Aws::Structure
|
80
80
|
end
|
81
81
|
|
82
|
-
# An object
|
82
|
+
# An object that represents the details of a container that's part of a
|
83
83
|
# job attempt.
|
84
84
|
#
|
85
85
|
# @!attribute [rw] container_instance_arn
|
@@ -95,23 +95,23 @@ module Aws::Batch
|
|
95
95
|
#
|
96
96
|
# @!attribute [rw] exit_code
|
97
97
|
# The exit code for the job attempt. A non-zero exit code is
|
98
|
-
# considered
|
98
|
+
# considered failed.
|
99
99
|
# @return [Integer]
|
100
100
|
#
|
101
101
|
# @!attribute [rw] reason
|
102
102
|
# A short (255 max characters) human-readable string to provide
|
103
|
-
# additional details
|
103
|
+
# additional details for a running or stopped container.
|
104
104
|
# @return [String]
|
105
105
|
#
|
106
106
|
# @!attribute [rw] log_stream_name
|
107
|
-
# The name of the CloudWatch Logs log stream associated with
|
108
|
-
# container. The log group for Batch jobs is `/aws/batch/job`.
|
109
|
-
# container attempt receives a log stream name when they reach
|
110
|
-
# `RUNNING` status.
|
107
|
+
# The name of the CloudWatch Logs log stream that's associated with
|
108
|
+
# the container. The log group for Batch jobs is `/aws/batch/job`.
|
109
|
+
# Each container attempt receives a log stream name when they reach
|
110
|
+
# the `RUNNING` status.
|
111
111
|
# @return [String]
|
112
112
|
#
|
113
113
|
# @!attribute [rw] network_interfaces
|
114
|
-
# The network interfaces associated with the job attempt.
|
114
|
+
# The network interfaces that are associated with the job attempt.
|
115
115
|
# @return [Array<Types::NetworkInterface>]
|
116
116
|
#
|
117
117
|
# @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/AttemptContainerDetail AWS API Documentation
|
@@ -127,10 +127,10 @@ module Aws::Batch
|
|
127
127
|
include Aws::Structure
|
128
128
|
end
|
129
129
|
|
130
|
-
# An object
|
130
|
+
# An object that represents a job attempt.
|
131
131
|
#
|
132
132
|
# @!attribute [rw] container
|
133
|
-
#
|
133
|
+
# The details for the container in this job attempt.
|
134
134
|
# @return [Types::AttemptContainerDetail]
|
135
135
|
#
|
136
136
|
# @!attribute [rw] started_at
|
@@ -146,8 +146,8 @@ module Aws::Batch
|
|
146
146
|
# @return [Integer]
|
147
147
|
#
|
148
148
|
# @!attribute [rw] status_reason
|
149
|
-
# A short, human-readable string to provide additional details
|
150
|
-
#
|
149
|
+
# A short, human-readable string to provide additional details for the
|
150
|
+
# current status of the job attempt.
|
151
151
|
# @return [String]
|
152
152
|
#
|
153
153
|
# @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/AttemptDetail AWS API Documentation
|
@@ -195,10 +195,10 @@ module Aws::Batch
|
|
195
195
|
#
|
196
196
|
class CancelJobResponse < Aws::EmptyStructure; end
|
197
197
|
|
198
|
-
# These errors are usually caused by a client action
|
199
|
-
# action or resource on behalf of a user that doesn't have
|
200
|
-
# to use the action or resource
|
201
|
-
# valid.
|
198
|
+
# These errors are usually caused by a client action. One example cause
|
199
|
+
# is using an action or resource on behalf of a user that doesn't have
|
200
|
+
# permissions to use the action or resource. Another cause is specifying
|
201
|
+
# an identifier that's not valid.
|
202
202
|
#
|
203
203
|
# @!attribute [rw] message
|
204
204
|
# @return [String]
|
@@ -211,10 +211,10 @@ module Aws::Batch
|
|
211
211
|
include Aws::Structure
|
212
212
|
end
|
213
213
|
|
214
|
-
# An object
|
214
|
+
# An object that represents an Batch compute environment.
|
215
215
|
#
|
216
216
|
# @!attribute [rw] compute_environment_name
|
217
|
-
# The name of the compute environment. It can be up to 128
|
217
|
+
# The name of the compute environment. It can be up to 128 characters
|
218
218
|
# long. It can contain uppercase and lowercase letters, numbers,
|
219
219
|
# hyphens (-), and underscores (\_).
|
220
220
|
# @return [String]
|
@@ -230,7 +230,7 @@ module Aws::Batch
|
|
230
230
|
#
|
231
231
|
# @!attribute [rw] ecs_cluster_arn
|
232
232
|
# The Amazon Resource Name (ARN) of the underlying Amazon ECS cluster
|
233
|
-
#
|
233
|
+
# that the compute environment uses.
|
234
234
|
# @return [String]
|
235
235
|
#
|
236
236
|
# @!attribute [rw] tags
|
@@ -254,7 +254,7 @@ module Aws::Batch
|
|
254
254
|
# If the state is `ENABLED`, then the Batch scheduler can attempt to
|
255
255
|
# place jobs from an associated job queue on the compute resources
|
256
256
|
# within the environment. If the compute environment is managed, then
|
257
|
-
# it can scale its instances out or in automatically
|
257
|
+
# it can scale its instances out or in automatically based on the job
|
258
258
|
# queue demand.
|
259
259
|
#
|
260
260
|
# If the state is `DISABLED`, then the Batch scheduler doesn't
|
@@ -270,8 +270,8 @@ module Aws::Batch
|
|
270
270
|
# @return [String]
|
271
271
|
#
|
272
272
|
# @!attribute [rw] status_reason
|
273
|
-
# A short, human-readable string to provide additional details
|
274
|
-
#
|
273
|
+
# A short, human-readable string to provide additional details for the
|
274
|
+
# current status of the compute environment.
|
275
275
|
# @return [String]
|
276
276
|
#
|
277
277
|
# @!attribute [rw] compute_resources
|
@@ -285,10 +285,10 @@ module Aws::Batch
|
|
285
285
|
# @return [Types::ComputeResource]
|
286
286
|
#
|
287
287
|
# @!attribute [rw] service_role
|
288
|
-
# The service role associated with the compute environment
|
289
|
-
# Batch to make calls to Amazon Web Services API
|
290
|
-
# behalf. For more information, see [Batch service
|
291
|
-
# *Batch User Guide*.
|
288
|
+
# The service role that's associated with the compute environment
|
289
|
+
# that allows Batch to make calls to Amazon Web Services API
|
290
|
+
# operations on your behalf. For more information, see [Batch service
|
291
|
+
# IAM role][1] in the *Batch User Guide*.
|
292
292
|
#
|
293
293
|
#
|
294
294
|
#
|
@@ -305,6 +305,21 @@ module Aws::Batch
|
|
305
305
|
# [1]: https://docs.aws.amazon.com/batch/latest/userguide/updating-compute-environments.html
|
306
306
|
# @return [Types::UpdatePolicy]
|
307
307
|
#
|
308
|
+
# @!attribute [rw] eks_configuration
|
309
|
+
# The configuration for the Amazon EKS cluster that supports the Batch
|
310
|
+
# compute environment. Only specify this parameter if the
|
311
|
+
# `containerOrchestrationType` is `EKS`.
|
312
|
+
# @return [Types::EksConfiguration]
|
313
|
+
#
|
314
|
+
# @!attribute [rw] container_orchestration_type
|
315
|
+
# The orchestration type of the compute environment. The valid values
|
316
|
+
# are `ECS` (default) or `EKS`.
|
317
|
+
# @return [String]
|
318
|
+
#
|
319
|
+
# @!attribute [rw] uuid
|
320
|
+
# Unique identifier for the compute environment.
|
321
|
+
# @return [String]
|
322
|
+
#
|
308
323
|
# @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/ComputeEnvironmentDetail AWS API Documentation
|
309
324
|
#
|
310
325
|
class ComputeEnvironmentDetail < Struct.new(
|
@@ -319,12 +334,15 @@ module Aws::Batch
|
|
319
334
|
:status_reason,
|
320
335
|
:compute_resources,
|
321
336
|
:service_role,
|
322
|
-
:update_policy
|
337
|
+
:update_policy,
|
338
|
+
:eks_configuration,
|
339
|
+
:container_orchestration_type,
|
340
|
+
:uuid)
|
323
341
|
SENSITIVE = []
|
324
342
|
include Aws::Structure
|
325
343
|
end
|
326
344
|
|
327
|
-
# The order
|
345
|
+
# The order that compute environments are tried in for job placement
|
328
346
|
# within a queue. Compute environments are tried in ascending order. For
|
329
347
|
# example, if two compute environments are associated with a job queue,
|
330
348
|
# the compute environment with a lower order integer value is tried for
|
@@ -368,7 +386,7 @@ module Aws::Batch
|
|
368
386
|
include Aws::Structure
|
369
387
|
end
|
370
388
|
|
371
|
-
# An object
|
389
|
+
# An object that represents an Batch compute resource. For more
|
372
390
|
# information, see [Compute environments][1] in the *Batch User Guide*.
|
373
391
|
#
|
374
392
|
#
|
@@ -405,6 +423,7 @@ module Aws::Batch
|
|
405
423
|
# {
|
406
424
|
# image_type: "ImageType", # required
|
407
425
|
# image_id_override: "ImageIdOverride",
|
426
|
+
# image_kubernetes_version: "KubernetesVersion",
|
408
427
|
# },
|
409
428
|
# ],
|
410
429
|
# }
|
@@ -432,7 +451,7 @@ module Aws::Batch
|
|
432
451
|
# [Allocation strategies][2] in the *Batch User Guide*.
|
433
452
|
#
|
434
453
|
# <note markdown="1"> This parameter isn't applicable to jobs that are running on Fargate
|
435
|
-
# resources
|
454
|
+
# resources. Don't specify it.
|
436
455
|
#
|
437
456
|
# </note>
|
438
457
|
#
|
@@ -442,36 +461,37 @@ module Aws::Batch
|
|
442
461
|
# jobs with a preference for the lowest-cost instance type. If
|
443
462
|
# additional instances of the selected instance type aren't
|
444
463
|
# available, Batch waits for the additional instances to be
|
445
|
-
# available. If there aren't enough instances available
|
446
|
-
#
|
447
|
-
#
|
448
|
-
#
|
449
|
-
#
|
450
|
-
#
|
451
|
-
#
|
452
|
-
#
|
453
|
-
#
|
464
|
+
# available. If there aren't enough instances available or the user
|
465
|
+
# is reaching [Amazon EC2 service limits][1], additional jobs
|
466
|
+
# aren't run until the currently running jobs are completed. This
|
467
|
+
# allocation strategy keeps costs lower but can limit scaling. If
|
468
|
+
# you're using Spot Fleets with `BEST_FIT`, the Spot Fleet IAM Role
|
469
|
+
# must be specified. Compute resources that use a `BEST_FIT`
|
470
|
+
# allocation strategy don't support infrastructure updates and
|
471
|
+
# can't update some parameters. For more information, see [Updating
|
472
|
+
# compute environments][3] in the *Batch User Guide*.
|
454
473
|
#
|
455
474
|
# BEST\_FIT\_PROGRESSIVE
|
456
475
|
#
|
457
|
-
# : Batch
|
458
|
-
#
|
459
|
-
#
|
460
|
-
#
|
461
|
-
#
|
476
|
+
# : Batch selects additional instance types that are large enough to
|
477
|
+
# meet the requirements of the jobs in the queue. Its preference is
|
478
|
+
# for instance types with lower cost vCPUs. If additional instances
|
479
|
+
# of the previously selected instance types aren't available, Batch
|
480
|
+
# selects new instance types.
|
462
481
|
#
|
463
482
|
# SPOT\_CAPACITY\_OPTIMIZED
|
464
483
|
#
|
465
|
-
# : Batch
|
466
|
-
#
|
467
|
-
#
|
468
|
-
#
|
469
|
-
#
|
484
|
+
# : Batch selects one or more instance types that are large enough to
|
485
|
+
# meet the requirements of the jobs in the queue. Its preference is
|
486
|
+
# for instance types that are less likely to be interrupted. This
|
487
|
+
# allocation strategy is only available for Spot Instance compute
|
488
|
+
# resources.
|
470
489
|
#
|
471
490
|
# With both `BEST_FIT_PROGRESSIVE` and `SPOT_CAPACITY_OPTIMIZED`
|
472
|
-
# strategies
|
473
|
-
#
|
474
|
-
#
|
491
|
+
# strategies using On-Demand or Spot Instances, and the `BEST_FIT`
|
492
|
+
# strategy using Spot Instances, Batch might need to exceed `maxvCpus`
|
493
|
+
# to meet your capacity requirements. In this event, Batch never
|
494
|
+
# exceeds `maxvCpus` by more than a single instance.
|
475
495
|
#
|
476
496
|
#
|
477
497
|
#
|
@@ -485,7 +505,7 @@ module Aws::Batch
|
|
485
505
|
# maintain (even if the compute environment is `DISABLED`).
|
486
506
|
#
|
487
507
|
# <note markdown="1"> This parameter isn't applicable to jobs that are running on Fargate
|
488
|
-
# resources
|
508
|
+
# resources. Don't specify it.
|
489
509
|
#
|
490
510
|
# </note>
|
491
511
|
# @return [Integer]
|
@@ -495,22 +515,23 @@ module Aws::Batch
|
|
495
515
|
# can reach.
|
496
516
|
#
|
497
517
|
# <note markdown="1"> With both `BEST_FIT_PROGRESSIVE` and `SPOT_CAPACITY_OPTIMIZED`
|
498
|
-
# allocation strategies
|
499
|
-
#
|
500
|
-
# `maxvCpus`
|
501
|
-
#
|
502
|
-
#
|
518
|
+
# allocation strategies using On-Demand or Spot Instances, and the
|
519
|
+
# `BEST_FIT` strategy using Spot Instances, Batch might need to exceed
|
520
|
+
# `maxvCpus` to meet your capacity requirements. In this event, Batch
|
521
|
+
# never exceeds `maxvCpus` by more than a single instance. For
|
522
|
+
# example, no more than a single instance from among those specified
|
523
|
+
# in your compute environment is allocated.
|
503
524
|
#
|
504
525
|
# </note>
|
505
526
|
# @return [Integer]
|
506
527
|
#
|
507
528
|
# @!attribute [rw] desiredv_cpus
|
508
529
|
# The desired number of Amazon EC2 vCPUS in the compute environment.
|
509
|
-
# Batch modifies this value between the minimum and maximum values
|
530
|
+
# Batch modifies this value between the minimum and maximum values
|
510
531
|
# based on job queue demand.
|
511
532
|
#
|
512
533
|
# <note markdown="1"> This parameter isn't applicable to jobs that are running on Fargate
|
513
|
-
# resources
|
534
|
+
# resources. Don't specify it.
|
514
535
|
#
|
515
536
|
# </note>
|
516
537
|
# @return [Integer]
|
@@ -524,7 +545,7 @@ module Aws::Batch
|
|
524
545
|
# that match the demand of your job queues.
|
525
546
|
#
|
526
547
|
# <note markdown="1"> This parameter isn't applicable to jobs that are running on Fargate
|
527
|
-
# resources
|
548
|
+
# resources. Don't specify it.
|
528
549
|
#
|
529
550
|
# </note>
|
530
551
|
#
|
@@ -537,7 +558,7 @@ module Aws::Batch
|
|
537
558
|
#
|
538
559
|
# <note markdown="1"> Currently, `optimal` uses instance types from the C4, M4, and R4
|
539
560
|
# instance families. In Regions that don't have instance types from
|
540
|
-
# those instance families, instance types from the C5, M5
|
561
|
+
# those instance families, instance types from the C5, M5, and R5
|
541
562
|
# instance families are used.
|
542
563
|
#
|
543
564
|
# </note>
|
@@ -549,7 +570,7 @@ module Aws::Batch
|
|
549
570
|
# `imageIdOverride` member of the `Ec2Configuration` structure.
|
550
571
|
#
|
551
572
|
# <note markdown="1"> This parameter isn't applicable to jobs that are running on Fargate
|
552
|
-
# resources
|
573
|
+
# resources. Don't specify it.
|
553
574
|
#
|
554
575
|
# </note>
|
555
576
|
#
|
@@ -581,13 +602,13 @@ module Aws::Batch
|
|
581
602
|
# @return [Array<String>]
|
582
603
|
#
|
583
604
|
# @!attribute [rw] security_group_ids
|
584
|
-
# The Amazon EC2 security groups associated with instances
|
585
|
-
# the compute environment. One or more security groups
|
586
|
-
# specified, either in `securityGroupIds` or using a launch
|
587
|
-
# referenced in `launchTemplate`. This parameter is required
|
588
|
-
# that are running on Fargate resources and must contain at
|
589
|
-
# security group. Fargate doesn't support launch templates.
|
590
|
-
# security groups are specified using both `securityGroupIds` and
|
605
|
+
# The Amazon EC2 security groups that are associated with instances
|
606
|
+
# launched in the compute environment. One or more security groups
|
607
|
+
# must be specified, either in `securityGroupIds` or using a launch
|
608
|
+
# template referenced in `launchTemplate`. This parameter is required
|
609
|
+
# for jobs that are running on Fargate resources and must contain at
|
610
|
+
# least one security group. Fargate doesn't support launch templates.
|
611
|
+
# If security groups are specified using both `securityGroupIds` and
|
591
612
|
# `launchTemplate`, the values in `securityGroupIds` are used.
|
592
613
|
# @return [Array<String>]
|
593
614
|
#
|
@@ -597,7 +618,7 @@ module Aws::Batch
|
|
597
618
|
# instances with SSH.
|
598
619
|
#
|
599
620
|
# <note markdown="1"> This parameter isn't applicable to jobs that are running on Fargate
|
600
|
-
# resources
|
621
|
+
# resources. Don't specify it.
|
601
622
|
#
|
602
623
|
# </note>
|
603
624
|
# @return [String]
|
@@ -612,7 +633,7 @@ module Aws::Batch
|
|
612
633
|
# *Batch User Guide*.
|
613
634
|
#
|
614
635
|
# <note markdown="1"> This parameter isn't applicable to jobs that are running on Fargate
|
615
|
-
# resources
|
636
|
+
# resources. Don't specify it.
|
616
637
|
#
|
617
638
|
# </note>
|
618
639
|
#
|
@@ -624,8 +645,8 @@ module Aws::Batch
|
|
624
645
|
# @!attribute [rw] tags
|
625
646
|
# Key-value pair tags to be applied to EC2 resources that are launched
|
626
647
|
# in the compute environment. For Batch, these take the form of
|
627
|
-
# "String1": "String2"
|
628
|
-
# is the tag value
|
648
|
+
# `"String1": "String2"`, where `String1` is the tag key and `String2`
|
649
|
+
# is the tag value-for example, `\{ "Name": "Batch Instance -
|
629
650
|
# C4OnDemand" \}`. This is helpful for recognizing your Batch
|
630
651
|
# instances in the Amazon EC2 console. Updating these tags requires an
|
631
652
|
# infrastructure update to the compute environment. For more
|
@@ -634,7 +655,7 @@ module Aws::Batch
|
|
634
655
|
# `ListTagsForResource` API operation.
|
635
656
|
#
|
636
657
|
# <note markdown="1"> This parameter isn't applicable to jobs that are running on Fargate
|
637
|
-
# resources
|
658
|
+
# resources. Don't specify it.
|
638
659
|
#
|
639
660
|
# </note>
|
640
661
|
#
|
@@ -654,7 +675,7 @@ module Aws::Batch
|
|
654
675
|
# *Amazon EC2 User Guide for Linux Instances*.
|
655
676
|
#
|
656
677
|
# <note markdown="1"> This parameter isn't applicable to jobs that are running on Fargate
|
657
|
-
# resources
|
678
|
+
# resources. Don't specify it.
|
658
679
|
#
|
659
680
|
# </note>
|
660
681
|
#
|
@@ -674,7 +695,7 @@ module Aws::Batch
|
|
674
695
|
# On-Demand price.
|
675
696
|
#
|
676
697
|
# <note markdown="1"> This parameter isn't applicable to jobs that are running on Fargate
|
677
|
-
# resources
|
698
|
+
# resources. Don't specify it.
|
678
699
|
#
|
679
700
|
# </note>
|
680
701
|
# @return [Integer]
|
@@ -687,7 +708,7 @@ module Aws::Batch
|
|
687
708
|
# spot fleet role][1] in the *Batch User Guide*.
|
688
709
|
#
|
689
710
|
# <note markdown="1"> This parameter isn't applicable to jobs that are running on Fargate
|
690
|
-
# resources
|
711
|
+
# resources. Don't specify it.
|
691
712
|
#
|
692
713
|
# </note>
|
693
714
|
#
|
@@ -714,7 +735,7 @@ module Aws::Batch
|
|
714
735
|
# Guide*.
|
715
736
|
#
|
716
737
|
# <note markdown="1"> This parameter isn't applicable to jobs that are running on Fargate
|
717
|
-
# resources
|
738
|
+
# resources. Don't specify it.
|
718
739
|
#
|
719
740
|
# </note>
|
720
741
|
#
|
@@ -724,14 +745,14 @@ module Aws::Batch
|
|
724
745
|
# @return [Types::LaunchTemplateSpecification]
|
725
746
|
#
|
726
747
|
# @!attribute [rw] ec2_configuration
|
727
|
-
# Provides information used to select Amazon Machine Images
|
728
|
-
# EC2 instances in the compute environment. If
|
729
|
-
# isn't specified, the default is `ECS_AL2`.
|
748
|
+
# Provides information that's used to select Amazon Machine Images
|
749
|
+
# (AMIs) for EC2 instances in the compute environment. If
|
750
|
+
# `Ec2Configuration` isn't specified, the default is `ECS_AL2`.
|
730
751
|
#
|
731
752
|
# One or two values can be provided.
|
732
753
|
#
|
733
754
|
# <note markdown="1"> This parameter isn't applicable to jobs that are running on Fargate
|
734
|
-
# resources
|
755
|
+
# resources. Don't specify it.
|
735
756
|
#
|
736
757
|
# </note>
|
737
758
|
# @return [Array<Types::Ec2Configuration>]
|
@@ -760,7 +781,7 @@ module Aws::Batch
|
|
760
781
|
include Aws::Structure
|
761
782
|
end
|
762
783
|
|
763
|
-
# An object
|
784
|
+
# An object that represents the attributes of a compute environment that
|
764
785
|
# can be updated. For more information, see [Updating compute
|
765
786
|
# environments][1] in the *Batch User Guide*.
|
766
787
|
#
|
@@ -795,6 +816,7 @@ module Aws::Batch
|
|
795
816
|
# {
|
796
817
|
# image_type: "ImageType", # required
|
797
818
|
# image_id_override: "ImageIdOverride",
|
819
|
+
# image_kubernetes_version: "KubernetesVersion",
|
798
820
|
# },
|
799
821
|
# ],
|
800
822
|
# update_to_latest_image_version: false,
|
@@ -807,7 +829,7 @@ module Aws::Batch
|
|
807
829
|
# maintain (even if the compute environment is `DISABLED`).
|
808
830
|
#
|
809
831
|
# <note markdown="1"> This parameter isn't applicable to jobs that are running on Fargate
|
810
|
-
# resources
|
832
|
+
# resources. Don't specify it.
|
811
833
|
#
|
812
834
|
# </note>
|
813
835
|
# @return [Integer]
|
@@ -817,11 +839,12 @@ module Aws::Batch
|
|
817
839
|
# reach.
|
818
840
|
#
|
819
841
|
# <note markdown="1"> With both `BEST_FIT_PROGRESSIVE` and `SPOT_CAPACITY_OPTIMIZED`
|
820
|
-
# allocation strategies
|
821
|
-
#
|
822
|
-
# `maxvCpus`
|
823
|
-
#
|
824
|
-
#
|
842
|
+
# allocation strategies using On-Demand or Spot Instances, and the
|
843
|
+
# `BEST_FIT` strategy using Spot Instances, Batch might need to exceed
|
844
|
+
# `maxvCpus` to meet your capacity requirements. In this event, Batch
|
845
|
+
# never exceeds `maxvCpus` by more than a single instance. That is, no
|
846
|
+
# more than a single instance from among those specified in your
|
847
|
+
# compute environment.
|
825
848
|
#
|
826
849
|
# </note>
|
827
850
|
# @return [Integer]
|
@@ -832,7 +855,7 @@ module Aws::Batch
|
|
832
855
|
# based on job queue demand.
|
833
856
|
#
|
834
857
|
# <note markdown="1"> This parameter isn't applicable to jobs that are running on Fargate
|
835
|
-
# resources
|
858
|
+
# resources. Don't specify it.
|
836
859
|
#
|
837
860
|
# </note>
|
838
861
|
# @return [Integer]
|
@@ -858,13 +881,13 @@ module Aws::Batch
|
|
858
881
|
# @return [Array<String>]
|
859
882
|
#
|
860
883
|
# @!attribute [rw] security_group_ids
|
861
|
-
# The Amazon EC2 security groups associated with instances
|
862
|
-
# the compute environment. This parameter is required for
|
863
|
-
# compute resources, where it can contain up to 5 security
|
864
|
-
# Fargate compute resources, providing an empty list is
|
865
|
-
# this parameter wasn't specified and no change is
|
866
|
-
# compute resources, providing an empty list removes the
|
867
|
-
# groups from the compute resource.
|
884
|
+
# The Amazon EC2 security groups that are associated with instances
|
885
|
+
# launched in the compute environment. This parameter is required for
|
886
|
+
# Fargate compute resources, where it can contain up to 5 security
|
887
|
+
# groups. For Fargate compute resources, providing an empty list is
|
888
|
+
# handled as if this parameter wasn't specified and no change is
|
889
|
+
# made. For EC2 compute resources, providing an empty list removes the
|
890
|
+
# security groups from the compute resource.
|
868
891
|
#
|
869
892
|
# When updating a compute environment, changing the EC2 security
|
870
893
|
# groups requires an infrastructure update of the compute environment.
|
@@ -877,11 +900,12 @@ module Aws::Batch
|
|
877
900
|
# @return [Array<String>]
|
878
901
|
#
|
879
902
|
# @!attribute [rw] allocation_strategy
|
880
|
-
# The allocation strategy to use for the compute resource if
|
881
|
-
# enough instances of the best fitting instance type can be
|
882
|
-
# This might be because of availability of the instance
|
883
|
-
# Region or [Amazon EC2 service limits][1]. For more
|
884
|
-
# [Allocation strategies][2] in the *Batch User
|
903
|
+
# The allocation strategy to use for the compute resource if there's
|
904
|
+
# not enough instances of the best fitting instance type that can be
|
905
|
+
# allocated. This might be because of availability of the instance
|
906
|
+
# type in the Region or [Amazon EC2 service limits][1]. For more
|
907
|
+
# information, see [Allocation strategies][2] in the *Batch User
|
908
|
+
# Guide*.
|
885
909
|
#
|
886
910
|
# When updating a compute environment, changing the allocation
|
887
911
|
# strategy requires an infrastructure update of the compute
|
@@ -890,30 +914,31 @@ module Aws::Batch
|
|
890
914
|
# supported when updating a compute environment.
|
891
915
|
#
|
892
916
|
# <note markdown="1"> This parameter isn't applicable to jobs that are running on Fargate
|
893
|
-
# resources
|
917
|
+
# resources. Don't specify it.
|
894
918
|
#
|
895
919
|
# </note>
|
896
920
|
#
|
897
921
|
# BEST\_FIT\_PROGRESSIVE
|
898
922
|
#
|
899
|
-
# : Batch
|
900
|
-
#
|
901
|
-
#
|
902
|
-
#
|
903
|
-
#
|
923
|
+
# : Batch selects additional instance types that are large enough to
|
924
|
+
# meet the requirements of the jobs in the queue. Its preference is
|
925
|
+
# for instance types with lower cost vCPUs. If additional instances
|
926
|
+
# of the previously selected instance types aren't available, Batch
|
927
|
+
# selects new instance types.
|
904
928
|
#
|
905
929
|
# SPOT\_CAPACITY\_OPTIMIZED
|
906
930
|
#
|
907
|
-
# : Batch
|
908
|
-
#
|
909
|
-
#
|
910
|
-
#
|
911
|
-
#
|
931
|
+
# : Batch selects one or more instance types that are large enough to
|
932
|
+
# meet the requirements of the jobs in the queue. Its preference is
|
933
|
+
# for instance types that are less likely to be interrupted. This
|
934
|
+
# allocation strategy is only available for Spot Instance compute
|
935
|
+
# resources.
|
912
936
|
#
|
913
937
|
# With both `BEST_FIT_PROGRESSIVE` and `SPOT_CAPACITY_OPTIMIZED`
|
914
|
-
# strategies
|
915
|
-
#
|
916
|
-
#
|
938
|
+
# strategies using On-Demand or Spot Instances, and the `BEST_FIT`
|
939
|
+
# strategy using Spot Instances, Batch might need to exceed `maxvCpus`
|
940
|
+
# to meet your capacity requirements. In this event, Batch never
|
941
|
+
# exceeds `maxvCpus` by more than a single instance.
|
917
942
|
#
|
918
943
|
#
|
919
944
|
#
|
@@ -936,7 +961,7 @@ module Aws::Batch
|
|
936
961
|
# User Guide*.
|
937
962
|
#
|
938
963
|
# <note markdown="1"> This parameter isn't applicable to jobs that are running on Fargate
|
939
|
-
# resources
|
964
|
+
# resources. Don't specify it.
|
940
965
|
#
|
941
966
|
# </note>
|
942
967
|
#
|
@@ -949,7 +974,7 @@ module Aws::Batch
|
|
949
974
|
#
|
950
975
|
# <note markdown="1"> Currently, `optimal` uses instance types from the C4, M4, and R4
|
951
976
|
# instance families. In Regions that don't have instance types from
|
952
|
-
# those instance families, instance types from the C5, M5
|
977
|
+
# those instance families, instance types from the C5, M5, and R5
|
953
978
|
# instance families are used.
|
954
979
|
#
|
955
980
|
# </note>
|
@@ -971,7 +996,7 @@ module Aws::Batch
|
|
971
996
|
# *Batch User Guide*.
|
972
997
|
#
|
973
998
|
# <note markdown="1"> This parameter isn't applicable to jobs that are running on Fargate
|
974
|
-
# resources
|
999
|
+
# resources. Don't specify it.
|
975
1000
|
#
|
976
1001
|
# </note>
|
977
1002
|
#
|
@@ -995,7 +1020,7 @@ module Aws::Batch
|
|
995
1020
|
# User Guide*.
|
996
1021
|
#
|
997
1022
|
# <note markdown="1"> This parameter isn't applicable to jobs that are running on Fargate
|
998
|
-
# resources
|
1023
|
+
# resources. Don't specify it.
|
999
1024
|
#
|
1000
1025
|
# </note>
|
1001
1026
|
#
|
@@ -1008,8 +1033,8 @@ module Aws::Batch
|
|
1008
1033
|
# @!attribute [rw] tags
|
1009
1034
|
# Key-value pair tags to be applied to EC2 resources that are launched
|
1010
1035
|
# in the compute environment. For Batch, these take the form of
|
1011
|
-
# "String1": "String2"
|
1012
|
-
# is the tag value
|
1036
|
+
# `"String1": "String2"`, where `String1` is the tag key and `String2`
|
1037
|
+
# is the tag value-for example, `\{ "Name": "Batch Instance -
|
1013
1038
|
# C4OnDemand" \}`. This is helpful for recognizing your Batch
|
1014
1039
|
# instances in the Amazon EC2 console. These tags aren't seen when
|
1015
1040
|
# using the Batch `ListTagsForResource` API operation.
|
@@ -1020,7 +1045,7 @@ module Aws::Batch
|
|
1020
1045
|
# User Guide*.
|
1021
1046
|
#
|
1022
1047
|
# <note markdown="1"> This parameter isn't applicable to jobs that are running on Fargate
|
1023
|
-
# resources
|
1048
|
+
# resources. Don't specify it.
|
1024
1049
|
#
|
1025
1050
|
# </note>
|
1026
1051
|
#
|
@@ -1045,7 +1070,7 @@ module Aws::Batch
|
|
1045
1070
|
# *Batch User Guide*.
|
1046
1071
|
#
|
1047
1072
|
# <note markdown="1"> This parameter isn't applicable to jobs that are running on Fargate
|
1048
|
-
# resources
|
1073
|
+
# resources. Don't specify it.
|
1049
1074
|
#
|
1050
1075
|
# </note>
|
1051
1076
|
#
|
@@ -1059,9 +1084,9 @@ module Aws::Batch
|
|
1059
1084
|
# The maximum percentage that a Spot Instance price can be when
|
1060
1085
|
# compared with the On-Demand price for that instance type before
|
1061
1086
|
# instances are launched. For example, if your maximum percentage is
|
1062
|
-
# 20%,
|
1063
|
-
#
|
1064
|
-
#
|
1087
|
+
# 20%, the Spot price must be less than 20% of the current On-Demand
|
1088
|
+
# price for that Amazon EC2 instance. You always pay the lowest
|
1089
|
+
# (market) price and never more than your maximum percentage.
|
1065
1090
|
#
|
1066
1091
|
# When updating a compute environment, changing the bid percentage
|
1067
1092
|
# requires an infrastructure update of the compute environment. For
|
@@ -1069,7 +1094,7 @@ module Aws::Batch
|
|
1069
1094
|
# *Batch User Guide*.
|
1070
1095
|
#
|
1071
1096
|
# <note markdown="1"> This parameter isn't applicable to jobs that are running on Fargate
|
1072
|
-
# resources
|
1097
|
+
# resources. Don't specify it.
|
1073
1098
|
#
|
1074
1099
|
# </note>
|
1075
1100
|
#
|
@@ -1097,7 +1122,7 @@ module Aws::Batch
|
|
1097
1122
|
# *Batch User Guide*.
|
1098
1123
|
#
|
1099
1124
|
# <note markdown="1"> This parameter isn't applicable to jobs that are running on Fargate
|
1100
|
-
# resources
|
1125
|
+
# resources. Don't specify it.
|
1101
1126
|
#
|
1102
1127
|
# </note>
|
1103
1128
|
#
|
@@ -1121,7 +1146,7 @@ module Aws::Batch
|
|
1121
1146
|
# One or two values can be provided.
|
1122
1147
|
#
|
1123
1148
|
# <note markdown="1"> This parameter isn't applicable to jobs that are running on Fargate
|
1124
|
-
# resources
|
1149
|
+
# resources. Don't specify it.
|
1125
1150
|
#
|
1126
1151
|
# </note>
|
1127
1152
|
#
|
@@ -1135,11 +1160,12 @@ module Aws::Batch
|
|
1135
1160
|
# supported by Batch when the compute environment has an
|
1136
1161
|
# infrastructure update. The default value is `false`.
|
1137
1162
|
#
|
1138
|
-
# <note markdown="1">
|
1139
|
-
# parameters or by the launch template
|
1140
|
-
# `launchTemplate` parameter
|
1141
|
-
#
|
1142
|
-
#
|
1163
|
+
# <note markdown="1"> An AMI ID can either be specified in the `imageId` or
|
1164
|
+
# `imageIdOverride` parameters or be determined by the launch template
|
1165
|
+
# that's specified in the `launchTemplate` parameter. If an AMI ID is
|
1166
|
+
# specified any of these ways, this parameter is ignored. For more
|
1167
|
+
# information about to update AMI IDs during an infrastructure update,
|
1168
|
+
# see [Updating the AMI ID][1] in the *Batch User Guide*.
|
1143
1169
|
#
|
1144
1170
|
# </note>
|
1145
1171
|
#
|
@@ -1188,7 +1214,7 @@ module Aws::Batch
|
|
1188
1214
|
# User Guide*.
|
1189
1215
|
#
|
1190
1216
|
# <note markdown="1"> This parameter isn't applicable to jobs that are running on Fargate
|
1191
|
-
# resources
|
1217
|
+
# resources. Don't specify it.
|
1192
1218
|
#
|
1193
1219
|
# </note>
|
1194
1220
|
#
|
@@ -1233,7 +1259,7 @@ module Aws::Batch
|
|
1233
1259
|
include Aws::Structure
|
1234
1260
|
end
|
1235
1261
|
|
1236
|
-
# An object
|
1262
|
+
# An object that represents the details of a container that's part of a
|
1237
1263
|
# job.
|
1238
1264
|
#
|
1239
1265
|
# @!attribute [rw] image
|
@@ -1277,8 +1303,8 @@ module Aws::Batch
|
|
1277
1303
|
# @return [Array<String>]
|
1278
1304
|
#
|
1279
1305
|
# @!attribute [rw] job_role_arn
|
1280
|
-
# The Amazon Resource Name (ARN) associated with the job
|
1281
|
-
#
|
1306
|
+
# The Amazon Resource Name (ARN) that's associated with the job when
|
1307
|
+
# run.
|
1282
1308
|
# @return [String]
|
1283
1309
|
#
|
1284
1310
|
# @!attribute [rw] execution_role_arn
|
@@ -1292,15 +1318,14 @@ module Aws::Batch
|
|
1292
1318
|
# @return [String]
|
1293
1319
|
#
|
1294
1320
|
# @!attribute [rw] volumes
|
1295
|
-
# A list of volumes associated with the job.
|
1321
|
+
# A list of volumes that are associated with the job.
|
1296
1322
|
# @return [Array<Types::Volume>]
|
1297
1323
|
#
|
1298
1324
|
# @!attribute [rw] environment
|
1299
1325
|
# The environment variables to pass to a container.
|
1300
1326
|
#
|
1301
|
-
# <note markdown="1"> Environment variables
|
1302
|
-
# convention is reserved for variables that
|
1303
|
-
# service.
|
1327
|
+
# <note markdown="1"> Environment variables cannot start with "`AWS_BATCH`". This naming
|
1328
|
+
# convention is reserved for variables that Batch sets.
|
1304
1329
|
#
|
1305
1330
|
# </note>
|
1306
1331
|
# @return [Array<Types::KeyValuePair>]
|
@@ -1342,10 +1367,10 @@ module Aws::Batch
|
|
1342
1367
|
# @!attribute [rw] privileged
|
1343
1368
|
# When this parameter is true, the container is given elevated
|
1344
1369
|
# permissions on the host container instance (similar to the `root`
|
1345
|
-
# user). The default value is false
|
1370
|
+
# user). The default value is `false`.
|
1346
1371
|
#
|
1347
1372
|
# <note markdown="1"> This parameter isn't applicable to jobs that are running on Fargate
|
1348
|
-
# resources and shouldn't be provided, or specified as false
|
1373
|
+
# resources and shouldn't be provided, or specified as `false`.
|
1349
1374
|
#
|
1350
1375
|
# </note>
|
1351
1376
|
# @return [Boolean]
|
@@ -1368,7 +1393,7 @@ module Aws::Batch
|
|
1368
1393
|
#
|
1369
1394
|
# @!attribute [rw] reason
|
1370
1395
|
# A short (255 max characters) human-readable string to provide
|
1371
|
-
# additional details
|
1396
|
+
# additional details for a running or stopped container.
|
1372
1397
|
# @return [String]
|
1373
1398
|
#
|
1374
1399
|
# @!attribute [rw] container_instance_arn
|
@@ -1383,10 +1408,10 @@ module Aws::Batch
|
|
1383
1408
|
# @return [String]
|
1384
1409
|
#
|
1385
1410
|
# @!attribute [rw] log_stream_name
|
1386
|
-
# The name of the CloudWatch Logs log stream associated
|
1387
|
-
# container. The log group for Batch jobs is
|
1388
|
-
# container attempt receives a log stream name
|
1389
|
-
# `RUNNING` status.
|
1411
|
+
# The name of the Amazon CloudWatch Logs log stream that's associated
|
1412
|
+
# with the container. The log group for Batch jobs is
|
1413
|
+
# `/aws/batch/job`. Each container attempt receives a log stream name
|
1414
|
+
# when they reach the `RUNNING` status.
|
1390
1415
|
# @return [String]
|
1391
1416
|
#
|
1392
1417
|
# @!attribute [rw] instance_type
|
@@ -1400,7 +1425,7 @@ module Aws::Batch
|
|
1400
1425
|
# @return [String]
|
1401
1426
|
#
|
1402
1427
|
# @!attribute [rw] network_interfaces
|
1403
|
-
# The network interfaces associated with the job.
|
1428
|
+
# The network interfaces that are associated with the job.
|
1404
1429
|
# @return [Array<Types::NetworkInterface>]
|
1405
1430
|
#
|
1406
1431
|
# @!attribute [rw] resource_requirements
|
@@ -1438,9 +1463,9 @@ module Aws::Batch
|
|
1438
1463
|
#
|
1439
1464
|
# This parameter requires version 1.18 of the Docker Remote API or
|
1440
1465
|
# greater on your container instance. To check the Docker Remote API
|
1441
|
-
# version on your container instance, log
|
1442
|
-
# and run the following command: `sudo docker version | grep
|
1443
|
-
# API version"`
|
1466
|
+
# version on your container instance, log in to your container
|
1467
|
+
# instance and run the following command: `sudo docker version | grep
|
1468
|
+
# "Server API version"`
|
1444
1469
|
#
|
1445
1470
|
# <note markdown="1"> The Amazon ECS container agent running on a container instance must
|
1446
1471
|
# register the logging drivers available on that instance with the
|
@@ -1542,8 +1567,8 @@ module Aws::Batch
|
|
1542
1567
|
# @!attribute [rw] vcpus
|
1543
1568
|
# This parameter is deprecated, use `resourceRequirements` to override
|
1544
1569
|
# the `vcpus` parameter that's set in the job definition. It's not
|
1545
|
-
# supported for jobs running on Fargate resources. For jobs
|
1546
|
-
# EC2 resources, it overrides the `vcpus` parameter set in the job
|
1570
|
+
# supported for jobs running on Fargate resources. For jobs that run
|
1571
|
+
# on EC2 resources, it overrides the `vcpus` parameter set in the job
|
1547
1572
|
# definition, but doesn't override any vCPU requirement specified in
|
1548
1573
|
# the `resourceRequirements` structure in the job definition. To
|
1549
1574
|
# override vCPU requirements that are specified in the
|
@@ -1561,12 +1586,12 @@ module Aws::Batch
|
|
1561
1586
|
# @!attribute [rw] memory
|
1562
1587
|
# This parameter is deprecated, use `resourceRequirements` to override
|
1563
1588
|
# the memory requirements specified in the job definition. It's not
|
1564
|
-
# supported for jobs running on Fargate resources. For jobs
|
1565
|
-
# EC2 resources, it overrides the `memory` parameter set in the job
|
1566
|
-
# definition, but doesn't override any memory requirement
|
1567
|
-
# in the `resourceRequirements` structure in the job
|
1568
|
-
# override memory requirements that are specified in
|
1569
|
-
# `resourceRequirements` structure in the job definition,
|
1589
|
+
# supported for jobs running on Fargate resources. For jobs that run
|
1590
|
+
# on EC2 resources, it overrides the `memory` parameter set in the job
|
1591
|
+
# definition, but doesn't override any memory requirement that's
|
1592
|
+
# specified in the `resourceRequirements` structure in the job
|
1593
|
+
# definition. To override memory requirements that are specified in
|
1594
|
+
# the `resourceRequirements` structure in the job definition,
|
1570
1595
|
# `resourceRequirements` must be specified in the `SubmitJob` request,
|
1571
1596
|
# with `type` set to `MEMORY` and `value` set to the new value. For
|
1572
1597
|
# more information, see [Can't override job definition resource
|
@@ -1597,9 +1622,8 @@ module Aws::Batch
|
|
1597
1622
|
# or you can override the existing environment variables from the
|
1598
1623
|
# Docker image or the job definition.
|
1599
1624
|
#
|
1600
|
-
# <note markdown="1"> Environment variables
|
1601
|
-
# convention is reserved for variables that
|
1602
|
-
# service.
|
1625
|
+
# <note markdown="1"> Environment variables cannot start with "`AWS_BATCH`". This naming
|
1626
|
+
# convention is reserved for variables that Batch sets.
|
1603
1627
|
#
|
1604
1628
|
# </note>
|
1605
1629
|
# @return [Array<Types::KeyValuePair>]
|
@@ -1623,8 +1647,9 @@ module Aws::Batch
|
|
1623
1647
|
include Aws::Structure
|
1624
1648
|
end
|
1625
1649
|
|
1626
|
-
# Container properties are used
|
1627
|
-
# container that's launched as part of
|
1650
|
+
# Container properties are used for Amazon ECS based job definitions.
|
1651
|
+
# These properties to describe the container that's launched as part of
|
1652
|
+
# a job.
|
1628
1653
|
#
|
1629
1654
|
# @note When making an API call, you may pass ContainerProperties
|
1630
1655
|
# data as a hash:
|
@@ -1734,11 +1759,12 @@ module Aws::Batch
|
|
1734
1759
|
# The image used to start a container. This string is passed directly
|
1735
1760
|
# to the Docker daemon. Images in the Docker Hub registry are
|
1736
1761
|
# available by default. Other repositories are specified with `
|
1737
|
-
# repository-url/image:tag `.
|
1738
|
-
# lowercase
|
1739
|
-
#
|
1740
|
-
# `Image` in the [Create a
|
1741
|
-
# API][2] and the `IMAGE`
|
1762
|
+
# repository-url/image:tag `. It can be 255 characters long. It can
|
1763
|
+
# contain uppercase and lowercase letters, numbers, hyphens (-),
|
1764
|
+
# underscores (\_), colons (:), periods (.), forward slashes (/), and
|
1765
|
+
# number signs (#). This parameter maps to `Image` in the [Create a
|
1766
|
+
# container][1] section of the [Docker Remote API][2] and the `IMAGE`
|
1767
|
+
# parameter of [docker run][3].
|
1742
1768
|
#
|
1743
1769
|
# <note markdown="1"> Docker image architecture must match the processor architecture of
|
1744
1770
|
# the compute resources that they're scheduled on. For example,
|
@@ -1753,7 +1779,7 @@ module Aws::Batch
|
|
1753
1779
|
#
|
1754
1780
|
# * Images in Amazon ECR repositories use the full registry and
|
1755
1781
|
# repository URI (for example,
|
1756
|
-
# `
|
1782
|
+
# `123456789012.dkr.ecr.<region-name>.amazonaws.com/<repository-name>`).
|
1757
1783
|
#
|
1758
1784
|
# * Images in official repositories on Docker Hub use a single name
|
1759
1785
|
# (for example, `ubuntu` or `mongo`).
|
@@ -1793,7 +1819,7 @@ module Aws::Batch
|
|
1793
1819
|
# @!attribute [rw] memory
|
1794
1820
|
# This parameter is deprecated, use `resourceRequirements` to specify
|
1795
1821
|
# the memory requirements for the job definition. It's not supported
|
1796
|
-
# for jobs running on Fargate resources. For jobs
|
1822
|
+
# for jobs running on Fargate resources. For jobs that run on EC2
|
1797
1823
|
# resources, it specifies the memory hard limit (in MiB) for a
|
1798
1824
|
# container. If your container attempts to exceed the specified
|
1799
1825
|
# number, it's terminated. You must specify at least 4 MiB of memory
|
@@ -1851,9 +1877,8 @@ module Aws::Batch
|
|
1851
1877
|
# We don't recommend using plaintext environment variables for
|
1852
1878
|
# sensitive information, such as credential data.
|
1853
1879
|
#
|
1854
|
-
# <note markdown="1"> Environment variables
|
1855
|
-
# convention is reserved for variables that
|
1856
|
-
# service.
|
1880
|
+
# <note markdown="1"> Environment variables cannot start with "`AWS_BATCH`". This naming
|
1881
|
+
# convention is reserved for variables that Batch sets.
|
1857
1882
|
#
|
1858
1883
|
# </note>
|
1859
1884
|
#
|
@@ -1979,9 +2004,9 @@ module Aws::Batch
|
|
1979
2004
|
#
|
1980
2005
|
# This parameter requires version 1.18 of the Docker Remote API or
|
1981
2006
|
# greater on your container instance. To check the Docker Remote API
|
1982
|
-
# version on your container instance, log
|
1983
|
-
# and run the following command: `sudo docker version | grep
|
1984
|
-
# API version"`
|
2007
|
+
# version on your container instance, log in to your container
|
2008
|
+
# instance and run the following command: `sudo docker version | grep
|
2009
|
+
# "Server API version"`
|
1985
2010
|
#
|
1986
2011
|
# <note markdown="1"> The Amazon ECS container agent running on a container instance must
|
1987
2012
|
# register the logging drivers available on that instance with the
|
@@ -2050,7 +2075,7 @@ module Aws::Batch
|
|
2050
2075
|
include Aws::Structure
|
2051
2076
|
end
|
2052
2077
|
|
2053
|
-
# An object
|
2078
|
+
# An object that represents summary details of a container within a job.
|
2054
2079
|
#
|
2055
2080
|
# @!attribute [rw] exit_code
|
2056
2081
|
# The exit code to return upon completion.
|
@@ -2058,7 +2083,7 @@ module Aws::Batch
|
|
2058
2083
|
#
|
2059
2084
|
# @!attribute [rw] reason
|
2060
2085
|
# A short (255 max characters) human-readable string to provide
|
2061
|
-
# additional details
|
2086
|
+
# additional details for a running or stopped container.
|
2062
2087
|
# @return [String]
|
2063
2088
|
#
|
2064
2089
|
# @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/ContainerSummary AWS API Documentation
|
@@ -2107,6 +2132,7 @@ module Aws::Batch
|
|
2107
2132
|
# {
|
2108
2133
|
# image_type: "ImageType", # required
|
2109
2134
|
# image_id_override: "ImageIdOverride",
|
2135
|
+
# image_kubernetes_version: "KubernetesVersion",
|
2110
2136
|
# },
|
2111
2137
|
# ],
|
2112
2138
|
# },
|
@@ -2114,12 +2140,16 @@ module Aws::Batch
|
|
2114
2140
|
# tags: {
|
2115
2141
|
# "TagKey" => "TagValue",
|
2116
2142
|
# },
|
2143
|
+
# eks_configuration: {
|
2144
|
+
# eks_cluster_arn: "String", # required
|
2145
|
+
# kubernetes_namespace: "String", # required
|
2146
|
+
# },
|
2117
2147
|
# }
|
2118
2148
|
#
|
2119
2149
|
# @!attribute [rw] compute_environment_name
|
2120
|
-
# The name for your compute environment. It can be up to 128
|
2121
|
-
# long. It can contain uppercase and lowercase letters,
|
2122
|
-
# hyphens (-), and underscores (\_).
|
2150
|
+
# The name for your compute environment. It can be up to 128
|
2151
|
+
# characters long. It can contain uppercase and lowercase letters,
|
2152
|
+
# numbers, hyphens (-), and underscores (\_).
|
2123
2153
|
# @return [String]
|
2124
2154
|
#
|
2125
2155
|
# @!attribute [rw] type
|
@@ -2189,9 +2219,9 @@ module Aws::Batch
|
|
2189
2219
|
# If your specified role has a path other than `/`, then you must
|
2190
2220
|
# specify either the full role ARN (recommended) or prefix the role
|
2191
2221
|
# name with the path. For example, if a role with the name `bar` has a
|
2192
|
-
# path of `/foo
|
2193
|
-
#
|
2194
|
-
#
|
2222
|
+
# path of `/foo/`, specify `/foo/bar` as the role name. For more
|
2223
|
+
# information, see [Friendly names and paths][2] in the *IAM User
|
2224
|
+
# Guide*.
|
2195
2225
|
#
|
2196
2226
|
# <note markdown="1"> Depending on how you created your Batch service role, its ARN might
|
2197
2227
|
# contain the `service-role` path prefix. When you only specify the
|
@@ -2225,6 +2255,11 @@ module Aws::Batch
|
|
2225
2255
|
# [3]: https://docs.aws.amazon.com/batch/latest/APIReference/API_UntagResource.html
|
2226
2256
|
# @return [Hash<String,String>]
|
2227
2257
|
#
|
2258
|
+
# @!attribute [rw] eks_configuration
|
2259
|
+
# The details for the Amazon EKS cluster that supports the compute
|
2260
|
+
# environment.
|
2261
|
+
# @return [Types::EksConfiguration]
|
2262
|
+
#
|
2228
2263
|
# @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/CreateComputeEnvironmentRequest AWS API Documentation
|
2229
2264
|
#
|
2230
2265
|
class CreateComputeEnvironmentRequest < Struct.new(
|
@@ -2234,13 +2269,14 @@ module Aws::Batch
|
|
2234
2269
|
:unmanagedv_cpus,
|
2235
2270
|
:compute_resources,
|
2236
2271
|
:service_role,
|
2237
|
-
:tags
|
2272
|
+
:tags,
|
2273
|
+
:eks_configuration)
|
2238
2274
|
SENSITIVE = []
|
2239
2275
|
include Aws::Structure
|
2240
2276
|
end
|
2241
2277
|
|
2242
2278
|
# @!attribute [rw] compute_environment_name
|
2243
|
-
# The name of the compute environment. It can be up to 128
|
2279
|
+
# The name of the compute environment. It can be up to 128 characters
|
2244
2280
|
# long. It can contain uppercase and lowercase letters, numbers,
|
2245
2281
|
# hyphens (-), and underscores (\_).
|
2246
2282
|
# @return [String]
|
@@ -2301,7 +2337,7 @@ module Aws::Batch
|
|
2301
2337
|
# scheduling policy. The format is
|
2302
2338
|
# `aws:Partition:batch:Region:Account:scheduling-policy/Name `. An
|
2303
2339
|
# example is
|
2304
|
-
# `aws:aws:batch:us-west-2:
|
2340
|
+
# `aws:aws:batch:us-west-2:123456789012:scheduling-policy/MySchedulingPolicy`.
|
2305
2341
|
# @return [String]
|
2306
2342
|
#
|
2307
2343
|
# @!attribute [rw] priority
|
@@ -2441,7 +2477,7 @@ module Aws::Batch
|
|
2441
2477
|
# The Amazon Resource Name (ARN) of the scheduling policy. The format
|
2442
2478
|
# is `aws:Partition:batch:Region:Account:scheduling-policy/Name `. For
|
2443
2479
|
# example,
|
2444
|
-
# `aws:aws:batch:us-west-2:
|
2480
|
+
# `aws:aws:batch:us-west-2:123456789012:scheduling-policy/MySchedulingPolicy`.
|
2445
2481
|
# @return [String]
|
2446
2482
|
#
|
2447
2483
|
# @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/CreateSchedulingPolicyResponse AWS API Documentation
|
@@ -2591,9 +2627,9 @@ module Aws::Batch
|
|
2591
2627
|
# `nextToken` value. This value is `null` when there are no more
|
2592
2628
|
# results to return.
|
2593
2629
|
#
|
2594
|
-
# <note markdown="1">
|
2595
|
-
#
|
2596
|
-
#
|
2630
|
+
# <note markdown="1"> Treat this token as an opaque identifier that's only used to
|
2631
|
+
# retrieve the next items in a list and not for other programmatic
|
2632
|
+
# purposes.
|
2597
2633
|
#
|
2598
2634
|
# </note>
|
2599
2635
|
# @return [String]
|
@@ -2678,9 +2714,9 @@ module Aws::Batch
|
|
2678
2714
|
# value. This value is `null` when there are no more results to
|
2679
2715
|
# return.
|
2680
2716
|
#
|
2681
|
-
# <note markdown="1">
|
2682
|
-
#
|
2683
|
-
#
|
2717
|
+
# <note markdown="1"> Treat this token as an opaque identifier that's only used to
|
2718
|
+
# retrieve the next items in a list and not for other programmatic
|
2719
|
+
# purposes.
|
2684
2720
|
#
|
2685
2721
|
# </note>
|
2686
2722
|
# @return [String]
|
@@ -2753,9 +2789,9 @@ module Aws::Batch
|
|
2753
2789
|
# value. This value is `null` when there are no more results to
|
2754
2790
|
# return.
|
2755
2791
|
#
|
2756
|
-
# <note markdown="1">
|
2757
|
-
#
|
2758
|
-
#
|
2792
|
+
# <note markdown="1"> Treat this token as an opaque identifier that's only used to
|
2793
|
+
# retrieve the next items in a list and not for other programmatic
|
2794
|
+
# purposes.
|
2759
2795
|
#
|
2760
2796
|
# </note>
|
2761
2797
|
# @return [String]
|
@@ -2858,7 +2894,7 @@ module Aws::Batch
|
|
2858
2894
|
include Aws::Structure
|
2859
2895
|
end
|
2860
2896
|
|
2861
|
-
# An object
|
2897
|
+
# An object that represents a container instance host device.
|
2862
2898
|
#
|
2863
2899
|
# <note markdown="1"> This object isn't applicable to jobs that are running on Fargate
|
2864
2900
|
# resources and shouldn't be provided.
|
@@ -2914,8 +2950,8 @@ module Aws::Batch
|
|
2914
2950
|
# The Amazon EFS access point ID to use. If an access point is
|
2915
2951
|
# specified, the root directory value specified in the
|
2916
2952
|
# `EFSVolumeConfiguration` must either be omitted or set to `/` which
|
2917
|
-
#
|
2918
|
-
#
|
2953
|
+
# enforces the path set on the EFS access point. If an access point is
|
2954
|
+
# used, transit encryption must be enabled in the
|
2919
2955
|
# `EFSVolumeConfiguration`. For more information, see [Working with
|
2920
2956
|
# Amazon EFS access points][1] in the *Amazon Elastic File System User
|
2921
2957
|
# Guide*.
|
@@ -3049,31 +3085,56 @@ module Aws::Batch
|
|
3049
3085
|
# {
|
3050
3086
|
# image_type: "ImageType", # required
|
3051
3087
|
# image_id_override: "ImageIdOverride",
|
3088
|
+
# image_kubernetes_version: "KubernetesVersion",
|
3052
3089
|
# }
|
3053
3090
|
#
|
3054
3091
|
# @!attribute [rw] image_type
|
3055
|
-
# The image type to match with the instance type to select an AMI.
|
3056
|
-
#
|
3057
|
-
#
|
3058
|
-
#
|
3059
|
-
# nor a `imageIdOverride` parameter is specified, then the latest
|
3060
|
-
# Amazon ECS optimized AMI for that image type that's supported by
|
3061
|
-
# Batch is used.
|
3092
|
+
# The image type to match with the instance type to select an AMI. The
|
3093
|
+
# supported values are different for `ECS` and `EKS` resources.
|
3094
|
+
#
|
3095
|
+
# ECS
|
3062
3096
|
#
|
3063
|
-
#
|
3097
|
+
# : If the `imageIdOverride` parameter isn't specified, then a recent
|
3098
|
+
# [Amazon ECS-optimized Amazon Linux 2 AMI][1] (`ECS_AL2`) is used.
|
3099
|
+
# If a new image type is specified in an update, but neither an
|
3100
|
+
# `imageId` nor a `imageIdOverride` parameter is specified, then the
|
3101
|
+
# latest Amazon ECS optimized AMI for that image type that's
|
3102
|
+
# supported by Batch is used.
|
3064
3103
|
#
|
3065
|
-
#
|
3104
|
+
# ECS\_AL2
|
3066
3105
|
#
|
3067
|
-
#
|
3106
|
+
# : [Amazon Linux 2][1]\: Default for all non-GPU instance families.
|
3068
3107
|
#
|
3069
|
-
#
|
3070
|
-
# (for example `P4` and `G4`) and can be used for all non Amazon Web
|
3071
|
-
# Services Graviton-based instance types.
|
3108
|
+
# ECS\_AL2\_NVIDIA
|
3072
3109
|
#
|
3073
|
-
#
|
3110
|
+
# : [Amazon Linux 2 (GPU)][2]\: Default for all GPU instance
|
3111
|
+
# families (for example `P4` and `G4`) and can be used for all non
|
3112
|
+
# Amazon Web Services Graviton-based instance types.
|
3074
3113
|
#
|
3075
|
-
#
|
3076
|
-
#
|
3114
|
+
# ECS\_AL1
|
3115
|
+
#
|
3116
|
+
# : [Amazon Linux][3]. Amazon Linux has reached the end-of-life of
|
3117
|
+
# standard support. For more information, see [Amazon Linux
|
3118
|
+
# AMI][4].
|
3119
|
+
#
|
3120
|
+
# EKS
|
3121
|
+
#
|
3122
|
+
# : If the `imageIdOverride` parameter isn't specified, then a recent
|
3123
|
+
# [Amazon EKS-optimized Amazon Linux AMI][5] (`EKS_AL2`) is used. If
|
3124
|
+
# a new image type is specified in an update, but neither an
|
3125
|
+
# `imageId` nor a `imageIdOverride` parameter is specified, then the
|
3126
|
+
# latest Amazon EKS optimized AMI for that image type that Batch
|
3127
|
+
# supports is used.
|
3128
|
+
#
|
3129
|
+
# EKS\_AL2
|
3130
|
+
#
|
3131
|
+
# : [Amazon Linux 2][5]\: Default for all non-GPU instance families.
|
3132
|
+
#
|
3133
|
+
# EKS\_AL2\_NVIDIA
|
3134
|
+
#
|
3135
|
+
# : [Amazon Linux 2 (accelerated)][5]\: Default for all GPU instance
|
3136
|
+
# families (for example, `P4` and `G4`) and can be used for all
|
3137
|
+
# non Amazon Web Services Graviton-based instance types.
|
3077
3138
|
#
|
3078
3139
|
#
|
3079
3140
|
#
|
@@ -3081,6 +3142,7 @@ module Aws::Batch
|
|
3081
3142
|
# [2]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html#gpuami
|
3082
3143
|
# [3]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html#alami
|
3083
3144
|
# [4]: http://aws.amazon.com/amazon-linux-ami/
|
3145
|
+
# [5]: https://docs.aws.amazon.com/eks/latest/userguide/eks-optimized-ami.html
|
3084
3146
|
# @return [String]
|
3085
3147
|
#
|
3086
3148
|
# @!attribute [rw] image_id_override
|
@@ -3104,247 +3166,1603 @@ module Aws::Batch
|
|
3104
3166
|
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html#ecs-optimized-ami-linux-variants.html
|
3105
3167
|
# @return [String]
|
3106
3168
|
#
|
3169
|
+
# @!attribute [rw] image_kubernetes_version
|
3170
|
+
# The Kubernetes version for the compute environment. If you don't
|
3171
|
+
# specify a value, the latest version that Batch supports is used.
|
3172
|
+
# @return [String]
|
3173
|
+
#
|
3107
3174
|
# @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/Ec2Configuration AWS API Documentation
|
3108
3175
|
#
|
3109
3176
|
class Ec2Configuration < Struct.new(
|
3110
3177
|
:image_type,
|
3111
|
-
:image_id_override
|
3178
|
+
:image_id_override,
|
3179
|
+
:image_kubernetes_version)
|
3112
3180
|
SENSITIVE = []
|
3113
3181
|
include Aws::Structure
|
3114
3182
|
end
|
3115
3183
|
|
3116
|
-
#
|
3117
|
-
#
|
3184
|
+
# An object that represents the details for an attempt for a job attempt
|
3185
|
+
# that an Amazon EKS container runs.
|
3118
3186
|
#
|
3119
|
-
#
|
3120
|
-
#
|
3187
|
+
# @!attribute [rw] exit_code
|
3188
|
+
# The exit code for the job attempt. A non-zero exit code is
|
3189
|
+
# considered failed.
|
3190
|
+
# @return [Integer]
|
3121
3191
|
#
|
3122
|
-
#
|
3123
|
-
#
|
3124
|
-
#
|
3125
|
-
#
|
3126
|
-
# action: "RETRY", # required, accepts RETRY, EXIT
|
3127
|
-
# }
|
3192
|
+
# @!attribute [rw] reason
|
3193
|
+
# A short (255 max characters) human-readable string to provide
|
3194
|
+
# additional details for a running or stopped container.
|
3195
|
+
# @return [String]
|
3128
3196
|
#
|
3129
|
-
#
|
3130
|
-
# Contains a glob pattern to match against the `StatusReason` returned
|
3131
|
-
# for a job. The pattern can be up to 512 characters in length. It can
|
3132
|
-
# contain letters, numbers, periods (.), colons (:), and white space
|
3133
|
-
# (including spaces or tabs). It can optionally end with an asterisk
|
3134
|
-
# (*) so that only the start of the string needs to be an exact
|
3135
|
-
# match.
|
3197
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/EksAttemptContainerDetail AWS API Documentation
|
3136
3198
|
#
|
3137
|
-
|
3138
|
-
|
3199
|
+
class EksAttemptContainerDetail < Struct.new(
|
3200
|
+
:exit_code,
|
3201
|
+
:reason)
|
3202
|
+
SENSITIVE = []
|
3203
|
+
include Aws::Structure
|
3204
|
+
end
|
3205
|
+
|
3206
|
+
# An object that represents the details of a job attempt for a job
|
3207
|
+
# attempt by an Amazon EKS container.
|
3139
3208
|
#
|
3140
|
-
# @!attribute [rw]
|
3141
|
-
#
|
3142
|
-
#
|
3143
|
-
#
|
3144
|
-
# (including spaces and tabs). It can optionally end with an asterisk
|
3145
|
-
# (*) so that only the start of the string needs to be an exact
|
3146
|
-
# match.
|
3209
|
+
# @!attribute [rw] containers
|
3210
|
+
# The details for the final status of the containers for this job
|
3211
|
+
# attempt.
|
3212
|
+
# @return [Array<Types::EksAttemptContainerDetail>]
|
3147
3213
|
#
|
3148
|
-
#
|
3214
|
+
# @!attribute [rw] pod_name
|
3215
|
+
# The name of the pod for this job attempt.
|
3149
3216
|
# @return [String]
|
3150
3217
|
#
|
3151
|
-
# @!attribute [rw]
|
3152
|
-
#
|
3153
|
-
# of the `ExitCode` returned for a job. The pattern can be up to 512
|
3154
|
-
# characters in length. It can contain only numbers, and can
|
3155
|
-
# optionally end with an asterisk (*) so that only the start of the
|
3156
|
-
# string needs to be an exact match.
|
3157
|
-
#
|
3158
|
-
# The string can be between 1 and 512 characters in length.
|
3218
|
+
# @!attribute [rw] node_name
|
3219
|
+
# The name of the node for this job attempt.
|
3159
3220
|
# @return [String]
|
3160
3221
|
#
|
3161
|
-
# @!attribute [rw]
|
3162
|
-
#
|
3163
|
-
# (
|
3164
|
-
#
|
3222
|
+
# @!attribute [rw] started_at
|
3223
|
+
# The Unix timestamp (in milliseconds) for when the attempt was
|
3224
|
+
# started (when the attempt transitioned from the `STARTING` state to
|
3225
|
+
# the `RUNNING` state).
|
3226
|
+
# @return [Integer]
|
3227
|
+
#
|
3228
|
+
# @!attribute [rw] stopped_at
|
3229
|
+
# The Unix timestamp (in milliseconds) for when the attempt was
|
3230
|
+
# stopped. This happens when the attempt transitioned from the
|
3231
|
+
# `RUNNING` state to a terminal state, such as `SUCCEEDED` or
|
3232
|
+
# `FAILED`.
|
3233
|
+
# @return [Integer]
|
3234
|
+
#
|
3235
|
+
# @!attribute [rw] status_reason
|
3236
|
+
# A short, human-readable string to provide additional details for the
|
3237
|
+
# current status of the job attempt.
|
3165
3238
|
# @return [String]
|
3166
3239
|
#
|
3167
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/
|
3240
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/EksAttemptDetail AWS API Documentation
|
3168
3241
|
#
|
3169
|
-
class
|
3170
|
-
:
|
3171
|
-
:
|
3172
|
-
:
|
3173
|
-
:
|
3242
|
+
class EksAttemptDetail < Struct.new(
|
3243
|
+
:containers,
|
3244
|
+
:pod_name,
|
3245
|
+
:node_name,
|
3246
|
+
:started_at,
|
3247
|
+
:stopped_at,
|
3248
|
+
:status_reason)
|
3174
3249
|
SENSITIVE = []
|
3175
3250
|
include Aws::Structure
|
3176
3251
|
end
|
3177
3252
|
|
3178
|
-
#
|
3253
|
+
# Configuration for the Amazon EKS cluster that supports the Batch
|
3254
|
+
# compute environment. The cluster must exist before the compute
|
3255
|
+
# environment can be created.
|
3179
3256
|
#
|
3180
|
-
# @note When making an API call, you may pass
|
3257
|
+
# @note When making an API call, you may pass EksConfiguration
|
3181
3258
|
# data as a hash:
|
3182
3259
|
#
|
3183
3260
|
# {
|
3184
|
-
#
|
3185
|
-
#
|
3186
|
-
# share_distribution: [
|
3187
|
-
# {
|
3188
|
-
# share_identifier: "String", # required
|
3189
|
-
# weight_factor: 1.0,
|
3190
|
-
# },
|
3191
|
-
# ],
|
3261
|
+
# eks_cluster_arn: "String", # required
|
3262
|
+
# kubernetes_namespace: "String", # required
|
3192
3263
|
# }
|
3193
3264
|
#
|
3194
|
-
# @!attribute [rw]
|
3195
|
-
# The
|
3196
|
-
#
|
3197
|
-
#
|
3198
|
-
# allows for more recently run jobs to have more weight than jobs that
|
3199
|
-
# ran earlier. The maximum supported value is 604800 (1 week).
|
3200
|
-
# @return [Integer]
|
3201
|
-
#
|
3202
|
-
# @!attribute [rw] compute_reservation
|
3203
|
-
# A value used to reserve some of the available maximum vCPU for fair
|
3204
|
-
# share identifiers that have not yet been used.
|
3265
|
+
# @!attribute [rw] eks_cluster_arn
|
3266
|
+
# The Amazon Resource Name (ARN) of the Amazon EKS cluster. An example
|
3267
|
+
# is `arn:aws:eks:us-east-1:123456789012:cluster/ClusterForBatch `.
|
3268
|
+
# @return [String]
|
3205
3269
|
#
|
3206
|
-
#
|
3207
|
-
#
|
3208
|
-
#
|
3270
|
+
# @!attribute [rw] kubernetes_namespace
|
3271
|
+
# The namespace of the Amazon EKS cluster. Batch manages pods in this
|
3272
|
+
# namespace. The value can't left empty or null. It must be fewer
|
3273
|
+
# than 64 characters long, can't be set to `default`, can't start
|
3274
|
+
# with "`kube-`," and must match this regular expression:
|
3275
|
+
# `^[a-z0-9]([-a-z0-9]*[a-z0-9])?$`. For more information, see
|
3276
|
+
# [Namespaces][1] in the Kubernetes documentation.
|
3209
3277
|
#
|
3210
|
-
# For example, a `computeReservation` value of 50 indicates that Batch
|
3211
|
-
# should reserve 50% of the maximum available vCPU if there is only
|
3212
|
-
# one fair share identifier, 25% if there are two fair share
|
3213
|
-
# identifiers, and 12.5% if there are three fair share identifiers. A
|
3214
|
-
# `computeReservation` value of 25 indicates that Batch should reserve
|
3215
|
-
# 25% of the maximum available vCPU if there is only one fair share
|
3216
|
-
# identifier, 6.25% if there are two fair share identifiers, and 1.56%
|
3217
|
-
# if there are three fair share identifiers.
|
3218
3278
|
#
|
3219
|
-
# The minimum value is 0 and the maximum value is 99.
|
3220
|
-
# @return [Integer]
|
3221
3279
|
#
|
3222
|
-
#
|
3223
|
-
#
|
3224
|
-
# the fair share identifiers for the fair share policy. Fair share
|
3225
|
-
# identifiers that aren't included have a default weight of `1.0`.
|
3226
|
-
# @return [Array<Types::ShareAttributes>]
|
3280
|
+
# [1]: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/
|
3281
|
+
# @return [String]
|
3227
3282
|
#
|
3228
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/
|
3283
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/EksConfiguration AWS API Documentation
|
3229
3284
|
#
|
3230
|
-
class
|
3231
|
-
:
|
3232
|
-
:
|
3233
|
-
:share_distribution)
|
3285
|
+
class EksConfiguration < Struct.new(
|
3286
|
+
:eks_cluster_arn,
|
3287
|
+
:kubernetes_namespace)
|
3234
3288
|
SENSITIVE = []
|
3235
3289
|
include Aws::Structure
|
3236
3290
|
end
|
3237
3291
|
|
3238
|
-
#
|
3239
|
-
#
|
3240
|
-
#
|
3292
|
+
# EKS container properties are used in job definitions for Amazon EKS
|
3293
|
+
# based job definitions to describe the properties for a container node
|
3294
|
+
# in the pod that's launched as part of a job. This can't be specified
|
3295
|
+
# for Amazon ECS based job definitions.
|
3241
3296
|
#
|
3242
|
-
# @note When making an API call, you may pass
|
3297
|
+
# @note When making an API call, you may pass EksContainer
|
3243
3298
|
# data as a hash:
|
3244
3299
|
#
|
3245
3300
|
# {
|
3246
|
-
#
|
3301
|
+
# name: "String",
|
3302
|
+
# image: "String", # required
|
3303
|
+
# image_pull_policy: "String",
|
3304
|
+
# command: ["String"],
|
3305
|
+
# args: ["String"],
|
3306
|
+
# env: [
|
3307
|
+
# {
|
3308
|
+
# name: "String", # required
|
3309
|
+
# value: "String",
|
3310
|
+
# },
|
3311
|
+
# ],
|
3312
|
+
# resources: {
|
3313
|
+
# limits: {
|
3314
|
+
# "String" => "Quantity",
|
3315
|
+
# },
|
3316
|
+
# requests: {
|
3317
|
+
# "String" => "Quantity",
|
3318
|
+
# },
|
3319
|
+
# },
|
3320
|
+
# volume_mounts: [
|
3321
|
+
# {
|
3322
|
+
# name: "String",
|
3323
|
+
# mount_path: "String",
|
3324
|
+
# read_only: false,
|
3325
|
+
# },
|
3326
|
+
# ],
|
3327
|
+
# security_context: {
|
3328
|
+
# run_as_user: 1,
|
3329
|
+
# run_as_group: 1,
|
3330
|
+
# privileged: false,
|
3331
|
+
# read_only_root_filesystem: false,
|
3332
|
+
# run_as_non_root: false,
|
3333
|
+
# },
|
3247
3334
|
# }
|
3248
3335
|
#
|
3249
|
-
# @!attribute [rw]
|
3250
|
-
# The
|
3251
|
-
#
|
3252
|
-
#
|
3253
|
-
#
|
3254
|
-
# platform for compute resources. For more information, see [Fargate
|
3255
|
-
# platform versions][1] in the *Amazon Elastic Container Service
|
3256
|
-
# Developer Guide*.
|
3336
|
+
# @!attribute [rw] name
|
3337
|
+
# The name of the container. If the name isn't specified, the default
|
3338
|
+
# name "`Default`" is used. Each container in a pod must have a
|
3339
|
+
# unique name.
|
3340
|
+
# @return [String]
|
3257
3341
|
#
|
3342
|
+
# @!attribute [rw] image
|
3343
|
+
# The Docker image used to start the container.
|
3344
|
+
# @return [String]
|
3258
3345
|
#
|
3346
|
+
# @!attribute [rw] image_pull_policy
|
3347
|
+
# The image pull policy for the container. Supported values are
|
3348
|
+
# `Always`, `IfNotPresent`, and `Never`. This parameter defaults to
|
3349
|
+
# `IfNotPresent`. However, if the `:latest` tag is specified, it
|
3350
|
+
# defaults to `Always`. For more information, see [Updating images][1]
|
3351
|
+
# in the *Kubernetes documentation*.
|
3259
3352
|
#
|
3260
|
-
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html
|
3261
|
-
# @return [String]
|
3262
3353
|
#
|
3263
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/FargatePlatformConfiguration AWS API Documentation
|
3264
3354
|
#
|
3265
|
-
|
3266
|
-
|
3267
|
-
SENSITIVE = []
|
3268
|
-
include Aws::Structure
|
3269
|
-
end
|
3270
|
-
|
3271
|
-
# Determine whether your data volume persists on the host container
|
3272
|
-
# instance and where it is stored. If this parameter is empty, then the
|
3273
|
-
# Docker daemon assigns a host path for your data volume, but the data
|
3274
|
-
# isn't guaranteed to persist after the containers associated with it
|
3275
|
-
# stop running.
|
3355
|
+
# [1]: https://kubernetes.io/docs/concepts/containers/images/#updating-images
|
3356
|
+
# @return [String]
|
3276
3357
|
#
|
3277
|
-
#
|
3278
|
-
#
|
3358
|
+
# @!attribute [rw] command
|
3359
|
+
# The entrypoint for the container. This isn't run within a shell. If
|
3360
|
+
# this isn't specified, the `ENTRYPOINT` of the container image is
|
3361
|
+
# used. Environment variable references are expanded using the
|
3362
|
+
# container's environment.
|
3363
|
+
#
|
3364
|
+
# If the referenced environment variable doesn't exist, the reference
|
3365
|
+
# in the command isn't changed. For example, if the reference is to
|
3366
|
+
# "`$(NAME1)`" and the `NAME1` environment variable doesn't exist,
|
3367
|
+
# the command string will remain "`$(NAME1)`." `$$` is replaced with
|
3368
|
+
# `$` and the resulting string isn't expanded. For example,
|
3369
|
+
# `$$(VAR_NAME)` will be passed as `$(VAR_NAME)` whether or not the
|
3370
|
+
# `VAR_NAME` environment variable exists. The entrypoint can't be
|
3371
|
+
# updated. For more information, see [ENTRYPOINT][1] in the
|
3372
|
+
# *Dockerfile reference* and [Define a command and arguments for a
|
3373
|
+
# container][2] and [Entrypoint][3] in the *Kubernetes documentation*.
|
3374
|
+
#
|
3375
|
+
#
|
3376
|
+
#
|
3377
|
+
# [1]: https://docs.docker.com/engine/reference/builder/#entrypoint
|
3378
|
+
# [2]: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/
|
3379
|
+
# [3]: https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-v1/#entrypoint
|
3380
|
+
# @return [Array<String>]
|
3279
3381
|
#
|
3280
|
-
#
|
3281
|
-
#
|
3282
|
-
#
|
3382
|
+
# @!attribute [rw] args
|
3383
|
+
# An array of arguments to the entrypoint. If this isn't specified,
|
3384
|
+
# the `CMD` of the container image is used. This corresponds to the
|
3385
|
+
# `args` member in the [Entrypoint][1] portion of the [Pod][2] in
|
3386
|
+
# Kubernetes. Environment variable references are expanded using the
|
3387
|
+
# container's environment.
|
3388
|
+
#
|
3389
|
+
# If the referenced environment variable doesn't exist, the reference
|
3390
|
+
# in the command isn't changed. For example, if the reference is to
|
3391
|
+
# "`$(NAME1)`" and the `NAME1` environment variable doesn't exist,
|
3392
|
+
# the command string will remain "`$(NAME1)`." `$$` is replaced with
|
3393
|
+
# `$`, and the resulting string isn't expanded. For example,
|
3394
|
+
# `$$(VAR_NAME)` is passed as `$(VAR_NAME)` whether or not the
|
3395
|
+
# `VAR_NAME` environment variable exists. For more information, see
|
3396
|
+
# [CMD][3] in the *Dockerfile reference* and [Define a command and
|
3397
|
+
# arguments for a pod][4] in the *Kubernetes documentation*.
|
3398
|
+
#
|
3399
|
+
#
|
3400
|
+
#
|
3401
|
+
# [1]: https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-v1/#entrypoint
|
3402
|
+
# [2]: https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-v1/
|
3403
|
+
# [3]: https://docs.docker.com/engine/reference/builder/#cmd
|
3404
|
+
# [4]: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/
|
3405
|
+
# @return [Array<String>]
|
3283
3406
|
#
|
3284
|
-
# @!attribute [rw]
|
3285
|
-
# The
|
3286
|
-
# container. If this parameter is empty, then the Docker daemon has
|
3287
|
-
# assigned a host path for you. If this parameter contains a file
|
3288
|
-
# location, then the data volume persists at the specified location on
|
3289
|
-
# the host container instance until you delete it manually. If the
|
3290
|
-
# source path location doesn't exist on the host container instance,
|
3291
|
-
# the Docker daemon creates it. If the location does exist, the
|
3292
|
-
# contents of the source path folder are exported.
|
3407
|
+
# @!attribute [rw] env
|
3408
|
+
# The environment variables to pass to a container.
|
3293
3409
|
#
|
3294
|
-
# <note markdown="1">
|
3295
|
-
#
|
3410
|
+
# <note markdown="1"> Environment variables cannot start with "`AWS_BATCH`". This naming
|
3411
|
+
# convention is reserved for variables that Batch sets.
|
3296
3412
|
#
|
3297
3413
|
# </note>
|
3298
|
-
# @return [
|
3414
|
+
# @return [Array<Types::EksContainerEnvironmentVariable>]
|
3299
3415
|
#
|
3300
|
-
#
|
3416
|
+
# @!attribute [rw] resources
|
3417
|
+
# The type and amount of resources to assign to a container. The
|
3418
|
+
# supported resources include `memory`, `cpu`, and `nvidia.com/gpu`.
|
3419
|
+
# For more information, see [Resource management for pods and
|
3420
|
+
# containers][1] in the *Kubernetes documentation*.
|
3301
3421
|
#
|
3302
|
-
|
3303
|
-
|
3422
|
+
#
|
3423
|
+
#
|
3424
|
+
# [1]: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
|
3425
|
+
# @return [Types::EksContainerResourceRequirements]
|
3426
|
+
#
|
3427
|
+
# @!attribute [rw] volume_mounts
|
3428
|
+
# The volume mounts for the container. Batch supports `emptyDir`,
|
3429
|
+
# `hostPath`, and `secret` volume types. For more information about
|
3430
|
+
# volumes and volume mounts in Kubernetes, see [Volumes][1] in the
|
3431
|
+
# *Kubernetes documentation*.
|
3432
|
+
#
|
3433
|
+
#
|
3434
|
+
#
|
3435
|
+
# [1]: https://kubernetes.io/docs/concepts/storage/volumes/
|
3436
|
+
# @return [Array<Types::EksContainerVolumeMount>]
|
3437
|
+
#
|
3438
|
+
# @!attribute [rw] security_context
|
3439
|
+
# The security context for a job. For more information, see [Configure
|
3440
|
+
# a security context for a pod or container][1] in the *Kubernetes
|
3441
|
+
# documentation*.
|
3442
|
+
#
|
3443
|
+
#
|
3444
|
+
#
|
3445
|
+
# [1]: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/
|
3446
|
+
# @return [Types::EksContainerSecurityContext]
|
3447
|
+
#
|
3448
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/EksContainer AWS API Documentation
|
3449
|
+
#
|
3450
|
+
class EksContainer < Struct.new(
|
3451
|
+
:name,
|
3452
|
+
:image,
|
3453
|
+
:image_pull_policy,
|
3454
|
+
:command,
|
3455
|
+
:args,
|
3456
|
+
:env,
|
3457
|
+
:resources,
|
3458
|
+
:volume_mounts,
|
3459
|
+
:security_context)
|
3304
3460
|
SENSITIVE = []
|
3305
3461
|
include Aws::Structure
|
3306
3462
|
end
|
3307
3463
|
|
3308
|
-
#
|
3464
|
+
# The details for container properties that are returned by
|
3465
|
+
# `DescribeJobs` for jobs that use Amazon EKS.
|
3309
3466
|
#
|
3310
|
-
# @!attribute [rw]
|
3311
|
-
# The name of the
|
3467
|
+
# @!attribute [rw] name
|
3468
|
+
# The name of the container. If the name isn't specified, the default
|
3469
|
+
# name "`Default`" is used. Each container in a pod must have a
|
3470
|
+
# unique name.
|
3312
3471
|
# @return [String]
|
3313
3472
|
#
|
3314
|
-
# @!attribute [rw]
|
3315
|
-
# The
|
3473
|
+
# @!attribute [rw] image
|
3474
|
+
# The Docker image used to start the container.
|
3316
3475
|
# @return [String]
|
3317
3476
|
#
|
3318
|
-
# @!attribute [rw]
|
3319
|
-
# The
|
3320
|
-
#
|
3477
|
+
# @!attribute [rw] image_pull_policy
|
3478
|
+
# The image pull policy for the container. Supported values are
|
3479
|
+
# `Always`, `IfNotPresent`, and `Never`. This parameter defaults to
|
3480
|
+
# `Always` if the `:latest` tag is specified, `IfNotPresent`
|
3481
|
+
# otherwise. For more information, see [Updating images][1] in the
|
3482
|
+
# *Kubernetes documentation*.
|
3321
3483
|
#
|
3322
|
-
#
|
3323
|
-
#
|
3484
|
+
#
|
3485
|
+
#
|
3486
|
+
# [1]: https://kubernetes.io/docs/concepts/containers/images/#updating-images
|
3324
3487
|
# @return [String]
|
3325
3488
|
#
|
3326
|
-
# @!attribute [rw]
|
3327
|
-
# The
|
3328
|
-
#
|
3329
|
-
# supported. For more information about multi-node parallel jobs, see
|
3330
|
-
# [Creating a multi-node parallel job definition][1] in the *Batch
|
3331
|
-
# User Guide*.
|
3489
|
+
# @!attribute [rw] command
|
3490
|
+
# The entrypoint for the container. For more information, see
|
3491
|
+
# [Entrypoint][1] in the *Kubernetes documentation*.
|
3332
3492
|
#
|
3333
3493
|
#
|
3334
3494
|
#
|
3335
|
-
# [1]: https://
|
3336
|
-
# @return [String]
|
3495
|
+
# [1]: https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-v1/#entrypoint
|
3496
|
+
# @return [Array<String>]
|
3337
3497
|
#
|
3338
|
-
# @!attribute [rw]
|
3339
|
-
#
|
3340
|
-
#
|
3341
|
-
#
|
3342
|
-
#
|
3343
|
-
#
|
3498
|
+
# @!attribute [rw] args
|
3499
|
+
# An array of arguments to the entrypoint. If this isn't specified,
|
3500
|
+
# the `CMD` of the container image is used. This corresponds to the
|
3501
|
+
# `args` member in the [Entrypoint][1] portion of the [Pod][2] in
|
3502
|
+
# Kubernetes. Environment variable references are expanded using the
|
3503
|
+
# container's environment.
|
3504
|
+
#
|
3505
|
+
# If the referenced environment variable doesn't exist, the reference
|
3506
|
+
# in the command isn't changed. For example, if the reference is to
|
3507
|
+
# "`$(NAME1)`" and the `NAME1` environment variable doesn't exist,
|
3508
|
+
# the command string will remain "`$(NAME1)`". `$$` is replaced with
|
3509
|
+
# `$` and the resulting string isn't expanded. For example,
|
3510
|
+
# `$$(VAR_NAME)` is passed as `$(VAR_NAME)` whether or not the
|
3511
|
+
# `VAR_NAME` environment variable exists. For more information, see
|
3512
|
+
# [CMD][3] in the *Dockerfile reference* and [Define a command and
|
3513
|
+
# arguments for a pod][4] in the *Kubernetes documentation*.
|
3514
|
+
#
|
3515
|
+
#
|
3516
|
+
#
|
3517
|
+
# [1]: https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-v1/#entrypoint
|
3518
|
+
# [2]: https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-v1/
|
3519
|
+
# [3]: https://docs.docker.com/engine/reference/builder/#cmd
|
3520
|
+
# [4]: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/
|
3521
|
+
# @return [Array<String>]
|
3344
3522
|
#
|
3345
|
-
# @!attribute [rw]
|
3346
|
-
#
|
3347
|
-
#
|
3523
|
+
# @!attribute [rw] env
|
3524
|
+
# The environment variables to pass to a container.
|
3525
|
+
#
|
3526
|
+
# <note markdown="1"> Environment variables cannot start with "`AWS_BATCH`". This naming
|
3527
|
+
# convention is reserved for variables that Batch sets.
|
3528
|
+
#
|
3529
|
+
# </note>
|
3530
|
+
# @return [Array<Types::EksContainerEnvironmentVariable>]
|
3531
|
+
#
|
3532
|
+
# @!attribute [rw] resources
|
3533
|
+
# The type and amount of resources to assign to a container. The
|
3534
|
+
# supported resources include `memory`, `cpu`, and `nvidia.com/gpu`.
|
3535
|
+
# For more information, see [Resource management for pods and
|
3536
|
+
# containers][1] in the *Kubernetes documentation*.
|
3537
|
+
#
|
3538
|
+
#
|
3539
|
+
#
|
3540
|
+
# [1]: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
|
3541
|
+
# @return [Types::EksContainerResourceRequirements]
|
3542
|
+
#
|
3543
|
+
# @!attribute [rw] exit_code
|
3544
|
+
# The exit code for the job attempt. A non-zero exit code is
|
3545
|
+
# considered failed.
|
3546
|
+
# @return [Integer]
|
3547
|
+
#
|
3548
|
+
# @!attribute [rw] reason
|
3549
|
+
# A short human-readable string to provide additional details for a
|
3550
|
+
# running or stopped container. It can be up to 255 characters long.
|
3551
|
+
# @return [String]
|
3552
|
+
#
|
3553
|
+
# @!attribute [rw] volume_mounts
|
3554
|
+
# The volume mounts for the container. Batch supports `emptyDir`,
|
3555
|
+
# `hostPath`, and `secret` volume types. For more information about
|
3556
|
+
# volumes and volume mounts in Kubernetes, see [Volumes][1] in the
|
3557
|
+
# *Kubernetes documentation*.
|
3558
|
+
#
|
3559
|
+
#
|
3560
|
+
#
|
3561
|
+
# [1]: https://kubernetes.io/docs/concepts/storage/volumes/
|
3562
|
+
# @return [Array<Types::EksContainerVolumeMount>]
|
3563
|
+
#
|
3564
|
+
# @!attribute [rw] security_context
|
3565
|
+
# The security context for a job. For more information, see [Configure
|
3566
|
+
# a security context for a pod or container][1] in the *Kubernetes
|
3567
|
+
# documentation*.
|
3568
|
+
#
|
3569
|
+
#
|
3570
|
+
#
|
3571
|
+
# [1]: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/
|
3572
|
+
# @return [Types::EksContainerSecurityContext]
|
3573
|
+
#
|
3574
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/EksContainerDetail AWS API Documentation
|
3575
|
+
#
|
3576
|
+
class EksContainerDetail < Struct.new(
|
3577
|
+
:name,
|
3578
|
+
:image,
|
3579
|
+
:image_pull_policy,
|
3580
|
+
:command,
|
3581
|
+
:args,
|
3582
|
+
:env,
|
3583
|
+
:resources,
|
3584
|
+
:exit_code,
|
3585
|
+
:reason,
|
3586
|
+
:volume_mounts,
|
3587
|
+
:security_context)
|
3588
|
+
SENSITIVE = []
|
3589
|
+
include Aws::Structure
|
3590
|
+
end
|
3591
|
+
|
3592
|
+
# An environment variable.
|
3593
|
+
#
|
3594
|
+
# @note When making an API call, you may pass EksContainerEnvironmentVariable
|
3595
|
+
# data as a hash:
|
3596
|
+
#
|
3597
|
+
# {
|
3598
|
+
# name: "String", # required
|
3599
|
+
# value: "String",
|
3600
|
+
# }
|
3601
|
+
#
|
3602
|
+
# @!attribute [rw] name
|
3603
|
+
# The name of the environment variable.
|
3604
|
+
# @return [String]
|
3605
|
+
#
|
3606
|
+
# @!attribute [rw] value
|
3607
|
+
# The value of the environment variable.
|
3608
|
+
# @return [String]
|
3609
|
+
#
|
3610
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/EksContainerEnvironmentVariable AWS API Documentation
|
3611
|
+
#
|
3612
|
+
class EksContainerEnvironmentVariable < Struct.new(
|
3613
|
+
:name,
|
3614
|
+
:value)
|
3615
|
+
SENSITIVE = []
|
3616
|
+
include Aws::Structure
|
3617
|
+
end
|
3618
|
+
|
3619
|
+
# Object representing any Kubernetes overrides to a job definition
|
3620
|
+
# that's used in a SubmitJob API operation.
|
3621
|
+
#
|
3622
|
+
# @note When making an API call, you may pass EksContainerOverride
|
3623
|
+
# data as a hash:
|
3624
|
+
#
|
3625
|
+
# {
|
3626
|
+
# image: "String",
|
3627
|
+
# command: ["String"],
|
3628
|
+
# args: ["String"],
|
3629
|
+
# env: [
|
3630
|
+
# {
|
3631
|
+
# name: "String", # required
|
3632
|
+
# value: "String",
|
3633
|
+
# },
|
3634
|
+
# ],
|
3635
|
+
# resources: {
|
3636
|
+
# limits: {
|
3637
|
+
# "String" => "Quantity",
|
3638
|
+
# },
|
3639
|
+
# requests: {
|
3640
|
+
# "String" => "Quantity",
|
3641
|
+
# },
|
3642
|
+
# },
|
3643
|
+
# }
|
3644
|
+
#
|
3645
|
+
# @!attribute [rw] image
|
3646
|
+
# The override of the Docker image that's used to start the
|
3647
|
+
# container.
|
3648
|
+
# @return [String]
|
3649
|
+
#
|
3650
|
+
# @!attribute [rw] command
|
3651
|
+
# The command to send to the container that overrides the default
|
3652
|
+
# command from the Docker image or the job definition.
|
3653
|
+
# @return [Array<String>]
|
3654
|
+
#
|
3655
|
+
# @!attribute [rw] args
|
3656
|
+
# The arguments to the entrypoint to send to the container that
|
3657
|
+
# overrides the default arguments from the Docker image or the job
|
3658
|
+
# definition. For more information, see [CMD][1] in the *Dockerfile
|
3659
|
+
# reference* and [Define a command an arguments for a pod][2] in the
|
3660
|
+
# *Kubernetes documentation*.
|
3661
|
+
#
|
3662
|
+
#
|
3663
|
+
#
|
3664
|
+
# [1]: https://docs.docker.com/engine/reference/builder/#cmd
|
3665
|
+
# [2]: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/
|
3666
|
+
# @return [Array<String>]
|
3667
|
+
#
|
3668
|
+
# @!attribute [rw] env
|
3669
|
+
# The environment variables to send to the container. You can add new
|
3670
|
+
# environment variables, which are added to the container at launch.
|
3671
|
+
# Or, you can override the existing environment variables from the
|
3672
|
+
# Docker image or the job definition.
|
3673
|
+
#
|
3674
|
+
# <note markdown="1"> Environment variables cannot start with "`AWS_BATCH`". This naming
|
3675
|
+
# convention is reserved for variables that Batch sets.
|
3676
|
+
#
|
3677
|
+
# </note>
|
3678
|
+
# @return [Array<Types::EksContainerEnvironmentVariable>]
|
3679
|
+
#
|
3680
|
+
# @!attribute [rw] resources
|
3681
|
+
# The type and amount of resources to assign to a container. These
|
3682
|
+
# override the settings in the job definition. The supported resources
|
3683
|
+
# include `memory`, `cpu`, and `nvidia.com/gpu`. For more information,
|
3684
|
+
# see [Resource management for pods and containers][1] in the
|
3685
|
+
# *Kubernetes documentation*.
|
3686
|
+
#
|
3687
|
+
#
|
3688
|
+
#
|
3689
|
+
# [1]: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
|
3690
|
+
# @return [Types::EksContainerResourceRequirements]
|
3691
|
+
#
|
3692
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/EksContainerOverride AWS API Documentation
|
3693
|
+
#
|
3694
|
+
class EksContainerOverride < Struct.new(
|
3695
|
+
:image,
|
3696
|
+
:command,
|
3697
|
+
:args,
|
3698
|
+
:env,
|
3699
|
+
:resources)
|
3700
|
+
SENSITIVE = []
|
3701
|
+
include Aws::Structure
|
3702
|
+
end
|
3703
|
+
|
3704
|
+
# The type and amount of resources to assign to a container. The
|
3705
|
+
# supported resources include `memory`, `cpu`, and `nvidia.com/gpu`. For
|
3706
|
+
# more information, see [Resource management for pods and containers][1]
|
3707
|
+
# in the *Kubernetes documentation*.
|
3708
|
+
#
|
3709
|
+
#
|
3710
|
+
#
|
3711
|
+
# [1]: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
|
3712
|
+
#
|
3713
|
+
# @note When making an API call, you may pass EksContainerResourceRequirements
|
3714
|
+
# data as a hash:
|
3715
|
+
#
|
3716
|
+
# {
|
3717
|
+
# limits: {
|
3718
|
+
# "String" => "Quantity",
|
3719
|
+
# },
|
3720
|
+
# requests: {
|
3721
|
+
# "String" => "Quantity",
|
3722
|
+
# },
|
3723
|
+
# }
|
3724
|
+
#
|
3725
|
+
# @!attribute [rw] limits
|
3726
|
+
# The type and quantity of the resources to reserve for the container.
|
3727
|
+
# The values vary based on the `name` that's specified. Resources can
|
3728
|
+
# be requested using either the `limits` or the `requests` objects.
|
3729
|
+
#
|
3730
|
+
# memory
|
3731
|
+
#
|
3732
|
+
# : The memory hard limit (in MiB) for the container, using whole
|
3733
|
+
# integers, with a "Mi" suffix. If your container attempts to
|
3734
|
+
# exceed the memory specified, the container is terminated. You must
|
3735
|
+
# specify at least 4 MiB of memory for a job. `memory` can be
|
3736
|
+
# specified in `limits`, `requests`, or both. If `memory` is
|
3737
|
+
# specified in both places, then the value that's specified in
|
3738
|
+
# `limits` must be equal to the value that's specified in
|
3739
|
+
# `requests`.
|
3740
|
+
#
|
3741
|
+
# <note markdown="1"> To maximize your resource utilization, provide your jobs with as
|
3742
|
+
# much memory as possible for the specific instance type that you
|
3743
|
+
# are using. To learn how, see [Memory management][1] in the *Batch
|
3744
|
+
# User Guide*.
|
3745
|
+
#
|
3746
|
+
# </note>
|
3747
|
+
#
|
3748
|
+
# cpu
|
3749
|
+
#
|
3750
|
+
# : The number of CPUs that's reserved for the container. Values must
|
3751
|
+
# be an even multiple of `0.25`. `cpu` can be specified in `limits`,
|
3752
|
+
# `requests`, or both. If `cpu` is specified in both places, then
|
3753
|
+
# the value that's specified in `limits` must be at least as large
|
3754
|
+
# as the value that's specified in `requests`.
|
3755
|
+
#
|
3756
|
+
# nvidia.com/gpu
|
3757
|
+
#
|
3758
|
+
# : The number of GPUs that's reserved for the container. Values must
|
3759
|
+
# be a whole integer. `memory` can be specified in `limits`,
|
3760
|
+
# `requests`, or both. If `memory` is specified in both places, then
|
3761
|
+
# the value that's specified in `limits` must be equal to the value
|
3762
|
+
# that's specified in `requests`.
|
3763
|
+
#
|
3764
|
+
#
|
3765
|
+
#
|
3766
|
+
# [1]: https://docs.aws.amazon.com/batch/latest/userguide/memory-management.html
|
3767
|
+
# @return [Hash<String,String>]
|
3768
|
+
#
|
3769
|
+
# @!attribute [rw] requests
|
3770
|
+
# The type and quantity of the resources to request for the container.
|
3771
|
+
# The values vary based on the `name` that's specified. Resources can
|
3772
|
+
# be requested by using either the `limits` or the `requests` objects.
|
3773
|
+
#
|
3774
|
+
# memory
|
3775
|
+
#
|
3776
|
+
# : The memory hard limit (in MiB) for the container, using whole
|
3777
|
+
# integers, with a "Mi" suffix. If your container attempts to
|
3778
|
+
# exceed the memory specified, the container is terminated. You must
|
3779
|
+
# specify at least 4 MiB of memory for a job. `memory` can be
|
3780
|
+
# specified in `limits`, `requests`, or both. If `memory` is
|
3781
|
+
# specified in both, then the value that's specified in `limits`
|
3782
|
+
# must be equal to the value that's specified in `requests`.
|
3783
|
+
#
|
3784
|
+
# <note markdown="1"> If you're trying to maximize your resource utilization by
|
3785
|
+
# providing your jobs as much memory as possible for a particular
|
3786
|
+
# instance type, see [Memory management][1] in the *Batch User
|
3787
|
+
# Guide*.
|
3788
|
+
#
|
3789
|
+
# </note>
|
3790
|
+
#
|
3791
|
+
# cpu
|
3792
|
+
#
|
3793
|
+
# : The number of CPUs that are reserved for the container. Values
|
3794
|
+
# must be an even multiple of `0.25`. `cpu` can be specified in
|
3795
|
+
# `limits`, `requests`, or both. If `cpu` is specified in both, then
|
3796
|
+
# the value that's specified in `limits` must be at least as large
|
3797
|
+
# as the value that's specified in `requests`.
|
3798
|
+
#
|
3799
|
+
# nvidia.com/gpu
|
3800
|
+
#
|
3801
|
+
# : The number of GPUs that are reserved for the container. Values
|
3802
|
+
# must be a whole integer. `nvidia.com/gpu` can be specified in
|
3803
|
+
# `limits`, `requests`, or both. If `nvidia.com/gpu` is specified in
|
3804
|
+
# both, then the value that's specified in `limits` must be equal
|
3805
|
+
# to the value that's specified in `requests`.
|
3806
|
+
#
|
3807
|
+
#
|
3808
|
+
#
|
3809
|
+
# [1]: https://docs.aws.amazon.com/batch/latest/userguide/memory-management.html
|
3810
|
+
# @return [Hash<String,String>]
|
3811
|
+
#
|
3812
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/EksContainerResourceRequirements AWS API Documentation
|
3813
|
+
#
|
3814
|
+
class EksContainerResourceRequirements < Struct.new(
|
3815
|
+
:limits,
|
3816
|
+
:requests)
|
3817
|
+
SENSITIVE = []
|
3818
|
+
include Aws::Structure
|
3819
|
+
end
|
3820
|
+
|
3821
|
+
# The security context for a job. For more information, see [Configure a
|
3822
|
+
# security context for a pod or container][1] in the *Kubernetes
|
3823
|
+
# documentation*.
|
3824
|
+
#
|
3825
|
+
#
|
3826
|
+
#
|
3827
|
+
# [1]: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/
|
3828
|
+
#
|
3829
|
+
# @note When making an API call, you may pass EksContainerSecurityContext
|
3830
|
+
# data as a hash:
|
3831
|
+
#
|
3832
|
+
# {
|
3833
|
+
# run_as_user: 1,
|
3834
|
+
# run_as_group: 1,
|
3835
|
+
# privileged: false,
|
3836
|
+
# read_only_root_filesystem: false,
|
3837
|
+
# run_as_non_root: false,
|
3838
|
+
# }
|
3839
|
+
#
|
3840
|
+
# @!attribute [rw] run_as_user
|
3841
|
+
# When this parameter is specified, the container is run as the
|
3842
|
+
# specified user ID (`uid`). If this parameter isn't specified, the
|
3843
|
+
# default is the user that's specified in the image metadata. This
|
3844
|
+
# parameter maps to `RunAsUser` and `MustRanAs` policy in the [Users
|
3845
|
+
# and groups pod security policies][1] in the *Kubernetes
|
3846
|
+
# documentation*.
|
3847
|
+
#
|
3848
|
+
#
|
3849
|
+
#
|
3850
|
+
# [1]: https://kubernetes.io/docs/concepts/security/pod-security-policy/#users-and-groups
|
3851
|
+
# @return [Integer]
|
3852
|
+
#
|
3853
|
+
# @!attribute [rw] run_as_group
|
3854
|
+
# When this parameter is specified, the container is run as the
|
3855
|
+
# specified group ID (`gid`). If this parameter isn't specified, the
|
3856
|
+
# default is the group that's specified in the image metadata. This
|
3857
|
+
# parameter maps to `RunAsGroup` and `MustRunAs` policy in the [Users
|
3858
|
+
# and groups pod security policies][1] in the *Kubernetes
|
3859
|
+
# documentation*.
|
3860
|
+
#
|
3861
|
+
#
|
3862
|
+
#
|
3863
|
+
# [1]: https://kubernetes.io/docs/concepts/security/pod-security-policy/#users-and-groups
|
3864
|
+
# @return [Integer]
|
3865
|
+
#
|
3866
|
+
# @!attribute [rw] privileged
|
3867
|
+
# When this parameter is `true`, the container is given elevated
|
3868
|
+
# permissions on the host container instance. The level of permissions
|
3869
|
+
# are similar to the `root` user permissions. The default value is
|
3870
|
+
# `false`. This parameter maps to `privileged` policy in the
|
3871
|
+
# [Privileged pod security policies][1] in the *Kubernetes
|
3872
|
+
# documentation*.
|
3873
|
+
#
|
3874
|
+
#
|
3875
|
+
#
|
3876
|
+
# [1]: https://kubernetes.io/docs/concepts/security/pod-security-policy/#privileged
|
3877
|
+
# @return [Boolean]
|
3878
|
+
#
|
3879
|
+
# @!attribute [rw] read_only_root_filesystem
|
3880
|
+
# When this parameter is `true`, the container is given read-only
|
3881
|
+
# access to its root file system. The default value is `false`. This
|
3882
|
+
# parameter maps to `ReadOnlyRootFilesystem` policy in the [Volumes
|
3883
|
+
# and file systems pod security policies][1] in the *Kubernetes
|
3884
|
+
# documentation*.
|
3885
|
+
#
|
3886
|
+
#
|
3887
|
+
#
|
3888
|
+
# [1]: https://kubernetes.io/docs/concepts/security/pod-security-policy/#volumes-and-file-systems
|
3889
|
+
# @return [Boolean]
|
3890
|
+
#
|
3891
|
+
# @!attribute [rw] run_as_non_root
|
3892
|
+
# When this parameter is specified, the container is run as a user
|
3893
|
+
# with a `uid` other than 0. If this parameter isn't specified, so
|
3894
|
+
# such rule is enforced. This parameter maps to `RunAsUser` and
|
3895
|
+
# `MustRunAsNonRoot` policy in the [Users and groups pod security
|
3896
|
+
# policies][1] in the *Kubernetes documentation*.
|
3897
|
+
#
|
3898
|
+
#
|
3899
|
+
#
|
3900
|
+
# [1]: https://kubernetes.io/docs/concepts/security/pod-security-policy/#users-and-groups
|
3901
|
+
# @return [Boolean]
|
3902
|
+
#
|
3903
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/EksContainerSecurityContext AWS API Documentation
|
3904
|
+
#
|
3905
|
+
class EksContainerSecurityContext < Struct.new(
|
3906
|
+
:run_as_user,
|
3907
|
+
:run_as_group,
|
3908
|
+
:privileged,
|
3909
|
+
:read_only_root_filesystem,
|
3910
|
+
:run_as_non_root)
|
3911
|
+
SENSITIVE = []
|
3912
|
+
include Aws::Structure
|
3913
|
+
end
|
3914
|
+
|
3915
|
+
# The volume mounts for a container for an Amazon EKS job. For more
|
3916
|
+
# information about volumes and volume mounts in Kubernetes, see
|
3917
|
+
# [Volumes][1] in the *Kubernetes documentation*.
|
3918
|
+
#
|
3919
|
+
#
|
3920
|
+
#
|
3921
|
+
# [1]: https://kubernetes.io/docs/concepts/storage/volumes/
|
3922
|
+
#
|
3923
|
+
# @note When making an API call, you may pass EksContainerVolumeMount
|
3924
|
+
# data as a hash:
|
3925
|
+
#
|
3926
|
+
# {
|
3927
|
+
# name: "String",
|
3928
|
+
# mount_path: "String",
|
3929
|
+
# read_only: false,
|
3930
|
+
# }
|
3931
|
+
#
|
3932
|
+
# @!attribute [rw] name
|
3933
|
+
# The name the volume mount. This must match the name of one of the
|
3934
|
+
# volumes in the pod.
|
3935
|
+
# @return [String]
|
3936
|
+
#
|
3937
|
+
# @!attribute [rw] mount_path
|
3938
|
+
# The path on the container where the volume is mounted.
|
3939
|
+
# @return [String]
|
3940
|
+
#
|
3941
|
+
# @!attribute [rw] read_only
|
3942
|
+
# If this value is `true`, the container has read-only access to the
|
3943
|
+
# volume. Otherwise, the container can write to the volume. The
|
3944
|
+
# default value is `false`.
|
3945
|
+
# @return [Boolean]
|
3946
|
+
#
|
3947
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/EksContainerVolumeMount AWS API Documentation
|
3948
|
+
#
|
3949
|
+
class EksContainerVolumeMount < Struct.new(
|
3950
|
+
:name,
|
3951
|
+
:mount_path,
|
3952
|
+
:read_only)
|
3953
|
+
SENSITIVE = []
|
3954
|
+
include Aws::Structure
|
3955
|
+
end
|
3956
|
+
|
3957
|
+
# Specifies the configuration of a Kubernetes `emptyDir` volume. An
|
3958
|
+
# `emptyDir` volume is first created when a pod is assigned to a node.
|
3959
|
+
# It exists as long as that pod is running on that node. The `emptyDir`
|
3960
|
+
# volume is initially empty. All containers in the pod can read and
|
3961
|
+
# write the files in the `emptyDir` volume. However, the `emptyDir`
|
3962
|
+
# volume can be mounted at the same or different paths in each
|
3963
|
+
# container. When a pod is removed from a node for any reason, the data
|
3964
|
+
# in the `emptyDir` is deleted permanently. For more information, see
|
3965
|
+
# [emptyDir][1] in the *Kubernetes documentation*.
|
3966
|
+
#
|
3967
|
+
#
|
3968
|
+
#
|
3969
|
+
# [1]: https://kubernetes.io/docs/concepts/storage/volumes/#emptydir
|
3970
|
+
#
|
3971
|
+
# @note When making an API call, you may pass EksEmptyDir
|
3972
|
+
# data as a hash:
|
3973
|
+
#
|
3974
|
+
# {
|
3975
|
+
# medium: "String",
|
3976
|
+
# size_limit: "Quantity",
|
3977
|
+
# }
|
3978
|
+
#
|
3979
|
+
# @!attribute [rw] medium
|
3980
|
+
# The medium to store the volume. The default value is an empty
|
3981
|
+
# string, which uses the storage of the node.
|
3982
|
+
#
|
3983
|
+
# ""
|
3984
|
+
#
|
3985
|
+
# : **(Default)** Use the disk storage of the node.
|
3986
|
+
#
|
3987
|
+
# "Memory"
|
3988
|
+
#
|
3989
|
+
# : Use the `tmpfs` volume that's backed by the RAM of the node.
|
3990
|
+
# Contents of the volume are lost when the node reboots, and any
|
3991
|
+
# storage on the volume counts against the container's memory
|
3992
|
+
# limit.
|
3993
|
+
# @return [String]
|
3994
|
+
#
|
3995
|
+
# @!attribute [rw] size_limit
|
3996
|
+
# The maximum size of the volume. By default, there's no maximum size
|
3997
|
+
# defined.
|
3998
|
+
# @return [String]
|
3999
|
+
#
|
4000
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/EksEmptyDir AWS API Documentation
|
4001
|
+
#
|
4002
|
+
class EksEmptyDir < Struct.new(
|
4003
|
+
:medium,
|
4004
|
+
:size_limit)
|
4005
|
+
SENSITIVE = []
|
4006
|
+
include Aws::Structure
|
4007
|
+
end
|
4008
|
+
|
4009
|
+
# Specifies the configuration of a Kubernetes `hostPath` volume. A
|
4010
|
+
# `hostPath` volume mounts an existing file or directory from the host
|
4011
|
+
# node's filesystem into your pod. For more information, see
|
4012
|
+
# [hostPath][1] in the *Kubernetes documentation*.
|
4013
|
+
#
|
4014
|
+
#
|
4015
|
+
#
|
4016
|
+
# [1]: https://kubernetes.io/docs/concepts/storage/volumes/#hostpath
|
4017
|
+
#
|
4018
|
+
# @note When making an API call, you may pass EksHostPath
|
4019
|
+
# data as a hash:
|
4020
|
+
#
|
4021
|
+
# {
|
4022
|
+
# path: "String",
|
4023
|
+
# }
|
4024
|
+
#
|
4025
|
+
# @!attribute [rw] path
|
4026
|
+
# The path of the file or directory on the host to mount into
|
4027
|
+
# containers on the pod.
|
4028
|
+
# @return [String]
|
4029
|
+
#
|
4030
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/EksHostPath AWS API Documentation
|
4031
|
+
#
|
4032
|
+
class EksHostPath < Struct.new(
|
4033
|
+
:path)
|
4034
|
+
SENSITIVE = []
|
4035
|
+
include Aws::Structure
|
4036
|
+
end
|
4037
|
+
|
4038
|
+
# The properties for the pod.
|
4039
|
+
#
|
4040
|
+
# @note When making an API call, you may pass EksPodProperties
|
4041
|
+
# data as a hash:
|
4042
|
+
#
|
4043
|
+
# {
|
4044
|
+
# service_account_name: "String",
|
4045
|
+
# host_network: false,
|
4046
|
+
# dns_policy: "String",
|
4047
|
+
# containers: [
|
4048
|
+
# {
|
4049
|
+
# name: "String",
|
4050
|
+
# image: "String", # required
|
4051
|
+
# image_pull_policy: "String",
|
4052
|
+
# command: ["String"],
|
4053
|
+
# args: ["String"],
|
4054
|
+
# env: [
|
4055
|
+
# {
|
4056
|
+
# name: "String", # required
|
4057
|
+
# value: "String",
|
4058
|
+
# },
|
4059
|
+
# ],
|
4060
|
+
# resources: {
|
4061
|
+
# limits: {
|
4062
|
+
# "String" => "Quantity",
|
4063
|
+
# },
|
4064
|
+
# requests: {
|
4065
|
+
# "String" => "Quantity",
|
4066
|
+
# },
|
4067
|
+
# },
|
4068
|
+
# volume_mounts: [
|
4069
|
+
# {
|
4070
|
+
# name: "String",
|
4071
|
+
# mount_path: "String",
|
4072
|
+
# read_only: false,
|
4073
|
+
# },
|
4074
|
+
# ],
|
4075
|
+
# security_context: {
|
4076
|
+
# run_as_user: 1,
|
4077
|
+
# run_as_group: 1,
|
4078
|
+
# privileged: false,
|
4079
|
+
# read_only_root_filesystem: false,
|
4080
|
+
# run_as_non_root: false,
|
4081
|
+
# },
|
4082
|
+
# },
|
4083
|
+
# ],
|
4084
|
+
# volumes: [
|
4085
|
+
# {
|
4086
|
+
# name: "String", # required
|
4087
|
+
# host_path: {
|
4088
|
+
# path: "String",
|
4089
|
+
# },
|
4090
|
+
# empty_dir: {
|
4091
|
+
# medium: "String",
|
4092
|
+
# size_limit: "Quantity",
|
4093
|
+
# },
|
4094
|
+
# secret: {
|
4095
|
+
# secret_name: "String", # required
|
4096
|
+
# optional: false,
|
4097
|
+
# },
|
4098
|
+
# },
|
4099
|
+
# ],
|
4100
|
+
# }
|
4101
|
+
#
|
4102
|
+
# @!attribute [rw] service_account_name
|
4103
|
+
# The name of the service account that's used to run the pod. For
|
4104
|
+
# more information, see [Kubernetes service accounts][1] and
|
4105
|
+
# [Configure a Kubernetes service account to assume an IAM role][2] in
|
4106
|
+
# the *Amazon EKS User Guide* and [Configure service accounts for
|
4107
|
+
# pods][3] in the *Kubernetes documentation*.
|
4108
|
+
#
|
4109
|
+
#
|
4110
|
+
#
|
4111
|
+
# [1]: https://docs.aws.amazon.com/eks/latest/userguide/service-accounts.html
|
4112
|
+
# [2]: https://docs.aws.amazon.com/eks/latest/userguide/associate-service-account-role.html
|
4113
|
+
# [3]: https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/
|
4114
|
+
# @return [String]
|
4115
|
+
#
|
4116
|
+
# @!attribute [rw] host_network
|
4117
|
+
# Indicates if the pod uses the hosts' network IP address. The
|
4118
|
+
# default value is `true`. Setting this to `false` enables the
|
4119
|
+
# Kubernetes pod networking model. Most Batch workloads are
|
4120
|
+
# egress-only and don't require the overhead of IP allocation for
|
4121
|
+
# each pod for incoming connections. For more information, see [Host
|
4122
|
+
# namespaces][1] and [Pod networking][2] in the *Kubernetes
|
4123
|
+
# documentation*.
|
4124
|
+
#
|
4125
|
+
#
|
4126
|
+
#
|
4127
|
+
# [1]: https://kubernetes.io/docs/concepts/security/pod-security-policy/#host-namespaces
|
4128
|
+
# [2]: https://kubernetes.io/docs/concepts/workloads/pods/#pod-networking
|
4129
|
+
# @return [Boolean]
|
4130
|
+
#
|
4131
|
+
# @!attribute [rw] dns_policy
|
4132
|
+
# The DNS policy for the pod. The default value is `ClusterFirst`. If
|
4133
|
+
# the `hostNetwork` parameter is not specified, the default is
|
4134
|
+
# `ClusterFirstWithHostNet`. `ClusterFirst` indicates that any DNS
|
4135
|
+
# query that does not match the configured cluster domain suffix is
|
4136
|
+
# forwarded to the upstream nameserver inherited from the node. For
|
4137
|
+
# more information, see [Pod's DNS policy][1] in the *Kubernetes
|
4138
|
+
# documentation*.
|
4139
|
+
#
|
4140
|
+
# Valid values: `Default` \| `ClusterFirst` \|
|
4141
|
+
# `ClusterFirstWithHostNet` \| `None`
|
4142
|
+
#
|
4143
|
+
#
|
4144
|
+
#
|
4145
|
+
# [1]: https://kubernetes.io/docs/concepts/services-networking/dns-pod-service/#pod-s-dns-policy
|
4146
|
+
# @return [String]
|
4147
|
+
#
|
4148
|
+
# @!attribute [rw] containers
|
4149
|
+
# The properties of the container that's used on the Amazon EKS pod.
|
4150
|
+
# @return [Array<Types::EksContainer>]
|
4151
|
+
#
|
4152
|
+
# @!attribute [rw] volumes
|
4153
|
+
# Specifies the volumes for a job definition that uses Amazon EKS
|
4154
|
+
# resources.
|
4155
|
+
# @return [Array<Types::EksVolume>]
|
4156
|
+
#
|
4157
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/EksPodProperties AWS API Documentation
|
4158
|
+
#
|
4159
|
+
class EksPodProperties < Struct.new(
|
4160
|
+
:service_account_name,
|
4161
|
+
:host_network,
|
4162
|
+
:dns_policy,
|
4163
|
+
:containers,
|
4164
|
+
:volumes)
|
4165
|
+
SENSITIVE = []
|
4166
|
+
include Aws::Structure
|
4167
|
+
end
|
4168
|
+
|
4169
|
+
# The details for the pod.
|
4170
|
+
#
|
4171
|
+
# @!attribute [rw] service_account_name
|
4172
|
+
# The name of the service account that's used to run the pod. For
|
4173
|
+
# more information, see [Kubernetes service accounts][1] and
|
4174
|
+
# [Configure a Kubernetes service account to assume an IAM role][2] in
|
4175
|
+
# the *Amazon EKS User Guide* and [Configure service accounts for
|
4176
|
+
# pods][3] in the *Kubernetes documentation*.
|
4177
|
+
#
|
4178
|
+
#
|
4179
|
+
#
|
4180
|
+
# [1]: https://docs.aws.amazon.com/eks/latest/userguide/service-accounts.html
|
4181
|
+
# [2]: https://docs.aws.amazon.com/eks/latest/userguide/associate-service-account-role.html
|
4182
|
+
# [3]: https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/
|
4183
|
+
# @return [String]
|
4184
|
+
#
|
4185
|
+
# @!attribute [rw] host_network
|
4186
|
+
# Indicates if the pod uses the hosts' network IP address. The
|
4187
|
+
# default value is `true`. Setting this to `false` enables the
|
4188
|
+
# Kubernetes pod networking model. Most Batch workloads are
|
4189
|
+
# egress-only and don't require the overhead of IP allocation for
|
4190
|
+
# each pod for incoming connections. For more information, see [Host
|
4191
|
+
# namespaces][1] and [Pod networking][2] in the *Kubernetes
|
4192
|
+
# documentation*.
|
4193
|
+
#
|
4194
|
+
#
|
4195
|
+
#
|
4196
|
+
# [1]: https://kubernetes.io/docs/concepts/security/pod-security-policy/#host-namespaces
|
4197
|
+
# [2]: https://kubernetes.io/docs/concepts/workloads/pods/#pod-networking
|
4198
|
+
# @return [Boolean]
|
4199
|
+
#
|
4200
|
+
# @!attribute [rw] dns_policy
|
4201
|
+
# The DNS policy for the pod. The default value is `ClusterFirst`. If
|
4202
|
+
# the `hostNetwork` parameter is not specified, the default is
|
4203
|
+
# `ClusterFirstWithHostNet`. `ClusterFirst` indicates that any DNS
|
4204
|
+
# query that does not match the configured cluster domain suffix is
|
4205
|
+
# forwarded to the upstream nameserver inherited from the node. For
|
4206
|
+
# more information, see [Pod's DNS policy][1] in the *Kubernetes
|
4207
|
+
# documentation*.
|
4208
|
+
#
|
4209
|
+
# Valid values: `Default` \| `ClusterFirst` \|
|
4210
|
+
# `ClusterFirstWithHostNet` \| `None`
|
4211
|
+
#
|
4212
|
+
#
|
4213
|
+
#
|
4214
|
+
# [1]: https://kubernetes.io/docs/concepts/services-networking/dns-pod-service/#pod-s-dns-policy
|
4215
|
+
# @return [String]
|
4216
|
+
#
|
4217
|
+
# @!attribute [rw] containers
|
4218
|
+
# The properties of the container that's used on the Amazon EKS pod.
|
4219
|
+
# @return [Array<Types::EksContainerDetail>]
|
4220
|
+
#
|
4221
|
+
# @!attribute [rw] volumes
|
4222
|
+
# Specifies the volumes for a job definition using Amazon EKS
|
4223
|
+
# resources.
|
4224
|
+
# @return [Array<Types::EksVolume>]
|
4225
|
+
#
|
4226
|
+
# @!attribute [rw] pod_name
|
4227
|
+
# The name of the pod for this job.
|
4228
|
+
# @return [String]
|
4229
|
+
#
|
4230
|
+
# @!attribute [rw] node_name
|
4231
|
+
# The name of the node for this job.
|
4232
|
+
# @return [String]
|
4233
|
+
#
|
4234
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/EksPodPropertiesDetail AWS API Documentation
|
4235
|
+
#
|
4236
|
+
class EksPodPropertiesDetail < Struct.new(
|
4237
|
+
:service_account_name,
|
4238
|
+
:host_network,
|
4239
|
+
:dns_policy,
|
4240
|
+
:containers,
|
4241
|
+
:volumes,
|
4242
|
+
:pod_name,
|
4243
|
+
:node_name)
|
4244
|
+
SENSITIVE = []
|
4245
|
+
include Aws::Structure
|
4246
|
+
end
|
4247
|
+
|
4248
|
+
# An object that contains overrides for the Kubernetes pod properties of
|
4249
|
+
# a job.
|
4250
|
+
#
|
4251
|
+
# @note When making an API call, you may pass EksPodPropertiesOverride
|
4252
|
+
# data as a hash:
|
4253
|
+
#
|
4254
|
+
# {
|
4255
|
+
# containers: [
|
4256
|
+
# {
|
4257
|
+
# image: "String",
|
4258
|
+
# command: ["String"],
|
4259
|
+
# args: ["String"],
|
4260
|
+
# env: [
|
4261
|
+
# {
|
4262
|
+
# name: "String", # required
|
4263
|
+
# value: "String",
|
4264
|
+
# },
|
4265
|
+
# ],
|
4266
|
+
# resources: {
|
4267
|
+
# limits: {
|
4268
|
+
# "String" => "Quantity",
|
4269
|
+
# },
|
4270
|
+
# requests: {
|
4271
|
+
# "String" => "Quantity",
|
4272
|
+
# },
|
4273
|
+
# },
|
4274
|
+
# },
|
4275
|
+
# ],
|
4276
|
+
# }
|
4277
|
+
#
|
4278
|
+
# @!attribute [rw] containers
|
4279
|
+
# The overrides for the container that's used on the Amazon EKS pod.
|
4280
|
+
# @return [Array<Types::EksContainerOverride>]
|
4281
|
+
#
|
4282
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/EksPodPropertiesOverride AWS API Documentation
|
4283
|
+
#
|
4284
|
+
class EksPodPropertiesOverride < Struct.new(
|
4285
|
+
:containers)
|
4286
|
+
SENSITIVE = []
|
4287
|
+
include Aws::Structure
|
4288
|
+
end
|
4289
|
+
|
4290
|
+
# An object that contains the properties for the Kubernetes resources of
|
4291
|
+
# a job.
|
4292
|
+
#
|
4293
|
+
# @note When making an API call, you may pass EksProperties
|
4294
|
+
# data as a hash:
|
4295
|
+
#
|
4296
|
+
# {
|
4297
|
+
# pod_properties: {
|
4298
|
+
# service_account_name: "String",
|
4299
|
+
# host_network: false,
|
4300
|
+
# dns_policy: "String",
|
4301
|
+
# containers: [
|
4302
|
+
# {
|
4303
|
+
# name: "String",
|
4304
|
+
# image: "String", # required
|
4305
|
+
# image_pull_policy: "String",
|
4306
|
+
# command: ["String"],
|
4307
|
+
# args: ["String"],
|
4308
|
+
# env: [
|
4309
|
+
# {
|
4310
|
+
# name: "String", # required
|
4311
|
+
# value: "String",
|
4312
|
+
# },
|
4313
|
+
# ],
|
4314
|
+
# resources: {
|
4315
|
+
# limits: {
|
4316
|
+
# "String" => "Quantity",
|
4317
|
+
# },
|
4318
|
+
# requests: {
|
4319
|
+
# "String" => "Quantity",
|
4320
|
+
# },
|
4321
|
+
# },
|
4322
|
+
# volume_mounts: [
|
4323
|
+
# {
|
4324
|
+
# name: "String",
|
4325
|
+
# mount_path: "String",
|
4326
|
+
# read_only: false,
|
4327
|
+
# },
|
4328
|
+
# ],
|
4329
|
+
# security_context: {
|
4330
|
+
# run_as_user: 1,
|
4331
|
+
# run_as_group: 1,
|
4332
|
+
# privileged: false,
|
4333
|
+
# read_only_root_filesystem: false,
|
4334
|
+
# run_as_non_root: false,
|
4335
|
+
# },
|
4336
|
+
# },
|
4337
|
+
# ],
|
4338
|
+
# volumes: [
|
4339
|
+
# {
|
4340
|
+
# name: "String", # required
|
4341
|
+
# host_path: {
|
4342
|
+
# path: "String",
|
4343
|
+
# },
|
4344
|
+
# empty_dir: {
|
4345
|
+
# medium: "String",
|
4346
|
+
# size_limit: "Quantity",
|
4347
|
+
# },
|
4348
|
+
# secret: {
|
4349
|
+
# secret_name: "String", # required
|
4350
|
+
# optional: false,
|
4351
|
+
# },
|
4352
|
+
# },
|
4353
|
+
# ],
|
4354
|
+
# },
|
4355
|
+
# }
|
4356
|
+
#
|
4357
|
+
# @!attribute [rw] pod_properties
|
4358
|
+
# The properties for the Kubernetes pod resources of a job.
|
4359
|
+
# @return [Types::EksPodProperties]
|
4360
|
+
#
|
4361
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/EksProperties AWS API Documentation
|
4362
|
+
#
|
4363
|
+
class EksProperties < Struct.new(
|
4364
|
+
:pod_properties)
|
4365
|
+
SENSITIVE = []
|
4366
|
+
include Aws::Structure
|
4367
|
+
end
|
4368
|
+
|
4369
|
+
# An object that contains the details for the Kubernetes resources of a
|
4370
|
+
# job.
|
4371
|
+
#
|
4372
|
+
# @!attribute [rw] pod_properties
|
4373
|
+
# The properties for the Kubernetes pod resources of a job.
|
4374
|
+
# @return [Types::EksPodPropertiesDetail]
|
4375
|
+
#
|
4376
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/EksPropertiesDetail AWS API Documentation
|
4377
|
+
#
|
4378
|
+
class EksPropertiesDetail < Struct.new(
|
4379
|
+
:pod_properties)
|
4380
|
+
SENSITIVE = []
|
4381
|
+
include Aws::Structure
|
4382
|
+
end
|
4383
|
+
|
4384
|
+
# An object that contains overrides for the Kubernetes resources of a
|
4385
|
+
# job.
|
4386
|
+
#
|
4387
|
+
# @note When making an API call, you may pass EksPropertiesOverride
|
4388
|
+
# data as a hash:
|
4389
|
+
#
|
4390
|
+
# {
|
4391
|
+
# pod_properties: {
|
4392
|
+
# containers: [
|
4393
|
+
# {
|
4394
|
+
# image: "String",
|
4395
|
+
# command: ["String"],
|
4396
|
+
# args: ["String"],
|
4397
|
+
# env: [
|
4398
|
+
# {
|
4399
|
+
# name: "String", # required
|
4400
|
+
# value: "String",
|
4401
|
+
# },
|
4402
|
+
# ],
|
4403
|
+
# resources: {
|
4404
|
+
# limits: {
|
4405
|
+
# "String" => "Quantity",
|
4406
|
+
# },
|
4407
|
+
# requests: {
|
4408
|
+
# "String" => "Quantity",
|
4409
|
+
# },
|
4410
|
+
# },
|
4411
|
+
# },
|
4412
|
+
# ],
|
4413
|
+
# },
|
4414
|
+
# }
|
4415
|
+
#
|
4416
|
+
# @!attribute [rw] pod_properties
|
4417
|
+
# The overrides for the Kubernetes pod resources of a job.
|
4418
|
+
# @return [Types::EksPodPropertiesOverride]
|
4419
|
+
#
|
4420
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/EksPropertiesOverride AWS API Documentation
|
4421
|
+
#
|
4422
|
+
class EksPropertiesOverride < Struct.new(
|
4423
|
+
:pod_properties)
|
4424
|
+
SENSITIVE = []
|
4425
|
+
include Aws::Structure
|
4426
|
+
end
|
4427
|
+
|
4428
|
+
# Specifies the configuration of a Kubernetes `secret` volume. For more
|
4429
|
+
# information, see [secret][1] in the *Kubernetes documentation*.
|
4430
|
+
#
|
4431
|
+
#
|
4432
|
+
#
|
4433
|
+
# [1]: https://kubernetes.io/docs/concepts/storage/volumes/#secret
|
4434
|
+
#
|
4435
|
+
# @note When making an API call, you may pass EksSecret
|
4436
|
+
# data as a hash:
|
4437
|
+
#
|
4438
|
+
# {
|
4439
|
+
# secret_name: "String", # required
|
4440
|
+
# optional: false,
|
4441
|
+
# }
|
4442
|
+
#
|
4443
|
+
# @!attribute [rw] secret_name
|
4444
|
+
# The name of the secret. The name must be allowed as a DNS subdomain
|
4445
|
+
# name. For more information, see [DNS subdomain names][1] in the
|
4446
|
+
# *Kubernetes documentation*.
|
4447
|
+
#
|
4448
|
+
#
|
4449
|
+
#
|
4450
|
+
# [1]: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#dns-subdomain-names
|
4451
|
+
# @return [String]
|
4452
|
+
#
|
4453
|
+
# @!attribute [rw] optional
|
4454
|
+
# Specifies whether the secret or the secret's keys must be defined.
|
4455
|
+
# @return [Boolean]
|
4456
|
+
#
|
4457
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/EksSecret AWS API Documentation
|
4458
|
+
#
|
4459
|
+
class EksSecret < Struct.new(
|
4460
|
+
:secret_name,
|
4461
|
+
:optional)
|
4462
|
+
SENSITIVE = []
|
4463
|
+
include Aws::Structure
|
4464
|
+
end
|
4465
|
+
|
4466
|
+
# Specifies an Amazon EKS volume for a job definition.
|
4467
|
+
#
|
4468
|
+
# @note When making an API call, you may pass EksVolume
|
4469
|
+
# data as a hash:
|
4470
|
+
#
|
4471
|
+
# {
|
4472
|
+
# name: "String", # required
|
4473
|
+
# host_path: {
|
4474
|
+
# path: "String",
|
4475
|
+
# },
|
4476
|
+
# empty_dir: {
|
4477
|
+
# medium: "String",
|
4478
|
+
# size_limit: "Quantity",
|
4479
|
+
# },
|
4480
|
+
# secret: {
|
4481
|
+
# secret_name: "String", # required
|
4482
|
+
# optional: false,
|
4483
|
+
# },
|
4484
|
+
# }
|
4485
|
+
#
|
4486
|
+
# @!attribute [rw] name
|
4487
|
+
# The name of the volume. The name must be allowed as a DNS subdomain
|
4488
|
+
# name. For more information, see [DNS subdomain names][1] in the
|
4489
|
+
# *Kubernetes documentation*.
|
4490
|
+
#
|
4491
|
+
#
|
4492
|
+
#
|
4493
|
+
# [1]: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#dns-subdomain-names
|
4494
|
+
# @return [String]
|
4495
|
+
#
|
4496
|
+
# @!attribute [rw] host_path
|
4497
|
+
# Specifies the configuration of a Kubernetes `hostPath` volume. For
|
4498
|
+
# more information, see [hostPath][1] in the *Kubernetes
|
4499
|
+
# documentation*.
|
4500
|
+
#
|
4501
|
+
#
|
4502
|
+
#
|
4503
|
+
# [1]: https://kubernetes.io/docs/concepts/storage/volumes/#hostpath
|
4504
|
+
# @return [Types::EksHostPath]
|
4505
|
+
#
|
4506
|
+
# @!attribute [rw] empty_dir
|
4507
|
+
# Specifies the configuration of a Kubernetes `emptyDir` volume. For
|
4508
|
+
# more information, see [emptyDir][1] in the *Kubernetes
|
4509
|
+
# documentation*.
|
4510
|
+
#
|
4511
|
+
#
|
4512
|
+
#
|
4513
|
+
# [1]: https://kubernetes.io/docs/concepts/storage/volumes/#emptydir
|
4514
|
+
# @return [Types::EksEmptyDir]
|
4515
|
+
#
|
4516
|
+
# @!attribute [rw] secret
|
4517
|
+
# Specifies the configuration of a Kubernetes `secret` volume. For
|
4518
|
+
# more information, see [secret][1] in the *Kubernetes documentation*.
|
4519
|
+
#
|
4520
|
+
#
|
4521
|
+
#
|
4522
|
+
# [1]: https://kubernetes.io/docs/concepts/storage/volumes/#secret
|
4523
|
+
# @return [Types::EksSecret]
|
4524
|
+
#
|
4525
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/EksVolume AWS API Documentation
|
4526
|
+
#
|
4527
|
+
class EksVolume < Struct.new(
|
4528
|
+
:name,
|
4529
|
+
:host_path,
|
4530
|
+
:empty_dir,
|
4531
|
+
:secret)
|
4532
|
+
SENSITIVE = []
|
4533
|
+
include Aws::Structure
|
4534
|
+
end
|
4535
|
+
|
4536
|
+
# Specifies an array of up to 5 conditions to be met, and an action to
|
4537
|
+
# take (`RETRY` or `EXIT`) if all conditions are met. If none of the
|
4538
|
+
# `EvaluateOnExit` conditions in a `RetryStrategy` match, then the job
|
4539
|
+
# is retried.
|
4540
|
+
#
|
4541
|
+
# @note When making an API call, you may pass EvaluateOnExit
|
4542
|
+
# data as a hash:
|
4543
|
+
#
|
4544
|
+
# {
|
4545
|
+
# on_status_reason: "String",
|
4546
|
+
# on_reason: "String",
|
4547
|
+
# on_exit_code: "String",
|
4548
|
+
# action: "RETRY", # required, accepts RETRY, EXIT
|
4549
|
+
# }
|
4550
|
+
#
|
4551
|
+
# @!attribute [rw] on_status_reason
|
4552
|
+
# Contains a glob pattern to match against the `StatusReason` returned
|
4553
|
+
# for a job. The pattern can contain up to 512 characters. It can
|
4554
|
+
# contain letters, numbers, periods (.), colons (:), and white spaces
|
4555
|
+
# (including spaces or tabs). It can optionally end with an asterisk
|
4556
|
+
# (*) so that only the start of the string needs to be an exact
|
4557
|
+
# match.
|
4558
|
+
# @return [String]
|
4559
|
+
#
|
4560
|
+
# @!attribute [rw] on_reason
|
4561
|
+
# Contains a glob pattern to match against the `Reason` returned for a
|
4562
|
+
# job. The pattern can contain up to 512 characters. It can contain
|
4563
|
+
# letters, numbers, periods (.), colons (:), and white space
|
4564
|
+
# (including spaces and tabs). It can optionally end with an asterisk
|
4565
|
+
# (*) so that only the start of the string needs to be an exact
|
4566
|
+
# match.
|
4567
|
+
# @return [String]
|
4568
|
+
#
|
4569
|
+
# @!attribute [rw] on_exit_code
|
4570
|
+
# Contains a glob pattern to match against the decimal representation
|
4571
|
+
# of the `ExitCode` returned for a job. The pattern can be up to 512
|
4572
|
+
# characters long. It can contain only numbers, and can end with an
|
4573
|
+
# asterisk (*) so that only the start of the string needs to be an
|
4574
|
+
# exact match.
|
4575
|
+
#
|
4576
|
+
# The string can contain up to 512 characters.
|
4577
|
+
# @return [String]
|
4578
|
+
#
|
4579
|
+
# @!attribute [rw] action
|
4580
|
+
# Specifies the action to take if all of the specified conditions
|
4581
|
+
# (`onStatusReason`, `onReason`, and `onExitCode`) are met. The values
|
4582
|
+
# aren't case sensitive.
|
4583
|
+
# @return [String]
|
4584
|
+
#
|
4585
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/EvaluateOnExit AWS API Documentation
|
4586
|
+
#
|
4587
|
+
class EvaluateOnExit < Struct.new(
|
4588
|
+
:on_status_reason,
|
4589
|
+
:on_reason,
|
4590
|
+
:on_exit_code,
|
4591
|
+
:action)
|
4592
|
+
SENSITIVE = []
|
4593
|
+
include Aws::Structure
|
4594
|
+
end
|
4595
|
+
|
4596
|
+
# The fair share policy for a scheduling policy.
|
4597
|
+
#
|
4598
|
+
# @note When making an API call, you may pass FairsharePolicy
|
4599
|
+
# data as a hash:
|
4600
|
+
#
|
4601
|
+
# {
|
4602
|
+
# share_decay_seconds: 1,
|
4603
|
+
# compute_reservation: 1,
|
4604
|
+
# share_distribution: [
|
4605
|
+
# {
|
4606
|
+
# share_identifier: "String", # required
|
4607
|
+
# weight_factor: 1.0,
|
4608
|
+
# },
|
4609
|
+
# ],
|
4610
|
+
# }
|
4611
|
+
#
|
4612
|
+
# @!attribute [rw] share_decay_seconds
|
4613
|
+
# The amount of time (in seconds) to use to calculate a fair share
|
4614
|
+
# percentage for each fair share identifier in use. A value of zero
|
4615
|
+
# (0) indicates that only current usage is measured. The decay allows
|
4616
|
+
# for more recently run jobs to have more weight than jobs that ran
|
4617
|
+
# earlier. The maximum supported value is 604800 (1 week).
|
4618
|
+
# @return [Integer]
|
4619
|
+
#
|
4620
|
+
# @!attribute [rw] compute_reservation
|
4621
|
+
# A value used to reserve some of the available maximum vCPU for fair
|
4622
|
+
# share identifiers that aren't already used.
|
4623
|
+
#
|
4624
|
+
# The reserved ratio is `(computeReservation/100)^ActiveFairShares `
|
4625
|
+
# where ` ActiveFairShares ` is the number of active fair share
|
4626
|
+
# identifiers.
|
4627
|
+
#
|
4628
|
+
# For example, a `computeReservation` value of 50 indicates that
|
4629
|
+
# Batchreserves 50% of the maximum available vCPU if there's only one
|
4630
|
+
# fair share identifier. It reserves 25% if there are two fair share
|
4631
|
+
# identifiers. It reserves 12.5% if there are three fair share
|
4632
|
+
# identifiers. A `computeReservation` value of 25 indicates that Batch
|
4633
|
+
# should reserve 25% of the maximum available vCPU if there's only
|
4634
|
+
# one fair share identifier, 6.25% if there are two fair share
|
4635
|
+
# identifiers, and 1.56% if there are three fair share identifiers.
|
4636
|
+
#
|
4637
|
+
# The minimum value is 0 and the maximum value is 99.
|
4638
|
+
# @return [Integer]
|
4639
|
+
#
|
4640
|
+
# @!attribute [rw] share_distribution
|
4641
|
+
# An array of `SharedIdentifier` objects that contain the weights for
|
4642
|
+
# the fair share identifiers for the fair share policy. Fair share
|
4643
|
+
# identifiers that aren't included have a default weight of `1.0`.
|
4644
|
+
# @return [Array<Types::ShareAttributes>]
|
4645
|
+
#
|
4646
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/FairsharePolicy AWS API Documentation
|
4647
|
+
#
|
4648
|
+
class FairsharePolicy < Struct.new(
|
4649
|
+
:share_decay_seconds,
|
4650
|
+
:compute_reservation,
|
4651
|
+
:share_distribution)
|
4652
|
+
SENSITIVE = []
|
4653
|
+
include Aws::Structure
|
4654
|
+
end
|
4655
|
+
|
4656
|
+
# The platform configuration for jobs that are running on Fargate
|
4657
|
+
# resources. Jobs that run on EC2 resources must not specify this
|
4658
|
+
# parameter.
|
4659
|
+
#
|
4660
|
+
# @note When making an API call, you may pass FargatePlatformConfiguration
|
4661
|
+
# data as a hash:
|
4662
|
+
#
|
4663
|
+
# {
|
4664
|
+
# platform_version: "String",
|
4665
|
+
# }
|
4666
|
+
#
|
4667
|
+
# @!attribute [rw] platform_version
|
4668
|
+
# The Fargate platform version where the jobs are running. A platform
|
4669
|
+
# version is specified only for jobs that are running on Fargate
|
4670
|
+
# resources. If one isn't specified, the `LATEST` platform version is
|
4671
|
+
# used by default. This uses a recent, approved version of the Fargate
|
4672
|
+
# platform for compute resources. For more information, see [Fargate
|
4673
|
+
# platform versions][1] in the *Amazon Elastic Container Service
|
4674
|
+
# Developer Guide*.
|
4675
|
+
#
|
4676
|
+
#
|
4677
|
+
#
|
4678
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html
|
4679
|
+
# @return [String]
|
4680
|
+
#
|
4681
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/FargatePlatformConfiguration AWS API Documentation
|
4682
|
+
#
|
4683
|
+
class FargatePlatformConfiguration < Struct.new(
|
4684
|
+
:platform_version)
|
4685
|
+
SENSITIVE = []
|
4686
|
+
include Aws::Structure
|
4687
|
+
end
|
4688
|
+
|
4689
|
+
# Determine whether your data volume persists on the host container
|
4690
|
+
# instance and where it's stored. If this parameter is empty, then the
|
4691
|
+
# Docker daemon assigns a host path for your data volume. However, the
|
4692
|
+
# data isn't guaranteed to persist after the containers that are
|
4693
|
+
# associated with it stop running.
|
4694
|
+
#
|
4695
|
+
# @note When making an API call, you may pass Host
|
4696
|
+
# data as a hash:
|
4697
|
+
#
|
4698
|
+
# {
|
4699
|
+
# source_path: "String",
|
4700
|
+
# }
|
4701
|
+
#
|
4702
|
+
# @!attribute [rw] source_path
|
4703
|
+
# The path on the host container instance that's presented to the
|
4704
|
+
# container. If this parameter is empty, then the Docker daemon has
|
4705
|
+
# assigned a host path for you. If this parameter contains a file
|
4706
|
+
# location, then the data volume persists at the specified location on
|
4707
|
+
# the host container instance until you delete it manually. If the
|
4708
|
+
# source path location doesn't exist on the host container instance,
|
4709
|
+
# the Docker daemon creates it. If the location does exist, the
|
4710
|
+
# contents of the source path folder are exported.
|
4711
|
+
#
|
4712
|
+
# <note markdown="1"> This parameter isn't applicable to jobs that run on Fargate
|
4713
|
+
# resources. Don't provide this for these jobs.
|
4714
|
+
#
|
4715
|
+
# </note>
|
4716
|
+
# @return [String]
|
4717
|
+
#
|
4718
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/Host AWS API Documentation
|
4719
|
+
#
|
4720
|
+
class Host < Struct.new(
|
4721
|
+
:source_path)
|
4722
|
+
SENSITIVE = []
|
4723
|
+
include Aws::Structure
|
4724
|
+
end
|
4725
|
+
|
4726
|
+
# An object that represents an Batch job definition.
|
4727
|
+
#
|
4728
|
+
# @!attribute [rw] job_definition_name
|
4729
|
+
# The name of the job definition.
|
4730
|
+
# @return [String]
|
4731
|
+
#
|
4732
|
+
# @!attribute [rw] job_definition_arn
|
4733
|
+
# The Amazon Resource Name (ARN) for the job definition.
|
4734
|
+
# @return [String]
|
4735
|
+
#
|
4736
|
+
# @!attribute [rw] revision
|
4737
|
+
# The revision of the job definition.
|
4738
|
+
# @return [Integer]
|
4739
|
+
#
|
4740
|
+
# @!attribute [rw] status
|
4741
|
+
# The status of the job definition.
|
4742
|
+
# @return [String]
|
4743
|
+
#
|
4744
|
+
# @!attribute [rw] type
|
4745
|
+
# The type of job definition. It's either `container` or `multinode`.
|
4746
|
+
# If the job is run on Fargate resources, then `multinode` isn't
|
4747
|
+
# supported. For more information about multi-node parallel jobs, see
|
4748
|
+
# [Creating a multi-node parallel job definition][1] in the *Batch
|
4749
|
+
# User Guide*.
|
4750
|
+
#
|
4751
|
+
#
|
4752
|
+
#
|
4753
|
+
# [1]: https://docs.aws.amazon.com/batch/latest/userguide/multi-node-job-def.html
|
4754
|
+
# @return [String]
|
4755
|
+
#
|
4756
|
+
# @!attribute [rw] scheduling_priority
|
4757
|
+
# The scheduling priority of the job definition. This only affects
|
4758
|
+
# jobs in job queues with a fair share policy. Jobs with a higher
|
4759
|
+
# scheduling priority are scheduled before jobs with a lower
|
4760
|
+
# scheduling priority.
|
4761
|
+
# @return [Integer]
|
4762
|
+
#
|
4763
|
+
# @!attribute [rw] parameters
|
4764
|
+
# Default parameters or parameter substitution placeholders that are
|
4765
|
+
# set in the job definition. Parameters are specified as a key-value
|
3348
4766
|
# pair mapping. Parameters in a `SubmitJob` request override any
|
3349
4767
|
# corresponding parameter defaults from the job definition. For more
|
3350
4768
|
# information about specifying parameters, see [Job definition
|
@@ -3361,37 +4779,40 @@ module Aws::Batch
|
|
3361
4779
|
# @return [Types::RetryStrategy]
|
3362
4780
|
#
|
3363
4781
|
# @!attribute [rw] container_properties
|
3364
|
-
# An object with various properties specific to
|
4782
|
+
# An object with various properties specific to Amazon ECS based jobs.
|
4783
|
+
# Valid values are `containerProperties`, `eksProperties`, and
|
4784
|
+
# `nodeProperties`. Only one can be specified.
|
3365
4785
|
# @return [Types::ContainerProperties]
|
3366
4786
|
#
|
3367
4787
|
# @!attribute [rw] timeout
|
3368
|
-
# The timeout
|
3369
|
-
# definition.
|
3370
|
-
# terminates your jobs if they
|
4788
|
+
# The timeout time for jobs that are submitted with this job
|
4789
|
+
# definition. After the amount of time you specify passes, Batch
|
4790
|
+
# terminates your jobs if they aren't finished.
|
3371
4791
|
# @return [Types::JobTimeout]
|
3372
4792
|
#
|
3373
4793
|
# @!attribute [rw] node_properties
|
3374
|
-
# An object with various properties specific to multi-node
|
3375
|
-
# jobs.
|
4794
|
+
# An object with various properties that are specific to multi-node
|
4795
|
+
# parallel jobs. Valid values are `containerProperties`,
|
4796
|
+
# `eksProperties`, and `nodeProperties`. Only one can be specified.
|
3376
4797
|
#
|
3377
|
-
# <note markdown="1"> If the job runs on Fargate resources,
|
3378
|
-
# `nodeProperties
|
4798
|
+
# <note markdown="1"> If the job runs on Fargate resources, don't specify
|
4799
|
+
# `nodeProperties`. Use `containerProperties` instead.
|
3379
4800
|
#
|
3380
4801
|
# </note>
|
3381
4802
|
# @return [Types::NodeProperties]
|
3382
4803
|
#
|
3383
4804
|
# @!attribute [rw] tags
|
3384
|
-
# The tags applied to the job definition.
|
4805
|
+
# The tags that are applied to the job definition.
|
3385
4806
|
# @return [Hash<String,String>]
|
3386
4807
|
#
|
3387
4808
|
# @!attribute [rw] propagate_tags
|
3388
4809
|
# Specifies whether to propagate the tags from the job or job
|
3389
4810
|
# definition to the corresponding Amazon ECS task. If no value is
|
3390
4811
|
# specified, the tags aren't propagated. Tags can only be propagated
|
3391
|
-
# to the tasks
|
3392
|
-
# tags are given priority over job definitions tags. If the
|
3393
|
-
# number of combined tags from the job and job definition is
|
3394
|
-
# the job is moved to the `FAILED` state.
|
4812
|
+
# to the tasks when the tasks are created. For tags with the same
|
4813
|
+
# name, job tags are given priority over job definitions tags. If the
|
4814
|
+
# total number of combined tags from the job and job definition is
|
4815
|
+
# over 50, the job is moved to the `FAILED` state.
|
3395
4816
|
# @return [Boolean]
|
3396
4817
|
#
|
3397
4818
|
# @!attribute [rw] platform_capabilities
|
@@ -3400,6 +4821,17 @@ module Aws::Batch
|
|
3400
4821
|
# resources specify `FARGATE`.
|
3401
4822
|
# @return [Array<String>]
|
3402
4823
|
#
|
4824
|
+
# @!attribute [rw] eks_properties
|
4825
|
+
# An object with various properties that are specific to Amazon EKS
|
4826
|
+
# based jobs. Valid values are `containerProperties`, `eksProperties`,
|
4827
|
+
# and `nodeProperties`. Only one can be specified.
|
4828
|
+
# @return [Types::EksProperties]
|
4829
|
+
#
|
4830
|
+
# @!attribute [rw] container_orchestration_type
|
4831
|
+
# The orchestration type of the compute environment. The valid values
|
4832
|
+
# are `ECS` (default) or `EKS`.
|
4833
|
+
# @return [String]
|
4834
|
+
#
|
3403
4835
|
# @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/JobDefinition AWS API Documentation
|
3404
4836
|
#
|
3405
4837
|
class JobDefinition < Struct.new(
|
@@ -3416,12 +4848,14 @@ module Aws::Batch
|
|
3416
4848
|
:node_properties,
|
3417
4849
|
:tags,
|
3418
4850
|
:propagate_tags,
|
3419
|
-
:platform_capabilities
|
4851
|
+
:platform_capabilities,
|
4852
|
+
:eks_properties,
|
4853
|
+
:container_orchestration_type)
|
3420
4854
|
SENSITIVE = []
|
3421
4855
|
include Aws::Structure
|
3422
4856
|
end
|
3423
4857
|
|
3424
|
-
# An object
|
4858
|
+
# An object that represents an Batch job dependency.
|
3425
4859
|
#
|
3426
4860
|
# @note When making an API call, you may pass JobDependency
|
3427
4861
|
# data as a hash:
|
@@ -3432,7 +4866,7 @@ module Aws::Batch
|
|
3432
4866
|
# }
|
3433
4867
|
#
|
3434
4868
|
# @!attribute [rw] job_id
|
3435
|
-
# The job ID of the Batch job associated with this dependency.
|
4869
|
+
# The job ID of the Batch job that's associated with this dependency.
|
3436
4870
|
# @return [String]
|
3437
4871
|
#
|
3438
4872
|
# @!attribute [rw] type
|
@@ -3448,18 +4882,18 @@ module Aws::Batch
|
|
3448
4882
|
include Aws::Structure
|
3449
4883
|
end
|
3450
4884
|
|
3451
|
-
# An object
|
4885
|
+
# An object that represents an Batch job.
|
3452
4886
|
#
|
3453
4887
|
# @!attribute [rw] job_arn
|
3454
4888
|
# The Amazon Resource Name (ARN) of the job.
|
3455
4889
|
# @return [String]
|
3456
4890
|
#
|
3457
4891
|
# @!attribute [rw] job_name
|
3458
|
-
# The name
|
4892
|
+
# The job name.
|
3459
4893
|
# @return [String]
|
3460
4894
|
#
|
3461
4895
|
# @!attribute [rw] job_id
|
3462
|
-
# The ID
|
4896
|
+
# The job ID.
|
3463
4897
|
# @return [String]
|
3464
4898
|
#
|
3465
4899
|
# @!attribute [rw] job_queue
|
@@ -3493,20 +4927,20 @@ module Aws::Batch
|
|
3493
4927
|
# @return [Integer]
|
3494
4928
|
#
|
3495
4929
|
# @!attribute [rw] attempts
|
3496
|
-
# A list of job attempts associated with this job.
|
4930
|
+
# A list of job attempts that are associated with this job.
|
3497
4931
|
# @return [Array<Types::AttemptDetail>]
|
3498
4932
|
#
|
3499
4933
|
# @!attribute [rw] status_reason
|
3500
|
-
# A short, human-readable string to provide
|
3501
|
-
#
|
4934
|
+
# A short, human-readable string to provide more details for the
|
4935
|
+
# current status of the job.
|
3502
4936
|
# @return [String]
|
3503
4937
|
#
|
3504
4938
|
# @!attribute [rw] created_at
|
3505
4939
|
# The Unix timestamp (in milliseconds) for when the job was created.
|
3506
4940
|
# For non-array jobs and parent array jobs, this is when the job
|
3507
|
-
# entered the `SUBMITTED` state
|
3508
|
-
# For array child jobs, this is when the child
|
3509
|
-
# parent and entered the `PENDING` state.
|
4941
|
+
# entered the `SUBMITTED` state. This is specifically at the time
|
4942
|
+
# SubmitJob was called. For array child jobs, this is when the child
|
4943
|
+
# job was spawned by its parent and entered the `PENDING` state.
|
3510
4944
|
# @return [Integer]
|
3511
4945
|
#
|
3512
4946
|
# @!attribute [rw] retry_strategy
|
@@ -3514,16 +4948,17 @@ module Aws::Batch
|
|
3514
4948
|
# @return [Types::RetryStrategy]
|
3515
4949
|
#
|
3516
4950
|
# @!attribute [rw] started_at
|
3517
|
-
# The Unix timestamp (in milliseconds) for when the job was started
|
3518
|
-
#
|
3519
|
-
# `RUNNING` state
|
3520
|
-
# array jobs or multi-node parallel jobs.
|
4951
|
+
# The Unix timestamp (in milliseconds) for when the job was started.
|
4952
|
+
# More specifically, it's when the job transitioned from the
|
4953
|
+
# `STARTING` state to the `RUNNING` state. This parameter isn't
|
4954
|
+
# provided for child jobs of array jobs or multi-node parallel jobs.
|
3521
4955
|
# @return [Integer]
|
3522
4956
|
#
|
3523
4957
|
# @!attribute [rw] stopped_at
|
3524
|
-
# The Unix timestamp (in milliseconds) for when the job was stopped
|
3525
|
-
#
|
3526
|
-
# state, such as `SUCCEEDED` or
|
4958
|
+
# The Unix timestamp (in milliseconds) for when the job was stopped.
|
4959
|
+
# More specifically, it's when the job transitioned from the
|
4960
|
+
# `RUNNING` state to a terminal state, such as `SUCCEEDED` or
|
4961
|
+
# `FAILED`.
|
3527
4962
|
# @return [Integer]
|
3528
4963
|
#
|
3529
4964
|
# @!attribute [rw] depends_on
|
@@ -3531,29 +4966,29 @@ module Aws::Batch
|
|
3531
4966
|
# @return [Array<Types::JobDependency>]
|
3532
4967
|
#
|
3533
4968
|
# @!attribute [rw] job_definition
|
3534
|
-
# The Amazon Resource Name (ARN) of the job definition that
|
3535
|
-
#
|
4969
|
+
# The Amazon Resource Name (ARN) of the job definition that this job
|
4970
|
+
# uses.
|
3536
4971
|
# @return [String]
|
3537
4972
|
#
|
3538
4973
|
# @!attribute [rw] parameters
|
3539
|
-
# Additional parameters passed to the job that replace
|
3540
|
-
# substitution placeholders or override any corresponding
|
3541
|
-
# defaults from the job definition.
|
4974
|
+
# Additional parameters that are passed to the job that replace
|
4975
|
+
# parameter substitution placeholders or override any corresponding
|
4976
|
+
# parameter defaults from the job definition.
|
3542
4977
|
# @return [Hash<String,String>]
|
3543
4978
|
#
|
3544
4979
|
# @!attribute [rw] container
|
3545
|
-
# An object
|
4980
|
+
# An object that represents the details for the container that's
|
3546
4981
|
# associated with the job.
|
3547
4982
|
# @return [Types::ContainerDetail]
|
3548
4983
|
#
|
3549
4984
|
# @!attribute [rw] node_details
|
3550
|
-
# An object
|
3551
|
-
# a multi-node parallel job.
|
4985
|
+
# An object that represents the details of a node that's associated
|
4986
|
+
# with a multi-node parallel job.
|
3552
4987
|
# @return [Types::NodeDetails]
|
3553
4988
|
#
|
3554
4989
|
# @!attribute [rw] node_properties
|
3555
|
-
# An object
|
3556
|
-
# job.
|
4990
|
+
# An object that represents the node properties of a multi-node
|
4991
|
+
# parallel job.
|
3557
4992
|
#
|
3558
4993
|
# <note markdown="1"> This isn't applicable to jobs that are running on Fargate
|
3559
4994
|
# resources.
|
@@ -3562,7 +4997,7 @@ module Aws::Batch
|
|
3562
4997
|
# @return [Types::NodeProperties]
|
3563
4998
|
#
|
3564
4999
|
# @!attribute [rw] array_properties
|
3565
|
-
# The array properties of the job, if it
|
5000
|
+
# The array properties of the job, if it's an array job.
|
3566
5001
|
# @return [Types::ArrayPropertiesDetail]
|
3567
5002
|
#
|
3568
5003
|
# @!attribute [rw] timeout
|
@@ -3570,17 +5005,17 @@ module Aws::Batch
|
|
3570
5005
|
# @return [Types::JobTimeout]
|
3571
5006
|
#
|
3572
5007
|
# @!attribute [rw] tags
|
3573
|
-
# The tags applied to the job.
|
5008
|
+
# The tags that are applied to the job.
|
3574
5009
|
# @return [Hash<String,String>]
|
3575
5010
|
#
|
3576
5011
|
# @!attribute [rw] propagate_tags
|
3577
5012
|
# Specifies whether to propagate the tags from the job or job
|
3578
5013
|
# definition to the corresponding Amazon ECS task. If no value is
|
3579
5014
|
# specified, the tags aren't propagated. Tags can only be propagated
|
3580
|
-
# to the tasks
|
3581
|
-
# tags are given priority over job definitions tags. If the
|
3582
|
-
# number of combined tags from the job and job definition is
|
3583
|
-
# the job is moved to the `FAILED` state.
|
5015
|
+
# to the tasks when the tasks are created. For tags with the same
|
5016
|
+
# name, job tags are given priority over job definitions tags. If the
|
5017
|
+
# total number of combined tags from the job and job definition is
|
5018
|
+
# over 50, the job is moved to the `FAILED` state.
|
3584
5019
|
# @return [Boolean]
|
3585
5020
|
#
|
3586
5021
|
# @!attribute [rw] platform_capabilities
|
@@ -3589,6 +5024,16 @@ module Aws::Batch
|
|
3589
5024
|
# resources specify `FARGATE`.
|
3590
5025
|
# @return [Array<String>]
|
3591
5026
|
#
|
5027
|
+
# @!attribute [rw] eks_properties
|
5028
|
+
# An object with various properties that are specific to Amazon EKS
|
5029
|
+
# based jobs. Only one of `container`, `eksProperties`, or
|
5030
|
+
# `nodeDetails` is specified.
|
5031
|
+
# @return [Types::EksPropertiesDetail]
|
5032
|
+
#
|
5033
|
+
# @!attribute [rw] eks_attempts
|
5034
|
+
# A list of job attempts that are associated with this job.
|
5035
|
+
# @return [Array<Types::EksAttemptDetail>]
|
5036
|
+
#
|
3592
5037
|
# @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/JobDetail AWS API Documentation
|
3593
5038
|
#
|
3594
5039
|
class JobDetail < Struct.new(
|
@@ -3615,15 +5060,17 @@ module Aws::Batch
|
|
3615
5060
|
:timeout,
|
3616
5061
|
:tags,
|
3617
5062
|
:propagate_tags,
|
3618
|
-
:platform_capabilities
|
5063
|
+
:platform_capabilities,
|
5064
|
+
:eks_properties,
|
5065
|
+
:eks_attempts)
|
3619
5066
|
SENSITIVE = []
|
3620
5067
|
include Aws::Structure
|
3621
5068
|
end
|
3622
5069
|
|
3623
|
-
# An object
|
5070
|
+
# An object that represents the details for an Batch job queue.
|
3624
5071
|
#
|
3625
5072
|
# @!attribute [rw] job_queue_name
|
3626
|
-
# The
|
5073
|
+
# The job queue name.
|
3627
5074
|
# @return [String]
|
3628
5075
|
#
|
3629
5076
|
# @!attribute [rw] job_queue_arn
|
@@ -3632,16 +5079,16 @@ module Aws::Batch
|
|
3632
5079
|
#
|
3633
5080
|
# @!attribute [rw] state
|
3634
5081
|
# Describes the ability of the queue to accept new jobs. If the job
|
3635
|
-
# queue state is `ENABLED`, it
|
3636
|
-
#
|
3637
|
-
#
|
5082
|
+
# queue state is `ENABLED`, it can accept jobs. If the job queue state
|
5083
|
+
# is `DISABLED`, new jobs can't be added to the queue, but jobs
|
5084
|
+
# already in the queue can finish.
|
3638
5085
|
# @return [String]
|
3639
5086
|
#
|
3640
5087
|
# @!attribute [rw] scheduling_policy_arn
|
3641
5088
|
# The Amazon Resource Name (ARN) of the scheduling policy. The format
|
3642
5089
|
# is `aws:Partition:batch:Region:Account:scheduling-policy/Name `. For
|
3643
5090
|
# example,
|
3644
|
-
# `aws:aws:batch:us-west-2:
|
5091
|
+
# `aws:aws:batch:us-west-2:123456789012:scheduling-policy/MySchedulingPolicy`.
|
3645
5092
|
# @return [String]
|
3646
5093
|
#
|
3647
5094
|
# @!attribute [rw] status
|
@@ -3649,19 +5096,19 @@ module Aws::Batch
|
|
3649
5096
|
# @return [String]
|
3650
5097
|
#
|
3651
5098
|
# @!attribute [rw] status_reason
|
3652
|
-
# A short, human-readable string to provide additional details
|
3653
|
-
#
|
5099
|
+
# A short, human-readable string to provide additional details for the
|
5100
|
+
# current status of the job queue.
|
3654
5101
|
# @return [String]
|
3655
5102
|
#
|
3656
5103
|
# @!attribute [rw] priority
|
3657
5104
|
# The priority of the job queue. Job queues with a higher priority (or
|
3658
5105
|
# a higher integer value for the `priority` parameter) are evaluated
|
3659
5106
|
# first when associated with the same compute environment. Priority is
|
3660
|
-
# determined in descending order
|
5107
|
+
# determined in descending order. For example, a job queue with a
|
3661
5108
|
# priority value of `10` is given scheduling preference over a job
|
3662
5109
|
# queue with a priority value of `1`. All of the compute environments
|
3663
5110
|
# must be either EC2 (`EC2` or `SPOT`) or Fargate (`FARGATE` or
|
3664
|
-
# `FARGATE_SPOT`)
|
5111
|
+
# `FARGATE_SPOT`). EC2 and Fargate compute environments can't be
|
3665
5112
|
# mixed.
|
3666
5113
|
# @return [Integer]
|
3667
5114
|
#
|
@@ -3672,8 +5119,8 @@ module Aws::Batch
|
|
3672
5119
|
# @return [Array<Types::ComputeEnvironmentOrder>]
|
3673
5120
|
#
|
3674
5121
|
# @!attribute [rw] tags
|
3675
|
-
# The tags applied to the job queue. For more information,
|
3676
|
-
# [Tagging your Batch resources][1] in *Batch User Guide*.
|
5122
|
+
# The tags that are applied to the job queue. For more information,
|
5123
|
+
# see [Tagging your Batch resources][1] in *Batch User Guide*.
|
3677
5124
|
#
|
3678
5125
|
#
|
3679
5126
|
#
|
@@ -3696,18 +5143,18 @@ module Aws::Batch
|
|
3696
5143
|
include Aws::Structure
|
3697
5144
|
end
|
3698
5145
|
|
3699
|
-
# An object
|
5146
|
+
# An object that represents summary details of a job.
|
3700
5147
|
#
|
3701
5148
|
# @!attribute [rw] job_arn
|
3702
5149
|
# The Amazon Resource Name (ARN) of the job.
|
3703
5150
|
# @return [String]
|
3704
5151
|
#
|
3705
5152
|
# @!attribute [rw] job_id
|
3706
|
-
# The ID
|
5153
|
+
# The job ID.
|
3707
5154
|
# @return [String]
|
3708
5155
|
#
|
3709
5156
|
# @!attribute [rw] job_name
|
3710
|
-
# The name
|
5157
|
+
# The job name.
|
3711
5158
|
# @return [String]
|
3712
5159
|
#
|
3713
5160
|
# @!attribute [rw] created_at
|
@@ -3723,28 +5170,29 @@ module Aws::Batch
|
|
3723
5170
|
# @return [String]
|
3724
5171
|
#
|
3725
5172
|
# @!attribute [rw] status_reason
|
3726
|
-
# A short, human-readable string to provide
|
3727
|
-
#
|
5173
|
+
# A short, human-readable string to provide more details for the
|
5174
|
+
# current status of the job.
|
3728
5175
|
# @return [String]
|
3729
5176
|
#
|
3730
5177
|
# @!attribute [rw] started_at
|
3731
|
-
# The Unix timestamp for when the job was started
|
3732
|
-
# transitioned from the `STARTING` state to the
|
5178
|
+
# The Unix timestamp for when the job was started. More specifically,
|
5179
|
+
# it's when the job transitioned from the `STARTING` state to the
|
5180
|
+
# `RUNNING` state.
|
3733
5181
|
# @return [Integer]
|
3734
5182
|
#
|
3735
5183
|
# @!attribute [rw] stopped_at
|
3736
|
-
# The Unix timestamp for when the job was stopped
|
3737
|
-
# transitioned from the `RUNNING` state to a
|
3738
|
-
# `SUCCEEDED` or `FAILED
|
5184
|
+
# The Unix timestamp for when the job was stopped. More specifically,
|
5185
|
+
# it's when the job transitioned from the `RUNNING` state to a
|
5186
|
+
# terminal state, such as `SUCCEEDED` or `FAILED`.
|
3739
5187
|
# @return [Integer]
|
3740
5188
|
#
|
3741
5189
|
# @!attribute [rw] container
|
3742
|
-
# An object
|
5190
|
+
# An object that represents the details of the container that's
|
3743
5191
|
# associated with the job.
|
3744
5192
|
# @return [Types::ContainerSummary]
|
3745
5193
|
#
|
3746
5194
|
# @!attribute [rw] array_properties
|
3747
|
-
# The array properties of the job, if it
|
5195
|
+
# The array properties of the job, if it's an array job.
|
3748
5196
|
# @return [Types::ArrayPropertiesSummary]
|
3749
5197
|
#
|
3750
5198
|
# @!attribute [rw] node_properties
|
@@ -3779,7 +5227,7 @@ module Aws::Batch
|
|
3779
5227
|
include Aws::Structure
|
3780
5228
|
end
|
3781
5229
|
|
3782
|
-
# An object
|
5230
|
+
# An object that represents a job timeout configuration.
|
3783
5231
|
#
|
3784
5232
|
# @note When making an API call, you may pass JobTimeout
|
3785
5233
|
# data as a hash:
|
@@ -3789,10 +5237,10 @@ module Aws::Batch
|
|
3789
5237
|
# }
|
3790
5238
|
#
|
3791
5239
|
# @!attribute [rw] attempt_duration_seconds
|
3792
|
-
# The time
|
3793
|
-
# `startedAt` timestamp
|
3794
|
-
# they
|
3795
|
-
# seconds.
|
5240
|
+
# The job timeout time (in seconds) that's measured from the job
|
5241
|
+
# attempt's `startedAt` timestamp. After this time passes, Batch
|
5242
|
+
# terminates your jobs if they aren't finished. The minimum value for
|
5243
|
+
# the timeout is 60 seconds.
|
3796
5244
|
# @return [Integer]
|
3797
5245
|
#
|
3798
5246
|
# @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/JobTimeout AWS API Documentation
|
@@ -3860,9 +5308,9 @@ module Aws::Batch
|
|
3860
5308
|
include Aws::Structure
|
3861
5309
|
end
|
3862
5310
|
|
3863
|
-
# An object
|
3864
|
-
# resource. You must specify either the launch template ID or
|
3865
|
-
# template name in the request, but not both.
|
5311
|
+
# An object that represents a launch template that's associated with a
|
5312
|
+
# compute resource. You must specify either the launch template ID or
|
5313
|
+
# launch template name in the request, but not both.
|
3866
5314
|
#
|
3867
5315
|
# If security groups are specified using both the `securityGroupIds`
|
3868
5316
|
# parameter of `CreateComputeEnvironment` and the launch template, the
|
@@ -3956,12 +5404,12 @@ module Aws::Batch
|
|
3956
5404
|
# }
|
3957
5405
|
#
|
3958
5406
|
# @!attribute [rw] devices
|
3959
|
-
# Any host devices to expose to the container. This parameter
|
3960
|
-
# `Devices` in the [Create a container][1] section of the
|
3961
|
-
# Remote API][2] and the `--device` option to [docker run][3].
|
5407
|
+
# Any of the host devices to expose to the container. This parameter
|
5408
|
+
# maps to `Devices` in the [Create a container][1] section of the
|
5409
|
+
# [Docker Remote API][2] and the `--device` option to [docker run][3].
|
3962
5410
|
#
|
3963
5411
|
# <note markdown="1"> This parameter isn't applicable to jobs that are running on Fargate
|
3964
|
-
# resources
|
5412
|
+
# resources. Don't provide it for these jobs.
|
3965
5413
|
#
|
3966
5414
|
# </note>
|
3967
5415
|
#
|
@@ -3978,7 +5426,7 @@ module Aws::Batch
|
|
3978
5426
|
# option to [docker run][1]. This parameter requires version 1.25 of
|
3979
5427
|
# the Docker Remote API or greater on your container instance. To
|
3980
5428
|
# check the Docker Remote API version on your container instance, log
|
3981
|
-
#
|
5429
|
+
# in to your container instance and run the following command: `sudo
|
3982
5430
|
# docker version | grep "Server API version"`
|
3983
5431
|
#
|
3984
5432
|
#
|
@@ -3991,7 +5439,7 @@ module Aws::Batch
|
|
3991
5439
|
# parameter maps to the `--shm-size` option to [docker run][1].
|
3992
5440
|
#
|
3993
5441
|
# <note markdown="1"> This parameter isn't applicable to jobs that are running on Fargate
|
3994
|
-
# resources
|
5442
|
+
# resources. Don't provide it for these jobs.
|
3995
5443
|
#
|
3996
5444
|
# </note>
|
3997
5445
|
#
|
@@ -4001,12 +5449,12 @@ module Aws::Batch
|
|
4001
5449
|
# @return [Integer]
|
4002
5450
|
#
|
4003
5451
|
# @!attribute [rw] tmpfs
|
4004
|
-
# The container path, mount options, and size (in MiB) of the tmpfs
|
5452
|
+
# The container path, mount options, and size (in MiB) of the `tmpfs`
|
4005
5453
|
# mount. This parameter maps to the `--tmpfs` option to [docker
|
4006
5454
|
# run][1].
|
4007
5455
|
#
|
4008
5456
|
# <note markdown="1"> This parameter isn't applicable to jobs that are running on Fargate
|
4009
|
-
# resources
|
5457
|
+
# resources. Don't provide this parameter for this resource type.
|
4010
5458
|
#
|
4011
5459
|
# </note>
|
4012
5460
|
#
|
@@ -4025,12 +5473,12 @@ module Aws::Batch
|
|
4025
5473
|
# If a `maxSwap` value of `0` is specified, the container doesn't use
|
4026
5474
|
# swap. Accepted values are `0` or any positive integer. If the
|
4027
5475
|
# `maxSwap` parameter is omitted, the container doesn't use the swap
|
4028
|
-
# configuration for the container instance it
|
5476
|
+
# configuration for the container instance that it's running on. A
|
4029
5477
|
# `maxSwap` value must be set for the `swappiness` parameter to be
|
4030
5478
|
# used.
|
4031
5479
|
#
|
4032
5480
|
# <note markdown="1"> This parameter isn't applicable to jobs that are running on Fargate
|
4033
|
-
# resources
|
5481
|
+
# resources. Don't provide it for these jobs.
|
4034
5482
|
#
|
4035
5483
|
# </note>
|
4036
5484
|
#
|
@@ -4041,10 +5489,10 @@ module Aws::Batch
|
|
4041
5489
|
# @return [Integer]
|
4042
5490
|
#
|
4043
5491
|
# @!attribute [rw] swappiness
|
4044
|
-
#
|
4045
|
-
# `swappiness` value of `0` causes swapping
|
4046
|
-
# absolutely necessary. A `swappiness` value of `100` causes
|
4047
|
-
# be swapped
|
5492
|
+
# You can use this parameter to tune a container's memory swappiness
|
5493
|
+
# behavior. A `swappiness` value of `0` causes swapping to not occur
|
5494
|
+
# unless absolutely necessary. A `swappiness` value of `100` causes
|
5495
|
+
# pages to be swapped aggressively. Valid values are whole numbers
|
4048
5496
|
# between `0` and `100`. If the `swappiness` parameter isn't
|
4049
5497
|
# specified, a default value of `60` is used. If a value isn't
|
4050
5498
|
# specified for `maxSwap`, then this parameter is ignored. If
|
@@ -4058,12 +5506,12 @@ module Aws::Batch
|
|
4058
5506
|
# * Swap space must be enabled and allocated on the container instance
|
4059
5507
|
# for the containers to use.
|
4060
5508
|
#
|
4061
|
-
# <note markdown="1">
|
4062
|
-
# You must enable swap on the instance to use this feature.
|
4063
|
-
# information, see [Instance store swap volumes][2] in the
|
4064
|
-
# EC2 User Guide for Linux Instances* or [How do I allocate
|
4065
|
-
# to work as swap space in an Amazon EC2 instance by using a
|
4066
|
-
# file?][3]
|
5509
|
+
# <note markdown="1"> By default, the Amazon ECS optimized AMIs don't have swap
|
5510
|
+
# enabled. You must enable swap on the instance to use this feature.
|
5511
|
+
# For more information, see [Instance store swap volumes][2] in the
|
5512
|
+
# *Amazon EC2 User Guide for Linux Instances* or [How do I allocate
|
5513
|
+
# memory to work as swap space in an Amazon EC2 instance by using a
|
5514
|
+
# swap file?][3]
|
4067
5515
|
#
|
4068
5516
|
# </note>
|
4069
5517
|
#
|
@@ -4071,12 +5519,12 @@ module Aws::Batch
|
|
4071
5519
|
# using EC2 resources.
|
4072
5520
|
#
|
4073
5521
|
# * If the `maxSwap` and `swappiness` parameters are omitted from a
|
4074
|
-
# job definition, each container
|
4075
|
-
#
|
4076
|
-
#
|
5522
|
+
# job definition, each container has a default `swappiness` value of
|
5523
|
+
# 60. Moreover, the total swap usage is limited to two times the
|
5524
|
+
# memory reservation of the container.
|
4077
5525
|
#
|
4078
5526
|
# <note markdown="1"> This parameter isn't applicable to jobs that are running on Fargate
|
4079
|
-
# resources
|
5527
|
+
# resources. Don't provide it for these jobs.
|
4080
5528
|
#
|
4081
5529
|
# </note>
|
4082
5530
|
#
|
@@ -4161,9 +5609,9 @@ module Aws::Batch
|
|
4161
5609
|
# previous results that returned the `nextToken` value. This value is
|
4162
5610
|
# `null` when there are no more results to return.
|
4163
5611
|
#
|
4164
|
-
# <note markdown="1">
|
4165
|
-
#
|
4166
|
-
#
|
5612
|
+
# <note markdown="1"> Treat this token as an opaque identifier that's only used to
|
5613
|
+
# retrieve the next items in a list and not for other programmatic
|
5614
|
+
# purposes.
|
4167
5615
|
#
|
4168
5616
|
# </note>
|
4169
5617
|
# @return [String]
|
@@ -4178,12 +5626,12 @@ module Aws::Batch
|
|
4178
5626
|
# JOB\_NAME
|
4179
5627
|
#
|
4180
5628
|
# : The value of the filter is a case-insensitive match for the job
|
4181
|
-
# name. If the value ends with an asterisk (*), the filter
|
4182
|
-
#
|
4183
|
-
#
|
4184
|
-
#
|
4185
|
-
# `
|
4186
|
-
#
|
5629
|
+
# name. If the value ends with an asterisk (*), the filter matches
|
5630
|
+
# any job name that begins with the string before the '*'. This
|
5631
|
+
# corresponds to the `jobName` value. For example, `test1` matches
|
5632
|
+
# both `Test1` and `test1`, and `test1*` matches both `test1` and
|
5633
|
+
# `Test10`. When the `JOB_NAME` filter is used, the results are
|
5634
|
+
# grouped by the job name and version.
|
4187
5635
|
#
|
4188
5636
|
# JOB\_DEFINITION
|
4189
5637
|
#
|
@@ -4192,15 +5640,15 @@ module Aws::Batch
|
|
4192
5640
|
# value. The value is case sensitive. When the value for the filter
|
4193
5641
|
# is the job definition name, the results include all the jobs that
|
4194
5642
|
# used any revision of that job definition name. If the value ends
|
4195
|
-
# with an asterisk (*), the filter
|
4196
|
-
#
|
4197
|
-
#
|
4198
|
-
#
|
4199
|
-
#
|
4200
|
-
#
|
5643
|
+
# with an asterisk (*), the filter matches any job definition name
|
5644
|
+
# that begins with the string before the '*'. For example, `jd1`
|
5645
|
+
# matches only `jd1`, and `jd1*` matches both `jd1` and `jd1A`. The
|
5646
|
+
# version of the job definition that's used doesn't affect the
|
5647
|
+
# sort order. When the `JOB_DEFINITION` filter is used and the ARN
|
5648
|
+
# is used (which is in the form
|
4201
5649
|
# `arn:$\{Partition\}:batch:$\{Region\}:$\{Account\}:job-definition/$\{JobDefinitionName\}:$\{Revision\}`),
|
4202
5650
|
# the results include jobs that used the specified revision of the
|
4203
|
-
# job definition. Asterisk (*)
|
5651
|
+
# job definition. Asterisk (*) isn't supported when the ARN is
|
4204
5652
|
# used.
|
4205
5653
|
#
|
4206
5654
|
# BEFORE\_CREATED\_AT
|
@@ -4282,9 +5730,9 @@ module Aws::Batch
|
|
4282
5730
|
# value. This value is `null` when there are no more results to
|
4283
5731
|
# return.
|
4284
5732
|
#
|
4285
|
-
# <note markdown="1">
|
4286
|
-
#
|
4287
|
-
#
|
5733
|
+
# <note markdown="1"> Treat this token as an opaque identifier that's only used to
|
5734
|
+
# retrieve the next items in a list and not for other programmatic
|
5735
|
+
# purposes.
|
4288
5736
|
#
|
4289
5737
|
# </note>
|
4290
5738
|
# @return [String]
|
@@ -4333,7 +5781,7 @@ module Aws::Batch
|
|
4333
5781
|
# tags are listed for. Batch resources that support tags are compute
|
4334
5782
|
# environments, jobs, job definitions, job queues, and scheduling
|
4335
5783
|
# policies. ARNs for child jobs of array and multi-node parallel (MNP)
|
4336
|
-
# jobs
|
5784
|
+
# jobs aren't supported.
|
4337
5785
|
# @return [String]
|
4338
5786
|
#
|
4339
5787
|
# @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/ListTagsForResourceRequest AWS API Documentation
|
@@ -4376,9 +5824,9 @@ module Aws::Batch
|
|
4376
5824
|
# }
|
4377
5825
|
#
|
4378
5826
|
# @!attribute [rw] log_driver
|
4379
|
-
# The log driver to use for the container. The valid values
|
4380
|
-
# this parameter are log drivers that the Amazon ECS
|
4381
|
-
# can communicate with by default.
|
5827
|
+
# The log driver to use for the container. The valid values that are
|
5828
|
+
# listed for this parameter are log drivers that the Amazon ECS
|
5829
|
+
# container agent can communicate with by default.
|
4382
5830
|
#
|
4383
5831
|
# The supported log drivers are `awslogs`, `fluentd`, `gelf`,
|
4384
5832
|
# `json-file`, `journald`, `logentries`, `syslog`, and `splunk`.
|
@@ -4397,39 +5845,39 @@ module Aws::Batch
|
|
4397
5845
|
#
|
4398
5846
|
# fluentd
|
4399
5847
|
#
|
4400
|
-
# : Specifies the Fluentd logging driver. For more information
|
5848
|
+
# : Specifies the Fluentd logging driver. For more information
|
4401
5849
|
# including usage and options, see [Fluentd logging driver][3] in
|
4402
|
-
# the Docker documentation
|
5850
|
+
# the *Docker documentation*.
|
4403
5851
|
#
|
4404
5852
|
# gelf
|
4405
5853
|
#
|
4406
5854
|
# : Specifies the Graylog Extended Format (GELF) logging driver. For
|
4407
|
-
# more information
|
4408
|
-
# Extended Format logging driver][4] in the Docker documentation
|
5855
|
+
# more information including usage and options, see [Graylog
|
5856
|
+
# Extended Format logging driver][4] in the *Docker documentation*.
|
4409
5857
|
#
|
4410
5858
|
# journald
|
4411
5859
|
#
|
4412
|
-
# : Specifies the journald logging driver. For more information
|
5860
|
+
# : Specifies the journald logging driver. For more information
|
4413
5861
|
# including usage and options, see [Journald logging driver][5] in
|
4414
|
-
# the Docker documentation
|
5862
|
+
# the *Docker documentation*.
|
4415
5863
|
#
|
4416
5864
|
# json-file
|
4417
5865
|
#
|
4418
|
-
# : Specifies the JSON file logging driver. For more information
|
5866
|
+
# : Specifies the JSON file logging driver. For more information
|
4419
5867
|
# including usage and options, see [JSON File logging driver][6] in
|
4420
|
-
# the Docker documentation
|
5868
|
+
# the *Docker documentation*.
|
4421
5869
|
#
|
4422
5870
|
# splunk
|
4423
5871
|
#
|
4424
|
-
# : Specifies the Splunk logging driver. For more information
|
5872
|
+
# : Specifies the Splunk logging driver. For more information
|
4425
5873
|
# including usage and options, see [Splunk logging driver][7] in the
|
4426
|
-
# Docker documentation
|
5874
|
+
# *Docker documentation*.
|
4427
5875
|
#
|
4428
5876
|
# syslog
|
4429
5877
|
#
|
4430
|
-
# : Specifies the syslog logging driver. For more information
|
5878
|
+
# : Specifies the syslog logging driver. For more information
|
4431
5879
|
# including usage and options, see [Syslog logging driver][8] in the
|
4432
|
-
# Docker documentation
|
5880
|
+
# *Docker documentation*.
|
4433
5881
|
#
|
4434
5882
|
# <note markdown="1"> If you have a custom driver that's not listed earlier that you want
|
4435
5883
|
# to work with the Amazon ECS container agent, you can fork the Amazon
|
@@ -4443,9 +5891,9 @@ module Aws::Batch
|
|
4443
5891
|
#
|
4444
5892
|
# This parameter requires version 1.18 of the Docker Remote API or
|
4445
5893
|
# greater on your container instance. To check the Docker Remote API
|
4446
|
-
# version on your container instance, log
|
4447
|
-
# and run the following command: `sudo docker version | grep
|
4448
|
-
# API version"`
|
5894
|
+
# version on your container instance, log in to your container
|
5895
|
+
# instance and run the following command: `sudo docker version | grep
|
5896
|
+
# "Server API version"`
|
4449
5897
|
#
|
4450
5898
|
#
|
4451
5899
|
#
|
@@ -4464,7 +5912,7 @@ module Aws::Batch
|
|
4464
5912
|
# The configuration options to send to the log driver. This parameter
|
4465
5913
|
# requires version 1.19 of the Docker Remote API or greater on your
|
4466
5914
|
# container instance. To check the Docker Remote API version on your
|
4467
|
-
# container instance, log
|
5915
|
+
# container instance, log in to your container instance and run the
|
4468
5916
|
# following command: `sudo docker version | grep "Server API version"`
|
4469
5917
|
# @return [Hash<String,String>]
|
4470
5918
|
#
|
@@ -4487,9 +5935,9 @@ module Aws::Batch
|
|
4487
5935
|
include Aws::Structure
|
4488
5936
|
end
|
4489
5937
|
|
4490
|
-
# Details
|
5938
|
+
# Details for a Docker volume mount point that's used in a job's
|
4491
5939
|
# container properties. This parameter maps to `Volumes` in the [Create
|
4492
|
-
# a container][1] section of the Docker Remote API and the `--volume`
|
5940
|
+
# a container][1] section of the *Docker Remote API* and the `--volume`
|
4493
5941
|
# option to docker run.
|
4494
5942
|
#
|
4495
5943
|
#
|
@@ -4541,12 +5989,13 @@ module Aws::Batch
|
|
4541
5989
|
# }
|
4542
5990
|
#
|
4543
5991
|
# @!attribute [rw] assign_public_ip
|
4544
|
-
# Indicates whether the job
|
4545
|
-
#
|
4546
|
-
#
|
4547
|
-
#
|
4548
|
-
#
|
4549
|
-
#
|
5992
|
+
# Indicates whether the job has a public IP address. For a job that's
|
5993
|
+
# running on Fargate resources in a private subnet to send outbound
|
5994
|
+
# traffic to the internet (for example, to pull container images), the
|
5995
|
+
# private subnet requires a NAT gateway be attached to route requests
|
5996
|
+
# to the internet. For more information, see [Amazon ECS task
|
5997
|
+
# networking][1] in the *Amazon Elastic Container Service Developer
|
5998
|
+
# Guide*. The default value is "`DISABLED`".
|
4550
5999
|
#
|
4551
6000
|
#
|
4552
6001
|
#
|
@@ -4561,8 +6010,8 @@ module Aws::Batch
|
|
4561
6010
|
include Aws::Structure
|
4562
6011
|
end
|
4563
6012
|
|
4564
|
-
# An object
|
4565
|
-
# parallel job node.
|
6013
|
+
# An object that represents the elastic network interface for a
|
6014
|
+
# multi-node parallel job node.
|
4566
6015
|
#
|
4567
6016
|
# @!attribute [rw] attachment_id
|
4568
6017
|
# The attachment ID for the network interface.
|
@@ -4586,10 +6035,11 @@ module Aws::Batch
|
|
4586
6035
|
include Aws::Structure
|
4587
6036
|
end
|
4588
6037
|
|
4589
|
-
# An object
|
6038
|
+
# An object that represents the details of a multi-node parallel job
|
6039
|
+
# node.
|
4590
6040
|
#
|
4591
6041
|
# @!attribute [rw] node_index
|
4592
|
-
# The node index for the node. Node index numbering
|
6042
|
+
# The node index for the node. Node index numbering starts at zero.
|
4593
6043
|
# This index is also available on the node with the
|
4594
6044
|
# `AWS_BATCH_JOB_NODE_INDEX` environment variable.
|
4595
6045
|
# @return [Integer]
|
@@ -4608,11 +6058,12 @@ module Aws::Batch
|
|
4608
6058
|
include Aws::Structure
|
4609
6059
|
end
|
4610
6060
|
|
4611
|
-
#
|
4612
|
-
# used in a SubmitJob API operation.
|
6061
|
+
# An object that represents any node overrides to a job definition
|
6062
|
+
# that's used in a SubmitJob API operation.
|
4613
6063
|
#
|
4614
|
-
# <note markdown="1"> This isn't applicable to jobs that are running on Fargate
|
4615
|
-
#
|
6064
|
+
# <note markdown="1"> This parameter isn't applicable to jobs that are running on Fargate
|
6065
|
+
# resources. Don't provide it for these jobs. Rather, use
|
6066
|
+
# `containerOverrides` instead.
|
4616
6067
|
#
|
4617
6068
|
# </note>
|
4618
6069
|
#
|
@@ -4649,17 +6100,18 @@ module Aws::Batch
|
|
4649
6100
|
# @!attribute [rw] num_nodes
|
4650
6101
|
# The number of nodes to use with a multi-node parallel job. This
|
4651
6102
|
# value overrides the number of nodes that are specified in the job
|
4652
|
-
# definition. To use this override
|
6103
|
+
# definition. To use this override, you must meet the following
|
6104
|
+
# conditions:
|
4653
6105
|
#
|
4654
6106
|
# * There must be at least one node range in your job definition that
|
4655
|
-
# has an open upper boundary
|
6107
|
+
# has an open upper boundary, such as `:` or `n:`.
|
4656
6108
|
#
|
4657
|
-
# * The lower boundary of the node range specified in the job
|
6109
|
+
# * The lower boundary of the node range that's specified in the job
|
4658
6110
|
# definition must be fewer than the number of nodes specified in the
|
4659
6111
|
# override.
|
4660
6112
|
#
|
4661
|
-
# * The main node index specified in the job definition must
|
4662
|
-
# than the number of nodes specified in the override.
|
6113
|
+
# * The main node index that's specified in the job definition must
|
6114
|
+
# be fewer than the number of nodes specified in the override.
|
4663
6115
|
# @return [Integer]
|
4664
6116
|
#
|
4665
6117
|
# @!attribute [rw] node_property_overrides
|
@@ -4675,9 +6127,14 @@ module Aws::Batch
|
|
4675
6127
|
include Aws::Structure
|
4676
6128
|
end
|
4677
6129
|
|
4678
|
-
# An object
|
6130
|
+
# An object that represents the node properties of a multi-node parallel
|
4679
6131
|
# job.
|
4680
6132
|
#
|
6133
|
+
# <note markdown="1"> Node properties can't be specified for Amazon EKS based job
|
6134
|
+
# definitions.
|
6135
|
+
#
|
6136
|
+
# </note>
|
6137
|
+
#
|
4681
6138
|
# @note When making an API call, you may pass NodeProperties
|
4682
6139
|
# data as a hash:
|
4683
6140
|
#
|
@@ -4792,7 +6249,8 @@ module Aws::Batch
|
|
4792
6249
|
# }
|
4793
6250
|
#
|
4794
6251
|
# @!attribute [rw] num_nodes
|
4795
|
-
# The number of nodes associated with a multi-node parallel
|
6252
|
+
# The number of nodes that are associated with a multi-node parallel
|
6253
|
+
# job.
|
4796
6254
|
# @return [Integer]
|
4797
6255
|
#
|
4798
6256
|
# @!attribute [rw] main_node
|
@@ -4801,8 +6259,8 @@ module Aws::Batch
|
|
4801
6259
|
# @return [Integer]
|
4802
6260
|
#
|
4803
6261
|
# @!attribute [rw] node_range_properties
|
4804
|
-
# A list of node ranges and their properties associated with
|
4805
|
-
# multi-node parallel job.
|
6262
|
+
# A list of node ranges and their properties that are associated with
|
6263
|
+
# a multi-node parallel job.
|
4806
6264
|
# @return [Array<Types::NodeRangeProperty>]
|
4807
6265
|
#
|
4808
6266
|
# @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/NodeProperties AWS API Documentation
|
@@ -4815,7 +6273,7 @@ module Aws::Batch
|
|
4815
6273
|
include Aws::Structure
|
4816
6274
|
end
|
4817
6275
|
|
4818
|
-
# An object
|
6276
|
+
# An object that represents the properties of a node that's associated
|
4819
6277
|
# with a multi-node parallel job.
|
4820
6278
|
#
|
4821
6279
|
# @!attribute [rw] is_main_node
|
@@ -4824,7 +6282,8 @@ module Aws::Batch
|
|
4824
6282
|
# @return [Boolean]
|
4825
6283
|
#
|
4826
6284
|
# @!attribute [rw] num_nodes
|
4827
|
-
# The number of nodes associated with a multi-node parallel
|
6285
|
+
# The number of nodes that are associated with a multi-node parallel
|
6286
|
+
# job.
|
4828
6287
|
# @return [Integer]
|
4829
6288
|
#
|
4830
6289
|
# @!attribute [rw] node_index
|
@@ -4843,8 +6302,8 @@ module Aws::Batch
|
|
4843
6302
|
include Aws::Structure
|
4844
6303
|
end
|
4845
6304
|
|
4846
|
-
#
|
4847
|
-
# used in a SubmitJob API operation.
|
6305
|
+
# The object that represents any node overrides to a job definition
|
6306
|
+
# that's used in a SubmitJob API operation.
|
4848
6307
|
#
|
4849
6308
|
# @note When making an API call, you may pass NodePropertyOverride
|
4850
6309
|
# data as a hash:
|
@@ -4881,7 +6340,7 @@ module Aws::Batch
|
|
4881
6340
|
# @return [String]
|
4882
6341
|
#
|
4883
6342
|
# @!attribute [rw] container_overrides
|
4884
|
-
# The overrides that
|
6343
|
+
# The overrides that are sent to a node range.
|
4885
6344
|
# @return [Types::ContainerOverrides]
|
4886
6345
|
#
|
4887
6346
|
# @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/NodePropertyOverride AWS API Documentation
|
@@ -4893,7 +6352,7 @@ module Aws::Batch
|
|
4893
6352
|
include Aws::Structure
|
4894
6353
|
end
|
4895
6354
|
|
4896
|
-
# An object
|
6355
|
+
# An object that represents the properties of the node range for a
|
4897
6356
|
# multi-node parallel job.
|
4898
6357
|
#
|
4899
6358
|
# @note When making an API call, you may pass NodeRangeProperty
|
@@ -5010,7 +6469,7 @@ module Aws::Batch
|
|
5010
6469
|
# the range. If the ending range value is omitted (`n:`), then the
|
5011
6470
|
# highest possible node index is used to end the range. Your
|
5012
6471
|
# accumulative node ranges must account for all nodes (`0:n`). You can
|
5013
|
-
# nest node ranges
|
6472
|
+
# nest node ranges (for example, `0:10` and `4:5`). In this case, the
|
5014
6473
|
# `4:5` range properties override the `0:10` properties.
|
5015
6474
|
# @return [String]
|
5016
6475
|
#
|
@@ -5267,6 +6726,66 @@ module Aws::Batch
|
|
5267
6726
|
# "TagKey" => "TagValue",
|
5268
6727
|
# },
|
5269
6728
|
# platform_capabilities: ["EC2"], # accepts EC2, FARGATE
|
6729
|
+
# eks_properties: {
|
6730
|
+
# pod_properties: {
|
6731
|
+
# service_account_name: "String",
|
6732
|
+
# host_network: false,
|
6733
|
+
# dns_policy: "String",
|
6734
|
+
# containers: [
|
6735
|
+
# {
|
6736
|
+
# name: "String",
|
6737
|
+
# image: "String", # required
|
6738
|
+
# image_pull_policy: "String",
|
6739
|
+
# command: ["String"],
|
6740
|
+
# args: ["String"],
|
6741
|
+
# env: [
|
6742
|
+
# {
|
6743
|
+
# name: "String", # required
|
6744
|
+
# value: "String",
|
6745
|
+
# },
|
6746
|
+
# ],
|
6747
|
+
# resources: {
|
6748
|
+
# limits: {
|
6749
|
+
# "String" => "Quantity",
|
6750
|
+
# },
|
6751
|
+
# requests: {
|
6752
|
+
# "String" => "Quantity",
|
6753
|
+
# },
|
6754
|
+
# },
|
6755
|
+
# volume_mounts: [
|
6756
|
+
# {
|
6757
|
+
# name: "String",
|
6758
|
+
# mount_path: "String",
|
6759
|
+
# read_only: false,
|
6760
|
+
# },
|
6761
|
+
# ],
|
6762
|
+
# security_context: {
|
6763
|
+
# run_as_user: 1,
|
6764
|
+
# run_as_group: 1,
|
6765
|
+
# privileged: false,
|
6766
|
+
# read_only_root_filesystem: false,
|
6767
|
+
# run_as_non_root: false,
|
6768
|
+
# },
|
6769
|
+
# },
|
6770
|
+
# ],
|
6771
|
+
# volumes: [
|
6772
|
+
# {
|
6773
|
+
# name: "String", # required
|
6774
|
+
# host_path: {
|
6775
|
+
# path: "String",
|
6776
|
+
# },
|
6777
|
+
# empty_dir: {
|
6778
|
+
# medium: "String",
|
6779
|
+
# size_limit: "Quantity",
|
6780
|
+
# },
|
6781
|
+
# secret: {
|
6782
|
+
# secret_name: "String", # required
|
6783
|
+
# optional: false,
|
6784
|
+
# },
|
6785
|
+
# },
|
6786
|
+
# ],
|
6787
|
+
# },
|
6788
|
+
# },
|
5270
6789
|
# }
|
5271
6790
|
#
|
5272
6791
|
# @!attribute [rw] job_definition_name
|
@@ -5299,19 +6818,20 @@ module Aws::Batch
|
|
5299
6818
|
#
|
5300
6819
|
# @!attribute [rw] scheduling_priority
|
5301
6820
|
# The scheduling priority for jobs that are submitted with this job
|
5302
|
-
# definition. This
|
5303
|
-
#
|
5304
|
-
#
|
6821
|
+
# definition. This only affects jobs in job queues with a fair share
|
6822
|
+
# policy. Jobs with a higher scheduling priority are scheduled before
|
6823
|
+
# jobs with a lower scheduling priority.
|
5305
6824
|
#
|
5306
6825
|
# The minimum supported value is 0 and the maximum supported value is
|
5307
6826
|
# 9999.
|
5308
6827
|
# @return [Integer]
|
5309
6828
|
#
|
5310
6829
|
# @!attribute [rw] container_properties
|
5311
|
-
# An object with various properties specific to
|
5312
|
-
# container-based jobs. If the job definition's `type`
|
5313
|
-
# `container`, then you must specify either
|
5314
|
-
# `nodeProperties`.
|
6830
|
+
# An object with various properties specific to Amazon ECS based
|
6831
|
+
# single-node container-based jobs. If the job definition's `type`
|
6832
|
+
# parameter is `container`, then you must specify either
|
6833
|
+
# `containerProperties` or `nodeProperties`. This must not be
|
6834
|
+
# specified for Amazon EKS based job definitions.
|
5315
6835
|
#
|
5316
6836
|
# <note markdown="1"> If the job runs on Fargate resources, then you must not specify
|
5317
6837
|
# `nodeProperties`; use only `containerProperties`.
|
@@ -5332,6 +6852,11 @@ module Aws::Batch
|
|
5332
6852
|
#
|
5333
6853
|
# </note>
|
5334
6854
|
#
|
6855
|
+
# <note markdown="1"> If the job runs on Amazon EKS resources, then you must not specify
|
6856
|
+
# `nodeProperties`.
|
6857
|
+
#
|
6858
|
+
# </note>
|
6859
|
+
#
|
5335
6860
|
#
|
5336
6861
|
#
|
5337
6862
|
# [1]: https://docs.aws.amazon.com/batch/latest/userguide/multi-node-parallel-jobs.html
|
@@ -5352,6 +6877,11 @@ module Aws::Batch
|
|
5352
6877
|
# tags are given priority over job definitions tags. If the total
|
5353
6878
|
# number of combined tags from the job and job definition is over 50,
|
5354
6879
|
# the job is moved to the `FAILED` state.
|
6880
|
+
#
|
6881
|
+
# <note markdown="1"> If the job runs on Amazon EKS resources, then you must not specify
|
6882
|
+
# `propagateTags`.
|
6883
|
+
#
|
6884
|
+
# </note>
|
5355
6885
|
# @return [Boolean]
|
5356
6886
|
#
|
5357
6887
|
# @!attribute [rw] timeout
|
@@ -5383,8 +6913,19 @@ module Aws::Batch
|
|
5383
6913
|
# The platform capabilities required by the job definition. If no
|
5384
6914
|
# value is specified, it defaults to `EC2`. To run the job on Fargate
|
5385
6915
|
# resources, specify `FARGATE`.
|
6916
|
+
#
|
6917
|
+
# <note markdown="1"> If the job runs on Amazon EKS resources, then you must not specify
|
6918
|
+
# `platformCapabilities`.
|
6919
|
+
#
|
6920
|
+
# </note>
|
5386
6921
|
# @return [Array<String>]
|
5387
6922
|
#
|
6923
|
+
# @!attribute [rw] eks_properties
|
6924
|
+
# An object with various properties that are specific to Amazon EKS
|
6925
|
+
# based jobs. This must not be specified for Amazon ECS based job
|
6926
|
+
# definitions.
|
6927
|
+
# @return [Types::EksProperties]
|
6928
|
+
#
|
5388
6929
|
# @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/RegisterJobDefinitionRequest AWS API Documentation
|
5389
6930
|
#
|
5390
6931
|
class RegisterJobDefinitionRequest < Struct.new(
|
@@ -5398,7 +6939,8 @@ module Aws::Batch
|
|
5398
6939
|
:propagate_tags,
|
5399
6940
|
:timeout,
|
5400
6941
|
:tags,
|
5401
|
-
:platform_capabilities
|
6942
|
+
:platform_capabilities,
|
6943
|
+
:eks_properties)
|
5402
6944
|
SENSITIVE = []
|
5403
6945
|
include Aws::Structure
|
5404
6946
|
end
|
@@ -5442,12 +6984,12 @@ module Aws::Batch
|
|
5442
6984
|
#
|
5443
6985
|
# type="GPU"
|
5444
6986
|
#
|
5445
|
-
# : The number of physical GPUs to reserve for the container.
|
5446
|
-
# number of GPUs reserved for all containers in a job
|
5447
|
-
# exceed the number of available GPUs on the compute
|
5448
|
-
# the job is launched on.
|
6987
|
+
# : The number of physical GPUs to reserve for the container. Make
|
6988
|
+
# sure that the number of GPUs reserved for all containers in a job
|
6989
|
+
# doesn't exceed the number of available GPUs on the compute
|
6990
|
+
# resource that the job is launched on.
|
5449
6991
|
#
|
5450
|
-
# <note markdown="1"> GPUs
|
6992
|
+
# <note markdown="1"> GPUs aren't available for jobs that are running on Fargate
|
5451
6993
|
# resources.
|
5452
6994
|
#
|
5453
6995
|
# </note>
|
@@ -5574,8 +7116,8 @@ module Aws::Batch
|
|
5574
7116
|
include Aws::Structure
|
5575
7117
|
end
|
5576
7118
|
|
5577
|
-
# The retry strategy associated with a job. For more
|
5578
|
-
# [Automated job retries][1] in the *Batch User Guide*.
|
7119
|
+
# The retry strategy that's associated with a job. For more
|
7120
|
+
# information, see [Automated job retries][1] in the *Batch User Guide*.
|
5579
7121
|
#
|
5580
7122
|
#
|
5581
7123
|
#
|
@@ -5604,9 +7146,10 @@ module Aws::Batch
|
|
5604
7146
|
# @return [Integer]
|
5605
7147
|
#
|
5606
7148
|
# @!attribute [rw] evaluate_on_exit
|
5607
|
-
# Array of up to 5 objects that specify conditions
|
5608
|
-
#
|
5609
|
-
#
|
7149
|
+
# Array of up to 5 objects that specify the conditions where jobs are
|
7150
|
+
# retried or failed. If this parameter is specified, then the
|
7151
|
+
# `attempts` parameter must also be specified. If none of the listed
|
7152
|
+
# conditions match, then the job is retried.
|
5610
7153
|
# @return [Array<Types::EvaluateOnExit>]
|
5611
7154
|
#
|
5612
7155
|
# @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/RetryStrategy AWS API Documentation
|
@@ -5672,8 +7215,8 @@ module Aws::Batch
|
|
5672
7215
|
include Aws::Structure
|
5673
7216
|
end
|
5674
7217
|
|
5675
|
-
# An object
|
5676
|
-
# can be exposed to a container in the following ways:
|
7218
|
+
# An object that represents the secret to expose to your container.
|
7219
|
+
# Secrets can be exposed to a container in the following ways:
|
5677
7220
|
#
|
5678
7221
|
# * To inject sensitive data into your containers as environment
|
5679
7222
|
# variables, use the `secrets` container definition parameter.
|
@@ -5702,14 +7245,15 @@ module Aws::Batch
|
|
5702
7245
|
#
|
5703
7246
|
# @!attribute [rw] value_from
|
5704
7247
|
# The secret to expose to the container. The supported values are
|
5705
|
-
# either the full ARN of the Secrets Manager
|
5706
|
-
# the parameter in the Amazon Web Services
|
5707
|
-
# Store.
|
7248
|
+
# either the full Amazon Resource Name (ARN) of the Secrets Manager
|
7249
|
+
# secret or the full ARN of the parameter in the Amazon Web Services
|
7250
|
+
# Systems Manager Parameter Store.
|
5708
7251
|
#
|
5709
7252
|
# <note markdown="1"> If the Amazon Web Services Systems Manager Parameter Store parameter
|
5710
7253
|
# exists in the same Region as the job you're launching, then you can
|
5711
|
-
# use either the full ARN or name of the
|
5712
|
-
# exists in a different Region, then the
|
7254
|
+
# use either the full Amazon Resource Name (ARN) or name of the
|
7255
|
+
# parameter. If the parameter exists in a different Region, then the
|
7256
|
+
# full ARN must be specified.
|
5713
7257
|
#
|
5714
7258
|
# </note>
|
5715
7259
|
# @return [String]
|
@@ -5753,14 +7297,14 @@ module Aws::Batch
|
|
5753
7297
|
# string ends with an asterisk (*), this entry specifies the weight
|
5754
7298
|
# factor to use for fair share identifiers that start with that
|
5755
7299
|
# prefix. The list of fair share identifiers in a fair share policy
|
5756
|
-
#
|
7300
|
+
# can't overlap. For example, you can't have one that specifies a
|
5757
7301
|
# `shareIdentifier` of `UserA*` and another that specifies a
|
5758
7302
|
# `shareIdentifier` of `UserA-1`.
|
5759
7303
|
#
|
5760
7304
|
# There can be no more than 500 fair share identifiers active in a job
|
5761
7305
|
# queue.
|
5762
7306
|
#
|
5763
|
-
# The string is limited to 255 alphanumeric characters,
|
7307
|
+
# The string is limited to 255 alphanumeric characters, and can be
|
5764
7308
|
# followed by an asterisk (*).
|
5765
7309
|
# @return [String]
|
5766
7310
|
#
|
@@ -5869,6 +7413,31 @@ module Aws::Batch
|
|
5869
7413
|
# tags: {
|
5870
7414
|
# "TagKey" => "TagValue",
|
5871
7415
|
# },
|
7416
|
+
# eks_properties_override: {
|
7417
|
+
# pod_properties: {
|
7418
|
+
# containers: [
|
7419
|
+
# {
|
7420
|
+
# image: "String",
|
7421
|
+
# command: ["String"],
|
7422
|
+
# args: ["String"],
|
7423
|
+
# env: [
|
7424
|
+
# {
|
7425
|
+
# name: "String", # required
|
7426
|
+
# value: "String",
|
7427
|
+
# },
|
7428
|
+
# ],
|
7429
|
+
# resources: {
|
7430
|
+
# limits: {
|
7431
|
+
# "String" => "Quantity",
|
7432
|
+
# },
|
7433
|
+
# requests: {
|
7434
|
+
# "String" => "Quantity",
|
7435
|
+
# },
|
7436
|
+
# },
|
7437
|
+
# },
|
7438
|
+
# ],
|
7439
|
+
# },
|
7440
|
+
# },
|
5872
7441
|
# }
|
5873
7442
|
#
|
5874
7443
|
# @!attribute [rw] job_name
|
@@ -5883,18 +7452,17 @@ module Aws::Batch
|
|
5883
7452
|
# @return [String]
|
5884
7453
|
#
|
5885
7454
|
# @!attribute [rw] share_identifier
|
5886
|
-
# The share identifier for the job. If the job queue
|
7455
|
+
# The share identifier for the job. If the job queue doesn't have a
|
5887
7456
|
# scheduling policy, then this parameter must not be specified. If the
|
5888
7457
|
# job queue has a scheduling policy, then this parameter must be
|
5889
7458
|
# specified.
|
5890
7459
|
# @return [String]
|
5891
7460
|
#
|
5892
7461
|
# @!attribute [rw] scheduling_priority_override
|
5893
|
-
# The scheduling priority for the job. This
|
5894
|
-
#
|
5895
|
-
# priority
|
5896
|
-
#
|
5897
|
-
# definition.
|
7462
|
+
# The scheduling priority for the job. This only affects jobs in job
|
7463
|
+
# queues with a fair share policy. Jobs with a higher scheduling
|
7464
|
+
# priority are scheduled before jobs with a lower scheduling priority.
|
7465
|
+
# This overrides any scheduling priority in the job definition.
|
5898
7466
|
#
|
5899
7467
|
# The minimum supported value is 0 and the maximum supported value is
|
5900
7468
|
# 9999.
|
@@ -5937,13 +7505,13 @@ module Aws::Batch
|
|
5937
7505
|
# @return [Hash<String,String>]
|
5938
7506
|
#
|
5939
7507
|
# @!attribute [rw] container_overrides
|
5940
|
-
#
|
5941
|
-
# name of a container in the specified
|
5942
|
-
# overrides it
|
5943
|
-
# container, which is specified in the job
|
5944
|
-
# image, with a `command` override. You can
|
5945
|
-
# environment variables on a container or add
|
5946
|
-
# variables to it with an `environment` override.
|
7508
|
+
# An object with various properties that override the defaults for the
|
7509
|
+
# job definition that specify the name of a container in the specified
|
7510
|
+
# job definition and the overrides it should receive. You can override
|
7511
|
+
# the default command for a container, which is specified in the job
|
7512
|
+
# definition or the Docker image, with a `command` override. You can
|
7513
|
+
# also override existing environment variables on a container or add
|
7514
|
+
# new environment variables to it with an `environment` override.
|
5947
7515
|
# @return [Types::ContainerOverrides]
|
5948
7516
|
#
|
5949
7517
|
# @!attribute [rw] node_overrides
|
@@ -6000,6 +7568,12 @@ module Aws::Batch
|
|
6000
7568
|
# [1]: https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html
|
6001
7569
|
# @return [Hash<String,String>]
|
6002
7570
|
#
|
7571
|
+
# @!attribute [rw] eks_properties_override
|
7572
|
+
# An object that can only be specified for jobs that are run on Amazon
|
7573
|
+
# EKS resources with various properties that override defaults for the
|
7574
|
+
# job definition.
|
7575
|
+
# @return [Types::EksPropertiesOverride]
|
7576
|
+
#
|
6003
7577
|
# @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/SubmitJobRequest AWS API Documentation
|
6004
7578
|
#
|
6005
7579
|
class SubmitJobRequest < Struct.new(
|
@@ -6016,7 +7590,8 @@ module Aws::Batch
|
|
6016
7590
|
:retry_strategy,
|
6017
7591
|
:propagate_tags,
|
6018
7592
|
:timeout,
|
6019
|
-
:tags
|
7593
|
+
:tags,
|
7594
|
+
:eks_properties_override)
|
6020
7595
|
SENSITIVE = []
|
6021
7596
|
include Aws::Structure
|
6022
7597
|
end
|
@@ -6059,7 +7634,7 @@ module Aws::Batch
|
|
6059
7634
|
# The Amazon Resource Name (ARN) of the resource that tags are added
|
6060
7635
|
# to. Batch resources that support tags are compute environments,
|
6061
7636
|
# jobs, job definitions, job queues, and scheduling policies. ARNs for
|
6062
|
-
# child jobs of array and multi-node parallel (MNP) jobs
|
7637
|
+
# child jobs of array and multi-node parallel (MNP) jobs aren't
|
6063
7638
|
# supported.
|
6064
7639
|
# @return [String]
|
6065
7640
|
#
|
@@ -6121,7 +7696,7 @@ module Aws::Batch
|
|
6121
7696
|
#
|
6122
7697
|
class TerminateJobResponse < Aws::EmptyStructure; end
|
6123
7698
|
|
6124
|
-
# The container path, mount options, and size of the tmpfs mount.
|
7699
|
+
# The container path, mount options, and size of the `tmpfs` mount.
|
6125
7700
|
#
|
6126
7701
|
# <note markdown="1"> This object isn't applicable to jobs that are running on Fargate
|
6127
7702
|
# resources.
|
@@ -6138,16 +7713,16 @@ module Aws::Batch
|
|
6138
7713
|
# }
|
6139
7714
|
#
|
6140
7715
|
# @!attribute [rw] container_path
|
6141
|
-
# The absolute file path in the container where the tmpfs volume is
|
7716
|
+
# The absolute file path in the container where the `tmpfs` volume is
|
6142
7717
|
# mounted.
|
6143
7718
|
# @return [String]
|
6144
7719
|
#
|
6145
7720
|
# @!attribute [rw] size
|
6146
|
-
# The size (in MiB) of the tmpfs volume.
|
7721
|
+
# The size (in MiB) of the `tmpfs` volume.
|
6147
7722
|
# @return [Integer]
|
6148
7723
|
#
|
6149
7724
|
# @!attribute [rw] mount_options
|
6150
|
-
# The list of tmpfs volume mount options.
|
7725
|
+
# The list of `tmpfs` volume mount options.
|
6151
7726
|
#
|
6152
7727
|
# Valid values: "`defaults`" \| "`ro`" \| "`rw`" \| "`suid`"
|
6153
7728
|
# \| "`nosuid`" \| "`dev`" \| "`nodev`" \| "`exec`" \|
|
@@ -6223,7 +7798,7 @@ module Aws::Batch
|
|
6223
7798
|
# The Amazon Resource Name (ARN) of the resource from which to delete
|
6224
7799
|
# tags. Batch resources that support tags are compute environments,
|
6225
7800
|
# jobs, job definitions, job queues, and scheduling policies. ARNs for
|
6226
|
-
# child jobs of array and multi-node parallel (MNP) jobs
|
7801
|
+
# child jobs of array and multi-node parallel (MNP) jobs aren't
|
6227
7802
|
# supported.
|
6228
7803
|
# @return [String]
|
6229
7804
|
#
|
@@ -6277,6 +7852,7 @@ module Aws::Batch
|
|
6277
7852
|
# {
|
6278
7853
|
# image_type: "ImageType", # required
|
6279
7854
|
# image_id_override: "ImageIdOverride",
|
7855
|
+
# image_kubernetes_version: "KubernetesVersion",
|
6280
7856
|
# },
|
6281
7857
|
# ],
|
6282
7858
|
# update_to_latest_image_version: false,
|
@@ -6315,11 +7891,11 @@ module Aws::Batch
|
|
6315
7891
|
#
|
6316
7892
|
# @!attribute [rw] unmanagedv_cpus
|
6317
7893
|
# The maximum number of vCPUs expected to be used for an unmanaged
|
6318
|
-
# compute environment.
|
7894
|
+
# compute environment. Don't specify this parameter for a managed
|
6319
7895
|
# compute environment. This parameter is only used for fair share
|
6320
7896
|
# scheduling to reserve vCPU capacity for new share identifiers. If
|
6321
|
-
# this parameter
|
6322
|
-
# capacity
|
7897
|
+
# this parameter isn't provided for a fair share job queue, no vCPU
|
7898
|
+
# capacity is reserved.
|
6323
7899
|
# @return [Integer]
|
6324
7900
|
#
|
6325
7901
|
# @!attribute [rw] compute_resources
|
@@ -6390,7 +7966,7 @@ module Aws::Batch
|
|
6390
7966
|
end
|
6391
7967
|
|
6392
7968
|
# @!attribute [rw] compute_environment_name
|
6393
|
-
# The name of the compute environment. It can be up to 128
|
7969
|
+
# The name of the compute environment. It can be up to 128 characters
|
6394
7970
|
# long. It can contain uppercase and lowercase letters, numbers,
|
6395
7971
|
# hyphens (-), and underscores (\_).
|
6396
7972
|
# @return [String]
|
@@ -6443,7 +8019,7 @@ module Aws::Batch
|
|
6443
8019
|
# replaced but not removed. The format is
|
6444
8020
|
# `aws:Partition:batch:Region:Account:scheduling-policy/Name `. For
|
6445
8021
|
# example,
|
6446
|
-
# `aws:aws:batch:us-west-2:
|
8022
|
+
# `aws:aws:batch:us-west-2:123456789012:scheduling-policy/MySchedulingPolicy`.
|
6447
8023
|
# @return [String]
|
6448
8024
|
#
|
6449
8025
|
# @!attribute [rw] priority
|
@@ -6527,7 +8103,7 @@ module Aws::Batch
|
|
6527
8103
|
# @return [Boolean]
|
6528
8104
|
#
|
6529
8105
|
# @!attribute [rw] job_execution_timeout_minutes
|
6530
|
-
# Specifies the job timeout
|
8106
|
+
# Specifies the job timeout (in minutes) when the compute environment
|
6531
8107
|
# infrastructure is updated. The default value is 30.
|
6532
8108
|
# @return [Integer]
|
6533
8109
|
#
|
@@ -6580,7 +8156,7 @@ module Aws::Batch
|
|
6580
8156
|
#
|
6581
8157
|
class UpdateSchedulingPolicyResponse < Aws::EmptyStructure; end
|
6582
8158
|
|
6583
|
-
# A data volume used in a job's container properties.
|
8159
|
+
# A data volume that's used in a job's container properties.
|
6584
8160
|
#
|
6585
8161
|
# @note When making an API call, you may pass Volume
|
6586
8162
|
# data as a hash:
|
@@ -6604,11 +8180,11 @@ module Aws::Batch
|
|
6604
8180
|
#
|
6605
8181
|
# @!attribute [rw] host
|
6606
8182
|
# The contents of the `host` parameter determine whether your data
|
6607
|
-
# volume persists on the host container instance and where it
|
8183
|
+
# volume persists on the host container instance and where it's
|
6608
8184
|
# stored. If the host parameter is empty, then the Docker daemon
|
6609
8185
|
# assigns a host path for your data volume. However, the data isn't
|
6610
|
-
# guaranteed to persist after the containers associated with
|
6611
|
-
# running.
|
8186
|
+
# guaranteed to persist after the containers that are associated with
|
8187
|
+
# it stop running.
|
6612
8188
|
#
|
6613
8189
|
# <note markdown="1"> This parameter isn't applicable to jobs that are running on Fargate
|
6614
8190
|
# resources and shouldn't be provided.
|
@@ -6617,14 +8193,14 @@ module Aws::Batch
|
|
6617
8193
|
# @return [Types::Host]
|
6618
8194
|
#
|
6619
8195
|
# @!attribute [rw] name
|
6620
|
-
# The name of the volume. It can be up to 255
|
8196
|
+
# The name of the volume. It can be up to 255 characters long. It can
|
6621
8197
|
# contain uppercase and lowercase letters, numbers, hyphens (-), and
|
6622
8198
|
# underscores (\_). This name is referenced in the `sourceVolume`
|
6623
8199
|
# parameter of container definition `mountPoints`.
|
6624
8200
|
# @return [String]
|
6625
8201
|
#
|
6626
8202
|
# @!attribute [rw] efs_volume_configuration
|
6627
|
-
# This parameter is specified when you
|
8203
|
+
# This parameter is specified when you're using an Amazon Elastic
|
6628
8204
|
# File System file system for job storage. Jobs that are running on
|
6629
8205
|
# Fargate resources must specify a `platformVersion` of at least
|
6630
8206
|
# `1.4.0`.
|